diff --git a/.gitignore b/.gitignore index 8ac3f51d..35fcdeea 100755 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,4 @@ src/*.egg-info/ __pycache__/ .pytest_cache/ .python-version` +.env diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index f0826df2..b85abb7f 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 07961597-3730-4940-9fd0-35eb4118eab3 management: - docChecksum: f32864912d3a716aa1b28aee6ebab024 + docChecksum: c7cb5a18199f070c4946089791aa6bfc docVersion: 1.0.0 - speakeasyVersion: internal - generationVersion: 2.272.4 - releaseVersion: 0.47.3 - configChecksum: 68885b14db26f61ceed06a1c3f3211b8 + speakeasyVersion: 1.250.0 + generationVersion: 2.304.1 + releaseVersion: 0.49.1 + configChecksum: 8e8b005782719e52a4271a009cf35cb3 repoURL: https://github.com/airbytehq/airbyte-api-python-sdk.git repoSubDirectory: . installationURL: https://github.com/airbytehq/airbyte-api-python-sdk.git @@ -14,2235 +14,2250 @@ management: features: python: additionalProperties: 0.1.0 - constsAndDefaults: 0.1.2 - core: 4.4.7 - globalSecurity: 2.83.3 - globalServerURLs: 2.82.1 - unions: 2.82.5 + constsAndDefaults: 0.1.3 + core: 4.6.4 + globalSecurity: 2.83.5 + globalServerURLs: 2.82.2 + responseFormat: 0.1.0 + unions: 2.82.6 generatedFiles: - - src/airbyte/sdkconfiguration.py - - src/airbyte/connections.py - - src/airbyte/destinations.py - - src/airbyte/jobs.py - - src/airbyte/sources.py - - src/airbyte/streams.py - - src/airbyte/workspaces.py - - src/airbyte/sdk.py + - src/airbyte_api/sdkconfiguration.py + - src/airbyte_api/connections.py + - src/airbyte_api/destinations.py + - src/airbyte_api/jobs.py + - src/airbyte_api/sources.py + - src/airbyte_api/streams.py + - src/airbyte_api/workspaces.py + - src/airbyte_api/sdk.py + - py.typed - pylintrc - setup.py - - src/airbyte/__init__.py - - src/airbyte/utils/__init__.py - - src/airbyte/utils/retries.py - - src/airbyte/utils/utils.py - - src/airbyte/models/errors/sdkerror.py + - src/airbyte_api/__init__.py + - src/airbyte_api/utils/__init__.py + - src/airbyte_api/utils/retries.py + - src/airbyte_api/utils/utils.py + - src/airbyte_api/errors/sdkerror.py - tests/helpers.py - - src/airbyte/models/operations/createconnection.py - - src/airbyte/models/operations/deleteconnection.py - - src/airbyte/models/operations/getconnection.py - - src/airbyte/models/operations/listconnections.py - - src/airbyte/models/operations/patchconnection.py - - src/airbyte/models/operations/createdestination.py - - src/airbyte/models/operations/deletedestination.py - - src/airbyte/models/operations/getdestination.py - - src/airbyte/models/operations/listdestinations.py - - src/airbyte/models/operations/patchdestination.py - - src/airbyte/models/operations/putdestination.py - - src/airbyte/models/operations/canceljob.py - - src/airbyte/models/operations/createjob.py - - src/airbyte/models/operations/getjob.py - - src/airbyte/models/operations/listjobs.py - - src/airbyte/models/operations/createsource.py - - src/airbyte/models/operations/deletesource.py - - src/airbyte/models/operations/getsource.py - - src/airbyte/models/operations/initiateoauth.py - - src/airbyte/models/operations/listsources.py - - src/airbyte/models/operations/patchsource.py - - src/airbyte/models/operations/putsource.py - - src/airbyte/models/operations/getstreamproperties.py - - src/airbyte/models/operations/createorupdateworkspaceoauthcredentials.py - - src/airbyte/models/operations/createworkspace.py - - src/airbyte/models/operations/deleteworkspace.py - - src/airbyte/models/operations/getworkspace.py - - src/airbyte/models/operations/listworkspaces.py - - src/airbyte/models/operations/updateworkspace.py - - src/airbyte/models/shared/connectionresponse.py - - src/airbyte/models/shared/connectionstatusenum.py - - src/airbyte/models/shared/connectionscheduleresponse.py - - src/airbyte/models/shared/scheduletypewithbasicenum.py - - src/airbyte/models/shared/nonbreakingschemaupdatesbehaviorenum.py - - src/airbyte/models/shared/namespacedefinitionenum.py - - src/airbyte/models/shared/geographyenum.py - - src/airbyte/models/shared/streamconfigurations.py - - src/airbyte/models/shared/streamconfiguration.py - - src/airbyte/models/shared/connectionsyncmodeenum.py - - src/airbyte/models/shared/connectioncreaterequest.py - - src/airbyte/models/shared/connectionschedule.py - - src/airbyte/models/shared/scheduletypeenum.py - - src/airbyte/models/shared/connectionsresponse.py - - src/airbyte/models/shared/connectionpatchrequest.py - - src/airbyte/models/shared/nonbreakingschemaupdatesbehaviorenumnodefault.py - - src/airbyte/models/shared/namespacedefinitionenumnodefault.py - - src/airbyte/models/shared/geographyenumnodefault.py - - src/airbyte/models/shared/destinationresponse.py - - src/airbyte/models/shared/destination_google_sheets.py - - src/airbyte/models/shared/destination_astra.py - - src/airbyte/models/shared/destination_aws_datalake.py - - src/airbyte/models/shared/destination_azure_blob_storage.py - - src/airbyte/models/shared/destination_bigquery.py - - src/airbyte/models/shared/destination_clickhouse.py - - src/airbyte/models/shared/destination_convex.py - - src/airbyte/models/shared/destination_cumulio.py - - src/airbyte/models/shared/destination_databend.py - - src/airbyte/models/shared/destination_databricks.py - - src/airbyte/models/shared/destination_dev_null.py - - src/airbyte/models/shared/destination_duckdb.py - - src/airbyte/models/shared/destination_dynamodb.py - - src/airbyte/models/shared/destination_elasticsearch.py - - src/airbyte/models/shared/destination_firebolt.py - - src/airbyte/models/shared/destination_firestore.py - - src/airbyte/models/shared/destination_gcs.py - - src/airbyte/models/shared/destination_keen.py - - src/airbyte/models/shared/destination_kinesis.py - - src/airbyte/models/shared/destination_langchain.py - - src/airbyte/models/shared/destination_milvus.py - - src/airbyte/models/shared/destination_mongodb.py - - src/airbyte/models/shared/destination_mssql.py - - src/airbyte/models/shared/destination_mysql.py - - src/airbyte/models/shared/destination_oracle.py - - src/airbyte/models/shared/destination_pinecone.py - - src/airbyte/models/shared/destination_postgres.py - - src/airbyte/models/shared/destination_pubsub.py - - src/airbyte/models/shared/destination_qdrant.py - - src/airbyte/models/shared/destination_redis.py - - src/airbyte/models/shared/destination_redshift.py - - src/airbyte/models/shared/destination_s3.py - - src/airbyte/models/shared/destination_s3_glue.py - - src/airbyte/models/shared/destination_sftp_json.py - - src/airbyte/models/shared/destination_snowflake.py - - src/airbyte/models/shared/destination_teradata.py - - src/airbyte/models/shared/destination_timeplus.py - - src/airbyte/models/shared/destination_typesense.py - - src/airbyte/models/shared/destination_vectara.py - - src/airbyte/models/shared/destination_vertica.py - - src/airbyte/models/shared/destination_weaviate.py - - src/airbyte/models/shared/destination_xata.py - - src/airbyte/models/shared/destinationcreaterequest.py - - src/airbyte/models/shared/destinationsresponse.py - - src/airbyte/models/shared/destinationpatchrequest.py - - src/airbyte/models/shared/destinationputrequest.py - - src/airbyte/models/shared/jobresponse.py - - src/airbyte/models/shared/jobstatusenum.py - - src/airbyte/models/shared/jobtypeenum.py - - src/airbyte/models/shared/jobcreaterequest.py - - src/airbyte/models/shared/jobsresponse.py - - src/airbyte/models/shared/sourceresponse.py - - src/airbyte/models/shared/source_aha.py - - src/airbyte/models/shared/source_aircall.py - - src/airbyte/models/shared/source_airtable.py - - src/airbyte/models/shared/source_amazon_ads.py - - src/airbyte/models/shared/source_amazon_seller_partner.py - - src/airbyte/models/shared/source_amazon_sqs.py - - src/airbyte/models/shared/source_amplitude.py - - src/airbyte/models/shared/source_apify_dataset.py - - src/airbyte/models/shared/source_appfollow.py - - src/airbyte/models/shared/source_asana.py - - src/airbyte/models/shared/source_auth0.py - - src/airbyte/models/shared/source_aws_cloudtrail.py - - src/airbyte/models/shared/source_azure_blob_storage.py - - src/airbyte/models/shared/source_azure_table.py - - src/airbyte/models/shared/source_bamboo_hr.py - - src/airbyte/models/shared/source_bigquery.py - - src/airbyte/models/shared/source_bing_ads.py - - src/airbyte/models/shared/source_braintree.py - - src/airbyte/models/shared/source_braze.py - - src/airbyte/models/shared/source_cart.py - - src/airbyte/models/shared/source_chargebee.py - - src/airbyte/models/shared/source_chartmogul.py - - src/airbyte/models/shared/source_clickhouse.py - - src/airbyte/models/shared/source_clickup_api.py - - src/airbyte/models/shared/source_clockify.py - - src/airbyte/models/shared/source_close_com.py - - src/airbyte/models/shared/source_coda.py - - src/airbyte/models/shared/source_coin_api.py - - src/airbyte/models/shared/source_coinmarketcap.py - - src/airbyte/models/shared/source_configcat.py - - src/airbyte/models/shared/source_confluence.py - - src/airbyte/models/shared/source_convex.py - - src/airbyte/models/shared/source_datascope.py - - src/airbyte/models/shared/source_delighted.py - - src/airbyte/models/shared/source_dixa.py - - src/airbyte/models/shared/source_dockerhub.py - - src/airbyte/models/shared/source_dremio.py - - src/airbyte/models/shared/source_dynamodb.py - - src/airbyte/models/shared/source_e2e_test_cloud.py - - src/airbyte/models/shared/source_emailoctopus.py - - src/airbyte/models/shared/source_exchange_rates.py - - src/airbyte/models/shared/source_facebook_marketing.py - - src/airbyte/models/shared/source_faker.py - - src/airbyte/models/shared/source_fauna.py - - src/airbyte/models/shared/source_file.py - - src/airbyte/models/shared/source_firebolt.py - - src/airbyte/models/shared/source_freshcaller.py - - src/airbyte/models/shared/source_freshdesk.py - - src/airbyte/models/shared/source_freshsales.py - - src/airbyte/models/shared/source_gainsight_px.py - - src/airbyte/models/shared/source_gcs.py - - src/airbyte/models/shared/source_getlago.py - - src/airbyte/models/shared/source_github.py - - src/airbyte/models/shared/source_gitlab.py - - src/airbyte/models/shared/source_glassfrog.py - - src/airbyte/models/shared/source_gnews.py - - src/airbyte/models/shared/source_google_ads.py - - src/airbyte/models/shared/source_google_analytics_data_api.py - - src/airbyte/models/shared/source_google_analytics_v4_service_account_only.py - - src/airbyte/models/shared/source_google_directory.py - - src/airbyte/models/shared/source_google_drive.py - - src/airbyte/models/shared/source_google_pagespeed_insights.py - - src/airbyte/models/shared/source_google_search_console.py - - src/airbyte/models/shared/source_google_sheets.py - - src/airbyte/models/shared/source_google_webfonts.py - - src/airbyte/models/shared/source_google_workspace_admin_reports.py - - src/airbyte/models/shared/source_greenhouse.py - - src/airbyte/models/shared/source_gridly.py - - src/airbyte/models/shared/source_harvest.py - - src/airbyte/models/shared/source_hubplanner.py - - src/airbyte/models/shared/source_hubspot.py - - src/airbyte/models/shared/source_insightly.py - - src/airbyte/models/shared/source_instagram.py - - src/airbyte/models/shared/source_instatus.py - - src/airbyte/models/shared/source_intercom.py - - src/airbyte/models/shared/source_ip2whois.py - - src/airbyte/models/shared/source_iterable.py - - src/airbyte/models/shared/source_jira.py - - src/airbyte/models/shared/source_k6_cloud.py - - src/airbyte/models/shared/source_klarna.py - - src/airbyte/models/shared/source_klaviyo.py - - src/airbyte/models/shared/source_kyve.py - - src/airbyte/models/shared/source_launchdarkly.py - - src/airbyte/models/shared/source_lemlist.py - - src/airbyte/models/shared/source_lever_hiring.py - - src/airbyte/models/shared/source_linkedin_ads.py - - src/airbyte/models/shared/source_linkedin_pages.py - - src/airbyte/models/shared/source_lokalise.py - - src/airbyte/models/shared/source_mailchimp.py - - src/airbyte/models/shared/source_mailgun.py - - src/airbyte/models/shared/source_mailjet_sms.py - - src/airbyte/models/shared/source_marketo.py - - src/airbyte/models/shared/source_metabase.py - - src/airbyte/models/shared/source_microsoft_sharepoint.py - - src/airbyte/models/shared/source_microsoft_teams.py - - src/airbyte/models/shared/source_mixpanel.py - - src/airbyte/models/shared/source_monday.py - - src/airbyte/models/shared/source_mongodb_internal_poc.py - - src/airbyte/models/shared/source_mongodb_v2.py - - src/airbyte/models/shared/source_mssql.py - - src/airbyte/models/shared/source_my_hours.py - - src/airbyte/models/shared/source_mysql.py - - src/airbyte/models/shared/source_netsuite.py - - src/airbyte/models/shared/source_notion.py - - src/airbyte/models/shared/source_nytimes.py - - src/airbyte/models/shared/source_okta.py - - src/airbyte/models/shared/source_omnisend.py - - src/airbyte/models/shared/source_onesignal.py - - src/airbyte/models/shared/source_oracle.py - - src/airbyte/models/shared/source_orb.py - - src/airbyte/models/shared/source_orbit.py - - src/airbyte/models/shared/source_outbrain_amplify.py - - src/airbyte/models/shared/source_outreach.py - - src/airbyte/models/shared/source_paypal_transaction.py - - src/airbyte/models/shared/source_paystack.py - - src/airbyte/models/shared/source_pendo.py - - src/airbyte/models/shared/source_persistiq.py - - src/airbyte/models/shared/source_pexels_api.py - - src/airbyte/models/shared/source_pinterest.py - - src/airbyte/models/shared/source_pipedrive.py - - src/airbyte/models/shared/source_pocket.py - - src/airbyte/models/shared/source_pokeapi.py - - src/airbyte/models/shared/source_polygon_stock_api.py - - src/airbyte/models/shared/source_postgres.py - - src/airbyte/models/shared/source_posthog.py - - src/airbyte/models/shared/source_postmarkapp.py - - src/airbyte/models/shared/source_prestashop.py - - src/airbyte/models/shared/source_punk_api.py - - src/airbyte/models/shared/source_pypi.py - - src/airbyte/models/shared/source_qualaroo.py - - src/airbyte/models/shared/source_quickbooks.py - - src/airbyte/models/shared/source_railz.py - - src/airbyte/models/shared/source_recharge.py - - src/airbyte/models/shared/source_recreation.py - - src/airbyte/models/shared/source_recruitee.py - - src/airbyte/models/shared/source_redshift.py - - src/airbyte/models/shared/source_retently.py - - src/airbyte/models/shared/source_rki_covid.py - - src/airbyte/models/shared/source_rss.py - - src/airbyte/models/shared/source_s3.py - - src/airbyte/models/shared/source_salesforce.py - - src/airbyte/models/shared/source_salesloft.py - - src/airbyte/models/shared/source_sap_fieldglass.py - - src/airbyte/models/shared/source_secoda.py - - src/airbyte/models/shared/source_sendgrid.py - - src/airbyte/models/shared/source_sendinblue.py - - src/airbyte/models/shared/source_senseforce.py - - src/airbyte/models/shared/source_sentry.py - - src/airbyte/models/shared/source_sftp.py - - src/airbyte/models/shared/source_sftp_bulk.py - - src/airbyte/models/shared/source_shopify.py - - src/airbyte/models/shared/source_shortio.py - - src/airbyte/models/shared/source_slack.py - - src/airbyte/models/shared/source_smaily.py - - src/airbyte/models/shared/source_smartengage.py - - src/airbyte/models/shared/source_smartsheets.py - - src/airbyte/models/shared/source_snapchat_marketing.py - - src/airbyte/models/shared/source_snowflake.py - - src/airbyte/models/shared/source_sonar_cloud.py - - src/airbyte/models/shared/source_spacex_api.py - - src/airbyte/models/shared/source_square.py - - src/airbyte/models/shared/source_strava.py - - src/airbyte/models/shared/source_stripe.py - - src/airbyte/models/shared/source_survey_sparrow.py - - src/airbyte/models/shared/source_surveymonkey.py - - src/airbyte/models/shared/source_tempo.py - - src/airbyte/models/shared/source_the_guardian_api.py - - src/airbyte/models/shared/source_tiktok_marketing.py - - src/airbyte/models/shared/source_trello.py - - src/airbyte/models/shared/source_trustpilot.py - - src/airbyte/models/shared/source_tvmaze_schedule.py - - src/airbyte/models/shared/source_twilio.py - - src/airbyte/models/shared/source_twilio_taskrouter.py - - src/airbyte/models/shared/source_twitter.py - - src/airbyte/models/shared/source_typeform.py - - src/airbyte/models/shared/source_us_census.py - - src/airbyte/models/shared/source_vantage.py - - src/airbyte/models/shared/source_webflow.py - - src/airbyte/models/shared/source_whisky_hunter.py - - src/airbyte/models/shared/source_wikipedia_pageviews.py - - src/airbyte/models/shared/source_woocommerce.py - - src/airbyte/models/shared/source_xkcd.py - - src/airbyte/models/shared/source_yandex_metrica.py - - src/airbyte/models/shared/source_yotpo.py - - src/airbyte/models/shared/source_youtube_analytics.py - - src/airbyte/models/shared/source_zendesk_chat.py - - src/airbyte/models/shared/source_zendesk_sell.py - - src/airbyte/models/shared/source_zendesk_sunshine.py - - src/airbyte/models/shared/source_zendesk_support.py - - src/airbyte/models/shared/source_zendesk_talk.py - - src/airbyte/models/shared/source_zenloop.py - - src/airbyte/models/shared/source_zoho_crm.py - - src/airbyte/models/shared/source_zoom.py - - src/airbyte/models/shared/sourcecreaterequest.py - - src/airbyte/models/shared/initiateoauthrequest.py - - src/airbyte/models/shared/oauthactornames.py - - src/airbyte/models/shared/oauthinputconfiguration.py - - src/airbyte/models/shared/sourcesresponse.py - - src/airbyte/models/shared/sourcepatchrequest.py - - src/airbyte/models/shared/sourceputrequest.py - - src/airbyte/models/shared/streampropertiesresponse.py - - src/airbyte/models/shared/streamproperties.py - - src/airbyte/models/shared/workspaceoauthcredentialsrequest.py - - src/airbyte/models/shared/airtable.py - - src/airbyte/models/shared/amazon_ads.py - - src/airbyte/models/shared/amazon_seller_partner.py - - src/airbyte/models/shared/asana.py - - src/airbyte/models/shared/bing_ads.py - - src/airbyte/models/shared/facebook_marketing.py - - src/airbyte/models/shared/github.py - - src/airbyte/models/shared/gitlab.py - - src/airbyte/models/shared/google_ads.py - - src/airbyte/models/shared/google_analytics_data_api.py - - src/airbyte/models/shared/google_drive.py - - src/airbyte/models/shared/google_search_console.py - - src/airbyte/models/shared/google_sheets.py - - src/airbyte/models/shared/harvest.py - - src/airbyte/models/shared/hubspot.py - - src/airbyte/models/shared/instagram.py - - src/airbyte/models/shared/intercom.py - - src/airbyte/models/shared/lever_hiring.py - - src/airbyte/models/shared/linkedin_ads.py - - src/airbyte/models/shared/mailchimp.py - - src/airbyte/models/shared/microsoft_sharepoint.py - - src/airbyte/models/shared/microsoft_teams.py - - src/airbyte/models/shared/monday.py - - src/airbyte/models/shared/notion.py - - src/airbyte/models/shared/pinterest.py - - src/airbyte/models/shared/retently.py - - src/airbyte/models/shared/salesforce.py - - src/airbyte/models/shared/shopify.py - - src/airbyte/models/shared/slack.py - - src/airbyte/models/shared/smartsheets.py - - src/airbyte/models/shared/snapchat_marketing.py - - src/airbyte/models/shared/snowflake.py - - src/airbyte/models/shared/square.py - - src/airbyte/models/shared/strava.py - - src/airbyte/models/shared/surveymonkey.py - - src/airbyte/models/shared/tiktok_marketing.py - - src/airbyte/models/shared/typeform.py - - src/airbyte/models/shared/youtube_analytics.py - - src/airbyte/models/shared/zendesk_chat.py - - src/airbyte/models/shared/zendesk_sunshine.py - - src/airbyte/models/shared/zendesk_support.py - - src/airbyte/models/shared/zendesk_talk.py - - src/airbyte/models/shared/actortypeenum.py - - src/airbyte/models/shared/workspaceresponse.py - - src/airbyte/models/shared/workspacecreaterequest.py - - src/airbyte/models/shared/workspacesresponse.py - - src/airbyte/models/shared/workspaceupdaterequest.py - - src/airbyte/models/shared/security.py - - src/airbyte/models/shared/schemebasicauth.py - - src/airbyte/models/__init__.py - - src/airbyte/models/errors/__init__.py - - src/airbyte/models/operations/__init__.py - - src/airbyte/models/shared/__init__.py - - docs/models/operations/createconnectionresponse.md - - docs/models/operations/deleteconnectionrequest.md - - docs/models/operations/deleteconnectionresponse.md - - docs/models/operations/getconnectionrequest.md - - docs/models/operations/getconnectionresponse.md - - docs/models/operations/listconnectionsrequest.md - - docs/models/operations/listconnectionsresponse.md - - docs/models/operations/patchconnectionrequest.md - - docs/models/operations/patchconnectionresponse.md - - docs/models/operations/createdestinationresponse.md - - docs/models/operations/deletedestinationrequest.md - - docs/models/operations/deletedestinationresponse.md - - docs/models/operations/getdestinationrequest.md - - docs/models/operations/getdestinationresponse.md - - docs/models/operations/listdestinationsrequest.md - - docs/models/operations/listdestinationsresponse.md - - docs/models/operations/patchdestinationrequest.md - - docs/models/operations/patchdestinationresponse.md - - docs/models/operations/putdestinationrequest.md - - docs/models/operations/putdestinationresponse.md - - docs/models/operations/canceljobrequest.md - - docs/models/operations/canceljobresponse.md - - docs/models/operations/createjobresponse.md - - docs/models/operations/getjobrequest.md - - docs/models/operations/getjobresponse.md - - docs/models/operations/listjobsrequest.md - - docs/models/operations/listjobsresponse.md - - docs/models/operations/createsourceresponse.md - - docs/models/operations/deletesourcerequest.md - - docs/models/operations/deletesourceresponse.md - - docs/models/operations/getsourcerequest.md - - docs/models/operations/getsourceresponse.md - - docs/models/operations/initiateoauthresponse.md - - docs/models/operations/listsourcesrequest.md - - docs/models/operations/listsourcesresponse.md - - docs/models/operations/patchsourcerequest.md - - docs/models/operations/patchsourceresponse.md - - docs/models/operations/putsourcerequest.md - - docs/models/operations/putsourceresponse.md - - docs/models/operations/getstreampropertiesrequest.md - - docs/models/operations/getstreampropertiesresponse.md - - docs/models/operations/createorupdateworkspaceoauthcredentialsrequest.md - - docs/models/operations/createorupdateworkspaceoauthcredentialsresponse.md - - docs/models/operations/createworkspaceresponse.md - - docs/models/operations/deleteworkspacerequest.md - - docs/models/operations/deleteworkspaceresponse.md - - docs/models/operations/getworkspacerequest.md - - docs/models/operations/getworkspaceresponse.md - - docs/models/operations/listworkspacesrequest.md - - docs/models/operations/listworkspacesresponse.md - - docs/models/operations/updateworkspacerequest.md - - docs/models/operations/updateworkspaceresponse.md - - docs/models/shared/connectionresponse.md - - docs/models/shared/connectionstatusenum.md - - docs/models/shared/connectionscheduleresponse.md - - docs/models/shared/scheduletypewithbasicenum.md - - docs/models/shared/nonbreakingschemaupdatesbehaviorenum.md - - docs/models/shared/namespacedefinitionenum.md - - docs/models/shared/geographyenum.md - - docs/models/shared/streamconfigurations.md - - docs/models/shared/streamconfiguration.md - - docs/models/shared/connectionsyncmodeenum.md - - docs/models/shared/connectioncreaterequest.md - - docs/models/shared/connectionschedule.md - - docs/models/shared/scheduletypeenum.md - - docs/models/shared/connectionsresponse.md - - docs/models/shared/connectionpatchrequest.md - - docs/models/shared/nonbreakingschemaupdatesbehaviorenumnodefault.md - - docs/models/shared/namespacedefinitionenumnodefault.md - - docs/models/shared/geographyenumnodefault.md - - docs/models/shared/destinationresponse.md - - docs/models/shared/destinationconfiguration.md - - docs/models/shared/authenticationviagoogleoauth.md - - docs/models/shared/destinationgooglesheetsgooglesheets.md - - docs/models/shared/destinationgooglesheets.md - - docs/models/shared/astra.md - - docs/models/shared/destinationastraschemasembeddingembeddingmode.md - - docs/models/shared/openaicompatible.md - - docs/models/shared/destinationastraschemasembeddingmode.md - - docs/models/shared/azureopenai.md - - docs/models/shared/destinationastraschemasmode.md - - docs/models/shared/fake.md - - docs/models/shared/destinationastramode.md - - docs/models/shared/cohere.md - - docs/models/shared/destinationastraschemasembeddingembedding1mode.md - - docs/models/shared/openai.md - - docs/models/shared/embedding.md - - docs/models/shared/indexing.md - - docs/models/shared/fieldnamemappingconfigmodel.md - - docs/models/shared/destinationastralanguage.md - - docs/models/shared/destinationastraschemasprocessingtextsplittertextsplittermode.md - - docs/models/shared/byprogramminglanguage.md - - docs/models/shared/destinationastraschemasprocessingtextsplittermode.md - - docs/models/shared/bymarkdownheader.md - - docs/models/shared/destinationastraschemasprocessingmode.md - - docs/models/shared/byseparator.md - - docs/models/shared/textsplitter.md - - docs/models/shared/processingconfigmodel.md - - docs/models/shared/destinationastra.md - - docs/models/shared/destinationawsdatalakecredentialstitle.md - - docs/models/shared/iamuser.md - - docs/models/shared/credentialstitle.md - - docs/models/shared/iamrole.md - - docs/models/shared/authenticationmode.md - - docs/models/shared/awsdatalake.md - - docs/models/shared/destinationawsdatalakecompressioncodecoptional.md - - docs/models/shared/destinationawsdatalakeformattypewildcard.md - - docs/models/shared/parquetcolumnarstorage.md - - docs/models/shared/compressioncodecoptional.md - - docs/models/shared/formattypewildcard.md - - docs/models/shared/jsonlinesnewlinedelimitedjson.md - - docs/models/shared/outputformatwildcard.md - - docs/models/shared/choosehowtopartitiondata.md - - docs/models/shared/s3bucketregion.md - - docs/models/shared/destinationawsdatalake.md - - docs/models/shared/azureblobstorage.md - - docs/models/shared/destinationazureblobstorageformattype.md - - docs/models/shared/destinationazureblobstoragejsonlinesnewlinedelimitedjson.md - - docs/models/shared/normalizationflattening.md - - docs/models/shared/formattype.md - - docs/models/shared/csvcommaseparatedvalues.md - - docs/models/shared/outputformat.md - - docs/models/shared/destinationazureblobstorage.md - - docs/models/shared/datasetlocation.md - - docs/models/shared/bigquery.md - - docs/models/shared/destinationbigquerymethod.md - - docs/models/shared/standardinserts.md - - docs/models/shared/destinationbigquerycredentialtype.md - - docs/models/shared/destinationbigqueryhmackey.md - - docs/models/shared/credential.md - - docs/models/shared/gcstmpfilesafterwardprocessing.md - - docs/models/shared/method.md - - docs/models/shared/gcsstaging.md - - docs/models/shared/loadingmethod.md - - docs/models/shared/transformationqueryruntype.md - - docs/models/shared/destinationbigquery.md - - docs/models/shared/clickhouse.md - - docs/models/shared/destinationclickhouseschemastunnelmethod.md - - docs/models/shared/passwordauthentication.md - - docs/models/shared/destinationclickhousetunnelmethod.md - - docs/models/shared/sshkeyauthentication.md - - docs/models/shared/tunnelmethod.md - - docs/models/shared/notunnel.md - - docs/models/shared/sshtunnelmethod.md - - docs/models/shared/destinationclickhouse.md - - docs/models/shared/convex.md - - docs/models/shared/destinationconvex.md - - docs/models/shared/cumulio.md - - docs/models/shared/destinationcumulio.md - - docs/models/shared/databend.md - - docs/models/shared/destinationdatabend.md - - docs/models/shared/destinationdatabricksschemasdatasourcetype.md - - docs/models/shared/destinationdatabricksazureblobstorage.md - - docs/models/shared/destinationdatabricksdatasourcetype.md - - docs/models/shared/destinationdatabrickss3bucketregion.md - - docs/models/shared/amazons3.md - - docs/models/shared/datasourcetype.md - - docs/models/shared/recommendedmanagedtables.md - - docs/models/shared/datasource.md - - docs/models/shared/databricks.md - - docs/models/shared/destinationdatabricks.md - - docs/models/shared/devnull.md - - docs/models/shared/testdestinationtype.md - - docs/models/shared/silent.md - - docs/models/shared/testdestination.md - - docs/models/shared/destinationdevnull.md - - docs/models/shared/duckdb.md - - docs/models/shared/destinationduckdb.md - - docs/models/shared/dynamodb.md - - docs/models/shared/dynamodbregion.md - - docs/models/shared/destinationdynamodb.md - - docs/models/shared/destinationelasticsearchschemasmethod.md - - docs/models/shared/usernamepassword.md - - docs/models/shared/destinationelasticsearchmethod.md - - docs/models/shared/apikeysecret.md - - docs/models/shared/authenticationmethod.md - - docs/models/shared/elasticsearch.md - - docs/models/shared/destinationelasticsearch.md - - docs/models/shared/firebolt.md - - docs/models/shared/destinationfireboltschemasmethod.md - - docs/models/shared/externaltablevias3.md - - docs/models/shared/destinationfireboltmethod.md - - docs/models/shared/sqlinserts.md - - docs/models/shared/destinationfireboltloadingmethod.md - - docs/models/shared/destinationfirebolt.md - - docs/models/shared/firestore.md - - docs/models/shared/destinationfirestore.md - - docs/models/shared/credentialtype.md - - docs/models/shared/hmackey.md - - docs/models/shared/authentication.md - - docs/models/shared/gcs.md - - docs/models/shared/destinationgcscompressioncodec.md - - docs/models/shared/destinationgcsschemasformatoutputformatformattype.md - - docs/models/shared/destinationgcsparquetcolumnarstorage.md - - docs/models/shared/destinationgcsschemasformatcompressiontype.md - - docs/models/shared/destinationgcsgzip.md - - docs/models/shared/destinationgcsschemascompressiontype.md - - docs/models/shared/destinationgcsschemasnocompression.md - - docs/models/shared/destinationgcscompression.md - - docs/models/shared/destinationgcsschemasformatformattype.md - - docs/models/shared/destinationgcsjsonlinesnewlinedelimitedjson.md - - docs/models/shared/destinationgcscompressiontype.md - - docs/models/shared/gzip.md - - docs/models/shared/compressiontype.md - - docs/models/shared/destinationgcsnocompression.md - - docs/models/shared/compression.md - - docs/models/shared/normalization.md - - docs/models/shared/destinationgcsschemasformattype.md - - docs/models/shared/destinationgcscsvcommaseparatedvalues.md - - docs/models/shared/destinationgcsschemasformatoutputformat1codec.md - - docs/models/shared/snappy.md - - docs/models/shared/destinationgcsschemasformatoutputformatcodec.md - - docs/models/shared/zstandard.md - - docs/models/shared/destinationgcsschemasformatcodec.md - - docs/models/shared/xz.md - - docs/models/shared/destinationgcsschemascodec.md - - docs/models/shared/bzip2.md - - docs/models/shared/destinationgcscodec.md - - docs/models/shared/deflate.md - - docs/models/shared/codec.md - - docs/models/shared/nocompression.md - - docs/models/shared/compressioncodec.md - - docs/models/shared/destinationgcsformattype.md - - docs/models/shared/avroapacheavro.md - - docs/models/shared/destinationgcsoutputformat.md - - docs/models/shared/gcsbucketregion.md - - docs/models/shared/destinationgcs.md - - docs/models/shared/keen.md - - docs/models/shared/destinationkeen.md - - docs/models/shared/kinesis.md - - docs/models/shared/destinationkinesis.md - - docs/models/shared/langchain.md - - docs/models/shared/destinationlangchainschemasmode.md - - docs/models/shared/destinationlangchainfake.md - - docs/models/shared/destinationlangchainmode.md - - docs/models/shared/destinationlangchainopenai.md - - docs/models/shared/destinationlangchainembedding.md - - docs/models/shared/destinationlangchainschemasindexingindexing3mode.md - - docs/models/shared/chromalocalpersistance.md - - docs/models/shared/destinationlangchainschemasindexingindexingmode.md - - docs/models/shared/docarrayhnswsearch.md - - docs/models/shared/destinationlangchainschemasindexingmode.md - - docs/models/shared/destinationlangchainpinecone.md - - docs/models/shared/destinationlangchainindexing.md - - docs/models/shared/destinationlangchainprocessingconfigmodel.md - - docs/models/shared/destinationlangchain.md - - docs/models/shared/milvus.md - - docs/models/shared/destinationmilvusschemasembeddingembedding5mode.md - - docs/models/shared/destinationmilvusopenaicompatible.md - - docs/models/shared/destinationmilvusschemasembeddingembeddingmode.md - - docs/models/shared/destinationmilvusazureopenai.md - - docs/models/shared/destinationmilvusschemasembeddingmode.md - - docs/models/shared/destinationmilvusfake.md - - docs/models/shared/destinationmilvusschemasmode.md - - docs/models/shared/destinationmilvuscohere.md - - docs/models/shared/destinationmilvusmode.md - - docs/models/shared/destinationmilvusopenai.md - - docs/models/shared/destinationmilvusembedding.md - - docs/models/shared/destinationmilvusschemasindexingauthauthenticationmode.md - - docs/models/shared/noauth.md - - docs/models/shared/destinationmilvusschemasindexingauthmode.md - - docs/models/shared/destinationmilvususernamepassword.md - - docs/models/shared/destinationmilvusschemasindexingmode.md - - docs/models/shared/destinationmilvusapitoken.md - - docs/models/shared/destinationmilvusauthentication.md - - docs/models/shared/destinationmilvusindexing.md - - docs/models/shared/destinationmilvusfieldnamemappingconfigmodel.md - - docs/models/shared/destinationmilvuslanguage.md - - docs/models/shared/destinationmilvusschemasprocessingtextsplittertextsplittermode.md - - docs/models/shared/destinationmilvusbyprogramminglanguage.md - - docs/models/shared/destinationmilvusschemasprocessingtextsplittermode.md - - docs/models/shared/destinationmilvusbymarkdownheader.md - - docs/models/shared/destinationmilvusschemasprocessingmode.md - - docs/models/shared/destinationmilvusbyseparator.md - - docs/models/shared/destinationmilvustextsplitter.md - - docs/models/shared/destinationmilvusprocessingconfigmodel.md - - docs/models/shared/destinationmilvus.md - - docs/models/shared/destinationmongodbauthorization.md - - docs/models/shared/loginpassword.md - - docs/models/shared/destinationmongodbschemasauthorization.md - - docs/models/shared/nonet.md - - docs/models/shared/authorizationtype.md - - docs/models/shared/mongodb.md - - docs/models/shared/destinationmongodbschemasinstance.md - - docs/models/shared/mongodbatlas.md - - docs/models/shared/destinationmongodbinstance.md - - docs/models/shared/replicaset.md - - docs/models/shared/instance.md - - docs/models/shared/standalonemongodbinstance.md - - docs/models/shared/mongodbinstancetype.md - - docs/models/shared/destinationmongodbschemastunnelmethodtunnelmethod.md - - docs/models/shared/destinationmongodbpasswordauthentication.md - - docs/models/shared/destinationmongodbschemastunnelmethod.md - - docs/models/shared/destinationmongodbsshkeyauthentication.md - - docs/models/shared/destinationmongodbtunnelmethod.md - - docs/models/shared/destinationmongodbnotunnel.md - - docs/models/shared/destinationmongodbsshtunnelmethod.md - - docs/models/shared/destinationmongodb.md - - docs/models/shared/mssql.md - - docs/models/shared/destinationmssqlschemassslmethod.md - - docs/models/shared/encryptedverifycertificate.md - - docs/models/shared/destinationmssqlsslmethod.md - - docs/models/shared/encryptedtrustservercertificate.md - - docs/models/shared/sslmethod.md - - docs/models/shared/destinationmssqlschemastunnelmethodtunnelmethod.md - - docs/models/shared/destinationmssqlpasswordauthentication.md - - docs/models/shared/destinationmssqlschemastunnelmethod.md - - docs/models/shared/destinationmssqlsshkeyauthentication.md - - docs/models/shared/destinationmssqltunnelmethod.md - - docs/models/shared/destinationmssqlnotunnel.md - - docs/models/shared/destinationmssqlsshtunnelmethod.md - - docs/models/shared/destinationmssql.md - - docs/models/shared/mysql.md - - docs/models/shared/destinationmysqlschemastunnelmethodtunnelmethod.md - - docs/models/shared/destinationmysqlpasswordauthentication.md - - docs/models/shared/destinationmysqlschemastunnelmethod.md - - docs/models/shared/destinationmysqlsshkeyauthentication.md - - docs/models/shared/destinationmysqltunnelmethod.md - - docs/models/shared/destinationmysqlnotunnel.md - - docs/models/shared/destinationmysqlsshtunnelmethod.md - - docs/models/shared/destinationmysql.md - - docs/models/shared/oracle.md - - docs/models/shared/destinationoracleschemastunnelmethodtunnelmethod.md - - docs/models/shared/destinationoraclepasswordauthentication.md - - docs/models/shared/destinationoracleschemastunnelmethod.md - - docs/models/shared/destinationoraclesshkeyauthentication.md - - docs/models/shared/destinationoracletunnelmethod.md - - docs/models/shared/destinationoraclenotunnel.md - - docs/models/shared/destinationoraclesshtunnelmethod.md - - docs/models/shared/destinationoracle.md - - docs/models/shared/pinecone.md - - docs/models/shared/destinationpineconeschemasembeddingembedding5mode.md - - docs/models/shared/destinationpineconeopenaicompatible.md - - docs/models/shared/destinationpineconeschemasembeddingembeddingmode.md - - docs/models/shared/destinationpineconeazureopenai.md - - docs/models/shared/destinationpineconeschemasembeddingmode.md - - docs/models/shared/destinationpineconefake.md - - docs/models/shared/destinationpineconeschemasmode.md - - docs/models/shared/destinationpineconecohere.md - - docs/models/shared/destinationpineconemode.md - - docs/models/shared/destinationpineconeopenai.md - - docs/models/shared/destinationpineconeembedding.md - - docs/models/shared/destinationpineconeindexing.md - - docs/models/shared/destinationpineconefieldnamemappingconfigmodel.md - - docs/models/shared/destinationpineconelanguage.md - - docs/models/shared/destinationpineconeschemasprocessingtextsplittertextsplittermode.md - - docs/models/shared/destinationpineconebyprogramminglanguage.md - - docs/models/shared/destinationpineconeschemasprocessingtextsplittermode.md - - docs/models/shared/destinationpineconebymarkdownheader.md - - docs/models/shared/destinationpineconeschemasprocessingmode.md - - docs/models/shared/destinationpineconebyseparator.md - - docs/models/shared/destinationpineconetextsplitter.md - - docs/models/shared/destinationpineconeprocessingconfigmodel.md - - docs/models/shared/destinationpinecone.md - - docs/models/shared/postgres.md - - docs/models/shared/destinationpostgresschemassslmodesslmodes6mode.md - - docs/models/shared/verifyfull.md - - docs/models/shared/destinationpostgresschemassslmodesslmodesmode.md - - docs/models/shared/verifyca.md - - docs/models/shared/destinationpostgresschemassslmodemode.md - - docs/models/shared/require.md - - docs/models/shared/destinationpostgresschemasmode.md - - docs/models/shared/prefer.md - - docs/models/shared/destinationpostgresmode.md - - docs/models/shared/allow.md - - docs/models/shared/mode.md - - docs/models/shared/disable.md - - docs/models/shared/sslmodes.md - - docs/models/shared/destinationpostgresschemastunnelmethodtunnelmethod.md - - docs/models/shared/destinationpostgrespasswordauthentication.md - - docs/models/shared/destinationpostgresschemastunnelmethod.md - - docs/models/shared/destinationpostgressshkeyauthentication.md - - docs/models/shared/destinationpostgrestunnelmethod.md - - docs/models/shared/destinationpostgresnotunnel.md - - docs/models/shared/destinationpostgressshtunnelmethod.md - - docs/models/shared/destinationpostgres.md - - docs/models/shared/pubsub.md - - docs/models/shared/destinationpubsub.md - - docs/models/shared/qdrant.md - - docs/models/shared/destinationqdrantschemasembeddingembedding5mode.md - - docs/models/shared/destinationqdrantopenaicompatible.md - - docs/models/shared/destinationqdrantschemasembeddingembeddingmode.md - - docs/models/shared/destinationqdrantazureopenai.md - - docs/models/shared/destinationqdrantschemasembeddingmode.md - - docs/models/shared/destinationqdrantfake.md - - docs/models/shared/destinationqdrantschemasmode.md - - docs/models/shared/destinationqdrantcohere.md - - docs/models/shared/destinationqdrantmode.md - - docs/models/shared/destinationqdrantopenai.md - - docs/models/shared/destinationqdrantembedding.md - - docs/models/shared/destinationqdrantschemasindexingauthmethodmode.md - - docs/models/shared/destinationqdrantnoauth.md - - docs/models/shared/destinationqdrantschemasindexingmode.md - - docs/models/shared/apikeyauth.md - - docs/models/shared/destinationqdrantauthenticationmethod.md - - docs/models/shared/distancemetric.md - - docs/models/shared/destinationqdrantindexing.md - - docs/models/shared/destinationqdrantfieldnamemappingconfigmodel.md - - docs/models/shared/destinationqdrantlanguage.md - - docs/models/shared/destinationqdrantschemasprocessingtextsplittertextsplittermode.md - - docs/models/shared/destinationqdrantbyprogramminglanguage.md - - docs/models/shared/destinationqdrantschemasprocessingtextsplittermode.md - - docs/models/shared/destinationqdrantbymarkdownheader.md - - docs/models/shared/destinationqdrantschemasprocessingmode.md - - docs/models/shared/destinationqdrantbyseparator.md - - docs/models/shared/destinationqdranttextsplitter.md - - docs/models/shared/destinationqdrantprocessingconfigmodel.md - - docs/models/shared/destinationqdrant.md - - docs/models/shared/cachetype.md - - docs/models/shared/redis.md - - docs/models/shared/destinationredisschemasmode.md - - docs/models/shared/destinationredisverifyfull.md - - docs/models/shared/destinationredismode.md - - docs/models/shared/destinationredisdisable.md - - docs/models/shared/destinationredissslmodes.md - - docs/models/shared/destinationredisschemastunnelmethodtunnelmethod.md - - docs/models/shared/destinationredispasswordauthentication.md - - docs/models/shared/destinationredisschemastunnelmethod.md - - docs/models/shared/destinationredissshkeyauthentication.md - - docs/models/shared/destinationredistunnelmethod.md - - docs/models/shared/destinationredisnotunnel.md - - docs/models/shared/destinationredissshtunnelmethod.md - - docs/models/shared/destinationredis.md - - docs/models/shared/redshift.md - - docs/models/shared/destinationredshiftschemastunnelmethodtunnelmethod.md - - docs/models/shared/destinationredshiftpasswordauthentication.md - - docs/models/shared/destinationredshiftschemastunnelmethod.md - - docs/models/shared/destinationredshiftsshkeyauthentication.md - - docs/models/shared/destinationredshifttunnelmethod.md - - docs/models/shared/destinationredshiftnotunnel.md - - docs/models/shared/destinationredshiftsshtunnelmethod.md - - docs/models/shared/destinationredshiftschemasmethod.md - - docs/models/shared/standard.md - - docs/models/shared/destinationredshiftencryptiontype.md - - docs/models/shared/aescbcenvelopeencryption.md - - docs/models/shared/encryptiontype.md - - docs/models/shared/noencryption.md - - docs/models/shared/destinationredshiftencryption.md - - docs/models/shared/destinationredshiftmethod.md - - docs/models/shared/destinationredshifts3bucketregion.md - - docs/models/shared/awss3staging.md - - docs/models/shared/uploadingmethod.md - - docs/models/shared/destinationredshift.md - - docs/models/shared/s3.md - - docs/models/shared/destinations3schemascompressioncodec.md - - docs/models/shared/destinations3schemasformatoutputformatformattype.md - - docs/models/shared/destinations3parquetcolumnarstorage.md - - docs/models/shared/destinations3schemasformatoutputformat3compressioncodeccodec.md - - docs/models/shared/destinations3snappy.md - - docs/models/shared/destinations3schemasformatoutputformat3codec.md - - docs/models/shared/destinations3zstandard.md - - docs/models/shared/destinations3schemasformatoutputformatcodec.md - - docs/models/shared/destinations3xz.md - - docs/models/shared/destinations3schemasformatcodec.md - - docs/models/shared/destinations3bzip2.md - - docs/models/shared/destinations3schemascodec.md - - docs/models/shared/destinations3deflate.md - - docs/models/shared/destinations3codec.md - - docs/models/shared/destinations3schemasformatnocompression.md - - docs/models/shared/destinations3compressioncodec.md - - docs/models/shared/destinations3schemasformatformattype.md - - docs/models/shared/destinations3avroapacheavro.md - - docs/models/shared/destinations3schemasformatoutputformatcompressiontype.md - - docs/models/shared/destinations3schemasgzip.md - - docs/models/shared/destinations3schemasformatcompressiontype.md - - docs/models/shared/destinations3schemasnocompression.md - - docs/models/shared/destinations3schemascompression.md - - docs/models/shared/destinations3schemasflattening.md - - docs/models/shared/destinations3schemasformattype.md - - docs/models/shared/destinations3jsonlinesnewlinedelimitedjson.md - - docs/models/shared/destinations3schemascompressiontype.md - - docs/models/shared/destinations3gzip.md - - docs/models/shared/destinations3compressiontype.md - - docs/models/shared/destinations3nocompression.md - - docs/models/shared/destinations3compression.md - - docs/models/shared/destinations3flattening.md - - docs/models/shared/destinations3formattype.md - - docs/models/shared/destinations3csvcommaseparatedvalues.md - - docs/models/shared/destinations3outputformat.md - - docs/models/shared/destinations3s3bucketregion.md - - docs/models/shared/destinations3.md - - docs/models/shared/s3glue.md - - docs/models/shared/destinations3glueschemascompressiontype.md - - docs/models/shared/destinations3gluegzip.md - - docs/models/shared/destinations3gluecompressiontype.md - - docs/models/shared/destinations3gluenocompression.md - - docs/models/shared/destinations3gluecompression.md - - docs/models/shared/flattening.md - - docs/models/shared/destinations3glueformattype.md - - docs/models/shared/destinations3gluejsonlinesnewlinedelimitedjson.md - - docs/models/shared/destinations3glueoutputformat.md - - docs/models/shared/serializationlibrary.md - - docs/models/shared/destinations3glues3bucketregion.md - - docs/models/shared/destinations3glue.md - - docs/models/shared/sftpjson.md - - docs/models/shared/destinationsftpjson.md - - docs/models/shared/destinationsnowflakeschemasauthtype.md - - docs/models/shared/destinationsnowflakeoauth20.md - - docs/models/shared/destinationsnowflakeauthtype.md - - docs/models/shared/usernameandpassword.md - - docs/models/shared/destinationsnowflakeschemascredentialsauthtype.md - - docs/models/shared/keypairauthentication.md - - docs/models/shared/authorizationmethod.md - - docs/models/shared/destinationsnowflakesnowflake.md - - docs/models/shared/destinationsnowflake.md - - docs/models/shared/teradata.md - - docs/models/shared/destinationteradataschemassslmodesslmodes6mode.md - - docs/models/shared/destinationteradataverifyfull.md - - docs/models/shared/destinationteradataschemassslmodesslmodes5mode.md - - docs/models/shared/destinationteradataverifyca.md - - docs/models/shared/destinationteradataschemassslmodesslmodesmode.md - - docs/models/shared/destinationteradatarequire.md - - docs/models/shared/destinationteradataschemassslmodemode.md - - docs/models/shared/destinationteradataprefer.md - - docs/models/shared/destinationteradataschemasmode.md - - docs/models/shared/destinationteradataallow.md - - docs/models/shared/destinationteradatamode.md - - docs/models/shared/destinationteradatadisable.md - - docs/models/shared/destinationteradatasslmodes.md - - docs/models/shared/destinationteradata.md - - docs/models/shared/timeplus.md - - docs/models/shared/destinationtimeplus.md - - docs/models/shared/typesense.md - - docs/models/shared/destinationtypesense.md - - docs/models/shared/vectara.md - - docs/models/shared/oauth20credentials.md - - docs/models/shared/destinationvectara.md - - docs/models/shared/vertica.md - - docs/models/shared/destinationverticaschemastunnelmethodtunnelmethod.md - - docs/models/shared/destinationverticapasswordauthentication.md - - docs/models/shared/destinationverticaschemastunnelmethod.md - - docs/models/shared/destinationverticasshkeyauthentication.md - - docs/models/shared/destinationverticatunnelmethod.md - - docs/models/shared/destinationverticanotunnel.md - - docs/models/shared/destinationverticasshtunnelmethod.md - - docs/models/shared/destinationvertica.md - - docs/models/shared/weaviate.md - - docs/models/shared/destinationweaviateschemasembeddingembedding7mode.md - - docs/models/shared/destinationweaviateopenaicompatible.md - - docs/models/shared/destinationweaviateschemasembeddingembedding6mode.md - - docs/models/shared/destinationweaviatefake.md - - docs/models/shared/destinationweaviateschemasembeddingembedding5mode.md - - docs/models/shared/fromfield.md - - docs/models/shared/destinationweaviateschemasembeddingembeddingmode.md - - docs/models/shared/destinationweaviatecohere.md - - docs/models/shared/destinationweaviateschemasembeddingmode.md - - docs/models/shared/destinationweaviateopenai.md - - docs/models/shared/destinationweaviateschemasmode.md - - docs/models/shared/destinationweaviateazureopenai.md - - docs/models/shared/destinationweaviatemode.md - - docs/models/shared/noexternalembedding.md - - docs/models/shared/destinationweaviateembedding.md - - docs/models/shared/header.md - - docs/models/shared/destinationweaviateschemasindexingauthauthenticationmode.md - - docs/models/shared/noauthentication.md - - docs/models/shared/destinationweaviateschemasindexingauthmode.md - - docs/models/shared/destinationweaviateusernamepassword.md - - docs/models/shared/destinationweaviateschemasindexingmode.md - - docs/models/shared/destinationweaviateapitoken.md - - docs/models/shared/destinationweaviateauthentication.md - - docs/models/shared/defaultvectorizer.md - - docs/models/shared/destinationweaviateindexing.md - - docs/models/shared/destinationweaviatefieldnamemappingconfigmodel.md - - docs/models/shared/destinationweaviatelanguage.md - - docs/models/shared/destinationweaviateschemasprocessingtextsplittertextsplittermode.md - - docs/models/shared/destinationweaviatebyprogramminglanguage.md - - docs/models/shared/destinationweaviateschemasprocessingtextsplittermode.md - - docs/models/shared/destinationweaviatebymarkdownheader.md - - docs/models/shared/destinationweaviateschemasprocessingmode.md - - docs/models/shared/destinationweaviatebyseparator.md - - docs/models/shared/destinationweaviatetextsplitter.md - - docs/models/shared/destinationweaviateprocessingconfigmodel.md - - docs/models/shared/destinationweaviate.md - - docs/models/shared/xata.md - - docs/models/shared/destinationxata.md - - docs/models/shared/destinationcreaterequest.md - - docs/models/shared/destinationsresponse.md - - docs/models/shared/destinationpatchrequest.md - - docs/models/shared/destinationputrequest.md - - docs/models/shared/jobresponse.md - - docs/models/shared/jobstatusenum.md - - docs/models/shared/jobtypeenum.md - - docs/models/shared/jobcreaterequest.md - - docs/models/shared/jobsresponse.md - - docs/models/shared/sourceresponse.md - - docs/models/shared/sourceconfiguration.md - - docs/models/shared/aha.md - - docs/models/shared/sourceaha.md - - docs/models/shared/aircall.md - - docs/models/shared/sourceaircall.md - - docs/models/shared/sourceairtableauthmethod.md - - docs/models/shared/personalaccesstoken.md - - docs/models/shared/sourceairtableschemasauthmethod.md - - docs/models/shared/sourceairtableoauth20.md - - docs/models/shared/sourceairtableauthentication.md - - docs/models/shared/sourceairtableairtable.md - - docs/models/shared/sourceairtable.md - - docs/models/shared/sourceamazonadsauthtype.md - - docs/models/shared/region.md - - docs/models/shared/reportrecordtypes.md - - docs/models/shared/sourceamazonadsamazonads.md - - docs/models/shared/statefilter.md - - docs/models/shared/sourceamazonads.md - - docs/models/shared/awssellerpartneraccounttype.md - - docs/models/shared/sourceamazonsellerpartnerauthtype.md - - docs/models/shared/awsenvironment.md - - docs/models/shared/awsregion.md - - docs/models/shared/optionslist.md - - docs/models/shared/streamname.md - - docs/models/shared/reportoptions.md - - docs/models/shared/sourceamazonsellerpartneramazonsellerpartner.md - - docs/models/shared/sourceamazonsellerpartner.md - - docs/models/shared/sourceamazonsqsawsregion.md - - docs/models/shared/amazonsqs.md - - docs/models/shared/sourceamazonsqs.md - - docs/models/shared/dataregion.md - - docs/models/shared/amplitude.md - - docs/models/shared/sourceamplitude.md - - docs/models/shared/apifydataset.md - - docs/models/shared/sourceapifydataset.md - - docs/models/shared/appfollow.md - - docs/models/shared/sourceappfollow.md - - docs/models/shared/sourceasanaschemascredentialstitle.md - - docs/models/shared/authenticatewithpersonalaccesstoken.md - - docs/models/shared/sourceasanacredentialstitle.md - - docs/models/shared/authenticateviaasanaoauth.md - - docs/models/shared/authenticationmechanism.md - - docs/models/shared/sourceasanaasana.md - - docs/models/shared/sourceasana.md - - docs/models/shared/sourceauth0schemascredentialsauthenticationmethod.md - - docs/models/shared/oauth2accesstoken.md - - docs/models/shared/sourceauth0schemasauthenticationmethod.md - - docs/models/shared/oauth2confidentialapplication.md - - docs/models/shared/sourceauth0authenticationmethod.md - - docs/models/shared/auth0.md - - docs/models/shared/sourceauth0.md - - docs/models/shared/awscloudtrail.md - - docs/models/shared/sourceawscloudtrail.md - - docs/models/shared/sourceazureblobstorageazureblobstorage.md - - docs/models/shared/sourceazureblobstorageschemasstreamsformatfiletype.md - - docs/models/shared/sourceazureblobstoragemode.md - - docs/models/shared/local.md - - docs/models/shared/processing.md - - docs/models/shared/parsingstrategy.md - - docs/models/shared/documentfiletypeformatexperimental.md - - docs/models/shared/sourceazureblobstorageschemasstreamsfiletype.md - - docs/models/shared/parquetformat.md - - docs/models/shared/sourceazureblobstorageschemasfiletype.md - - docs/models/shared/jsonlformat.md - - docs/models/shared/sourceazureblobstoragefiletype.md - - docs/models/shared/sourceazureblobstorageschemasheaderdefinitiontype.md - - docs/models/shared/userprovided.md - - docs/models/shared/sourceazureblobstorageheaderdefinitiontype.md - - docs/models/shared/autogenerated.md - - docs/models/shared/headerdefinitiontype.md - - docs/models/shared/fromcsv.md - - docs/models/shared/csvheaderdefinition.md - - docs/models/shared/inferencetype.md - - docs/models/shared/csvformat.md - - docs/models/shared/sourceazureblobstorageschemasstreamsformatformatfiletype.md - - docs/models/shared/avroformat.md - - docs/models/shared/format.md - - docs/models/shared/validationpolicy.md - - docs/models/shared/filebasedstreamconfig.md - - docs/models/shared/sourceazureblobstorage.md - - docs/models/shared/azuretable.md - - docs/models/shared/sourceazuretable.md - - docs/models/shared/bamboohr.md - - docs/models/shared/sourcebamboohr.md - - docs/models/shared/sourcebigquerybigquery.md - - docs/models/shared/sourcebigquery.md - - docs/models/shared/operator.md - - docs/models/shared/accountnames.md - - docs/models/shared/authmethod.md - - docs/models/shared/reportingdataobject.md - - docs/models/shared/customreportconfig.md - - docs/models/shared/sourcebingadsbingads.md - - docs/models/shared/sourcebingads.md - - docs/models/shared/sourcebraintreeenvironment.md - - docs/models/shared/braintree.md - - docs/models/shared/sourcebraintree.md - - docs/models/shared/braze.md - - docs/models/shared/sourcebraze.md - - docs/models/shared/sourcecartschemasauthtype.md - - docs/models/shared/singlestoreaccesstoken.md - - docs/models/shared/sourcecartauthtype.md - - docs/models/shared/centralapirouter.md - - docs/models/shared/sourcecartauthorizationmethod.md - - docs/models/shared/cart.md - - docs/models/shared/sourcecart.md - - docs/models/shared/productcatalog.md - - docs/models/shared/chargebee.md - - docs/models/shared/sourcechargebee.md - - docs/models/shared/chartmogul.md - - docs/models/shared/sourcechartmogul.md - - docs/models/shared/sourceclickhouseclickhouse.md - - docs/models/shared/sourceclickhouseschemastunnelmethodtunnelmethod.md - - docs/models/shared/sourceclickhousepasswordauthentication.md - - docs/models/shared/sourceclickhouseschemastunnelmethod.md - - docs/models/shared/sourceclickhousesshkeyauthentication.md - - docs/models/shared/sourceclickhousetunnelmethod.md - - docs/models/shared/sourceclickhousenotunnel.md - - docs/models/shared/sourceclickhousesshtunnelmethod.md - - docs/models/shared/sourceclickhouse.md - - docs/models/shared/clickupapi.md - - docs/models/shared/sourceclickupapi.md - - docs/models/shared/clockify.md - - docs/models/shared/sourceclockify.md - - docs/models/shared/closecom.md - - docs/models/shared/sourceclosecom.md - - docs/models/shared/coda.md - - docs/models/shared/sourcecoda.md - - docs/models/shared/environment.md - - docs/models/shared/coinapi.md - - docs/models/shared/sourcecoinapi.md - - docs/models/shared/datatype.md - - docs/models/shared/coinmarketcap.md - - docs/models/shared/sourcecoinmarketcap.md - - docs/models/shared/configcat.md - - docs/models/shared/sourceconfigcat.md - - docs/models/shared/confluence.md - - docs/models/shared/sourceconfluence.md - - docs/models/shared/sourceconvexconvex.md - - docs/models/shared/sourceconvex.md - - docs/models/shared/datascope.md - - docs/models/shared/sourcedatascope.md - - docs/models/shared/delighted.md - - docs/models/shared/sourcedelighted.md - - docs/models/shared/dixa.md - - docs/models/shared/sourcedixa.md - - docs/models/shared/dockerhub.md - - docs/models/shared/sourcedockerhub.md - - docs/models/shared/dremio.md - - docs/models/shared/sourcedremio.md - - docs/models/shared/sourcedynamodbdynamodbregion.md - - docs/models/shared/sourcedynamodbdynamodb.md - - docs/models/shared/sourcedynamodb.md - - docs/models/shared/sourcee2etestcloudtype.md - - docs/models/shared/multischema.md - - docs/models/shared/sourcee2etestcloudschemastype.md - - docs/models/shared/singleschema.md - - docs/models/shared/mockcatalog.md - - docs/models/shared/e2etestcloud.md - - docs/models/shared/type.md - - docs/models/shared/continuousfeed.md - - docs/models/shared/sourcee2etestcloud.md - - docs/models/shared/emailoctopus.md - - docs/models/shared/sourceemailoctopus.md - - docs/models/shared/exchangerates.md - - docs/models/shared/sourceexchangerates.md - - docs/models/shared/validactionbreakdowns.md - - docs/models/shared/actionreporttime.md - - docs/models/shared/validbreakdowns.md - - docs/models/shared/sourcefacebookmarketingvalidenums.md - - docs/models/shared/level.md - - docs/models/shared/insightconfig.md - - docs/models/shared/sourcefacebookmarketingfacebookmarketing.md - - docs/models/shared/sourcefacebookmarketing.md - - docs/models/shared/faker.md - - docs/models/shared/sourcefaker.md - - docs/models/shared/sourcefaunaschemasdeletionmode.md - - docs/models/shared/enabled.md - - docs/models/shared/sourcefaunadeletionmode.md - - docs/models/shared/disabled.md - - docs/models/shared/deletionmode.md - - docs/models/shared/collection.md - - docs/models/shared/fauna.md - - docs/models/shared/sourcefauna.md - - docs/models/shared/fileformat.md - - docs/models/shared/sourcefileschemasproviderstorageprovider7storage.md - - docs/models/shared/sftpsecurefiletransferprotocol.md - - docs/models/shared/sourcefileschemasproviderstorageprovider6storage.md - - docs/models/shared/scpsecurecopyprotocol.md - - docs/models/shared/sourcefileschemasproviderstorageproviderstorage.md - - docs/models/shared/sshsecureshell.md - - docs/models/shared/sourcefileschemasproviderstorage.md - - docs/models/shared/azblobazureblobstorage.md - - docs/models/shared/sourcefileschemasstorage.md - - docs/models/shared/sourcefiles3amazonwebservices.md - - docs/models/shared/sourcefilestorage.md - - docs/models/shared/gcsgooglecloudstorage.md - - docs/models/shared/storage.md - - docs/models/shared/httpspublicweb.md - - docs/models/shared/storageprovider.md - - docs/models/shared/file.md - - docs/models/shared/sourcefile.md - - docs/models/shared/sourcefireboltfirebolt.md - - docs/models/shared/sourcefirebolt.md - - docs/models/shared/freshcaller.md - - docs/models/shared/sourcefreshcaller.md - - docs/models/shared/freshdesk.md - - docs/models/shared/sourcefreshdesk.md - - docs/models/shared/freshsales.md - - docs/models/shared/sourcefreshsales.md - - docs/models/shared/gainsightpx.md - - docs/models/shared/sourcegainsightpx.md - - docs/models/shared/sourcegcsgcs.md - - docs/models/shared/sourcegcsfiletype.md - - docs/models/shared/sourcegcsschemasstreamsheaderdefinitiontype.md - - docs/models/shared/sourcegcsuserprovided.md - - docs/models/shared/sourcegcsschemasheaderdefinitiontype.md - - docs/models/shared/sourcegcsautogenerated.md - - docs/models/shared/sourcegcsheaderdefinitiontype.md - - docs/models/shared/sourcegcsfromcsv.md - - docs/models/shared/sourcegcscsvheaderdefinition.md - - docs/models/shared/sourcegcsinferencetype.md - - docs/models/shared/sourcegcscsvformat.md - - docs/models/shared/sourcegcsformat.md - - docs/models/shared/sourcegcsvalidationpolicy.md - - docs/models/shared/sourcegcsstreamconfig.md - - docs/models/shared/sourcegcs.md - - docs/models/shared/getlago.md - - docs/models/shared/sourcegetlago.md - - docs/models/shared/sourcegithuboptiontitle.md - - docs/models/shared/sourcegithubpersonalaccesstoken.md - - docs/models/shared/optiontitle.md - - docs/models/shared/oauth.md - - docs/models/shared/sourcegithubauthentication.md - - docs/models/shared/sourcegithubgithub.md - - docs/models/shared/sourcegithub.md - - docs/models/shared/sourcegitlabschemasauthtype.md - - docs/models/shared/privatetoken.md - - docs/models/shared/sourcegitlabauthtype.md - - docs/models/shared/sourcegitlaboauth20.md - - docs/models/shared/sourcegitlabauthorizationmethod.md - - docs/models/shared/sourcegitlabgitlab.md - - docs/models/shared/sourcegitlab.md - - docs/models/shared/glassfrog.md - - docs/models/shared/sourceglassfrog.md - - docs/models/shared/country.md - - docs/models/shared/in_.md - - docs/models/shared/language.md - - docs/models/shared/nullable.md - - docs/models/shared/sortby.md - - docs/models/shared/gnews.md - - docs/models/shared/topheadlinestopic.md - - docs/models/shared/sourcegnews.md - - docs/models/shared/googlecredentials.md - - docs/models/shared/customqueriesarray.md - - docs/models/shared/customerstatus.md - - docs/models/shared/sourcegoogleadsgoogleads.md - - docs/models/shared/sourcegoogleads.md - - docs/models/shared/sourcegoogleanalyticsdataapischemasauthtype.md - - docs/models/shared/serviceaccountkeyauthentication.md - - docs/models/shared/sourcegoogleanalyticsdataapiauthtype.md - - docs/models/shared/authenticateviagoogleoauth.md - - docs/models/shared/sourcegoogleanalyticsdataapicredentials.md - - docs/models/shared/cohortreportsettings.md - - docs/models/shared/daterange.md - - docs/models/shared/dimension.md - - docs/models/shared/cohorts.md - - docs/models/shared/sourcegoogleanalyticsdataapigranularity.md - - docs/models/shared/cohortsrange.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayenabled.md - - docs/models/shared/sourcegoogleanalyticsdataapischemasenabled.md - - docs/models/shared/sourcegoogleanalyticsdataapienabled.md - - docs/models/shared/sourcegoogleanalyticsdataapidisabled.md - - docs/models/shared/cohortreports.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayfiltername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayvaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapidoublevalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemasvaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapiint64value.md - - docs/models/shared/fromvalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfiltervaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemasdoublevalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemasint64value.md - - docs/models/shared/tovalue.md - - docs/models/shared/betweenfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemasfiltername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemasvalidenums.md - - docs/models/shared/sourcegoogleanalyticsdataapivaluetype.md - - docs/models/shared/doublevalue.md - - docs/models/shared/valuetype.md - - docs/models/shared/int64value.md - - docs/models/shared/value.md - - docs/models/shared/numericfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapifiltername.md - - docs/models/shared/inlistfilter.md - - docs/models/shared/filtername.md - - docs/models/shared/sourcegoogleanalyticsdataapivalidenums.md - - docs/models/shared/stringfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemasfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayfiltertype.md - - docs/models/shared/filter_.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilterfiltername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfiltervaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressiondoublevalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfiltervaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionint64value.md - - docs/models/shared/sourcegoogleanalyticsdataapischemasfromvalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilter4tovaluevaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterdoublevalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilter4valuetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterint64value.md - - docs/models/shared/sourcegoogleanalyticsdataapischemastovalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemasbetweenfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfiltername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3validenums.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionvaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3doublevalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3valuetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3int64value.md - - docs/models/shared/sourcegoogleanalyticsdataapischemasvalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemasnumericfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfiltername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemasinlistfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3filtername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfiltervalidenums.md - - docs/models/shared/sourcegoogleanalyticsdataapischemasstringfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemasexpression.md - - docs/models/shared/sourcegoogleanalyticsdataapischemasfiltertype.md - - docs/models/shared/notexpression.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfiltername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfilterfiltervaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdoublevalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfiltervaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterint64value.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfromvalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfilterfilter4tovaluevaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterdoublevalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfilterfilter4valuetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterint64value.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltertovalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterbetweenfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2filtername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervalidenums.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsvaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2doublevalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2valuetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2int64value.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilternumericfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterfiltername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterinlistfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfiltername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2validenums.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterstringfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapiexpression.md - - docs/models/shared/sourcegoogleanalyticsdataapifiltertype.md - - docs/models/shared/orgroup.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilterfiltername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfiltervaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsdoublevalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfiltervaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsint64value.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayfromvalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilter4tovaluevaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterdoublevalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilter4valuetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterint64value.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraytovalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraybetweenfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfiltername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsvalidenums.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsvaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1doublevalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1valuetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1int64value.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayvalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraynumericfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfiltername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayinlistfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1filtername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1validenums.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraystringfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1filter.md - - docs/models/shared/expression.md - - docs/models/shared/filtertype.md - - docs/models/shared/andgroup.md - - docs/models/shared/dimensionsfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfiltername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtervaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterdoublevalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4valuetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterint64value.md - - docs/models/shared/sourcegoogleanalyticsdataapifromvalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfilter4valuetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterdoublevalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfiltervaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterint64value.md - - docs/models/shared/sourcegoogleanalyticsdataapitovalue.md - - docs/models/shared/sourcegoogleanalyticsdataapibetweenfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervalidenums.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydoublevalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayint64value.md - - docs/models/shared/sourcegoogleanalyticsdataapivalue.md - - docs/models/shared/sourcegoogleanalyticsdataapinumericfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfiltername.md - - docs/models/shared/sourcegoogleanalyticsdataapiinlistfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfiltername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayvalidenums.md - - docs/models/shared/sourcegoogleanalyticsdataapistringfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtertype.md - - docs/models/shared/sourcegoogleanalyticsdataapifilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilterfiltername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfiltervaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressiondoublevalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfiltervaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionint64value.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3fromvalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilter4tovaluevaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterdoublevalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilter4valuetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterint64value.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3tovalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3betweenfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfiltername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionvalidenums.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionvaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3doublevalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3valuetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3int64value.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3value.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3numericfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfiltername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3inlistfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filtername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3validenums.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3stringfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterexpression.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filtertype.md - - docs/models/shared/sourcegoogleanalyticsdataapinotexpression.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilterfiltername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfiltervaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsdoublevalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfiltervaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsint64value.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfromvalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilter4tovaluevaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterdoublevalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilter4valuetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterint64value.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltertovalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterbetweenfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfiltername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsvalidenums.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsvaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2doublevalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2valuetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2int64value.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilternumericfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfiltername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterinlistfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2filtername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2validenums.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterstringfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterexpression.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfiltertype.md - - docs/models/shared/sourcegoogleanalyticsdataapiorgroup.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfiltername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsvaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterdoublevalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1valuetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterint64value.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfromvalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfiltervaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1doublevalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfiltervaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1int64value.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltertovalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterbetweenfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1filtername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervalidenums.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilter3valuevaluetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsdoublevalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilter3valuetype.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsint64value.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervalue.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilternumericfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilterfiltername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterinlistfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfiltername.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1validenums.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterstringfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayexpression.md - - docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfiltertype.md - - docs/models/shared/sourcegoogleanalyticsdataapiandgroup.md - - docs/models/shared/metricsfilter.md - - docs/models/shared/sourcegoogleanalyticsdataapicustomreportconfig.md - - docs/models/shared/sourcegoogleanalyticsdataapigoogleanalyticsdataapi.md - - docs/models/shared/sourcegoogleanalyticsdataapi.md - - docs/models/shared/sourcegoogleanalyticsv4serviceaccountonlyauthtype.md - - docs/models/shared/sourcegoogleanalyticsv4serviceaccountonlyserviceaccountkeyauthentication.md - - docs/models/shared/sourcegoogleanalyticsv4serviceaccountonlycredentials.md - - docs/models/shared/googleanalyticsv4serviceaccountonly.md - - docs/models/shared/sourcegoogleanalyticsv4serviceaccountonly.md - - docs/models/shared/sourcegoogledirectoryschemascredentialstitle.md - - docs/models/shared/serviceaccountkey.md - - docs/models/shared/sourcegoogledirectorycredentialstitle.md - - docs/models/shared/signinviagoogleoauth.md - - docs/models/shared/sourcegoogledirectorygooglecredentials.md - - docs/models/shared/googledirectory.md - - docs/models/shared/sourcegoogledirectory.md - - docs/models/shared/sourcegoogledriveschemasauthtype.md - - docs/models/shared/sourcegoogledriveserviceaccountkeyauthentication.md - - docs/models/shared/sourcegoogledriveauthtype.md - - docs/models/shared/sourcegoogledriveauthenticateviagoogleoauth.md - - docs/models/shared/sourcegoogledriveauthentication.md - - docs/models/shared/sourcegoogledrivegoogledrive.md - - docs/models/shared/sourcegoogledriveschemasstreamsformatformatfiletype.md - - docs/models/shared/sourcegoogledrivemode.md - - docs/models/shared/sourcegoogledrivelocal.md - - docs/models/shared/sourcegoogledriveprocessing.md - - docs/models/shared/sourcegoogledriveparsingstrategy.md - - docs/models/shared/sourcegoogledrivedocumentfiletypeformatexperimental.md - - docs/models/shared/sourcegoogledriveschemasstreamsformatfiletype.md - - docs/models/shared/sourcegoogledriveparquetformat.md - - docs/models/shared/sourcegoogledriveschemasstreamsfiletype.md - - docs/models/shared/sourcegoogledrivejsonlformat.md - - docs/models/shared/sourcegoogledriveschemasfiletype.md - - docs/models/shared/sourcegoogledriveschemasstreamsheaderdefinitiontype.md - - docs/models/shared/sourcegoogledriveuserprovided.md - - docs/models/shared/sourcegoogledriveschemasheaderdefinitiontype.md - - docs/models/shared/sourcegoogledriveautogenerated.md - - docs/models/shared/sourcegoogledriveheaderdefinitiontype.md - - docs/models/shared/sourcegoogledrivefromcsv.md - - docs/models/shared/sourcegoogledrivecsvheaderdefinition.md - - docs/models/shared/sourcegoogledrivecsvformat.md - - docs/models/shared/sourcegoogledrivefiletype.md - - docs/models/shared/sourcegoogledriveavroformat.md - - docs/models/shared/sourcegoogledriveformat.md - - docs/models/shared/sourcegoogledrivevalidationpolicy.md - - docs/models/shared/sourcegoogledrivefilebasedstreamconfig.md - - docs/models/shared/sourcegoogledrive.md - - docs/models/shared/categories.md - - docs/models/shared/googlepagespeedinsights.md - - docs/models/shared/strategies.md - - docs/models/shared/sourcegooglepagespeedinsights.md - - docs/models/shared/sourcegooglesearchconsoleschemasauthtype.md - - docs/models/shared/sourcegooglesearchconsoleserviceaccountkeyauthentication.md - - docs/models/shared/sourcegooglesearchconsoleauthtype.md - - docs/models/shared/sourcegooglesearchconsoleoauth.md - - docs/models/shared/authenticationtype.md - - docs/models/shared/sourcegooglesearchconsolevalidenums.md - - docs/models/shared/sourcegooglesearchconsolecustomreportconfig.md - - docs/models/shared/datafreshness.md - - docs/models/shared/sourcegooglesearchconsolegooglesearchconsole.md - - docs/models/shared/sourcegooglesearchconsole.md - - docs/models/shared/sourcegooglesheetsschemasauthtype.md - - docs/models/shared/sourcegooglesheetsserviceaccountkeyauthentication.md - - docs/models/shared/sourcegooglesheetsauthtype.md - - docs/models/shared/sourcegooglesheetsauthenticateviagoogleoauth.md - - docs/models/shared/sourcegooglesheetsauthentication.md - - docs/models/shared/sourcegooglesheetsgooglesheets.md - - docs/models/shared/sourcegooglesheets.md - - docs/models/shared/googlewebfonts.md - - docs/models/shared/sourcegooglewebfonts.md - - docs/models/shared/googleworkspaceadminreports.md - - docs/models/shared/sourcegoogleworkspaceadminreports.md - - docs/models/shared/greenhouse.md - - docs/models/shared/sourcegreenhouse.md - - docs/models/shared/gridly.md - - docs/models/shared/sourcegridly.md - - docs/models/shared/sourceharvestschemasauthtype.md - - docs/models/shared/sourceharvestauthenticatewithpersonalaccesstoken.md - - docs/models/shared/sourceharvestauthtype.md - - docs/models/shared/authenticateviaharvestoauth.md - - docs/models/shared/sourceharvestauthenticationmechanism.md - - docs/models/shared/sourceharvestharvest.md - - docs/models/shared/sourceharvest.md - - docs/models/shared/hubplanner.md - - docs/models/shared/sourcehubplanner.md - - docs/models/shared/sourcehubspotschemasauthtype.md - - docs/models/shared/privateapp.md - - docs/models/shared/sourcehubspotauthtype.md - - docs/models/shared/sourcehubspotoauth.md - - docs/models/shared/sourcehubspotauthentication.md - - docs/models/shared/sourcehubspothubspot.md - - docs/models/shared/sourcehubspot.md - - docs/models/shared/insightly.md - - docs/models/shared/sourceinsightly.md - - docs/models/shared/sourceinstagraminstagram.md - - docs/models/shared/sourceinstagram.md - - docs/models/shared/instatus.md - - docs/models/shared/sourceinstatus.md - - docs/models/shared/sourceintercomintercom.md - - docs/models/shared/sourceintercom.md - - docs/models/shared/ip2whois.md - - docs/models/shared/sourceip2whois.md - - docs/models/shared/iterable.md - - docs/models/shared/sourceiterable.md - - docs/models/shared/issuesstreamexpandwith.md - - docs/models/shared/jira.md - - docs/models/shared/sourcejira.md - - docs/models/shared/k6cloud.md - - docs/models/shared/sourcek6cloud.md - - docs/models/shared/sourceklarnaregion.md - - docs/models/shared/klarna.md - - docs/models/shared/sourceklarna.md - - docs/models/shared/klaviyo.md - - docs/models/shared/sourceklaviyo.md - - docs/models/shared/kyve.md - - docs/models/shared/sourcekyve.md - - docs/models/shared/launchdarkly.md - - docs/models/shared/sourcelaunchdarkly.md - - docs/models/shared/lemlist.md - - docs/models/shared/sourcelemlist.md - - docs/models/shared/sourceleverhiringschemasauthtype.md - - docs/models/shared/authenticatevialeverapikey.md - - docs/models/shared/sourceleverhiringauthtype.md - - docs/models/shared/authenticatevialeveroauth.md - - docs/models/shared/sourceleverhiringauthenticationmechanism.md - - docs/models/shared/sourceleverhiringenvironment.md - - docs/models/shared/sourceleverhiringleverhiring.md - - docs/models/shared/sourceleverhiring.md - - docs/models/shared/pivotcategory.md - - docs/models/shared/timegranularity.md - - docs/models/shared/adanalyticsreportconfiguration.md - - docs/models/shared/sourcelinkedinadsschemasauthmethod.md - - docs/models/shared/accesstoken.md - - docs/models/shared/sourcelinkedinadsauthmethod.md - - docs/models/shared/sourcelinkedinadsoauth20.md - - docs/models/shared/sourcelinkedinadsauthentication.md - - docs/models/shared/sourcelinkedinadslinkedinads.md - - docs/models/shared/sourcelinkedinads.md - - docs/models/shared/sourcelinkedinpagesschemasauthmethod.md - - docs/models/shared/sourcelinkedinpagesaccesstoken.md - - docs/models/shared/sourcelinkedinpagesauthmethod.md - - docs/models/shared/sourcelinkedinpagesoauth20.md - - docs/models/shared/sourcelinkedinpagesauthentication.md - - docs/models/shared/linkedinpages.md - - docs/models/shared/sourcelinkedinpages.md - - docs/models/shared/lokalise.md - - docs/models/shared/sourcelokalise.md - - docs/models/shared/sourcemailchimpschemasauthtype.md - - docs/models/shared/apikey.md - - docs/models/shared/sourcemailchimpauthtype.md - - docs/models/shared/sourcemailchimpoauth20.md - - docs/models/shared/sourcemailchimpauthentication.md - - docs/models/shared/sourcemailchimpmailchimp.md - - docs/models/shared/sourcemailchimp.md - - docs/models/shared/mailgun.md - - docs/models/shared/sourcemailgun.md - - docs/models/shared/mailjetsms.md - - docs/models/shared/sourcemailjetsms.md - - docs/models/shared/marketo.md - - docs/models/shared/sourcemarketo.md - - docs/models/shared/metabase.md - - docs/models/shared/sourcemetabase.md - - docs/models/shared/sourcemicrosoftsharepointschemasauthtype.md - - docs/models/shared/servicekeyauthentication.md - - docs/models/shared/sourcemicrosoftsharepointauthtype.md - - docs/models/shared/authenticateviamicrosoftoauth.md - - docs/models/shared/sourcemicrosoftsharepointauthentication.md - - docs/models/shared/sourcemicrosoftsharepointmicrosoftsharepoint.md - - docs/models/shared/sourcemicrosoftsharepointschemasstreamsformatformatfiletype.md - - docs/models/shared/sourcemicrosoftsharepointmode.md - - docs/models/shared/sourcemicrosoftsharepointlocal.md - - docs/models/shared/sourcemicrosoftsharepointprocessing.md - - docs/models/shared/sourcemicrosoftsharepointparsingstrategy.md - - docs/models/shared/sourcemicrosoftsharepointdocumentfiletypeformatexperimental.md - - docs/models/shared/sourcemicrosoftsharepointschemasstreamsformatfiletype.md - - docs/models/shared/sourcemicrosoftsharepointparquetformat.md - - docs/models/shared/sourcemicrosoftsharepointschemasstreamsfiletype.md - - docs/models/shared/sourcemicrosoftsharepointjsonlformat.md - - docs/models/shared/sourcemicrosoftsharepointschemasfiletype.md - - docs/models/shared/sourcemicrosoftsharepointschemasstreamsheaderdefinitiontype.md - - docs/models/shared/sourcemicrosoftsharepointuserprovided.md - - docs/models/shared/sourcemicrosoftsharepointschemasheaderdefinitiontype.md - - docs/models/shared/sourcemicrosoftsharepointautogenerated.md - - docs/models/shared/sourcemicrosoftsharepointheaderdefinitiontype.md - - docs/models/shared/sourcemicrosoftsharepointfromcsv.md - - docs/models/shared/sourcemicrosoftsharepointcsvheaderdefinition.md - - docs/models/shared/sourcemicrosoftsharepointcsvformat.md - - docs/models/shared/sourcemicrosoftsharepointfiletype.md - - docs/models/shared/sourcemicrosoftsharepointavroformat.md - - docs/models/shared/sourcemicrosoftsharepointformat.md - - docs/models/shared/sourcemicrosoftsharepointvalidationpolicy.md - - docs/models/shared/sourcemicrosoftsharepointfilebasedstreamconfig.md - - docs/models/shared/sourcemicrosoftsharepoint.md - - docs/models/shared/sourcemicrosoftteamsschemasauthtype.md - - docs/models/shared/authenticateviamicrosoft.md - - docs/models/shared/sourcemicrosoftteamsauthtype.md - - docs/models/shared/authenticateviamicrosoftoauth20.md - - docs/models/shared/sourcemicrosoftteamsauthenticationmechanism.md - - docs/models/shared/sourcemicrosoftteamsmicrosoftteams.md - - docs/models/shared/sourcemicrosoftteams.md - - docs/models/shared/sourcemixpanelschemasoptiontitle.md - - docs/models/shared/projectsecret.md - - docs/models/shared/sourcemixpaneloptiontitle.md - - docs/models/shared/serviceaccount.md - - docs/models/shared/authenticationwildcard.md - - docs/models/shared/sourcemixpanelregion.md - - docs/models/shared/mixpanel.md - - docs/models/shared/sourcemixpanel.md - - docs/models/shared/sourcemondayschemasauthtype.md - - docs/models/shared/apitoken.md - - docs/models/shared/sourcemondayauthtype.md - - docs/models/shared/sourcemondayoauth20.md - - docs/models/shared/sourcemondayauthorizationmethod.md - - docs/models/shared/sourcemondaymonday.md - - docs/models/shared/sourcemonday.md - - docs/models/shared/mongodbinternalpoc.md - - docs/models/shared/sourcemongodbinternalpoc.md - - docs/models/shared/sourcemongodbv2schemasclustertype.md - - docs/models/shared/selfmanagedreplicaset.md - - docs/models/shared/sourcemongodbv2clustertype.md - - docs/models/shared/mongodbatlasreplicaset.md - - docs/models/shared/clustertype.md - - docs/models/shared/mongodbv2.md - - docs/models/shared/sourcemongodbv2.md - - docs/models/shared/sourcemssqlschemasmethod.md - - docs/models/shared/scanchangeswithuserdefinedcursor.md - - docs/models/shared/sourcemssqlmethod.md - - docs/models/shared/readchangesusingchangedatacapturecdc.md - - docs/models/shared/updatemethod.md - - docs/models/shared/sourcemssqlmssql.md - - docs/models/shared/sourcemssqlschemassslmethodsslmethodsslmethod.md - - docs/models/shared/sourcemssqlencryptedverifycertificate.md - - docs/models/shared/sourcemssqlschemassslmethodsslmethod.md - - docs/models/shared/sourcemssqlencryptedtrustservercertificate.md - - docs/models/shared/sourcemssqlschemassslmethod.md - - docs/models/shared/unencrypted.md - - docs/models/shared/sourcemssqlsslmethod.md - - docs/models/shared/sourcemssqlschemastunnelmethodtunnelmethod.md - - docs/models/shared/sourcemssqlpasswordauthentication.md - - docs/models/shared/sourcemssqlschemastunnelmethod.md - - docs/models/shared/sourcemssqlsshkeyauthentication.md - - docs/models/shared/sourcemssqltunnelmethod.md - - docs/models/shared/sourcemssqlnotunnel.md - - docs/models/shared/sourcemssqlsshtunnelmethod.md - - docs/models/shared/sourcemssql.md - - docs/models/shared/myhours.md - - docs/models/shared/sourcemyhours.md - - docs/models/shared/sourcemysqlschemasmethod.md - - docs/models/shared/sourcemysqlscanchangeswithuserdefinedcursor.md - - docs/models/shared/sourcemysqlmethod.md - - docs/models/shared/readchangesusingbinarylogcdc.md - - docs/models/shared/sourcemysqlupdatemethod.md - - docs/models/shared/sourcemysqlmysql.md - - docs/models/shared/sourcemysqlschemassslmodesslmodesmode.md - - docs/models/shared/verifyidentity.md - - docs/models/shared/sourcemysqlschemassslmodemode.md - - docs/models/shared/sourcemysqlverifyca.md - - docs/models/shared/sourcemysqlschemasmode.md - - docs/models/shared/required.md - - docs/models/shared/sourcemysqlmode.md - - docs/models/shared/preferred.md - - docs/models/shared/sourcemysqlsslmodes.md - - docs/models/shared/sourcemysqlschemastunnelmethodtunnelmethod.md - - docs/models/shared/sourcemysqlpasswordauthentication.md - - docs/models/shared/sourcemysqlschemastunnelmethod.md - - docs/models/shared/sourcemysqlsshkeyauthentication.md - - docs/models/shared/sourcemysqltunnelmethod.md - - docs/models/shared/sourcemysqlnotunnel.md - - docs/models/shared/sourcemysqlsshtunnelmethod.md - - docs/models/shared/sourcemysql.md - - docs/models/shared/netsuite.md - - docs/models/shared/sourcenetsuite.md - - docs/models/shared/sourcenotionschemasauthtype.md - - docs/models/shared/sourcenotionaccesstoken.md - - docs/models/shared/sourcenotionauthtype.md - - docs/models/shared/sourcenotionoauth20.md - - docs/models/shared/sourcenotionauthenticationmethod.md - - docs/models/shared/sourcenotionnotion.md - - docs/models/shared/sourcenotion.md - - docs/models/shared/periodusedformostpopularstreams.md - - docs/models/shared/sharetypeusedformostpopularsharedstream.md - - docs/models/shared/nytimes.md - - docs/models/shared/sourcenytimes.md - - docs/models/shared/sourceoktaschemasauthtype.md - - docs/models/shared/sourceoktaapitoken.md - - docs/models/shared/sourceoktaauthtype.md - - docs/models/shared/sourceoktaoauth20.md - - docs/models/shared/sourceoktaauthorizationmethod.md - - docs/models/shared/okta.md - - docs/models/shared/sourceokta.md - - docs/models/shared/omnisend.md - - docs/models/shared/sourceomnisend.md - - docs/models/shared/applications.md - - docs/models/shared/onesignal.md - - docs/models/shared/sourceonesignal.md - - docs/models/shared/sourceoracleconnectiontype.md - - docs/models/shared/systemidsid.md - - docs/models/shared/connectiontype.md - - docs/models/shared/servicename.md - - docs/models/shared/connectby.md - - docs/models/shared/sourceoracleencryptionmethod.md - - docs/models/shared/tlsencryptedverifycertificate.md - - docs/models/shared/encryptionalgorithm.md - - docs/models/shared/encryptionmethod.md - - docs/models/shared/nativenetworkencryptionnne.md - - docs/models/shared/encryption.md - - docs/models/shared/sourceoracleoracle.md - - docs/models/shared/sourceoracleschemastunnelmethodtunnelmethod.md - - docs/models/shared/sourceoraclepasswordauthentication.md - - docs/models/shared/sourceoracleschemastunnelmethod.md - - docs/models/shared/sourceoraclesshkeyauthentication.md - - docs/models/shared/sourceoracletunnelmethod.md - - docs/models/shared/sourceoraclenotunnel.md - - docs/models/shared/sourceoraclesshtunnelmethod.md - - docs/models/shared/sourceoracle.md - - docs/models/shared/orb.md - - docs/models/shared/sourceorb.md - - docs/models/shared/orbit.md - - docs/models/shared/sourceorbit.md - - docs/models/shared/bothusernameandpasswordisrequiredforauthenticationrequest.md - - docs/models/shared/sourceoutbrainamplifyusernamepassword.md - - docs/models/shared/accesstokenisrequiredforauthenticationrequests.md - - docs/models/shared/sourceoutbrainamplifyaccesstoken.md - - docs/models/shared/sourceoutbrainamplifyauthenticationmethod.md - - docs/models/shared/granularityforgeolocationregion.md - - docs/models/shared/granularityforperiodicreports.md - - docs/models/shared/outbrainamplify.md - - docs/models/shared/sourceoutbrainamplify.md - - docs/models/shared/outreach.md - - docs/models/shared/sourceoutreach.md - - docs/models/shared/paypaltransaction.md - - docs/models/shared/sourcepaypaltransaction.md - - docs/models/shared/paystack.md - - docs/models/shared/sourcepaystack.md - - docs/models/shared/pendo.md - - docs/models/shared/sourcependo.md - - docs/models/shared/persistiq.md - - docs/models/shared/sourcepersistiq.md - - docs/models/shared/pexelsapi.md - - docs/models/shared/sourcepexelsapi.md - - docs/models/shared/sourcepinterestauthmethod.md - - docs/models/shared/oauth20.md - - docs/models/shared/sourcepinterestvalidenums.md - - docs/models/shared/clickwindowdays.md - - docs/models/shared/sourcepinterestschemasvalidenums.md - - docs/models/shared/conversionreporttime.md - - docs/models/shared/engagementwindowdays.md - - docs/models/shared/granularity.md - - docs/models/shared/sourcepinterestlevel.md - - docs/models/shared/viewwindowdays.md - - docs/models/shared/reportconfig.md - - docs/models/shared/sourcepinterestpinterest.md - - docs/models/shared/status.md - - docs/models/shared/sourcepinterest.md - - docs/models/shared/pipedrive.md - - docs/models/shared/sourcepipedrive.md - - docs/models/shared/contenttype.md - - docs/models/shared/detailtype.md - - docs/models/shared/sourcepocketsortby.md - - docs/models/shared/pocket.md - - docs/models/shared/state.md - - docs/models/shared/sourcepocket.md - - docs/models/shared/pokemonname.md - - docs/models/shared/pokeapi.md - - docs/models/shared/sourcepokeapi.md - - docs/models/shared/polygonstockapi.md - - docs/models/shared/sourcepolygonstockapi.md - - docs/models/shared/sourcepostgresschemasreplicationmethodmethod.md - - docs/models/shared/sourcepostgresscanchangeswithuserdefinedcursor.md - - docs/models/shared/sourcepostgresschemasmethod.md - - docs/models/shared/detectchangeswithxminsystemcolumn.md - - docs/models/shared/lsncommitbehaviour.md - - docs/models/shared/sourcepostgresmethod.md - - docs/models/shared/plugin.md - - docs/models/shared/readchangesusingwriteaheadlogcdc.md - - docs/models/shared/sourcepostgresupdatemethod.md - - docs/models/shared/sourcepostgrespostgres.md - - docs/models/shared/sourcepostgresschemassslmodesslmodes6mode.md - - docs/models/shared/sourcepostgresverifyfull.md - - docs/models/shared/sourcepostgresschemassslmodesslmodes5mode.md - - docs/models/shared/sourcepostgresverifyca.md - - docs/models/shared/sourcepostgresschemassslmodesslmodesmode.md - - docs/models/shared/sourcepostgresrequire.md - - docs/models/shared/sourcepostgresschemassslmodemode.md - - docs/models/shared/sourcepostgresprefer.md - - docs/models/shared/sourcepostgresschemasmode.md - - docs/models/shared/sourcepostgresallow.md - - docs/models/shared/sourcepostgresmode.md - - docs/models/shared/sourcepostgresdisable.md - - docs/models/shared/sourcepostgressslmodes.md - - docs/models/shared/sourcepostgresschemastunnelmethodtunnelmethod.md - - docs/models/shared/sourcepostgrespasswordauthentication.md - - docs/models/shared/sourcepostgresschemastunnelmethod.md - - docs/models/shared/sourcepostgressshkeyauthentication.md - - docs/models/shared/sourcepostgrestunnelmethod.md - - docs/models/shared/sourcepostgresnotunnel.md - - docs/models/shared/sourcepostgressshtunnelmethod.md - - docs/models/shared/sourcepostgres.md - - docs/models/shared/posthog.md - - docs/models/shared/sourceposthog.md - - docs/models/shared/postmarkapp.md - - docs/models/shared/sourcepostmarkapp.md - - docs/models/shared/prestashop.md - - docs/models/shared/sourceprestashop.md - - docs/models/shared/punkapi.md - - docs/models/shared/sourcepunkapi.md - - docs/models/shared/pypi.md - - docs/models/shared/sourcepypi.md - - docs/models/shared/qualaroo.md - - docs/models/shared/sourcequalaroo.md - - docs/models/shared/sourcequickbooksauthtype.md - - docs/models/shared/sourcequickbooksoauth20.md - - docs/models/shared/sourcequickbooksauthorizationmethod.md - - docs/models/shared/quickbooks.md - - docs/models/shared/sourcequickbooks.md - - docs/models/shared/railz.md - - docs/models/shared/sourcerailz.md - - docs/models/shared/recharge.md - - docs/models/shared/sourcerecharge.md - - docs/models/shared/recreation.md - - docs/models/shared/sourcerecreation.md - - docs/models/shared/recruitee.md - - docs/models/shared/sourcerecruitee.md - - docs/models/shared/sourceredshiftredshift.md - - docs/models/shared/sourceredshift.md - - docs/models/shared/sourceretentlyschemasauthtype.md - - docs/models/shared/authenticatewithapitoken.md - - docs/models/shared/sourceretentlyauthtype.md - - docs/models/shared/authenticateviaretentlyoauth.md - - docs/models/shared/sourceretentlyauthenticationmechanism.md - - docs/models/shared/sourceretentlyretently.md - - docs/models/shared/sourceretently.md - - docs/models/shared/rkicovid.md - - docs/models/shared/sourcerkicovid.md - - docs/models/shared/rss.md - - docs/models/shared/sourcerss.md - - docs/models/shared/sources3schemasformatfiletype.md - - docs/models/shared/unexpectedfieldbehavior.md - - docs/models/shared/jsonl.md - - docs/models/shared/sources3schemasfiletype.md - - docs/models/shared/avro.md - - docs/models/shared/sources3filetype.md - - docs/models/shared/parquet.md - - docs/models/shared/sources3schemasformatfileformatfiletype.md - - docs/models/shared/csv.md - - docs/models/shared/sources3fileformat.md - - docs/models/shared/s3amazonwebservices.md - - docs/models/shared/sources3s3.md - - docs/models/shared/sources3schemasstreamsformatformat5filetype.md - - docs/models/shared/sources3mode.md - - docs/models/shared/sources3local.md - - docs/models/shared/sources3processing.md - - docs/models/shared/sources3parsingstrategy.md - - docs/models/shared/sources3documentfiletypeformatexperimental.md - - docs/models/shared/sources3schemasstreamsformatformat4filetype.md - - docs/models/shared/sources3parquetformat.md - - docs/models/shared/sources3schemasstreamsformatformatfiletype.md - - docs/models/shared/sources3jsonlformat.md - - docs/models/shared/sources3schemasstreamsformatfiletype.md - - docs/models/shared/sources3schemasstreamsheaderdefinitiontype.md - - docs/models/shared/sources3userprovided.md - - docs/models/shared/sources3schemasheaderdefinitiontype.md - - docs/models/shared/sources3autogenerated.md - - docs/models/shared/sources3headerdefinitiontype.md - - docs/models/shared/sources3fromcsv.md - - docs/models/shared/sources3csvheaderdefinition.md - - docs/models/shared/sources3inferencetype.md - - docs/models/shared/sources3csvformat.md - - docs/models/shared/sources3schemasstreamsfiletype.md - - docs/models/shared/sources3avroformat.md - - docs/models/shared/sources3format.md - - docs/models/shared/sources3validationpolicy.md - - docs/models/shared/sources3filebasedstreamconfig.md - - docs/models/shared/sources3.md - - docs/models/shared/authtype.md - - docs/models/shared/sourcesalesforcesalesforce.md - - docs/models/shared/searchcriteria.md - - docs/models/shared/streamscriteria.md - - docs/models/shared/sourcesalesforce.md - - docs/models/shared/sourcesalesloftschemasauthtype.md - - docs/models/shared/authenticateviaapikey.md - - docs/models/shared/sourcesalesloftauthtype.md - - docs/models/shared/authenticateviaoauth.md - - docs/models/shared/sourcesalesloftcredentials.md - - docs/models/shared/salesloft.md - - docs/models/shared/sourcesalesloft.md - - docs/models/shared/sapfieldglass.md - - docs/models/shared/sourcesapfieldglass.md - - docs/models/shared/secoda.md - - docs/models/shared/sourcesecoda.md - - docs/models/shared/sendgrid.md - - docs/models/shared/sourcesendgrid.md - - docs/models/shared/sendinblue.md - - docs/models/shared/sourcesendinblue.md - - docs/models/shared/senseforce.md - - docs/models/shared/sourcesenseforce.md - - docs/models/shared/sentry.md - - docs/models/shared/sourcesentry.md - - docs/models/shared/sourcesftpschemasauthmethod.md - - docs/models/shared/sourcesftpsshkeyauthentication.md - - docs/models/shared/sourcesftpauthmethod.md - - docs/models/shared/sourcesftppasswordauthentication.md - - docs/models/shared/sourcesftpauthentication.md - - docs/models/shared/sftp.md - - docs/models/shared/sourcesftp.md - - docs/models/shared/filetype.md - - docs/models/shared/sftpbulk.md - - docs/models/shared/sourcesftpbulk.md - - docs/models/shared/sourceshopifyschemasauthmethod.md - - docs/models/shared/apipassword.md - - docs/models/shared/sourceshopifyauthmethod.md - - docs/models/shared/sourceshopifyoauth20.md - - docs/models/shared/shopifyauthorizationmethod.md - - docs/models/shared/sourceshopifyshopify.md - - docs/models/shared/sourceshopify.md - - docs/models/shared/shortio.md - - docs/models/shared/sourceshortio.md - - docs/models/shared/sourceslackschemasoptiontitle.md - - docs/models/shared/sourceslackapitoken.md - - docs/models/shared/sourceslackoptiontitle.md - - docs/models/shared/signinviaslackoauth.md - - docs/models/shared/sourceslackauthenticationmechanism.md - - docs/models/shared/sourceslackslack.md - - docs/models/shared/sourceslack.md - - docs/models/shared/smaily.md - - docs/models/shared/sourcesmaily.md - - docs/models/shared/smartengage.md - - docs/models/shared/sourcesmartengage.md - - docs/models/shared/sourcesmartsheetsschemasauthtype.md - - docs/models/shared/apiaccesstoken.md - - docs/models/shared/sourcesmartsheetsauthtype.md - - docs/models/shared/sourcesmartsheetsoauth20.md - - docs/models/shared/sourcesmartsheetsauthorizationmethod.md - - docs/models/shared/validenums.md - - docs/models/shared/sourcesmartsheetssmartsheets.md - - docs/models/shared/sourcesmartsheets.md - - docs/models/shared/sourcesnapchatmarketingsnapchatmarketing.md - - docs/models/shared/sourcesnapchatmarketing.md - - docs/models/shared/sourcesnowflakeschemasauthtype.md - - docs/models/shared/sourcesnowflakeusernameandpassword.md - - docs/models/shared/sourcesnowflakeauthtype.md - - docs/models/shared/sourcesnowflakeoauth20.md - - docs/models/shared/sourcesnowflakeauthorizationmethod.md - - docs/models/shared/sourcesnowflakesnowflake.md - - docs/models/shared/sourcesnowflake.md - - docs/models/shared/sonarcloud.md - - docs/models/shared/sourcesonarcloud.md - - docs/models/shared/spacexapi.md - - docs/models/shared/sourcespacexapi.md - - docs/models/shared/sourcesquareschemasauthtype.md - - docs/models/shared/sourcesquareapikey.md - - docs/models/shared/sourcesquareauthtype.md - - docs/models/shared/oauthauthentication.md - - docs/models/shared/sourcesquareauthentication.md - - docs/models/shared/sourcesquaresquare.md - - docs/models/shared/sourcesquare.md - - docs/models/shared/sourcestravaauthtype.md - - docs/models/shared/sourcestravastrava.md - - docs/models/shared/sourcestrava.md - - docs/models/shared/stripe.md - - docs/models/shared/sourcestripe.md - - docs/models/shared/sourcesurveysparrowurlbase.md - - docs/models/shared/globalaccount.md - - docs/models/shared/urlbase.md - - docs/models/shared/eubasedaccount.md - - docs/models/shared/baseurl.md - - docs/models/shared/surveysparrow.md - - docs/models/shared/sourcesurveysparrow.md - - docs/models/shared/sourcesurveymonkeyauthmethod.md - - docs/models/shared/surveymonkeyauthorizationmethod.md - - docs/models/shared/origindatacenterofthesurveymonkeyaccount.md - - docs/models/shared/sourcesurveymonkeysurveymonkey.md - - docs/models/shared/sourcesurveymonkey.md - - docs/models/shared/tempo.md - - docs/models/shared/sourcetempo.md - - docs/models/shared/theguardianapi.md - - docs/models/shared/sourcetheguardianapi.md - - docs/models/shared/sourcetiktokmarketingschemasauthtype.md - - docs/models/shared/sandboxaccesstoken.md - - docs/models/shared/sourcetiktokmarketingauthtype.md - - docs/models/shared/sourcetiktokmarketingoauth20.md - - docs/models/shared/sourcetiktokmarketingauthenticationmethod.md - - docs/models/shared/sourcetiktokmarketingtiktokmarketing.md - - docs/models/shared/sourcetiktokmarketing.md - - docs/models/shared/trello.md - - docs/models/shared/sourcetrello.md - - docs/models/shared/sourcetrustpilotschemasauthtype.md - - docs/models/shared/sourcetrustpilotapikey.md - - docs/models/shared/sourcetrustpilotauthtype.md - - docs/models/shared/sourcetrustpilotoauth20.md - - docs/models/shared/sourcetrustpilotauthorizationmethod.md - - docs/models/shared/trustpilot.md - - docs/models/shared/sourcetrustpilot.md - - docs/models/shared/tvmazeschedule.md - - docs/models/shared/sourcetvmazeschedule.md - - docs/models/shared/twilio.md - - docs/models/shared/sourcetwilio.md - - docs/models/shared/twiliotaskrouter.md - - docs/models/shared/sourcetwiliotaskrouter.md - - docs/models/shared/twitter.md - - docs/models/shared/sourcetwitter.md - - docs/models/shared/sourcetypeformschemasauthtype.md - - docs/models/shared/sourcetypeformprivatetoken.md - - docs/models/shared/sourcetypeformauthtype.md - - docs/models/shared/sourcetypeformoauth20.md - - docs/models/shared/sourcetypeformauthorizationmethod.md - - docs/models/shared/sourcetypeformtypeform.md - - docs/models/shared/sourcetypeform.md - - docs/models/shared/uscensus.md - - docs/models/shared/sourceuscensus.md - - docs/models/shared/vantage.md - - docs/models/shared/sourcevantage.md - - docs/models/shared/webflow.md - - docs/models/shared/sourcewebflow.md - - docs/models/shared/whiskyhunter.md - - docs/models/shared/sourcewhiskyhunter.md - - docs/models/shared/wikipediapageviews.md - - docs/models/shared/sourcewikipediapageviews.md - - docs/models/shared/woocommerce.md - - docs/models/shared/sourcewoocommerce.md - - docs/models/shared/xkcd.md - - docs/models/shared/sourcexkcd.md - - docs/models/shared/yandexmetrica.md - - docs/models/shared/sourceyandexmetrica.md - - docs/models/shared/yotpo.md - - docs/models/shared/sourceyotpo.md - - docs/models/shared/authenticateviaoauth20.md - - docs/models/shared/sourceyoutubeanalyticsyoutubeanalytics.md - - docs/models/shared/sourceyoutubeanalytics.md - - docs/models/shared/sourcezendeskchatschemascredentials.md - - docs/models/shared/sourcezendeskchataccesstoken.md - - docs/models/shared/sourcezendeskchatcredentials.md - - docs/models/shared/sourcezendeskchatoauth20.md - - docs/models/shared/sourcezendeskchatauthorizationmethod.md - - docs/models/shared/sourcezendeskchatzendeskchat.md - - docs/models/shared/sourcezendeskchat.md - - docs/models/shared/zendesksell.md - - docs/models/shared/sourcezendesksell.md - - docs/models/shared/sourcezendesksunshineschemasauthmethod.md - - docs/models/shared/sourcezendesksunshineapitoken.md - - docs/models/shared/sourcezendesksunshineauthmethod.md - - docs/models/shared/sourcezendesksunshineoauth20.md - - docs/models/shared/sourcezendesksunshineauthorizationmethod.md - - docs/models/shared/sourcezendesksunshinezendesksunshine.md - - docs/models/shared/sourcezendesksunshine.md - - docs/models/shared/sourcezendesksupportschemascredentials.md - - docs/models/shared/sourcezendesksupportapitoken.md - - docs/models/shared/sourcezendesksupportcredentials.md - - docs/models/shared/sourcezendesksupportoauth20.md - - docs/models/shared/sourcezendesksupportauthentication.md - - docs/models/shared/sourcezendesksupportzendesksupport.md - - docs/models/shared/sourcezendesksupport.md - - docs/models/shared/sourcezendesktalkschemasauthtype.md - - docs/models/shared/sourcezendesktalkoauth20.md - - docs/models/shared/sourcezendesktalkauthtype.md - - docs/models/shared/sourcezendesktalkapitoken.md - - docs/models/shared/sourcezendesktalkauthentication.md - - docs/models/shared/sourcezendesktalkzendesktalk.md - - docs/models/shared/sourcezendesktalk.md - - docs/models/shared/zenloop.md - - docs/models/shared/sourcezenloop.md - - docs/models/shared/datacenterlocation.md - - docs/models/shared/zohocrmedition.md - - docs/models/shared/sourcezohocrmenvironment.md - - docs/models/shared/zohocrm.md - - docs/models/shared/sourcezohocrm.md - - docs/models/shared/zoom.md - - docs/models/shared/sourcezoom.md - - docs/models/shared/sourcecreaterequest.md - - docs/models/shared/initiateoauthrequest.md - - docs/models/shared/oauthactornames.md - - docs/models/shared/oauthinputconfiguration.md - - docs/models/shared/sourcesresponse.md - - docs/models/shared/sourcepatchrequest.md - - docs/models/shared/sourceputrequest.md - - docs/models/shared/streampropertiesresponse.md - - docs/models/shared/streamproperties.md - - docs/models/shared/workspaceoauthcredentialsrequest.md - - docs/models/shared/oauthcredentialsconfiguration.md - - docs/models/shared/credentials.md - - docs/models/shared/airtable.md - - docs/models/shared/amazonads.md - - docs/models/shared/amazonsellerpartner.md - - docs/models/shared/asanacredentials.md - - docs/models/shared/asana.md - - docs/models/shared/bingads.md - - docs/models/shared/facebookmarketing.md - - docs/models/shared/githubcredentials.md - - docs/models/shared/github.md - - docs/models/shared/gitlabcredentials.md - - docs/models/shared/gitlab.md - - docs/models/shared/googleadscredentials.md - - docs/models/shared/googleads.md - - docs/models/shared/googleanalyticsdataapicredentials.md - - docs/models/shared/googleanalyticsdataapi.md - - docs/models/shared/googledrivecredentials.md - - docs/models/shared/googledrive.md - - docs/models/shared/authorization.md - - docs/models/shared/googlesearchconsole.md - - docs/models/shared/googlesheetscredentials.md - - docs/models/shared/googlesheets.md - - docs/models/shared/harvestcredentials.md - - docs/models/shared/harvest.md - - docs/models/shared/hubspotcredentials.md - - docs/models/shared/hubspot.md - - docs/models/shared/instagram.md - - docs/models/shared/intercom.md - - docs/models/shared/leverhiringcredentials.md - - docs/models/shared/leverhiring.md - - docs/models/shared/linkedinadscredentials.md - - docs/models/shared/linkedinads.md - - docs/models/shared/mailchimpcredentials.md - - docs/models/shared/mailchimp.md - - docs/models/shared/microsoftsharepointcredentials.md - - docs/models/shared/microsoftsharepoint.md - - docs/models/shared/microsoftteamscredentials.md - - docs/models/shared/microsoftteams.md - - docs/models/shared/mondaycredentials.md - - docs/models/shared/monday.md - - docs/models/shared/notioncredentials.md - - docs/models/shared/notion.md - - docs/models/shared/pinterestcredentials.md - - docs/models/shared/pinterest.md - - docs/models/shared/retentlycredentials.md - - docs/models/shared/retently.md - - docs/models/shared/salesforce.md - - docs/models/shared/shopifycredentials.md - - docs/models/shared/shopify.md - - docs/models/shared/slackcredentials.md - - docs/models/shared/slack.md - - docs/models/shared/smartsheetscredentials.md - - docs/models/shared/smartsheets.md - - docs/models/shared/snapchatmarketing.md - - docs/models/shared/snowflakecredentials.md - - docs/models/shared/snowflake.md - - docs/models/shared/squarecredentials.md - - docs/models/shared/square.md - - docs/models/shared/strava.md - - docs/models/shared/surveymonkeycredentials.md - - docs/models/shared/surveymonkey.md - - docs/models/shared/tiktokmarketingcredentials.md - - docs/models/shared/tiktokmarketing.md - - docs/models/shared/typeformcredentials.md - - docs/models/shared/typeform.md - - docs/models/shared/youtubeanalyticscredentials.md - - docs/models/shared/youtubeanalytics.md - - docs/models/shared/zendeskchatcredentials.md - - docs/models/shared/zendeskchat.md - - docs/models/shared/zendesksunshinecredentials.md - - docs/models/shared/zendesksunshine.md - - docs/models/shared/zendesksupportcredentials.md - - docs/models/shared/zendesksupport.md - - docs/models/shared/zendesktalkcredentials.md - - docs/models/shared/zendesktalk.md - - docs/models/shared/actortypeenum.md - - docs/models/shared/workspaceresponse.md - - docs/models/shared/workspacecreaterequest.md - - docs/models/shared/workspacesresponse.md - - docs/models/shared/workspaceupdaterequest.md - - docs/models/shared/security.md - - docs/models/shared/schemebasicauth.md - - docs/sdks/airbyte/README.md + - src/airbyte_api/api/createconnection.py + - src/airbyte_api/api/deleteconnection.py + - src/airbyte_api/api/getconnection.py + - src/airbyte_api/api/listconnections.py + - src/airbyte_api/api/patchconnection.py + - src/airbyte_api/api/createdestination.py + - src/airbyte_api/api/deletedestination.py + - src/airbyte_api/api/getdestination.py + - src/airbyte_api/api/listdestinations.py + - src/airbyte_api/api/patchdestination.py + - src/airbyte_api/api/putdestination.py + - src/airbyte_api/api/canceljob.py + - src/airbyte_api/api/createjob.py + - src/airbyte_api/api/getjob.py + - src/airbyte_api/api/listjobs.py + - src/airbyte_api/api/createsource.py + - src/airbyte_api/api/deletesource.py + - src/airbyte_api/api/getsource.py + - src/airbyte_api/api/initiateoauth.py + - src/airbyte_api/api/listsources.py + - src/airbyte_api/api/patchsource.py + - src/airbyte_api/api/putsource.py + - src/airbyte_api/api/getstreamproperties.py + - src/airbyte_api/api/createorupdateworkspaceoauthcredentials.py + - src/airbyte_api/api/createworkspace.py + - src/airbyte_api/api/deleteworkspace.py + - src/airbyte_api/api/getworkspace.py + - src/airbyte_api/api/listworkspaces.py + - src/airbyte_api/api/updateworkspace.py + - src/airbyte_api/models/connectionresponse.py + - src/airbyte_api/models/connectionstatusenum.py + - src/airbyte_api/models/connectionscheduleresponse.py + - src/airbyte_api/models/scheduletypewithbasicenum.py + - src/airbyte_api/models/nonbreakingschemaupdatesbehaviorenum.py + - src/airbyte_api/models/namespacedefinitionenum.py + - src/airbyte_api/models/geographyenum.py + - src/airbyte_api/models/streamconfigurations.py + - src/airbyte_api/models/streamconfiguration.py + - src/airbyte_api/models/connectionsyncmodeenum.py + - src/airbyte_api/models/connectioncreaterequest.py + - src/airbyte_api/models/connectionschedule.py + - src/airbyte_api/models/scheduletypeenum.py + - src/airbyte_api/models/connectionsresponse.py + - src/airbyte_api/models/connectionpatchrequest.py + - src/airbyte_api/models/nonbreakingschemaupdatesbehaviorenumnodefault.py + - src/airbyte_api/models/namespacedefinitionenumnodefault.py + - src/airbyte_api/models/geographyenumnodefault.py + - src/airbyte_api/models/destinationresponse.py + - src/airbyte_api/models/destination_google_sheets.py + - src/airbyte_api/models/destination_astra.py + - src/airbyte_api/models/destination_aws_datalake.py + - src/airbyte_api/models/destination_azure_blob_storage.py + - src/airbyte_api/models/destination_bigquery.py + - src/airbyte_api/models/destination_clickhouse.py + - src/airbyte_api/models/destination_convex.py + - src/airbyte_api/models/destination_databricks.py + - src/airbyte_api/models/destination_dev_null.py + - src/airbyte_api/models/destination_duckdb.py + - src/airbyte_api/models/destination_dynamodb.py + - src/airbyte_api/models/destination_elasticsearch.py + - src/airbyte_api/models/destination_firestore.py + - src/airbyte_api/models/destination_gcs.py + - src/airbyte_api/models/destination_langchain.py + - src/airbyte_api/models/destination_milvus.py + - src/airbyte_api/models/destination_mongodb.py + - src/airbyte_api/models/destination_mssql.py + - src/airbyte_api/models/destination_mysql.py + - src/airbyte_api/models/destination_oracle.py + - src/airbyte_api/models/destination_pinecone.py + - src/airbyte_api/models/destination_postgres.py + - src/airbyte_api/models/destination_pubsub.py + - src/airbyte_api/models/destination_qdrant.py + - src/airbyte_api/models/destination_redis.py + - src/airbyte_api/models/destination_redshift.py + - src/airbyte_api/models/destination_s3.py + - src/airbyte_api/models/destination_s3_glue.py + - src/airbyte_api/models/destination_sftp_json.py + - src/airbyte_api/models/destination_snowflake.py + - src/airbyte_api/models/destination_teradata.py + - src/airbyte_api/models/destination_typesense.py + - src/airbyte_api/models/destination_vectara.py + - src/airbyte_api/models/destination_weaviate.py + - src/airbyte_api/models/destinationcreaterequest.py + - src/airbyte_api/models/destinationsresponse.py + - src/airbyte_api/models/destinationpatchrequest.py + - src/airbyte_api/models/destinationputrequest.py + - src/airbyte_api/models/jobresponse.py + - src/airbyte_api/models/jobstatusenum.py + - src/airbyte_api/models/jobtypeenum.py + - src/airbyte_api/models/jobcreaterequest.py + - src/airbyte_api/models/jobsresponse.py + - src/airbyte_api/models/sourceresponse.py + - src/airbyte_api/models/source_aha.py + - src/airbyte_api/models/source_aircall.py + - src/airbyte_api/models/source_airtable.py + - src/airbyte_api/models/source_amazon_ads.py + - src/airbyte_api/models/source_amazon_seller_partner.py + - src/airbyte_api/models/source_amazon_sqs.py + - src/airbyte_api/models/source_amplitude.py + - src/airbyte_api/models/source_apify_dataset.py + - src/airbyte_api/models/source_appfollow.py + - src/airbyte_api/models/source_asana.py + - src/airbyte_api/models/source_auth0.py + - src/airbyte_api/models/source_aws_cloudtrail.py + - src/airbyte_api/models/source_azure_blob_storage.py + - src/airbyte_api/models/source_azure_table.py + - src/airbyte_api/models/source_bamboo_hr.py + - src/airbyte_api/models/source_bigquery.py + - src/airbyte_api/models/source_bing_ads.py + - src/airbyte_api/models/source_braintree.py + - src/airbyte_api/models/source_braze.py + - src/airbyte_api/models/source_cart.py + - src/airbyte_api/models/source_chargebee.py + - src/airbyte_api/models/source_chartmogul.py + - src/airbyte_api/models/source_clickhouse.py + - src/airbyte_api/models/source_clickup_api.py + - src/airbyte_api/models/source_clockify.py + - src/airbyte_api/models/source_close_com.py + - src/airbyte_api/models/source_coda.py + - src/airbyte_api/models/source_coin_api.py + - src/airbyte_api/models/source_coinmarketcap.py + - src/airbyte_api/models/source_configcat.py + - src/airbyte_api/models/source_confluence.py + - src/airbyte_api/models/source_convex.py + - src/airbyte_api/models/source_datascope.py + - src/airbyte_api/models/source_delighted.py + - src/airbyte_api/models/source_dixa.py + - src/airbyte_api/models/source_dockerhub.py + - src/airbyte_api/models/source_dremio.py + - src/airbyte_api/models/source_dynamodb.py + - src/airbyte_api/models/source_e2e_test_cloud.py + - src/airbyte_api/models/source_emailoctopus.py + - src/airbyte_api/models/source_exchange_rates.py + - src/airbyte_api/models/source_facebook_marketing.py + - src/airbyte_api/models/source_faker.py + - src/airbyte_api/models/source_fauna.py + - src/airbyte_api/models/source_file.py + - src/airbyte_api/models/source_firebolt.py + - src/airbyte_api/models/source_freshcaller.py + - src/airbyte_api/models/source_freshdesk.py + - src/airbyte_api/models/source_freshsales.py + - src/airbyte_api/models/source_gainsight_px.py + - src/airbyte_api/models/source_gcs.py + - src/airbyte_api/models/source_getlago.py + - src/airbyte_api/models/source_github.py + - src/airbyte_api/models/source_gitlab.py + - src/airbyte_api/models/source_glassfrog.py + - src/airbyte_api/models/source_gnews.py + - src/airbyte_api/models/source_google_ads.py + - src/airbyte_api/models/source_google_analytics_data_api.py + - src/airbyte_api/models/source_google_analytics_v4_service_account_only.py + - src/airbyte_api/models/source_google_directory.py + - src/airbyte_api/models/source_google_drive.py + - src/airbyte_api/models/source_google_pagespeed_insights.py + - src/airbyte_api/models/source_google_search_console.py + - src/airbyte_api/models/source_google_sheets.py + - src/airbyte_api/models/source_google_webfonts.py + - src/airbyte_api/models/source_greenhouse.py + - src/airbyte_api/models/source_gridly.py + - src/airbyte_api/models/source_harvest.py + - src/airbyte_api/models/source_hubplanner.py + - src/airbyte_api/models/source_hubspot.py + - src/airbyte_api/models/source_insightly.py + - src/airbyte_api/models/source_instagram.py + - src/airbyte_api/models/source_instatus.py + - src/airbyte_api/models/source_intercom.py + - src/airbyte_api/models/source_ip2whois.py + - src/airbyte_api/models/source_iterable.py + - src/airbyte_api/models/source_jira.py + - src/airbyte_api/models/source_k6_cloud.py + - src/airbyte_api/models/source_klarna.py + - src/airbyte_api/models/source_klaviyo.py + - src/airbyte_api/models/source_kyve.py + - src/airbyte_api/models/source_launchdarkly.py + - src/airbyte_api/models/source_lemlist.py + - src/airbyte_api/models/source_lever_hiring.py + - src/airbyte_api/models/source_linkedin_ads.py + - src/airbyte_api/models/source_linkedin_pages.py + - src/airbyte_api/models/source_linnworks.py + - src/airbyte_api/models/source_lokalise.py + - src/airbyte_api/models/source_mailchimp.py + - src/airbyte_api/models/source_mailgun.py + - src/airbyte_api/models/source_mailjet_sms.py + - src/airbyte_api/models/source_marketo.py + - src/airbyte_api/models/source_metabase.py + - src/airbyte_api/models/source_microsoft_onedrive.py + - src/airbyte_api/models/source_microsoft_sharepoint.py + - src/airbyte_api/models/source_microsoft_teams.py + - src/airbyte_api/models/source_mixpanel.py + - src/airbyte_api/models/source_monday.py + - src/airbyte_api/models/source_mongodb_internal_poc.py + - src/airbyte_api/models/source_mongodb_v2.py + - src/airbyte_api/models/source_mssql.py + - src/airbyte_api/models/source_my_hours.py + - src/airbyte_api/models/source_mysql.py + - src/airbyte_api/models/source_netsuite.py + - src/airbyte_api/models/source_notion.py + - src/airbyte_api/models/source_nytimes.py + - src/airbyte_api/models/source_okta.py + - src/airbyte_api/models/source_omnisend.py + - src/airbyte_api/models/source_onesignal.py + - src/airbyte_api/models/source_oracle.py + - src/airbyte_api/models/source_orb.py + - src/airbyte_api/models/source_orbit.py + - src/airbyte_api/models/source_outbrain_amplify.py + - src/airbyte_api/models/source_outreach.py + - src/airbyte_api/models/source_paypal_transaction.py + - src/airbyte_api/models/source_paystack.py + - src/airbyte_api/models/source_pendo.py + - src/airbyte_api/models/source_persistiq.py + - src/airbyte_api/models/source_pexels_api.py + - src/airbyte_api/models/source_pinterest.py + - src/airbyte_api/models/source_pipedrive.py + - src/airbyte_api/models/source_pocket.py + - src/airbyte_api/models/source_pokeapi.py + - src/airbyte_api/models/source_polygon_stock_api.py + - src/airbyte_api/models/source_postgres.py + - src/airbyte_api/models/source_posthog.py + - src/airbyte_api/models/source_postmarkapp.py + - src/airbyte_api/models/source_prestashop.py + - src/airbyte_api/models/source_punk_api.py + - src/airbyte_api/models/source_pypi.py + - src/airbyte_api/models/source_qualaroo.py + - src/airbyte_api/models/source_quickbooks.py + - src/airbyte_api/models/source_railz.py + - src/airbyte_api/models/source_recharge.py + - src/airbyte_api/models/source_recreation.py + - src/airbyte_api/models/source_recruitee.py + - src/airbyte_api/models/source_recurly.py + - src/airbyte_api/models/source_redshift.py + - src/airbyte_api/models/source_retently.py + - src/airbyte_api/models/source_rki_covid.py + - src/airbyte_api/models/source_rss.py + - src/airbyte_api/models/source_s3.py + - src/airbyte_api/models/source_salesforce.py + - src/airbyte_api/models/source_salesloft.py + - src/airbyte_api/models/source_sap_fieldglass.py + - src/airbyte_api/models/source_secoda.py + - src/airbyte_api/models/source_sendgrid.py + - src/airbyte_api/models/source_sendinblue.py + - src/airbyte_api/models/source_senseforce.py + - src/airbyte_api/models/source_sentry.py + - src/airbyte_api/models/source_sftp.py + - src/airbyte_api/models/source_sftp_bulk.py + - src/airbyte_api/models/source_shopify.py + - src/airbyte_api/models/source_shortio.py + - src/airbyte_api/models/source_slack.py + - src/airbyte_api/models/source_smaily.py + - src/airbyte_api/models/source_smartengage.py + - src/airbyte_api/models/source_smartsheets.py + - src/airbyte_api/models/source_snapchat_marketing.py + - src/airbyte_api/models/source_snowflake.py + - src/airbyte_api/models/source_sonar_cloud.py + - src/airbyte_api/models/source_spacex_api.py + - src/airbyte_api/models/source_square.py + - src/airbyte_api/models/source_strava.py + - src/airbyte_api/models/source_stripe.py + - src/airbyte_api/models/source_survey_sparrow.py + - src/airbyte_api/models/source_surveymonkey.py + - src/airbyte_api/models/source_tempo.py + - src/airbyte_api/models/source_the_guardian_api.py + - src/airbyte_api/models/source_tiktok_marketing.py + - src/airbyte_api/models/source_trello.py + - src/airbyte_api/models/source_trustpilot.py + - src/airbyte_api/models/source_tvmaze_schedule.py + - src/airbyte_api/models/source_twilio.py + - src/airbyte_api/models/source_twilio_taskrouter.py + - src/airbyte_api/models/source_twitter.py + - src/airbyte_api/models/source_typeform.py + - src/airbyte_api/models/source_us_census.py + - src/airbyte_api/models/source_vantage.py + - src/airbyte_api/models/source_webflow.py + - src/airbyte_api/models/source_whisky_hunter.py + - src/airbyte_api/models/source_wikipedia_pageviews.py + - src/airbyte_api/models/source_woocommerce.py + - src/airbyte_api/models/source_xkcd.py + - src/airbyte_api/models/source_yandex_metrica.py + - src/airbyte_api/models/source_yotpo.py + - src/airbyte_api/models/source_youtube_analytics.py + - src/airbyte_api/models/source_zendesk_chat.py + - src/airbyte_api/models/source_zendesk_sell.py + - src/airbyte_api/models/source_zendesk_sunshine.py + - src/airbyte_api/models/source_zendesk_support.py + - src/airbyte_api/models/source_zendesk_talk.py + - src/airbyte_api/models/source_zenloop.py + - src/airbyte_api/models/source_zoho_crm.py + - src/airbyte_api/models/source_zoom.py + - src/airbyte_api/models/sourcecreaterequest.py + - src/airbyte_api/models/initiateoauthrequest.py + - src/airbyte_api/models/oauthactornames.py + - src/airbyte_api/models/oauthinputconfiguration.py + - src/airbyte_api/models/sourcesresponse.py + - src/airbyte_api/models/sourcepatchrequest.py + - src/airbyte_api/models/sourceputrequest.py + - src/airbyte_api/models/streampropertiesresponse.py + - src/airbyte_api/models/streamproperties.py + - src/airbyte_api/models/workspaceoauthcredentialsrequest.py + - src/airbyte_api/models/airtable.py + - src/airbyte_api/models/amazon_ads.py + - src/airbyte_api/models/amazon_seller_partner.py + - src/airbyte_api/models/asana.py + - src/airbyte_api/models/bing_ads.py + - src/airbyte_api/models/facebook_marketing.py + - src/airbyte_api/models/github.py + - src/airbyte_api/models/gitlab.py + - src/airbyte_api/models/google_ads.py + - src/airbyte_api/models/google_analytics_data_api.py + - src/airbyte_api/models/google_drive.py + - src/airbyte_api/models/google_search_console.py + - src/airbyte_api/models/google_sheets.py + - src/airbyte_api/models/harvest.py + - src/airbyte_api/models/hubspot.py + - src/airbyte_api/models/instagram.py + - src/airbyte_api/models/intercom.py + - src/airbyte_api/models/lever_hiring.py + - src/airbyte_api/models/linkedin_ads.py + - src/airbyte_api/models/mailchimp.py + - src/airbyte_api/models/microsoft_onedrive.py + - src/airbyte_api/models/microsoft_sharepoint.py + - src/airbyte_api/models/microsoft_teams.py + - src/airbyte_api/models/monday.py + - src/airbyte_api/models/notion.py + - src/airbyte_api/models/pinterest.py + - src/airbyte_api/models/retently.py + - src/airbyte_api/models/salesforce.py + - src/airbyte_api/models/shopify.py + - src/airbyte_api/models/slack.py + - src/airbyte_api/models/smartsheets.py + - src/airbyte_api/models/snapchat_marketing.py + - src/airbyte_api/models/snowflake.py + - src/airbyte_api/models/square.py + - src/airbyte_api/models/strava.py + - src/airbyte_api/models/surveymonkey.py + - src/airbyte_api/models/tiktok_marketing.py + - src/airbyte_api/models/typeform.py + - src/airbyte_api/models/youtube_analytics.py + - src/airbyte_api/models/zendesk_chat.py + - src/airbyte_api/models/zendesk_sunshine.py + - src/airbyte_api/models/zendesk_support.py + - src/airbyte_api/models/zendesk_talk.py + - src/airbyte_api/models/actortypeenum.py + - src/airbyte_api/models/workspaceresponse.py + - src/airbyte_api/models/workspacecreaterequest.py + - src/airbyte_api/models/workspacesresponse.py + - src/airbyte_api/models/workspaceupdaterequest.py + - src/airbyte_api/models/security.py + - src/airbyte_api/models/schemebasicauth.py + - src/airbyte_api/errors/__init__.py + - src/airbyte_api/api/__init__.py + - src/airbyte_api/models/__init__.py + - docs/api/createconnectionresponse.md + - docs/api/deleteconnectionrequest.md + - docs/api/deleteconnectionresponse.md + - docs/api/getconnectionrequest.md + - docs/api/getconnectionresponse.md + - docs/api/listconnectionsrequest.md + - docs/api/listconnectionsresponse.md + - docs/api/patchconnectionrequest.md + - docs/api/patchconnectionresponse.md + - docs/api/createdestinationresponse.md + - docs/api/deletedestinationrequest.md + - docs/api/deletedestinationresponse.md + - docs/api/getdestinationrequest.md + - docs/api/getdestinationresponse.md + - docs/api/listdestinationsrequest.md + - docs/api/listdestinationsresponse.md + - docs/api/patchdestinationrequest.md + - docs/api/patchdestinationresponse.md + - docs/api/putdestinationrequest.md + - docs/api/putdestinationresponse.md + - docs/api/canceljobrequest.md + - docs/api/canceljobresponse.md + - docs/api/createjobresponse.md + - docs/api/getjobrequest.md + - docs/api/getjobresponse.md + - docs/api/listjobsrequest.md + - docs/api/listjobsresponse.md + - docs/api/createsourceresponse.md + - docs/api/deletesourcerequest.md + - docs/api/deletesourceresponse.md + - docs/api/getsourcerequest.md + - docs/api/getsourceresponse.md + - docs/api/initiateoauthresponse.md + - docs/api/listsourcesrequest.md + - docs/api/listsourcesresponse.md + - docs/api/patchsourcerequest.md + - docs/api/patchsourceresponse.md + - docs/api/putsourcerequest.md + - docs/api/putsourceresponse.md + - docs/api/getstreampropertiesrequest.md + - docs/api/getstreampropertiesresponse.md + - docs/api/createorupdateworkspaceoauthcredentialsrequest.md + - docs/api/createorupdateworkspaceoauthcredentialsresponse.md + - docs/api/createworkspaceresponse.md + - docs/api/deleteworkspacerequest.md + - docs/api/deleteworkspaceresponse.md + - docs/api/getworkspacerequest.md + - docs/api/getworkspaceresponse.md + - docs/api/listworkspacesrequest.md + - docs/api/listworkspacesresponse.md + - docs/api/updateworkspacerequest.md + - docs/api/updateworkspaceresponse.md + - docs/models/connectionresponse.md + - docs/models/connectionstatusenum.md + - docs/models/connectionscheduleresponse.md + - docs/models/scheduletypewithbasicenum.md + - docs/models/nonbreakingschemaupdatesbehaviorenum.md + - docs/models/namespacedefinitionenum.md + - docs/models/geographyenum.md + - docs/models/streamconfigurations.md + - docs/models/streamconfiguration.md + - docs/models/connectionsyncmodeenum.md + - docs/models/connectioncreaterequest.md + - docs/models/connectionschedule.md + - docs/models/scheduletypeenum.md + - docs/models/connectionsresponse.md + - docs/models/connectionpatchrequest.md + - docs/models/nonbreakingschemaupdatesbehaviorenumnodefault.md + - docs/models/namespacedefinitionenumnodefault.md + - docs/models/geographyenumnodefault.md + - docs/models/destinationresponse.md + - docs/models/destinationconfiguration.md + - docs/models/authenticationviagoogleoauth.md + - docs/models/destinationgooglesheetsgooglesheets.md + - docs/models/destinationgooglesheets.md + - docs/models/astra.md + - docs/models/destinationastraschemasembeddingembeddingmode.md + - docs/models/openaicompatible.md + - docs/models/destinationastraschemasembeddingmode.md + - docs/models/azureopenai.md + - docs/models/destinationastraschemasmode.md + - docs/models/fake.md + - docs/models/destinationastramode.md + - docs/models/cohere.md + - docs/models/destinationastraschemasembeddingembedding1mode.md + - docs/models/openai.md + - docs/models/embedding.md + - docs/models/indexing.md + - docs/models/fieldnamemappingconfigmodel.md + - docs/models/destinationastralanguage.md + - docs/models/destinationastraschemasprocessingtextsplittertextsplittermode.md + - docs/models/byprogramminglanguage.md + - docs/models/destinationastraschemasprocessingtextsplittermode.md + - docs/models/bymarkdownheader.md + - docs/models/destinationastraschemasprocessingmode.md + - docs/models/byseparator.md + - docs/models/textsplitter.md + - docs/models/processingconfigmodel.md + - docs/models/destinationastra.md + - docs/models/destinationawsdatalakecredentialstitle.md + - docs/models/iamuser.md + - docs/models/credentialstitle.md + - docs/models/iamrole.md + - docs/models/authenticationmode.md + - docs/models/awsdatalake.md + - docs/models/destinationawsdatalakecompressioncodecoptional.md + - docs/models/destinationawsdatalakeformattypewildcard.md + - docs/models/parquetcolumnarstorage.md + - docs/models/compressioncodecoptional.md + - docs/models/formattypewildcard.md + - docs/models/jsonlinesnewlinedelimitedjson.md + - docs/models/outputformatwildcard.md + - docs/models/choosehowtopartitiondata.md + - docs/models/s3bucketregion.md + - docs/models/destinationawsdatalake.md + - docs/models/azureblobstorage.md + - docs/models/destinationazureblobstorageformattype.md + - docs/models/destinationazureblobstoragejsonlinesnewlinedelimitedjson.md + - docs/models/normalizationflattening.md + - docs/models/formattype.md + - docs/models/csvcommaseparatedvalues.md + - docs/models/outputformat.md + - docs/models/destinationazureblobstorage.md + - docs/models/datasetlocation.md + - docs/models/bigquery.md + - docs/models/destinationbigquerymethod.md + - docs/models/standardinserts.md + - docs/models/destinationbigquerycredentialtype.md + - docs/models/destinationbigqueryhmackey.md + - docs/models/credential.md + - docs/models/gcstmpfilesafterwardprocessing.md + - docs/models/method.md + - docs/models/gcsstaging.md + - docs/models/loadingmethod.md + - docs/models/transformationqueryruntype.md + - docs/models/destinationbigquery.md + - docs/models/clickhouse.md + - docs/models/destinationclickhouseschemastunnelmethod.md + - docs/models/passwordauthentication.md + - docs/models/destinationclickhousetunnelmethod.md + - docs/models/sshkeyauthentication.md + - docs/models/tunnelmethod.md + - docs/models/notunnel.md + - docs/models/sshtunnelmethod.md + - docs/models/destinationclickhouse.md + - docs/models/convex.md + - docs/models/destinationconvex.md + - docs/models/destinationdatabricksschemasdatasourcetype.md + - docs/models/destinationdatabricksazureblobstorage.md + - docs/models/destinationdatabricksdatasourcetype.md + - docs/models/destinationdatabrickss3bucketregion.md + - docs/models/amazons3.md + - docs/models/datasourcetype.md + - docs/models/recommendedmanagedtables.md + - docs/models/datasource.md + - docs/models/databricks.md + - docs/models/destinationdatabricks.md + - docs/models/devnull.md + - docs/models/testdestinationtype.md + - docs/models/silent.md + - docs/models/testdestination.md + - docs/models/destinationdevnull.md + - docs/models/duckdb.md + - docs/models/destinationduckdb.md + - docs/models/dynamodb.md + - docs/models/dynamodbregion.md + - docs/models/destinationdynamodb.md + - docs/models/destinationelasticsearchschemasmethod.md + - docs/models/usernamepassword.md + - docs/models/destinationelasticsearchmethod.md + - docs/models/apikeysecret.md + - docs/models/authenticationmethod.md + - docs/models/elasticsearch.md + - docs/models/destinationelasticsearch.md + - docs/models/firestore.md + - docs/models/destinationfirestore.md + - docs/models/credentialtype.md + - docs/models/hmackey.md + - docs/models/authentication.md + - docs/models/gcs.md + - docs/models/destinationgcscompressioncodec.md + - docs/models/destinationgcsschemasformatoutputformatformattype.md + - docs/models/destinationgcsparquetcolumnarstorage.md + - docs/models/destinationgcsschemasformatcompressiontype.md + - docs/models/destinationgcsgzip.md + - docs/models/destinationgcsschemascompressiontype.md + - docs/models/destinationgcsschemasnocompression.md + - docs/models/destinationgcscompression.md + - docs/models/destinationgcsschemasformatformattype.md + - docs/models/destinationgcsjsonlinesnewlinedelimitedjson.md + - docs/models/destinationgcscompressiontype.md + - docs/models/gzip.md + - docs/models/compressiontype.md + - docs/models/destinationgcsnocompression.md + - docs/models/compression.md + - docs/models/normalization.md + - docs/models/destinationgcsschemasformattype.md + - docs/models/destinationgcscsvcommaseparatedvalues.md + - docs/models/destinationgcsschemasformatoutputformat1codec.md + - docs/models/snappy.md + - docs/models/destinationgcsschemasformatoutputformatcodec.md + - docs/models/zstandard.md + - docs/models/destinationgcsschemasformatcodec.md + - docs/models/xz.md + - docs/models/destinationgcsschemascodec.md + - docs/models/bzip2.md + - docs/models/destinationgcscodec.md + - docs/models/deflate.md + - docs/models/codec.md + - docs/models/nocompression.md + - docs/models/compressioncodec.md + - docs/models/destinationgcsformattype.md + - docs/models/avroapacheavro.md + - docs/models/destinationgcsoutputformat.md + - docs/models/gcsbucketregion.md + - docs/models/destinationgcs.md + - docs/models/langchain.md + - docs/models/destinationlangchainschemasmode.md + - docs/models/destinationlangchainfake.md + - docs/models/destinationlangchainmode.md + - docs/models/destinationlangchainopenai.md + - docs/models/destinationlangchainembedding.md + - docs/models/destinationlangchainschemasindexingindexing3mode.md + - docs/models/chromalocalpersistance.md + - docs/models/destinationlangchainschemasindexingindexingmode.md + - docs/models/docarrayhnswsearch.md + - docs/models/destinationlangchainschemasindexingmode.md + - docs/models/destinationlangchainpinecone.md + - docs/models/destinationlangchainindexing.md + - docs/models/destinationlangchainprocessingconfigmodel.md + - docs/models/destinationlangchain.md + - docs/models/milvus.md + - docs/models/destinationmilvusschemasembeddingembedding5mode.md + - docs/models/destinationmilvusopenaicompatible.md + - docs/models/destinationmilvusschemasembeddingembeddingmode.md + - docs/models/destinationmilvusazureopenai.md + - docs/models/destinationmilvusschemasembeddingmode.md + - docs/models/destinationmilvusfake.md + - docs/models/destinationmilvusschemasmode.md + - docs/models/destinationmilvuscohere.md + - docs/models/destinationmilvusmode.md + - docs/models/destinationmilvusopenai.md + - docs/models/destinationmilvusembedding.md + - docs/models/destinationmilvusschemasindexingauthauthenticationmode.md + - docs/models/noauth.md + - docs/models/destinationmilvusschemasindexingauthmode.md + - docs/models/destinationmilvususernamepassword.md + - docs/models/destinationmilvusschemasindexingmode.md + - docs/models/destinationmilvusapitoken.md + - docs/models/destinationmilvusauthentication.md + - docs/models/destinationmilvusindexing.md + - docs/models/destinationmilvusfieldnamemappingconfigmodel.md + - docs/models/destinationmilvuslanguage.md + - docs/models/destinationmilvusschemasprocessingtextsplittertextsplittermode.md + - docs/models/destinationmilvusbyprogramminglanguage.md + - docs/models/destinationmilvusschemasprocessingtextsplittermode.md + - docs/models/destinationmilvusbymarkdownheader.md + - docs/models/destinationmilvusschemasprocessingmode.md + - docs/models/destinationmilvusbyseparator.md + - docs/models/destinationmilvustextsplitter.md + - docs/models/destinationmilvusprocessingconfigmodel.md + - docs/models/destinationmilvus.md + - docs/models/destinationmongodbauthorization.md + - docs/models/loginpassword.md + - docs/models/destinationmongodbschemasauthorization.md + - docs/models/nonet.md + - docs/models/authorizationtype.md + - docs/models/mongodb.md + - docs/models/destinationmongodbschemasinstance.md + - docs/models/mongodbatlas.md + - docs/models/destinationmongodbinstance.md + - docs/models/replicaset.md + - docs/models/instance.md + - docs/models/standalonemongodbinstance.md + - docs/models/mongodbinstancetype.md + - docs/models/destinationmongodbschemastunnelmethodtunnelmethod.md + - docs/models/destinationmongodbpasswordauthentication.md + - docs/models/destinationmongodbschemastunnelmethod.md + - docs/models/destinationmongodbsshkeyauthentication.md + - docs/models/destinationmongodbtunnelmethod.md + - docs/models/destinationmongodbnotunnel.md + - docs/models/destinationmongodbsshtunnelmethod.md + - docs/models/destinationmongodb.md + - docs/models/mssql.md + - docs/models/destinationmssqlschemassslmethod.md + - docs/models/encryptedverifycertificate.md + - docs/models/destinationmssqlsslmethod.md + - docs/models/encryptedtrustservercertificate.md + - docs/models/sslmethod.md + - docs/models/destinationmssqlschemastunnelmethodtunnelmethod.md + - docs/models/destinationmssqlpasswordauthentication.md + - docs/models/destinationmssqlschemastunnelmethod.md + - docs/models/destinationmssqlsshkeyauthentication.md + - docs/models/destinationmssqltunnelmethod.md + - docs/models/destinationmssqlnotunnel.md + - docs/models/destinationmssqlsshtunnelmethod.md + - docs/models/destinationmssql.md + - docs/models/mysql.md + - docs/models/destinationmysqlschemastunnelmethodtunnelmethod.md + - docs/models/destinationmysqlpasswordauthentication.md + - docs/models/destinationmysqlschemastunnelmethod.md + - docs/models/destinationmysqlsshkeyauthentication.md + - docs/models/destinationmysqltunnelmethod.md + - docs/models/destinationmysqlnotunnel.md + - docs/models/destinationmysqlsshtunnelmethod.md + - docs/models/destinationmysql.md + - docs/models/oracle.md + - docs/models/destinationoracleschemastunnelmethodtunnelmethod.md + - docs/models/destinationoraclepasswordauthentication.md + - docs/models/destinationoracleschemastunnelmethod.md + - docs/models/destinationoraclesshkeyauthentication.md + - docs/models/destinationoracletunnelmethod.md + - docs/models/destinationoraclenotunnel.md + - docs/models/destinationoraclesshtunnelmethod.md + - docs/models/destinationoracle.md + - docs/models/pinecone.md + - docs/models/destinationpineconeschemasembeddingembedding5mode.md + - docs/models/destinationpineconeopenaicompatible.md + - docs/models/destinationpineconeschemasembeddingembeddingmode.md + - docs/models/destinationpineconeazureopenai.md + - docs/models/destinationpineconeschemasembeddingmode.md + - docs/models/destinationpineconefake.md + - docs/models/destinationpineconeschemasmode.md + - docs/models/destinationpineconecohere.md + - docs/models/destinationpineconemode.md + - docs/models/destinationpineconeopenai.md + - docs/models/destinationpineconeembedding.md + - docs/models/destinationpineconeindexing.md + - docs/models/destinationpineconefieldnamemappingconfigmodel.md + - docs/models/destinationpineconelanguage.md + - docs/models/destinationpineconeschemasprocessingtextsplittertextsplittermode.md + - docs/models/destinationpineconebyprogramminglanguage.md + - docs/models/destinationpineconeschemasprocessingtextsplittermode.md + - docs/models/destinationpineconebymarkdownheader.md + - docs/models/destinationpineconeschemasprocessingmode.md + - docs/models/destinationpineconebyseparator.md + - docs/models/destinationpineconetextsplitter.md + - docs/models/destinationpineconeprocessingconfigmodel.md + - docs/models/destinationpinecone.md + - docs/models/postgres.md + - docs/models/destinationpostgresschemassslmodesslmodes6mode.md + - docs/models/verifyfull.md + - docs/models/destinationpostgresschemassslmodesslmodesmode.md + - docs/models/verifyca.md + - docs/models/destinationpostgresschemassslmodemode.md + - docs/models/require.md + - docs/models/destinationpostgresschemasmode.md + - docs/models/prefer.md + - docs/models/destinationpostgresmode.md + - docs/models/allow.md + - docs/models/mode.md + - docs/models/disable.md + - docs/models/sslmodes.md + - docs/models/destinationpostgresschemastunnelmethodtunnelmethod.md + - docs/models/destinationpostgrespasswordauthentication.md + - docs/models/destinationpostgresschemastunnelmethod.md + - docs/models/destinationpostgressshkeyauthentication.md + - docs/models/destinationpostgrestunnelmethod.md + - docs/models/destinationpostgresnotunnel.md + - docs/models/destinationpostgressshtunnelmethod.md + - docs/models/destinationpostgres.md + - docs/models/pubsub.md + - docs/models/destinationpubsub.md + - docs/models/qdrant.md + - docs/models/destinationqdrantschemasembeddingembedding5mode.md + - docs/models/destinationqdrantopenaicompatible.md + - docs/models/destinationqdrantschemasembeddingembeddingmode.md + - docs/models/destinationqdrantazureopenai.md + - docs/models/destinationqdrantschemasembeddingmode.md + - docs/models/destinationqdrantfake.md + - docs/models/destinationqdrantschemasmode.md + - docs/models/destinationqdrantcohere.md + - docs/models/destinationqdrantmode.md + - docs/models/destinationqdrantopenai.md + - docs/models/destinationqdrantembedding.md + - docs/models/destinationqdrantschemasindexingauthmethodmode.md + - docs/models/destinationqdrantnoauth.md + - docs/models/destinationqdrantschemasindexingmode.md + - docs/models/apikeyauth.md + - docs/models/destinationqdrantauthenticationmethod.md + - docs/models/distancemetric.md + - docs/models/destinationqdrantindexing.md + - docs/models/destinationqdrantfieldnamemappingconfigmodel.md + - docs/models/destinationqdrantlanguage.md + - docs/models/destinationqdrantschemasprocessingtextsplittertextsplittermode.md + - docs/models/destinationqdrantbyprogramminglanguage.md + - docs/models/destinationqdrantschemasprocessingtextsplittermode.md + - docs/models/destinationqdrantbymarkdownheader.md + - docs/models/destinationqdrantschemasprocessingmode.md + - docs/models/destinationqdrantbyseparator.md + - docs/models/destinationqdranttextsplitter.md + - docs/models/destinationqdrantprocessingconfigmodel.md + - docs/models/destinationqdrant.md + - docs/models/cachetype.md + - docs/models/redis.md + - docs/models/destinationredisschemasmode.md + - docs/models/destinationredisverifyfull.md + - docs/models/destinationredismode.md + - docs/models/destinationredisdisable.md + - docs/models/destinationredissslmodes.md + - docs/models/destinationredisschemastunnelmethodtunnelmethod.md + - docs/models/destinationredispasswordauthentication.md + - docs/models/destinationredisschemastunnelmethod.md + - docs/models/destinationredissshkeyauthentication.md + - docs/models/destinationredistunnelmethod.md + - docs/models/destinationredisnotunnel.md + - docs/models/destinationredissshtunnelmethod.md + - docs/models/destinationredis.md + - docs/models/redshift.md + - docs/models/destinationredshiftschemastunnelmethodtunnelmethod.md + - docs/models/destinationredshiftpasswordauthentication.md + - docs/models/destinationredshiftschemastunnelmethod.md + - docs/models/destinationredshiftsshkeyauthentication.md + - docs/models/destinationredshifttunnelmethod.md + - docs/models/destinationredshiftnotunnel.md + - docs/models/destinationredshiftsshtunnelmethod.md + - docs/models/destinationredshiftschemasmethod.md + - docs/models/standard.md + - docs/models/destinationredshiftencryptiontype.md + - docs/models/aescbcenvelopeencryption.md + - docs/models/encryptiontype.md + - docs/models/noencryption.md + - docs/models/destinationredshiftencryption.md + - docs/models/destinationredshiftmethod.md + - docs/models/destinationredshifts3bucketregion.md + - docs/models/awss3staging.md + - docs/models/uploadingmethod.md + - docs/models/destinationredshift.md + - docs/models/s3.md + - docs/models/destinations3schemascompressioncodec.md + - docs/models/destinations3schemasformatoutputformatformattype.md + - docs/models/destinations3parquetcolumnarstorage.md + - docs/models/destinations3schemasformatoutputformat3compressioncodeccodec.md + - docs/models/destinations3snappy.md + - docs/models/destinations3schemasformatoutputformat3codec.md + - docs/models/destinations3zstandard.md + - docs/models/destinations3schemasformatoutputformatcodec.md + - docs/models/destinations3xz.md + - docs/models/destinations3schemasformatcodec.md + - docs/models/destinations3bzip2.md + - docs/models/destinations3schemascodec.md + - docs/models/destinations3deflate.md + - docs/models/destinations3codec.md + - docs/models/destinations3schemasformatnocompression.md + - docs/models/destinations3compressioncodec.md + - docs/models/destinations3schemasformatformattype.md + - docs/models/destinations3avroapacheavro.md + - docs/models/destinations3schemasformatoutputformatcompressiontype.md + - docs/models/destinations3schemasgzip.md + - docs/models/destinations3schemasformatcompressiontype.md + - docs/models/destinations3schemasnocompression.md + - docs/models/destinations3schemascompression.md + - docs/models/destinations3schemasflattening.md + - docs/models/destinations3schemasformattype.md + - docs/models/destinations3jsonlinesnewlinedelimitedjson.md + - docs/models/destinations3schemascompressiontype.md + - docs/models/destinations3gzip.md + - docs/models/destinations3compressiontype.md + - docs/models/destinations3nocompression.md + - docs/models/destinations3compression.md + - docs/models/destinations3flattening.md + - docs/models/destinations3formattype.md + - docs/models/destinations3csvcommaseparatedvalues.md + - docs/models/destinations3outputformat.md + - docs/models/destinations3s3bucketregion.md + - docs/models/destinations3.md + - docs/models/s3glue.md + - docs/models/destinations3glueschemascompressiontype.md + - docs/models/destinations3gluegzip.md + - docs/models/destinations3gluecompressiontype.md + - docs/models/destinations3gluenocompression.md + - docs/models/destinations3gluecompression.md + - docs/models/flattening.md + - docs/models/destinations3glueformattype.md + - docs/models/destinations3gluejsonlinesnewlinedelimitedjson.md + - docs/models/destinations3glueoutputformat.md + - docs/models/serializationlibrary.md + - docs/models/destinations3glues3bucketregion.md + - docs/models/destinations3glue.md + - docs/models/sftpjson.md + - docs/models/destinationsftpjson.md + - docs/models/destinationsnowflakeschemasauthtype.md + - docs/models/destinationsnowflakeoauth20.md + - docs/models/destinationsnowflakeauthtype.md + - docs/models/usernameandpassword.md + - docs/models/destinationsnowflakeschemascredentialsauthtype.md + - docs/models/keypairauthentication.md + - docs/models/authorizationmethod.md + - docs/models/destinationsnowflakesnowflake.md + - docs/models/destinationsnowflake.md + - docs/models/teradata.md + - docs/models/destinationteradataschemassslmodesslmodes6mode.md + - docs/models/destinationteradataverifyfull.md + - docs/models/destinationteradataschemassslmodesslmodes5mode.md + - docs/models/destinationteradataverifyca.md + - docs/models/destinationteradataschemassslmodesslmodesmode.md + - docs/models/destinationteradatarequire.md + - docs/models/destinationteradataschemassslmodemode.md + - docs/models/destinationteradataprefer.md + - docs/models/destinationteradataschemasmode.md + - docs/models/destinationteradataallow.md + - docs/models/destinationteradatamode.md + - docs/models/destinationteradatadisable.md + - docs/models/destinationteradatasslmodes.md + - docs/models/destinationteradata.md + - docs/models/typesense.md + - docs/models/destinationtypesense.md + - docs/models/vectara.md + - docs/models/oauth20credentials.md + - docs/models/destinationvectara.md + - docs/models/weaviate.md + - docs/models/destinationweaviateschemasembeddingembedding7mode.md + - docs/models/destinationweaviateopenaicompatible.md + - docs/models/destinationweaviateschemasembeddingembedding6mode.md + - docs/models/destinationweaviatefake.md + - docs/models/destinationweaviateschemasembeddingembedding5mode.md + - docs/models/fromfield.md + - docs/models/destinationweaviateschemasembeddingembeddingmode.md + - docs/models/destinationweaviatecohere.md + - docs/models/destinationweaviateschemasembeddingmode.md + - docs/models/destinationweaviateopenai.md + - docs/models/destinationweaviateschemasmode.md + - docs/models/destinationweaviateazureopenai.md + - docs/models/destinationweaviatemode.md + - docs/models/noexternalembedding.md + - docs/models/destinationweaviateembedding.md + - docs/models/header.md + - docs/models/destinationweaviateschemasindexingauthauthenticationmode.md + - docs/models/noauthentication.md + - docs/models/destinationweaviateschemasindexingauthmode.md + - docs/models/destinationweaviateusernamepassword.md + - docs/models/destinationweaviateschemasindexingmode.md + - docs/models/destinationweaviateapitoken.md + - docs/models/destinationweaviateauthentication.md + - docs/models/defaultvectorizer.md + - docs/models/destinationweaviateindexing.md + - docs/models/destinationweaviatefieldnamemappingconfigmodel.md + - docs/models/destinationweaviatelanguage.md + - docs/models/destinationweaviateschemasprocessingtextsplittertextsplittermode.md + - docs/models/destinationweaviatebyprogramminglanguage.md + - docs/models/destinationweaviateschemasprocessingtextsplittermode.md + - docs/models/destinationweaviatebymarkdownheader.md + - docs/models/destinationweaviateschemasprocessingmode.md + - docs/models/destinationweaviatebyseparator.md + - docs/models/destinationweaviatetextsplitter.md + - docs/models/destinationweaviateprocessingconfigmodel.md + - docs/models/destinationweaviate.md + - docs/models/destinationcreaterequest.md + - docs/models/destinationsresponse.md + - docs/models/destinationpatchrequest.md + - docs/models/destinationputrequest.md + - docs/models/jobresponse.md + - docs/models/jobstatusenum.md + - docs/models/jobtypeenum.md + - docs/models/jobcreaterequest.md + - docs/models/jobsresponse.md + - docs/models/sourceresponse.md + - docs/models/sourceconfiguration.md + - docs/models/aha.md + - docs/models/sourceaha.md + - docs/models/aircall.md + - docs/models/sourceaircall.md + - docs/models/sourceairtableauthmethod.md + - docs/models/personalaccesstoken.md + - docs/models/sourceairtableschemasauthmethod.md + - docs/models/sourceairtableoauth20.md + - docs/models/sourceairtableauthentication.md + - docs/models/sourceairtableairtable.md + - docs/models/sourceairtable.md + - docs/models/sourceamazonadsauthtype.md + - docs/models/region.md + - docs/models/reportrecordtypes.md + - docs/models/sourceamazonadsamazonads.md + - docs/models/statefilter.md + - docs/models/sourceamazonads.md + - docs/models/awssellerpartneraccounttype.md + - docs/models/sourceamazonsellerpartnerauthtype.md + - docs/models/awsenvironment.md + - docs/models/awsregion.md + - docs/models/optionslist.md + - docs/models/streamname.md + - docs/models/reportoptions.md + - docs/models/sourceamazonsellerpartneramazonsellerpartner.md + - docs/models/sourceamazonsellerpartner.md + - docs/models/sourceamazonsqsawsregion.md + - docs/models/amazonsqs.md + - docs/models/sourceamazonsqs.md + - docs/models/dataregion.md + - docs/models/amplitude.md + - docs/models/sourceamplitude.md + - docs/models/apifydataset.md + - docs/models/sourceapifydataset.md + - docs/models/appfollow.md + - docs/models/sourceappfollow.md + - docs/models/sourceasanaschemascredentialstitle.md + - docs/models/authenticatewithpersonalaccesstoken.md + - docs/models/sourceasanacredentialstitle.md + - docs/models/authenticateviaasanaoauth.md + - docs/models/authenticationmechanism.md + - docs/models/sourceasanaasana.md + - docs/models/sourceasana.md + - docs/models/sourceauth0schemascredentialsauthenticationmethod.md + - docs/models/oauth2accesstoken.md + - docs/models/sourceauth0schemasauthenticationmethod.md + - docs/models/oauth2confidentialapplication.md + - docs/models/sourceauth0authenticationmethod.md + - docs/models/auth0.md + - docs/models/sourceauth0.md + - docs/models/awscloudtrail.md + - docs/models/sourceawscloudtrail.md + - docs/models/sourceazureblobstorageazureblobstorage.md + - docs/models/sourceazureblobstorageschemasstreamsformatfiletype.md + - docs/models/sourceazureblobstoragemode.md + - docs/models/local.md + - docs/models/processing.md + - docs/models/parsingstrategy.md + - docs/models/documentfiletypeformatexperimental.md + - docs/models/sourceazureblobstorageschemasstreamsfiletype.md + - docs/models/parquetformat.md + - docs/models/sourceazureblobstorageschemasfiletype.md + - docs/models/jsonlformat.md + - docs/models/sourceazureblobstoragefiletype.md + - docs/models/sourceazureblobstorageschemasheaderdefinitiontype.md + - docs/models/userprovided.md + - docs/models/sourceazureblobstorageheaderdefinitiontype.md + - docs/models/autogenerated.md + - docs/models/headerdefinitiontype.md + - docs/models/fromcsv.md + - docs/models/csvheaderdefinition.md + - docs/models/inferencetype.md + - docs/models/csvformat.md + - docs/models/sourceazureblobstorageschemasstreamsformatformatfiletype.md + - docs/models/avroformat.md + - docs/models/format.md + - docs/models/validationpolicy.md + - docs/models/filebasedstreamconfig.md + - docs/models/sourceazureblobstorage.md + - docs/models/azuretable.md + - docs/models/sourceazuretable.md + - docs/models/bamboohr.md + - docs/models/sourcebamboohr.md + - docs/models/sourcebigquerybigquery.md + - docs/models/sourcebigquery.md + - docs/models/operator.md + - docs/models/accountnames.md + - docs/models/authmethod.md + - docs/models/reportingdataobject.md + - docs/models/customreportconfig.md + - docs/models/sourcebingadsbingads.md + - docs/models/sourcebingads.md + - docs/models/sourcebraintreeenvironment.md + - docs/models/braintree.md + - docs/models/sourcebraintree.md + - docs/models/braze.md + - docs/models/sourcebraze.md + - docs/models/sourcecartschemasauthtype.md + - docs/models/singlestoreaccesstoken.md + - docs/models/sourcecartauthtype.md + - docs/models/centralapirouter.md + - docs/models/sourcecartauthorizationmethod.md + - docs/models/cart.md + - docs/models/sourcecart.md + - docs/models/productcatalog.md + - docs/models/chargebee.md + - docs/models/sourcechargebee.md + - docs/models/chartmogul.md + - docs/models/sourcechartmogul.md + - docs/models/sourceclickhouseclickhouse.md + - docs/models/sourceclickhouseschemastunnelmethodtunnelmethod.md + - docs/models/sourceclickhousepasswordauthentication.md + - docs/models/sourceclickhouseschemastunnelmethod.md + - docs/models/sourceclickhousesshkeyauthentication.md + - docs/models/sourceclickhousetunnelmethod.md + - docs/models/sourceclickhousenotunnel.md + - docs/models/sourceclickhousesshtunnelmethod.md + - docs/models/sourceclickhouse.md + - docs/models/clickupapi.md + - docs/models/sourceclickupapi.md + - docs/models/clockify.md + - docs/models/sourceclockify.md + - docs/models/closecom.md + - docs/models/sourceclosecom.md + - docs/models/coda.md + - docs/models/sourcecoda.md + - docs/models/environment.md + - docs/models/coinapi.md + - docs/models/sourcecoinapi.md + - docs/models/datatype.md + - docs/models/coinmarketcap.md + - docs/models/sourcecoinmarketcap.md + - docs/models/configcat.md + - docs/models/sourceconfigcat.md + - docs/models/confluence.md + - docs/models/sourceconfluence.md + - docs/models/sourceconvexconvex.md + - docs/models/sourceconvex.md + - docs/models/datascope.md + - docs/models/sourcedatascope.md + - docs/models/delighted.md + - docs/models/sourcedelighted.md + - docs/models/dixa.md + - docs/models/sourcedixa.md + - docs/models/dockerhub.md + - docs/models/sourcedockerhub.md + - docs/models/dremio.md + - docs/models/sourcedremio.md + - docs/models/sourcedynamodbdynamodbregion.md + - docs/models/sourcedynamodbdynamodb.md + - docs/models/sourcedynamodb.md + - docs/models/sourcee2etestcloudtype.md + - docs/models/multischema.md + - docs/models/sourcee2etestcloudschemastype.md + - docs/models/singleschema.md + - docs/models/mockcatalog.md + - docs/models/e2etestcloud.md + - docs/models/type.md + - docs/models/continuousfeed.md + - docs/models/sourcee2etestcloud.md + - docs/models/emailoctopus.md + - docs/models/sourceemailoctopus.md + - docs/models/exchangerates.md + - docs/models/sourceexchangerates.md + - docs/models/validadstatuses.md + - docs/models/validadsetstatuses.md + - docs/models/validcampaignstatuses.md + - docs/models/validactionbreakdowns.md + - docs/models/sourcefacebookmarketingactionreporttime.md + - docs/models/validbreakdowns.md + - docs/models/sourcefacebookmarketingvalidenums.md + - docs/models/level.md + - docs/models/insightconfig.md + - docs/models/sourcefacebookmarketingfacebookmarketing.md + - docs/models/sourcefacebookmarketing.md + - docs/models/faker.md + - docs/models/sourcefaker.md + - docs/models/sourcefaunaschemasdeletionmode.md + - docs/models/enabled.md + - docs/models/sourcefaunadeletionmode.md + - docs/models/disabled.md + - docs/models/deletionmode.md + - docs/models/collection.md + - docs/models/fauna.md + - docs/models/sourcefauna.md + - docs/models/fileformat.md + - docs/models/sourcefileschemasproviderstorageprovider7storage.md + - docs/models/sftpsecurefiletransferprotocol.md + - docs/models/sourcefileschemasproviderstorageprovider6storage.md + - docs/models/scpsecurecopyprotocol.md + - docs/models/sourcefileschemasproviderstorageproviderstorage.md + - docs/models/sshsecureshell.md + - docs/models/sourcefileschemasproviderstorage.md + - docs/models/azblobazureblobstorage.md + - docs/models/sourcefileschemasstorage.md + - docs/models/sourcefiles3amazonwebservices.md + - docs/models/sourcefilestorage.md + - docs/models/gcsgooglecloudstorage.md + - docs/models/storage.md + - docs/models/httpspublicweb.md + - docs/models/storageprovider.md + - docs/models/file.md + - docs/models/sourcefile.md + - docs/models/firebolt.md + - docs/models/sourcefirebolt.md + - docs/models/freshcaller.md + - docs/models/sourcefreshcaller.md + - docs/models/freshdesk.md + - docs/models/sourcefreshdesk.md + - docs/models/freshsales.md + - docs/models/sourcefreshsales.md + - docs/models/gainsightpx.md + - docs/models/sourcegainsightpx.md + - docs/models/sourcegcsgcs.md + - docs/models/sourcegcsfiletype.md + - docs/models/sourcegcsschemasstreamsheaderdefinitiontype.md + - docs/models/sourcegcsuserprovided.md + - docs/models/sourcegcsschemasheaderdefinitiontype.md + - docs/models/sourcegcsautogenerated.md + - docs/models/sourcegcsheaderdefinitiontype.md + - docs/models/sourcegcsfromcsv.md + - docs/models/sourcegcscsvheaderdefinition.md + - docs/models/sourcegcsinferencetype.md + - docs/models/sourcegcscsvformat.md + - docs/models/sourcegcsformat.md + - docs/models/sourcegcsvalidationpolicy.md + - docs/models/sourcegcsstreamconfig.md + - docs/models/sourcegcs.md + - docs/models/getlago.md + - docs/models/sourcegetlago.md + - docs/models/sourcegithuboptiontitle.md + - docs/models/sourcegithubpersonalaccesstoken.md + - docs/models/optiontitle.md + - docs/models/oauth.md + - docs/models/sourcegithubauthentication.md + - docs/models/sourcegithubgithub.md + - docs/models/sourcegithub.md + - docs/models/sourcegitlabschemasauthtype.md + - docs/models/privatetoken.md + - docs/models/sourcegitlabauthtype.md + - docs/models/sourcegitlaboauth20.md + - docs/models/sourcegitlabauthorizationmethod.md + - docs/models/sourcegitlabgitlab.md + - docs/models/sourcegitlab.md + - docs/models/glassfrog.md + - docs/models/sourceglassfrog.md + - docs/models/country.md + - docs/models/in_.md + - docs/models/language.md + - docs/models/nullable.md + - docs/models/sortby.md + - docs/models/gnews.md + - docs/models/topheadlinestopic.md + - docs/models/sourcegnews.md + - docs/models/googlecredentials.md + - docs/models/customqueriesarray.md + - docs/models/customerstatus.md + - docs/models/sourcegoogleadsgoogleads.md + - docs/models/sourcegoogleads.md + - docs/models/sourcegoogleanalyticsdataapischemasauthtype.md + - docs/models/serviceaccountkeyauthentication.md + - docs/models/sourcegoogleanalyticsdataapiauthtype.md + - docs/models/authenticateviagoogleoauth.md + - docs/models/sourcegoogleanalyticsdataapicredentials.md + - docs/models/cohortreportsettings.md + - docs/models/daterange.md + - docs/models/dimension.md + - docs/models/cohorts.md + - docs/models/sourcegoogleanalyticsdataapigranularity.md + - docs/models/cohortsrange.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayenabled.md + - docs/models/sourcegoogleanalyticsdataapischemasenabled.md + - docs/models/sourcegoogleanalyticsdataapienabled.md + - docs/models/sourcegoogleanalyticsdataapidisabled.md + - docs/models/cohortreports.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayfiltername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayvaluetype.md + - docs/models/sourcegoogleanalyticsdataapidoublevalue.md + - docs/models/sourcegoogleanalyticsdataapischemasvaluetype.md + - docs/models/sourcegoogleanalyticsdataapiint64value.md + - docs/models/fromvalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfiltervaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemasdoublevalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemasint64value.md + - docs/models/tovalue.md + - docs/models/betweenfilter.md + - docs/models/sourcegoogleanalyticsdataapischemasfiltername.md + - docs/models/sourcegoogleanalyticsdataapischemasvalidenums.md + - docs/models/sourcegoogleanalyticsdataapivaluetype.md + - docs/models/doublevalue.md + - docs/models/valuetype.md + - docs/models/int64value.md + - docs/models/value.md + - docs/models/numericfilter.md + - docs/models/sourcegoogleanalyticsdataapifiltername.md + - docs/models/inlistfilter.md + - docs/models/filtername.md + - docs/models/sourcegoogleanalyticsdataapivalidenums.md + - docs/models/stringfilter.md + - docs/models/sourcegoogleanalyticsdataapischemasfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayfiltertype.md + - docs/models/filter_.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilterfiltername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfiltervaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressiondoublevalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfiltervaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionint64value.md + - docs/models/sourcegoogleanalyticsdataapischemasfromvalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilter4tovaluevaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterdoublevalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilter4valuetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterint64value.md + - docs/models/sourcegoogleanalyticsdataapischemastovalue.md + - docs/models/sourcegoogleanalyticsdataapischemasbetweenfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfiltername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3validenums.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionvaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3doublevalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3valuetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3int64value.md + - docs/models/sourcegoogleanalyticsdataapischemasvalue.md + - docs/models/sourcegoogleanalyticsdataapischemasnumericfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfiltername.md + - docs/models/sourcegoogleanalyticsdataapischemasinlistfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3filtername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfiltervalidenums.md + - docs/models/sourcegoogleanalyticsdataapischemasstringfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterfilter.md + - docs/models/sourcegoogleanalyticsdataapischemasexpression.md + - docs/models/sourcegoogleanalyticsdataapischemasfiltertype.md + - docs/models/notexpression.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfiltername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfilterfiltervaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdoublevalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfiltervaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterint64value.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfromvalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfilterfilter4tovaluevaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterdoublevalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfilterfilter4valuetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterint64value.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltertovalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterbetweenfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2filtername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervalidenums.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsvaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2doublevalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2valuetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2int64value.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilternumericfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterfiltername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterinlistfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfiltername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2validenums.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterstringfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfilter.md + - docs/models/sourcegoogleanalyticsdataapiexpression.md + - docs/models/sourcegoogleanalyticsdataapifiltertype.md + - docs/models/orgroup.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilterfiltername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfiltervaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsdoublevalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfiltervaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsint64value.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayfromvalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilter4tovaluevaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterdoublevalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilter4valuetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterint64value.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraytovalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraybetweenfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfiltername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsvalidenums.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsvaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1doublevalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1valuetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1int64value.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayvalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraynumericfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfiltername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayinlistfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1filtername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1validenums.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraystringfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1filter.md + - docs/models/expression.md + - docs/models/filtertype.md + - docs/models/andgroup.md + - docs/models/dimensionsfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfiltername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtervaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterdoublevalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4valuetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterint64value.md + - docs/models/sourcegoogleanalyticsdataapifromvalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfilter4valuetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterdoublevalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfiltervaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterint64value.md + - docs/models/sourcegoogleanalyticsdataapitovalue.md + - docs/models/sourcegoogleanalyticsdataapibetweenfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervalidenums.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydoublevalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayint64value.md + - docs/models/sourcegoogleanalyticsdataapivalue.md + - docs/models/sourcegoogleanalyticsdataapinumericfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfiltername.md + - docs/models/sourcegoogleanalyticsdataapiinlistfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfiltername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayvalidenums.md + - docs/models/sourcegoogleanalyticsdataapistringfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtertype.md + - docs/models/sourcegoogleanalyticsdataapifilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilterfiltername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfiltervaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressiondoublevalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfiltervaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionint64value.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3fromvalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilter4tovaluevaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterdoublevalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilter4valuetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterint64value.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3tovalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3betweenfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfiltername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionvalidenums.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionvaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3doublevalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3valuetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3int64value.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3value.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3numericfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfiltername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3inlistfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filtername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3validenums.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3stringfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterexpression.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filtertype.md + - docs/models/sourcegoogleanalyticsdataapinotexpression.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilterfiltername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfiltervaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsdoublevalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfiltervaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsint64value.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfromvalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilter4tovaluevaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterdoublevalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilter4valuetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterint64value.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltertovalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterbetweenfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfiltername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsvalidenums.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsvaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2doublevalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2valuetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2int64value.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilternumericfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfiltername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterinlistfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2filtername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2validenums.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterstringfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterexpression.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfiltertype.md + - docs/models/sourcegoogleanalyticsdataapiorgroup.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfiltername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsvaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterdoublevalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1valuetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterint64value.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfromvalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfiltervaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1doublevalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfiltervaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1int64value.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltertovalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterbetweenfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1filtername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervalidenums.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilter3valuevaluetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsdoublevalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilter3valuetype.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsint64value.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervalue.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilternumericfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilterfiltername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterinlistfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfiltername.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1validenums.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterstringfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfilter.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayexpression.md + - docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfiltertype.md + - docs/models/sourcegoogleanalyticsdataapiandgroup.md + - docs/models/metricsfilter.md + - docs/models/sourcegoogleanalyticsdataapicustomreportconfig.md + - docs/models/sourcegoogleanalyticsdataapigoogleanalyticsdataapi.md + - docs/models/sourcegoogleanalyticsdataapi.md + - docs/models/sourcegoogleanalyticsv4serviceaccountonlyauthtype.md + - docs/models/sourcegoogleanalyticsv4serviceaccountonlyserviceaccountkeyauthentication.md + - docs/models/sourcegoogleanalyticsv4serviceaccountonlycredentials.md + - docs/models/googleanalyticsv4serviceaccountonly.md + - docs/models/sourcegoogleanalyticsv4serviceaccountonly.md + - docs/models/sourcegoogledirectoryschemascredentialstitle.md + - docs/models/serviceaccountkey.md + - docs/models/sourcegoogledirectorycredentialstitle.md + - docs/models/signinviagoogleoauth.md + - docs/models/sourcegoogledirectorygooglecredentials.md + - docs/models/googledirectory.md + - docs/models/sourcegoogledirectory.md + - docs/models/sourcegoogledriveschemasauthtype.md + - docs/models/sourcegoogledriveserviceaccountkeyauthentication.md + - docs/models/sourcegoogledriveauthtype.md + - docs/models/sourcegoogledriveauthenticateviagoogleoauth.md + - docs/models/sourcegoogledriveauthentication.md + - docs/models/sourcegoogledrivegoogledrive.md + - docs/models/sourcegoogledriveschemasstreamsformatformatfiletype.md + - docs/models/sourcegoogledrivemode.md + - docs/models/sourcegoogledrivelocal.md + - docs/models/sourcegoogledriveprocessing.md + - docs/models/sourcegoogledriveparsingstrategy.md + - docs/models/sourcegoogledrivedocumentfiletypeformatexperimental.md + - docs/models/sourcegoogledriveschemasstreamsformatfiletype.md + - docs/models/sourcegoogledriveparquetformat.md + - docs/models/sourcegoogledriveschemasstreamsfiletype.md + - docs/models/sourcegoogledrivejsonlformat.md + - docs/models/sourcegoogledriveschemasfiletype.md + - docs/models/sourcegoogledriveschemasstreamsheaderdefinitiontype.md + - docs/models/sourcegoogledriveuserprovided.md + - docs/models/sourcegoogledriveschemasheaderdefinitiontype.md + - docs/models/sourcegoogledriveautogenerated.md + - docs/models/sourcegoogledriveheaderdefinitiontype.md + - docs/models/sourcegoogledrivefromcsv.md + - docs/models/sourcegoogledrivecsvheaderdefinition.md + - docs/models/sourcegoogledrivecsvformat.md + - docs/models/sourcegoogledrivefiletype.md + - docs/models/sourcegoogledriveavroformat.md + - docs/models/sourcegoogledriveformat.md + - docs/models/sourcegoogledrivevalidationpolicy.md + - docs/models/sourcegoogledrivefilebasedstreamconfig.md + - docs/models/sourcegoogledrive.md + - docs/models/categories.md + - docs/models/googlepagespeedinsights.md + - docs/models/strategies.md + - docs/models/sourcegooglepagespeedinsights.md + - docs/models/sourcegooglesearchconsoleschemasauthtype.md + - docs/models/sourcegooglesearchconsoleserviceaccountkeyauthentication.md + - docs/models/sourcegooglesearchconsoleauthtype.md + - docs/models/sourcegooglesearchconsoleoauth.md + - docs/models/authenticationtype.md + - docs/models/sourcegooglesearchconsolevalidenums.md + - docs/models/sourcegooglesearchconsolecustomreportconfig.md + - docs/models/datafreshness.md + - docs/models/sourcegooglesearchconsolegooglesearchconsole.md + - docs/models/sourcegooglesearchconsole.md + - docs/models/sourcegooglesheetsschemasauthtype.md + - docs/models/sourcegooglesheetsserviceaccountkeyauthentication.md + - docs/models/sourcegooglesheetsauthtype.md + - docs/models/sourcegooglesheetsauthenticateviagoogleoauth.md + - docs/models/sourcegooglesheetsauthentication.md + - docs/models/sourcegooglesheetsgooglesheets.md + - docs/models/sourcegooglesheets.md + - docs/models/googlewebfonts.md + - docs/models/sourcegooglewebfonts.md + - docs/models/greenhouse.md + - docs/models/sourcegreenhouse.md + - docs/models/gridly.md + - docs/models/sourcegridly.md + - docs/models/sourceharvestschemasauthtype.md + - docs/models/sourceharvestauthenticatewithpersonalaccesstoken.md + - docs/models/sourceharvestauthtype.md + - docs/models/authenticateviaharvestoauth.md + - docs/models/sourceharvestauthenticationmechanism.md + - docs/models/sourceharvestharvest.md + - docs/models/sourceharvest.md + - docs/models/hubplanner.md + - docs/models/sourcehubplanner.md + - docs/models/sourcehubspotschemasauthtype.md + - docs/models/privateapp.md + - docs/models/sourcehubspotauthtype.md + - docs/models/sourcehubspotoauth.md + - docs/models/sourcehubspotauthentication.md + - docs/models/sourcehubspothubspot.md + - docs/models/sourcehubspot.md + - docs/models/insightly.md + - docs/models/sourceinsightly.md + - docs/models/sourceinstagraminstagram.md + - docs/models/sourceinstagram.md + - docs/models/instatus.md + - docs/models/sourceinstatus.md + - docs/models/sourceintercomintercom.md + - docs/models/sourceintercom.md + - docs/models/ip2whois.md + - docs/models/sourceip2whois.md + - docs/models/iterable.md + - docs/models/sourceiterable.md + - docs/models/issuesstreamexpandwith.md + - docs/models/jira.md + - docs/models/sourcejira.md + - docs/models/k6cloud.md + - docs/models/sourcek6cloud.md + - docs/models/sourceklarnaregion.md + - docs/models/klarna.md + - docs/models/sourceklarna.md + - docs/models/klaviyo.md + - docs/models/sourceklaviyo.md + - docs/models/kyve.md + - docs/models/sourcekyve.md + - docs/models/launchdarkly.md + - docs/models/sourcelaunchdarkly.md + - docs/models/lemlist.md + - docs/models/sourcelemlist.md + - docs/models/sourceleverhiringschemasauthtype.md + - docs/models/authenticatevialeverapikey.md + - docs/models/sourceleverhiringauthtype.md + - docs/models/authenticatevialeveroauth.md + - docs/models/sourceleverhiringauthenticationmechanism.md + - docs/models/sourceleverhiringenvironment.md + - docs/models/sourceleverhiringleverhiring.md + - docs/models/sourceleverhiring.md + - docs/models/pivotcategory.md + - docs/models/timegranularity.md + - docs/models/adanalyticsreportconfiguration.md + - docs/models/sourcelinkedinadsschemasauthmethod.md + - docs/models/accesstoken.md + - docs/models/sourcelinkedinadsauthmethod.md + - docs/models/sourcelinkedinadsoauth20.md + - docs/models/sourcelinkedinadsauthentication.md + - docs/models/sourcelinkedinadslinkedinads.md + - docs/models/sourcelinkedinads.md + - docs/models/sourcelinkedinpagesschemasauthmethod.md + - docs/models/sourcelinkedinpagesaccesstoken.md + - docs/models/sourcelinkedinpagesauthmethod.md + - docs/models/sourcelinkedinpagesoauth20.md + - docs/models/sourcelinkedinpagesauthentication.md + - docs/models/linkedinpages.md + - docs/models/sourcelinkedinpages.md + - docs/models/linnworks.md + - docs/models/sourcelinnworks.md + - docs/models/lokalise.md + - docs/models/sourcelokalise.md + - docs/models/sourcemailchimpschemasauthtype.md + - docs/models/apikey.md + - docs/models/sourcemailchimpauthtype.md + - docs/models/sourcemailchimpoauth20.md + - docs/models/sourcemailchimpauthentication.md + - docs/models/sourcemailchimpmailchimp.md + - docs/models/sourcemailchimp.md + - docs/models/mailgun.md + - docs/models/sourcemailgun.md + - docs/models/mailjetsms.md + - docs/models/sourcemailjetsms.md + - docs/models/marketo.md + - docs/models/sourcemarketo.md + - docs/models/metabase.md + - docs/models/sourcemetabase.md + - docs/models/sourcemicrosoftonedriveschemasauthtype.md + - docs/models/servicekeyauthentication.md + - docs/models/sourcemicrosoftonedriveauthtype.md + - docs/models/authenticateviamicrosoftoauth.md + - docs/models/sourcemicrosoftonedriveauthentication.md + - docs/models/searchscope.md + - docs/models/sourcemicrosoftonedrivemicrosoftonedrive.md + - docs/models/sourcemicrosoftonedriveschemasstreamsformatformatfiletype.md + - docs/models/sourcemicrosoftonedrivemode.md + - docs/models/sourcemicrosoftonedrivelocal.md + - docs/models/sourcemicrosoftonedriveprocessing.md + - docs/models/sourcemicrosoftonedriveparsingstrategy.md + - docs/models/sourcemicrosoftonedrivedocumentfiletypeformatexperimental.md + - docs/models/sourcemicrosoftonedriveschemasstreamsformatfiletype.md + - docs/models/sourcemicrosoftonedriveparquetformat.md + - docs/models/sourcemicrosoftonedriveschemasstreamsfiletype.md + - docs/models/sourcemicrosoftonedrivejsonlformat.md + - docs/models/sourcemicrosoftonedriveschemasfiletype.md + - docs/models/sourcemicrosoftonedriveschemasstreamsheaderdefinitiontype.md + - docs/models/sourcemicrosoftonedriveuserprovided.md + - docs/models/sourcemicrosoftonedriveschemasheaderdefinitiontype.md + - docs/models/sourcemicrosoftonedriveautogenerated.md + - docs/models/sourcemicrosoftonedriveheaderdefinitiontype.md + - docs/models/sourcemicrosoftonedrivefromcsv.md + - docs/models/sourcemicrosoftonedrivecsvheaderdefinition.md + - docs/models/sourcemicrosoftonedrivecsvformat.md + - docs/models/sourcemicrosoftonedrivefiletype.md + - docs/models/sourcemicrosoftonedriveavroformat.md + - docs/models/sourcemicrosoftonedriveformat.md + - docs/models/sourcemicrosoftonedrivevalidationpolicy.md + - docs/models/sourcemicrosoftonedrivefilebasedstreamconfig.md + - docs/models/sourcemicrosoftonedrive.md + - docs/models/sourcemicrosoftsharepointschemasauthtype.md + - docs/models/sourcemicrosoftsharepointservicekeyauthentication.md + - docs/models/sourcemicrosoftsharepointauthtype.md + - docs/models/sourcemicrosoftsharepointauthenticateviamicrosoftoauth.md + - docs/models/sourcemicrosoftsharepointauthentication.md + - docs/models/sourcemicrosoftsharepointsearchscope.md + - docs/models/sourcemicrosoftsharepointmicrosoftsharepoint.md + - docs/models/sourcemicrosoftsharepointschemasstreamsformatformatfiletype.md + - docs/models/sourcemicrosoftsharepointmode.md + - docs/models/sourcemicrosoftsharepointlocal.md + - docs/models/sourcemicrosoftsharepointprocessing.md + - docs/models/sourcemicrosoftsharepointparsingstrategy.md + - docs/models/sourcemicrosoftsharepointdocumentfiletypeformatexperimental.md + - docs/models/sourcemicrosoftsharepointschemasstreamsformatfiletype.md + - docs/models/sourcemicrosoftsharepointparquetformat.md + - docs/models/sourcemicrosoftsharepointschemasstreamsfiletype.md + - docs/models/sourcemicrosoftsharepointjsonlformat.md + - docs/models/sourcemicrosoftsharepointschemasfiletype.md + - docs/models/sourcemicrosoftsharepointschemasstreamsheaderdefinitiontype.md + - docs/models/sourcemicrosoftsharepointuserprovided.md + - docs/models/sourcemicrosoftsharepointschemasheaderdefinitiontype.md + - docs/models/sourcemicrosoftsharepointautogenerated.md + - docs/models/sourcemicrosoftsharepointheaderdefinitiontype.md + - docs/models/sourcemicrosoftsharepointfromcsv.md + - docs/models/sourcemicrosoftsharepointcsvheaderdefinition.md + - docs/models/sourcemicrosoftsharepointcsvformat.md + - docs/models/sourcemicrosoftsharepointfiletype.md + - docs/models/sourcemicrosoftsharepointavroformat.md + - docs/models/sourcemicrosoftsharepointformat.md + - docs/models/sourcemicrosoftsharepointvalidationpolicy.md + - docs/models/sourcemicrosoftsharepointfilebasedstreamconfig.md + - docs/models/sourcemicrosoftsharepoint.md + - docs/models/sourcemicrosoftteamsschemasauthtype.md + - docs/models/authenticateviamicrosoft.md + - docs/models/sourcemicrosoftteamsauthtype.md + - docs/models/authenticateviamicrosoftoauth20.md + - docs/models/sourcemicrosoftteamsauthenticationmechanism.md + - docs/models/sourcemicrosoftteamsmicrosoftteams.md + - docs/models/sourcemicrosoftteams.md + - docs/models/sourcemixpanelschemasoptiontitle.md + - docs/models/projectsecret.md + - docs/models/sourcemixpaneloptiontitle.md + - docs/models/serviceaccount.md + - docs/models/authenticationwildcard.md + - docs/models/sourcemixpanelregion.md + - docs/models/mixpanel.md + - docs/models/sourcemixpanel.md + - docs/models/sourcemondayschemasauthtype.md + - docs/models/apitoken.md + - docs/models/sourcemondayauthtype.md + - docs/models/sourcemondayoauth20.md + - docs/models/sourcemondayauthorizationmethod.md + - docs/models/sourcemondaymonday.md + - docs/models/sourcemonday.md + - docs/models/mongodbinternalpoc.md + - docs/models/sourcemongodbinternalpoc.md + - docs/models/sourcemongodbv2schemasclustertype.md + - docs/models/selfmanagedreplicaset.md + - docs/models/sourcemongodbv2clustertype.md + - docs/models/mongodbatlasreplicaset.md + - docs/models/clustertype.md + - docs/models/invalidcdcpositionbehavioradvanced.md + - docs/models/mongodbv2.md + - docs/models/sourcemongodbv2.md + - docs/models/sourcemssqlschemasmethod.md + - docs/models/scanchangeswithuserdefinedcursor.md + - docs/models/sourcemssqlinvalidcdcpositionbehavioradvanced.md + - docs/models/sourcemssqlmethod.md + - docs/models/readchangesusingchangedatacapturecdc.md + - docs/models/updatemethod.md + - docs/models/sourcemssqlmssql.md + - docs/models/sourcemssqlschemassslmethodsslmethodsslmethod.md + - docs/models/sourcemssqlencryptedverifycertificate.md + - docs/models/sourcemssqlschemassslmethodsslmethod.md + - docs/models/sourcemssqlencryptedtrustservercertificate.md + - docs/models/sourcemssqlschemassslmethod.md + - docs/models/unencrypted.md + - docs/models/sourcemssqlsslmethod.md + - docs/models/sourcemssqlschemastunnelmethodtunnelmethod.md + - docs/models/sourcemssqlpasswordauthentication.md + - docs/models/sourcemssqlschemastunnelmethod.md + - docs/models/sourcemssqlsshkeyauthentication.md + - docs/models/sourcemssqltunnelmethod.md + - docs/models/sourcemssqlnotunnel.md + - docs/models/sourcemssqlsshtunnelmethod.md + - docs/models/sourcemssql.md + - docs/models/myhours.md + - docs/models/sourcemyhours.md + - docs/models/sourcemysqlschemasmethod.md + - docs/models/sourcemysqlscanchangeswithuserdefinedcursor.md + - docs/models/sourcemysqlinvalidcdcpositionbehavioradvanced.md + - docs/models/sourcemysqlmethod.md + - docs/models/readchangesusingbinarylogcdc.md + - docs/models/sourcemysqlupdatemethod.md + - docs/models/sourcemysqlmysql.md + - docs/models/sourcemysqlschemassslmodesslmodesmode.md + - docs/models/verifyidentity.md + - docs/models/sourcemysqlschemassslmodemode.md + - docs/models/sourcemysqlverifyca.md + - docs/models/sourcemysqlschemasmode.md + - docs/models/required.md + - docs/models/sourcemysqlmode.md + - docs/models/preferred.md + - docs/models/sourcemysqlsslmodes.md + - docs/models/sourcemysqlschemastunnelmethodtunnelmethod.md + - docs/models/sourcemysqlpasswordauthentication.md + - docs/models/sourcemysqlschemastunnelmethod.md + - docs/models/sourcemysqlsshkeyauthentication.md + - docs/models/sourcemysqltunnelmethod.md + - docs/models/sourcemysqlnotunnel.md + - docs/models/sourcemysqlsshtunnelmethod.md + - docs/models/sourcemysql.md + - docs/models/netsuite.md + - docs/models/sourcenetsuite.md + - docs/models/sourcenotionschemasauthtype.md + - docs/models/sourcenotionaccesstoken.md + - docs/models/sourcenotionauthtype.md + - docs/models/sourcenotionoauth20.md + - docs/models/sourcenotionauthenticationmethod.md + - docs/models/sourcenotionnotion.md + - docs/models/sourcenotion.md + - docs/models/periodusedformostpopularstreams.md + - docs/models/sharetypeusedformostpopularsharedstream.md + - docs/models/nytimes.md + - docs/models/sourcenytimes.md + - docs/models/sourceoktaschemasauthtype.md + - docs/models/sourceoktaapitoken.md + - docs/models/sourceoktaauthtype.md + - docs/models/sourceoktaoauth20.md + - docs/models/sourceoktaauthorizationmethod.md + - docs/models/okta.md + - docs/models/sourceokta.md + - docs/models/omnisend.md + - docs/models/sourceomnisend.md + - docs/models/applications.md + - docs/models/onesignal.md + - docs/models/sourceonesignal.md + - docs/models/sourceoracleconnectiontype.md + - docs/models/systemidsid.md + - docs/models/connectiontype.md + - docs/models/servicename.md + - docs/models/connectby.md + - docs/models/sourceoracleencryptionmethod.md + - docs/models/tlsencryptedverifycertificate.md + - docs/models/encryptionalgorithm.md + - docs/models/encryptionmethod.md + - docs/models/nativenetworkencryptionnne.md + - docs/models/encryption.md + - docs/models/sourceoracleoracle.md + - docs/models/sourceoracleschemastunnelmethodtunnelmethod.md + - docs/models/sourceoraclepasswordauthentication.md + - docs/models/sourceoracleschemastunnelmethod.md + - docs/models/sourceoraclesshkeyauthentication.md + - docs/models/sourceoracletunnelmethod.md + - docs/models/sourceoraclenotunnel.md + - docs/models/sourceoraclesshtunnelmethod.md + - docs/models/sourceoracle.md + - docs/models/orb.md + - docs/models/sourceorb.md + - docs/models/orbit.md + - docs/models/sourceorbit.md + - docs/models/bothusernameandpasswordisrequiredforauthenticationrequest.md + - docs/models/sourceoutbrainamplifyusernamepassword.md + - docs/models/accesstokenisrequiredforauthenticationrequests.md + - docs/models/sourceoutbrainamplifyaccesstoken.md + - docs/models/sourceoutbrainamplifyauthenticationmethod.md + - docs/models/granularityforgeolocationregion.md + - docs/models/granularityforperiodicreports.md + - docs/models/outbrainamplify.md + - docs/models/sourceoutbrainamplify.md + - docs/models/outreach.md + - docs/models/sourceoutreach.md + - docs/models/paypaltransaction.md + - docs/models/sourcepaypaltransaction.md + - docs/models/paystack.md + - docs/models/sourcepaystack.md + - docs/models/pendo.md + - docs/models/sourcependo.md + - docs/models/persistiq.md + - docs/models/sourcepersistiq.md + - docs/models/pexelsapi.md + - docs/models/sourcepexelsapi.md + - docs/models/sourcepinterestauthmethod.md + - docs/models/oauth20.md + - docs/models/sourcepinterestvalidenums.md + - docs/models/clickwindowdays.md + - docs/models/sourcepinterestschemasvalidenums.md + - docs/models/conversionreporttime.md + - docs/models/engagementwindowdays.md + - docs/models/granularity.md + - docs/models/sourcepinterestlevel.md + - docs/models/viewwindowdays.md + - docs/models/reportconfig.md + - docs/models/sourcepinterestpinterest.md + - docs/models/status.md + - docs/models/sourcepinterest.md + - docs/models/pipedrive.md + - docs/models/sourcepipedrive.md + - docs/models/contenttype.md + - docs/models/detailtype.md + - docs/models/sourcepocketsortby.md + - docs/models/pocket.md + - docs/models/state.md + - docs/models/sourcepocket.md + - docs/models/pokemonname.md + - docs/models/pokeapi.md + - docs/models/sourcepokeapi.md + - docs/models/polygonstockapi.md + - docs/models/sourcepolygonstockapi.md + - docs/models/sourcepostgresschemasreplicationmethodmethod.md + - docs/models/sourcepostgresscanchangeswithuserdefinedcursor.md + - docs/models/sourcepostgresschemasmethod.md + - docs/models/detectchangeswithxminsystemcolumn.md + - docs/models/sourcepostgresinvalidcdcpositionbehavioradvanced.md + - docs/models/lsncommitbehaviour.md + - docs/models/sourcepostgresmethod.md + - docs/models/plugin.md + - docs/models/readchangesusingwriteaheadlogcdc.md + - docs/models/sourcepostgresupdatemethod.md + - docs/models/sourcepostgrespostgres.md + - docs/models/sourcepostgresschemassslmodesslmodes6mode.md + - docs/models/sourcepostgresverifyfull.md + - docs/models/sourcepostgresschemassslmodesslmodes5mode.md + - docs/models/sourcepostgresverifyca.md + - docs/models/sourcepostgresschemassslmodesslmodesmode.md + - docs/models/sourcepostgresrequire.md + - docs/models/sourcepostgresschemassslmodemode.md + - docs/models/sourcepostgresprefer.md + - docs/models/sourcepostgresschemasmode.md + - docs/models/sourcepostgresallow.md + - docs/models/sourcepostgresmode.md + - docs/models/sourcepostgresdisable.md + - docs/models/sourcepostgressslmodes.md + - docs/models/sourcepostgresschemastunnelmethodtunnelmethod.md + - docs/models/sourcepostgrespasswordauthentication.md + - docs/models/sourcepostgresschemastunnelmethod.md + - docs/models/sourcepostgressshkeyauthentication.md + - docs/models/sourcepostgrestunnelmethod.md + - docs/models/sourcepostgresnotunnel.md + - docs/models/sourcepostgressshtunnelmethod.md + - docs/models/sourcepostgres.md + - docs/models/posthog.md + - docs/models/sourceposthog.md + - docs/models/postmarkapp.md + - docs/models/sourcepostmarkapp.md + - docs/models/prestashop.md + - docs/models/sourceprestashop.md + - docs/models/punkapi.md + - docs/models/sourcepunkapi.md + - docs/models/pypi.md + - docs/models/sourcepypi.md + - docs/models/qualaroo.md + - docs/models/sourcequalaroo.md + - docs/models/sourcequickbooksauthtype.md + - docs/models/sourcequickbooksoauth20.md + - docs/models/sourcequickbooksauthorizationmethod.md + - docs/models/quickbooks.md + - docs/models/sourcequickbooks.md + - docs/models/railz.md + - docs/models/sourcerailz.md + - docs/models/recharge.md + - docs/models/sourcerecharge.md + - docs/models/recreation.md + - docs/models/sourcerecreation.md + - docs/models/recruitee.md + - docs/models/sourcerecruitee.md + - docs/models/recurly.md + - docs/models/sourcerecurly.md + - docs/models/sourceredshiftredshift.md + - docs/models/sourceredshift.md + - docs/models/sourceretentlyschemasauthtype.md + - docs/models/authenticatewithapitoken.md + - docs/models/sourceretentlyauthtype.md + - docs/models/authenticateviaretentlyoauth.md + - docs/models/sourceretentlyauthenticationmechanism.md + - docs/models/sourceretentlyretently.md + - docs/models/sourceretently.md + - docs/models/rkicovid.md + - docs/models/sourcerkicovid.md + - docs/models/rss.md + - docs/models/sourcerss.md + - docs/models/sources3schemasformatfiletype.md + - docs/models/unexpectedfieldbehavior.md + - docs/models/jsonl.md + - docs/models/sources3schemasfiletype.md + - docs/models/avro.md + - docs/models/sources3filetype.md + - docs/models/parquet.md + - docs/models/sources3schemasformatfileformatfiletype.md + - docs/models/csv.md + - docs/models/sources3fileformat.md + - docs/models/s3amazonwebservices.md + - docs/models/sources3s3.md + - docs/models/sources3schemasstreamsformatformat5filetype.md + - docs/models/sources3mode.md + - docs/models/sources3local.md + - docs/models/sources3processing.md + - docs/models/sources3parsingstrategy.md + - docs/models/sources3documentfiletypeformatexperimental.md + - docs/models/sources3schemasstreamsformatformat4filetype.md + - docs/models/sources3parquetformat.md + - docs/models/sources3schemasstreamsformatformatfiletype.md + - docs/models/sources3jsonlformat.md + - docs/models/sources3schemasstreamsformatfiletype.md + - docs/models/sources3schemasstreamsheaderdefinitiontype.md + - docs/models/sources3userprovided.md + - docs/models/sources3schemasheaderdefinitiontype.md + - docs/models/sources3autogenerated.md + - docs/models/sources3headerdefinitiontype.md + - docs/models/sources3fromcsv.md + - docs/models/sources3csvheaderdefinition.md + - docs/models/sources3inferencetype.md + - docs/models/sources3csvformat.md + - docs/models/sources3schemasstreamsfiletype.md + - docs/models/sources3avroformat.md + - docs/models/sources3format.md + - docs/models/sources3validationpolicy.md + - docs/models/sources3filebasedstreamconfig.md + - docs/models/sources3.md + - docs/models/authtype.md + - docs/models/sourcesalesforcesalesforce.md + - docs/models/searchcriteria.md + - docs/models/streamscriteria.md + - docs/models/sourcesalesforce.md + - docs/models/sourcesalesloftschemasauthtype.md + - docs/models/authenticateviaapikey.md + - docs/models/sourcesalesloftauthtype.md + - docs/models/authenticateviaoauth.md + - docs/models/sourcesalesloftcredentials.md + - docs/models/salesloft.md + - docs/models/sourcesalesloft.md + - docs/models/sapfieldglass.md + - docs/models/sourcesapfieldglass.md + - docs/models/secoda.md + - docs/models/sourcesecoda.md + - docs/models/sendgrid.md + - docs/models/sourcesendgrid.md + - docs/models/sendinblue.md + - docs/models/sourcesendinblue.md + - docs/models/senseforce.md + - docs/models/sourcesenseforce.md + - docs/models/sentry.md + - docs/models/sourcesentry.md + - docs/models/sourcesftpschemasauthmethod.md + - docs/models/sourcesftpsshkeyauthentication.md + - docs/models/sourcesftpauthmethod.md + - docs/models/sourcesftppasswordauthentication.md + - docs/models/sourcesftpauthentication.md + - docs/models/sftp.md + - docs/models/sourcesftp.md + - docs/models/filetype.md + - docs/models/sftpbulk.md + - docs/models/sourcesftpbulk.md + - docs/models/sourceshopifyschemasauthmethod.md + - docs/models/apipassword.md + - docs/models/sourceshopifyauthmethod.md + - docs/models/sourceshopifyoauth20.md + - docs/models/shopifyauthorizationmethod.md + - docs/models/sourceshopifyshopify.md + - docs/models/sourceshopify.md + - docs/models/shortio.md + - docs/models/sourceshortio.md + - docs/models/sourceslackschemasoptiontitle.md + - docs/models/sourceslackapitoken.md + - docs/models/sourceslackoptiontitle.md + - docs/models/signinviaslackoauth.md + - docs/models/sourceslackauthenticationmechanism.md + - docs/models/sourceslackslack.md + - docs/models/sourceslack.md + - docs/models/smaily.md + - docs/models/sourcesmaily.md + - docs/models/smartengage.md + - docs/models/sourcesmartengage.md + - docs/models/sourcesmartsheetsschemasauthtype.md + - docs/models/apiaccesstoken.md + - docs/models/sourcesmartsheetsauthtype.md + - docs/models/sourcesmartsheetsoauth20.md + - docs/models/sourcesmartsheetsauthorizationmethod.md + - docs/models/validenums.md + - docs/models/sourcesmartsheetssmartsheets.md + - docs/models/sourcesmartsheets.md + - docs/models/actionreporttime.md + - docs/models/sourcesnapchatmarketingsnapchatmarketing.md + - docs/models/swipeupattributionwindow.md + - docs/models/viewattributionwindow.md + - docs/models/sourcesnapchatmarketing.md + - docs/models/sourcesnowflakeschemasauthtype.md + - docs/models/sourcesnowflakeusernameandpassword.md + - docs/models/sourcesnowflakeauthtype.md + - docs/models/sourcesnowflakeoauth20.md + - docs/models/sourcesnowflakeauthorizationmethod.md + - docs/models/sourcesnowflakesnowflake.md + - docs/models/sourcesnowflake.md + - docs/models/sonarcloud.md + - docs/models/sourcesonarcloud.md + - docs/models/spacexapi.md + - docs/models/sourcespacexapi.md + - docs/models/sourcesquareschemasauthtype.md + - docs/models/sourcesquareapikey.md + - docs/models/sourcesquareauthtype.md + - docs/models/oauthauthentication.md + - docs/models/sourcesquareauthentication.md + - docs/models/sourcesquaresquare.md + - docs/models/sourcesquare.md + - docs/models/sourcestravaauthtype.md + - docs/models/sourcestravastrava.md + - docs/models/sourcestrava.md + - docs/models/stripe.md + - docs/models/sourcestripe.md + - docs/models/sourcesurveysparrowurlbase.md + - docs/models/globalaccount.md + - docs/models/urlbase.md + - docs/models/eubasedaccount.md + - docs/models/baseurl.md + - docs/models/surveysparrow.md + - docs/models/sourcesurveysparrow.md + - docs/models/sourcesurveymonkeyauthmethod.md + - docs/models/surveymonkeyauthorizationmethod.md + - docs/models/origindatacenterofthesurveymonkeyaccount.md + - docs/models/sourcesurveymonkeysurveymonkey.md + - docs/models/sourcesurveymonkey.md + - docs/models/tempo.md + - docs/models/sourcetempo.md + - docs/models/theguardianapi.md + - docs/models/sourcetheguardianapi.md + - docs/models/sourcetiktokmarketingschemasauthtype.md + - docs/models/sandboxaccesstoken.md + - docs/models/sourcetiktokmarketingauthtype.md + - docs/models/sourcetiktokmarketingoauth20.md + - docs/models/sourcetiktokmarketingauthenticationmethod.md + - docs/models/sourcetiktokmarketingtiktokmarketing.md + - docs/models/sourcetiktokmarketing.md + - docs/models/trello.md + - docs/models/sourcetrello.md + - docs/models/sourcetrustpilotschemasauthtype.md + - docs/models/sourcetrustpilotapikey.md + - docs/models/sourcetrustpilotauthtype.md + - docs/models/sourcetrustpilotoauth20.md + - docs/models/sourcetrustpilotauthorizationmethod.md + - docs/models/trustpilot.md + - docs/models/sourcetrustpilot.md + - docs/models/tvmazeschedule.md + - docs/models/sourcetvmazeschedule.md + - docs/models/twilio.md + - docs/models/sourcetwilio.md + - docs/models/twiliotaskrouter.md + - docs/models/sourcetwiliotaskrouter.md + - docs/models/twitter.md + - docs/models/sourcetwitter.md + - docs/models/sourcetypeformschemasauthtype.md + - docs/models/sourcetypeformprivatetoken.md + - docs/models/sourcetypeformauthtype.md + - docs/models/sourcetypeformoauth20.md + - docs/models/sourcetypeformauthorizationmethod.md + - docs/models/sourcetypeformtypeform.md + - docs/models/sourcetypeform.md + - docs/models/uscensus.md + - docs/models/sourceuscensus.md + - docs/models/vantage.md + - docs/models/sourcevantage.md + - docs/models/webflow.md + - docs/models/sourcewebflow.md + - docs/models/whiskyhunter.md + - docs/models/sourcewhiskyhunter.md + - docs/models/wikipediapageviews.md + - docs/models/sourcewikipediapageviews.md + - docs/models/woocommerce.md + - docs/models/sourcewoocommerce.md + - docs/models/xkcd.md + - docs/models/sourcexkcd.md + - docs/models/yandexmetrica.md + - docs/models/sourceyandexmetrica.md + - docs/models/yotpo.md + - docs/models/sourceyotpo.md + - docs/models/authenticateviaoauth20.md + - docs/models/sourceyoutubeanalyticsyoutubeanalytics.md + - docs/models/sourceyoutubeanalytics.md + - docs/models/sourcezendeskchatschemascredentials.md + - docs/models/sourcezendeskchataccesstoken.md + - docs/models/sourcezendeskchatcredentials.md + - docs/models/sourcezendeskchatoauth20.md + - docs/models/sourcezendeskchatauthorizationmethod.md + - docs/models/sourcezendeskchatzendeskchat.md + - docs/models/sourcezendeskchat.md + - docs/models/zendesksell.md + - docs/models/sourcezendesksell.md + - docs/models/sourcezendesksunshineschemasauthmethod.md + - docs/models/sourcezendesksunshineapitoken.md + - docs/models/sourcezendesksunshineauthmethod.md + - docs/models/sourcezendesksunshineoauth20.md + - docs/models/sourcezendesksunshineauthorizationmethod.md + - docs/models/sourcezendesksunshinezendesksunshine.md + - docs/models/sourcezendesksunshine.md + - docs/models/sourcezendesksupportschemascredentials.md + - docs/models/sourcezendesksupportapitoken.md + - docs/models/sourcezendesksupportcredentials.md + - docs/models/sourcezendesksupportoauth20.md + - docs/models/sourcezendesksupportauthentication.md + - docs/models/sourcezendesksupportzendesksupport.md + - docs/models/sourcezendesksupport.md + - docs/models/sourcezendesktalkschemasauthtype.md + - docs/models/sourcezendesktalkapitoken.md + - docs/models/sourcezendesktalkauthtype.md + - docs/models/sourcezendesktalkoauth20.md + - docs/models/sourcezendesktalkauthentication.md + - docs/models/sourcezendesktalkzendesktalk.md + - docs/models/sourcezendesktalk.md + - docs/models/zenloop.md + - docs/models/sourcezenloop.md + - docs/models/datacenterlocation.md + - docs/models/zohocrmedition.md + - docs/models/sourcezohocrmenvironment.md + - docs/models/zohocrm.md + - docs/models/sourcezohocrm.md + - docs/models/zoom.md + - docs/models/sourcezoom.md + - docs/models/sourcecreaterequest.md + - docs/models/initiateoauthrequest.md + - docs/models/oauthactornames.md + - docs/models/oauthinputconfiguration.md + - docs/models/sourcesresponse.md + - docs/models/sourcepatchrequest.md + - docs/models/sourceputrequest.md + - docs/models/streampropertiesresponse.md + - docs/models/streamproperties.md + - docs/models/workspaceoauthcredentialsrequest.md + - docs/models/oauthcredentialsconfiguration.md + - docs/models/credentials.md + - docs/models/airtable.md + - docs/models/amazonads.md + - docs/models/amazonsellerpartner.md + - docs/models/asanacredentials.md + - docs/models/asana.md + - docs/models/bingads.md + - docs/models/facebookmarketing.md + - docs/models/githubcredentials.md + - docs/models/github.md + - docs/models/gitlabcredentials.md + - docs/models/gitlab.md + - docs/models/googleadscredentials.md + - docs/models/googleads.md + - docs/models/googleanalyticsdataapicredentials.md + - docs/models/googleanalyticsdataapi.md + - docs/models/googledrivecredentials.md + - docs/models/googledrive.md + - docs/models/authorization.md + - docs/models/googlesearchconsole.md + - docs/models/googlesheetscredentials.md + - docs/models/googlesheets.md + - docs/models/harvestcredentials.md + - docs/models/harvest.md + - docs/models/hubspotcredentials.md + - docs/models/hubspot.md + - docs/models/instagram.md + - docs/models/intercom.md + - docs/models/leverhiringcredentials.md + - docs/models/leverhiring.md + - docs/models/linkedinadscredentials.md + - docs/models/linkedinads.md + - docs/models/mailchimpcredentials.md + - docs/models/mailchimp.md + - docs/models/microsoftonedrivecredentials.md + - docs/models/microsoftonedrive.md + - docs/models/microsoftsharepointcredentials.md + - docs/models/microsoftsharepoint.md + - docs/models/microsoftteamscredentials.md + - docs/models/microsoftteams.md + - docs/models/mondaycredentials.md + - docs/models/monday.md + - docs/models/notioncredentials.md + - docs/models/notion.md + - docs/models/pinterestcredentials.md + - docs/models/pinterest.md + - docs/models/retentlycredentials.md + - docs/models/retently.md + - docs/models/salesforce.md + - docs/models/shopifycredentials.md + - docs/models/shopify.md + - docs/models/slackcredentials.md + - docs/models/slack.md + - docs/models/smartsheetscredentials.md + - docs/models/smartsheets.md + - docs/models/snapchatmarketing.md + - docs/models/snowflakecredentials.md + - docs/models/snowflake.md + - docs/models/squarecredentials.md + - docs/models/square.md + - docs/models/strava.md + - docs/models/surveymonkeycredentials.md + - docs/models/surveymonkey.md + - docs/models/tiktokmarketingcredentials.md + - docs/models/tiktokmarketing.md + - docs/models/typeformcredentials.md + - docs/models/typeform.md + - docs/models/youtubeanalyticscredentials.md + - docs/models/youtubeanalytics.md + - docs/models/zendeskchatcredentials.md + - docs/models/zendeskchat.md + - docs/models/zendesksunshinecredentials.md + - docs/models/zendesksunshine.md + - docs/models/zendesksupportcredentials.md + - docs/models/zendesksupport.md + - docs/models/zendesktalkcredentials.md + - docs/models/zendesktalk.md + - docs/models/actortypeenum.md + - docs/models/workspaceresponse.md + - docs/models/workspacecreaterequest.md + - docs/models/workspacesresponse.md + - docs/models/workspaceupdaterequest.md + - docs/models/security.md + - docs/models/schemebasicauth.md + - docs/sdks/airbyteapi/README.md - docs/sdks/connections/README.md - docs/sdks/destinations/README.md - docs/sdks/jobs/README.md @@ -2251,3 +2266,6 @@ generatedFiles: - docs/sdks/workspaces/README.md - USAGE.md - .gitattributes + - src/airbyte_api/_hooks/sdkhooks.py + - src/airbyte_api/_hooks/types.py + - src/airbyte_api/_hooks/__init__.py diff --git a/.speakeasy/workflow.yaml b/.speakeasy/workflow.yaml new file mode 100644 index 00000000..2b347bc2 --- /dev/null +++ b/.speakeasy/workflow.yaml @@ -0,0 +1,12 @@ +workflowVersion: 1.0.0 +sources: + my-source: + inputs: + - location: ./airbyte-api.openapi.yaml +targets: + python-api: + target: python + source: my-source + publish: + pypi: + token: $PYPI_TOKEN diff --git a/README.md b/README.md index 415fcefd..9e842325 100755 --- a/README.md +++ b/README.md @@ -27,19 +27,19 @@ pip install airbyte-api ### Example ```python -import airbyte -from airbyte.models import shared +import airbyte_api +from airbyte_api import models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = shared.ConnectionCreateRequest( +req = models.ConnectionCreateRequest( destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', source_id='6dd427d8-3a55-4584-b835-842325b6c7b3', namespace_format='${SOURCE_NAMESPACE}', @@ -50,6 +50,7 @@ res = s.connections.create_connection(req) if res.connection_response is not None: # handle response pass + ``` @@ -117,24 +118,24 @@ Handling errors in this SDK should largely match your expectations. All operati | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | ### Example ```python -import airbyte -from airbyte.models import errors, shared +import airbyte_api +from airbyte_api import errors, models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = shared.ConnectionCreateRequest( +req = models.ConnectionCreateRequest( destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', source_id='6dd427d8-3a55-4584-b835-842325b6c7b3', namespace_format='${SOURCE_NAMESPACE}', @@ -150,6 +151,7 @@ except errors.SDKError as e: if res.connection_response is not None: # handle response pass + ``` @@ -169,20 +171,20 @@ You can override the default server globally by passing a server index to the `s #### Example ```python -import airbyte -from airbyte.models import shared +import airbyte_api +from airbyte_api import models -s = airbyte.Airbyte( +s = airbyte_api.AirbyteAPI( server_idx=0, - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = shared.ConnectionCreateRequest( +req = models.ConnectionCreateRequest( destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', source_id='6dd427d8-3a55-4584-b835-842325b6c7b3', namespace_format='${SOURCE_NAMESPACE}', @@ -193,6 +195,7 @@ res = s.connections.create_connection(req) if res.connection_response is not None: # handle response pass + ``` @@ -200,20 +203,20 @@ if res.connection_response is not None: The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example: ```python -import airbyte -from airbyte.models import shared +import airbyte_api +from airbyte_api import models -s = airbyte.Airbyte( +s = airbyte_api.AirbyteAPI( server_url="https://api.airbyte.com/v1", - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = shared.ConnectionCreateRequest( +req = models.ConnectionCreateRequest( destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', source_id='6dd427d8-3a55-4584-b835-842325b6c7b3', namespace_format='${SOURCE_NAMESPACE}', @@ -224,6 +227,7 @@ res = s.connections.create_connection(req) if res.connection_response is not None: # handle response pass + ``` @@ -236,12 +240,12 @@ The Python SDK makes API calls using the [requests](https://pypi.org/project/req For example, you could specify a header for every request that this sdk makes as follows: ```python -import airbyte +import airbyte_api import requests http_client = requests.Session() http_client.headers.update({'x-custom-header': 'someValue'}) -s = airbyte.Airbyte(client: http_client) +s = airbyte_api.AirbyteAPI(client=http_client) ``` @@ -261,19 +265,19 @@ This SDK supports the following security schemes globally: You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example: ```python -import airbyte -from airbyte.models import shared +import airbyte_api +from airbyte_api import models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = shared.ConnectionCreateRequest( +req = models.ConnectionCreateRequest( destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', source_id='6dd427d8-3a55-4584-b835-842325b6c7b3', namespace_format='${SOURCE_NAMESPACE}', @@ -284,6 +288,7 @@ res = s.connections.create_connection(req) if res.connection_response is not None: # handle response pass + ``` diff --git a/USAGE.md b/USAGE.md index 9140b30c..df95980c 100644 --- a/USAGE.md +++ b/USAGE.md @@ -1,18 +1,18 @@ ```python -import airbyte -from airbyte.models import shared +import airbyte_api +from airbyte_api import models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = shared.ConnectionCreateRequest( +req = models.ConnectionCreateRequest( destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', source_id='6dd427d8-3a55-4584-b835-842325b6c7b3', namespace_format='${SOURCE_NAMESPACE}', @@ -23,5 +23,6 @@ res = s.connections.create_connection(req) if res.connection_response is not None: # handle response pass + ``` \ No newline at end of file diff --git a/airbyte-api.openapi.yaml b/airbyte-api.openapi.yaml new file mode 100644 index 00000000..c1983146 --- /dev/null +++ b/airbyte-api.openapi.yaml @@ -0,0 +1,54210 @@ +--- +openapi: "3.1.0" +info: + title: "airbyte-api" + version: "1.0.0" + description: "Programmatically control Airbyte Cloud, OSS & Enterprise." +servers: +- url: "https://api.airbyte.com/v1" + description: "Airbyte API v1" +paths: + /jobs: + get: + tags: + - "Jobs" + parameters: + - name: "connectionId" + description: "Filter the Jobs by connectionId." + schema: + format: "UUID" + type: "string" + in: "query" + required: false + - name: "limit" + description: "Set the limit on the number of Jobs returned. The default is\ + \ 20 Jobs." + schema: + format: "int32" + default: 20 + maximum: 100 + minimum: 1 + type: "integer" + in: "query" + - name: "offset" + description: "Set the offset to start at when returning Jobs. The default\ + \ is 0." + schema: + format: "int32" + default: 0 + minimum: 0 + type: "integer" + in: "query" + - name: "jobType" + description: "Filter the Jobs by jobType." + schema: + $ref: "#/components/schemas/JobTypeEnum" + in: "query" + - name: "workspaceIds" + description: "The UUIDs of the workspaces you wish to list jobs for. Empty\ + \ list will retrieve all allowed workspaces." + schema: + type: "array" + items: + format: "uuid" + type: "string" + in: "query" + required: false + - name: "status" + description: "The Job status you want to filter by" + schema: + $ref: "#/components/schemas/JobStatusEnum" + in: "query" + required: false + - name: "createdAtStart" + description: "The start date to filter by" + schema: + type: "string" + format: "date-time" + in: "query" + required: false + example: "2023-06-22T16:15:00Z" + - name: "createdAtEnd" + description: "The end date to filter by" + schema: + type: "string" + format: "date-time" + in: "query" + required: false + example: "2023-06-22T16:15:00Z" + - name: "updatedAtStart" + description: "The start date to filter by" + schema: + type: "string" + format: "date-time" + example: "2023-06-22T16:15:00Z" + in: "query" + required: false + - name: "updatedAtEnd" + description: "The end date to filter by" + schema: + type: "string" + format: "date-time" + in: "query" + required: false + example: "2023-06-22T16:15:00Z" + - name: "orderBy" + description: "The field and method to use for ordering. Currently allowed\ + \ are createdAt and updatedAt." + schema: + type: "string" + pattern: "\\w+|(ASC|DESC)" + in: "query" + required: false + example: "updatedAt|DESC" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/JobsResponse" + examples: + Job List Response Example: + value: + 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" + description: "List all the Jobs by connectionId." + "403": + description: "Not allowed" + operationId: "listJobs" + summary: "List Jobs by sync type" + x-use-speakeasy-middleware: true + post: + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/JobCreateRequest" + examples: + Job Creation Request Example: + value: + connectionId: "e735894a-e773-4938-969f-45f53957b75b" + jobType: "sync" + required: true + tags: + - "Jobs" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/JobResponse" + examples: + Job Creation Response Example: + value: + jobId: 1234 + status: "running" + jobType: "sync" + description: "Kicks off a new Job based on the JobType. The connectionId\ + \ is the resource that Job will be run for." + "400": + description: "Invalid data" + "403": + description: "Not allowed" + operationId: "createJob" + summary: "Trigger a sync or reset job of a connection" + x-use-speakeasy-middleware: true + /jobs/{jobId}: + get: + tags: + - "Jobs" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/JobResponse" + examples: + Job Get Response Example: + value: + id: "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826" + status: "running" + jobType: "sync" + description: "Get a Job by the id in the path." + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "getJob" + summary: "Get Job status and details" + x-use-speakeasy-middleware: true + delete: + tags: + - "Jobs" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/JobResponse" + description: "Cancel a Job." + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "cancelJob" + summary: "Cancel a running Job" + x-use-speakeasy-middleware: true + parameters: + - name: "jobId" + schema: + format: "int64" + type: "integer" + in: "path" + required: true + /sources: + get: + tags: + - "Sources" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/SourcesResponse" + description: "Successful operation" + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "listSources" + summary: "List sources" + x-use-speakeasy-middleware: true + parameters: + - name: "workspaceIds" + description: "The UUIDs of the workspaces you wish to list sources for. Empty\ + \ list will retrieve all allowed workspaces." + schema: + type: "array" + items: + format: "uuid" + type: "string" + example: "df08f6b0-b364-4cc1-9b3f-96f5d2fccfb2,b0796797-de23-4fc7-a5e2-7e131314718c" + in: "query" + required: false + - name: "includeDeleted" + description: "Include deleted sources in the returned results." + schema: + default: false + type: "boolean" + in: "query" + required: false + - name: "limit" + description: "Set the limit on the number of sources returned. The default\ + \ is 20." + schema: + format: "int32" + type: "integer" + minimum: 1 + maximum: 100 + default: 20 + in: "query" + - name: "offset" + description: "Set the offset to start at when returning sources. The default\ + \ is 0" + schema: + type: "integer" + format: "int32" + minimum: 0 + default: 0 + in: "query" + post: + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/SourceCreateRequest" + examples: + Source Creation Request Example: + value: + configuration: + airbyte_source_name: "google-ads" + conversion_window_days: 14 + customer_id: "1234567890" + start_date: "2023-01-01" + end_date: "2024-01-01" + name: "My Source" + workspaceId: "744cc0ed-7f05-4949-9e60-2a814f90c035" + tags: + - "Sources" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/SourceResponse" + examples: + Source Creation Response Example: + value: + sourceId: "0c31738c-0b2d-4887-b506-e2cd1c39cc35" + description: "Successful operation" + "400": + description: "Invalid data" + "403": + description: "Not allowed" + operationId: "createSource" + summary: "Create a source" + description: "Creates a source given a name, workspace id, and a json blob containing\ + \ the configuration for the source." + x-use-speakeasy-middleware: true + /sources/{sourceId}: + get: + tags: + - "Sources" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/SourceResponse" + examples: + Source Get Response Example: + value: + sourceId: "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826" + name: "running" + sourceType: "postgres" + workspaceId: "744cc0ed-7f05-4949-9e60-2a814f90c035" + description: "Get a Source by the id in the path." + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "getSource" + summary: "Get Source details" + x-use-speakeasy-middleware: true + patch: + tags: + - "Sources" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/SourcePatchRequest" + examples: + Source Update Request Example: + value: + configuration: + airbyte_source_name: "google-ads" + conversion_window_days: 14 + customer_id: "1234567890" + start_date: "2023-01-01" + end_date: "2024-01-01" + name: "My Source" + workspaceId: "744cc0ed-7f05-4949-9e60-2a814f90c035" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/SourceResponse" + examples: + Source Update Response Example: + value: + sourceId: "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826" + name: "running" + sourceType: "postgres" + workspaceId: "744cc0ed-7f05-4949-9e60-2a814f90c035" + description: "Update a Source" + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "patchSource" + summary: "Update a Source" + x-use-speakeasy-middleware: true + put: + tags: + - "Sources" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/SourcePutRequest" + examples: + Source Update Request Example: + value: + configuration: + airbyte_source_name: "google-ads" + conversion_window_days: 14 + customer_id: "1234567890" + start_date: "2023-01-01" + end_date: "2024-01-01" + name: "My Source" + workspaceId: "744cc0ed-7f05-4949-9e60-2a814f90c035" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/SourceResponse" + examples: + Source Update Response Example: + value: + sourceId: "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826" + name: "running" + sourceType: "postgres" + workspaceId: "744cc0ed-7f05-4949-9e60-2a814f90c035" + description: "Update a source and fully overwrite it" + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "putSource" + summary: "Update a Source and fully overwrite it" + x-use-speakeasy-middleware: true + x-speakeasy-entity-operation: "Source#update" + delete: + tags: + - "Sources" + responses: + "204": + description: "The resource was deleted successfully" + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "deleteSource" + summary: "Delete a Source" + x-use-speakeasy-middleware: true + parameters: + - name: "sourceId" + schema: + format: "UUID" + type: "string" + in: "path" + required: true + /destinations: + get: + tags: + - "Destinations" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/DestinationsResponse" + description: "Successful operation" + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "listDestinations" + summary: "List destinations" + x-use-speakeasy-middleware: true + parameters: + - name: "workspaceIds" + description: "The UUIDs of the workspaces you wish to list destinations for.\ + \ Empty list will retrieve all allowed workspaces." + schema: + type: "array" + items: + format: "uuid" + type: "string" + in: "query" + required: false + - name: "includeDeleted" + description: "Include deleted destinations in the returned results." + schema: + default: false + type: "boolean" + in: "query" + required: false + - name: "limit" + description: "Set the limit on the number of destinations returned. The default\ + \ is 20." + schema: + format: "int32" + type: "integer" + minimum: 1 + maximum: 100 + default: 20 + in: "query" + - name: "offset" + description: "Set the offset to start at when returning destinations. The\ + \ default is 0" + schema: + type: "integer" + format: "int32" + minimum: 0 + default: 0 + in: "query" + post: + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DestinationCreateRequest" + examples: + Destination Creation Request Example: + value: + name: "Postgres" + workspaceId: "2155ae5a-de39-4808-af6a-16fe7b8b4ed2" + configuration: + airbyte_destination_name: "postgres" + port: 5432 + schema: "public" + ssl_mode: + mode: "prefer" + tunnel_method: + tunnel_method: "NO_TUNNEL" + host: "localhost" + database: "postgres" + username: "postgres" + password: "test" + tags: + - "Destinations" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/DestinationResponse" + examples: + Destination Creation Response Example: + value: + destinationId: "af0c3c67-aa61-419f-8922-95b0bf840e86" + description: "Successful operation" + "400": + description: "Invalid data" + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "createDestination" + summary: "Create a destination" + description: "Creates a destination given a name, workspace id, and a json blob\ + \ containing the configuration for the source." + x-use-speakeasy-middleware: true + /destinations/{destinationId}: + get: + tags: + - "Destinations" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/DestinationResponse" + examples: + Destination Get Response Example: + value: + destinationId: "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826" + name: "My Destination" + sourceType: "postgres" + workspaceId: "744cc0ed-7f05-4949-9e60-2a814f90c035" + configuration: + conversion_window_days: 14 + customer_id: "1234567890" + start_date: "2023-01-01" + end_date: "2024-01-01" + description: "Get a Destination by the id in the path." + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "getDestination" + summary: "Get Destination details" + x-use-speakeasy-middleware: true + delete: + tags: + - "Destinations" + responses: + "204": + description: "The resource was deleted successfully" + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "deleteDestination" + summary: "Delete a Destination" + x-use-speakeasy-middleware: true + patch: + tags: + - "Destinations" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DestinationPatchRequest" + examples: + Destination Update Request Example: + value: + configuration: + conversion_window_days: 14 + customer_id: "1234567890" + start_date: "2023-01-01" + end_date: "2024-01-01" + name: "My Destination" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/DestinationResponse" + examples: + Destination Update Response Example: + value: + destinationId: "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826" + name: "running" + sourceType: "postgres" + workspaceId: "744cc0ed-7f05-4949-9e60-2a814f90c035" + configuration: + conversion_window_days: 14 + customer_id: "1234567890" + start_date: "2023-01-01" + end_date: "2024-01-01" + description: "Update a Destination" + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "patchDestination" + summary: "Update a Destination" + x-use-speakeasy-middleware: true + put: + tags: + - "Destinations" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DestinationPutRequest" + examples: + Destination Update Request Example: + value: + configuration: + conversion_window_days: 14 + customer_id: "1234567890" + start_date: "2023-01-01" + end_date: "2024-01-01" + name: "My Destination" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/DestinationResponse" + examples: + Destination Update Response Example: + value: + destinationId: "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826" + name: "running" + sourceType: "postgres" + workspaceId: "744cc0ed-7f05-4949-9e60-2a814f90c035" + configuration: + conversion_window_days: 14 + customer_id: "1234567890" + start_date: "2023-01-01" + end_date: "2024-01-01" + description: "Update a Destination and fully overwrite it" + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "putDestination" + summary: "Update a Destination and fully overwrite it" + x-use-speakeasy-middleware: true + x-speakeasy-entity-operation: "Destination#update" + parameters: + - name: "destinationId" + schema: + format: "UUID" + type: "string" + in: "path" + required: true + /sources/initiateOAuth: + post: + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/InitiateOauthRequest" + required: true + tags: + - "Sources" + responses: + "200": + $ref: "#/components/responses/InitiateOauthResponse" + "400": + description: "A field in the body has not been set appropriately." + "403": + description: "API key is invalid." + operationId: "initiateOAuth" + summary: "Initiate OAuth for a source" + description: "Given a source ID, workspace ID, and redirect URL, initiates OAuth\ + \ for the source.\n\nThis returns a fully formed URL for performing user authentication\ + \ against the relevant source identity provider (IdP). Once authentication\ + \ has been completed, the IdP will redirect to an Airbyte endpoint which will\ + \ save the access and refresh tokens off as a secret and return the secret\ + \ ID to the redirect URL specified in the `secret_id` query string parameter.\n\ + \nThat secret ID can be used to create a source with credentials in place\ + \ of actual tokens." + x-use-speakeasy-middleware: true + /connections: + post: + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionCreateRequest" + examples: + Connection Creation Request Example: + value: + sourceId: "95e66a59-8045-4307-9678-63bc3c9b8c93" + destinationId: "e478de0d-a3a0-475c-b019-25f7dd29e281" + name: "Postgres-to-Bigquery" + required: true + tags: + - "Connections" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionResponse" + examples: + Connection Creation Response Example: + value: + connectionId: "9924bcd0-99be-453d-ba47-c2c9766f7da5" + description: "Successful operation" + "400": + description: "Invalid data" + "403": + description: "Not allowed" + operationId: "createConnection" + summary: "Create a connection" + x-use-speakeasy-middleware: true + x-speakeasy-entity-operation: "Connection#create" + get: + tags: + - "Connections" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionsResponse" + description: "Successful operation" + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "listConnections" + summary: "List connections" + x-use-speakeasy-middleware: true + x-speakeasy-entity-operation: "Connection#list" + parameters: + - name: "workspaceIds" + description: "The UUIDs of the workspaces you wish to list connections for.\ + \ Empty list will retrieve all allowed workspaces." + schema: + type: "array" + items: + format: "uuid" + type: "string" + in: "query" + required: false + - name: "includeDeleted" + description: "Include deleted connections in the returned results." + schema: + default: false + type: "boolean" + in: "query" + required: false + - name: "limit" + description: "Set the limit on the number of Connections returned. The default\ + \ is 20." + schema: + format: "int32" + type: "integer" + minimum: 1 + maximum: 100 + default: 20 + in: "query" + - name: "offset" + description: "Set the offset to start at when returning Connections. The default\ + \ is 0" + schema: + type: "integer" + format: "int32" + minimum: 0 + default: 0 + in: "query" + /connections/{connectionId}: + get: + tags: + - "Connections" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionResponse" + examples: + Connection Get Response Example: + value: + workspaceId: "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826" + name: "Postgres To Snowflake" + sourceId: "9924bcd0-99be-453d-ba47-c2c9766f7da5" + destinationId: "744cc0ed-7f05-4949-9e60-2a814f90c035" + description: "Get a Connection by the id in the path." + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "getConnection" + summary: "Get Connection details" + x-use-speakeasy-middleware: true + x-speakeasy-entity-operation: "Connection#read" + patch: + tags: + - "Connections" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionPatchRequest" + examples: + Connection Update Request Example: + value: + sourceId: "95e66a59-8045-4307-9678-63bc3c9b8c93" + destinationId: "e478de0d-a3a0-475c-b019-25f7dd29e281" + name: "Postgres-to-Bigquery" + required: true + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/ConnectionResponse" + examples: + Connection Get Response Example: + value: + workspaceId: "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826" + name: "Postgres To Snowflake" + sourceId: "9924bcd0-99be-453d-ba47-c2c9766f7da5" + destinationId: "744cc0ed-7f05-4949-9e60-2a814f90c035" + description: "Update a Connection by the id in the path." + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "patchConnection" + summary: "Update Connection details" + x-use-speakeasy-middleware: true + x-speakeasy-entity-operation: "Connection#update" + delete: + tags: + - "Connections" + responses: + "204": + description: "The resource was deleted successfully" + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "deleteConnection" + summary: "Delete a Connection" + x-use-speakeasy-middleware: true + x-speakeasy-entity-operation: "Connection#delete" + parameters: + - name: "connectionId" + schema: + format: "UUID" + type: "string" + in: "path" + required: true + /streams: + get: + tags: + - "Streams" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/StreamPropertiesResponse" + description: "Get the available streams properties for a source/destination\ + \ pair." + "400": + description: "Required parameters are missing" + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "getStreamProperties" + summary: "Get stream properties" + x-use-speakeasy-middleware: true + parameters: + - name: "sourceId" + description: "ID of the source" + schema: + format: "UUID" + type: "string" + in: "query" + required: true + - name: "destinationId" + description: "ID of the destination" + schema: + format: "UUID" + type: "string" + in: "query" + required: true + - name: "ignoreCache" + description: "If true pull the latest schema from the source, else pull from\ + \ cache (default false)" + schema: + type: "boolean" + default: false + in: "query" + required: false + /workspaces: + get: + tags: + - "Workspaces" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/WorkspacesResponse" + description: "Successful operation" + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "listWorkspaces" + summary: "List workspaces" + x-use-speakeasy-middleware: true + parameters: + - name: "workspaceIds" + description: "The UUIDs of the workspaces you wish to fetch. Empty list will\ + \ retrieve all allowed workspaces." + schema: + type: "array" + items: + format: "uuid" + type: "string" + in: "query" + required: false + - name: "includeDeleted" + description: "Include deleted workspaces in the returned results." + schema: + default: false + type: "boolean" + in: "query" + required: false + - name: "limit" + description: "Set the limit on the number of workspaces returned. The default\ + \ is 20." + schema: + format: "int32" + type: "integer" + minimum: 1 + maximum: 100 + default: 20 + in: "query" + - name: "offset" + description: "Set the offset to start at when returning workspaces. The default\ + \ is 0" + schema: + type: "integer" + format: "int32" + minimum: 0 + default: 0 + in: "query" + x-speakeasy-entity-operation: "Workspace#list" + post: + tags: + - "Workspaces" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/WorkspaceCreateRequest" + examples: + Workspace Creation Request Example: + value: + name: "Company Workspace Name" + required: true + x-speakeasy-entity-operation: "Workspace#create" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/WorkspaceResponse" + examples: + Workspace Creation Response Example: + value: + workspaceId: "9924bcd0-99be-453d-ba47-c2c9766f7da5" + description: "Successful operation" + "400": + description: "Invalid data" + "403": + description: "Not allowed" + operationId: "createWorkspace" + summary: "Create a workspace" + x-use-speakeasy-middleware: true + x-speakeasy-entity-operation: "Workspace#create" + /workspaces/{workspaceId}: + parameters: + - name: "workspaceId" + schema: + format: "UUID" + type: "string" + in: "path" + required: true + get: + tags: + - "Workspaces" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/WorkspaceResponse" + examples: + Workspace Get Response Example: + value: + workspaceId: "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826" + name: "Acme Company" + dataResidency: "auto" + description: "Get a Workspace by the id in the path." + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "getWorkspace" + summary: "Get Workspace details" + x-use-speakeasy-middleware: true + x-speakeasy-entity-operation: "Workspace#read" + patch: + tags: + - "Workspaces" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/WorkspaceUpdateRequest" + examples: + Workspace Update Request Example: + value: + name: "Company Workspace Name" + required: true + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/WorkspaceResponse" + examples: + Workspace Update Response Example: + value: + workspaceId: "9924bcd0-99be-453d-ba47-c2c9766f7da5" + description: "Successful operation" + "400": + description: "Invalid data" + "403": + description: "Not allowed" + operationId: "updateWorkspace" + summary: "Update a workspace" + x-use-speakeasy-middleware: true + x-speakeasy-entity-operation: "Workspace#update" + delete: + tags: + - "Workspaces" + responses: + "204": + description: "The resource was deleted successfully" + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "deleteWorkspace" + summary: "Delete a Workspace" + x-use-speakeasy-middleware: true + x-speakeasy-entity-operation: "Workspace#delete" + /workspaces/{workspaceId}/oauthCredentials: + put: + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/WorkspaceOAuthCredentialsRequest" + required: true + tags: + - "Workspaces" + responses: + "200": + description: "OAuth credential override was successful." + "400": + description: "A field in the body has not been set appropriately." + "403": + description: "API key is invalid." + operationId: "createOrUpdateWorkspaceOAuthCredentials" + summary: "Create OAuth override credentials for a workspace and source type." + description: "Create/update a set of OAuth credentials to override the Airbyte-provided\ + \ OAuth credentials used for source/destination OAuth.\nIn order to determine\ + \ what the credential configuration needs to be, please see the connector\ + \ specification of the relevant source/destination." + x-use-speakeasy-middleware: true + parameters: + - name: "workspaceId" + schema: + format: "UUID" + type: "string" + in: "path" + required: true +components: + responses: + InitiateOauthResponse: + content: + application/json: {} + description: "Response from the initiate OAuth call should be an object with\ + \ a single property which will be the `redirect_url`. If a user is redirected\ + \ to this URL, they'll be prompted by the identity provider to authenticate." + schemas: + RedirectUrlResponse: + title: "Root Type for RedirectUrlResponse" + description: "" + type: "object" + properties: + redirectUrl: + format: "url" + type: "string" + example: + redirectUrl: "https://airbyte.portal.speakeasyapi.dev?speakeasyAccessToken=eydas.ad45.1234" + JobResponse: + title: "Root Type for JobResponse" + description: "Provides details of a single job." + required: + - "jobId" + - "status" + - "jobType" + - "startTime" + - "connectionId" + type: "object" + properties: + jobId: + format: "int64" + type: "integer" + status: + $ref: "#/components/schemas/JobStatusEnum" + jobType: + $ref: "#/components/schemas/JobTypeEnum" + startTime: + type: "string" + connectionId: + format: "UUID" + type: "string" + lastUpdatedAt: + type: "string" + duration: + description: "Duration of a sync in ISO_8601 format" + type: "string" + bytesSynced: + format: "int64" + type: "integer" + rowsSynced: + format: "int64" + type: "integer" + example: + id: "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826" + status: "running" + jobType: "sync" + startTime: "2023-03-25T01:30:50Z" + duration: "PT8H6M12S" + JobsResponse: + title: "Root Type for JobsResponse" + description: "" + required: + - "data" + type: "object" + properties: + previous: + type: "string" + next: + type: "string" + data: + type: "array" + items: + $ref: "#/components/schemas/JobResponse" + example: + 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" + ConnectionCreateRequest: + required: + - "sourceId" + - "destinationId" + type: "object" + properties: + name: + description: "Optional name of the connection" + type: "string" + sourceId: + format: "uuid" + type: "string" + destinationId: + format: "uuid" + type: "string" + configurations: + $ref: "#/components/schemas/StreamConfigurations" + schedule: + $ref: "#/components/schemas/ConnectionSchedule" + dataResidency: + $ref: "#/components/schemas/GeographyEnum" + namespaceDefinition: + $ref: "#/components/schemas/NamespaceDefinitionEnum" + namespaceFormat: + type: "string" + description: "Used when namespaceDefinition is 'custom_format'. If blank\ + \ then behaves like namespaceDefinition = 'destination'. If \"${SOURCE_NAMESPACE}\"\ + \ then behaves like namespaceDefinition = 'source'." + default: null + example: "${SOURCE_NAMESPACE}" + prefix: + type: "string" + description: "Prefix that will be prepended to the name of each stream when\ + \ it is written to the destination (ex. “airbyte_” causes “projects” =>\ + \ “airbyte_projects”)." + nonBreakingSchemaUpdatesBehavior: + $ref: "#/components/schemas/NonBreakingSchemaUpdatesBehaviorEnum" + status: + $ref: "#/components/schemas/ConnectionStatusEnum" + x-speakeasy-entity: "Connection" + x-speakeasy-param-suppress-computed-diff: true + ConnectionPatchRequest: + type: "object" + properties: + name: + description: "Optional name of the connection" + type: "string" + configurations: + $ref: "#/components/schemas/StreamConfigurations" + schedule: + $ref: "#/components/schemas/ConnectionSchedule" + dataResidency: + $ref: "#/components/schemas/GeographyEnumNoDefault" + namespaceDefinition: + $ref: "#/components/schemas/NamespaceDefinitionEnumNoDefault" + namespaceFormat: + type: "string" + description: "Used when namespaceDefinition is 'custom_format'. If blank\ + \ then behaves like namespaceDefinition = 'destination'. If \"${SOURCE_NAMESPACE}\"\ + \ then behaves like namespaceDefinition = 'source'." + default: null + example: "${SOURCE_NAMESPACE}" + prefix: + type: "string" + description: "Prefix that will be prepended to the name of each stream when\ + \ it is written to the destination (ex. “airbyte_” causes “projects” =>\ + \ “airbyte_projects”)." + nonBreakingSchemaUpdatesBehavior: + $ref: "#/components/schemas/NonBreakingSchemaUpdatesBehaviorEnumNoDefault" + status: + $ref: "#/components/schemas/ConnectionStatusEnum" + x-speakeasy-entity: "Connection" + x-speakeasy-param-suppress-computed-diff: true + JobCreateRequest: + title: "Root Type for JobCreate" + description: "Creates a new Job from the configuration provided in the request\ + \ body." + required: + - "jobType" + - "connectionId" + type: "object" + properties: + connectionId: + format: "UUID" + type: "string" + jobType: + $ref: "#/components/schemas/JobTypeEnum" + example: + connectionId: "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826" + jobType: "sync" + JobStatusEnum: + enum: + - "pending" + - "running" + - "incomplete" + - "failed" + - "succeeded" + - "cancelled" + type: "string" + JobTypeEnum: + description: "Enum that describes the different types of jobs that the platform\ + \ runs." + enum: + - "sync" + - "reset" + type: "string" + SourceCreateRequest: + required: + - "name" + - "workspaceId" + - "configuration" + type: "object" + properties: + name: + description: "Name of the source e.g. dev-mysql-instance." + type: "string" + definitionId: + description: "The UUID of the connector definition. One of configuration.sourceType\ + \ or definitionId must be provided." + format: "uuid" + type: "string" + workspaceId: + format: "uuid" + type: "string" + configuration: + $ref: "#/components/schemas/SourceConfiguration" + secretId: + description: "Optional secretID obtained through the public API OAuth redirect\ + \ flow." + type: "string" + x-implements: "io.airbyte.public_api.server.helpers.ConfigurableActor" + x-speakeasy-entity: "Source" + x-speakeasy-param-suppress-computed-diff: true + SourcePutRequest: + required: + - "name" + - "configuration" + type: "object" + properties: + name: + type: "string" + configuration: + $ref: "#/components/schemas/SourceConfiguration" + x-implements: "io.airbyte.public_api.server.helpers.ConfigurableActor" + x-speakeasy-entity: "Source" + x-speakeasy-param-suppress-computed-diff: true + SourcePatchRequest: + type: "object" + properties: + name: + type: "string" + example: "My source" + workspaceId: + format: "uuid" + type: "string" + configuration: + $ref: "#/components/schemas/SourceConfiguration" + secretId: + description: "Optional secretID obtained through the public API OAuth redirect\ + \ flow." + type: "string" + x-implements: "io.airbyte.public_api.server.helpers.ConfigurableActor" + x-speakeasy-entity: "Source" + x-speakeasy-param-suppress-computed-diff: true + OAuthInputConfiguration: + description: "Arbitrary vars to pass for OAuth depending on what the source/destination\ + \ spec requires." + type: "object" + example: + host: "test.snowflake.com" + ConnectionResponse: + title: "Root Type for ConnectionResponse" + description: "Provides details of a single connection." + type: "object" + required: + - "connectionId" + - "name" + - "sourceId" + - "destinationId" + - "workspaceId" + - "status" + - "schedule" + - "dataResidency" + - "configurations" + properties: + connectionId: + format: "UUID" + type: "string" + name: + type: "string" + sourceId: + format: "UUID" + type: "string" + destinationId: + format: "UUID" + type: "string" + workspaceId: + format: "UUID" + type: "string" + status: + $ref: "#/components/schemas/ConnectionStatusEnum" + schedule: + $ref: "#/components/schemas/ConnectionScheduleResponse" + dataResidency: + $ref: "#/components/schemas/GeographyEnum" + nonBreakingSchemaUpdatesBehavior: + $ref: "#/components/schemas/NonBreakingSchemaUpdatesBehaviorEnum" + namespaceDefinition: + $ref: "#/components/schemas/NamespaceDefinitionEnum" + namespaceFormat: + type: "string" + prefix: + type: "string" + configurations: + $ref: "#/components/schemas/StreamConfigurations" + x-speakeasy-entity: "Connection" + x-speakeasy-param-suppress-computed-diff: true + ConnectionSchedule: + description: "schedule for when the the connection should run, per the schedule\ + \ type" + type: "object" + required: + - "scheduleType" + properties: + scheduleType: + $ref: "#/components/schemas/ScheduleTypeEnum" + cronExpression: + type: "string" + ScheduleTypeEnum: + type: "string" + enum: + - "manual" + - "cron" + ConnectionScheduleResponse: + description: "schedule for when the the connection should run, per the schedule\ + \ type" + type: "object" + required: + - "scheduleType" + properties: + scheduleType: + $ref: "#/components/schemas/ScheduleTypeWithBasicEnum" + cronExpression: + type: "string" + basicTiming: + type: "string" + ScheduleTypeWithBasicEnum: + type: "string" + enum: + - "manual" + - "cron" + - "basic" + GeographyEnum: + type: "string" + enum: + - "auto" + - "us" + - "eu" + default: "auto" + GeographyEnumNoDefault: + type: "string" + enum: + - "auto" + - "us" + - "eu" + ConnectionStatusEnum: + type: "string" + enum: + - "active" + - "inactive" + - "deprecated" + NamespaceDefinitionEnum: + type: "string" + description: "Define the location where the data will be stored in the destination" + enum: + - "source" + - "destination" + - "custom_format" + default: "destination" + NonBreakingSchemaUpdatesBehaviorEnum: + type: "string" + description: "Set how Airbyte handles syncs when it detects a non-breaking schema\ + \ change in the source" + enum: + - "ignore" + - "disable_connection" + - "propagate_columns" + - "propagate_fully" + default: "ignore" + NamespaceDefinitionEnumNoDefault: + type: "string" + description: "Define the location where the data will be stored in the destination" + enum: + - "source" + - "destination" + - "custom_format" + NonBreakingSchemaUpdatesBehaviorEnumNoDefault: + type: "string" + description: "Set how Airbyte handles syncs when it detects a non-breaking schema\ + \ change in the source" + enum: + - "ignore" + - "disable_connection" + - "propagate_columns" + - "propagate_fully" + DestinationResponse: + title: "Root Type for DestinationResponse" + description: "Provides details of a single destination." + type: "object" + required: + - "destinationId" + - "name" + - "destinationType" + - "workspaceId" + - "configuration" + properties: + destinationId: + format: "UUID" + type: "string" + name: + type: "string" + destinationType: + type: "string" + workspaceId: + format: "UUID" + type: "string" + configuration: + $ref: "#/components/schemas/DestinationConfiguration" + example: + destinationId: "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826" + name: "Analytics Team Postgres" + destinationType: "postgres" + workspaceId: "871d9b60-11d1-44cb-8c92-c246d53bf87e" + SourceResponse: + title: "Root Type for SourceResponse" + description: "Provides details of a single source." + type: "object" + required: + - "sourceId" + - "name" + - "sourceType" + - "workspaceId" + - "configuration" + properties: + sourceId: + format: "UUID" + type: "string" + name: + type: "string" + sourceType: + type: "string" + workspaceId: + format: "UUID" + type: "string" + configuration: + $ref: "#/components/schemas/SourceConfiguration" + example: + sourceId: "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826" + name: "Analytics Team Postgres" + sourceType: "postgres" + workspaceId: "871d9b60-11d1-44cb-8c92-c246d53bf87e" + DestinationCreateRequest: + required: + - "name" + - "workspaceId" + - "configuration" + type: "object" + properties: + name: + description: "Name of the destination e.g. dev-mysql-instance." + type: "string" + definitionId: + description: "The UUID of the connector definition. One of configuration.destinationType\ + \ or definitionId must be provided." + format: "uuid" + type: "string" + workspaceId: + format: "uuid" + type: "string" + configuration: + $ref: "#/components/schemas/DestinationConfiguration" + x-implements: "io.airbyte.public_api.server.helpers.ConfigurableActor" + x-speakeasy-entity: "Destination" + x-speakeasy-param-suppress-computed-diff: true + DestinationPatchRequest: + type: "object" + properties: + name: + type: "string" + configuration: + $ref: "#/components/schemas/DestinationConfiguration" + x-implements: "io.airbyte.public_api.server.helpers.ConfigurableActor" + x-speakeasy-entity: "Destination" + x-speakeasy-param-suppress-computed-diff: true + DestinationPutRequest: + required: + - "name" + - "configuration" + type: "object" + properties: + name: + type: "string" + configuration: + $ref: "#/components/schemas/DestinationConfiguration" + x-implements: "io.airbyte.public_api.server.helpers.ConfigurableActor" + x-speakeasy-entity: "Destination" + x-speakeasy-param-suppress-computed-diff: true + WorkspaceCreateRequest: + required: + - "name" + type: "object" + properties: + name: + description: "Name of the workspace" + type: "string" + x-speakeasy-entity: "Workspace" + x-speakeasy-param-suppress-computed-diff: true + WorkspaceUpdateRequest: + required: + - "name" + type: "object" + properties: + name: + description: "Name of the workspace" + type: "string" + x-speakeasy-entity: "Workspace" + x-speakeasy-param-suppress-computed-diff: true + WorkspaceResponse: + title: "Root Type for WorkspaceResponse" + description: "Provides details of a single workspace." + type: "object" + required: + - "workspaceId" + - "name" + - "dataResidency" + properties: + workspaceId: + format: "UUID" + type: "string" + name: + type: "string" + dataResidency: + $ref: "#/components/schemas/GeographyEnum" + x-speakeasy-entity: "Workspace" + x-speakeasy-param-suppress-computed-diff: true + ConnectionsResponse: + title: "Root Type for ConnectionsResponse" + description: "" + required: + - "data" + type: "object" + properties: + previous: + type: "string" + next: + type: "string" + data: + type: "array" + items: + $ref: "#/components/schemas/ConnectionResponse" + default: [] + example: + 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" + SourcesResponse: + title: "Root Type for SourcesResponse" + description: "" + required: + - "data" + type: "object" + properties: + previous: + type: "string" + next: + type: "string" + data: + type: "array" + items: + $ref: "#/components/schemas/SourceResponse" + example: + 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" + DestinationsResponse: + title: "Root Type for DestinationsResponse" + description: "" + required: + - "data" + type: "object" + properties: + previous: + type: "string" + next: + type: "string" + data: + type: "array" + items: + $ref: "#/components/schemas/DestinationResponse" + example: + 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" + WorkspacesResponse: + title: "Root Type for WorkspacesResponse" + description: "" + required: + - "data" + type: "object" + properties: + previous: + type: "string" + next: + type: "string" + data: + type: "array" + items: + $ref: "#/components/schemas/WorkspaceResponse" + example: + 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" + StreamConfiguration: + description: "Configurations for a single stream." + type: "object" + required: + - "name" + properties: + name: + type: "string" + syncMode: + $ref: "#/components/schemas/ConnectionSyncModeEnum" + cursorField: + description: "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." + type: "array" + items: + type: "string" + primaryKey: + description: "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." + type: "array" + items: + type: "array" + items: + type: "string" + StreamConfigurations: + description: "A list of configured stream options for a connection." + type: "object" + properties: + streams: + type: "array" + items: + $ref: "#/components/schemas/StreamConfiguration" + StreamPropertiesResponse: + description: "A list of stream properties." + type: "object" + properties: + streams: + type: "array" + items: + $ref: "#/components/schemas/StreamProperties" + StreamProperties: + description: "The stream properties associated with a connection." + type: "object" + properties: + streamName: + type: "string" + syncModes: + type: "array" + items: + $ref: "#/components/schemas/ConnectionSyncModeEnum" + defaultCursorField: + type: "array" + items: + type: "string" + sourceDefinedCursorField: + type: "boolean" + sourceDefinedPrimaryKey: + type: "array" + items: + type: "array" + items: + type: "string" + propertyFields: + type: "array" + items: + type: "array" + items: + type: "string" + ConnectionSyncModeEnum: + enum: + - "full_refresh_overwrite" + - "full_refresh_append" + - "incremental_append" + - "incremental_deduped_history" + ActorTypeEnum: + description: "Whether you're setting this override for a source or destination" + enum: + - "source" + - "destination" + source-trello: + type: "object" + required: + - "key" + - "token" + - "start_date" + - "sourceType" + properties: + key: + type: "string" + title: "API key" + description: "Trello API key. See the docs for instructions on how to generate it." + airbyte_secret: true + order: 0 + x-speakeasy-param-sensitive: true + token: + type: "string" + title: "API token" + description: "Trello API token. See the docs for instructions on how to generate it." + airbyte_secret: true + order: 1 + x-speakeasy-param-sensitive: true + start_date: + type: "string" + title: "Start Date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + examples: + - "2021-03-01T00:00:00Z" + format: "date-time" + order: 2 + board_ids: + type: "array" + items: + type: "string" + pattern: "^[0-9a-fA-F]{24}$" + title: "Trello Board IDs" + description: "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" + order: 3 + sourceType: + title: "trello" + const: "trello" + enum: + - "trello" + order: 0 + type: "string" + source-trello-update: + type: "object" + required: + - "key" + - "token" + - "start_date" + properties: + key: + type: "string" + title: "API key" + description: "Trello API key. See the docs for instructions on how to generate it." + airbyte_secret: true + order: 0 + token: + type: "string" + title: "API token" + description: "Trello API token. See the docs for instructions on how to generate it." + airbyte_secret: true + order: 1 + start_date: + type: "string" + title: "Start Date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + examples: + - "2021-03-01T00:00:00Z" + format: "date-time" + order: 2 + board_ids: + type: "array" + items: + type: "string" + pattern: "^[0-9a-fA-F]{24}$" + title: "Trello Board IDs" + description: "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" + order: 3 + source-the-guardian-api: + title: "The Guardian Api Spec" + type: "object" + required: + - "api_key" + - "start_date" + - "sourceType" + properties: + api_key: + title: "API Key" + type: "string" + description: "Your API Key. See here. The key is case sensitive." + airbyte_secret: true + x-speakeasy-param-sensitive: true + start_date: + title: "Start Date" + type: "string" + description: "Use this to set the minimum date (YYYY-MM-DD) of the results.\ + \ Results older than the start_date will not be shown." + pattern: "^([1-9][0-9]{3})\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01])$" + examples: + - "YYYY-MM-DD" + query: + title: "Query" + type: "string" + description: "(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." + examples: + - "environment AND NOT water" + - "environment AND political" + - "amusement park" + - "political" + tag: + title: "Tag" + type: "string" + description: "(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." + examples: + - "environment/recycling" + - "environment/plasticbags" + - "environment/energyefficiency" + section: + title: "Section" + type: "string" + description: "(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." + examples: + - "media" + - "technology" + - "housing-network" + end_date: + title: "End Date" + type: "string" + description: "(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." + pattern: "^([1-9][0-9]{3})\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01])$" + examples: + - "YYYY-MM-DD" + sourceType: + title: "the-guardian-api" + const: "the-guardian-api" + enum: + - "the-guardian-api" + order: 0 + type: "string" + source-the-guardian-api-update: + title: "The Guardian Api Spec" + type: "object" + required: + - "api_key" + - "start_date" + properties: + api_key: + title: "API Key" + type: "string" + description: "Your API Key. See here. The key is case sensitive." + airbyte_secret: true + start_date: + title: "Start Date" + type: "string" + description: "Use this to set the minimum date (YYYY-MM-DD) of the results.\ + \ Results older than the start_date will not be shown." + pattern: "^([1-9][0-9]{3})\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01])$" + examples: + - "YYYY-MM-DD" + query: + title: "Query" + type: "string" + description: "(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." + examples: + - "environment AND NOT water" + - "environment AND political" + - "amusement park" + - "political" + tag: + title: "Tag" + type: "string" + description: "(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." + examples: + - "environment/recycling" + - "environment/plasticbags" + - "environment/energyefficiency" + section: + title: "Section" + type: "string" + description: "(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." + examples: + - "media" + - "technology" + - "housing-network" + end_date: + title: "End Date" + type: "string" + description: "(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." + pattern: "^([1-9][0-9]{3})\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01])$" + examples: + - "YYYY-MM-DD" + source-harvest: + title: "Harvest Spec" + type: "object" + required: + - "account_id" + - "replication_start_date" + - "sourceType" + properties: + account_id: + title: "Account ID" + description: "Harvest account ID. Required for all Harvest requests in pair\ + \ with Personal Access Token" + airbyte_secret: true + type: "string" + order: 0 + replication_start_date: + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2017-01-25T00:00:00Z" + type: "string" + order: 1 + format: "date-time" + replication_end_date: + title: "End Date" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data after this date will not be replicated." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2017-01-25T00:00:00Z" + type: "string" + airbyte_hidden: true + order: 2 + format: "date-time" + credentials: + title: "Authentication mechanism" + description: "Choose how to authenticate to Harvest." + type: "object" + order: 3 + oneOf: + - type: "object" + title: "Authenticate via Harvest (OAuth)" + required: + - "client_id" + - "client_secret" + - "refresh_token" + additionalProperties: true + properties: + auth_type: + type: "string" + const: "Client" + order: 0 + enum: + - "Client" + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Harvest developer application." + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Harvest developer application." + airbyte_secret: true + refresh_token: + title: "Refresh Token" + type: "string" + description: "Refresh Token to renew the expired Access Token." + airbyte_secret: true + x-speakeasy-param-sensitive: true + - type: "object" + title: "Authenticate with Personal Access Token" + required: + - "api_token" + additionalProperties: true + properties: + auth_type: + type: "string" + const: "Token" + order: 0 + enum: + - "Token" + api_token: + title: "Personal Access Token" + description: "Log into Harvest and then create new personal access token." + type: "string" + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "harvest" + const: "harvest" + enum: + - "harvest" + order: 0 + type: "string" + source-harvest-update: + title: "Harvest Spec" + type: "object" + required: + - "account_id" + - "replication_start_date" + properties: + account_id: + title: "Account ID" + description: "Harvest account ID. Required for all Harvest requests in pair\ + \ with Personal Access Token" + airbyte_secret: true + type: "string" + order: 0 + replication_start_date: + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2017-01-25T00:00:00Z" + type: "string" + order: 1 + format: "date-time" + replication_end_date: + title: "End Date" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data after this date will not be replicated." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2017-01-25T00:00:00Z" + type: "string" + airbyte_hidden: true + order: 2 + format: "date-time" + credentials: + title: "Authentication mechanism" + description: "Choose how to authenticate to Harvest." + type: "object" + order: 3 + oneOf: + - type: "object" + title: "Authenticate via Harvest (OAuth)" + required: + - "client_id" + - "client_secret" + - "refresh_token" + additionalProperties: true + properties: + auth_type: + type: "string" + const: "Client" + order: 0 + enum: + - "Client" + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Harvest developer application." + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Harvest developer application." + airbyte_secret: true + refresh_token: + title: "Refresh Token" + type: "string" + description: "Refresh Token to renew the expired Access Token." + airbyte_secret: true + - type: "object" + title: "Authenticate with Personal Access Token" + required: + - "api_token" + additionalProperties: true + properties: + auth_type: + type: "string" + const: "Token" + order: 0 + enum: + - "Token" + api_token: + title: "Personal Access Token" + description: "Log into Harvest and then create new personal access token." + type: "string" + airbyte_secret: true + source-yotpo: + title: "Yotpo Spec" + type: "object" + required: + - "access_token" + - "app_key" + - "start_date" + - "email" + - "sourceType" + properties: + access_token: + title: "Access Token" + type: "string" + description: "Access token recieved as a result of API call to https://api.yotpo.com/oauth/token\ + \ (Ref- https://apidocs.yotpo.com/reference/yotpo-authentication)" + airbyte_secret: true + x-speakeasy-param-sensitive: true + app_key: + title: "App Key" + type: "string" + description: "App key found at settings (Ref- https://settings.yotpo.com/#/general_settings)" + x-speakeasy-param-sensitive: true + start_date: + title: "Date-From Filter" + type: "string" + description: "Date time filter for incremental filter, Specify which date\ + \ to extract from." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$" + examples: + - "2022-03-01T00:00:00.000Z" + format: "date-time" + email: + title: "Registered email address" + type: "string" + description: "Email address registered with yotpo." + default: "example@gmail.com" + sourceType: + title: "yotpo" + const: "yotpo" + enum: + - "yotpo" + order: 0 + type: "string" + source-yotpo-update: + title: "Yotpo Spec" + type: "object" + required: + - "access_token" + - "app_key" + - "start_date" + - "email" + properties: + access_token: + title: "Access Token" + type: "string" + description: "Access token recieved as a result of API call to https://api.yotpo.com/oauth/token\ + \ (Ref- https://apidocs.yotpo.com/reference/yotpo-authentication)" + airbyte_secret: true + app_key: + title: "App Key" + type: "string" + description: "App key found at settings (Ref- https://settings.yotpo.com/#/general_settings)" + start_date: + title: "Date-From Filter" + type: "string" + description: "Date time filter for incremental filter, Specify which date\ + \ to extract from." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$" + examples: + - "2022-03-01T00:00:00.000Z" + format: "date-time" + email: + title: "Registered email address" + type: "string" + description: "Email address registered with yotpo." + default: "example@gmail.com" + source-prestashop: + title: "PrestaShop Spec" + type: "object" + required: + - "access_key" + - "url" + - "start_date" + - "sourceType" + properties: + access_key: + type: "string" + title: "Access Key" + description: "Your PrestaShop access key. See the docs for info on how to obtain this." + order: 0 + airbyte_secret: true + x-speakeasy-param-sensitive: true + url: + type: "string" + title: "Shop URL" + description: "Shop URL without trailing slash." + order: 1 + start_date: + type: "string" + title: "Start date" + description: "The Start date in the format YYYY-MM-DD." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + examples: + - "2022-01-01" + format: "date" + order: 2 + sourceType: + title: "prestashop" + const: "prestashop" + enum: + - "prestashop" + order: 0 + type: "string" + source-prestashop-update: + title: "PrestaShop Spec" + type: "object" + required: + - "access_key" + - "url" + - "start_date" + properties: + access_key: + type: "string" + title: "Access Key" + description: "Your PrestaShop access key. See the docs for info on how to obtain this." + order: 0 + airbyte_secret: true + url: + type: "string" + title: "Shop URL" + description: "Shop URL without trailing slash." + order: 1 + start_date: + type: "string" + title: "Start date" + description: "The Start date in the format YYYY-MM-DD." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + examples: + - "2022-01-01" + format: "date" + order: 2 + source-netsuite: + title: "Netsuite Spec" + type: "object" + required: + - "realm" + - "consumer_key" + - "consumer_secret" + - "token_key" + - "token_secret" + - "start_datetime" + - "sourceType" + properties: + realm: + type: "string" + title: "Realm (Account Id)" + description: "Netsuite realm e.g. 2344535, as for `production` or 2344535_SB1,\ + \ as for the `sandbox`" + order: 0 + airbyte_secret: true + consumer_key: + type: "string" + title: "Consumer Key" + description: "Consumer key associated with your integration" + order: 1 + airbyte_secret: true + x-speakeasy-param-sensitive: true + consumer_secret: + type: "string" + title: "Consumer Secret" + description: "Consumer secret associated with your integration" + order: 2 + airbyte_secret: true + token_key: + type: "string" + title: "Token Key (Token Id)" + description: "Access token key" + order: 3 + airbyte_secret: true + x-speakeasy-param-sensitive: true + token_secret: + type: "string" + title: "Token Secret" + description: "Access token secret" + order: 4 + airbyte_secret: true + x-speakeasy-param-sensitive: true + object_types: + type: "array" + title: "Object Types" + items: + type: "string" + description: "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." + order: 5 + examples: + - "customer" + - "salesorder" + - "etc" + default: [] + start_datetime: + type: "string" + title: "Start Date" + description: "Starting point for your data replication, in format of \"\ + YYYY-MM-DDTHH:mm:ssZ\"" + order: 6 + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2017-01-25T00:00:00Z" + window_in_days: + type: "integer" + title: "Window in Days" + description: "The amount of days used to query the data with date chunks.\ + \ Set smaller value, if you have lots of data." + order: 7 + default: 30 + sourceType: + title: "netsuite" + const: "netsuite" + enum: + - "netsuite" + order: 0 + type: "string" + source-netsuite-update: + title: "Netsuite Spec" + type: "object" + required: + - "realm" + - "consumer_key" + - "consumer_secret" + - "token_key" + - "token_secret" + - "start_datetime" + properties: + realm: + type: "string" + title: "Realm (Account Id)" + description: "Netsuite realm e.g. 2344535, as for `production` or 2344535_SB1,\ + \ as for the `sandbox`" + order: 0 + airbyte_secret: true + consumer_key: + type: "string" + title: "Consumer Key" + description: "Consumer key associated with your integration" + order: 1 + airbyte_secret: true + consumer_secret: + type: "string" + title: "Consumer Secret" + description: "Consumer secret associated with your integration" + order: 2 + airbyte_secret: true + token_key: + type: "string" + title: "Token Key (Token Id)" + description: "Access token key" + order: 3 + airbyte_secret: true + token_secret: + type: "string" + title: "Token Secret" + description: "Access token secret" + order: 4 + airbyte_secret: true + object_types: + type: "array" + title: "Object Types" + items: + type: "string" + description: "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." + order: 5 + examples: + - "customer" + - "salesorder" + - "etc" + default: [] + start_datetime: + type: "string" + title: "Start Date" + description: "Starting point for your data replication, in format of \"\ + YYYY-MM-DDTHH:mm:ssZ\"" + order: 6 + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2017-01-25T00:00:00Z" + window_in_days: + type: "integer" + title: "Window in Days" + description: "The amount of days used to query the data with date chunks.\ + \ Set smaller value, if you have lots of data." + order: 7 + default: 30 + source-convex: + title: "Convex Source Spec" + type: "object" + required: + - "deployment_url" + - "access_key" + - "sourceType" + properties: + deployment_url: + type: "string" + title: "Deployment Url" + examples: + - "https://murky-swan-635.convex.cloud" + - "https://cluttered-owl-337.convex.cloud" + access_key: + type: "string" + title: "Access Key" + description: "API access key used to retrieve data from Convex." + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "convex" + const: "convex" + enum: + - "convex" + order: 0 + type: "string" + source-convex-update: + title: "Convex Source Spec" + type: "object" + required: + - "deployment_url" + - "access_key" + properties: + deployment_url: + type: "string" + title: "Deployment Url" + examples: + - "https://murky-swan-635.convex.cloud" + - "https://cluttered-owl-337.convex.cloud" + access_key: + type: "string" + title: "Access Key" + description: "API access key used to retrieve data from Convex." + airbyte_secret: true + source-recurly: + title: "Recurly Source Spec" + type: "object" + required: + - "api_key" + - "sourceType" + properties: + api_key: + type: "string" + title: "API Key" + airbyte_secret: true + description: "Recurly API Key. See the docs for more information on how to generate this key." + order: 1 + x-speakeasy-param-sensitive: true + begin_time: + type: "string" + description: "ISO8601 timestamp from which the replication from Recurly\ + \ API will start from." + examples: + - "2021-12-01T00:00:00" + pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$" + order: 2 + end_time: + type: "string" + description: "ISO8601 timestamp to which the replication from Recurly API\ + \ will stop. Records after that date won't be imported." + examples: + - "2021-12-01T00:00:00" + pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$" + order: 3 + sourceType: + title: "recurly" + const: "recurly" + enum: + - "recurly" + order: 0 + type: "string" + source-recurly-update: + title: "Recurly Source Spec" + type: "object" + required: + - "api_key" + properties: + api_key: + type: "string" + title: "API Key" + airbyte_secret: true + description: "Recurly API Key. See the docs for more information on how to generate this key." + order: 1 + begin_time: + type: "string" + description: "ISO8601 timestamp from which the replication from Recurly\ + \ API will start from." + examples: + - "2021-12-01T00:00:00" + pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$" + order: 2 + end_time: + type: "string" + description: "ISO8601 timestamp to which the replication from Recurly API\ + \ will stop. Records after that date won't be imported." + examples: + - "2021-12-01T00:00:00" + pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$" + order: 3 + source-zendesk-chat: + title: "Zendesk Chat Spec" + type: "object" + required: + - "start_date" + - "sourceType" + properties: + start_date: + type: "string" + title: "Start Date" + description: "The date from which you'd like to replicate data for Zendesk\ + \ Chat API, in the format YYYY-MM-DDT00:00:00Z." + examples: + - "2021-02-01T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + format: "date-time" + subdomain: + type: "string" + title: "Subdomain" + description: "Required if you access Zendesk Chat from a Zendesk Support\ + \ subdomain." + default: "" + credentials: + title: "Authorization Method" + type: "object" + oneOf: + - type: "object" + title: "OAuth2.0" + required: + - "credentials" + properties: + credentials: + type: "string" + const: "oauth2.0" + order: 0 + enum: + - "oauth2.0" + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your OAuth application" + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of your OAuth application." + airbyte_secret: true + access_token: + type: "string" + title: "Access Token" + description: "Access Token for making authenticated requests." + airbyte_secret: true + x-speakeasy-param-sensitive: true + refresh_token: + type: "string" + title: "Refresh Token" + description: "Refresh Token to obtain new Access Token, when it's\ + \ expired." + airbyte_secret: true + x-speakeasy-param-sensitive: true + - type: "object" + title: "Access Token" + required: + - "credentials" + - "access_token" + properties: + credentials: + type: "string" + const: "access_token" + order: 0 + enum: + - "access_token" + access_token: + type: "string" + title: "Access Token" + description: "The Access Token to make authenticated requests." + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "zendesk-chat" + const: "zendesk-chat" + enum: + - "zendesk-chat" + order: 0 + type: "string" + source-zendesk-chat-update: + title: "Zendesk Chat Spec" + type: "object" + required: + - "start_date" + properties: + start_date: + type: "string" + title: "Start Date" + description: "The date from which you'd like to replicate data for Zendesk\ + \ Chat API, in the format YYYY-MM-DDT00:00:00Z." + examples: + - "2021-02-01T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + format: "date-time" + subdomain: + type: "string" + title: "Subdomain" + description: "Required if you access Zendesk Chat from a Zendesk Support\ + \ subdomain." + default: "" + credentials: + title: "Authorization Method" + type: "object" + oneOf: + - type: "object" + title: "OAuth2.0" + required: + - "credentials" + properties: + credentials: + type: "string" + const: "oauth2.0" + order: 0 + enum: + - "oauth2.0" + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your OAuth application" + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of your OAuth application." + airbyte_secret: true + access_token: + type: "string" + title: "Access Token" + description: "Access Token for making authenticated requests." + airbyte_secret: true + refresh_token: + type: "string" + title: "Refresh Token" + description: "Refresh Token to obtain new Access Token, when it's\ + \ expired." + airbyte_secret: true + - type: "object" + title: "Access Token" + required: + - "credentials" + - "access_token" + properties: + credentials: + type: "string" + const: "access_token" + order: 0 + enum: + - "access_token" + access_token: + type: "string" + title: "Access Token" + description: "The Access Token to make authenticated requests." + airbyte_secret: true + source-my-hours: + title: "My Hours Spec" + type: "object" + required: + - "email" + - "password" + - "start_date" + - "sourceType" + properties: + email: + title: "Email" + type: "string" + description: "Your My Hours username" + example: "john@doe.com" + password: + title: "Password" + type: "string" + description: "The password associated to the username" + airbyte_secret: true + x-speakeasy-param-sensitive: true + start_date: + title: "Start Date" + description: "Start date for collecting time logs" + examples: + - "%Y-%m-%d" + - "2016-01-01" + type: "string" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + logs_batch_size: + title: "Time logs batch size" + description: "Pagination size used for retrieving logs in days" + examples: + - 30 + type: "integer" + minimum: 1 + maximum: 365 + default: 30 + sourceType: + title: "my-hours" + const: "my-hours" + enum: + - "my-hours" + order: 0 + type: "string" + source-my-hours-update: + title: "My Hours Spec" + type: "object" + required: + - "email" + - "password" + - "start_date" + properties: + email: + title: "Email" + type: "string" + description: "Your My Hours username" + example: "john@doe.com" + password: + title: "Password" + type: "string" + description: "The password associated to the username" + airbyte_secret: true + start_date: + title: "Start Date" + description: "Start date for collecting time logs" + examples: + - "%Y-%m-%d" + - "2016-01-01" + type: "string" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + logs_batch_size: + title: "Time logs batch size" + description: "Pagination size used for retrieving logs in days" + examples: + - 30 + type: "integer" + minimum: 1 + maximum: 365 + default: 30 + source-zendesk-sell: + title: "Source Zendesk Sell Spec" + type: "object" + required: + - "api_token" + - "sourceType" + properties: + api_token: + title: "API token" + type: "string" + description: "The API token for authenticating to Zendesk Sell" + examples: + - "f23yhd630otl94y85a8bf384958473pto95847fd006da49382716or937ruw059" + airbyte_secret: true + order: 1 + x-speakeasy-param-sensitive: true + sourceType: + title: "zendesk-sell" + const: "zendesk-sell" + enum: + - "zendesk-sell" + order: 0 + type: "string" + source-zendesk-sell-update: + title: "Source Zendesk Sell Spec" + type: "object" + required: + - "api_token" + properties: + api_token: + title: "API token" + type: "string" + description: "The API token for authenticating to Zendesk Sell" + examples: + - "f23yhd630otl94y85a8bf384958473pto95847fd006da49382716or937ruw059" + airbyte_secret: true + order: 1 + source-klaviyo: + title: "Klaviyo Spec" + type: "object" + properties: + api_key: + title: "Api Key" + description: "Klaviyo API Key. See our docs if you need help finding this key." + airbyte_secret: true + type: "string" + order: 0 + x-speakeasy-param-sensitive: true + start_date: + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated. This field is optional\ + \ - if not provided, all data will be replicated." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2017-01-25T00:00:00Z" + type: "string" + format: "date-time" + order: 1 + sourceType: + title: "klaviyo" + const: "klaviyo" + enum: + - "klaviyo" + order: 0 + type: "string" + required: + - "api_key" + - "sourceType" + source-klaviyo-update: + title: "Klaviyo Spec" + type: "object" + properties: + api_key: + title: "Api Key" + description: "Klaviyo API Key. See our docs if you need help finding this key." + airbyte_secret: true + type: "string" + order: 0 + start_date: + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated. This field is optional\ + \ - if not provided, all data will be replicated." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2017-01-25T00:00:00Z" + type: "string" + format: "date-time" + order: 1 + required: + - "api_key" + source-quickbooks: + title: "Source QuickBooks Spec" + type: "object" + required: + - "credentials" + - "start_date" + - "sandbox" + - "sourceType" + properties: + credentials: + title: "Authorization Method" + type: "object" + order: 0 + oneOf: + - type: "object" + title: "OAuth2.0" + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "access_token" + - "token_expiry_date" + - "realm_id" + properties: + auth_type: + type: "string" + const: "oauth2.0" + enum: + - "oauth2.0" + client_id: + type: "string" + title: "Client ID" + description: "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: + description: " 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." + title: "Client Secret" + type: "string" + airbyte_secret: true + refresh_token: + description: "A token used when refreshing the access token." + title: "Refresh Token" + type: "string" + airbyte_secret: true + x-speakeasy-param-sensitive: true + access_token: + description: "Access token for making authenticated requests." + title: "Access Token" + type: "string" + airbyte_secret: true + x-speakeasy-param-sensitive: true + token_expiry_date: + type: "string" + title: "Token Expiry Date" + description: "The date-time when the access token should be refreshed." + format: "date-time" + x-speakeasy-param-sensitive: true + realm_id: + description: "Labeled Company ID. The Make API Calls panel is populated\ + \ with the realm id and the current access token." + title: "Realm ID" + type: "string" + airbyte_secret: true + start_date: + order: 1 + description: "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." + title: "Start Date" + type: "string" + format: "date-time" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2021-03-20T00:00:00Z" + sandbox: + order: 2 + description: "Determines whether to use the sandbox or production environment." + title: "Sandbox" + type: "boolean" + default: false + sourceType: + title: "quickbooks" + const: "quickbooks" + enum: + - "quickbooks" + order: 0 + type: "string" + source-quickbooks-update: + title: "Source QuickBooks Spec" + type: "object" + required: + - "credentials" + - "start_date" + - "sandbox" + properties: + credentials: + title: "Authorization Method" + type: "object" + order: 0 + oneOf: + - type: "object" + title: "OAuth2.0" + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "access_token" + - "token_expiry_date" + - "realm_id" + properties: + auth_type: + type: "string" + const: "oauth2.0" + enum: + - "oauth2.0" + client_id: + type: "string" + title: "Client ID" + description: "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: + description: " 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." + title: "Client Secret" + type: "string" + airbyte_secret: true + refresh_token: + description: "A token used when refreshing the access token." + title: "Refresh Token" + type: "string" + airbyte_secret: true + access_token: + description: "Access token for making authenticated requests." + title: "Access Token" + type: "string" + airbyte_secret: true + token_expiry_date: + type: "string" + title: "Token Expiry Date" + description: "The date-time when the access token should be refreshed." + format: "date-time" + realm_id: + description: "Labeled Company ID. The Make API Calls panel is populated\ + \ with the realm id and the current access token." + title: "Realm ID" + type: "string" + airbyte_secret: true + start_date: + order: 1 + description: "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." + title: "Start Date" + type: "string" + format: "date-time" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2021-03-20T00:00:00Z" + sandbox: + order: 2 + description: "Determines whether to use the sandbox or production environment." + title: "Sandbox" + type: "boolean" + default: false + source-dockerhub: + type: "object" + required: + - "docker_username" + - "sourceType" + properties: + docker_username: + type: "string" + order: 0 + title: "Docker Username" + description: "Username of DockerHub person or organization (for https://hub.docker.com/v2/repositories/USERNAME/\ + \ API call)" + pattern: "^[a-z0-9_\\-]+$" + examples: + - "airbyte" + sourceType: + title: "dockerhub" + const: "dockerhub" + enum: + - "dockerhub" + order: 0 + type: "string" + source-dockerhub-update: + type: "object" + required: + - "docker_username" + properties: + docker_username: + type: "string" + order: 0 + title: "Docker Username" + description: "Username of DockerHub person or organization (for https://hub.docker.com/v2/repositories/USERNAME/\ + \ API call)" + pattern: "^[a-z0-9_\\-]+$" + examples: + - "airbyte" + source-webflow: + title: "Webflow Spec" + type: "object" + required: + - "api_key" + - "site_id" + - "sourceType" + properties: + site_id: + title: "Site id" + type: "string" + description: "The id of the Webflow site you are requesting data from. See\ + \ https://developers.webflow.com/#sites" + example: "a relatively long hex sequence" + order: 0 + api_key: + title: "API token" + type: "string" + description: "The API token for authenticating to Webflow. See https://university.webflow.com/lesson/intro-to-the-webflow-api" + example: "a very long hex sequence" + order: 1 + airbyte_secret: true + x-speakeasy-param-sensitive: true + accept_version: + title: "Accept Version" + type: "string" + description: "The version of the Webflow API to use. See https://developers.webflow.com/#versioning" + example: "1.0.0" + order: 2 + sourceType: + title: "webflow" + const: "webflow" + enum: + - "webflow" + order: 0 + type: "string" + source-webflow-update: + title: "Webflow Spec" + type: "object" + required: + - "api_key" + - "site_id" + properties: + site_id: + title: "Site id" + type: "string" + description: "The id of the Webflow site you are requesting data from. See\ + \ https://developers.webflow.com/#sites" + example: "a relatively long hex sequence" + order: 0 + api_key: + title: "API token" + type: "string" + description: "The API token for authenticating to Webflow. See https://university.webflow.com/lesson/intro-to-the-webflow-api" + example: "a very long hex sequence" + order: 1 + airbyte_secret: true + accept_version: + title: "Accept Version" + type: "string" + description: "The version of the Webflow API to use. See https://developers.webflow.com/#versioning" + example: "1.0.0" + order: 2 + source-wikipedia-pageviews: + title: "Wikipedia Pageviews Spec" + type: "object" + required: + - "project" + - "access" + - "agent" + - "article" + - "start" + - "end" + - "country" + - "sourceType" + properties: + project: + type: "string" + title: "Project" + description: "If you want to filter by project, use the domain of any Wikimedia\ + \ project." + examples: + - "en.wikipedia.org" + - "www.mediawiki.org" + - "commons.wikimedia.org" + access: + type: "string" + title: "Access" + description: "If you want to filter by access method, use one of desktop,\ + \ mobile-app or mobile-web. If you are interested in pageviews regardless\ + \ of access method, use all-access." + examples: + - "all-access" + - "desktop" + - "mobile-app" + - "mobile-web" + agent: + type: "string" + title: "Agent" + description: "If you want to filter by agent type, use one of user, automated\ + \ or spider. If you are interested in pageviews regardless of agent type,\ + \ use all-agents." + examples: + - "all-agents" + - "user" + - "spider" + - "automated" + article: + type: "string" + title: "Article" + description: "The title of any article in the specified project. Any spaces\ + \ should be replaced with underscores. It also should be URI-encoded,\ + \ so that non-URI-safe characters like %, / or ? are accepted." + examples: + - "Are_You_the_One%3F" + start: + type: "string" + title: "Start" + description: "The date of the first day to include, in YYYYMMDD or YYYYMMDDHH\ + \ format." + end: + type: "string" + title: "End" + description: "The date of the last day to include, in YYYYMMDD or YYYYMMDDHH\ + \ format." + country: + type: "string" + title: "Country" + description: "The ISO 3166-1 alpha-2 code of a country for which to retrieve\ + \ top articles." + examples: + - "FR" + - "IN" + sourceType: + title: "wikipedia-pageviews" + const: "wikipedia-pageviews" + enum: + - "wikipedia-pageviews" + order: 0 + type: "string" + source-wikipedia-pageviews-update: + title: "Wikipedia Pageviews Spec" + type: "object" + required: + - "project" + - "access" + - "agent" + - "article" + - "start" + - "end" + - "country" + properties: + project: + type: "string" + title: "Project" + description: "If you want to filter by project, use the domain of any Wikimedia\ + \ project." + examples: + - "en.wikipedia.org" + - "www.mediawiki.org" + - "commons.wikimedia.org" + access: + type: "string" + title: "Access" + description: "If you want to filter by access method, use one of desktop,\ + \ mobile-app or mobile-web. If you are interested in pageviews regardless\ + \ of access method, use all-access." + examples: + - "all-access" + - "desktop" + - "mobile-app" + - "mobile-web" + agent: + type: "string" + title: "Agent" + description: "If you want to filter by agent type, use one of user, automated\ + \ or spider. If you are interested in pageviews regardless of agent type,\ + \ use all-agents." + examples: + - "all-agents" + - "user" + - "spider" + - "automated" + article: + type: "string" + title: "Article" + description: "The title of any article in the specified project. Any spaces\ + \ should be replaced with underscores. It also should be URI-encoded,\ + \ so that non-URI-safe characters like %, / or ? are accepted." + examples: + - "Are_You_the_One%3F" + start: + type: "string" + title: "Start" + description: "The date of the first day to include, in YYYYMMDD or YYYYMMDDHH\ + \ format." + end: + type: "string" + title: "End" + description: "The date of the last day to include, in YYYYMMDD or YYYYMMDDHH\ + \ format." + country: + type: "string" + title: "Country" + description: "The ISO 3166-1 alpha-2 code of a country for which to retrieve\ + \ top articles." + examples: + - "FR" + - "IN" + source-google-directory: + title: "Google Directory Spec" + type: "object" + required: + - "sourceType" + properties: + credentials: + title: "Google Credentials" + description: "Google APIs use the OAuth 2.0 protocol for authentication\ + \ and authorization. The Source supports Web server application and Service accounts scenarios." + type: "object" + oneOf: + - title: "Sign in via Google (OAuth)" + description: "For these scenario user only needs to give permission to\ + \ read Google Directory data." + type: "object" + required: + - "client_id" + - "client_secret" + - "refresh_token" + properties: + credentials_title: + type: "string" + title: "Credentials Title" + description: "Authentication Scenario" + const: "Web server app" + order: 0 + enum: + - "Web server app" + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of the developer application." + airbyte_secret: true + client_secret: + title: "Client secret" + type: "string" + description: "The Client Secret of the developer application." + airbyte_secret: true + refresh_token: + title: "Refresh Token" + type: "string" + description: "The Token for obtaining a new access token." + airbyte_secret: true + x-speakeasy-param-sensitive: true + - title: "Service Account Key" + description: "For these scenario user should obtain service account's\ + \ credentials from the Google API Console and provide delegated email." + type: "object" + required: + - "credentials_json" + - "email" + properties: + credentials_title: + type: "string" + title: "Credentials Title" + description: "Authentication Scenario" + const: "Service accounts" + order: 0 + enum: + - "Service accounts" + credentials_json: + type: "string" + title: "Credentials JSON" + description: "The contents of the JSON service account key. See the\ + \ docs for more information on how to generate this key." + airbyte_secret: true + email: + type: "string" + title: "Email" + description: "The email of the user, which has permissions to access\ + \ the Google Workspace Admin APIs." + sourceType: + title: "google-directory" + const: "google-directory" + enum: + - "google-directory" + order: 0 + type: "string" + source-google-directory-update: + title: "Google Directory Spec" + type: "object" + required: [] + properties: + credentials: + title: "Google Credentials" + description: "Google APIs use the OAuth 2.0 protocol for authentication\ + \ and authorization. The Source supports Web server application and Service accounts scenarios." + type: "object" + oneOf: + - title: "Sign in via Google (OAuth)" + description: "For these scenario user only needs to give permission to\ + \ read Google Directory data." + type: "object" + required: + - "client_id" + - "client_secret" + - "refresh_token" + properties: + credentials_title: + type: "string" + title: "Credentials Title" + description: "Authentication Scenario" + const: "Web server app" + order: 0 + enum: + - "Web server app" + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of the developer application." + airbyte_secret: true + client_secret: + title: "Client secret" + type: "string" + description: "The Client Secret of the developer application." + airbyte_secret: true + refresh_token: + title: "Refresh Token" + type: "string" + description: "The Token for obtaining a new access token." + airbyte_secret: true + - title: "Service Account Key" + description: "For these scenario user should obtain service account's\ + \ credentials from the Google API Console and provide delegated email." + type: "object" + required: + - "credentials_json" + - "email" + properties: + credentials_title: + type: "string" + title: "Credentials Title" + description: "Authentication Scenario" + const: "Service accounts" + order: 0 + enum: + - "Service accounts" + credentials_json: + type: "string" + title: "Credentials JSON" + description: "The contents of the JSON service account key. See the\ + \ docs for more information on how to generate this key." + airbyte_secret: true + email: + type: "string" + title: "Email" + description: "The email of the user, which has permissions to access\ + \ the Google Workspace Admin APIs." + source-smartengage: + title: "SmartEngage Spec" + type: "object" + required: + - "api_key" + - "sourceType" + properties: + api_key: + title: "API Key" + type: "string" + description: "API Key" + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "smartengage" + const: "smartengage" + enum: + - "smartengage" + order: 0 + type: "string" + source-smartengage-update: + title: "SmartEngage Spec" + type: "object" + required: + - "api_key" + properties: + api_key: + title: "API Key" + type: "string" + description: "API Key" + airbyte_secret: true + source-outbrain-amplify: + title: "Outbrain Amplify Spec" + type: "object" + required: + - "credentials" + - "start_date" + - "sourceType" + properties: + credentials: + title: "Authentication Method" + description: "Credentials for making authenticated requests requires either\ + \ username/password or access_token." + default: {} + order: 0 + type: "object" + oneOf: + - title: "Access token" + type: "object" + properties: + type: + title: "Access token is required for authentication requests." + const: "access_token" + type: "string" + enum: + - "access_token" + access_token: + type: "string" + description: "Access Token for making authenticated requests." + airbyte_secret: true + x-speakeasy-param-sensitive: true + required: + - "type" + - "access_token" + - title: "Username Password" + type: "object" + properties: + type: + title: "Both username and password is required for authentication\ + \ request." + const: "username_password" + type: "string" + enum: + - "username_password" + username: + type: "string" + description: "Add Username for authentication." + password: + type: "string" + description: "Add Password for authentication." + airbyte_secret: true + x-speakeasy-param-sensitive: true + required: + - "type" + - "username" + - "password" + report_granularity: + title: "Granularity for periodic reports." + description: "The granularity used for periodic data in reports. See the docs." + enum: + - "daily" + - "weekly" + - "monthly" + order: 1 + type: "string" + geo_location_breakdown: + title: "Granularity for geo-location region." + description: "The granularity used for geo location data in reports." + enum: + - "country" + - "region" + - "subregion" + order: 2 + type: "string" + start_date: + type: "string" + order: 3 + description: "Date in the format YYYY-MM-DD eg. 2017-01-25. Any data before\ + \ this date will not be replicated." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + end_date: + type: "string" + order: 4 + description: "Date in the format YYYY-MM-DD." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + sourceType: + title: "outbrain-amplify" + const: "outbrain-amplify" + enum: + - "outbrain-amplify" + order: 0 + type: "string" + source-outbrain-amplify-update: + title: "Outbrain Amplify Spec" + type: "object" + required: + - "credentials" + - "start_date" + properties: + credentials: + title: "Authentication Method" + description: "Credentials for making authenticated requests requires either\ + \ username/password or access_token." + default: {} + order: 0 + type: "object" + oneOf: + - title: "Access token" + type: "object" + properties: + type: + title: "Access token is required for authentication requests." + const: "access_token" + type: "string" + enum: + - "access_token" + access_token: + type: "string" + description: "Access Token for making authenticated requests." + airbyte_secret: true + required: + - "type" + - "access_token" + - title: "Username Password" + type: "object" + properties: + type: + title: "Both username and password is required for authentication\ + \ request." + const: "username_password" + type: "string" + enum: + - "username_password" + username: + type: "string" + description: "Add Username for authentication." + password: + type: "string" + description: "Add Password for authentication." + airbyte_secret: true + required: + - "type" + - "username" + - "password" + report_granularity: + title: "Granularity for periodic reports." + description: "The granularity used for periodic data in reports. See the docs." + enum: + - "daily" + - "weekly" + - "monthly" + order: 1 + type: "string" + geo_location_breakdown: + title: "Granularity for geo-location region." + description: "The granularity used for geo location data in reports." + enum: + - "country" + - "region" + - "subregion" + order: 2 + type: "string" + start_date: + type: "string" + order: 3 + description: "Date in the format YYYY-MM-DD eg. 2017-01-25. Any data before\ + \ this date will not be replicated." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + end_date: + type: "string" + order: 4 + description: "Date in the format YYYY-MM-DD." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + source-k6-cloud: + title: "K6 Cloud Spec" + type: "object" + required: + - "api_token" + - "sourceType" + properties: + api_token: + title: "Api Token" + type: "string" + description: "Your API Token. See here. The key is case sensitive." + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "k6-cloud" + const: "k6-cloud" + enum: + - "k6-cloud" + order: 0 + type: "string" + source-k6-cloud-update: + title: "K6 Cloud Spec" + type: "object" + required: + - "api_token" + properties: + api_token: + title: "Api Token" + type: "string" + description: "Your API Token. See here. The key is case sensitive." + airbyte_secret: true + source-postgres: + title: "Postgres Source Spec" + type: "object" + required: + - "host" + - "port" + - "database" + - "username" + - "sourceType" + properties: + host: + title: "Host" + description: "Hostname of the database." + type: "string" + order: 0 + group: "db" + port: + title: "Port" + description: "Port of the database." + type: "integer" + minimum: 0 + maximum: 65536 + default: 5432 + examples: + - "5432" + order: 1 + group: "db" + database: + title: "Database Name" + description: "Name of the database." + type: "string" + order: 2 + group: "db" + schemas: + title: "Schemas" + description: "The list of schemas (case sensitive) to sync from. Defaults\ + \ to public." + type: "array" + items: + type: "string" + minItems: 0 + uniqueItems: true + default: + - "public" + order: 3 + group: "db" + username: + title: "Username" + description: "Username to access the database." + type: "string" + order: 4 + group: "auth" + password: + title: "Password" + description: "Password associated with the username." + type: "string" + airbyte_secret: true + order: 5 + group: "auth" + always_show: true + x-speakeasy-param-sensitive: true + jdbc_url_params: + description: "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." + title: "JDBC URL Parameters (Advanced)" + type: "string" + order: 6 + group: "advanced" + pattern_descriptor: "key1=value1&key2=value2" + ssl_mode: + title: "SSL Modes" + description: "SSL connection modes. \n Read more in the docs." + type: "object" + order: 8 + group: "security" + oneOf: + - title: "disable" + additionalProperties: true + description: "Disables encryption of communication between Airbyte and\ + \ source database." + required: + - "mode" + properties: + mode: + type: "string" + const: "disable" + order: 0 + enum: + - "disable" + - title: "allow" + additionalProperties: true + description: "Enables encryption only when required by the source database." + required: + - "mode" + properties: + mode: + type: "string" + const: "allow" + order: 0 + enum: + - "allow" + - title: "prefer" + additionalProperties: true + description: "Allows unencrypted connection only if the source database\ + \ does not support encryption." + required: + - "mode" + properties: + mode: + type: "string" + const: "prefer" + order: 0 + enum: + - "prefer" + - title: "require" + additionalProperties: true + description: "Always require encryption. If the source database server\ + \ does not support encryption, connection will fail." + required: + - "mode" + properties: + mode: + type: "string" + const: "require" + order: 0 + enum: + - "require" + - title: "verify-ca" + additionalProperties: true + description: "Always require encryption and verifies that the source database\ + \ server has a valid SSL certificate." + required: + - "mode" + - "ca_certificate" + properties: + mode: + type: "string" + const: "verify-ca" + order: 0 + enum: + - "verify-ca" + ca_certificate: + type: "string" + title: "CA Certificate" + description: "CA certificate" + airbyte_secret: true + multiline: true + order: 1 + client_certificate: + type: "string" + title: "Client Certificate" + description: "Client certificate" + airbyte_secret: true + multiline: true + order: 2 + always_show: true + client_key: + type: "string" + title: "Client Key" + description: "Client key" + airbyte_secret: true + multiline: true + order: 3 + always_show: true + x-speakeasy-param-sensitive: true + client_key_password: + type: "string" + title: "Client key password" + description: "Password for keystorage. If you do not add it - the\ + \ password will be generated automatically." + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + - title: "verify-full" + additionalProperties: true + description: "This is the most secure mode. Always require encryption\ + \ and verifies the identity of the source database server." + required: + - "mode" + - "ca_certificate" + properties: + mode: + type: "string" + const: "verify-full" + order: 0 + enum: + - "verify-full" + ca_certificate: + type: "string" + title: "CA Certificate" + description: "CA certificate" + airbyte_secret: true + multiline: true + order: 1 + client_certificate: + type: "string" + title: "Client Certificate" + description: "Client certificate" + airbyte_secret: true + multiline: true + order: 2 + always_show: true + client_key: + type: "string" + title: "Client Key" + description: "Client key" + airbyte_secret: true + multiline: true + order: 3 + always_show: true + x-speakeasy-param-sensitive: true + client_key_password: + type: "string" + title: "Client key password" + description: "Password for keystorage. If you do not add it - the\ + \ password will be generated automatically." + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + default: "require" + replication_method: + type: "object" + title: "Update Method" + description: "Configures how data is extracted from the database." + order: 9 + group: "advanced" + default: "CDC" + display_type: "radio" + oneOf: + - title: "Read Changes using Write-Ahead Log (CDC)" + description: "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." + required: + - "method" + - "replication_slot" + - "publication" + additionalProperties: true + properties: + method: + type: "string" + const: "CDC" + order: 1 + enum: + - "CDC" + plugin: + type: "string" + title: "Plugin" + description: "A logical decoding plugin installed on the PostgreSQL\ + \ server." + enum: + - "pgoutput" + default: "pgoutput" + order: 2 + replication_slot: + type: "string" + title: "Replication Slot" + description: "A plugin logical replication slot. Read about replication slots." + order: 3 + publication: + type: "string" + title: "Publication" + description: "A Postgres publication used for consuming changes. Read\ + \ about publications and replication identities." + order: 4 + initial_waiting_seconds: + type: "integer" + title: "Initial Waiting Time in Seconds (Advanced)" + description: "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." + default: 1200 + order: 5 + min: 120 + max: 2400 + queue_size: + type: "integer" + title: "Size of the queue (Advanced)" + description: "The size of the internal queue. This may interfere with\ + \ memory consumption and efficiency of the connector, please be\ + \ careful." + default: 10000 + order: 6 + min: 1000 + max: 10000 + lsn_commit_behaviour: + type: "string" + title: "LSN commit behaviour" + description: "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." + enum: + - "While reading Data" + - "After loading Data in the destination" + default: "After loading Data in the destination" + order: 7 + heartbeat_action_query: + type: "string" + title: "Debezium heartbeat query (Advanced)" + description: "Specifies a query that the connector executes on the\ + \ source database when the connector sends a heartbeat message.\ + \ Please see the setup guide for how and when to configure this setting." + default: "" + order: 8 + invalid_cdc_cursor_position_behavior: + type: "string" + title: "Invalid CDC position behavior (Advanced)" + description: "Determines whether Airbyte should fail or re-sync data\ + \ in case of an stale/invalid cursor value into the WAL. If 'Fail\ + \ sync' is chosen, a user will have to manually reset the connection\ + \ before being able to continue syncing data. If 'Re-sync data'\ + \ is chosen, Airbyte will automatically trigger a refresh but could\ + \ lead to higher cloud costs and data loss." + enum: + - "Fail sync" + - "Re-sync data" + default: "Fail sync" + order: 9 + - title: "Detect Changes with Xmin System Column" + description: "Recommended - Incrementally reads new inserts and\ + \ updates via Postgres Xmin system column. Only recommended for tables up to 500GB." + required: + - "method" + properties: + method: + type: "string" + const: "Xmin" + order: 0 + enum: + - "Xmin" + - title: "Scan Changes with User Defined Cursor" + description: "Incrementally detects new inserts and updates using the\ + \ cursor column chosen when configuring a connection (e.g. created_at,\ + \ updated_at)." + required: + - "method" + properties: + method: + type: "string" + const: "Standard" + order: 8 + enum: + - "Standard" + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + x-speakeasy-param-sensitive: true + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + group: "security" + sourceType: + title: "postgres" + const: "postgres" + enum: + - "postgres" + order: 0 + type: "string" + groups: + - id: "db" + - id: "auth" + - id: "security" + title: "Security" + - id: "advanced" + title: "Advanced" + source-postgres-update: + title: "Postgres Source Spec" + type: "object" + required: + - "host" + - "port" + - "database" + - "username" + properties: + host: + title: "Host" + description: "Hostname of the database." + type: "string" + order: 0 + group: "db" + port: + title: "Port" + description: "Port of the database." + type: "integer" + minimum: 0 + maximum: 65536 + default: 5432 + examples: + - "5432" + order: 1 + group: "db" + database: + title: "Database Name" + description: "Name of the database." + type: "string" + order: 2 + group: "db" + schemas: + title: "Schemas" + description: "The list of schemas (case sensitive) to sync from. Defaults\ + \ to public." + type: "array" + items: + type: "string" + minItems: 0 + uniqueItems: true + default: + - "public" + order: 3 + group: "db" + username: + title: "Username" + description: "Username to access the database." + type: "string" + order: 4 + group: "auth" + password: + title: "Password" + description: "Password associated with the username." + type: "string" + airbyte_secret: true + order: 5 + group: "auth" + always_show: true + jdbc_url_params: + description: "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." + title: "JDBC URL Parameters (Advanced)" + type: "string" + order: 6 + group: "advanced" + pattern_descriptor: "key1=value1&key2=value2" + ssl_mode: + title: "SSL Modes" + description: "SSL connection modes. \n Read more in the docs." + type: "object" + order: 8 + group: "security" + oneOf: + - title: "disable" + additionalProperties: true + description: "Disables encryption of communication between Airbyte and\ + \ source database." + required: + - "mode" + properties: + mode: + type: "string" + const: "disable" + order: 0 + enum: + - "disable" + - title: "allow" + additionalProperties: true + description: "Enables encryption only when required by the source database." + required: + - "mode" + properties: + mode: + type: "string" + const: "allow" + order: 0 + enum: + - "allow" + - title: "prefer" + additionalProperties: true + description: "Allows unencrypted connection only if the source database\ + \ does not support encryption." + required: + - "mode" + properties: + mode: + type: "string" + const: "prefer" + order: 0 + enum: + - "prefer" + - title: "require" + additionalProperties: true + description: "Always require encryption. If the source database server\ + \ does not support encryption, connection will fail." + required: + - "mode" + properties: + mode: + type: "string" + const: "require" + order: 0 + enum: + - "require" + - title: "verify-ca" + additionalProperties: true + description: "Always require encryption and verifies that the source database\ + \ server has a valid SSL certificate." + required: + - "mode" + - "ca_certificate" + properties: + mode: + type: "string" + const: "verify-ca" + order: 0 + enum: + - "verify-ca" + ca_certificate: + type: "string" + title: "CA Certificate" + description: "CA certificate" + airbyte_secret: true + multiline: true + order: 1 + client_certificate: + type: "string" + title: "Client Certificate" + description: "Client certificate" + airbyte_secret: true + multiline: true + order: 2 + always_show: true + client_key: + type: "string" + title: "Client Key" + description: "Client key" + airbyte_secret: true + multiline: true + order: 3 + always_show: true + client_key_password: + type: "string" + title: "Client key password" + description: "Password for keystorage. If you do not add it - the\ + \ password will be generated automatically." + airbyte_secret: true + order: 4 + - title: "verify-full" + additionalProperties: true + description: "This is the most secure mode. Always require encryption\ + \ and verifies the identity of the source database server." + required: + - "mode" + - "ca_certificate" + properties: + mode: + type: "string" + const: "verify-full" + order: 0 + enum: + - "verify-full" + ca_certificate: + type: "string" + title: "CA Certificate" + description: "CA certificate" + airbyte_secret: true + multiline: true + order: 1 + client_certificate: + type: "string" + title: "Client Certificate" + description: "Client certificate" + airbyte_secret: true + multiline: true + order: 2 + always_show: true + client_key: + type: "string" + title: "Client Key" + description: "Client key" + airbyte_secret: true + multiline: true + order: 3 + always_show: true + client_key_password: + type: "string" + title: "Client key password" + description: "Password for keystorage. If you do not add it - the\ + \ password will be generated automatically." + airbyte_secret: true + order: 4 + default: "require" + replication_method: + type: "object" + title: "Update Method" + description: "Configures how data is extracted from the database." + order: 9 + group: "advanced" + default: "CDC" + display_type: "radio" + oneOf: + - title: "Read Changes using Write-Ahead Log (CDC)" + description: "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." + required: + - "method" + - "replication_slot" + - "publication" + additionalProperties: true + properties: + method: + type: "string" + const: "CDC" + order: 1 + enum: + - "CDC" + plugin: + type: "string" + title: "Plugin" + description: "A logical decoding plugin installed on the PostgreSQL\ + \ server." + enum: + - "pgoutput" + default: "pgoutput" + order: 2 + replication_slot: + type: "string" + title: "Replication Slot" + description: "A plugin logical replication slot. Read about replication slots." + order: 3 + publication: + type: "string" + title: "Publication" + description: "A Postgres publication used for consuming changes. Read\ + \ about publications and replication identities." + order: 4 + initial_waiting_seconds: + type: "integer" + title: "Initial Waiting Time in Seconds (Advanced)" + description: "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." + default: 1200 + order: 5 + min: 120 + max: 2400 + queue_size: + type: "integer" + title: "Size of the queue (Advanced)" + description: "The size of the internal queue. This may interfere with\ + \ memory consumption and efficiency of the connector, please be\ + \ careful." + default: 10000 + order: 6 + min: 1000 + max: 10000 + lsn_commit_behaviour: + type: "string" + title: "LSN commit behaviour" + description: "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." + enum: + - "While reading Data" + - "After loading Data in the destination" + default: "After loading Data in the destination" + order: 7 + heartbeat_action_query: + type: "string" + title: "Debezium heartbeat query (Advanced)" + description: "Specifies a query that the connector executes on the\ + \ source database when the connector sends a heartbeat message.\ + \ Please see the setup guide for how and when to configure this setting." + default: "" + order: 8 + invalid_cdc_cursor_position_behavior: + type: "string" + title: "Invalid CDC position behavior (Advanced)" + description: "Determines whether Airbyte should fail or re-sync data\ + \ in case of an stale/invalid cursor value into the WAL. If 'Fail\ + \ sync' is chosen, a user will have to manually reset the connection\ + \ before being able to continue syncing data. If 'Re-sync data'\ + \ is chosen, Airbyte will automatically trigger a refresh but could\ + \ lead to higher cloud costs and data loss." + enum: + - "Fail sync" + - "Re-sync data" + default: "Fail sync" + order: 9 + - title: "Detect Changes with Xmin System Column" + description: "Recommended - Incrementally reads new inserts and\ + \ updates via Postgres Xmin system column. Only recommended for tables up to 500GB." + required: + - "method" + properties: + method: + type: "string" + const: "Xmin" + order: 0 + enum: + - "Xmin" + - title: "Scan Changes with User Defined Cursor" + description: "Incrementally detects new inserts and updates using the\ + \ cursor column chosen when configuring a connection (e.g. created_at,\ + \ updated_at)." + required: + - "method" + properties: + method: + type: "string" + const: "Standard" + order: 8 + enum: + - "Standard" + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + group: "security" + groups: + - id: "db" + - id: "auth" + - id: "security" + title: "Security" + - id: "advanced" + title: "Advanced" + source-fauna: + title: "Fauna Spec" + type: "object" + required: + - "domain" + - "port" + - "scheme" + - "secret" + - "sourceType" + properties: + domain: + order: 0 + type: "string" + title: "Domain" + description: "Domain of Fauna to query. Defaults db.fauna.com. See the\ + \ docs." + default: "db.fauna.com" + port: + order: 1 + type: "integer" + title: "Port" + description: "Endpoint port." + default: 443 + scheme: + order: 2 + type: "string" + title: "Scheme" + description: "URL scheme." + default: "https" + secret: + order: 3 + type: "string" + title: "Fauna Secret" + description: "Fauna secret, used when authenticating with the database." + airbyte_secret: true + collection: + order: 5 + type: "object" + title: "Collection" + description: "Settings for the Fauna Collection." + required: + - "page_size" + - "deletions" + properties: + page_size: + order: 4 + type: "integer" + title: "Page Size" + default: 64 + description: "The page size used when reading documents from the database.\ + \ The larger the page size, the faster the connector processes documents.\ + \ However, if a page is too large, the connector may fail.
\n\ + Choose your page size based on how large the documents are.
\n\ + See the docs." + deletions: + order: 5 + type: "object" + title: "Deletion Mode" + description: "This only applies to incremental syncs.
\n\ + Enabling deletion mode informs your destination of deleted documents.
\n\ + Disabled - Leave this feature disabled, and ignore deleted documents.
\n\ + Enabled - Enables this feature. When a document is deleted, the connector\ + \ exports a record with a \"deleted at\" column containing the time\ + \ that the document was deleted." + oneOf: + - title: "Disabled" + type: "object" + order: 0 + required: + - "deletion_mode" + properties: + deletion_mode: + type: "string" + const: "ignore" + enum: + - "ignore" + - title: "Enabled" + type: "object" + order: 1 + required: + - "deletion_mode" + - "column" + properties: + deletion_mode: + type: "string" + const: "deleted_field" + enum: + - "deleted_field" + column: + type: "string" + title: "Deleted At Column" + description: "Name of the \"deleted at\" column." + default: "deleted_at" + sourceType: + title: "fauna" + const: "fauna" + enum: + - "fauna" + order: 0 + type: "string" + source-fauna-update: + title: "Fauna Spec" + type: "object" + required: + - "domain" + - "port" + - "scheme" + - "secret" + properties: + domain: + order: 0 + type: "string" + title: "Domain" + description: "Domain of Fauna to query. Defaults db.fauna.com. See the\ + \ docs." + default: "db.fauna.com" + port: + order: 1 + type: "integer" + title: "Port" + description: "Endpoint port." + default: 443 + scheme: + order: 2 + type: "string" + title: "Scheme" + description: "URL scheme." + default: "https" + secret: + order: 3 + type: "string" + title: "Fauna Secret" + description: "Fauna secret, used when authenticating with the database." + airbyte_secret: true + collection: + order: 5 + type: "object" + title: "Collection" + description: "Settings for the Fauna Collection." + required: + - "page_size" + - "deletions" + properties: + page_size: + order: 4 + type: "integer" + title: "Page Size" + default: 64 + description: "The page size used when reading documents from the database.\ + \ The larger the page size, the faster the connector processes documents.\ + \ However, if a page is too large, the connector may fail.
\n\ + Choose your page size based on how large the documents are.
\n\ + See the docs." + deletions: + order: 5 + type: "object" + title: "Deletion Mode" + description: "This only applies to incremental syncs.
\n\ + Enabling deletion mode informs your destination of deleted documents.
\n\ + Disabled - Leave this feature disabled, and ignore deleted documents.
\n\ + Enabled - Enables this feature. When a document is deleted, the connector\ + \ exports a record with a \"deleted at\" column containing the time\ + \ that the document was deleted." + oneOf: + - title: "Disabled" + type: "object" + order: 0 + required: + - "deletion_mode" + properties: + deletion_mode: + type: "string" + const: "ignore" + enum: + - "ignore" + - title: "Enabled" + type: "object" + order: 1 + required: + - "deletion_mode" + - "column" + properties: + deletion_mode: + type: "string" + const: "deleted_field" + enum: + - "deleted_field" + column: + type: "string" + title: "Deleted At Column" + description: "Name of the \"deleted at\" column." + default: "deleted_at" + source-twilio: + title: "Twilio Spec" + type: "object" + required: + - "account_sid" + - "auth_token" + - "start_date" + - "sourceType" + properties: + account_sid: + title: "Account ID" + description: "Twilio account SID" + airbyte_secret: true + type: "string" + order: 1 + auth_token: + title: "Auth Token" + description: "Twilio Auth Token." + airbyte_secret: true + type: "string" + order: 2 + x-speakeasy-param-sensitive: true + start_date: + title: "Replication Start Date" + description: "UTC date and time in the format 2020-10-01T00:00:00Z. Any\ + \ data before this date will not be replicated." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2020-10-01T00:00:00Z" + type: "string" + order: 3 + format: "date-time" + lookback_window: + title: "Lookback window" + description: "How far into the past to look for records. (in minutes)" + examples: + - 60 + default: 0 + minimum: 0 + maximum: 576000 + type: "integer" + order: 4 + sourceType: + title: "twilio" + const: "twilio" + enum: + - "twilio" + order: 0 + type: "string" + source-twilio-update: + title: "Twilio Spec" + type: "object" + required: + - "account_sid" + - "auth_token" + - "start_date" + properties: + account_sid: + title: "Account ID" + description: "Twilio account SID" + airbyte_secret: true + type: "string" + order: 1 + auth_token: + title: "Auth Token" + description: "Twilio Auth Token." + airbyte_secret: true + type: "string" + order: 2 + start_date: + title: "Replication Start Date" + description: "UTC date and time in the format 2020-10-01T00:00:00Z. Any\ + \ data before this date will not be replicated." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2020-10-01T00:00:00Z" + type: "string" + order: 3 + format: "date-time" + lookback_window: + title: "Lookback window" + description: "How far into the past to look for records. (in minutes)" + examples: + - 60 + default: 0 + minimum: 0 + maximum: 576000 + type: "integer" + order: 4 + source-sendgrid: + title: "Sendgrid Spec" + type: "object" + required: + - "apikey" + - "sourceType" + properties: + apikey: + title: "Sendgrid API key" + airbyte_secret: true + type: "string" + description: "API Key, use admin to generate this key." + order: 0 + x-speakeasy-param-sensitive: true + start_time: + title: "Start time" + type: "string" + format: "date-time" + pattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(.\\d+)?Z$" + description: "Start time in ISO8601 format. Any data before this time point\ + \ will not be replicated." + examples: + - "2020-01-01T01:01:01Z" + - "2020-01-01T01:01:01.000001Z" + order: 1 + sourceType: + title: "sendgrid" + const: "sendgrid" + enum: + - "sendgrid" + order: 0 + type: "string" + source-sendgrid-update: + title: "Sendgrid Spec" + type: "object" + required: + - "apikey" + properties: + apikey: + title: "Sendgrid API key" + airbyte_secret: true + type: "string" + description: "API Key, use admin to generate this key." + order: 0 + start_time: + title: "Start time" + type: "string" + format: "date-time" + pattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(.\\d+)?Z$" + description: "Start time in ISO8601 format. Any data before this time point\ + \ will not be replicated." + examples: + - "2020-01-01T01:01:01Z" + - "2020-01-01T01:01:01.000001Z" + order: 1 + source-gnews: + title: "Gnews Spec" + type: "object" + required: + - "api_key" + - "query" + - "sourceType" + properties: + api_key: + type: "string" + title: "API Key" + description: "API Key" + order: 0 + airbyte_secret: true + x-speakeasy-param-sensitive: true + query: + type: "string" + order: 1 + title: "Query" + description: "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 \n quotation marks\ + \ are used to search for articles with the exact same keyword sequence.\ + \ \n For example the query: \"Apple iPhone\" will return articles matching\ + \ at least once this sequence of keywords.\n- Logical AND Operator: This\ + \ operator allows you to make sure that several keywords are all used\ + \ in the article\n search. By default the space character acts as an\ + \ AND operator, it is possible to replace the space character \n by AND\ + \ to obtain the same result. For example the query: Apple Microsoft is\ + \ equivalent to Apple AND Microsoft\n- Logical OR Operator: This operator\ + \ allows you to retrieve articles matching the keyword a or the keyword\ + \ b.\n It is important to note that this operator has a higher precedence\ + \ than the AND operator. For example the \n query: Apple OR Microsoft\ + \ will return all articles matching the keyword Apple as well as all articles\ + \ matching \n the keyword Microsoft\n- Logical NOT Operator: This operator\ + \ allows you to remove from the results the articles corresponding to\ + \ the\n specified keywords. To use it, you need to add NOT in front of\ + \ each word or phrase surrounded by quotes.\n For example the query:\ + \ Apple NOT iPhone will return all articles matching the keyword Apple\ + \ but not the keyword\n iPhone" + examples: + - "Microsoft Windows 10" + - "Apple OR Microsoft" + - "Apple AND NOT iPhone" + - "(Windows 7) AND (Windows 10)" + - "Intel AND (i7 OR i9)" + language: + type: "string" + title: "Language" + decription: "This parameter allows you to specify the language of the news\ + \ articles returned by the API. You have to set as value the 2 letters\ + \ code of the language you want to filter." + order: 2 + enum: + - "ar" + - "zh" + - "nl" + - "en" + - "fr" + - "de" + - "el" + - "he" + - "hi" + - "it" + - "ja" + - "ml" + - "mr" + - "no" + - "pt" + - "ro" + - "ru" + - "es" + - "sv" + - "ta" + - "te" + - "uk" + country: + type: "string" + title: "Country" + description: "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." + order: 3 + enum: + - "au" + - "br" + - "ca" + - "cn" + - "eg" + - "fr" + - "de" + - "gr" + - "hk" + - "in" + - "ie" + - "il" + - "it" + - "jp" + - "nl" + - "no" + - "pk" + - "pe" + - "ph" + - "pt" + - "ro" + - "ru" + - "sg" + - "es" + - "se" + - "ch" + - "tw" + - "ua" + - "gb" + - "us" + in: + type: "array" + title: "In" + description: "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." + order: 4 + items: + type: "string" + enum: + - "title" + - "description" + - "content" + nullable: + type: "array" + title: "Nullable" + description: "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" + order: 5 + items: + type: "string" + enum: + - "title" + - "description" + - "content" + start_date: + type: "string" + title: "Start Date" + description: "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)" + order: 6 + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$" + examples: + - "2022-08-21 16:27:09" + end_date: + type: "string" + title: "End Date" + description: "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)" + order: 6 + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$" + examples: + - "2022-08-21 16:27:09" + sortby: + type: "string" + title: "Sort By" + description: "This parameter allows you to choose with which type of sorting\ + \ the articles should be returned. Two values are possible:\n - publishedAt\ + \ = sort by publication date, the articles with the most recent publication\ + \ date are returned first\n - relevance = sort by best match to keywords,\ + \ the articles with the best match are returned first" + order: 7 + enum: + - "publishedAt" + - "relevance" + top_headlines_query: + type: "string" + order: 8 + title: "Top Headlines Query" + description: "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 \n quotation marks\ + \ are used to search for articles with the exact same keyword sequence.\ + \ \n For example the query: \"Apple iPhone\" will return articles matching\ + \ at least once this sequence of keywords.\n- Logical AND Operator: This\ + \ operator allows you to make sure that several keywords are all used\ + \ in the article\n search. By default the space character acts as an\ + \ AND operator, it is possible to replace the space character \n by AND\ + \ to obtain the same result. For example the query: Apple Microsoft is\ + \ equivalent to Apple AND Microsoft\n- Logical OR Operator: This operator\ + \ allows you to retrieve articles matching the keyword a or the keyword\ + \ b.\n It is important to note that this operator has a higher precedence\ + \ than the AND operator. For example the \n query: Apple OR Microsoft\ + \ will return all articles matching the keyword Apple as well as all articles\ + \ matching \n the keyword Microsoft\n- Logical NOT Operator: This operator\ + \ allows you to remove from the results the articles corresponding to\ + \ the\n specified keywords. To use it, you need to add NOT in front of\ + \ each word or phrase surrounded by quotes.\n For example the query:\ + \ Apple NOT iPhone will return all articles matching the keyword Apple\ + \ but not the keyword\n iPhone" + examples: + - "Microsoft Windows 10" + - "Apple OR Microsoft" + - "Apple AND NOT iPhone" + - "(Windows 7) AND (Windows 10)" + - "Intel AND (i7 OR i9)" + top_headlines_topic: + type: "string" + title: "Top Headlines Topic" + description: "This parameter allows you to change the category for the request." + order: 9 + enum: + - "breaking-news" + - "world" + - "nation" + - "business" + - "technology" + - "entertainment" + - "sports" + - "science" + - "health" + sourceType: + title: "gnews" + const: "gnews" + enum: + - "gnews" + order: 0 + type: "string" + source-gnews-update: + title: "Gnews Spec" + type: "object" + required: + - "api_key" + - "query" + properties: + api_key: + type: "string" + title: "API Key" + description: "API Key" + order: 0 + airbyte_secret: true + query: + type: "string" + order: 1 + title: "Query" + description: "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 \n quotation marks\ + \ are used to search for articles with the exact same keyword sequence.\ + \ \n For example the query: \"Apple iPhone\" will return articles matching\ + \ at least once this sequence of keywords.\n- Logical AND Operator: This\ + \ operator allows you to make sure that several keywords are all used\ + \ in the article\n search. By default the space character acts as an\ + \ AND operator, it is possible to replace the space character \n by AND\ + \ to obtain the same result. For example the query: Apple Microsoft is\ + \ equivalent to Apple AND Microsoft\n- Logical OR Operator: This operator\ + \ allows you to retrieve articles matching the keyword a or the keyword\ + \ b.\n It is important to note that this operator has a higher precedence\ + \ than the AND operator. For example the \n query: Apple OR Microsoft\ + \ will return all articles matching the keyword Apple as well as all articles\ + \ matching \n the keyword Microsoft\n- Logical NOT Operator: This operator\ + \ allows you to remove from the results the articles corresponding to\ + \ the\n specified keywords. To use it, you need to add NOT in front of\ + \ each word or phrase surrounded by quotes.\n For example the query:\ + \ Apple NOT iPhone will return all articles matching the keyword Apple\ + \ but not the keyword\n iPhone" + examples: + - "Microsoft Windows 10" + - "Apple OR Microsoft" + - "Apple AND NOT iPhone" + - "(Windows 7) AND (Windows 10)" + - "Intel AND (i7 OR i9)" + language: + type: "string" + title: "Language" + decription: "This parameter allows you to specify the language of the news\ + \ articles returned by the API. You have to set as value the 2 letters\ + \ code of the language you want to filter." + order: 2 + enum: + - "ar" + - "zh" + - "nl" + - "en" + - "fr" + - "de" + - "el" + - "he" + - "hi" + - "it" + - "ja" + - "ml" + - "mr" + - "no" + - "pt" + - "ro" + - "ru" + - "es" + - "sv" + - "ta" + - "te" + - "uk" + country: + type: "string" + title: "Country" + description: "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." + order: 3 + enum: + - "au" + - "br" + - "ca" + - "cn" + - "eg" + - "fr" + - "de" + - "gr" + - "hk" + - "in" + - "ie" + - "il" + - "it" + - "jp" + - "nl" + - "no" + - "pk" + - "pe" + - "ph" + - "pt" + - "ro" + - "ru" + - "sg" + - "es" + - "se" + - "ch" + - "tw" + - "ua" + - "gb" + - "us" + in: + type: "array" + title: "In" + description: "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." + order: 4 + items: + type: "string" + enum: + - "title" + - "description" + - "content" + nullable: + type: "array" + title: "Nullable" + description: "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" + order: 5 + items: + type: "string" + enum: + - "title" + - "description" + - "content" + start_date: + type: "string" + title: "Start Date" + description: "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)" + order: 6 + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$" + examples: + - "2022-08-21 16:27:09" + end_date: + type: "string" + title: "End Date" + description: "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)" + order: 6 + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$" + examples: + - "2022-08-21 16:27:09" + sortby: + type: "string" + title: "Sort By" + description: "This parameter allows you to choose with which type of sorting\ + \ the articles should be returned. Two values are possible:\n - publishedAt\ + \ = sort by publication date, the articles with the most recent publication\ + \ date are returned first\n - relevance = sort by best match to keywords,\ + \ the articles with the best match are returned first" + order: 7 + enum: + - "publishedAt" + - "relevance" + top_headlines_query: + type: "string" + order: 8 + title: "Top Headlines Query" + description: "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 \n quotation marks\ + \ are used to search for articles with the exact same keyword sequence.\ + \ \n For example the query: \"Apple iPhone\" will return articles matching\ + \ at least once this sequence of keywords.\n- Logical AND Operator: This\ + \ operator allows you to make sure that several keywords are all used\ + \ in the article\n search. By default the space character acts as an\ + \ AND operator, it is possible to replace the space character \n by AND\ + \ to obtain the same result. For example the query: Apple Microsoft is\ + \ equivalent to Apple AND Microsoft\n- Logical OR Operator: This operator\ + \ allows you to retrieve articles matching the keyword a or the keyword\ + \ b.\n It is important to note that this operator has a higher precedence\ + \ than the AND operator. For example the \n query: Apple OR Microsoft\ + \ will return all articles matching the keyword Apple as well as all articles\ + \ matching \n the keyword Microsoft\n- Logical NOT Operator: This operator\ + \ allows you to remove from the results the articles corresponding to\ + \ the\n specified keywords. To use it, you need to add NOT in front of\ + \ each word or phrase surrounded by quotes.\n For example the query:\ + \ Apple NOT iPhone will return all articles matching the keyword Apple\ + \ but not the keyword\n iPhone" + examples: + - "Microsoft Windows 10" + - "Apple OR Microsoft" + - "Apple AND NOT iPhone" + - "(Windows 7) AND (Windows 10)" + - "Intel AND (i7 OR i9)" + top_headlines_topic: + type: "string" + title: "Top Headlines Topic" + description: "This parameter allows you to change the category for the request." + order: 9 + enum: + - "breaking-news" + - "world" + - "nation" + - "business" + - "technology" + - "entertainment" + - "sports" + - "science" + - "health" + source-google-ads: + title: "Google Ads Spec" + type: "object" + required: + - "credentials" + - "sourceType" + properties: + credentials: + type: "object" + description: "" + title: "Google Credentials" + order: 0 + required: + - "developer_token" + - "client_id" + - "client_secret" + - "refresh_token" + properties: + developer_token: + type: "string" + title: "Developer Token" + order: 0 + description: "The Developer Token granted by Google to use their APIs.\ + \ For detailed instructions on finding this value, refer to our documentation." + airbyte_secret: true + x-speakeasy-param-sensitive: true + client_id: + type: "string" + title: "Client ID" + order: 1 + description: "The Client ID of your Google Ads developer application.\ + \ For detailed instructions on finding this value, refer to our documentation." + client_secret: + type: "string" + title: "Client Secret" + order: 2 + description: "The Client Secret of your Google Ads developer application.\ + \ For detailed instructions on finding this value, refer to our documentation." + airbyte_secret: true + refresh_token: + type: "string" + title: "Refresh Token" + order: 3 + description: "The token used to obtain a new Access Token. For detailed\ + \ instructions on finding this value, refer to our documentation." + airbyte_secret: true + x-speakeasy-param-sensitive: true + access_token: + type: "string" + title: "Access Token" + order: 4 + description: "The Access Token for making authenticated requests. For\ + \ detailed instructions on finding this value, refer to our documentation." + airbyte_secret: true + x-speakeasy-param-sensitive: true + customer_id: + title: "Customer ID(s)" + type: "string" + description: "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." + pattern: "^[0-9]{10}(,[0-9]{10})*$" + pattern_descriptor: "The customer ID must be 10 digits. Separate multiple\ + \ customer IDs using commas." + examples: + - "6783948572,5839201945" + order: 1 + customer_status_filter: + title: "Customer Statuses Filter" + description: "A list of customer statuses to filter on. For detailed info\ + \ about what each status mean refer to Google Ads documentation." + default: [] + order: 2 + type: "array" + items: + title: "CustomerStatus" + description: "An enumeration." + enum: + - "UNKNOWN" + - "ENABLED" + - "CANCELED" + - "SUSPENDED" + - "CLOSED" + start_date: + type: "string" + title: "Start Date" + description: "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)" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + pattern_descriptor: "YYYY-MM-DD" + examples: + - "2017-01-25" + order: 3 + format: "date" + end_date: + type: "string" + title: "End Date" + description: "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)" + pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + pattern_descriptor: "YYYY-MM-DD" + examples: + - "2017-01-30" + order: 4 + format: "date" + custom_queries_array: + type: "array" + title: "Custom GAQL Queries" + description: "" + order: 5 + items: + type: "object" + required: + - "query" + - "table_name" + properties: + query: + type: "string" + multiline: true + title: "Custom Query" + description: "A custom defined GAQL query for building the report.\ + \ Avoid including the segments.date field; wherever possible, Airbyte\ + \ will automatically include it for incremental syncs. For more\ + \ information, refer to Google's documentation." + examples: + - "SELECT segments.ad_destination_type, campaign.advertising_channel_sub_type\ + \ FROM campaign WHERE campaign.status = 'PAUSED'" + table_name: + type: "string" + title: "Destination Table Name" + description: "The table name in your destination database for the\ + \ chosen query." + conversion_window_days: + title: "Conversion Window" + type: "integer" + description: "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." + minimum: 0 + maximum: 1095 + default: 14 + examples: + - 14 + order: 6 + sourceType: + title: "google-ads" + const: "google-ads" + enum: + - "google-ads" + order: 0 + type: "string" + source-google-ads-update: + title: "Google Ads Spec" + type: "object" + required: + - "credentials" + properties: + credentials: + type: "object" + description: "" + title: "Google Credentials" + order: 0 + required: + - "developer_token" + - "client_id" + - "client_secret" + - "refresh_token" + properties: + developer_token: + type: "string" + title: "Developer Token" + order: 0 + description: "The Developer Token granted by Google to use their APIs.\ + \ For detailed instructions on finding this value, refer to our documentation." + airbyte_secret: true + client_id: + type: "string" + title: "Client ID" + order: 1 + description: "The Client ID of your Google Ads developer application.\ + \ For detailed instructions on finding this value, refer to our documentation." + client_secret: + type: "string" + title: "Client Secret" + order: 2 + description: "The Client Secret of your Google Ads developer application.\ + \ For detailed instructions on finding this value, refer to our documentation." + airbyte_secret: true + refresh_token: + type: "string" + title: "Refresh Token" + order: 3 + description: "The token used to obtain a new Access Token. For detailed\ + \ instructions on finding this value, refer to our documentation." + airbyte_secret: true + access_token: + type: "string" + title: "Access Token" + order: 4 + description: "The Access Token for making authenticated requests. For\ + \ detailed instructions on finding this value, refer to our documentation." + airbyte_secret: true + customer_id: + title: "Customer ID(s)" + type: "string" + description: "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." + pattern: "^[0-9]{10}(,[0-9]{10})*$" + pattern_descriptor: "The customer ID must be 10 digits. Separate multiple\ + \ customer IDs using commas." + examples: + - "6783948572,5839201945" + order: 1 + customer_status_filter: + title: "Customer Statuses Filter" + description: "A list of customer statuses to filter on. For detailed info\ + \ about what each status mean refer to Google Ads documentation." + default: [] + order: 2 + type: "array" + items: + title: "CustomerStatus" + description: "An enumeration." + enum: + - "UNKNOWN" + - "ENABLED" + - "CANCELED" + - "SUSPENDED" + - "CLOSED" + start_date: + type: "string" + title: "Start Date" + description: "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)" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + pattern_descriptor: "YYYY-MM-DD" + examples: + - "2017-01-25" + order: 3 + format: "date" + end_date: + type: "string" + title: "End Date" + description: "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)" + pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + pattern_descriptor: "YYYY-MM-DD" + examples: + - "2017-01-30" + order: 4 + format: "date" + custom_queries_array: + type: "array" + title: "Custom GAQL Queries" + description: "" + order: 5 + items: + type: "object" + required: + - "query" + - "table_name" + properties: + query: + type: "string" + multiline: true + title: "Custom Query" + description: "A custom defined GAQL query for building the report.\ + \ Avoid including the segments.date field; wherever possible, Airbyte\ + \ will automatically include it for incremental syncs. For more\ + \ information, refer to Google's documentation." + examples: + - "SELECT segments.ad_destination_type, campaign.advertising_channel_sub_type\ + \ FROM campaign WHERE campaign.status = 'PAUSED'" + table_name: + type: "string" + title: "Destination Table Name" + description: "The table name in your destination database for the\ + \ chosen query." + conversion_window_days: + title: "Conversion Window" + type: "integer" + description: "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." + minimum: 0 + maximum: 1095 + default: 14 + examples: + - 14 + order: 6 + source-google-search-console: + title: "Google Search Console Spec" + type: "object" + required: + - "site_urls" + - "authorization" + - "sourceType" + properties: + site_urls: + type: "array" + items: + type: "string" + title: "Website URL Property" + description: "The URLs of the website property attached to your GSC account.\ + \ Learn more about properties here." + examples: + - "https://example1.com/" + - "sc-domain:example2.com" + order: 0 + start_date: + type: "string" + title: "Start Date" + description: "UTC date in the format YYYY-MM-DD. Any data before this date\ + \ will not be replicated." + default: "2021-01-01" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + pattern_descriptor: "YYYY-MM-DD" + always_show: true + order: 1 + format: "date" + end_date: + type: "string" + title: "End Date" + description: "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." + examples: + - "2021-12-12" + pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + pattern_descriptor: "YYYY-MM-DD" + order: 2 + format: "date" + authorization: + type: "object" + title: "Authentication Type" + description: "" + order: 3 + oneOf: + - title: "OAuth" + type: "object" + required: + - "auth_type" + - "client_id" + - "client_secret" + - "refresh_token" + properties: + auth_type: + type: "string" + const: "Client" + order: 0 + enum: + - "Client" + client_id: + title: "Client ID" + type: "string" + description: "The client ID of your Google Search Console developer\ + \ application. Read more here." + airbyte_secret: true + client_secret: + title: "Client Secret" + type: "string" + description: "The client secret of your Google Search Console developer\ + \ application. Read more here." + airbyte_secret: true + access_token: + title: "Access Token" + type: "string" + description: "Access token for making authenticated requests. Read\ + \ more here." + airbyte_secret: true + x-speakeasy-param-sensitive: true + refresh_token: + title: "Refresh Token" + type: "string" + description: "The token for obtaining a new access token. Read more\ + \ here." + airbyte_secret: true + x-speakeasy-param-sensitive: true + - type: "object" + title: "Service Account Key Authentication" + required: + - "auth_type" + - "service_account_info" + - "email" + properties: + auth_type: + type: "string" + const: "Service" + order: 0 + enum: + - "Service" + service_account_info: + title: "Service Account JSON Key" + type: "string" + description: "The JSON key of the service account to use for authorization.\ + \ Read more here." + examples: + - "{ \"type\": \"service_account\", \"project_id\": YOUR_PROJECT_ID,\ + \ \"private_key_id\": YOUR_PRIVATE_KEY, ... }" + airbyte_secret: true + email: + title: "Admin Email" + type: "string" + description: "The email of the user which has permissions to access\ + \ the Google Workspace Admin APIs." + custom_reports: + order: 4 + type: "string" + title: "Custom Reports" + airbyte_hidden: true + description: "(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: + title: "Custom Reports" + description: "You can add your Custom Analytics report by creating one." + order: 5 + type: "array" + items: + title: "Custom Report Config" + type: "object" + properties: + name: + title: "Name" + description: "The name of the custom report, this name would be used\ + \ as stream name" + type: "string" + dimensions: + title: "Dimensions" + description: "A list of available dimensions. Please note, that for\ + \ technical reasons `date` is the default dimension which will be\ + \ included in your query whether you specify it or not. Primary\ + \ key will consist of your custom dimensions and the default dimension\ + \ along with `site_url` and `search_type`." + type: "array" + items: + title: "ValidEnums" + description: "An enumeration of dimensions." + enum: + - "country" + - "date" + - "device" + - "page" + - "query" + default: + - "date" + minItems: 0 + required: + - "name" + - "dimensions" + data_state: + type: "string" + title: "Data Freshness" + enum: + - "final" + - "all" + description: "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." + examples: + - "final" + - "all" + default: "final" + order: 6 + sourceType: + title: "google-search-console" + const: "google-search-console" + enum: + - "google-search-console" + order: 0 + type: "string" + source-google-search-console-update: + title: "Google Search Console Spec" + type: "object" + required: + - "site_urls" + - "authorization" + properties: + site_urls: + type: "array" + items: + type: "string" + title: "Website URL Property" + description: "The URLs of the website property attached to your GSC account.\ + \ Learn more about properties here." + examples: + - "https://example1.com/" + - "sc-domain:example2.com" + order: 0 + start_date: + type: "string" + title: "Start Date" + description: "UTC date in the format YYYY-MM-DD. Any data before this date\ + \ will not be replicated." + default: "2021-01-01" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + pattern_descriptor: "YYYY-MM-DD" + always_show: true + order: 1 + format: "date" + end_date: + type: "string" + title: "End Date" + description: "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." + examples: + - "2021-12-12" + pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + pattern_descriptor: "YYYY-MM-DD" + order: 2 + format: "date" + authorization: + type: "object" + title: "Authentication Type" + description: "" + order: 3 + oneOf: + - title: "OAuth" + type: "object" + required: + - "auth_type" + - "client_id" + - "client_secret" + - "refresh_token" + properties: + auth_type: + type: "string" + const: "Client" + order: 0 + enum: + - "Client" + client_id: + title: "Client ID" + type: "string" + description: "The client ID of your Google Search Console developer\ + \ application. Read more here." + airbyte_secret: true + client_secret: + title: "Client Secret" + type: "string" + description: "The client secret of your Google Search Console developer\ + \ application. Read more here." + airbyte_secret: true + access_token: + title: "Access Token" + type: "string" + description: "Access token for making authenticated requests. Read\ + \ more here." + airbyte_secret: true + refresh_token: + title: "Refresh Token" + type: "string" + description: "The token for obtaining a new access token. Read more\ + \ here." + airbyte_secret: true + - type: "object" + title: "Service Account Key Authentication" + required: + - "auth_type" + - "service_account_info" + - "email" + properties: + auth_type: + type: "string" + const: "Service" + order: 0 + enum: + - "Service" + service_account_info: + title: "Service Account JSON Key" + type: "string" + description: "The JSON key of the service account to use for authorization.\ + \ Read more here." + examples: + - "{ \"type\": \"service_account\", \"project_id\": YOUR_PROJECT_ID,\ + \ \"private_key_id\": YOUR_PRIVATE_KEY, ... }" + airbyte_secret: true + email: + title: "Admin Email" + type: "string" + description: "The email of the user which has permissions to access\ + \ the Google Workspace Admin APIs." + custom_reports: + order: 4 + type: "string" + title: "Custom Reports" + airbyte_hidden: true + description: "(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: + title: "Custom Reports" + description: "You can add your Custom Analytics report by creating one." + order: 5 + type: "array" + items: + title: "Custom Report Config" + type: "object" + properties: + name: + title: "Name" + description: "The name of the custom report, this name would be used\ + \ as stream name" + type: "string" + dimensions: + title: "Dimensions" + description: "A list of available dimensions. Please note, that for\ + \ technical reasons `date` is the default dimension which will be\ + \ included in your query whether you specify it or not. Primary\ + \ key will consist of your custom dimensions and the default dimension\ + \ along with `site_url` and `search_type`." + type: "array" + items: + title: "ValidEnums" + description: "An enumeration of dimensions." + enum: + - "country" + - "date" + - "device" + - "page" + - "query" + default: + - "date" + minItems: 0 + required: + - "name" + - "dimensions" + data_state: + type: "string" + title: "Data Freshness" + enum: + - "final" + - "all" + description: "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." + examples: + - "final" + - "all" + default: "final" + order: 6 + source-kyve: + title: "KYVE Spec" + type: "object" + required: + - "pool_ids" + - "start_ids" + - "url_base" + - "sourceType" + properties: + pool_ids: + type: "string" + title: "Pool-IDs" + description: "The IDs of the KYVE storage pool you want to archive. (Comma\ + \ separated)" + order: 0 + examples: + - "0" + - "0,1" + start_ids: + type: "string" + title: "Bundle-Start-IDs" + description: "The start-id defines, from which bundle id the pipeline should\ + \ start to extract the data. (Comma separated)" + order: 1 + examples: + - "0" + - "0,0" + url_base: + type: "string" + title: "KYVE-API URL Base" + description: "URL to the KYVE Chain API." + default: "https://api.kyve.network" + order: 2 + examples: + - "https://api.kaon.kyve.network/" + - "https://api.korellia.kyve.network/" + max_pages: + type: "integer" + description: "The maximum amount of pages to go trough. Set to 'null' for\ + \ all pages." + order: 3 + airbyte_hidden: true + page_size: + type: "integer" + description: "The pagesize for pagination, smaller numbers are used in integration\ + \ tests." + default: 100 + order: 4 + airbyte_hidden: true + sourceType: + title: "kyve" + const: "kyve" + enum: + - "kyve" + order: 0 + type: "string" + source-kyve-update: + title: "KYVE Spec" + type: "object" + required: + - "pool_ids" + - "start_ids" + - "url_base" + properties: + pool_ids: + type: "string" + title: "Pool-IDs" + description: "The IDs of the KYVE storage pool you want to archive. (Comma\ + \ separated)" + order: 0 + examples: + - "0" + - "0,1" + start_ids: + type: "string" + title: "Bundle-Start-IDs" + description: "The start-id defines, from which bundle id the pipeline should\ + \ start to extract the data. (Comma separated)" + order: 1 + examples: + - "0" + - "0,0" + url_base: + type: "string" + title: "KYVE-API URL Base" + description: "URL to the KYVE Chain API." + default: "https://api.kyve.network" + order: 2 + examples: + - "https://api.kaon.kyve.network/" + - "https://api.korellia.kyve.network/" + max_pages: + type: "integer" + description: "The maximum amount of pages to go trough. Set to 'null' for\ + \ all pages." + order: 3 + airbyte_hidden: true + page_size: + type: "integer" + description: "The pagesize for pagination, smaller numbers are used in integration\ + \ tests." + default: 100 + order: 4 + airbyte_hidden: true + source-strava: + title: "Strava Spec" + type: "object" + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "athlete_id" + - "start_date" + - "sourceType" + properties: + auth_type: + type: "string" + const: "Client" + enum: + - "Client" + default: "Client" + client_id: + type: "string" + description: "The Client ID of your Strava developer application." + title: "Client ID" + pattern: "^[0-9_\\-]+$" + examples: + - "12345" + order: 0 + client_secret: + type: "string" + description: "The Client Secret of your Strava developer application." + title: "Client Secret" + pattern: "^[0-9a-fA-F]+$" + examples: + - "fc6243f283e51f6ca989aab298b17da125496f50" + airbyte_secret: true + order: 1 + refresh_token: + type: "string" + description: "The Refresh Token with the activity: read_all permissions." + title: "Refresh Token" + pattern: "^[0-9a-fA-F]+$" + examples: + - "fc6243f283e51f6ca989aab298b17da125496f50" + airbyte_secret: true + order: 2 + x-speakeasy-param-sensitive: true + athlete_id: + type: "integer" + description: "The Athlete ID of your Strava developer application." + title: "Athlete ID" + pattern: "^[0-9_\\-]+$" + examples: + - "17831421" + order: 3 + start_date: + type: "string" + description: "UTC date and time. Any data before this date will not be replicated." + title: "Start Date" + examples: + - "2021-03-01T00:00:00Z" + format: "date-time" + order: 4 + sourceType: + title: "strava" + const: "strava" + enum: + - "strava" + order: 0 + type: "string" + source-strava-update: + title: "Strava Spec" + type: "object" + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "athlete_id" + - "start_date" + properties: + auth_type: + type: "string" + const: "Client" + enum: + - "Client" + default: "Client" + client_id: + type: "string" + description: "The Client ID of your Strava developer application." + title: "Client ID" + pattern: "^[0-9_\\-]+$" + examples: + - "12345" + order: 0 + client_secret: + type: "string" + description: "The Client Secret of your Strava developer application." + title: "Client Secret" + pattern: "^[0-9a-fA-F]+$" + examples: + - "fc6243f283e51f6ca989aab298b17da125496f50" + airbyte_secret: true + order: 1 + refresh_token: + type: "string" + description: "The Refresh Token with the activity: read_all permissions." + title: "Refresh Token" + pattern: "^[0-9a-fA-F]+$" + examples: + - "fc6243f283e51f6ca989aab298b17da125496f50" + airbyte_secret: true + order: 2 + athlete_id: + type: "integer" + description: "The Athlete ID of your Strava developer application." + title: "Athlete ID" + pattern: "^[0-9_\\-]+$" + examples: + - "17831421" + order: 3 + start_date: + type: "string" + description: "UTC date and time. Any data before this date will not be replicated." + title: "Start Date" + examples: + - "2021-03-01T00:00:00Z" + format: "date-time" + order: 4 + source-smaily: + title: "Smaily Spec" + type: "object" + required: + - "api_subdomain" + - "api_username" + - "api_password" + - "sourceType" + properties: + api_subdomain: + type: "string" + title: "API Subdomain" + description: "API Subdomain. See https://smaily.com/help/api/general/create-api-user/" + api_username: + type: "string" + title: "API User Username" + description: "API user username. See https://smaily.com/help/api/general/create-api-user/" + api_password: + type: "string" + title: "API User Password" + description: "API user password. See https://smaily.com/help/api/general/create-api-user/" + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "smaily" + const: "smaily" + enum: + - "smaily" + order: 0 + type: "string" + source-smaily-update: + title: "Smaily Spec" + type: "object" + required: + - "api_subdomain" + - "api_username" + - "api_password" + properties: + api_subdomain: + type: "string" + title: "API Subdomain" + description: "API Subdomain. See https://smaily.com/help/api/general/create-api-user/" + api_username: + type: "string" + title: "API User Username" + description: "API user username. See https://smaily.com/help/api/general/create-api-user/" + api_password: + type: "string" + title: "API User Password" + description: "API user password. See https://smaily.com/help/api/general/create-api-user/" + airbyte_secret: true + source-polygon-stock-api: + title: "Weather API Spec" + type: "object" + required: + - "apiKey" + - "stocksTicker" + - "multiplier" + - "timespan" + - "start_date" + - "end_date" + - "sourceType" + properties: + apiKey: + title: "API Key" + type: "string" + description: "Your API ACCESS Key" + airbyte_secret: true + stocksTicker: + title: "Stock Ticker" + type: "string" + description: "The exchange symbol that this item is traded under." + examples: + - "IBM" + - "MSFT" + multiplier: + title: "Multiplier" + type: "integer" + description: "The size of the timespan multiplier." + examples: + - 1 + - 2 + timespan: + title: "Timespan" + type: "string" + description: "The size of the time window." + examples: + - "day" + start_date: + title: "Start Date" + type: "string" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + description: "The beginning date for the aggregate window." + examples: + - "2020-10-14" + format: "date" + end_date: + title: "End Date" + type: "string" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + description: "The target date for the aggregate window." + examples: + - "2020-10-14" + format: "date" + adjusted: + title: "Adjusted" + type: "string" + description: "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." + examples: + - "true" + - "false" + sort: + title: "Sort" + type: "string" + description: "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)." + examples: + - "asc" + - "desc" + limit: + title: "Limit" + type: "integer" + description: "The target date for the aggregate window." + examples: + - 100 + - 120 + sourceType: + title: "polygon-stock-api" + const: "polygon-stock-api" + enum: + - "polygon-stock-api" + order: 0 + type: "string" + source-polygon-stock-api-update: + title: "Weather API Spec" + type: "object" + required: + - "apiKey" + - "stocksTicker" + - "multiplier" + - "timespan" + - "start_date" + - "end_date" + properties: + apiKey: + title: "API Key" + type: "string" + description: "Your API ACCESS Key" + airbyte_secret: true + stocksTicker: + title: "Stock Ticker" + type: "string" + description: "The exchange symbol that this item is traded under." + examples: + - "IBM" + - "MSFT" + multiplier: + title: "Multiplier" + type: "integer" + description: "The size of the timespan multiplier." + examples: + - 1 + - 2 + timespan: + title: "Timespan" + type: "string" + description: "The size of the time window." + examples: + - "day" + start_date: + title: "Start Date" + type: "string" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + description: "The beginning date for the aggregate window." + examples: + - "2020-10-14" + format: "date" + end_date: + title: "End Date" + type: "string" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + description: "The target date for the aggregate window." + examples: + - "2020-10-14" + format: "date" + adjusted: + title: "Adjusted" + type: "string" + description: "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." + examples: + - "true" + - "false" + sort: + title: "Sort" + type: "string" + description: "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)." + examples: + - "asc" + - "desc" + limit: + title: "Limit" + type: "integer" + description: "The target date for the aggregate window." + examples: + - 100 + - 120 + source-shopify: + title: "Shopify Source CDK Specifications" + type: "object" + required: + - "shop" + - "sourceType" + properties: + shop: + type: "string" + title: "Shopify Store" + description: "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'." + pattern: "^(?!https://)(?!https://).*" + examples: + - "my-store" + - "my-store.myshopify.com" + order: 1 + credentials: + title: "Shopify Authorization Method" + description: "The authorization method to use to retrieve data from Shopify" + type: "object" + order: 2 + oneOf: + - type: "object" + title: "OAuth2.0" + description: "OAuth2.0" + required: + - "auth_method" + properties: + auth_method: + type: "string" + const: "oauth2.0" + order: 0 + enum: + - "oauth2.0" + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of the Shopify developer application." + airbyte_secret: true + order: 1 + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of the Shopify developer application." + airbyte_secret: true + order: 2 + access_token: + type: "string" + title: "Access Token" + description: "The Access Token for making authenticated requests." + airbyte_secret: true + order: 3 + x-speakeasy-param-sensitive: true + - title: "API Password" + description: "API Password Auth" + type: "object" + required: + - "auth_method" + - "api_password" + properties: + auth_method: + type: "string" + const: "api_password" + order: 0 + enum: + - "api_password" + api_password: + type: "string" + title: "API Password" + description: "The API Password for your private application in the\ + \ `Shopify` store." + airbyte_secret: true + order: 1 + x-speakeasy-param-sensitive: true + start_date: + type: "string" + title: "Replication Start Date" + description: "The date you would like to replicate data from. Format: YYYY-MM-DD.\ + \ Any data before this date will not be replicated." + default: "2020-01-01" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + format: "date" + order: 3 + bulk_window_in_days: + type: "integer" + title: "GraphQL BULK Date Range in Days" + description: "Defines what would be a date range per single BULK Job" + default: 30 + fetch_transactions_user_id: + type: "boolean" + title: "Add `user_id` to Transactions (slower)" + description: "Defines which API type (REST/BULK) to use to fetch `Transactions`\ + \ data. If you are a `Shopify Plus` user, leave the default value to speed\ + \ up the fetch." + default: false + sourceType: + title: "shopify" + const: "shopify" + enum: + - "shopify" + order: 0 + type: "string" + source-shopify-update: + title: "Shopify Source CDK Specifications" + type: "object" + required: + - "shop" + properties: + shop: + type: "string" + title: "Shopify Store" + description: "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'." + pattern: "^(?!https://)(?!https://).*" + examples: + - "my-store" + - "my-store.myshopify.com" + order: 1 + credentials: + title: "Shopify Authorization Method" + description: "The authorization method to use to retrieve data from Shopify" + type: "object" + order: 2 + oneOf: + - type: "object" + title: "OAuth2.0" + description: "OAuth2.0" + required: + - "auth_method" + properties: + auth_method: + type: "string" + const: "oauth2.0" + order: 0 + enum: + - "oauth2.0" + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of the Shopify developer application." + airbyte_secret: true + order: 1 + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of the Shopify developer application." + airbyte_secret: true + order: 2 + access_token: + type: "string" + title: "Access Token" + description: "The Access Token for making authenticated requests." + airbyte_secret: true + order: 3 + - title: "API Password" + description: "API Password Auth" + type: "object" + required: + - "auth_method" + - "api_password" + properties: + auth_method: + type: "string" + const: "api_password" + order: 0 + enum: + - "api_password" + api_password: + type: "string" + title: "API Password" + description: "The API Password for your private application in the\ + \ `Shopify` store." + airbyte_secret: true + order: 1 + start_date: + type: "string" + title: "Replication Start Date" + description: "The date you would like to replicate data from. Format: YYYY-MM-DD.\ + \ Any data before this date will not be replicated." + default: "2020-01-01" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + format: "date" + order: 3 + bulk_window_in_days: + type: "integer" + title: "GraphQL BULK Date Range in Days" + description: "Defines what would be a date range per single BULK Job" + default: 30 + fetch_transactions_user_id: + type: "boolean" + title: "Add `user_id` to Transactions (slower)" + description: "Defines which API type (REST/BULK) to use to fetch `Transactions`\ + \ data. If you are a `Shopify Plus` user, leave the default value to speed\ + \ up the fetch." + default: false + source-omnisend: + title: "Omnisend Spec" + type: "object" + required: + - "api_key" + - "sourceType" + properties: + api_key: + title: "API Key" + type: "string" + description: "API Key" + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "omnisend" + const: "omnisend" + enum: + - "omnisend" + order: 0 + type: "string" + source-omnisend-update: + title: "Omnisend Spec" + type: "object" + required: + - "api_key" + properties: + api_key: + title: "API Key" + type: "string" + description: "API Key" + airbyte_secret: true + source-mongodb-v2: + title: "MongoDb Source Spec" + type: "object" + required: + - "database_config" + - "sourceType" + properties: + database_config: + type: "object" + title: "Cluster Type" + description: "Configures the MongoDB cluster type." + order: 1 + group: "connection" + display_type: "radio" + oneOf: + - title: "MongoDB Atlas Replica Set" + description: "MongoDB Atlas-hosted cluster configured as a replica set" + required: + - "cluster_type" + - "connection_string" + - "database" + - "username" + - "password" + - "auth_source" + additionalProperties: true + properties: + cluster_type: + type: "string" + const: "ATLAS_REPLICA_SET" + order: 1 + enum: + - "ATLAS_REPLICA_SET" + connection_string: + title: "Connection String" + type: "string" + description: "The connection string of the cluster that you want to\ + \ replicate." + examples: + - "mongodb+srv://cluster0.abcd1.mongodb.net/" + order: 2 + database: + title: "Database Name" + type: "string" + description: "The name of the MongoDB database that contains the collection(s)\ + \ to replicate." + order: 3 + username: + title: "Username" + type: "string" + description: "The username which is used to access the database." + order: 4 + password: + title: "Password" + type: "string" + description: "The password associated with this username." + airbyte_secret: true + order: 5 + x-speakeasy-param-sensitive: true + auth_source: + title: "Authentication Source" + type: "string" + description: "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." + default: "admin" + examples: + - "admin" + order: 6 + schema_enforced: + title: "Schema Enforced" + description: "When enabled, syncs will validate and structure records\ + \ against the stream's schema." + default: true + type: "boolean" + always_show: true + order: 7 + - title: "Self-Managed Replica Set" + description: "MongoDB self-hosted cluster configured as a replica set" + required: + - "cluster_type" + - "connection_string" + - "database" + additionalProperties: true + properties: + cluster_type: + type: "string" + const: "SELF_MANAGED_REPLICA_SET" + order: 1 + enum: + - "SELF_MANAGED_REPLICA_SET" + connection_string: + title: "Connection String" + type: "string" + description: "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." + examples: + - "mongodb://example1.host.com:27017,example2.host.com:27017,example3.host.com:27017/" + - "mongodb://example.host.com:27017/" + order: 2 + database: + title: "Database Name" + type: "string" + description: "The name of the MongoDB database that contains the collection(s)\ + \ to replicate." + order: 3 + username: + title: "Username" + type: "string" + description: "The username which is used to access the database." + order: 4 + password: + title: "Password" + type: "string" + description: "The password associated with this username." + airbyte_secret: true + order: 5 + x-speakeasy-param-sensitive: true + auth_source: + title: "Authentication Source" + type: "string" + description: "The authentication source where the user information\ + \ is stored." + default: "admin" + examples: + - "admin" + order: 6 + schema_enforced: + title: "Schema Enforced" + description: "When enabled, syncs will validate and structure records\ + \ against the stream's schema." + default: true + type: "boolean" + always_show: true + order: 7 + initial_waiting_seconds: + type: "integer" + title: "Initial Waiting Time in Seconds (Advanced)" + description: "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." + default: 300 + order: 8 + min: 120 + max: 1200 + group: "advanced" + queue_size: + type: "integer" + title: "Size of the queue (Advanced)" + description: "The size of the internal queue. This may interfere with memory\ + \ consumption and efficiency of the connector, please be careful." + default: 10000 + order: 9 + min: 1000 + max: 10000 + group: "advanced" + discover_sample_size: + type: "integer" + title: "Document discovery sample size (Advanced)" + description: "The maximum number of documents to sample when attempting\ + \ to discover the unique fields for a collection." + default: 10000 + order: 10 + minimum: 10 + maximum: 100000 + group: "advanced" + invalid_cdc_cursor_position_behavior: + type: "string" + title: "Invalid CDC position behavior (Advanced)" + description: "Determines whether Airbyte should fail or re-sync data in\ + \ case of an stale/invalid cursor value into the WAL. If 'Fail sync' is\ + \ chosen, a user will have to manually reset the connection before being\ + \ able to continue syncing data. If 'Re-sync data' is chosen, Airbyte\ + \ will automatically trigger a refresh but could lead to higher cloud\ + \ costs and data loss." + enum: + - "Fail sync" + - "Re-sync data" + default: "Fail sync" + order: 11 + group: "advanced" + sourceType: + title: "mongodb-v2" + const: "mongodb-v2" + enum: + - "mongodb-v2" + order: 0 + type: "string" + groups: + - id: "connection" + - id: "advanced" + title: "Advanced" + source-mongodb-v2-update: + title: "MongoDb Source Spec" + type: "object" + required: + - "database_config" + properties: + database_config: + type: "object" + title: "Cluster Type" + description: "Configures the MongoDB cluster type." + order: 1 + group: "connection" + display_type: "radio" + oneOf: + - title: "MongoDB Atlas Replica Set" + description: "MongoDB Atlas-hosted cluster configured as a replica set" + required: + - "cluster_type" + - "connection_string" + - "database" + - "username" + - "password" + - "auth_source" + additionalProperties: true + properties: + cluster_type: + type: "string" + const: "ATLAS_REPLICA_SET" + order: 1 + enum: + - "ATLAS_REPLICA_SET" + connection_string: + title: "Connection String" + type: "string" + description: "The connection string of the cluster that you want to\ + \ replicate." + examples: + - "mongodb+srv://cluster0.abcd1.mongodb.net/" + order: 2 + database: + title: "Database Name" + type: "string" + description: "The name of the MongoDB database that contains the collection(s)\ + \ to replicate." + order: 3 + username: + title: "Username" + type: "string" + description: "The username which is used to access the database." + order: 4 + password: + title: "Password" + type: "string" + description: "The password associated with this username." + airbyte_secret: true + order: 5 + auth_source: + title: "Authentication Source" + type: "string" + description: "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." + default: "admin" + examples: + - "admin" + order: 6 + schema_enforced: + title: "Schema Enforced" + description: "When enabled, syncs will validate and structure records\ + \ against the stream's schema." + default: true + type: "boolean" + always_show: true + order: 7 + - title: "Self-Managed Replica Set" + description: "MongoDB self-hosted cluster configured as a replica set" + required: + - "cluster_type" + - "connection_string" + - "database" + additionalProperties: true + properties: + cluster_type: + type: "string" + const: "SELF_MANAGED_REPLICA_SET" + order: 1 + enum: + - "SELF_MANAGED_REPLICA_SET" + connection_string: + title: "Connection String" + type: "string" + description: "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." + examples: + - "mongodb://example1.host.com:27017,example2.host.com:27017,example3.host.com:27017/" + - "mongodb://example.host.com:27017/" + order: 2 + database: + title: "Database Name" + type: "string" + description: "The name of the MongoDB database that contains the collection(s)\ + \ to replicate." + order: 3 + username: + title: "Username" + type: "string" + description: "The username which is used to access the database." + order: 4 + password: + title: "Password" + type: "string" + description: "The password associated with this username." + airbyte_secret: true + order: 5 + auth_source: + title: "Authentication Source" + type: "string" + description: "The authentication source where the user information\ + \ is stored." + default: "admin" + examples: + - "admin" + order: 6 + schema_enforced: + title: "Schema Enforced" + description: "When enabled, syncs will validate and structure records\ + \ against the stream's schema." + default: true + type: "boolean" + always_show: true + order: 7 + initial_waiting_seconds: + type: "integer" + title: "Initial Waiting Time in Seconds (Advanced)" + description: "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." + default: 300 + order: 8 + min: 120 + max: 1200 + group: "advanced" + queue_size: + type: "integer" + title: "Size of the queue (Advanced)" + description: "The size of the internal queue. This may interfere with memory\ + \ consumption and efficiency of the connector, please be careful." + default: 10000 + order: 9 + min: 1000 + max: 10000 + group: "advanced" + discover_sample_size: + type: "integer" + title: "Document discovery sample size (Advanced)" + description: "The maximum number of documents to sample when attempting\ + \ to discover the unique fields for a collection." + default: 10000 + order: 10 + minimum: 10 + maximum: 100000 + group: "advanced" + invalid_cdc_cursor_position_behavior: + type: "string" + title: "Invalid CDC position behavior (Advanced)" + description: "Determines whether Airbyte should fail or re-sync data in\ + \ case of an stale/invalid cursor value into the WAL. If 'Fail sync' is\ + \ chosen, a user will have to manually reset the connection before being\ + \ able to continue syncing data. If 'Re-sync data' is chosen, Airbyte\ + \ will automatically trigger a refresh but could lead to higher cloud\ + \ costs and data loss." + enum: + - "Fail sync" + - "Re-sync data" + default: "Fail sync" + order: 11 + group: "advanced" + groups: + - id: "connection" + - id: "advanced" + title: "Advanced" + source-retently: + title: "Retently Api Spec" + type: "object" + properties: + credentials: + title: "Authentication Mechanism" + description: "Choose how to authenticate to Retently" + type: "object" + oneOf: + - type: "object" + title: "Authenticate via Retently (OAuth)" + required: + - "client_id" + - "client_secret" + - "refresh_token" + additionalProperties: true + properties: + auth_type: + type: "string" + const: "Client" + order: 0 + enum: + - "Client" + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Retently developer application." + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Retently developer application." + airbyte_secret: true + refresh_token: + title: "Refresh Token" + type: "string" + description: "Retently Refresh Token which can be used to fetch new\ + \ Bearer Tokens when the current one expires." + airbyte_secret: true + x-speakeasy-param-sensitive: true + - type: "object" + title: "Authenticate with API Token" + required: + - "api_key" + additionalProperties: true + properties: + auth_type: + type: "string" + const: "Token" + order: 0 + enum: + - "Token" + api_key: + title: "API Token" + description: "Retently API Token. See the docs for more information on how to obtain this key." + type: "string" + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "retently" + const: "retently" + enum: + - "retently" + order: 0 + type: "string" + source-retently-update: + title: "Retently Api Spec" + type: "object" + properties: + credentials: + title: "Authentication Mechanism" + description: "Choose how to authenticate to Retently" + type: "object" + oneOf: + - type: "object" + title: "Authenticate via Retently (OAuth)" + required: + - "client_id" + - "client_secret" + - "refresh_token" + additionalProperties: true + properties: + auth_type: + type: "string" + const: "Client" + order: 0 + enum: + - "Client" + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Retently developer application." + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Retently developer application." + airbyte_secret: true + refresh_token: + title: "Refresh Token" + type: "string" + description: "Retently Refresh Token which can be used to fetch new\ + \ Bearer Tokens when the current one expires." + airbyte_secret: true + - type: "object" + title: "Authenticate with API Token" + required: + - "api_key" + additionalProperties: true + properties: + auth_type: + type: "string" + const: "Token" + order: 0 + enum: + - "Token" + api_key: + title: "API Token" + description: "Retently API Token. See the docs for more information on how to obtain this key." + type: "string" + airbyte_secret: true + source-coda: + title: "Required attributes for hitting apis" + type: "object" + required: + - "auth_token" + - "sourceType" + properties: + auth_token: + title: "Authentication token" + type: "string" + description: "Bearer token" + airbyte_secret: true + order: 0 + x-speakeasy-param-sensitive: true + sourceType: + title: "coda" + const: "coda" + enum: + - "coda" + order: 0 + type: "string" + source-coda-update: + title: "Required attributes for hitting apis" + type: "object" + required: + - "auth_token" + properties: + auth_token: + title: "Authentication token" + type: "string" + description: "Bearer token" + airbyte_secret: true + order: 0 + source-pendo: + type: "object" + required: + - "api_key" + - "sourceType" + properties: + api_key: + type: "string" + title: "API Key" + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "pendo" + const: "pendo" + enum: + - "pendo" + order: 0 + type: "string" + source-pendo-update: + type: "object" + required: + - "api_key" + properties: + api_key: + type: "string" + title: "API Key" + airbyte_secret: true + source-instagram: + title: "Source Instagram" + type: "object" + properties: + start_date: + title: "Start Date" + description: "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." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2017-01-25T00:00:00Z" + type: "string" + format: "date-time" + access_token: + title: "Access Token" + description: "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" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + client_id: + title: "Client Id" + description: "The Client ID for your Oauth application" + airbyte_secret: true + airbyte_hidden: true + type: "string" + client_secret: + title: "Client Secret" + description: "The Client Secret for your Oauth application" + airbyte_secret: true + airbyte_hidden: true + type: "string" + sourceType: + title: "instagram" + const: "instagram" + enum: + - "instagram" + order: 0 + type: "string" + required: + - "access_token" + - "sourceType" + source-instagram-update: + title: "Source Instagram" + type: "object" + properties: + start_date: + title: "Start Date" + description: "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." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2017-01-25T00:00:00Z" + type: "string" + format: "date-time" + access_token: + title: "Access Token" + description: "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" + airbyte_secret: true + type: "string" + client_id: + title: "Client Id" + description: "The Client ID for your Oauth application" + airbyte_secret: true + airbyte_hidden: true + type: "string" + client_secret: + title: "Client Secret" + description: "The Client Secret for your Oauth application" + airbyte_secret: true + airbyte_hidden: true + type: "string" + required: + - "access_token" + source-s3: + title: "Config" + description: "NOTE: When this Spec is changed, legacy_config_transformer.py\ + \ must also be modified to uptake the changes\nbecause it is responsible for\ + \ converting legacy S3 v3 configs into v4 configs using the File-Based CDK." + type: "object" + properties: + start_date: + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00.000000Z.\ + \ Any file modified before this date will not be replicated." + examples: + - "2021-01-01T00:00:00.000000Z" + format: "date-time" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$" + pattern_descriptor: "YYYY-MM-DDTHH:mm:ss.SSSSSSZ" + order: 1 + type: "string" + streams: + title: "The list of streams to sync" + description: "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." + order: 10 + type: "array" + items: + title: "FileBasedStreamConfig" + type: "object" + properties: + name: + title: "Name" + description: "The name of the stream." + type: "string" + globs: + title: "Globs" + description: "The pattern used to specify which files should be selected\ + \ from the file system. For more information on glob pattern matching\ + \ look here." + default: + - "**" + order: 1 + type: "array" + items: + type: "string" + legacy_prefix: + title: "Legacy Prefix" + description: "The path prefix configured in v3 versions of the S3\ + \ connector. This option is deprecated in favor of a single glob." + airbyte_hidden: true + type: "string" + validation_policy: + title: "Validation Policy" + description: "The name of the validation policy that dictates sync\ + \ behavior when a record does not adhere to the stream schema." + default: "Emit Record" + enum: + - "Emit Record" + - "Skip Record" + - "Wait for Discover" + input_schema: + title: "Input Schema" + description: "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." + type: "string" + primary_key: + title: "Primary Key" + description: "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." + airbyte_hidden: true + type: "string" + x-speakeasy-param-sensitive: true + days_to_sync_if_history_is_full: + title: "Days To Sync If History Is Full" + description: "When the state history of the file store is full, syncs\ + \ will only read files that were last modified in the provided day\ + \ range." + default: 3 + type: "integer" + format: + title: "Format" + description: "The configuration options that are used to alter how\ + \ to read incoming files that deviate from the standard formatting." + type: "object" + oneOf: + - title: "Avro Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "avro" + const: "avro" + type: "string" + enum: + - "avro" + double_as_string: + title: "Convert Double Fields to Strings" + description: "Whether to convert double fields to strings. This\ + \ is recommended if you have decimal numbers with a high degree\ + \ of precision because there can be a loss precision when\ + \ handling floating point numbers." + default: false + type: "boolean" + required: + - "filetype" + - title: "CSV Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "csv" + const: "csv" + type: "string" + enum: + - "csv" + delimiter: + title: "Delimiter" + description: "The character delimiting individual cells in the\ + \ CSV data. This may only be a 1-character string. For tab-delimited\ + \ data enter '\\t'." + default: "," + type: "string" + quote_char: + title: "Quote Character" + description: "The character used for quoting CSV values. To\ + \ disallow quoting, make this field blank." + default: "\"" + type: "string" + escape_char: + title: "Escape Character" + description: "The character used for escaping special characters.\ + \ To disallow escaping, leave this field blank." + type: "string" + encoding: + title: "Encoding" + description: "The character encoding of the CSV data. Leave\ + \ blank to default to UTF8. See list of python encodings for allowable\ + \ options." + default: "utf8" + type: "string" + double_quote: + title: "Double Quote" + description: "Whether two quotes in a quoted CSV value denote\ + \ a single quote in the data." + default: true + type: "boolean" + null_values: + title: "Null Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as null values. For example, if the value 'NA'\ + \ should be interpreted as null, enter 'NA' in this field." + default: [] + type: "array" + items: + type: "string" + uniqueItems: true + strings_can_be_null: + title: "Strings Can Be Null" + description: "Whether strings can be interpreted as null values.\ + \ If true, strings that match the null_values set will be\ + \ interpreted as null. If false, strings that match the null_values\ + \ set will be interpreted as the string itself." + default: true + type: "boolean" + skip_rows_before_header: + title: "Skip Rows Before Header" + description: "The number of rows to skip before the header row.\ + \ For example, if the header row is on the 3rd row, enter\ + \ 2 in this field." + default: 0 + type: "integer" + skip_rows_after_header: + title: "Skip Rows After Header" + description: "The number of rows to skip after the header row." + default: 0 + type: "integer" + header_definition: + title: "CSV Header Definition" + description: "How headers will be defined. `User Provided` assumes\ + \ the CSV does not have a header row and uses the headers\ + \ provided and `Autogenerated` assumes the CSV does not have\ + \ a header row and the CDK will generate headers using for\ + \ `f{i}` where `i` is the index starting from 0. Else, the\ + \ default behavior is to use the header from the CSV file.\ + \ If a user wants to autogenerate or provide column names\ + \ for a CSV having headers, they can skip rows." + default: + header_definition_type: "From CSV" + oneOf: + - title: "From CSV" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "From CSV" + const: "From CSV" + type: "string" + enum: + - "From CSV" + required: + - "header_definition_type" + - title: "Autogenerated" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "Autogenerated" + const: "Autogenerated" + type: "string" + enum: + - "Autogenerated" + required: + - "header_definition_type" + - title: "User Provided" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "User Provided" + const: "User Provided" + type: "string" + enum: + - "User Provided" + column_names: + title: "Column Names" + description: "The column names that will be used while\ + \ emitting the CSV records" + type: "array" + items: + type: "string" + required: + - "column_names" + - "header_definition_type" + type: "object" + true_values: + title: "True Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as true values." + default: + - "y" + - "yes" + - "t" + - "true" + - "on" + - "1" + type: "array" + items: + type: "string" + uniqueItems: true + false_values: + title: "False Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as false values." + default: + - "n" + - "no" + - "f" + - "false" + - "off" + - "0" + type: "array" + items: + type: "string" + uniqueItems: true + inference_type: + title: "Inference Type" + description: "How to infer the types of the columns. If none,\ + \ inference default to strings." + default: "None" + airbyte_hidden: true + enum: + - "None" + - "Primitive Types Only" + required: + - "filetype" + - title: "Jsonl Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "jsonl" + const: "jsonl" + type: "string" + enum: + - "jsonl" + required: + - "filetype" + - title: "Parquet Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "parquet" + const: "parquet" + type: "string" + enum: + - "parquet" + decimal_as_float: + title: "Convert Decimal Fields to Floats" + description: "Whether to convert decimal fields to floats. There\ + \ is a loss of precision when converting decimals to floats,\ + \ so this is not recommended." + default: false + type: "boolean" + required: + - "filetype" + - title: "Document File Type Format (Experimental)" + type: "object" + properties: + filetype: + title: "Filetype" + default: "unstructured" + const: "unstructured" + type: "string" + enum: + - "unstructured" + skip_unprocessable_files: + title: "Skip Unprocessable Files" + description: "If true, skip files that cannot be parsed and\ + \ pass the error message along as the _ab_source_file_parse_error\ + \ field. If false, fail the sync." + default: true + always_show: true + type: "boolean" + strategy: + title: "Parsing Strategy" + description: "The strategy used to parse documents. `fast` extracts\ + \ text directly from the document which doesn't work for all\ + \ files. `ocr_only` is more reliable, but slower. `hi_res`\ + \ is the most reliable, but requires an API key and a hosted\ + \ instance of unstructured and can't be used with local mode.\ + \ See the unstructured.io documentation for more details:\ + \ https://unstructured-io.github.io/unstructured/core/partition.html#partition-pdf" + default: "auto" + always_show: true + order: 0 + enum: + - "auto" + - "fast" + - "ocr_only" + - "hi_res" + type: "string" + processing: + title: "Processing" + description: "Processing configuration" + default: + mode: "local" + type: "object" + oneOf: + - title: "Local" + type: "object" + properties: + mode: + title: "Mode" + default: "local" + const: "local" + enum: + - "local" + type: "string" + description: "Process files locally, supporting `fast` and\ + \ `ocr` modes. This is the default option." + required: + - "mode" + description: "Extract text from document formats (.pdf, .docx, .md,\ + \ .pptx) and emit as one record per file." + required: + - "filetype" + schemaless: + title: "Schemaless" + description: "When enabled, syncs will not validate or structure records\ + \ against the stream's schema." + default: false + type: "boolean" + required: + - "name" + - "format" + bucket: + title: "Bucket" + description: "Name of the S3 bucket where the file(s) exist." + order: 0 + type: "string" + aws_access_key_id: + title: "AWS Access Key ID" + description: "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." + airbyte_secret: true + order: 2 + type: "string" + x-speakeasy-param-sensitive: true + role_arn: + title: "AWS Role ARN" + description: "Specifies the Amazon Resource Name (ARN) of an IAM role that\ + \ you want to use to perform operations requested using this profile.\ + \ Set the External ID to the Airbyte workspace ID, which can be found\ + \ in the URL of this page." + order: 6 + type: "string" + aws_secret_access_key: + title: "AWS Secret Access Key" + description: "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." + airbyte_secret: true + order: 3 + type: "string" + x-speakeasy-param-sensitive: true + endpoint: + title: "Endpoint" + description: "Endpoint to an S3 compatible service. Leave empty to use AWS.\ + \ The custom endpoint must be secure, but the 'https' prefix is not required." + default: "" + examples: + - "my-s3-endpoint.com" + - "https://my-s3-endpoint.com" + order: 4 + type: "string" + pattern: "^(?!http://).*$" + region_name: + title: "AWS Region" + description: "AWS region where the S3 bucket is located. If not provided,\ + \ the region will be determined automatically." + order: 5 + type: "string" + dataset: + title: "Output Stream Name" + description: "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." + pattern: "^([A-Za-z0-9-_]+)$" + order: 100 + type: "string" + airbyte_hidden: true + path_pattern: + title: "Pattern of files to replicate" + description: "Deprecated and will be removed soon. Please do not use this\ + \ field anymore and use streams.globs instead. A regular expression which\ + \ tells the connector which files to replicate. All files which match\ + \ this pattern will be replicated. Use | to separate multiple patterns.\ + \ See this page to understand pattern syntax (GLOBSTAR and SPLIT\ + \ flags are enabled). Use pattern ** to pick up all files." + examples: + - "**" + - "myFolder/myTableFiles/*.csv|myFolder/myOtherTableFiles/*.csv" + order: 110 + type: "string" + airbyte_hidden: true + format: + title: "File Format" + description: "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" + default: "csv" + order: 120 + type: "object" + oneOf: + - title: "CSV" + description: "This connector utilises PyArrow (Apache Arrow) for CSV parsing." + type: "object" + properties: + filetype: + title: "Filetype" + default: "csv" + const: "csv" + type: "string" + enum: + - "csv" + delimiter: + title: "Delimiter" + description: "The character delimiting individual cells in the CSV\ + \ data. This may only be a 1-character string. For tab-delimited\ + \ data enter '\\t'." + default: "," + minLength: 1 + order: 0 + type: "string" + infer_datatypes: + title: "Infer Datatypes" + description: "Configures whether a schema for the source should be\ + \ inferred from the current data or not. If set to false and a custom\ + \ schema is set, then the manually enforced schema is used. If a\ + \ schema is not manually set, and this is set to false, then all\ + \ fields will be read as strings" + default: true + order: 1 + type: "boolean" + quote_char: + title: "Quote Character" + description: "The character used for quoting CSV values. To disallow\ + \ quoting, make this field blank." + default: "\"" + order: 2 + type: "string" + escape_char: + title: "Escape Character" + description: "The character used for escaping special characters.\ + \ To disallow escaping, leave this field blank." + order: 3 + type: "string" + encoding: + title: "Encoding" + description: "The character encoding of the CSV data. Leave blank\ + \ to default to UTF8. See list of python encodings for allowable options." + default: "utf8" + order: 4 + type: "string" + double_quote: + title: "Double Quote" + description: "Whether two quotes in a quoted CSV value denote a single\ + \ quote in the data." + default: true + order: 5 + type: "boolean" + newlines_in_values: + title: "Allow newlines in values" + description: "Whether newline characters are allowed in CSV values.\ + \ Turning this on may affect performance. Leave blank to default\ + \ to False." + default: false + order: 6 + type: "boolean" + additional_reader_options: + title: "Additional Reader Options" + description: "Optionally add a valid JSON string here to provide additional\ + \ options to the csv reader. Mappings must correspond to options\ + \ detailed here. 'column_types' is used internally\ + \ to handle schema so overriding that would likely cause problems." + examples: + - "{\"timestamp_parsers\": [\"%m/%d/%Y %H:%M\", \"%Y/%m/%d %H:%M\"\ + ], \"strings_can_be_null\": true, \"null_values\": [\"NA\", \"NULL\"\ + ]}" + order: 7 + type: "string" + advanced_options: + title: "Advanced Options" + description: "Optionally add a valid JSON string here to provide additional\ + \ Pyarrow ReadOptions. Specify 'column_names'\ + \ here if your CSV doesn't have header, or if you want to use custom\ + \ column names. 'block_size' and 'encoding' are already used above,\ + \ specify them again here will override the values above." + examples: + - "{\"column_names\": [\"column1\", \"column2\"]}" + order: 8 + type: "string" + block_size: + title: "Block Size" + description: "The chunk size in bytes to process at a time in memory\ + \ from each file. If your data is particularly wide and failing\ + \ during schema detection, increasing this should solve it. Beware\ + \ of raising this too high as you could hit OOM errors." + default: 10000 + minimum: 1 + maximum: 2147483647 + order: 9 + type: "integer" + - title: "Parquet" + description: "This connector utilises PyArrow (Apache Arrow) for Parquet parsing." + type: "object" + properties: + filetype: + title: "Filetype" + default: "parquet" + const: "parquet" + type: "string" + enum: + - "parquet" + columns: + title: "Selected Columns" + description: "If you only want to sync a subset of the columns from\ + \ the file(s), add the columns you want here as a comma-delimited\ + \ list. Leave it empty to sync all columns." + order: 0 + type: "array" + items: + type: "string" + batch_size: + title: "Record batch size" + description: "Maximum number of records per batch read from the input\ + \ files. Batches may be smaller if there aren’t enough rows in the\ + \ file. This option can help avoid out-of-memory errors if your\ + \ data is particularly wide." + default: 65536 + order: 1 + type: "integer" + buffer_size: + title: "Buffer Size" + description: "Perform read buffering when deserializing individual\ + \ column chunks. By default every group column will be loaded fully\ + \ to memory. This option can help avoid out-of-memory errors if\ + \ your data is particularly wide." + default: 2 + type: "integer" + - title: "Avro" + description: "This connector utilises fastavro for Avro parsing." + type: "object" + properties: + filetype: + title: "Filetype" + default: "avro" + const: "avro" + type: "string" + enum: + - "avro" + - title: "Jsonl" + description: "This connector uses PyArrow for JSON Lines (jsonl) file parsing." + type: "object" + properties: + filetype: + title: "Filetype" + default: "jsonl" + const: "jsonl" + type: "string" + enum: + - "jsonl" + newlines_in_values: + title: "Allow newlines in values" + description: "Whether newline characters are allowed in JSON values.\ + \ Turning this on may affect performance. Leave blank to default\ + \ to False." + default: false + order: 0 + type: "boolean" + unexpected_field_behavior: + title: "Unexpected field behavior" + description: "How JSON fields outside of explicit_schema (if given)\ + \ are treated. Check PyArrow documentation for details" + default: "infer" + examples: + - "ignore" + - "infer" + - "error" + order: 1 + enum: + - "ignore" + - "infer" + - "error" + block_size: + title: "Block Size" + description: "The chunk size in bytes to process at a time in memory\ + \ from each file. If your data is particularly wide and failing\ + \ during schema detection, increasing this should solve it. Beware\ + \ of raising this too high as you could hit OOM errors." + default: 0 + order: 2 + type: "integer" + airbyte_hidden: true + schema: + title: "Manually enforced data schema" + description: "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." + default: "{}" + examples: + - "{\"column_1\": \"number\", \"column_2\": \"string\", \"column_3\": \"\ + array\", \"column_4\": \"object\", \"column_5\": \"boolean\"}" + order: 130 + type: "string" + airbyte_hidden: true + provider: + title: "S3: Amazon Web Services" + type: "object" + properties: + bucket: + title: "Bucket" + description: "Name of the S3 bucket where the file(s) exist." + order: 0 + type: "string" + aws_access_key_id: + title: "AWS Access Key ID" + description: "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." + airbyte_secret: true + always_show: true + order: 1 + type: "string" + x-speakeasy-param-sensitive: true + aws_secret_access_key: + title: "AWS Secret Access Key" + description: "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." + airbyte_secret: true + always_show: true + order: 2 + type: "string" + x-speakeasy-param-sensitive: true + role_arn: + title: "AWS Role ARN" + description: "Specifies the Amazon Resource Name (ARN) of an IAM role\ + \ that you want to use to perform operations requested using this\ + \ profile. Set the External ID to the Airbyte workspace ID, which\ + \ can be found in the URL of this page." + always_show: true + order: 7 + type: "string" + path_prefix: + title: "Path Prefix" + description: "By providing a path-like prefix (e.g. myFolder/thisTable/)\ + \ under which all the relevant files sit, we can optimize finding\ + \ these in S3. This is optional but recommended if your bucket contains\ + \ many folders/files which you don't need to replicate." + default: "" + order: 3 + type: "string" + endpoint: + title: "Endpoint" + description: "Endpoint to an S3 compatible service. Leave empty to use\ + \ AWS." + default: "" + order: 4 + type: "string" + region_name: + title: "AWS Region" + description: "AWS region where the S3 bucket is located. If not provided,\ + \ the region will be determined automatically." + order: 5 + type: "string" + start_date: + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00Z.\ + \ Any file modified before this date will not be replicated." + examples: + - "2021-01-01T00:00:00Z" + format: "date-time" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + order: 6 + type: "string" + required: [] + order: 111 + description: "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" + airbyte_hidden: true + sourceType: + title: "s3" + const: "s3" + enum: + - "s3" + order: 0 + type: "string" + required: + - "streams" + - "bucket" + - "sourceType" + source-s3-update: + title: "Config" + description: "NOTE: When this Spec is changed, legacy_config_transformer.py\ + \ must also be modified to uptake the changes\nbecause it is responsible for\ + \ converting legacy S3 v3 configs into v4 configs using the File-Based CDK." + type: "object" + properties: + start_date: + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00.000000Z.\ + \ Any file modified before this date will not be replicated." + examples: + - "2021-01-01T00:00:00.000000Z" + format: "date-time" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$" + pattern_descriptor: "YYYY-MM-DDTHH:mm:ss.SSSSSSZ" + order: 1 + type: "string" + streams: + title: "The list of streams to sync" + description: "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." + order: 10 + type: "array" + items: + title: "FileBasedStreamConfig" + type: "object" + properties: + name: + title: "Name" + description: "The name of the stream." + type: "string" + globs: + title: "Globs" + description: "The pattern used to specify which files should be selected\ + \ from the file system. For more information on glob pattern matching\ + \ look here." + default: + - "**" + order: 1 + type: "array" + items: + type: "string" + legacy_prefix: + title: "Legacy Prefix" + description: "The path prefix configured in v3 versions of the S3\ + \ connector. This option is deprecated in favor of a single glob." + airbyte_hidden: true + type: "string" + validation_policy: + title: "Validation Policy" + description: "The name of the validation policy that dictates sync\ + \ behavior when a record does not adhere to the stream schema." + default: "Emit Record" + enum: + - "Emit Record" + - "Skip Record" + - "Wait for Discover" + input_schema: + title: "Input Schema" + description: "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." + type: "string" + primary_key: + title: "Primary Key" + description: "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." + airbyte_hidden: true + type: "string" + days_to_sync_if_history_is_full: + title: "Days To Sync If History Is Full" + description: "When the state history of the file store is full, syncs\ + \ will only read files that were last modified in the provided day\ + \ range." + default: 3 + type: "integer" + format: + title: "Format" + description: "The configuration options that are used to alter how\ + \ to read incoming files that deviate from the standard formatting." + type: "object" + oneOf: + - title: "Avro Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "avro" + const: "avro" + type: "string" + enum: + - "avro" + double_as_string: + title: "Convert Double Fields to Strings" + description: "Whether to convert double fields to strings. This\ + \ is recommended if you have decimal numbers with a high degree\ + \ of precision because there can be a loss precision when\ + \ handling floating point numbers." + default: false + type: "boolean" + required: + - "filetype" + - title: "CSV Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "csv" + const: "csv" + type: "string" + enum: + - "csv" + delimiter: + title: "Delimiter" + description: "The character delimiting individual cells in the\ + \ CSV data. This may only be a 1-character string. For tab-delimited\ + \ data enter '\\t'." + default: "," + type: "string" + quote_char: + title: "Quote Character" + description: "The character used for quoting CSV values. To\ + \ disallow quoting, make this field blank." + default: "\"" + type: "string" + escape_char: + title: "Escape Character" + description: "The character used for escaping special characters.\ + \ To disallow escaping, leave this field blank." + type: "string" + encoding: + title: "Encoding" + description: "The character encoding of the CSV data. Leave\ + \ blank to default to UTF8. See list of python encodings for allowable\ + \ options." + default: "utf8" + type: "string" + double_quote: + title: "Double Quote" + description: "Whether two quotes in a quoted CSV value denote\ + \ a single quote in the data." + default: true + type: "boolean" + null_values: + title: "Null Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as null values. For example, if the value 'NA'\ + \ should be interpreted as null, enter 'NA' in this field." + default: [] + type: "array" + items: + type: "string" + uniqueItems: true + strings_can_be_null: + title: "Strings Can Be Null" + description: "Whether strings can be interpreted as null values.\ + \ If true, strings that match the null_values set will be\ + \ interpreted as null. If false, strings that match the null_values\ + \ set will be interpreted as the string itself." + default: true + type: "boolean" + skip_rows_before_header: + title: "Skip Rows Before Header" + description: "The number of rows to skip before the header row.\ + \ For example, if the header row is on the 3rd row, enter\ + \ 2 in this field." + default: 0 + type: "integer" + skip_rows_after_header: + title: "Skip Rows After Header" + description: "The number of rows to skip after the header row." + default: 0 + type: "integer" + header_definition: + title: "CSV Header Definition" + description: "How headers will be defined. `User Provided` assumes\ + \ the CSV does not have a header row and uses the headers\ + \ provided and `Autogenerated` assumes the CSV does not have\ + \ a header row and the CDK will generate headers using for\ + \ `f{i}` where `i` is the index starting from 0. Else, the\ + \ default behavior is to use the header from the CSV file.\ + \ If a user wants to autogenerate or provide column names\ + \ for a CSV having headers, they can skip rows." + default: + header_definition_type: "From CSV" + oneOf: + - title: "From CSV" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "From CSV" + const: "From CSV" + type: "string" + enum: + - "From CSV" + required: + - "header_definition_type" + - title: "Autogenerated" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "Autogenerated" + const: "Autogenerated" + type: "string" + enum: + - "Autogenerated" + required: + - "header_definition_type" + - title: "User Provided" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "User Provided" + const: "User Provided" + type: "string" + enum: + - "User Provided" + column_names: + title: "Column Names" + description: "The column names that will be used while\ + \ emitting the CSV records" + type: "array" + items: + type: "string" + required: + - "column_names" + - "header_definition_type" + type: "object" + true_values: + title: "True Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as true values." + default: + - "y" + - "yes" + - "t" + - "true" + - "on" + - "1" + type: "array" + items: + type: "string" + uniqueItems: true + false_values: + title: "False Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as false values." + default: + - "n" + - "no" + - "f" + - "false" + - "off" + - "0" + type: "array" + items: + type: "string" + uniqueItems: true + inference_type: + title: "Inference Type" + description: "How to infer the types of the columns. If none,\ + \ inference default to strings." + default: "None" + airbyte_hidden: true + enum: + - "None" + - "Primitive Types Only" + required: + - "filetype" + - title: "Jsonl Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "jsonl" + const: "jsonl" + type: "string" + enum: + - "jsonl" + required: + - "filetype" + - title: "Parquet Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "parquet" + const: "parquet" + type: "string" + enum: + - "parquet" + decimal_as_float: + title: "Convert Decimal Fields to Floats" + description: "Whether to convert decimal fields to floats. There\ + \ is a loss of precision when converting decimals to floats,\ + \ so this is not recommended." + default: false + type: "boolean" + required: + - "filetype" + - title: "Document File Type Format (Experimental)" + type: "object" + properties: + filetype: + title: "Filetype" + default: "unstructured" + const: "unstructured" + type: "string" + enum: + - "unstructured" + skip_unprocessable_files: + title: "Skip Unprocessable Files" + description: "If true, skip files that cannot be parsed and\ + \ pass the error message along as the _ab_source_file_parse_error\ + \ field. If false, fail the sync." + default: true + always_show: true + type: "boolean" + strategy: + title: "Parsing Strategy" + description: "The strategy used to parse documents. `fast` extracts\ + \ text directly from the document which doesn't work for all\ + \ files. `ocr_only` is more reliable, but slower. `hi_res`\ + \ is the most reliable, but requires an API key and a hosted\ + \ instance of unstructured and can't be used with local mode.\ + \ See the unstructured.io documentation for more details:\ + \ https://unstructured-io.github.io/unstructured/core/partition.html#partition-pdf" + default: "auto" + always_show: true + order: 0 + enum: + - "auto" + - "fast" + - "ocr_only" + - "hi_res" + type: "string" + processing: + title: "Processing" + description: "Processing configuration" + default: + mode: "local" + type: "object" + oneOf: + - title: "Local" + type: "object" + properties: + mode: + title: "Mode" + default: "local" + const: "local" + enum: + - "local" + type: "string" + description: "Process files locally, supporting `fast` and\ + \ `ocr` modes. This is the default option." + required: + - "mode" + description: "Extract text from document formats (.pdf, .docx, .md,\ + \ .pptx) and emit as one record per file." + required: + - "filetype" + schemaless: + title: "Schemaless" + description: "When enabled, syncs will not validate or structure records\ + \ against the stream's schema." + default: false + type: "boolean" + required: + - "name" + - "format" + bucket: + title: "Bucket" + description: "Name of the S3 bucket where the file(s) exist." + order: 0 + type: "string" + aws_access_key_id: + title: "AWS Access Key ID" + description: "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." + airbyte_secret: true + order: 2 + type: "string" + role_arn: + title: "AWS Role ARN" + description: "Specifies the Amazon Resource Name (ARN) of an IAM role that\ + \ you want to use to perform operations requested using this profile.\ + \ Set the External ID to the Airbyte workspace ID, which can be found\ + \ in the URL of this page." + order: 6 + type: "string" + aws_secret_access_key: + title: "AWS Secret Access Key" + description: "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." + airbyte_secret: true + order: 3 + type: "string" + endpoint: + title: "Endpoint" + description: "Endpoint to an S3 compatible service. Leave empty to use AWS.\ + \ The custom endpoint must be secure, but the 'https' prefix is not required." + default: "" + examples: + - "my-s3-endpoint.com" + - "https://my-s3-endpoint.com" + order: 4 + type: "string" + pattern: "^(?!http://).*$" + region_name: + title: "AWS Region" + description: "AWS region where the S3 bucket is located. If not provided,\ + \ the region will be determined automatically." + order: 5 + type: "string" + dataset: + title: "Output Stream Name" + description: "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." + pattern: "^([A-Za-z0-9-_]+)$" + order: 100 + type: "string" + airbyte_hidden: true + path_pattern: + title: "Pattern of files to replicate" + description: "Deprecated and will be removed soon. Please do not use this\ + \ field anymore and use streams.globs instead. A regular expression which\ + \ tells the connector which files to replicate. All files which match\ + \ this pattern will be replicated. Use | to separate multiple patterns.\ + \ See this page to understand pattern syntax (GLOBSTAR and SPLIT\ + \ flags are enabled). Use pattern ** to pick up all files." + examples: + - "**" + - "myFolder/myTableFiles/*.csv|myFolder/myOtherTableFiles/*.csv" + order: 110 + type: "string" + airbyte_hidden: true + format: + title: "File Format" + description: "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" + default: "csv" + order: 120 + type: "object" + oneOf: + - title: "CSV" + description: "This connector utilises PyArrow (Apache Arrow) for CSV parsing." + type: "object" + properties: + filetype: + title: "Filetype" + default: "csv" + const: "csv" + type: "string" + enum: + - "csv" + delimiter: + title: "Delimiter" + description: "The character delimiting individual cells in the CSV\ + \ data. This may only be a 1-character string. For tab-delimited\ + \ data enter '\\t'." + default: "," + minLength: 1 + order: 0 + type: "string" + infer_datatypes: + title: "Infer Datatypes" + description: "Configures whether a schema for the source should be\ + \ inferred from the current data or not. If set to false and a custom\ + \ schema is set, then the manually enforced schema is used. If a\ + \ schema is not manually set, and this is set to false, then all\ + \ fields will be read as strings" + default: true + order: 1 + type: "boolean" + quote_char: + title: "Quote Character" + description: "The character used for quoting CSV values. To disallow\ + \ quoting, make this field blank." + default: "\"" + order: 2 + type: "string" + escape_char: + title: "Escape Character" + description: "The character used for escaping special characters.\ + \ To disallow escaping, leave this field blank." + order: 3 + type: "string" + encoding: + title: "Encoding" + description: "The character encoding of the CSV data. Leave blank\ + \ to default to UTF8. See list of python encodings for allowable options." + default: "utf8" + order: 4 + type: "string" + double_quote: + title: "Double Quote" + description: "Whether two quotes in a quoted CSV value denote a single\ + \ quote in the data." + default: true + order: 5 + type: "boolean" + newlines_in_values: + title: "Allow newlines in values" + description: "Whether newline characters are allowed in CSV values.\ + \ Turning this on may affect performance. Leave blank to default\ + \ to False." + default: false + order: 6 + type: "boolean" + additional_reader_options: + title: "Additional Reader Options" + description: "Optionally add a valid JSON string here to provide additional\ + \ options to the csv reader. Mappings must correspond to options\ + \ detailed here. 'column_types' is used internally\ + \ to handle schema so overriding that would likely cause problems." + examples: + - "{\"timestamp_parsers\": [\"%m/%d/%Y %H:%M\", \"%Y/%m/%d %H:%M\"\ + ], \"strings_can_be_null\": true, \"null_values\": [\"NA\", \"NULL\"\ + ]}" + order: 7 + type: "string" + advanced_options: + title: "Advanced Options" + description: "Optionally add a valid JSON string here to provide additional\ + \ Pyarrow ReadOptions. Specify 'column_names'\ + \ here if your CSV doesn't have header, or if you want to use custom\ + \ column names. 'block_size' and 'encoding' are already used above,\ + \ specify them again here will override the values above." + examples: + - "{\"column_names\": [\"column1\", \"column2\"]}" + order: 8 + type: "string" + block_size: + title: "Block Size" + description: "The chunk size in bytes to process at a time in memory\ + \ from each file. If your data is particularly wide and failing\ + \ during schema detection, increasing this should solve it. Beware\ + \ of raising this too high as you could hit OOM errors." + default: 10000 + minimum: 1 + maximum: 2147483647 + order: 9 + type: "integer" + - title: "Parquet" + description: "This connector utilises PyArrow (Apache Arrow) for Parquet parsing." + type: "object" + properties: + filetype: + title: "Filetype" + default: "parquet" + const: "parquet" + type: "string" + enum: + - "parquet" + columns: + title: "Selected Columns" + description: "If you only want to sync a subset of the columns from\ + \ the file(s), add the columns you want here as a comma-delimited\ + \ list. Leave it empty to sync all columns." + order: 0 + type: "array" + items: + type: "string" + batch_size: + title: "Record batch size" + description: "Maximum number of records per batch read from the input\ + \ files. Batches may be smaller if there aren’t enough rows in the\ + \ file. This option can help avoid out-of-memory errors if your\ + \ data is particularly wide." + default: 65536 + order: 1 + type: "integer" + buffer_size: + title: "Buffer Size" + description: "Perform read buffering when deserializing individual\ + \ column chunks. By default every group column will be loaded fully\ + \ to memory. This option can help avoid out-of-memory errors if\ + \ your data is particularly wide." + default: 2 + type: "integer" + - title: "Avro" + description: "This connector utilises fastavro for Avro parsing." + type: "object" + properties: + filetype: + title: "Filetype" + default: "avro" + const: "avro" + type: "string" + enum: + - "avro" + - title: "Jsonl" + description: "This connector uses PyArrow for JSON Lines (jsonl) file parsing." + type: "object" + properties: + filetype: + title: "Filetype" + default: "jsonl" + const: "jsonl" + type: "string" + enum: + - "jsonl" + newlines_in_values: + title: "Allow newlines in values" + description: "Whether newline characters are allowed in JSON values.\ + \ Turning this on may affect performance. Leave blank to default\ + \ to False." + default: false + order: 0 + type: "boolean" + unexpected_field_behavior: + title: "Unexpected field behavior" + description: "How JSON fields outside of explicit_schema (if given)\ + \ are treated. Check PyArrow documentation for details" + default: "infer" + examples: + - "ignore" + - "infer" + - "error" + order: 1 + enum: + - "ignore" + - "infer" + - "error" + block_size: + title: "Block Size" + description: "The chunk size in bytes to process at a time in memory\ + \ from each file. If your data is particularly wide and failing\ + \ during schema detection, increasing this should solve it. Beware\ + \ of raising this too high as you could hit OOM errors." + default: 0 + order: 2 + type: "integer" + airbyte_hidden: true + schema: + title: "Manually enforced data schema" + description: "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." + default: "{}" + examples: + - "{\"column_1\": \"number\", \"column_2\": \"string\", \"column_3\": \"\ + array\", \"column_4\": \"object\", \"column_5\": \"boolean\"}" + order: 130 + type: "string" + airbyte_hidden: true + provider: + title: "S3: Amazon Web Services" + type: "object" + properties: + bucket: + title: "Bucket" + description: "Name of the S3 bucket where the file(s) exist." + order: 0 + type: "string" + aws_access_key_id: + title: "AWS Access Key ID" + description: "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." + airbyte_secret: true + always_show: true + order: 1 + type: "string" + aws_secret_access_key: + title: "AWS Secret Access Key" + description: "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." + airbyte_secret: true + always_show: true + order: 2 + type: "string" + role_arn: + title: "AWS Role ARN" + description: "Specifies the Amazon Resource Name (ARN) of an IAM role\ + \ that you want to use to perform operations requested using this\ + \ profile. Set the External ID to the Airbyte workspace ID, which\ + \ can be found in the URL of this page." + always_show: true + order: 7 + type: "string" + path_prefix: + title: "Path Prefix" + description: "By providing a path-like prefix (e.g. myFolder/thisTable/)\ + \ under which all the relevant files sit, we can optimize finding\ + \ these in S3. This is optional but recommended if your bucket contains\ + \ many folders/files which you don't need to replicate." + default: "" + order: 3 + type: "string" + endpoint: + title: "Endpoint" + description: "Endpoint to an S3 compatible service. Leave empty to use\ + \ AWS." + default: "" + order: 4 + type: "string" + region_name: + title: "AWS Region" + description: "AWS region where the S3 bucket is located. If not provided,\ + \ the region will be determined automatically." + order: 5 + type: "string" + start_date: + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00Z.\ + \ Any file modified before this date will not be replicated." + examples: + - "2021-01-01T00:00:00Z" + format: "date-time" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + order: 6 + type: "string" + required: [] + order: 111 + description: "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" + airbyte_hidden: true + required: + - "streams" + - "bucket" + source-azure-blob-storage: + title: "Config" + description: "NOTE: When this Spec is changed, legacy_config_transformer.py\ + \ must also be modified to uptake the changes\nbecause it is responsible for\ + \ converting legacy Azure Blob Storage v0 configs into v1 configs using the\ + \ File-Based CDK." + type: "object" + properties: + start_date: + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00.000000Z.\ + \ Any file modified before this date will not be replicated." + examples: + - "2021-01-01T00:00:00.000000Z" + format: "date-time" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$" + pattern_descriptor: "YYYY-MM-DDTHH:mm:ss.SSSSSSZ" + order: 1 + type: "string" + streams: + title: "The list of streams to sync" + description: "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." + order: 10 + type: "array" + items: + title: "FileBasedStreamConfig" + type: "object" + properties: + name: + title: "Name" + description: "The name of the stream." + type: "string" + globs: + title: "Globs" + description: "The pattern used to specify which files should be selected\ + \ from the file system. For more information on glob pattern matching\ + \ look here." + default: + - "**" + order: 1 + type: "array" + items: + type: "string" + legacy_prefix: + title: "Legacy Prefix" + description: "The path prefix configured in v3 versions of the S3\ + \ connector. This option is deprecated in favor of a single glob." + airbyte_hidden: true + type: "string" + validation_policy: + title: "Validation Policy" + description: "The name of the validation policy that dictates sync\ + \ behavior when a record does not adhere to the stream schema." + default: "Emit Record" + enum: + - "Emit Record" + - "Skip Record" + - "Wait for Discover" + input_schema: + title: "Input Schema" + description: "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." + type: "string" + primary_key: + title: "Primary Key" + description: "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." + airbyte_hidden: true + type: "string" + x-speakeasy-param-sensitive: true + days_to_sync_if_history_is_full: + title: "Days To Sync If History Is Full" + description: "When the state history of the file store is full, syncs\ + \ will only read files that were last modified in the provided day\ + \ range." + default: 3 + type: "integer" + format: + title: "Format" + description: "The configuration options that are used to alter how\ + \ to read incoming files that deviate from the standard formatting." + type: "object" + oneOf: + - title: "Avro Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "avro" + const: "avro" + type: "string" + enum: + - "avro" + double_as_string: + title: "Convert Double Fields to Strings" + description: "Whether to convert double fields to strings. This\ + \ is recommended if you have decimal numbers with a high degree\ + \ of precision because there can be a loss precision when\ + \ handling floating point numbers." + default: false + type: "boolean" + required: + - "filetype" + - title: "CSV Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "csv" + const: "csv" + type: "string" + enum: + - "csv" + delimiter: + title: "Delimiter" + description: "The character delimiting individual cells in the\ + \ CSV data. This may only be a 1-character string. For tab-delimited\ + \ data enter '\\t'." + default: "," + type: "string" + quote_char: + title: "Quote Character" + description: "The character used for quoting CSV values. To\ + \ disallow quoting, make this field blank." + default: "\"" + type: "string" + escape_char: + title: "Escape Character" + description: "The character used for escaping special characters.\ + \ To disallow escaping, leave this field blank." + type: "string" + encoding: + title: "Encoding" + description: "The character encoding of the CSV data. Leave\ + \ blank to default to UTF8. See list of python encodings for allowable\ + \ options." + default: "utf8" + type: "string" + double_quote: + title: "Double Quote" + description: "Whether two quotes in a quoted CSV value denote\ + \ a single quote in the data." + default: true + type: "boolean" + null_values: + title: "Null Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as null values. For example, if the value 'NA'\ + \ should be interpreted as null, enter 'NA' in this field." + default: [] + type: "array" + items: + type: "string" + uniqueItems: true + strings_can_be_null: + title: "Strings Can Be Null" + description: "Whether strings can be interpreted as null values.\ + \ If true, strings that match the null_values set will be\ + \ interpreted as null. If false, strings that match the null_values\ + \ set will be interpreted as the string itself." + default: true + type: "boolean" + skip_rows_before_header: + title: "Skip Rows Before Header" + description: "The number of rows to skip before the header row.\ + \ For example, if the header row is on the 3rd row, enter\ + \ 2 in this field." + default: 0 + type: "integer" + skip_rows_after_header: + title: "Skip Rows After Header" + description: "The number of rows to skip after the header row." + default: 0 + type: "integer" + header_definition: + title: "CSV Header Definition" + description: "How headers will be defined. `User Provided` assumes\ + \ the CSV does not have a header row and uses the headers\ + \ provided and `Autogenerated` assumes the CSV does not have\ + \ a header row and the CDK will generate headers using for\ + \ `f{i}` where `i` is the index starting from 0. Else, the\ + \ default behavior is to use the header from the CSV file.\ + \ If a user wants to autogenerate or provide column names\ + \ for a CSV having headers, they can skip rows." + default: + header_definition_type: "From CSV" + oneOf: + - title: "From CSV" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "From CSV" + const: "From CSV" + type: "string" + enum: + - "From CSV" + required: + - "header_definition_type" + - title: "Autogenerated" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "Autogenerated" + const: "Autogenerated" + type: "string" + enum: + - "Autogenerated" + required: + - "header_definition_type" + - title: "User Provided" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "User Provided" + const: "User Provided" + type: "string" + enum: + - "User Provided" + column_names: + title: "Column Names" + description: "The column names that will be used while\ + \ emitting the CSV records" + type: "array" + items: + type: "string" + required: + - "column_names" + - "header_definition_type" + type: "object" + true_values: + title: "True Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as true values." + default: + - "y" + - "yes" + - "t" + - "true" + - "on" + - "1" + type: "array" + items: + type: "string" + uniqueItems: true + false_values: + title: "False Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as false values." + default: + - "n" + - "no" + - "f" + - "false" + - "off" + - "0" + type: "array" + items: + type: "string" + uniqueItems: true + inference_type: + title: "Inference Type" + description: "How to infer the types of the columns. If none,\ + \ inference default to strings." + default: "None" + airbyte_hidden: true + enum: + - "None" + - "Primitive Types Only" + ignore_errors_on_fields_mismatch: + title: "Ignore errors on field mismatch" + description: "Whether to ignore errors that occur when the number\ + \ of fields in the CSV does not match the number of columns\ + \ in the schema." + default: false + type: "boolean" + required: + - "filetype" + - title: "Jsonl Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "jsonl" + const: "jsonl" + type: "string" + enum: + - "jsonl" + required: + - "filetype" + - title: "Parquet Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "parquet" + const: "parquet" + type: "string" + enum: + - "parquet" + decimal_as_float: + title: "Convert Decimal Fields to Floats" + description: "Whether to convert decimal fields to floats. There\ + \ is a loss of precision when converting decimals to floats,\ + \ so this is not recommended." + default: false + type: "boolean" + required: + - "filetype" + - title: "Document File Type Format (Experimental)" + type: "object" + properties: + filetype: + title: "Filetype" + default: "unstructured" + const: "unstructured" + type: "string" + enum: + - "unstructured" + skip_unprocessable_files: + title: "Skip Unprocessable Files" + description: "If true, skip files that cannot be parsed and\ + \ pass the error message along as the _ab_source_file_parse_error\ + \ field. If false, fail the sync." + default: true + always_show: true + type: "boolean" + strategy: + title: "Parsing Strategy" + description: "The strategy used to parse documents. `fast` extracts\ + \ text directly from the document which doesn't work for all\ + \ files. `ocr_only` is more reliable, but slower. `hi_res`\ + \ is the most reliable, but requires an API key and a hosted\ + \ instance of unstructured and can't be used with local mode.\ + \ See the unstructured.io documentation for more details:\ + \ https://unstructured-io.github.io/unstructured/core/partition.html#partition-pdf" + default: "auto" + always_show: true + order: 0 + enum: + - "auto" + - "fast" + - "ocr_only" + - "hi_res" + type: "string" + processing: + title: "Processing" + description: "Processing configuration" + default: + mode: "local" + type: "object" + oneOf: + - title: "Local" + type: "object" + properties: + mode: + title: "Mode" + default: "local" + const: "local" + enum: + - "local" + type: "string" + description: "Process files locally, supporting `fast` and\ + \ `ocr` modes. This is the default option." + required: + - "mode" + description: "Extract text from document formats (.pdf, .docx, .md,\ + \ .pptx) and emit as one record per file." + required: + - "filetype" + schemaless: + title: "Schemaless" + description: "When enabled, syncs will not validate or structure records\ + \ against the stream's schema." + default: false + type: "boolean" + required: + - "name" + - "format" + azure_blob_storage_account_name: + title: "Azure Blob Storage account name" + description: "The account's name of the Azure Blob Storage." + examples: + - "airbyte5storage" + order: 2 + type: "string" + azure_blob_storage_account_key: + title: "Azure Blob Storage account key" + description: "The Azure blob storage account key." + airbyte_secret: true + examples: + - "Z8ZkZpteggFx394vm+PJHnGTvdRncaYS+JhLKdj789YNmD+iyGTnG+PV+POiuYNhBg/ACS+LKjd%4FG3FHGN12Nd==" + order: 3 + type: "string" + x-speakeasy-param-sensitive: true + azure_blob_storage_container_name: + title: "Azure blob storage container (Bucket) Name" + description: "The name of the Azure blob storage container." + examples: + - "airbytetescontainername" + order: 4 + type: "string" + azure_blob_storage_endpoint: + title: "Endpoint Domain Name" + description: "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." + examples: + - "blob.core.windows.net" + order: 11 + type: "string" + sourceType: + title: "azure-blob-storage" + const: "azure-blob-storage" + enum: + - "azure-blob-storage" + order: 0 + type: "string" + required: + - "streams" + - "azure_blob_storage_account_name" + - "azure_blob_storage_account_key" + - "azure_blob_storage_container_name" + - "sourceType" + source-azure-blob-storage-update: + title: "Config" + description: "NOTE: When this Spec is changed, legacy_config_transformer.py\ + \ must also be modified to uptake the changes\nbecause it is responsible for\ + \ converting legacy Azure Blob Storage v0 configs into v1 configs using the\ + \ File-Based CDK." + type: "object" + properties: + start_date: + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00.000000Z.\ + \ Any file modified before this date will not be replicated." + examples: + - "2021-01-01T00:00:00.000000Z" + format: "date-time" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$" + pattern_descriptor: "YYYY-MM-DDTHH:mm:ss.SSSSSSZ" + order: 1 + type: "string" + streams: + title: "The list of streams to sync" + description: "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." + order: 10 + type: "array" + items: + title: "FileBasedStreamConfig" + type: "object" + properties: + name: + title: "Name" + description: "The name of the stream." + type: "string" + globs: + title: "Globs" + description: "The pattern used to specify which files should be selected\ + \ from the file system. For more information on glob pattern matching\ + \ look here." + default: + - "**" + order: 1 + type: "array" + items: + type: "string" + legacy_prefix: + title: "Legacy Prefix" + description: "The path prefix configured in v3 versions of the S3\ + \ connector. This option is deprecated in favor of a single glob." + airbyte_hidden: true + type: "string" + validation_policy: + title: "Validation Policy" + description: "The name of the validation policy that dictates sync\ + \ behavior when a record does not adhere to the stream schema." + default: "Emit Record" + enum: + - "Emit Record" + - "Skip Record" + - "Wait for Discover" + input_schema: + title: "Input Schema" + description: "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." + type: "string" + primary_key: + title: "Primary Key" + description: "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." + airbyte_hidden: true + type: "string" + days_to_sync_if_history_is_full: + title: "Days To Sync If History Is Full" + description: "When the state history of the file store is full, syncs\ + \ will only read files that were last modified in the provided day\ + \ range." + default: 3 + type: "integer" + format: + title: "Format" + description: "The configuration options that are used to alter how\ + \ to read incoming files that deviate from the standard formatting." + type: "object" + oneOf: + - title: "Avro Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "avro" + const: "avro" + type: "string" + enum: + - "avro" + double_as_string: + title: "Convert Double Fields to Strings" + description: "Whether to convert double fields to strings. This\ + \ is recommended if you have decimal numbers with a high degree\ + \ of precision because there can be a loss precision when\ + \ handling floating point numbers." + default: false + type: "boolean" + required: + - "filetype" + - title: "CSV Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "csv" + const: "csv" + type: "string" + enum: + - "csv" + delimiter: + title: "Delimiter" + description: "The character delimiting individual cells in the\ + \ CSV data. This may only be a 1-character string. For tab-delimited\ + \ data enter '\\t'." + default: "," + type: "string" + quote_char: + title: "Quote Character" + description: "The character used for quoting CSV values. To\ + \ disallow quoting, make this field blank." + default: "\"" + type: "string" + escape_char: + title: "Escape Character" + description: "The character used for escaping special characters.\ + \ To disallow escaping, leave this field blank." + type: "string" + encoding: + title: "Encoding" + description: "The character encoding of the CSV data. Leave\ + \ blank to default to UTF8. See list of python encodings for allowable\ + \ options." + default: "utf8" + type: "string" + double_quote: + title: "Double Quote" + description: "Whether two quotes in a quoted CSV value denote\ + \ a single quote in the data." + default: true + type: "boolean" + null_values: + title: "Null Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as null values. For example, if the value 'NA'\ + \ should be interpreted as null, enter 'NA' in this field." + default: [] + type: "array" + items: + type: "string" + uniqueItems: true + strings_can_be_null: + title: "Strings Can Be Null" + description: "Whether strings can be interpreted as null values.\ + \ If true, strings that match the null_values set will be\ + \ interpreted as null. If false, strings that match the null_values\ + \ set will be interpreted as the string itself." + default: true + type: "boolean" + skip_rows_before_header: + title: "Skip Rows Before Header" + description: "The number of rows to skip before the header row.\ + \ For example, if the header row is on the 3rd row, enter\ + \ 2 in this field." + default: 0 + type: "integer" + skip_rows_after_header: + title: "Skip Rows After Header" + description: "The number of rows to skip after the header row." + default: 0 + type: "integer" + header_definition: + title: "CSV Header Definition" + description: "How headers will be defined. `User Provided` assumes\ + \ the CSV does not have a header row and uses the headers\ + \ provided and `Autogenerated` assumes the CSV does not have\ + \ a header row and the CDK will generate headers using for\ + \ `f{i}` where `i` is the index starting from 0. Else, the\ + \ default behavior is to use the header from the CSV file.\ + \ If a user wants to autogenerate or provide column names\ + \ for a CSV having headers, they can skip rows." + default: + header_definition_type: "From CSV" + oneOf: + - title: "From CSV" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "From CSV" + const: "From CSV" + type: "string" + enum: + - "From CSV" + required: + - "header_definition_type" + - title: "Autogenerated" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "Autogenerated" + const: "Autogenerated" + type: "string" + enum: + - "Autogenerated" + required: + - "header_definition_type" + - title: "User Provided" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "User Provided" + const: "User Provided" + type: "string" + enum: + - "User Provided" + column_names: + title: "Column Names" + description: "The column names that will be used while\ + \ emitting the CSV records" + type: "array" + items: + type: "string" + required: + - "column_names" + - "header_definition_type" + type: "object" + true_values: + title: "True Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as true values." + default: + - "y" + - "yes" + - "t" + - "true" + - "on" + - "1" + type: "array" + items: + type: "string" + uniqueItems: true + false_values: + title: "False Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as false values." + default: + - "n" + - "no" + - "f" + - "false" + - "off" + - "0" + type: "array" + items: + type: "string" + uniqueItems: true + inference_type: + title: "Inference Type" + description: "How to infer the types of the columns. If none,\ + \ inference default to strings." + default: "None" + airbyte_hidden: true + enum: + - "None" + - "Primitive Types Only" + ignore_errors_on_fields_mismatch: + title: "Ignore errors on field mismatch" + description: "Whether to ignore errors that occur when the number\ + \ of fields in the CSV does not match the number of columns\ + \ in the schema." + default: false + type: "boolean" + required: + - "filetype" + - title: "Jsonl Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "jsonl" + const: "jsonl" + type: "string" + enum: + - "jsonl" + required: + - "filetype" + - title: "Parquet Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "parquet" + const: "parquet" + type: "string" + enum: + - "parquet" + decimal_as_float: + title: "Convert Decimal Fields to Floats" + description: "Whether to convert decimal fields to floats. There\ + \ is a loss of precision when converting decimals to floats,\ + \ so this is not recommended." + default: false + type: "boolean" + required: + - "filetype" + - title: "Document File Type Format (Experimental)" + type: "object" + properties: + filetype: + title: "Filetype" + default: "unstructured" + const: "unstructured" + type: "string" + enum: + - "unstructured" + skip_unprocessable_files: + title: "Skip Unprocessable Files" + description: "If true, skip files that cannot be parsed and\ + \ pass the error message along as the _ab_source_file_parse_error\ + \ field. If false, fail the sync." + default: true + always_show: true + type: "boolean" + strategy: + title: "Parsing Strategy" + description: "The strategy used to parse documents. `fast` extracts\ + \ text directly from the document which doesn't work for all\ + \ files. `ocr_only` is more reliable, but slower. `hi_res`\ + \ is the most reliable, but requires an API key and a hosted\ + \ instance of unstructured and can't be used with local mode.\ + \ See the unstructured.io documentation for more details:\ + \ https://unstructured-io.github.io/unstructured/core/partition.html#partition-pdf" + default: "auto" + always_show: true + order: 0 + enum: + - "auto" + - "fast" + - "ocr_only" + - "hi_res" + type: "string" + processing: + title: "Processing" + description: "Processing configuration" + default: + mode: "local" + type: "object" + oneOf: + - title: "Local" + type: "object" + properties: + mode: + title: "Mode" + default: "local" + const: "local" + enum: + - "local" + type: "string" + description: "Process files locally, supporting `fast` and\ + \ `ocr` modes. This is the default option." + required: + - "mode" + description: "Extract text from document formats (.pdf, .docx, .md,\ + \ .pptx) and emit as one record per file." + required: + - "filetype" + schemaless: + title: "Schemaless" + description: "When enabled, syncs will not validate or structure records\ + \ against the stream's schema." + default: false + type: "boolean" + required: + - "name" + - "format" + azure_blob_storage_account_name: + title: "Azure Blob Storage account name" + description: "The account's name of the Azure Blob Storage." + examples: + - "airbyte5storage" + order: 2 + type: "string" + azure_blob_storage_account_key: + title: "Azure Blob Storage account key" + description: "The Azure blob storage account key." + airbyte_secret: true + examples: + - "Z8ZkZpteggFx394vm+PJHnGTvdRncaYS+JhLKdj789YNmD+iyGTnG+PV+POiuYNhBg/ACS+LKjd%4FG3FHGN12Nd==" + order: 3 + type: "string" + azure_blob_storage_container_name: + title: "Azure blob storage container (Bucket) Name" + description: "The name of the Azure blob storage container." + examples: + - "airbytetescontainername" + order: 4 + type: "string" + azure_blob_storage_endpoint: + title: "Endpoint Domain Name" + description: "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." + examples: + - "blob.core.windows.net" + order: 11 + type: "string" + required: + - "streams" + - "azure_blob_storage_account_name" + - "azure_blob_storage_account_key" + - "azure_blob_storage_container_name" + source-close-com: + title: "Close.com Spec" + type: "object" + required: + - "api_key" + - "sourceType" + properties: + api_key: + title: "API Key" + type: "string" + description: "Close.com API key (usually starts with 'api_'; find yours\ + \ here)." + airbyte_secret: true + x-speakeasy-param-sensitive: true + start_date: + title: "Replication Start Date" + type: "string" + description: "The start date to sync data; all data after this date will\ + \ be replicated. Leave blank to retrieve all the data available in the\ + \ account. Format: YYYY-MM-DD." + examples: + - "2021-01-01" + default: "2021-01-01" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + format: "date" + sourceType: + title: "close-com" + const: "close-com" + enum: + - "close-com" + order: 0 + type: "string" + source-close-com-update: + title: "Close.com Spec" + type: "object" + required: + - "api_key" + properties: + api_key: + title: "API Key" + type: "string" + description: "Close.com API key (usually starts with 'api_'; find yours\ + \ here)." + airbyte_secret: true + start_date: + title: "Replication Start Date" + type: "string" + description: "The start date to sync data; all data after this date will\ + \ be replicated. Leave blank to retrieve all the data available in the\ + \ account. Format: YYYY-MM-DD." + examples: + - "2021-01-01" + default: "2021-01-01" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + format: "date" + source-zendesk-sunshine: + type: "object" + required: + - "start_date" + - "subdomain" + - "sourceType" + properties: + subdomain: + type: "string" + order: 0 + title: "Subdomain" + description: "The subdomain for your Zendesk Account." + start_date: + type: "string" + title: "Start date" + format: "date-time" + description: "The date from which you'd like to replicate data for Zendesk\ + \ Sunshine API, in the format YYYY-MM-DDT00:00:00Z." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2021-01-01T00:00:00Z" + order: 1 + credentials: + title: "Authorization Method" + type: "object" + oneOf: + - type: "object" + title: "OAuth2.0" + required: + - "auth_method" + - "client_id" + - "client_secret" + - "access_token" + properties: + auth_method: + type: "string" + const: "oauth2.0" + enum: + - "oauth2.0" + default: "oauth2.0" + order: 0 + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your OAuth application." + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of your OAuth application." + airbyte_secret: true + access_token: + type: "string" + title: "Access Token" + description: "Long-term access Token for making authenticated requests." + airbyte_secret: true + x-speakeasy-param-sensitive: true + - type: "object" + title: "API Token" + required: + - "auth_method" + - "api_token" + - "email" + properties: + auth_method: + type: "string" + const: "api_token" + enum: + - "api_token" + default: "api_token" + order: 1 + api_token: + type: "string" + title: "API Token" + description: "API Token. See the docs for information on how to generate this key." + airbyte_secret: true + x-speakeasy-param-sensitive: true + email: + type: "string" + title: "Email" + description: "The user email for your Zendesk account" + sourceType: + title: "zendesk-sunshine" + const: "zendesk-sunshine" + enum: + - "zendesk-sunshine" + order: 0 + type: "string" + source-zendesk-sunshine-update: + type: "object" + required: + - "start_date" + - "subdomain" + properties: + subdomain: + type: "string" + order: 0 + title: "Subdomain" + description: "The subdomain for your Zendesk Account." + start_date: + type: "string" + title: "Start date" + format: "date-time" + description: "The date from which you'd like to replicate data for Zendesk\ + \ Sunshine API, in the format YYYY-MM-DDT00:00:00Z." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2021-01-01T00:00:00Z" + order: 1 + credentials: + title: "Authorization Method" + type: "object" + oneOf: + - type: "object" + title: "OAuth2.0" + required: + - "auth_method" + - "client_id" + - "client_secret" + - "access_token" + properties: + auth_method: + type: "string" + const: "oauth2.0" + enum: + - "oauth2.0" + default: "oauth2.0" + order: 0 + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your OAuth application." + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of your OAuth application." + airbyte_secret: true + access_token: + type: "string" + title: "Access Token" + description: "Long-term access Token for making authenticated requests." + airbyte_secret: true + - type: "object" + title: "API Token" + required: + - "auth_method" + - "api_token" + - "email" + properties: + auth_method: + type: "string" + const: "api_token" + enum: + - "api_token" + default: "api_token" + order: 1 + api_token: + type: "string" + title: "API Token" + description: "API Token. See the docs for information on how to generate this key." + airbyte_secret: true + email: + type: "string" + title: "Email" + description: "The user email for your Zendesk account" + source-exchange-rates: + title: "exchangeratesapi.io Source Spec" + type: "object" + required: + - "start_date" + - "access_key" + - "sourceType" + properties: + start_date: + type: "string" + description: "Start getting data from that date." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + examples: + - "YYYY-MM-DD" + format: "date" + access_key: + type: "string" + description: "Your API Key. See here. The key is case sensitive." + airbyte_secret: true + x-speakeasy-param-sensitive: true + base: + type: "string" + description: "ISO reference currency. See here. Free plan doesn't support Source Currency Switching, default\ + \ base currency is EUR" + examples: + - "EUR" + - "USD" + ignore_weekends: + type: "boolean" + description: "Ignore weekends? (Exchanges don't run on weekends)" + default: true + sourceType: + title: "exchange-rates" + const: "exchange-rates" + enum: + - "exchange-rates" + order: 0 + type: "string" + source-exchange-rates-update: + title: "exchangeratesapi.io Source Spec" + type: "object" + required: + - "start_date" + - "access_key" + properties: + start_date: + type: "string" + description: "Start getting data from that date." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + examples: + - "YYYY-MM-DD" + format: "date" + access_key: + type: "string" + description: "Your API Key. See here. The key is case sensitive." + airbyte_secret: true + base: + type: "string" + description: "ISO reference currency. See here. Free plan doesn't support Source Currency Switching, default\ + \ base currency is EUR" + examples: + - "EUR" + - "USD" + ignore_weekends: + type: "boolean" + description: "Ignore weekends? (Exchanges don't run on weekends)" + default: true + source-woocommerce: + title: "Woocommerce Spec" + type: "object" + required: + - "api_key" + - "api_secret" + - "shop" + - "start_date" + - "sourceType" + properties: + api_key: + type: "string" + title: "Customer Key" + description: "Customer Key for API in WooCommerce shop" + airbyte_secret: true + order: 0 + x-speakeasy-param-sensitive: true + api_secret: + type: "string" + title: "Customer Secret" + description: "Customer Secret for API in WooCommerce shop" + airbyte_secret: true + order: 1 + shop: + type: "string" + title: "Shop Name" + description: "The name of the store. For https://EXAMPLE.com, the shop name\ + \ is 'EXAMPLE.com'." + order: 2 + start_date: + type: "string" + title: "Start Date" + description: "The date you would like to replicate data from. Format: YYYY-MM-DD" + examples: + - "2021-01-01" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + format: "date" + order: 3 + sourceType: + title: "woocommerce" + const: "woocommerce" + enum: + - "woocommerce" + order: 0 + type: "string" + source-woocommerce-update: + title: "Woocommerce Spec" + type: "object" + required: + - "api_key" + - "api_secret" + - "shop" + - "start_date" + properties: + api_key: + type: "string" + title: "Customer Key" + description: "Customer Key for API in WooCommerce shop" + airbyte_secret: true + order: 0 + api_secret: + type: "string" + title: "Customer Secret" + description: "Customer Secret for API in WooCommerce shop" + airbyte_secret: true + order: 1 + shop: + type: "string" + title: "Shop Name" + description: "The name of the store. For https://EXAMPLE.com, the shop name\ + \ is 'EXAMPLE.com'." + order: 2 + start_date: + type: "string" + title: "Start Date" + description: "The date you would like to replicate data from. Format: YYYY-MM-DD" + examples: + - "2021-01-01" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + format: "date" + order: 3 + source-linkedin-pages: + title: "Linkedin Pages Spec" + type: "object" + required: + - "org_id" + - "sourceType" + properties: + org_id: + title: "Organization ID" + type: "string" + airbyte_secret: true + description: "Specify the Organization ID" + examples: + - "123456789" + credentials: + title: "Authentication" + type: "object" + oneOf: + - type: "object" + title: "OAuth2.0" + required: + - "client_id" + - "client_secret" + - "refresh_token" + properties: + auth_method: + type: "string" + const: "oAuth2.0" + enum: + - "oAuth2.0" + client_id: + type: "string" + title: "Client ID" + description: "The client ID of the LinkedIn developer application." + airbyte_secret: true + client_secret: + type: "string" + title: "Client secret" + description: "The client secret of the LinkedIn developer application." + airbyte_secret: true + refresh_token: + type: "string" + title: "Refresh token" + description: "The token value generated using the LinkedIn Developers\ + \ OAuth Token Tools. See the docs to obtain yours." + airbyte_secret: true + x-speakeasy-param-sensitive: true + - title: "Access token" + type: "object" + required: + - "access_token" + properties: + auth_method: + type: "string" + const: "access_token" + enum: + - "access_token" + access_token: + type: "string" + title: "Access token" + description: "The token value generated using the LinkedIn Developers\ + \ OAuth Token Tools. See the docs to obtain yours." + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "linkedin-pages" + const: "linkedin-pages" + enum: + - "linkedin-pages" + order: 0 + type: "string" + source-linkedin-pages-update: + title: "Linkedin Pages Spec" + type: "object" + required: + - "org_id" + properties: + org_id: + title: "Organization ID" + type: "string" + airbyte_secret: true + description: "Specify the Organization ID" + examples: + - "123456789" + credentials: + title: "Authentication" + type: "object" + oneOf: + - type: "object" + title: "OAuth2.0" + required: + - "client_id" + - "client_secret" + - "refresh_token" + properties: + auth_method: + type: "string" + const: "oAuth2.0" + enum: + - "oAuth2.0" + client_id: + type: "string" + title: "Client ID" + description: "The client ID of the LinkedIn developer application." + airbyte_secret: true + client_secret: + type: "string" + title: "Client secret" + description: "The client secret of the LinkedIn developer application." + airbyte_secret: true + refresh_token: + type: "string" + title: "Refresh token" + description: "The token value generated using the LinkedIn Developers\ + \ OAuth Token Tools. See the docs to obtain yours." + airbyte_secret: true + - title: "Access token" + type: "object" + required: + - "access_token" + properties: + auth_method: + type: "string" + const: "access_token" + enum: + - "access_token" + access_token: + type: "string" + title: "Access token" + description: "The token value generated using the LinkedIn Developers\ + \ OAuth Token Tools. See the docs to obtain yours." + airbyte_secret: true + source-whisky-hunter: + title: "Whisky Hunter Spec" + type: "object" + properties: + sourceType: + title: "whisky-hunter" + const: "whisky-hunter" + enum: + - "whisky-hunter" + order: 0 + type: "string" + source-whisky-hunter-update: + title: "Whisky Hunter Spec" + type: "object" + properties: {} + source-tvmaze-schedule: + title: "TVMaze Schedule Spec" + type: "object" + required: + - "start_date" + - "domestic_schedule_country_code" + - "sourceType" + properties: + start_date: + type: "string" + description: "Start date for TV schedule retrieval. May be in the future." + order: 0 + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + end_date: + type: "string" + description: "End date for TV schedule retrieval. May be in the future.\ + \ Optional.\n" + order: 1 + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + domestic_schedule_country_code: + type: "string" + description: "Country code for domestic TV schedule retrieval." + examples: + - "US" + - "GB" + web_schedule_country_code: + type: "string" + description: "ISO 3166-1 country code for web TV schedule retrieval. Leave\ + \ blank for\nall countries plus global web channels (e.g. Netflix). Alternatively,\n\ + set to 'global' for just global web channels.\n" + examples: + - "US" + - "GB" + - "global" + sourceType: + title: "tvmaze-schedule" + const: "tvmaze-schedule" + enum: + - "tvmaze-schedule" + order: 0 + type: "string" + source-tvmaze-schedule-update: + title: "TVMaze Schedule Spec" + type: "object" + required: + - "start_date" + - "domestic_schedule_country_code" + properties: + start_date: + type: "string" + description: "Start date for TV schedule retrieval. May be in the future." + order: 0 + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + end_date: + type: "string" + description: "End date for TV schedule retrieval. May be in the future.\ + \ Optional.\n" + order: 1 + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + domestic_schedule_country_code: + type: "string" + description: "Country code for domestic TV schedule retrieval." + examples: + - "US" + - "GB" + web_schedule_country_code: + type: "string" + description: "ISO 3166-1 country code for web TV schedule retrieval. Leave\ + \ blank for\nall countries plus global web channels (e.g. Netflix). Alternatively,\n\ + set to 'global' for just global web channels.\n" + examples: + - "US" + - "GB" + - "global" + source-salesloft: + title: "Source Salesloft Spec" + type: "object" + required: + - "credentials" + - "start_date" + - "sourceType" + properties: + credentials: + order: 0 + type: "object" + title: "Credentials" + oneOf: + - title: "Authenticate via OAuth" + type: "object" + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "access_token" + - "token_expiry_date" + - "auth_type" + properties: + auth_type: + type: "string" + const: "oauth2.0" + enum: + - "oauth2.0" + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your Salesloft developer application." + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of your Salesloft developer application." + airbyte_secret: true + access_token: + type: "string" + description: "Access Token for making authenticated requests." + airbyte_secret: true + x-speakeasy-param-sensitive: true + token_expiry_date: + type: "string" + description: "The date-time when the access token should be refreshed." + format: "date-time" + x-speakeasy-param-sensitive: true + refresh_token: + type: "string" + title: "Refresh Token" + description: "The token for obtaining a new access token." + airbyte_secret: true + x-speakeasy-param-sensitive: true + - title: "Authenticate via API Key" + type: "object" + required: + - "api_key" + - "auth_type" + properties: + auth_type: + type: "string" + const: "api_key" + enum: + - "api_key" + api_key: + type: "string" + airbyte_secret: true + title: "API Key" + description: "API Key for making authenticated requests. More instruction\ + \ on how to find this value in our docs" + x-speakeasy-param-sensitive: true + start_date: + order: 1 + type: "string" + title: "Start Date" + description: "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." + examples: + - "2020-11-16T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + format: "date-time" + sourceType: + title: "salesloft" + const: "salesloft" + enum: + - "salesloft" + order: 0 + type: "string" + source-salesloft-update: + title: "Source Salesloft Spec" + type: "object" + required: + - "credentials" + - "start_date" + properties: + credentials: + order: 0 + type: "object" + title: "Credentials" + oneOf: + - title: "Authenticate via OAuth" + type: "object" + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "access_token" + - "token_expiry_date" + - "auth_type" + properties: + auth_type: + type: "string" + const: "oauth2.0" + enum: + - "oauth2.0" + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your Salesloft developer application." + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of your Salesloft developer application." + airbyte_secret: true + access_token: + type: "string" + description: "Access Token for making authenticated requests." + airbyte_secret: true + token_expiry_date: + type: "string" + description: "The date-time when the access token should be refreshed." + format: "date-time" + refresh_token: + type: "string" + title: "Refresh Token" + description: "The token for obtaining a new access token." + airbyte_secret: true + - title: "Authenticate via API Key" + type: "object" + required: + - "api_key" + - "auth_type" + properties: + auth_type: + type: "string" + const: "api_key" + enum: + - "api_key" + api_key: + type: "string" + airbyte_secret: true + title: "API Key" + description: "API Key for making authenticated requests. More instruction\ + \ on how to find this value in our docs" + start_date: + order: 1 + type: "string" + title: "Start Date" + description: "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." + examples: + - "2020-11-16T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + format: "date-time" + source-shortio: + title: "Shortio Spec" + type: "object" + required: + - "domain_id" + - "secret_key" + - "start_date" + - "sourceType" + properties: + domain_id: + type: "string" + desciprtion: "Short.io Domain ID" + title: "Domain ID" + airbyte_secret: false + secret_key: + type: "string" + title: "Secret Key" + description: "Short.io Secret Key" + airbyte_secret: true + x-speakeasy-param-sensitive: true + start_date: + type: "string" + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + examples: + - "2023-07-30T03:43:59.244Z" + airbyte_secret: false + sourceType: + title: "shortio" + const: "shortio" + enum: + - "shortio" + order: 0 + type: "string" + source-shortio-update: + title: "Shortio Spec" + type: "object" + required: + - "domain_id" + - "secret_key" + - "start_date" + properties: + domain_id: + type: "string" + desciprtion: "Short.io Domain ID" + title: "Domain ID" + airbyte_secret: false + secret_key: + type: "string" + title: "Secret Key" + description: "Short.io Secret Key" + airbyte_secret: true + start_date: + type: "string" + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + examples: + - "2023-07-30T03:43:59.244Z" + airbyte_secret: false + source-instatus: + title: "Instatus Spec" + type: "object" + required: + - "api_key" + - "sourceType" + properties: + api_key: + type: "string" + title: "Rest API Key" + airbyte_secret: true + description: "Instatus REST API key" + x-speakeasy-param-sensitive: true + sourceType: + title: "instatus" + const: "instatus" + enum: + - "instatus" + order: 0 + type: "string" + source-instatus-update: + title: "Instatus Spec" + type: "object" + required: + - "api_key" + properties: + api_key: + type: "string" + title: "Rest API Key" + airbyte_secret: true + description: "Instatus REST API key" + source-yandex-metrica: + title: "Yandex Metrica Spec" + type: "object" + required: + - "auth_token" + - "counter_id" + - "start_date" + - "sourceType" + properties: + auth_token: + type: "string" + title: "Authentication Token" + description: "Your Yandex Metrica API access token" + airbyte_secret: true + order: 0 + x-speakeasy-param-sensitive: true + counter_id: + type: "string" + title: "Counter ID" + description: "Counter ID" + pattern: "^[0-9]+$" + order: 1 + start_date: + title: "Start Date" + type: "string" + description: "Starting point for your data replication, in format of \"\ + YYYY-MM-DD\"." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + format: "date" + examples: + - "2022-01-01" + order: 2 + end_date: + title: "End Date" + type: "string" + description: "Starting point for your data replication, in format of \"\ + YYYY-MM-DD\". If not provided will sync till most recent date." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + format: "date" + examples: + - "2022-01-01" + order: 3 + sourceType: + title: "yandex-metrica" + const: "yandex-metrica" + enum: + - "yandex-metrica" + order: 0 + type: "string" + source-yandex-metrica-update: + title: "Yandex Metrica Spec" + type: "object" + required: + - "auth_token" + - "counter_id" + - "start_date" + properties: + auth_token: + type: "string" + title: "Authentication Token" + description: "Your Yandex Metrica API access token" + airbyte_secret: true + order: 0 + counter_id: + type: "string" + title: "Counter ID" + description: "Counter ID" + pattern: "^[0-9]+$" + order: 1 + start_date: + title: "Start Date" + type: "string" + description: "Starting point for your data replication, in format of \"\ + YYYY-MM-DD\"." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + format: "date" + examples: + - "2022-01-01" + order: 2 + end_date: + title: "End Date" + type: "string" + description: "Starting point for your data replication, in format of \"\ + YYYY-MM-DD\". If not provided will sync till most recent date." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + format: "date" + examples: + - "2022-01-01" + order: 3 + source-aircall: + title: "Aircall Spec" + type: "object" + required: + - "api_id" + - "api_token" + - "start_date" + - "sourceType" + properties: + api_id: + title: "API ID" + type: "string" + description: "App ID found at settings https://dashboard.aircall.io/integrations/api-keys" + airbyte_secret: true + api_token: + title: "API Token" + type: "string" + description: "App token found at settings (Ref- https://dashboard.aircall.io/integrations/api-keys)" + airbyte_secret: true + x-speakeasy-param-sensitive: true + start_date: + title: "Date-From Filter" + type: "string" + description: "Date time filter for incremental filter, Specify which date\ + \ to extract from." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$" + examples: + - "2022-03-01T00:00:00.000Z" + format: "date-time" + sourceType: + title: "aircall" + const: "aircall" + enum: + - "aircall" + order: 0 + type: "string" + source-aircall-update: + title: "Aircall Spec" + type: "object" + required: + - "api_id" + - "api_token" + - "start_date" + properties: + api_id: + title: "API ID" + type: "string" + description: "App ID found at settings https://dashboard.aircall.io/integrations/api-keys" + airbyte_secret: true + api_token: + title: "API Token" + type: "string" + description: "App token found at settings (Ref- https://dashboard.aircall.io/integrations/api-keys)" + airbyte_secret: true + start_date: + title: "Date-From Filter" + type: "string" + description: "Date time filter for incremental filter, Specify which date\ + \ to extract from." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$" + examples: + - "2022-03-01T00:00:00.000Z" + format: "date-time" + source-clickup-api: + title: "ClickUp Api Spec" + type: "object" + required: + - "api_token" + - "sourceType" + properties: + api_token: + type: "string" + description: "Every ClickUp API call required authentication. This field\ + \ is your personal API token. See here." + airbyte_secret: true + x-speakeasy-param-sensitive: true + team_id: + type: "string" + description: "The ID of your team in ClickUp. Retrieve it from the `/team`\ + \ of the ClickUp API. See here." + space_id: + type: "string" + description: "The ID of your space in your workspace. Retrieve it from the\ + \ `/team/{team_id}/space` of the ClickUp API. See here." + folder_id: + type: "string" + description: "The ID of your folder in your space. Retrieve it from the\ + \ `/space/{space_id}/folder` of the ClickUp API. See here." + list_id: + type: "string" + description: "The ID of your list in your folder. Retrieve it from the `/folder/{folder_id}/list`\ + \ of the ClickUp API. See here." + include_closed_tasks: + title: "Include Closed Tasks" + type: "boolean" + default: false + description: "Include or exclude closed tasks. By default, they are excluded.\ + \ See here." + sourceType: + title: "clickup-api" + const: "clickup-api" + enum: + - "clickup-api" + order: 0 + type: "string" + source-clickup-api-update: + title: "ClickUp Api Spec" + type: "object" + required: + - "api_token" + properties: + api_token: + type: "string" + description: "Every ClickUp API call required authentication. This field\ + \ is your personal API token. See here." + airbyte_secret: true + team_id: + type: "string" + description: "The ID of your team in ClickUp. Retrieve it from the `/team`\ + \ of the ClickUp API. See here." + space_id: + type: "string" + description: "The ID of your space in your workspace. Retrieve it from the\ + \ `/team/{team_id}/space` of the ClickUp API. See here." + folder_id: + type: "string" + description: "The ID of your folder in your space. Retrieve it from the\ + \ `/space/{space_id}/folder` of the ClickUp API. See here." + list_id: + type: "string" + description: "The ID of your list in your folder. Retrieve it from the `/folder/{folder_id}/list`\ + \ of the ClickUp API. See here." + include_closed_tasks: + title: "Include Closed Tasks" + type: "boolean" + default: false + description: "Include or exclude closed tasks. By default, they are excluded.\ + \ See here." + source-snapchat-marketing: + title: "Snapchat Marketing Spec" + type: "object" + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "sourceType" + properties: + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Snapchat developer application." + airbyte_secret: true + order: 0 + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Snapchat developer application." + airbyte_secret: true + order: 1 + refresh_token: + title: "Refresh Token" + type: "string" + description: "Refresh Token to renew the expired Access Token." + airbyte_secret: true + order: 2 + x-speakeasy-param-sensitive: true + start_date: + title: "Start Date" + type: "string" + description: "Date in the format 2022-01-01. Any data before this date will\ + \ not be replicated." + examples: + - "2022-01-01" + default: "2022-01-01" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + order: 3 + format: "date" + end_date: + type: "string" + title: "End Date" + description: "Date in the format 2017-01-25. Any data after this date will\ + \ not be replicated." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + examples: + - "2022-01-30" + order: 4 + format: "date" + action_report_time: + type: "string" + enum: + - "conversion" + - "impression" + title: "Action Report Time" + description: "Specifies the principle for conversion reporting." + default: "conversion" + order: 5 + swipe_up_attribution_window: + type: "string" + title: "Swipe Up Attribution Window" + description: "Attribution window for swipe ups." + enum: + - "1_DAY" + - "7_DAY" + - "28_DAY" + default: "28_DAY" + order: 6 + view_attribution_window: + type: "string" + title: "View Attribution Window" + description: "Attribution window for views." + enum: + - "1_HOUR" + - "3_HOUR" + - "6_HOUR" + - "1_DAY" + - "7_DAY" + default: "1_DAY" + order: 7 + sourceType: + title: "snapchat-marketing" + const: "snapchat-marketing" + enum: + - "snapchat-marketing" + order: 0 + type: "string" + source-snapchat-marketing-update: + title: "Snapchat Marketing Spec" + type: "object" + required: + - "client_id" + - "client_secret" + - "refresh_token" + properties: + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Snapchat developer application." + airbyte_secret: true + order: 0 + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Snapchat developer application." + airbyte_secret: true + order: 1 + refresh_token: + title: "Refresh Token" + type: "string" + description: "Refresh Token to renew the expired Access Token." + airbyte_secret: true + order: 2 + start_date: + title: "Start Date" + type: "string" + description: "Date in the format 2022-01-01. Any data before this date will\ + \ not be replicated." + examples: + - "2022-01-01" + default: "2022-01-01" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + order: 3 + format: "date" + end_date: + type: "string" + title: "End Date" + description: "Date in the format 2017-01-25. Any data after this date will\ + \ not be replicated." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + examples: + - "2022-01-30" + order: 4 + format: "date" + action_report_time: + type: "string" + enum: + - "conversion" + - "impression" + title: "Action Report Time" + description: "Specifies the principle for conversion reporting." + default: "conversion" + order: 5 + swipe_up_attribution_window: + type: "string" + title: "Swipe Up Attribution Window" + description: "Attribution window for swipe ups." + enum: + - "1_DAY" + - "7_DAY" + - "28_DAY" + default: "28_DAY" + order: 6 + view_attribution_window: + type: "string" + title: "View Attribution Window" + description: "Attribution window for views." + enum: + - "1_HOUR" + - "3_HOUR" + - "6_HOUR" + - "1_DAY" + - "7_DAY" + default: "1_DAY" + order: 7 + source-gitlab: + title: "Source Gitlab Spec" + type: "object" + required: + - "credentials" + - "sourceType" + properties: + credentials: + title: "Authorization Method" + type: "object" + order: 0 + oneOf: + - type: "object" + title: "OAuth2.0" + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "access_token" + - "token_expiry_date" + properties: + auth_type: + type: "string" + const: "oauth2.0" + enum: + - "oauth2.0" + client_id: + type: "string" + description: "The API ID of the Gitlab developer application." + airbyte_secret: true + client_secret: + type: "string" + description: "The API Secret the Gitlab developer application." + airbyte_secret: true + access_token: + type: "string" + description: "Access Token for making authenticated requests." + airbyte_secret: true + x-speakeasy-param-sensitive: true + token_expiry_date: + type: "string" + description: "The date-time when the access token should be refreshed." + format: "date-time" + x-speakeasy-param-sensitive: true + refresh_token: + type: "string" + description: "The key to refresh the expired access_token." + airbyte_secret: true + x-speakeasy-param-sensitive: true + - title: "Private Token" + type: "object" + required: + - "access_token" + properties: + auth_type: + type: "string" + const: "access_token" + enum: + - "access_token" + access_token: + type: "string" + title: "Private Token" + description: "Log into your Gitlab account and then generate a personal\ + \ Access Token." + airbyte_secret: true + x-speakeasy-param-sensitive: true + start_date: + type: "string" + title: "Start Date" + description: "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." + examples: + - "2021-03-01T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + order: 1 + format: "date-time" + api_url: + type: "string" + examples: + - "gitlab.com" + - "https://gitlab.com" + - "https://gitlab.company.org" + title: "API URL" + default: "gitlab.com" + description: "Please enter your basic URL from GitLab instance." + order: 2 + groups: + type: "string" + examples: + - "airbyte.io" + title: "Groups" + description: "[DEPRECATED] Space-delimited list of groups. e.g. airbyte.io." + airbyte_hidden: true + groups_list: + type: "array" + items: + type: "string" + examples: + - "airbyte.io" + title: "Groups" + description: "List of groups. e.g. airbyte.io." + order: 3 + projects: + type: "string" + title: "Projects" + examples: + - "airbyte.io/documentation" + description: "[DEPRECATED] Space-delimited list of projects. e.g. airbyte.io/documentation\ + \ meltano/tap-gitlab." + airbyte_hidden: true + projects_list: + type: "array" + items: + type: "string" + title: "Projects" + examples: + - "airbyte.io/documentation" + description: "Space-delimited list of projects. e.g. airbyte.io/documentation\ + \ meltano/tap-gitlab." + order: 4 + sourceType: + title: "gitlab" + const: "gitlab" + enum: + - "gitlab" + order: 0 + type: "string" + source-gitlab-update: + title: "Source Gitlab Spec" + type: "object" + required: + - "credentials" + properties: + credentials: + title: "Authorization Method" + type: "object" + order: 0 + oneOf: + - type: "object" + title: "OAuth2.0" + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "access_token" + - "token_expiry_date" + properties: + auth_type: + type: "string" + const: "oauth2.0" + enum: + - "oauth2.0" + client_id: + type: "string" + description: "The API ID of the Gitlab developer application." + airbyte_secret: true + client_secret: + type: "string" + description: "The API Secret the Gitlab developer application." + airbyte_secret: true + access_token: + type: "string" + description: "Access Token for making authenticated requests." + airbyte_secret: true + token_expiry_date: + type: "string" + description: "The date-time when the access token should be refreshed." + format: "date-time" + refresh_token: + type: "string" + description: "The key to refresh the expired access_token." + airbyte_secret: true + - title: "Private Token" + type: "object" + required: + - "access_token" + properties: + auth_type: + type: "string" + const: "access_token" + enum: + - "access_token" + access_token: + type: "string" + title: "Private Token" + description: "Log into your Gitlab account and then generate a personal\ + \ Access Token." + airbyte_secret: true + start_date: + type: "string" + title: "Start Date" + description: "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." + examples: + - "2021-03-01T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + order: 1 + format: "date-time" + api_url: + type: "string" + examples: + - "gitlab.com" + - "https://gitlab.com" + - "https://gitlab.company.org" + title: "API URL" + default: "gitlab.com" + description: "Please enter your basic URL from GitLab instance." + order: 2 + groups: + type: "string" + examples: + - "airbyte.io" + title: "Groups" + description: "[DEPRECATED] Space-delimited list of groups. e.g. airbyte.io." + airbyte_hidden: true + groups_list: + type: "array" + items: + type: "string" + examples: + - "airbyte.io" + title: "Groups" + description: "List of groups. e.g. airbyte.io." + order: 3 + projects: + type: "string" + title: "Projects" + examples: + - "airbyte.io/documentation" + description: "[DEPRECATED] Space-delimited list of projects. e.g. airbyte.io/documentation\ + \ meltano/tap-gitlab." + airbyte_hidden: true + projects_list: + type: "array" + items: + type: "string" + title: "Projects" + examples: + - "airbyte.io/documentation" + description: "Space-delimited list of projects. e.g. airbyte.io/documentation\ + \ meltano/tap-gitlab." + order: 4 + source-launchdarkly: + title: "Launchdarkly Spec" + type: "object" + required: + - "access_token" + - "sourceType" + properties: + access_token: + title: "Access token" + type: "string" + description: "Your Access token. See here." + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "launchdarkly" + const: "launchdarkly" + enum: + - "launchdarkly" + order: 0 + type: "string" + source-launchdarkly-update: + title: "Launchdarkly Spec" + type: "object" + required: + - "access_token" + properties: + access_token: + title: "Access token" + type: "string" + description: "Your Access token. See here." + airbyte_secret: true + source-snowflake: + title: "Snowflake Source Spec" + type: "object" + required: + - "host" + - "role" + - "warehouse" + - "database" + - "sourceType" + properties: + credentials: + title: "Authorization Method" + type: "object" + oneOf: + - type: "object" + title: "OAuth2.0" + order: 0 + required: + - "client_id" + - "client_secret" + - "auth_type" + properties: + auth_type: + type: "string" + const: "OAuth" + order: 0 + enum: + - "OAuth" + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your Snowflake developer application." + airbyte_secret: true + order: 1 + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of your Snowflake developer application." + airbyte_secret: true + order: 2 + access_token: + type: "string" + title: "Access Token" + description: "Access Token for making authenticated requests." + airbyte_secret: true + order: 3 + x-speakeasy-param-sensitive: true + refresh_token: + type: "string" + title: "Refresh Token" + description: "Refresh Token for making authenticated requests." + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + - title: "Username and Password" + type: "object" + required: + - "username" + - "password" + - "auth_type" + order: 1 + properties: + auth_type: + type: "string" + const: "username/password" + order: 0 + enum: + - "username/password" + username: + description: "The username you created to allow Airbyte to access\ + \ the database." + examples: + - "AIRBYTE_USER" + type: "string" + title: "Username" + order: 1 + password: + description: "The password associated with the username." + type: "string" + airbyte_secret: true + title: "Password" + order: 2 + x-speakeasy-param-sensitive: true + order: 0 + host: + description: "The host domain of the snowflake instance (must include the\ + \ account, region, cloud environment, and end with snowflakecomputing.com)." + examples: + - "accountname.us-east-2.aws.snowflakecomputing.com" + type: "string" + title: "Account Name" + order: 1 + role: + description: "The role you created for Airbyte to access Snowflake." + examples: + - "AIRBYTE_ROLE" + type: "string" + title: "Role" + order: 2 + warehouse: + description: "The warehouse you created for Airbyte to access data." + examples: + - "AIRBYTE_WAREHOUSE" + type: "string" + title: "Warehouse" + order: 3 + database: + description: "The database you created for Airbyte to access data." + examples: + - "AIRBYTE_DATABASE" + type: "string" + title: "Database" + order: 4 + schema: + description: "The source Snowflake schema tables. Leave empty to access\ + \ tables from multiple schemas." + examples: + - "AIRBYTE_SCHEMA" + type: "string" + title: "Schema" + order: 5 + jdbc_url_params: + description: "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)." + title: "JDBC URL Params" + type: "string" + order: 6 + sourceType: + title: "snowflake" + const: "snowflake" + enum: + - "snowflake" + order: 0 + type: "string" + source-snowflake-update: + title: "Snowflake Source Spec" + type: "object" + required: + - "host" + - "role" + - "warehouse" + - "database" + properties: + credentials: + title: "Authorization Method" + type: "object" + oneOf: + - type: "object" + title: "OAuth2.0" + order: 0 + required: + - "client_id" + - "client_secret" + - "auth_type" + properties: + auth_type: + type: "string" + const: "OAuth" + order: 0 + enum: + - "OAuth" + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your Snowflake developer application." + airbyte_secret: true + order: 1 + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of your Snowflake developer application." + airbyte_secret: true + order: 2 + access_token: + type: "string" + title: "Access Token" + description: "Access Token for making authenticated requests." + airbyte_secret: true + order: 3 + refresh_token: + type: "string" + title: "Refresh Token" + description: "Refresh Token for making authenticated requests." + airbyte_secret: true + order: 4 + - title: "Username and Password" + type: "object" + required: + - "username" + - "password" + - "auth_type" + order: 1 + properties: + auth_type: + type: "string" + const: "username/password" + order: 0 + enum: + - "username/password" + username: + description: "The username you created to allow Airbyte to access\ + \ the database." + examples: + - "AIRBYTE_USER" + type: "string" + title: "Username" + order: 1 + password: + description: "The password associated with the username." + type: "string" + airbyte_secret: true + title: "Password" + order: 2 + order: 0 + host: + description: "The host domain of the snowflake instance (must include the\ + \ account, region, cloud environment, and end with snowflakecomputing.com)." + examples: + - "accountname.us-east-2.aws.snowflakecomputing.com" + type: "string" + title: "Account Name" + order: 1 + role: + description: "The role you created for Airbyte to access Snowflake." + examples: + - "AIRBYTE_ROLE" + type: "string" + title: "Role" + order: 2 + warehouse: + description: "The warehouse you created for Airbyte to access data." + examples: + - "AIRBYTE_WAREHOUSE" + type: "string" + title: "Warehouse" + order: 3 + database: + description: "The database you created for Airbyte to access data." + examples: + - "AIRBYTE_DATABASE" + type: "string" + title: "Database" + order: 4 + schema: + description: "The source Snowflake schema tables. Leave empty to access\ + \ tables from multiple schemas." + examples: + - "AIRBYTE_SCHEMA" + type: "string" + title: "Schema" + order: 5 + jdbc_url_params: + description: "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)." + title: "JDBC URL Params" + type: "string" + order: 6 + source-auth0: + title: "Auth0 Management API Spec" + type: "object" + required: + - "base_url" + - "credentials" + - "sourceType" + properties: + base_url: + type: "string" + title: "Base URL" + examples: + - "https://dev-yourOrg.us.auth0.com/" + description: "The Authentication API is served over HTTPS. All URLs referenced\ + \ in the documentation have the following base `https://YOUR_DOMAIN`" + credentials: + title: "Authentication Method" + type: "object" + oneOf: + - type: "object" + title: "OAuth2 Confidential Application" + required: + - "auth_type" + - "client_id" + - "client_secret" + - "audience" + properties: + auth_type: + type: "string" + title: "Authentication Method" + const: "oauth2_confidential_application" + order: 0 + enum: + - "oauth2_confidential_application" + client_id: + title: "Client ID" + description: "Your application's Client ID. You can find this value\ + \ on the application's\ + \ settings tab after you login the admin portal." + type: "string" + examples: + - "Client_ID" + client_secret: + title: "Client Secret" + description: "Your application's Client Secret. You can find this\ + \ value on the application's settings tab after you login the admin portal." + type: "string" + examples: + - "Client_Secret" + airbyte_secret: true + audience: + title: "Audience" + description: "The audience for the token, which is your API. You can\ + \ find this in the Identifier field on your API's settings tab" + type: "string" + examples: + - "https://dev-yourOrg.us.auth0.com/api/v2/" + - type: "object" + title: "OAuth2 Access Token" + required: + - "access_token" + - "auth_type" + properties: + auth_type: + type: "string" + title: "Authentication Method" + const: "oauth2_access_token" + examples: + - "oauth2_access_token" + order: 0 + enum: + - "oauth2_access_token" + access_token: + title: "OAuth2 Access Token" + description: "Also called API Access Token The access token used to call the Auth0 Management\ + \ API Token. It's a JWT that contains specific grant permissions\ + \ knowns as scopes." + type: "string" + airbyte_secret: true + x-speakeasy-param-sensitive: true + start_date: + type: "string" + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + examples: + - "2023-08-05T00:43:59.244Z" + default: "2023-08-05T00:43:59.244Z" + airbyte_secret: false + sourceType: + title: "auth0" + const: "auth0" + enum: + - "auth0" + order: 0 + type: "string" + source-auth0-update: + title: "Auth0 Management API Spec" + type: "object" + required: + - "base_url" + - "credentials" + properties: + base_url: + type: "string" + title: "Base URL" + examples: + - "https://dev-yourOrg.us.auth0.com/" + description: "The Authentication API is served over HTTPS. All URLs referenced\ + \ in the documentation have the following base `https://YOUR_DOMAIN`" + credentials: + title: "Authentication Method" + type: "object" + oneOf: + - type: "object" + title: "OAuth2 Confidential Application" + required: + - "auth_type" + - "client_id" + - "client_secret" + - "audience" + properties: + auth_type: + type: "string" + title: "Authentication Method" + const: "oauth2_confidential_application" + order: 0 + enum: + - "oauth2_confidential_application" + client_id: + title: "Client ID" + description: "Your application's Client ID. You can find this value\ + \ on the application's\ + \ settings tab after you login the admin portal." + type: "string" + examples: + - "Client_ID" + client_secret: + title: "Client Secret" + description: "Your application's Client Secret. You can find this\ + \ value on the application's settings tab after you login the admin portal." + type: "string" + examples: + - "Client_Secret" + airbyte_secret: true + audience: + title: "Audience" + description: "The audience for the token, which is your API. You can\ + \ find this in the Identifier field on your API's settings tab" + type: "string" + examples: + - "https://dev-yourOrg.us.auth0.com/api/v2/" + - type: "object" + title: "OAuth2 Access Token" + required: + - "access_token" + - "auth_type" + properties: + auth_type: + type: "string" + title: "Authentication Method" + const: "oauth2_access_token" + examples: + - "oauth2_access_token" + order: 0 + enum: + - "oauth2_access_token" + access_token: + title: "OAuth2 Access Token" + description: "Also called API Access Token The access token used to call the Auth0 Management\ + \ API Token. It's a JWT that contains specific grant permissions\ + \ knowns as scopes." + type: "string" + airbyte_secret: true + start_date: + type: "string" + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + examples: + - "2023-08-05T00:43:59.244Z" + default: "2023-08-05T00:43:59.244Z" + airbyte_secret: false + source-linnworks: + title: "Linnworks Spec" + type: "object" + required: + - "application_id" + - "application_secret" + - "token" + - "start_date" + - "sourceType" + properties: + application_id: + title: "Application ID." + description: "Linnworks Application ID" + type: "string" + application_secret: + title: "Application Secret" + description: "Linnworks Application Secret" + type: "string" + airbyte_secret: true + token: + title: "API Token" + type: "string" + airbyte_secret: true + x-speakeasy-param-sensitive: true + start_date: + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + type: "string" + format: "date-time" + sourceType: + title: "linnworks" + const: "linnworks" + enum: + - "linnworks" + order: 0 + type: "string" + source-linnworks-update: + title: "Linnworks Spec" + type: "object" + required: + - "application_id" + - "application_secret" + - "token" + - "start_date" + properties: + application_id: + title: "Application ID." + description: "Linnworks Application ID" + type: "string" + application_secret: + title: "Application Secret" + description: "Linnworks Application Secret" + type: "string" + airbyte_secret: true + token: + title: "API Token" + type: "string" + airbyte_secret: true + start_date: + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + type: "string" + format: "date-time" + source-microsoft-sharepoint: + title: "Microsoft SharePoint Source Spec" + description: "SourceMicrosoftSharePointSpec class for Microsoft SharePoint Source\ + \ Specification.\nThis class combines the authentication details with additional\ + \ configuration for the SharePoint API." + type: "object" + properties: + start_date: + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00.000000Z.\ + \ Any file modified before this date will not be replicated." + examples: + - "2021-01-01T00:00:00.000000Z" + format: "date-time" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$" + pattern_descriptor: "YYYY-MM-DDTHH:mm:ss.SSSSSSZ" + order: 1 + type: "string" + streams: + title: "The list of streams to sync" + description: "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." + order: 10 + type: "array" + items: + title: "FileBasedStreamConfig" + type: "object" + properties: + name: + title: "Name" + description: "The name of the stream." + type: "string" + globs: + title: "Globs" + description: "The pattern used to specify which files should be selected\ + \ from the file system. For more information on glob pattern matching\ + \ look here." + default: + - "**" + order: 1 + type: "array" + items: + type: "string" + validation_policy: + title: "Validation Policy" + description: "The name of the validation policy that dictates sync\ + \ behavior when a record does not adhere to the stream schema." + default: "Emit Record" + enum: + - "Emit Record" + - "Skip Record" + - "Wait for Discover" + input_schema: + title: "Input Schema" + description: "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." + type: "string" + primary_key: + title: "Primary Key" + description: "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." + airbyte_hidden: true + type: "string" + x-speakeasy-param-sensitive: true + days_to_sync_if_history_is_full: + title: "Days To Sync If History Is Full" + description: "When the state history of the file store is full, syncs\ + \ will only read files that were last modified in the provided day\ + \ range." + default: 3 + type: "integer" + format: + title: "Format" + description: "The configuration options that are used to alter how\ + \ to read incoming files that deviate from the standard formatting." + type: "object" + oneOf: + - title: "Avro Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "avro" + const: "avro" + type: "string" + enum: + - "avro" + double_as_string: + title: "Convert Double Fields to Strings" + description: "Whether to convert double fields to strings. This\ + \ is recommended if you have decimal numbers with a high degree\ + \ of precision because there can be a loss precision when\ + \ handling floating point numbers." + default: false + type: "boolean" + required: + - "filetype" + - title: "CSV Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "csv" + const: "csv" + type: "string" + enum: + - "csv" + delimiter: + title: "Delimiter" + description: "The character delimiting individual cells in the\ + \ CSV data. This may only be a 1-character string. For tab-delimited\ + \ data enter '\\t'." + default: "," + type: "string" + quote_char: + title: "Quote Character" + description: "The character used for quoting CSV values. To\ + \ disallow quoting, make this field blank." + default: "\"" + type: "string" + escape_char: + title: "Escape Character" + description: "The character used for escaping special characters.\ + \ To disallow escaping, leave this field blank." + type: "string" + encoding: + title: "Encoding" + description: "The character encoding of the CSV data. Leave\ + \ blank to default to UTF8. See list of python encodings for allowable\ + \ options." + default: "utf8" + type: "string" + double_quote: + title: "Double Quote" + description: "Whether two quotes in a quoted CSV value denote\ + \ a single quote in the data." + default: true + type: "boolean" + null_values: + title: "Null Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as null values. For example, if the value 'NA'\ + \ should be interpreted as null, enter 'NA' in this field." + default: [] + type: "array" + items: + type: "string" + uniqueItems: true + strings_can_be_null: + title: "Strings Can Be Null" + description: "Whether strings can be interpreted as null values.\ + \ If true, strings that match the null_values set will be\ + \ interpreted as null. If false, strings that match the null_values\ + \ set will be interpreted as the string itself." + default: true + type: "boolean" + skip_rows_before_header: + title: "Skip Rows Before Header" + description: "The number of rows to skip before the header row.\ + \ For example, if the header row is on the 3rd row, enter\ + \ 2 in this field." + default: 0 + type: "integer" + skip_rows_after_header: + title: "Skip Rows After Header" + description: "The number of rows to skip after the header row." + default: 0 + type: "integer" + header_definition: + title: "CSV Header Definition" + description: "How headers will be defined. `User Provided` assumes\ + \ the CSV does not have a header row and uses the headers\ + \ provided and `Autogenerated` assumes the CSV does not have\ + \ a header row and the CDK will generate headers using for\ + \ `f{i}` where `i` is the index starting from 0. Else, the\ + \ default behavior is to use the header from the CSV file.\ + \ If a user wants to autogenerate or provide column names\ + \ for a CSV having headers, they can skip rows." + default: + header_definition_type: "From CSV" + oneOf: + - title: "From CSV" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "From CSV" + const: "From CSV" + type: "string" + enum: + - "From CSV" + required: + - "header_definition_type" + - title: "Autogenerated" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "Autogenerated" + const: "Autogenerated" + type: "string" + enum: + - "Autogenerated" + required: + - "header_definition_type" + - title: "User Provided" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "User Provided" + const: "User Provided" + type: "string" + enum: + - "User Provided" + column_names: + title: "Column Names" + description: "The column names that will be used while\ + \ emitting the CSV records" + type: "array" + items: + type: "string" + required: + - "column_names" + - "header_definition_type" + type: "object" + true_values: + title: "True Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as true values." + default: + - "y" + - "yes" + - "t" + - "true" + - "on" + - "1" + type: "array" + items: + type: "string" + uniqueItems: true + false_values: + title: "False Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as false values." + default: + - "n" + - "no" + - "f" + - "false" + - "off" + - "0" + type: "array" + items: + type: "string" + uniqueItems: true + ignore_errors_on_fields_mismatch: + title: "Ignore errors on field mismatch" + description: "Whether to ignore errors that occur when the number\ + \ of fields in the CSV does not match the number of columns\ + \ in the schema." + default: false + type: "boolean" + required: + - "filetype" + - title: "Jsonl Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "jsonl" + const: "jsonl" + type: "string" + enum: + - "jsonl" + required: + - "filetype" + - title: "Parquet Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "parquet" + const: "parquet" + type: "string" + enum: + - "parquet" + decimal_as_float: + title: "Convert Decimal Fields to Floats" + description: "Whether to convert decimal fields to floats. There\ + \ is a loss of precision when converting decimals to floats,\ + \ so this is not recommended." + default: false + type: "boolean" + required: + - "filetype" + - title: "Document File Type Format (Experimental)" + type: "object" + properties: + filetype: + title: "Filetype" + default: "unstructured" + const: "unstructured" + type: "string" + enum: + - "unstructured" + skip_unprocessable_files: + title: "Skip Unprocessable Files" + description: "If true, skip files that cannot be parsed and\ + \ pass the error message along as the _ab_source_file_parse_error\ + \ field. If false, fail the sync." + default: true + always_show: true + type: "boolean" + strategy: + title: "Parsing Strategy" + description: "The strategy used to parse documents. `fast` extracts\ + \ text directly from the document which doesn't work for all\ + \ files. `ocr_only` is more reliable, but slower. `hi_res`\ + \ is the most reliable, but requires an API key and a hosted\ + \ instance of unstructured and can't be used with local mode.\ + \ See the unstructured.io documentation for more details:\ + \ https://unstructured-io.github.io/unstructured/core/partition.html#partition-pdf" + default: "auto" + always_show: true + order: 0 + enum: + - "auto" + - "fast" + - "ocr_only" + - "hi_res" + type: "string" + processing: + title: "Processing" + description: "Processing configuration" + default: + mode: "local" + type: "object" + oneOf: + - title: "Local" + type: "object" + properties: + mode: + title: "Mode" + default: "local" + const: "local" + enum: + - "local" + type: "string" + description: "Process files locally, supporting `fast` and\ + \ `ocr` modes. This is the default option." + required: + - "mode" + description: "Extract text from document formats (.pdf, .docx, .md,\ + \ .pptx) and emit as one record per file." + required: + - "filetype" + schemaless: + title: "Schemaless" + description: "When enabled, syncs will not validate or structure records\ + \ against the stream's schema." + default: false + type: "boolean" + required: + - "name" + - "format" + credentials: + title: "Authentication" + description: "Credentials for connecting to the One Drive API" + type: "object" + order: 0 + oneOf: + - title: "Authenticate via Microsoft (OAuth)" + description: "OAuthCredentials class to hold authentication details for\ + \ Microsoft OAuth authentication.\nThis class uses pydantic for data\ + \ validation and settings management." + type: "object" + properties: + auth_type: + title: "Auth Type" + default: "Client" + const: "Client" + enum: + - "Client" + type: "string" + tenant_id: + title: "Tenant ID" + description: "Tenant ID of the Microsoft SharePoint user" + airbyte_secret: true + type: "string" + client_id: + title: "Client ID" + description: "Client ID of your Microsoft developer application" + airbyte_secret: true + type: "string" + client_secret: + title: "Client Secret" + description: "Client Secret of your Microsoft developer application" + airbyte_secret: true + type: "string" + refresh_token: + title: "Refresh Token" + description: "Refresh Token of your Microsoft developer application" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + required: + - "tenant_id" + - "client_id" + - "client_secret" + - "refresh_token" + - title: "Service Key Authentication" + description: "ServiceCredentials class for service key authentication.\n\ + This class is structured similarly to OAuthCredentials but for a different\ + \ authentication method." + type: "object" + properties: + auth_type: + title: "Auth Type" + default: "Service" + const: "Service" + enum: + - "Service" + type: "string" + tenant_id: + title: "Tenant ID" + description: "Tenant ID of the Microsoft SharePoint user" + airbyte_secret: true + type: "string" + user_principal_name: + title: "User Principal Name" + description: "Special characters such as a period, comma, space, and\ + \ the at sign (@) are converted to underscores (_). More details:\ + \ https://learn.microsoft.com/en-us/sharepoint/list-onedrive-urls" + airbyte_secret: true + type: "string" + client_id: + title: "Client ID" + description: "Client ID of your Microsoft developer application" + airbyte_secret: true + type: "string" + client_secret: + title: "Client Secret" + description: "Client Secret of your Microsoft developer application" + airbyte_secret: true + type: "string" + required: + - "tenant_id" + - "user_principal_name" + - "client_id" + - "client_secret" + search_scope: + title: "Search Scope" + description: "Specifies the location(s) to search for files. Valid options\ + \ are 'ACCESSIBLE_DRIVES' for all SharePoint drives the user can access,\ + \ 'SHARED_ITEMS' for shared items the user has access to, and 'ALL' to\ + \ search both." + default: "ALL" + enum: + - "ACCESSIBLE_DRIVES" + - "SHARED_ITEMS" + - "ALL" + order: 3 + type: "string" + folder_path: + title: "Folder Path" + description: "Path to a specific folder within the drives to search for\ + \ files. Leave empty to search all folders of the drives. This does not\ + \ apply to shared items." + default: "." + order: 4 + type: "string" + sourceType: + title: "microsoft-sharepoint" + const: "microsoft-sharepoint" + enum: + - "microsoft-sharepoint" + order: 0 + type: "string" + required: + - "streams" + - "credentials" + - "sourceType" + source-microsoft-sharepoint-update: + title: "Microsoft SharePoint Source Spec" + description: "SourceMicrosoftSharePointSpec class for Microsoft SharePoint Source\ + \ Specification.\nThis class combines the authentication details with additional\ + \ configuration for the SharePoint API." + type: "object" + properties: + start_date: + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00.000000Z.\ + \ Any file modified before this date will not be replicated." + examples: + - "2021-01-01T00:00:00.000000Z" + format: "date-time" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$" + pattern_descriptor: "YYYY-MM-DDTHH:mm:ss.SSSSSSZ" + order: 1 + type: "string" + streams: + title: "The list of streams to sync" + description: "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." + order: 10 + type: "array" + items: + title: "FileBasedStreamConfig" + type: "object" + properties: + name: + title: "Name" + description: "The name of the stream." + type: "string" + globs: + title: "Globs" + description: "The pattern used to specify which files should be selected\ + \ from the file system. For more information on glob pattern matching\ + \ look here." + default: + - "**" + order: 1 + type: "array" + items: + type: "string" + validation_policy: + title: "Validation Policy" + description: "The name of the validation policy that dictates sync\ + \ behavior when a record does not adhere to the stream schema." + default: "Emit Record" + enum: + - "Emit Record" + - "Skip Record" + - "Wait for Discover" + input_schema: + title: "Input Schema" + description: "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." + type: "string" + primary_key: + title: "Primary Key" + description: "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." + airbyte_hidden: true + type: "string" + days_to_sync_if_history_is_full: + title: "Days To Sync If History Is Full" + description: "When the state history of the file store is full, syncs\ + \ will only read files that were last modified in the provided day\ + \ range." + default: 3 + type: "integer" + format: + title: "Format" + description: "The configuration options that are used to alter how\ + \ to read incoming files that deviate from the standard formatting." + type: "object" + oneOf: + - title: "Avro Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "avro" + const: "avro" + type: "string" + enum: + - "avro" + double_as_string: + title: "Convert Double Fields to Strings" + description: "Whether to convert double fields to strings. This\ + \ is recommended if you have decimal numbers with a high degree\ + \ of precision because there can be a loss precision when\ + \ handling floating point numbers." + default: false + type: "boolean" + required: + - "filetype" + - title: "CSV Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "csv" + const: "csv" + type: "string" + enum: + - "csv" + delimiter: + title: "Delimiter" + description: "The character delimiting individual cells in the\ + \ CSV data. This may only be a 1-character string. For tab-delimited\ + \ data enter '\\t'." + default: "," + type: "string" + quote_char: + title: "Quote Character" + description: "The character used for quoting CSV values. To\ + \ disallow quoting, make this field blank." + default: "\"" + type: "string" + escape_char: + title: "Escape Character" + description: "The character used for escaping special characters.\ + \ To disallow escaping, leave this field blank." + type: "string" + encoding: + title: "Encoding" + description: "The character encoding of the CSV data. Leave\ + \ blank to default to UTF8. See list of python encodings for allowable\ + \ options." + default: "utf8" + type: "string" + double_quote: + title: "Double Quote" + description: "Whether two quotes in a quoted CSV value denote\ + \ a single quote in the data." + default: true + type: "boolean" + null_values: + title: "Null Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as null values. For example, if the value 'NA'\ + \ should be interpreted as null, enter 'NA' in this field." + default: [] + type: "array" + items: + type: "string" + uniqueItems: true + strings_can_be_null: + title: "Strings Can Be Null" + description: "Whether strings can be interpreted as null values.\ + \ If true, strings that match the null_values set will be\ + \ interpreted as null. If false, strings that match the null_values\ + \ set will be interpreted as the string itself." + default: true + type: "boolean" + skip_rows_before_header: + title: "Skip Rows Before Header" + description: "The number of rows to skip before the header row.\ + \ For example, if the header row is on the 3rd row, enter\ + \ 2 in this field." + default: 0 + type: "integer" + skip_rows_after_header: + title: "Skip Rows After Header" + description: "The number of rows to skip after the header row." + default: 0 + type: "integer" + header_definition: + title: "CSV Header Definition" + description: "How headers will be defined. `User Provided` assumes\ + \ the CSV does not have a header row and uses the headers\ + \ provided and `Autogenerated` assumes the CSV does not have\ + \ a header row and the CDK will generate headers using for\ + \ `f{i}` where `i` is the index starting from 0. Else, the\ + \ default behavior is to use the header from the CSV file.\ + \ If a user wants to autogenerate or provide column names\ + \ for a CSV having headers, they can skip rows." + default: + header_definition_type: "From CSV" + oneOf: + - title: "From CSV" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "From CSV" + const: "From CSV" + type: "string" + enum: + - "From CSV" + required: + - "header_definition_type" + - title: "Autogenerated" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "Autogenerated" + const: "Autogenerated" + type: "string" + enum: + - "Autogenerated" + required: + - "header_definition_type" + - title: "User Provided" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "User Provided" + const: "User Provided" + type: "string" + enum: + - "User Provided" + column_names: + title: "Column Names" + description: "The column names that will be used while\ + \ emitting the CSV records" + type: "array" + items: + type: "string" + required: + - "column_names" + - "header_definition_type" + type: "object" + true_values: + title: "True Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as true values." + default: + - "y" + - "yes" + - "t" + - "true" + - "on" + - "1" + type: "array" + items: + type: "string" + uniqueItems: true + false_values: + title: "False Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as false values." + default: + - "n" + - "no" + - "f" + - "false" + - "off" + - "0" + type: "array" + items: + type: "string" + uniqueItems: true + ignore_errors_on_fields_mismatch: + title: "Ignore errors on field mismatch" + description: "Whether to ignore errors that occur when the number\ + \ of fields in the CSV does not match the number of columns\ + \ in the schema." + default: false + type: "boolean" + required: + - "filetype" + - title: "Jsonl Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "jsonl" + const: "jsonl" + type: "string" + enum: + - "jsonl" + required: + - "filetype" + - title: "Parquet Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "parquet" + const: "parquet" + type: "string" + enum: + - "parquet" + decimal_as_float: + title: "Convert Decimal Fields to Floats" + description: "Whether to convert decimal fields to floats. There\ + \ is a loss of precision when converting decimals to floats,\ + \ so this is not recommended." + default: false + type: "boolean" + required: + - "filetype" + - title: "Document File Type Format (Experimental)" + type: "object" + properties: + filetype: + title: "Filetype" + default: "unstructured" + const: "unstructured" + type: "string" + enum: + - "unstructured" + skip_unprocessable_files: + title: "Skip Unprocessable Files" + description: "If true, skip files that cannot be parsed and\ + \ pass the error message along as the _ab_source_file_parse_error\ + \ field. If false, fail the sync." + default: true + always_show: true + type: "boolean" + strategy: + title: "Parsing Strategy" + description: "The strategy used to parse documents. `fast` extracts\ + \ text directly from the document which doesn't work for all\ + \ files. `ocr_only` is more reliable, but slower. `hi_res`\ + \ is the most reliable, but requires an API key and a hosted\ + \ instance of unstructured and can't be used with local mode.\ + \ See the unstructured.io documentation for more details:\ + \ https://unstructured-io.github.io/unstructured/core/partition.html#partition-pdf" + default: "auto" + always_show: true + order: 0 + enum: + - "auto" + - "fast" + - "ocr_only" + - "hi_res" + type: "string" + processing: + title: "Processing" + description: "Processing configuration" + default: + mode: "local" + type: "object" + oneOf: + - title: "Local" + type: "object" + properties: + mode: + title: "Mode" + default: "local" + const: "local" + enum: + - "local" + type: "string" + description: "Process files locally, supporting `fast` and\ + \ `ocr` modes. This is the default option." + required: + - "mode" + description: "Extract text from document formats (.pdf, .docx, .md,\ + \ .pptx) and emit as one record per file." + required: + - "filetype" + schemaless: + title: "Schemaless" + description: "When enabled, syncs will not validate or structure records\ + \ against the stream's schema." + default: false + type: "boolean" + required: + - "name" + - "format" + credentials: + title: "Authentication" + description: "Credentials for connecting to the One Drive API" + type: "object" + order: 0 + oneOf: + - title: "Authenticate via Microsoft (OAuth)" + description: "OAuthCredentials class to hold authentication details for\ + \ Microsoft OAuth authentication.\nThis class uses pydantic for data\ + \ validation and settings management." + type: "object" + properties: + auth_type: + title: "Auth Type" + default: "Client" + const: "Client" + enum: + - "Client" + type: "string" + tenant_id: + title: "Tenant ID" + description: "Tenant ID of the Microsoft SharePoint user" + airbyte_secret: true + type: "string" + client_id: + title: "Client ID" + description: "Client ID of your Microsoft developer application" + airbyte_secret: true + type: "string" + client_secret: + title: "Client Secret" + description: "Client Secret of your Microsoft developer application" + airbyte_secret: true + type: "string" + refresh_token: + title: "Refresh Token" + description: "Refresh Token of your Microsoft developer application" + airbyte_secret: true + type: "string" + required: + - "tenant_id" + - "client_id" + - "client_secret" + - "refresh_token" + - title: "Service Key Authentication" + description: "ServiceCredentials class for service key authentication.\n\ + This class is structured similarly to OAuthCredentials but for a different\ + \ authentication method." + type: "object" + properties: + auth_type: + title: "Auth Type" + default: "Service" + const: "Service" + enum: + - "Service" + type: "string" + tenant_id: + title: "Tenant ID" + description: "Tenant ID of the Microsoft SharePoint user" + airbyte_secret: true + type: "string" + user_principal_name: + title: "User Principal Name" + description: "Special characters such as a period, comma, space, and\ + \ the at sign (@) are converted to underscores (_). More details:\ + \ https://learn.microsoft.com/en-us/sharepoint/list-onedrive-urls" + airbyte_secret: true + type: "string" + client_id: + title: "Client ID" + description: "Client ID of your Microsoft developer application" + airbyte_secret: true + type: "string" + client_secret: + title: "Client Secret" + description: "Client Secret of your Microsoft developer application" + airbyte_secret: true + type: "string" + required: + - "tenant_id" + - "user_principal_name" + - "client_id" + - "client_secret" + search_scope: + title: "Search Scope" + description: "Specifies the location(s) to search for files. Valid options\ + \ are 'ACCESSIBLE_DRIVES' for all SharePoint drives the user can access,\ + \ 'SHARED_ITEMS' for shared items the user has access to, and 'ALL' to\ + \ search both." + default: "ALL" + enum: + - "ACCESSIBLE_DRIVES" + - "SHARED_ITEMS" + - "ALL" + order: 3 + type: "string" + folder_path: + title: "Folder Path" + description: "Path to a specific folder within the drives to search for\ + \ files. Leave empty to search all folders of the drives. This does not\ + \ apply to shared items." + default: "." + order: 4 + type: "string" + required: + - "streams" + - "credentials" + source-amazon-sqs: + title: "Amazon SQS Source Spec" + type: "object" + required: + - "queue_url" + - "region" + - "delete_messages" + - "sourceType" + properties: + queue_url: + title: "Queue URL" + description: "URL of the SQS Queue" + type: "string" + examples: + - "https://sqs.eu-west-1.amazonaws.com/1234567890/my-example-queue" + order: 0 + region: + title: "AWS Region" + description: "AWS Region of the SQS Queue" + type: "string" + enum: + - "af-south-1" + - "ap-east-1" + - "ap-northeast-1" + - "ap-northeast-2" + - "ap-northeast-3" + - "ap-south-1" + - "ap-south-2" + - "ap-southeast-1" + - "ap-southeast-2" + - "ap-southeast-3" + - "ap-southeast-4" + - "ca-central-1" + - "ca-west-1" + - "cn-north-1" + - "cn-northwest-1" + - "eu-central-1" + - "eu-central-2" + - "eu-north-1" + - "eu-south-1" + - "eu-south-2" + - "eu-west-1" + - "eu-west-2" + - "eu-west-3" + - "il-central-1" + - "me-central-1" + - "me-south-1" + - "sa-east-1" + - "us-east-1" + - "us-east-2" + - "us-gov-east-1" + - "us-gov-west-1" + - "us-west-1" + - "us-west-2" + order: 1 + delete_messages: + title: "Delete Messages After Read" + description: "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. " + type: "boolean" + default: false + order: 2 + max_batch_size: + title: "Max Batch Size" + description: "Max amount of messages to get in one batch (10 max)" + type: "integer" + examples: + - "5" + order: 3 + max_wait_time: + title: "Max Wait Time" + description: "Max amount of time in seconds to wait for messages in a single\ + \ poll (20 max)" + type: "integer" + examples: + - "5" + order: 4 + attributes_to_return: + title: "Message Attributes To Return" + description: "Comma separated list of Mesage Attribute names to return" + type: "string" + examples: + - "attr1,attr2" + order: 5 + visibility_timeout: + title: "Message Visibility Timeout" + description: "Modify the Visibility Timeout of the individual message from\ + \ the Queue's default (seconds)." + type: "integer" + examples: + - "15" + order: 6 + access_key: + title: "AWS IAM Access Key ID" + description: "The Access Key ID of the AWS IAM Role to use for pulling messages" + type: "string" + examples: + - "xxxxxHRNxxx3TBxxxxxx" + airbyte_secret: true + order: 7 + x-speakeasy-param-sensitive: true + secret_key: + title: "AWS IAM Secret Key" + description: "The Secret Key of the AWS IAM Role to use for pulling messages" + type: "string" + examples: + - "hu+qE5exxxxT6o/ZrKsxxxxxxBhxxXLexxxxxVKz" + airbyte_secret: true + order: 8 + x-speakeasy-param-sensitive: true + sourceType: + title: "amazon-sqs" + const: "amazon-sqs" + enum: + - "amazon-sqs" + order: 0 + type: "string" + source-amazon-sqs-update: + title: "Amazon SQS Source Spec" + type: "object" + required: + - "queue_url" + - "region" + - "delete_messages" + properties: + queue_url: + title: "Queue URL" + description: "URL of the SQS Queue" + type: "string" + examples: + - "https://sqs.eu-west-1.amazonaws.com/1234567890/my-example-queue" + order: 0 + region: + title: "AWS Region" + description: "AWS Region of the SQS Queue" + type: "string" + enum: + - "af-south-1" + - "ap-east-1" + - "ap-northeast-1" + - "ap-northeast-2" + - "ap-northeast-3" + - "ap-south-1" + - "ap-south-2" + - "ap-southeast-1" + - "ap-southeast-2" + - "ap-southeast-3" + - "ap-southeast-4" + - "ca-central-1" + - "ca-west-1" + - "cn-north-1" + - "cn-northwest-1" + - "eu-central-1" + - "eu-central-2" + - "eu-north-1" + - "eu-south-1" + - "eu-south-2" + - "eu-west-1" + - "eu-west-2" + - "eu-west-3" + - "il-central-1" + - "me-central-1" + - "me-south-1" + - "sa-east-1" + - "us-east-1" + - "us-east-2" + - "us-gov-east-1" + - "us-gov-west-1" + - "us-west-1" + - "us-west-2" + order: 1 + delete_messages: + title: "Delete Messages After Read" + description: "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. " + type: "boolean" + default: false + order: 2 + max_batch_size: + title: "Max Batch Size" + description: "Max amount of messages to get in one batch (10 max)" + type: "integer" + examples: + - "5" + order: 3 + max_wait_time: + title: "Max Wait Time" + description: "Max amount of time in seconds to wait for messages in a single\ + \ poll (20 max)" + type: "integer" + examples: + - "5" + order: 4 + attributes_to_return: + title: "Message Attributes To Return" + description: "Comma separated list of Mesage Attribute names to return" + type: "string" + examples: + - "attr1,attr2" + order: 5 + visibility_timeout: + title: "Message Visibility Timeout" + description: "Modify the Visibility Timeout of the individual message from\ + \ the Queue's default (seconds)." + type: "integer" + examples: + - "15" + order: 6 + access_key: + title: "AWS IAM Access Key ID" + description: "The Access Key ID of the AWS IAM Role to use for pulling messages" + type: "string" + examples: + - "xxxxxHRNxxx3TBxxxxxx" + airbyte_secret: true + order: 7 + secret_key: + title: "AWS IAM Secret Key" + description: "The Secret Key of the AWS IAM Role to use for pulling messages" + type: "string" + examples: + - "hu+qE5exxxxT6o/ZrKsxxxxxxBhxxXLexxxxxVKz" + airbyte_secret: true + order: 8 + source-sonar-cloud: + title: "Sonar Cloud Spec" + type: "object" + required: + - "user_token" + - "organization" + - "component_keys" + - "sourceType" + properties: + user_token: + title: "User Token" + type: "string" + description: "Your User Token. See here. The token is case sensitive." + airbyte_secret: true + x-speakeasy-param-sensitive: true + organization: + title: "Organization" + type: "string" + description: "Organization key. See here." + examples: + - "airbyte" + component_keys: + title: "Component Keys" + type: "array" + description: "Comma-separated list of component keys." + examples: + - "airbyte-ws-order" + - "airbyte-ws-checkout" + x-speakeasy-param-sensitive: true + start_date: + title: "Start date" + type: "string" + description: "To retrieve issues created after the given date (inclusive)." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + examples: + - "YYYY-MM-DD" + format: "date" + end_date: + title: "End date" + type: "string" + description: "To retrieve issues created before the given date (inclusive)." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + examples: + - "YYYY-MM-DD" + format: "date" + sourceType: + title: "sonar-cloud" + const: "sonar-cloud" + enum: + - "sonar-cloud" + order: 0 + type: "string" + source-sonar-cloud-update: + title: "Sonar Cloud Spec" + type: "object" + required: + - "user_token" + - "organization" + - "component_keys" + properties: + user_token: + title: "User Token" + type: "string" + description: "Your User Token. See here. The token is case sensitive." + airbyte_secret: true + organization: + title: "Organization" + type: "string" + description: "Organization key. See here." + examples: + - "airbyte" + component_keys: + title: "Component Keys" + type: "array" + description: "Comma-separated list of component keys." + examples: + - "airbyte-ws-order" + - "airbyte-ws-checkout" + start_date: + title: "Start date" + type: "string" + description: "To retrieve issues created after the given date (inclusive)." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + examples: + - "YYYY-MM-DD" + format: "date" + end_date: + title: "End date" + type: "string" + description: "To retrieve issues created before the given date (inclusive)." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + examples: + - "YYYY-MM-DD" + format: "date" + source-clockify: + title: "Clockify Spec" + type: "object" + required: + - "workspace_id" + - "api_key" + - "sourceType" + properties: + workspace_id: + title: "Workspace Id" + description: "WorkSpace Id" + type: "string" + api_key: + title: "API Key" + description: "You can get your api access_key here This API is Case Sensitive." + type: "string" + airbyte_secret: true + x-speakeasy-param-sensitive: true + api_url: + title: "API Url" + description: "The URL for the Clockify API. This should only need to be\ + \ modified if connecting to an enterprise version of Clockify." + type: "string" + default: "https://api.clockify.me" + sourceType: + title: "clockify" + const: "clockify" + enum: + - "clockify" + order: 0 + type: "string" + source-clockify-update: + title: "Clockify Spec" + type: "object" + required: + - "workspace_id" + - "api_key" + properties: + workspace_id: + title: "Workspace Id" + description: "WorkSpace Id" + type: "string" + api_key: + title: "API Key" + description: "You can get your api access_key here This API is Case Sensitive." + type: "string" + airbyte_secret: true + api_url: + title: "API Url" + description: "The URL for the Clockify API. This should only need to be\ + \ modified if connecting to an enterprise version of Clockify." + type: "string" + default: "https://api.clockify.me" + source-marketo: + title: "Source Marketo Spec" + type: "object" + required: + - "domain_url" + - "client_id" + - "client_secret" + - "start_date" + - "sourceType" + properties: + domain_url: + title: "Domain URL" + type: "string" + order: 3 + description: "Your Marketo Base URL. See the docs for info on how to obtain this." + examples: + - "https://000-AAA-000.mktorest.com" + airbyte_secret: true + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Marketo developer application. See the\ + \ docs for info on how to obtain this." + order: 0 + airbyte_secret: true + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Marketo developer application. See\ + \ the\ + \ docs for info on how to obtain this." + order: 1 + airbyte_secret: true + start_date: + title: "Start Date" + type: "string" + order: 2 + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + examples: + - "2020-09-25T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + format: "date-time" + sourceType: + title: "marketo" + const: "marketo" + enum: + - "marketo" + order: 0 + type: "string" + source-marketo-update: + title: "Source Marketo Spec" + type: "object" + required: + - "domain_url" + - "client_id" + - "client_secret" + - "start_date" + properties: + domain_url: + title: "Domain URL" + type: "string" + order: 3 + description: "Your Marketo Base URL. See the docs for info on how to obtain this." + examples: + - "https://000-AAA-000.mktorest.com" + airbyte_secret: true + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Marketo developer application. See the\ + \ docs for info on how to obtain this." + order: 0 + airbyte_secret: true + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Marketo developer application. See\ + \ the\ + \ docs for info on how to obtain this." + order: 1 + airbyte_secret: true + start_date: + title: "Start Date" + type: "string" + order: 2 + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + examples: + - "2020-09-25T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + format: "date-time" + source-pocket: + title: "Pocket Spec" + type: "object" + required: + - "consumer_key" + - "access_token" + - "sourceType" + properties: + consumer_key: + type: "string" + title: "Consumer Key" + description: "Your application's Consumer Key." + airbyte_secret: true + order: 0 + x-speakeasy-param-sensitive: true + access_token: + type: "string" + title: "Access Token" + description: "The user's Pocket access token." + airbyte_secret: true + order: 1 + x-speakeasy-param-sensitive: true + state: + type: "string" + title: "State" + description: "Select the state of the items to retrieve." + order: 2 + enum: + - "unread" + - "archive" + - "all" + favorite: + type: "boolean" + title: "Is Favorite?" + description: "Retrieve only favorited items." + default: false + order: 3 + tag: + type: "string" + title: "Tag Name" + description: "Return only items tagged with this tag name. Use _untagged_\ + \ for retrieving only untagged items." + order: 4 + content_type: + type: "string" + title: "Content Type" + description: "Select the content type of the items to retrieve." + order: 5 + enum: + - "article" + - "video" + - "image" + sort: + type: "string" + title: "Sort By" + description: "Sort retrieved items by the given criteria." + order: 6 + enum: + - "newest" + - "oldest" + - "title" + - "site" + detail_type: + type: "string" + title: "Detail Type" + description: "Select the granularity of the information about each item." + order: 7 + enum: + - "simple" + - "complete" + search: + type: "string" + title: "Search Query" + description: "Only return items whose title or url contain the `search`\ + \ string." + order: 8 + domain: + type: "string" + title: "Domain" + description: "Only return items from a particular `domain`." + order: 9 + since: + type: "string" + title: "Since" + description: "Only return items modified since the given timestamp." + pattern: "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}" + examples: + - "2022-10-20 14:14:14" + order: 10 + sourceType: + title: "pocket" + const: "pocket" + enum: + - "pocket" + order: 0 + type: "string" + source-pocket-update: + title: "Pocket Spec" + type: "object" + required: + - "consumer_key" + - "access_token" + properties: + consumer_key: + type: "string" + title: "Consumer Key" + description: "Your application's Consumer Key." + airbyte_secret: true + order: 0 + access_token: + type: "string" + title: "Access Token" + description: "The user's Pocket access token." + airbyte_secret: true + order: 1 + state: + type: "string" + title: "State" + description: "Select the state of the items to retrieve." + order: 2 + enum: + - "unread" + - "archive" + - "all" + favorite: + type: "boolean" + title: "Is Favorite?" + description: "Retrieve only favorited items." + default: false + order: 3 + tag: + type: "string" + title: "Tag Name" + description: "Return only items tagged with this tag name. Use _untagged_\ + \ for retrieving only untagged items." + order: 4 + content_type: + type: "string" + title: "Content Type" + description: "Select the content type of the items to retrieve." + order: 5 + enum: + - "article" + - "video" + - "image" + sort: + type: "string" + title: "Sort By" + description: "Sort retrieved items by the given criteria." + order: 6 + enum: + - "newest" + - "oldest" + - "title" + - "site" + detail_type: + type: "string" + title: "Detail Type" + description: "Select the granularity of the information about each item." + order: 7 + enum: + - "simple" + - "complete" + search: + type: "string" + title: "Search Query" + description: "Only return items whose title or url contain the `search`\ + \ string." + order: 8 + domain: + type: "string" + title: "Domain" + description: "Only return items from a particular `domain`." + order: 9 + since: + type: "string" + title: "Since" + description: "Only return items modified since the given timestamp." + pattern: "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}" + examples: + - "2022-10-20 14:14:14" + order: 10 + source-smartsheets: + title: "Smartsheets Source Spec" + type: "object" + required: + - "credentials" + - "spreadsheet_id" + - "sourceType" + properties: + credentials: + title: "Authorization Method" + type: "object" + order: 0 + oneOf: + - type: "object" + title: "OAuth2.0" + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "access_token" + - "token_expiry_date" + properties: + auth_type: + type: "string" + const: "oauth2.0" + enum: + - "oauth2.0" + client_id: + type: "string" + description: "The API ID of the SmartSheets developer application." + airbyte_secret: true + client_secret: + type: "string" + description: "The API Secret the SmartSheets developer application." + airbyte_secret: true + access_token: + type: "string" + description: "Access Token for making authenticated requests." + airbyte_secret: true + x-speakeasy-param-sensitive: true + token_expiry_date: + type: "string" + description: "The date-time when the access token should be refreshed." + format: "date-time" + x-speakeasy-param-sensitive: true + refresh_token: + type: "string" + description: "The key to refresh the expired access_token." + airbyte_secret: true + x-speakeasy-param-sensitive: true + - title: "API Access Token" + type: "object" + required: + - "access_token" + properties: + auth_type: + type: "string" + const: "access_token" + enum: + - "access_token" + access_token: + type: "string" + title: "Access Token" + description: "The access token to use for accessing your data from\ + \ Smartsheets. This access token must be generated by a user with\ + \ at least read access to the data you'd like to replicate. Generate\ + \ an access token in the Smartsheets main menu by clicking Account\ + \ > Apps & Integrations > API Access. See the setup guide for information on how to obtain this token." + airbyte_secret: true + x-speakeasy-param-sensitive: true + spreadsheet_id: + title: "Sheet ID" + description: "The spreadsheet ID. Find it by opening the spreadsheet then\ + \ navigating to File > Properties" + type: "string" + order: 1 + start_datetime: + title: "Start Datetime" + type: "string" + examples: + - "2000-01-01T13:00:00" + - "2000-01-01T13:00:00-07:00" + description: "Only rows modified after this date/time will be replicated.\ + \ This should be an ISO 8601 string, for instance: `2000-01-01T13:00:00`" + format: "date-time" + default: "2020-01-01T00:00:00+00:00" + order: 2 + airbyte_hidden: true + metadata_fields: + title: "Metadata Fields" + type: "array" + items: + title: "Validenums" + enum: + - "sheetcreatedAt" + - "sheetid" + - "sheetmodifiedAt" + - "sheetname" + - "sheetpermalink" + - "sheetversion" + - "sheetaccess_level" + - "row_id" + - "row_access_level" + - "row_created_at" + - "row_created_by" + - "row_expanded" + - "row_modified_by" + - "row_parent_id" + - "row_permalink" + - "row_number" + - "row_version" + description: "A List of available columns which metadata can be pulled from." + order: 3 + sourceType: + title: "smartsheets" + const: "smartsheets" + enum: + - "smartsheets" + order: 0 + type: "string" + source-smartsheets-update: + title: "Smartsheets Source Spec" + type: "object" + required: + - "credentials" + - "spreadsheet_id" + properties: + credentials: + title: "Authorization Method" + type: "object" + order: 0 + oneOf: + - type: "object" + title: "OAuth2.0" + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "access_token" + - "token_expiry_date" + properties: + auth_type: + type: "string" + const: "oauth2.0" + enum: + - "oauth2.0" + client_id: + type: "string" + description: "The API ID of the SmartSheets developer application." + airbyte_secret: true + client_secret: + type: "string" + description: "The API Secret the SmartSheets developer application." + airbyte_secret: true + access_token: + type: "string" + description: "Access Token for making authenticated requests." + airbyte_secret: true + token_expiry_date: + type: "string" + description: "The date-time when the access token should be refreshed." + format: "date-time" + refresh_token: + type: "string" + description: "The key to refresh the expired access_token." + airbyte_secret: true + - title: "API Access Token" + type: "object" + required: + - "access_token" + properties: + auth_type: + type: "string" + const: "access_token" + enum: + - "access_token" + access_token: + type: "string" + title: "Access Token" + description: "The access token to use for accessing your data from\ + \ Smartsheets. This access token must be generated by a user with\ + \ at least read access to the data you'd like to replicate. Generate\ + \ an access token in the Smartsheets main menu by clicking Account\ + \ > Apps & Integrations > API Access. See the setup guide for information on how to obtain this token." + airbyte_secret: true + spreadsheet_id: + title: "Sheet ID" + description: "The spreadsheet ID. Find it by opening the spreadsheet then\ + \ navigating to File > Properties" + type: "string" + order: 1 + start_datetime: + title: "Start Datetime" + type: "string" + examples: + - "2000-01-01T13:00:00" + - "2000-01-01T13:00:00-07:00" + description: "Only rows modified after this date/time will be replicated.\ + \ This should be an ISO 8601 string, for instance: `2000-01-01T13:00:00`" + format: "date-time" + default: "2020-01-01T00:00:00+00:00" + order: 2 + airbyte_hidden: true + metadata_fields: + title: "Metadata Fields" + type: "array" + items: + title: "Validenums" + enum: + - "sheetcreatedAt" + - "sheetid" + - "sheetmodifiedAt" + - "sheetname" + - "sheetpermalink" + - "sheetversion" + - "sheetaccess_level" + - "row_id" + - "row_access_level" + - "row_created_at" + - "row_created_by" + - "row_expanded" + - "row_modified_by" + - "row_parent_id" + - "row_permalink" + - "row_number" + - "row_version" + description: "A List of available columns which metadata can be pulled from." + order: 3 + source-iterable: + title: "Iterable Spec" + type: "object" + required: + - "start_date" + - "api_key" + - "sourceType" + properties: + api_key: + type: "string" + title: "API Key" + description: "Iterable API Key. See the docs for more information on how to obtain this key." + airbyte_secret: true + order: 0 + x-speakeasy-param-sensitive: true + start_date: + type: "string" + title: "Start Date" + description: "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." + examples: + - "2021-04-01T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + order: 1 + format: "date-time" + sourceType: + title: "iterable" + const: "iterable" + enum: + - "iterable" + order: 0 + type: "string" + source-iterable-update: + title: "Iterable Spec" + type: "object" + required: + - "start_date" + - "api_key" + properties: + api_key: + type: "string" + title: "API Key" + description: "Iterable API Key. See the docs for more information on how to obtain this key." + airbyte_secret: true + order: 0 + start_date: + type: "string" + title: "Start Date" + description: "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." + examples: + - "2021-04-01T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + order: 1 + format: "date-time" + source-mysql: + title: "MySql Source Spec" + type: "object" + required: + - "host" + - "port" + - "database" + - "username" + - "replication_method" + - "sourceType" + properties: + host: + description: "The host name of the database." + title: "Host" + type: "string" + order: 0 + port: + description: "The port to connect to." + title: "Port" + type: "integer" + minimum: 0 + maximum: 65536 + default: 3306 + examples: + - "3306" + order: 1 + database: + description: "The database name." + title: "Database" + type: "string" + order: 2 + username: + description: "The username which is used to access the database." + title: "Username" + type: "string" + order: 3 + password: + description: "The password associated with the username." + title: "Password" + type: "string" + airbyte_secret: true + order: 4 + always_show: true + x-speakeasy-param-sensitive: true + jdbc_url_params: + description: "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." + title: "JDBC URL Parameters (Advanced)" + type: "string" + order: 5 + ssl_mode: + title: "SSL modes" + description: "SSL connection modes. Read more in the docs." + type: "object" + order: 7 + oneOf: + - title: "preferred" + description: "Automatically attempt SSL connection. If the MySQL server\ + \ does not support SSL, continue with a regular connection." + required: + - "mode" + properties: + mode: + type: "string" + const: "preferred" + order: 0 + enum: + - "preferred" + - title: "required" + description: "Always connect with SSL. If the MySQL server doesn’t support\ + \ SSL, the connection will not be established. Certificate Authority\ + \ (CA) and Hostname are not verified." + required: + - "mode" + properties: + mode: + type: "string" + const: "required" + order: 0 + enum: + - "required" + - title: "Verify CA" + description: "Always connect with SSL. Verifies CA, but allows connection\ + \ even if Hostname does not match." + required: + - "mode" + - "ca_certificate" + properties: + mode: + type: "string" + const: "verify_ca" + order: 0 + enum: + - "verify_ca" + ca_certificate: + type: "string" + title: "CA certificate" + description: "CA certificate" + airbyte_secret: true + multiline: true + order: 1 + client_certificate: + type: "string" + title: "Client certificate" + description: "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)" + airbyte_secret: true + multiline: true + order: 2 + always_show: true + client_key: + type: "string" + title: "Client key" + description: "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)" + airbyte_secret: true + multiline: true + order: 3 + always_show: true + x-speakeasy-param-sensitive: true + client_key_password: + type: "string" + title: "Client key password" + description: "Password for keystorage. This field is optional. If\ + \ you do not add it - the password will be generated automatically." + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + - title: "Verify Identity" + description: "Always connect with SSL. Verify both CA and Hostname." + required: + - "mode" + - "ca_certificate" + properties: + mode: + type: "string" + const: "verify_identity" + order: 0 + enum: + - "verify_identity" + ca_certificate: + type: "string" + title: "CA certificate" + description: "CA certificate" + airbyte_secret: true + multiline: true + order: 1 + client_certificate: + type: "string" + title: "Client certificate" + description: "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)" + airbyte_secret: true + multiline: true + order: 2 + always_show: true + client_key: + type: "string" + title: "Client key" + description: "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)" + airbyte_secret: true + multiline: true + order: 3 + always_show: true + x-speakeasy-param-sensitive: true + client_key_password: + type: "string" + title: "Client key password" + description: "Password for keystorage. This field is optional. If\ + \ you do not add it - the password will be generated automatically." + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + default: "required" + replication_method: + type: "object" + title: "Update Method" + description: "Configures how data is extracted from the database." + order: 8 + default: "CDC" + display_type: "radio" + oneOf: + - title: "Read Changes using Binary Log (CDC)" + description: "Recommended - Incrementally reads new inserts, updates,\ + \ and deletes using the MySQL binary log. This must be enabled on your database." + required: + - "method" + properties: + method: + type: "string" + const: "CDC" + order: 0 + enum: + - "CDC" + initial_waiting_seconds: + type: "integer" + title: "Initial Waiting Time in Seconds (Advanced)" + description: "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." + default: 300 + min: 120 + max: 1200 + order: 1 + always_show: true + server_time_zone: + type: "string" + title: "Configured server timezone for the MySQL source (Advanced)" + description: "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." + order: 2 + always_show: true + invalid_cdc_cursor_position_behavior: + type: "string" + title: "Invalid CDC position behavior (Advanced)" + description: "Determines whether Airbyte should fail or re-sync data\ + \ in case of an stale/invalid cursor value into the WAL. If 'Fail\ + \ sync' is chosen, a user will have to manually reset the connection\ + \ before being able to continue syncing data. If 'Re-sync data'\ + \ is chosen, Airbyte will automatically trigger a refresh but could\ + \ lead to higher cloud costs and data loss." + enum: + - "Fail sync" + - "Re-sync data" + default: "Fail sync" + order: 3 + always_show: true + - title: "Scan Changes with User Defined Cursor" + description: "Incrementally detects new inserts and updates using the\ + \ cursor column chosen when configuring a connection (e.g. created_at,\ + \ updated_at)." + required: + - "method" + properties: + method: + type: "string" + const: "STANDARD" + order: 0 + enum: + - "STANDARD" + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + x-speakeasy-param-sensitive: true + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + sourceType: + title: "mysql" + const: "mysql" + enum: + - "mysql" + order: 0 + type: "string" + source-mysql-update: + title: "MySql Source Spec" + type: "object" + required: + - "host" + - "port" + - "database" + - "username" + - "replication_method" + properties: + host: + description: "The host name of the database." + title: "Host" + type: "string" + order: 0 + port: + description: "The port to connect to." + title: "Port" + type: "integer" + minimum: 0 + maximum: 65536 + default: 3306 + examples: + - "3306" + order: 1 + database: + description: "The database name." + title: "Database" + type: "string" + order: 2 + username: + description: "The username which is used to access the database." + title: "Username" + type: "string" + order: 3 + password: + description: "The password associated with the username." + title: "Password" + type: "string" + airbyte_secret: true + order: 4 + always_show: true + jdbc_url_params: + description: "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." + title: "JDBC URL Parameters (Advanced)" + type: "string" + order: 5 + ssl_mode: + title: "SSL modes" + description: "SSL connection modes. Read more in the docs." + type: "object" + order: 7 + oneOf: + - title: "preferred" + description: "Automatically attempt SSL connection. If the MySQL server\ + \ does not support SSL, continue with a regular connection." + required: + - "mode" + properties: + mode: + type: "string" + const: "preferred" + order: 0 + enum: + - "preferred" + - title: "required" + description: "Always connect with SSL. If the MySQL server doesn’t support\ + \ SSL, the connection will not be established. Certificate Authority\ + \ (CA) and Hostname are not verified." + required: + - "mode" + properties: + mode: + type: "string" + const: "required" + order: 0 + enum: + - "required" + - title: "Verify CA" + description: "Always connect with SSL. Verifies CA, but allows connection\ + \ even if Hostname does not match." + required: + - "mode" + - "ca_certificate" + properties: + mode: + type: "string" + const: "verify_ca" + order: 0 + enum: + - "verify_ca" + ca_certificate: + type: "string" + title: "CA certificate" + description: "CA certificate" + airbyte_secret: true + multiline: true + order: 1 + client_certificate: + type: "string" + title: "Client certificate" + description: "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)" + airbyte_secret: true + multiline: true + order: 2 + always_show: true + client_key: + type: "string" + title: "Client key" + description: "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)" + airbyte_secret: true + multiline: true + order: 3 + always_show: true + client_key_password: + type: "string" + title: "Client key password" + description: "Password for keystorage. This field is optional. If\ + \ you do not add it - the password will be generated automatically." + airbyte_secret: true + order: 4 + - title: "Verify Identity" + description: "Always connect with SSL. Verify both CA and Hostname." + required: + - "mode" + - "ca_certificate" + properties: + mode: + type: "string" + const: "verify_identity" + order: 0 + enum: + - "verify_identity" + ca_certificate: + type: "string" + title: "CA certificate" + description: "CA certificate" + airbyte_secret: true + multiline: true + order: 1 + client_certificate: + type: "string" + title: "Client certificate" + description: "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)" + airbyte_secret: true + multiline: true + order: 2 + always_show: true + client_key: + type: "string" + title: "Client key" + description: "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)" + airbyte_secret: true + multiline: true + order: 3 + always_show: true + client_key_password: + type: "string" + title: "Client key password" + description: "Password for keystorage. This field is optional. If\ + \ you do not add it - the password will be generated automatically." + airbyte_secret: true + order: 4 + default: "required" + replication_method: + type: "object" + title: "Update Method" + description: "Configures how data is extracted from the database." + order: 8 + default: "CDC" + display_type: "radio" + oneOf: + - title: "Read Changes using Binary Log (CDC)" + description: "Recommended - Incrementally reads new inserts, updates,\ + \ and deletes using the MySQL binary log. This must be enabled on your database." + required: + - "method" + properties: + method: + type: "string" + const: "CDC" + order: 0 + enum: + - "CDC" + initial_waiting_seconds: + type: "integer" + title: "Initial Waiting Time in Seconds (Advanced)" + description: "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." + default: 300 + min: 120 + max: 1200 + order: 1 + always_show: true + server_time_zone: + type: "string" + title: "Configured server timezone for the MySQL source (Advanced)" + description: "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." + order: 2 + always_show: true + invalid_cdc_cursor_position_behavior: + type: "string" + title: "Invalid CDC position behavior (Advanced)" + description: "Determines whether Airbyte should fail or re-sync data\ + \ in case of an stale/invalid cursor value into the WAL. If 'Fail\ + \ sync' is chosen, a user will have to manually reset the connection\ + \ before being able to continue syncing data. If 'Re-sync data'\ + \ is chosen, Airbyte will automatically trigger a refresh but could\ + \ lead to higher cloud costs and data loss." + enum: + - "Fail sync" + - "Re-sync data" + default: "Fail sync" + order: 3 + always_show: true + - title: "Scan Changes with User Defined Cursor" + description: "Incrementally detects new inserts and updates using the\ + \ cursor column chosen when configuring a connection (e.g. created_at,\ + \ updated_at)." + required: + - "method" + properties: + method: + type: "string" + const: "STANDARD" + order: 0 + enum: + - "STANDARD" + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + source-emailoctopus: + title: "EmailOctopus Spec" + type: "object" + required: + - "api_key" + - "sourceType" + properties: + api_key: + type: "string" + title: "EmailOctopus API key" + description: "EmailOctopus API Key. See the docs for information on how to generate this key." + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "emailoctopus" + const: "emailoctopus" + enum: + - "emailoctopus" + order: 0 + type: "string" + source-emailoctopus-update: + title: "EmailOctopus Spec" + type: "object" + required: + - "api_key" + properties: + api_key: + type: "string" + title: "EmailOctopus API key" + description: "EmailOctopus API Key. See the docs for information on how to generate this key." + airbyte_secret: true + source-railz: + title: "Railz Spec" + type: "object" + required: + - "client_id" + - "secret_key" + - "start_date" + - "sourceType" + properties: + client_id: + type: "string" + title: "Client ID" + description: "Client ID (client_id)" + order: 0 + secret_key: + type: "string" + title: "Secret key" + description: "Secret key (secret_key)" + order: 1 + airbyte_secret: true + x-speakeasy-param-sensitive: true + start_date: + type: "string" + title: "Start date" + description: "Start date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + order: 2 + sourceType: + title: "railz" + const: "railz" + enum: + - "railz" + order: 0 + type: "string" + source-railz-update: + title: "Railz Spec" + type: "object" + required: + - "client_id" + - "secret_key" + - "start_date" + properties: + client_id: + type: "string" + title: "Client ID" + description: "Client ID (client_id)" + order: 0 + secret_key: + type: "string" + title: "Secret key" + description: "Secret key (secret_key)" + order: 1 + airbyte_secret: true + start_date: + type: "string" + title: "Start date" + description: "Start date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + order: 2 + source-orbit: + title: "Orbit Source Spec" + type: "object" + required: + - "api_token" + - "workspace" + - "sourceType" + properties: + api_token: + type: "string" + airbyte_secret: true + title: "API Token" + description: "Authorizes you to work with Orbit workspaces associated with\ + \ the token." + order: 0 + x-speakeasy-param-sensitive: true + workspace: + type: "string" + title: "Workspace" + description: "The unique name of the workspace that your API token is associated\ + \ with." + order: 1 + start_date: + type: "string" + title: "Start Date" + description: "Date in the format 2022-06-26. Only load members whose last\ + \ activities are after this date." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + order: 2 + sourceType: + title: "orbit" + const: "orbit" + enum: + - "orbit" + order: 0 + type: "string" + source-orbit-update: + title: "Orbit Source Spec" + type: "object" + required: + - "api_token" + - "workspace" + properties: + api_token: + type: "string" + airbyte_secret: true + title: "API Token" + description: "Authorizes you to work with Orbit workspaces associated with\ + \ the token." + order: 0 + workspace: + type: "string" + title: "Workspace" + description: "The unique name of the workspace that your API token is associated\ + \ with." + order: 1 + start_date: + type: "string" + title: "Start Date" + description: "Date in the format 2022-06-26. Only load members whose last\ + \ activities are after this date." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + order: 2 + source-apify-dataset: + title: "Apify Dataset Spec" + type: "object" + required: + - "token" + - "dataset_id" + - "sourceType" + properties: + token: + type: "string" + title: "API token" + description: "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." + examples: + - "apify_api_PbVwb1cBbuvbfg2jRmAIHZKgx3NQyfEMG7uk" + airbyte_secret: true + x-speakeasy-param-sensitive: true + dataset_id: + type: "string" + title: "Dataset ID" + description: "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." + examples: + - "rHuMdwm6xCFt6WiGU" + sourceType: + title: "apify-dataset" + const: "apify-dataset" + enum: + - "apify-dataset" + order: 0 + type: "string" + source-apify-dataset-update: + title: "Apify Dataset Spec" + type: "object" + required: + - "token" + - "dataset_id" + properties: + token: + type: "string" + title: "API token" + description: "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." + examples: + - "apify_api_PbVwb1cBbuvbfg2jRmAIHZKgx3NQyfEMG7uk" + airbyte_secret: true + dataset_id: + type: "string" + title: "Dataset ID" + description: "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." + examples: + - "rHuMdwm6xCFt6WiGU" + source-confluence: + type: "object" + required: + - "email" + - "api_token" + - "domain_name" + - "sourceType" + properties: + email: + type: "string" + title: "Email" + description: "Your Confluence login email" + examples: + - "abc@example.com" + order: 0 + api_token: + type: "string" + title: "API Token" + description: "Please follow the Jira confluence for generating an API token:\ + \ generating an API token." + airbyte_secret: true + order: 1 + x-speakeasy-param-sensitive: true + domain_name: + title: "Domain name" + description: "Your Confluence domain name" + type: "string" + order: 2 + sourceType: + title: "confluence" + const: "confluence" + enum: + - "confluence" + order: 0 + type: "string" + source-confluence-update: + type: "object" + required: + - "email" + - "api_token" + - "domain_name" + properties: + email: + type: "string" + title: "Email" + description: "Your Confluence login email" + examples: + - "abc@example.com" + order: 0 + api_token: + type: "string" + title: "API Token" + description: "Please follow the Jira confluence for generating an API token:\ + \ generating an API token." + airbyte_secret: true + order: 1 + domain_name: + title: "Domain name" + description: "Your Confluence domain name" + type: "string" + order: 2 + source-coin-api: + title: "Coin API Spec" + type: "object" + required: + - "api_key" + - "environment" + - "symbol_id" + - "period" + - "start_date" + - "sourceType" + properties: + api_key: + type: "string" + description: "API Key" + airbyte_secret: true + order: 0 + x-speakeasy-param-sensitive: true + environment: + type: "string" + description: "The environment to use. Either sandbox or production.\n" + enum: + - "sandbox" + - "production" + default: "sandbox" + order: 1 + symbol_id: + type: "string" + description: "The symbol ID to use. See the documentation for a list.\n\ + https://docs.coinapi.io/#list-all-symbols-get\n" + order: 2 + period: + type: "string" + description: "The period to use. See the documentation for a list. https://docs.coinapi.io/#list-all-periods-get" + examples: + - "5SEC" + - "2MTH" + start_date: + type: "string" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$" + description: "The start date in ISO 8601 format." + examples: + - "2019-01-01T00:00:00" + end_date: + type: "string" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$" + description: "The end date in ISO 8601 format. If not supplied, data will\ + \ be returned\nfrom the start date to the current time, or when the count\ + \ of result\nelements reaches its limit.\n" + examples: + - "2019-01-01T00:00:00" + limit: + type: "integer" + description: "The maximum number of elements to return. If not supplied,\ + \ the default\nis 100. For numbers larger than 100, each 100 items is\ + \ counted as one\nrequest for pricing purposes. Maximum value is 100000.\n" + minimum: 1 + maximum: 100000 + default: 100 + sourceType: + title: "coin-api" + const: "coin-api" + enum: + - "coin-api" + order: 0 + type: "string" + source-coin-api-update: + title: "Coin API Spec" + type: "object" + required: + - "api_key" + - "environment" + - "symbol_id" + - "period" + - "start_date" + properties: + api_key: + type: "string" + description: "API Key" + airbyte_secret: true + order: 0 + environment: + type: "string" + description: "The environment to use. Either sandbox or production.\n" + enum: + - "sandbox" + - "production" + default: "sandbox" + order: 1 + symbol_id: + type: "string" + description: "The symbol ID to use. See the documentation for a list.\n\ + https://docs.coinapi.io/#list-all-symbols-get\n" + order: 2 + period: + type: "string" + description: "The period to use. See the documentation for a list. https://docs.coinapi.io/#list-all-periods-get" + examples: + - "5SEC" + - "2MTH" + start_date: + type: "string" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$" + description: "The start date in ISO 8601 format." + examples: + - "2019-01-01T00:00:00" + end_date: + type: "string" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$" + description: "The end date in ISO 8601 format. If not supplied, data will\ + \ be returned\nfrom the start date to the current time, or when the count\ + \ of result\nelements reaches its limit.\n" + examples: + - "2019-01-01T00:00:00" + limit: + type: "integer" + description: "The maximum number of elements to return. If not supplied,\ + \ the default\nis 100. For numbers larger than 100, each 100 items is\ + \ counted as one\nrequest for pricing purposes. Maximum value is 100000.\n" + minimum: 1 + maximum: 100000 + default: 100 + source-orb: + title: "Orb Spec" + type: "object" + required: + - "api_key" + - "start_date" + - "sourceType" + properties: + api_key: + type: "string" + title: "Orb API Key" + description: "Orb API Key, issued from the Orb admin console." + airbyte_secret: true + order: 1 + x-speakeasy-param-sensitive: true + start_date: + type: "string" + title: "Start Date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + description: "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." + examples: + - "2022-03-01T00:00:00Z" + order: 2 + end_date: + type: "string" + title: "End Date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + description: "UTC date and time in the format 2022-03-01T00:00:00Z. Any\ + \ data with created_at after this data will not be synced. For Subscription\ + \ Usage, this becomes the `timeframe_start` API parameter." + examples: + - "2024-03-01T00:00:00Z" + order: 3 + lookback_window_days: + type: "integer" + title: "Lookback Window (in days)" + default: 0 + minimum: 0 + description: "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." + order: 4 + string_event_properties_keys: + type: "array" + items: + type: "string" + title: "Event properties keys (string values)" + description: "Property key names to extract from all events, in order to\ + \ enrich ledger entries corresponding to an event deduction." + order: 5 + x-speakeasy-param-sensitive: true + numeric_event_properties_keys: + type: "array" + items: + type: "string" + title: "Event properties keys (numeric values)" + description: "Property key names to extract from all events, in order to\ + \ enrich ledger entries corresponding to an event deduction." + order: 6 + x-speakeasy-param-sensitive: true + subscription_usage_grouping_key: + type: "string" + title: "Subscription usage grouping key (string value)" + description: "Property key name to group subscription usage by." + x-speakeasy-param-sensitive: true + plan_id: + type: "string" + title: "Orb Plan ID for Subscription Usage (string value)" + description: "Orb Plan ID to filter subscriptions that should have usage\ + \ fetched." + sourceType: + title: "orb" + const: "orb" + enum: + - "orb" + order: 0 + type: "string" + source-orb-update: + title: "Orb Spec" + type: "object" + required: + - "api_key" + - "start_date" + properties: + api_key: + type: "string" + title: "Orb API Key" + description: "Orb API Key, issued from the Orb admin console." + airbyte_secret: true + order: 1 + start_date: + type: "string" + title: "Start Date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + description: "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." + examples: + - "2022-03-01T00:00:00Z" + order: 2 + end_date: + type: "string" + title: "End Date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + description: "UTC date and time in the format 2022-03-01T00:00:00Z. Any\ + \ data with created_at after this data will not be synced. For Subscription\ + \ Usage, this becomes the `timeframe_start` API parameter." + examples: + - "2024-03-01T00:00:00Z" + order: 3 + lookback_window_days: + type: "integer" + title: "Lookback Window (in days)" + default: 0 + minimum: 0 + description: "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." + order: 4 + string_event_properties_keys: + type: "array" + items: + type: "string" + title: "Event properties keys (string values)" + description: "Property key names to extract from all events, in order to\ + \ enrich ledger entries corresponding to an event deduction." + order: 5 + numeric_event_properties_keys: + type: "array" + items: + type: "string" + title: "Event properties keys (numeric values)" + description: "Property key names to extract from all events, in order to\ + \ enrich ledger entries corresponding to an event deduction." + order: 6 + subscription_usage_grouping_key: + type: "string" + title: "Subscription usage grouping key (string value)" + description: "Property key name to group subscription usage by." + plan_id: + type: "string" + title: "Orb Plan ID for Subscription Usage (string value)" + description: "Orb Plan ID to filter subscriptions that should have usage\ + \ fetched." + source-sentry: + title: "Sentry Spec" + type: "object" + required: + - "auth_token" + - "organization" + - "project" + - "sourceType" + properties: + auth_token: + type: "string" + title: "Authentication Tokens" + description: "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/\"" + airbyte_secret: true + x-speakeasy-param-sensitive: true + hostname: + type: "string" + title: "Host Name" + description: "Host name of Sentry API server.For self-hosted, specify your\ + \ host name here. Otherwise, leave it empty." + default: "sentry.io" + organization: + type: "string" + title: "Organization" + description: "The slug of the organization the groups belong to." + project: + type: "string" + title: "Project" + description: "The name (slug) of the Project you want to sync." + discover_fields: + type: "array" + item: "string" + title: "Discover Event Fields" + description: "Fields to retrieve when fetching discover events" + sourceType: + title: "sentry" + const: "sentry" + enum: + - "sentry" + order: 0 + type: "string" + source-sentry-update: + title: "Sentry Spec" + type: "object" + required: + - "auth_token" + - "organization" + - "project" + properties: + auth_token: + type: "string" + title: "Authentication Tokens" + description: "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/\"" + airbyte_secret: true + hostname: + type: "string" + title: "Host Name" + description: "Host name of Sentry API server.For self-hosted, specify your\ + \ host name here. Otherwise, leave it empty." + default: "sentry.io" + organization: + type: "string" + title: "Organization" + description: "The slug of the organization the groups belong to." + project: + type: "string" + title: "Project" + description: "The name (slug) of the Project you want to sync." + discover_fields: + type: "array" + item: "string" + title: "Discover Event Fields" + description: "Fields to retrieve when fetching discover events" + source-notion: + title: "Notion Source Spec" + type: "object" + required: + - "credentials" + - "sourceType" + properties: + start_date: + title: "Start Date" + description: "UTC date and time in the format YYYY-MM-DDTHH:MM:SS.000Z.\ + \ During incremental sync, any data generated before this date will not\ + \ be replicated. If left blank, the start date will be set to 2 years\ + \ before the present date." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$" + pattern_descriptor: "YYYY-MM-DDTHH:MM:SS.000Z" + examples: + - "2020-11-16T00:00:00.000Z" + type: "string" + format: "date-time" + credentials: + title: "Authentication Method" + description: "Choose either OAuth (recommended for Airbyte Cloud) or Access\ + \ Token. See our docs\ + \ for more information." + type: "object" + order: 1 + oneOf: + - type: "object" + title: "OAuth2.0" + required: + - "auth_type" + - "client_id" + - "client_secret" + - "access_token" + properties: + auth_type: + type: "string" + const: "OAuth2.0" + enum: + - "OAuth2.0" + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Notion integration. See our docs\ + \ for more information." + airbyte_secret: true + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Notion integration. See our\ + \ docs\ + \ for more information." + airbyte_secret: true + access_token: + title: "Access Token" + type: "string" + description: "The Access Token received by completing the OAuth flow\ + \ for your Notion integration. See our docs\ + \ for more information." + airbyte_secret: true + x-speakeasy-param-sensitive: true + - type: "object" + title: "Access Token" + required: + - "auth_type" + - "token" + properties: + auth_type: + type: "string" + const: "token" + enum: + - "token" + token: + title: "Access Token" + description: "The Access Token for your private Notion integration.\ + \ See the docs\ + \ for more information on how to obtain this token." + type: "string" + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "notion" + const: "notion" + enum: + - "notion" + order: 0 + type: "string" + source-notion-update: + title: "Notion Source Spec" + type: "object" + required: + - "credentials" + properties: + start_date: + title: "Start Date" + description: "UTC date and time in the format YYYY-MM-DDTHH:MM:SS.000Z.\ + \ During incremental sync, any data generated before this date will not\ + \ be replicated. If left blank, the start date will be set to 2 years\ + \ before the present date." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$" + pattern_descriptor: "YYYY-MM-DDTHH:MM:SS.000Z" + examples: + - "2020-11-16T00:00:00.000Z" + type: "string" + format: "date-time" + credentials: + title: "Authentication Method" + description: "Choose either OAuth (recommended for Airbyte Cloud) or Access\ + \ Token. See our docs\ + \ for more information." + type: "object" + order: 1 + oneOf: + - type: "object" + title: "OAuth2.0" + required: + - "auth_type" + - "client_id" + - "client_secret" + - "access_token" + properties: + auth_type: + type: "string" + const: "OAuth2.0" + enum: + - "OAuth2.0" + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Notion integration. See our docs\ + \ for more information." + airbyte_secret: true + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Notion integration. See our\ + \ docs\ + \ for more information." + airbyte_secret: true + access_token: + title: "Access Token" + type: "string" + description: "The Access Token received by completing the OAuth flow\ + \ for your Notion integration. See our docs\ + \ for more information." + airbyte_secret: true + - type: "object" + title: "Access Token" + required: + - "auth_type" + - "token" + properties: + auth_type: + type: "string" + const: "token" + enum: + - "token" + token: + title: "Access Token" + description: "The Access Token for your private Notion integration.\ + \ See the docs\ + \ for more information on how to obtain this token." + type: "string" + airbyte_secret: true + source-trustpilot: + title: "Trustpilot Spec" + type: "object" + required: + - "credentials" + - "business_units" + - "start_date" + - "sourceType" + properties: + credentials: + title: "Authorization Method" + type: "object" + order: 0 + oneOf: + - type: "object" + title: "OAuth 2.0" + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "access_token" + - "token_expiry_date" + properties: + auth_type: + type: "string" + const: "oauth2.0" + enum: + - "oauth2.0" + client_id: + type: "string" + title: "API key" + description: "The API key of the Trustpilot API application. (represents\ + \ the OAuth Client ID)" + airbyte_secret: true + client_secret: + type: "string" + title: "Secret" + description: "The Secret of the Trustpilot API application. (represents\ + \ the OAuth Client Secret)" + airbyte_secret: true + access_token: + type: "string" + title: "Access Token" + description: "Access Token for making authenticated requests." + airbyte_secret: true + x-speakeasy-param-sensitive: true + token_expiry_date: + type: "string" + title: "Token expiry date time" + description: "The date-time when the access token should be refreshed." + format: "date-time" + x-speakeasy-param-sensitive: true + refresh_token: + type: "string" + title: "Refresh token" + description: "The key to refresh the expired access_token." + airbyte_secret: true + x-speakeasy-param-sensitive: true + - type: "object" + title: "API Key" + description: "The API key authentication method gives you access to only\ + \ the streams which are part of the Public API. When you want to get\ + \ streams available via the Consumer API (e.g. the private reviews)\ + \ you need to use authentication method OAuth 2.0." + required: + - "client_id" + properties: + auth_type: + type: "string" + const: "apikey" + enum: + - "apikey" + client_id: + type: "string" + title: "API key" + description: "The API key of the Trustpilot API application." + airbyte_secret: true + business_units: + type: "array" + items: + type: "string" + title: "Business Unit names" + description: "The names of business units which shall be synchronized. Some\ + \ streams e.g. configured_business_units or private_reviews use this configuration." + examples: + - "mydomain.com" + - "www.mydomain.com" + start_date: + type: "string" + title: "Start Date" + description: "For streams with sync. method incremental the start date time\ + \ to be used" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "%Y-%m-%dT%H:%M:%S" + sourceType: + title: "trustpilot" + const: "trustpilot" + enum: + - "trustpilot" + order: 0 + type: "string" + source-trustpilot-update: + title: "Trustpilot Spec" + type: "object" + required: + - "credentials" + - "business_units" + - "start_date" + properties: + credentials: + title: "Authorization Method" + type: "object" + order: 0 + oneOf: + - type: "object" + title: "OAuth 2.0" + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "access_token" + - "token_expiry_date" + properties: + auth_type: + type: "string" + const: "oauth2.0" + enum: + - "oauth2.0" + client_id: + type: "string" + title: "API key" + description: "The API key of the Trustpilot API application. (represents\ + \ the OAuth Client ID)" + airbyte_secret: true + client_secret: + type: "string" + title: "Secret" + description: "The Secret of the Trustpilot API application. (represents\ + \ the OAuth Client Secret)" + airbyte_secret: true + access_token: + type: "string" + title: "Access Token" + description: "Access Token for making authenticated requests." + airbyte_secret: true + token_expiry_date: + type: "string" + title: "Token expiry date time" + description: "The date-time when the access token should be refreshed." + format: "date-time" + refresh_token: + type: "string" + title: "Refresh token" + description: "The key to refresh the expired access_token." + airbyte_secret: true + - type: "object" + title: "API Key" + description: "The API key authentication method gives you access to only\ + \ the streams which are part of the Public API. When you want to get\ + \ streams available via the Consumer API (e.g. the private reviews)\ + \ you need to use authentication method OAuth 2.0." + required: + - "client_id" + properties: + auth_type: + type: "string" + const: "apikey" + enum: + - "apikey" + client_id: + type: "string" + title: "API key" + description: "The API key of the Trustpilot API application." + airbyte_secret: true + business_units: + type: "array" + items: + type: "string" + title: "Business Unit names" + description: "The names of business units which shall be synchronized. Some\ + \ streams e.g. configured_business_units or private_reviews use this configuration." + examples: + - "mydomain.com" + - "www.mydomain.com" + start_date: + type: "string" + title: "Start Date" + description: "For streams with sync. method incremental the start date time\ + \ to be used" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "%Y-%m-%dT%H:%M:%S" + source-google-webfonts: + title: "Google Webfonts Spec" + type: "object" + required: + - "api_key" + - "sourceType" + properties: + api_key: + type: "string" + description: "API key is required to access google apis, For getting your's\ + \ goto google console and generate api key for Webfonts" + airbyte_secret: true + x-speakeasy-param-sensitive: true + sort: + type: "string" + description: "Optional, to find how to sort" + prettyPrint: + type: "string" + description: "Optional, boolean type" + alt: + type: "string" + description: "Optional, Available params- json, media, proto" + sourceType: + title: "google-webfonts" + const: "google-webfonts" + enum: + - "google-webfonts" + order: 0 + type: "string" + source-google-webfonts-update: + title: "Google Webfonts Spec" + type: "object" + required: + - "api_key" + properties: + api_key: + type: "string" + description: "API key is required to access google apis, For getting your's\ + \ goto google console and generate api key for Webfonts" + airbyte_secret: true + sort: + type: "string" + description: "Optional, to find how to sort" + prettyPrint: + type: "string" + description: "Optional, boolean type" + alt: + type: "string" + description: "Optional, Available params- json, media, proto" + source-pypi: + title: "Pypi Spec" + type: "object" + required: + - "project_name" + - "sourceType" + properties: + project_name: + type: "string" + title: "PyPI Package" + description: "Name of the project/package. Can only be in lowercase with\ + \ hyphen. This is the name used using pip command for installing the package." + examples: + - "sampleproject" + version: + title: "Package Version" + type: "string" + description: "Version of the project/package. Use it to find a particular\ + \ release instead of all releases." + examples: + - "1.2.0" + sourceType: + title: "pypi" + const: "pypi" + enum: + - "pypi" + order: 0 + type: "string" + source-pypi-update: + title: "Pypi Spec" + type: "object" + required: + - "project_name" + properties: + project_name: + type: "string" + title: "PyPI Package" + description: "Name of the project/package. Can only be in lowercase with\ + \ hyphen. This is the name used using pip command for installing the package." + examples: + - "sampleproject" + version: + title: "Package Version" + type: "string" + description: "Version of the project/package. Use it to find a particular\ + \ release instead of all releases." + examples: + - "1.2.0" + source-slack: + title: "Slack Spec" + type: "object" + required: + - "start_date" + - "lookback_window" + - "join_channels" + - "sourceType" + properties: + start_date: + type: "string" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + examples: + - "2017-01-25T00:00:00Z" + title: "Start Date" + format: "date-time" + lookback_window: + type: "integer" + title: "Threads Lookback window (Days)" + description: "How far into the past to look for messages in threads, default\ + \ is 0 days" + examples: + - 7 + - 14 + minimum: 0 + default: 0 + maximum: 365 + join_channels: + type: "boolean" + default: true + title: "Join all channels" + description: "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. " + channel_filter: + type: "array" + default: [] + items: + type: "string" + minLength: 0 + title: "Channel name filter" + description: "A channel name list (without leading '#' char) which limit\ + \ the channels from which you'd like to sync. Empty list means no filter." + examples: + - "channel_one" + - "channel_two" + credentials: + title: "Authentication mechanism" + description: "Choose how to authenticate into Slack" + type: "object" + oneOf: + - type: "object" + title: "Sign in via Slack (OAuth)" + required: + - "option_title" + - "client_id" + - "client_secret" + - "access_token" + properties: + option_title: + type: "string" + const: "Default OAuth2.0 authorization" + enum: + - "Default OAuth2.0 authorization" + client_id: + type: "string" + title: "Client ID" + description: "Slack client_id. See our docs if you need help finding this id." + client_secret: + type: "string" + title: "Client Secret" + description: "Slack client_secret. See our docs if you need help finding this secret." + airbyte_secret: true + access_token: + type: "string" + title: "Access token" + description: "Slack access_token. See our docs if you need help generating the token." + airbyte_secret: true + x-speakeasy-param-sensitive: true + order: 0 + - type: "object" + title: "API Token" + required: + - "option_title" + - "api_token" + properties: + option_title: + type: "string" + const: "API Token Credentials" + enum: + - "API Token Credentials" + api_token: + type: "string" + title: "API Token" + description: "A Slack bot token. See the docs for instructions on how to generate it." + airbyte_secret: true + x-speakeasy-param-sensitive: true + order: 1 + sourceType: + title: "slack" + const: "slack" + enum: + - "slack" + order: 0 + type: "string" + source-slack-update: + title: "Slack Spec" + type: "object" + required: + - "start_date" + - "lookback_window" + - "join_channels" + properties: + start_date: + type: "string" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + examples: + - "2017-01-25T00:00:00Z" + title: "Start Date" + format: "date-time" + lookback_window: + type: "integer" + title: "Threads Lookback window (Days)" + description: "How far into the past to look for messages in threads, default\ + \ is 0 days" + examples: + - 7 + - 14 + minimum: 0 + default: 0 + maximum: 365 + join_channels: + type: "boolean" + default: true + title: "Join all channels" + description: "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. " + channel_filter: + type: "array" + default: [] + items: + type: "string" + minLength: 0 + title: "Channel name filter" + description: "A channel name list (without leading '#' char) which limit\ + \ the channels from which you'd like to sync. Empty list means no filter." + examples: + - "channel_one" + - "channel_two" + credentials: + title: "Authentication mechanism" + description: "Choose how to authenticate into Slack" + type: "object" + oneOf: + - type: "object" + title: "Sign in via Slack (OAuth)" + required: + - "option_title" + - "client_id" + - "client_secret" + - "access_token" + properties: + option_title: + type: "string" + const: "Default OAuth2.0 authorization" + enum: + - "Default OAuth2.0 authorization" + client_id: + type: "string" + title: "Client ID" + description: "Slack client_id. See our docs if you need help finding this id." + client_secret: + type: "string" + title: "Client Secret" + description: "Slack client_secret. See our docs if you need help finding this secret." + airbyte_secret: true + access_token: + type: "string" + title: "Access token" + description: "Slack access_token. See our docs if you need help generating the token." + airbyte_secret: true + order: 0 + - type: "object" + title: "API Token" + required: + - "option_title" + - "api_token" + properties: + option_title: + type: "string" + const: "API Token Credentials" + enum: + - "API Token Credentials" + api_token: + type: "string" + title: "API Token" + description: "A Slack bot token. See the docs for instructions on how to generate it." + airbyte_secret: true + order: 1 + source-file: + title: "File Source Spec" + type: "object" + required: + - "dataset_name" + - "format" + - "url" + - "provider" + - "sourceType" + properties: + dataset_name: + type: "string" + title: "Dataset Name" + description: "The Name of the final table to replicate this file into (should\ + \ include letters, numbers dash and underscores only)." + format: + type: "string" + enum: + - "csv" + - "json" + - "jsonl" + - "excel" + - "excel_binary" + - "fwf" + - "feather" + - "parquet" + - "yaml" + default: "csv" + title: "File Format" + description: "The Format of the file which should be replicated (Warning:\ + \ some formats may be experimental, please refer to the docs)." + reader_options: + type: "string" + title: "Reader Options" + description: "This should be a string in JSON format. It depends on the\ + \ chosen file format to provide additional options and tune its behavior." + examples: + - "{}" + - "{\"sep\": \" \"}" + - "{\"sep\": \"\t\", \"header\": 0, \"names\": [\"column1\", \"column2\"\ + ] }" + url: + type: "string" + title: "URL" + description: "The URL path to access the file which should be replicated." + examples: + - "https://storage.googleapis.com/covid19-open-data/v2/latest/epidemiology.csv" + - "gs://my-google-bucket/data.csv" + - "s3://gdelt-open-data/events/20190914.export.csv" + provider: + type: "object" + title: "Storage Provider" + description: "The storage Provider or Location of the file(s) which should\ + \ be replicated." + default: "Public Web" + oneOf: + - title: "HTTPS: Public Web" + required: + - "storage" + properties: + storage: + type: "string" + const: "HTTPS" + enum: + - "HTTPS" + user_agent: + type: "boolean" + title: "User-Agent" + default: false + description: "Add User-Agent to request" + - title: "GCS: Google Cloud Storage" + required: + - "storage" + properties: + storage: + type: "string" + title: "Storage" + const: "GCS" + enum: + - "GCS" + service_account_json: + type: "string" + title: "Service Account JSON" + airbyte_secret: true + description: "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." + - title: "S3: Amazon Web Services" + required: + - "storage" + properties: + storage: + type: "string" + title: "Storage" + const: "S3" + enum: + - "S3" + aws_access_key_id: + type: "string" + title: "AWS Access Key ID" + description: "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." + x-speakeasy-param-sensitive: true + aws_secret_access_key: + type: "string" + title: "AWS Secret Access Key" + description: "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." + airbyte_secret: true + x-speakeasy-param-sensitive: true + - title: "AzBlob: Azure Blob Storage" + required: + - "storage" + - "storage_account" + properties: + storage: + type: "string" + title: "Storage" + const: "AzBlob" + enum: + - "AzBlob" + storage_account: + type: "string" + title: "Storage Account" + description: "The globally unique name of the storage account that\ + \ the desired blob sits within. See here for more details." + sas_token: + type: "string" + title: "SAS Token" + description: "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." + airbyte_secret: true + x-speakeasy-param-sensitive: true + shared_key: + type: "string" + title: "Shared Key" + description: "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." + airbyte_secret: true + x-speakeasy-param-sensitive: true + - title: "SSH: Secure Shell" + required: + - "storage" + - "user" + - "host" + properties: + storage: + type: "string" + title: "Storage" + const: "SSH" + enum: + - "SSH" + user: + type: "string" + title: "User" + description: "" + password: + type: "string" + title: "Password" + description: "" + airbyte_secret: true + x-speakeasy-param-sensitive: true + host: + type: "string" + title: "Host" + description: "" + port: + type: "string" + title: "Port" + default: "22" + description: "" + - title: "SCP: Secure copy protocol" + required: + - "storage" + - "user" + - "host" + properties: + storage: + type: "string" + title: "Storage" + const: "SCP" + enum: + - "SCP" + user: + type: "string" + title: "User" + description: "" + password: + type: "string" + title: "Password" + description: "" + airbyte_secret: true + x-speakeasy-param-sensitive: true + host: + type: "string" + title: "Host" + description: "" + port: + type: "string" + title: "Port" + default: "22" + description: "" + - title: "SFTP: Secure File Transfer Protocol" + required: + - "storage" + - "user" + - "host" + properties: + storage: + type: "string" + title: "Storage" + const: "SFTP" + enum: + - "SFTP" + user: + type: "string" + title: "User" + description: "" + password: + type: "string" + title: "Password" + description: "" + airbyte_secret: true + x-speakeasy-param-sensitive: true + host: + type: "string" + title: "Host" + description: "" + port: + type: "string" + title: "Port" + default: "22" + description: "" + sourceType: + title: "file" + const: "file" + enum: + - "file" + order: 0 + type: "string" + source-file-update: + title: "File Source Spec" + type: "object" + required: + - "dataset_name" + - "format" + - "url" + - "provider" + properties: + dataset_name: + type: "string" + title: "Dataset Name" + description: "The Name of the final table to replicate this file into (should\ + \ include letters, numbers dash and underscores only)." + format: + type: "string" + enum: + - "csv" + - "json" + - "jsonl" + - "excel" + - "excel_binary" + - "fwf" + - "feather" + - "parquet" + - "yaml" + default: "csv" + title: "File Format" + description: "The Format of the file which should be replicated (Warning:\ + \ some formats may be experimental, please refer to the docs)." + reader_options: + type: "string" + title: "Reader Options" + description: "This should be a string in JSON format. It depends on the\ + \ chosen file format to provide additional options and tune its behavior." + examples: + - "{}" + - "{\"sep\": \" \"}" + - "{\"sep\": \"\t\", \"header\": 0, \"names\": [\"column1\", \"column2\"\ + ] }" + url: + type: "string" + title: "URL" + description: "The URL path to access the file which should be replicated." + examples: + - "https://storage.googleapis.com/covid19-open-data/v2/latest/epidemiology.csv" + - "gs://my-google-bucket/data.csv" + - "s3://gdelt-open-data/events/20190914.export.csv" + provider: + type: "object" + title: "Storage Provider" + description: "The storage Provider or Location of the file(s) which should\ + \ be replicated." + default: "Public Web" + oneOf: + - title: "HTTPS: Public Web" + required: + - "storage" + properties: + storage: + type: "string" + const: "HTTPS" + enum: + - "HTTPS" + user_agent: + type: "boolean" + title: "User-Agent" + default: false + description: "Add User-Agent to request" + - title: "GCS: Google Cloud Storage" + required: + - "storage" + properties: + storage: + type: "string" + title: "Storage" + const: "GCS" + enum: + - "GCS" + service_account_json: + type: "string" + title: "Service Account JSON" + airbyte_secret: true + description: "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." + - title: "S3: Amazon Web Services" + required: + - "storage" + properties: + storage: + type: "string" + title: "Storage" + const: "S3" + enum: + - "S3" + aws_access_key_id: + type: "string" + title: "AWS Access Key ID" + description: "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: + type: "string" + title: "AWS Secret Access Key" + description: "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." + airbyte_secret: true + - title: "AzBlob: Azure Blob Storage" + required: + - "storage" + - "storage_account" + properties: + storage: + type: "string" + title: "Storage" + const: "AzBlob" + enum: + - "AzBlob" + storage_account: + type: "string" + title: "Storage Account" + description: "The globally unique name of the storage account that\ + \ the desired blob sits within. See here for more details." + sas_token: + type: "string" + title: "SAS Token" + description: "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." + airbyte_secret: true + shared_key: + type: "string" + title: "Shared Key" + description: "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." + airbyte_secret: true + - title: "SSH: Secure Shell" + required: + - "storage" + - "user" + - "host" + properties: + storage: + type: "string" + title: "Storage" + const: "SSH" + enum: + - "SSH" + user: + type: "string" + title: "User" + description: "" + password: + type: "string" + title: "Password" + description: "" + airbyte_secret: true + host: + type: "string" + title: "Host" + description: "" + port: + type: "string" + title: "Port" + default: "22" + description: "" + - title: "SCP: Secure copy protocol" + required: + - "storage" + - "user" + - "host" + properties: + storage: + type: "string" + title: "Storage" + const: "SCP" + enum: + - "SCP" + user: + type: "string" + title: "User" + description: "" + password: + type: "string" + title: "Password" + description: "" + airbyte_secret: true + host: + type: "string" + title: "Host" + description: "" + port: + type: "string" + title: "Port" + default: "22" + description: "" + - title: "SFTP: Secure File Transfer Protocol" + required: + - "storage" + - "user" + - "host" + properties: + storage: + type: "string" + title: "Storage" + const: "SFTP" + enum: + - "SFTP" + user: + type: "string" + title: "User" + description: "" + password: + type: "string" + title: "Password" + description: "" + airbyte_secret: true + host: + type: "string" + title: "Host" + description: "" + port: + type: "string" + title: "Port" + default: "22" + description: "" + source-lokalise: + title: "Lokalise Spec" + type: "object" + required: + - "api_key" + - "project_id" + - "sourceType" + properties: + api_key: + title: "API Key" + type: "string" + description: "Lokalise API Key with read-access. Available at Profile settings\ + \ > API tokens. See here." + airbyte_secret: true + x-speakeasy-param-sensitive: true + project_id: + title: "Project Id" + type: "string" + description: "Lokalise project ID. Available at Project Settings > General." + sourceType: + title: "lokalise" + const: "lokalise" + enum: + - "lokalise" + order: 0 + type: "string" + source-lokalise-update: + title: "Lokalise Spec" + type: "object" + required: + - "api_key" + - "project_id" + properties: + api_key: + title: "API Key" + type: "string" + description: "Lokalise API Key with read-access. Available at Profile settings\ + \ > API tokens. See here." + airbyte_secret: true + project_id: + title: "Project Id" + type: "string" + description: "Lokalise project ID. Available at Project Settings > General." + source-zoho-crm: + title: "Zoho Crm Configuration" + type: "object" + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "environment" + - "dc_region" + - "edition" + - "sourceType" + properties: + client_id: + type: "string" + title: "Client ID" + description: "OAuth2.0 Client ID" + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "OAuth2.0 Client Secret" + airbyte_secret: true + refresh_token: + type: "string" + title: "Refresh Token" + description: "OAuth2.0 Refresh Token" + airbyte_secret: true + x-speakeasy-param-sensitive: true + dc_region: + title: "Data Center Location" + type: "string" + description: "Please choose the region of your Data Center location. More\ + \ info by this Link" + enum: + - "US" + - "AU" + - "EU" + - "IN" + - "CN" + - "JP" + environment: + title: "Environment" + type: "string" + description: "Please choose the environment" + enum: + - "Production" + - "Developer" + - "Sandbox" + start_datetime: + title: "Start Date" + type: + - "string" + - "null" + examples: + - "2000-01-01" + - "2000-01-01 13:00" + - "2000-01-01 13:00:00" + - "2000-01-01T13:00+00:00" + - "2000-01-01T13:00:00-07:00" + description: "ISO 8601, for instance: `YYYY-MM-DD`, `YYYY-MM-DD HH:MM:SS+HH:MM`" + format: "date-time" + edition: + title: "Zoho CRM Edition" + type: "string" + description: "Choose your Edition of Zoho CRM to determine API Concurrency\ + \ Limits" + enum: + - "Free" + - "Standard" + - "Professional" + - "Enterprise" + - "Ultimate" + default: "Free" + sourceType: + title: "zoho-crm" + const: "zoho-crm" + enum: + - "zoho-crm" + order: 0 + type: "string" + source-zoho-crm-update: + title: "Zoho Crm Configuration" + type: "object" + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "environment" + - "dc_region" + - "edition" + properties: + client_id: + type: "string" + title: "Client ID" + description: "OAuth2.0 Client ID" + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "OAuth2.0 Client Secret" + airbyte_secret: true + refresh_token: + type: "string" + title: "Refresh Token" + description: "OAuth2.0 Refresh Token" + airbyte_secret: true + dc_region: + title: "Data Center Location" + type: "string" + description: "Please choose the region of your Data Center location. More\ + \ info by this Link" + enum: + - "US" + - "AU" + - "EU" + - "IN" + - "CN" + - "JP" + environment: + title: "Environment" + type: "string" + description: "Please choose the environment" + enum: + - "Production" + - "Developer" + - "Sandbox" + start_datetime: + title: "Start Date" + type: + - "string" + - "null" + examples: + - "2000-01-01" + - "2000-01-01 13:00" + - "2000-01-01 13:00:00" + - "2000-01-01T13:00+00:00" + - "2000-01-01T13:00:00-07:00" + description: "ISO 8601, for instance: `YYYY-MM-DD`, `YYYY-MM-DD HH:MM:SS+HH:MM`" + format: "date-time" + edition: + title: "Zoho CRM Edition" + type: "string" + description: "Choose your Edition of Zoho CRM to determine API Concurrency\ + \ Limits" + enum: + - "Free" + - "Standard" + - "Professional" + - "Enterprise" + - "Ultimate" + default: "Free" + source-gainsight-px: + title: "Gainsight Px Spec" + type: "object" + required: + - "api_key" + - "sourceType" + properties: + api_key: + title: "API Key" + type: "string" + description: "The Aptrinsic API Key which is recieved from the dashboard\ + \ settings (ref - https://app.aptrinsic.com/settings/api-keys)" + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "gainsight-px" + const: "gainsight-px" + enum: + - "gainsight-px" + order: 0 + type: "string" + source-gainsight-px-update: + title: "Gainsight Px Spec" + type: "object" + required: + - "api_key" + properties: + api_key: + title: "API Key" + type: "string" + description: "The Aptrinsic API Key which is recieved from the dashboard\ + \ settings (ref - https://app.aptrinsic.com/settings/api-keys)" + airbyte_secret: true + source-stripe: + title: "Stripe Source Spec" + type: "object" + required: + - "client_secret" + - "account_id" + - "sourceType" + properties: + account_id: + type: "string" + title: "Account ID" + description: "Your Stripe account ID (starts with 'acct_', find yours here)." + order: 0 + client_secret: + type: "string" + title: "Secret Key" + description: "Stripe API key (usually starts with 'sk_live_'; find yours\ + \ here)." + airbyte_secret: true + order: 1 + start_date: + type: "string" + title: "Replication start date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Only\ + \ data generated after this date will be replicated." + default: "2017-01-25T00:00:00Z" + examples: + - "2017-01-25T00:00:00Z" + format: "date-time" + order: 2 + lookback_window_days: + type: "integer" + title: "Lookback Window in days" + default: 0 + minimum: 0 + description: "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" + order: 3 + slice_range: + type: "integer" + title: "Data request time increment in days" + default: 365 + minimum: 1 + examples: + - 1 + - 3 + - 10 + - 30 + - 180 + - 360 + description: "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." + order: 4 + num_workers: + type: "integer" + title: "Number of concurrent workers" + minimum: 1 + maximum: 20 + default: 10 + examples: + - 1 + - 2 + - 3 + description: "The number of worker thread to use for the sync. The performance\ + \ upper boundary depends on call_rate_limit setting and type of account." + order: 5 + call_rate_limit: + type: "integer" + title: "Max number of API calls per second" + examples: + - 25 + - 100 + description: "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." + sourceType: + title: "stripe" + const: "stripe" + enum: + - "stripe" + order: 0 + type: "string" + source-stripe-update: + title: "Stripe Source Spec" + type: "object" + required: + - "client_secret" + - "account_id" + properties: + account_id: + type: "string" + title: "Account ID" + description: "Your Stripe account ID (starts with 'acct_', find yours here)." + order: 0 + client_secret: + type: "string" + title: "Secret Key" + description: "Stripe API key (usually starts with 'sk_live_'; find yours\ + \ here)." + airbyte_secret: true + order: 1 + start_date: + type: "string" + title: "Replication start date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Only\ + \ data generated after this date will be replicated." + default: "2017-01-25T00:00:00Z" + examples: + - "2017-01-25T00:00:00Z" + format: "date-time" + order: 2 + lookback_window_days: + type: "integer" + title: "Lookback Window in days" + default: 0 + minimum: 0 + description: "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" + order: 3 + slice_range: + type: "integer" + title: "Data request time increment in days" + default: 365 + minimum: 1 + examples: + - 1 + - 3 + - 10 + - 30 + - 180 + - 360 + description: "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." + order: 4 + num_workers: + type: "integer" + title: "Number of concurrent workers" + minimum: 1 + maximum: 20 + default: 10 + examples: + - 1 + - 2 + - 3 + description: "The number of worker thread to use for the sync. The performance\ + \ upper boundary depends on call_rate_limit setting and type of account." + order: 5 + call_rate_limit: + type: "integer" + title: "Max number of API calls per second" + examples: + - 25 + - 100 + description: "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." + source-youtube-analytics: + title: "YouTube Analytics Spec" + type: "object" + required: + - "credentials" + - "sourceType" + properties: + credentials: + title: "Authenticate via OAuth 2.0" + type: "object" + required: + - "client_id" + - "client_secret" + - "refresh_token" + additionalProperties: true + properties: + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your developer application" + airbyte_secret: true + client_secret: + title: "Client Secret" + type: "string" + description: "The client secret of your developer application" + airbyte_secret: true + refresh_token: + title: "Refresh Token" + type: "string" + description: "A refresh token generated using the above client ID and\ + \ secret" + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "youtube-analytics" + const: "youtube-analytics" + enum: + - "youtube-analytics" + order: 0 + type: "string" + source-youtube-analytics-update: + title: "YouTube Analytics Spec" + type: "object" + required: + - "credentials" + properties: + credentials: + title: "Authenticate via OAuth 2.0" + type: "object" + required: + - "client_id" + - "client_secret" + - "refresh_token" + additionalProperties: true + properties: + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your developer application" + airbyte_secret: true + client_secret: + title: "Client Secret" + type: "string" + description: "The client secret of your developer application" + airbyte_secret: true + refresh_token: + title: "Refresh Token" + type: "string" + description: "A refresh token generated using the above client ID and\ + \ secret" + airbyte_secret: true + source-google-sheets: + title: "Google Sheets Source Spec" + type: "object" + required: + - "spreadsheet_id" + - "credentials" + - "sourceType" + properties: + spreadsheet_id: + type: "string" + title: "Spreadsheet Link" + description: "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'." + examples: + - "https://docs.google.com/spreadsheets/d/1hLd9Qqti3UyLXZB2aFfUWDT7BG-arw2xy4HR3D-dwUb/edit" + names_conversion: + type: "boolean" + title: "Convert Column Names to SQL-Compliant Format" + description: "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." + default: false + credentials: + type: "object" + title: "Authentication" + description: "Credentials for connecting to the Google Sheets API" + oneOf: + - title: "Authenticate via Google (OAuth)" + type: "object" + required: + - "auth_type" + - "client_id" + - "client_secret" + - "refresh_token" + properties: + auth_type: + type: "string" + const: "Client" + enum: + - "Client" + client_id: + title: "Client ID" + type: "string" + description: "Enter your Google application's Client ID. See Google's\ + \ documentation for more information." + airbyte_secret: true + client_secret: + title: "Client Secret" + type: "string" + description: "Enter your Google application's Client Secret. See Google's\ + \ documentation for more information." + airbyte_secret: true + refresh_token: + title: "Refresh Token" + type: "string" + description: "Enter your Google application's refresh token. See Google's\ + \ documentation for more information." + airbyte_secret: true + x-speakeasy-param-sensitive: true + - title: "Service Account Key Authentication" + type: "object" + required: + - "auth_type" + - "service_account_info" + properties: + auth_type: + type: "string" + const: "Service" + enum: + - "Service" + service_account_info: + type: "string" + title: "Service Account Information." + description: "The JSON key of the service account to use for authorization.\ + \ Read more here." + airbyte_secret: true + examples: + - "{ \"type\": \"service_account\", \"project_id\": YOUR_PROJECT_ID,\ + \ \"private_key_id\": YOUR_PRIVATE_KEY, ... }" + sourceType: + title: "google-sheets" + const: "google-sheets" + enum: + - "google-sheets" + order: 0 + type: "string" + source-google-sheets-update: + title: "Google Sheets Source Spec" + type: "object" + required: + - "spreadsheet_id" + - "credentials" + properties: + spreadsheet_id: + type: "string" + title: "Spreadsheet Link" + description: "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'." + examples: + - "https://docs.google.com/spreadsheets/d/1hLd9Qqti3UyLXZB2aFfUWDT7BG-arw2xy4HR3D-dwUb/edit" + names_conversion: + type: "boolean" + title: "Convert Column Names to SQL-Compliant Format" + description: "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." + default: false + credentials: + type: "object" + title: "Authentication" + description: "Credentials for connecting to the Google Sheets API" + oneOf: + - title: "Authenticate via Google (OAuth)" + type: "object" + required: + - "auth_type" + - "client_id" + - "client_secret" + - "refresh_token" + properties: + auth_type: + type: "string" + const: "Client" + enum: + - "Client" + client_id: + title: "Client ID" + type: "string" + description: "Enter your Google application's Client ID. See Google's\ + \ documentation for more information." + airbyte_secret: true + client_secret: + title: "Client Secret" + type: "string" + description: "Enter your Google application's Client Secret. See Google's\ + \ documentation for more information." + airbyte_secret: true + refresh_token: + title: "Refresh Token" + type: "string" + description: "Enter your Google application's refresh token. See Google's\ + \ documentation for more information." + airbyte_secret: true + - title: "Service Account Key Authentication" + type: "object" + required: + - "auth_type" + - "service_account_info" + properties: + auth_type: + type: "string" + const: "Service" + enum: + - "Service" + service_account_info: + type: "string" + title: "Service Account Information." + description: "The JSON key of the service account to use for authorization.\ + \ Read more here." + airbyte_secret: true + examples: + - "{ \"type\": \"service_account\", \"project_id\": YOUR_PROJECT_ID,\ + \ \"private_key_id\": YOUR_PRIVATE_KEY, ... }" + source-zendesk-talk: + title: "Source Zendesk Talk Spec" + type: "object" + required: + - "start_date" + - "subdomain" + - "sourceType" + properties: + subdomain: + type: "string" + title: "Subdomain" + order: 0 + description: "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: + title: "Authentication" + type: "object" + order: 1 + description: "Zendesk service provides two authentication methods. Choose\ + \ between: `OAuth2.0` or `API token`." + oneOf: + - title: "OAuth2.0" + type: "object" + required: + - "access_token" + additionalProperties: true + properties: + auth_type: + type: "string" + const: "oauth2.0" + order: 0 + enum: + - "oauth2.0" + access_token: + type: "string" + title: "Access Token" + description: "The value of the API token generated. See the docs\ + \ for more information." + airbyte_secret: true + x-speakeasy-param-sensitive: true + client_id: + type: "string" + title: "Client ID" + description: "Client ID" + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "Client Secret" + airbyte_secret: true + - title: "API Token" + type: "object" + required: + - "email" + - "api_token" + additionalProperties: true + properties: + auth_type: + type: "string" + const: "api_token" + enum: + - "api_token" + email: + title: "Email" + type: "string" + description: "The user email for your Zendesk account." + api_token: + title: "API Token" + type: "string" + description: "The value of the API token generated. See the docs\ + \ for more information." + airbyte_secret: true + x-speakeasy-param-sensitive: true + start_date: + type: "string" + title: "Start Date" + order: 2 + description: "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." + examples: + - "2020-10-15T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + format: "date-time" + sourceType: + title: "zendesk-talk" + const: "zendesk-talk" + enum: + - "zendesk-talk" + order: 0 + type: "string" + source-zendesk-talk-update: + title: "Source Zendesk Talk Spec" + type: "object" + required: + - "start_date" + - "subdomain" + properties: + subdomain: + type: "string" + title: "Subdomain" + order: 0 + description: "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: + title: "Authentication" + type: "object" + order: 1 + description: "Zendesk service provides two authentication methods. Choose\ + \ between: `OAuth2.0` or `API token`." + oneOf: + - title: "OAuth2.0" + type: "object" + required: + - "access_token" + additionalProperties: true + properties: + auth_type: + type: "string" + const: "oauth2.0" + order: 0 + enum: + - "oauth2.0" + access_token: + type: "string" + title: "Access Token" + description: "The value of the API token generated. See the docs\ + \ for more information." + airbyte_secret: true + client_id: + type: "string" + title: "Client ID" + description: "Client ID" + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "Client Secret" + airbyte_secret: true + - title: "API Token" + type: "object" + required: + - "email" + - "api_token" + additionalProperties: true + properties: + auth_type: + type: "string" + const: "api_token" + enum: + - "api_token" + email: + title: "Email" + type: "string" + description: "The user email for your Zendesk account." + api_token: + title: "API Token" + type: "string" + description: "The value of the API token generated. See the docs\ + \ for more information." + airbyte_secret: true + start_date: + type: "string" + title: "Start Date" + order: 2 + description: "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." + examples: + - "2020-10-15T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + format: "date-time" + source-freshdesk: + type: "object" + required: + - "api_key" + - "domain" + - "sourceType" + properties: + api_key: + type: "string" + order: 1 + title: "API Key" + description: "Freshdesk API Key. See the docs for more information on how to obtain this key." + airbyte_secret: true + x-speakeasy-param-sensitive: true + domain: + type: "string" + order: 2 + title: "Domain" + description: "Freshdesk domain" + examples: + - "myaccount.freshdesk.com" + pattern: "^[a-zA-Z0-9._-]*\\.freshdesk\\.com$" + requests_per_minute: + type: "integer" + order: 3 + title: "Requests per minute" + description: "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." + start_date: + title: "Start Date" + type: "string" + order: 4 + description: "UTC date and time. Any data created after this date will be\ + \ replicated. If this parameter is not set, all data will be replicated." + format: "date-time" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2020-12-01T00:00:00Z" + lookback_window_in_days: + type: "integer" + order: 5 + title: "Lookback Window" + default: 14 + description: "Number of days for lookback window for the stream Satisfaction\ + \ Ratings" + sourceType: + title: "freshdesk" + const: "freshdesk" + enum: + - "freshdesk" + order: 0 + type: "string" + source-freshdesk-update: + type: "object" + required: + - "api_key" + - "domain" + properties: + api_key: + type: "string" + order: 1 + title: "API Key" + description: "Freshdesk API Key. See the docs for more information on how to obtain this key." + airbyte_secret: true + domain: + type: "string" + order: 2 + title: "Domain" + description: "Freshdesk domain" + examples: + - "myaccount.freshdesk.com" + pattern: "^[a-zA-Z0-9._-]*\\.freshdesk\\.com$" + requests_per_minute: + type: "integer" + order: 3 + title: "Requests per minute" + description: "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." + start_date: + title: "Start Date" + type: "string" + order: 4 + description: "UTC date and time. Any data created after this date will be\ + \ replicated. If this parameter is not set, all data will be replicated." + format: "date-time" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2020-12-01T00:00:00Z" + lookback_window_in_days: + type: "integer" + order: 5 + title: "Lookback Window" + default: 14 + description: "Number of days for lookback window for the stream Satisfaction\ + \ Ratings" + source-asana: + title: "Asana Spec" + type: "object" + properties: + credentials: + title: "Authentication mechanism" + description: "Choose how to authenticate to Github" + type: "object" + oneOf: + - type: "object" + title: "Authenticate via Asana (Oauth)" + required: + - "client_id" + - "client_secret" + - "refresh_token" + properties: + option_title: + type: "string" + title: "Credentials title" + description: "OAuth Credentials" + const: "OAuth Credentials" + enum: + - "OAuth Credentials" + client_id: + type: "string" + title: "" + description: "" + airbyte_secret: true + client_secret: + type: "string" + title: "" + description: "" + airbyte_secret: true + refresh_token: + type: "string" + title: "" + description: "" + airbyte_secret: true + x-speakeasy-param-sensitive: true + - type: "object" + title: "Authenticate with Personal Access Token" + required: + - "personal_access_token" + properties: + option_title: + type: "string" + title: "Credentials title" + description: "PAT Credentials" + const: "PAT Credentials" + enum: + - "PAT Credentials" + personal_access_token: + type: "string" + title: "Personal Access Token" + description: "Asana Personal Access Token (generate yours here)." + airbyte_secret: true + x-speakeasy-param-sensitive: true + test_mode: + type: "boolean" + title: "Test Mode" + description: "This flag is used for testing purposes for certain streams\ + \ that return a lot of data. This flag is not meant to be enabled for\ + \ prod." + airbyte_hidden: true + organization_export_ids: + title: "Organization Export IDs" + description: "Globally unique identifiers for the organization exports" + type: "array" + sourceType: + title: "asana" + const: "asana" + enum: + - "asana" + order: 0 + type: "string" + source-asana-update: + title: "Asana Spec" + type: "object" + properties: + credentials: + title: "Authentication mechanism" + description: "Choose how to authenticate to Github" + type: "object" + oneOf: + - type: "object" + title: "Authenticate via Asana (Oauth)" + required: + - "client_id" + - "client_secret" + - "refresh_token" + properties: + option_title: + type: "string" + title: "Credentials title" + description: "OAuth Credentials" + const: "OAuth Credentials" + enum: + - "OAuth Credentials" + client_id: + type: "string" + title: "" + description: "" + airbyte_secret: true + client_secret: + type: "string" + title: "" + description: "" + airbyte_secret: true + refresh_token: + type: "string" + title: "" + description: "" + airbyte_secret: true + - type: "object" + title: "Authenticate with Personal Access Token" + required: + - "personal_access_token" + properties: + option_title: + type: "string" + title: "Credentials title" + description: "PAT Credentials" + const: "PAT Credentials" + enum: + - "PAT Credentials" + personal_access_token: + type: "string" + title: "Personal Access Token" + description: "Asana Personal Access Token (generate yours here)." + airbyte_secret: true + test_mode: + type: "boolean" + title: "Test Mode" + description: "This flag is used for testing purposes for certain streams\ + \ that return a lot of data. This flag is not meant to be enabled for\ + \ prod." + airbyte_hidden: true + organization_export_ids: + title: "Organization Export IDs" + description: "Globally unique identifiers for the organization exports" + type: "array" + source-posthog: + title: "PostHog Spec" + type: "object" + required: + - "api_key" + - "start_date" + - "sourceType" + properties: + start_date: + title: "Start Date" + type: "string" + description: "The date from which you'd like to replicate the data. Any\ + \ data before this date will not be replicated." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2021-01-01T00:00:00Z" + format: "date-time" + api_key: + type: "string" + airbyte_secret: true + title: "API Key" + description: "API Key. See the docs for information on how to generate this key." + x-speakeasy-param-sensitive: true + base_url: + type: "string" + default: "https://app.posthog.com" + title: "Base URL" + description: "Base PostHog url. Defaults to PostHog Cloud (https://app.posthog.com)." + examples: + - "https://posthog.example.com" + events_time_step: + type: "integer" + order: 3 + default: 30 + minimum: 1 + maximum: 91 + title: "Events stream slice step size (in days)" + description: "Set lower value in case of failing long running sync of events\ + \ stream." + examples: + - 30 + - 10 + - 5 + sourceType: + title: "posthog" + const: "posthog" + enum: + - "posthog" + order: 0 + type: "string" + source-posthog-update: + title: "PostHog Spec" + type: "object" + required: + - "api_key" + - "start_date" + properties: + start_date: + title: "Start Date" + type: "string" + description: "The date from which you'd like to replicate the data. Any\ + \ data before this date will not be replicated." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2021-01-01T00:00:00Z" + format: "date-time" + api_key: + type: "string" + airbyte_secret: true + title: "API Key" + description: "API Key. See the docs for information on how to generate this key." + base_url: + type: "string" + default: "https://app.posthog.com" + title: "Base URL" + description: "Base PostHog url. Defaults to PostHog Cloud (https://app.posthog.com)." + examples: + - "https://posthog.example.com" + events_time_step: + type: "integer" + order: 3 + default: 30 + minimum: 1 + maximum: 91 + title: "Events stream slice step size (in days)" + description: "Set lower value in case of failing long running sync of events\ + \ stream." + examples: + - 30 + - 10 + - 5 + source-getlago: + title: "Lago Spec" + type: "object" + required: + - "api_key" + - "sourceType" + properties: + api_url: + title: "API Url" + type: "string" + description: "Your Lago API URL" + default: "https://api.getlago.com/api/v1" + api_key: + title: "API Key" + type: "string" + description: "Your API Key. See here." + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "getlago" + const: "getlago" + enum: + - "getlago" + order: 0 + type: "string" + source-getlago-update: + title: "Lago Spec" + type: "object" + required: + - "api_key" + properties: + api_url: + title: "API Url" + type: "string" + description: "Your Lago API URL" + default: "https://api.getlago.com/api/v1" + api_key: + title: "API Key" + type: "string" + description: "Your API Key. See here." + airbyte_secret: true + source-gridly: + title: "Gridly Spec" + type: "object" + required: + - "api_key" + - "grid_id" + - "sourceType" + properties: + api_key: + type: "string" + title: "API Key" + airbyte_secret: true + x-speakeasy-param-sensitive: true + grid_id: + type: "string" + title: "Grid ID" + description: "ID of a grid, or can be ID of a branch" + sourceType: + title: "gridly" + const: "gridly" + enum: + - "gridly" + order: 0 + type: "string" + source-gridly-update: + title: "Gridly Spec" + type: "object" + required: + - "api_key" + - "grid_id" + properties: + api_key: + type: "string" + title: "API Key" + airbyte_secret: true + grid_id: + type: "string" + title: "Grid ID" + description: "ID of a grid, or can be ID of a branch" + source-microsoft-teams: + title: "Microsoft Teams Spec" + type: "object" + required: + - "period" + - "sourceType" + properties: + period: + type: "string" + title: "Period" + description: "Specifies the length of time over which the Team Device Report\ + \ stream is aggregated. The supported values are: D7, D30, D90, and D180." + examples: + - "D7" + credentials: + title: "Authentication mechanism" + description: "Choose how to authenticate to Microsoft" + type: "object" + oneOf: + - type: "object" + title: "Authenticate via Microsoft (OAuth 2.0)" + required: + - "tenant_id" + - "client_id" + - "client_secret" + - "refresh_token" + properties: + auth_type: + type: "string" + const: "Client" + enum: + - "Client" + default: "Client" + order: 0 + tenant_id: + title: "Directory (tenant) ID" + type: "string" + description: "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" + airbyte_secret: true + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Microsoft Teams developer application." + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Microsoft Teams developer\ + \ application." + airbyte_secret: true + refresh_token: + title: "Refresh Token" + type: "string" + description: "A Refresh Token to renew the expired Access Token." + airbyte_secret: true + x-speakeasy-param-sensitive: true + - type: "object" + title: "Authenticate via Microsoft" + required: + - "tenant_id" + - "client_id" + - "client_secret" + properties: + auth_type: + type: "string" + const: "Token" + enum: + - "Token" + default: "Token" + order: 0 + tenant_id: + title: "Directory (tenant) ID" + type: "string" + description: "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" + airbyte_secret: true + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Microsoft Teams developer application." + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Microsoft Teams developer\ + \ application." + airbyte_secret: true + sourceType: + title: "microsoft-teams" + const: "microsoft-teams" + enum: + - "microsoft-teams" + order: 0 + type: "string" + source-microsoft-teams-update: + title: "Microsoft Teams Spec" + type: "object" + required: + - "period" + properties: + period: + type: "string" + title: "Period" + description: "Specifies the length of time over which the Team Device Report\ + \ stream is aggregated. The supported values are: D7, D30, D90, and D180." + examples: + - "D7" + credentials: + title: "Authentication mechanism" + description: "Choose how to authenticate to Microsoft" + type: "object" + oneOf: + - type: "object" + title: "Authenticate via Microsoft (OAuth 2.0)" + required: + - "tenant_id" + - "client_id" + - "client_secret" + - "refresh_token" + properties: + auth_type: + type: "string" + const: "Client" + enum: + - "Client" + default: "Client" + order: 0 + tenant_id: + title: "Directory (tenant) ID" + type: "string" + description: "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" + airbyte_secret: true + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Microsoft Teams developer application." + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Microsoft Teams developer\ + \ application." + airbyte_secret: true + refresh_token: + title: "Refresh Token" + type: "string" + description: "A Refresh Token to renew the expired Access Token." + airbyte_secret: true + - type: "object" + title: "Authenticate via Microsoft" + required: + - "tenant_id" + - "client_id" + - "client_secret" + properties: + auth_type: + type: "string" + const: "Token" + enum: + - "Token" + default: "Token" + order: 0 + tenant_id: + title: "Directory (tenant) ID" + type: "string" + description: "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" + airbyte_secret: true + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Microsoft Teams developer application." + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Microsoft Teams developer\ + \ application." + airbyte_secret: true + source-amazon-seller-partner: + title: "Amazon Seller Partner Spec" + type: "object" + required: + - "aws_environment" + - "region" + - "account_type" + - "lwa_app_id" + - "lwa_client_secret" + - "refresh_token" + - "sourceType" + properties: + auth_type: + title: "Auth Type" + const: "oauth2.0" + order: 0 + type: "string" + enum: + - "oauth2.0" + aws_environment: + title: "AWS Environment" + description: "Select the AWS Environment." + enum: + - "PRODUCTION" + - "SANDBOX" + default: "PRODUCTION" + type: "string" + order: 1 + region: + title: "AWS Region" + description: "Select the AWS Region." + enum: + - "AE" + - "AU" + - "BE" + - "BR" + - "CA" + - "DE" + - "EG" + - "ES" + - "FR" + - "GB" + - "IN" + - "IT" + - "JP" + - "MX" + - "NL" + - "PL" + - "SA" + - "SE" + - "SG" + - "TR" + - "UK" + - "US" + default: "US" + type: "string" + order: 2 + account_type: + title: "AWS Seller Partner Account Type" + description: "Type of the Account you're going to authorize the Airbyte\ + \ application by" + enum: + - "Seller" + - "Vendor" + default: "Seller" + type: "string" + order: 3 + lwa_app_id: + title: "LWA Client Id" + description: "Your Login with Amazon Client ID." + order: 4 + airbyte_secret: true + type: "string" + lwa_client_secret: + title: "LWA Client Secret" + description: "Your Login with Amazon Client Secret." + airbyte_secret: true + order: 5 + type: "string" + refresh_token: + title: "Refresh Token" + description: "The Refresh Token obtained via OAuth flow authorization." + airbyte_secret: true + order: 6 + type: "string" + x-speakeasy-param-sensitive: true + replication_start_date: + title: "Start Date" + description: "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." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2017-01-25T00:00:00Z" + order: 7 + type: "string" + format: "date-time" + replication_end_date: + title: "End Date" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data after this date will not be replicated." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$|^$" + examples: + - "2017-01-25T00:00:00Z" + order: 8 + type: "string" + format: "date-time" + period_in_days: + title: "Period In Days" + type: "integer" + description: "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." + default: 90 + minimum: 1 + order: 9 + report_options_list: + title: "Report Options" + description: "Additional information passed to reports. This varies by report\ + \ type." + order: 10 + type: "array" + items: + type: "object" + title: "Report Options" + required: + - "stream_name" + - "options_list" + properties: + stream_name: + title: "Stream Name" + type: "string" + order: 0 + enum: + - "GET_AFN_INVENTORY_DATA" + - "GET_AFN_INVENTORY_DATA_BY_COUNTRY" + - "GET_AMAZON_FULFILLED_SHIPMENTS_DATA_GENERAL" + - "GET_BRAND_ANALYTICS_MARKET_BASKET_REPORT" + - "GET_BRAND_ANALYTICS_REPEAT_PURCHASE_REPORT" + - "GET_BRAND_ANALYTICS_SEARCH_TERMS_REPORT" + - "GET_FBA_ESTIMATED_FBA_FEES_TXT_DATA" + - "GET_FBA_FULFILLMENT_CUSTOMER_RETURNS_DATA" + - "GET_FBA_FULFILLMENT_CUSTOMER_SHIPMENT_PROMOTION_DATA" + - "GET_FBA_FULFILLMENT_CUSTOMER_SHIPMENT_REPLACEMENT_DATA" + - "GET_FBA_FULFILLMENT_REMOVAL_ORDER_DETAIL_DATA" + - "GET_FBA_FULFILLMENT_REMOVAL_SHIPMENT_DETAIL_DATA" + - "GET_FBA_INVENTORY_PLANNING_DATA" + - "GET_FBA_MYI_UNSUPPRESSED_INVENTORY_DATA" + - "GET_FBA_REIMBURSEMENTS_DATA" + - "GET_FBA_SNS_FORECAST_DATA" + - "GET_FBA_SNS_PERFORMANCE_DATA" + - "GET_FBA_STORAGE_FEE_CHARGES_DATA" + - "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA_SHIPPING" + - "GET_FLAT_FILE_ALL_ORDERS_DATA_BY_LAST_UPDATE_GENERAL" + - "GET_FLAT_FILE_ALL_ORDERS_DATA_BY_ORDER_DATE_GENERAL" + - "GET_FLAT_FILE_ARCHIVED_ORDERS_DATA_BY_ORDER_DATE" + - "GET_FLAT_FILE_OPEN_LISTINGS_DATA" + - "GET_FLAT_FILE_RETURNS_DATA_BY_RETURN_DATE" + - "GET_LEDGER_DETAIL_VIEW_DATA" + - "GET_LEDGER_SUMMARY_VIEW_DATA" + - "GET_MERCHANT_CANCELLED_LISTINGS_DATA" + - "GET_MERCHANT_LISTINGS_ALL_DATA" + - "GET_MERCHANT_LISTINGS_DATA" + - "GET_MERCHANT_LISTINGS_DATA_BACK_COMPAT" + - "GET_MERCHANT_LISTINGS_INACTIVE_DATA" + - "GET_MERCHANTS_LISTINGS_FYP_REPORT" + - "GET_ORDER_REPORT_DATA_SHIPPING" + - "GET_RESTOCK_INVENTORY_RECOMMENDATIONS_REPORT" + - "GET_SALES_AND_TRAFFIC_REPORT" + - "GET_SELLER_FEEDBACK_DATA" + - "GET_STRANDED_INVENTORY_UI_DATA" + - "GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE" + - "GET_VENDOR_INVENTORY_REPORT" + - "GET_VENDOR_NET_PURE_PRODUCT_MARGIN_REPORT" + - "GET_VENDOR_TRAFFIC_REPORT" + - "GET_VENDOR_SALES_REPORT" + - "GET_XML_ALL_ORDERS_DATA_BY_ORDER_DATE_GENERAL" + - "GET_XML_BROWSE_TREE_DATA" + options_list: + title: "List of options" + description: "List of options" + type: "array" + items: + type: "object" + required: + - "option_name" + - "option_value" + properties: + option_name: + title: "Name" + type: "string" + order: 0 + option_value: + title: "Value" + type: "string" + order: 1 + sourceType: + title: "amazon-seller-partner" + const: "amazon-seller-partner" + enum: + - "amazon-seller-partner" + order: 0 + type: "string" + source-amazon-seller-partner-update: + title: "Amazon Seller Partner Spec" + type: "object" + required: + - "aws_environment" + - "region" + - "account_type" + - "lwa_app_id" + - "lwa_client_secret" + - "refresh_token" + properties: + auth_type: + title: "Auth Type" + const: "oauth2.0" + order: 0 + type: "string" + enum: + - "oauth2.0" + aws_environment: + title: "AWS Environment" + description: "Select the AWS Environment." + enum: + - "PRODUCTION" + - "SANDBOX" + default: "PRODUCTION" + type: "string" + order: 1 + region: + title: "AWS Region" + description: "Select the AWS Region." + enum: + - "AE" + - "AU" + - "BE" + - "BR" + - "CA" + - "DE" + - "EG" + - "ES" + - "FR" + - "GB" + - "IN" + - "IT" + - "JP" + - "MX" + - "NL" + - "PL" + - "SA" + - "SE" + - "SG" + - "TR" + - "UK" + - "US" + default: "US" + type: "string" + order: 2 + account_type: + title: "AWS Seller Partner Account Type" + description: "Type of the Account you're going to authorize the Airbyte\ + \ application by" + enum: + - "Seller" + - "Vendor" + default: "Seller" + type: "string" + order: 3 + lwa_app_id: + title: "LWA Client Id" + description: "Your Login with Amazon Client ID." + order: 4 + airbyte_secret: true + type: "string" + lwa_client_secret: + title: "LWA Client Secret" + description: "Your Login with Amazon Client Secret." + airbyte_secret: true + order: 5 + type: "string" + refresh_token: + title: "Refresh Token" + description: "The Refresh Token obtained via OAuth flow authorization." + airbyte_secret: true + order: 6 + type: "string" + replication_start_date: + title: "Start Date" + description: "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." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2017-01-25T00:00:00Z" + order: 7 + type: "string" + format: "date-time" + replication_end_date: + title: "End Date" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data after this date will not be replicated." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$|^$" + examples: + - "2017-01-25T00:00:00Z" + order: 8 + type: "string" + format: "date-time" + period_in_days: + title: "Period In Days" + type: "integer" + description: "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." + default: 90 + minimum: 1 + order: 9 + report_options_list: + title: "Report Options" + description: "Additional information passed to reports. This varies by report\ + \ type." + order: 10 + type: "array" + items: + type: "object" + title: "Report Options" + required: + - "stream_name" + - "options_list" + properties: + stream_name: + title: "Stream Name" + type: "string" + order: 0 + enum: + - "GET_AFN_INVENTORY_DATA" + - "GET_AFN_INVENTORY_DATA_BY_COUNTRY" + - "GET_AMAZON_FULFILLED_SHIPMENTS_DATA_GENERAL" + - "GET_BRAND_ANALYTICS_MARKET_BASKET_REPORT" + - "GET_BRAND_ANALYTICS_REPEAT_PURCHASE_REPORT" + - "GET_BRAND_ANALYTICS_SEARCH_TERMS_REPORT" + - "GET_FBA_ESTIMATED_FBA_FEES_TXT_DATA" + - "GET_FBA_FULFILLMENT_CUSTOMER_RETURNS_DATA" + - "GET_FBA_FULFILLMENT_CUSTOMER_SHIPMENT_PROMOTION_DATA" + - "GET_FBA_FULFILLMENT_CUSTOMER_SHIPMENT_REPLACEMENT_DATA" + - "GET_FBA_FULFILLMENT_REMOVAL_ORDER_DETAIL_DATA" + - "GET_FBA_FULFILLMENT_REMOVAL_SHIPMENT_DETAIL_DATA" + - "GET_FBA_INVENTORY_PLANNING_DATA" + - "GET_FBA_MYI_UNSUPPRESSED_INVENTORY_DATA" + - "GET_FBA_REIMBURSEMENTS_DATA" + - "GET_FBA_SNS_FORECAST_DATA" + - "GET_FBA_SNS_PERFORMANCE_DATA" + - "GET_FBA_STORAGE_FEE_CHARGES_DATA" + - "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA_SHIPPING" + - "GET_FLAT_FILE_ALL_ORDERS_DATA_BY_LAST_UPDATE_GENERAL" + - "GET_FLAT_FILE_ALL_ORDERS_DATA_BY_ORDER_DATE_GENERAL" + - "GET_FLAT_FILE_ARCHIVED_ORDERS_DATA_BY_ORDER_DATE" + - "GET_FLAT_FILE_OPEN_LISTINGS_DATA" + - "GET_FLAT_FILE_RETURNS_DATA_BY_RETURN_DATE" + - "GET_LEDGER_DETAIL_VIEW_DATA" + - "GET_LEDGER_SUMMARY_VIEW_DATA" + - "GET_MERCHANT_CANCELLED_LISTINGS_DATA" + - "GET_MERCHANT_LISTINGS_ALL_DATA" + - "GET_MERCHANT_LISTINGS_DATA" + - "GET_MERCHANT_LISTINGS_DATA_BACK_COMPAT" + - "GET_MERCHANT_LISTINGS_INACTIVE_DATA" + - "GET_MERCHANTS_LISTINGS_FYP_REPORT" + - "GET_ORDER_REPORT_DATA_SHIPPING" + - "GET_RESTOCK_INVENTORY_RECOMMENDATIONS_REPORT" + - "GET_SALES_AND_TRAFFIC_REPORT" + - "GET_SELLER_FEEDBACK_DATA" + - "GET_STRANDED_INVENTORY_UI_DATA" + - "GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE" + - "GET_VENDOR_INVENTORY_REPORT" + - "GET_VENDOR_NET_PURE_PRODUCT_MARGIN_REPORT" + - "GET_VENDOR_TRAFFIC_REPORT" + - "GET_VENDOR_SALES_REPORT" + - "GET_XML_ALL_ORDERS_DATA_BY_ORDER_DATE_GENERAL" + - "GET_XML_BROWSE_TREE_DATA" + options_list: + title: "List of options" + description: "List of options" + type: "array" + items: + type: "object" + required: + - "option_name" + - "option_value" + properties: + option_name: + title: "Name" + type: "string" + order: 0 + option_value: + title: "Value" + type: "string" + order: 1 + source-recreation: + title: "Recreation Spec" + type: "object" + required: + - "apikey" + - "sourceType" + properties: + apikey: + title: "API Key" + type: "string" + description: "API Key" + airbyte_secret: true + x-speakeasy-param-sensitive: true + query_campsites: + title: "Query Campsite" + type: "string" + sourceType: + title: "recreation" + const: "recreation" + enum: + - "recreation" + order: 0 + type: "string" + source-recreation-update: + title: "Recreation Spec" + type: "object" + required: + - "apikey" + properties: + apikey: + title: "API Key" + type: "string" + description: "API Key" + airbyte_secret: true + query_campsites: + title: "Query Campsite" + type: "string" + source-linkedin-ads: + title: "Linkedin Ads Spec" + type: "object" + required: + - "start_date" + - "sourceType" + properties: + credentials: + title: "Authentication" + type: "object" + oneOf: + - type: "object" + title: "OAuth2.0" + required: + - "client_id" + - "client_secret" + - "refresh_token" + properties: + auth_method: + type: "string" + const: "oAuth2.0" + enum: + - "oAuth2.0" + client_id: + type: "string" + title: "Client ID" + description: "The client ID of your developer application. Refer to\ + \ our documentation\ + \ for more information." + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "The client secret of your developer application. Refer\ + \ to our documentation\ + \ for more information." + airbyte_secret: true + refresh_token: + type: "string" + title: "Refresh Token" + description: "The key to refresh the expired access token. Refer to\ + \ our documentation\ + \ for more information." + airbyte_secret: true + x-speakeasy-param-sensitive: true + - title: "Access Token" + type: "object" + required: + - "access_token" + properties: + auth_method: + type: "string" + const: "access_token" + enum: + - "access_token" + access_token: + type: "string" + title: "Access Token" + description: "The access token generated for your developer application.\ + \ Refer to our documentation\ + \ for more information." + airbyte_secret: true + x-speakeasy-param-sensitive: true + start_date: + type: "string" + title: "Start Date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + pattern_descriptor: "YYYY-MM-DD" + description: "UTC date in the format YYYY-MM-DD. Any data before this date\ + \ will not be replicated." + examples: + - "2021-05-17" + format: "date" + account_ids: + title: "Account IDs" + type: "array" + description: "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." + items: + type: "integer" + examples: + - "123456789" + default: [] + ad_analytics_reports: + title: "Custom Ad Analytics Reports" + type: "array" + items: + type: "object" + title: "Ad Analytics Report Configuration" + description: "Config for custom ad Analytics Report" + required: + - "name" + - "pivot_by" + - "time_granularity" + properties: + name: + title: "Report Name" + description: "The name for the custom report." + type: "string" + pivot_by: + title: "Pivot Category" + description: "Choose a category to pivot your analytics report around.\ + \ This selection will organize your data based on the chosen attribute,\ + \ allowing you to analyze trends and performance from different\ + \ perspectives." + type: "string" + enum: + - "COMPANY" + - "ACCOUNT" + - "SHARE" + - "CAMPAIGN" + - "CREATIVE" + - "CAMPAIGN_GROUP" + - "CONVERSION" + - "CONVERSATION_NODE" + - "CONVERSATION_NODE_OPTION_INDEX" + - "SERVING_LOCATION" + - "CARD_INDEX" + - "MEMBER_COMPANY_SIZE" + - "MEMBER_INDUSTRY" + - "MEMBER_SENIORITY" + - "MEMBER_JOB_TITLE" + - "MEMBER_JOB_FUNCTION" + - "MEMBER_COUNTRY_V2" + - "MEMBER_REGION_V2" + - "MEMBER_COMPANY" + - "PLACEMENT_NAME" + - "IMPRESSION_DEVICE_TYPE" + time_granularity: + title: "Time Granularity" + description: "Choose how to group the data in your report by time.\ + \ The options are:
- 'ALL': A single result summarizing the entire\ + \ time range.
- 'DAILY': Group results by each day.
- 'MONTHLY':\ + \ Group results by each month.
- 'YEARLY': Group results by each\ + \ year.
Selecting a time grouping helps you analyze trends and\ + \ patterns over different time periods." + type: "string" + enum: + - "ALL" + - "DAILY" + - "MONTHLY" + - "YEARLY" + default: [] + sourceType: + title: "linkedin-ads" + const: "linkedin-ads" + enum: + - "linkedin-ads" + order: 0 + type: "string" + source-linkedin-ads-update: + title: "Linkedin Ads Spec" + type: "object" + required: + - "start_date" + properties: + credentials: + title: "Authentication" + type: "object" + oneOf: + - type: "object" + title: "OAuth2.0" + required: + - "client_id" + - "client_secret" + - "refresh_token" + properties: + auth_method: + type: "string" + const: "oAuth2.0" + enum: + - "oAuth2.0" + client_id: + type: "string" + title: "Client ID" + description: "The client ID of your developer application. Refer to\ + \ our documentation\ + \ for more information." + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "The client secret of your developer application. Refer\ + \ to our documentation\ + \ for more information." + airbyte_secret: true + refresh_token: + type: "string" + title: "Refresh Token" + description: "The key to refresh the expired access token. Refer to\ + \ our documentation\ + \ for more information." + airbyte_secret: true + - title: "Access Token" + type: "object" + required: + - "access_token" + properties: + auth_method: + type: "string" + const: "access_token" + enum: + - "access_token" + access_token: + type: "string" + title: "Access Token" + description: "The access token generated for your developer application.\ + \ Refer to our documentation\ + \ for more information." + airbyte_secret: true + start_date: + type: "string" + title: "Start Date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + pattern_descriptor: "YYYY-MM-DD" + description: "UTC date in the format YYYY-MM-DD. Any data before this date\ + \ will not be replicated." + examples: + - "2021-05-17" + format: "date" + account_ids: + title: "Account IDs" + type: "array" + description: "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." + items: + type: "integer" + examples: + - "123456789" + default: [] + ad_analytics_reports: + title: "Custom Ad Analytics Reports" + type: "array" + items: + type: "object" + title: "Ad Analytics Report Configuration" + description: "Config for custom ad Analytics Report" + required: + - "name" + - "pivot_by" + - "time_granularity" + properties: + name: + title: "Report Name" + description: "The name for the custom report." + type: "string" + pivot_by: + title: "Pivot Category" + description: "Choose a category to pivot your analytics report around.\ + \ This selection will organize your data based on the chosen attribute,\ + \ allowing you to analyze trends and performance from different\ + \ perspectives." + type: "string" + enum: + - "COMPANY" + - "ACCOUNT" + - "SHARE" + - "CAMPAIGN" + - "CREATIVE" + - "CAMPAIGN_GROUP" + - "CONVERSION" + - "CONVERSATION_NODE" + - "CONVERSATION_NODE_OPTION_INDEX" + - "SERVING_LOCATION" + - "CARD_INDEX" + - "MEMBER_COMPANY_SIZE" + - "MEMBER_INDUSTRY" + - "MEMBER_SENIORITY" + - "MEMBER_JOB_TITLE" + - "MEMBER_JOB_FUNCTION" + - "MEMBER_COUNTRY_V2" + - "MEMBER_REGION_V2" + - "MEMBER_COMPANY" + - "PLACEMENT_NAME" + - "IMPRESSION_DEVICE_TYPE" + time_granularity: + title: "Time Granularity" + description: "Choose how to group the data in your report by time.\ + \ The options are:
- 'ALL': A single result summarizing the entire\ + \ time range.
- 'DAILY': Group results by each day.
- 'MONTHLY':\ + \ Group results by each month.
- 'YEARLY': Group results by each\ + \ year.
Selecting a time grouping helps you analyze trends and\ + \ patterns over different time periods." + type: "string" + enum: + - "ALL" + - "DAILY" + - "MONTHLY" + - "YEARLY" + default: [] + source-us-census: + title: "https://api.census.gov/ Source Spec" + type: "object" + required: + - "api_key" + - "query_path" + - "sourceType" + properties: + query_params: + type: "string" + description: "The query parameters portion of the GET request, without the\ + \ api key" + pattern: "^\\w+=[\\w,:*]+(&(?!key)\\w+=[\\w,:*]+)*$" + examples: + - "get=NAME,NAICS2017_LABEL,LFO_LABEL,EMPSZES_LABEL,ESTAB,PAYANN,PAYQTR1,EMP&for=us:*&NAICS2017=72&LFO=001&EMPSZES=001" + - "get=MOVEDIN,GEOID1,GEOID2,MOVEDOUT,FULL1_NAME,FULL2_NAME,MOVEDNET&for=county:*" + query_path: + type: "string" + description: "The path portion of the GET request" + pattern: "^data(\\/[\\w\\d]+)+$" + examples: + - "data/2019/cbp" + - "data/2018/acs" + - "data/timeseries/healthins/sahie" + api_key: + type: "string" + description: "Your API Key. Get your key here." + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "us-census" + const: "us-census" + enum: + - "us-census" + order: 0 + type: "string" + source-us-census-update: + title: "https://api.census.gov/ Source Spec" + type: "object" + required: + - "api_key" + - "query_path" + properties: + query_params: + type: "string" + description: "The query parameters portion of the GET request, without the\ + \ api key" + pattern: "^\\w+=[\\w,:*]+(&(?!key)\\w+=[\\w,:*]+)*$" + examples: + - "get=NAME,NAICS2017_LABEL,LFO_LABEL,EMPSZES_LABEL,ESTAB,PAYANN,PAYQTR1,EMP&for=us:*&NAICS2017=72&LFO=001&EMPSZES=001" + - "get=MOVEDIN,GEOID1,GEOID2,MOVEDOUT,FULL1_NAME,FULL2_NAME,MOVEDNET&for=county:*" + query_path: + type: "string" + description: "The path portion of the GET request" + pattern: "^data(\\/[\\w\\d]+)+$" + examples: + - "data/2019/cbp" + - "data/2018/acs" + - "data/timeseries/healthins/sahie" + api_key: + type: "string" + description: "Your API Key. Get your key here." + airbyte_secret: true + source-pinterest: + title: "Pinterest Spec" + type: "object" + properties: + start_date: + type: "string" + title: "Start Date" + description: "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)." + format: "date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + pattern_descriptor: "YYYY-MM-DD" + examples: + - "2022-07-28" + status: + title: "Status" + description: "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." + type: + - "array" + - "null" + items: + type: "string" + enum: + - "ACTIVE" + - "PAUSED" + - "ARCHIVED" + uniqueItems: true + credentials: + title: "OAuth2.0" + type: "object" + required: + - "auth_method" + - "refresh_token" + - "client_id" + - "client_secret" + properties: + auth_method: + type: "string" + const: "oauth2.0" + order: 0 + enum: + - "oauth2.0" + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your OAuth application" + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of your OAuth application." + airbyte_secret: true + refresh_token: + type: "string" + title: "Refresh Token" + description: "Refresh Token to obtain new Access Token, when it's expired." + airbyte_secret: true + x-speakeasy-param-sensitive: true + custom_reports: + title: "Custom Reports" + description: "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." + type: "array" + items: + title: "ReportConfig" + description: "Config for custom report" + type: "object" + required: + - "name" + - "level" + - "granularity" + - "columns" + properties: + name: + title: "Name" + description: "The name value of report" + type: "string" + order: 0 + level: + title: "Level" + description: "Chosen level for API" + default: "ADVERTISER" + enum: + - "ADVERTISER" + - "ADVERTISER_TARGETING" + - "CAMPAIGN" + - "CAMPAIGN_TARGETING" + - "AD_GROUP" + - "AD_GROUP_TARGETING" + - "PIN_PROMOTION" + - "PIN_PROMOTION_TARGETING" + - "KEYWORD" + - "PRODUCT_GROUP" + - "PRODUCT_GROUP_TARGETING" + - "PRODUCT_ITEM" + type: "string" + order: 1 + granularity: + title: "Granularity" + description: "Chosen granularity for API" + default: "TOTAL" + enum: + - "TOTAL" + - "DAY" + - "HOUR" + - "WEEK" + - "MONTH" + type: "string" + order: 2 + columns: + title: "Columns" + description: "A list of chosen columns" + default: [] + type: "array" + order: 3 + items: + title: "ValidEnums" + description: "An enumeration." + enum: + - "ADVERTISER_ID" + - "AD_ACCOUNT_ID" + - "AD_GROUP_ENTITY_STATUS" + - "AD_GROUP_ID" + - "AD_ID" + - "CAMPAIGN_DAILY_SPEND_CAP" + - "CAMPAIGN_ENTITY_STATUS" + - "CAMPAIGN_ID" + - "CAMPAIGN_LIFETIME_SPEND_CAP" + - "CAMPAIGN_NAME" + - "CHECKOUT_ROAS" + - "CLICKTHROUGH_1" + - "CLICKTHROUGH_1_GROSS" + - "CLICKTHROUGH_2" + - "CPC_IN_MICRO_DOLLAR" + - "CPM_IN_DOLLAR" + - "CPM_IN_MICRO_DOLLAR" + - "CTR" + - "CTR_2" + - "ECPCV_IN_DOLLAR" + - "ECPCV_P95_IN_DOLLAR" + - "ECPC_IN_DOLLAR" + - "ECPC_IN_MICRO_DOLLAR" + - "ECPE_IN_DOLLAR" + - "ECPM_IN_MICRO_DOLLAR" + - "ECPV_IN_DOLLAR" + - "ECTR" + - "EENGAGEMENT_RATE" + - "ENGAGEMENT_1" + - "ENGAGEMENT_2" + - "ENGAGEMENT_RATE" + - "IDEA_PIN_PRODUCT_TAG_VISIT_1" + - "IDEA_PIN_PRODUCT_TAG_VISIT_2" + - "IMPRESSION_1" + - "IMPRESSION_1_GROSS" + - "IMPRESSION_2" + - "INAPP_CHECKOUT_COST_PER_ACTION" + - "OUTBOUND_CLICK_1" + - "OUTBOUND_CLICK_2" + - "PAGE_VISIT_COST_PER_ACTION" + - "PAGE_VISIT_ROAS" + - "PAID_IMPRESSION" + - "PIN_ID" + - "PIN_PROMOTION_ID" + - "REPIN_1" + - "REPIN_2" + - "REPIN_RATE" + - "SPEND_IN_DOLLAR" + - "SPEND_IN_MICRO_DOLLAR" + - "TOTAL_CHECKOUT" + - "TOTAL_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + - "TOTAL_CLICKTHROUGH" + - "TOTAL_CLICK_ADD_TO_CART" + - "TOTAL_CLICK_CHECKOUT" + - "TOTAL_CLICK_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + - "TOTAL_CLICK_LEAD" + - "TOTAL_CLICK_SIGNUP" + - "TOTAL_CLICK_SIGNUP_VALUE_IN_MICRO_DOLLAR" + - "TOTAL_CONVERSIONS" + - "TOTAL_CUSTOM" + - "TOTAL_ENGAGEMENT" + - "TOTAL_ENGAGEMENT_CHECKOUT" + - "TOTAL_ENGAGEMENT_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + - "TOTAL_ENGAGEMENT_LEAD" + - "TOTAL_ENGAGEMENT_SIGNUP" + - "TOTAL_ENGAGEMENT_SIGNUP_VALUE_IN_MICRO_DOLLAR" + - "TOTAL_IDEA_PIN_PRODUCT_TAG_VISIT" + - "TOTAL_IMPRESSION_FREQUENCY" + - "TOTAL_IMPRESSION_USER" + - "TOTAL_LEAD" + - "TOTAL_OFFLINE_CHECKOUT" + - "TOTAL_PAGE_VISIT" + - "TOTAL_REPIN_RATE" + - "TOTAL_SIGNUP" + - "TOTAL_SIGNUP_VALUE_IN_MICRO_DOLLAR" + - "TOTAL_VIDEO_3SEC_VIEWS" + - "TOTAL_VIDEO_AVG_WATCHTIME_IN_SECOND" + - "TOTAL_VIDEO_MRC_VIEWS" + - "TOTAL_VIDEO_P0_COMBINED" + - "TOTAL_VIDEO_P100_COMPLETE" + - "TOTAL_VIDEO_P25_COMBINED" + - "TOTAL_VIDEO_P50_COMBINED" + - "TOTAL_VIDEO_P75_COMBINED" + - "TOTAL_VIDEO_P95_COMBINED" + - "TOTAL_VIEW_ADD_TO_CART" + - "TOTAL_VIEW_CHECKOUT" + - "TOTAL_VIEW_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + - "TOTAL_VIEW_LEAD" + - "TOTAL_VIEW_SIGNUP" + - "TOTAL_VIEW_SIGNUP_VALUE_IN_MICRO_DOLLAR" + - "TOTAL_WEB_CHECKOUT" + - "TOTAL_WEB_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + - "TOTAL_WEB_CLICK_CHECKOUT" + - "TOTAL_WEB_CLICK_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + - "TOTAL_WEB_ENGAGEMENT_CHECKOUT" + - "TOTAL_WEB_ENGAGEMENT_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + - "TOTAL_WEB_SESSIONS" + - "TOTAL_WEB_VIEW_CHECKOUT" + - "TOTAL_WEB_VIEW_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + - "VIDEO_3SEC_VIEWS_2" + - "VIDEO_LENGTH" + - "VIDEO_MRC_VIEWS_2" + - "VIDEO_P0_COMBINED_2" + - "VIDEO_P100_COMPLETE_2" + - "VIDEO_P25_COMBINED_2" + - "VIDEO_P50_COMBINED_2" + - "VIDEO_P75_COMBINED_2" + - "VIDEO_P95_COMBINED_2" + - "WEB_CHECKOUT_COST_PER_ACTION" + - "WEB_CHECKOUT_ROAS" + - "WEB_SESSIONS_1" + - "WEB_SESSIONS_2" + click_window_days: + title: "Click window days" + description: "Number of days to use as the conversion attribution\ + \ window for a pin click action." + default: 30 + enum: + - 0 + - 1 + - 7 + - 14 + - 30 + - 60 + type: "integer" + order: 4 + engagement_window_days: + title: "Engagement window days" + description: "Number of days to use as the conversion attribution\ + \ window for an engagement action." + default: + - 30 + enum: + - 0 + - 1 + - 7 + - 14 + - 30 + - 60 + type: "integer" + order: 5 + view_window_days: + title: "View window days" + description: "Number of days to use as the conversion attribution\ + \ window for a view action." + default: + - 30 + enum: + - 0 + - 1 + - 7 + - 14 + - 30 + - 60 + type: "integer" + order: 6 + conversion_report_time: + title: "Conversion report time" + description: "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.." + default: "TIME_OF_AD_ACTION" + enum: + - "TIME_OF_AD_ACTION" + - "TIME_OF_CONVERSION" + type: "string" + order: 7 + attribution_types: + title: "Attribution types" + description: "List of types of attribution for the conversion report" + default: + - "INDIVIDUAL" + - "HOUSEHOLD" + type: "array" + items: + title: "ValidEnums" + description: "An enumeration." + enum: + - "INDIVIDUAL" + - "HOUSEHOLD" + order: 8 + start_date: + type: "string" + title: "Start Date" + description: "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)." + format: "date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + pattern_descriptor: "YYYY-MM-DD" + examples: + - "2022-07-28" + order: 9 + sourceType: + title: "pinterest" + const: "pinterest" + enum: + - "pinterest" + order: 0 + type: "string" + source-pinterest-update: + title: "Pinterest Spec" + type: "object" + properties: + start_date: + type: "string" + title: "Start Date" + description: "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)." + format: "date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + pattern_descriptor: "YYYY-MM-DD" + examples: + - "2022-07-28" + status: + title: "Status" + description: "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." + type: + - "array" + - "null" + items: + type: "string" + enum: + - "ACTIVE" + - "PAUSED" + - "ARCHIVED" + uniqueItems: true + credentials: + title: "OAuth2.0" + type: "object" + required: + - "auth_method" + - "refresh_token" + - "client_id" + - "client_secret" + properties: + auth_method: + type: "string" + const: "oauth2.0" + order: 0 + enum: + - "oauth2.0" + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your OAuth application" + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of your OAuth application." + airbyte_secret: true + refresh_token: + type: "string" + title: "Refresh Token" + description: "Refresh Token to obtain new Access Token, when it's expired." + airbyte_secret: true + custom_reports: + title: "Custom Reports" + description: "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." + type: "array" + items: + title: "ReportConfig" + description: "Config for custom report" + type: "object" + required: + - "name" + - "level" + - "granularity" + - "columns" + properties: + name: + title: "Name" + description: "The name value of report" + type: "string" + order: 0 + level: + title: "Level" + description: "Chosen level for API" + default: "ADVERTISER" + enum: + - "ADVERTISER" + - "ADVERTISER_TARGETING" + - "CAMPAIGN" + - "CAMPAIGN_TARGETING" + - "AD_GROUP" + - "AD_GROUP_TARGETING" + - "PIN_PROMOTION" + - "PIN_PROMOTION_TARGETING" + - "KEYWORD" + - "PRODUCT_GROUP" + - "PRODUCT_GROUP_TARGETING" + - "PRODUCT_ITEM" + type: "string" + order: 1 + granularity: + title: "Granularity" + description: "Chosen granularity for API" + default: "TOTAL" + enum: + - "TOTAL" + - "DAY" + - "HOUR" + - "WEEK" + - "MONTH" + type: "string" + order: 2 + columns: + title: "Columns" + description: "A list of chosen columns" + default: [] + type: "array" + order: 3 + items: + title: "ValidEnums" + description: "An enumeration." + enum: + - "ADVERTISER_ID" + - "AD_ACCOUNT_ID" + - "AD_GROUP_ENTITY_STATUS" + - "AD_GROUP_ID" + - "AD_ID" + - "CAMPAIGN_DAILY_SPEND_CAP" + - "CAMPAIGN_ENTITY_STATUS" + - "CAMPAIGN_ID" + - "CAMPAIGN_LIFETIME_SPEND_CAP" + - "CAMPAIGN_NAME" + - "CHECKOUT_ROAS" + - "CLICKTHROUGH_1" + - "CLICKTHROUGH_1_GROSS" + - "CLICKTHROUGH_2" + - "CPC_IN_MICRO_DOLLAR" + - "CPM_IN_DOLLAR" + - "CPM_IN_MICRO_DOLLAR" + - "CTR" + - "CTR_2" + - "ECPCV_IN_DOLLAR" + - "ECPCV_P95_IN_DOLLAR" + - "ECPC_IN_DOLLAR" + - "ECPC_IN_MICRO_DOLLAR" + - "ECPE_IN_DOLLAR" + - "ECPM_IN_MICRO_DOLLAR" + - "ECPV_IN_DOLLAR" + - "ECTR" + - "EENGAGEMENT_RATE" + - "ENGAGEMENT_1" + - "ENGAGEMENT_2" + - "ENGAGEMENT_RATE" + - "IDEA_PIN_PRODUCT_TAG_VISIT_1" + - "IDEA_PIN_PRODUCT_TAG_VISIT_2" + - "IMPRESSION_1" + - "IMPRESSION_1_GROSS" + - "IMPRESSION_2" + - "INAPP_CHECKOUT_COST_PER_ACTION" + - "OUTBOUND_CLICK_1" + - "OUTBOUND_CLICK_2" + - "PAGE_VISIT_COST_PER_ACTION" + - "PAGE_VISIT_ROAS" + - "PAID_IMPRESSION" + - "PIN_ID" + - "PIN_PROMOTION_ID" + - "REPIN_1" + - "REPIN_2" + - "REPIN_RATE" + - "SPEND_IN_DOLLAR" + - "SPEND_IN_MICRO_DOLLAR" + - "TOTAL_CHECKOUT" + - "TOTAL_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + - "TOTAL_CLICKTHROUGH" + - "TOTAL_CLICK_ADD_TO_CART" + - "TOTAL_CLICK_CHECKOUT" + - "TOTAL_CLICK_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + - "TOTAL_CLICK_LEAD" + - "TOTAL_CLICK_SIGNUP" + - "TOTAL_CLICK_SIGNUP_VALUE_IN_MICRO_DOLLAR" + - "TOTAL_CONVERSIONS" + - "TOTAL_CUSTOM" + - "TOTAL_ENGAGEMENT" + - "TOTAL_ENGAGEMENT_CHECKOUT" + - "TOTAL_ENGAGEMENT_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + - "TOTAL_ENGAGEMENT_LEAD" + - "TOTAL_ENGAGEMENT_SIGNUP" + - "TOTAL_ENGAGEMENT_SIGNUP_VALUE_IN_MICRO_DOLLAR" + - "TOTAL_IDEA_PIN_PRODUCT_TAG_VISIT" + - "TOTAL_IMPRESSION_FREQUENCY" + - "TOTAL_IMPRESSION_USER" + - "TOTAL_LEAD" + - "TOTAL_OFFLINE_CHECKOUT" + - "TOTAL_PAGE_VISIT" + - "TOTAL_REPIN_RATE" + - "TOTAL_SIGNUP" + - "TOTAL_SIGNUP_VALUE_IN_MICRO_DOLLAR" + - "TOTAL_VIDEO_3SEC_VIEWS" + - "TOTAL_VIDEO_AVG_WATCHTIME_IN_SECOND" + - "TOTAL_VIDEO_MRC_VIEWS" + - "TOTAL_VIDEO_P0_COMBINED" + - "TOTAL_VIDEO_P100_COMPLETE" + - "TOTAL_VIDEO_P25_COMBINED" + - "TOTAL_VIDEO_P50_COMBINED" + - "TOTAL_VIDEO_P75_COMBINED" + - "TOTAL_VIDEO_P95_COMBINED" + - "TOTAL_VIEW_ADD_TO_CART" + - "TOTAL_VIEW_CHECKOUT" + - "TOTAL_VIEW_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + - "TOTAL_VIEW_LEAD" + - "TOTAL_VIEW_SIGNUP" + - "TOTAL_VIEW_SIGNUP_VALUE_IN_MICRO_DOLLAR" + - "TOTAL_WEB_CHECKOUT" + - "TOTAL_WEB_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + - "TOTAL_WEB_CLICK_CHECKOUT" + - "TOTAL_WEB_CLICK_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + - "TOTAL_WEB_ENGAGEMENT_CHECKOUT" + - "TOTAL_WEB_ENGAGEMENT_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + - "TOTAL_WEB_SESSIONS" + - "TOTAL_WEB_VIEW_CHECKOUT" + - "TOTAL_WEB_VIEW_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + - "VIDEO_3SEC_VIEWS_2" + - "VIDEO_LENGTH" + - "VIDEO_MRC_VIEWS_2" + - "VIDEO_P0_COMBINED_2" + - "VIDEO_P100_COMPLETE_2" + - "VIDEO_P25_COMBINED_2" + - "VIDEO_P50_COMBINED_2" + - "VIDEO_P75_COMBINED_2" + - "VIDEO_P95_COMBINED_2" + - "WEB_CHECKOUT_COST_PER_ACTION" + - "WEB_CHECKOUT_ROAS" + - "WEB_SESSIONS_1" + - "WEB_SESSIONS_2" + click_window_days: + title: "Click window days" + description: "Number of days to use as the conversion attribution\ + \ window for a pin click action." + default: 30 + enum: + - 0 + - 1 + - 7 + - 14 + - 30 + - 60 + type: "integer" + order: 4 + engagement_window_days: + title: "Engagement window days" + description: "Number of days to use as the conversion attribution\ + \ window for an engagement action." + default: + - 30 + enum: + - 0 + - 1 + - 7 + - 14 + - 30 + - 60 + type: "integer" + order: 5 + view_window_days: + title: "View window days" + description: "Number of days to use as the conversion attribution\ + \ window for a view action." + default: + - 30 + enum: + - 0 + - 1 + - 7 + - 14 + - 30 + - 60 + type: "integer" + order: 6 + conversion_report_time: + title: "Conversion report time" + description: "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.." + default: "TIME_OF_AD_ACTION" + enum: + - "TIME_OF_AD_ACTION" + - "TIME_OF_CONVERSION" + type: "string" + order: 7 + attribution_types: + title: "Attribution types" + description: "List of types of attribution for the conversion report" + default: + - "INDIVIDUAL" + - "HOUSEHOLD" + type: "array" + items: + title: "ValidEnums" + description: "An enumeration." + enum: + - "INDIVIDUAL" + - "HOUSEHOLD" + order: 8 + start_date: + type: "string" + title: "Start Date" + description: "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)." + format: "date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + pattern_descriptor: "YYYY-MM-DD" + examples: + - "2022-07-28" + order: 9 + source-spacex-api: + type: "object" + required: + - "sourceType" + properties: + id: + title: "Unique ID for specific source target" + type: "string" + desciption: "Optional, For a specific ID" + order: 0 + options: + title: "Configuration options for endpoints" + type: "string" + desciption: "Optional, Possible values for an endpoint. Example values for\ + \ launches-latest, upcoming, past" + order: 1 + sourceType: + title: "spacex-api" + const: "spacex-api" + enum: + - "spacex-api" + order: 0 + type: "string" + source-spacex-api-update: + type: "object" + required: [] + properties: + id: + title: "Unique ID for specific source target" + type: "string" + desciption: "Optional, For a specific ID" + order: 0 + options: + title: "Configuration options for endpoints" + type: "string" + desciption: "Optional, Possible values for an endpoint. Example values for\ + \ launches-latest, upcoming, past" + order: 1 + source-google-analytics-v4-service-account-only: + title: "Google Analytics (V4) Spec" + type: "object" + required: + - "view_id" + - "start_date" + - "sourceType" + properties: + credentials: + order: 0 + type: "object" + title: "Credentials" + description: "Credentials for the service" + oneOf: + - type: "object" + title: "Service Account Key Authentication" + required: + - "credentials_json" + properties: + auth_type: + type: "string" + const: "Service" + order: 0 + enum: + - "Service" + credentials_json: + title: "Service Account JSON Key" + type: "string" + description: "The JSON key of the service account to use for authorization" + examples: + - "{ \"type\": \"service_account\", \"project_id\": YOUR_PROJECT_ID,\ + \ \"private_key_id\": YOUR_PRIVATE_KEY, ... }" + airbyte_secret: true + start_date: + order: 1 + type: "string" + title: "Replication Start Date" + description: "The date in the format YYYY-MM-DD. Any data before this date\ + \ will not be replicated." + examples: + - "2020-06-01" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$|^$|[\\s\\S]+$" + format: "date" + view_id: + order: 2 + type: "string" + title: "View ID" + description: "The ID for the Google Analytics View you want to fetch data\ + \ from. This can be found from the Google Analytics Account Explorer." + end_date: + order: 3 + type: "string" + title: "Replication End Date" + description: "The date in the format YYYY-MM-DD. Any data after this date\ + \ will not be replicated." + examples: + - "2020-06-01" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$|^$|[\\s\\S]+$" + format: "date" + custom_reports: + order: 4 + type: "string" + title: "Custom Reports" + description: "A JSON array describing the custom reports you want to sync\ + \ from Google Analytics. See the docs for more information about the exact format you can use\ + \ to fill out this field." + window_in_days: + type: "integer" + title: "Data request time increment in days" + description: "The time increment used by the connector when requesting data\ + \ from the Google Analytics API. More information is available in the\ + \ the docs. The bigger this value is, the faster the sync will be,\ + \ but the more likely that sampling will be applied to your data, potentially\ + \ causing inaccuracies in the returned results. We recommend setting this\ + \ to 1 unless you have a hard requirement to make the sync faster at the\ + \ expense of accuracy. The minimum allowed value for this field is 1,\ + \ and the maximum is 364. " + examples: + - 30 + - 60 + - 90 + - 120 + - 200 + - 364 + default: 1 + order: 5 + sourceType: + title: "google-analytics-v4-service-account-only" + const: "google-analytics-v4-service-account-only" + enum: + - "google-analytics-v4-service-account-only" + order: 0 + type: "string" + source-google-analytics-v4-service-account-only-update: + title: "Google Analytics (V4) Spec" + type: "object" + required: + - "view_id" + - "start_date" + properties: + credentials: + order: 0 + type: "object" + title: "Credentials" + description: "Credentials for the service" + oneOf: + - type: "object" + title: "Service Account Key Authentication" + required: + - "credentials_json" + properties: + auth_type: + type: "string" + const: "Service" + order: 0 + enum: + - "Service" + credentials_json: + title: "Service Account JSON Key" + type: "string" + description: "The JSON key of the service account to use for authorization" + examples: + - "{ \"type\": \"service_account\", \"project_id\": YOUR_PROJECT_ID,\ + \ \"private_key_id\": YOUR_PRIVATE_KEY, ... }" + airbyte_secret: true + start_date: + order: 1 + type: "string" + title: "Replication Start Date" + description: "The date in the format YYYY-MM-DD. Any data before this date\ + \ will not be replicated." + examples: + - "2020-06-01" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$|^$|[\\s\\S]+$" + format: "date" + view_id: + order: 2 + type: "string" + title: "View ID" + description: "The ID for the Google Analytics View you want to fetch data\ + \ from. This can be found from the Google Analytics Account Explorer." + end_date: + order: 3 + type: "string" + title: "Replication End Date" + description: "The date in the format YYYY-MM-DD. Any data after this date\ + \ will not be replicated." + examples: + - "2020-06-01" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$|^$|[\\s\\S]+$" + format: "date" + custom_reports: + order: 4 + type: "string" + title: "Custom Reports" + description: "A JSON array describing the custom reports you want to sync\ + \ from Google Analytics. See the docs for more information about the exact format you can use\ + \ to fill out this field." + window_in_days: + type: "integer" + title: "Data request time increment in days" + description: "The time increment used by the connector when requesting data\ + \ from the Google Analytics API. More information is available in the\ + \ the docs. The bigger this value is, the faster the sync will be,\ + \ but the more likely that sampling will be applied to your data, potentially\ + \ causing inaccuracies in the returned results. We recommend setting this\ + \ to 1 unless you have a hard requirement to make the sync faster at the\ + \ expense of accuracy. The minimum allowed value for this field is 1,\ + \ and the maximum is 364. " + examples: + - 30 + - 60 + - 90 + - 120 + - 200 + - 364 + default: 1 + order: 5 + source-bamboo-hr: + title: "Bamboo HR Spec" + type: "object" + required: + - "subdomain" + - "api_key" + - "sourceType" + properties: + subdomain: + type: "string" + description: "Sub Domain of bamboo hr" + api_key: + type: "string" + description: "Api key of bamboo hr" + airbyte_secret: true + x-speakeasy-param-sensitive: true + custom_reports_fields: + type: "string" + default: "" + description: "Comma-separated list of fields to include in custom reports." + custom_reports_include_default_fields: + type: "boolean" + default: true + description: "If true, the custom reports endpoint will include the default\ + \ fields defined here: https://documentation.bamboohr.com/docs/list-of-field-names." + sourceType: + title: "bamboo-hr" + const: "bamboo-hr" + enum: + - "bamboo-hr" + order: 0 + type: "string" + source-bamboo-hr-update: + title: "Bamboo HR Spec" + type: "object" + required: + - "subdomain" + - "api_key" + properties: + subdomain: + type: "string" + description: "Sub Domain of bamboo hr" + api_key: + type: "string" + description: "Api key of bamboo hr" + airbyte_secret: true + custom_reports_fields: + type: "string" + default: "" + description: "Comma-separated list of fields to include in custom reports." + custom_reports_include_default_fields: + type: "boolean" + default: true + description: "If true, the custom reports endpoint will include the default\ + \ fields defined here: https://documentation.bamboohr.com/docs/list-of-field-names." + source-okta: + title: "Okta Spec" + type: "object" + required: + - "sourceType" + properties: + domain: + type: "string" + title: "Okta domain" + description: "The Okta domain. See the docs for instructions on how to find it." + airbyte_secret: false + start_date: + type: "string" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + description: "UTC date and time in the format YYYY-MM-DDTHH:MM:SSZ. Any\ + \ data before this date will not be replicated." + examples: + - "2022-07-22T00:00:00Z" + title: "Start Date" + credentials: + title: "Authorization Method" + type: "object" + oneOf: + - type: "object" + title: "OAuth2.0" + required: + - "auth_type" + - "client_id" + - "client_secret" + - "refresh_token" + properties: + auth_type: + type: "string" + const: "oauth2.0" + order: 0 + enum: + - "oauth2.0" + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your OAuth application." + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of your OAuth application." + airbyte_secret: true + refresh_token: + type: "string" + title: "Refresh Token" + description: "Refresh Token to obtain new Access Token, when it's\ + \ expired." + airbyte_secret: true + x-speakeasy-param-sensitive: true + - type: "object" + title: "API Token" + required: + - "auth_type" + - "api_token" + properties: + auth_type: + type: "string" + const: "api_token" + order: 0 + enum: + - "api_token" + api_token: + type: "string" + title: "Personal API Token" + description: "An Okta token. See the docs for instructions on how to generate it." + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "okta" + const: "okta" + enum: + - "okta" + order: 0 + type: "string" + source-okta-update: + title: "Okta Spec" + type: "object" + required: [] + properties: + domain: + type: "string" + title: "Okta domain" + description: "The Okta domain. See the docs for instructions on how to find it." + airbyte_secret: false + start_date: + type: "string" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + description: "UTC date and time in the format YYYY-MM-DDTHH:MM:SSZ. Any\ + \ data before this date will not be replicated." + examples: + - "2022-07-22T00:00:00Z" + title: "Start Date" + credentials: + title: "Authorization Method" + type: "object" + oneOf: + - type: "object" + title: "OAuth2.0" + required: + - "auth_type" + - "client_id" + - "client_secret" + - "refresh_token" + properties: + auth_type: + type: "string" + const: "oauth2.0" + order: 0 + enum: + - "oauth2.0" + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your OAuth application." + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of your OAuth application." + airbyte_secret: true + refresh_token: + type: "string" + title: "Refresh Token" + description: "Refresh Token to obtain new Access Token, when it's\ + \ expired." + airbyte_secret: true + - type: "object" + title: "API Token" + required: + - "auth_type" + - "api_token" + properties: + auth_type: + type: "string" + const: "api_token" + order: 0 + enum: + - "api_token" + api_token: + type: "string" + title: "Personal API Token" + description: "An Okta token. See the docs for instructions on how to generate it." + airbyte_secret: true + source-mixpanel: + title: "Source Mixpanel Spec" + required: + - "credentials" + - "sourceType" + type: "object" + properties: + credentials: + title: "Authentication *" + description: "Choose how to authenticate to Mixpanel" + type: "object" + order: 0 + oneOf: + - type: "object" + title: "Service Account" + required: + - "username" + - "secret" + - "project_id" + properties: + option_title: + type: "string" + const: "Service Account" + order: 0 + enum: + - "Service Account" + username: + order: 1 + title: "Username" + type: "string" + description: "Mixpanel Service Account Username. See the docs\ + \ for more information on how to obtain this." + secret: + order: 2 + title: "Secret" + type: "string" + description: "Mixpanel Service Account Secret. See the docs\ + \ for more information on how to obtain this." + airbyte_secret: true + project_id: + order: 3 + title: "Project ID" + description: "Your project ID number. See the docs for more information on how to obtain this." + type: "integer" + - type: "object" + title: "Project Secret" + required: + - "api_secret" + properties: + option_title: + type: "string" + const: "Project Secret" + order: 0 + enum: + - "Project Secret" + api_secret: + order: 1 + title: "Project Secret" + type: "string" + description: "Mixpanel project secret. See the docs for more information on how to obtain this." + airbyte_secret: true + attribution_window: + order: 2 + title: "Attribution Window" + type: "integer" + description: "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)" + default: 5 + project_timezone: + order: 3 + title: "Project Timezone" + type: "string" + description: "Time zone in which integer date times are stored. The project\ + \ timezone may be found in the project settings in the Mixpanel console." + default: "US/Pacific" + examples: + - "US/Pacific" + - "UTC" + select_properties_by_default: + order: 4 + title: "Select Properties By Default" + type: "boolean" + description: "Setting this config parameter to TRUE ensures that new properties\ + \ on events and engage records are captured. Otherwise new properties\ + \ will be ignored." + default: true + start_date: + order: 5 + title: "Start Date" + type: "string" + description: "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." + examples: + - "2021-11-16" + pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}Z)?$" + format: "date" + end_date: + order: 6 + title: "End Date" + type: "string" + description: "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" + examples: + - "2021-11-16" + pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}Z)?$" + format: "date" + region: + order: 7 + title: "Region" + description: "The region of mixpanel domain instance either US or EU." + type: "string" + enum: + - "US" + - "EU" + default: "US" + date_window_size: + order: 8 + title: "Date slicing window" + description: "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)" + type: "integer" + minimum: 1 + default: 30 + sourceType: + title: "mixpanel" + const: "mixpanel" + enum: + - "mixpanel" + order: 0 + type: "string" + source-mixpanel-update: + title: "Source Mixpanel Spec" + required: + - "credentials" + type: "object" + properties: + credentials: + title: "Authentication *" + description: "Choose how to authenticate to Mixpanel" + type: "object" + order: 0 + oneOf: + - type: "object" + title: "Service Account" + required: + - "username" + - "secret" + - "project_id" + properties: + option_title: + type: "string" + const: "Service Account" + order: 0 + enum: + - "Service Account" + username: + order: 1 + title: "Username" + type: "string" + description: "Mixpanel Service Account Username. See the docs\ + \ for more information on how to obtain this." + secret: + order: 2 + title: "Secret" + type: "string" + description: "Mixpanel Service Account Secret. See the docs\ + \ for more information on how to obtain this." + airbyte_secret: true + project_id: + order: 3 + title: "Project ID" + description: "Your project ID number. See the docs for more information on how to obtain this." + type: "integer" + - type: "object" + title: "Project Secret" + required: + - "api_secret" + properties: + option_title: + type: "string" + const: "Project Secret" + order: 0 + enum: + - "Project Secret" + api_secret: + order: 1 + title: "Project Secret" + type: "string" + description: "Mixpanel project secret. See the docs for more information on how to obtain this." + airbyte_secret: true + attribution_window: + order: 2 + title: "Attribution Window" + type: "integer" + description: "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)" + default: 5 + project_timezone: + order: 3 + title: "Project Timezone" + type: "string" + description: "Time zone in which integer date times are stored. The project\ + \ timezone may be found in the project settings in the Mixpanel console." + default: "US/Pacific" + examples: + - "US/Pacific" + - "UTC" + select_properties_by_default: + order: 4 + title: "Select Properties By Default" + type: "boolean" + description: "Setting this config parameter to TRUE ensures that new properties\ + \ on events and engage records are captured. Otherwise new properties\ + \ will be ignored." + default: true + start_date: + order: 5 + title: "Start Date" + type: "string" + description: "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." + examples: + - "2021-11-16" + pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}Z)?$" + format: "date" + end_date: + order: 6 + title: "End Date" + type: "string" + description: "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" + examples: + - "2021-11-16" + pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}Z)?$" + format: "date" + region: + order: 7 + title: "Region" + description: "The region of mixpanel domain instance either US or EU." + type: "string" + enum: + - "US" + - "EU" + default: "US" + date_window_size: + order: 8 + title: "Date slicing window" + description: "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)" + type: "integer" + minimum: 1 + default: 30 + source-ip2whois: + title: "Ip2whois Spec" + type: "object" + properties: + api_key: + title: "API key" + type: "string" + description: "Your API Key. See here." + airbyte_secret: true + x-speakeasy-param-sensitive: true + domain: + title: "Domain" + type: "string" + description: "Domain name. See here." + examples: + - "www.google.com" + - "www.facebook.com" + sourceType: + title: "ip2whois" + const: "ip2whois" + enum: + - "ip2whois" + order: 0 + type: "string" + source-ip2whois-update: + title: "Ip2whois Spec" + type: "object" + properties: + api_key: + title: "API key" + type: "string" + description: "Your API Key. See here." + airbyte_secret: true + domain: + title: "Domain" + type: "string" + description: "Domain name. See here." + examples: + - "www.google.com" + - "www.facebook.com" + source-twitter: + title: "Twitter Spec" + type: "object" + required: + - "api_key" + - "query" + - "sourceType" + properties: + api_key: + type: "string" + title: "Access Token" + description: "App only Bearer Token. See the docs for more information on how to obtain this token." + airbyte_secret: true + order: 0 + x-speakeasy-param-sensitive: true + query: + type: "string" + title: "Search Query" + description: "Query for matching Tweets. You can learn how to build this\ + \ query by reading build a query guide ." + order: 1 + start_date: + type: "string" + title: "Start Date" + description: "The start date for retrieving tweets cannot be more than 7\ + \ days in the past." + format: "date-time" + order: 2 + end_date: + type: "string" + title: "End Date" + description: "The end date for retrieving tweets must be a minimum of 10\ + \ seconds prior to the request time." + format: "date-time" + order: 3 + sourceType: + title: "twitter" + const: "twitter" + enum: + - "twitter" + order: 0 + type: "string" + source-twitter-update: + title: "Twitter Spec" + type: "object" + required: + - "api_key" + - "query" + properties: + api_key: + type: "string" + title: "Access Token" + description: "App only Bearer Token. See the docs for more information on how to obtain this token." + airbyte_secret: true + order: 0 + query: + type: "string" + title: "Search Query" + description: "Query for matching Tweets. You can learn how to build this\ + \ query by reading build a query guide ." + order: 1 + start_date: + type: "string" + title: "Start Date" + description: "The start date for retrieving tweets cannot be more than 7\ + \ days in the past." + format: "date-time" + order: 2 + end_date: + type: "string" + title: "End Date" + description: "The end date for retrieving tweets must be a minimum of 10\ + \ seconds prior to the request time." + format: "date-time" + order: 3 + source-sftp-bulk: + title: "FTP Source Spec" + type: "object" + required: + - "username" + - "host" + - "port" + - "stream_name" + - "start_date" + - "folder_path" + - "sourceType" + properties: + username: + title: "User Name" + description: "The server user" + type: "string" + order: 0 + password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 1 + x-speakeasy-param-sensitive: true + private_key: + title: "Private key" + description: "The private key" + type: "string" + multiline: true + order: 2 + x-speakeasy-param-sensitive: true + host: + title: "Host Address" + description: "The server host address" + type: "string" + examples: + - "www.host.com" + - "192.0.2.1" + order: 3 + port: + title: "Port" + description: "The server port" + type: "integer" + default: 22 + examples: + - "22" + order: 4 + stream_name: + title: "Stream name" + description: "The name of the stream or table you want to create" + type: "string" + examples: + - "ftp_contacts" + order: 5 + file_type: + title: "File type" + description: "The file type you want to sync. Currently only 'csv' and 'json'\ + \ files are supported." + type: "string" + default: "csv" + enum: + - "csv" + - "json" + order: 6 + examples: + - "csv" + - "json" + separator: + title: "CSV Separator (Optional)" + description: "The separator used in the CSV files. Define None if you want\ + \ to use the Sniffer functionality" + type: "string" + default: "," + examples: + - "," + order: 7 + folder_path: + title: "Folder Path (Optional)" + description: "The directory to search files for sync" + type: "string" + default: "" + examples: + - "/logs/2022" + order: 8 + file_pattern: + title: "File Pattern (Optional)" + description: "The regular expression to specify files for sync in a chosen\ + \ Folder Path" + type: "string" + default: "" + examples: + - "log-([0-9]{4})([0-9]{2})([0-9]{2}) - This will filter files which `log-yearmmdd`" + order: 9 + file_most_recent: + title: "Most recent file (Optional)" + description: "Sync only the most recent file for the configured folder path\ + \ and file pattern" + type: "boolean" + default: false + order: 10 + start_date: + type: "string" + title: "Start Date" + format: "date-time" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2017-01-25T00:00:00Z" + description: "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." + order: 11 + sourceType: + title: "sftp-bulk" + const: "sftp-bulk" + enum: + - "sftp-bulk" + order: 0 + type: "string" + source-sftp-bulk-update: + title: "FTP Source Spec" + type: "object" + required: + - "username" + - "host" + - "port" + - "stream_name" + - "start_date" + - "folder_path" + properties: + username: + title: "User Name" + description: "The server user" + type: "string" + order: 0 + password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 1 + private_key: + title: "Private key" + description: "The private key" + type: "string" + multiline: true + order: 2 + host: + title: "Host Address" + description: "The server host address" + type: "string" + examples: + - "www.host.com" + - "192.0.2.1" + order: 3 + port: + title: "Port" + description: "The server port" + type: "integer" + default: 22 + examples: + - "22" + order: 4 + stream_name: + title: "Stream name" + description: "The name of the stream or table you want to create" + type: "string" + examples: + - "ftp_contacts" + order: 5 + file_type: + title: "File type" + description: "The file type you want to sync. Currently only 'csv' and 'json'\ + \ files are supported." + type: "string" + default: "csv" + enum: + - "csv" + - "json" + order: 6 + examples: + - "csv" + - "json" + separator: + title: "CSV Separator (Optional)" + description: "The separator used in the CSV files. Define None if you want\ + \ to use the Sniffer functionality" + type: "string" + default: "," + examples: + - "," + order: 7 + folder_path: + title: "Folder Path (Optional)" + description: "The directory to search files for sync" + type: "string" + default: "" + examples: + - "/logs/2022" + order: 8 + file_pattern: + title: "File Pattern (Optional)" + description: "The regular expression to specify files for sync in a chosen\ + \ Folder Path" + type: "string" + default: "" + examples: + - "log-([0-9]{4})([0-9]{2})([0-9]{2}) - This will filter files which `log-yearmmdd`" + order: 9 + file_most_recent: + title: "Most recent file (Optional)" + description: "Sync only the most recent file for the configured folder path\ + \ and file pattern" + type: "boolean" + default: false + order: 10 + start_date: + type: "string" + title: "Start Date" + format: "date-time" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2017-01-25T00:00:00Z" + description: "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." + order: 11 + source-zendesk-support: + title: "Source Zendesk Support Spec" + type: "object" + required: + - "subdomain" + - "sourceType" + properties: + start_date: + type: "string" + title: "Start Date" + description: "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." + examples: + - "2020-10-15T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + pattern_descriptor: "YYYY-MM-DDTHH:mm:ssZ" + format: "date-time" + order: 2 + subdomain: + type: "string" + title: "Subdomain" + description: "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." + order: 0 + credentials: + title: "Authentication" + type: "object" + description: "Zendesk allows two authentication methods. We recommend using\ + \ `OAuth2.0` for Airbyte Cloud users and `API token` for Airbyte Open\ + \ Source users." + order: 1 + oneOf: + - title: "OAuth2.0" + type: "object" + required: + - "access_token" + additionalProperties: true + properties: + credentials: + type: "string" + const: "oauth2.0" + order: 0 + enum: + - "oauth2.0" + access_token: + type: "string" + title: "Access Token" + description: "The OAuth access token. See the Zendesk docs for more information on generating this token." + airbyte_secret: true + x-speakeasy-param-sensitive: true + client_id: + type: "string" + title: "Client ID" + description: "The OAuth client's ID. See this guide for more information." + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "The OAuth client secret. See this guide for more information." + airbyte_secret: true + - title: "API Token" + type: "object" + required: + - "email" + - "api_token" + additionalProperties: true + properties: + credentials: + type: "string" + const: "api_token" + order: 0 + enum: + - "api_token" + email: + title: "Email" + type: "string" + description: "The user email for your Zendesk account." + api_token: + title: "API Token" + type: "string" + description: "The value of the API token generated. See our full documentation for more information on generating this\ + \ token." + airbyte_secret: true + x-speakeasy-param-sensitive: true + ignore_pagination: + type: "boolean" + default: false + description: "Makes each stream read a single page of data." + title: "Should the connector read the second and further pages of data." + airbyte_hidden: true + sourceType: + title: "zendesk-support" + const: "zendesk-support" + enum: + - "zendesk-support" + order: 0 + type: "string" + source-zendesk-support-update: + title: "Source Zendesk Support Spec" + type: "object" + required: + - "subdomain" + properties: + start_date: + type: "string" + title: "Start Date" + description: "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." + examples: + - "2020-10-15T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + pattern_descriptor: "YYYY-MM-DDTHH:mm:ssZ" + format: "date-time" + order: 2 + subdomain: + type: "string" + title: "Subdomain" + description: "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." + order: 0 + credentials: + title: "Authentication" + type: "object" + description: "Zendesk allows two authentication methods. We recommend using\ + \ `OAuth2.0` for Airbyte Cloud users and `API token` for Airbyte Open\ + \ Source users." + order: 1 + oneOf: + - title: "OAuth2.0" + type: "object" + required: + - "access_token" + additionalProperties: true + properties: + credentials: + type: "string" + const: "oauth2.0" + order: 0 + enum: + - "oauth2.0" + access_token: + type: "string" + title: "Access Token" + description: "The OAuth access token. See the Zendesk docs for more information on generating this token." + airbyte_secret: true + client_id: + type: "string" + title: "Client ID" + description: "The OAuth client's ID. See this guide for more information." + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "The OAuth client secret. See this guide for more information." + airbyte_secret: true + - title: "API Token" + type: "object" + required: + - "email" + - "api_token" + additionalProperties: true + properties: + credentials: + type: "string" + const: "api_token" + order: 0 + enum: + - "api_token" + email: + title: "Email" + type: "string" + description: "The user email for your Zendesk account." + api_token: + title: "API Token" + type: "string" + description: "The value of the API token generated. See our full documentation for more information on generating this\ + \ token." + airbyte_secret: true + ignore_pagination: + type: "boolean" + default: false + description: "Makes each stream read a single page of data." + title: "Should the connector read the second and further pages of data." + airbyte_hidden: true + source-microsoft-onedrive: + title: "Microsoft OneDrive Source Spec" + description: "SourceMicrosoftOneDriveSpec class for Microsoft OneDrive Source\ + \ Specification.\nThis class combines the authentication details with additional\ + \ configuration for the OneDrive API." + type: "object" + properties: + start_date: + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00.000000Z.\ + \ Any file modified before this date will not be replicated." + examples: + - "2021-01-01T00:00:00.000000Z" + format: "date-time" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$" + pattern_descriptor: "YYYY-MM-DDTHH:mm:ss.SSSSSSZ" + order: 1 + type: "string" + streams: + title: "The list of streams to sync" + description: "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." + order: 10 + type: "array" + items: + title: "FileBasedStreamConfig" + type: "object" + properties: + name: + title: "Name" + description: "The name of the stream." + type: "string" + globs: + title: "Globs" + description: "The pattern used to specify which files should be selected\ + \ from the file system. For more information on glob pattern matching\ + \ look here." + default: + - "**" + order: 1 + type: "array" + items: + type: "string" + validation_policy: + title: "Validation Policy" + description: "The name of the validation policy that dictates sync\ + \ behavior when a record does not adhere to the stream schema." + default: "Emit Record" + enum: + - "Emit Record" + - "Skip Record" + - "Wait for Discover" + input_schema: + title: "Input Schema" + description: "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." + type: "string" + primary_key: + title: "Primary Key" + description: "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." + airbyte_hidden: true + type: "string" + x-speakeasy-param-sensitive: true + days_to_sync_if_history_is_full: + title: "Days To Sync If History Is Full" + description: "When the state history of the file store is full, syncs\ + \ will only read files that were last modified in the provided day\ + \ range." + default: 3 + type: "integer" + format: + title: "Format" + description: "The configuration options that are used to alter how\ + \ to read incoming files that deviate from the standard formatting." + type: "object" + oneOf: + - title: "Avro Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "avro" + const: "avro" + type: "string" + enum: + - "avro" + double_as_string: + title: "Convert Double Fields to Strings" + description: "Whether to convert double fields to strings. This\ + \ is recommended if you have decimal numbers with a high degree\ + \ of precision because there can be a loss precision when\ + \ handling floating point numbers." + default: false + type: "boolean" + required: + - "filetype" + - title: "CSV Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "csv" + const: "csv" + type: "string" + enum: + - "csv" + delimiter: + title: "Delimiter" + description: "The character delimiting individual cells in the\ + \ CSV data. This may only be a 1-character string. For tab-delimited\ + \ data enter '\\t'." + default: "," + type: "string" + quote_char: + title: "Quote Character" + description: "The character used for quoting CSV values. To\ + \ disallow quoting, make this field blank." + default: "\"" + type: "string" + escape_char: + title: "Escape Character" + description: "The character used for escaping special characters.\ + \ To disallow escaping, leave this field blank." + type: "string" + encoding: + title: "Encoding" + description: "The character encoding of the CSV data. Leave\ + \ blank to default to UTF8. See list of python encodings for allowable\ + \ options." + default: "utf8" + type: "string" + double_quote: + title: "Double Quote" + description: "Whether two quotes in a quoted CSV value denote\ + \ a single quote in the data." + default: true + type: "boolean" + null_values: + title: "Null Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as null values. For example, if the value 'NA'\ + \ should be interpreted as null, enter 'NA' in this field." + default: [] + type: "array" + items: + type: "string" + uniqueItems: true + strings_can_be_null: + title: "Strings Can Be Null" + description: "Whether strings can be interpreted as null values.\ + \ If true, strings that match the null_values set will be\ + \ interpreted as null. If false, strings that match the null_values\ + \ set will be interpreted as the string itself." + default: true + type: "boolean" + skip_rows_before_header: + title: "Skip Rows Before Header" + description: "The number of rows to skip before the header row.\ + \ For example, if the header row is on the 3rd row, enter\ + \ 2 in this field." + default: 0 + type: "integer" + skip_rows_after_header: + title: "Skip Rows After Header" + description: "The number of rows to skip after the header row." + default: 0 + type: "integer" + header_definition: + title: "CSV Header Definition" + description: "How headers will be defined. `User Provided` assumes\ + \ the CSV does not have a header row and uses the headers\ + \ provided and `Autogenerated` assumes the CSV does not have\ + \ a header row and the CDK will generate headers using for\ + \ `f{i}` where `i` is the index starting from 0. Else, the\ + \ default behavior is to use the header from the CSV file.\ + \ If a user wants to autogenerate or provide column names\ + \ for a CSV having headers, they can skip rows." + default: + header_definition_type: "From CSV" + oneOf: + - title: "From CSV" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "From CSV" + const: "From CSV" + type: "string" + enum: + - "From CSV" + required: + - "header_definition_type" + - title: "Autogenerated" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "Autogenerated" + const: "Autogenerated" + type: "string" + enum: + - "Autogenerated" + required: + - "header_definition_type" + - title: "User Provided" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "User Provided" + const: "User Provided" + type: "string" + enum: + - "User Provided" + column_names: + title: "Column Names" + description: "The column names that will be used while\ + \ emitting the CSV records" + type: "array" + items: + type: "string" + required: + - "column_names" + - "header_definition_type" + type: "object" + true_values: + title: "True Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as true values." + default: + - "y" + - "yes" + - "t" + - "true" + - "on" + - "1" + type: "array" + items: + type: "string" + uniqueItems: true + false_values: + title: "False Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as false values." + default: + - "n" + - "no" + - "f" + - "false" + - "off" + - "0" + type: "array" + items: + type: "string" + uniqueItems: true + required: + - "filetype" + - title: "Jsonl Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "jsonl" + const: "jsonl" + type: "string" + enum: + - "jsonl" + required: + - "filetype" + - title: "Parquet Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "parquet" + const: "parquet" + type: "string" + enum: + - "parquet" + decimal_as_float: + title: "Convert Decimal Fields to Floats" + description: "Whether to convert decimal fields to floats. There\ + \ is a loss of precision when converting decimals to floats,\ + \ so this is not recommended." + default: false + type: "boolean" + required: + - "filetype" + - title: "Document File Type Format (Experimental)" + type: "object" + properties: + filetype: + title: "Filetype" + default: "unstructured" + const: "unstructured" + type: "string" + enum: + - "unstructured" + skip_unprocessable_files: + title: "Skip Unprocessable Files" + description: "If true, skip files that cannot be parsed and\ + \ pass the error message along as the _ab_source_file_parse_error\ + \ field. If false, fail the sync." + default: true + always_show: true + type: "boolean" + strategy: + title: "Parsing Strategy" + description: "The strategy used to parse documents. `fast` extracts\ + \ text directly from the document which doesn't work for all\ + \ files. `ocr_only` is more reliable, but slower. `hi_res`\ + \ is the most reliable, but requires an API key and a hosted\ + \ instance of unstructured and can't be used with local mode.\ + \ See the unstructured.io documentation for more details:\ + \ https://unstructured-io.github.io/unstructured/core/partition.html#partition-pdf" + default: "auto" + always_show: true + order: 0 + enum: + - "auto" + - "fast" + - "ocr_only" + - "hi_res" + type: "string" + processing: + title: "Processing" + description: "Processing configuration" + default: + mode: "local" + type: "object" + oneOf: + - title: "Local" + type: "object" + properties: + mode: + title: "Mode" + default: "local" + const: "local" + enum: + - "local" + type: "string" + description: "Process files locally, supporting `fast` and\ + \ `ocr` modes. This is the default option." + required: + - "mode" + description: "Extract text from document formats (.pdf, .docx, .md,\ + \ .pptx) and emit as one record per file." + required: + - "filetype" + schemaless: + title: "Schemaless" + description: "When enabled, syncs will not validate or structure records\ + \ against the stream's schema." + default: false + type: "boolean" + required: + - "name" + - "format" + credentials: + title: "Authentication" + description: "Credentials for connecting to the One Drive API" + type: "object" + order: 0 + oneOf: + - title: "Authenticate via Microsoft (OAuth)" + description: "OAuthCredentials class to hold authentication details for\ + \ Microsoft OAuth authentication.\nThis class uses pydantic for data\ + \ validation and settings management." + type: "object" + properties: + auth_type: + title: "Auth Type" + default: "Client" + const: "Client" + enum: + - "Client" + type: "string" + tenant_id: + title: "Tenant ID" + description: "Tenant ID of the Microsoft OneDrive user" + airbyte_secret: true + type: "string" + client_id: + title: "Client ID" + description: "Client ID of your Microsoft developer application" + airbyte_secret: true + type: "string" + client_secret: + title: "Client Secret" + description: "Client Secret of your Microsoft developer application" + airbyte_secret: true + type: "string" + refresh_token: + title: "Refresh Token" + description: "Refresh Token of your Microsoft developer application" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + required: + - "tenant_id" + - "client_id" + - "client_secret" + - "refresh_token" + - title: "Service Key Authentication" + description: "ServiceCredentials class for service key authentication.\n\ + This class is structured similarly to OAuthCredentials but for a different\ + \ authentication method." + type: "object" + properties: + auth_type: + title: "Auth Type" + default: "Service" + const: "Service" + enum: + - "Service" + type: "string" + tenant_id: + title: "Tenant ID" + description: "Tenant ID of the Microsoft OneDrive user" + airbyte_secret: true + type: "string" + user_principal_name: + title: "User Principal Name" + description: "Special characters such as a period, comma, space, and\ + \ the at sign (@) are converted to underscores (_). More details:\ + \ https://learn.microsoft.com/en-us/sharepoint/list-onedrive-urls" + airbyte_secret: true + type: "string" + client_id: + title: "Client ID" + description: "Client ID of your Microsoft developer application" + airbyte_secret: true + type: "string" + client_secret: + title: "Client Secret" + description: "Client Secret of your Microsoft developer application" + airbyte_secret: true + type: "string" + required: + - "tenant_id" + - "user_principal_name" + - "client_id" + - "client_secret" + drive_name: + title: "Drive Name" + description: "Name of the Microsoft OneDrive drive where the file(s) exist." + default: "OneDrive" + order: 2 + type: "string" + search_scope: + title: "Search Scope" + description: "Specifies the location(s) to search for files. Valid options\ + \ are 'ACCESSIBLE_DRIVES' to search in the selected OneDrive drive, 'SHARED_ITEMS'\ + \ for shared items the user has access to, and 'ALL' to search both." + default: "ALL" + enum: + - "ACCESSIBLE_DRIVES" + - "SHARED_ITEMS" + - "ALL" + order: 3 + type: "string" + folder_path: + title: "Folder Path" + description: "Path to a specific folder within the drives to search for\ + \ files. Leave empty to search all folders of the drives. This does not\ + \ apply to shared items." + default: "." + order: 4 + type: "string" + sourceType: + title: "microsoft-onedrive" + const: "microsoft-onedrive" + enum: + - "microsoft-onedrive" + order: 0 + type: "string" + required: + - "streams" + - "credentials" + - "sourceType" + source-microsoft-onedrive-update: + title: "Microsoft OneDrive Source Spec" + description: "SourceMicrosoftOneDriveSpec class for Microsoft OneDrive Source\ + \ Specification.\nThis class combines the authentication details with additional\ + \ configuration for the OneDrive API." + type: "object" + properties: + start_date: + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00.000000Z.\ + \ Any file modified before this date will not be replicated." + examples: + - "2021-01-01T00:00:00.000000Z" + format: "date-time" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$" + pattern_descriptor: "YYYY-MM-DDTHH:mm:ss.SSSSSSZ" + order: 1 + type: "string" + streams: + title: "The list of streams to sync" + description: "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." + order: 10 + type: "array" + items: + title: "FileBasedStreamConfig" + type: "object" + properties: + name: + title: "Name" + description: "The name of the stream." + type: "string" + globs: + title: "Globs" + description: "The pattern used to specify which files should be selected\ + \ from the file system. For more information on glob pattern matching\ + \ look here." + default: + - "**" + order: 1 + type: "array" + items: + type: "string" + validation_policy: + title: "Validation Policy" + description: "The name of the validation policy that dictates sync\ + \ behavior when a record does not adhere to the stream schema." + default: "Emit Record" + enum: + - "Emit Record" + - "Skip Record" + - "Wait for Discover" + input_schema: + title: "Input Schema" + description: "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." + type: "string" + primary_key: + title: "Primary Key" + description: "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." + airbyte_hidden: true + type: "string" + days_to_sync_if_history_is_full: + title: "Days To Sync If History Is Full" + description: "When the state history of the file store is full, syncs\ + \ will only read files that were last modified in the provided day\ + \ range." + default: 3 + type: "integer" + format: + title: "Format" + description: "The configuration options that are used to alter how\ + \ to read incoming files that deviate from the standard formatting." + type: "object" + oneOf: + - title: "Avro Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "avro" + const: "avro" + type: "string" + enum: + - "avro" + double_as_string: + title: "Convert Double Fields to Strings" + description: "Whether to convert double fields to strings. This\ + \ is recommended if you have decimal numbers with a high degree\ + \ of precision because there can be a loss precision when\ + \ handling floating point numbers." + default: false + type: "boolean" + required: + - "filetype" + - title: "CSV Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "csv" + const: "csv" + type: "string" + enum: + - "csv" + delimiter: + title: "Delimiter" + description: "The character delimiting individual cells in the\ + \ CSV data. This may only be a 1-character string. For tab-delimited\ + \ data enter '\\t'." + default: "," + type: "string" + quote_char: + title: "Quote Character" + description: "The character used for quoting CSV values. To\ + \ disallow quoting, make this field blank." + default: "\"" + type: "string" + escape_char: + title: "Escape Character" + description: "The character used for escaping special characters.\ + \ To disallow escaping, leave this field blank." + type: "string" + encoding: + title: "Encoding" + description: "The character encoding of the CSV data. Leave\ + \ blank to default to UTF8. See list of python encodings for allowable\ + \ options." + default: "utf8" + type: "string" + double_quote: + title: "Double Quote" + description: "Whether two quotes in a quoted CSV value denote\ + \ a single quote in the data." + default: true + type: "boolean" + null_values: + title: "Null Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as null values. For example, if the value 'NA'\ + \ should be interpreted as null, enter 'NA' in this field." + default: [] + type: "array" + items: + type: "string" + uniqueItems: true + strings_can_be_null: + title: "Strings Can Be Null" + description: "Whether strings can be interpreted as null values.\ + \ If true, strings that match the null_values set will be\ + \ interpreted as null. If false, strings that match the null_values\ + \ set will be interpreted as the string itself." + default: true + type: "boolean" + skip_rows_before_header: + title: "Skip Rows Before Header" + description: "The number of rows to skip before the header row.\ + \ For example, if the header row is on the 3rd row, enter\ + \ 2 in this field." + default: 0 + type: "integer" + skip_rows_after_header: + title: "Skip Rows After Header" + description: "The number of rows to skip after the header row." + default: 0 + type: "integer" + header_definition: + title: "CSV Header Definition" + description: "How headers will be defined. `User Provided` assumes\ + \ the CSV does not have a header row and uses the headers\ + \ provided and `Autogenerated` assumes the CSV does not have\ + \ a header row and the CDK will generate headers using for\ + \ `f{i}` where `i` is the index starting from 0. Else, the\ + \ default behavior is to use the header from the CSV file.\ + \ If a user wants to autogenerate or provide column names\ + \ for a CSV having headers, they can skip rows." + default: + header_definition_type: "From CSV" + oneOf: + - title: "From CSV" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "From CSV" + const: "From CSV" + type: "string" + enum: + - "From CSV" + required: + - "header_definition_type" + - title: "Autogenerated" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "Autogenerated" + const: "Autogenerated" + type: "string" + enum: + - "Autogenerated" + required: + - "header_definition_type" + - title: "User Provided" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "User Provided" + const: "User Provided" + type: "string" + enum: + - "User Provided" + column_names: + title: "Column Names" + description: "The column names that will be used while\ + \ emitting the CSV records" + type: "array" + items: + type: "string" + required: + - "column_names" + - "header_definition_type" + type: "object" + true_values: + title: "True Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as true values." + default: + - "y" + - "yes" + - "t" + - "true" + - "on" + - "1" + type: "array" + items: + type: "string" + uniqueItems: true + false_values: + title: "False Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as false values." + default: + - "n" + - "no" + - "f" + - "false" + - "off" + - "0" + type: "array" + items: + type: "string" + uniqueItems: true + required: + - "filetype" + - title: "Jsonl Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "jsonl" + const: "jsonl" + type: "string" + enum: + - "jsonl" + required: + - "filetype" + - title: "Parquet Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "parquet" + const: "parquet" + type: "string" + enum: + - "parquet" + decimal_as_float: + title: "Convert Decimal Fields to Floats" + description: "Whether to convert decimal fields to floats. There\ + \ is a loss of precision when converting decimals to floats,\ + \ so this is not recommended." + default: false + type: "boolean" + required: + - "filetype" + - title: "Document File Type Format (Experimental)" + type: "object" + properties: + filetype: + title: "Filetype" + default: "unstructured" + const: "unstructured" + type: "string" + enum: + - "unstructured" + skip_unprocessable_files: + title: "Skip Unprocessable Files" + description: "If true, skip files that cannot be parsed and\ + \ pass the error message along as the _ab_source_file_parse_error\ + \ field. If false, fail the sync." + default: true + always_show: true + type: "boolean" + strategy: + title: "Parsing Strategy" + description: "The strategy used to parse documents. `fast` extracts\ + \ text directly from the document which doesn't work for all\ + \ files. `ocr_only` is more reliable, but slower. `hi_res`\ + \ is the most reliable, but requires an API key and a hosted\ + \ instance of unstructured and can't be used with local mode.\ + \ See the unstructured.io documentation for more details:\ + \ https://unstructured-io.github.io/unstructured/core/partition.html#partition-pdf" + default: "auto" + always_show: true + order: 0 + enum: + - "auto" + - "fast" + - "ocr_only" + - "hi_res" + type: "string" + processing: + title: "Processing" + description: "Processing configuration" + default: + mode: "local" + type: "object" + oneOf: + - title: "Local" + type: "object" + properties: + mode: + title: "Mode" + default: "local" + const: "local" + enum: + - "local" + type: "string" + description: "Process files locally, supporting `fast` and\ + \ `ocr` modes. This is the default option." + required: + - "mode" + description: "Extract text from document formats (.pdf, .docx, .md,\ + \ .pptx) and emit as one record per file." + required: + - "filetype" + schemaless: + title: "Schemaless" + description: "When enabled, syncs will not validate or structure records\ + \ against the stream's schema." + default: false + type: "boolean" + required: + - "name" + - "format" + credentials: + title: "Authentication" + description: "Credentials for connecting to the One Drive API" + type: "object" + order: 0 + oneOf: + - title: "Authenticate via Microsoft (OAuth)" + description: "OAuthCredentials class to hold authentication details for\ + \ Microsoft OAuth authentication.\nThis class uses pydantic for data\ + \ validation and settings management." + type: "object" + properties: + auth_type: + title: "Auth Type" + default: "Client" + const: "Client" + enum: + - "Client" + type: "string" + tenant_id: + title: "Tenant ID" + description: "Tenant ID of the Microsoft OneDrive user" + airbyte_secret: true + type: "string" + client_id: + title: "Client ID" + description: "Client ID of your Microsoft developer application" + airbyte_secret: true + type: "string" + client_secret: + title: "Client Secret" + description: "Client Secret of your Microsoft developer application" + airbyte_secret: true + type: "string" + refresh_token: + title: "Refresh Token" + description: "Refresh Token of your Microsoft developer application" + airbyte_secret: true + type: "string" + required: + - "tenant_id" + - "client_id" + - "client_secret" + - "refresh_token" + - title: "Service Key Authentication" + description: "ServiceCredentials class for service key authentication.\n\ + This class is structured similarly to OAuthCredentials but for a different\ + \ authentication method." + type: "object" + properties: + auth_type: + title: "Auth Type" + default: "Service" + const: "Service" + enum: + - "Service" + type: "string" + tenant_id: + title: "Tenant ID" + description: "Tenant ID of the Microsoft OneDrive user" + airbyte_secret: true + type: "string" + user_principal_name: + title: "User Principal Name" + description: "Special characters such as a period, comma, space, and\ + \ the at sign (@) are converted to underscores (_). More details:\ + \ https://learn.microsoft.com/en-us/sharepoint/list-onedrive-urls" + airbyte_secret: true + type: "string" + client_id: + title: "Client ID" + description: "Client ID of your Microsoft developer application" + airbyte_secret: true + type: "string" + client_secret: + title: "Client Secret" + description: "Client Secret of your Microsoft developer application" + airbyte_secret: true + type: "string" + required: + - "tenant_id" + - "user_principal_name" + - "client_id" + - "client_secret" + drive_name: + title: "Drive Name" + description: "Name of the Microsoft OneDrive drive where the file(s) exist." + default: "OneDrive" + order: 2 + type: "string" + search_scope: + title: "Search Scope" + description: "Specifies the location(s) to search for files. Valid options\ + \ are 'ACCESSIBLE_DRIVES' to search in the selected OneDrive drive, 'SHARED_ITEMS'\ + \ for shared items the user has access to, and 'ALL' to search both." + default: "ALL" + enum: + - "ACCESSIBLE_DRIVES" + - "SHARED_ITEMS" + - "ALL" + order: 3 + type: "string" + folder_path: + title: "Folder Path" + description: "Path to a specific folder within the drives to search for\ + \ files. Leave empty to search all folders of the drives. This does not\ + \ apply to shared items." + default: "." + order: 4 + type: "string" + required: + - "streams" + - "credentials" + source-punk-api: + title: "Punk Api Spec" + type: "object" + required: + - "brewed_before" + - "brewed_after" + - "sourceType" + properties: + id: + title: "Beers with specific ID" + type: "string" + description: "To extract specific data with Unique ID" + examples: + - 1 + - 22 + brewed_before: + title: "Brewed before data to get incremental reads" + type: "string" + description: "To extract specific data with Unique ID" + pattern: "^[0-9]{2}-[0-9]{4}$" + examples: + - "MM-YYYY" + brewed_after: + title: "Brewed after data to get incremental reads" + type: "string" + description: "To extract specific data with Unique ID" + pattern: "^[0-9]{2}-[0-9]{4}$" + examples: + - "MM-YYYY" + sourceType: + title: "punk-api" + const: "punk-api" + enum: + - "punk-api" + order: 0 + type: "string" + source-punk-api-update: + title: "Punk Api Spec" + type: "object" + required: + - "brewed_before" + - "brewed_after" + properties: + id: + title: "Beers with specific ID" + type: "string" + description: "To extract specific data with Unique ID" + examples: + - 1 + - 22 + brewed_before: + title: "Brewed before data to get incremental reads" + type: "string" + description: "To extract specific data with Unique ID" + pattern: "^[0-9]{2}-[0-9]{4}$" + examples: + - "MM-YYYY" + brewed_after: + title: "Brewed after data to get incremental reads" + type: "string" + description: "To extract specific data with Unique ID" + pattern: "^[0-9]{2}-[0-9]{4}$" + examples: + - "MM-YYYY" + source-tiktok-marketing: + title: "TikTok Marketing Source Spec" + type: "object" + properties: + credentials: + title: "Authentication Method" + description: "Authentication method" + default: {} + order: 0 + type: "object" + oneOf: + - title: "OAuth2.0" + type: "object" + properties: + auth_type: + title: "Auth Type" + const: "oauth2.0" + order: 0 + type: "string" + enum: + - "oauth2.0" + app_id: + title: "App ID" + description: "The Developer Application App ID." + airbyte_secret: true + type: "string" + secret: + title: "Secret" + description: "The Developer Application Secret." + airbyte_secret: true + type: "string" + access_token: + title: "Access Token" + description: "Long-term Authorized Access Token." + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + advertiser_id: + title: "Advertiser ID" + description: "The Advertiser ID to filter reports and streams. Let\ + \ this empty to retrieve all." + type: "string" + required: + - "app_id" + - "secret" + - "access_token" + - title: "Sandbox Access Token" + type: "object" + properties: + auth_type: + title: "Auth Type" + const: "sandbox_access_token" + order: 0 + type: "string" + enum: + - "sandbox_access_token" + advertiser_id: + title: "Advertiser ID" + description: "The Advertiser ID which generated for the developer's\ + \ Sandbox application." + type: "string" + access_token: + title: "Access Token" + description: "The long-term authorized access token." + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + required: + - "advertiser_id" + - "access_token" + start_date: + title: "Replication Start Date" + description: "The Start Date in format: YYYY-MM-DD. Any data before this\ + \ date will not be replicated. If this parameter is not set, all data\ + \ will be replicated." + default: "2016-09-01" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + order: 1 + type: "string" + format: "date" + end_date: + title: "End Date" + description: "The date until which you'd like to replicate data for all\ + \ incremental streams, in the format YYYY-MM-DD. All data generated between\ + \ start_date and this date will be replicated. Not setting this option\ + \ will result in always syncing the data till the current date." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + order: 2 + type: "string" + format: "date" + attribution_window: + title: "Attribution Window" + description: "The attribution window in days." + minimum: 0 + maximum: 364 + default: 3 + order: 3 + type: "integer" + include_deleted: + title: "Include Deleted Data in Reports" + description: "Set to active if you want to include deleted data in reports." + default: false + order: 4 + type: "boolean" + sourceType: + title: "tiktok-marketing" + const: "tiktok-marketing" + enum: + - "tiktok-marketing" + order: 0 + type: "string" + source-tiktok-marketing-update: + title: "TikTok Marketing Source Spec" + type: "object" + properties: + credentials: + title: "Authentication Method" + description: "Authentication method" + default: {} + order: 0 + type: "object" + oneOf: + - title: "OAuth2.0" + type: "object" + properties: + auth_type: + title: "Auth Type" + const: "oauth2.0" + order: 0 + type: "string" + enum: + - "oauth2.0" + app_id: + title: "App ID" + description: "The Developer Application App ID." + airbyte_secret: true + type: "string" + secret: + title: "Secret" + description: "The Developer Application Secret." + airbyte_secret: true + type: "string" + access_token: + title: "Access Token" + description: "Long-term Authorized Access Token." + airbyte_secret: true + type: "string" + advertiser_id: + title: "Advertiser ID" + description: "The Advertiser ID to filter reports and streams. Let\ + \ this empty to retrieve all." + type: "string" + required: + - "app_id" + - "secret" + - "access_token" + - title: "Sandbox Access Token" + type: "object" + properties: + auth_type: + title: "Auth Type" + const: "sandbox_access_token" + order: 0 + type: "string" + enum: + - "sandbox_access_token" + advertiser_id: + title: "Advertiser ID" + description: "The Advertiser ID which generated for the developer's\ + \ Sandbox application." + type: "string" + access_token: + title: "Access Token" + description: "The long-term authorized access token." + airbyte_secret: true + type: "string" + required: + - "advertiser_id" + - "access_token" + start_date: + title: "Replication Start Date" + description: "The Start Date in format: YYYY-MM-DD. Any data before this\ + \ date will not be replicated. If this parameter is not set, all data\ + \ will be replicated." + default: "2016-09-01" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + order: 1 + type: "string" + format: "date" + end_date: + title: "End Date" + description: "The date until which you'd like to replicate data for all\ + \ incremental streams, in the format YYYY-MM-DD. All data generated between\ + \ start_date and this date will be replicated. Not setting this option\ + \ will result in always syncing the data till the current date." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + order: 2 + type: "string" + format: "date" + attribution_window: + title: "Attribution Window" + description: "The attribution window in days." + minimum: 0 + maximum: 364 + default: 3 + order: 3 + type: "integer" + include_deleted: + title: "Include Deleted Data in Reports" + description: "Set to active if you want to include deleted data in reports." + default: false + order: 4 + type: "boolean" + source-aws-cloudtrail: + title: "Aws CloudTrail Spec" + type: "object" + required: + - "aws_key_id" + - "aws_secret_key" + - "aws_region_name" + - "start_date" + - "sourceType" + properties: + aws_key_id: + type: "string" + title: "Key ID" + description: "AWS CloudTrail Access Key ID. See the docs for more information on how to obtain this key." + airbyte_secret: true + x-speakeasy-param-sensitive: true + aws_secret_key: + type: "string" + title: "Secret Key" + description: "AWS CloudTrail Access Key ID. See the docs for more information on how to obtain this key." + airbyte_secret: true + x-speakeasy-param-sensitive: true + aws_region_name: + type: "string" + title: "Region Name" + description: "The default AWS Region to use, for example, us-west-1 or us-west-2.\ + \ When specifying a Region inline during client initialization, this property\ + \ is named region_name." + start_date: + type: "string" + title: "Start Date" + description: "The date you would like to replicate data. Data in AWS CloudTrail\ + \ is available for last 90 days only. Format: YYYY-MM-DD." + examples: + - "2021-01-01" + default: "1970-01-01" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + format: "date" + sourceType: + title: "aws-cloudtrail" + const: "aws-cloudtrail" + enum: + - "aws-cloudtrail" + order: 0 + type: "string" + source-aws-cloudtrail-update: + title: "Aws CloudTrail Spec" + type: "object" + required: + - "aws_key_id" + - "aws_secret_key" + - "aws_region_name" + - "start_date" + properties: + aws_key_id: + type: "string" + title: "Key ID" + description: "AWS CloudTrail Access Key ID. See the docs for more information on how to obtain this key." + airbyte_secret: true + aws_secret_key: + type: "string" + title: "Secret Key" + description: "AWS CloudTrail Access Key ID. See the docs for more information on how to obtain this key." + airbyte_secret: true + aws_region_name: + type: "string" + title: "Region Name" + description: "The default AWS Region to use, for example, us-west-1 or us-west-2.\ + \ When specifying a Region inline during client initialization, this property\ + \ is named region_name." + start_date: + type: "string" + title: "Start Date" + description: "The date you would like to replicate data. Data in AWS CloudTrail\ + \ is available for last 90 days only. Format: YYYY-MM-DD." + examples: + - "2021-01-01" + default: "1970-01-01" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + format: "date" + source-jira: + title: "Jira Spec" + type: "object" + required: + - "api_token" + - "domain" + - "email" + - "sourceType" + properties: + api_token: + type: "string" + title: "API Token" + description: "Jira API Token. See the docs for more information on how to generate this key. API Token\ + \ is used for Authorization to your account by BasicAuth." + airbyte_secret: true + order: 0 + x-speakeasy-param-sensitive: true + domain: + type: "string" + title: "Domain" + examples: + - ".atlassian.net" + - ".jira.com" + - "jira..com" + description: "The Domain for your Jira account, e.g. airbyteio.atlassian.net,\ + \ airbyteio.jira.com, jira.your-domain.com" + order: 1 + email: + type: "string" + title: "Email" + description: "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." + order: 2 + projects: + type: "array" + title: "Projects" + items: + type: "string" + examples: + - "PROJ1" + - "PROJ2" + description: "List of Jira project keys to replicate data for, or leave\ + \ it empty if you want to replicate data for all projects." + order: 3 + start_date: + type: "string" + title: "Start Date" + description: "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." + examples: + - "2021-03-01T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + format: "date-time" + order: 4 + expand_issue_changelog: + type: "boolean" + title: "Expand Issue Changelog" + airbyte_hidden: true + description: "(DEPRECATED) Expand the changelog when replicating issues." + default: false + render_fields: + type: "boolean" + title: "Render Issue Fields" + airbyte_hidden: true + description: "(DEPRECATED) Render issue fields in HTML format in addition\ + \ to Jira JSON-like format." + default: false + expand_issue_transition: + type: "boolean" + title: "Expand Issue Transitions" + airbyte_hidden: true + description: "(DEPRECATED) Expand the transitions when replicating issues." + default: false + issues_stream_expand_with: + type: "array" + items: + type: "string" + enum: + - "renderedFields" + - "transitions" + - "changelog" + title: "Expand Issues stream" + airbyte_hidden: true + description: "Select fields to Expand the `Issues` stream when replicating\ + \ with: " + default: [] + lookback_window_minutes: + title: "Lookback window" + description: "When set to N, the connector will always refresh resources\ + \ created within the past N minutes. By default, updated objects that\ + \ are not newly created are not incrementally synced." + examples: + - 60 + default: 0 + minimum: 0 + maximum: 576000 + type: "integer" + order: 5 + enable_experimental_streams: + type: "boolean" + title: "Enable Experimental Streams" + description: "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." + default: false + order: 6 + sourceType: + title: "jira" + const: "jira" + enum: + - "jira" + order: 0 + type: "string" + source-jira-update: + title: "Jira Spec" + type: "object" + required: + - "api_token" + - "domain" + - "email" + properties: + api_token: + type: "string" + title: "API Token" + description: "Jira API Token. See the docs for more information on how to generate this key. API Token\ + \ is used for Authorization to your account by BasicAuth." + airbyte_secret: true + order: 0 + domain: + type: "string" + title: "Domain" + examples: + - ".atlassian.net" + - ".jira.com" + - "jira..com" + description: "The Domain for your Jira account, e.g. airbyteio.atlassian.net,\ + \ airbyteio.jira.com, jira.your-domain.com" + order: 1 + email: + type: "string" + title: "Email" + description: "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." + order: 2 + projects: + type: "array" + title: "Projects" + items: + type: "string" + examples: + - "PROJ1" + - "PROJ2" + description: "List of Jira project keys to replicate data for, or leave\ + \ it empty if you want to replicate data for all projects." + order: 3 + start_date: + type: "string" + title: "Start Date" + description: "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." + examples: + - "2021-03-01T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + format: "date-time" + order: 4 + expand_issue_changelog: + type: "boolean" + title: "Expand Issue Changelog" + airbyte_hidden: true + description: "(DEPRECATED) Expand the changelog when replicating issues." + default: false + render_fields: + type: "boolean" + title: "Render Issue Fields" + airbyte_hidden: true + description: "(DEPRECATED) Render issue fields in HTML format in addition\ + \ to Jira JSON-like format." + default: false + expand_issue_transition: + type: "boolean" + title: "Expand Issue Transitions" + airbyte_hidden: true + description: "(DEPRECATED) Expand the transitions when replicating issues." + default: false + issues_stream_expand_with: + type: "array" + items: + type: "string" + enum: + - "renderedFields" + - "transitions" + - "changelog" + title: "Expand Issues stream" + airbyte_hidden: true + description: "Select fields to Expand the `Issues` stream when replicating\ + \ with: " + default: [] + lookback_window_minutes: + title: "Lookback window" + description: "When set to N, the connector will always refresh resources\ + \ created within the past N minutes. By default, updated objects that\ + \ are not newly created are not incrementally synced." + examples: + - 60 + default: 0 + minimum: 0 + maximum: 576000 + type: "integer" + order: 5 + enable_experimental_streams: + type: "boolean" + title: "Enable Experimental Streams" + description: "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." + default: false + order: 6 + source-hubspot: + title: "HubSpot Source Spec" + type: "object" + required: + - "credentials" + - "sourceType" + properties: + start_date: + type: "string" + title: "Start date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated. If not set, \"2006-06-01T00:00:00Z\"\ + \ (Hubspot creation date) will be used as start date. It's recommended\ + \ to provide relevant to your data start date value to optimize synchronization." + examples: + - "2017-01-25T00:00:00Z" + format: "date-time" + credentials: + title: "Authentication" + description: "Choose how to authenticate to HubSpot." + type: "object" + oneOf: + - type: "object" + title: "OAuth" + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "credentials_title" + properties: + credentials_title: + type: "string" + title: "Auth Type" + description: "Name of the credentials" + const: "OAuth Credentials" + order: 0 + enum: + - "OAuth Credentials" + client_id: + title: "Client ID" + description: "The Client ID of your HubSpot developer application.\ + \ See the Hubspot docs if you need help finding this ID." + type: "string" + examples: + - "123456789000" + client_secret: + title: "Client Secret" + description: "The client secret for your HubSpot developer application.\ + \ See the Hubspot docs if you need help finding this secret." + type: "string" + examples: + - "secret" + airbyte_secret: true + refresh_token: + title: "Refresh Token" + description: "Refresh token to renew an expired access token. See\ + \ the Hubspot docs if you need help finding this token." + type: "string" + examples: + - "refresh_token" + airbyte_secret: true + x-speakeasy-param-sensitive: true + - type: "object" + title: "Private App" + required: + - "access_token" + - "credentials_title" + properties: + credentials_title: + type: "string" + title: "Auth Type" + description: "Name of the credentials set" + const: "Private App Credentials" + order: 0 + enum: + - "Private App Credentials" + access_token: + title: "Access token" + description: "HubSpot Access token. See the Hubspot docs if you need help finding this token." + type: "string" + airbyte_secret: true + x-speakeasy-param-sensitive: true + enable_experimental_streams: + title: "Enable experimental streams" + description: "If enabled then experimental streams become available for\ + \ sync." + type: "boolean" + default: false + sourceType: + title: "hubspot" + const: "hubspot" + enum: + - "hubspot" + order: 0 + type: "string" + source-hubspot-update: + title: "HubSpot Source Spec" + type: "object" + required: + - "credentials" + properties: + start_date: + type: "string" + title: "Start date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated. If not set, \"2006-06-01T00:00:00Z\"\ + \ (Hubspot creation date) will be used as start date. It's recommended\ + \ to provide relevant to your data start date value to optimize synchronization." + examples: + - "2017-01-25T00:00:00Z" + format: "date-time" + credentials: + title: "Authentication" + description: "Choose how to authenticate to HubSpot." + type: "object" + oneOf: + - type: "object" + title: "OAuth" + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "credentials_title" + properties: + credentials_title: + type: "string" + title: "Auth Type" + description: "Name of the credentials" + const: "OAuth Credentials" + order: 0 + enum: + - "OAuth Credentials" + client_id: + title: "Client ID" + description: "The Client ID of your HubSpot developer application.\ + \ See the Hubspot docs if you need help finding this ID." + type: "string" + examples: + - "123456789000" + client_secret: + title: "Client Secret" + description: "The client secret for your HubSpot developer application.\ + \ See the Hubspot docs if you need help finding this secret." + type: "string" + examples: + - "secret" + airbyte_secret: true + refresh_token: + title: "Refresh Token" + description: "Refresh token to renew an expired access token. See\ + \ the Hubspot docs if you need help finding this token." + type: "string" + examples: + - "refresh_token" + airbyte_secret: true + - type: "object" + title: "Private App" + required: + - "access_token" + - "credentials_title" + properties: + credentials_title: + type: "string" + title: "Auth Type" + description: "Name of the credentials set" + const: "Private App Credentials" + order: 0 + enum: + - "Private App Credentials" + access_token: + title: "Access token" + description: "HubSpot Access token. See the Hubspot docs if you need help finding this token." + type: "string" + airbyte_secret: true + enable_experimental_streams: + title: "Enable experimental streams" + description: "If enabled then experimental streams become available for\ + \ sync." + type: "boolean" + default: false + source-rss: + title: "RSS Spec" + type: "object" + required: + - "url" + - "sourceType" + properties: + url: + type: "string" + description: "RSS Feed URL" + sourceType: + title: "rss" + const: "rss" + enum: + - "rss" + order: 0 + type: "string" + source-rss-update: + title: "RSS Spec" + type: "object" + required: + - "url" + properties: + url: + type: "string" + description: "RSS Feed URL" + source-sap-fieldglass: + title: "Sap Fieldglass Spec" + type: "object" + required: + - "api_key" + - "sourceType" + properties: + api_key: + type: "string" + description: "API Key" + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "sap-fieldglass" + const: "sap-fieldglass" + enum: + - "sap-fieldglass" + order: 0 + type: "string" + source-sap-fieldglass-update: + title: "Sap Fieldglass Spec" + type: "object" + required: + - "api_key" + properties: + api_key: + type: "string" + description: "API Key" + airbyte_secret: true + source-twilio-taskrouter: + title: "Twilio Taskrouter Spec" + type: "object" + required: + - "account_sid" + - "auth_token" + - "sourceType" + properties: + account_sid: + title: "Account SID" + type: "string" + description: "Twilio Account ID" + airbyte_secret: true + auth_token: + type: "string" + description: "Twilio Auth Token" + airbyte_secret: true + title: "Auth Token" + x-speakeasy-param-sensitive: true + sourceType: + title: "twilio-taskrouter" + const: "twilio-taskrouter" + enum: + - "twilio-taskrouter" + order: 0 + type: "string" + source-twilio-taskrouter-update: + title: "Twilio Taskrouter Spec" + type: "object" + required: + - "account_sid" + - "auth_token" + properties: + account_sid: + title: "Account SID" + type: "string" + description: "Twilio Account ID" + airbyte_secret: true + auth_token: + type: "string" + description: "Twilio Auth Token" + airbyte_secret: true + title: "Auth Token" + source-xkcd: + title: "Xkcd Spec" + type: "object" + properties: + sourceType: + title: "xkcd" + const: "xkcd" + enum: + - "xkcd" + order: 0 + type: "string" + source-xkcd-update: + title: "Xkcd Spec" + type: "object" + properties: {} + source-zenloop: + title: "Zenloop Spec" + type: "object" + required: + - "api_token" + - "sourceType" + properties: + api_token: + type: "string" + description: "Zenloop API Token. You can get the API token in settings page\ + \ here " + airbyte_secret: true + x-speakeasy-param-sensitive: true + date_from: + type: "string" + description: "Zenloop date_from. Format: 2021-10-24T03:30:30Z or 2021-10-24.\ + \ Leave empty if only data from current data should be synced" + examples: + - "2021-10-24T03:30:30Z" + survey_id: + type: "string" + description: "Zenloop Survey ID. Can be found here. Leave empty to pull answers from all surveys" + airbyte_secret: true + survey_group_id: + type: "string" + description: "Zenloop Survey Group ID. Can be found by pulling All Survey\ + \ Groups via SurveyGroups stream. Leave empty to pull answers from all\ + \ survey groups" + airbyte_secret: true + sourceType: + title: "zenloop" + const: "zenloop" + enum: + - "zenloop" + order: 0 + type: "string" + source-zenloop-update: + title: "Zenloop Spec" + type: "object" + required: + - "api_token" + properties: + api_token: + type: "string" + description: "Zenloop API Token. You can get the API token in settings page\ + \ here " + airbyte_secret: true + date_from: + type: "string" + description: "Zenloop date_from. Format: 2021-10-24T03:30:30Z or 2021-10-24.\ + \ Leave empty if only data from current data should be synced" + examples: + - "2021-10-24T03:30:30Z" + survey_id: + type: "string" + description: "Zenloop Survey ID. Can be found here. Leave empty to pull answers from all surveys" + airbyte_secret: true + survey_group_id: + type: "string" + description: "Zenloop Survey Group ID. Can be found by pulling All Survey\ + \ Groups via SurveyGroups stream. Leave empty to pull answers from all\ + \ survey groups" + airbyte_secret: true + source-tempo: + title: "Tempo Spec" + type: "object" + required: + - "api_token" + - "sourceType" + properties: + api_token: + type: "string" + title: "API token" + description: "Tempo API Token. Go to Tempo>Settings, scroll down to Data\ + \ Access and select API integration." + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "tempo" + const: "tempo" + enum: + - "tempo" + order: 0 + type: "string" + source-tempo-update: + title: "Tempo Spec" + type: "object" + required: + - "api_token" + properties: + api_token: + type: "string" + title: "API token" + description: "Tempo API Token. Go to Tempo>Settings, scroll down to Data\ + \ Access and select API integration." + airbyte_secret: true + source-chargebee: + title: "Chargebee Spec" + type: "object" + required: + - "site" + - "site_api_key" + - "start_date" + - "sourceType" + properties: + site_api_key: + type: "string" + title: "API Key" + description: "Chargebee API Key. See the docs for more information on how to obtain this key." + airbyte_secret: true + order: 0 + x-speakeasy-param-sensitive: true + site: + type: "string" + title: "Site" + description: "The site prefix for your Chargebee instance." + examples: + - "airbyte-test" + order: 1 + start_date: + type: "string" + format: "date-time" + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00.000Z.\ + \ Any data before this date will not be replicated." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2021-01-25T00:00:00Z" + order: 2 + product_catalog: + type: "string" + title: "Product Catalog" + description: "Product Catalog version of your Chargebee site. Instructions\ + \ on how to find your version you may find here under `API Version` section. If left blank, the product catalog\ + \ version will be set to 2.0." + enum: + - "1.0" + - "2.0" + default: "2.0" + order: 3 + sourceType: + title: "chargebee" + const: "chargebee" + enum: + - "chargebee" + order: 0 + type: "string" + source-chargebee-update: + title: "Chargebee Spec" + type: "object" + required: + - "site" + - "site_api_key" + - "start_date" + properties: + site_api_key: + type: "string" + title: "API Key" + description: "Chargebee API Key. See the docs for more information on how to obtain this key." + airbyte_secret: true + order: 0 + site: + type: "string" + title: "Site" + description: "The site prefix for your Chargebee instance." + examples: + - "airbyte-test" + order: 1 + start_date: + type: "string" + format: "date-time" + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00.000Z.\ + \ Any data before this date will not be replicated." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2021-01-25T00:00:00Z" + order: 2 + product_catalog: + type: "string" + title: "Product Catalog" + description: "Product Catalog version of your Chargebee site. Instructions\ + \ on how to find your version you may find here under `API Version` section. If left blank, the product catalog\ + \ version will be set to 2.0." + enum: + - "1.0" + - "2.0" + default: "2.0" + order: 3 + source-onesignal: + title: "OneSignal Source Spec" + type: "object" + required: + - "user_auth_key" + - "start_date" + - "outcome_names" + - "applications" + - "sourceType" + properties: + user_auth_key: + type: "string" + title: "User Auth Key" + description: "OneSignal User Auth Key, see the docs for more information on how to obtain this key." + airbyte_secret: true + order: 0 + x-speakeasy-param-sensitive: true + applications: + type: "array" + title: "Applications" + description: "Applications keys, see the docs for more information on how to obtain this data" + items: + type: "object" + properties: + app_name: + type: "string" + title: "OneSignal App Name" + order: 0 + app_id: + type: "string" + title: "OneSignal App ID" + order: 1 + airbyte_secret: true + app_api_key: + type: "string" + title: "REST API Key" + order: 2 + airbyte_secret: true + x-speakeasy-param-sensitive: true + required: + - "app_id" + - "app_api_key" + order: 1 + start_date: + type: "string" + title: "Start Date" + description: "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." + examples: + - "2020-11-16T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + format: "date-time" + order: 2 + outcome_names: + type: "string" + title: "Outcome Names" + description: "Comma-separated list of names and the value (sum/count) for\ + \ the returned outcome data. See the docs for more details" + examples: + - "os__session_duration.count,os__click.count,CustomOutcomeName.sum" + order: 3 + sourceType: + title: "onesignal" + const: "onesignal" + enum: + - "onesignal" + order: 0 + type: "string" + source-onesignal-update: + title: "OneSignal Source Spec" + type: "object" + required: + - "user_auth_key" + - "start_date" + - "outcome_names" + - "applications" + properties: + user_auth_key: + type: "string" + title: "User Auth Key" + description: "OneSignal User Auth Key, see the docs for more information on how to obtain this key." + airbyte_secret: true + order: 0 + applications: + type: "array" + title: "Applications" + description: "Applications keys, see the docs for more information on how to obtain this data" + items: + type: "object" + properties: + app_name: + type: "string" + title: "OneSignal App Name" + order: 0 + app_id: + type: "string" + title: "OneSignal App ID" + order: 1 + airbyte_secret: true + app_api_key: + type: "string" + title: "REST API Key" + order: 2 + airbyte_secret: true + required: + - "app_id" + - "app_api_key" + order: 1 + start_date: + type: "string" + title: "Start Date" + description: "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." + examples: + - "2020-11-16T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + format: "date-time" + order: 2 + outcome_names: + type: "string" + title: "Outcome Names" + description: "Comma-separated list of names and the value (sum/count) for\ + \ the returned outcome data. See the docs for more details" + examples: + - "os__session_duration.count,os__click.count,CustomOutcomeName.sum" + order: 3 + source-google-analytics-data-api: + title: "Google Analytics (Data API) Spec" + type: "object" + required: + - "property_ids" + - "sourceType" + properties: + credentials: + order: 0 + type: "object" + title: "Credentials" + description: "Credentials for the service" + oneOf: + - title: "Authenticate via Google (Oauth)" + type: "object" + required: + - "client_id" + - "client_secret" + - "refresh_token" + properties: + auth_type: + type: "string" + const: "Client" + order: 0 + enum: + - "Client" + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Google Analytics developer application." + order: 1 + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Google Analytics developer\ + \ application." + airbyte_secret: true + order: 2 + refresh_token: + title: "Refresh Token" + type: "string" + description: "The token for obtaining a new access token." + airbyte_secret: true + order: 3 + x-speakeasy-param-sensitive: true + access_token: + title: "Access Token" + type: "string" + description: "Access Token for making authenticated requests." + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + - type: "object" + title: "Service Account Key Authentication" + required: + - "credentials_json" + properties: + auth_type: + type: "string" + const: "Service" + order: 0 + enum: + - "Service" + credentials_json: + title: "Service Account JSON Key" + type: "string" + description: "The JSON key linked to the service account used for\ + \ authorization. For steps on obtaining this key, refer to the setup guide." + examples: + - "{ \"type\": \"service_account\", \"project_id\": YOUR_PROJECT_ID,\ + \ \"private_key_id\": YOUR_PRIVATE_KEY, ... }" + airbyte_secret: true + order: 1 + property_ids: + title: "Property IDs" + description: "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." + order: 1 + type: "array" + items: + type: "string" + pattern: "^[0-9]*$" + examples: + - - "1738294" + - "5729978930" + date_ranges_start_date: + type: "string" + title: "Start Date" + description: "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." + format: "date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + pattern_descriptor: "YYYY-MM-DD" + examples: + - "2021-01-01" + order: 2 + custom_reports_array: + title: "Custom Reports" + description: "You can add your Custom Analytics report by creating one." + order: 4 + type: "array" + items: + title: "Custom Report Config" + type: "object" + properties: + name: + title: "Name" + description: "The name of the custom report, this name would be used\ + \ as stream name." + type: "string" + order: 0 + dimensions: + title: "Dimensions" + description: "A list of dimensions." + type: "array" + items: + type: "string" + minItems: 1 + order: 1 + metrics: + title: "Metrics" + description: "A list of metrics." + type: "array" + items: + type: "string" + minItems: 1 + order: 2 + dimensionFilter: + title: "Dimensions filter" + description: "Dimensions filter" + type: "object" + order: 3 + oneOf: + - title: "andGroup" + description: "The FilterExpressions in andGroup have an AND relationship." + type: "object" + properties: + filter_type: + type: "string" + const: "andGroup" + order: 0 + enum: + - "andGroup" + expressions: + title: "Expressions" + type: "array" + order: 1 + items: + title: "Expression" + type: "object" + properties: + field_name: + title: "fieldName" + type: "string" + order: 1 + filter: + title: "filter" + type: "object" + order: 2 + oneOf: + - title: "stringFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "stringFilter" + enum: + - "stringFilter" + matchType: + title: "matchType" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "MATCH_TYPE_UNSPECIFIED" + - "EXACT" + - "BEGINS_WITH" + - "ENDS_WITH" + - "CONTAINS" + - "FULL_REGEXP" + - "PARTIAL_REGEXP" + value: + tittle: "value" + type: "string" + order: 0 + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 2 + required: + - "filter_name" + - "value" + - title: "inListFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "inListFilter" + enum: + - "inListFilter" + values: + tittle: "values" + type: "array" + minItems: 1 + order: 0 + items: + type: "string" + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 1 + required: + - "filter_name" + - "values" + - title: "numericFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "numericFilter" + enum: + - "numericFilter" + operation: + title: "operation" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "OPERATION_UNSPECIFIED" + - "EQUAL" + - "LESS_THAN" + - "LESS_THAN_OR_EQUAL" + - "GREATER_THAN" + - "GREATER_THAN_OR_EQUAL" + value: + tittle: "value" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "operation" + - "value" + - title: "betweenFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "betweenFilter" + enum: + - "betweenFilter" + fromValue: + tittle: "fromValue" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + toValue: + tittle: "toValue" + type: "object" + order: 1 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "fromValue" + - "toValue" + required: + - "field_name" + - "filter" + required: + - "filter_type" + - "expressions" + - title: "orGroup" + type: "object" + description: "The FilterExpressions in orGroup have an OR relationship." + properties: + filter_type: + type: "string" + const: "orGroup" + order: 0 + enum: + - "orGroup" + expressions: + title: "Expressions" + type: "array" + order: 1 + items: + title: "Expression" + type: "object" + properties: + field_name: + title: "fieldName" + type: "string" + order: 1 + filter: + title: "filter" + type: "object" + order: 2 + oneOf: + - title: "stringFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "stringFilter" + enum: + - "stringFilter" + matchType: + title: "matchType" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "MATCH_TYPE_UNSPECIFIED" + - "EXACT" + - "BEGINS_WITH" + - "ENDS_WITH" + - "CONTAINS" + - "FULL_REGEXP" + - "PARTIAL_REGEXP" + value: + tittle: "value" + type: "string" + order: 0 + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 2 + required: + - "filter_name" + - "value" + - title: "inListFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "inListFilter" + enum: + - "inListFilter" + values: + tittle: "values" + type: "array" + minItems: 1 + order: 0 + items: + type: "string" + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 1 + required: + - "filter_name" + - "values" + - title: "numericFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "numericFilter" + enum: + - "numericFilter" + operation: + title: "operation" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "OPERATION_UNSPECIFIED" + - "EQUAL" + - "LESS_THAN" + - "LESS_THAN_OR_EQUAL" + - "GREATER_THAN" + - "GREATER_THAN_OR_EQUAL" + value: + tittle: "value" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "operation" + - "value" + - title: "betweenFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "betweenFilter" + enum: + - "betweenFilter" + fromValue: + tittle: "fromValue" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + toValue: + tittle: "toValue" + type: "object" + order: 1 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "fromValue" + - "toValue" + required: + - "field_name" + - "filter" + required: + - "filter_type" + - "expressions" + - title: "notExpression" + type: "object" + description: "The FilterExpression is NOT of notExpression." + properties: + filter_type: + type: "string" + const: "notExpression" + order: 0 + enum: + - "notExpression" + expression: + title: "Expression" + type: "object" + properties: + field_name: + title: "fieldName" + type: "string" + order: 1 + filter: + title: "filter" + type: "object" + order: 2 + oneOf: + - title: "stringFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "stringFilter" + enum: + - "stringFilter" + matchType: + title: "matchType" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "MATCH_TYPE_UNSPECIFIED" + - "EXACT" + - "BEGINS_WITH" + - "ENDS_WITH" + - "CONTAINS" + - "FULL_REGEXP" + - "PARTIAL_REGEXP" + value: + tittle: "value" + type: "string" + order: 0 + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 2 + required: + - "filter_name" + - "value" + - title: "inListFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "inListFilter" + enum: + - "inListFilter" + values: + tittle: "values" + type: "array" + minItems: 1 + order: 0 + items: + type: "string" + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 1 + required: + - "filter_name" + - "values" + - title: "numericFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "numericFilter" + enum: + - "numericFilter" + operation: + title: "operation" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "OPERATION_UNSPECIFIED" + - "EQUAL" + - "LESS_THAN" + - "LESS_THAN_OR_EQUAL" + - "GREATER_THAN" + - "GREATER_THAN_OR_EQUAL" + value: + tittle: "value" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "operation" + - "value" + - title: "betweenFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "betweenFilter" + enum: + - "betweenFilter" + fromValue: + tittle: "fromValue" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + toValue: + tittle: "toValue" + type: "object" + order: 1 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "fromValue" + - "toValue" + required: + - "field_name" + - "filter" + - title: "filter" + type: "object" + description: "A primitive filter. In the same FilterExpression,\ + \ all of the filter's field names need to be either all dimensions." + properties: + filter_type: + type: "string" + const: "filter" + order: 0 + enum: + - "filter" + field_name: + title: "fieldName" + type: "string" + order: 1 + filter: + title: "filter" + type: "object" + order: 2 + oneOf: + - title: "stringFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "stringFilter" + enum: + - "stringFilter" + matchType: + title: "matchType" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "MATCH_TYPE_UNSPECIFIED" + - "EXACT" + - "BEGINS_WITH" + - "ENDS_WITH" + - "CONTAINS" + - "FULL_REGEXP" + - "PARTIAL_REGEXP" + value: + tittle: "value" + type: "string" + order: 0 + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 2 + required: + - "filter_name" + - "value" + - title: "inListFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "inListFilter" + enum: + - "inListFilter" + values: + tittle: "values" + type: "array" + minItems: 1 + order: 0 + items: + type: "string" + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 1 + required: + - "filter_name" + - "values" + - title: "numericFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "numericFilter" + enum: + - "numericFilter" + operation: + title: "operation" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "OPERATION_UNSPECIFIED" + - "EQUAL" + - "LESS_THAN" + - "LESS_THAN_OR_EQUAL" + - "GREATER_THAN" + - "GREATER_THAN_OR_EQUAL" + value: + tittle: "value" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "operation" + - "value" + - title: "betweenFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "betweenFilter" + enum: + - "betweenFilter" + fromValue: + tittle: "fromValue" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + toValue: + tittle: "toValue" + type: "object" + order: 1 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "fromValue" + - "toValue" + required: + - "field_name" + - "filter" + metricFilter: + title: "Metrics filter" + description: "Metrics filter" + type: "object" + order: 4 + oneOf: + - title: "andGroup" + description: "The FilterExpressions in andGroup have an AND relationship." + type: "object" + properties: + filter_type: + type: "string" + const: "andGroup" + order: 0 + enum: + - "andGroup" + expressions: + title: "Expressions" + type: "array" + order: 1 + items: + title: "Expression" + type: "object" + properties: + field_name: + title: "fieldName" + type: "string" + order: 1 + filter: + title: "filter" + type: "object" + order: 2 + oneOf: + - title: "stringFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "stringFilter" + enum: + - "stringFilter" + matchType: + title: "matchType" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "MATCH_TYPE_UNSPECIFIED" + - "EXACT" + - "BEGINS_WITH" + - "ENDS_WITH" + - "CONTAINS" + - "FULL_REGEXP" + - "PARTIAL_REGEXP" + value: + tittle: "value" + type: "string" + order: 0 + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 2 + required: + - "filter_name" + - "value" + - title: "inListFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "inListFilter" + enum: + - "inListFilter" + values: + tittle: "values" + type: "array" + minItems: 1 + order: 0 + items: + type: "string" + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 1 + required: + - "filter_name" + - "values" + - title: "numericFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "numericFilter" + enum: + - "numericFilter" + operation: + title: "operation" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "OPERATION_UNSPECIFIED" + - "EQUAL" + - "LESS_THAN" + - "LESS_THAN_OR_EQUAL" + - "GREATER_THAN" + - "GREATER_THAN_OR_EQUAL" + value: + tittle: "value" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "operation" + - "value" + - title: "betweenFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "betweenFilter" + enum: + - "betweenFilter" + fromValue: + tittle: "fromValue" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + toValue: + tittle: "toValue" + type: "object" + order: 1 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "fromValue" + - "toValue" + required: + - "field_name" + - "filter" + required: + - "filter_type" + - "expressions" + - title: "orGroup" + type: "object" + description: "The FilterExpressions in orGroup have an OR relationship." + properties: + filter_type: + type: "string" + const: "orGroup" + order: 0 + enum: + - "orGroup" + expressions: + title: "Expressions" + type: "array" + order: 1 + items: + title: "Expression" + type: "object" + properties: + field_name: + title: "fieldName" + type: "string" + order: 1 + filter: + title: "filter" + type: "object" + order: 2 + oneOf: + - title: "stringFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "stringFilter" + enum: + - "stringFilter" + matchType: + title: "matchType" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "MATCH_TYPE_UNSPECIFIED" + - "EXACT" + - "BEGINS_WITH" + - "ENDS_WITH" + - "CONTAINS" + - "FULL_REGEXP" + - "PARTIAL_REGEXP" + value: + tittle: "value" + type: "string" + order: 0 + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 2 + required: + - "filter_name" + - "value" + - title: "inListFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "inListFilter" + enum: + - "inListFilter" + values: + tittle: "values" + type: "array" + minItems: 1 + order: 0 + items: + type: "string" + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 1 + required: + - "filter_name" + - "values" + - title: "numericFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "numericFilter" + enum: + - "numericFilter" + operation: + title: "operation" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "OPERATION_UNSPECIFIED" + - "EQUAL" + - "LESS_THAN" + - "LESS_THAN_OR_EQUAL" + - "GREATER_THAN" + - "GREATER_THAN_OR_EQUAL" + value: + tittle: "value" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "operation" + - "value" + - title: "betweenFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "betweenFilter" + enum: + - "betweenFilter" + fromValue: + tittle: "fromValue" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + toValue: + tittle: "toValue" + type: "object" + order: 1 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "fromValue" + - "toValue" + required: + - "field_name" + - "filter" + required: + - "filter_type" + - "expressions" + - title: "notExpression" + type: "object" + description: "The FilterExpression is NOT of notExpression." + properties: + filter_type: + type: "string" + const: "notExpression" + order: 0 + enum: + - "notExpression" + expression: + title: "Expression" + type: "object" + properties: + field_name: + title: "fieldName" + type: "string" + order: 1 + filter: + title: "filter" + type: "object" + order: 2 + oneOf: + - title: "stringFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "stringFilter" + enum: + - "stringFilter" + matchType: + title: "matchType" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "MATCH_TYPE_UNSPECIFIED" + - "EXACT" + - "BEGINS_WITH" + - "ENDS_WITH" + - "CONTAINS" + - "FULL_REGEXP" + - "PARTIAL_REGEXP" + value: + tittle: "value" + type: "string" + order: 0 + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 2 + required: + - "filter_name" + - "value" + - title: "inListFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "inListFilter" + enum: + - "inListFilter" + values: + tittle: "values" + type: "array" + minItems: 1 + order: 0 + items: + type: "string" + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 1 + required: + - "filter_name" + - "values" + - title: "numericFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "numericFilter" + enum: + - "numericFilter" + operation: + title: "operation" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "OPERATION_UNSPECIFIED" + - "EQUAL" + - "LESS_THAN" + - "LESS_THAN_OR_EQUAL" + - "GREATER_THAN" + - "GREATER_THAN_OR_EQUAL" + value: + tittle: "value" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "operation" + - "value" + - title: "betweenFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "betweenFilter" + enum: + - "betweenFilter" + fromValue: + tittle: "fromValue" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + toValue: + tittle: "toValue" + type: "object" + order: 1 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "fromValue" + - "toValue" + required: + - "field_name" + - "filter" + - title: "filter" + type: "object" + description: "A primitive filter. In the same FilterExpression,\ + \ all of the filter's field names need to be either all metrics." + properties: + filter_type: + type: "string" + const: "filter" + order: 0 + enum: + - "filter" + field_name: + title: "fieldName" + type: "string" + order: 1 + filter: + title: "filter" + type: "object" + order: 2 + oneOf: + - title: "stringFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "stringFilter" + enum: + - "stringFilter" + matchType: + title: "matchType" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "MATCH_TYPE_UNSPECIFIED" + - "EXACT" + - "BEGINS_WITH" + - "ENDS_WITH" + - "CONTAINS" + - "FULL_REGEXP" + - "PARTIAL_REGEXP" + value: + tittle: "value" + type: "string" + order: 0 + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 2 + required: + - "filter_name" + - "value" + - title: "inListFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "inListFilter" + enum: + - "inListFilter" + values: + tittle: "values" + type: "array" + minItems: 1 + order: 0 + items: + type: "string" + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 1 + required: + - "filter_name" + - "values" + - title: "numericFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "numericFilter" + enum: + - "numericFilter" + operation: + title: "operation" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "OPERATION_UNSPECIFIED" + - "EQUAL" + - "LESS_THAN" + - "LESS_THAN_OR_EQUAL" + - "GREATER_THAN" + - "GREATER_THAN_OR_EQUAL" + value: + tittle: "value" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "operation" + - "value" + - title: "betweenFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "betweenFilter" + enum: + - "betweenFilter" + fromValue: + tittle: "fromValue" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + toValue: + tittle: "toValue" + type: "object" + order: 1 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "fromValue" + - "toValue" + required: + - "field_name" + - "filter" + cohortSpec: + title: "Cohort Reports" + description: "Cohort reports creates a time series of user retention\ + \ for the cohort." + type: "object" + order: 5 + oneOf: + - title: "Disabled" + type: "object" + properties: + enabled: + type: "string" + const: "false" + enum: + - "false" + - title: "Enabled" + type: "object" + properties: + enabled: + type: "string" + const: "true" + enum: + - "true" + cohorts: + name: "Cohorts" + order: 0 + type: "array" + always_show: true + items: + title: "Cohorts" + type: "object" + required: + - "dimension" + - "dateRange" + properties: + name: + title: "Name" + type: "string" + always_show: true + pattern: "^(?!(cohort_|RESERVED_)).*$" + description: "Assigns a name to this cohort. If not set,\ + \ cohorts are named by their zero based index cohort_0,\ + \ cohort_1, etc." + order: 0 + dimension: + title: "Dimension" + description: "Dimension used by the cohort. Required and\ + \ only supports `firstSessionDate`" + type: "string" + enum: + - "firstSessionDate" + order: 1 + dateRange: + type: "object" + required: + - "startDate" + - "endDate" + properties: + startDate: + title: "Start Date" + type: "string" + format: "date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + pattern_descriptor: "YYYY-MM-DD" + examples: + - "2021-01-01" + order: 2 + endDate: + title: "End Date" + type: "string" + format: "date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + pattern_descriptor: "YYYY-MM-DD" + examples: + - "2021-01-01" + order: 3 + cohortsRange: + type: "object" + order: 1 + required: + - "granularity" + - "endOffset" + properties: + granularity: + title: "Granularity" + description: "The granularity used to interpret the startOffset\ + \ and endOffset for the extended reporting date range\ + \ for a cohort report." + type: "string" + enum: + - "GRANULARITY_UNSPECIFIED" + - "DAILY" + - "WEEKLY" + - "MONTHLY" + order: 0 + startOffset: + title: "Start Offset" + description: "Specifies the start date of the extended reporting\ + \ date range for a cohort report." + type: "integer" + minimum: 0 + order: 1 + endOffset: + title: "End Offset" + description: "Specifies the end date of the extended reporting\ + \ date range for a cohort report." + type: "integer" + minimum: 0 + order: 2 + cohortReportSettings: + type: "object" + title: "Cohort Report Settings" + description: "Optional settings for a cohort report." + properties: + accumulate: + always_show: true + title: "Accumulate" + description: "If true, accumulates the result from first\ + \ touch day to the end day" + type: "boolean" + required: + - "name" + - "dimensions" + - "metrics" + window_in_days: + type: "integer" + title: "Data Request Interval (Days)" + description: "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." + examples: + - 30 + - 60 + - 90 + - 120 + - 200 + - 364 + minimum: 1 + maximum: 364 + default: 1 + order: 5 + keep_empty_rows: + type: "boolean" + title: "Keep Empty Rows" + description: "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." + default: false + order: 6 + convert_conversions_event: + type: "boolean" + title: "Convert `conversions:*` Metrics to Float" + description: "Enables conversion of `conversions:*` event metrics from integers\ + \ to floats. This is beneficial for preventing data rounding when the\ + \ API returns float values for any `conversions:*` fields." + default: false + order: 7 + sourceType: + title: "google-analytics-data-api" + const: "google-analytics-data-api" + enum: + - "google-analytics-data-api" + order: 0 + type: "string" + source-google-analytics-data-api-update: + title: "Google Analytics (Data API) Spec" + type: "object" + required: + - "property_ids" + properties: + credentials: + order: 0 + type: "object" + title: "Credentials" + description: "Credentials for the service" + oneOf: + - title: "Authenticate via Google (Oauth)" + type: "object" + required: + - "client_id" + - "client_secret" + - "refresh_token" + properties: + auth_type: + type: "string" + const: "Client" + order: 0 + enum: + - "Client" + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Google Analytics developer application." + order: 1 + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Google Analytics developer\ + \ application." + airbyte_secret: true + order: 2 + refresh_token: + title: "Refresh Token" + type: "string" + description: "The token for obtaining a new access token." + airbyte_secret: true + order: 3 + access_token: + title: "Access Token" + type: "string" + description: "Access Token for making authenticated requests." + airbyte_secret: true + order: 4 + - type: "object" + title: "Service Account Key Authentication" + required: + - "credentials_json" + properties: + auth_type: + type: "string" + const: "Service" + order: 0 + enum: + - "Service" + credentials_json: + title: "Service Account JSON Key" + type: "string" + description: "The JSON key linked to the service account used for\ + \ authorization. For steps on obtaining this key, refer to the setup guide." + examples: + - "{ \"type\": \"service_account\", \"project_id\": YOUR_PROJECT_ID,\ + \ \"private_key_id\": YOUR_PRIVATE_KEY, ... }" + airbyte_secret: true + order: 1 + property_ids: + title: "Property IDs" + description: "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." + order: 1 + type: "array" + items: + type: "string" + pattern: "^[0-9]*$" + examples: + - - "1738294" + - "5729978930" + date_ranges_start_date: + type: "string" + title: "Start Date" + description: "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." + format: "date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + pattern_descriptor: "YYYY-MM-DD" + examples: + - "2021-01-01" + order: 2 + custom_reports_array: + title: "Custom Reports" + description: "You can add your Custom Analytics report by creating one." + order: 4 + type: "array" + items: + title: "Custom Report Config" + type: "object" + properties: + name: + title: "Name" + description: "The name of the custom report, this name would be used\ + \ as stream name." + type: "string" + order: 0 + dimensions: + title: "Dimensions" + description: "A list of dimensions." + type: "array" + items: + type: "string" + minItems: 1 + order: 1 + metrics: + title: "Metrics" + description: "A list of metrics." + type: "array" + items: + type: "string" + minItems: 1 + order: 2 + dimensionFilter: + title: "Dimensions filter" + description: "Dimensions filter" + type: "object" + order: 3 + oneOf: + - title: "andGroup" + description: "The FilterExpressions in andGroup have an AND relationship." + type: "object" + properties: + filter_type: + type: "string" + const: "andGroup" + order: 0 + enum: + - "andGroup" + expressions: + title: "Expressions" + type: "array" + order: 1 + items: + title: "Expression" + type: "object" + properties: + field_name: + title: "fieldName" + type: "string" + order: 1 + filter: + title: "filter" + type: "object" + order: 2 + oneOf: + - title: "stringFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "stringFilter" + enum: + - "stringFilter" + matchType: + title: "matchType" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "MATCH_TYPE_UNSPECIFIED" + - "EXACT" + - "BEGINS_WITH" + - "ENDS_WITH" + - "CONTAINS" + - "FULL_REGEXP" + - "PARTIAL_REGEXP" + value: + tittle: "value" + type: "string" + order: 0 + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 2 + required: + - "filter_name" + - "value" + - title: "inListFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "inListFilter" + enum: + - "inListFilter" + values: + tittle: "values" + type: "array" + minItems: 1 + order: 0 + items: + type: "string" + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 1 + required: + - "filter_name" + - "values" + - title: "numericFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "numericFilter" + enum: + - "numericFilter" + operation: + title: "operation" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "OPERATION_UNSPECIFIED" + - "EQUAL" + - "LESS_THAN" + - "LESS_THAN_OR_EQUAL" + - "GREATER_THAN" + - "GREATER_THAN_OR_EQUAL" + value: + tittle: "value" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "operation" + - "value" + - title: "betweenFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "betweenFilter" + enum: + - "betweenFilter" + fromValue: + tittle: "fromValue" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + toValue: + tittle: "toValue" + type: "object" + order: 1 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "fromValue" + - "toValue" + required: + - "field_name" + - "filter" + required: + - "filter_type" + - "expressions" + - title: "orGroup" + type: "object" + description: "The FilterExpressions in orGroup have an OR relationship." + properties: + filter_type: + type: "string" + const: "orGroup" + order: 0 + enum: + - "orGroup" + expressions: + title: "Expressions" + type: "array" + order: 1 + items: + title: "Expression" + type: "object" + properties: + field_name: + title: "fieldName" + type: "string" + order: 1 + filter: + title: "filter" + type: "object" + order: 2 + oneOf: + - title: "stringFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "stringFilter" + enum: + - "stringFilter" + matchType: + title: "matchType" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "MATCH_TYPE_UNSPECIFIED" + - "EXACT" + - "BEGINS_WITH" + - "ENDS_WITH" + - "CONTAINS" + - "FULL_REGEXP" + - "PARTIAL_REGEXP" + value: + tittle: "value" + type: "string" + order: 0 + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 2 + required: + - "filter_name" + - "value" + - title: "inListFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "inListFilter" + enum: + - "inListFilter" + values: + tittle: "values" + type: "array" + minItems: 1 + order: 0 + items: + type: "string" + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 1 + required: + - "filter_name" + - "values" + - title: "numericFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "numericFilter" + enum: + - "numericFilter" + operation: + title: "operation" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "OPERATION_UNSPECIFIED" + - "EQUAL" + - "LESS_THAN" + - "LESS_THAN_OR_EQUAL" + - "GREATER_THAN" + - "GREATER_THAN_OR_EQUAL" + value: + tittle: "value" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "operation" + - "value" + - title: "betweenFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "betweenFilter" + enum: + - "betweenFilter" + fromValue: + tittle: "fromValue" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + toValue: + tittle: "toValue" + type: "object" + order: 1 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "fromValue" + - "toValue" + required: + - "field_name" + - "filter" + required: + - "filter_type" + - "expressions" + - title: "notExpression" + type: "object" + description: "The FilterExpression is NOT of notExpression." + properties: + filter_type: + type: "string" + const: "notExpression" + order: 0 + enum: + - "notExpression" + expression: + title: "Expression" + type: "object" + properties: + field_name: + title: "fieldName" + type: "string" + order: 1 + filter: + title: "filter" + type: "object" + order: 2 + oneOf: + - title: "stringFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "stringFilter" + enum: + - "stringFilter" + matchType: + title: "matchType" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "MATCH_TYPE_UNSPECIFIED" + - "EXACT" + - "BEGINS_WITH" + - "ENDS_WITH" + - "CONTAINS" + - "FULL_REGEXP" + - "PARTIAL_REGEXP" + value: + tittle: "value" + type: "string" + order: 0 + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 2 + required: + - "filter_name" + - "value" + - title: "inListFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "inListFilter" + enum: + - "inListFilter" + values: + tittle: "values" + type: "array" + minItems: 1 + order: 0 + items: + type: "string" + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 1 + required: + - "filter_name" + - "values" + - title: "numericFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "numericFilter" + enum: + - "numericFilter" + operation: + title: "operation" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "OPERATION_UNSPECIFIED" + - "EQUAL" + - "LESS_THAN" + - "LESS_THAN_OR_EQUAL" + - "GREATER_THAN" + - "GREATER_THAN_OR_EQUAL" + value: + tittle: "value" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "operation" + - "value" + - title: "betweenFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "betweenFilter" + enum: + - "betweenFilter" + fromValue: + tittle: "fromValue" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + toValue: + tittle: "toValue" + type: "object" + order: 1 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "fromValue" + - "toValue" + required: + - "field_name" + - "filter" + - title: "filter" + type: "object" + description: "A primitive filter. In the same FilterExpression,\ + \ all of the filter's field names need to be either all dimensions." + properties: + filter_type: + type: "string" + const: "filter" + order: 0 + enum: + - "filter" + field_name: + title: "fieldName" + type: "string" + order: 1 + filter: + title: "filter" + type: "object" + order: 2 + oneOf: + - title: "stringFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "stringFilter" + enum: + - "stringFilter" + matchType: + title: "matchType" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "MATCH_TYPE_UNSPECIFIED" + - "EXACT" + - "BEGINS_WITH" + - "ENDS_WITH" + - "CONTAINS" + - "FULL_REGEXP" + - "PARTIAL_REGEXP" + value: + tittle: "value" + type: "string" + order: 0 + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 2 + required: + - "filter_name" + - "value" + - title: "inListFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "inListFilter" + enum: + - "inListFilter" + values: + tittle: "values" + type: "array" + minItems: 1 + order: 0 + items: + type: "string" + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 1 + required: + - "filter_name" + - "values" + - title: "numericFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "numericFilter" + enum: + - "numericFilter" + operation: + title: "operation" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "OPERATION_UNSPECIFIED" + - "EQUAL" + - "LESS_THAN" + - "LESS_THAN_OR_EQUAL" + - "GREATER_THAN" + - "GREATER_THAN_OR_EQUAL" + value: + tittle: "value" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "operation" + - "value" + - title: "betweenFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "betweenFilter" + enum: + - "betweenFilter" + fromValue: + tittle: "fromValue" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + toValue: + tittle: "toValue" + type: "object" + order: 1 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "fromValue" + - "toValue" + required: + - "field_name" + - "filter" + metricFilter: + title: "Metrics filter" + description: "Metrics filter" + type: "object" + order: 4 + oneOf: + - title: "andGroup" + description: "The FilterExpressions in andGroup have an AND relationship." + type: "object" + properties: + filter_type: + type: "string" + const: "andGroup" + order: 0 + enum: + - "andGroup" + expressions: + title: "Expressions" + type: "array" + order: 1 + items: + title: "Expression" + type: "object" + properties: + field_name: + title: "fieldName" + type: "string" + order: 1 + filter: + title: "filter" + type: "object" + order: 2 + oneOf: + - title: "stringFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "stringFilter" + enum: + - "stringFilter" + matchType: + title: "matchType" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "MATCH_TYPE_UNSPECIFIED" + - "EXACT" + - "BEGINS_WITH" + - "ENDS_WITH" + - "CONTAINS" + - "FULL_REGEXP" + - "PARTIAL_REGEXP" + value: + tittle: "value" + type: "string" + order: 0 + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 2 + required: + - "filter_name" + - "value" + - title: "inListFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "inListFilter" + enum: + - "inListFilter" + values: + tittle: "values" + type: "array" + minItems: 1 + order: 0 + items: + type: "string" + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 1 + required: + - "filter_name" + - "values" + - title: "numericFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "numericFilter" + enum: + - "numericFilter" + operation: + title: "operation" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "OPERATION_UNSPECIFIED" + - "EQUAL" + - "LESS_THAN" + - "LESS_THAN_OR_EQUAL" + - "GREATER_THAN" + - "GREATER_THAN_OR_EQUAL" + value: + tittle: "value" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "operation" + - "value" + - title: "betweenFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "betweenFilter" + enum: + - "betweenFilter" + fromValue: + tittle: "fromValue" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + toValue: + tittle: "toValue" + type: "object" + order: 1 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "fromValue" + - "toValue" + required: + - "field_name" + - "filter" + required: + - "filter_type" + - "expressions" + - title: "orGroup" + type: "object" + description: "The FilterExpressions in orGroup have an OR relationship." + properties: + filter_type: + type: "string" + const: "orGroup" + order: 0 + enum: + - "orGroup" + expressions: + title: "Expressions" + type: "array" + order: 1 + items: + title: "Expression" + type: "object" + properties: + field_name: + title: "fieldName" + type: "string" + order: 1 + filter: + title: "filter" + type: "object" + order: 2 + oneOf: + - title: "stringFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "stringFilter" + enum: + - "stringFilter" + matchType: + title: "matchType" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "MATCH_TYPE_UNSPECIFIED" + - "EXACT" + - "BEGINS_WITH" + - "ENDS_WITH" + - "CONTAINS" + - "FULL_REGEXP" + - "PARTIAL_REGEXP" + value: + tittle: "value" + type: "string" + order: 0 + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 2 + required: + - "filter_name" + - "value" + - title: "inListFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "inListFilter" + enum: + - "inListFilter" + values: + tittle: "values" + type: "array" + minItems: 1 + order: 0 + items: + type: "string" + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 1 + required: + - "filter_name" + - "values" + - title: "numericFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "numericFilter" + enum: + - "numericFilter" + operation: + title: "operation" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "OPERATION_UNSPECIFIED" + - "EQUAL" + - "LESS_THAN" + - "LESS_THAN_OR_EQUAL" + - "GREATER_THAN" + - "GREATER_THAN_OR_EQUAL" + value: + tittle: "value" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "operation" + - "value" + - title: "betweenFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "betweenFilter" + enum: + - "betweenFilter" + fromValue: + tittle: "fromValue" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + toValue: + tittle: "toValue" + type: "object" + order: 1 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "fromValue" + - "toValue" + required: + - "field_name" + - "filter" + required: + - "filter_type" + - "expressions" + - title: "notExpression" + type: "object" + description: "The FilterExpression is NOT of notExpression." + properties: + filter_type: + type: "string" + const: "notExpression" + order: 0 + enum: + - "notExpression" + expression: + title: "Expression" + type: "object" + properties: + field_name: + title: "fieldName" + type: "string" + order: 1 + filter: + title: "filter" + type: "object" + order: 2 + oneOf: + - title: "stringFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "stringFilter" + enum: + - "stringFilter" + matchType: + title: "matchType" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "MATCH_TYPE_UNSPECIFIED" + - "EXACT" + - "BEGINS_WITH" + - "ENDS_WITH" + - "CONTAINS" + - "FULL_REGEXP" + - "PARTIAL_REGEXP" + value: + tittle: "value" + type: "string" + order: 0 + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 2 + required: + - "filter_name" + - "value" + - title: "inListFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "inListFilter" + enum: + - "inListFilter" + values: + tittle: "values" + type: "array" + minItems: 1 + order: 0 + items: + type: "string" + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 1 + required: + - "filter_name" + - "values" + - title: "numericFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "numericFilter" + enum: + - "numericFilter" + operation: + title: "operation" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "OPERATION_UNSPECIFIED" + - "EQUAL" + - "LESS_THAN" + - "LESS_THAN_OR_EQUAL" + - "GREATER_THAN" + - "GREATER_THAN_OR_EQUAL" + value: + tittle: "value" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "operation" + - "value" + - title: "betweenFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "betweenFilter" + enum: + - "betweenFilter" + fromValue: + tittle: "fromValue" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + toValue: + tittle: "toValue" + type: "object" + order: 1 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "fromValue" + - "toValue" + required: + - "field_name" + - "filter" + - title: "filter" + type: "object" + description: "A primitive filter. In the same FilterExpression,\ + \ all of the filter's field names need to be either all metrics." + properties: + filter_type: + type: "string" + const: "filter" + order: 0 + enum: + - "filter" + field_name: + title: "fieldName" + type: "string" + order: 1 + filter: + title: "filter" + type: "object" + order: 2 + oneOf: + - title: "stringFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "stringFilter" + enum: + - "stringFilter" + matchType: + title: "matchType" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "MATCH_TYPE_UNSPECIFIED" + - "EXACT" + - "BEGINS_WITH" + - "ENDS_WITH" + - "CONTAINS" + - "FULL_REGEXP" + - "PARTIAL_REGEXP" + value: + tittle: "value" + type: "string" + order: 0 + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 2 + required: + - "filter_name" + - "value" + - title: "inListFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "inListFilter" + enum: + - "inListFilter" + values: + tittle: "values" + type: "array" + minItems: 1 + order: 0 + items: + type: "string" + caseSensitive: + tittle: "caseSensitive" + type: "boolean" + order: 1 + required: + - "filter_name" + - "values" + - title: "numericFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "numericFilter" + enum: + - "numericFilter" + operation: + title: "operation" + type: "array" + order: 1 + items: + title: "ValidEnums" + enum: + - "OPERATION_UNSPECIFIED" + - "EQUAL" + - "LESS_THAN" + - "LESS_THAN_OR_EQUAL" + - "GREATER_THAN" + - "GREATER_THAN_OR_EQUAL" + value: + tittle: "value" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "operation" + - "value" + - title: "betweenFilter" + type: "object" + properties: + filter_name: + type: "string" + const: "betweenFilter" + enum: + - "betweenFilter" + fromValue: + tittle: "fromValue" + type: "object" + order: 0 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + toValue: + tittle: "toValue" + type: "object" + order: 1 + oneOf: + - title: "int64Value" + type: "object" + properties: + value_type: + type: "string" + const: "int64Value" + enum: + - "int64Value" + value: + type: "string" + required: + - "value_type" + - "value" + - title: "doubleValue" + type: "object" + properties: + value_type: + type: "string" + const: "doubleValue" + enum: + - "doubleValue" + value: + type: "number" + required: + - "value_type" + - "value" + required: + - "filter_name" + - "fromValue" + - "toValue" + required: + - "field_name" + - "filter" + cohortSpec: + title: "Cohort Reports" + description: "Cohort reports creates a time series of user retention\ + \ for the cohort." + type: "object" + order: 5 + oneOf: + - title: "Disabled" + type: "object" + properties: + enabled: + type: "string" + const: "false" + enum: + - "false" + - title: "Enabled" + type: "object" + properties: + enabled: + type: "string" + const: "true" + enum: + - "true" + cohorts: + name: "Cohorts" + order: 0 + type: "array" + always_show: true + items: + title: "Cohorts" + type: "object" + required: + - "dimension" + - "dateRange" + properties: + name: + title: "Name" + type: "string" + always_show: true + pattern: "^(?!(cohort_|RESERVED_)).*$" + description: "Assigns a name to this cohort. If not set,\ + \ cohorts are named by their zero based index cohort_0,\ + \ cohort_1, etc." + order: 0 + dimension: + title: "Dimension" + description: "Dimension used by the cohort. Required and\ + \ only supports `firstSessionDate`" + type: "string" + enum: + - "firstSessionDate" + order: 1 + dateRange: + type: "object" + required: + - "startDate" + - "endDate" + properties: + startDate: + title: "Start Date" + type: "string" + format: "date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + pattern_descriptor: "YYYY-MM-DD" + examples: + - "2021-01-01" + order: 2 + endDate: + title: "End Date" + type: "string" + format: "date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + pattern_descriptor: "YYYY-MM-DD" + examples: + - "2021-01-01" + order: 3 + cohortsRange: + type: "object" + order: 1 + required: + - "granularity" + - "endOffset" + properties: + granularity: + title: "Granularity" + description: "The granularity used to interpret the startOffset\ + \ and endOffset for the extended reporting date range\ + \ for a cohort report." + type: "string" + enum: + - "GRANULARITY_UNSPECIFIED" + - "DAILY" + - "WEEKLY" + - "MONTHLY" + order: 0 + startOffset: + title: "Start Offset" + description: "Specifies the start date of the extended reporting\ + \ date range for a cohort report." + type: "integer" + minimum: 0 + order: 1 + endOffset: + title: "End Offset" + description: "Specifies the end date of the extended reporting\ + \ date range for a cohort report." + type: "integer" + minimum: 0 + order: 2 + cohortReportSettings: + type: "object" + title: "Cohort Report Settings" + description: "Optional settings for a cohort report." + properties: + accumulate: + always_show: true + title: "Accumulate" + description: "If true, accumulates the result from first\ + \ touch day to the end day" + type: "boolean" + required: + - "name" + - "dimensions" + - "metrics" + window_in_days: + type: "integer" + title: "Data Request Interval (Days)" + description: "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." + examples: + - 30 + - 60 + - 90 + - 120 + - 200 + - 364 + minimum: 1 + maximum: 364 + default: 1 + order: 5 + keep_empty_rows: + type: "boolean" + title: "Keep Empty Rows" + description: "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." + default: false + order: 6 + convert_conversions_event: + type: "boolean" + title: "Convert `conversions:*` Metrics to Float" + description: "Enables conversion of `conversions:*` event metrics from integers\ + \ to floats. This is beneficial for preventing data rounding when the\ + \ API returns float values for any `conversions:*` fields." + default: false + order: 7 + source-mailgun: + title: "Source Mailgun Spec" + type: "object" + required: + - "private_key" + - "sourceType" + properties: + private_key: + type: "string" + airbyte_secret: true + description: "Primary account API key to access your Mailgun data." + title: "Private API Key" + x-speakeasy-param-sensitive: true + domain_region: + type: "string" + description: "Domain region code. 'EU' or 'US' are possible values. The\ + \ default is 'US'." + title: "Domain Region Code" + default: "US" + start_date: + title: "Replication Start Date" + description: "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." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2023-08-01T00:00:00Z" + type: "string" + format: "date-time" + sourceType: + title: "mailgun" + const: "mailgun" + enum: + - "mailgun" + order: 0 + type: "string" + source-mailgun-update: + title: "Source Mailgun Spec" + type: "object" + required: + - "private_key" + properties: + private_key: + type: "string" + airbyte_secret: true + description: "Primary account API key to access your Mailgun data." + title: "Private API Key" + domain_region: + type: "string" + description: "Domain region code. 'EU' or 'US' are possible values. The\ + \ default is 'US'." + title: "Domain Region Code" + default: "US" + start_date: + title: "Replication Start Date" + description: "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." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2023-08-01T00:00:00Z" + type: "string" + format: "date-time" + source-intercom: + title: "Source Intercom Spec" + type: "object" + required: + - "start_date" + - "access_token" + - "sourceType" + properties: + start_date: + type: "string" + title: "Start date" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + examples: + - "2020-11-16T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + format: "date-time" + access_token: + title: "Access token" + type: "string" + description: "Access token for making authenticated requests. See the Intercom docs for more information." + airbyte_secret: true + x-speakeasy-param-sensitive: true + client_id: + title: "Client Id" + type: "string" + description: "Client Id for your Intercom application." + airbyte_secret: true + client_secret: + title: "Client Secret" + type: "string" + description: "Client Secret for your Intercom application." + airbyte_secret: true + sourceType: + title: "intercom" + const: "intercom" + enum: + - "intercom" + order: 0 + type: "string" + source-intercom-update: + title: "Source Intercom Spec" + type: "object" + required: + - "start_date" + - "access_token" + properties: + start_date: + type: "string" + title: "Start date" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + examples: + - "2020-11-16T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + format: "date-time" + access_token: + title: "Access token" + type: "string" + description: "Access token for making authenticated requests. See the Intercom docs for more information." + airbyte_secret: true + client_id: + title: "Client Id" + type: "string" + description: "Client Id for your Intercom application." + airbyte_secret: true + client_secret: + title: "Client Secret" + type: "string" + description: "Client Secret for your Intercom application." + airbyte_secret: true + source-rki-covid: + title: "RKI Covid Spec" + type: "object" + required: + - "start_date" + - "sourceType" + properties: + start_date: + type: "string" + title: "Start Date" + description: "UTC date in the format 2017-01-25. Any data before this date\ + \ will not be replicated." + order: 1 + sourceType: + title: "rki-covid" + const: "rki-covid" + enum: + - "rki-covid" + order: 0 + type: "string" + source-rki-covid-update: + title: "RKI Covid Spec" + type: "object" + required: + - "start_date" + properties: + start_date: + type: "string" + title: "Start Date" + description: "UTC date in the format 2017-01-25. Any data before this date\ + \ will not be replicated." + order: 1 + source-secoda: + title: "Secoda Spec" + type: "object" + required: + - "api_key" + - "sourceType" + properties: + api_key: + title: "Api Key" + type: "string" + description: "Your API Access Key. See here. The key is case sensitive." + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "secoda" + const: "secoda" + enum: + - "secoda" + order: 0 + type: "string" + source-secoda-update: + title: "Secoda Spec" + type: "object" + required: + - "api_key" + properties: + api_key: + title: "Api Key" + type: "string" + description: "Your API Access Key. See here. The key is case sensitive." + airbyte_secret: true + source-zoom: + title: "Zoom Spec" + type: "object" + required: + - "account_id" + - "client_id" + - "client_secret" + - "authorization_endpoint" + - "sourceType" + properties: + account_id: + type: "string" + order: 0 + description: "The account ID for your Zoom account. You can find this in\ + \ the Zoom Marketplace under the \"Manage\" tab for your app." + client_id: + type: "string" + order: 1 + description: "The client ID for your Zoom app. You can find this in the\ + \ Zoom Marketplace under the \"Manage\" tab for your app." + client_secret: + type: "string" + order: 2 + description: "The client secret for your Zoom app. You can find this in\ + \ the Zoom Marketplace under the \"Manage\" tab for your app." + airbyte_secret: true + authorization_endpoint: + type: "string" + order: 3 + default: "https://zoom.us/oauth/token" + sourceType: + title: "zoom" + const: "zoom" + enum: + - "zoom" + order: 0 + type: "string" + source-zoom-update: + title: "Zoom Spec" + type: "object" + required: + - "account_id" + - "client_id" + - "client_secret" + - "authorization_endpoint" + properties: + account_id: + type: "string" + order: 0 + description: "The account ID for your Zoom account. You can find this in\ + \ the Zoom Marketplace under the \"Manage\" tab for your app." + client_id: + type: "string" + order: 1 + description: "The client ID for your Zoom app. You can find this in the\ + \ Zoom Marketplace under the \"Manage\" tab for your app." + client_secret: + type: "string" + order: 2 + description: "The client secret for your Zoom app. You can find this in\ + \ the Zoom Marketplace under the \"Manage\" tab for your app." + airbyte_secret: true + authorization_endpoint: + type: "string" + order: 3 + default: "https://zoom.us/oauth/token" + source-delighted: + title: "Delighted Spec" + type: "object" + required: + - "since" + - "api_key" + - "sourceType" + properties: + api_key: + title: "Delighted API Key" + type: "string" + description: "A Delighted API key." + airbyte_secret: true + order: 0 + x-speakeasy-param-sensitive: true + since: + title: "Replication Start Date" + type: "string" + description: "The date from which you'd like to replicate the data" + examples: + - "2022-05-30T04:50:23Z" + - "2022-05-30 04:50:23" + pattern: "^\\d{4}-\\d{2}-\\d{2}[T ]\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z?$" + order: 1 + format: "date-time" + sourceType: + title: "delighted" + const: "delighted" + enum: + - "delighted" + order: 0 + type: "string" + source-delighted-update: + title: "Delighted Spec" + type: "object" + required: + - "since" + - "api_key" + properties: + api_key: + title: "Delighted API Key" + type: "string" + description: "A Delighted API key." + airbyte_secret: true + order: 0 + since: + title: "Replication Start Date" + type: "string" + description: "The date from which you'd like to replicate the data" + examples: + - "2022-05-30T04:50:23Z" + - "2022-05-30 04:50:23" + pattern: "^\\d{4}-\\d{2}-\\d{2}[T ]\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z?$" + order: 1 + format: "date-time" + source-klarna: + title: "Klarna Spec" + type: "object" + required: + - "region" + - "playground" + - "username" + - "password" + - "sourceType" + properties: + region: + title: "Region" + type: "string" + enum: + - "eu" + - "us" + - "oc" + description: "Base url region (For playground eu https://docs.klarna.com/klarna-payments/api/payments-api/#tag/API-URLs).\ + \ Supported 'eu', 'us', 'oc'" + playground: + title: "Playground" + type: "boolean" + description: "Propertie defining if connector is used against playground\ + \ or production environment" + default: false + username: + title: "Username" + type: "string" + description: "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)" + password: + title: "Password" + type: "string" + description: "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)" + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "klarna" + const: "klarna" + enum: + - "klarna" + order: 0 + type: "string" + source-klarna-update: + title: "Klarna Spec" + type: "object" + required: + - "region" + - "playground" + - "username" + - "password" + properties: + region: + title: "Region" + type: "string" + enum: + - "eu" + - "us" + - "oc" + description: "Base url region (For playground eu https://docs.klarna.com/klarna-payments/api/payments-api/#tag/API-URLs).\ + \ Supported 'eu', 'us', 'oc'" + playground: + title: "Playground" + type: "boolean" + description: "Propertie defining if connector is used against playground\ + \ or production environment" + default: false + username: + title: "Username" + type: "string" + description: "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)" + password: + title: "Password" + type: "string" + description: "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)" + airbyte_secret: true + source-typeform: + type: "object" + required: + - "credentials" + - "sourceType" + properties: + credentials: + title: "Authorization Method" + type: "object" + order: 0 + oneOf: + - type: "object" + title: "OAuth2.0" + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "access_token" + - "token_expiry_date" + properties: + auth_type: + type: "string" + const: "oauth2.0" + enum: + - "oauth2.0" + client_id: + type: "string" + description: "The Client ID of the Typeform developer application." + airbyte_secret: true + client_secret: + type: "string" + description: "The Client Secret the Typeform developer application." + airbyte_secret: true + access_token: + type: "string" + description: "Access Token for making authenticated requests." + airbyte_secret: true + x-speakeasy-param-sensitive: true + token_expiry_date: + type: "string" + description: "The date-time when the access token should be refreshed." + format: "date-time" + x-speakeasy-param-sensitive: true + refresh_token: + type: "string" + description: "The key to refresh the expired access_token." + airbyte_secret: true + x-speakeasy-param-sensitive: true + - title: "Private Token" + type: "object" + required: + - "access_token" + properties: + auth_type: + type: "string" + const: "access_token" + enum: + - "access_token" + access_token: + type: "string" + title: "Private Token" + description: "Log into your Typeform account and then generate a personal\ + \ Access Token." + airbyte_secret: true + x-speakeasy-param-sensitive: true + start_date: + type: "string" + title: "Start Date" + description: "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." + examples: + - "2021-03-01T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + order: 2 + format: "date-time" + form_ids: + title: "Form IDs to replicate" + description: "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" + type: "array" + items: + type: "string" + uniqueItems: true + order: 3 + sourceType: + title: "typeform" + const: "typeform" + enum: + - "typeform" + order: 0 + type: "string" + source-typeform-update: + type: "object" + required: + - "credentials" + properties: + credentials: + title: "Authorization Method" + type: "object" + order: 0 + oneOf: + - type: "object" + title: "OAuth2.0" + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "access_token" + - "token_expiry_date" + properties: + auth_type: + type: "string" + const: "oauth2.0" + enum: + - "oauth2.0" + client_id: + type: "string" + description: "The Client ID of the Typeform developer application." + airbyte_secret: true + client_secret: + type: "string" + description: "The Client Secret the Typeform developer application." + airbyte_secret: true + access_token: + type: "string" + description: "Access Token for making authenticated requests." + airbyte_secret: true + token_expiry_date: + type: "string" + description: "The date-time when the access token should be refreshed." + format: "date-time" + refresh_token: + type: "string" + description: "The key to refresh the expired access_token." + airbyte_secret: true + - title: "Private Token" + type: "object" + required: + - "access_token" + properties: + auth_type: + type: "string" + const: "access_token" + enum: + - "access_token" + access_token: + type: "string" + title: "Private Token" + description: "Log into your Typeform account and then generate a personal\ + \ Access Token." + airbyte_secret: true + start_date: + type: "string" + title: "Start Date" + description: "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." + examples: + - "2021-03-01T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + order: 2 + format: "date-time" + form_ids: + title: "Form IDs to replicate" + description: "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" + type: "array" + items: + type: "string" + uniqueItems: true + order: 3 + source-dremio: + title: "Dremio Spec" + type: "object" + required: + - "api_key" + - "base_url" + - "sourceType" + properties: + api_key: + type: "string" + description: "API Key that is generated when you authenticate to Dremio\ + \ API" + airbyte_secret: true + x-speakeasy-param-sensitive: true + base_url: + type: "string" + description: "URL of your Dremio instance" + default: "https://app.dremio.cloud" + sourceType: + title: "dremio" + const: "dremio" + enum: + - "dremio" + order: 0 + type: "string" + source-dremio-update: + title: "Dremio Spec" + type: "object" + required: + - "api_key" + - "base_url" + properties: + api_key: + type: "string" + description: "API Key that is generated when you authenticate to Dremio\ + \ API" + airbyte_secret: true + base_url: + type: "string" + description: "URL of your Dremio instance" + default: "https://app.dremio.cloud" + source-paypal-transaction: + type: "object" + required: + - "client_id" + - "client_secret" + - "start_date" + - "is_sandbox" + - "sourceType" + properties: + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your Paypal developer application." + airbyte_secret: true + order: 0 + client_secret: + type: "string" + title: "Client secret" + description: "The Client Secret of your Paypal developer application." + airbyte_secret: true + order: 1 + start_date: + title: "Start Date" + description: "Start Date for data extraction in ISO format. Date must be in range from 3 years till 12 hrs before\ + \ present time." + type: "string" + examples: + - "2021-06-11T23:59:59Z" + - "2021-06-11T23:59:59+00:00" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(|Z|[+-][0-9]{2}:[0-9]{2})$" + format: "date-time" + order: 2 + is_sandbox: + title: "Sandbox" + description: "Determines whether to use the sandbox or production environment." + type: "boolean" + default: false + dispute_start_date: + title: "Dispute Start Date Range" + description: "Start Date parameter for the list dispute endpoint in ISO format.\ + \ This Start Date must be in range within 180 days before present time,\ + \ and requires ONLY 3 miliseconds(mandatory). If you don't use this option,\ + \ it defaults to a start date set 180 days in the past." + type: "string" + examples: + - "2021-06-11T23:59:59.000Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{3}Z$" + format: "date-time" + order: 3 + end_date: + title: "End Date" + description: "End Date for data extraction in ISO format. This can be help you select specific range of time,\ + \ mainly for test purposes or data integrity tests. When this is not\ + \ used, now_utc() is used by the streams. This does not apply to Disputes\ + \ and Product streams." + type: "string" + examples: + - "2021-06-11T23:59:59Z" + - "2021-06-11T23:59:59+00:00" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(|Z|[+-][0-9]{2}:[0-9]{2})$" + format: "date-time" + order: 4 + refresh_token: + type: "string" + title: "Refresh token" + description: "The key to refresh the expired access token." + airbyte_secret: true + x-speakeasy-param-sensitive: true + time_window: + type: "integer" + title: "Number of days per request" + description: "The number of days per request. Must be a number between 1\ + \ and 31." + default: 7 + minimum: 1 + maximum: 31 + sourceType: + title: "paypal-transaction" + const: "paypal-transaction" + enum: + - "paypal-transaction" + order: 0 + type: "string" + source-paypal-transaction-update: + type: "object" + required: + - "client_id" + - "client_secret" + - "start_date" + - "is_sandbox" + properties: + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your Paypal developer application." + airbyte_secret: true + order: 0 + client_secret: + type: "string" + title: "Client secret" + description: "The Client Secret of your Paypal developer application." + airbyte_secret: true + order: 1 + start_date: + title: "Start Date" + description: "Start Date for data extraction in ISO format. Date must be in range from 3 years till 12 hrs before\ + \ present time." + type: "string" + examples: + - "2021-06-11T23:59:59Z" + - "2021-06-11T23:59:59+00:00" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(|Z|[+-][0-9]{2}:[0-9]{2})$" + format: "date-time" + order: 2 + is_sandbox: + title: "Sandbox" + description: "Determines whether to use the sandbox or production environment." + type: "boolean" + default: false + dispute_start_date: + title: "Dispute Start Date Range" + description: "Start Date parameter for the list dispute endpoint in ISO format.\ + \ This Start Date must be in range within 180 days before present time,\ + \ and requires ONLY 3 miliseconds(mandatory). If you don't use this option,\ + \ it defaults to a start date set 180 days in the past." + type: "string" + examples: + - "2021-06-11T23:59:59.000Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{3}Z$" + format: "date-time" + order: 3 + end_date: + title: "End Date" + description: "End Date for data extraction in ISO format. This can be help you select specific range of time,\ + \ mainly for test purposes or data integrity tests. When this is not\ + \ used, now_utc() is used by the streams. This does not apply to Disputes\ + \ and Product streams." + type: "string" + examples: + - "2021-06-11T23:59:59Z" + - "2021-06-11T23:59:59+00:00" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(|Z|[+-][0-9]{2}:[0-9]{2})$" + format: "date-time" + order: 4 + refresh_token: + type: "string" + title: "Refresh token" + description: "The key to refresh the expired access token." + airbyte_secret: true + time_window: + type: "integer" + title: "Number of days per request" + description: "The number of days per request. Must be a number between 1\ + \ and 31." + default: 7 + minimum: 1 + maximum: 31 + source-lemlist: + title: "Lemlist Spec" + type: "object" + required: + - "api_key" + - "sourceType" + properties: + api_key: + type: "string" + title": "API key" + description: "Lemlist API key," + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "lemlist" + const: "lemlist" + enum: + - "lemlist" + order: 0 + type: "string" + source-lemlist-update: + title: "Lemlist Spec" + type: "object" + required: + - "api_key" + properties: + api_key: + type: "string" + title": "API key" + description: "Lemlist API key," + airbyte_secret: true + source-pexels-api: + title: "Pexel API Spec" + type: "object" + required: + - "api_key" + - "query" + - "sourceType" + properties: + api_key: + title: "API Key from the pexels website" + type: "string" + description: "API key is required to access pexels api, For getting your's\ + \ goto https://www.pexels.com/api/documentation and create account for\ + \ free." + airbyte_secret: true + x-speakeasy-param-sensitive: true + query: + title: "Specific query for the search" + type: "string" + description: "Optional, the search query, Example Ocean, Tigers, Pears,\ + \ etc." + examples: + - "people" + - "oceans" + orientation: + title: "Specific orientation for the search" + type: "string" + description: "Optional, Desired photo orientation. The current supported\ + \ orientations are landscape, portrait or square" + examples: + - "square" + - "landscape" + size: + title: "Specific size for the search" + type: "string" + description: "Optional, Minimum photo size. The current supported sizes\ + \ are large(24MP), medium(12MP) or small(4MP)." + examples: + - "large" + - "small" + color: + title: "Specific color for the search" + type: "string" + description: "Optional, Desired photo color. Supported colors red, orange,\ + \ yellow, green, turquoise, blue, violet, pink, brown, black, gray, white\ + \ or any hexidecimal color code." + examples: + - "red" + - "orange" + locale: + title: "Specific locale for the search" + type: "string" + description: "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'." + examples: + - "en-US" + - "pt-BR" + sourceType: + title: "pexels-api" + const: "pexels-api" + enum: + - "pexels-api" + order: 0 + type: "string" + source-pexels-api-update: + title: "Pexel API Spec" + type: "object" + required: + - "api_key" + - "query" + properties: + api_key: + title: "API Key from the pexels website" + type: "string" + description: "API key is required to access pexels api, For getting your's\ + \ goto https://www.pexels.com/api/documentation and create account for\ + \ free." + airbyte_secret: true + query: + title: "Specific query for the search" + type: "string" + description: "Optional, the search query, Example Ocean, Tigers, Pears,\ + \ etc." + examples: + - "people" + - "oceans" + orientation: + title: "Specific orientation for the search" + type: "string" + description: "Optional, Desired photo orientation. The current supported\ + \ orientations are landscape, portrait or square" + examples: + - "square" + - "landscape" + size: + title: "Specific size for the search" + type: "string" + description: "Optional, Minimum photo size. The current supported sizes\ + \ are large(24MP), medium(12MP) or small(4MP)." + examples: + - "large" + - "small" + color: + title: "Specific color for the search" + type: "string" + description: "Optional, Desired photo color. Supported colors red, orange,\ + \ yellow, green, turquoise, blue, violet, pink, brown, black, gray, white\ + \ or any hexidecimal color code." + examples: + - "red" + - "orange" + locale: + title: "Specific locale for the search" + type: "string" + description: "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'." + examples: + - "en-US" + - "pt-BR" + source-glassfrog: + title: "Glassfrog Spec" + type: "object" + required: + - "api_key" + - "sourceType" + properties: + api_key: + type: "string" + description: "API key provided by Glassfrog" + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "glassfrog" + const: "glassfrog" + enum: + - "glassfrog" + order: 0 + type: "string" + source-glassfrog-update: + title: "Glassfrog Spec" + type: "object" + required: + - "api_key" + properties: + api_key: + type: "string" + description: "API key provided by Glassfrog" + airbyte_secret: true + source-facebook-marketing: + title: "Source Facebook Marketing" + type: "object" + properties: + account_ids: + title: "Ad Account ID(s)" + description: "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." + order: 0 + pattern_descriptor: "The Ad Account ID must be a number." + examples: + - "111111111111111" + minItems: 1 + type: "array" + items: + type: "string" + pattern: "^[0-9]+$" + uniqueItems: true + access_token: + title: "Access Token" + description: "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." + order: 1 + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + start_date: + title: "Start Date" + description: "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." + order: 2 + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2017-01-25T00:00:00Z" + type: "string" + format: "date-time" + end_date: + title: "End Date" + description: "The date until which you'd like to replicate data for all\ + \ incremental streams, in the format YYYY-MM-DDT00:00:00Z. All data generated\ + \ between the start date and this end date will be replicated. Not setting\ + \ this option will result in always syncing the latest data." + order: 3 + pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2017-01-26T00:00:00Z" + type: "string" + format: "date-time" + campaign_statuses: + title: "Campaign Statuses" + description: "Select the statuses you want to be loaded in the stream. If\ + \ no specific statuses are selected, the API's default behavior applies,\ + \ and some statuses may be filtered out." + default: [] + order: 4 + type: "array" + items: + title: "ValidCampaignStatuses" + description: "An enumeration." + enum: + - "ACTIVE" + - "ARCHIVED" + - "DELETED" + - "IN_PROCESS" + - "PAUSED" + - "WITH_ISSUES" + adset_statuses: + title: "AdSet Statuses" + description: "Select the statuses you want to be loaded in the stream. If\ + \ no specific statuses are selected, the API's default behavior applies,\ + \ and some statuses may be filtered out." + default: [] + order: 5 + type: "array" + items: + title: "ValidAdSetStatuses" + description: "An enumeration." + enum: + - "ACTIVE" + - "ARCHIVED" + - "CAMPAIGN_PAUSED" + - "DELETED" + - "IN_PROCESS" + - "PAUSED" + - "WITH_ISSUES" + ad_statuses: + title: "Ad Statuses" + description: "Select the statuses you want to be loaded in the stream. If\ + \ no specific statuses are selected, the API's default behavior applies,\ + \ and some statuses may be filtered out." + default: [] + order: 6 + type: "array" + items: + title: "ValidAdStatuses" + description: "An enumeration." + enum: + - "ACTIVE" + - "ADSET_PAUSED" + - "ARCHIVED" + - "CAMPAIGN_PAUSED" + - "DELETED" + - "DISAPPROVED" + - "IN_PROCESS" + - "PAUSED" + - "PENDING_BILLING_INFO" + - "PENDING_REVIEW" + - "PREAPPROVED" + - "WITH_ISSUES" + fetch_thumbnail_images: + title: "Fetch Thumbnail Images from Ad Creative" + description: "Set to active if you want to fetch the thumbnail_url and store\ + \ the result in thumbnail_data_url for each Ad Creative." + default: false + order: 7 + type: "boolean" + custom_insights: + title: "Custom Insights" + description: "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." + order: 8 + type: "array" + items: + title: "InsightConfig" + description: "Config for custom insights" + type: "object" + properties: + name: + title: "Name" + description: "The name value of insight" + type: "string" + level: + title: "Level" + description: "Chosen level for API" + default: "ad" + enum: + - "ad" + - "adset" + - "campaign" + - "account" + type: "string" + fields: + title: "Fields" + description: "A list of chosen fields for fields parameter" + default: [] + type: "array" + items: + title: "ValidEnums" + description: "An enumeration." + enum: + - "account_currency" + - "account_id" + - "account_name" + - "action_values" + - "actions" + - "ad_click_actions" + - "ad_id" + - "ad_impression_actions" + - "ad_name" + - "adset_end" + - "adset_id" + - "adset_name" + - "adset_start" + - "age_targeting" + - "attribution_setting" + - "auction_bid" + - "auction_competitiveness" + - "auction_max_competitor_bid" + - "buying_type" + - "campaign_id" + - "campaign_name" + - "canvas_avg_view_percent" + - "canvas_avg_view_time" + - "catalog_segment_actions" + - "catalog_segment_value" + - "catalog_segment_value_mobile_purchase_roas" + - "catalog_segment_value_omni_purchase_roas" + - "catalog_segment_value_website_purchase_roas" + - "clicks" + - "conversion_lead_rate" + - "conversion_rate_ranking" + - "conversion_values" + - "conversions" + - "converted_product_quantity" + - "converted_product_value" + - "cost_per_15_sec_video_view" + - "cost_per_2_sec_continuous_video_view" + - "cost_per_action_type" + - "cost_per_ad_click" + - "cost_per_conversion" + - "cost_per_conversion_lead" + - "cost_per_dda_countby_convs" + - "cost_per_estimated_ad_recallers" + - "cost_per_inline_link_click" + - "cost_per_inline_post_engagement" + - "cost_per_one_thousand_ad_impression" + - "cost_per_outbound_click" + - "cost_per_thruplay" + - "cost_per_unique_action_type" + - "cost_per_unique_click" + - "cost_per_unique_conversion" + - "cost_per_unique_inline_link_click" + - "cost_per_unique_outbound_click" + - "cpc" + - "cpm" + - "cpp" + - "created_time" + - "creative_media_type" + - "ctr" + - "date_start" + - "date_stop" + - "dda_countby_convs" + - "dda_results" + - "engagement_rate_ranking" + - "estimated_ad_recall_rate" + - "estimated_ad_recall_rate_lower_bound" + - "estimated_ad_recall_rate_upper_bound" + - "estimated_ad_recallers" + - "estimated_ad_recallers_lower_bound" + - "estimated_ad_recallers_upper_bound" + - "frequency" + - "full_view_impressions" + - "full_view_reach" + - "gender_targeting" + - "impressions" + - "inline_link_click_ctr" + - "inline_link_clicks" + - "inline_post_engagement" + - "instagram_upcoming_event_reminders_set" + - "instant_experience_clicks_to_open" + - "instant_experience_clicks_to_start" + - "instant_experience_outbound_clicks" + - "interactive_component_tap" + - "labels" + - "location" + - "marketing_messages_cost_per_delivered" + - "marketing_messages_cost_per_link_btn_click" + - "marketing_messages_spend" + - "mobile_app_purchase_roas" + - "objective" + - "optimization_goal" + - "outbound_clicks" + - "outbound_clicks_ctr" + - "place_page_name" + - "purchase_roas" + - "qualifying_question_qualify_answer_rate" + - "quality_ranking" + - "reach" + - "social_spend" + - "spend" + - "total_postbacks" + - "total_postbacks_detailed" + - "total_postbacks_detailed_v4" + - "unique_actions" + - "unique_clicks" + - "unique_conversions" + - "unique_ctr" + - "unique_inline_link_click_ctr" + - "unique_inline_link_clicks" + - "unique_link_clicks_ctr" + - "unique_outbound_clicks" + - "unique_outbound_clicks_ctr" + - "unique_video_continuous_2_sec_watched_actions" + - "unique_video_view_15_sec" + - "updated_time" + - "video_15_sec_watched_actions" + - "video_30_sec_watched_actions" + - "video_avg_time_watched_actions" + - "video_continuous_2_sec_watched_actions" + - "video_p100_watched_actions" + - "video_p25_watched_actions" + - "video_p50_watched_actions" + - "video_p75_watched_actions" + - "video_p95_watched_actions" + - "video_play_actions" + - "video_play_curve_actions" + - "video_play_retention_0_to_15s_actions" + - "video_play_retention_20_to_60s_actions" + - "video_play_retention_graph_actions" + - "video_thruplay_watched_actions" + - "video_time_watched_actions" + - "website_ctr" + - "website_purchase_roas" + - "wish_bid" + breakdowns: + title: "Breakdowns" + description: "A list of chosen breakdowns for breakdowns" + default: [] + type: "array" + items: + title: "ValidBreakdowns" + description: "An enumeration." + enum: + - "ad_format_asset" + - "age" + - "app_id" + - "body_asset" + - "call_to_action_asset" + - "coarse_conversion_value" + - "country" + - "description_asset" + - "device_platform" + - "dma" + - "fidelity_type" + - "frequency_value" + - "gender" + - "hourly_stats_aggregated_by_advertiser_time_zone" + - "hourly_stats_aggregated_by_audience_time_zone" + - "hsid" + - "image_asset" + - "impression_device" + - "is_conversion_id_modeled" + - "landing_destination" + - "link_url_asset" + - "marketing_messages_btn_name" + - "mdsa_landing_destination" + - "media_asset_url" + - "media_creator" + - "media_destination_url" + - "media_format" + - "media_origin_url" + - "media_text_content" + - "mmm" + - "place_page_id" + - "platform_position" + - "postback_sequence_index" + - "product_id" + - "publisher_platform" + - "redownload" + - "region" + - "skan_campaign_id" + - "skan_conversion_id" + - "skan_version" + - "standard_event_content_type" + - "title_asset" + - "video_asset" + action_breakdowns: + title: "Action Breakdowns" + description: "A list of chosen action_breakdowns for action_breakdowns" + default: [] + type: "array" + items: + title: "ValidActionBreakdowns" + description: "An enumeration." + enum: + - "action_canvas_component_name" + - "action_carousel_card_id" + - "action_carousel_card_name" + - "action_destination" + - "action_device" + - "action_reaction" + - "action_target_id" + - "action_type" + - "action_video_sound" + - "action_video_type" + - "standard_event_content_type" + action_report_time: + title: "Action Report Time" + description: "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." + default: "mixed" + enum: + - "conversion" + - "impression" + - "mixed" + type: "string" + time_increment: + title: "Time Increment" + description: "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)." + default: 1 + exclusiveMaximum: 90 + exclusiveMinimum: 0 + type: "integer" + start_date: + title: "Start Date" + description: "The date from which you'd like to replicate data for\ + \ this stream, in the format YYYY-MM-DDT00:00:00Z." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2017-01-25T00:00:00Z" + type: "string" + format: "date-time" + end_date: + title: "End Date" + description: "The date until which you'd like to replicate data for\ + \ this stream, in the format YYYY-MM-DDT00:00:00Z. All data generated\ + \ between the start date and this end date will be replicated. Not\ + \ setting this option will result in always syncing the latest data." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2017-01-26T00:00:00Z" + type: "string" + format: "date-time" + insights_lookback_window: + title: "Custom Insights Lookback Window" + description: "The attribution window" + default: 28 + maximum: 28 + mininum: 1 + exclusiveMinimum: 0 + type: "integer" + insights_job_timeout: + title: "Custom Insights Job Timeout" + description: "The insights job timeout" + default: 60 + maximum: 60 + mininum: 10 + exclusiveMinimum: 0 + type: "integer" + required: + - "name" + page_size: + title: "Page Size of Requests" + description: "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." + default: 100 + order: 10 + exclusiveMinimum: 0 + type: "integer" + insights_lookback_window: + title: "Insights Lookback Window" + description: "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." + default: 28 + order: 11 + maximum: 28 + mininum: 1 + exclusiveMinimum: 0 + type: "integer" + insights_job_timeout: + title: "Insights Job Timeout" + description: "Insights Job Timeout establishes the maximum amount of time\ + \ (in minutes) of waiting for the report job to complete. When timeout\ + \ is reached the job is considered failed and we are trying to request\ + \ smaller amount of data by breaking the job to few smaller ones. If you\ + \ definitely know that 60 minutes is not enough for your report to be\ + \ processed then you can decrease the timeout value, so we start breaking\ + \ job to smaller parts faster." + default: 60 + order: 12 + maximum: 60 + mininum: 10 + exclusiveMinimum: 0 + type: "integer" + action_breakdowns_allow_empty: + title: "Action Breakdowns Allow Empty" + description: "Allows action_breakdowns to be an empty list" + default: true + airbyte_hidden: true + type: "boolean" + client_id: + title: "Client Id" + description: "The Client Id for your OAuth app" + airbyte_secret: true + airbyte_hidden: true + type: "string" + client_secret: + title: "Client Secret" + description: "The Client Secret for your OAuth app" + airbyte_secret: true + airbyte_hidden: true + type: "string" + sourceType: + title: "facebook-marketing" + const: "facebook-marketing" + enum: + - "facebook-marketing" + order: 0 + type: "string" + required: + - "account_ids" + - "access_token" + - "sourceType" + source-facebook-marketing-update: + title: "Source Facebook Marketing" + type: "object" + properties: + account_ids: + title: "Ad Account ID(s)" + description: "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." + order: 0 + pattern_descriptor: "The Ad Account ID must be a number." + examples: + - "111111111111111" + minItems: 1 + type: "array" + items: + type: "string" + pattern: "^[0-9]+$" + uniqueItems: true + access_token: + title: "Access Token" + description: "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." + order: 1 + airbyte_secret: true + type: "string" + start_date: + title: "Start Date" + description: "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." + order: 2 + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2017-01-25T00:00:00Z" + type: "string" + format: "date-time" + end_date: + title: "End Date" + description: "The date until which you'd like to replicate data for all\ + \ incremental streams, in the format YYYY-MM-DDT00:00:00Z. All data generated\ + \ between the start date and this end date will be replicated. Not setting\ + \ this option will result in always syncing the latest data." + order: 3 + pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2017-01-26T00:00:00Z" + type: "string" + format: "date-time" + campaign_statuses: + title: "Campaign Statuses" + description: "Select the statuses you want to be loaded in the stream. If\ + \ no specific statuses are selected, the API's default behavior applies,\ + \ and some statuses may be filtered out." + default: [] + order: 4 + type: "array" + items: + title: "ValidCampaignStatuses" + description: "An enumeration." + enum: + - "ACTIVE" + - "ARCHIVED" + - "DELETED" + - "IN_PROCESS" + - "PAUSED" + - "WITH_ISSUES" + adset_statuses: + title: "AdSet Statuses" + description: "Select the statuses you want to be loaded in the stream. If\ + \ no specific statuses are selected, the API's default behavior applies,\ + \ and some statuses may be filtered out." + default: [] + order: 5 + type: "array" + items: + title: "ValidAdSetStatuses" + description: "An enumeration." + enum: + - "ACTIVE" + - "ARCHIVED" + - "CAMPAIGN_PAUSED" + - "DELETED" + - "IN_PROCESS" + - "PAUSED" + - "WITH_ISSUES" + ad_statuses: + title: "Ad Statuses" + description: "Select the statuses you want to be loaded in the stream. If\ + \ no specific statuses are selected, the API's default behavior applies,\ + \ and some statuses may be filtered out." + default: [] + order: 6 + type: "array" + items: + title: "ValidAdStatuses" + description: "An enumeration." + enum: + - "ACTIVE" + - "ADSET_PAUSED" + - "ARCHIVED" + - "CAMPAIGN_PAUSED" + - "DELETED" + - "DISAPPROVED" + - "IN_PROCESS" + - "PAUSED" + - "PENDING_BILLING_INFO" + - "PENDING_REVIEW" + - "PREAPPROVED" + - "WITH_ISSUES" + fetch_thumbnail_images: + title: "Fetch Thumbnail Images from Ad Creative" + description: "Set to active if you want to fetch the thumbnail_url and store\ + \ the result in thumbnail_data_url for each Ad Creative." + default: false + order: 7 + type: "boolean" + custom_insights: + title: "Custom Insights" + description: "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." + order: 8 + type: "array" + items: + title: "InsightConfig" + description: "Config for custom insights" + type: "object" + properties: + name: + title: "Name" + description: "The name value of insight" + type: "string" + level: + title: "Level" + description: "Chosen level for API" + default: "ad" + enum: + - "ad" + - "adset" + - "campaign" + - "account" + type: "string" + fields: + title: "Fields" + description: "A list of chosen fields for fields parameter" + default: [] + type: "array" + items: + title: "ValidEnums" + description: "An enumeration." + enum: + - "account_currency" + - "account_id" + - "account_name" + - "action_values" + - "actions" + - "ad_click_actions" + - "ad_id" + - "ad_impression_actions" + - "ad_name" + - "adset_end" + - "adset_id" + - "adset_name" + - "adset_start" + - "age_targeting" + - "attribution_setting" + - "auction_bid" + - "auction_competitiveness" + - "auction_max_competitor_bid" + - "buying_type" + - "campaign_id" + - "campaign_name" + - "canvas_avg_view_percent" + - "canvas_avg_view_time" + - "catalog_segment_actions" + - "catalog_segment_value" + - "catalog_segment_value_mobile_purchase_roas" + - "catalog_segment_value_omni_purchase_roas" + - "catalog_segment_value_website_purchase_roas" + - "clicks" + - "conversion_lead_rate" + - "conversion_rate_ranking" + - "conversion_values" + - "conversions" + - "converted_product_quantity" + - "converted_product_value" + - "cost_per_15_sec_video_view" + - "cost_per_2_sec_continuous_video_view" + - "cost_per_action_type" + - "cost_per_ad_click" + - "cost_per_conversion" + - "cost_per_conversion_lead" + - "cost_per_dda_countby_convs" + - "cost_per_estimated_ad_recallers" + - "cost_per_inline_link_click" + - "cost_per_inline_post_engagement" + - "cost_per_one_thousand_ad_impression" + - "cost_per_outbound_click" + - "cost_per_thruplay" + - "cost_per_unique_action_type" + - "cost_per_unique_click" + - "cost_per_unique_conversion" + - "cost_per_unique_inline_link_click" + - "cost_per_unique_outbound_click" + - "cpc" + - "cpm" + - "cpp" + - "created_time" + - "creative_media_type" + - "ctr" + - "date_start" + - "date_stop" + - "dda_countby_convs" + - "dda_results" + - "engagement_rate_ranking" + - "estimated_ad_recall_rate" + - "estimated_ad_recall_rate_lower_bound" + - "estimated_ad_recall_rate_upper_bound" + - "estimated_ad_recallers" + - "estimated_ad_recallers_lower_bound" + - "estimated_ad_recallers_upper_bound" + - "frequency" + - "full_view_impressions" + - "full_view_reach" + - "gender_targeting" + - "impressions" + - "inline_link_click_ctr" + - "inline_link_clicks" + - "inline_post_engagement" + - "instagram_upcoming_event_reminders_set" + - "instant_experience_clicks_to_open" + - "instant_experience_clicks_to_start" + - "instant_experience_outbound_clicks" + - "interactive_component_tap" + - "labels" + - "location" + - "marketing_messages_cost_per_delivered" + - "marketing_messages_cost_per_link_btn_click" + - "marketing_messages_spend" + - "mobile_app_purchase_roas" + - "objective" + - "optimization_goal" + - "outbound_clicks" + - "outbound_clicks_ctr" + - "place_page_name" + - "purchase_roas" + - "qualifying_question_qualify_answer_rate" + - "quality_ranking" + - "reach" + - "social_spend" + - "spend" + - "total_postbacks" + - "total_postbacks_detailed" + - "total_postbacks_detailed_v4" + - "unique_actions" + - "unique_clicks" + - "unique_conversions" + - "unique_ctr" + - "unique_inline_link_click_ctr" + - "unique_inline_link_clicks" + - "unique_link_clicks_ctr" + - "unique_outbound_clicks" + - "unique_outbound_clicks_ctr" + - "unique_video_continuous_2_sec_watched_actions" + - "unique_video_view_15_sec" + - "updated_time" + - "video_15_sec_watched_actions" + - "video_30_sec_watched_actions" + - "video_avg_time_watched_actions" + - "video_continuous_2_sec_watched_actions" + - "video_p100_watched_actions" + - "video_p25_watched_actions" + - "video_p50_watched_actions" + - "video_p75_watched_actions" + - "video_p95_watched_actions" + - "video_play_actions" + - "video_play_curve_actions" + - "video_play_retention_0_to_15s_actions" + - "video_play_retention_20_to_60s_actions" + - "video_play_retention_graph_actions" + - "video_thruplay_watched_actions" + - "video_time_watched_actions" + - "website_ctr" + - "website_purchase_roas" + - "wish_bid" + breakdowns: + title: "Breakdowns" + description: "A list of chosen breakdowns for breakdowns" + default: [] + type: "array" + items: + title: "ValidBreakdowns" + description: "An enumeration." + enum: + - "ad_format_asset" + - "age" + - "app_id" + - "body_asset" + - "call_to_action_asset" + - "coarse_conversion_value" + - "country" + - "description_asset" + - "device_platform" + - "dma" + - "fidelity_type" + - "frequency_value" + - "gender" + - "hourly_stats_aggregated_by_advertiser_time_zone" + - "hourly_stats_aggregated_by_audience_time_zone" + - "hsid" + - "image_asset" + - "impression_device" + - "is_conversion_id_modeled" + - "landing_destination" + - "link_url_asset" + - "marketing_messages_btn_name" + - "mdsa_landing_destination" + - "media_asset_url" + - "media_creator" + - "media_destination_url" + - "media_format" + - "media_origin_url" + - "media_text_content" + - "mmm" + - "place_page_id" + - "platform_position" + - "postback_sequence_index" + - "product_id" + - "publisher_platform" + - "redownload" + - "region" + - "skan_campaign_id" + - "skan_conversion_id" + - "skan_version" + - "standard_event_content_type" + - "title_asset" + - "video_asset" + action_breakdowns: + title: "Action Breakdowns" + description: "A list of chosen action_breakdowns for action_breakdowns" + default: [] + type: "array" + items: + title: "ValidActionBreakdowns" + description: "An enumeration." + enum: + - "action_canvas_component_name" + - "action_carousel_card_id" + - "action_carousel_card_name" + - "action_destination" + - "action_device" + - "action_reaction" + - "action_target_id" + - "action_type" + - "action_video_sound" + - "action_video_type" + - "standard_event_content_type" + action_report_time: + title: "Action Report Time" + description: "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." + default: "mixed" + enum: + - "conversion" + - "impression" + - "mixed" + type: "string" + time_increment: + title: "Time Increment" + description: "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)." + default: 1 + exclusiveMaximum: 90 + exclusiveMinimum: 0 + type: "integer" + start_date: + title: "Start Date" + description: "The date from which you'd like to replicate data for\ + \ this stream, in the format YYYY-MM-DDT00:00:00Z." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2017-01-25T00:00:00Z" + type: "string" + format: "date-time" + end_date: + title: "End Date" + description: "The date until which you'd like to replicate data for\ + \ this stream, in the format YYYY-MM-DDT00:00:00Z. All data generated\ + \ between the start date and this end date will be replicated. Not\ + \ setting this option will result in always syncing the latest data." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2017-01-26T00:00:00Z" + type: "string" + format: "date-time" + insights_lookback_window: + title: "Custom Insights Lookback Window" + description: "The attribution window" + default: 28 + maximum: 28 + mininum: 1 + exclusiveMinimum: 0 + type: "integer" + insights_job_timeout: + title: "Custom Insights Job Timeout" + description: "The insights job timeout" + default: 60 + maximum: 60 + mininum: 10 + exclusiveMinimum: 0 + type: "integer" + required: + - "name" + page_size: + title: "Page Size of Requests" + description: "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." + default: 100 + order: 10 + exclusiveMinimum: 0 + type: "integer" + insights_lookback_window: + title: "Insights Lookback Window" + description: "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." + default: 28 + order: 11 + maximum: 28 + mininum: 1 + exclusiveMinimum: 0 + type: "integer" + insights_job_timeout: + title: "Insights Job Timeout" + description: "Insights Job Timeout establishes the maximum amount of time\ + \ (in minutes) of waiting for the report job to complete. When timeout\ + \ is reached the job is considered failed and we are trying to request\ + \ smaller amount of data by breaking the job to few smaller ones. If you\ + \ definitely know that 60 minutes is not enough for your report to be\ + \ processed then you can decrease the timeout value, so we start breaking\ + \ job to smaller parts faster." + default: 60 + order: 12 + maximum: 60 + mininum: 10 + exclusiveMinimum: 0 + type: "integer" + action_breakdowns_allow_empty: + title: "Action Breakdowns Allow Empty" + description: "Allows action_breakdowns to be an empty list" + default: true + airbyte_hidden: true + type: "boolean" + client_id: + title: "Client Id" + description: "The Client Id for your OAuth app" + airbyte_secret: true + airbyte_hidden: true + type: "string" + client_secret: + title: "Client Secret" + description: "The Client Secret for your OAuth app" + airbyte_secret: true + airbyte_hidden: true + type: "string" + required: + - "account_ids" + - "access_token" + source-recruitee: + title: "Recruitee Spec" + type: "object" + required: + - "api_key" + - "company_id" + - "sourceType" + properties: + api_key: + title: "API Key" + type: "string" + description: "Recruitee API Key. See here." + airbyte_secret: true + x-speakeasy-param-sensitive: true + company_id: + title: "Company ID" + type: "integer" + description: "Recruitee Company ID. You can also find this ID on the Recruitee API\ + \ tokens page." + sourceType: + title: "recruitee" + const: "recruitee" + enum: + - "recruitee" + order: 0 + type: "string" + source-recruitee-update: + title: "Recruitee Spec" + type: "object" + required: + - "api_key" + - "company_id" + properties: + api_key: + title: "API Key" + type: "string" + description: "Recruitee API Key. See here." + airbyte_secret: true + company_id: + title: "Company ID" + type: "integer" + description: "Recruitee Company ID. You can also find this ID on the Recruitee API\ + \ tokens page." + source-survey-sparrow: + title: "Survey Sparrow Spec" + type: "object" + required: + - "access_token" + - "sourceType" + properties: + access_token: + type: "string" + description: "Your access token. See here. The key is case sensitive." + airbyte_secret: true + order: 0 + x-speakeasy-param-sensitive: true + survey_id: + type: "array" + description: "A List of your survey ids for survey-specific stream" + order: 2 + region: + title: "Base URL" + type: "object" + description: "Is your account location is EU based? If yes, the base url\ + \ to retrieve data will be different." + oneOf: + - title: "EU-based account" + type: "object" + properties: + url_base: + type: "string" + const: "https://eu-api.surveysparrow.com/v3" + enum: + - "https://eu-api.surveysparrow.com/v3" + - title: "Global account" + type: "object" + properties: + url_base: + type: "string" + const: "https://api.surveysparrow.com/v3" + enum: + - "https://api.surveysparrow.com/v3" + default: + title: "Global account" + type: "object" + properties: + url_base: + type: "string" + const: "https://api.surveysparrow.com/v3" + enum: + - "https://api.surveysparrow.com/v3" + order: 1 + sourceType: + title: "survey-sparrow" + const: "survey-sparrow" + enum: + - "survey-sparrow" + order: 0 + type: "string" + source-survey-sparrow-update: + title: "Survey Sparrow Spec" + type: "object" + required: + - "access_token" + properties: + access_token: + type: "string" + description: "Your access token. See here. The key is case sensitive." + airbyte_secret: true + order: 0 + survey_id: + type: "array" + description: "A List of your survey ids for survey-specific stream" + order: 2 + region: + title: "Base URL" + type: "object" + description: "Is your account location is EU based? If yes, the base url\ + \ to retrieve data will be different." + oneOf: + - title: "EU-based account" + type: "object" + properties: + url_base: + type: "string" + const: "https://eu-api.surveysparrow.com/v3" + enum: + - "https://eu-api.surveysparrow.com/v3" + - title: "Global account" + type: "object" + properties: + url_base: + type: "string" + const: "https://api.surveysparrow.com/v3" + enum: + - "https://api.surveysparrow.com/v3" + default: + title: "Global account" + type: "object" + properties: + url_base: + type: "string" + const: "https://api.surveysparrow.com/v3" + enum: + - "https://api.surveysparrow.com/v3" + order: 1 + source-azure-table: + title: "Azure Data Table Spec" + type: "object" + required: + - "storage_account_name" + - "storage_access_key" + - "sourceType" + properties: + storage_account_name: + title: "Account Name" + type: "string" + description: "The name of your storage account." + order: 0 + airbyte_secret: false + storage_access_key: + title: "Access Key" + type: "string" + description: "Azure Table Storage Access Key. See the docs for more information on how to obtain this key." + order: 1 + airbyte_secret: true + x-speakeasy-param-sensitive: true + storage_endpoint_suffix: + title: "Endpoint Suffix" + type: "string" + description: "Azure Table Storage service account URL suffix. See the docs\ + \ for more information on how to obtain endpoint suffix" + order: 2 + default: "core.windows.net" + examples: + - "core.windows.net" + - "core.chinacloudapi.cn" + airbyte_secret: false + sourceType: + title: "azure-table" + const: "azure-table" + enum: + - "azure-table" + order: 0 + type: "string" + source-azure-table-update: + title: "Azure Data Table Spec" + type: "object" + required: + - "storage_account_name" + - "storage_access_key" + properties: + storage_account_name: + title: "Account Name" + type: "string" + description: "The name of your storage account." + order: 0 + airbyte_secret: false + storage_access_key: + title: "Access Key" + type: "string" + description: "Azure Table Storage Access Key. See the docs for more information on how to obtain this key." + order: 1 + airbyte_secret: true + storage_endpoint_suffix: + title: "Endpoint Suffix" + type: "string" + description: "Azure Table Storage service account URL suffix. See the docs\ + \ for more information on how to obtain endpoint suffix" + order: 2 + default: "core.windows.net" + examples: + - "core.windows.net" + - "core.chinacloudapi.cn" + airbyte_secret: false + source-surveymonkey: + type: "object" + required: + - "start_date" + - "credentials" + - "sourceType" + properties: + origin: + type: "string" + order: 1 + enum: + - "USA" + - "Europe" + - "Canada" + default: "USA" + title: "Origin datacenter of the SurveyMonkey account" + description: "Depending on the originating datacenter of the SurveyMonkey\ + \ account, the API access URL may be different." + credentials: + title: "SurveyMonkey Authorization Method" + description: "The authorization method to use to retrieve data from SurveyMonkey" + type: "object" + required: + - "auth_method" + - "access_token" + order: 2 + properties: + auth_method: + type: "string" + const: "oauth2.0" + order: 0 + enum: + - "oauth2.0" + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of the SurveyMonkey developer application." + airbyte_secret: true + order: 1 + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of the SurveyMonkey developer application." + airbyte_secret: true + order: 2 + access_token: + title: "Access Token" + order: 3 + type: "string" + airbyte_secret: true + description: "Access Token for making authenticated requests. See the\ + \ docs for information on how to generate this key." + x-speakeasy-param-sensitive: true + start_date: + title: "Start Date" + order: 3 + type: "string" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z?$" + examples: + - "2021-01-01T00:00:00Z" + format: "date-time" + survey_ids: + type: "array" + order: 1000 + items: + type: "string" + pattern: "^[0-9]{8,9}$" + title: "Survey Monkey survey IDs" + description: "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." + sourceType: + title: "surveymonkey" + const: "surveymonkey" + enum: + - "surveymonkey" + order: 0 + type: "string" + source-surveymonkey-update: + type: "object" + required: + - "start_date" + - "credentials" + properties: + origin: + type: "string" + order: 1 + enum: + - "USA" + - "Europe" + - "Canada" + default: "USA" + title: "Origin datacenter of the SurveyMonkey account" + description: "Depending on the originating datacenter of the SurveyMonkey\ + \ account, the API access URL may be different." + credentials: + title: "SurveyMonkey Authorization Method" + description: "The authorization method to use to retrieve data from SurveyMonkey" + type: "object" + required: + - "auth_method" + - "access_token" + order: 2 + properties: + auth_method: + type: "string" + const: "oauth2.0" + order: 0 + enum: + - "oauth2.0" + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of the SurveyMonkey developer application." + airbyte_secret: true + order: 1 + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of the SurveyMonkey developer application." + airbyte_secret: true + order: 2 + access_token: + title: "Access Token" + order: 3 + type: "string" + airbyte_secret: true + description: "Access Token for making authenticated requests. See the\ + \ docs for information on how to generate this key." + start_date: + title: "Start Date" + order: 3 + type: "string" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z?$" + examples: + - "2021-01-01T00:00:00Z" + format: "date-time" + survey_ids: + type: "array" + order: 1000 + items: + type: "string" + pattern: "^[0-9]{8,9}$" + title: "Survey Monkey survey IDs" + description: "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." + source-persistiq: + title: "Persistiq Spec" + type: "object" + required: + - "api_key" + - "sourceType" + properties: + api_key: + type: "string" + description: "PersistIq API Key. See the docs for more information on where to find that key." + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "persistiq" + const: "persistiq" + enum: + - "persistiq" + order: 0 + type: "string" + source-persistiq-update: + title: "Persistiq Spec" + type: "object" + required: + - "api_key" + properties: + api_key: + type: "string" + description: "PersistIq API Key. See the docs for more information on where to find that key." + airbyte_secret: true + source-configcat: + title: "Configcat Spec" + type: "object" + required: + - "username" + - "password" + - "sourceType" + properties: + username: + title: "Username" + type: "string" + description: "Basic auth user name. See here." + password: + title: "Password" + type: "string" + description: "Basic auth password. See here." + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "configcat" + const: "configcat" + enum: + - "configcat" + order: 0 + type: "string" + source-configcat-update: + title: "Configcat Spec" + type: "object" + required: + - "username" + - "password" + properties: + username: + title: "Username" + type: "string" + description: "Basic auth user name. See here." + password: + title: "Password" + type: "string" + description: "Basic auth password. See here." + airbyte_secret: true + source-insightly: + title: "Insightly Spec" + type: "object" + required: + - "token" + - "start_date" + - "sourceType" + properties: + token: + type: + - "string" + - "null" + title: "API Token" + description: "Your Insightly API token." + airbyte_secret: true + x-speakeasy-param-sensitive: true + start_date: + type: + - "string" + - "null" + title: "Start Date" + description: "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." + examples: + - "2021-03-01T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + sourceType: + title: "insightly" + const: "insightly" + enum: + - "insightly" + order: 0 + type: "string" + source-insightly-update: + title: "Insightly Spec" + type: "object" + required: + - "token" + - "start_date" + properties: + token: + type: + - "string" + - "null" + title: "API Token" + description: "Your Insightly API token." + airbyte_secret: true + start_date: + type: + - "string" + - "null" + title: "Start Date" + description: "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." + examples: + - "2021-03-01T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + source-cart: + title: "Cart.com Spec" + type: "object" + required: + - "start_date" + - "sourceType" + properties: + credentials: + title: "Authorization Method" + description: "" + type: "object" + oneOf: + - title: "Central API Router" + type: "object" + order: 0 + required: + - "auth_type" + - "user_name" + - "user_secret" + - "site_id" + properties: + auth_type: + type: "string" + const: "CENTRAL_API_ROUTER" + order: 0 + enum: + - "CENTRAL_API_ROUTER" + user_name: + type: "string" + title: "User Name" + description: "Enter your application's User Name" + airbyte_secret: true + order: 1 + user_secret: + type: "string" + title: "User Secret" + description: "Enter your application's User Secret" + airbyte_secret: true + order: 2 + site_id: + type: "string" + title: "Site ID" + description: "You can determine a site provisioning site Id by hitting\ + \ https://site.com/store/sitemonitor.aspx and reading the response\ + \ param PSID" + airbyte_secret: true + order: 3 + - title: "Single Store Access Token" + type: "object" + order: 1 + required: + - "auth_type" + - "access_token" + - "store_name" + properties: + auth_type: + type: "string" + const: "SINGLE_STORE_ACCESS_TOKEN" + order: 0 + enum: + - "SINGLE_STORE_ACCESS_TOKEN" + access_token: + type: "string" + title: "Access Token" + airbyte_secret: true + order: 1 + description: "Access Token for making authenticated requests." + x-speakeasy-param-sensitive: true + store_name: + type: "string" + title: "Store Name" + order: 2 + description: "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." + start_date: + title: "Start Date" + type: "string" + description: "The date from which you'd like to replicate the data" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2021-01-01T00:00:00Z" + sourceType: + title: "cart" + const: "cart" + enum: + - "cart" + order: 0 + type: "string" + source-cart-update: + title: "Cart.com Spec" + type: "object" + required: + - "start_date" + properties: + credentials: + title: "Authorization Method" + description: "" + type: "object" + oneOf: + - title: "Central API Router" + type: "object" + order: 0 + required: + - "auth_type" + - "user_name" + - "user_secret" + - "site_id" + properties: + auth_type: + type: "string" + const: "CENTRAL_API_ROUTER" + order: 0 + enum: + - "CENTRAL_API_ROUTER" + user_name: + type: "string" + title: "User Name" + description: "Enter your application's User Name" + airbyte_secret: true + order: 1 + user_secret: + type: "string" + title: "User Secret" + description: "Enter your application's User Secret" + airbyte_secret: true + order: 2 + site_id: + type: "string" + title: "Site ID" + description: "You can determine a site provisioning site Id by hitting\ + \ https://site.com/store/sitemonitor.aspx and reading the response\ + \ param PSID" + airbyte_secret: true + order: 3 + - title: "Single Store Access Token" + type: "object" + order: 1 + required: + - "auth_type" + - "access_token" + - "store_name" + properties: + auth_type: + type: "string" + const: "SINGLE_STORE_ACCESS_TOKEN" + order: 0 + enum: + - "SINGLE_STORE_ACCESS_TOKEN" + access_token: + type: "string" + title: "Access Token" + airbyte_secret: true + order: 1 + description: "Access Token for making authenticated requests." + store_name: + type: "string" + title: "Store Name" + order: 2 + description: "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." + start_date: + title: "Start Date" + type: "string" + description: "The date from which you'd like to replicate the data" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2021-01-01T00:00:00Z" + source-oracle: + title: "Oracle Source Spec" + type: "object" + required: + - "host" + - "port" + - "username" + - "encryption" + - "sourceType" + properties: + host: + title: "Host" + description: "Hostname of the database." + type: "string" + order: 1 + port: + title: "Port" + description: "Port of the database.\nOracle Corporations recommends the\ + \ following port numbers:\n1521 - Default listening port for client connections\ + \ to the listener. \n2484 - Recommended and officially registered listening\ + \ port for client connections to the listener using TCP/IP with SSL" + type: "integer" + minimum: 0 + maximum: 65536 + default: 1521 + order: 2 + connection_data: + title: "Connect by" + type: "object" + description: "Connect data that will be used for DB connection" + order: 3 + oneOf: + - title: "Service name" + description: "Use service name" + required: + - "service_name" + properties: + connection_type: + type: "string" + const: "service_name" + order: 0 + enum: + - "service_name" + service_name: + title: "Service name" + type: "string" + order: 1 + - title: "System ID (SID)" + description: "Use SID (Oracle System Identifier)" + required: + - "sid" + properties: + connection_type: + type: "string" + const: "sid" + order: 0 + enum: + - "sid" + sid: + title: "System ID (SID)" + type: "string" + order: 1 + username: + title: "User" + description: "The username which is used to access the database." + type: "string" + order: 4 + password: + title: "Password" + description: "The password associated with the username." + type: "string" + airbyte_secret: true + order: 5 + x-speakeasy-param-sensitive: true + schemas: + title: "Schemas" + description: "The list of schemas to sync from. Defaults to user. Case sensitive." + type: "array" + items: + type: "string" + minItems: 1 + uniqueItems: true + order: 6 + jdbc_url_params: + title: "JDBC URL Params" + description: "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)." + type: "string" + order: 7 + encryption: + title: "Encryption" + type: "object" + description: "The encryption method with is used when communicating with\ + \ the database." + order: 8 + oneOf: + - title: "Native Network Encryption (NNE)" + description: "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." + required: + - "encryption_method" + properties: + encryption_method: + type: "string" + const: "client_nne" + enum: + - "client_nne" + encryption_algorithm: + type: "string" + description: "This parameter defines what encryption algorithm is\ + \ used." + title: "Encryption Algorithm" + default: "AES256" + enum: + - "AES256" + - "RC4_56" + - "3DES168" + - title: "TLS Encrypted (verify certificate)" + description: "Verify and use the certificate provided by the server." + required: + - "encryption_method" + - "ssl_certificate" + properties: + encryption_method: + type: "string" + const: "encrypted_verify_certificate" + enum: + - "encrypted_verify_certificate" + ssl_certificate: + title: "SSL PEM File" + description: "Privacy Enhanced Mail (PEM) files are concatenated certificate\ + \ containers frequently used in certificate installations." + type: "string" + airbyte_secret: true + multiline: true + order: 4 + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + x-speakeasy-param-sensitive: true + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + sourceType: + title: "oracle" + const: "oracle" + enum: + - "oracle" + order: 0 + type: "string" + source-oracle-update: + title: "Oracle Source Spec" + type: "object" + required: + - "host" + - "port" + - "username" + - "encryption" + properties: + host: + title: "Host" + description: "Hostname of the database." + type: "string" + order: 1 + port: + title: "Port" + description: "Port of the database.\nOracle Corporations recommends the\ + \ following port numbers:\n1521 - Default listening port for client connections\ + \ to the listener. \n2484 - Recommended and officially registered listening\ + \ port for client connections to the listener using TCP/IP with SSL" + type: "integer" + minimum: 0 + maximum: 65536 + default: 1521 + order: 2 + connection_data: + title: "Connect by" + type: "object" + description: "Connect data that will be used for DB connection" + order: 3 + oneOf: + - title: "Service name" + description: "Use service name" + required: + - "service_name" + properties: + connection_type: + type: "string" + const: "service_name" + order: 0 + enum: + - "service_name" + service_name: + title: "Service name" + type: "string" + order: 1 + - title: "System ID (SID)" + description: "Use SID (Oracle System Identifier)" + required: + - "sid" + properties: + connection_type: + type: "string" + const: "sid" + order: 0 + enum: + - "sid" + sid: + title: "System ID (SID)" + type: "string" + order: 1 + username: + title: "User" + description: "The username which is used to access the database." + type: "string" + order: 4 + password: + title: "Password" + description: "The password associated with the username." + type: "string" + airbyte_secret: true + order: 5 + schemas: + title: "Schemas" + description: "The list of schemas to sync from. Defaults to user. Case sensitive." + type: "array" + items: + type: "string" + minItems: 1 + uniqueItems: true + order: 6 + jdbc_url_params: + title: "JDBC URL Params" + description: "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)." + type: "string" + order: 7 + encryption: + title: "Encryption" + type: "object" + description: "The encryption method with is used when communicating with\ + \ the database." + order: 8 + oneOf: + - title: "Native Network Encryption (NNE)" + description: "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." + required: + - "encryption_method" + properties: + encryption_method: + type: "string" + const: "client_nne" + enum: + - "client_nne" + encryption_algorithm: + type: "string" + description: "This parameter defines what encryption algorithm is\ + \ used." + title: "Encryption Algorithm" + default: "AES256" + enum: + - "AES256" + - "RC4_56" + - "3DES168" + - title: "TLS Encrypted (verify certificate)" + description: "Verify and use the certificate provided by the server." + required: + - "encryption_method" + - "ssl_certificate" + properties: + encryption_method: + type: "string" + const: "encrypted_verify_certificate" + enum: + - "encrypted_verify_certificate" + ssl_certificate: + title: "SSL PEM File" + description: "Privacy Enhanced Mail (PEM) files are concatenated certificate\ + \ containers frequently used in certificate installations." + type: "string" + airbyte_secret: true + multiline: true + order: 4 + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + source-appfollow: + title: "Appfollow Spec" + type: "object" + required: + - "api_key" + - "sourceType" + properties: + api_secret: + type: "string" + title: "API Key" + description: "API Key provided by Appfollow" + airbyte_secret: true + sourceType: + title: "appfollow" + const: "appfollow" + enum: + - "appfollow" + order: 0 + type: "string" + source-appfollow-update: + title: "Appfollow Spec" + type: "object" + required: + - "api_key" + properties: + api_secret: + type: "string" + title: "API Key" + description: "API Key provided by Appfollow" + airbyte_secret: true + source-chartmogul: + title: "Chartmogul Spec" + type: "object" + required: + - "api_key" + - "start_date" + - "sourceType" + properties: + api_key: + type: "string" + title: "API key" + description: "Your Chartmogul API key. See the docs for info on how to obtain this." + airbyte_secret: true + order: 0 + x-speakeasy-param-sensitive: true + start_date: + type: "string" + title: "Start date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. When\ + \ feasible, any data before this date will not be replicated." + examples: + - "2017-01-25T00:00:00Z" + order: 1 + format: "date-time" + sourceType: + title: "chartmogul" + const: "chartmogul" + enum: + - "chartmogul" + order: 0 + type: "string" + source-chartmogul-update: + title: "Chartmogul Spec" + type: "object" + required: + - "api_key" + - "start_date" + properties: + api_key: + type: "string" + title: "API key" + description: "Your Chartmogul API key. See the docs for info on how to obtain this." + airbyte_secret: true + order: 0 + start_date: + type: "string" + title: "Start date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. When\ + \ feasible, any data before this date will not be replicated." + examples: + - "2017-01-25T00:00:00Z" + order: 1 + format: "date-time" + source-coinmarketcap: + title: "Coinmarketcap Spec" + type: "object" + required: + - "api_key" + - "data_type" + - "sourceType" + properties: + api_key: + title: "API Key" + type: "string" + description: "Your API Key. See here. The token is case sensitive." + airbyte_secret: true + x-speakeasy-param-sensitive: true + data_type: + title: "Data type" + type: "string" + enum: + - "latest" + - "historical" + description: "/latest: Latest market ticker quotes and averages for cryptocurrencies\ + \ and exchanges. /historical: Intervals of historic market data like OHLCV\ + \ data or data for use in charting libraries. See here." + symbols: + title: "Symbol" + type: "array" + items: + type: "string" + description: "Cryptocurrency symbols. (only used for quotes stream)" + minItems: 1 + examples: + - "AVAX" + - "BTC" + sourceType: + title: "coinmarketcap" + const: "coinmarketcap" + enum: + - "coinmarketcap" + order: 0 + type: "string" + source-coinmarketcap-update: + title: "Coinmarketcap Spec" + type: "object" + required: + - "api_key" + - "data_type" + properties: + api_key: + title: "API Key" + type: "string" + description: "Your API Key. See here. The token is case sensitive." + airbyte_secret: true + data_type: + title: "Data type" + type: "string" + enum: + - "latest" + - "historical" + description: "/latest: Latest market ticker quotes and averages for cryptocurrencies\ + \ and exchanges. /historical: Intervals of historic market data like OHLCV\ + \ data or data for use in charting libraries. See here." + symbols: + title: "Symbol" + type: "array" + items: + type: "string" + description: "Cryptocurrency symbols. (only used for quotes stream)" + minItems: 1 + examples: + - "AVAX" + - "BTC" + source-dixa: + type: "object" + required: + - "api_token" + - "start_date" + - "sourceType" + properties: + api_token: + type: "string" + description: "Dixa API token" + airbyte_secret: true + order: 1 + x-speakeasy-param-sensitive: true + batch_size: + type: "integer" + description: "Number of days to batch into one request. Max 31." + pattern: "^[0-9]{1,2}$" + examples: + - 1 + - 31 + default: 31 + order: 2 + start_date: + type: "string" + title: "Start date" + format: "date-time" + description: "The connector pulls records updated from this date onwards." + examples: + - "YYYY-MM-DD" + order: 3 + sourceType: + title: "dixa" + const: "dixa" + enum: + - "dixa" + order: 0 + type: "string" + source-dixa-update: + type: "object" + required: + - "api_token" + - "start_date" + properties: + api_token: + type: "string" + description: "Dixa API token" + airbyte_secret: true + order: 1 + batch_size: + type: "integer" + description: "Number of days to batch into one request. Max 31." + pattern: "^[0-9]{1,2}$" + examples: + - 1 + - 31 + default: 31 + order: 2 + start_date: + type: "string" + title: "Start date" + format: "date-time" + description: "The connector pulls records updated from this date onwards." + examples: + - "YYYY-MM-DD" + order: 3 + source-freshcaller: + title: "Freshcaller Spec" + type: "object" + required: + - "domain" + - "api_key" + - "sourceType" + properties: + domain: + type: "string" + title: "Domain for Freshcaller account" + description: "Used to construct Base URL for the Freshcaller APIs" + examples: + - "snaptravel" + api_key: + type: "string" + title: "API Key" + description: "Freshcaller API Key. See the docs for more information on how to obtain this key." + airbyte_secret: true + x-speakeasy-param-sensitive: true + requests_per_minute: + title: "Requests per minute" + type: "integer" + description: "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." + start_date: + title: "Start Date" + description: "UTC date and time. Any data created after this date will be\ + \ replicated." + format: "date-time" + type: "string" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2022-01-01T12:00:00Z" + sync_lag_minutes: + title: "Lag in minutes for each sync" + type: "integer" + description: "Lag in minutes for each sync, i.e., at time T, data for the\ + \ time range [prev_sync_time, T-30] will be fetched" + sourceType: + title: "freshcaller" + const: "freshcaller" + enum: + - "freshcaller" + order: 0 + type: "string" + source-freshcaller-update: + title: "Freshcaller Spec" + type: "object" + required: + - "domain" + - "api_key" + properties: + domain: + type: "string" + title: "Domain for Freshcaller account" + description: "Used to construct Base URL for the Freshcaller APIs" + examples: + - "snaptravel" + api_key: + type: "string" + title: "API Key" + description: "Freshcaller API Key. See the docs for more information on how to obtain this key." + airbyte_secret: true + requests_per_minute: + title: "Requests per minute" + type: "integer" + description: "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." + start_date: + title: "Start Date" + description: "UTC date and time. Any data created after this date will be\ + \ replicated." + format: "date-time" + type: "string" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + examples: + - "2022-01-01T12:00:00Z" + sync_lag_minutes: + title: "Lag in minutes for each sync" + type: "integer" + description: "Lag in minutes for each sync, i.e., at time T, data for the\ + \ time range [prev_sync_time, T-30] will be fetched" + source-recharge: + title: "Recharge Spec" + type: "object" + required: + - "start_date" + - "access_token" + - "sourceType" + properties: + start_date: + type: "string" + title: "Start Date" + description: "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." + examples: + - "2021-05-14T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + format: "date-time" + access_token: + type: "string" + title: "Access Token" + description: "The value of the Access Token generated. See the docs for\ + \ more information." + airbyte_secret: true + x-speakeasy-param-sensitive: true + use_orders_deprecated_api: + type: "boolean" + title: "Use `Orders` Deprecated API" + description: "Define whether or not the `Orders` stream should use the deprecated\ + \ `2021-01` API version, or use `2021-11`, otherwise." + default: true + sourceType: + title: "recharge" + const: "recharge" + enum: + - "recharge" + order: 0 + type: "string" + source-recharge-update: + title: "Recharge Spec" + type: "object" + required: + - "start_date" + - "access_token" + properties: + start_date: + type: "string" + title: "Start Date" + description: "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." + examples: + - "2021-05-14T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + format: "date-time" + access_token: + type: "string" + title: "Access Token" + description: "The value of the Access Token generated. See the docs for\ + \ more information." + airbyte_secret: true + use_orders_deprecated_api: + type: "boolean" + title: "Use `Orders` Deprecated API" + description: "Define whether or not the `Orders` stream should use the deprecated\ + \ `2021-01` API version, or use `2021-11`, otherwise." + default: true + source-aha: + title: "Aha Spec" + type: "object" + required: + - "api_key" + - "url" + - "sourceType" + properties: + api_key: + type: "string" + description: "API Key" + title: "API Bearer Token" + airbyte_secret: true + x-speakeasy-param-sensitive: true + url: + type: "string" + description: "URL" + title: "Aha Url Instance" + sourceType: + title: "aha" + const: "aha" + enum: + - "aha" + order: 0 + type: "string" + source-aha-update: + title: "Aha Spec" + type: "object" + required: + - "api_key" + - "url" + properties: + api_key: + type: "string" + description: "API Key" + title: "API Bearer Token" + airbyte_secret: true + url: + type: "string" + description: "URL" + title: "Aha Url Instance" + source-datascope: + title: "Datascope Spec" + type: "object" + required: + - "api_key" + - "start_date" + - "sourceType" + properties: + start_date: + title: "Start Date" + type: "string" + description: "Start date for the data to be replicated" + examples: + - "dd/mm/YYYY HH:MM" + pattern: "^[0-9]{2}/[0-9]{2}/[0-9]{4} [0-9]{2}:[0-9]{2}$" + api_key: + title: "Authorization" + type: "string" + description: "API Key" + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "datascope" + const: "datascope" + enum: + - "datascope" + order: 0 + type: "string" + source-datascope-update: + title: "Datascope Spec" + type: "object" + required: + - "api_key" + - "start_date" + properties: + start_date: + title: "Start Date" + type: "string" + description: "Start date for the data to be replicated" + examples: + - "dd/mm/YYYY HH:MM" + pattern: "^[0-9]{2}/[0-9]{2}/[0-9]{4} [0-9]{2}:[0-9]{2}$" + api_key: + title: "Authorization" + type: "string" + description: "API Key" + airbyte_secret: true + source-metabase: + title: "Metabase Source Spec" + type: "object" + required: + - "instance_api_url" + - "sourceType" + properties: + instance_api_url: + type: "string" + title: "Metabase Instance API URL" + description: "URL to your metabase instance API" + examples: + - "https://localhost:3000/api/" + pattern: "^https://" + order: 0 + username: + type: "string" + order: 1 + password: + type: "string" + airbyte_secret: true + order: 2 + x-speakeasy-param-sensitive: true + session_token: + type: "string" + description: "To generate your session token, you need to run the following\ + \ command: ``` curl -X POST \\\n -H \"Content-Type: application/json\"\ + \ \\\n -d '{\"username\": \"person@metabase.com\", \"password\": \"fakepassword\"\ + }' \\\n http://localhost:3000/api/session\n``` Then copy the value of\ + \ the `id` field returned by a successful call to that API.\nNote that\ + \ by default, sessions are good for 14 days and needs to be regenerated." + airbyte_secret: true + order: 3 + x-speakeasy-param-sensitive: true + sourceType: + title: "metabase" + const: "metabase" + enum: + - "metabase" + order: 0 + type: "string" + source-metabase-update: + title: "Metabase Source Spec" + type: "object" + required: + - "instance_api_url" + properties: + instance_api_url: + type: "string" + title: "Metabase Instance API URL" + description: "URL to your metabase instance API" + examples: + - "https://localhost:3000/api/" + pattern: "^https://" + order: 0 + username: + type: "string" + order: 1 + password: + type: "string" + airbyte_secret: true + order: 2 + session_token: + type: "string" + description: "To generate your session token, you need to run the following\ + \ command: ``` curl -X POST \\\n -H \"Content-Type: application/json\"\ + \ \\\n -d '{\"username\": \"person@metabase.com\", \"password\": \"fakepassword\"\ + }' \\\n http://localhost:3000/api/session\n``` Then copy the value of\ + \ the `id` field returned by a successful call to that API.\nNote that\ + \ by default, sessions are good for 14 days and needs to be regenerated." + airbyte_secret: true + order: 3 + source-bing-ads: + title: "Bing Ads Spec" + type: "object" + required: + - "developer_token" + - "client_id" + - "refresh_token" + - "sourceType" + properties: + auth_method: + type: "string" + const: "oauth2.0" + enum: + - "oauth2.0" + tenant_id: + type: "string" + title: "Tenant ID" + description: "The Tenant ID of your Microsoft Advertising developer application.\ + \ Set this to \"common\" unless you know you need a different value." + airbyte_secret: true + default: "common" + order: 0 + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your Microsoft Advertising developer application." + airbyte_secret: true + order: 1 + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of your Microsoft Advertising developer\ + \ application." + default: "" + airbyte_secret: true + order: 2 + refresh_token: + type: "string" + title: "Refresh Token" + description: "Refresh Token to renew the expired Access Token." + airbyte_secret: true + order: 3 + x-speakeasy-param-sensitive: true + developer_token: + type: "string" + title: "Developer Token" + description: "Developer token associated with user. See more info in the docs." + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + account_names: + title: "Account Names Predicates" + description: "Predicates that will be used to sync data by specific accounts." + type: "array" + order: 5 + items: + description: "Account Names Predicates Config." + type: "object" + properties: + operator: + title: "Operator" + description: "An Operator that will be used to filter accounts. The\ + \ Contains predicate has features for matching words, matching inflectional\ + \ forms of words, searching using wildcard characters, and searching\ + \ using proximity. The Equals is used to return all rows where account\ + \ name is equal(=) to the string that you provided" + type: "string" + enum: + - "Contains" + - "Equals" + name: + title: "Account Name" + description: "Account Name is a string value for comparing with the\ + \ specified predicate." + type: "string" + required: + - "operator" + - "name" + reports_start_date: + type: "string" + title: "Reports replication start date" + format: "date" + description: "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." + order: 6 + lookback_window: + title: "Lookback window" + description: "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." + type: "integer" + default: 0 + minimum: 0 + maximum: 90 + order: 7 + custom_reports: + title: "Custom Reports" + description: "You can add your Custom Bing Ads report by creating one." + order: 8 + type: "array" + items: + title: "Custom Report Config" + type: "object" + properties: + name: + title: "Report Name" + description: "The name of the custom report, this name would be used\ + \ as stream name" + type: "string" + examples: + - "Account Performance" + - "AdDynamicTextPerformanceReport" + - "custom report" + reporting_object: + title: "Reporting Data Object" + description: "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." + type: "string" + enum: + - "AccountPerformanceReportRequest" + - "AdDynamicTextPerformanceReportRequest" + - "AdExtensionByAdReportRequest" + - "AdExtensionByKeywordReportRequest" + - "AdExtensionDetailReportRequest" + - "AdGroupPerformanceReportRequest" + - "AdPerformanceReportRequest" + - "AgeGenderAudienceReportRequest" + - "AudiencePerformanceReportRequest" + - "CallDetailReportRequest" + - "CampaignPerformanceReportRequest" + - "ConversionPerformanceReportRequest" + - "DestinationUrlPerformanceReportRequest" + - "DSAAutoTargetPerformanceReportRequest" + - "DSACategoryPerformanceReportRequest" + - "DSASearchQueryPerformanceReportRequest" + - "GeographicPerformanceReportRequest" + - "GoalsAndFunnelsReportRequest" + - "HotelDimensionPerformanceReportRequest" + - "HotelGroupPerformanceReportRequest" + - "KeywordPerformanceReportRequest" + - "NegativeKeywordConflictReportRequest" + - "ProductDimensionPerformanceReportRequest" + - "ProductMatchCountReportRequest" + - "ProductNegativeKeywordConflictReportRequest" + - "ProductPartitionPerformanceReportRequest" + - "ProductPartitionUnitPerformanceReportRequest" + - "ProductSearchQueryPerformanceReportRequest" + - "ProfessionalDemographicsAudienceReportRequest" + - "PublisherUsagePerformanceReportRequest" + - "SearchCampaignChangeHistoryReportRequest" + - "SearchQueryPerformanceReportRequest" + - "ShareOfVoiceReportRequest" + - "UserLocationPerformanceReportRequest" + report_columns: + title: "Columns" + description: "A list of available report object columns. You can find\ + \ it in description of reporting object that you want to add to\ + \ custom report." + type: "array" + items: + description: "Name of report column." + type: "string" + minItems: 1 + report_aggregation: + title: "Aggregation" + description: "A list of available aggregations." + type: "string" + items: + title: "ValidEnums" + description: "An enumeration of aggregations." + enum: + - "Hourly" + - "Daily" + - "Weekly" + - "Monthly" + - "DayOfWeek" + - "HourOfDay" + - "WeeklyStartingMonday" + - "Summary" + default: + - "Hourly" + required: + - "name" + - "reporting_object" + - "report_columns" + - "report_aggregation" + sourceType: + title: "bing-ads" + const: "bing-ads" + enum: + - "bing-ads" + order: 0 + type: "string" + source-bing-ads-update: + title: "Bing Ads Spec" + type: "object" + required: + - "developer_token" + - "client_id" + - "refresh_token" + properties: + auth_method: + type: "string" + const: "oauth2.0" + enum: + - "oauth2.0" + tenant_id: + type: "string" + title: "Tenant ID" + description: "The Tenant ID of your Microsoft Advertising developer application.\ + \ Set this to \"common\" unless you know you need a different value." + airbyte_secret: true + default: "common" + order: 0 + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your Microsoft Advertising developer application." + airbyte_secret: true + order: 1 + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of your Microsoft Advertising developer\ + \ application." + default: "" + airbyte_secret: true + order: 2 + refresh_token: + type: "string" + title: "Refresh Token" + description: "Refresh Token to renew the expired Access Token." + airbyte_secret: true + order: 3 + developer_token: + type: "string" + title: "Developer Token" + description: "Developer token associated with user. See more info in the docs." + airbyte_secret: true + order: 4 + account_names: + title: "Account Names Predicates" + description: "Predicates that will be used to sync data by specific accounts." + type: "array" + order: 5 + items: + description: "Account Names Predicates Config." + type: "object" + properties: + operator: + title: "Operator" + description: "An Operator that will be used to filter accounts. The\ + \ Contains predicate has features for matching words, matching inflectional\ + \ forms of words, searching using wildcard characters, and searching\ + \ using proximity. The Equals is used to return all rows where account\ + \ name is equal(=) to the string that you provided" + type: "string" + enum: + - "Contains" + - "Equals" + name: + title: "Account Name" + description: "Account Name is a string value for comparing with the\ + \ specified predicate." + type: "string" + required: + - "operator" + - "name" + reports_start_date: + type: "string" + title: "Reports replication start date" + format: "date" + description: "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." + order: 6 + lookback_window: + title: "Lookback window" + description: "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." + type: "integer" + default: 0 + minimum: 0 + maximum: 90 + order: 7 + custom_reports: + title: "Custom Reports" + description: "You can add your Custom Bing Ads report by creating one." + order: 8 + type: "array" + items: + title: "Custom Report Config" + type: "object" + properties: + name: + title: "Report Name" + description: "The name of the custom report, this name would be used\ + \ as stream name" + type: "string" + examples: + - "Account Performance" + - "AdDynamicTextPerformanceReport" + - "custom report" + reporting_object: + title: "Reporting Data Object" + description: "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." + type: "string" + enum: + - "AccountPerformanceReportRequest" + - "AdDynamicTextPerformanceReportRequest" + - "AdExtensionByAdReportRequest" + - "AdExtensionByKeywordReportRequest" + - "AdExtensionDetailReportRequest" + - "AdGroupPerformanceReportRequest" + - "AdPerformanceReportRequest" + - "AgeGenderAudienceReportRequest" + - "AudiencePerformanceReportRequest" + - "CallDetailReportRequest" + - "CampaignPerformanceReportRequest" + - "ConversionPerformanceReportRequest" + - "DestinationUrlPerformanceReportRequest" + - "DSAAutoTargetPerformanceReportRequest" + - "DSACategoryPerformanceReportRequest" + - "DSASearchQueryPerformanceReportRequest" + - "GeographicPerformanceReportRequest" + - "GoalsAndFunnelsReportRequest" + - "HotelDimensionPerformanceReportRequest" + - "HotelGroupPerformanceReportRequest" + - "KeywordPerformanceReportRequest" + - "NegativeKeywordConflictReportRequest" + - "ProductDimensionPerformanceReportRequest" + - "ProductMatchCountReportRequest" + - "ProductNegativeKeywordConflictReportRequest" + - "ProductPartitionPerformanceReportRequest" + - "ProductPartitionUnitPerformanceReportRequest" + - "ProductSearchQueryPerformanceReportRequest" + - "ProfessionalDemographicsAudienceReportRequest" + - "PublisherUsagePerformanceReportRequest" + - "SearchCampaignChangeHistoryReportRequest" + - "SearchQueryPerformanceReportRequest" + - "ShareOfVoiceReportRequest" + - "UserLocationPerformanceReportRequest" + report_columns: + title: "Columns" + description: "A list of available report object columns. You can find\ + \ it in description of reporting object that you want to add to\ + \ custom report." + type: "array" + items: + description: "Name of report column." + type: "string" + minItems: 1 + report_aggregation: + title: "Aggregation" + description: "A list of available aggregations." + type: "string" + items: + title: "ValidEnums" + description: "An enumeration of aggregations." + enum: + - "Hourly" + - "Daily" + - "Weekly" + - "Monthly" + - "DayOfWeek" + - "HourOfDay" + - "WeeklyStartingMonday" + - "Summary" + default: + - "Hourly" + required: + - "name" + - "reporting_object" + - "report_columns" + - "report_aggregation" + source-e2e-test-cloud: + title: "Cloud E2E Test Source Spec" + type: "object" + oneOf: + - title: "Continuous Feed" + type: "object" + required: + - "type" + - "max_messages" + - "mock_catalog" + additionalProperties: true + properties: + type: + type: "string" + const: "CONTINUOUS_FEED" + default: "CONTINUOUS_FEED" + order: 10 + enum: + - "CONTINUOUS_FEED" + max_messages: + title: "Max Records" + description: "Number of records to emit per stream. Min 1. Max 100 billion." + type: "integer" + default: 100 + min: 1 + max: 100000000000 + order: 20 + seed: + title: "Random Seed" + description: "When the seed is unspecified, the current time millis will\ + \ be used as the seed. Range: [0, 1000000]." + type: "integer" + default: 0 + examples: + - 42 + min: 0 + max: 1000000 + order: 30 + message_interval_ms: + title: "Message Interval (ms)" + description: "Interval between messages in ms. Min 0 ms. Max 60000 ms\ + \ (1 minute)." + type: "integer" + min: 0 + max: 60000 + default: 0 + order: 40 + mock_catalog: + title: "Mock Catalog" + type: "object" + order: 50 + oneOf: + - title: "Single Schema" + description: "A catalog with one or multiple streams that share the\ + \ same schema." + type: "object" + required: + - "type" + - "stream_name" + - "stream_schema" + properties: + type: + type: "string" + const: "SINGLE_STREAM" + default: "SINGLE_STREAM" + enum: + - "SINGLE_STREAM" + stream_name: + title: "Stream Name" + description: "Name of the data stream." + type: "string" + default: "data_stream" + stream_schema: + title: "Stream Schema" + description: "A Json schema for the stream. The schema should be\ + \ compatible with draft-07. See this doc for examples." + type: "string" + default: "{ \"type\": \"object\", \"properties\": { \"column1\"\ + : { \"type\": \"string\" } } }" + stream_duplication: + title: "Duplicate the stream N times" + description: "Duplicate the stream for easy load testing. Each stream\ + \ name will have a number suffix. For example, if the stream name\ + \ is \"ds\", the duplicated streams will be \"ds_0\", \"ds_1\"\ + , etc." + type: "integer" + default: 1 + min: 1 + max: 10000 + - title: "Multi Schema" + type: "object" + description: "A catalog with multiple data streams, each with a different\ + \ schema." + required: + - "type" + - "stream_schemas" + properties: + type: + type: "string" + const: "MULTI_STREAM" + default: "MULTI_STREAM" + enum: + - "MULTI_STREAM" + stream_schemas: + title: "Streams and Schemas" + description: "A Json object specifying multiple data streams and\ + \ their schemas. Each key in this object is one stream name. Each\ + \ value is the schema for that stream. The schema should be compatible\ + \ with draft-07. See this doc for examples." + type: "string" + default: "{ \"stream1\": { \"type\": \"object\", \"properties\"\ + : { \"field1\": { \"type\": \"string\" } } }, \"stream2\": { \"\ + type\": \"object\", \"properties\": { \"field1\": { \"type\":\ + \ \"boolean\" } } } }" + sourceType: + title: "e2e-test-cloud" + const: "e2e-test-cloud" + enum: + - "e2e-test-cloud" + order: 0 + type: "string" + source-e2e-test-cloud-update: + title: "Cloud E2E Test Source Spec" + type: "object" + oneOf: + - title: "Continuous Feed" + type: "object" + required: + - "type" + - "max_messages" + - "mock_catalog" + additionalProperties: true + properties: + type: + type: "string" + const: "CONTINUOUS_FEED" + default: "CONTINUOUS_FEED" + order: 10 + enum: + - "CONTINUOUS_FEED" + max_messages: + title: "Max Records" + description: "Number of records to emit per stream. Min 1. Max 100 billion." + type: "integer" + default: 100 + min: 1 + max: 100000000000 + order: 20 + seed: + title: "Random Seed" + description: "When the seed is unspecified, the current time millis will\ + \ be used as the seed. Range: [0, 1000000]." + type: "integer" + default: 0 + examples: + - 42 + min: 0 + max: 1000000 + order: 30 + message_interval_ms: + title: "Message Interval (ms)" + description: "Interval between messages in ms. Min 0 ms. Max 60000 ms\ + \ (1 minute)." + type: "integer" + min: 0 + max: 60000 + default: 0 + order: 40 + mock_catalog: + title: "Mock Catalog" + type: "object" + order: 50 + oneOf: + - title: "Single Schema" + description: "A catalog with one or multiple streams that share the\ + \ same schema." + type: "object" + required: + - "type" + - "stream_name" + - "stream_schema" + properties: + type: + type: "string" + const: "SINGLE_STREAM" + default: "SINGLE_STREAM" + enum: + - "SINGLE_STREAM" + stream_name: + title: "Stream Name" + description: "Name of the data stream." + type: "string" + default: "data_stream" + stream_schema: + title: "Stream Schema" + description: "A Json schema for the stream. The schema should be\ + \ compatible with draft-07. See this doc for examples." + type: "string" + default: "{ \"type\": \"object\", \"properties\": { \"column1\"\ + : { \"type\": \"string\" } } }" + stream_duplication: + title: "Duplicate the stream N times" + description: "Duplicate the stream for easy load testing. Each stream\ + \ name will have a number suffix. For example, if the stream name\ + \ is \"ds\", the duplicated streams will be \"ds_0\", \"ds_1\"\ + , etc." + type: "integer" + default: 1 + min: 1 + max: 10000 + - title: "Multi Schema" + type: "object" + description: "A catalog with multiple data streams, each with a different\ + \ schema." + required: + - "type" + - "stream_schemas" + properties: + type: + type: "string" + const: "MULTI_STREAM" + default: "MULTI_STREAM" + enum: + - "MULTI_STREAM" + stream_schemas: + title: "Streams and Schemas" + description: "A Json object specifying multiple data streams and\ + \ their schemas. Each key in this object is one stream name. Each\ + \ value is the schema for that stream. The schema should be compatible\ + \ with draft-07. See this doc for examples." + type: "string" + default: "{ \"stream1\": { \"type\": \"object\", \"properties\"\ + : { \"field1\": { \"type\": \"string\" } } }, \"stream2\": { \"\ + type\": \"object\", \"properties\": { \"field1\": { \"type\":\ + \ \"boolean\" } } } }" + source-monday: + title: "Monday Spec" + type: "object" + required: + - "sourceType" + properties: + credentials: + title: "Authorization Method" + type: "object" + oneOf: + - type: "object" + title: "OAuth2.0" + required: + - "auth_type" + - "client_id" + - "client_secret" + - "access_token" + properties: + subdomain: + type: "string" + title: "Subdomain/Slug" + description: "Slug/subdomain of the account, or the first part of\ + \ the URL that comes before .monday.com" + default: "" + order: 0 + auth_type: + type: "string" + const: "oauth2.0" + order: 1 + enum: + - "oauth2.0" + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your OAuth application." + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of your OAuth application." + airbyte_secret: true + access_token: + type: "string" + title: "Access Token" + description: "Access Token for making authenticated requests." + airbyte_secret: true + x-speakeasy-param-sensitive: true + - type: "object" + title: "API Token" + required: + - "auth_type" + - "api_token" + properties: + auth_type: + type: "string" + const: "api_token" + order: 0 + enum: + - "api_token" + api_token: + type: "string" + title: "Personal API Token" + description: "API Token for making authenticated requests." + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "monday" + const: "monday" + enum: + - "monday" + order: 0 + type: "string" + source-monday-update: + title: "Monday Spec" + type: "object" + required: [] + properties: + credentials: + title: "Authorization Method" + type: "object" + oneOf: + - type: "object" + title: "OAuth2.0" + required: + - "auth_type" + - "client_id" + - "client_secret" + - "access_token" + properties: + subdomain: + type: "string" + title: "Subdomain/Slug" + description: "Slug/subdomain of the account, or the first part of\ + \ the URL that comes before .monday.com" + default: "" + order: 0 + auth_type: + type: "string" + const: "oauth2.0" + order: 1 + enum: + - "oauth2.0" + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your OAuth application." + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of your OAuth application." + airbyte_secret: true + access_token: + type: "string" + title: "Access Token" + description: "Access Token for making authenticated requests." + airbyte_secret: true + - type: "object" + title: "API Token" + required: + - "auth_type" + - "api_token" + properties: + auth_type: + type: "string" + const: "api_token" + order: 0 + enum: + - "api_token" + api_token: + type: "string" + title: "Personal API Token" + description: "API Token for making authenticated requests." + airbyte_secret: true + source-amplitude: + title: "Amplitude Spec" + type: "object" + required: + - "api_key" + - "secret_key" + - "start_date" + - "sourceType" + properties: + data_region: + type: "string" + title: "Data region" + description: "Amplitude data region server" + enum: + - "Standard Server" + - "EU Residency Server" + default: "Standard Server" + api_key: + type: "string" + title: "API Key" + description: "Amplitude API Key. See the setup guide for more information on how to obtain this key." + airbyte_secret: true + x-speakeasy-param-sensitive: true + secret_key: + type: "string" + title: "Secret Key" + description: "Amplitude Secret Key. See the setup guide for more information on how to obtain this key." + airbyte_secret: true + x-speakeasy-param-sensitive: true + start_date: + type: "string" + format: "date-time" + title: "Replication Start Date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + description: "UTC date and time in the format 2021-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + examples: + - "2021-01-25T00:00:00Z" + request_time_range: + type: "integer" + title: "Request time range" + description: "According to Considerations too big time range in request can cause a timeout\ + \ error. In this case, set shorter time interval in hours." + default: 24 + minimum: 1 + maximum: 8760 + sourceType: + title: "amplitude" + const: "amplitude" + enum: + - "amplitude" + order: 0 + type: "string" + source-amplitude-update: + title: "Amplitude Spec" + type: "object" + required: + - "api_key" + - "secret_key" + - "start_date" + properties: + data_region: + type: "string" + title: "Data region" + description: "Amplitude data region server" + enum: + - "Standard Server" + - "EU Residency Server" + default: "Standard Server" + api_key: + type: "string" + title: "API Key" + description: "Amplitude API Key. See the setup guide for more information on how to obtain this key." + airbyte_secret: true + secret_key: + type: "string" + title: "Secret Key" + description: "Amplitude Secret Key. See the setup guide for more information on how to obtain this key." + airbyte_secret: true + start_date: + type: "string" + format: "date-time" + title: "Replication Start Date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + description: "UTC date and time in the format 2021-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + examples: + - "2021-01-25T00:00:00Z" + request_time_range: + type: "integer" + title: "Request time range" + description: "According to Considerations too big time range in request can cause a timeout\ + \ error. In this case, set shorter time interval in hours." + default: 24 + minimum: 1 + maximum: 8760 + source-google-pagespeed-insights: + title: "Google PageSpeed Insights Spec" + type: "object" + required: + - "urls" + - "strategies" + - "categories" + - "sourceType" + properties: + api_key: + type: "string" + title: "API Key" + description: "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." + airbyte_secret: true + x-speakeasy-param-sensitive: true + urls: + type: "array" + items: + type: "string" + pattern: "^(?:origin:)?(http(s)?:\\/\\/)[\\w.-]+(?:\\.[\\w\\.-]+)+[\\\ + w\\-\\._~:\\/?#\\[\\]@!\\$&'\\(\\)\\*\\+,;=.]+$" + title: "URLs to analyse" + description: "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" + example: "https://example.com" + strategies: + type: "array" + items: + type: "string" + enum: + - "desktop" + - "mobile" + title: "Analyses Strategies" + description: "The analyses strategy to use. Either \"desktop\" or \"mobile\"\ + ." + categories: + type: "array" + items: + type: "string" + enum: + - "accessibility" + - "best-practices" + - "performance" + - "pwa" + - "seo" + title: "Lighthouse Categories" + description: "Defines which Lighthouse category to run. One or many of:\ + \ \"accessibility\", \"best-practices\", \"performance\", \"pwa\", \"\ + seo\"." + sourceType: + title: "google-pagespeed-insights" + const: "google-pagespeed-insights" + enum: + - "google-pagespeed-insights" + order: 0 + type: "string" + source-google-pagespeed-insights-update: + title: "Google PageSpeed Insights Spec" + type: "object" + required: + - "urls" + - "strategies" + - "categories" + properties: + api_key: + type: "string" + title: "API Key" + description: "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." + airbyte_secret: true + urls: + type: "array" + items: + type: "string" + pattern: "^(?:origin:)?(http(s)?:\\/\\/)[\\w.-]+(?:\\.[\\w\\.-]+)+[\\\ + w\\-\\._~:\\/?#\\[\\]@!\\$&'\\(\\)\\*\\+,;=.]+$" + title: "URLs to analyse" + description: "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" + example: "https://example.com" + strategies: + type: "array" + items: + type: "string" + enum: + - "desktop" + - "mobile" + title: "Analyses Strategies" + description: "The analyses strategy to use. Either \"desktop\" or \"mobile\"\ + ." + categories: + type: "array" + items: + type: "string" + enum: + - "accessibility" + - "best-practices" + - "performance" + - "pwa" + - "seo" + title: "Lighthouse Categories" + description: "Defines which Lighthouse category to run. One or many of:\ + \ \"accessibility\", \"best-practices\", \"performance\", \"pwa\", \"\ + seo\"." + source-pipedrive: + title: "Pipedrive Spec" + type: "object" + required: + - "replication_start_date" + - "api_token" + - "sourceType" + properties: + api_token: + title: "API Token" + type: "string" + description: "The Pipedrive API Token." + airbyte_secret: true + x-speakeasy-param-sensitive: true + replication_start_date: + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated. When specified and not\ + \ None, then stream will behave as incremental" + examples: + - "2017-01-25 00:00:00Z" + type: "string" + sourceType: + title: "pipedrive" + const: "pipedrive" + enum: + - "pipedrive" + order: 0 + type: "string" + source-pipedrive-update: + title: "Pipedrive Spec" + type: "object" + required: + - "replication_start_date" + - "api_token" + properties: + api_token: + title: "API Token" + type: "string" + description: "The Pipedrive API Token." + airbyte_secret: true + replication_start_date: + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated. When specified and not\ + \ None, then stream will behave as incremental" + examples: + - "2017-01-25 00:00:00Z" + type: "string" + source-amazon-ads: + title: "Amazon Ads Spec" + type: "object" + properties: + auth_type: + title: "Auth Type" + const: "oauth2.0" + order: 0 + type: "string" + enum: + - "oauth2.0" + client_id: + title: "Client ID" + description: "The client ID of your Amazon Ads developer application. See\ + \ the docs for more information." + order: 1 + type: "string" + airbyte_secret: true + client_secret: + title: "Client Secret" + description: "The client secret of your Amazon Ads developer application.\ + \ See the docs for more information." + airbyte_secret: true + order: 2 + type: "string" + refresh_token: + title: "Refresh Token" + description: "Amazon Ads refresh token. See the docs for more information on how to obtain this token." + airbyte_secret: true + order: 3 + type: "string" + x-speakeasy-param-sensitive: true + region: + title: "Region" + description: "Region to pull data from (EU/NA/FE). See docs for more details." + enum: + - "NA" + - "EU" + - "FE" + type: "string" + default: "NA" + order: 4 + start_date: + title: "Start Date" + description: "The Start date for collecting reports, should not be more\ + \ than 60 days in the past. In YYYY-MM-DD format" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + format: "date" + examples: + - "2022-10-10" + - "2022-10-22" + order: 5 + type: "string" + profiles: + title: "Profile IDs" + description: "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." + order: 6 + type: "array" + items: + type: "integer" + marketplace_ids: + title: "Marketplace IDs" + description: "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." + order: 7 + type: "array" + items: + type: "string" + state_filter: + title: "State Filter" + description: "Reflects the state of the Display, Product, and Brand Campaign\ + \ streams as enabled, paused, or archived. If you do not populate this\ + \ field, it will be ignored completely." + items: + type: "string" + enum: + - "enabled" + - "paused" + - "archived" + type: "array" + uniqueItems: true + order: 8 + look_back_window: + title: "Look Back Window" + description: "The amount of days to go back in time to get the updated data\ + \ from Amazon Ads" + examples: + - 3 + - 10 + type: "integer" + default: 3 + order: 9 + report_record_types: + title: "Report Record Types" + description: "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" + items: + type: "string" + enum: + - "adGroups" + - "asins" + - "asins_keywords" + - "asins_targets" + - "campaigns" + - "keywords" + - "productAds" + - "targets" + type: "array" + uniqueItems: true + order: 10 + sourceType: + title: "amazon-ads" + const: "amazon-ads" + enum: + - "amazon-ads" + order: 0 + type: "string" + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "sourceType" + source-amazon-ads-update: + title: "Amazon Ads Spec" + type: "object" + properties: + auth_type: + title: "Auth Type" + const: "oauth2.0" + order: 0 + type: "string" + enum: + - "oauth2.0" + client_id: + title: "Client ID" + description: "The client ID of your Amazon Ads developer application. See\ + \ the docs for more information." + order: 1 + type: "string" + airbyte_secret: true + client_secret: + title: "Client Secret" + description: "The client secret of your Amazon Ads developer application.\ + \ See the docs for more information." + airbyte_secret: true + order: 2 + type: "string" + refresh_token: + title: "Refresh Token" + description: "Amazon Ads refresh token. See the docs for more information on how to obtain this token." + airbyte_secret: true + order: 3 + type: "string" + region: + title: "Region" + description: "Region to pull data from (EU/NA/FE). See docs for more details." + enum: + - "NA" + - "EU" + - "FE" + type: "string" + default: "NA" + order: 4 + start_date: + title: "Start Date" + description: "The Start date for collecting reports, should not be more\ + \ than 60 days in the past. In YYYY-MM-DD format" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + format: "date" + examples: + - "2022-10-10" + - "2022-10-22" + order: 5 + type: "string" + profiles: + title: "Profile IDs" + description: "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." + order: 6 + type: "array" + items: + type: "integer" + marketplace_ids: + title: "Marketplace IDs" + description: "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." + order: 7 + type: "array" + items: + type: "string" + state_filter: + title: "State Filter" + description: "Reflects the state of the Display, Product, and Brand Campaign\ + \ streams as enabled, paused, or archived. If you do not populate this\ + \ field, it will be ignored completely." + items: + type: "string" + enum: + - "enabled" + - "paused" + - "archived" + type: "array" + uniqueItems: true + order: 8 + look_back_window: + title: "Look Back Window" + description: "The amount of days to go back in time to get the updated data\ + \ from Amazon Ads" + examples: + - 3 + - 10 + type: "integer" + default: 3 + order: 9 + report_record_types: + title: "Report Record Types" + description: "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" + items: + type: "string" + enum: + - "adGroups" + - "asins" + - "asins_keywords" + - "asins_targets" + - "campaigns" + - "keywords" + - "productAds" + - "targets" + type: "array" + uniqueItems: true + order: 10 + required: + - "client_id" + - "client_secret" + - "refresh_token" + source-sendinblue: + title: "Sendinblue Spec" + type: "object" + required: + - "api_key" + - "sourceType" + properties: + api_key: + title: "API Key" + type: "string" + description: "Your API Key. See here." + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "sendinblue" + const: "sendinblue" + enum: + - "sendinblue" + order: 0 + type: "string" + source-sendinblue-update: + title: "Sendinblue Spec" + type: "object" + required: + - "api_key" + properties: + api_key: + title: "API Key" + type: "string" + description: "Your API Key. See here." + airbyte_secret: true + source-github: + title: "GitHub Source Spec" + type: "object" + required: + - "credentials" + - "repositories" + - "sourceType" + properties: + credentials: + title: "Authentication" + description: "Choose how to authenticate to GitHub" + type: "object" + order: 0 + group: "auth" + oneOf: + - type: "object" + title: "OAuth" + required: + - "access_token" + properties: + option_title: + type: "string" + const: "OAuth Credentials" + order: 0 + enum: + - "OAuth Credentials" + access_token: + type: "string" + title: "Access Token" + description: "OAuth access token" + airbyte_secret: true + x-speakeasy-param-sensitive: true + client_id: + type: "string" + title: "Client Id" + description: "OAuth Client Id" + airbyte_secret: true + client_secret: + type: "string" + title: "Client ssecret" + description: "OAuth Client secret" + airbyte_secret: true + - type: "object" + title: "Personal Access Token" + required: + - "personal_access_token" + properties: + option_title: + type: "string" + const: "PAT Credentials" + order: 0 + enum: + - "PAT Credentials" + personal_access_token: + type: "string" + title: "Personal Access Tokens" + description: "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\ + \ \",\"" + airbyte_secret: true + x-speakeasy-param-sensitive: true + repository: + type: "string" + examples: + - "airbytehq/airbyte airbytehq/another-repo" + - "airbytehq/*" + - "airbytehq/airbyte" + title: "GitHub Repositories" + description: "(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." + airbyte_hidden: true + pattern: "^([\\w.-]+/(\\*|[\\w.-]+(?docs for more info" + examples: + - "2021-03-01T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + pattern_descriptor: "YYYY-MM-DDTHH:mm:ssZ" + order: 2 + format: "date-time" + api_url: + type: "string" + examples: + - "https://github.com" + - "https://github.company.org" + title: "API URL" + default: "https://api.github.com/" + description: "Please enter your basic URL from self-hosted GitHub instance\ + \ or leave it empty to use GitHub." + order: 3 + branch: + type: "string" + title: "Branch" + examples: + - "airbytehq/airbyte/master airbytehq/airbyte/my-branch" + description: "(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." + airbyte_hidden: true + pattern_descriptor: "org/repo/branch1 org/repo/branch2" + branches: + type: "array" + items: + type: "string" + title: "Branches" + examples: + - "airbytehq/airbyte/master" + - "airbytehq/airbyte/my-branch" + description: "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." + order: 4 + pattern_descriptor: "org/repo/branch1 org/repo/branch2" + sourceType: + title: "github" + const: "github" + enum: + - "github" + order: 0 + type: "string" + source-github-update: + title: "GitHub Source Spec" + type: "object" + required: + - "credentials" + - "repositories" + properties: + credentials: + title: "Authentication" + description: "Choose how to authenticate to GitHub" + type: "object" + order: 0 + group: "auth" + oneOf: + - type: "object" + title: "OAuth" + required: + - "access_token" + properties: + option_title: + type: "string" + const: "OAuth Credentials" + order: 0 + enum: + - "OAuth Credentials" + access_token: + type: "string" + title: "Access Token" + description: "OAuth access token" + airbyte_secret: true + client_id: + type: "string" + title: "Client Id" + description: "OAuth Client Id" + airbyte_secret: true + client_secret: + type: "string" + title: "Client ssecret" + description: "OAuth Client secret" + airbyte_secret: true + - type: "object" + title: "Personal Access Token" + required: + - "personal_access_token" + properties: + option_title: + type: "string" + const: "PAT Credentials" + order: 0 + enum: + - "PAT Credentials" + personal_access_token: + type: "string" + title: "Personal Access Tokens" + description: "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\ + \ \",\"" + airbyte_secret: true + repository: + type: "string" + examples: + - "airbytehq/airbyte airbytehq/another-repo" + - "airbytehq/*" + - "airbytehq/airbyte" + title: "GitHub Repositories" + description: "(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." + airbyte_hidden: true + pattern: "^([\\w.-]+/(\\*|[\\w.-]+(?docs for more info" + examples: + - "2021-03-01T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + pattern_descriptor: "YYYY-MM-DDTHH:mm:ssZ" + order: 2 + format: "date-time" + api_url: + type: "string" + examples: + - "https://github.com" + - "https://github.company.org" + title: "API URL" + default: "https://api.github.com/" + description: "Please enter your basic URL from self-hosted GitHub instance\ + \ or leave it empty to use GitHub." + order: 3 + branch: + type: "string" + title: "Branch" + examples: + - "airbytehq/airbyte/master airbytehq/airbyte/my-branch" + description: "(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." + airbyte_hidden: true + pattern_descriptor: "org/repo/branch1 org/repo/branch2" + branches: + type: "array" + items: + type: "string" + title: "Branches" + examples: + - "airbytehq/airbyte/master" + - "airbytehq/airbyte/my-branch" + description: "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." + order: 4 + pattern_descriptor: "org/repo/branch1 org/repo/branch2" + source-bigquery: + title: "BigQuery Source Spec" + type: "object" + required: + - "project_id" + - "credentials_json" + - "sourceType" + properties: + project_id: + type: "string" + description: "The GCP project ID for the project containing the target BigQuery\ + \ dataset." + title: "Project ID" + dataset_id: + type: "string" + description: "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." + title: "Default Dataset ID" + credentials_json: + type: "string" + description: "The contents of your Service Account Key JSON file. See the\ + \ docs for more information on how to obtain this key." + title: "Credentials JSON" + airbyte_secret: true + sourceType: + title: "bigquery" + const: "bigquery" + enum: + - "bigquery" + order: 0 + type: "string" + source-bigquery-update: + title: "BigQuery Source Spec" + type: "object" + required: + - "project_id" + - "credentials_json" + properties: + project_id: + type: "string" + description: "The GCP project ID for the project containing the target BigQuery\ + \ dataset." + title: "Project ID" + dataset_id: + type: "string" + description: "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." + title: "Default Dataset ID" + credentials_json: + type: "string" + description: "The contents of your Service Account Key JSON file. See the\ + \ docs for more information on how to obtain this key." + title: "Credentials JSON" + airbyte_secret: true + source-vantage: + title: "Vantage Spec" + type: "object" + required: + - "access_token" + - "sourceType" + properties: + access_token: + title: "API Access Token" + type: "string" + description: "Your API Access token. See here." + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "vantage" + const: "vantage" + enum: + - "vantage" + order: 0 + type: "string" + source-vantage-update: + title: "Vantage Spec" + type: "object" + required: + - "access_token" + properties: + access_token: + title: "API Access Token" + type: "string" + description: "Your API Access token. See here." + airbyte_secret: true + source-firebolt: + title: "Firebolt Spec" + type: "object" + required: + - "username" + - "password" + - "database" + - "sourceType" + properties: + username: + type: "string" + title: "Username" + description: "Firebolt email address you use to login." + examples: + - "username@email.com" + password: + type: "string" + title: "Password" + description: "Firebolt password." + airbyte_secret: true + x-speakeasy-param-sensitive: true + account: + type: "string" + title: "Account" + description: "Firebolt account to login." + host: + type: "string" + title: "Host" + description: "The host name of your Firebolt database." + examples: + - "api.app.firebolt.io" + database: + type: "string" + title: "Database" + description: "The database to connect to." + engine: + type: "string" + title: "Engine" + description: "Engine name or url to connect to." + sourceType: + title: "firebolt" + const: "firebolt" + enum: + - "firebolt" + order: 0 + type: "string" + source-firebolt-update: + title: "Firebolt Spec" + type: "object" + required: + - "username" + - "password" + - "database" + properties: + username: + type: "string" + title: "Username" + description: "Firebolt email address you use to login." + examples: + - "username@email.com" + password: + type: "string" + title: "Password" + description: "Firebolt password." + airbyte_secret: true + account: + type: "string" + title: "Account" + description: "Firebolt account to login." + host: + type: "string" + title: "Host" + description: "The host name of your Firebolt database." + examples: + - "api.app.firebolt.io" + database: + type: "string" + title: "Database" + description: "The database to connect to." + engine: + type: "string" + title: "Engine" + description: "Engine name or url to connect to." + source-outreach: + title: "Source Outreach Spec" + type: "object" + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "redirect_uri" + - "start_date" + - "sourceType" + properties: + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your Outreach developer application." + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of your Outreach developer application." + airbyte_secret: true + refresh_token: + type: "string" + title: "Refresh Token" + description: "The token for obtaining the new access token." + airbyte_secret: true + x-speakeasy-param-sensitive: true + redirect_uri: + type: "string" + title: "Redirect URI" + description: "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." + start_date: + type: "string" + title: "Start Date" + description: "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." + examples: + - "2020-11-16T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + sourceType: + title: "outreach" + const: "outreach" + enum: + - "outreach" + order: 0 + type: "string" + source-outreach-update: + title: "Source Outreach Spec" + type: "object" + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "redirect_uri" + - "start_date" + properties: + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your Outreach developer application." + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of your Outreach developer application." + airbyte_secret: true + refresh_token: + type: "string" + title: "Refresh Token" + description: "The token for obtaining the new access token." + airbyte_secret: true + redirect_uri: + type: "string" + title: "Redirect URI" + description: "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." + start_date: + type: "string" + title: "Start Date" + description: "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." + examples: + - "2020-11-16T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + source-pokeapi: + title: "Pokeapi Spec" + type: "object" + required: + - "pokemon_name" + - "sourceType" + properties: + pokemon_name: + type: "string" + title: "Pokemon Name" + description: "Pokemon requested from the API." + pattern: "^[a-z0-9_\\-]+$" + enum: + - "bulbasaur" + - "ivysaur" + - "venusaur" + - "charmander" + - "charmeleon" + - "charizard" + - "squirtle" + - "wartortle" + - "blastoise" + - "caterpie" + - "metapod" + - "butterfree" + - "weedle" + - "kakuna" + - "beedrill" + - "pidgey" + - "pidgeotto" + - "pidgeot" + - "rattata" + - "raticate" + - "spearow" + - "fearow" + - "ekans" + - "arbok" + - "pikachu" + - "raichu" + - "sandshrew" + - "sandslash" + - "nidoranf" + - "nidorina" + - "nidoqueen" + - "nidoranm" + - "nidorino" + - "nidoking" + - "clefairy" + - "clefable" + - "vulpix" + - "ninetales" + - "jigglypuff" + - "wigglytuff" + - "zubat" + - "golbat" + - "oddish" + - "gloom" + - "vileplume" + - "paras" + - "parasect" + - "venonat" + - "venomoth" + - "diglett" + - "dugtrio" + - "meowth" + - "persian" + - "psyduck" + - "golduck" + - "mankey" + - "primeape" + - "growlithe" + - "arcanine" + - "poliwag" + - "poliwhirl" + - "poliwrath" + - "abra" + - "kadabra" + - "alakazam" + - "machop" + - "machoke" + - "machamp" + - "bellsprout" + - "weepinbell" + - "victreebel" + - "tentacool" + - "tentacruel" + - "geodude" + - "graveler" + - "golem" + - "ponyta" + - "rapidash" + - "slowpoke" + - "slowbro" + - "magnemite" + - "magneton" + - "farfetchd" + - "doduo" + - "dodrio" + - "seel" + - "dewgong" + - "grimer" + - "muk" + - "shellder" + - "cloyster" + - "gastly" + - "haunter" + - "gengar" + - "onix" + - "drowzee" + - "hypno" + - "krabby" + - "kingler" + - "voltorb" + - "electrode" + - "exeggcute" + - "exeggutor" + - "cubone" + - "marowak" + - "hitmonlee" + - "hitmonchan" + - "lickitung" + - "koffing" + - "weezing" + - "rhyhorn" + - "rhydon" + - "chansey" + - "tangela" + - "kangaskhan" + - "horsea" + - "seadra" + - "goldeen" + - "seaking" + - "staryu" + - "starmie" + - "mrmime" + - "scyther" + - "jynx" + - "electabuzz" + - "magmar" + - "pinsir" + - "tauros" + - "magikarp" + - "gyarados" + - "lapras" + - "ditto" + - "eevee" + - "vaporeon" + - "jolteon" + - "flareon" + - "porygon" + - "omanyte" + - "omastar" + - "kabuto" + - "kabutops" + - "aerodactyl" + - "snorlax" + - "articuno" + - "zapdos" + - "moltres" + - "dratini" + - "dragonair" + - "dragonite" + - "mewtwo" + - "mew" + - "chikorita" + - "bayleef" + - "meganium" + - "cyndaquil" + - "quilava" + - "typhlosion" + - "totodile" + - "croconaw" + - "feraligatr" + - "sentret" + - "furret" + - "hoothoot" + - "noctowl" + - "ledyba" + - "ledian" + - "spinarak" + - "ariados" + - "crobat" + - "chinchou" + - "lanturn" + - "pichu" + - "cleffa" + - "igglybuff" + - "togepi" + - "togetic" + - "natu" + - "xatu" + - "mareep" + - "flaaffy" + - "ampharos" + - "bellossom" + - "marill" + - "azumarill" + - "sudowoodo" + - "politoed" + - "hoppip" + - "skiploom" + - "jumpluff" + - "aipom" + - "sunkern" + - "sunflora" + - "yanma" + - "wooper" + - "quagsire" + - "espeon" + - "umbreon" + - "murkrow" + - "slowking" + - "misdreavus" + - "unown" + - "wobbuffet" + - "girafarig" + - "pineco" + - "forretress" + - "dunsparce" + - "gligar" + - "steelix" + - "snubbull" + - "granbull" + - "qwilfish" + - "scizor" + - "shuckle" + - "heracross" + - "sneasel" + - "teddiursa" + - "ursaring" + - "slugma" + - "magcargo" + - "swinub" + - "piloswine" + - "corsola" + - "remoraid" + - "octillery" + - "delibird" + - "mantine" + - "skarmory" + - "houndour" + - "houndoom" + - "kingdra" + - "phanpy" + - "donphan" + - "porygon2" + - "stantler" + - "smeargle" + - "tyrogue" + - "hitmontop" + - "smoochum" + - "elekid" + - "magby" + - "miltank" + - "blissey" + - "raikou" + - "entei" + - "suicune" + - "larvitar" + - "pupitar" + - "tyranitar" + - "lugia" + - "ho-oh" + - "celebi" + - "treecko" + - "grovyle" + - "sceptile" + - "torchic" + - "combusken" + - "blaziken" + - "mudkip" + - "marshtomp" + - "swampert" + - "poochyena" + - "mightyena" + - "zigzagoon" + - "linoone" + - "wurmple" + - "silcoon" + - "beautifly" + - "cascoon" + - "dustox" + - "lotad" + - "lombre" + - "ludicolo" + - "seedot" + - "nuzleaf" + - "shiftry" + - "taillow" + - "swellow" + - "wingull" + - "pelipper" + - "ralts" + - "kirlia" + - "gardevoir" + - "surskit" + - "masquerain" + - "shroomish" + - "breloom" + - "slakoth" + - "vigoroth" + - "slaking" + - "nincada" + - "ninjask" + - "shedinja" + - "whismur" + - "loudred" + - "exploud" + - "makuhita" + - "hariyama" + - "azurill" + - "nosepass" + - "skitty" + - "delcatty" + - "sableye" + - "mawile" + - "aron" + - "lairon" + - "aggron" + - "meditite" + - "medicham" + - "electrike" + - "manectric" + - "plusle" + - "minun" + - "volbeat" + - "illumise" + - "roselia" + - "gulpin" + - "swalot" + - "carvanha" + - "sharpedo" + - "wailmer" + - "wailord" + - "numel" + - "camerupt" + - "torkoal" + - "spoink" + - "grumpig" + - "spinda" + - "trapinch" + - "vibrava" + - "flygon" + - "cacnea" + - "cacturne" + - "swablu" + - "altaria" + - "zangoose" + - "seviper" + - "lunatone" + - "solrock" + - "barboach" + - "whiscash" + - "corphish" + - "crawdaunt" + - "baltoy" + - "claydol" + - "lileep" + - "cradily" + - "anorith" + - "armaldo" + - "feebas" + - "milotic" + - "castform" + - "kecleon" + - "shuppet" + - "banette" + - "duskull" + - "dusclops" + - "tropius" + - "chimecho" + - "absol" + - "wynaut" + - "snorunt" + - "glalie" + - "spheal" + - "sealeo" + - "walrein" + - "clamperl" + - "huntail" + - "gorebyss" + - "relicanth" + - "luvdisc" + - "bagon" + - "shelgon" + - "salamence" + - "beldum" + - "metang" + - "metagross" + - "regirock" + - "regice" + - "registeel" + - "latias" + - "latios" + - "kyogre" + - "groudon" + - "rayquaza" + - "jirachi" + - "deoxys" + - "turtwig" + - "grotle" + - "torterra" + - "chimchar" + - "monferno" + - "infernape" + - "piplup" + - "prinplup" + - "empoleon" + - "starly" + - "staravia" + - "staraptor" + - "bidoof" + - "bibarel" + - "kricketot" + - "kricketune" + - "shinx" + - "luxio" + - "luxray" + - "budew" + - "roserade" + - "cranidos" + - "rampardos" + - "shieldon" + - "bastiodon" + - "burmy" + - "wormadam" + - "mothim" + - "combee" + - "vespiquen" + - "pachirisu" + - "buizel" + - "floatzel" + - "cherubi" + - "cherrim" + - "shellos" + - "gastrodon" + - "ambipom" + - "drifloon" + - "drifblim" + - "buneary" + - "lopunny" + - "mismagius" + - "honchkrow" + - "glameow" + - "purugly" + - "chingling" + - "stunky" + - "skuntank" + - "bronzor" + - "bronzong" + - "bonsly" + - "mimejr" + - "happiny" + - "chatot" + - "spiritomb" + - "gible" + - "gabite" + - "garchomp" + - "munchlax" + - "riolu" + - "lucario" + - "hippopotas" + - "hippowdon" + - "skorupi" + - "drapion" + - "croagunk" + - "toxicroak" + - "carnivine" + - "finneon" + - "lumineon" + - "mantyke" + - "snover" + - "abomasnow" + - "weavile" + - "magnezone" + - "lickilicky" + - "rhyperior" + - "tangrowth" + - "electivire" + - "magmortar" + - "togekiss" + - "yanmega" + - "leafeon" + - "glaceon" + - "gliscor" + - "mamoswine" + - "porygon-z" + - "gallade" + - "probopass" + - "dusknoir" + - "froslass" + - "rotom" + - "uxie" + - "mesprit" + - "azelf" + - "dialga" + - "palkia" + - "heatran" + - "regigigas" + - "giratina" + - "cresselia" + - "phione" + - "manaphy" + - "darkrai" + - "shaymin" + - "arceus" + - "victini" + - "snivy" + - "servine" + - "serperior" + - "tepig" + - "pignite" + - "emboar" + - "oshawott" + - "dewott" + - "samurott" + - "patrat" + - "watchog" + - "lillipup" + - "herdier" + - "stoutland" + - "purrloin" + - "liepard" + - "pansage" + - "simisage" + - "pansear" + - "simisear" + - "panpour" + - "simipour" + - "munna" + - "musharna" + - "pidove" + - "tranquill" + - "unfezant" + - "blitzle" + - "zebstrika" + - "roggenrola" + - "boldore" + - "gigalith" + - "woobat" + - "swoobat" + - "drilbur" + - "excadrill" + - "audino" + - "timburr" + - "gurdurr" + - "conkeldurr" + - "tympole" + - "palpitoad" + - "seismitoad" + - "throh" + - "sawk" + - "sewaddle" + - "swadloon" + - "leavanny" + - "venipede" + - "whirlipede" + - "scolipede" + - "cottonee" + - "whimsicott" + - "petilil" + - "lilligant" + - "basculin" + - "sandile" + - "krokorok" + - "krookodile" + - "darumaka" + - "darmanitan" + - "maractus" + - "dwebble" + - "crustle" + - "scraggy" + - "scrafty" + - "sigilyph" + - "yamask" + - "cofagrigus" + - "tirtouga" + - "carracosta" + - "archen" + - "archeops" + - "trubbish" + - "garbodor" + - "zorua" + - "zoroark" + - "minccino" + - "cinccino" + - "gothita" + - "gothorita" + - "gothitelle" + - "solosis" + - "duosion" + - "reuniclus" + - "ducklett" + - "swanna" + - "vanillite" + - "vanillish" + - "vanilluxe" + - "deerling" + - "sawsbuck" + - "emolga" + - "karrablast" + - "escavalier" + - "foongus" + - "amoonguss" + - "frillish" + - "jellicent" + - "alomomola" + - "joltik" + - "galvantula" + - "ferroseed" + - "ferrothorn" + - "klink" + - "klang" + - "klinklang" + - "tynamo" + - "eelektrik" + - "eelektross" + - "elgyem" + - "beheeyem" + - "litwick" + - "lampent" + - "chandelure" + - "axew" + - "fraxure" + - "haxorus" + - "cubchoo" + - "beartic" + - "cryogonal" + - "shelmet" + - "accelgor" + - "stunfisk" + - "mienfoo" + - "mienshao" + - "druddigon" + - "golett" + - "golurk" + - "pawniard" + - "bisharp" + - "bouffalant" + - "rufflet" + - "braviary" + - "vullaby" + - "mandibuzz" + - "heatmor" + - "durant" + - "deino" + - "zweilous" + - "hydreigon" + - "larvesta" + - "volcarona" + - "cobalion" + - "terrakion" + - "virizion" + - "tornadus" + - "thundurus" + - "reshiram" + - "zekrom" + - "landorus" + - "kyurem" + - "keldeo" + - "meloetta" + - "genesect" + - "chespin" + - "quilladin" + - "chesnaught" + - "fennekin" + - "braixen" + - "delphox" + - "froakie" + - "frogadier" + - "greninja" + - "bunnelby" + - "diggersby" + - "fletchling" + - "fletchinder" + - "talonflame" + - "scatterbug" + - "spewpa" + - "vivillon" + - "litleo" + - "pyroar" + - "flabebe" + - "floette" + - "florges" + - "skiddo" + - "gogoat" + - "pancham" + - "pangoro" + - "furfrou" + - "espurr" + - "meowstic" + - "honedge" + - "doublade" + - "aegislash" + - "spritzee" + - "aromatisse" + - "swirlix" + - "slurpuff" + - "inkay" + - "malamar" + - "binacle" + - "barbaracle" + - "skrelp" + - "dragalge" + - "clauncher" + - "clawitzer" + - "helioptile" + - "heliolisk" + - "tyrunt" + - "tyrantrum" + - "amaura" + - "aurorus" + - "sylveon" + - "hawlucha" + - "dedenne" + - "carbink" + - "goomy" + - "sliggoo" + - "goodra" + - "klefki" + - "phantump" + - "trevenant" + - "pumpkaboo" + - "gourgeist" + - "bergmite" + - "avalugg" + - "noibat" + - "noivern" + - "xerneas" + - "yveltal" + - "zygarde" + - "diancie" + - "hoopa" + - "volcanion" + - "rowlet" + - "dartrix" + - "decidueye" + - "litten" + - "torracat" + - "incineroar" + - "popplio" + - "brionne" + - "primarina" + - "pikipek" + - "trumbeak" + - "toucannon" + - "yungoos" + - "gumshoos" + - "grubbin" + - "charjabug" + - "vikavolt" + - "crabrawler" + - "crabominable" + - "oricorio" + - "cutiefly" + - "ribombee" + - "rockruff" + - "lycanroc" + - "wishiwashi" + - "mareanie" + - "toxapex" + - "mudbray" + - "mudsdale" + - "dewpider" + - "araquanid" + - "fomantis" + - "lurantis" + - "morelull" + - "shiinotic" + - "salandit" + - "salazzle" + - "stufful" + - "bewear" + - "bounsweet" + - "steenee" + - "tsareena" + - "comfey" + - "oranguru" + - "passimian" + - "wimpod" + - "golisopod" + - "sandygast" + - "palossand" + - "pyukumuku" + - "typenull" + - "silvally" + - "minior" + - "komala" + - "turtonator" + - "togedemaru" + - "mimikyu" + - "bruxish" + - "drampa" + - "dhelmise" + - "jangmo-o" + - "hakamo-o" + - "kommo-o" + - "tapukoko" + - "tapulele" + - "tapubulu" + - "tapufini" + - "cosmog" + - "cosmoem" + - "solgaleo" + - "lunala" + - "nihilego" + - "buzzwole" + - "pheromosa" + - "xurkitree" + - "celesteela" + - "kartana" + - "guzzlord" + - "necrozma" + - "magearna" + - "marshadow" + - "poipole" + - "naganadel" + - "stakataka" + - "blacephalon" + - "zeraora" + - "meltan" + - "melmetal" + - "grookey" + - "thwackey" + - "rillaboom" + - "scorbunny" + - "raboot" + - "cinderace" + - "sobble" + - "drizzile" + - "inteleon" + - "skwovet" + - "greedent" + - "rookidee" + - "corvisquire" + - "corviknight" + - "blipbug" + - "dottler" + - "orbeetle" + - "nickit" + - "thievul" + - "gossifleur" + - "eldegoss" + - "wooloo" + - "dubwool" + - "chewtle" + - "drednaw" + - "yamper" + - "boltund" + - "rolycoly" + - "carkol" + - "coalossal" + - "applin" + - "flapple" + - "appletun" + - "silicobra" + - "sandaconda" + - "cramorant" + - "arrokuda" + - "barraskewda" + - "toxel" + - "toxtricity" + - "sizzlipede" + - "centiskorch" + - "clobbopus" + - "grapploct" + - "sinistea" + - "polteageist" + - "hatenna" + - "hattrem" + - "hatterene" + - "impidimp" + - "morgrem" + - "grimmsnarl" + - "obstagoon" + - "perrserker" + - "cursola" + - "sirfetchd" + - "mrrime" + - "runerigus" + - "milcery" + - "alcremie" + - "falinks" + - "pincurchin" + - "snom" + - "frosmoth" + - "stonjourner" + - "eiscue" + - "indeedee" + - "morpeko" + - "cufant" + - "copperajah" + - "dracozolt" + - "arctozolt" + - "dracovish" + - "arctovish" + - "duraludon" + - "dreepy" + - "drakloak" + - "dragapult" + - "zacian" + - "zamazenta" + - "eternatus" + - "kubfu" + - "urshifu" + - "zarude" + - "regieleki" + - "regidrago" + - "glastrier" + - "spectrier" + - "calyrex" + examples: + - "ditto" + - "luxray" + - "snorlax" + sourceType: + title: "pokeapi" + const: "pokeapi" + enum: + - "pokeapi" + order: 0 + type: "string" + source-pokeapi-update: + title: "Pokeapi Spec" + type: "object" + required: + - "pokemon_name" + properties: + pokemon_name: + type: "string" + title: "Pokemon Name" + description: "Pokemon requested from the API." + pattern: "^[a-z0-9_\\-]+$" + enum: + - "bulbasaur" + - "ivysaur" + - "venusaur" + - "charmander" + - "charmeleon" + - "charizard" + - "squirtle" + - "wartortle" + - "blastoise" + - "caterpie" + - "metapod" + - "butterfree" + - "weedle" + - "kakuna" + - "beedrill" + - "pidgey" + - "pidgeotto" + - "pidgeot" + - "rattata" + - "raticate" + - "spearow" + - "fearow" + - "ekans" + - "arbok" + - "pikachu" + - "raichu" + - "sandshrew" + - "sandslash" + - "nidoranf" + - "nidorina" + - "nidoqueen" + - "nidoranm" + - "nidorino" + - "nidoking" + - "clefairy" + - "clefable" + - "vulpix" + - "ninetales" + - "jigglypuff" + - "wigglytuff" + - "zubat" + - "golbat" + - "oddish" + - "gloom" + - "vileplume" + - "paras" + - "parasect" + - "venonat" + - "venomoth" + - "diglett" + - "dugtrio" + - "meowth" + - "persian" + - "psyduck" + - "golduck" + - "mankey" + - "primeape" + - "growlithe" + - "arcanine" + - "poliwag" + - "poliwhirl" + - "poliwrath" + - "abra" + - "kadabra" + - "alakazam" + - "machop" + - "machoke" + - "machamp" + - "bellsprout" + - "weepinbell" + - "victreebel" + - "tentacool" + - "tentacruel" + - "geodude" + - "graveler" + - "golem" + - "ponyta" + - "rapidash" + - "slowpoke" + - "slowbro" + - "magnemite" + - "magneton" + - "farfetchd" + - "doduo" + - "dodrio" + - "seel" + - "dewgong" + - "grimer" + - "muk" + - "shellder" + - "cloyster" + - "gastly" + - "haunter" + - "gengar" + - "onix" + - "drowzee" + - "hypno" + - "krabby" + - "kingler" + - "voltorb" + - "electrode" + - "exeggcute" + - "exeggutor" + - "cubone" + - "marowak" + - "hitmonlee" + - "hitmonchan" + - "lickitung" + - "koffing" + - "weezing" + - "rhyhorn" + - "rhydon" + - "chansey" + - "tangela" + - "kangaskhan" + - "horsea" + - "seadra" + - "goldeen" + - "seaking" + - "staryu" + - "starmie" + - "mrmime" + - "scyther" + - "jynx" + - "electabuzz" + - "magmar" + - "pinsir" + - "tauros" + - "magikarp" + - "gyarados" + - "lapras" + - "ditto" + - "eevee" + - "vaporeon" + - "jolteon" + - "flareon" + - "porygon" + - "omanyte" + - "omastar" + - "kabuto" + - "kabutops" + - "aerodactyl" + - "snorlax" + - "articuno" + - "zapdos" + - "moltres" + - "dratini" + - "dragonair" + - "dragonite" + - "mewtwo" + - "mew" + - "chikorita" + - "bayleef" + - "meganium" + - "cyndaquil" + - "quilava" + - "typhlosion" + - "totodile" + - "croconaw" + - "feraligatr" + - "sentret" + - "furret" + - "hoothoot" + - "noctowl" + - "ledyba" + - "ledian" + - "spinarak" + - "ariados" + - "crobat" + - "chinchou" + - "lanturn" + - "pichu" + - "cleffa" + - "igglybuff" + - "togepi" + - "togetic" + - "natu" + - "xatu" + - "mareep" + - "flaaffy" + - "ampharos" + - "bellossom" + - "marill" + - "azumarill" + - "sudowoodo" + - "politoed" + - "hoppip" + - "skiploom" + - "jumpluff" + - "aipom" + - "sunkern" + - "sunflora" + - "yanma" + - "wooper" + - "quagsire" + - "espeon" + - "umbreon" + - "murkrow" + - "slowking" + - "misdreavus" + - "unown" + - "wobbuffet" + - "girafarig" + - "pineco" + - "forretress" + - "dunsparce" + - "gligar" + - "steelix" + - "snubbull" + - "granbull" + - "qwilfish" + - "scizor" + - "shuckle" + - "heracross" + - "sneasel" + - "teddiursa" + - "ursaring" + - "slugma" + - "magcargo" + - "swinub" + - "piloswine" + - "corsola" + - "remoraid" + - "octillery" + - "delibird" + - "mantine" + - "skarmory" + - "houndour" + - "houndoom" + - "kingdra" + - "phanpy" + - "donphan" + - "porygon2" + - "stantler" + - "smeargle" + - "tyrogue" + - "hitmontop" + - "smoochum" + - "elekid" + - "magby" + - "miltank" + - "blissey" + - "raikou" + - "entei" + - "suicune" + - "larvitar" + - "pupitar" + - "tyranitar" + - "lugia" + - "ho-oh" + - "celebi" + - "treecko" + - "grovyle" + - "sceptile" + - "torchic" + - "combusken" + - "blaziken" + - "mudkip" + - "marshtomp" + - "swampert" + - "poochyena" + - "mightyena" + - "zigzagoon" + - "linoone" + - "wurmple" + - "silcoon" + - "beautifly" + - "cascoon" + - "dustox" + - "lotad" + - "lombre" + - "ludicolo" + - "seedot" + - "nuzleaf" + - "shiftry" + - "taillow" + - "swellow" + - "wingull" + - "pelipper" + - "ralts" + - "kirlia" + - "gardevoir" + - "surskit" + - "masquerain" + - "shroomish" + - "breloom" + - "slakoth" + - "vigoroth" + - "slaking" + - "nincada" + - "ninjask" + - "shedinja" + - "whismur" + - "loudred" + - "exploud" + - "makuhita" + - "hariyama" + - "azurill" + - "nosepass" + - "skitty" + - "delcatty" + - "sableye" + - "mawile" + - "aron" + - "lairon" + - "aggron" + - "meditite" + - "medicham" + - "electrike" + - "manectric" + - "plusle" + - "minun" + - "volbeat" + - "illumise" + - "roselia" + - "gulpin" + - "swalot" + - "carvanha" + - "sharpedo" + - "wailmer" + - "wailord" + - "numel" + - "camerupt" + - "torkoal" + - "spoink" + - "grumpig" + - "spinda" + - "trapinch" + - "vibrava" + - "flygon" + - "cacnea" + - "cacturne" + - "swablu" + - "altaria" + - "zangoose" + - "seviper" + - "lunatone" + - "solrock" + - "barboach" + - "whiscash" + - "corphish" + - "crawdaunt" + - "baltoy" + - "claydol" + - "lileep" + - "cradily" + - "anorith" + - "armaldo" + - "feebas" + - "milotic" + - "castform" + - "kecleon" + - "shuppet" + - "banette" + - "duskull" + - "dusclops" + - "tropius" + - "chimecho" + - "absol" + - "wynaut" + - "snorunt" + - "glalie" + - "spheal" + - "sealeo" + - "walrein" + - "clamperl" + - "huntail" + - "gorebyss" + - "relicanth" + - "luvdisc" + - "bagon" + - "shelgon" + - "salamence" + - "beldum" + - "metang" + - "metagross" + - "regirock" + - "regice" + - "registeel" + - "latias" + - "latios" + - "kyogre" + - "groudon" + - "rayquaza" + - "jirachi" + - "deoxys" + - "turtwig" + - "grotle" + - "torterra" + - "chimchar" + - "monferno" + - "infernape" + - "piplup" + - "prinplup" + - "empoleon" + - "starly" + - "staravia" + - "staraptor" + - "bidoof" + - "bibarel" + - "kricketot" + - "kricketune" + - "shinx" + - "luxio" + - "luxray" + - "budew" + - "roserade" + - "cranidos" + - "rampardos" + - "shieldon" + - "bastiodon" + - "burmy" + - "wormadam" + - "mothim" + - "combee" + - "vespiquen" + - "pachirisu" + - "buizel" + - "floatzel" + - "cherubi" + - "cherrim" + - "shellos" + - "gastrodon" + - "ambipom" + - "drifloon" + - "drifblim" + - "buneary" + - "lopunny" + - "mismagius" + - "honchkrow" + - "glameow" + - "purugly" + - "chingling" + - "stunky" + - "skuntank" + - "bronzor" + - "bronzong" + - "bonsly" + - "mimejr" + - "happiny" + - "chatot" + - "spiritomb" + - "gible" + - "gabite" + - "garchomp" + - "munchlax" + - "riolu" + - "lucario" + - "hippopotas" + - "hippowdon" + - "skorupi" + - "drapion" + - "croagunk" + - "toxicroak" + - "carnivine" + - "finneon" + - "lumineon" + - "mantyke" + - "snover" + - "abomasnow" + - "weavile" + - "magnezone" + - "lickilicky" + - "rhyperior" + - "tangrowth" + - "electivire" + - "magmortar" + - "togekiss" + - "yanmega" + - "leafeon" + - "glaceon" + - "gliscor" + - "mamoswine" + - "porygon-z" + - "gallade" + - "probopass" + - "dusknoir" + - "froslass" + - "rotom" + - "uxie" + - "mesprit" + - "azelf" + - "dialga" + - "palkia" + - "heatran" + - "regigigas" + - "giratina" + - "cresselia" + - "phione" + - "manaphy" + - "darkrai" + - "shaymin" + - "arceus" + - "victini" + - "snivy" + - "servine" + - "serperior" + - "tepig" + - "pignite" + - "emboar" + - "oshawott" + - "dewott" + - "samurott" + - "patrat" + - "watchog" + - "lillipup" + - "herdier" + - "stoutland" + - "purrloin" + - "liepard" + - "pansage" + - "simisage" + - "pansear" + - "simisear" + - "panpour" + - "simipour" + - "munna" + - "musharna" + - "pidove" + - "tranquill" + - "unfezant" + - "blitzle" + - "zebstrika" + - "roggenrola" + - "boldore" + - "gigalith" + - "woobat" + - "swoobat" + - "drilbur" + - "excadrill" + - "audino" + - "timburr" + - "gurdurr" + - "conkeldurr" + - "tympole" + - "palpitoad" + - "seismitoad" + - "throh" + - "sawk" + - "sewaddle" + - "swadloon" + - "leavanny" + - "venipede" + - "whirlipede" + - "scolipede" + - "cottonee" + - "whimsicott" + - "petilil" + - "lilligant" + - "basculin" + - "sandile" + - "krokorok" + - "krookodile" + - "darumaka" + - "darmanitan" + - "maractus" + - "dwebble" + - "crustle" + - "scraggy" + - "scrafty" + - "sigilyph" + - "yamask" + - "cofagrigus" + - "tirtouga" + - "carracosta" + - "archen" + - "archeops" + - "trubbish" + - "garbodor" + - "zorua" + - "zoroark" + - "minccino" + - "cinccino" + - "gothita" + - "gothorita" + - "gothitelle" + - "solosis" + - "duosion" + - "reuniclus" + - "ducklett" + - "swanna" + - "vanillite" + - "vanillish" + - "vanilluxe" + - "deerling" + - "sawsbuck" + - "emolga" + - "karrablast" + - "escavalier" + - "foongus" + - "amoonguss" + - "frillish" + - "jellicent" + - "alomomola" + - "joltik" + - "galvantula" + - "ferroseed" + - "ferrothorn" + - "klink" + - "klang" + - "klinklang" + - "tynamo" + - "eelektrik" + - "eelektross" + - "elgyem" + - "beheeyem" + - "litwick" + - "lampent" + - "chandelure" + - "axew" + - "fraxure" + - "haxorus" + - "cubchoo" + - "beartic" + - "cryogonal" + - "shelmet" + - "accelgor" + - "stunfisk" + - "mienfoo" + - "mienshao" + - "druddigon" + - "golett" + - "golurk" + - "pawniard" + - "bisharp" + - "bouffalant" + - "rufflet" + - "braviary" + - "vullaby" + - "mandibuzz" + - "heatmor" + - "durant" + - "deino" + - "zweilous" + - "hydreigon" + - "larvesta" + - "volcarona" + - "cobalion" + - "terrakion" + - "virizion" + - "tornadus" + - "thundurus" + - "reshiram" + - "zekrom" + - "landorus" + - "kyurem" + - "keldeo" + - "meloetta" + - "genesect" + - "chespin" + - "quilladin" + - "chesnaught" + - "fennekin" + - "braixen" + - "delphox" + - "froakie" + - "frogadier" + - "greninja" + - "bunnelby" + - "diggersby" + - "fletchling" + - "fletchinder" + - "talonflame" + - "scatterbug" + - "spewpa" + - "vivillon" + - "litleo" + - "pyroar" + - "flabebe" + - "floette" + - "florges" + - "skiddo" + - "gogoat" + - "pancham" + - "pangoro" + - "furfrou" + - "espurr" + - "meowstic" + - "honedge" + - "doublade" + - "aegislash" + - "spritzee" + - "aromatisse" + - "swirlix" + - "slurpuff" + - "inkay" + - "malamar" + - "binacle" + - "barbaracle" + - "skrelp" + - "dragalge" + - "clauncher" + - "clawitzer" + - "helioptile" + - "heliolisk" + - "tyrunt" + - "tyrantrum" + - "amaura" + - "aurorus" + - "sylveon" + - "hawlucha" + - "dedenne" + - "carbink" + - "goomy" + - "sliggoo" + - "goodra" + - "klefki" + - "phantump" + - "trevenant" + - "pumpkaboo" + - "gourgeist" + - "bergmite" + - "avalugg" + - "noibat" + - "noivern" + - "xerneas" + - "yveltal" + - "zygarde" + - "diancie" + - "hoopa" + - "volcanion" + - "rowlet" + - "dartrix" + - "decidueye" + - "litten" + - "torracat" + - "incineroar" + - "popplio" + - "brionne" + - "primarina" + - "pikipek" + - "trumbeak" + - "toucannon" + - "yungoos" + - "gumshoos" + - "grubbin" + - "charjabug" + - "vikavolt" + - "crabrawler" + - "crabominable" + - "oricorio" + - "cutiefly" + - "ribombee" + - "rockruff" + - "lycanroc" + - "wishiwashi" + - "mareanie" + - "toxapex" + - "mudbray" + - "mudsdale" + - "dewpider" + - "araquanid" + - "fomantis" + - "lurantis" + - "morelull" + - "shiinotic" + - "salandit" + - "salazzle" + - "stufful" + - "bewear" + - "bounsweet" + - "steenee" + - "tsareena" + - "comfey" + - "oranguru" + - "passimian" + - "wimpod" + - "golisopod" + - "sandygast" + - "palossand" + - "pyukumuku" + - "typenull" + - "silvally" + - "minior" + - "komala" + - "turtonator" + - "togedemaru" + - "mimikyu" + - "bruxish" + - "drampa" + - "dhelmise" + - "jangmo-o" + - "hakamo-o" + - "kommo-o" + - "tapukoko" + - "tapulele" + - "tapubulu" + - "tapufini" + - "cosmog" + - "cosmoem" + - "solgaleo" + - "lunala" + - "nihilego" + - "buzzwole" + - "pheromosa" + - "xurkitree" + - "celesteela" + - "kartana" + - "guzzlord" + - "necrozma" + - "magearna" + - "marshadow" + - "poipole" + - "naganadel" + - "stakataka" + - "blacephalon" + - "zeraora" + - "meltan" + - "melmetal" + - "grookey" + - "thwackey" + - "rillaboom" + - "scorbunny" + - "raboot" + - "cinderace" + - "sobble" + - "drizzile" + - "inteleon" + - "skwovet" + - "greedent" + - "rookidee" + - "corvisquire" + - "corviknight" + - "blipbug" + - "dottler" + - "orbeetle" + - "nickit" + - "thievul" + - "gossifleur" + - "eldegoss" + - "wooloo" + - "dubwool" + - "chewtle" + - "drednaw" + - "yamper" + - "boltund" + - "rolycoly" + - "carkol" + - "coalossal" + - "applin" + - "flapple" + - "appletun" + - "silicobra" + - "sandaconda" + - "cramorant" + - "arrokuda" + - "barraskewda" + - "toxel" + - "toxtricity" + - "sizzlipede" + - "centiskorch" + - "clobbopus" + - "grapploct" + - "sinistea" + - "polteageist" + - "hatenna" + - "hattrem" + - "hatterene" + - "impidimp" + - "morgrem" + - "grimmsnarl" + - "obstagoon" + - "perrserker" + - "cursola" + - "sirfetchd" + - "mrrime" + - "runerigus" + - "milcery" + - "alcremie" + - "falinks" + - "pincurchin" + - "snom" + - "frosmoth" + - "stonjourner" + - "eiscue" + - "indeedee" + - "morpeko" + - "cufant" + - "copperajah" + - "dracozolt" + - "arctozolt" + - "dracovish" + - "arctovish" + - "duraludon" + - "dreepy" + - "drakloak" + - "dragapult" + - "zacian" + - "zamazenta" + - "eternatus" + - "kubfu" + - "urshifu" + - "zarude" + - "regieleki" + - "regidrago" + - "glastrier" + - "spectrier" + - "calyrex" + examples: + - "ditto" + - "luxray" + - "snorlax" + source-senseforce: + title: "Senseforce Source Spec" + type: "object" + required: + - "access_token" + - "backend_url" + - "dataset_id" + - "start_date" + - "sourceType" + properties: + access_token: + type: "string" + title: "API Access Token" + description: "Your API access token. See here. The toke is case sensitive." + airbyte_secret: true + x-speakeasy-param-sensitive: true + backend_url: + type: "string" + title: "Senseforce backend URL" + examples: + - "https://galaxyapi.senseforce.io" + description: "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)" + dataset_id: + type: "string" + title: "Dataset ID" + examples: + - "8f418098-ca28-4df5-9498-0df9fe78eda7" + description: "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: + type: "string" + title: "The first day (in UTC) when to read data from." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + description: "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" + examples: + - "2017-01-25" + format: "date" + slice_range: + type: "integer" + title: "Data request time increment in days" + default: 10 + minimum: 1 + maximum: 365 + examples: + - 1 + - 3 + - 10 + - 30 + - 180 + - 360 + airbyte_hidden: true + description: "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." + sourceType: + title: "senseforce" + const: "senseforce" + enum: + - "senseforce" + order: 0 + type: "string" + source-senseforce-update: + title: "Senseforce Source Spec" + type: "object" + required: + - "access_token" + - "backend_url" + - "dataset_id" + - "start_date" + properties: + access_token: + type: "string" + title: "API Access Token" + description: "Your API access token. See here. The toke is case sensitive." + airbyte_secret: true + backend_url: + type: "string" + title: "Senseforce backend URL" + examples: + - "https://galaxyapi.senseforce.io" + description: "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)" + dataset_id: + type: "string" + title: "Dataset ID" + examples: + - "8f418098-ca28-4df5-9498-0df9fe78eda7" + description: "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: + type: "string" + title: "The first day (in UTC) when to read data from." + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + description: "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" + examples: + - "2017-01-25" + format: "date" + slice_range: + type: "integer" + title: "Data request time increment in days" + default: 10 + minimum: 1 + maximum: 365 + examples: + - 1 + - 3 + - 10 + - 30 + - 180 + - 360 + airbyte_hidden: true + description: "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-freshsales: + type: "object" + title: "Freshsales Spec" + required: + - "domain_name" + - "api_key" + - "sourceType" + properties: + domain_name: + type: "string" + order: 0 + title: "Domain Name" + description: "The Name of your Freshsales domain" + examples: + - "mydomain.myfreshworks.com" + api_key: + type: "string" + order: 1 + title: "API Key" + description: "Freshsales API Key. See here. The key is case sensitive." + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "freshsales" + const: "freshsales" + enum: + - "freshsales" + order: 0 + type: "string" + source-freshsales-update: + type: "object" + title: "Freshsales Spec" + required: + - "domain_name" + - "api_key" + properties: + domain_name: + type: "string" + order: 0 + title: "Domain Name" + description: "The Name of your Freshsales domain" + examples: + - "mydomain.myfreshworks.com" + api_key: + type: "string" + order: 1 + title: "API Key" + description: "Freshsales API Key. See here. The key is case sensitive." + airbyte_secret: true + source-hubplanner: + title: "Hubplanner Spec" + type: "object" + required: + - "api_key" + - "sourceType" + properties: + api_key: + type: "string" + description: "Hubplanner API key. See https://github.com/hubplanner/API#authentication\ + \ for more details." + airbyte_secret: true + x-speakeasy-param-sensitive: true + sourceType: + title: "hubplanner" + const: "hubplanner" + enum: + - "hubplanner" + order: 0 + type: "string" + source-hubplanner-update: + title: "Hubplanner Spec" + type: "object" + required: + - "api_key" + properties: + api_key: + type: "string" + description: "Hubplanner API key. See https://github.com/hubplanner/API#authentication\ + \ for more details." + airbyte_secret: true + source-square: + title: "Square Spec" + type: "object" + required: + - "is_sandbox" + - "sourceType" + properties: + credentials: + title: "Authentication" + description: "Choose how to authenticate to Square." + type: "object" + order: 0 + oneOf: + - title: "Oauth authentication" + type: "object" + required: + - "auth_type" + - "client_id" + - "client_secret" + - "refresh_token" + properties: + auth_type: + type: "string" + const: "OAuth" + order: 0 + enum: + - "OAuth" + client_id: + type: "string" + title: "Client ID" + description: "The Square-issued ID of your application" + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "The Square-issued application secret for your application" + airbyte_secret: true + refresh_token: + title: "Refresh Token" + type: "string" + description: "A refresh token generated using the above client ID\ + \ and secret" + airbyte_secret: true + x-speakeasy-param-sensitive: true + - title: "API key" + type: "object" + required: + - "auth_type" + - "api_key" + properties: + auth_type: + type: "string" + const: "API Key" + order: 1 + enum: + - "API Key" + api_key: + type: "string" + title: "API key token" + description: "The API key for a Square application" + airbyte_secret: true + x-speakeasy-param-sensitive: true + is_sandbox: + type: "boolean" + description: "Determines whether to use the sandbox or production environment." + title: "Sandbox" + default: false + order: 1 + start_date: + type: "string" + description: "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." + title: "Start Date" + default: "2021-01-01" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + order: 2 + format: "date" + include_deleted_objects: + type: "boolean" + description: "In some streams there is an option to include deleted objects\ + \ (Items, Categories, Discounts, Taxes)" + title: "Include Deleted Objects" + default: false + order: 3 + sourceType: + title: "square" + const: "square" + enum: + - "square" + order: 0 + type: "string" + source-square-update: + title: "Square Spec" + type: "object" + required: + - "is_sandbox" + properties: + credentials: + title: "Authentication" + description: "Choose how to authenticate to Square." + type: "object" + order: 0 + oneOf: + - title: "Oauth authentication" + type: "object" + required: + - "auth_type" + - "client_id" + - "client_secret" + - "refresh_token" + properties: + auth_type: + type: "string" + const: "OAuth" + order: 0 + enum: + - "OAuth" + client_id: + type: "string" + title: "Client ID" + description: "The Square-issued ID of your application" + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "The Square-issued application secret for your application" + airbyte_secret: true + refresh_token: + title: "Refresh Token" + type: "string" + description: "A refresh token generated using the above client ID\ + \ and secret" + airbyte_secret: true + - title: "API key" + type: "object" + required: + - "auth_type" + - "api_key" + properties: + auth_type: + type: "string" + const: "API Key" + order: 1 + enum: + - "API Key" + api_key: + type: "string" + title: "API key token" + description: "The API key for a Square application" + airbyte_secret: true + is_sandbox: + type: "boolean" + description: "Determines whether to use the sandbox or production environment." + title: "Sandbox" + default: false + order: 1 + start_date: + type: "string" + description: "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." + title: "Start Date" + default: "2021-01-01" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + order: 2 + format: "date" + include_deleted_objects: + type: "boolean" + description: "In some streams there is an option to include deleted objects\ + \ (Items, Categories, Discounts, Taxes)" + title: "Include Deleted Objects" + default: false + order: 3 + source-paystack: + title: "Paystack Source Spec" + type: "object" + required: + - "secret_key" + - "start_date" + - "sourceType" + properties: + secret_key: + type: "string" + title: "Secret Key" + pattern: "^(s|r)k_(live|test)_[a-zA-Z0-9]+$" + description: "The Paystack API key (usually starts with 'sk_live_'; find\ + \ yours here)." + airbyte_secret: true + x-speakeasy-param-sensitive: true + start_date: + type: "string" + title: "Start Date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + examples: + - "2017-01-25T00:00:00Z" + format: "date-time" + lookback_window_days: + type: "integer" + title: "Lookback Window (in days)" + default: 0 + minimum: 0 + description: "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." + sourceType: + title: "paystack" + const: "paystack" + enum: + - "paystack" + order: 0 + type: "string" + source-paystack-update: + title: "Paystack Source Spec" + type: "object" + required: + - "secret_key" + - "start_date" + properties: + secret_key: + type: "string" + title: "Secret Key" + pattern: "^(s|r)k_(live|test)_[a-zA-Z0-9]+$" + description: "The Paystack API key (usually starts with 'sk_live_'; find\ + \ yours here)." + airbyte_secret: true + start_date: + type: "string" + title: "Start Date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + examples: + - "2017-01-25T00:00:00Z" + format: "date-time" + lookback_window_days: + type: "integer" + title: "Lookback Window (in days)" + default: 0 + minimum: 0 + description: "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-redshift: + title: "Redshift Source Spec" + type: "object" + required: + - "host" + - "port" + - "database" + - "username" + - "password" + - "sourceType" + properties: + host: + title: "Host" + description: "Host Endpoint of the Redshift Cluster (must include the cluster-id,\ + \ region and end with .redshift.amazonaws.com)." + type: "string" + order: 1 + port: + title: "Port" + description: "Port of the database." + type: "integer" + minimum: 0 + maximum: 65536 + default: 5439 + examples: + - "5439" + order: 2 + database: + title: "Database" + description: "Name of the database." + type: "string" + examples: + - "master" + order: 3 + schemas: + title: "Schemas" + description: "The list of schemas to sync from. Specify one or more explicitly\ + \ or keep empty to process all schemas. Schema names are case sensitive." + type: "array" + items: + type: "string" + minItems: 0 + uniqueItems: true + examples: + - "public" + order: 4 + username: + title: "Username" + description: "Username to use to access the database." + type: "string" + order: 5 + password: + title: "Password" + description: "Password associated with the username." + type: "string" + airbyte_secret: true + order: 6 + x-speakeasy-param-sensitive: true + jdbc_url_params: + title: "JDBC URL Params" + description: "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)." + type: "string" + order: 7 + sourceType: + title: "redshift" + const: "redshift" + enum: + - "redshift" + order: 0 + type: "string" + source-redshift-update: + title: "Redshift Source Spec" + type: "object" + required: + - "host" + - "port" + - "database" + - "username" + - "password" + properties: + host: + title: "Host" + description: "Host Endpoint of the Redshift Cluster (must include the cluster-id,\ + \ region and end with .redshift.amazonaws.com)." + type: "string" + order: 1 + port: + title: "Port" + description: "Port of the database." + type: "integer" + minimum: 0 + maximum: 65536 + default: 5439 + examples: + - "5439" + order: 2 + database: + title: "Database" + description: "Name of the database." + type: "string" + examples: + - "master" + order: 3 + schemas: + title: "Schemas" + description: "The list of schemas to sync from. Specify one or more explicitly\ + \ or keep empty to process all schemas. Schema names are case sensitive." + type: "array" + items: + type: "string" + minItems: 0 + uniqueItems: true + examples: + - "public" + order: 4 + username: + title: "Username" + description: "Username to use to access the database." + type: "string" + order: 5 + password: + title: "Password" + description: "Password associated with the username." + type: "string" + airbyte_secret: true + order: 6 + jdbc_url_params: + title: "JDBC URL Params" + description: "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)." + type: "string" + order: 7 + source-mongodb-internal-poc: + title: "MongoDb Source Spec" + type: "object" + required: + - "database" + - "sourceType" + properties: + connection_string: + title: "Connection String" + type: "string" + description: "The connection string of the database that you want to replicate.." + examples: + - "mongodb+srv://example.mongodb.net" + - "mongodb://example1.host.com:27017,example2.host.com:27017,example3.host.com:27017" + - "mongodb://example.host.com:27017" + order: 1 + user: + title: "User" + type: "string" + description: "The username which is used to access the database." + order: 2 + password: + title: "Password" + type: "string" + description: "The password associated with this username." + airbyte_secret: true + order: 3 + x-speakeasy-param-sensitive: true + auth_source: + title: "Authentication Source" + type: "string" + description: "The authentication source where the user information is stored." + default: "admin" + examples: + - "admin" + order: 4 + replica_set: + title: "Replica Set" + type: "string" + description: "The name of the replica set to be replicated." + order: 5 + sourceType: + title: "mongodb-internal-poc" + const: "mongodb-internal-poc" + enum: + - "mongodb-internal-poc" + order: 0 + type: "string" + source-mongodb-internal-poc-update: + title: "MongoDb Source Spec" + type: "object" + required: + - "database" + properties: + connection_string: + title: "Connection String" + type: "string" + description: "The connection string of the database that you want to replicate.." + examples: + - "mongodb+srv://example.mongodb.net" + - "mongodb://example1.host.com:27017,example2.host.com:27017,example3.host.com:27017" + - "mongodb://example.host.com:27017" + order: 1 + user: + title: "User" + type: "string" + description: "The username which is used to access the database." + order: 2 + password: + title: "Password" + type: "string" + description: "The password associated with this username." + airbyte_secret: true + order: 3 + auth_source: + title: "Authentication Source" + type: "string" + description: "The authentication source where the user information is stored." + default: "admin" + examples: + - "admin" + order: 4 + replica_set: + title: "Replica Set" + type: "string" + description: "The name of the replica set to be replicated." + order: 5 + source-braintree: + title: "Braintree Spec" + type: "object" + properties: + merchant_id: + title: "Merchant ID" + description: "The unique identifier for your entire gateway account. See\ + \ the docs for more information on how to obtain this ID." + name: "Merchant ID" + type: "string" + public_key: + title: "Public Key" + description: "Braintree Public Key. See the docs for more information on how to obtain this key." + name: "Public Key" + type: "string" + x-speakeasy-param-sensitive: true + private_key: + title: "Private Key" + description: "Braintree Private Key. See the docs for more information on how to obtain this key." + name: "Private Key" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + start_date: + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + name: "Start Date" + examples: + - "2020" + - "2020-12-30" + - "2020-11-22 20:20:05" + type: "string" + format: "date-time" + environment: + title: "Environment" + description: "Environment specifies where the data will come from." + name: "Environment" + examples: + - "sandbox" + - "production" + - "qa" + - "development" + enum: + - "Development" + - "Sandbox" + - "Qa" + - "Production" + type: "string" + sourceType: + title: "braintree" + const: "braintree" + enum: + - "braintree" + order: 0 + type: "string" + required: + - "merchant_id" + - "public_key" + - "private_key" + - "environment" + - "sourceType" + source-braintree-update: + title: "Braintree Spec" + type: "object" + properties: + merchant_id: + title: "Merchant ID" + description: "The unique identifier for your entire gateway account. See\ + \ the docs for more information on how to obtain this ID." + name: "Merchant ID" + type: "string" + public_key: + title: "Public Key" + description: "Braintree Public Key. See the docs for more information on how to obtain this key." + name: "Public Key" + type: "string" + private_key: + title: "Private Key" + description: "Braintree Private Key. See the docs for more information on how to obtain this key." + name: "Private Key" + airbyte_secret: true + type: "string" + start_date: + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + name: "Start Date" + examples: + - "2020" + - "2020-12-30" + - "2020-11-22 20:20:05" + type: "string" + format: "date-time" + environment: + title: "Environment" + description: "Environment specifies where the data will come from." + name: "Environment" + examples: + - "sandbox" + - "production" + - "qa" + - "development" + enum: + - "Development" + - "Sandbox" + - "Qa" + - "Production" + type: "string" + required: + - "merchant_id" + - "public_key" + - "private_key" + - "environment" + source-mailchimp: + title: "Mailchimp Spec" + type: "object" + required: + - "sourceType" + properties: + credentials: + type: "object" + title: "Authentication" + oneOf: + - title: "OAuth2.0" + type: "object" + required: + - "auth_type" + - "access_token" + properties: + auth_type: + type: "string" + const: "oauth2.0" + order: 0 + enum: + - "oauth2.0" + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your OAuth application." + airbyte_secret: true + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your OAuth application." + airbyte_secret: true + access_token: + title: "Access Token" + type: "string" + description: "An access token generated using the above client ID\ + \ and secret." + airbyte_secret: true + x-speakeasy-param-sensitive: true + - type: "object" + title: "API Key" + required: + - "auth_type" + - "apikey" + properties: + auth_type: + type: "string" + const: "apikey" + order: 1 + enum: + - "apikey" + apikey: + type: "string" + title: "API Key" + description: "Mailchimp API Key. See the docs for information on how to generate this key." + airbyte_secret: true + x-speakeasy-param-sensitive: true + start_date: + title: "Incremental Sync Start Date" + description: "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." + type: "string" + format: "date-time" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$" + pattern_descriptor: "YYYY-MM-DDTHH:MM:SS.000Z" + examples: + - "2020-01-01T00:00:00.000Z" + data_center: + title: "DataCenter" + description: "Technical fields used to identify datacenter to send request\ + \ to" + type: "string" + airbyte_hidden: true + sourceType: + title: "mailchimp" + const: "mailchimp" + enum: + - "mailchimp" + order: 0 + type: "string" + source-mailchimp-update: + title: "Mailchimp Spec" + type: "object" + required: [] + properties: + credentials: + type: "object" + title: "Authentication" + oneOf: + - title: "OAuth2.0" + type: "object" + required: + - "auth_type" + - "access_token" + properties: + auth_type: + type: "string" + const: "oauth2.0" + order: 0 + enum: + - "oauth2.0" + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your OAuth application." + airbyte_secret: true + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your OAuth application." + airbyte_secret: true + access_token: + title: "Access Token" + type: "string" + description: "An access token generated using the above client ID\ + \ and secret." + airbyte_secret: true + - type: "object" + title: "API Key" + required: + - "auth_type" + - "apikey" + properties: + auth_type: + type: "string" + const: "apikey" + order: 1 + enum: + - "apikey" + apikey: + type: "string" + title: "API Key" + description: "Mailchimp API Key. See the docs for information on how to generate this key." + airbyte_secret: true + start_date: + title: "Incremental Sync Start Date" + description: "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." + type: "string" + format: "date-time" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$" + pattern_descriptor: "YYYY-MM-DDTHH:MM:SS.000Z" + examples: + - "2020-01-01T00:00:00.000Z" + data_center: + title: "DataCenter" + description: "Technical fields used to identify datacenter to send request\ + \ to" + type: "string" + airbyte_hidden: true + source-airtable: + title: "Airtable Source Spec" + type: "object" + properties: + credentials: + title: "Authentication" + type: "object" + oneOf: + - type: "object" + title: "OAuth2.0" + required: + - "client_id" + - "client_secret" + - "refresh_token" + properties: + auth_method: + type: "string" + const: "oauth2.0" + enum: + - "oauth2.0" + client_id: + type: "string" + title: "Client ID" + description: "The client ID of the Airtable developer application." + airbyte_secret: true + client_secret: + type: "string" + title: "Client secret" + description: "The client secret the Airtable developer application." + airbyte_secret: true + access_token: + type: "string" + description: "Access Token for making authenticated requests." + airbyte_secret: true + x-speakeasy-param-sensitive: true + token_expiry_date: + type: "string" + description: "The date-time when the access token should be refreshed." + format: "date-time" + x-speakeasy-param-sensitive: true + refresh_token: + type: "string" + title: "Refresh token" + description: "The key to refresh the expired access token." + airbyte_secret: true + x-speakeasy-param-sensitive: true + - title: "Personal Access Token" + type: "object" + required: + - "api_key" + properties: + auth_method: + type: "string" + const: "api_key" + enum: + - "api_key" + api_key: + type: "string" + description: "The Personal Access Token for the Airtable account.\ + \ See the Support Guide for more information on how to obtain this token." + title: "Personal Access Token" + airbyte_secret: true + examples: + - "key1234567890" + x-speakeasy-param-sensitive: true + sourceType: + title: "airtable" + const: "airtable" + enum: + - "airtable" + order: 0 + type: "string" + source-airtable-update: + title: "Airtable Source Spec" + type: "object" + properties: + credentials: + title: "Authentication" + type: "object" + oneOf: + - type: "object" + title: "OAuth2.0" + required: + - "client_id" + - "client_secret" + - "refresh_token" + properties: + auth_method: + type: "string" + const: "oauth2.0" + enum: + - "oauth2.0" + client_id: + type: "string" + title: "Client ID" + description: "The client ID of the Airtable developer application." + airbyte_secret: true + client_secret: + type: "string" + title: "Client secret" + description: "The client secret the Airtable developer application." + airbyte_secret: true + access_token: + type: "string" + description: "Access Token for making authenticated requests." + airbyte_secret: true + token_expiry_date: + type: "string" + description: "The date-time when the access token should be refreshed." + format: "date-time" + refresh_token: + type: "string" + title: "Refresh token" + description: "The key to refresh the expired access token." + airbyte_secret: true + - title: "Personal Access Token" + type: "object" + required: + - "api_key" + properties: + auth_method: + type: "string" + const: "api_key" + enum: + - "api_key" + api_key: + type: "string" + description: "The Personal Access Token for the Airtable account.\ + \ See the Support Guide for more information on how to obtain this token." + title: "Personal Access Token" + airbyte_secret: true + examples: + - "key1234567890" + source-mssql: + title: "MSSQL Source Spec" + type: "object" + required: + - "host" + - "port" + - "database" + - "username" + - "password" + - "sourceType" + properties: + host: + description: "The hostname of the database." + title: "Host" + type: "string" + order: 0 + port: + description: "The port of the database." + title: "Port" + type: "integer" + minimum: 0 + maximum: 65536 + examples: + - "1433" + order: 1 + database: + description: "The name of the database." + title: "Database" + type: "string" + examples: + - "master" + order: 2 + schemas: + title: "Schemas" + description: "The list of schemas to sync from. Defaults to user. Case sensitive." + type: "array" + items: + type: "string" + minItems: 0 + uniqueItems: true + default: + - "dbo" + order: 3 + username: + description: "The username which is used to access the database." + title: "Username" + type: "string" + order: 4 + password: + description: "The password associated with the username." + title: "Password" + type: "string" + airbyte_secret: true + order: 5 + x-speakeasy-param-sensitive: true + jdbc_url_params: + title: "JDBC URL Params" + description: "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)." + type: "string" + order: 6 + ssl_method: + title: "SSL Method" + type: "object" + description: "The encryption method which is used when communicating with\ + \ the database." + order: 7 + oneOf: + - title: "Unencrypted" + description: "Data transfer will not be encrypted." + required: + - "ssl_method" + properties: + ssl_method: + type: "string" + const: "unencrypted" + enum: + - "unencrypted" + - title: "Encrypted (trust server certificate)" + description: "Use the certificate provided by the server without verification.\ + \ (For testing purposes only!)" + required: + - "ssl_method" + properties: + ssl_method: + type: "string" + const: "encrypted_trust_server_certificate" + enum: + - "encrypted_trust_server_certificate" + - title: "Encrypted (verify certificate)" + description: "Verify and use the certificate provided by the server." + required: + - "ssl_method" + properties: + ssl_method: + type: "string" + const: "encrypted_verify_certificate" + enum: + - "encrypted_verify_certificate" + hostNameInCertificate: + title: "Host Name In Certificate" + type: "string" + description: "Specifies the host name of the server. The value of\ + \ this property must match the subject property of the certificate." + order: 0 + certificate: + title: "Certificate" + type: "string" + description: "certificate of the server, or of the CA that signed\ + \ the server certificate" + order: 1 + airbyte_secret: true + multiline: true + replication_method: + type: "object" + title: "Update Method" + description: "Configures how data is extracted from the database." + default: "CDC" + display_type: "radio" + order: 8 + oneOf: + - title: "Read Changes using Change Data Capture (CDC)" + description: "Recommended - Incrementally reads new inserts, updates,\ + \ and deletes using the SQL Server's change data capture feature. This must be enabled on your database." + required: + - "method" + properties: + method: + type: "string" + const: "CDC" + order: 0 + enum: + - "CDC" + initial_waiting_seconds: + type: "integer" + title: "Initial Waiting Time in Seconds (Advanced)" + description: "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 2400 seconds. Read about\ + \ initial waiting time." + default: 300 + min: 120 + max: 2400 + order: 3 + invalid_cdc_cursor_position_behavior: + type: "string" + title: "Invalid CDC position behavior (Advanced)" + description: "Determines whether Airbyte should fail or re-sync data\ + \ in case of an stale/invalid cursor value into the WAL. If 'Fail\ + \ sync' is chosen, a user will have to manually reset the connection\ + \ before being able to continue syncing data. If 'Re-sync data'\ + \ is chosen, Airbyte will automatically trigger a refresh but could\ + \ lead to higher cloud costs and data loss." + enum: + - "Fail sync" + - "Re-sync data" + default: "Fail sync" + order: 4 + queue_size: + type: "integer" + title: "Size of the queue (Advanced)" + description: "The size of the internal queue. This may interfere with\ + \ memory consumption and efficiency of the connector, please be\ + \ careful." + default: 10000 + order: 5 + min: 1000 + max: 10000 + - title: "Scan Changes with User Defined Cursor" + description: "Incrementally detects new inserts and updates using the\ + \ cursor column chosen when configuring a connection (e.g. created_at,\ + \ updated_at)." + required: + - "method" + properties: + method: + type: "string" + const: "STANDARD" + order: 0 + enum: + - "STANDARD" + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + x-speakeasy-param-sensitive: true + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + sourceType: + title: "mssql" + const: "mssql" + enum: + - "mssql" + order: 0 + type: "string" + source-mssql-update: + title: "MSSQL Source Spec" + type: "object" + required: + - "host" + - "port" + - "database" + - "username" + - "password" + properties: + host: + description: "The hostname of the database." + title: "Host" + type: "string" + order: 0 + port: + description: "The port of the database." + title: "Port" + type: "integer" + minimum: 0 + maximum: 65536 + examples: + - "1433" + order: 1 + database: + description: "The name of the database." + title: "Database" + type: "string" + examples: + - "master" + order: 2 + schemas: + title: "Schemas" + description: "The list of schemas to sync from. Defaults to user. Case sensitive." + type: "array" + items: + type: "string" + minItems: 0 + uniqueItems: true + default: + - "dbo" + order: 3 + username: + description: "The username which is used to access the database." + title: "Username" + type: "string" + order: 4 + password: + description: "The password associated with the username." + title: "Password" + type: "string" + airbyte_secret: true + order: 5 + jdbc_url_params: + title: "JDBC URL Params" + description: "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)." + type: "string" + order: 6 + ssl_method: + title: "SSL Method" + type: "object" + description: "The encryption method which is used when communicating with\ + \ the database." + order: 7 + oneOf: + - title: "Unencrypted" + description: "Data transfer will not be encrypted." + required: + - "ssl_method" + properties: + ssl_method: + type: "string" + const: "unencrypted" + enum: + - "unencrypted" + - title: "Encrypted (trust server certificate)" + description: "Use the certificate provided by the server without verification.\ + \ (For testing purposes only!)" + required: + - "ssl_method" + properties: + ssl_method: + type: "string" + const: "encrypted_trust_server_certificate" + enum: + - "encrypted_trust_server_certificate" + - title: "Encrypted (verify certificate)" + description: "Verify and use the certificate provided by the server." + required: + - "ssl_method" + properties: + ssl_method: + type: "string" + const: "encrypted_verify_certificate" + enum: + - "encrypted_verify_certificate" + hostNameInCertificate: + title: "Host Name In Certificate" + type: "string" + description: "Specifies the host name of the server. The value of\ + \ this property must match the subject property of the certificate." + order: 0 + certificate: + title: "Certificate" + type: "string" + description: "certificate of the server, or of the CA that signed\ + \ the server certificate" + order: 1 + airbyte_secret: true + multiline: true + replication_method: + type: "object" + title: "Update Method" + description: "Configures how data is extracted from the database." + default: "CDC" + display_type: "radio" + order: 8 + oneOf: + - title: "Read Changes using Change Data Capture (CDC)" + description: "Recommended - Incrementally reads new inserts, updates,\ + \ and deletes using the SQL Server's change data capture feature. This must be enabled on your database." + required: + - "method" + properties: + method: + type: "string" + const: "CDC" + order: 0 + enum: + - "CDC" + initial_waiting_seconds: + type: "integer" + title: "Initial Waiting Time in Seconds (Advanced)" + description: "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 2400 seconds. Read about\ + \ initial waiting time." + default: 300 + min: 120 + max: 2400 + order: 3 + invalid_cdc_cursor_position_behavior: + type: "string" + title: "Invalid CDC position behavior (Advanced)" + description: "Determines whether Airbyte should fail or re-sync data\ + \ in case of an stale/invalid cursor value into the WAL. If 'Fail\ + \ sync' is chosen, a user will have to manually reset the connection\ + \ before being able to continue syncing data. If 'Re-sync data'\ + \ is chosen, Airbyte will automatically trigger a refresh but could\ + \ lead to higher cloud costs and data loss." + enum: + - "Fail sync" + - "Re-sync data" + default: "Fail sync" + order: 4 + queue_size: + type: "integer" + title: "Size of the queue (Advanced)" + description: "The size of the internal queue. This may interfere with\ + \ memory consumption and efficiency of the connector, please be\ + \ careful." + default: 10000 + order: 5 + min: 1000 + max: 10000 + - title: "Scan Changes with User Defined Cursor" + description: "Incrementally detects new inserts and updates using the\ + \ cursor column chosen when configuring a connection (e.g. created_at,\ + \ updated_at)." + required: + - "method" + properties: + method: + type: "string" + const: "STANDARD" + order: 0 + enum: + - "STANDARD" + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + source-dynamodb: + title: "Dynamodb Source Spec" + type: "object" + required: + - "access_key_id" + - "secret_access_key" + - "sourceType" + properties: + endpoint: + title: "Dynamodb Endpoint" + type: "string" + default: "" + description: "the URL of the Dynamodb database" + examples: + - "https://{aws_dynamo_db_url}.com" + region: + title: "Dynamodb Region" + type: "string" + default: "" + description: "The region of the Dynamodb database" + enum: + - "" + - "af-south-1" + - "ap-east-1" + - "ap-northeast-1" + - "ap-northeast-2" + - "ap-northeast-3" + - "ap-south-1" + - "ap-south-2" + - "ap-southeast-1" + - "ap-southeast-2" + - "ap-southeast-3" + - "ap-southeast-4" + - "ca-central-1" + - "ca-west-1" + - "cn-north-1" + - "cn-northwest-1" + - "eu-central-1" + - "eu-central-2" + - "eu-north-1" + - "eu-south-1" + - "eu-south-2" + - "eu-west-1" + - "eu-west-2" + - "eu-west-3" + - "il-central-1" + - "me-central-1" + - "me-south-1" + - "sa-east-1" + - "us-east-1" + - "us-east-2" + - "us-gov-east-1" + - "us-gov-west-1" + - "us-west-1" + - "us-west-2" + access_key_id: + title: "Dynamodb Key Id" + type: "string" + description: "The access key id to access Dynamodb. Airbyte requires read\ + \ permissions to the database" + airbyte_secret: true + examples: + - "A012345678910EXAMPLE" + x-speakeasy-param-sensitive: true + secret_access_key: + title: "Dynamodb Access Key" + type: "string" + description: "The corresponding secret to the access key id." + airbyte_secret: true + examples: + - "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY" + x-speakeasy-param-sensitive: true + reserved_attribute_names: + title: "Reserved attribute names" + type: "string" + description: "Comma separated reserved attribute names present in your tables" + airbyte_secret: true + examples: + - "name, field_name, field-name" + sourceType: + title: "dynamodb" + const: "dynamodb" + enum: + - "dynamodb" + order: 0 + type: "string" + source-dynamodb-update: + title: "Dynamodb Source Spec" + type: "object" + required: + - "access_key_id" + - "secret_access_key" + properties: + endpoint: + title: "Dynamodb Endpoint" + type: "string" + default: "" + description: "the URL of the Dynamodb database" + examples: + - "https://{aws_dynamo_db_url}.com" + region: + title: "Dynamodb Region" + type: "string" + default: "" + description: "The region of the Dynamodb database" + enum: + - "" + - "af-south-1" + - "ap-east-1" + - "ap-northeast-1" + - "ap-northeast-2" + - "ap-northeast-3" + - "ap-south-1" + - "ap-south-2" + - "ap-southeast-1" + - "ap-southeast-2" + - "ap-southeast-3" + - "ap-southeast-4" + - "ca-central-1" + - "ca-west-1" + - "cn-north-1" + - "cn-northwest-1" + - "eu-central-1" + - "eu-central-2" + - "eu-north-1" + - "eu-south-1" + - "eu-south-2" + - "eu-west-1" + - "eu-west-2" + - "eu-west-3" + - "il-central-1" + - "me-central-1" + - "me-south-1" + - "sa-east-1" + - "us-east-1" + - "us-east-2" + - "us-gov-east-1" + - "us-gov-west-1" + - "us-west-1" + - "us-west-2" + access_key_id: + title: "Dynamodb Key Id" + type: "string" + description: "The access key id to access Dynamodb. Airbyte requires read\ + \ permissions to the database" + airbyte_secret: true + examples: + - "A012345678910EXAMPLE" + secret_access_key: + title: "Dynamodb Access Key" + type: "string" + description: "The corresponding secret to the access key id." + airbyte_secret: true + examples: + - "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY" + reserved_attribute_names: + title: "Reserved attribute names" + type: "string" + description: "Comma separated reserved attribute names present in your tables" + airbyte_secret: true + examples: + - "name, field_name, field-name" + source-salesforce: + title: "Salesforce Source Spec" + type: "object" + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "sourceType" + properties: + is_sandbox: + title: "Sandbox" + description: "Toggle if you're using a Salesforce Sandbox" + type: "boolean" + default: false + order: 1 + auth_type: + type: "string" + const: "Client" + enum: + - "Client" + client_id: + title: "Client ID" + description: "Enter your Salesforce developer application's Client ID" + type: "string" + order: 2 + client_secret: + title: "Client Secret" + description: "Enter your Salesforce developer application's Client secret" + type: "string" + airbyte_secret: true + order: 3 + refresh_token: + title: "Refresh Token" + description: "Enter your application's Salesforce Refresh Token used for Airbyte to access your Salesforce\ + \ account." + type: "string" + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + start_date: + title: "Start Date" + description: "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." + type: "string" + pattern: "^([0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}Z)?)$" + pattern_descriptor: "YYYY-MM-DD or YYYY-MM-DDTHH:mm:ssZ" + examples: + - "2021-07-25" + - "2021-07-25T00:00:00Z" + format: "date-time" + order: 5 + force_use_bulk_api: + title: "Force to use BULK API" + type: "boolean" + description: "Toggle to use Bulk API (this might cause empty fields for\ + \ some streams)" + default: false + order: 6 + stream_slice_step: + title: "Stream Slice Step for Incremental sync" + type: "string" + description: "The size of the time window (ISO8601 duration) to slice requests." + default: "P30D" + order: 7 + examples: + - "PT12H" + - "P7D" + - "P30D" + - "P1M" + - "P1Y" + streams_criteria: + type: "array" + order: 8 + items: + type: "object" + required: + - "criteria" + - "value" + properties: + criteria: + type: "string" + title: "Search criteria" + enum: + - "starts with" + - "ends with" + - "contains" + - "exacts" + - "starts not with" + - "ends not with" + - "not contains" + - "not exacts" + order: 1 + default: "contains" + value: + type: "string" + title: "Search value" + order: 2 + title: "Filter Salesforce Objects" + description: "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." + sourceType: + title: "salesforce" + const: "salesforce" + enum: + - "salesforce" + order: 0 + type: "string" + source-salesforce-update: + title: "Salesforce Source Spec" + type: "object" + required: + - "client_id" + - "client_secret" + - "refresh_token" + properties: + is_sandbox: + title: "Sandbox" + description: "Toggle if you're using a Salesforce Sandbox" + type: "boolean" + default: false + order: 1 + auth_type: + type: "string" + const: "Client" + enum: + - "Client" + client_id: + title: "Client ID" + description: "Enter your Salesforce developer application's Client ID" + type: "string" + order: 2 + client_secret: + title: "Client Secret" + description: "Enter your Salesforce developer application's Client secret" + type: "string" + airbyte_secret: true + order: 3 + refresh_token: + title: "Refresh Token" + description: "Enter your application's Salesforce Refresh Token used for Airbyte to access your Salesforce\ + \ account." + type: "string" + airbyte_secret: true + order: 4 + start_date: + title: "Start Date" + description: "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." + type: "string" + pattern: "^([0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}Z)?)$" + pattern_descriptor: "YYYY-MM-DD or YYYY-MM-DDTHH:mm:ssZ" + examples: + - "2021-07-25" + - "2021-07-25T00:00:00Z" + format: "date-time" + order: 5 + force_use_bulk_api: + title: "Force to use BULK API" + type: "boolean" + description: "Toggle to use Bulk API (this might cause empty fields for\ + \ some streams)" + default: false + order: 6 + stream_slice_step: + title: "Stream Slice Step for Incremental sync" + type: "string" + description: "The size of the time window (ISO8601 duration) to slice requests." + default: "P30D" + order: 7 + examples: + - "PT12H" + - "P7D" + - "P30D" + - "P1M" + - "P1Y" + streams_criteria: + type: "array" + order: 8 + items: + type: "object" + required: + - "criteria" + - "value" + properties: + criteria: + type: "string" + title: "Search criteria" + enum: + - "starts with" + - "ends with" + - "contains" + - "exacts" + - "starts not with" + - "ends not with" + - "not contains" + - "not exacts" + order: 1 + default: "contains" + value: + type: "string" + title: "Search value" + order: 2 + title: "Filter Salesforce Objects" + description: "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." + source-clickhouse: + title: "ClickHouse Source Spec" + type: "object" + required: + - "host" + - "port" + - "database" + - "username" + - "sourceType" + properties: + host: + description: "The host endpoint of the Clickhouse cluster." + title: "Host" + type: "string" + order: 0 + port: + description: "The port of the database." + title: "Port" + type: "integer" + minimum: 0 + maximum: 65536 + default: 8123 + examples: + - "8123" + order: 1 + database: + description: "The name of the database." + title: "Database" + type: "string" + examples: + - "default" + order: 2 + username: + description: "The username which is used to access the database." + title: "Username" + type: "string" + order: 3 + password: + description: "The password associated with this username." + title: "Password" + type: "string" + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + jdbc_url_params: + description: "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." + title: "JDBC URL Parameters (Advanced)" + type: "string" + order: 5 + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + x-speakeasy-param-sensitive: true + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + sourceType: + title: "clickhouse" + const: "clickhouse" + enum: + - "clickhouse" + order: 0 + type: "string" + source-clickhouse-update: + title: "ClickHouse Source Spec" + type: "object" + required: + - "host" + - "port" + - "database" + - "username" + properties: + host: + description: "The host endpoint of the Clickhouse cluster." + title: "Host" + type: "string" + order: 0 + port: + description: "The port of the database." + title: "Port" + type: "integer" + minimum: 0 + maximum: 65536 + default: 8123 + examples: + - "8123" + order: 1 + database: + description: "The name of the database." + title: "Database" + type: "string" + examples: + - "default" + order: 2 + username: + description: "The username which is used to access the database." + title: "Username" + type: "string" + order: 3 + password: + description: "The password associated with this username." + title: "Password" + type: "string" + airbyte_secret: true + order: 4 + jdbc_url_params: + description: "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." + title: "JDBC URL Parameters (Advanced)" + type: "string" + order: 5 + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + source-postmarkapp: + title: "Postmarkapp Spec" + type: "object" + required: + - "X-Postmark-Server-Token" + - "X-Postmark-Account-Token" + - "sourceType" + properties: + X-Postmark-Server-Token: + title: "X-Postmark-Server-Token" + type: "string" + description: "API Key for server" + airbyte_secret: true + X-Postmark-Account-Token: + title: "X-Postmark-Account-Token" + type: "string" + description: "API Key for account" + airbyte_secret: true + sourceType: + title: "postmarkapp" + const: "postmarkapp" + enum: + - "postmarkapp" + order: 0 + type: "string" + source-postmarkapp-update: + title: "Postmarkapp Spec" + type: "object" + required: + - "X-Postmark-Server-Token" + - "X-Postmark-Account-Token" + properties: + X-Postmark-Server-Token: + title: "X-Postmark-Server-Token" + type: "string" + description: "API Key for server" + airbyte_secret: true + X-Postmark-Account-Token: + title: "X-Postmark-Account-Token" + type: "string" + description: "API Key for account" + airbyte_secret: true + source-faker: + title: "Faker Source Spec" + type: "object" + required: + - "sourceType" + properties: + count: + title: "Count" + description: "How many users should be generated in total. The purchases\ + \ table will be scaled to match, with 10 purchases created per 10 users.\ + \ This setting does not apply to the products stream." + type: "integer" + minimum: 1 + default: 1000 + order: 0 + seed: + title: "Seed" + description: "Manually control the faker random seed to return the same\ + \ values on subsequent runs (leave -1 for random)" + type: "integer" + default: -1 + order: 1 + records_per_slice: + title: "Records Per Stream Slice" + description: "How many fake records will be in each page (stream slice),\ + \ before a state message is emitted?" + type: "integer" + minimum: 1 + default: 1000 + order: 2 + always_updated: + title: "Always Updated" + description: "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." + type: "boolean" + default: true + parallelism: + title: "Parallelism" + description: "How many parallel workers should we use to generate fake data?\ + \ Choose a value equal to the number of CPUs you will allocate to this\ + \ source." + type: "integer" + minimum: 1 + default: 4 + order: 4 + sourceType: + title: "faker" + const: "faker" + enum: + - "faker" + order: 0 + type: "string" + source-faker-update: + title: "Faker Source Spec" + type: "object" + required: [] + properties: + count: + title: "Count" + description: "How many users should be generated in total. The purchases\ + \ table will be scaled to match, with 10 purchases created per 10 users.\ + \ This setting does not apply to the products stream." + type: "integer" + minimum: 1 + default: 1000 + order: 0 + seed: + title: "Seed" + description: "Manually control the faker random seed to return the same\ + \ values on subsequent runs (leave -1 for random)" + type: "integer" + default: -1 + order: 1 + records_per_slice: + title: "Records Per Stream Slice" + description: "How many fake records will be in each page (stream slice),\ + \ before a state message is emitted?" + type: "integer" + minimum: 1 + default: 1000 + order: 2 + always_updated: + title: "Always Updated" + description: "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." + type: "boolean" + default: true + parallelism: + title: "Parallelism" + description: "How many parallel workers should we use to generate fake data?\ + \ Choose a value equal to the number of CPUs you will allocate to this\ + \ source." + type: "integer" + minimum: 1 + default: 4 + order: 4 + source-lever-hiring: + title: "Lever Hiring Source Spec" + type: "object" + required: + - "start_date" + - "sourceType" + properties: + credentials: + order: 3 + title: "Authentication Mechanism" + description: "Choose how to authenticate to Lever Hiring." + type: "object" + oneOf: + - type: "object" + title: "Authenticate via Lever (OAuth)" + required: + - "refresh_token" + properties: + auth_type: + type: "string" + const: "Client" + order: 0 + enum: + - "Client" + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Lever Hiring developer application." + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Lever Hiring developer application." + airbyte_secret: true + refresh_token: + type: "string" + title: "Refresh Token" + description: "The token for obtaining new access token." + airbyte_secret: true + x-speakeasy-param-sensitive: true + - type: "object" + title: "Authenticate via Lever (Api Key)" + required: + - "api_key" + properties: + auth_type: + type: "string" + const: "Api Key" + order: 0 + enum: + - "Api Key" + api_key: + title: "Api key" + type: "string" + description: "The Api Key of your Lever Hiring account." + airbyte_secret: true + order: 1 + x-speakeasy-param-sensitive: true + start_date: + order: 0 + type: "string" + title: "Start Date" + description: "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." + examples: + - "2021-03-01T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + environment: + order: 1 + type: "string" + title: "Environment" + description: "The environment in which you'd like to replicate data for\ + \ Lever. This is used to determine which Lever API endpoint to use." + default: "Sandbox" + enum: + - "Production" + - "Sandbox" + sourceType: + title: "lever-hiring" + const: "lever-hiring" + enum: + - "lever-hiring" + order: 0 + type: "string" + source-lever-hiring-update: + title: "Lever Hiring Source Spec" + type: "object" + required: + - "start_date" + properties: + credentials: + order: 3 + title: "Authentication Mechanism" + description: "Choose how to authenticate to Lever Hiring." + type: "object" + oneOf: + - type: "object" + title: "Authenticate via Lever (OAuth)" + required: + - "refresh_token" + properties: + auth_type: + type: "string" + const: "Client" + order: 0 + enum: + - "Client" + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Lever Hiring developer application." + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Lever Hiring developer application." + airbyte_secret: true + refresh_token: + type: "string" + title: "Refresh Token" + description: "The token for obtaining new access token." + airbyte_secret: true + - type: "object" + title: "Authenticate via Lever (Api Key)" + required: + - "api_key" + properties: + auth_type: + type: "string" + const: "Api Key" + order: 0 + enum: + - "Api Key" + api_key: + title: "Api key" + type: "string" + description: "The Api Key of your Lever Hiring account." + airbyte_secret: true + order: 1 + start_date: + order: 0 + type: "string" + title: "Start Date" + description: "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." + examples: + - "2021-03-01T00:00:00Z" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + environment: + order: 1 + type: "string" + title: "Environment" + description: "The environment in which you'd like to replicate data for\ + \ Lever. This is used to determine which Lever API endpoint to use." + default: "Sandbox" + enum: + - "Production" + - "Sandbox" + source-braze: + title: "Braze Spec" + type: "object" + required: + - "url" + - "api_key" + - "start_date" + - "sourceType" + properties: + url: + type: "string" + title: "URL" + description: "Braze REST API endpoint" + api_key: + type: "string" + title: "Rest API Key" + airbyte_secret: true + description: "Braze REST API key" + x-speakeasy-param-sensitive: true + start_date: + type: "string" + format: "date" + title: "Start date" + description: "Rows after this date will be synced" + sourceType: + title: "braze" + const: "braze" + enum: + - "braze" + order: 0 + type: "string" + source-braze-update: + title: "Braze Spec" + type: "object" + required: + - "url" + - "api_key" + - "start_date" + properties: + url: + type: "string" + title: "URL" + description: "Braze REST API endpoint" + api_key: + type: "string" + title: "Rest API Key" + airbyte_secret: true + description: "Braze REST API key" + start_date: + type: "string" + format: "date" + title: "Start date" + description: "Rows after this date will be synced" + source-sftp: + title: "SFTP Source Spec" + type: "object" + required: + - "user" + - "host" + - "port" + - "sourceType" + properties: + user: + title: "User Name" + description: "The server user" + type: "string" + order: 0 + host: + title: "Host Address" + description: "The server host address" + type: "string" + examples: + - "www.host.com" + - "192.0.2.1" + order: 1 + port: + title: "Port" + description: "The server port" + type: "integer" + default: 22 + examples: + - "22" + order: 2 + credentials: + type: "object" + title: "Authentication" + description: "The server authentication method" + order: 3 + oneOf: + - title: "Password Authentication" + required: + - "auth_method" + - "auth_user_password" + properties: + auth_method: + description: "Connect through password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + auth_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 1 + x-speakeasy-param-sensitive: true + - title: "SSH Key Authentication" + required: + - "auth_method" + - "auth_ssh_key" + properties: + auth_method: + description: "Connect through ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + auth_ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 1 + x-speakeasy-param-sensitive: true + file_types: + title: "File types" + description: "Coma separated file types. Currently only 'csv' and 'json'\ + \ types are supported." + type: "string" + default: "csv,json" + order: 4 + examples: + - "csv,json" + - "csv" + folder_path: + title: "Folder Path" + description: "The directory to search files for sync" + type: "string" + default: "" + examples: + - "/logs/2022" + order: 5 + file_pattern: + title: "File Pattern" + description: "The regular expression to specify files for sync in a chosen\ + \ Folder Path" + type: "string" + default: "" + examples: + - "log-([0-9]{4})([0-9]{2})([0-9]{2}) - This will filter files which `log-yearmmdd`" + order: 6 + sourceType: + title: "sftp" + const: "sftp" + enum: + - "sftp" + order: 0 + type: "string" + source-sftp-update: + title: "SFTP Source Spec" + type: "object" + required: + - "user" + - "host" + - "port" + properties: + user: + title: "User Name" + description: "The server user" + type: "string" + order: 0 + host: + title: "Host Address" + description: "The server host address" + type: "string" + examples: + - "www.host.com" + - "192.0.2.1" + order: 1 + port: + title: "Port" + description: "The server port" + type: "integer" + default: 22 + examples: + - "22" + order: 2 + credentials: + type: "object" + title: "Authentication" + description: "The server authentication method" + order: 3 + oneOf: + - title: "Password Authentication" + required: + - "auth_method" + - "auth_user_password" + properties: + auth_method: + description: "Connect through password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + auth_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 1 + - title: "SSH Key Authentication" + required: + - "auth_method" + - "auth_ssh_key" + properties: + auth_method: + description: "Connect through ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + auth_ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 1 + file_types: + title: "File types" + description: "Coma separated file types. Currently only 'csv' and 'json'\ + \ types are supported." + type: "string" + default: "csv,json" + order: 4 + examples: + - "csv,json" + - "csv" + folder_path: + title: "Folder Path" + description: "The directory to search files for sync" + type: "string" + default: "" + examples: + - "/logs/2022" + order: 5 + file_pattern: + title: "File Pattern" + description: "The regular expression to specify files for sync in a chosen\ + \ Folder Path" + type: "string" + default: "" + examples: + - "log-([0-9]{4})([0-9]{2})([0-9]{2}) - This will filter files which `log-yearmmdd`" + order: 6 + source-google-drive: + title: "Google Drive Source Spec" + description: "Used during spec; allows the developer to configure the cloud\ + \ provider specific options\nthat are needed when users configure a file-based\ + \ source." + type: "object" + properties: + start_date: + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00.000000Z.\ + \ Any file modified before this date will not be replicated." + examples: + - "2021-01-01T00:00:00.000000Z" + format: "date-time" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$" + pattern_descriptor: "YYYY-MM-DDTHH:mm:ss.SSSSSSZ" + order: 1 + type: "string" + streams: + title: "The list of streams to sync" + description: "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." + order: 10 + type: "array" + items: + title: "FileBasedStreamConfig" + type: "object" + properties: + name: + title: "Name" + description: "The name of the stream." + type: "string" + globs: + title: "Globs" + description: "The pattern used to specify which files should be selected\ + \ from the file system. For more information on glob pattern matching\ + \ look here." + default: + - "**" + order: 1 + type: "array" + items: + type: "string" + validation_policy: + title: "Validation Policy" + description: "The name of the validation policy that dictates sync\ + \ behavior when a record does not adhere to the stream schema." + default: "Emit Record" + enum: + - "Emit Record" + - "Skip Record" + - "Wait for Discover" + input_schema: + title: "Input Schema" + description: "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." + type: "string" + primary_key: + title: "Primary Key" + description: "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." + airbyte_hidden: true + type: "string" + x-speakeasy-param-sensitive: true + days_to_sync_if_history_is_full: + title: "Days To Sync If History Is Full" + description: "When the state history of the file store is full, syncs\ + \ will only read files that were last modified in the provided day\ + \ range." + default: 3 + type: "integer" + format: + title: "Format" + description: "The configuration options that are used to alter how\ + \ to read incoming files that deviate from the standard formatting." + type: "object" + oneOf: + - title: "Avro Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "avro" + const: "avro" + type: "string" + enum: + - "avro" + double_as_string: + title: "Convert Double Fields to Strings" + description: "Whether to convert double fields to strings. This\ + \ is recommended if you have decimal numbers with a high degree\ + \ of precision because there can be a loss precision when\ + \ handling floating point numbers." + default: false + type: "boolean" + required: + - "filetype" + - title: "CSV Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "csv" + const: "csv" + type: "string" + enum: + - "csv" + delimiter: + title: "Delimiter" + description: "The character delimiting individual cells in the\ + \ CSV data. This may only be a 1-character string. For tab-delimited\ + \ data enter '\\t'." + default: "," + type: "string" + quote_char: + title: "Quote Character" + description: "The character used for quoting CSV values. To\ + \ disallow quoting, make this field blank." + default: "\"" + type: "string" + escape_char: + title: "Escape Character" + description: "The character used for escaping special characters.\ + \ To disallow escaping, leave this field blank." + type: "string" + encoding: + title: "Encoding" + description: "The character encoding of the CSV data. Leave\ + \ blank to default to UTF8. See list of python encodings for allowable\ + \ options." + default: "utf8" + type: "string" + double_quote: + title: "Double Quote" + description: "Whether two quotes in a quoted CSV value denote\ + \ a single quote in the data." + default: true + type: "boolean" + null_values: + title: "Null Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as null values. For example, if the value 'NA'\ + \ should be interpreted as null, enter 'NA' in this field." + default: [] + type: "array" + items: + type: "string" + uniqueItems: true + strings_can_be_null: + title: "Strings Can Be Null" + description: "Whether strings can be interpreted as null values.\ + \ If true, strings that match the null_values set will be\ + \ interpreted as null. If false, strings that match the null_values\ + \ set will be interpreted as the string itself." + default: true + type: "boolean" + skip_rows_before_header: + title: "Skip Rows Before Header" + description: "The number of rows to skip before the header row.\ + \ For example, if the header row is on the 3rd row, enter\ + \ 2 in this field." + default: 0 + type: "integer" + skip_rows_after_header: + title: "Skip Rows After Header" + description: "The number of rows to skip after the header row." + default: 0 + type: "integer" + header_definition: + title: "CSV Header Definition" + description: "How headers will be defined. `User Provided` assumes\ + \ the CSV does not have a header row and uses the headers\ + \ provided and `Autogenerated` assumes the CSV does not have\ + \ a header row and the CDK will generate headers using for\ + \ `f{i}` where `i` is the index starting from 0. Else, the\ + \ default behavior is to use the header from the CSV file.\ + \ If a user wants to autogenerate or provide column names\ + \ for a CSV having headers, they can skip rows." + default: + header_definition_type: "From CSV" + oneOf: + - title: "From CSV" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "From CSV" + const: "From CSV" + type: "string" + enum: + - "From CSV" + required: + - "header_definition_type" + - title: "Autogenerated" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "Autogenerated" + const: "Autogenerated" + type: "string" + enum: + - "Autogenerated" + required: + - "header_definition_type" + - title: "User Provided" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "User Provided" + const: "User Provided" + type: "string" + enum: + - "User Provided" + column_names: + title: "Column Names" + description: "The column names that will be used while\ + \ emitting the CSV records" + type: "array" + items: + type: "string" + required: + - "column_names" + - "header_definition_type" + type: "object" + true_values: + title: "True Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as true values." + default: + - "y" + - "yes" + - "t" + - "true" + - "on" + - "1" + type: "array" + items: + type: "string" + uniqueItems: true + false_values: + title: "False Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as false values." + default: + - "n" + - "no" + - "f" + - "false" + - "off" + - "0" + type: "array" + items: + type: "string" + uniqueItems: true + required: + - "filetype" + - title: "Jsonl Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "jsonl" + const: "jsonl" + type: "string" + enum: + - "jsonl" + required: + - "filetype" + - title: "Parquet Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "parquet" + const: "parquet" + type: "string" + enum: + - "parquet" + decimal_as_float: + title: "Convert Decimal Fields to Floats" + description: "Whether to convert decimal fields to floats. There\ + \ is a loss of precision when converting decimals to floats,\ + \ so this is not recommended." + default: false + type: "boolean" + required: + - "filetype" + - title: "Document File Type Format (Experimental)" + type: "object" + properties: + filetype: + title: "Filetype" + default: "unstructured" + const: "unstructured" + type: "string" + enum: + - "unstructured" + skip_unprocessable_files: + title: "Skip Unprocessable Files" + description: "If true, skip files that cannot be parsed and\ + \ pass the error message along as the _ab_source_file_parse_error\ + \ field. If false, fail the sync." + default: true + always_show: true + type: "boolean" + strategy: + title: "Parsing Strategy" + description: "The strategy used to parse documents. `fast` extracts\ + \ text directly from the document which doesn't work for all\ + \ files. `ocr_only` is more reliable, but slower. `hi_res`\ + \ is the most reliable, but requires an API key and a hosted\ + \ instance of unstructured and can't be used with local mode.\ + \ See the unstructured.io documentation for more details:\ + \ https://unstructured-io.github.io/unstructured/core/partition.html#partition-pdf" + default: "auto" + always_show: true + order: 0 + enum: + - "auto" + - "fast" + - "ocr_only" + - "hi_res" + type: "string" + processing: + title: "Processing" + description: "Processing configuration" + default: + mode: "local" + type: "object" + oneOf: + - title: "Local" + type: "object" + properties: + mode: + title: "Mode" + default: "local" + const: "local" + enum: + - "local" + type: "string" + description: "Process files locally, supporting `fast` and\ + \ `ocr` modes. This is the default option." + required: + - "mode" + description: "Extract text from document formats (.pdf, .docx, .md,\ + \ .pptx) and emit as one record per file." + required: + - "filetype" + schemaless: + title: "Schemaless" + description: "When enabled, syncs will not validate or structure records\ + \ against the stream's schema." + default: false + type: "boolean" + required: + - "name" + - "format" + folder_url: + title: "Folder Url" + description: "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." + examples: + - "https://drive.google.com/drive/folders/1Xaz0vXXXX2enKnNYU5qSt9NS70gvMyYn" + order: 0 + pattern: "^https://drive.google.com/.+" + pattern_descriptor: "https://drive.google.com/drive/folders/MY-FOLDER-ID" + type: "string" + credentials: + title: "Authentication" + description: "Credentials for connecting to the Google Drive API" + type: "object" + oneOf: + - title: "Authenticate via Google (OAuth)" + type: "object" + properties: + auth_type: + title: "Auth Type" + default: "Client" + const: "Client" + enum: + - "Client" + type: "string" + client_id: + title: "Client ID" + description: "Client ID for the Google Drive API" + airbyte_secret: true + type: "string" + client_secret: + title: "Client Secret" + description: "Client Secret for the Google Drive API" + airbyte_secret: true + type: "string" + refresh_token: + title: "Refresh Token" + description: "Refresh Token for the Google Drive API" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "auth_type" + - title: "Service Account Key Authentication" + type: "object" + properties: + auth_type: + title: "Auth Type" + default: "Service" + const: "Service" + enum: + - "Service" + type: "string" + service_account_info: + title: "Service Account Information" + description: "The JSON key of the service account to use for authorization.\ + \ Read more here." + airbyte_secret: true + type: "string" + required: + - "service_account_info" + - "auth_type" + sourceType: + title: "google-drive" + const: "google-drive" + enum: + - "google-drive" + order: 0 + type: "string" + required: + - "streams" + - "folder_url" + - "credentials" + - "sourceType" + source-google-drive-update: + title: "Google Drive Source Spec" + description: "Used during spec; allows the developer to configure the cloud\ + \ provider specific options\nthat are needed when users configure a file-based\ + \ source." + type: "object" + properties: + start_date: + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00.000000Z.\ + \ Any file modified before this date will not be replicated." + examples: + - "2021-01-01T00:00:00.000000Z" + format: "date-time" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$" + pattern_descriptor: "YYYY-MM-DDTHH:mm:ss.SSSSSSZ" + order: 1 + type: "string" + streams: + title: "The list of streams to sync" + description: "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." + order: 10 + type: "array" + items: + title: "FileBasedStreamConfig" + type: "object" + properties: + name: + title: "Name" + description: "The name of the stream." + type: "string" + globs: + title: "Globs" + description: "The pattern used to specify which files should be selected\ + \ from the file system. For more information on glob pattern matching\ + \ look here." + default: + - "**" + order: 1 + type: "array" + items: + type: "string" + validation_policy: + title: "Validation Policy" + description: "The name of the validation policy that dictates sync\ + \ behavior when a record does not adhere to the stream schema." + default: "Emit Record" + enum: + - "Emit Record" + - "Skip Record" + - "Wait for Discover" + input_schema: + title: "Input Schema" + description: "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." + type: "string" + primary_key: + title: "Primary Key" + description: "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." + airbyte_hidden: true + type: "string" + days_to_sync_if_history_is_full: + title: "Days To Sync If History Is Full" + description: "When the state history of the file store is full, syncs\ + \ will only read files that were last modified in the provided day\ + \ range." + default: 3 + type: "integer" + format: + title: "Format" + description: "The configuration options that are used to alter how\ + \ to read incoming files that deviate from the standard formatting." + type: "object" + oneOf: + - title: "Avro Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "avro" + const: "avro" + type: "string" + enum: + - "avro" + double_as_string: + title: "Convert Double Fields to Strings" + description: "Whether to convert double fields to strings. This\ + \ is recommended if you have decimal numbers with a high degree\ + \ of precision because there can be a loss precision when\ + \ handling floating point numbers." + default: false + type: "boolean" + required: + - "filetype" + - title: "CSV Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "csv" + const: "csv" + type: "string" + enum: + - "csv" + delimiter: + title: "Delimiter" + description: "The character delimiting individual cells in the\ + \ CSV data. This may only be a 1-character string. For tab-delimited\ + \ data enter '\\t'." + default: "," + type: "string" + quote_char: + title: "Quote Character" + description: "The character used for quoting CSV values. To\ + \ disallow quoting, make this field blank." + default: "\"" + type: "string" + escape_char: + title: "Escape Character" + description: "The character used for escaping special characters.\ + \ To disallow escaping, leave this field blank." + type: "string" + encoding: + title: "Encoding" + description: "The character encoding of the CSV data. Leave\ + \ blank to default to UTF8. See list of python encodings for allowable\ + \ options." + default: "utf8" + type: "string" + double_quote: + title: "Double Quote" + description: "Whether two quotes in a quoted CSV value denote\ + \ a single quote in the data." + default: true + type: "boolean" + null_values: + title: "Null Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as null values. For example, if the value 'NA'\ + \ should be interpreted as null, enter 'NA' in this field." + default: [] + type: "array" + items: + type: "string" + uniqueItems: true + strings_can_be_null: + title: "Strings Can Be Null" + description: "Whether strings can be interpreted as null values.\ + \ If true, strings that match the null_values set will be\ + \ interpreted as null. If false, strings that match the null_values\ + \ set will be interpreted as the string itself." + default: true + type: "boolean" + skip_rows_before_header: + title: "Skip Rows Before Header" + description: "The number of rows to skip before the header row.\ + \ For example, if the header row is on the 3rd row, enter\ + \ 2 in this field." + default: 0 + type: "integer" + skip_rows_after_header: + title: "Skip Rows After Header" + description: "The number of rows to skip after the header row." + default: 0 + type: "integer" + header_definition: + title: "CSV Header Definition" + description: "How headers will be defined. `User Provided` assumes\ + \ the CSV does not have a header row and uses the headers\ + \ provided and `Autogenerated` assumes the CSV does not have\ + \ a header row and the CDK will generate headers using for\ + \ `f{i}` where `i` is the index starting from 0. Else, the\ + \ default behavior is to use the header from the CSV file.\ + \ If a user wants to autogenerate or provide column names\ + \ for a CSV having headers, they can skip rows." + default: + header_definition_type: "From CSV" + oneOf: + - title: "From CSV" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "From CSV" + const: "From CSV" + type: "string" + enum: + - "From CSV" + required: + - "header_definition_type" + - title: "Autogenerated" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "Autogenerated" + const: "Autogenerated" + type: "string" + enum: + - "Autogenerated" + required: + - "header_definition_type" + - title: "User Provided" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "User Provided" + const: "User Provided" + type: "string" + enum: + - "User Provided" + column_names: + title: "Column Names" + description: "The column names that will be used while\ + \ emitting the CSV records" + type: "array" + items: + type: "string" + required: + - "column_names" + - "header_definition_type" + type: "object" + true_values: + title: "True Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as true values." + default: + - "y" + - "yes" + - "t" + - "true" + - "on" + - "1" + type: "array" + items: + type: "string" + uniqueItems: true + false_values: + title: "False Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as false values." + default: + - "n" + - "no" + - "f" + - "false" + - "off" + - "0" + type: "array" + items: + type: "string" + uniqueItems: true + required: + - "filetype" + - title: "Jsonl Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "jsonl" + const: "jsonl" + type: "string" + enum: + - "jsonl" + required: + - "filetype" + - title: "Parquet Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "parquet" + const: "parquet" + type: "string" + enum: + - "parquet" + decimal_as_float: + title: "Convert Decimal Fields to Floats" + description: "Whether to convert decimal fields to floats. There\ + \ is a loss of precision when converting decimals to floats,\ + \ so this is not recommended." + default: false + type: "boolean" + required: + - "filetype" + - title: "Document File Type Format (Experimental)" + type: "object" + properties: + filetype: + title: "Filetype" + default: "unstructured" + const: "unstructured" + type: "string" + enum: + - "unstructured" + skip_unprocessable_files: + title: "Skip Unprocessable Files" + description: "If true, skip files that cannot be parsed and\ + \ pass the error message along as the _ab_source_file_parse_error\ + \ field. If false, fail the sync." + default: true + always_show: true + type: "boolean" + strategy: + title: "Parsing Strategy" + description: "The strategy used to parse documents. `fast` extracts\ + \ text directly from the document which doesn't work for all\ + \ files. `ocr_only` is more reliable, but slower. `hi_res`\ + \ is the most reliable, but requires an API key and a hosted\ + \ instance of unstructured and can't be used with local mode.\ + \ See the unstructured.io documentation for more details:\ + \ https://unstructured-io.github.io/unstructured/core/partition.html#partition-pdf" + default: "auto" + always_show: true + order: 0 + enum: + - "auto" + - "fast" + - "ocr_only" + - "hi_res" + type: "string" + processing: + title: "Processing" + description: "Processing configuration" + default: + mode: "local" + type: "object" + oneOf: + - title: "Local" + type: "object" + properties: + mode: + title: "Mode" + default: "local" + const: "local" + enum: + - "local" + type: "string" + description: "Process files locally, supporting `fast` and\ + \ `ocr` modes. This is the default option." + required: + - "mode" + description: "Extract text from document formats (.pdf, .docx, .md,\ + \ .pptx) and emit as one record per file." + required: + - "filetype" + schemaless: + title: "Schemaless" + description: "When enabled, syncs will not validate or structure records\ + \ against the stream's schema." + default: false + type: "boolean" + required: + - "name" + - "format" + folder_url: + title: "Folder Url" + description: "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." + examples: + - "https://drive.google.com/drive/folders/1Xaz0vXXXX2enKnNYU5qSt9NS70gvMyYn" + order: 0 + pattern: "^https://drive.google.com/.+" + pattern_descriptor: "https://drive.google.com/drive/folders/MY-FOLDER-ID" + type: "string" + credentials: + title: "Authentication" + description: "Credentials for connecting to the Google Drive API" + type: "object" + oneOf: + - title: "Authenticate via Google (OAuth)" + type: "object" + properties: + auth_type: + title: "Auth Type" + default: "Client" + const: "Client" + enum: + - "Client" + type: "string" + client_id: + title: "Client ID" + description: "Client ID for the Google Drive API" + airbyte_secret: true + type: "string" + client_secret: + title: "Client Secret" + description: "Client Secret for the Google Drive API" + airbyte_secret: true + type: "string" + refresh_token: + title: "Refresh Token" + description: "Refresh Token for the Google Drive API" + airbyte_secret: true + type: "string" + required: + - "client_id" + - "client_secret" + - "refresh_token" + - "auth_type" + - title: "Service Account Key Authentication" + type: "object" + properties: + auth_type: + title: "Auth Type" + default: "Service" + const: "Service" + enum: + - "Service" + type: "string" + service_account_info: + title: "Service Account Information" + description: "The JSON key of the service account to use for authorization.\ + \ Read more here." + airbyte_secret: true + type: "string" + required: + - "service_account_info" + - "auth_type" + required: + - "streams" + - "folder_url" + - "credentials" + source-mailjet-sms: + title: "Mailjet Sms Spec" + type: "object" + required: + - "token" + - "sourceType" + properties: + token: + title: "Access Token" + type: "string" + description: "Your access token. See here." + airbyte_secret: true + x-speakeasy-param-sensitive: true + start_date: + title: "Start date" + type: "integer" + description: "Retrieve SMS messages created after the specified timestamp.\ + \ Required format - Unix timestamp." + pattern: "^[0-9]*$" + examples: + - 1666261656 + end_date: + title: "End date" + type: "integer" + description: "Retrieve SMS messages created before the specified timestamp.\ + \ Required format - Unix timestamp." + pattern: "^[0-9]*$" + examples: + - 1666281656 + sourceType: + title: "mailjet-sms" + const: "mailjet-sms" + enum: + - "mailjet-sms" + order: 0 + type: "string" + source-mailjet-sms-update: + title: "Mailjet Sms Spec" + type: "object" + required: + - "token" + properties: + token: + title: "Access Token" + type: "string" + description: "Your access token. See here." + airbyte_secret: true + start_date: + title: "Start date" + type: "integer" + description: "Retrieve SMS messages created after the specified timestamp.\ + \ Required format - Unix timestamp." + pattern: "^[0-9]*$" + examples: + - 1666261656 + end_date: + title: "End date" + type: "integer" + description: "Retrieve SMS messages created before the specified timestamp.\ + \ Required format - Unix timestamp." + pattern: "^[0-9]*$" + examples: + - 1666281656 + source-gcs: + title: "Config" + description: "NOTE: When this Spec is changed, legacy_config_transformer.py\ + \ must also be\nmodified to uptake the changes because it is responsible for\ + \ converting\nlegacy GCS configs into file based configs using the File-Based\ + \ CDK." + type: "object" + properties: + start_date: + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00.000000Z.\ + \ Any file modified before this date will not be replicated." + examples: + - "2021-01-01T00:00:00.000000Z" + format: "date-time" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$" + pattern_descriptor: "YYYY-MM-DDTHH:mm:ss.SSSSSSZ" + order: 1 + type: "string" + streams: + title: "The list of streams to sync" + description: "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." + order: 3 + type: "array" + items: + title: "SourceGCSStreamConfig" + type: "object" + properties: + name: + title: "Name" + description: "The name of the stream." + order: 0 + type: "string" + globs: + title: "Globs" + description: "The pattern used to specify which files should be selected\ + \ from the file system. For more information on glob pattern matching\ + \ look here." + order: 1 + type: "array" + items: + type: "string" + legacy_prefix: + title: "Legacy Prefix" + description: "The path prefix configured in previous versions of the\ + \ GCS connector. This option is deprecated in favor of a single\ + \ glob." + airbyte_hidden: true + type: "string" + validation_policy: + title: "Validation Policy" + description: "The name of the validation policy that dictates sync\ + \ behavior when a record does not adhere to the stream schema." + default: "Emit Record" + enum: + - "Emit Record" + - "Skip Record" + - "Wait for Discover" + input_schema: + title: "Input Schema" + description: "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." + type: "string" + primary_key: + title: "Primary Key" + description: "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." + airbyte_hidden: true + type: "string" + x-speakeasy-param-sensitive: true + days_to_sync_if_history_is_full: + title: "Days To Sync If History Is Full" + description: "When the state history of the file store is full, syncs\ + \ will only read files that were last modified in the provided day\ + \ range." + default: 3 + type: "integer" + format: + title: "Format" + description: "The configuration options that are used to alter how\ + \ to read incoming files that deviate from the standard formatting." + order: 2 + type: "object" + oneOf: + - title: "CSV Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "csv" + const: "csv" + type: "string" + enum: + - "csv" + delimiter: + title: "Delimiter" + description: "The character delimiting individual cells in the\ + \ CSV data. This may only be a 1-character string. For tab-delimited\ + \ data enter '\\t'." + default: "," + type: "string" + quote_char: + title: "Quote Character" + description: "The character used for quoting CSV values. To\ + \ disallow quoting, make this field blank." + default: "\"" + type: "string" + escape_char: + title: "Escape Character" + description: "The character used for escaping special characters.\ + \ To disallow escaping, leave this field blank." + type: "string" + encoding: + title: "Encoding" + description: "The character encoding of the CSV data. Leave\ + \ blank to default to UTF8. See list of python encodings for allowable\ + \ options." + default: "utf8" + type: "string" + double_quote: + title: "Double Quote" + description: "Whether two quotes in a quoted CSV value denote\ + \ a single quote in the data." + default: true + type: "boolean" + null_values: + title: "Null Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as null values. For example, if the value 'NA'\ + \ should be interpreted as null, enter 'NA' in this field." + default: [] + type: "array" + items: + type: "string" + uniqueItems: true + strings_can_be_null: + title: "Strings Can Be Null" + description: "Whether strings can be interpreted as null values.\ + \ If true, strings that match the null_values set will be\ + \ interpreted as null. If false, strings that match the null_values\ + \ set will be interpreted as the string itself." + default: true + type: "boolean" + skip_rows_before_header: + title: "Skip Rows Before Header" + description: "The number of rows to skip before the header row.\ + \ For example, if the header row is on the 3rd row, enter\ + \ 2 in this field." + default: 0 + type: "integer" + skip_rows_after_header: + title: "Skip Rows After Header" + description: "The number of rows to skip after the header row." + default: 0 + type: "integer" + header_definition: + title: "CSV Header Definition" + description: "How headers will be defined. `User Provided` assumes\ + \ the CSV does not have a header row and uses the headers\ + \ provided and `Autogenerated` assumes the CSV does not have\ + \ a header row and the CDK will generate headers using for\ + \ `f{i}` where `i` is the index starting from 0. Else, the\ + \ default behavior is to use the header from the CSV file.\ + \ If a user wants to autogenerate or provide column names\ + \ for a CSV having headers, they can skip rows." + default: + header_definition_type: "From CSV" + oneOf: + - title: "From CSV" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "From CSV" + const: "From CSV" + type: "string" + enum: + - "From CSV" + required: + - "header_definition_type" + - title: "Autogenerated" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "Autogenerated" + const: "Autogenerated" + type: "string" + enum: + - "Autogenerated" + required: + - "header_definition_type" + - title: "User Provided" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "User Provided" + const: "User Provided" + type: "string" + enum: + - "User Provided" + column_names: + title: "Column Names" + description: "The column names that will be used while\ + \ emitting the CSV records" + type: "array" + items: + type: "string" + required: + - "column_names" + - "header_definition_type" + type: "object" + true_values: + title: "True Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as true values." + default: + - "y" + - "yes" + - "t" + - "true" + - "on" + - "1" + type: "array" + items: + type: "string" + uniqueItems: true + false_values: + title: "False Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as false values." + default: + - "n" + - "no" + - "f" + - "false" + - "off" + - "0" + type: "array" + items: + type: "string" + uniqueItems: true + inference_type: + title: "Inference Type" + description: "How to infer the types of the columns. If none,\ + \ inference default to strings." + default: "None" + airbyte_hidden: true + enum: + - "None" + - "Primitive Types Only" + ignore_errors_on_fields_mismatch: + title: "Ignore errors on field mismatch" + description: "Whether to ignore errors that occur when the number\ + \ of fields in the CSV does not match the number of columns\ + \ in the schema." + default: false + type: "boolean" + required: + - "filetype" + schemaless: + title: "Schemaless" + description: "When enabled, syncs will not validate or structure records\ + \ against the stream's schema." + default: false + type: "boolean" + required: + - "name" + - "format" + service_account: + title: "Service Account Information" + description: "Enter your Google Cloud service account key in JSON format" + airbyte_secret: true + order: 0 + type: "string" + bucket: + title: "Bucket" + description: "Name of the GCS bucket where the file(s) exist." + order: 2 + type: "string" + sourceType: + title: "gcs" + const: "gcs" + enum: + - "gcs" + order: 0 + type: "string" + required: + - "streams" + - "service_account" + - "bucket" + - "sourceType" + source-gcs-update: + title: "Config" + description: "NOTE: When this Spec is changed, legacy_config_transformer.py\ + \ must also be\nmodified to uptake the changes because it is responsible for\ + \ converting\nlegacy GCS configs into file based configs using the File-Based\ + \ CDK." + type: "object" + properties: + start_date: + title: "Start Date" + description: "UTC date and time in the format 2017-01-25T00:00:00.000000Z.\ + \ Any file modified before this date will not be replicated." + examples: + - "2021-01-01T00:00:00.000000Z" + format: "date-time" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$" + pattern_descriptor: "YYYY-MM-DDTHH:mm:ss.SSSSSSZ" + order: 1 + type: "string" + streams: + title: "The list of streams to sync" + description: "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." + order: 3 + type: "array" + items: + title: "SourceGCSStreamConfig" + type: "object" + properties: + name: + title: "Name" + description: "The name of the stream." + order: 0 + type: "string" + globs: + title: "Globs" + description: "The pattern used to specify which files should be selected\ + \ from the file system. For more information on glob pattern matching\ + \ look here." + order: 1 + type: "array" + items: + type: "string" + legacy_prefix: + title: "Legacy Prefix" + description: "The path prefix configured in previous versions of the\ + \ GCS connector. This option is deprecated in favor of a single\ + \ glob." + airbyte_hidden: true + type: "string" + validation_policy: + title: "Validation Policy" + description: "The name of the validation policy that dictates sync\ + \ behavior when a record does not adhere to the stream schema." + default: "Emit Record" + enum: + - "Emit Record" + - "Skip Record" + - "Wait for Discover" + input_schema: + title: "Input Schema" + description: "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." + type: "string" + primary_key: + title: "Primary Key" + description: "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." + airbyte_hidden: true + type: "string" + days_to_sync_if_history_is_full: + title: "Days To Sync If History Is Full" + description: "When the state history of the file store is full, syncs\ + \ will only read files that were last modified in the provided day\ + \ range." + default: 3 + type: "integer" + format: + title: "Format" + description: "The configuration options that are used to alter how\ + \ to read incoming files that deviate from the standard formatting." + order: 2 + type: "object" + oneOf: + - title: "CSV Format" + type: "object" + properties: + filetype: + title: "Filetype" + default: "csv" + const: "csv" + type: "string" + enum: + - "csv" + delimiter: + title: "Delimiter" + description: "The character delimiting individual cells in the\ + \ CSV data. This may only be a 1-character string. For tab-delimited\ + \ data enter '\\t'." + default: "," + type: "string" + quote_char: + title: "Quote Character" + description: "The character used for quoting CSV values. To\ + \ disallow quoting, make this field blank." + default: "\"" + type: "string" + escape_char: + title: "Escape Character" + description: "The character used for escaping special characters.\ + \ To disallow escaping, leave this field blank." + type: "string" + encoding: + title: "Encoding" + description: "The character encoding of the CSV data. Leave\ + \ blank to default to UTF8. See list of python encodings for allowable\ + \ options." + default: "utf8" + type: "string" + double_quote: + title: "Double Quote" + description: "Whether two quotes in a quoted CSV value denote\ + \ a single quote in the data." + default: true + type: "boolean" + null_values: + title: "Null Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as null values. For example, if the value 'NA'\ + \ should be interpreted as null, enter 'NA' in this field." + default: [] + type: "array" + items: + type: "string" + uniqueItems: true + strings_can_be_null: + title: "Strings Can Be Null" + description: "Whether strings can be interpreted as null values.\ + \ If true, strings that match the null_values set will be\ + \ interpreted as null. If false, strings that match the null_values\ + \ set will be interpreted as the string itself." + default: true + type: "boolean" + skip_rows_before_header: + title: "Skip Rows Before Header" + description: "The number of rows to skip before the header row.\ + \ For example, if the header row is on the 3rd row, enter\ + \ 2 in this field." + default: 0 + type: "integer" + skip_rows_after_header: + title: "Skip Rows After Header" + description: "The number of rows to skip after the header row." + default: 0 + type: "integer" + header_definition: + title: "CSV Header Definition" + description: "How headers will be defined. `User Provided` assumes\ + \ the CSV does not have a header row and uses the headers\ + \ provided and `Autogenerated` assumes the CSV does not have\ + \ a header row and the CDK will generate headers using for\ + \ `f{i}` where `i` is the index starting from 0. Else, the\ + \ default behavior is to use the header from the CSV file.\ + \ If a user wants to autogenerate or provide column names\ + \ for a CSV having headers, they can skip rows." + default: + header_definition_type: "From CSV" + oneOf: + - title: "From CSV" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "From CSV" + const: "From CSV" + type: "string" + enum: + - "From CSV" + required: + - "header_definition_type" + - title: "Autogenerated" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "Autogenerated" + const: "Autogenerated" + type: "string" + enum: + - "Autogenerated" + required: + - "header_definition_type" + - title: "User Provided" + type: "object" + properties: + header_definition_type: + title: "Header Definition Type" + default: "User Provided" + const: "User Provided" + type: "string" + enum: + - "User Provided" + column_names: + title: "Column Names" + description: "The column names that will be used while\ + \ emitting the CSV records" + type: "array" + items: + type: "string" + required: + - "column_names" + - "header_definition_type" + type: "object" + true_values: + title: "True Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as true values." + default: + - "y" + - "yes" + - "t" + - "true" + - "on" + - "1" + type: "array" + items: + type: "string" + uniqueItems: true + false_values: + title: "False Values" + description: "A set of case-sensitive strings that should be\ + \ interpreted as false values." + default: + - "n" + - "no" + - "f" + - "false" + - "off" + - "0" + type: "array" + items: + type: "string" + uniqueItems: true + inference_type: + title: "Inference Type" + description: "How to infer the types of the columns. If none,\ + \ inference default to strings." + default: "None" + airbyte_hidden: true + enum: + - "None" + - "Primitive Types Only" + ignore_errors_on_fields_mismatch: + title: "Ignore errors on field mismatch" + description: "Whether to ignore errors that occur when the number\ + \ of fields in the CSV does not match the number of columns\ + \ in the schema." + default: false + type: "boolean" + required: + - "filetype" + schemaless: + title: "Schemaless" + description: "When enabled, syncs will not validate or structure records\ + \ against the stream's schema." + default: false + type: "boolean" + required: + - "name" + - "format" + service_account: + title: "Service Account Information" + description: "Enter your Google Cloud service account key in JSON format" + airbyte_secret: true + order: 0 + type: "string" + bucket: + title: "Bucket" + description: "Name of the GCS bucket where the file(s) exist." + order: 2 + type: "string" + required: + - "streams" + - "service_account" + - "bucket" + source-qualaroo: + title: "Qualaroo Spec" + type: "object" + required: + - "token" + - "key" + - "start_date" + - "sourceType" + properties: + token: + type: "string" + title: "API token" + description: "A Qualaroo token. See the docs for instructions on how to generate it." + airbyte_secret: true + x-speakeasy-param-sensitive: true + key: + type: "string" + title: "API key" + description: "A Qualaroo token. See the docs for instructions on how to generate it." + airbyte_secret: true + x-speakeasy-param-sensitive: true + start_date: + type: "string" + title: "Start Date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + examples: + - "2021-03-01T00:00:00.000Z" + survey_ids: + type: "array" + items: + type: "string" + pattern: "^[0-9]{1,8}$" + title: "Qualaroo survey IDs" + description: "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." + sourceType: + title: "qualaroo" + const: "qualaroo" + enum: + - "qualaroo" + order: 0 + type: "string" + source-qualaroo-update: + title: "Qualaroo Spec" + type: "object" + required: + - "token" + - "key" + - "start_date" + properties: + token: + type: "string" + title: "API token" + description: "A Qualaroo token. See the docs for instructions on how to generate it." + airbyte_secret: true + key: + type: "string" + title: "API key" + description: "A Qualaroo token. See the docs for instructions on how to generate it." + airbyte_secret: true + start_date: + type: "string" + title: "Start Date" + pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$" + description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\ + \ data before this date will not be replicated." + examples: + - "2021-03-01T00:00:00.000Z" + survey_ids: + type: "array" + items: + type: "string" + pattern: "^[0-9]{1,8}$" + title: "Qualaroo survey IDs" + description: "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." + source-nytimes: + title: "Nytimes Spec" + type: "object" + required: + - "api_key" + - "start_date" + - "period" + - "sourceType" + properties: + api_key: + type: "string" + title: "API Key" + description: "API Key" + airbyte_secret: true + order: 0 + x-speakeasy-param-sensitive: true + start_date: + type: "string" + title: "Start Date" + description: "Start date to begin the article retrieval (format YYYY-MM)" + pattern: "^[0-9]{4}-[0-9]{2}$" + examples: + - "2022-08" + - "1851-01" + format: "date" + order: 1 + end_date: + type: "string" + title: "End Date" + description: "End date to stop the article retrieval (format YYYY-MM)" + pattern: "^[0-9]{4}-[0-9]{2}$" + examples: + - "2022-08" + - "1851-01" + format: "date" + order: 2 + period: + type: "integer" + title: "Period (used for Most Popular streams)" + description: "Period of time (in days)" + order: 3 + enum: + - 1 + - 7 + - 30 + share_type: + type: "string" + title: "Share Type (used for Most Popular Shared stream)" + description: "Share Type" + order: 4 + enum: + - "facebook" + sourceType: + title: "nytimes" + const: "nytimes" + enum: + - "nytimes" + order: 0 + type: "string" + source-nytimes-update: + title: "Nytimes Spec" + type: "object" + required: + - "api_key" + - "start_date" + - "period" + properties: + api_key: + type: "string" + title: "API Key" + description: "API Key" + airbyte_secret: true + order: 0 + start_date: + type: "string" + title: "Start Date" + description: "Start date to begin the article retrieval (format YYYY-MM)" + pattern: "^[0-9]{4}-[0-9]{2}$" + examples: + - "2022-08" + - "1851-01" + format: "date" + order: 1 + end_date: + type: "string" + title: "End Date" + description: "End date to stop the article retrieval (format YYYY-MM)" + pattern: "^[0-9]{4}-[0-9]{2}$" + examples: + - "2022-08" + - "1851-01" + format: "date" + order: 2 + period: + type: "integer" + title: "Period (used for Most Popular streams)" + description: "Period of time (in days)" + order: 3 + enum: + - 1 + - 7 + - 30 + share_type: + type: "string" + title: "Share Type (used for Most Popular Shared stream)" + description: "Share Type" + order: 4 + enum: + - "facebook" + source-greenhouse: + title: "Greenhouse Spec" + type: "object" + required: + - "api_key" + - "sourceType" + properties: + api_key: + title: "API Key" + type: "string" + description: "Greenhouse API Key. See the docs for more information on how to generate this key." + airbyte_secret: true + order: 0 + x-speakeasy-param-sensitive: true + sourceType: + title: "greenhouse" + const: "greenhouse" + enum: + - "greenhouse" + order: 0 + type: "string" + source-greenhouse-update: + title: "Greenhouse Spec" + type: "object" + required: + - "api_key" + properties: + api_key: + title: "API Key" + type: "string" + description: "Greenhouse API Key. See the docs for more information on how to generate this key." + airbyte_secret: true + order: 0 + trello: + title: null + harvest: + properties: + credentials: + properties: + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Harvest developer application." + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Harvest developer application." + airbyte_secret: true + title: "Harvest Spec" + zendesk-chat: + properties: + credentials: + properties: + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your OAuth application" + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of your OAuth application." + airbyte_secret: true + title: "Zendesk Chat Spec" + google-ads: + properties: + credentials: + properties: + client_id: + type: "string" + title: "Client ID" + order: 1 + description: "The Client ID of your Google Ads developer application.\ + \ For detailed instructions on finding this value, refer to our documentation." + client_secret: + type: "string" + title: "Client Secret" + order: 2 + description: "The Client Secret of your Google Ads developer application.\ + \ For detailed instructions on finding this value, refer to our documentation." + airbyte_secret: true + developer_token: + type: "string" + title: "Developer Token" + order: 0 + description: "The Developer Token granted by Google to use their APIs.\ + \ For detailed instructions on finding this value, refer to our documentation." + airbyte_secret: true + title: "Google Ads Spec" + google-search-console: + properties: + authorization: + properties: + client_id: + title: "Client ID" + type: "string" + description: "The client ID of your Google Search Console developer\ + \ application. Read more here." + airbyte_secret: true + client_secret: + title: "Client Secret" + type: "string" + description: "The client secret of your Google Search Console developer\ + \ application. Read more here." + airbyte_secret: true + title: "Google Search Console Spec" + strava: + properties: + client_id: + type: "string" + description: "The Client ID of your Strava developer application." + title: "Client ID" + pattern: "^[0-9_\\-]+$" + examples: + - "12345" + order: 0 + client_secret: + type: "string" + description: "The Client Secret of your Strava developer application." + title: "Client Secret" + pattern: "^[0-9a-fA-F]+$" + examples: + - "fc6243f283e51f6ca989aab298b17da125496f50" + airbyte_secret: true + order: 1 + title: "Strava Spec" + shopify: + properties: + credentials: + properties: + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of the Shopify developer application." + airbyte_secret: true + order: 1 + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of the Shopify developer application." + airbyte_secret: true + order: 2 + title: "Shopify Source CDK Specifications" + retently: + properties: + credentials: + properties: + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Retently developer application." + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Retently developer application." + airbyte_secret: true + title: "Retently Api Spec" + instagram: + properties: + client_id: + title: "Client Id" + description: "The Client ID for your Oauth application" + airbyte_secret: true + airbyte_hidden: true + type: "string" + client_secret: + title: "Client Secret" + description: "The Client Secret for your Oauth application" + airbyte_secret: true + airbyte_hidden: true + type: "string" + title: "Source Instagram" + zendesk-sunshine: + properties: + credentials: + properties: + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your OAuth application." + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of your OAuth application." + airbyte_secret: true + title: null + snapchat-marketing: + properties: + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Snapchat developer application." + airbyte_secret: true + order: 0 + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Snapchat developer application." + airbyte_secret: true + order: 1 + title: "Snapchat Marketing Spec" + gitlab: + properties: + credentials: + properties: + client_id: + type: "string" + description: "The API ID of the Gitlab developer application." + airbyte_secret: true + client_secret: + type: "string" + description: "The API Secret the Gitlab developer application." + airbyte_secret: true + title: "Source Gitlab Spec" + snowflake: + properties: + credentials: + properties: + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your Snowflake developer application." + airbyte_secret: true + order: 1 + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of your Snowflake developer application." + airbyte_secret: true + order: 2 + title: "Snowflake Source Spec" + microsoft-sharepoint: + properties: + credentials: + properties: + client_id: + title: "Client ID" + description: "Client ID of your Microsoft developer application" + airbyte_secret: true + type: "string" + client_secret: + title: "Client Secret" + description: "Client Secret of your Microsoft developer application" + airbyte_secret: true + type: "string" + title: "Microsoft SharePoint Source Spec" + smartsheets: + properties: + credentials: + properties: + client_id: + type: "string" + description: "The API ID of the SmartSheets developer application." + airbyte_secret: true + client_secret: + type: "string" + description: "The API Secret the SmartSheets developer application." + airbyte_secret: true + title: "Smartsheets Source Spec" + notion: + properties: + credentials: + properties: + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Notion integration. See our docs\ + \ for more information." + airbyte_secret: true + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Notion integration. See our\ + \ docs\ + \ for more information." + airbyte_secret: true + title: "Notion Source Spec" + slack: + properties: + credentials: + properties: + client_id: + type: "string" + title: "Client ID" + description: "Slack client_id. See our docs if you need help finding this id." + client_secret: + type: "string" + title: "Client Secret" + description: "Slack client_secret. See our docs if you need help finding this secret." + airbyte_secret: true + title: "Slack Spec" + youtube-analytics: + properties: + credentials: + properties: + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your developer application" + airbyte_secret: true + client_secret: + title: "Client Secret" + type: "string" + description: "The client secret of your developer application" + airbyte_secret: true + title: "YouTube Analytics Spec" + google-sheets: + properties: + credentials: + properties: + client_id: + title: "Client ID" + type: "string" + description: "Enter your Google application's Client ID. See Google's\ + \ documentation for more information." + airbyte_secret: true + client_secret: + title: "Client Secret" + type: "string" + description: "Enter your Google application's Client Secret. See Google's\ + \ documentation for more information." + airbyte_secret: true + title: "Google Sheets Source Spec" + zendesk-talk: + properties: + credentials: + properties: + client_id: + type: "string" + title: "Client ID" + description: "Client ID" + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "Client Secret" + airbyte_secret: true + title: "Source Zendesk Talk Spec" + asana: + properties: + credentials: + properties: + client_id: + type: "string" + title: "" + description: "" + airbyte_secret: true + client_secret: + type: "string" + title: "" + description: "" + airbyte_secret: true + title: "Asana Spec" + microsoft-teams: + properties: + credentials: + properties: + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Microsoft Teams developer application." + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Microsoft Teams developer application." + airbyte_secret: true + title: "Microsoft Teams Spec" + amazon-seller-partner: + properties: + lwa_app_id: + title: "LWA Client Id" + description: "Your Login with Amazon Client ID." + order: 4 + airbyte_secret: true + type: "string" + lwa_client_secret: + title: "LWA Client Secret" + description: "Your Login with Amazon Client Secret." + airbyte_secret: true + order: 5 + type: "string" + title: "Amazon Seller Partner Spec" + linkedin-ads: + properties: + credentials: + properties: + client_id: + type: "string" + title: "Client ID" + description: "The client ID of your developer application. Refer to\ + \ our documentation\ + \ for more information." + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "The client secret of your developer application. Refer\ + \ to our documentation\ + \ for more information." + airbyte_secret: true + title: "Linkedin Ads Spec" + pinterest: + properties: + credentials: + properties: + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your OAuth application" + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of your OAuth application." + airbyte_secret: true + title: "Pinterest Spec" + zendesk-support: + properties: + credentials: + properties: + client_id: + type: "string" + title: "Client ID" + description: "The OAuth client's ID. See this guide for more information." + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "The OAuth client secret. See this guide for more information." + airbyte_secret: true + title: "Source Zendesk Support Spec" + microsoft-onedrive: + properties: + credentials: + properties: + client_id: + title: "Client ID" + description: "Client ID of your Microsoft developer application" + airbyte_secret: true + type: "string" + client_secret: + title: "Client Secret" + description: "Client Secret of your Microsoft developer application" + airbyte_secret: true + type: "string" + title: "Microsoft OneDrive Source Spec" + tiktok-marketing: + properties: + credentials: + properties: + app_id: + title: "App ID" + description: "The Developer Application App ID." + airbyte_secret: true + type: "string" + secret: + title: "Secret" + description: "The Developer Application Secret." + airbyte_secret: true + type: "string" + title: "TikTok Marketing Source Spec" + hubspot: + properties: + credentials: + properties: + client_id: + title: "Client ID" + description: "The Client ID of your HubSpot developer application. See\ + \ the Hubspot docs if you need help finding this ID." + type: "string" + examples: + - "123456789000" + client_secret: + title: "Client Secret" + description: "The client secret for your HubSpot developer application.\ + \ See the Hubspot docs if you need help finding this secret." + type: "string" + examples: + - "secret" + airbyte_secret: true + title: "HubSpot Source Spec" + google-analytics-data-api: + properties: + credentials: + properties: + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Google Analytics developer application." + order: 1 + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Google Analytics developer application." + airbyte_secret: true + order: 2 + title: "Google Analytics (Data API) Spec" + intercom: + properties: + client_id: + title: "Client Id" + type: "string" + description: "Client Id for your Intercom application." + airbyte_secret: true + client_secret: + title: "Client Secret" + type: "string" + description: "Client Secret for your Intercom application." + airbyte_secret: true + title: "Source Intercom Spec" + typeform: + properties: + credentials: + properties: + client_id: + type: "string" + description: "The Client ID of the Typeform developer application." + airbyte_secret: true + client_secret: + type: "string" + description: "The Client Secret the Typeform developer application." + airbyte_secret: true + title: null + facebook-marketing: + properties: + client_id: + title: "Client Id" + description: "The Client Id for your OAuth app" + airbyte_secret: true + airbyte_hidden: true + type: "string" + client_secret: + title: "Client Secret" + description: "The Client Secret for your OAuth app" + airbyte_secret: true + airbyte_hidden: true + type: "string" + title: "Source Facebook Marketing" + surveymonkey: + properties: + credentials: + properties: + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of the SurveyMonkey developer application." + airbyte_secret: true + order: 1 + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of the SurveyMonkey developer application." + airbyte_secret: true + order: 2 + title: null + bing-ads: + properties: + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your Microsoft Advertising developer application." + airbyte_secret: true + order: 1 + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of your Microsoft Advertising developer\ + \ application." + default: "" + airbyte_secret: true + order: 2 + title: "Bing Ads Spec" + monday: + properties: + credentials: + properties: + client_id: + type: "string" + title: "Client ID" + description: "The Client ID of your OAuth application." + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "The Client Secret of your OAuth application." + airbyte_secret: true + title: "Monday Spec" + amazon-ads: + properties: + client_id: + title: "Client ID" + description: "The client ID of your Amazon Ads developer application. See\ + \ the docs for more information." + order: 1 + type: "string" + airbyte_secret: true + client_secret: + title: "Client Secret" + description: "The client secret of your Amazon Ads developer application.\ + \ See the docs for more information." + airbyte_secret: true + order: 2 + type: "string" + title: "Amazon Ads Spec" + github: + properties: + credentials: + properties: + client_id: + type: "string" + title: "Client Id" + description: "OAuth Client Id" + airbyte_secret: true + client_secret: + type: "string" + title: "Client ssecret" + description: "OAuth Client secret" + airbyte_secret: true + title: "GitHub Source Spec" + square: + properties: + credentials: + properties: + client_id: + type: "string" + title: "Client ID" + description: "The Square-issued ID of your application" + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "The Square-issued application secret for your application" + airbyte_secret: true + title: "Square Spec" + mailchimp: + properties: + credentials: + properties: + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your OAuth application." + airbyte_secret: true + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your OAuth application." + airbyte_secret: true + title: "Mailchimp Spec" + airtable: + properties: + credentials: + properties: + client_id: + type: "string" + title: "Client ID" + description: "The client ID of the Airtable developer application." + airbyte_secret: true + client_secret: + type: "string" + title: "Client secret" + description: "The client secret the Airtable developer application." + airbyte_secret: true + title: "Airtable Source Spec" + salesforce: + properties: + client_id: + title: "Client ID" + description: "Enter your Salesforce developer application's Client ID" + type: "string" + order: 2 + client_secret: + title: "Client Secret" + description: "Enter your Salesforce developer application's Client secret" + type: "string" + airbyte_secret: true + order: 3 + title: "Salesforce Source Spec" + lever-hiring: + properties: + credentials: + properties: + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Lever Hiring developer application." + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Lever Hiring developer application." + airbyte_secret: true + title: "Lever Hiring Source Spec" + google-drive: + properties: + credentials: + properties: + client_id: + title: "Client ID" + description: "Client ID for the Google Drive API" + airbyte_secret: true + type: "string" + client_secret: + title: "Client Secret" + description: "Client Secret for the Google Drive API" + airbyte_secret: true + type: "string" + title: "Google Drive Source Spec" + destination-gcs: + title: "GCS Destination Spec" + type: "object" + required: + - "gcs_bucket_name" + - "gcs_bucket_path" + - "credential" + - "format" + - "destinationType" + properties: + gcs_bucket_name: + title: "GCS Bucket Name" + order: 1 + type: "string" + description: "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." + examples: + - "airbyte_sync" + gcs_bucket_path: + title: "GCS Bucket Path" + description: "GCS Bucket Path string Subdirectory under the above bucket\ + \ to sync the data into." + order: 2 + type: "string" + examples: + - "data_sync/test" + gcs_bucket_region: + title: "GCS Bucket Region" + type: "string" + order: 3 + default: "us" + description: "Select a Region of the GCS Bucket. Read more here." + enum: + - "northamerica-northeast1" + - "northamerica-northeast2" + - "us-central1" + - "us-east1" + - "us-east4" + - "us-west1" + - "us-west2" + - "us-west3" + - "us-west4" + - "southamerica-east1" + - "southamerica-west1" + - "europe-central2" + - "europe-north1" + - "europe-west1" + - "europe-west2" + - "europe-west3" + - "europe-west4" + - "europe-west6" + - "asia-east1" + - "asia-east2" + - "asia-northeast1" + - "asia-northeast2" + - "asia-northeast3" + - "asia-south1" + - "asia-south2" + - "asia-southeast1" + - "asia-southeast2" + - "australia-southeast1" + - "australia-southeast2" + - "asia" + - "eu" + - "us" + - "asia1" + - "eur4" + - "nam4" + credential: + title: "Authentication" + description: "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." + type: "object" + order: 0 + oneOf: + - title: "HMAC Key" + required: + - "credential_type" + - "hmac_key_access_id" + - "hmac_key_secret" + properties: + credential_type: + type: "string" + enum: + - "HMAC_KEY" + default: "HMAC_KEY" + hmac_key_access_id: + type: "string" + description: "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." + title: "Access ID" + airbyte_secret: true + order: 0 + examples: + - "1234567890abcdefghij1234" + x-speakeasy-param-sensitive: true + hmac_key_secret: + type: "string" + description: "The corresponding secret for the access ID. It is a\ + \ 40-character base-64 encoded string. Read more here." + title: "Secret" + airbyte_secret: true + order: 1 + examples: + - "1234567890abcdefghij1234567890ABCDEFGHIJ" + x-speakeasy-param-sensitive: true + format: + title: "Output Format" + type: "object" + description: "Output data format. One of the following formats must be selected\ + \ - AVRO format, PARQUET format, CSV format, or JSONL format." + order: 4 + oneOf: + - title: "Avro: Apache Avro" + required: + - "format_type" + - "compression_codec" + properties: + format_type: + type: "string" + enum: + - "Avro" + default: "Avro" + compression_codec: + title: "Compression Codec" + description: "The compression algorithm used to compress data. Default\ + \ to no compression." + type: "object" + oneOf: + - title: "No Compression" + required: + - "codec" + properties: + codec: + type: "string" + enum: + - "no compression" + default: "no compression" + - title: "Deflate" + required: + - "codec" + properties: + codec: + type: "string" + enum: + - "Deflate" + default: "Deflate" + compression_level: + title: "Deflate level" + description: "0: no compression & fastest, 9: best compression\ + \ & slowest." + type: "integer" + default: 0 + minimum: 0 + maximum: 9 + - title: "bzip2" + required: + - "codec" + properties: + codec: + type: "string" + enum: + - "bzip2" + default: "bzip2" + - title: "xz" + required: + - "codec" + properties: + codec: + type: "string" + enum: + - "xz" + default: "xz" + compression_level: + title: "Compression Level" + description: "The presets 0-3 are fast presets with medium compression.\ + \ The presets 4-6 are fairly slow presets with high compression.\ + \ The default preset is 6. The presets 7-9 are like the preset\ + \ 6 but use bigger dictionaries and have higher compressor\ + \ and decompressor memory requirements. Unless the uncompressed\ + \ size of the file exceeds 8 MiB, 16 MiB, or 32 MiB, it is\ + \ waste of memory to use the presets 7, 8, or 9, respectively.\ + \ Read more here for details." + type: "integer" + default: 6 + minimum: 0 + maximum: 9 + - title: "zstandard" + required: + - "codec" + properties: + codec: + type: "string" + enum: + - "zstandard" + default: "zstandard" + compression_level: + title: "Compression Level" + description: "Negative levels are 'fast' modes akin to lz4 or\ + \ snappy, levels above 9 are generally for archival purposes,\ + \ and levels above 18 use a lot of memory." + type: "integer" + default: 3 + minimum: -5 + maximum: 22 + include_checksum: + title: "Include Checksum" + description: "If true, include a checksum with each data block." + type: "boolean" + default: false + - title: "snappy" + required: + - "codec" + properties: + codec: + type: "string" + enum: + - "snappy" + default: "snappy" + - title: "CSV: Comma-Separated Values" + required: + - "format_type" + properties: + format_type: + type: "string" + enum: + - "CSV" + default: "CSV" + flattening: + type: "string" + title: "Normalization" + description: "Whether the input JSON data should be normalized (flattened)\ + \ in the output CSV. Please refer to docs for details." + default: "No flattening" + enum: + - "No flattening" + - "Root level flattening" + compression: + title: "Compression" + type: "object" + description: "Whether the output files should be compressed. If compression\ + \ is selected, the output filename will have an extra extension\ + \ (GZIP: \".csv.gz\")." + oneOf: + - title: "No Compression" + requires: + - "compression_type" + properties: + compression_type: + type: "string" + enum: + - "No Compression" + default: "No Compression" + - title: "GZIP" + requires: + - "compression_type" + properties: + compression_type: + type: "string" + enum: + - "GZIP" + default: "GZIP" + - title: "JSON Lines: newline-delimited JSON" + required: + - "format_type" + properties: + format_type: + type: "string" + enum: + - "JSONL" + default: "JSONL" + compression: + title: "Compression" + type: "object" + description: "Whether the output files should be compressed. If compression\ + \ is selected, the output filename will have an extra extension\ + \ (GZIP: \".jsonl.gz\")." + oneOf: + - title: "No Compression" + requires: "compression_type" + properties: + compression_type: + type: "string" + enum: + - "No Compression" + default: "No Compression" + - title: "GZIP" + requires: "compression_type" + properties: + compression_type: + type: "string" + enum: + - "GZIP" + default: "GZIP" + - title: "Parquet: Columnar Storage" + required: + - "format_type" + properties: + format_type: + type: "string" + enum: + - "Parquet" + default: "Parquet" + compression_codec: + title: "Compression Codec" + description: "The compression algorithm used to compress data pages." + type: "string" + default: "UNCOMPRESSED" + enum: + - "UNCOMPRESSED" + - "SNAPPY" + - "GZIP" + - "LZO" + - "BROTLI" + - "LZ4" + - "ZSTD" + block_size_mb: + title: "Block Size (Row Group Size) (MB)" + description: "This is the size of a row group being buffered in memory.\ + \ It limits the memory usage when writing. Larger values will improve\ + \ the IO when reading, but consume more memory when writing. Default:\ + \ 128 MB." + type: "integer" + default: 128 + examples: + - 128 + max_padding_size_mb: + title: "Max Padding Size (MB)" + description: "Maximum size allowed as padding to align row groups.\ + \ This is also the minimum size of a row group. Default: 8 MB." + type: "integer" + default: 8 + examples: + - 8 + page_size_kb: + title: "Page Size (KB)" + description: "The page size is for compression. A block is composed\ + \ of pages. A page is the smallest unit that must be read fully\ + \ to access a single record. If this value is too small, the compression\ + \ will deteriorate. Default: 1024 KB." + type: "integer" + default: 1024 + examples: + - 1024 + dictionary_page_size_kb: + title: "Dictionary Page Size (KB)" + description: "There is one dictionary page per column per row group\ + \ when dictionary encoding is used. The dictionary page size works\ + \ like the page size but for dictionary. Default: 1024 KB." + type: "integer" + default: 1024 + examples: + - 1024 + dictionary_encoding: + title: "Dictionary Encoding" + description: "Default: true." + type: "boolean" + default: true + destinationType: + title: "gcs" + const: "gcs" + enum: + - "gcs" + order: 0 + type: "string" + destination-gcs-update: + title: "GCS Destination Spec" + type: "object" + required: + - "gcs_bucket_name" + - "gcs_bucket_path" + - "credential" + - "format" + properties: + gcs_bucket_name: + title: "GCS Bucket Name" + order: 1 + type: "string" + description: "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." + examples: + - "airbyte_sync" + gcs_bucket_path: + title: "GCS Bucket Path" + description: "GCS Bucket Path string Subdirectory under the above bucket\ + \ to sync the data into." + order: 2 + type: "string" + examples: + - "data_sync/test" + gcs_bucket_region: + title: "GCS Bucket Region" + type: "string" + order: 3 + default: "us" + description: "Select a Region of the GCS Bucket. Read more here." + enum: + - "northamerica-northeast1" + - "northamerica-northeast2" + - "us-central1" + - "us-east1" + - "us-east4" + - "us-west1" + - "us-west2" + - "us-west3" + - "us-west4" + - "southamerica-east1" + - "southamerica-west1" + - "europe-central2" + - "europe-north1" + - "europe-west1" + - "europe-west2" + - "europe-west3" + - "europe-west4" + - "europe-west6" + - "asia-east1" + - "asia-east2" + - "asia-northeast1" + - "asia-northeast2" + - "asia-northeast3" + - "asia-south1" + - "asia-south2" + - "asia-southeast1" + - "asia-southeast2" + - "australia-southeast1" + - "australia-southeast2" + - "asia" + - "eu" + - "us" + - "asia1" + - "eur4" + - "nam4" + credential: + title: "Authentication" + description: "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." + type: "object" + order: 0 + oneOf: + - title: "HMAC Key" + required: + - "credential_type" + - "hmac_key_access_id" + - "hmac_key_secret" + properties: + credential_type: + type: "string" + enum: + - "HMAC_KEY" + default: "HMAC_KEY" + hmac_key_access_id: + type: "string" + description: "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." + title: "Access ID" + airbyte_secret: true + order: 0 + examples: + - "1234567890abcdefghij1234" + hmac_key_secret: + type: "string" + description: "The corresponding secret for the access ID. It is a\ + \ 40-character base-64 encoded string. Read more here." + title: "Secret" + airbyte_secret: true + order: 1 + examples: + - "1234567890abcdefghij1234567890ABCDEFGHIJ" + format: + title: "Output Format" + type: "object" + description: "Output data format. One of the following formats must be selected\ + \ - AVRO format, PARQUET format, CSV format, or JSONL format." + order: 4 + oneOf: + - title: "Avro: Apache Avro" + required: + - "format_type" + - "compression_codec" + properties: + format_type: + type: "string" + enum: + - "Avro" + default: "Avro" + compression_codec: + title: "Compression Codec" + description: "The compression algorithm used to compress data. Default\ + \ to no compression." + type: "object" + oneOf: + - title: "No Compression" + required: + - "codec" + properties: + codec: + type: "string" + enum: + - "no compression" + default: "no compression" + - title: "Deflate" + required: + - "codec" + properties: + codec: + type: "string" + enum: + - "Deflate" + default: "Deflate" + compression_level: + title: "Deflate level" + description: "0: no compression & fastest, 9: best compression\ + \ & slowest." + type: "integer" + default: 0 + minimum: 0 + maximum: 9 + - title: "bzip2" + required: + - "codec" + properties: + codec: + type: "string" + enum: + - "bzip2" + default: "bzip2" + - title: "xz" + required: + - "codec" + properties: + codec: + type: "string" + enum: + - "xz" + default: "xz" + compression_level: + title: "Compression Level" + description: "The presets 0-3 are fast presets with medium compression.\ + \ The presets 4-6 are fairly slow presets with high compression.\ + \ The default preset is 6. The presets 7-9 are like the preset\ + \ 6 but use bigger dictionaries and have higher compressor\ + \ and decompressor memory requirements. Unless the uncompressed\ + \ size of the file exceeds 8 MiB, 16 MiB, or 32 MiB, it is\ + \ waste of memory to use the presets 7, 8, or 9, respectively.\ + \ Read more here for details." + type: "integer" + default: 6 + minimum: 0 + maximum: 9 + - title: "zstandard" + required: + - "codec" + properties: + codec: + type: "string" + enum: + - "zstandard" + default: "zstandard" + compression_level: + title: "Compression Level" + description: "Negative levels are 'fast' modes akin to lz4 or\ + \ snappy, levels above 9 are generally for archival purposes,\ + \ and levels above 18 use a lot of memory." + type: "integer" + default: 3 + minimum: -5 + maximum: 22 + include_checksum: + title: "Include Checksum" + description: "If true, include a checksum with each data block." + type: "boolean" + default: false + - title: "snappy" + required: + - "codec" + properties: + codec: + type: "string" + enum: + - "snappy" + default: "snappy" + - title: "CSV: Comma-Separated Values" + required: + - "format_type" + properties: + format_type: + type: "string" + enum: + - "CSV" + default: "CSV" + flattening: + type: "string" + title: "Normalization" + description: "Whether the input JSON data should be normalized (flattened)\ + \ in the output CSV. Please refer to docs for details." + default: "No flattening" + enum: + - "No flattening" + - "Root level flattening" + compression: + title: "Compression" + type: "object" + description: "Whether the output files should be compressed. If compression\ + \ is selected, the output filename will have an extra extension\ + \ (GZIP: \".csv.gz\")." + oneOf: + - title: "No Compression" + requires: + - "compression_type" + properties: + compression_type: + type: "string" + enum: + - "No Compression" + default: "No Compression" + - title: "GZIP" + requires: + - "compression_type" + properties: + compression_type: + type: "string" + enum: + - "GZIP" + default: "GZIP" + - title: "JSON Lines: newline-delimited JSON" + required: + - "format_type" + properties: + format_type: + type: "string" + enum: + - "JSONL" + default: "JSONL" + compression: + title: "Compression" + type: "object" + description: "Whether the output files should be compressed. If compression\ + \ is selected, the output filename will have an extra extension\ + \ (GZIP: \".jsonl.gz\")." + oneOf: + - title: "No Compression" + requires: "compression_type" + properties: + compression_type: + type: "string" + enum: + - "No Compression" + default: "No Compression" + - title: "GZIP" + requires: "compression_type" + properties: + compression_type: + type: "string" + enum: + - "GZIP" + default: "GZIP" + - title: "Parquet: Columnar Storage" + required: + - "format_type" + properties: + format_type: + type: "string" + enum: + - "Parquet" + default: "Parquet" + compression_codec: + title: "Compression Codec" + description: "The compression algorithm used to compress data pages." + type: "string" + default: "UNCOMPRESSED" + enum: + - "UNCOMPRESSED" + - "SNAPPY" + - "GZIP" + - "LZO" + - "BROTLI" + - "LZ4" + - "ZSTD" + block_size_mb: + title: "Block Size (Row Group Size) (MB)" + description: "This is the size of a row group being buffered in memory.\ + \ It limits the memory usage when writing. Larger values will improve\ + \ the IO when reading, but consume more memory when writing. Default:\ + \ 128 MB." + type: "integer" + default: 128 + examples: + - 128 + max_padding_size_mb: + title: "Max Padding Size (MB)" + description: "Maximum size allowed as padding to align row groups.\ + \ This is also the minimum size of a row group. Default: 8 MB." + type: "integer" + default: 8 + examples: + - 8 + page_size_kb: + title: "Page Size (KB)" + description: "The page size is for compression. A block is composed\ + \ of pages. A page is the smallest unit that must be read fully\ + \ to access a single record. If this value is too small, the compression\ + \ will deteriorate. Default: 1024 KB." + type: "integer" + default: 1024 + examples: + - 1024 + dictionary_page_size_kb: + title: "Dictionary Page Size (KB)" + description: "There is one dictionary page per column per row group\ + \ when dictionary encoding is used. The dictionary page size works\ + \ like the page size but for dictionary. Default: 1024 KB." + type: "integer" + default: 1024 + examples: + - 1024 + dictionary_encoding: + title: "Dictionary Encoding" + description: "Default: true." + type: "boolean" + default: true + destination-clickhouse: + title: "ClickHouse Destination Spec" + type: "object" + required: + - "host" + - "port" + - "database" + - "username" + - "destinationType" + properties: + host: + title: "Host" + description: "Hostname of the database." + type: "string" + order: 0 + port: + title: "Port" + description: "HTTP port of the database." + type: "integer" + minimum: 0 + maximum: 65536 + default: 8123 + examples: + - "8123" + order: 1 + database: + title: "DB Name" + description: "Name of the database." + type: "string" + order: 2 + username: + title: "User" + description: "Username to use to access the database." + type: "string" + order: 3 + password: + title: "Password" + description: "Password associated with the username." + type: "string" + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + jdbc_url_params: + description: "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)." + title: "JDBC URL Params" + type: "string" + order: 5 + raw_data_schema: + type: "string" + description: "The schema to write raw tables into (default: airbyte_internal)" + title: "Raw Table Schema Name" + order: 7 + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + x-speakeasy-param-sensitive: true + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + destinationType: + title: "clickhouse" + const: "clickhouse" + enum: + - "clickhouse" + order: 0 + type: "string" + destination-clickhouse-update: + title: "ClickHouse Destination Spec" + type: "object" + required: + - "host" + - "port" + - "database" + - "username" + properties: + host: + title: "Host" + description: "Hostname of the database." + type: "string" + order: 0 + port: + title: "Port" + description: "HTTP port of the database." + type: "integer" + minimum: 0 + maximum: 65536 + default: 8123 + examples: + - "8123" + order: 1 + database: + title: "DB Name" + description: "Name of the database." + type: "string" + order: 2 + username: + title: "User" + description: "Username to use to access the database." + type: "string" + order: 3 + password: + title: "Password" + description: "Password associated with the username." + type: "string" + airbyte_secret: true + order: 4 + jdbc_url_params: + description: "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)." + title: "JDBC URL Params" + type: "string" + order: 5 + raw_data_schema: + type: "string" + description: "The schema to write raw tables into (default: airbyte_internal)" + title: "Raw Table Schema Name" + order: 7 + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + destination-mssql: + title: "MS SQL Server Destination Spec" + type: "object" + required: + - "host" + - "port" + - "username" + - "database" + - "schema" + - "destinationType" + properties: + host: + title: "Host" + description: "The host name of the MSSQL database." + type: "string" + order: 0 + port: + title: "Port" + description: "The port of the MSSQL database." + type: "integer" + minimum: 0 + maximum: 65536 + default: 1433 + examples: + - "1433" + order: 1 + database: + title: "DB Name" + description: "The name of the MSSQL database." + type: "string" + order: 2 + schema: + title: "Default Schema" + description: "The default schema tables are written to if the source does\ + \ not specify a namespace. The usual value for this field is \"public\"\ + ." + type: "string" + examples: + - "public" + default: "public" + order: 3 + username: + title: "User" + description: "The username which is used to access the database." + type: "string" + order: 4 + password: + title: "Password" + description: "The password associated with this username." + type: "string" + airbyte_secret: true + order: 5 + x-speakeasy-param-sensitive: true + jdbc_url_params: + title: "JDBC URL Params" + description: "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)." + type: "string" + order: 6 + ssl_method: + title: "SSL Method" + type: "object" + description: "The encryption method which is used to communicate with the\ + \ database." + order: 7 + oneOf: + - title: "Encrypted (trust server certificate)" + description: "Use the certificate provided by the server without verification.\ + \ (For testing purposes only!)" + required: + - "ssl_method" + type: "object" + properties: + ssl_method: + type: "string" + const: "encrypted_trust_server_certificate" + enum: + - "encrypted_trust_server_certificate" + default: "encrypted_trust_server_certificate" + - title: "Encrypted (verify certificate)" + description: "Verify and use the certificate provided by the server." + required: + - "ssl_method" + - "trustStoreName" + - "trustStorePassword" + type: "object" + properties: + ssl_method: + type: "string" + const: "encrypted_verify_certificate" + enum: + - "encrypted_verify_certificate" + default: "encrypted_verify_certificate" + hostNameInCertificate: + title: "Host Name In Certificate" + type: "string" + description: "Specifies the host name of the server. The value of\ + \ this property must match the subject property of the certificate." + order: 8 + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + x-speakeasy-param-sensitive: true + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + destinationType: + title: "mssql" + const: "mssql" + enum: + - "mssql" + order: 0 + type: "string" + destination-mssql-update: + title: "MS SQL Server Destination Spec" + type: "object" + required: + - "host" + - "port" + - "username" + - "database" + - "schema" + properties: + host: + title: "Host" + description: "The host name of the MSSQL database." + type: "string" + order: 0 + port: + title: "Port" + description: "The port of the MSSQL database." + type: "integer" + minimum: 0 + maximum: 65536 + default: 1433 + examples: + - "1433" + order: 1 + database: + title: "DB Name" + description: "The name of the MSSQL database." + type: "string" + order: 2 + schema: + title: "Default Schema" + description: "The default schema tables are written to if the source does\ + \ not specify a namespace. The usual value for this field is \"public\"\ + ." + type: "string" + examples: + - "public" + default: "public" + order: 3 + username: + title: "User" + description: "The username which is used to access the database." + type: "string" + order: 4 + password: + title: "Password" + description: "The password associated with this username." + type: "string" + airbyte_secret: true + order: 5 + jdbc_url_params: + title: "JDBC URL Params" + description: "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)." + type: "string" + order: 6 + ssl_method: + title: "SSL Method" + type: "object" + description: "The encryption method which is used to communicate with the\ + \ database." + order: 7 + oneOf: + - title: "Encrypted (trust server certificate)" + description: "Use the certificate provided by the server without verification.\ + \ (For testing purposes only!)" + required: + - "ssl_method" + type: "object" + properties: + ssl_method: + type: "string" + const: "encrypted_trust_server_certificate" + enum: + - "encrypted_trust_server_certificate" + default: "encrypted_trust_server_certificate" + - title: "Encrypted (verify certificate)" + description: "Verify and use the certificate provided by the server." + required: + - "ssl_method" + - "trustStoreName" + - "trustStorePassword" + type: "object" + properties: + ssl_method: + type: "string" + const: "encrypted_verify_certificate" + enum: + - "encrypted_verify_certificate" + default: "encrypted_verify_certificate" + hostNameInCertificate: + title: "Host Name In Certificate" + type: "string" + description: "Specifies the host name of the server. The value of\ + \ this property must match the subject property of the certificate." + order: 8 + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + destination-mysql: + title: "MySQL Destination Spec" + type: "object" + required: + - "host" + - "port" + - "username" + - "database" + - "destinationType" + properties: + host: + title: "Host" + description: "Hostname of the database." + type: "string" + order: 0 + port: + title: "Port" + description: "Port of the database." + type: "integer" + minimum: 0 + maximum: 65536 + default: 3306 + examples: + - "3306" + order: 1 + database: + title: "DB Name" + description: "Name of the database." + type: "string" + order: 2 + username: + title: "User" + description: "Username to use to access the database." + type: "string" + order: 3 + password: + title: "Password" + description: "Password associated with the username." + type: "string" + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + jdbc_url_params: + description: "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)." + title: "JDBC URL Params" + type: "string" + order: 6 + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + x-speakeasy-param-sensitive: true + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + destinationType: + title: "mysql" + const: "mysql" + enum: + - "mysql" + order: 0 + type: "string" + destination-mysql-update: + title: "MySQL Destination Spec" + type: "object" + required: + - "host" + - "port" + - "username" + - "database" + properties: + host: + title: "Host" + description: "Hostname of the database." + type: "string" + order: 0 + port: + title: "Port" + description: "Port of the database." + type: "integer" + minimum: 0 + maximum: 65536 + default: 3306 + examples: + - "3306" + order: 1 + database: + title: "DB Name" + description: "Name of the database." + type: "string" + order: 2 + username: + title: "User" + description: "Username to use to access the database." + type: "string" + order: 3 + password: + title: "Password" + description: "Password associated with the username." + type: "string" + airbyte_secret: true + order: 4 + jdbc_url_params: + description: "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)." + title: "JDBC URL Params" + type: "string" + order: 6 + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + destination-pubsub: + title: "Google PubSub Destination Spec" + type: "object" + required: + - "project_id" + - "topic_id" + - "credentials_json" + - "ordering_enabled" + - "batching_enabled" + - "destinationType" + properties: + project_id: + type: "string" + description: "The GCP project ID for the project containing the target PubSub." + title: "Project ID" + topic_id: + type: "string" + description: "The PubSub topic ID in the given GCP project ID." + title: "PubSub Topic ID" + credentials_json: + type: "string" + description: "The contents of the JSON service account key. Check out the\ + \ docs if you need help generating this key." + title: "Credentials JSON" + airbyte_secret: true + ordering_enabled: + title: "Message Ordering Enabled" + description: "If TRUE PubSub publisher will have message ordering enabled. Every message will have an ordering key\ + \ of stream" + type: "boolean" + default: false + batching_enabled: + type: "boolean" + title: "Message Batching Enabled" + description: "If TRUE messages will be buffered instead of sending them\ + \ one by one" + default: false + batching_delay_threshold: + type: "integer" + title: "Message Batching: Delay Threshold" + description: "Number of ms before the buffer is flushed" + default: 1 + minimum: 1 + batching_element_count_threshold: + type: "integer" + title: "Message Batching: Element Count Threshold" + description: "Number of messages before the buffer is flushed" + default: 1 + minimum: 1 + batching_request_bytes_threshold: + type: "integer" + title: "Message Batching: Request Bytes Threshold" + description: "Number of bytes before the buffer is flushed" + default: 1 + minimum: 1 + destinationType: + title: "pubsub" + const: "pubsub" + enum: + - "pubsub" + order: 0 + type: "string" + destination-pubsub-update: + title: "Google PubSub Destination Spec" + type: "object" + required: + - "project_id" + - "topic_id" + - "credentials_json" + - "ordering_enabled" + - "batching_enabled" + properties: + project_id: + type: "string" + description: "The GCP project ID for the project containing the target PubSub." + title: "Project ID" + topic_id: + type: "string" + description: "The PubSub topic ID in the given GCP project ID." + title: "PubSub Topic ID" + credentials_json: + type: "string" + description: "The contents of the JSON service account key. Check out the\ + \ docs if you need help generating this key." + title: "Credentials JSON" + airbyte_secret: true + ordering_enabled: + title: "Message Ordering Enabled" + description: "If TRUE PubSub publisher will have message ordering enabled. Every message will have an ordering key\ + \ of stream" + type: "boolean" + default: false + batching_enabled: + type: "boolean" + title: "Message Batching Enabled" + description: "If TRUE messages will be buffered instead of sending them\ + \ one by one" + default: false + batching_delay_threshold: + type: "integer" + title: "Message Batching: Delay Threshold" + description: "Number of ms before the buffer is flushed" + default: 1 + minimum: 1 + batching_element_count_threshold: + type: "integer" + title: "Message Batching: Element Count Threshold" + description: "Number of messages before the buffer is flushed" + default: 1 + minimum: 1 + batching_request_bytes_threshold: + type: "integer" + title: "Message Batching: Request Bytes Threshold" + description: "Number of bytes before the buffer is flushed" + default: 1 + minimum: 1 + destination-weaviate: + title: "Destination Config" + description: "The configuration model for the Vector DB based destinations.\ + \ This model is used to generate the UI for the destination configuration,\n\ + as well as to provide type safety for the configuration passed to the destination.\n\ + \nThe configuration model is composed of four parts:\n* Processing configuration\n\ + * Embedding configuration\n* Indexing configuration\n* Advanced configuration\n\ + \nProcessing, embedding and advanced configuration are provided by this base\ + \ class, while the indexing configuration is provided by the destination connector\ + \ in the sub class." + type: "object" + properties: + embedding: + title: "Embedding" + description: "Embedding configuration" + group: "embedding" + type: "object" + oneOf: + - title: "No external embedding" + type: "object" + properties: + mode: + title: "Mode" + default: "no_embedding" + const: "no_embedding" + enum: + - "no_embedding" + type: "string" + description: "Do not calculate and pass embeddings to Weaviate. Suitable\ + \ for clusters with configured vectorizers to calculate embeddings within\ + \ Weaviate or for classes that should only support regular text search." + required: + - "mode" + - title: "Azure OpenAI" + type: "object" + properties: + mode: + title: "Mode" + default: "azure_openai" + const: "azure_openai" + enum: + - "azure_openai" + type: "string" + openai_key: + title: "Azure OpenAI API key" + description: "The API key for your Azure OpenAI resource. You can\ + \ find this in the Azure portal under your Azure OpenAI resource" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + api_base: + title: "Resource base URL" + description: "The base URL for your Azure OpenAI resource. You can\ + \ find this in the Azure portal under your Azure OpenAI resource" + examples: + - "https://your-resource-name.openai.azure.com" + type: "string" + deployment: + title: "Deployment" + description: "The deployment for your Azure OpenAI resource. You\ + \ can find this in the Azure portal under your Azure OpenAI resource" + examples: + - "your-resource-name" + type: "string" + required: + - "openai_key" + - "api_base" + - "deployment" + - "mode" + description: "Use the Azure-hosted OpenAI API to embed text. This option\ + \ is using the text-embedding-ada-002 model with 1536 embedding dimensions." + - title: "OpenAI" + type: "object" + properties: + mode: + title: "Mode" + default: "openai" + const: "openai" + enum: + - "openai" + type: "string" + openai_key: + title: "OpenAI API key" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + required: + - "openai_key" + - "mode" + description: "Use the OpenAI API to embed text. This option is using the\ + \ text-embedding-ada-002 model with 1536 embedding dimensions." + - title: "Cohere" + type: "object" + properties: + mode: + title: "Mode" + default: "cohere" + const: "cohere" + enum: + - "cohere" + type: "string" + cohere_key: + title: "Cohere API key" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + required: + - "cohere_key" + - "mode" + description: "Use the Cohere API to embed text." + - title: "From Field" + type: "object" + properties: + mode: + title: "Mode" + default: "from_field" + const: "from_field" + enum: + - "from_field" + type: "string" + field_name: + title: "Field name" + description: "Name of the field in the record that contains the embedding" + examples: + - "embedding" + - "vector" + type: "string" + dimensions: + title: "Embedding dimensions" + description: "The number of dimensions the embedding model is generating" + examples: + - 1536 + - 384 + type: "integer" + required: + - "field_name" + - "dimensions" + - "mode" + description: "Use a field in the record as the embedding. This is useful\ + \ if you already have an embedding for your data and want to store it\ + \ in the vector store." + - title: "Fake" + type: "object" + properties: + mode: + title: "Mode" + default: "fake" + const: "fake" + enum: + - "fake" + type: "string" + description: "Use a fake embedding made out of random vectors with 1536\ + \ embedding dimensions. This is useful for testing the data pipeline\ + \ without incurring any costs." + required: + - "mode" + - title: "OpenAI-compatible" + type: "object" + properties: + mode: + title: "Mode" + default: "openai_compatible" + const: "openai_compatible" + enum: + - "openai_compatible" + type: "string" + api_key: + title: "API key" + default: "" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + base_url: + title: "Base URL" + description: "The base URL for your OpenAI-compatible service" + examples: + - "https://your-service-name.com" + type: "string" + model_name: + title: "Model name" + description: "The name of the model to use for embedding" + default: "text-embedding-ada-002" + examples: + - "text-embedding-ada-002" + type: "string" + dimensions: + title: "Embedding dimensions" + description: "The number of dimensions the embedding model is generating" + examples: + - 1536 + - 384 + type: "integer" + required: + - "base_url" + - "dimensions" + - "mode" + description: "Use a service that's compatible with the OpenAI API to embed\ + \ text." + processing: + title: "ProcessingConfigModel" + type: "object" + properties: + chunk_size: + title: "Chunk size" + description: "Size of chunks in tokens to store in vector store (make\ + \ sure it is not too big for the context if your LLM)" + maximum: 8191 + minimum: 1 + type: "integer" + chunk_overlap: + title: "Chunk overlap" + description: "Size of overlap between chunks in tokens to store in vector\ + \ store to better capture relevant context" + default: 0 + type: "integer" + text_fields: + title: "Text fields to embed" + description: "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." + default: [] + always_show: true + examples: + - "text" + - "user.name" + - "users.*.name" + type: "array" + items: + type: "string" + metadata_fields: + title: "Fields to store as metadata" + description: "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." + default: [] + always_show: true + examples: + - "age" + - "user" + - "user.name" + type: "array" + items: + type: "string" + text_splitter: + title: "Text splitter" + description: "Split text fields into chunks based on the specified method." + type: "object" + oneOf: + - title: "By Separator" + type: "object" + properties: + mode: + title: "Mode" + default: "separator" + const: "separator" + enum: + - "separator" + type: "string" + separators: + title: "Separators" + description: "List of separator strings to split text fields by.\ + \ The separator itself needs to be wrapped in double quotes,\ + \ e.g. to split by the dot character, use \".\". To split by\ + \ a newline, use \"\\n\"." + default: + - "\"\\n\\n\"" + - "\"\\n\"" + - "\" \"" + - "\"\"" + type: "array" + items: + type: "string" + keep_separator: + title: "Keep separator" + description: "Whether to keep the separator in the resulting chunks" + default: false + type: "boolean" + description: "Split the text by the list of separators until the chunk\ + \ size is reached, using the earlier mentioned separators where\ + \ possible. This is useful for splitting text fields by paragraphs,\ + \ sentences, words, etc." + required: + - "mode" + - title: "By Markdown header" + type: "object" + properties: + mode: + title: "Mode" + default: "markdown" + const: "markdown" + enum: + - "markdown" + type: "string" + split_level: + title: "Split level" + description: "Level of markdown headers to split text fields by.\ + \ Headings down to the specified level will be used as split\ + \ points" + default: 1 + minimum: 1 + maximum: 6 + type: "integer" + description: "Split the text by Markdown headers down to the specified\ + \ header level. If the chunk size fits multiple sections, they will\ + \ be combined into a single chunk." + required: + - "mode" + - title: "By Programming Language" + type: "object" + properties: + mode: + title: "Mode" + default: "code" + const: "code" + enum: + - "code" + type: "string" + language: + title: "Language" + description: "Split code in suitable places based on the programming\ + \ language" + enum: + - "cpp" + - "go" + - "java" + - "js" + - "php" + - "proto" + - "python" + - "rst" + - "ruby" + - "rust" + - "scala" + - "swift" + - "markdown" + - "latex" + - "html" + - "sol" + type: "string" + required: + - "language" + - "mode" + description: "Split the text by suitable delimiters based on the programming\ + \ language. This is useful for splitting code into chunks." + field_name_mappings: + title: "Field name mappings" + description: "List of fields to rename. Not applicable for nested fields,\ + \ but can be used to rename fields already flattened via dot notation." + default: [] + type: "array" + items: + title: "FieldNameMappingConfigModel" + type: "object" + properties: + from_field: + title: "From field name" + description: "The field name in the source" + type: "string" + to_field: + title: "To field name" + description: "The field name to use in the destination" + type: "string" + required: + - "from_field" + - "to_field" + required: + - "chunk_size" + group: "processing" + omit_raw_text: + title: "Do not store raw text" + description: "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." + default: false + group: "advanced" + type: "boolean" + indexing: + title: "Indexing" + type: "object" + properties: + host: + title: "Public Endpoint" + description: "The public endpoint of the Weaviate cluster." + order: 1 + examples: + - "https://my-cluster.weaviate.network" + type: "string" + auth: + title: "Authentication" + description: "Authentication method" + type: "object" + order: 2 + oneOf: + - title: "API Token" + type: "object" + properties: + mode: + title: "Mode" + default: "token" + const: "token" + enum: + - "token" + type: "string" + token: + title: "API Token" + description: "API Token for the Weaviate instance" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + required: + - "token" + - "mode" + description: "Authenticate using an API token (suitable for Weaviate\ + \ Cloud)" + - title: "Username/Password" + type: "object" + properties: + mode: + title: "Mode" + default: "username_password" + const: "username_password" + enum: + - "username_password" + type: "string" + username: + title: "Username" + description: "Username for the Weaviate cluster" + order: 1 + type: "string" + password: + title: "Password" + description: "Password for the Weaviate cluster" + airbyte_secret: true + order: 2 + type: "string" + x-speakeasy-param-sensitive: true + required: + - "username" + - "password" + - "mode" + description: "Authenticate using username and password (suitable for\ + \ self-managed Weaviate clusters)" + - title: "No Authentication" + type: "object" + properties: + mode: + title: "Mode" + default: "no_auth" + const: "no_auth" + enum: + - "no_auth" + type: "string" + description: "Do not authenticate (suitable for locally running test\ + \ clusters, do not use for clusters with public IP addresses)" + required: + - "mode" + batch_size: + title: "Batch Size" + description: "The number of records to send to Weaviate in each batch" + default: 128 + type: "integer" + text_field: + title: "Text Field" + description: "The field in the object that contains the embedded text" + default: "text" + type: "string" + tenant_id: + title: "Tenant ID" + description: "The tenant ID to use for multi tenancy" + default: "" + airbyte_secret: true + type: "string" + default_vectorizer: + title: "Default Vectorizer" + description: "The vectorizer to use if new classes need to be created" + default: "none" + enum: + - "none" + - "text2vec-cohere" + - "text2vec-huggingface" + - "text2vec-openai" + - "text2vec-palm" + - "text2vec-contextionary" + - "text2vec-transformers" + - "text2vec-gpt4all" + type: "string" + additional_headers: + title: "Additional headers" + description: "Additional HTTP headers to send with every request." + default: [] + examples: + - header_key: "X-OpenAI-Api-Key" + value: "my-openai-api-key" + type: "array" + items: + title: "Header" + type: "object" + properties: + header_key: + title: "Header Key" + type: "string" + x-speakeasy-param-sensitive: true + value: + title: "Header Value" + airbyte_secret: true + type: "string" + required: + - "header_key" + - "value" + required: + - "host" + - "auth" + group: "indexing" + description: "Indexing configuration" + destinationType: + title: "weaviate" + const: "weaviate" + enum: + - "weaviate" + order: 0 + type: "string" + required: + - "embedding" + - "processing" + - "indexing" + - "destinationType" + groups: + - id: "processing" + title: "Processing" + - id: "embedding" + title: "Embedding" + - id: "indexing" + title: "Indexing" + - id: "advanced" + title: "Advanced" + destination-weaviate-update: + title: "Destination Config" + description: "The configuration model for the Vector DB based destinations.\ + \ This model is used to generate the UI for the destination configuration,\n\ + as well as to provide type safety for the configuration passed to the destination.\n\ + \nThe configuration model is composed of four parts:\n* Processing configuration\n\ + * Embedding configuration\n* Indexing configuration\n* Advanced configuration\n\ + \nProcessing, embedding and advanced configuration are provided by this base\ + \ class, while the indexing configuration is provided by the destination connector\ + \ in the sub class." + type: "object" + properties: + embedding: + title: "Embedding" + description: "Embedding configuration" + group: "embedding" + type: "object" + oneOf: + - title: "No external embedding" + type: "object" + properties: + mode: + title: "Mode" + default: "no_embedding" + const: "no_embedding" + enum: + - "no_embedding" + type: "string" + description: "Do not calculate and pass embeddings to Weaviate. Suitable\ + \ for clusters with configured vectorizers to calculate embeddings within\ + \ Weaviate or for classes that should only support regular text search." + required: + - "mode" + - title: "Azure OpenAI" + type: "object" + properties: + mode: + title: "Mode" + default: "azure_openai" + const: "azure_openai" + enum: + - "azure_openai" + type: "string" + openai_key: + title: "Azure OpenAI API key" + description: "The API key for your Azure OpenAI resource. You can\ + \ find this in the Azure portal under your Azure OpenAI resource" + airbyte_secret: true + type: "string" + api_base: + title: "Resource base URL" + description: "The base URL for your Azure OpenAI resource. You can\ + \ find this in the Azure portal under your Azure OpenAI resource" + examples: + - "https://your-resource-name.openai.azure.com" + type: "string" + deployment: + title: "Deployment" + description: "The deployment for your Azure OpenAI resource. You\ + \ can find this in the Azure portal under your Azure OpenAI resource" + examples: + - "your-resource-name" + type: "string" + required: + - "openai_key" + - "api_base" + - "deployment" + - "mode" + description: "Use the Azure-hosted OpenAI API to embed text. This option\ + \ is using the text-embedding-ada-002 model with 1536 embedding dimensions." + - title: "OpenAI" + type: "object" + properties: + mode: + title: "Mode" + default: "openai" + const: "openai" + enum: + - "openai" + type: "string" + openai_key: + title: "OpenAI API key" + airbyte_secret: true + type: "string" + required: + - "openai_key" + - "mode" + description: "Use the OpenAI API to embed text. This option is using the\ + \ text-embedding-ada-002 model with 1536 embedding dimensions." + - title: "Cohere" + type: "object" + properties: + mode: + title: "Mode" + default: "cohere" + const: "cohere" + enum: + - "cohere" + type: "string" + cohere_key: + title: "Cohere API key" + airbyte_secret: true + type: "string" + required: + - "cohere_key" + - "mode" + description: "Use the Cohere API to embed text." + - title: "From Field" + type: "object" + properties: + mode: + title: "Mode" + default: "from_field" + const: "from_field" + enum: + - "from_field" + type: "string" + field_name: + title: "Field name" + description: "Name of the field in the record that contains the embedding" + examples: + - "embedding" + - "vector" + type: "string" + dimensions: + title: "Embedding dimensions" + description: "The number of dimensions the embedding model is generating" + examples: + - 1536 + - 384 + type: "integer" + required: + - "field_name" + - "dimensions" + - "mode" + description: "Use a field in the record as the embedding. This is useful\ + \ if you already have an embedding for your data and want to store it\ + \ in the vector store." + - title: "Fake" + type: "object" + properties: + mode: + title: "Mode" + default: "fake" + const: "fake" + enum: + - "fake" + type: "string" + description: "Use a fake embedding made out of random vectors with 1536\ + \ embedding dimensions. This is useful for testing the data pipeline\ + \ without incurring any costs." + required: + - "mode" + - title: "OpenAI-compatible" + type: "object" + properties: + mode: + title: "Mode" + default: "openai_compatible" + const: "openai_compatible" + enum: + - "openai_compatible" + type: "string" + api_key: + title: "API key" + default: "" + airbyte_secret: true + type: "string" + base_url: + title: "Base URL" + description: "The base URL for your OpenAI-compatible service" + examples: + - "https://your-service-name.com" + type: "string" + model_name: + title: "Model name" + description: "The name of the model to use for embedding" + default: "text-embedding-ada-002" + examples: + - "text-embedding-ada-002" + type: "string" + dimensions: + title: "Embedding dimensions" + description: "The number of dimensions the embedding model is generating" + examples: + - 1536 + - 384 + type: "integer" + required: + - "base_url" + - "dimensions" + - "mode" + description: "Use a service that's compatible with the OpenAI API to embed\ + \ text." + processing: + title: "ProcessingConfigModel" + type: "object" + properties: + chunk_size: + title: "Chunk size" + description: "Size of chunks in tokens to store in vector store (make\ + \ sure it is not too big for the context if your LLM)" + maximum: 8191 + minimum: 1 + type: "integer" + chunk_overlap: + title: "Chunk overlap" + description: "Size of overlap between chunks in tokens to store in vector\ + \ store to better capture relevant context" + default: 0 + type: "integer" + text_fields: + title: "Text fields to embed" + description: "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." + default: [] + always_show: true + examples: + - "text" + - "user.name" + - "users.*.name" + type: "array" + items: + type: "string" + metadata_fields: + title: "Fields to store as metadata" + description: "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." + default: [] + always_show: true + examples: + - "age" + - "user" + - "user.name" + type: "array" + items: + type: "string" + text_splitter: + title: "Text splitter" + description: "Split text fields into chunks based on the specified method." + type: "object" + oneOf: + - title: "By Separator" + type: "object" + properties: + mode: + title: "Mode" + default: "separator" + const: "separator" + enum: + - "separator" + type: "string" + separators: + title: "Separators" + description: "List of separator strings to split text fields by.\ + \ The separator itself needs to be wrapped in double quotes,\ + \ e.g. to split by the dot character, use \".\". To split by\ + \ a newline, use \"\\n\"." + default: + - "\"\\n\\n\"" + - "\"\\n\"" + - "\" \"" + - "\"\"" + type: "array" + items: + type: "string" + keep_separator: + title: "Keep separator" + description: "Whether to keep the separator in the resulting chunks" + default: false + type: "boolean" + description: "Split the text by the list of separators until the chunk\ + \ size is reached, using the earlier mentioned separators where\ + \ possible. This is useful for splitting text fields by paragraphs,\ + \ sentences, words, etc." + required: + - "mode" + - title: "By Markdown header" + type: "object" + properties: + mode: + title: "Mode" + default: "markdown" + const: "markdown" + enum: + - "markdown" + type: "string" + split_level: + title: "Split level" + description: "Level of markdown headers to split text fields by.\ + \ Headings down to the specified level will be used as split\ + \ points" + default: 1 + minimum: 1 + maximum: 6 + type: "integer" + description: "Split the text by Markdown headers down to the specified\ + \ header level. If the chunk size fits multiple sections, they will\ + \ be combined into a single chunk." + required: + - "mode" + - title: "By Programming Language" + type: "object" + properties: + mode: + title: "Mode" + default: "code" + const: "code" + enum: + - "code" + type: "string" + language: + title: "Language" + description: "Split code in suitable places based on the programming\ + \ language" + enum: + - "cpp" + - "go" + - "java" + - "js" + - "php" + - "proto" + - "python" + - "rst" + - "ruby" + - "rust" + - "scala" + - "swift" + - "markdown" + - "latex" + - "html" + - "sol" + type: "string" + required: + - "language" + - "mode" + description: "Split the text by suitable delimiters based on the programming\ + \ language. This is useful for splitting code into chunks." + field_name_mappings: + title: "Field name mappings" + description: "List of fields to rename. Not applicable for nested fields,\ + \ but can be used to rename fields already flattened via dot notation." + default: [] + type: "array" + items: + title: "FieldNameMappingConfigModel" + type: "object" + properties: + from_field: + title: "From field name" + description: "The field name in the source" + type: "string" + to_field: + title: "To field name" + description: "The field name to use in the destination" + type: "string" + required: + - "from_field" + - "to_field" + required: + - "chunk_size" + group: "processing" + omit_raw_text: + title: "Do not store raw text" + description: "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." + default: false + group: "advanced" + type: "boolean" + indexing: + title: "Indexing" + type: "object" + properties: + host: + title: "Public Endpoint" + description: "The public endpoint of the Weaviate cluster." + order: 1 + examples: + - "https://my-cluster.weaviate.network" + type: "string" + auth: + title: "Authentication" + description: "Authentication method" + type: "object" + order: 2 + oneOf: + - title: "API Token" + type: "object" + properties: + mode: + title: "Mode" + default: "token" + const: "token" + enum: + - "token" + type: "string" + token: + title: "API Token" + description: "API Token for the Weaviate instance" + airbyte_secret: true + type: "string" + required: + - "token" + - "mode" + description: "Authenticate using an API token (suitable for Weaviate\ + \ Cloud)" + - title: "Username/Password" + type: "object" + properties: + mode: + title: "Mode" + default: "username_password" + const: "username_password" + enum: + - "username_password" + type: "string" + username: + title: "Username" + description: "Username for the Weaviate cluster" + order: 1 + type: "string" + password: + title: "Password" + description: "Password for the Weaviate cluster" + airbyte_secret: true + order: 2 + type: "string" + required: + - "username" + - "password" + - "mode" + description: "Authenticate using username and password (suitable for\ + \ self-managed Weaviate clusters)" + - title: "No Authentication" + type: "object" + properties: + mode: + title: "Mode" + default: "no_auth" + const: "no_auth" + enum: + - "no_auth" + type: "string" + description: "Do not authenticate (suitable for locally running test\ + \ clusters, do not use for clusters with public IP addresses)" + required: + - "mode" + batch_size: + title: "Batch Size" + description: "The number of records to send to Weaviate in each batch" + default: 128 + type: "integer" + text_field: + title: "Text Field" + description: "The field in the object that contains the embedded text" + default: "text" + type: "string" + tenant_id: + title: "Tenant ID" + description: "The tenant ID to use for multi tenancy" + default: "" + airbyte_secret: true + type: "string" + default_vectorizer: + title: "Default Vectorizer" + description: "The vectorizer to use if new classes need to be created" + default: "none" + enum: + - "none" + - "text2vec-cohere" + - "text2vec-huggingface" + - "text2vec-openai" + - "text2vec-palm" + - "text2vec-contextionary" + - "text2vec-transformers" + - "text2vec-gpt4all" + type: "string" + additional_headers: + title: "Additional headers" + description: "Additional HTTP headers to send with every request." + default: [] + examples: + - header_key: "X-OpenAI-Api-Key" + value: "my-openai-api-key" + type: "array" + items: + title: "Header" + type: "object" + properties: + header_key: + title: "Header Key" + type: "string" + value: + title: "Header Value" + airbyte_secret: true + type: "string" + required: + - "header_key" + - "value" + required: + - "host" + - "auth" + group: "indexing" + description: "Indexing configuration" + required: + - "embedding" + - "processing" + - "indexing" + groups: + - id: "processing" + title: "Processing" + - id: "embedding" + title: "Embedding" + - id: "indexing" + title: "Indexing" + - id: "advanced" + title: "Advanced" + destination-mongodb: + title: "MongoDB Destination Spec" + type: "object" + required: + - "database" + - "auth_type" + - "destinationType" + properties: + instance_type: + description: "MongoDb instance to connect to. For MongoDB Atlas and Replica\ + \ Set TLS connection is used by default." + title: "MongoDb Instance Type" + type: "object" + order: 0 + oneOf: + - title: "Standalone MongoDb Instance" + required: + - "instance" + - "host" + - "port" + properties: + instance: + type: "string" + enum: + - "standalone" + default: "standalone" + host: + title: "Host" + type: "string" + description: "The Host of a Mongo database to be replicated." + order: 0 + port: + title: "Port" + type: "integer" + description: "The Port of a Mongo database to be replicated." + minimum: 0 + maximum: 65536 + default: 27017 + examples: + - "27017" + order: 1 + - title: "Replica Set" + required: + - "instance" + - "server_addresses" + properties: + instance: + type: "string" + enum: + - "replica" + default: "replica" + server_addresses: + title: "Server addresses" + type: "string" + description: "The members of a replica set. Please specify `host`:`port`\ + \ of each member seperated by comma." + examples: + - "host1:27017,host2:27017,host3:27017" + order: 0 + replica_set: + title: "Replica Set" + type: "string" + description: "A replica set name." + order: 1 + - title: "MongoDB Atlas" + required: + - "instance" + - "cluster_url" + properties: + instance: + type: "string" + enum: + - "atlas" + default: "atlas" + cluster_url: + title: "Cluster URL" + type: "string" + description: "URL of a cluster to connect to." + order: 0 + database: + title: "DB Name" + description: "Name of the database." + type: "string" + order: 2 + auth_type: + title: "Authorization type" + type: "object" + description: "Authorization type." + oneOf: + - title: "None" + description: "None." + required: + - "authorization" + type: "object" + properties: + authorization: + type: "string" + const: "none" + enum: + - "none" + - title: "Login/Password" + description: "Login/Password." + required: + - "authorization" + - "username" + - "password" + type: "object" + properties: + authorization: + type: "string" + const: "login/password" + enum: + - "login/password" + username: + title: "User" + description: "Username to use to access the database." + type: "string" + order: 1 + password: + title: "Password" + description: "Password associated with the username." + type: "string" + airbyte_secret: true + order: 2 + x-speakeasy-param-sensitive: true + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + x-speakeasy-param-sensitive: true + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + destinationType: + title: "mongodb" + const: "mongodb" + enum: + - "mongodb" + order: 0 + type: "string" + destination-mongodb-update: + title: "MongoDB Destination Spec" + type: "object" + required: + - "database" + - "auth_type" + properties: + instance_type: + description: "MongoDb instance to connect to. For MongoDB Atlas and Replica\ + \ Set TLS connection is used by default." + title: "MongoDb Instance Type" + type: "object" + order: 0 + oneOf: + - title: "Standalone MongoDb Instance" + required: + - "instance" + - "host" + - "port" + properties: + instance: + type: "string" + enum: + - "standalone" + default: "standalone" + host: + title: "Host" + type: "string" + description: "The Host of a Mongo database to be replicated." + order: 0 + port: + title: "Port" + type: "integer" + description: "The Port of a Mongo database to be replicated." + minimum: 0 + maximum: 65536 + default: 27017 + examples: + - "27017" + order: 1 + - title: "Replica Set" + required: + - "instance" + - "server_addresses" + properties: + instance: + type: "string" + enum: + - "replica" + default: "replica" + server_addresses: + title: "Server addresses" + type: "string" + description: "The members of a replica set. Please specify `host`:`port`\ + \ of each member seperated by comma." + examples: + - "host1:27017,host2:27017,host3:27017" + order: 0 + replica_set: + title: "Replica Set" + type: "string" + description: "A replica set name." + order: 1 + - title: "MongoDB Atlas" + required: + - "instance" + - "cluster_url" + properties: + instance: + type: "string" + enum: + - "atlas" + default: "atlas" + cluster_url: + title: "Cluster URL" + type: "string" + description: "URL of a cluster to connect to." + order: 0 + database: + title: "DB Name" + description: "Name of the database." + type: "string" + order: 2 + auth_type: + title: "Authorization type" + type: "object" + description: "Authorization type." + oneOf: + - title: "None" + description: "None." + required: + - "authorization" + type: "object" + properties: + authorization: + type: "string" + const: "none" + enum: + - "none" + - title: "Login/Password" + description: "Login/Password." + required: + - "authorization" + - "username" + - "password" + type: "object" + properties: + authorization: + type: "string" + const: "login/password" + enum: + - "login/password" + username: + title: "User" + description: "Username to use to access the database." + type: "string" + order: 1 + password: + title: "Password" + description: "Password associated with the username." + type: "string" + airbyte_secret: true + order: 2 + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + destination-vectara: + title: "Vectara Config" + type: "object" + properties: + oauth2: + title: "OAuth2.0 Credentials" + type: "object" + properties: + client_id: + title: "OAuth Client ID" + description: "OAuth2.0 client id" + order: 0 + type: "string" + client_secret: + title: "OAuth Client Secret" + description: "OAuth2.0 client secret" + airbyte_secret: true + order: 1 + type: "string" + required: + - "client_id" + - "client_secret" + description: "OAuth2.0 credentials used to authenticate admin actions (creating/deleting\ + \ corpora)" + group: "auth" + customer_id: + title: "Customer ID" + description: "Your customer id as it is in the authenticaion url" + order: 2 + group: "account" + type: "string" + corpus_name: + title: "Corpus Name" + description: "The Name of Corpus to load data into" + order: 3 + group: "account" + type: "string" + parallelize: + title: "Parallelize" + description: "Parallelize indexing into Vectara with multiple threads" + default: false + always_show: true + group: "account" + type: "boolean" + text_fields: + title: "Text fields to index with Vectara" + description: "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." + default: [] + always_show: true + examples: + - "text" + - "user.name" + - "users.*.name" + type: "array" + items: + type: "string" + title_field: + title: "Text field to use as document title with Vectara" + description: "A field that will be used to populate the `title` of each\ + \ 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." + default: "" + always_show: true + examples: + - "document_key" + type: "string" + metadata_fields: + title: "Fields to store as metadata" + description: "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." + default: [] + always_show: true + examples: + - "age" + - "user" + type: "array" + items: + type: "string" + destinationType: + title: "vectara" + const: "vectara" + enum: + - "vectara" + order: 0 + type: "string" + required: + - "oauth2" + - "customer_id" + - "corpus_name" + - "destinationType" + description: "Configuration to connect to the Vectara instance" + groups: + - id: "account" + title: "Account" + - id: "auth" + title: "Authentication" + destination-vectara-update: + title: "Vectara Config" + type: "object" + properties: + oauth2: + title: "OAuth2.0 Credentials" + type: "object" + properties: + client_id: + title: "OAuth Client ID" + description: "OAuth2.0 client id" + order: 0 + type: "string" + client_secret: + title: "OAuth Client Secret" + description: "OAuth2.0 client secret" + airbyte_secret: true + order: 1 + type: "string" + required: + - "client_id" + - "client_secret" + description: "OAuth2.0 credentials used to authenticate admin actions (creating/deleting\ + \ corpora)" + group: "auth" + customer_id: + title: "Customer ID" + description: "Your customer id as it is in the authenticaion url" + order: 2 + group: "account" + type: "string" + corpus_name: + title: "Corpus Name" + description: "The Name of Corpus to load data into" + order: 3 + group: "account" + type: "string" + parallelize: + title: "Parallelize" + description: "Parallelize indexing into Vectara with multiple threads" + default: false + always_show: true + group: "account" + type: "boolean" + text_fields: + title: "Text fields to index with Vectara" + description: "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." + default: [] + always_show: true + examples: + - "text" + - "user.name" + - "users.*.name" + type: "array" + items: + type: "string" + title_field: + title: "Text field to use as document title with Vectara" + description: "A field that will be used to populate the `title` of each\ + \ 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." + default: "" + always_show: true + examples: + - "document_key" + type: "string" + metadata_fields: + title: "Fields to store as metadata" + description: "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." + default: [] + always_show: true + examples: + - "age" + - "user" + type: "array" + items: + type: "string" + required: + - "oauth2" + - "customer_id" + - "corpus_name" + description: "Configuration to connect to the Vectara instance" + groups: + - id: "account" + title: "Account" + - id: "auth" + title: "Authentication" + destination-s3-glue: + title: "S3 Destination Spec" + type: "object" + required: + - "s3_bucket_name" + - "s3_bucket_path" + - "s3_bucket_region" + - "format" + - "glue_database" + - "glue_serialization_library" + - "destinationType" + properties: + access_key_id: + type: "string" + description: "The access key ID to access the S3 bucket. Airbyte requires\ + \ Read and Write permissions to the given bucket. Read more here." + title: "S3 Key ID" + airbyte_secret: true + examples: + - "A012345678910EXAMPLE" + order: 0 + x-speakeasy-param-sensitive: true + secret_access_key: + type: "string" + description: "The corresponding secret to the access key ID. Read more here" + title: "S3 Access Key" + airbyte_secret: true + examples: + - "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY" + order: 1 + x-speakeasy-param-sensitive: true + s3_bucket_name: + title: "S3 Bucket Name" + type: "string" + description: "The name of the S3 bucket. Read more here." + examples: + - "airbyte_sync" + order: 2 + s3_bucket_path: + title: "S3 Bucket Path" + description: "Directory under the S3 bucket where data will be written.\ + \ Read more here" + type: "string" + examples: + - "data_sync/test" + order: 3 + s3_bucket_region: + title: "S3 Bucket Region" + type: "string" + default: "" + description: "The region of the S3 bucket. See here for all region codes." + enum: + - "" + - "af-south-1" + - "ap-east-1" + - "ap-northeast-1" + - "ap-northeast-2" + - "ap-northeast-3" + - "ap-south-1" + - "ap-south-2" + - "ap-southeast-1" + - "ap-southeast-2" + - "ap-southeast-3" + - "ap-southeast-4" + - "ca-central-1" + - "ca-west-1" + - "cn-north-1" + - "cn-northwest-1" + - "eu-central-1" + - "eu-central-2" + - "eu-north-1" + - "eu-south-1" + - "eu-south-2" + - "eu-west-1" + - "eu-west-2" + - "eu-west-3" + - "il-central-1" + - "me-central-1" + - "me-south-1" + - "sa-east-1" + - "us-east-1" + - "us-east-2" + - "us-gov-east-1" + - "us-gov-west-1" + - "us-west-1" + - "us-west-2" + order: 4 + format: + title: "Output Format" + type: "object" + description: "Format of the data output. See here for more details" + oneOf: + - title: "JSON Lines: Newline-delimited JSON" + required: + - "format_type" + properties: + format_type: + title: "Format Type" + type: "string" + enum: + - "JSONL" + default: "JSONL" + compression: + title: "Compression" + type: "object" + description: "Whether the output files should be compressed. If compression\ + \ is selected, the output filename will have an extra extension\ + \ (GZIP: \".jsonl.gz\")." + oneOf: + - title: "No Compression" + requires: "compression_type" + properties: + compression_type: + type: "string" + enum: + - "No Compression" + default: "No Compression" + - title: "GZIP" + requires: "compression_type" + properties: + compression_type: + type: "string" + enum: + - "GZIP" + default: "GZIP" + flattening: + type: "string" + title: "Flattening" + description: "Whether the input json data should be normalized (flattened)\ + \ in the output JSON Lines. Please refer to docs for details." + default: "Root level flattening" + enum: + - "No flattening" + - "Root level flattening" + order: 5 + s3_endpoint: + title: "Endpoint" + type: "string" + default: "" + description: "Your S3 endpoint url. Read more here" + examples: + - "http://localhost:9000" + order: 6 + s3_path_format: + title: "S3 Path Format" + description: "Format string on how data will be organized inside the S3\ + \ bucket directory. Read more here" + type: "string" + examples: + - "${NAMESPACE}/${STREAM_NAME}/${YEAR}_${MONTH}_${DAY}_${EPOCH}_" + order: 7 + file_name_pattern: + type: "string" + description: "The pattern allows you to set the file-name format for the\ + \ S3 staging file(s)" + title: "S3 Filename pattern" + examples: + - "{date}" + - "{date:yyyy_MM}" + - "{timestamp}" + - "{part_number}" + - "{sync_id}" + order: 8 + glue_database: + type: "string" + description: "Name of the glue database for creating the tables, leave blank\ + \ if no integration" + title: "Glue database name" + examples: + - "airbyte_database" + order: 9 + glue_serialization_library: + title: "Serialization Library" + description: "The library that your query engine will use for reading and\ + \ writing data in your lake." + type: "string" + enum: + - "org.openx.data.jsonserde.JsonSerDe" + - "org.apache.hive.hcatalog.data.JsonSerDe" + default: "org.openx.data.jsonserde.JsonSerDe" + order: 10 + destinationType: + title: "s3-glue" + const: "s3-glue" + enum: + - "s3-glue" + order: 0 + type: "string" + destination-s3-glue-update: + title: "S3 Destination Spec" + type: "object" + required: + - "s3_bucket_name" + - "s3_bucket_path" + - "s3_bucket_region" + - "format" + - "glue_database" + - "glue_serialization_library" + properties: + access_key_id: + type: "string" + description: "The access key ID to access the S3 bucket. Airbyte requires\ + \ Read and Write permissions to the given bucket. Read more here." + title: "S3 Key ID" + airbyte_secret: true + examples: + - "A012345678910EXAMPLE" + order: 0 + secret_access_key: + type: "string" + description: "The corresponding secret to the access key ID. Read more here" + title: "S3 Access Key" + airbyte_secret: true + examples: + - "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY" + order: 1 + s3_bucket_name: + title: "S3 Bucket Name" + type: "string" + description: "The name of the S3 bucket. Read more here." + examples: + - "airbyte_sync" + order: 2 + s3_bucket_path: + title: "S3 Bucket Path" + description: "Directory under the S3 bucket where data will be written.\ + \ Read more here" + type: "string" + examples: + - "data_sync/test" + order: 3 + s3_bucket_region: + title: "S3 Bucket Region" + type: "string" + default: "" + description: "The region of the S3 bucket. See here for all region codes." + enum: + - "" + - "af-south-1" + - "ap-east-1" + - "ap-northeast-1" + - "ap-northeast-2" + - "ap-northeast-3" + - "ap-south-1" + - "ap-south-2" + - "ap-southeast-1" + - "ap-southeast-2" + - "ap-southeast-3" + - "ap-southeast-4" + - "ca-central-1" + - "ca-west-1" + - "cn-north-1" + - "cn-northwest-1" + - "eu-central-1" + - "eu-central-2" + - "eu-north-1" + - "eu-south-1" + - "eu-south-2" + - "eu-west-1" + - "eu-west-2" + - "eu-west-3" + - "il-central-1" + - "me-central-1" + - "me-south-1" + - "sa-east-1" + - "us-east-1" + - "us-east-2" + - "us-gov-east-1" + - "us-gov-west-1" + - "us-west-1" + - "us-west-2" + order: 4 + format: + title: "Output Format" + type: "object" + description: "Format of the data output. See here for more details" + oneOf: + - title: "JSON Lines: Newline-delimited JSON" + required: + - "format_type" + properties: + format_type: + title: "Format Type" + type: "string" + enum: + - "JSONL" + default: "JSONL" + compression: + title: "Compression" + type: "object" + description: "Whether the output files should be compressed. If compression\ + \ is selected, the output filename will have an extra extension\ + \ (GZIP: \".jsonl.gz\")." + oneOf: + - title: "No Compression" + requires: "compression_type" + properties: + compression_type: + type: "string" + enum: + - "No Compression" + default: "No Compression" + - title: "GZIP" + requires: "compression_type" + properties: + compression_type: + type: "string" + enum: + - "GZIP" + default: "GZIP" + flattening: + type: "string" + title: "Flattening" + description: "Whether the input json data should be normalized (flattened)\ + \ in the output JSON Lines. Please refer to docs for details." + default: "Root level flattening" + enum: + - "No flattening" + - "Root level flattening" + order: 5 + s3_endpoint: + title: "Endpoint" + type: "string" + default: "" + description: "Your S3 endpoint url. Read more here" + examples: + - "http://localhost:9000" + order: 6 + s3_path_format: + title: "S3 Path Format" + description: "Format string on how data will be organized inside the S3\ + \ bucket directory. Read more here" + type: "string" + examples: + - "${NAMESPACE}/${STREAM_NAME}/${YEAR}_${MONTH}_${DAY}_${EPOCH}_" + order: 7 + file_name_pattern: + type: "string" + description: "The pattern allows you to set the file-name format for the\ + \ S3 staging file(s)" + title: "S3 Filename pattern" + examples: + - "{date}" + - "{date:yyyy_MM}" + - "{timestamp}" + - "{part_number}" + - "{sync_id}" + order: 8 + glue_database: + type: "string" + description: "Name of the glue database for creating the tables, leave blank\ + \ if no integration" + title: "Glue database name" + examples: + - "airbyte_database" + order: 9 + glue_serialization_library: + title: "Serialization Library" + description: "The library that your query engine will use for reading and\ + \ writing data in your lake." + type: "string" + enum: + - "org.openx.data.jsonserde.JsonSerDe" + - "org.apache.hive.hcatalog.data.JsonSerDe" + default: "org.openx.data.jsonserde.JsonSerDe" + order: 10 + destination-dev-null: + title: "E2E Test (/dev/null) Destination Spec" + type: "object" + required: + - "test_destination" + - "destinationType" + properties: + test_destination: + title: "Test Destination" + type: "object" + description: "The type of destination to be used" + oneOf: + - title: "Silent" + required: + - "test_destination_type" + properties: + test_destination_type: + type: "string" + const: "SILENT" + default: "SILENT" + enum: + - "SILENT" + destinationType: + title: "dev-null" + const: "dev-null" + enum: + - "dev-null" + order: 0 + type: "string" + destination-dev-null-update: + title: "E2E Test (/dev/null) Destination Spec" + type: "object" + required: + - "test_destination" + properties: + test_destination: + title: "Test Destination" + type: "object" + description: "The type of destination to be used" + oneOf: + - title: "Silent" + required: + - "test_destination_type" + properties: + test_destination_type: + type: "string" + const: "SILENT" + default: "SILENT" + enum: + - "SILENT" + destination-convex: + title: "Destination Convex" + type: "object" + required: + - "deployment_url" + - "access_key" + - "destinationType" + properties: + deployment_url: + type: "string" + description: "URL of the Convex deployment that is the destination" + examples: + - "https://murky-swan-635.convex.cloud" + - "https://cluttered-owl-337.convex.cloud" + access_key: + type: "string" + description: "API access key used to send data to a Convex deployment." + airbyte_secret: "true" + x-speakeasy-param-sensitive: true + destinationType: + title: "convex" + const: "convex" + enum: + - "convex" + order: 0 + type: "string" + destination-convex-update: + title: "Destination Convex" + type: "object" + required: + - "deployment_url" + - "access_key" + properties: + deployment_url: + type: "string" + description: "URL of the Convex deployment that is the destination" + examples: + - "https://murky-swan-635.convex.cloud" + - "https://cluttered-owl-337.convex.cloud" + access_key: + type: "string" + description: "API access key used to send data to a Convex deployment." + airbyte_secret: "true" + destination-firestore: + title: "Destination Google Firestore" + type: "object" + required: + - "project_id" + - "destinationType" + properties: + project_id: + type: "string" + description: "The GCP project ID for the project containing the target BigQuery\ + \ dataset." + title: "Project ID" + credentials_json: + type: "string" + description: "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." + title: "Credentials JSON" + airbyte_secret: true + destinationType: + title: "firestore" + const: "firestore" + enum: + - "firestore" + order: 0 + type: "string" + destination-firestore-update: + title: "Destination Google Firestore" + type: "object" + required: + - "project_id" + properties: + project_id: + type: "string" + description: "The GCP project ID for the project containing the target BigQuery\ + \ dataset." + title: "Project ID" + credentials_json: + type: "string" + description: "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." + title: "Credentials JSON" + airbyte_secret: true + destination-redshift: + title: "Redshift Destination Spec" + type: "object" + required: + - "host" + - "port" + - "database" + - "username" + - "password" + - "schema" + - "destinationType" + properties: + host: + description: "Host Endpoint of the Redshift Cluster (must include the cluster-id,\ + \ region and end with .redshift.amazonaws.com)" + type: "string" + title: "Host" + group: "connection" + order: 1 + port: + description: "Port of the database." + type: "integer" + minimum: 0 + maximum: 65536 + default: 5439 + examples: + - "5439" + title: "Port" + group: "connection" + order: 2 + username: + description: "Username to use to access the database." + type: "string" + title: "Username" + group: "connection" + order: 3 + password: + description: "Password associated with the username." + type: "string" + airbyte_secret: true + title: "Password" + group: "connection" + order: 4 + x-speakeasy-param-sensitive: true + database: + description: "Name of the database." + type: "string" + title: "Database" + group: "connection" + order: 5 + schema: + description: "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\"." + type: "string" + examples: + - "public" + default: "public" + group: "connection" + title: "Default Schema" + order: 6 + jdbc_url_params: + title: "JDBC URL Params" + description: "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)." + type: "string" + group: "connection" + order: 7 + uploading_method: + title: "Uploading Method" + type: "object" + description: "The way data will be uploaded to Redshift." + group: "connection" + order: 8 + display_type: "radio" + oneOf: + - title: "AWS S3 Staging" + description: "(recommended) Uploads data to S3 and then uses a\ + \ COPY to insert the data into Redshift. COPY is recommended for production\ + \ workloads for better speed and scalability. See AWS docs for more details." + required: + - "method" + - "s3_bucket_name" + - "s3_bucket_region" + - "access_key_id" + - "secret_access_key" + properties: + method: + type: "string" + const: "S3 Staging" + enum: + - "S3 Staging" + s3_bucket_name: + title: "S3 Bucket Name" + type: "string" + description: "The name of the staging S3 bucket." + examples: + - "airbyte.staging" + order: 0 + s3_bucket_path: + title: "S3 Bucket Path" + type: "string" + description: "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." + examples: + - "data_sync/test" + order: 1 + s3_bucket_region: + title: "S3 Bucket Region" + type: "string" + default: "" + description: "The region of the S3 staging bucket." + enum: + - "" + - "af-south-1" + - "ap-east-1" + - "ap-northeast-1" + - "ap-northeast-2" + - "ap-northeast-3" + - "ap-south-1" + - "ap-south-2" + - "ap-southeast-1" + - "ap-southeast-2" + - "ap-southeast-3" + - "ap-southeast-4" + - "ca-central-1" + - "ca-west-1" + - "cn-north-1" + - "cn-northwest-1" + - "eu-central-1" + - "eu-central-2" + - "eu-north-1" + - "eu-south-1" + - "eu-south-2" + - "eu-west-1" + - "eu-west-2" + - "eu-west-3" + - "il-central-1" + - "me-central-1" + - "me-south-1" + - "sa-east-1" + - "us-east-1" + - "us-east-2" + - "us-gov-east-1" + - "us-gov-west-1" + - "us-west-1" + - "us-west-2" + order: 2 + access_key_id: + type: "string" + description: "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." + title: "S3 Access Key Id" + airbyte_secret: true + order: 3 + x-speakeasy-param-sensitive: true + secret_access_key: + type: "string" + description: "The corresponding secret to the above access key id.\ + \ See AWS docs on how to generate an access key ID and secret access\ + \ key." + title: "S3 Secret Access Key" + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + file_name_pattern: + type: "string" + description: "The pattern allows you to set the file-name format for\ + \ the S3 staging file(s)" + title: "S3 Filename pattern" + examples: + - "{date}" + - "{date:yyyy_MM}" + - "{timestamp}" + - "{part_number}" + - "{sync_id}" + order: 5 + purge_staging_data: + title: "Purge Staging Files and Tables" + type: "boolean" + description: "Whether to delete the staging files from S3 after completing\ + \ the sync. See docs for details." + default: true + order: 6 + encryption: + title: "Encryption" + type: "object" + description: "How to encrypt the staging data" + default: + encryption_type: "none" + oneOf: + - title: "No encryption" + description: "Staging data will be stored in plaintext." + type: "object" + required: + - "encryption_type" + properties: + encryption_type: + type: "string" + const: "none" + enum: + - "none" + default: "none" + - title: "AES-CBC envelope encryption" + description: "Staging data will be encrypted using AES-CBC envelope\ + \ encryption." + type: "object" + required: + - "encryption_type" + properties: + encryption_type: + type: "string" + const: "aes_cbc_envelope" + enum: + - "aes_cbc_envelope" + default: "aes_cbc_envelope" + key_encrypting_key: + type: "string" + title: "Key" + description: "The key, base64-encoded. Must be either 128, 192,\ + \ or 256 bits. Leave blank to have Airbyte generate an ephemeral\ + \ key for each sync." + airbyte_secret: true + x-speakeasy-param-sensitive: true + order: 7 + - title: "Standard" + required: + - "method" + description: "(not recommended) Direct loading using SQL INSERT\ + \ statements. This method is extremely inefficient and provided only\ + \ for quick testing. In all other cases, you should use S3 uploading." + properties: + method: + type: "string" + const: "Standard" + enum: + - "Standard" + raw_data_schema: + type: "string" + description: "The schema to write raw tables into" + title: "Destinations V2 Raw Table Schema" + order: 9 + group: "connection" + enable_incremental_final_table_updates: + type: "boolean" + default: false + description: "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" + title: "Enable Loading Data Incrementally to Final Tables" + order: 10 + group: "connection" + disable_type_dedupe: + type: "boolean" + default: false + description: "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" + title: "Disable Final Tables. (WARNING! Unstable option; Columns in raw\ + \ table schema might change between versions)" + order: 11 + group: "connection" + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + x-speakeasy-param-sensitive: true + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + destinationType: + title: "redshift" + const: "redshift" + enum: + - "redshift" + order: 0 + type: "string" + groups: + - id: "connection" + title: "Connection" + destination-redshift-update: + title: "Redshift Destination Spec" + type: "object" + required: + - "host" + - "port" + - "database" + - "username" + - "password" + - "schema" + properties: + host: + description: "Host Endpoint of the Redshift Cluster (must include the cluster-id,\ + \ region and end with .redshift.amazonaws.com)" + type: "string" + title: "Host" + group: "connection" + order: 1 + port: + description: "Port of the database." + type: "integer" + minimum: 0 + maximum: 65536 + default: 5439 + examples: + - "5439" + title: "Port" + group: "connection" + order: 2 + username: + description: "Username to use to access the database." + type: "string" + title: "Username" + group: "connection" + order: 3 + password: + description: "Password associated with the username." + type: "string" + airbyte_secret: true + title: "Password" + group: "connection" + order: 4 + database: + description: "Name of the database." + type: "string" + title: "Database" + group: "connection" + order: 5 + schema: + description: "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\"." + type: "string" + examples: + - "public" + default: "public" + group: "connection" + title: "Default Schema" + order: 6 + jdbc_url_params: + title: "JDBC URL Params" + description: "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)." + type: "string" + group: "connection" + order: 7 + uploading_method: + title: "Uploading Method" + type: "object" + description: "The way data will be uploaded to Redshift." + group: "connection" + order: 8 + display_type: "radio" + oneOf: + - title: "AWS S3 Staging" + description: "(recommended) Uploads data to S3 and then uses a\ + \ COPY to insert the data into Redshift. COPY is recommended for production\ + \ workloads for better speed and scalability. See AWS docs for more details." + required: + - "method" + - "s3_bucket_name" + - "s3_bucket_region" + - "access_key_id" + - "secret_access_key" + properties: + method: + type: "string" + const: "S3 Staging" + enum: + - "S3 Staging" + s3_bucket_name: + title: "S3 Bucket Name" + type: "string" + description: "The name of the staging S3 bucket." + examples: + - "airbyte.staging" + order: 0 + s3_bucket_path: + title: "S3 Bucket Path" + type: "string" + description: "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." + examples: + - "data_sync/test" + order: 1 + s3_bucket_region: + title: "S3 Bucket Region" + type: "string" + default: "" + description: "The region of the S3 staging bucket." + enum: + - "" + - "af-south-1" + - "ap-east-1" + - "ap-northeast-1" + - "ap-northeast-2" + - "ap-northeast-3" + - "ap-south-1" + - "ap-south-2" + - "ap-southeast-1" + - "ap-southeast-2" + - "ap-southeast-3" + - "ap-southeast-4" + - "ca-central-1" + - "ca-west-1" + - "cn-north-1" + - "cn-northwest-1" + - "eu-central-1" + - "eu-central-2" + - "eu-north-1" + - "eu-south-1" + - "eu-south-2" + - "eu-west-1" + - "eu-west-2" + - "eu-west-3" + - "il-central-1" + - "me-central-1" + - "me-south-1" + - "sa-east-1" + - "us-east-1" + - "us-east-2" + - "us-gov-east-1" + - "us-gov-west-1" + - "us-west-1" + - "us-west-2" + order: 2 + access_key_id: + type: "string" + description: "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." + title: "S3 Access Key Id" + airbyte_secret: true + order: 3 + secret_access_key: + type: "string" + description: "The corresponding secret to the above access key id.\ + \ See AWS docs on how to generate an access key ID and secret access\ + \ key." + title: "S3 Secret Access Key" + airbyte_secret: true + order: 4 + file_name_pattern: + type: "string" + description: "The pattern allows you to set the file-name format for\ + \ the S3 staging file(s)" + title: "S3 Filename pattern" + examples: + - "{date}" + - "{date:yyyy_MM}" + - "{timestamp}" + - "{part_number}" + - "{sync_id}" + order: 5 + purge_staging_data: + title: "Purge Staging Files and Tables" + type: "boolean" + description: "Whether to delete the staging files from S3 after completing\ + \ the sync. See docs for details." + default: true + order: 6 + encryption: + title: "Encryption" + type: "object" + description: "How to encrypt the staging data" + default: + encryption_type: "none" + oneOf: + - title: "No encryption" + description: "Staging data will be stored in plaintext." + type: "object" + required: + - "encryption_type" + properties: + encryption_type: + type: "string" + const: "none" + enum: + - "none" + default: "none" + - title: "AES-CBC envelope encryption" + description: "Staging data will be encrypted using AES-CBC envelope\ + \ encryption." + type: "object" + required: + - "encryption_type" + properties: + encryption_type: + type: "string" + const: "aes_cbc_envelope" + enum: + - "aes_cbc_envelope" + default: "aes_cbc_envelope" + key_encrypting_key: + type: "string" + title: "Key" + description: "The key, base64-encoded. Must be either 128, 192,\ + \ or 256 bits. Leave blank to have Airbyte generate an ephemeral\ + \ key for each sync." + airbyte_secret: true + order: 7 + - title: "Standard" + required: + - "method" + description: "(not recommended) Direct loading using SQL INSERT\ + \ statements. This method is extremely inefficient and provided only\ + \ for quick testing. In all other cases, you should use S3 uploading." + properties: + method: + type: "string" + const: "Standard" + enum: + - "Standard" + raw_data_schema: + type: "string" + description: "The schema to write raw tables into" + title: "Destinations V2 Raw Table Schema" + order: 9 + group: "connection" + enable_incremental_final_table_updates: + type: "boolean" + default: false + description: "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" + title: "Enable Loading Data Incrementally to Final Tables" + order: 10 + group: "connection" + disable_type_dedupe: + type: "boolean" + default: false + description: "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" + title: "Disable Final Tables. (WARNING! Unstable option; Columns in raw\ + \ table schema might change between versions)" + order: 11 + group: "connection" + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + groups: + - id: "connection" + title: "Connection" + destination-dynamodb: + title: "DynamoDB Destination Spec" + type: "object" + required: + - "dynamodb_table_name_prefix" + - "dynamodb_region" + - "access_key_id" + - "secret_access_key" + - "destinationType" + properties: + dynamodb_endpoint: + title: "Endpoint" + type: "string" + default: "" + description: "This is your DynamoDB endpoint url.(if you are working with\ + \ AWS DynamoDB, just leave empty)." + examples: + - "http://localhost:9000" + dynamodb_table_name_prefix: + title: "Table name prefix" + type: "string" + description: "The prefix to use when naming DynamoDB tables." + examples: + - "airbyte_sync" + dynamodb_region: + title: "DynamoDB Region" + type: "string" + default: "" + description: "The region of the DynamoDB." + enum: + - "" + - "af-south-1" + - "ap-east-1" + - "ap-northeast-1" + - "ap-northeast-2" + - "ap-northeast-3" + - "ap-south-1" + - "ap-south-2" + - "ap-southeast-1" + - "ap-southeast-2" + - "ap-southeast-3" + - "ap-southeast-4" + - "ca-central-1" + - "ca-west-1" + - "cn-north-1" + - "cn-northwest-1" + - "eu-central-1" + - "eu-central-2" + - "eu-north-1" + - "eu-south-1" + - "eu-south-2" + - "eu-west-1" + - "eu-west-2" + - "eu-west-3" + - "il-central-1" + - "me-central-1" + - "me-south-1" + - "sa-east-1" + - "us-east-1" + - "us-east-2" + - "us-gov-east-1" + - "us-gov-west-1" + - "us-west-1" + - "us-west-2" + access_key_id: + type: "string" + description: "The access key id to access the DynamoDB. Airbyte requires\ + \ Read and Write permissions to the DynamoDB." + title: "DynamoDB Key Id" + airbyte_secret: true + examples: + - "A012345678910EXAMPLE" + x-speakeasy-param-sensitive: true + secret_access_key: + type: "string" + description: "The corresponding secret to the access key id." + title: "DynamoDB Access Key" + airbyte_secret: true + examples: + - "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY" + x-speakeasy-param-sensitive: true + destinationType: + title: "dynamodb" + const: "dynamodb" + enum: + - "dynamodb" + order: 0 + type: "string" + destination-dynamodb-update: + title: "DynamoDB Destination Spec" + type: "object" + required: + - "dynamodb_table_name_prefix" + - "dynamodb_region" + - "access_key_id" + - "secret_access_key" + properties: + dynamodb_endpoint: + title: "Endpoint" + type: "string" + default: "" + description: "This is your DynamoDB endpoint url.(if you are working with\ + \ AWS DynamoDB, just leave empty)." + examples: + - "http://localhost:9000" + dynamodb_table_name_prefix: + title: "Table name prefix" + type: "string" + description: "The prefix to use when naming DynamoDB tables." + examples: + - "airbyte_sync" + dynamodb_region: + title: "DynamoDB Region" + type: "string" + default: "" + description: "The region of the DynamoDB." + enum: + - "" + - "af-south-1" + - "ap-east-1" + - "ap-northeast-1" + - "ap-northeast-2" + - "ap-northeast-3" + - "ap-south-1" + - "ap-south-2" + - "ap-southeast-1" + - "ap-southeast-2" + - "ap-southeast-3" + - "ap-southeast-4" + - "ca-central-1" + - "ca-west-1" + - "cn-north-1" + - "cn-northwest-1" + - "eu-central-1" + - "eu-central-2" + - "eu-north-1" + - "eu-south-1" + - "eu-south-2" + - "eu-west-1" + - "eu-west-2" + - "eu-west-3" + - "il-central-1" + - "me-central-1" + - "me-south-1" + - "sa-east-1" + - "us-east-1" + - "us-east-2" + - "us-gov-east-1" + - "us-gov-west-1" + - "us-west-1" + - "us-west-2" + access_key_id: + type: "string" + description: "The access key id to access the DynamoDB. Airbyte requires\ + \ Read and Write permissions to the DynamoDB." + title: "DynamoDB Key Id" + airbyte_secret: true + examples: + - "A012345678910EXAMPLE" + secret_access_key: + type: "string" + description: "The corresponding secret to the access key id." + title: "DynamoDB Access Key" + airbyte_secret: true + examples: + - "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY" + destination-qdrant: + title: "Destination Config" + description: "The configuration model for the Vector DB based destinations.\ + \ This model is used to generate the UI for the destination configuration,\n\ + as well as to provide type safety for the configuration passed to the destination.\n\ + \nThe configuration model is composed of four parts:\n* Processing configuration\n\ + * Embedding configuration\n* Indexing configuration\n* Advanced configuration\n\ + \nProcessing, embedding and advanced configuration are provided by this base\ + \ class, while the indexing configuration is provided by the destination connector\ + \ in the sub class." + type: "object" + properties: + embedding: + title: "Embedding" + description: "Embedding configuration" + group: "embedding" + type: "object" + oneOf: + - title: "OpenAI" + type: "object" + properties: + mode: + title: "Mode" + default: "openai" + const: "openai" + enum: + - "openai" + type: "string" + openai_key: + title: "OpenAI API key" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + required: + - "openai_key" + - "mode" + description: "Use the OpenAI API to embed text. This option is using the\ + \ text-embedding-ada-002 model with 1536 embedding dimensions." + - title: "Cohere" + type: "object" + properties: + mode: + title: "Mode" + default: "cohere" + const: "cohere" + enum: + - "cohere" + type: "string" + cohere_key: + title: "Cohere API key" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + required: + - "cohere_key" + - "mode" + description: "Use the Cohere API to embed text." + - title: "Fake" + type: "object" + properties: + mode: + title: "Mode" + default: "fake" + const: "fake" + enum: + - "fake" + type: "string" + description: "Use a fake embedding made out of random vectors with 1536\ + \ embedding dimensions. This is useful for testing the data pipeline\ + \ without incurring any costs." + required: + - "mode" + - title: "Azure OpenAI" + type: "object" + properties: + mode: + title: "Mode" + default: "azure_openai" + const: "azure_openai" + enum: + - "azure_openai" + type: "string" + openai_key: + title: "Azure OpenAI API key" + description: "The API key for your Azure OpenAI resource. You can\ + \ find this in the Azure portal under your Azure OpenAI resource" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + api_base: + title: "Resource base URL" + description: "The base URL for your Azure OpenAI resource. You can\ + \ find this in the Azure portal under your Azure OpenAI resource" + examples: + - "https://your-resource-name.openai.azure.com" + type: "string" + deployment: + title: "Deployment" + description: "The deployment for your Azure OpenAI resource. You\ + \ can find this in the Azure portal under your Azure OpenAI resource" + examples: + - "your-resource-name" + type: "string" + required: + - "openai_key" + - "api_base" + - "deployment" + - "mode" + description: "Use the Azure-hosted OpenAI API to embed text. This option\ + \ is using the text-embedding-ada-002 model with 1536 embedding dimensions." + - title: "OpenAI-compatible" + type: "object" + properties: + mode: + title: "Mode" + default: "openai_compatible" + const: "openai_compatible" + enum: + - "openai_compatible" + type: "string" + api_key: + title: "API key" + default: "" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + base_url: + title: "Base URL" + description: "The base URL for your OpenAI-compatible service" + examples: + - "https://your-service-name.com" + type: "string" + model_name: + title: "Model name" + description: "The name of the model to use for embedding" + default: "text-embedding-ada-002" + examples: + - "text-embedding-ada-002" + type: "string" + dimensions: + title: "Embedding dimensions" + description: "The number of dimensions the embedding model is generating" + examples: + - 1536 + - 384 + type: "integer" + required: + - "base_url" + - "dimensions" + - "mode" + description: "Use a service that's compatible with the OpenAI API to embed\ + \ text." + processing: + title: "ProcessingConfigModel" + type: "object" + properties: + chunk_size: + title: "Chunk size" + description: "Size of chunks in tokens to store in vector store (make\ + \ sure it is not too big for the context if your LLM)" + maximum: 8191 + minimum: 1 + type: "integer" + chunk_overlap: + title: "Chunk overlap" + description: "Size of overlap between chunks in tokens to store in vector\ + \ store to better capture relevant context" + default: 0 + type: "integer" + text_fields: + title: "Text fields to embed" + description: "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." + default: [] + always_show: true + examples: + - "text" + - "user.name" + - "users.*.name" + type: "array" + items: + type: "string" + metadata_fields: + title: "Fields to store as metadata" + description: "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." + default: [] + always_show: true + examples: + - "age" + - "user" + - "user.name" + type: "array" + items: + type: "string" + text_splitter: + title: "Text splitter" + description: "Split text fields into chunks based on the specified method." + type: "object" + oneOf: + - title: "By Separator" + type: "object" + properties: + mode: + title: "Mode" + default: "separator" + const: "separator" + enum: + - "separator" + type: "string" + separators: + title: "Separators" + description: "List of separator strings to split text fields by.\ + \ The separator itself needs to be wrapped in double quotes,\ + \ e.g. to split by the dot character, use \".\". To split by\ + \ a newline, use \"\\n\"." + default: + - "\"\\n\\n\"" + - "\"\\n\"" + - "\" \"" + - "\"\"" + type: "array" + items: + type: "string" + keep_separator: + title: "Keep separator" + description: "Whether to keep the separator in the resulting chunks" + default: false + type: "boolean" + description: "Split the text by the list of separators until the chunk\ + \ size is reached, using the earlier mentioned separators where\ + \ possible. This is useful for splitting text fields by paragraphs,\ + \ sentences, words, etc." + required: + - "mode" + - title: "By Markdown header" + type: "object" + properties: + mode: + title: "Mode" + default: "markdown" + const: "markdown" + enum: + - "markdown" + type: "string" + split_level: + title: "Split level" + description: "Level of markdown headers to split text fields by.\ + \ Headings down to the specified level will be used as split\ + \ points" + default: 1 + minimum: 1 + maximum: 6 + type: "integer" + description: "Split the text by Markdown headers down to the specified\ + \ header level. If the chunk size fits multiple sections, they will\ + \ be combined into a single chunk." + required: + - "mode" + - title: "By Programming Language" + type: "object" + properties: + mode: + title: "Mode" + default: "code" + const: "code" + enum: + - "code" + type: "string" + language: + title: "Language" + description: "Split code in suitable places based on the programming\ + \ language" + enum: + - "cpp" + - "go" + - "java" + - "js" + - "php" + - "proto" + - "python" + - "rst" + - "ruby" + - "rust" + - "scala" + - "swift" + - "markdown" + - "latex" + - "html" + - "sol" + type: "string" + required: + - "language" + - "mode" + description: "Split the text by suitable delimiters based on the programming\ + \ language. This is useful for splitting code into chunks." + field_name_mappings: + title: "Field name mappings" + description: "List of fields to rename. Not applicable for nested fields,\ + \ but can be used to rename fields already flattened via dot notation." + default: [] + type: "array" + items: + title: "FieldNameMappingConfigModel" + type: "object" + properties: + from_field: + title: "From field name" + description: "The field name in the source" + type: "string" + to_field: + title: "To field name" + description: "The field name to use in the destination" + type: "string" + required: + - "from_field" + - "to_field" + required: + - "chunk_size" + group: "processing" + omit_raw_text: + title: "Do not store raw text" + description: "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." + default: false + group: "advanced" + type: "boolean" + indexing: + title: "Indexing" + type: "object" + properties: + url: + title: "Public Endpoint" + description: "Public Endpoint of the Qdrant cluser" + order: 0 + type: "string" + auth_method: + title: "Authentication Method" + description: "Method to authenticate with the Qdrant Instance" + default: "api_key_auth" + type: "object" + order: 1 + oneOf: + - title: "ApiKeyAuth" + type: "object" + properties: + mode: + title: "Mode" + default: "api_key_auth" + const: "api_key_auth" + enum: + - "api_key_auth" + type: "string" + api_key: + title: "API Key" + description: "API Key for the Qdrant instance" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + required: + - "api_key" + - title: "NoAuth" + type: "object" + properties: + mode: + title: "Mode" + default: "no_auth" + const: "no_auth" + enum: + - "no_auth" + type: "string" + prefer_grpc: + title: "Prefer gRPC" + description: "Whether to prefer gRPC over HTTP. Set to true for Qdrant\ + \ cloud clusters" + default: true + type: "boolean" + collection: + title: "Collection Name" + description: "The collection to load data into" + order: 2 + type: "string" + distance_metric: + title: "Distance Metric" + description: "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." + default: "cos" + enum: + - "dot" + - "cos" + - "euc" + type: "string" + text_field: + title: "Text Field" + description: "The field in the payload that contains the embedded text" + default: "text" + type: "string" + required: + - "url" + - "collection" + group: "Indexing" + description: "Indexing configuration" + destinationType: + title: "qdrant" + const: "qdrant" + enum: + - "qdrant" + order: 0 + type: "string" + required: + - "embedding" + - "processing" + - "indexing" + - "destinationType" + groups: + - id: "processing" + title: "Processing" + - id: "embedding" + title: "Embedding" + - id: "indexing" + title: "Indexing" + - id: "advanced" + title: "Advanced" + destination-qdrant-update: + title: "Destination Config" + description: "The configuration model for the Vector DB based destinations.\ + \ This model is used to generate the UI for the destination configuration,\n\ + as well as to provide type safety for the configuration passed to the destination.\n\ + \nThe configuration model is composed of four parts:\n* Processing configuration\n\ + * Embedding configuration\n* Indexing configuration\n* Advanced configuration\n\ + \nProcessing, embedding and advanced configuration are provided by this base\ + \ class, while the indexing configuration is provided by the destination connector\ + \ in the sub class." + type: "object" + properties: + embedding: + title: "Embedding" + description: "Embedding configuration" + group: "embedding" + type: "object" + oneOf: + - title: "OpenAI" + type: "object" + properties: + mode: + title: "Mode" + default: "openai" + const: "openai" + enum: + - "openai" + type: "string" + openai_key: + title: "OpenAI API key" + airbyte_secret: true + type: "string" + required: + - "openai_key" + - "mode" + description: "Use the OpenAI API to embed text. This option is using the\ + \ text-embedding-ada-002 model with 1536 embedding dimensions." + - title: "Cohere" + type: "object" + properties: + mode: + title: "Mode" + default: "cohere" + const: "cohere" + enum: + - "cohere" + type: "string" + cohere_key: + title: "Cohere API key" + airbyte_secret: true + type: "string" + required: + - "cohere_key" + - "mode" + description: "Use the Cohere API to embed text." + - title: "Fake" + type: "object" + properties: + mode: + title: "Mode" + default: "fake" + const: "fake" + enum: + - "fake" + type: "string" + description: "Use a fake embedding made out of random vectors with 1536\ + \ embedding dimensions. This is useful for testing the data pipeline\ + \ without incurring any costs." + required: + - "mode" + - title: "Azure OpenAI" + type: "object" + properties: + mode: + title: "Mode" + default: "azure_openai" + const: "azure_openai" + enum: + - "azure_openai" + type: "string" + openai_key: + title: "Azure OpenAI API key" + description: "The API key for your Azure OpenAI resource. You can\ + \ find this in the Azure portal under your Azure OpenAI resource" + airbyte_secret: true + type: "string" + api_base: + title: "Resource base URL" + description: "The base URL for your Azure OpenAI resource. You can\ + \ find this in the Azure portal under your Azure OpenAI resource" + examples: + - "https://your-resource-name.openai.azure.com" + type: "string" + deployment: + title: "Deployment" + description: "The deployment for your Azure OpenAI resource. You\ + \ can find this in the Azure portal under your Azure OpenAI resource" + examples: + - "your-resource-name" + type: "string" + required: + - "openai_key" + - "api_base" + - "deployment" + - "mode" + description: "Use the Azure-hosted OpenAI API to embed text. This option\ + \ is using the text-embedding-ada-002 model with 1536 embedding dimensions." + - title: "OpenAI-compatible" + type: "object" + properties: + mode: + title: "Mode" + default: "openai_compatible" + const: "openai_compatible" + enum: + - "openai_compatible" + type: "string" + api_key: + title: "API key" + default: "" + airbyte_secret: true + type: "string" + base_url: + title: "Base URL" + description: "The base URL for your OpenAI-compatible service" + examples: + - "https://your-service-name.com" + type: "string" + model_name: + title: "Model name" + description: "The name of the model to use for embedding" + default: "text-embedding-ada-002" + examples: + - "text-embedding-ada-002" + type: "string" + dimensions: + title: "Embedding dimensions" + description: "The number of dimensions the embedding model is generating" + examples: + - 1536 + - 384 + type: "integer" + required: + - "base_url" + - "dimensions" + - "mode" + description: "Use a service that's compatible with the OpenAI API to embed\ + \ text." + processing: + title: "ProcessingConfigModel" + type: "object" + properties: + chunk_size: + title: "Chunk size" + description: "Size of chunks in tokens to store in vector store (make\ + \ sure it is not too big for the context if your LLM)" + maximum: 8191 + minimum: 1 + type: "integer" + chunk_overlap: + title: "Chunk overlap" + description: "Size of overlap between chunks in tokens to store in vector\ + \ store to better capture relevant context" + default: 0 + type: "integer" + text_fields: + title: "Text fields to embed" + description: "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." + default: [] + always_show: true + examples: + - "text" + - "user.name" + - "users.*.name" + type: "array" + items: + type: "string" + metadata_fields: + title: "Fields to store as metadata" + description: "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." + default: [] + always_show: true + examples: + - "age" + - "user" + - "user.name" + type: "array" + items: + type: "string" + text_splitter: + title: "Text splitter" + description: "Split text fields into chunks based on the specified method." + type: "object" + oneOf: + - title: "By Separator" + type: "object" + properties: + mode: + title: "Mode" + default: "separator" + const: "separator" + enum: + - "separator" + type: "string" + separators: + title: "Separators" + description: "List of separator strings to split text fields by.\ + \ The separator itself needs to be wrapped in double quotes,\ + \ e.g. to split by the dot character, use \".\". To split by\ + \ a newline, use \"\\n\"." + default: + - "\"\\n\\n\"" + - "\"\\n\"" + - "\" \"" + - "\"\"" + type: "array" + items: + type: "string" + keep_separator: + title: "Keep separator" + description: "Whether to keep the separator in the resulting chunks" + default: false + type: "boolean" + description: "Split the text by the list of separators until the chunk\ + \ size is reached, using the earlier mentioned separators where\ + \ possible. This is useful for splitting text fields by paragraphs,\ + \ sentences, words, etc." + required: + - "mode" + - title: "By Markdown header" + type: "object" + properties: + mode: + title: "Mode" + default: "markdown" + const: "markdown" + enum: + - "markdown" + type: "string" + split_level: + title: "Split level" + description: "Level of markdown headers to split text fields by.\ + \ Headings down to the specified level will be used as split\ + \ points" + default: 1 + minimum: 1 + maximum: 6 + type: "integer" + description: "Split the text by Markdown headers down to the specified\ + \ header level. If the chunk size fits multiple sections, they will\ + \ be combined into a single chunk." + required: + - "mode" + - title: "By Programming Language" + type: "object" + properties: + mode: + title: "Mode" + default: "code" + const: "code" + enum: + - "code" + type: "string" + language: + title: "Language" + description: "Split code in suitable places based on the programming\ + \ language" + enum: + - "cpp" + - "go" + - "java" + - "js" + - "php" + - "proto" + - "python" + - "rst" + - "ruby" + - "rust" + - "scala" + - "swift" + - "markdown" + - "latex" + - "html" + - "sol" + type: "string" + required: + - "language" + - "mode" + description: "Split the text by suitable delimiters based on the programming\ + \ language. This is useful for splitting code into chunks." + field_name_mappings: + title: "Field name mappings" + description: "List of fields to rename. Not applicable for nested fields,\ + \ but can be used to rename fields already flattened via dot notation." + default: [] + type: "array" + items: + title: "FieldNameMappingConfigModel" + type: "object" + properties: + from_field: + title: "From field name" + description: "The field name in the source" + type: "string" + to_field: + title: "To field name" + description: "The field name to use in the destination" + type: "string" + required: + - "from_field" + - "to_field" + required: + - "chunk_size" + group: "processing" + omit_raw_text: + title: "Do not store raw text" + description: "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." + default: false + group: "advanced" + type: "boolean" + indexing: + title: "Indexing" + type: "object" + properties: + url: + title: "Public Endpoint" + description: "Public Endpoint of the Qdrant cluser" + order: 0 + type: "string" + auth_method: + title: "Authentication Method" + description: "Method to authenticate with the Qdrant Instance" + default: "api_key_auth" + type: "object" + order: 1 + oneOf: + - title: "ApiKeyAuth" + type: "object" + properties: + mode: + title: "Mode" + default: "api_key_auth" + const: "api_key_auth" + enum: + - "api_key_auth" + type: "string" + api_key: + title: "API Key" + description: "API Key for the Qdrant instance" + airbyte_secret: true + type: "string" + required: + - "api_key" + - title: "NoAuth" + type: "object" + properties: + mode: + title: "Mode" + default: "no_auth" + const: "no_auth" + enum: + - "no_auth" + type: "string" + prefer_grpc: + title: "Prefer gRPC" + description: "Whether to prefer gRPC over HTTP. Set to true for Qdrant\ + \ cloud clusters" + default: true + type: "boolean" + collection: + title: "Collection Name" + description: "The collection to load data into" + order: 2 + type: "string" + distance_metric: + title: "Distance Metric" + description: "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." + default: "cos" + enum: + - "dot" + - "cos" + - "euc" + type: "string" + text_field: + title: "Text Field" + description: "The field in the payload that contains the embedded text" + default: "text" + type: "string" + required: + - "url" + - "collection" + group: "Indexing" + description: "Indexing configuration" + required: + - "embedding" + - "processing" + - "indexing" + groups: + - id: "processing" + title: "Processing" + - id: "embedding" + title: "Embedding" + - id: "indexing" + title: "Indexing" + - id: "advanced" + title: "Advanced" + destination-snowflake: + title: "Snowflake Destination Spec" + type: "object" + required: + - "host" + - "role" + - "warehouse" + - "database" + - "schema" + - "username" + - "destinationType" + properties: + host: + description: "Enter your Snowflake account's locator (in the format ...snowflakecomputing.com)" + examples: + - "accountname.us-east-2.aws.snowflakecomputing.com" + - "accountname.snowflakecomputing.com" + type: "string" + title: "Host" + pattern: "^(http(s)?:\\/\\/)?([^./?#]+\\.)?([^./?#]+\\.)?([^./?#]+\\.)?([^./?#]+\\\ + .snowflakecomputing\\.com)$" + pattern_descriptor: "{account_name}.snowflakecomputing.com or {accountname}.{aws_location}.aws.snowflakecomputing.com" + order: 0 + role: + description: "Enter the role that you want to use to access Snowflake" + examples: + - "AIRBYTE_ROLE" + type: "string" + title: "Role" + order: 1 + warehouse: + description: "Enter the name of the warehouse that you want to sync data into" + examples: + - "AIRBYTE_WAREHOUSE" + type: "string" + title: "Warehouse" + order: 2 + database: + description: "Enter the name of the database you want to sync data into" + examples: + - "AIRBYTE_DATABASE" + type: "string" + title: "Database" + order: 3 + schema: + description: "Enter the name of the default schema" + examples: + - "AIRBYTE_SCHEMA" + type: "string" + title: "Default Schema" + order: 4 + username: + description: "Enter the name of the user you want to use to access the database" + examples: + - "AIRBYTE_USER" + type: "string" + title: "Username" + order: 5 + credentials: + title: "Authorization Method" + description: "" + type: "object" + oneOf: + - title: "Key Pair Authentication" + type: "object" + order: 0 + required: + - "private_key" + properties: + auth_type: + type: "string" + const: "Key Pair Authentication" + enum: + - "Key Pair Authentication" + default: "Key Pair Authentication" + order: 0 + private_key: + type: "string" + title: "Private Key" + description: "RSA Private key to use for Snowflake connection. See\ + \ the docs for more information on how to obtain this key." + multiline: true + airbyte_secret: true + x-speakeasy-param-sensitive: true + private_key_password: + type: "string" + title: "Passphrase" + description: "Passphrase for private key" + airbyte_secret: true + x-speakeasy-param-sensitive: true + - title: "Username and Password" + type: "object" + required: + - "password" + order: 1 + properties: + auth_type: + type: "string" + const: "Username and Password" + enum: + - "Username and Password" + default: "Username and Password" + order: 0 + password: + description: "Enter the password associated with the username." + type: "string" + airbyte_secret: true + title: "Password" + order: 1 + x-speakeasy-param-sensitive: true + - title: "OAuth2.0" + type: "object" + order: 2 + required: + - "access_token" + - "refresh_token" + airbyte_hidden: true + properties: + auth_type: + type: "string" + const: "OAuth2.0" + enum: + - "OAuth2.0" + default: "OAuth2.0" + order: 0 + client_id: + type: "string" + title: "Client ID" + description: "Enter your application's Client ID" + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "Enter your application's Client secret" + airbyte_secret: true + access_token: + type: "string" + title: "Access Token" + description: "Enter you application's Access Token" + airbyte_secret: true + x-speakeasy-param-sensitive: true + refresh_token: + type: "string" + title: "Refresh Token" + description: "Enter your application's Refresh Token" + airbyte_secret: true + x-speakeasy-param-sensitive: true + order: 6 + jdbc_url_params: + description: "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" + title: "JDBC URL Params" + type: "string" + order: 7 + raw_data_schema: + type: "string" + description: "The schema to write raw tables into (default: airbyte_internal)" + title: "Raw Table Schema Name" + order: 10 + disable_type_dedupe: + type: "boolean" + default: false + description: "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" + title: "Disable Final Tables. (WARNING! Unstable option; Columns in raw\ + \ table schema might change between versions)" + order: 11 + enable_incremental_final_table_updates: + type: "boolean" + default: false + description: "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" + title: "Enable Loading Data Incrementally to Final Tables" + order: 12 + retention_period_days: + type: "integer" + default: 1 + description: "The number of days of Snowflake Time Travel to enable on the\ + \ tables. See Snowflake's documentation for more information. Setting a nonzero\ + \ value will incur increased storage costs in your Snowflake instance." + title: "Data Retention Period (days)" + order: 13 + destinationType: + title: "snowflake" + const: "snowflake" + enum: + - "snowflake" + order: 0 + type: "string" + destination-snowflake-update: + title: "Snowflake Destination Spec" + type: "object" + required: + - "host" + - "role" + - "warehouse" + - "database" + - "schema" + - "username" + properties: + host: + description: "Enter your Snowflake account's locator (in the format ...snowflakecomputing.com)" + examples: + - "accountname.us-east-2.aws.snowflakecomputing.com" + - "accountname.snowflakecomputing.com" + type: "string" + title: "Host" + pattern: "^(http(s)?:\\/\\/)?([^./?#]+\\.)?([^./?#]+\\.)?([^./?#]+\\.)?([^./?#]+\\\ + .snowflakecomputing\\.com)$" + pattern_descriptor: "{account_name}.snowflakecomputing.com or {accountname}.{aws_location}.aws.snowflakecomputing.com" + order: 0 + role: + description: "Enter the role that you want to use to access Snowflake" + examples: + - "AIRBYTE_ROLE" + type: "string" + title: "Role" + order: 1 + warehouse: + description: "Enter the name of the warehouse that you want to sync data into" + examples: + - "AIRBYTE_WAREHOUSE" + type: "string" + title: "Warehouse" + order: 2 + database: + description: "Enter the name of the database you want to sync data into" + examples: + - "AIRBYTE_DATABASE" + type: "string" + title: "Database" + order: 3 + schema: + description: "Enter the name of the default schema" + examples: + - "AIRBYTE_SCHEMA" + type: "string" + title: "Default Schema" + order: 4 + username: + description: "Enter the name of the user you want to use to access the database" + examples: + - "AIRBYTE_USER" + type: "string" + title: "Username" + order: 5 + credentials: + title: "Authorization Method" + description: "" + type: "object" + oneOf: + - title: "Key Pair Authentication" + type: "object" + order: 0 + required: + - "private_key" + properties: + auth_type: + type: "string" + const: "Key Pair Authentication" + enum: + - "Key Pair Authentication" + default: "Key Pair Authentication" + order: 0 + private_key: + type: "string" + title: "Private Key" + description: "RSA Private key to use for Snowflake connection. See\ + \ the docs for more information on how to obtain this key." + multiline: true + airbyte_secret: true + private_key_password: + type: "string" + title: "Passphrase" + description: "Passphrase for private key" + airbyte_secret: true + - title: "Username and Password" + type: "object" + required: + - "password" + order: 1 + properties: + auth_type: + type: "string" + const: "Username and Password" + enum: + - "Username and Password" + default: "Username and Password" + order: 0 + password: + description: "Enter the password associated with the username." + type: "string" + airbyte_secret: true + title: "Password" + order: 1 + - title: "OAuth2.0" + type: "object" + order: 2 + required: + - "access_token" + - "refresh_token" + airbyte_hidden: true + properties: + auth_type: + type: "string" + const: "OAuth2.0" + enum: + - "OAuth2.0" + default: "OAuth2.0" + order: 0 + client_id: + type: "string" + title: "Client ID" + description: "Enter your application's Client ID" + airbyte_secret: true + client_secret: + type: "string" + title: "Client Secret" + description: "Enter your application's Client secret" + airbyte_secret: true + access_token: + type: "string" + title: "Access Token" + description: "Enter you application's Access Token" + airbyte_secret: true + refresh_token: + type: "string" + title: "Refresh Token" + description: "Enter your application's Refresh Token" + airbyte_secret: true + order: 6 + jdbc_url_params: + description: "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" + title: "JDBC URL Params" + type: "string" + order: 7 + raw_data_schema: + type: "string" + description: "The schema to write raw tables into (default: airbyte_internal)" + title: "Raw Table Schema Name" + order: 10 + disable_type_dedupe: + type: "boolean" + default: false + description: "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" + title: "Disable Final Tables. (WARNING! Unstable option; Columns in raw\ + \ table schema might change between versions)" + order: 11 + enable_incremental_final_table_updates: + type: "boolean" + default: false + description: "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" + title: "Enable Loading Data Incrementally to Final Tables" + order: 12 + retention_period_days: + type: "integer" + default: 1 + description: "The number of days of Snowflake Time Travel to enable on the\ + \ tables. See Snowflake's documentation for more information. Setting a nonzero\ + \ value will incur increased storage costs in your Snowflake instance." + title: "Data Retention Period (days)" + order: 13 + destination-databricks: + title: "Databricks Lakehouse Destination Spec" + type: "object" + required: + - "accept_terms" + - "databricks_server_hostname" + - "databricks_http_path" + - "databricks_personal_access_token" + - "data_source" + - "destinationType" + properties: + accept_terms: + title: "Agree to the Databricks JDBC Driver Terms & Conditions" + type: "boolean" + description: "You must agree to the Databricks JDBC Driver Terms & Conditions to use this connector." + default: false + order: 1 + databricks_server_hostname: + title: "Server Hostname" + type: "string" + description: "Databricks Cluster Server Hostname." + examples: + - "abc-12345678-wxyz.cloud.databricks.com" + order: 2 + databricks_http_path: + title: "HTTP Path" + type: "string" + description: "Databricks Cluster HTTP Path." + examples: + - "sql/protocolvx/o/1234567489/0000-1111111-abcd90" + order: 3 + databricks_port: + title: "Port" + type: "string" + description: "Databricks Cluster Port." + default: "443" + examples: + - "443" + order: 4 + databricks_personal_access_token: + title: "Access Token" + type: "string" + description: "Databricks Personal Access Token for making authenticated\ + \ requests." + examples: + - "dapi0123456789abcdefghij0123456789AB" + airbyte_secret: true + order: 5 + x-speakeasy-param-sensitive: true + database: + title: "Databricks catalog" + description: "The name of the catalog. If not specified otherwise, the \"\ + hive_metastore\" will be used." + type: "string" + order: 6 + schema: + title: "Default Schema" + description: "The default schema tables are written. If not specified otherwise,\ + \ the \"default\" will be used." + type: "string" + examples: + - "default" + default: "default" + order: 7 + enable_schema_evolution: + title: "Support schema evolution for all streams." + type: "boolean" + description: "Support schema evolution for all streams. If \"false\", the\ + \ connector might fail when a stream's schema changes." + default: false + order: 8 + data_source: + title: "Data Source" + type: "object" + description: "Storage on which the delta lake is built." + default: "MANAGED_TABLES_STORAGE" + order: 9 + oneOf: + - title: "[Recommended] Managed tables" + required: + - "data_source_type" + properties: + data_source_type: + type: "string" + const: "MANAGED_TABLES_STORAGE" + order: 0 + enum: + - "MANAGED_TABLES_STORAGE" + - title: "Amazon S3" + required: + - "data_source_type" + - "s3_bucket_name" + - "s3_bucket_path" + - "s3_bucket_region" + - "s3_access_key_id" + - "s3_secret_access_key" + properties: + data_source_type: + type: "string" + const: "S3_STORAGE" + order: 1 + enum: + - "S3_STORAGE" + s3_bucket_name: + title: "S3 Bucket Name" + type: "string" + description: "The name of the S3 bucket to use for intermittent staging\ + \ of the data." + examples: + - "airbyte.staging" + order: 2 + s3_bucket_path: + title: "S3 Bucket Path" + type: "string" + description: "The directory under the S3 bucket where data will be\ + \ written." + examples: + - "data_sync/test" + order: 3 + s3_bucket_region: + title: "S3 Bucket Region" + type: "string" + default: "" + description: "The region of the S3 staging bucket to use if utilising\ + \ a copy strategy." + enum: + - "" + - "us-east-1" + - "us-east-2" + - "us-west-1" + - "us-west-2" + - "af-south-1" + - "ap-east-1" + - "ap-south-1" + - "ap-northeast-1" + - "ap-northeast-2" + - "ap-northeast-3" + - "ap-southeast-1" + - "ap-southeast-2" + - "ca-central-1" + - "cn-north-1" + - "cn-northwest-1" + - "eu-central-1" + - "eu-north-1" + - "eu-south-1" + - "eu-west-1" + - "eu-west-2" + - "eu-west-3" + - "sa-east-1" + - "me-south-1" + - "us-gov-east-1" + - "us-gov-west-1" + order: 4 + s3_access_key_id: + type: "string" + description: "The Access Key Id granting allow one to access the above\ + \ S3 staging bucket. Airbyte requires Read and Write permissions\ + \ to the given bucket." + title: "S3 Access Key ID" + examples: + - "A012345678910EXAMPLE" + airbyte_secret: true + order: 5 + x-speakeasy-param-sensitive: true + s3_secret_access_key: + title: "S3 Secret Access Key" + type: "string" + description: "The corresponding secret to the above access key id." + examples: + - "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY" + airbyte_secret: true + order: 6 + x-speakeasy-param-sensitive: true + file_name_pattern: + type: "string" + description: "The pattern allows you to set the file-name format for\ + \ the S3 staging file(s)" + title: "S3 Filename pattern" + examples: + - "{date}" + - "{date:yyyy_MM}" + - "{timestamp}" + - "{part_number}" + - "{sync_id}" + order: 7 + - title: "Azure Blob Storage" + required: + - "data_source_type" + - "azure_blob_storage_account_name" + - "azure_blob_storage_container_name" + - "azure_blob_storage_sas_token" + properties: + data_source_type: + type: "string" + const: "AZURE_BLOB_STORAGE" + order: 0 + enum: + - "AZURE_BLOB_STORAGE" + azure_blob_storage_endpoint_domain_name: + title: "Endpoint Domain Name" + type: "string" + default: "blob.core.windows.net" + description: "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." + examples: + - "blob.core.windows.net" + order: 1 + azure_blob_storage_account_name: + title: "Azure Blob Storage Account Name" + type: "string" + description: "The account's name of the Azure Blob Storage." + examples: + - "airbyte5storage" + order: 2 + azure_blob_storage_container_name: + title: "Azure Blob Storage Container Name" + type: "string" + description: "The name of the Azure blob storage container." + examples: + - "airbytetestcontainername" + order: 3 + azure_blob_storage_sas_token: + title: "SAS Token" + type: "string" + airbyte_secret: true + description: "Shared access signature (SAS) token to grant limited\ + \ access to objects in your storage account." + examples: + - "?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" + order: 4 + x-speakeasy-param-sensitive: true + purge_staging_data: + title: "Purge Staging Files and Tables" + type: "boolean" + description: "Default to 'true'. Switch it to 'false' for debugging purpose." + default: true + order: 10 + destinationType: + title: "databricks" + const: "databricks" + enum: + - "databricks" + order: 0 + type: "string" + destination-databricks-update: + title: "Databricks Lakehouse Destination Spec" + type: "object" + required: + - "accept_terms" + - "databricks_server_hostname" + - "databricks_http_path" + - "databricks_personal_access_token" + - "data_source" + properties: + accept_terms: + title: "Agree to the Databricks JDBC Driver Terms & Conditions" + type: "boolean" + description: "You must agree to the Databricks JDBC Driver Terms & Conditions to use this connector." + default: false + order: 1 + databricks_server_hostname: + title: "Server Hostname" + type: "string" + description: "Databricks Cluster Server Hostname." + examples: + - "abc-12345678-wxyz.cloud.databricks.com" + order: 2 + databricks_http_path: + title: "HTTP Path" + type: "string" + description: "Databricks Cluster HTTP Path." + examples: + - "sql/protocolvx/o/1234567489/0000-1111111-abcd90" + order: 3 + databricks_port: + title: "Port" + type: "string" + description: "Databricks Cluster Port." + default: "443" + examples: + - "443" + order: 4 + databricks_personal_access_token: + title: "Access Token" + type: "string" + description: "Databricks Personal Access Token for making authenticated\ + \ requests." + examples: + - "dapi0123456789abcdefghij0123456789AB" + airbyte_secret: true + order: 5 + database: + title: "Databricks catalog" + description: "The name of the catalog. If not specified otherwise, the \"\ + hive_metastore\" will be used." + type: "string" + order: 6 + schema: + title: "Default Schema" + description: "The default schema tables are written. If not specified otherwise,\ + \ the \"default\" will be used." + type: "string" + examples: + - "default" + default: "default" + order: 7 + enable_schema_evolution: + title: "Support schema evolution for all streams." + type: "boolean" + description: "Support schema evolution for all streams. If \"false\", the\ + \ connector might fail when a stream's schema changes." + default: false + order: 8 + data_source: + title: "Data Source" + type: "object" + description: "Storage on which the delta lake is built." + default: "MANAGED_TABLES_STORAGE" + order: 9 + oneOf: + - title: "[Recommended] Managed tables" + required: + - "data_source_type" + properties: + data_source_type: + type: "string" + const: "MANAGED_TABLES_STORAGE" + order: 0 + enum: + - "MANAGED_TABLES_STORAGE" + - title: "Amazon S3" + required: + - "data_source_type" + - "s3_bucket_name" + - "s3_bucket_path" + - "s3_bucket_region" + - "s3_access_key_id" + - "s3_secret_access_key" + properties: + data_source_type: + type: "string" + const: "S3_STORAGE" + order: 1 + enum: + - "S3_STORAGE" + s3_bucket_name: + title: "S3 Bucket Name" + type: "string" + description: "The name of the S3 bucket to use for intermittent staging\ + \ of the data." + examples: + - "airbyte.staging" + order: 2 + s3_bucket_path: + title: "S3 Bucket Path" + type: "string" + description: "The directory under the S3 bucket where data will be\ + \ written." + examples: + - "data_sync/test" + order: 3 + s3_bucket_region: + title: "S3 Bucket Region" + type: "string" + default: "" + description: "The region of the S3 staging bucket to use if utilising\ + \ a copy strategy." + enum: + - "" + - "us-east-1" + - "us-east-2" + - "us-west-1" + - "us-west-2" + - "af-south-1" + - "ap-east-1" + - "ap-south-1" + - "ap-northeast-1" + - "ap-northeast-2" + - "ap-northeast-3" + - "ap-southeast-1" + - "ap-southeast-2" + - "ca-central-1" + - "cn-north-1" + - "cn-northwest-1" + - "eu-central-1" + - "eu-north-1" + - "eu-south-1" + - "eu-west-1" + - "eu-west-2" + - "eu-west-3" + - "sa-east-1" + - "me-south-1" + - "us-gov-east-1" + - "us-gov-west-1" + order: 4 + s3_access_key_id: + type: "string" + description: "The Access Key Id granting allow one to access the above\ + \ S3 staging bucket. Airbyte requires Read and Write permissions\ + \ to the given bucket." + title: "S3 Access Key ID" + examples: + - "A012345678910EXAMPLE" + airbyte_secret: true + order: 5 + s3_secret_access_key: + title: "S3 Secret Access Key" + type: "string" + description: "The corresponding secret to the above access key id." + examples: + - "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY" + airbyte_secret: true + order: 6 + file_name_pattern: + type: "string" + description: "The pattern allows you to set the file-name format for\ + \ the S3 staging file(s)" + title: "S3 Filename pattern" + examples: + - "{date}" + - "{date:yyyy_MM}" + - "{timestamp}" + - "{part_number}" + - "{sync_id}" + order: 7 + - title: "Azure Blob Storage" + required: + - "data_source_type" + - "azure_blob_storage_account_name" + - "azure_blob_storage_container_name" + - "azure_blob_storage_sas_token" + properties: + data_source_type: + type: "string" + const: "AZURE_BLOB_STORAGE" + order: 0 + enum: + - "AZURE_BLOB_STORAGE" + azure_blob_storage_endpoint_domain_name: + title: "Endpoint Domain Name" + type: "string" + default: "blob.core.windows.net" + description: "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." + examples: + - "blob.core.windows.net" + order: 1 + azure_blob_storage_account_name: + title: "Azure Blob Storage Account Name" + type: "string" + description: "The account's name of the Azure Blob Storage." + examples: + - "airbyte5storage" + order: 2 + azure_blob_storage_container_name: + title: "Azure Blob Storage Container Name" + type: "string" + description: "The name of the Azure blob storage container." + examples: + - "airbytetestcontainername" + order: 3 + azure_blob_storage_sas_token: + title: "SAS Token" + type: "string" + airbyte_secret: true + description: "Shared access signature (SAS) token to grant limited\ + \ access to objects in your storage account." + examples: + - "?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" + order: 4 + purge_staging_data: + title: "Purge Staging Files and Tables" + type: "boolean" + description: "Default to 'true'. Switch it to 'false' for debugging purpose." + default: true + order: 10 + destination-oracle: + title: "Oracle Destination Spec" + type: "object" + required: + - "host" + - "port" + - "username" + - "sid" + - "destinationType" + properties: + host: + title: "Host" + description: "The hostname of the database." + type: "string" + order: 0 + port: + title: "Port" + description: "The port of the database." + type: "integer" + minimum: 0 + maximum: 65536 + default: 1521 + examples: + - "1521" + order: 1 + sid: + title: "SID" + description: "The System Identifier uniquely distinguishes the instance\ + \ from any other instance on the same computer." + type: "string" + order: 2 + username: + title: "User" + description: "The username to access the database. This user must have CREATE\ + \ USER privileges in the database." + type: "string" + order: 3 + password: + title: "Password" + description: "The password associated with the username." + type: "string" + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + jdbc_url_params: + description: "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)." + title: "JDBC URL Params" + type: "string" + order: 5 + schema: + title: "Default Schema" + description: "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." + type: "string" + examples: + - "airbyte" + default: "airbyte" + order: 6 + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + x-speakeasy-param-sensitive: true + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + destinationType: + title: "oracle" + const: "oracle" + enum: + - "oracle" + order: 0 + type: "string" + destination-oracle-update: + title: "Oracle Destination Spec" + type: "object" + required: + - "host" + - "port" + - "username" + - "sid" + properties: + host: + title: "Host" + description: "The hostname of the database." + type: "string" + order: 0 + port: + title: "Port" + description: "The port of the database." + type: "integer" + minimum: 0 + maximum: 65536 + default: 1521 + examples: + - "1521" + order: 1 + sid: + title: "SID" + description: "The System Identifier uniquely distinguishes the instance\ + \ from any other instance on the same computer." + type: "string" + order: 2 + username: + title: "User" + description: "The username to access the database. This user must have CREATE\ + \ USER privileges in the database." + type: "string" + order: 3 + password: + title: "Password" + description: "The password associated with the username." + type: "string" + airbyte_secret: true + order: 4 + jdbc_url_params: + description: "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)." + title: "JDBC URL Params" + type: "string" + order: 5 + schema: + title: "Default Schema" + description: "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." + type: "string" + examples: + - "airbyte" + default: "airbyte" + order: 6 + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + destination-aws-datalake: + title: "AWS Datalake Destination Spec" + type: "object" + required: + - "credentials" + - "region" + - "bucket_name" + - "lakeformation_database_name" + - "destinationType" + properties: + aws_account_id: + type: "string" + title: "AWS Account Id" + description: "target aws account id" + examples: + - "111111111111" + order: 1 + credentials: + title: "Authentication mode" + description: "Choose How to Authenticate to AWS." + type: "object" + oneOf: + - type: "object" + title: "IAM Role" + required: + - "role_arn" + - "credentials_title" + properties: + credentials_title: + type: "string" + title: "Credentials Title" + description: "Name of the credentials" + const: "IAM Role" + enum: + - "IAM Role" + default: "IAM Role" + order: 0 + role_arn: + title: "Target Role Arn" + type: "string" + description: "Will assume this role to write data to s3" + airbyte_secret: false + - type: "object" + title: "IAM User" + required: + - "credentials_title" + - "aws_access_key_id" + - "aws_secret_access_key" + properties: + credentials_title: + type: "string" + title: "Credentials Title" + description: "Name of the credentials" + const: "IAM User" + enum: + - "IAM User" + default: "IAM User" + order: 0 + aws_access_key_id: + title: "Access Key Id" + type: "string" + description: "AWS User Access Key Id" + airbyte_secret: true + x-speakeasy-param-sensitive: true + aws_secret_access_key: + title: "Secret Access Key" + type: "string" + description: "Secret Access Key" + airbyte_secret: true + x-speakeasy-param-sensitive: true + order: 2 + region: + title: "S3 Bucket Region" + type: "string" + default: "" + description: "The region of the S3 bucket. See here for all region codes." + enum: + - "" + - "af-south-1" + - "ap-east-1" + - "ap-northeast-1" + - "ap-northeast-2" + - "ap-northeast-3" + - "ap-south-1" + - "ap-south-2" + - "ap-southeast-1" + - "ap-southeast-2" + - "ap-southeast-3" + - "ap-southeast-4" + - "ca-central-1" + - "ca-west-1" + - "cn-north-1" + - "cn-northwest-1" + - "eu-central-1" + - "eu-central-2" + - "eu-north-1" + - "eu-south-1" + - "eu-south-2" + - "eu-west-1" + - "eu-west-2" + - "eu-west-3" + - "il-central-1" + - "me-central-1" + - "me-south-1" + - "sa-east-1" + - "us-east-1" + - "us-east-2" + - "us-gov-east-1" + - "us-gov-west-1" + - "us-west-1" + - "us-west-2" + order: 3 + bucket_name: + title: "S3 Bucket Name" + type: "string" + description: "The name of the S3 bucket. Read more here." + order: 4 + bucket_prefix: + title: "Target S3 Bucket Prefix" + type: "string" + description: "S3 prefix" + order: 5 + lakeformation_database_name: + title: "Lake Formation Database Name" + type: "string" + description: "The default database this destination will use to create tables\ + \ in per stream. Can be changed per connection by customizing the namespace." + order: 6 + lakeformation_database_default_tag_key: + title: "Lake Formation Database Tag Key" + description: "Add a default tag key to databases created by this destination" + examples: + - "pii_level" + type: "string" + order: 7 + x-speakeasy-param-sensitive: true + lakeformation_database_default_tag_values: + title: "Lake Formation Database Tag Values" + description: "Add default values for the `Tag Key` to databases created\ + \ by this destination. Comma separate for multiple values." + examples: + - "private,public" + type: "string" + order: 8 + lakeformation_governed_tables: + title: "Lake Formation Governed Tables" + description: "Whether to create tables as LF governed tables." + type: "boolean" + default: false + order: 9 + format: + title: "Output Format *" + type: "object" + description: "Format of the data output." + oneOf: + - title: "JSON Lines: Newline-delimited JSON" + required: + - "format_type" + properties: + format_type: + title: "Format Type *" + type: "string" + enum: + - "JSONL" + default: "JSONL" + compression_codec: + title: "Compression Codec (Optional)" + description: "The compression algorithm used to compress data." + type: "string" + enum: + - "UNCOMPRESSED" + - "GZIP" + default: "UNCOMPRESSED" + - title: "Parquet: Columnar Storage" + required: + - "format_type" + properties: + format_type: + title: "Format Type *" + type: "string" + enum: + - "Parquet" + default: "Parquet" + compression_codec: + title: "Compression Codec (Optional)" + description: "The compression algorithm used to compress data." + type: "string" + enum: + - "UNCOMPRESSED" + - "SNAPPY" + - "GZIP" + - "ZSTD" + default: "SNAPPY" + order: 10 + partitioning: + title: "Choose how to partition data" + description: "Partition data by cursor fields when a cursor field is a date" + type: "string" + enum: + - "NO PARTITIONING" + - "DATE" + - "YEAR" + - "MONTH" + - "DAY" + - "YEAR/MONTH" + - "YEAR/MONTH/DAY" + default: "NO PARTITIONING" + order: 11 + glue_catalog_float_as_decimal: + title: "Glue Catalog: Float as Decimal" + description: "Cast float/double as decimal(38,18). This can help achieve\ + \ higher accuracy and represent numbers correctly as received from the\ + \ source." + type: "boolean" + default: false + order: 12 + destinationType: + title: "aws-datalake" + const: "aws-datalake" + enum: + - "aws-datalake" + order: 0 + type: "string" + destination-aws-datalake-update: + title: "AWS Datalake Destination Spec" + type: "object" + required: + - "credentials" + - "region" + - "bucket_name" + - "lakeformation_database_name" + properties: + aws_account_id: + type: "string" + title: "AWS Account Id" + description: "target aws account id" + examples: + - "111111111111" + order: 1 + credentials: + title: "Authentication mode" + description: "Choose How to Authenticate to AWS." + type: "object" + oneOf: + - type: "object" + title: "IAM Role" + required: + - "role_arn" + - "credentials_title" + properties: + credentials_title: + type: "string" + title: "Credentials Title" + description: "Name of the credentials" + const: "IAM Role" + enum: + - "IAM Role" + default: "IAM Role" + order: 0 + role_arn: + title: "Target Role Arn" + type: "string" + description: "Will assume this role to write data to s3" + airbyte_secret: false + - type: "object" + title: "IAM User" + required: + - "credentials_title" + - "aws_access_key_id" + - "aws_secret_access_key" + properties: + credentials_title: + type: "string" + title: "Credentials Title" + description: "Name of the credentials" + const: "IAM User" + enum: + - "IAM User" + default: "IAM User" + order: 0 + aws_access_key_id: + title: "Access Key Id" + type: "string" + description: "AWS User Access Key Id" + airbyte_secret: true + aws_secret_access_key: + title: "Secret Access Key" + type: "string" + description: "Secret Access Key" + airbyte_secret: true + order: 2 + region: + title: "S3 Bucket Region" + type: "string" + default: "" + description: "The region of the S3 bucket. See here for all region codes." + enum: + - "" + - "af-south-1" + - "ap-east-1" + - "ap-northeast-1" + - "ap-northeast-2" + - "ap-northeast-3" + - "ap-south-1" + - "ap-south-2" + - "ap-southeast-1" + - "ap-southeast-2" + - "ap-southeast-3" + - "ap-southeast-4" + - "ca-central-1" + - "ca-west-1" + - "cn-north-1" + - "cn-northwest-1" + - "eu-central-1" + - "eu-central-2" + - "eu-north-1" + - "eu-south-1" + - "eu-south-2" + - "eu-west-1" + - "eu-west-2" + - "eu-west-3" + - "il-central-1" + - "me-central-1" + - "me-south-1" + - "sa-east-1" + - "us-east-1" + - "us-east-2" + - "us-gov-east-1" + - "us-gov-west-1" + - "us-west-1" + - "us-west-2" + order: 3 + bucket_name: + title: "S3 Bucket Name" + type: "string" + description: "The name of the S3 bucket. Read more here." + order: 4 + bucket_prefix: + title: "Target S3 Bucket Prefix" + type: "string" + description: "S3 prefix" + order: 5 + lakeformation_database_name: + title: "Lake Formation Database Name" + type: "string" + description: "The default database this destination will use to create tables\ + \ in per stream. Can be changed per connection by customizing the namespace." + order: 6 + lakeformation_database_default_tag_key: + title: "Lake Formation Database Tag Key" + description: "Add a default tag key to databases created by this destination" + examples: + - "pii_level" + type: "string" + order: 7 + lakeformation_database_default_tag_values: + title: "Lake Formation Database Tag Values" + description: "Add default values for the `Tag Key` to databases created\ + \ by this destination. Comma separate for multiple values." + examples: + - "private,public" + type: "string" + order: 8 + lakeformation_governed_tables: + title: "Lake Formation Governed Tables" + description: "Whether to create tables as LF governed tables." + type: "boolean" + default: false + order: 9 + format: + title: "Output Format *" + type: "object" + description: "Format of the data output." + oneOf: + - title: "JSON Lines: Newline-delimited JSON" + required: + - "format_type" + properties: + format_type: + title: "Format Type *" + type: "string" + enum: + - "JSONL" + default: "JSONL" + compression_codec: + title: "Compression Codec (Optional)" + description: "The compression algorithm used to compress data." + type: "string" + enum: + - "UNCOMPRESSED" + - "GZIP" + default: "UNCOMPRESSED" + - title: "Parquet: Columnar Storage" + required: + - "format_type" + properties: + format_type: + title: "Format Type *" + type: "string" + enum: + - "Parquet" + default: "Parquet" + compression_codec: + title: "Compression Codec (Optional)" + description: "The compression algorithm used to compress data." + type: "string" + enum: + - "UNCOMPRESSED" + - "SNAPPY" + - "GZIP" + - "ZSTD" + default: "SNAPPY" + order: 10 + partitioning: + title: "Choose how to partition data" + description: "Partition data by cursor fields when a cursor field is a date" + type: "string" + enum: + - "NO PARTITIONING" + - "DATE" + - "YEAR" + - "MONTH" + - "DAY" + - "YEAR/MONTH" + - "YEAR/MONTH/DAY" + default: "NO PARTITIONING" + order: 11 + glue_catalog_float_as_decimal: + title: "Glue Catalog: Float as Decimal" + description: "Cast float/double as decimal(38,18). This can help achieve\ + \ higher accuracy and represent numbers correctly as received from the\ + \ source." + type: "boolean" + default: false + order: 12 + destination-milvus: + title: "Destination Config" + description: "The configuration model for the Vector DB based destinations.\ + \ This model is used to generate the UI for the destination configuration,\n\ + as well as to provide type safety for the configuration passed to the destination.\n\ + \nThe configuration model is composed of four parts:\n* Processing configuration\n\ + * Embedding configuration\n* Indexing configuration\n* Advanced configuration\n\ + \nProcessing, embedding and advanced configuration are provided by this base\ + \ class, while the indexing configuration is provided by the destination connector\ + \ in the sub class." + type: "object" + properties: + embedding: + title: "Embedding" + description: "Embedding configuration" + group: "embedding" + type: "object" + oneOf: + - title: "OpenAI" + type: "object" + properties: + mode: + title: "Mode" + default: "openai" + const: "openai" + enum: + - "openai" + type: "string" + openai_key: + title: "OpenAI API key" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + required: + - "openai_key" + - "mode" + description: "Use the OpenAI API to embed text. This option is using the\ + \ text-embedding-ada-002 model with 1536 embedding dimensions." + - title: "Cohere" + type: "object" + properties: + mode: + title: "Mode" + default: "cohere" + const: "cohere" + enum: + - "cohere" + type: "string" + cohere_key: + title: "Cohere API key" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + required: + - "cohere_key" + - "mode" + description: "Use the Cohere API to embed text." + - title: "Fake" + type: "object" + properties: + mode: + title: "Mode" + default: "fake" + const: "fake" + enum: + - "fake" + type: "string" + description: "Use a fake embedding made out of random vectors with 1536\ + \ embedding dimensions. This is useful for testing the data pipeline\ + \ without incurring any costs." + required: + - "mode" + - title: "Azure OpenAI" + type: "object" + properties: + mode: + title: "Mode" + default: "azure_openai" + const: "azure_openai" + enum: + - "azure_openai" + type: "string" + openai_key: + title: "Azure OpenAI API key" + description: "The API key for your Azure OpenAI resource. You can\ + \ find this in the Azure portal under your Azure OpenAI resource" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + api_base: + title: "Resource base URL" + description: "The base URL for your Azure OpenAI resource. You can\ + \ find this in the Azure portal under your Azure OpenAI resource" + examples: + - "https://your-resource-name.openai.azure.com" + type: "string" + deployment: + title: "Deployment" + description: "The deployment for your Azure OpenAI resource. You\ + \ can find this in the Azure portal under your Azure OpenAI resource" + examples: + - "your-resource-name" + type: "string" + required: + - "openai_key" + - "api_base" + - "deployment" + - "mode" + description: "Use the Azure-hosted OpenAI API to embed text. This option\ + \ is using the text-embedding-ada-002 model with 1536 embedding dimensions." + - title: "OpenAI-compatible" + type: "object" + properties: + mode: + title: "Mode" + default: "openai_compatible" + const: "openai_compatible" + enum: + - "openai_compatible" + type: "string" + api_key: + title: "API key" + default: "" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + base_url: + title: "Base URL" + description: "The base URL for your OpenAI-compatible service" + examples: + - "https://your-service-name.com" + type: "string" + model_name: + title: "Model name" + description: "The name of the model to use for embedding" + default: "text-embedding-ada-002" + examples: + - "text-embedding-ada-002" + type: "string" + dimensions: + title: "Embedding dimensions" + description: "The number of dimensions the embedding model is generating" + examples: + - 1536 + - 384 + type: "integer" + required: + - "base_url" + - "dimensions" + - "mode" + description: "Use a service that's compatible with the OpenAI API to embed\ + \ text." + processing: + title: "ProcessingConfigModel" + type: "object" + properties: + chunk_size: + title: "Chunk size" + description: "Size of chunks in tokens to store in vector store (make\ + \ sure it is not too big for the context if your LLM)" + maximum: 8191 + minimum: 1 + type: "integer" + chunk_overlap: + title: "Chunk overlap" + description: "Size of overlap between chunks in tokens to store in vector\ + \ store to better capture relevant context" + default: 0 + type: "integer" + text_fields: + title: "Text fields to embed" + description: "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." + default: [] + always_show: true + examples: + - "text" + - "user.name" + - "users.*.name" + type: "array" + items: + type: "string" + metadata_fields: + title: "Fields to store as metadata" + description: "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." + default: [] + always_show: true + examples: + - "age" + - "user" + - "user.name" + type: "array" + items: + type: "string" + text_splitter: + title: "Text splitter" + description: "Split text fields into chunks based on the specified method." + type: "object" + oneOf: + - title: "By Separator" + type: "object" + properties: + mode: + title: "Mode" + default: "separator" + const: "separator" + enum: + - "separator" + type: "string" + separators: + title: "Separators" + description: "List of separator strings to split text fields by.\ + \ The separator itself needs to be wrapped in double quotes,\ + \ e.g. to split by the dot character, use \".\". To split by\ + \ a newline, use \"\\n\"." + default: + - "\"\\n\\n\"" + - "\"\\n\"" + - "\" \"" + - "\"\"" + type: "array" + items: + type: "string" + keep_separator: + title: "Keep separator" + description: "Whether to keep the separator in the resulting chunks" + default: false + type: "boolean" + description: "Split the text by the list of separators until the chunk\ + \ size is reached, using the earlier mentioned separators where\ + \ possible. This is useful for splitting text fields by paragraphs,\ + \ sentences, words, etc." + required: + - "mode" + - title: "By Markdown header" + type: "object" + properties: + mode: + title: "Mode" + default: "markdown" + const: "markdown" + enum: + - "markdown" + type: "string" + split_level: + title: "Split level" + description: "Level of markdown headers to split text fields by.\ + \ Headings down to the specified level will be used as split\ + \ points" + default: 1 + minimum: 1 + maximum: 6 + type: "integer" + description: "Split the text by Markdown headers down to the specified\ + \ header level. If the chunk size fits multiple sections, they will\ + \ be combined into a single chunk." + required: + - "mode" + - title: "By Programming Language" + type: "object" + properties: + mode: + title: "Mode" + default: "code" + const: "code" + enum: + - "code" + type: "string" + language: + title: "Language" + description: "Split code in suitable places based on the programming\ + \ language" + enum: + - "cpp" + - "go" + - "java" + - "js" + - "php" + - "proto" + - "python" + - "rst" + - "ruby" + - "rust" + - "scala" + - "swift" + - "markdown" + - "latex" + - "html" + - "sol" + type: "string" + required: + - "language" + - "mode" + description: "Split the text by suitable delimiters based on the programming\ + \ language. This is useful for splitting code into chunks." + field_name_mappings: + title: "Field name mappings" + description: "List of fields to rename. Not applicable for nested fields,\ + \ but can be used to rename fields already flattened via dot notation." + default: [] + type: "array" + items: + title: "FieldNameMappingConfigModel" + type: "object" + properties: + from_field: + title: "From field name" + description: "The field name in the source" + type: "string" + to_field: + title: "To field name" + description: "The field name to use in the destination" + type: "string" + required: + - "from_field" + - "to_field" + required: + - "chunk_size" + group: "processing" + omit_raw_text: + title: "Do not store raw text" + description: "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." + default: false + group: "advanced" + type: "boolean" + indexing: + title: "Indexing" + type: "object" + properties: + host: + title: "Public Endpoint" + description: "The public endpoint of the Milvus instance. " + order: 1 + examples: + - "https://my-instance.zone.zillizcloud.com" + - "tcp://host.docker.internal:19530" + - "tcp://my-local-milvus:19530" + type: "string" + db: + title: "Database Name" + description: "The database to connect to" + default: "" + type: "string" + collection: + title: "Collection Name" + description: "The collection to load data into" + order: 3 + type: "string" + auth: + title: "Authentication" + description: "Authentication method" + type: "object" + order: 2 + oneOf: + - title: "API Token" + type: "object" + properties: + mode: + title: "Mode" + default: "token" + const: "token" + enum: + - "token" + type: "string" + token: + title: "API Token" + description: "API Token for the Milvus instance" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + required: + - "token" + - "mode" + description: "Authenticate using an API token (suitable for Zilliz\ + \ Cloud)" + - title: "Username/Password" + type: "object" + properties: + mode: + title: "Mode" + default: "username_password" + const: "username_password" + enum: + - "username_password" + type: "string" + username: + title: "Username" + description: "Username for the Milvus instance" + order: 1 + type: "string" + password: + title: "Password" + description: "Password for the Milvus instance" + airbyte_secret: true + order: 2 + type: "string" + x-speakeasy-param-sensitive: true + required: + - "username" + - "password" + - "mode" + description: "Authenticate using username and password (suitable for\ + \ self-managed Milvus clusters)" + - title: "No auth" + type: "object" + properties: + mode: + title: "Mode" + default: "no_auth" + const: "no_auth" + enum: + - "no_auth" + type: "string" + description: "Do not authenticate (suitable for locally running test\ + \ clusters, do not use for clusters with public IP addresses)" + required: + - "mode" + vector_field: + title: "Vector Field" + description: "The field in the entity that contains the vector" + default: "vector" + type: "string" + text_field: + title: "Text Field" + description: "The field in the entity that contains the embedded text" + default: "text" + type: "string" + required: + - "host" + - "collection" + - "auth" + group: "indexing" + description: "Indexing configuration" + destinationType: + title: "milvus" + const: "milvus" + enum: + - "milvus" + order: 0 + type: "string" + required: + - "embedding" + - "processing" + - "indexing" + - "destinationType" + groups: + - id: "processing" + title: "Processing" + - id: "embedding" + title: "Embedding" + - id: "indexing" + title: "Indexing" + - id: "advanced" + title: "Advanced" + destination-milvus-update: + title: "Destination Config" + description: "The configuration model for the Vector DB based destinations.\ + \ This model is used to generate the UI for the destination configuration,\n\ + as well as to provide type safety for the configuration passed to the destination.\n\ + \nThe configuration model is composed of four parts:\n* Processing configuration\n\ + * Embedding configuration\n* Indexing configuration\n* Advanced configuration\n\ + \nProcessing, embedding and advanced configuration are provided by this base\ + \ class, while the indexing configuration is provided by the destination connector\ + \ in the sub class." + type: "object" + properties: + embedding: + title: "Embedding" + description: "Embedding configuration" + group: "embedding" + type: "object" + oneOf: + - title: "OpenAI" + type: "object" + properties: + mode: + title: "Mode" + default: "openai" + const: "openai" + enum: + - "openai" + type: "string" + openai_key: + title: "OpenAI API key" + airbyte_secret: true + type: "string" + required: + - "openai_key" + - "mode" + description: "Use the OpenAI API to embed text. This option is using the\ + \ text-embedding-ada-002 model with 1536 embedding dimensions." + - title: "Cohere" + type: "object" + properties: + mode: + title: "Mode" + default: "cohere" + const: "cohere" + enum: + - "cohere" + type: "string" + cohere_key: + title: "Cohere API key" + airbyte_secret: true + type: "string" + required: + - "cohere_key" + - "mode" + description: "Use the Cohere API to embed text." + - title: "Fake" + type: "object" + properties: + mode: + title: "Mode" + default: "fake" + const: "fake" + enum: + - "fake" + type: "string" + description: "Use a fake embedding made out of random vectors with 1536\ + \ embedding dimensions. This is useful for testing the data pipeline\ + \ without incurring any costs." + required: + - "mode" + - title: "Azure OpenAI" + type: "object" + properties: + mode: + title: "Mode" + default: "azure_openai" + const: "azure_openai" + enum: + - "azure_openai" + type: "string" + openai_key: + title: "Azure OpenAI API key" + description: "The API key for your Azure OpenAI resource. You can\ + \ find this in the Azure portal under your Azure OpenAI resource" + airbyte_secret: true + type: "string" + api_base: + title: "Resource base URL" + description: "The base URL for your Azure OpenAI resource. You can\ + \ find this in the Azure portal under your Azure OpenAI resource" + examples: + - "https://your-resource-name.openai.azure.com" + type: "string" + deployment: + title: "Deployment" + description: "The deployment for your Azure OpenAI resource. You\ + \ can find this in the Azure portal under your Azure OpenAI resource" + examples: + - "your-resource-name" + type: "string" + required: + - "openai_key" + - "api_base" + - "deployment" + - "mode" + description: "Use the Azure-hosted OpenAI API to embed text. This option\ + \ is using the text-embedding-ada-002 model with 1536 embedding dimensions." + - title: "OpenAI-compatible" + type: "object" + properties: + mode: + title: "Mode" + default: "openai_compatible" + const: "openai_compatible" + enum: + - "openai_compatible" + type: "string" + api_key: + title: "API key" + default: "" + airbyte_secret: true + type: "string" + base_url: + title: "Base URL" + description: "The base URL for your OpenAI-compatible service" + examples: + - "https://your-service-name.com" + type: "string" + model_name: + title: "Model name" + description: "The name of the model to use for embedding" + default: "text-embedding-ada-002" + examples: + - "text-embedding-ada-002" + type: "string" + dimensions: + title: "Embedding dimensions" + description: "The number of dimensions the embedding model is generating" + examples: + - 1536 + - 384 + type: "integer" + required: + - "base_url" + - "dimensions" + - "mode" + description: "Use a service that's compatible with the OpenAI API to embed\ + \ text." + processing: + title: "ProcessingConfigModel" + type: "object" + properties: + chunk_size: + title: "Chunk size" + description: "Size of chunks in tokens to store in vector store (make\ + \ sure it is not too big for the context if your LLM)" + maximum: 8191 + minimum: 1 + type: "integer" + chunk_overlap: + title: "Chunk overlap" + description: "Size of overlap between chunks in tokens to store in vector\ + \ store to better capture relevant context" + default: 0 + type: "integer" + text_fields: + title: "Text fields to embed" + description: "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." + default: [] + always_show: true + examples: + - "text" + - "user.name" + - "users.*.name" + type: "array" + items: + type: "string" + metadata_fields: + title: "Fields to store as metadata" + description: "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." + default: [] + always_show: true + examples: + - "age" + - "user" + - "user.name" + type: "array" + items: + type: "string" + text_splitter: + title: "Text splitter" + description: "Split text fields into chunks based on the specified method." + type: "object" + oneOf: + - title: "By Separator" + type: "object" + properties: + mode: + title: "Mode" + default: "separator" + const: "separator" + enum: + - "separator" + type: "string" + separators: + title: "Separators" + description: "List of separator strings to split text fields by.\ + \ The separator itself needs to be wrapped in double quotes,\ + \ e.g. to split by the dot character, use \".\". To split by\ + \ a newline, use \"\\n\"." + default: + - "\"\\n\\n\"" + - "\"\\n\"" + - "\" \"" + - "\"\"" + type: "array" + items: + type: "string" + keep_separator: + title: "Keep separator" + description: "Whether to keep the separator in the resulting chunks" + default: false + type: "boolean" + description: "Split the text by the list of separators until the chunk\ + \ size is reached, using the earlier mentioned separators where\ + \ possible. This is useful for splitting text fields by paragraphs,\ + \ sentences, words, etc." + required: + - "mode" + - title: "By Markdown header" + type: "object" + properties: + mode: + title: "Mode" + default: "markdown" + const: "markdown" + enum: + - "markdown" + type: "string" + split_level: + title: "Split level" + description: "Level of markdown headers to split text fields by.\ + \ Headings down to the specified level will be used as split\ + \ points" + default: 1 + minimum: 1 + maximum: 6 + type: "integer" + description: "Split the text by Markdown headers down to the specified\ + \ header level. If the chunk size fits multiple sections, they will\ + \ be combined into a single chunk." + required: + - "mode" + - title: "By Programming Language" + type: "object" + properties: + mode: + title: "Mode" + default: "code" + const: "code" + enum: + - "code" + type: "string" + language: + title: "Language" + description: "Split code in suitable places based on the programming\ + \ language" + enum: + - "cpp" + - "go" + - "java" + - "js" + - "php" + - "proto" + - "python" + - "rst" + - "ruby" + - "rust" + - "scala" + - "swift" + - "markdown" + - "latex" + - "html" + - "sol" + type: "string" + required: + - "language" + - "mode" + description: "Split the text by suitable delimiters based on the programming\ + \ language. This is useful for splitting code into chunks." + field_name_mappings: + title: "Field name mappings" + description: "List of fields to rename. Not applicable for nested fields,\ + \ but can be used to rename fields already flattened via dot notation." + default: [] + type: "array" + items: + title: "FieldNameMappingConfigModel" + type: "object" + properties: + from_field: + title: "From field name" + description: "The field name in the source" + type: "string" + to_field: + title: "To field name" + description: "The field name to use in the destination" + type: "string" + required: + - "from_field" + - "to_field" + required: + - "chunk_size" + group: "processing" + omit_raw_text: + title: "Do not store raw text" + description: "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." + default: false + group: "advanced" + type: "boolean" + indexing: + title: "Indexing" + type: "object" + properties: + host: + title: "Public Endpoint" + description: "The public endpoint of the Milvus instance. " + order: 1 + examples: + - "https://my-instance.zone.zillizcloud.com" + - "tcp://host.docker.internal:19530" + - "tcp://my-local-milvus:19530" + type: "string" + db: + title: "Database Name" + description: "The database to connect to" + default: "" + type: "string" + collection: + title: "Collection Name" + description: "The collection to load data into" + order: 3 + type: "string" + auth: + title: "Authentication" + description: "Authentication method" + type: "object" + order: 2 + oneOf: + - title: "API Token" + type: "object" + properties: + mode: + title: "Mode" + default: "token" + const: "token" + enum: + - "token" + type: "string" + token: + title: "API Token" + description: "API Token for the Milvus instance" + airbyte_secret: true + type: "string" + required: + - "token" + - "mode" + description: "Authenticate using an API token (suitable for Zilliz\ + \ Cloud)" + - title: "Username/Password" + type: "object" + properties: + mode: + title: "Mode" + default: "username_password" + const: "username_password" + enum: + - "username_password" + type: "string" + username: + title: "Username" + description: "Username for the Milvus instance" + order: 1 + type: "string" + password: + title: "Password" + description: "Password for the Milvus instance" + airbyte_secret: true + order: 2 + type: "string" + required: + - "username" + - "password" + - "mode" + description: "Authenticate using username and password (suitable for\ + \ self-managed Milvus clusters)" + - title: "No auth" + type: "object" + properties: + mode: + title: "Mode" + default: "no_auth" + const: "no_auth" + enum: + - "no_auth" + type: "string" + description: "Do not authenticate (suitable for locally running test\ + \ clusters, do not use for clusters with public IP addresses)" + required: + - "mode" + vector_field: + title: "Vector Field" + description: "The field in the entity that contains the vector" + default: "vector" + type: "string" + text_field: + title: "Text Field" + description: "The field in the entity that contains the embedded text" + default: "text" + type: "string" + required: + - "host" + - "collection" + - "auth" + group: "indexing" + description: "Indexing configuration" + required: + - "embedding" + - "processing" + - "indexing" + groups: + - id: "processing" + title: "Processing" + - id: "embedding" + title: "Embedding" + - id: "indexing" + title: "Indexing" + - id: "advanced" + title: "Advanced" + destination-google-sheets: + title: "Destination Google Sheets" + type: "object" + required: + - "spreadsheet_id" + - "credentials" + - "destinationType" + properties: + spreadsheet_id: + type: "string" + title: "Spreadsheet Link" + description: "The link to your spreadsheet. See this\ + \ guide for more details." + examples: + - "https://docs.google.com/spreadsheets/d/1hLd9Qqti3UyLXZB2aFfUWDT7BG/edit" + credentials: + type: "object" + title: "Authentication via Google (OAuth)" + description: "Google API Credentials for connecting to Google Sheets and\ + \ Google Drive APIs" + required: + - "client_id" + - "client_secret" + - "refresh_token" + properties: + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Google Sheets developer application." + airbyte_secret: true + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Google Sheets developer application." + airbyte_secret: true + refresh_token: + title: "Refresh Token" + type: "string" + description: "The token for obtaining new access token." + airbyte_secret: true + x-speakeasy-param-sensitive: true + destinationType: + title: "google-sheets" + const: "google-sheets" + enum: + - "google-sheets" + order: 0 + type: "string" + destination-google-sheets-update: + title: "Destination Google Sheets" + type: "object" + required: + - "spreadsheet_id" + - "credentials" + properties: + spreadsheet_id: + type: "string" + title: "Spreadsheet Link" + description: "The link to your spreadsheet. See this\ + \ guide for more details." + examples: + - "https://docs.google.com/spreadsheets/d/1hLd9Qqti3UyLXZB2aFfUWDT7BG/edit" + credentials: + type: "object" + title: "Authentication via Google (OAuth)" + description: "Google API Credentials for connecting to Google Sheets and\ + \ Google Drive APIs" + required: + - "client_id" + - "client_secret" + - "refresh_token" + properties: + client_id: + title: "Client ID" + type: "string" + description: "The Client ID of your Google Sheets developer application." + airbyte_secret: true + client_secret: + title: "Client Secret" + type: "string" + description: "The Client Secret of your Google Sheets developer application." + airbyte_secret: true + refresh_token: + title: "Refresh Token" + type: "string" + description: "The token for obtaining new access token." + airbyte_secret: true + destination-astra: + title: "Destination Config" + description: "The configuration model for the Vector DB based destinations.\ + \ This model is used to generate the UI for the destination configuration,\n\ + as well as to provide type safety for the configuration passed to the destination.\n\ + \nThe configuration model is composed of four parts:\n* Processing configuration\n\ + * Embedding configuration\n* Indexing configuration\n* Advanced configuration\n\ + \nProcessing, embedding and advanced configuration are provided by this base\ + \ class, while the indexing configuration is provided by the destination connector\ + \ in the sub class." + type: "object" + properties: + embedding: + title: "Embedding" + description: "Embedding configuration" + group: "embedding" + type: "object" + oneOf: + - title: "OpenAI" + type: "object" + properties: + mode: + title: "Mode" + default: "openai" + const: "openai" + enum: + - "openai" + type: "string" + openai_key: + title: "OpenAI API key" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + required: + - "openai_key" + - "mode" + description: "Use the OpenAI API to embed text. This option is using the\ + \ text-embedding-ada-002 model with 1536 embedding dimensions." + - title: "Cohere" + type: "object" + properties: + mode: + title: "Mode" + default: "cohere" + const: "cohere" + enum: + - "cohere" + type: "string" + cohere_key: + title: "Cohere API key" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + required: + - "cohere_key" + - "mode" + description: "Use the Cohere API to embed text." + - title: "Fake" + type: "object" + properties: + mode: + title: "Mode" + default: "fake" + const: "fake" + enum: + - "fake" + type: "string" + description: "Use a fake embedding made out of random vectors with 1536\ + \ embedding dimensions. This is useful for testing the data pipeline\ + \ without incurring any costs." + required: + - "mode" + - title: "Azure OpenAI" + type: "object" + properties: + mode: + title: "Mode" + default: "azure_openai" + const: "azure_openai" + enum: + - "azure_openai" + type: "string" + openai_key: + title: "Azure OpenAI API key" + description: "The API key for your Azure OpenAI resource. You can\ + \ find this in the Azure portal under your Azure OpenAI resource" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + api_base: + title: "Resource base URL" + description: "The base URL for your Azure OpenAI resource. You can\ + \ find this in the Azure portal under your Azure OpenAI resource" + examples: + - "https://your-resource-name.openai.azure.com" + type: "string" + deployment: + title: "Deployment" + description: "The deployment for your Azure OpenAI resource. You\ + \ can find this in the Azure portal under your Azure OpenAI resource" + examples: + - "your-resource-name" + type: "string" + required: + - "openai_key" + - "api_base" + - "deployment" + - "mode" + description: "Use the Azure-hosted OpenAI API to embed text. This option\ + \ is using the text-embedding-ada-002 model with 1536 embedding dimensions." + - title: "OpenAI-compatible" + type: "object" + properties: + mode: + title: "Mode" + default: "openai_compatible" + const: "openai_compatible" + enum: + - "openai_compatible" + type: "string" + api_key: + title: "API key" + default: "" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + base_url: + title: "Base URL" + description: "The base URL for your OpenAI-compatible service" + examples: + - "https://your-service-name.com" + type: "string" + model_name: + title: "Model name" + description: "The name of the model to use for embedding" + default: "text-embedding-ada-002" + examples: + - "text-embedding-ada-002" + type: "string" + dimensions: + title: "Embedding dimensions" + description: "The number of dimensions the embedding model is generating" + examples: + - 1536 + - 384 + type: "integer" + required: + - "base_url" + - "dimensions" + - "mode" + description: "Use a service that's compatible with the OpenAI API to embed\ + \ text." + processing: + title: "ProcessingConfigModel" + type: "object" + properties: + chunk_size: + title: "Chunk size" + description: "Size of chunks in tokens to store in vector store (make\ + \ sure it is not too big for the context if your LLM)" + maximum: 8191 + minimum: 1 + type: "integer" + chunk_overlap: + title: "Chunk overlap" + description: "Size of overlap between chunks in tokens to store in vector\ + \ store to better capture relevant context" + default: 0 + type: "integer" + text_fields: + title: "Text fields to embed" + description: "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." + default: [] + always_show: true + examples: + - "text" + - "user.name" + - "users.*.name" + type: "array" + items: + type: "string" + metadata_fields: + title: "Fields to store as metadata" + description: "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." + default: [] + always_show: true + examples: + - "age" + - "user" + - "user.name" + type: "array" + items: + type: "string" + text_splitter: + title: "Text splitter" + description: "Split text fields into chunks based on the specified method." + type: "object" + oneOf: + - title: "By Separator" + type: "object" + properties: + mode: + title: "Mode" + default: "separator" + const: "separator" + enum: + - "separator" + type: "string" + separators: + title: "Separators" + description: "List of separator strings to split text fields by.\ + \ The separator itself needs to be wrapped in double quotes,\ + \ e.g. to split by the dot character, use \".\". To split by\ + \ a newline, use \"\\n\"." + default: + - "\"\\n\\n\"" + - "\"\\n\"" + - "\" \"" + - "\"\"" + type: "array" + items: + type: "string" + keep_separator: + title: "Keep separator" + description: "Whether to keep the separator in the resulting chunks" + default: false + type: "boolean" + description: "Split the text by the list of separators until the chunk\ + \ size is reached, using the earlier mentioned separators where\ + \ possible. This is useful for splitting text fields by paragraphs,\ + \ sentences, words, etc." + required: + - "mode" + - title: "By Markdown header" + type: "object" + properties: + mode: + title: "Mode" + default: "markdown" + const: "markdown" + enum: + - "markdown" + type: "string" + split_level: + title: "Split level" + description: "Level of markdown headers to split text fields by.\ + \ Headings down to the specified level will be used as split\ + \ points" + default: 1 + minimum: 1 + maximum: 6 + type: "integer" + description: "Split the text by Markdown headers down to the specified\ + \ header level. If the chunk size fits multiple sections, they will\ + \ be combined into a single chunk." + required: + - "mode" + - title: "By Programming Language" + type: "object" + properties: + mode: + title: "Mode" + default: "code" + const: "code" + enum: + - "code" + type: "string" + language: + title: "Language" + description: "Split code in suitable places based on the programming\ + \ language" + enum: + - "cpp" + - "go" + - "java" + - "js" + - "php" + - "proto" + - "python" + - "rst" + - "ruby" + - "rust" + - "scala" + - "swift" + - "markdown" + - "latex" + - "html" + - "sol" + type: "string" + required: + - "language" + - "mode" + description: "Split the text by suitable delimiters based on the programming\ + \ language. This is useful for splitting code into chunks." + field_name_mappings: + title: "Field name mappings" + description: "List of fields to rename. Not applicable for nested fields,\ + \ but can be used to rename fields already flattened via dot notation." + default: [] + type: "array" + items: + title: "FieldNameMappingConfigModel" + type: "object" + properties: + from_field: + title: "From field name" + description: "The field name in the source" + type: "string" + to_field: + title: "To field name" + description: "The field name to use in the destination" + type: "string" + required: + - "from_field" + - "to_field" + required: + - "chunk_size" + group: "processing" + omit_raw_text: + title: "Do not store raw text" + description: "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." + default: false + group: "advanced" + type: "boolean" + indexing: + title: "Indexing" + type: "object" + properties: + astra_db_app_token: + title: "Astra DB Application Token" + description: "The application token authorizes a user to connect to\ + \ a specific Astra DB database. It is created when the user clicks\ + \ the Generate Token button on the Overview tab of the Database page\ + \ in the Astra UI." + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + astra_db_endpoint: + title: "Astra DB Endpoint" + description: "The endpoint specifies which Astra DB database queries\ + \ are sent to. It can be copied from the Database Details section\ + \ of the Overview tab of the Database page in the Astra UI." + pattern: "^https:\\/\\/([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12}-[^\\\ + .]*?\\.apps\\.astra\\.datastax\\.com" + examples: + - "https://8292d414-dd1b-4c33-8431-e838bedc04f7-us-east1.apps.astra.datastax.com" + type: "string" + astra_db_keyspace: + title: "Astra DB Keyspace" + description: "Keyspaces (or Namespaces) serve as containers for organizing\ + \ data within a database. You can create a new keyspace uisng the\ + \ Data Explorer tab in the Astra UI. The keyspace default_keyspace\ + \ is created for you when you create a Vector Database in Astra DB." + type: "string" + x-speakeasy-param-sensitive: true + collection: + title: "Astra DB collection" + description: "Collections hold data. They are analagous to tables in\ + \ traditional Cassandra terminology. This tool will create the collection\ + \ with the provided name automatically if it does not already exist.\ + \ Alternatively, you can create one thorugh the Data Explorer tab\ + \ in the Astra UI." + type: "string" + required: + - "astra_db_app_token" + - "astra_db_endpoint" + - "astra_db_keyspace" + - "collection" + description: "Astra DB gives developers the APIs, real-time data and ecosystem\ + \ integrations to put accurate RAG and Gen AI apps with fewer hallucinations\ + \ in production." + group: "indexing" + destinationType: + title: "astra" + const: "astra" + enum: + - "astra" + order: 0 + type: "string" + required: + - "embedding" + - "processing" + - "indexing" + - "destinationType" + groups: + - id: "processing" + title: "Processing" + - id: "embedding" + title: "Embedding" + - id: "indexing" + title: "Indexing" + - id: "advanced" + title: "Advanced" + destination-astra-update: + title: "Destination Config" + description: "The configuration model for the Vector DB based destinations.\ + \ This model is used to generate the UI for the destination configuration,\n\ + as well as to provide type safety for the configuration passed to the destination.\n\ + \nThe configuration model is composed of four parts:\n* Processing configuration\n\ + * Embedding configuration\n* Indexing configuration\n* Advanced configuration\n\ + \nProcessing, embedding and advanced configuration are provided by this base\ + \ class, while the indexing configuration is provided by the destination connector\ + \ in the sub class." + type: "object" + properties: + embedding: + title: "Embedding" + description: "Embedding configuration" + group: "embedding" + type: "object" + oneOf: + - title: "OpenAI" + type: "object" + properties: + mode: + title: "Mode" + default: "openai" + const: "openai" + enum: + - "openai" + type: "string" + openai_key: + title: "OpenAI API key" + airbyte_secret: true + type: "string" + required: + - "openai_key" + - "mode" + description: "Use the OpenAI API to embed text. This option is using the\ + \ text-embedding-ada-002 model with 1536 embedding dimensions." + - title: "Cohere" + type: "object" + properties: + mode: + title: "Mode" + default: "cohere" + const: "cohere" + enum: + - "cohere" + type: "string" + cohere_key: + title: "Cohere API key" + airbyte_secret: true + type: "string" + required: + - "cohere_key" + - "mode" + description: "Use the Cohere API to embed text." + - title: "Fake" + type: "object" + properties: + mode: + title: "Mode" + default: "fake" + const: "fake" + enum: + - "fake" + type: "string" + description: "Use a fake embedding made out of random vectors with 1536\ + \ embedding dimensions. This is useful for testing the data pipeline\ + \ without incurring any costs." + required: + - "mode" + - title: "Azure OpenAI" + type: "object" + properties: + mode: + title: "Mode" + default: "azure_openai" + const: "azure_openai" + enum: + - "azure_openai" + type: "string" + openai_key: + title: "Azure OpenAI API key" + description: "The API key for your Azure OpenAI resource. You can\ + \ find this in the Azure portal under your Azure OpenAI resource" + airbyte_secret: true + type: "string" + api_base: + title: "Resource base URL" + description: "The base URL for your Azure OpenAI resource. You can\ + \ find this in the Azure portal under your Azure OpenAI resource" + examples: + - "https://your-resource-name.openai.azure.com" + type: "string" + deployment: + title: "Deployment" + description: "The deployment for your Azure OpenAI resource. You\ + \ can find this in the Azure portal under your Azure OpenAI resource" + examples: + - "your-resource-name" + type: "string" + required: + - "openai_key" + - "api_base" + - "deployment" + - "mode" + description: "Use the Azure-hosted OpenAI API to embed text. This option\ + \ is using the text-embedding-ada-002 model with 1536 embedding dimensions." + - title: "OpenAI-compatible" + type: "object" + properties: + mode: + title: "Mode" + default: "openai_compatible" + const: "openai_compatible" + enum: + - "openai_compatible" + type: "string" + api_key: + title: "API key" + default: "" + airbyte_secret: true + type: "string" + base_url: + title: "Base URL" + description: "The base URL for your OpenAI-compatible service" + examples: + - "https://your-service-name.com" + type: "string" + model_name: + title: "Model name" + description: "The name of the model to use for embedding" + default: "text-embedding-ada-002" + examples: + - "text-embedding-ada-002" + type: "string" + dimensions: + title: "Embedding dimensions" + description: "The number of dimensions the embedding model is generating" + examples: + - 1536 + - 384 + type: "integer" + required: + - "base_url" + - "dimensions" + - "mode" + description: "Use a service that's compatible with the OpenAI API to embed\ + \ text." + processing: + title: "ProcessingConfigModel" + type: "object" + properties: + chunk_size: + title: "Chunk size" + description: "Size of chunks in tokens to store in vector store (make\ + \ sure it is not too big for the context if your LLM)" + maximum: 8191 + minimum: 1 + type: "integer" + chunk_overlap: + title: "Chunk overlap" + description: "Size of overlap between chunks in tokens to store in vector\ + \ store to better capture relevant context" + default: 0 + type: "integer" + text_fields: + title: "Text fields to embed" + description: "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." + default: [] + always_show: true + examples: + - "text" + - "user.name" + - "users.*.name" + type: "array" + items: + type: "string" + metadata_fields: + title: "Fields to store as metadata" + description: "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." + default: [] + always_show: true + examples: + - "age" + - "user" + - "user.name" + type: "array" + items: + type: "string" + text_splitter: + title: "Text splitter" + description: "Split text fields into chunks based on the specified method." + type: "object" + oneOf: + - title: "By Separator" + type: "object" + properties: + mode: + title: "Mode" + default: "separator" + const: "separator" + enum: + - "separator" + type: "string" + separators: + title: "Separators" + description: "List of separator strings to split text fields by.\ + \ The separator itself needs to be wrapped in double quotes,\ + \ e.g. to split by the dot character, use \".\". To split by\ + \ a newline, use \"\\n\"." + default: + - "\"\\n\\n\"" + - "\"\\n\"" + - "\" \"" + - "\"\"" + type: "array" + items: + type: "string" + keep_separator: + title: "Keep separator" + description: "Whether to keep the separator in the resulting chunks" + default: false + type: "boolean" + description: "Split the text by the list of separators until the chunk\ + \ size is reached, using the earlier mentioned separators where\ + \ possible. This is useful for splitting text fields by paragraphs,\ + \ sentences, words, etc." + required: + - "mode" + - title: "By Markdown header" + type: "object" + properties: + mode: + title: "Mode" + default: "markdown" + const: "markdown" + enum: + - "markdown" + type: "string" + split_level: + title: "Split level" + description: "Level of markdown headers to split text fields by.\ + \ Headings down to the specified level will be used as split\ + \ points" + default: 1 + minimum: 1 + maximum: 6 + type: "integer" + description: "Split the text by Markdown headers down to the specified\ + \ header level. If the chunk size fits multiple sections, they will\ + \ be combined into a single chunk." + required: + - "mode" + - title: "By Programming Language" + type: "object" + properties: + mode: + title: "Mode" + default: "code" + const: "code" + enum: + - "code" + type: "string" + language: + title: "Language" + description: "Split code in suitable places based on the programming\ + \ language" + enum: + - "cpp" + - "go" + - "java" + - "js" + - "php" + - "proto" + - "python" + - "rst" + - "ruby" + - "rust" + - "scala" + - "swift" + - "markdown" + - "latex" + - "html" + - "sol" + type: "string" + required: + - "language" + - "mode" + description: "Split the text by suitable delimiters based on the programming\ + \ language. This is useful for splitting code into chunks." + field_name_mappings: + title: "Field name mappings" + description: "List of fields to rename. Not applicable for nested fields,\ + \ but can be used to rename fields already flattened via dot notation." + default: [] + type: "array" + items: + title: "FieldNameMappingConfigModel" + type: "object" + properties: + from_field: + title: "From field name" + description: "The field name in the source" + type: "string" + to_field: + title: "To field name" + description: "The field name to use in the destination" + type: "string" + required: + - "from_field" + - "to_field" + required: + - "chunk_size" + group: "processing" + omit_raw_text: + title: "Do not store raw text" + description: "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." + default: false + group: "advanced" + type: "boolean" + indexing: + title: "Indexing" + type: "object" + properties: + astra_db_app_token: + title: "Astra DB Application Token" + description: "The application token authorizes a user to connect to\ + \ a specific Astra DB database. It is created when the user clicks\ + \ the Generate Token button on the Overview tab of the Database page\ + \ in the Astra UI." + airbyte_secret: true + type: "string" + astra_db_endpoint: + title: "Astra DB Endpoint" + description: "The endpoint specifies which Astra DB database queries\ + \ are sent to. It can be copied from the Database Details section\ + \ of the Overview tab of the Database page in the Astra UI." + pattern: "^https:\\/\\/([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12}-[^\\\ + .]*?\\.apps\\.astra\\.datastax\\.com" + examples: + - "https://8292d414-dd1b-4c33-8431-e838bedc04f7-us-east1.apps.astra.datastax.com" + type: "string" + astra_db_keyspace: + title: "Astra DB Keyspace" + description: "Keyspaces (or Namespaces) serve as containers for organizing\ + \ data within a database. You can create a new keyspace uisng the\ + \ Data Explorer tab in the Astra UI. The keyspace default_keyspace\ + \ is created for you when you create a Vector Database in Astra DB." + type: "string" + collection: + title: "Astra DB collection" + description: "Collections hold data. They are analagous to tables in\ + \ traditional Cassandra terminology. This tool will create the collection\ + \ with the provided name automatically if it does not already exist.\ + \ Alternatively, you can create one thorugh the Data Explorer tab\ + \ in the Astra UI." + type: "string" + required: + - "astra_db_app_token" + - "astra_db_endpoint" + - "astra_db_keyspace" + - "collection" + description: "Astra DB gives developers the APIs, real-time data and ecosystem\ + \ integrations to put accurate RAG and Gen AI apps with fewer hallucinations\ + \ in production." + group: "indexing" + required: + - "embedding" + - "processing" + - "indexing" + groups: + - id: "processing" + title: "Processing" + - id: "embedding" + title: "Embedding" + - id: "indexing" + title: "Indexing" + - id: "advanced" + title: "Advanced" + destination-teradata: + title: "Teradata Destination Spec" + type: "object" + required: + - "host" + - "username" + - "destinationType" + properties: + host: + title: "Host" + description: "Hostname of the database." + type: "string" + order: 0 + username: + title: "User" + description: "Username to use to access the database." + type: "string" + order: 1 + password: + title: "Password" + description: "Password associated with the username." + type: "string" + airbyte_secret: true + order: 2 + x-speakeasy-param-sensitive: true + schema: + title: "Default Schema" + description: "The default schema tables are written to if the source does\ + \ not specify a namespace. The usual value for this field is \"public\"\ + ." + type: "string" + examples: + - "airbyte_td" + default: "airbyte_td" + order: 3 + ssl: + title: "SSL Connection" + description: "Encrypt data using SSL. When activating SSL, please select\ + \ one of the connection modes." + type: "boolean" + default: false + order: 5 + ssl_mode: + title: "SSL modes" + description: "SSL connection modes. \n disable - Chose this mode\ + \ to disable encryption of communication between Airbyte and destination\ + \ database\n allow - Chose this mode to enable encryption only\ + \ when required by the destination database\n prefer - Chose this\ + \ mode to allow unencrypted connection only if the destination database\ + \ does not support encryption\n require - Chose this mode to always\ + \ require encryption. If the destination database server does not support\ + \ encryption, connection will fail\n verify-ca - Chose this mode\ + \ to always require encryption and to verify that the destination database\ + \ server has a valid SSL certificate\n verify-full - This is the\ + \ most secure mode. Chose this mode to always require encryption and to\ + \ verify the identity of the destination database server\n See more information\ + \ - in the docs." + type: "object" + order: 6 + oneOf: + - title: "disable" + additionalProperties: false + description: "Disable SSL." + required: + - "mode" + properties: + mode: + type: "string" + const: "disable" + enum: + - "disable" + default: "disable" + order: 0 + - title: "allow" + additionalProperties: false + description: "Allow SSL mode." + required: + - "mode" + properties: + mode: + type: "string" + const: "allow" + enum: + - "allow" + default: "allow" + order: 0 + - title: "prefer" + additionalProperties: false + description: "Prefer SSL mode." + required: + - "mode" + properties: + mode: + type: "string" + const: "prefer" + enum: + - "prefer" + default: "prefer" + order: 0 + - title: "require" + additionalProperties: false + description: "Require SSL mode." + required: + - "mode" + properties: + mode: + type: "string" + const: "require" + enum: + - "require" + default: "require" + order: 0 + - title: "verify-ca" + additionalProperties: false + description: "Verify-ca SSL mode." + required: + - "mode" + - "ssl_ca_certificate" + properties: + mode: + type: "string" + const: "verify-ca" + enum: + - "verify-ca" + default: "verify-ca" + order: 0 + ssl_ca_certificate: + type: "string" + title: "CA certificate" + description: "Specifies the file name of a PEM file that contains\ + \ Certificate Authority (CA) certificates for use with SSLMODE=verify-ca.\n\ + \ See more information - in the docs." + airbyte_secret: true + multiline: true + order: 1 + - title: "verify-full" + additionalProperties: false + description: "Verify-full SSL mode." + required: + - "mode" + - "ssl_ca_certificate" + properties: + mode: + type: "string" + const: "verify-full" + enum: + - "verify-full" + default: "verify-full" + order: 0 + ssl_ca_certificate: + type: "string" + title: "CA certificate" + description: "Specifies the file name of a PEM file that contains\ + \ Certificate Authority (CA) certificates for use with SSLMODE=verify-full.\n\ + \ See more information - in the docs." + airbyte_secret: true + multiline: true + order: 1 + jdbc_url_params: + description: "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)." + title: "JDBC URL Params" + type: "string" + order: 7 + destinationType: + title: "teradata" + const: "teradata" + enum: + - "teradata" + order: 0 + type: "string" + destination-teradata-update: + title: "Teradata Destination Spec" + type: "object" + required: + - "host" + - "username" + properties: + host: + title: "Host" + description: "Hostname of the database." + type: "string" + order: 0 + username: + title: "User" + description: "Username to use to access the database." + type: "string" + order: 1 + password: + title: "Password" + description: "Password associated with the username." + type: "string" + airbyte_secret: true + order: 2 + schema: + title: "Default Schema" + description: "The default schema tables are written to if the source does\ + \ not specify a namespace. The usual value for this field is \"public\"\ + ." + type: "string" + examples: + - "airbyte_td" + default: "airbyte_td" + order: 3 + ssl: + title: "SSL Connection" + description: "Encrypt data using SSL. When activating SSL, please select\ + \ one of the connection modes." + type: "boolean" + default: false + order: 5 + ssl_mode: + title: "SSL modes" + description: "SSL connection modes. \n disable - Chose this mode\ + \ to disable encryption of communication between Airbyte and destination\ + \ database\n allow - Chose this mode to enable encryption only\ + \ when required by the destination database\n prefer - Chose this\ + \ mode to allow unencrypted connection only if the destination database\ + \ does not support encryption\n require - Chose this mode to always\ + \ require encryption. If the destination database server does not support\ + \ encryption, connection will fail\n verify-ca - Chose this mode\ + \ to always require encryption and to verify that the destination database\ + \ server has a valid SSL certificate\n verify-full - This is the\ + \ most secure mode. Chose this mode to always require encryption and to\ + \ verify the identity of the destination database server\n See more information\ + \ - in the docs." + type: "object" + order: 6 + oneOf: + - title: "disable" + additionalProperties: false + description: "Disable SSL." + required: + - "mode" + properties: + mode: + type: "string" + const: "disable" + enum: + - "disable" + default: "disable" + order: 0 + - title: "allow" + additionalProperties: false + description: "Allow SSL mode." + required: + - "mode" + properties: + mode: + type: "string" + const: "allow" + enum: + - "allow" + default: "allow" + order: 0 + - title: "prefer" + additionalProperties: false + description: "Prefer SSL mode." + required: + - "mode" + properties: + mode: + type: "string" + const: "prefer" + enum: + - "prefer" + default: "prefer" + order: 0 + - title: "require" + additionalProperties: false + description: "Require SSL mode." + required: + - "mode" + properties: + mode: + type: "string" + const: "require" + enum: + - "require" + default: "require" + order: 0 + - title: "verify-ca" + additionalProperties: false + description: "Verify-ca SSL mode." + required: + - "mode" + - "ssl_ca_certificate" + properties: + mode: + type: "string" + const: "verify-ca" + enum: + - "verify-ca" + default: "verify-ca" + order: 0 + ssl_ca_certificate: + type: "string" + title: "CA certificate" + description: "Specifies the file name of a PEM file that contains\ + \ Certificate Authority (CA) certificates for use with SSLMODE=verify-ca.\n\ + \ See more information - in the docs." + airbyte_secret: true + multiline: true + order: 1 + - title: "verify-full" + additionalProperties: false + description: "Verify-full SSL mode." + required: + - "mode" + - "ssl_ca_certificate" + properties: + mode: + type: "string" + const: "verify-full" + enum: + - "verify-full" + default: "verify-full" + order: 0 + ssl_ca_certificate: + type: "string" + title: "CA certificate" + description: "Specifies the file name of a PEM file that contains\ + \ Certificate Authority (CA) certificates for use with SSLMODE=verify-full.\n\ + \ See more information - in the docs." + airbyte_secret: true + multiline: true + order: 1 + jdbc_url_params: + description: "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)." + title: "JDBC URL Params" + type: "string" + order: 7 + destination-pinecone: + title: "Destination Config" + description: "The configuration model for the Vector DB based destinations.\ + \ This model is used to generate the UI for the destination configuration,\n\ + as well as to provide type safety for the configuration passed to the destination.\n\ + \nThe configuration model is composed of four parts:\n* Processing configuration\n\ + * Embedding configuration\n* Indexing configuration\n* Advanced configuration\n\ + \nProcessing, embedding and advanced configuration are provided by this base\ + \ class, while the indexing configuration is provided by the destination connector\ + \ in the sub class." + type: "object" + properties: + embedding: + title: "Embedding" + description: "Embedding configuration" + group: "embedding" + type: "object" + oneOf: + - title: "OpenAI" + type: "object" + properties: + mode: + title: "Mode" + default: "openai" + const: "openai" + enum: + - "openai" + type: "string" + openai_key: + title: "OpenAI API key" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + required: + - "openai_key" + - "mode" + description: "Use the OpenAI API to embed text. This option is using the\ + \ text-embedding-ada-002 model with 1536 embedding dimensions." + - title: "Cohere" + type: "object" + properties: + mode: + title: "Mode" + default: "cohere" + const: "cohere" + enum: + - "cohere" + type: "string" + cohere_key: + title: "Cohere API key" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + required: + - "cohere_key" + - "mode" + description: "Use the Cohere API to embed text." + - title: "Fake" + type: "object" + properties: + mode: + title: "Mode" + default: "fake" + const: "fake" + enum: + - "fake" + type: "string" + description: "Use a fake embedding made out of random vectors with 1536\ + \ embedding dimensions. This is useful for testing the data pipeline\ + \ without incurring any costs." + required: + - "mode" + - title: "Azure OpenAI" + type: "object" + properties: + mode: + title: "Mode" + default: "azure_openai" + const: "azure_openai" + enum: + - "azure_openai" + type: "string" + openai_key: + title: "Azure OpenAI API key" + description: "The API key for your Azure OpenAI resource. You can\ + \ find this in the Azure portal under your Azure OpenAI resource" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + api_base: + title: "Resource base URL" + description: "The base URL for your Azure OpenAI resource. You can\ + \ find this in the Azure portal under your Azure OpenAI resource" + examples: + - "https://your-resource-name.openai.azure.com" + type: "string" + deployment: + title: "Deployment" + description: "The deployment for your Azure OpenAI resource. You\ + \ can find this in the Azure portal under your Azure OpenAI resource" + examples: + - "your-resource-name" + type: "string" + required: + - "openai_key" + - "api_base" + - "deployment" + - "mode" + description: "Use the Azure-hosted OpenAI API to embed text. This option\ + \ is using the text-embedding-ada-002 model with 1536 embedding dimensions." + - title: "OpenAI-compatible" + type: "object" + properties: + mode: + title: "Mode" + default: "openai_compatible" + const: "openai_compatible" + enum: + - "openai_compatible" + type: "string" + api_key: + title: "API key" + default: "" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + base_url: + title: "Base URL" + description: "The base URL for your OpenAI-compatible service" + examples: + - "https://your-service-name.com" + type: "string" + model_name: + title: "Model name" + description: "The name of the model to use for embedding" + default: "text-embedding-ada-002" + examples: + - "text-embedding-ada-002" + type: "string" + dimensions: + title: "Embedding dimensions" + description: "The number of dimensions the embedding model is generating" + examples: + - 1536 + - 384 + type: "integer" + required: + - "base_url" + - "dimensions" + - "mode" + description: "Use a service that's compatible with the OpenAI API to embed\ + \ text." + processing: + title: "ProcessingConfigModel" + type: "object" + properties: + chunk_size: + title: "Chunk size" + description: "Size of chunks in tokens to store in vector store (make\ + \ sure it is not too big for the context if your LLM)" + maximum: 8191 + minimum: 1 + type: "integer" + chunk_overlap: + title: "Chunk overlap" + description: "Size of overlap between chunks in tokens to store in vector\ + \ store to better capture relevant context" + default: 0 + type: "integer" + text_fields: + title: "Text fields to embed" + description: "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." + default: [] + always_show: true + examples: + - "text" + - "user.name" + - "users.*.name" + type: "array" + items: + type: "string" + metadata_fields: + title: "Fields to store as metadata" + description: "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." + default: [] + always_show: true + examples: + - "age" + - "user" + - "user.name" + type: "array" + items: + type: "string" + text_splitter: + title: "Text splitter" + description: "Split text fields into chunks based on the specified method." + type: "object" + oneOf: + - title: "By Separator" + type: "object" + properties: + mode: + title: "Mode" + default: "separator" + const: "separator" + enum: + - "separator" + type: "string" + separators: + title: "Separators" + description: "List of separator strings to split text fields by.\ + \ The separator itself needs to be wrapped in double quotes,\ + \ e.g. to split by the dot character, use \".\". To split by\ + \ a newline, use \"\\n\"." + default: + - "\"\\n\\n\"" + - "\"\\n\"" + - "\" \"" + - "\"\"" + type: "array" + items: + type: "string" + keep_separator: + title: "Keep separator" + description: "Whether to keep the separator in the resulting chunks" + default: false + type: "boolean" + description: "Split the text by the list of separators until the chunk\ + \ size is reached, using the earlier mentioned separators where\ + \ possible. This is useful for splitting text fields by paragraphs,\ + \ sentences, words, etc." + required: + - "mode" + - title: "By Markdown header" + type: "object" + properties: + mode: + title: "Mode" + default: "markdown" + const: "markdown" + enum: + - "markdown" + type: "string" + split_level: + title: "Split level" + description: "Level of markdown headers to split text fields by.\ + \ Headings down to the specified level will be used as split\ + \ points" + default: 1 + minimum: 1 + maximum: 6 + type: "integer" + description: "Split the text by Markdown headers down to the specified\ + \ header level. If the chunk size fits multiple sections, they will\ + \ be combined into a single chunk." + required: + - "mode" + - title: "By Programming Language" + type: "object" + properties: + mode: + title: "Mode" + default: "code" + const: "code" + enum: + - "code" + type: "string" + language: + title: "Language" + description: "Split code in suitable places based on the programming\ + \ language" + enum: + - "cpp" + - "go" + - "java" + - "js" + - "php" + - "proto" + - "python" + - "rst" + - "ruby" + - "rust" + - "scala" + - "swift" + - "markdown" + - "latex" + - "html" + - "sol" + type: "string" + required: + - "language" + - "mode" + description: "Split the text by suitable delimiters based on the programming\ + \ language. This is useful for splitting code into chunks." + field_name_mappings: + title: "Field name mappings" + description: "List of fields to rename. Not applicable for nested fields,\ + \ but can be used to rename fields already flattened via dot notation." + default: [] + type: "array" + items: + title: "FieldNameMappingConfigModel" + type: "object" + properties: + from_field: + title: "From field name" + description: "The field name in the source" + type: "string" + to_field: + title: "To field name" + description: "The field name to use in the destination" + type: "string" + required: + - "from_field" + - "to_field" + required: + - "chunk_size" + group: "processing" + omit_raw_text: + title: "Do not store raw text" + description: "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." + default: false + group: "advanced" + type: "boolean" + indexing: + title: "Indexing" + type: "object" + properties: + pinecone_key: + title: "Pinecone API key" + description: "The Pinecone API key to use matching the environment (copy\ + \ from Pinecone console)" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + pinecone_environment: + title: "Pinecone Environment" + description: "Pinecone Cloud environment to use" + examples: + - "us-west1-gcp" + - "gcp-starter" + type: "string" + index: + title: "Index" + description: "Pinecone index in your project to load data into" + type: "string" + required: + - "pinecone_key" + - "pinecone_environment" + - "index" + description: "Pinecone is a popular vector store that can be used to store\ + \ and retrieve embeddings." + group: "indexing" + destinationType: + title: "pinecone" + const: "pinecone" + enum: + - "pinecone" + order: 0 + type: "string" + required: + - "embedding" + - "processing" + - "indexing" + - "destinationType" + groups: + - id: "processing" + title: "Processing" + - id: "embedding" + title: "Embedding" + - id: "indexing" + title: "Indexing" + - id: "advanced" + title: "Advanced" + destination-pinecone-update: + title: "Destination Config" + description: "The configuration model for the Vector DB based destinations.\ + \ This model is used to generate the UI for the destination configuration,\n\ + as well as to provide type safety for the configuration passed to the destination.\n\ + \nThe configuration model is composed of four parts:\n* Processing configuration\n\ + * Embedding configuration\n* Indexing configuration\n* Advanced configuration\n\ + \nProcessing, embedding and advanced configuration are provided by this base\ + \ class, while the indexing configuration is provided by the destination connector\ + \ in the sub class." + type: "object" + properties: + embedding: + title: "Embedding" + description: "Embedding configuration" + group: "embedding" + type: "object" + oneOf: + - title: "OpenAI" + type: "object" + properties: + mode: + title: "Mode" + default: "openai" + const: "openai" + enum: + - "openai" + type: "string" + openai_key: + title: "OpenAI API key" + airbyte_secret: true + type: "string" + required: + - "openai_key" + - "mode" + description: "Use the OpenAI API to embed text. This option is using the\ + \ text-embedding-ada-002 model with 1536 embedding dimensions." + - title: "Cohere" + type: "object" + properties: + mode: + title: "Mode" + default: "cohere" + const: "cohere" + enum: + - "cohere" + type: "string" + cohere_key: + title: "Cohere API key" + airbyte_secret: true + type: "string" + required: + - "cohere_key" + - "mode" + description: "Use the Cohere API to embed text." + - title: "Fake" + type: "object" + properties: + mode: + title: "Mode" + default: "fake" + const: "fake" + enum: + - "fake" + type: "string" + description: "Use a fake embedding made out of random vectors with 1536\ + \ embedding dimensions. This is useful for testing the data pipeline\ + \ without incurring any costs." + required: + - "mode" + - title: "Azure OpenAI" + type: "object" + properties: + mode: + title: "Mode" + default: "azure_openai" + const: "azure_openai" + enum: + - "azure_openai" + type: "string" + openai_key: + title: "Azure OpenAI API key" + description: "The API key for your Azure OpenAI resource. You can\ + \ find this in the Azure portal under your Azure OpenAI resource" + airbyte_secret: true + type: "string" + api_base: + title: "Resource base URL" + description: "The base URL for your Azure OpenAI resource. You can\ + \ find this in the Azure portal under your Azure OpenAI resource" + examples: + - "https://your-resource-name.openai.azure.com" + type: "string" + deployment: + title: "Deployment" + description: "The deployment for your Azure OpenAI resource. You\ + \ can find this in the Azure portal under your Azure OpenAI resource" + examples: + - "your-resource-name" + type: "string" + required: + - "openai_key" + - "api_base" + - "deployment" + - "mode" + description: "Use the Azure-hosted OpenAI API to embed text. This option\ + \ is using the text-embedding-ada-002 model with 1536 embedding dimensions." + - title: "OpenAI-compatible" + type: "object" + properties: + mode: + title: "Mode" + default: "openai_compatible" + const: "openai_compatible" + enum: + - "openai_compatible" + type: "string" + api_key: + title: "API key" + default: "" + airbyte_secret: true + type: "string" + base_url: + title: "Base URL" + description: "The base URL for your OpenAI-compatible service" + examples: + - "https://your-service-name.com" + type: "string" + model_name: + title: "Model name" + description: "The name of the model to use for embedding" + default: "text-embedding-ada-002" + examples: + - "text-embedding-ada-002" + type: "string" + dimensions: + title: "Embedding dimensions" + description: "The number of dimensions the embedding model is generating" + examples: + - 1536 + - 384 + type: "integer" + required: + - "base_url" + - "dimensions" + - "mode" + description: "Use a service that's compatible with the OpenAI API to embed\ + \ text." + processing: + title: "ProcessingConfigModel" + type: "object" + properties: + chunk_size: + title: "Chunk size" + description: "Size of chunks in tokens to store in vector store (make\ + \ sure it is not too big for the context if your LLM)" + maximum: 8191 + minimum: 1 + type: "integer" + chunk_overlap: + title: "Chunk overlap" + description: "Size of overlap between chunks in tokens to store in vector\ + \ store to better capture relevant context" + default: 0 + type: "integer" + text_fields: + title: "Text fields to embed" + description: "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." + default: [] + always_show: true + examples: + - "text" + - "user.name" + - "users.*.name" + type: "array" + items: + type: "string" + metadata_fields: + title: "Fields to store as metadata" + description: "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." + default: [] + always_show: true + examples: + - "age" + - "user" + - "user.name" + type: "array" + items: + type: "string" + text_splitter: + title: "Text splitter" + description: "Split text fields into chunks based on the specified method." + type: "object" + oneOf: + - title: "By Separator" + type: "object" + properties: + mode: + title: "Mode" + default: "separator" + const: "separator" + enum: + - "separator" + type: "string" + separators: + title: "Separators" + description: "List of separator strings to split text fields by.\ + \ The separator itself needs to be wrapped in double quotes,\ + \ e.g. to split by the dot character, use \".\". To split by\ + \ a newline, use \"\\n\"." + default: + - "\"\\n\\n\"" + - "\"\\n\"" + - "\" \"" + - "\"\"" + type: "array" + items: + type: "string" + keep_separator: + title: "Keep separator" + description: "Whether to keep the separator in the resulting chunks" + default: false + type: "boolean" + description: "Split the text by the list of separators until the chunk\ + \ size is reached, using the earlier mentioned separators where\ + \ possible. This is useful for splitting text fields by paragraphs,\ + \ sentences, words, etc." + required: + - "mode" + - title: "By Markdown header" + type: "object" + properties: + mode: + title: "Mode" + default: "markdown" + const: "markdown" + enum: + - "markdown" + type: "string" + split_level: + title: "Split level" + description: "Level of markdown headers to split text fields by.\ + \ Headings down to the specified level will be used as split\ + \ points" + default: 1 + minimum: 1 + maximum: 6 + type: "integer" + description: "Split the text by Markdown headers down to the specified\ + \ header level. If the chunk size fits multiple sections, they will\ + \ be combined into a single chunk." + required: + - "mode" + - title: "By Programming Language" + type: "object" + properties: + mode: + title: "Mode" + default: "code" + const: "code" + enum: + - "code" + type: "string" + language: + title: "Language" + description: "Split code in suitable places based on the programming\ + \ language" + enum: + - "cpp" + - "go" + - "java" + - "js" + - "php" + - "proto" + - "python" + - "rst" + - "ruby" + - "rust" + - "scala" + - "swift" + - "markdown" + - "latex" + - "html" + - "sol" + type: "string" + required: + - "language" + - "mode" + description: "Split the text by suitable delimiters based on the programming\ + \ language. This is useful for splitting code into chunks." + field_name_mappings: + title: "Field name mappings" + description: "List of fields to rename. Not applicable for nested fields,\ + \ but can be used to rename fields already flattened via dot notation." + default: [] + type: "array" + items: + title: "FieldNameMappingConfigModel" + type: "object" + properties: + from_field: + title: "From field name" + description: "The field name in the source" + type: "string" + to_field: + title: "To field name" + description: "The field name to use in the destination" + type: "string" + required: + - "from_field" + - "to_field" + required: + - "chunk_size" + group: "processing" + omit_raw_text: + title: "Do not store raw text" + description: "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." + default: false + group: "advanced" + type: "boolean" + indexing: + title: "Indexing" + type: "object" + properties: + pinecone_key: + title: "Pinecone API key" + description: "The Pinecone API key to use matching the environment (copy\ + \ from Pinecone console)" + airbyte_secret: true + type: "string" + pinecone_environment: + title: "Pinecone Environment" + description: "Pinecone Cloud environment to use" + examples: + - "us-west1-gcp" + - "gcp-starter" + type: "string" + index: + title: "Index" + description: "Pinecone index in your project to load data into" + type: "string" + required: + - "pinecone_key" + - "pinecone_environment" + - "index" + description: "Pinecone is a popular vector store that can be used to store\ + \ and retrieve embeddings." + group: "indexing" + required: + - "embedding" + - "processing" + - "indexing" + groups: + - id: "processing" + title: "Processing" + - id: "embedding" + title: "Embedding" + - id: "indexing" + title: "Indexing" + - id: "advanced" + title: "Advanced" + destination-duckdb: + title: "Destination Duckdb" + type: "object" + required: + - "destination_path" + - "destinationType" + properties: + motherduck_api_key: + title: "MotherDuck API Key" + type: "string" + description: "API key to use for authentication to a MotherDuck database." + airbyte_secret: true + x-speakeasy-param-sensitive: true + destination_path: + title: "Destination DB" + type: "string" + description: "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" + examples: + - "/local/destination.duckdb" + - "md:" + - "motherduck:" + schema: + title: "Destination Schema" + type: "string" + description: "Database schema name, default for duckdb is 'main'." + example: "main" + destinationType: + title: "duckdb" + const: "duckdb" + enum: + - "duckdb" + order: 0 + type: "string" + destination-duckdb-update: + title: "Destination Duckdb" + type: "object" + required: + - "destination_path" + properties: + motherduck_api_key: + title: "MotherDuck API Key" + type: "string" + description: "API key to use for authentication to a MotherDuck database." + airbyte_secret: true + destination_path: + title: "Destination DB" + type: "string" + description: "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" + examples: + - "/local/destination.duckdb" + - "md:" + - "motherduck:" + schema: + title: "Destination Schema" + type: "string" + description: "Database schema name, default for duckdb is 'main'." + example: "main" + destination-sftp-json: + title: "Destination SFTP JSON" + type: "object" + required: + - "host" + - "username" + - "password" + - "destination_path" + - "destinationType" + properties: + host: + title: "Host" + description: "Hostname of the SFTP server." + type: "string" + order: 0 + port: + title: "Port" + description: "Port of the SFTP server." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - 22 + order: 1 + username: + title: "User" + description: "Username to use to access the SFTP server." + type: "string" + order: 2 + password: + title: "Password" + description: "Password associated with the username." + type: "string" + airbyte_secret: true + order: 3 + x-speakeasy-param-sensitive: true + destination_path: + title: "Destination path" + type: "string" + description: "Path to the directory where json files will be written." + examples: + - "/json_data" + order: 4 + destinationType: + title: "sftp-json" + const: "sftp-json" + enum: + - "sftp-json" + order: 0 + type: "string" + destination-sftp-json-update: + title: "Destination SFTP JSON" + type: "object" + required: + - "host" + - "username" + - "password" + - "destination_path" + properties: + host: + title: "Host" + description: "Hostname of the SFTP server." + type: "string" + order: 0 + port: + title: "Port" + description: "Port of the SFTP server." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - 22 + order: 1 + username: + title: "User" + description: "Username to use to access the SFTP server." + type: "string" + order: 2 + password: + title: "Password" + description: "Password associated with the username." + type: "string" + airbyte_secret: true + order: 3 + destination_path: + title: "Destination path" + type: "string" + description: "Path to the directory where json files will be written." + examples: + - "/json_data" + order: 4 + destination-s3: + title: "S3 Destination Spec" + type: "object" + required: + - "s3_bucket_name" + - "s3_bucket_path" + - "s3_bucket_region" + - "format" + - "destinationType" + properties: + access_key_id: + type: "string" + description: "The access key ID to access the S3 bucket. Airbyte requires\ + \ Read and Write permissions to the given bucket. Read more here." + title: "S3 Key ID" + airbyte_secret: true + always_show: true + examples: + - "A012345678910EXAMPLE" + order: 0 + x-speakeasy-param-sensitive: true + secret_access_key: + type: "string" + description: "The corresponding secret to the access key ID. Read more here" + title: "S3 Access Key" + airbyte_secret: true + always_show: true + examples: + - "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY" + order: 1 + x-speakeasy-param-sensitive: true + s3_bucket_name: + title: "S3 Bucket Name" + type: "string" + description: "The name of the S3 bucket. Read more here." + examples: + - "airbyte_sync" + order: 2 + s3_bucket_path: + title: "S3 Bucket Path" + description: "Directory under the S3 bucket where data will be written.\ + \ Read more here" + type: "string" + examples: + - "data_sync/test" + order: 3 + s3_bucket_region: + title: "S3 Bucket Region" + type: "string" + default: "" + description: "The region of the S3 bucket. See here for all region codes." + enum: + - "" + - "af-south-1" + - "ap-east-1" + - "ap-northeast-1" + - "ap-northeast-2" + - "ap-northeast-3" + - "ap-south-1" + - "ap-south-2" + - "ap-southeast-1" + - "ap-southeast-2" + - "ap-southeast-3" + - "ap-southeast-4" + - "ca-central-1" + - "ca-west-1" + - "cn-north-1" + - "cn-northwest-1" + - "eu-central-1" + - "eu-central-2" + - "eu-north-1" + - "eu-south-1" + - "eu-south-2" + - "eu-west-1" + - "eu-west-2" + - "eu-west-3" + - "il-central-1" + - "me-central-1" + - "me-south-1" + - "sa-east-1" + - "us-east-1" + - "us-east-2" + - "us-gov-east-1" + - "us-gov-west-1" + - "us-west-1" + - "us-west-2" + order: 4 + format: + title: "Output Format" + type: "object" + description: "Format of the data output. See here for more details" + oneOf: + - title: "CSV: Comma-Separated Values" + required: + - "format_type" + - "flattening" + properties: + format_type: + title: "Format Type" + type: "string" + enum: + - "CSV" + default: "CSV" + flattening: + type: "string" + title: "Flattening" + description: "Whether the input json data should be normalized (flattened)\ + \ in the output CSV. Please refer to docs for details." + default: "No flattening" + enum: + - "No flattening" + - "Root level flattening" + compression: + title: "Compression" + type: "object" + description: "Whether the output files should be compressed. If compression\ + \ is selected, the output filename will have an extra extension\ + \ (GZIP: \".csv.gz\")." + oneOf: + - title: "No Compression" + requires: + - "compression_type" + properties: + compression_type: + type: "string" + enum: + - "No Compression" + default: "No Compression" + - title: "GZIP" + requires: + - "compression_type" + properties: + compression_type: + type: "string" + enum: + - "GZIP" + default: "GZIP" + - title: "JSON Lines: Newline-delimited JSON" + required: + - "format_type" + properties: + format_type: + title: "Format Type" + type: "string" + enum: + - "JSONL" + default: "JSONL" + flattening: + type: "string" + title: "Flattening" + description: "Whether the input json data should be normalized (flattened)\ + \ in the output JSON Lines. Please refer to docs for details." + default: "No flattening" + enum: + - "No flattening" + - "Root level flattening" + compression: + title: "Compression" + type: "object" + description: "Whether the output files should be compressed. If compression\ + \ is selected, the output filename will have an extra extension\ + \ (GZIP: \".jsonl.gz\")." + oneOf: + - title: "No Compression" + requires: "compression_type" + properties: + compression_type: + type: "string" + enum: + - "No Compression" + default: "No Compression" + - title: "GZIP" + requires: "compression_type" + properties: + compression_type: + type: "string" + enum: + - "GZIP" + default: "GZIP" + - title: "Avro: Apache Avro" + required: + - "format_type" + - "compression_codec" + properties: + format_type: + title: "Format Type" + type: "string" + enum: + - "Avro" + default: "Avro" + order: 0 + compression_codec: + title: "Compression Codec" + description: "The compression algorithm used to compress data. Default\ + \ to no compression." + type: "object" + oneOf: + - title: "No Compression" + required: + - "codec" + properties: + codec: + type: "string" + enum: + - "no compression" + default: "no compression" + - title: "Deflate" + required: + - "codec" + - "compression_level" + properties: + codec: + type: "string" + enum: + - "Deflate" + default: "Deflate" + compression_level: + title: "Deflate Level" + description: "0: no compression & fastest, 9: best compression\ + \ & slowest." + type: "integer" + default: 0 + minimum: 0 + maximum: 9 + - title: "bzip2" + required: + - "codec" + properties: + codec: + type: "string" + enum: + - "bzip2" + default: "bzip2" + - title: "xz" + required: + - "codec" + - "compression_level" + properties: + codec: + type: "string" + enum: + - "xz" + default: "xz" + compression_level: + title: "Compression Level" + description: "See here for details." + type: "integer" + default: 6 + minimum: 0 + maximum: 9 + - title: "zstandard" + required: + - "codec" + - "compression_level" + properties: + codec: + type: "string" + enum: + - "zstandard" + default: "zstandard" + compression_level: + title: "Compression Level" + description: "Negative levels are 'fast' modes akin to lz4 or\ + \ snappy, levels above 9 are generally for archival purposes,\ + \ and levels above 18 use a lot of memory." + type: "integer" + default: 3 + minimum: -5 + maximum: 22 + include_checksum: + title: "Include Checksum" + description: "If true, include a checksum with each data block." + type: "boolean" + default: false + - title: "snappy" + required: + - "codec" + properties: + codec: + type: "string" + enum: + - "snappy" + default: "snappy" + order: 1 + - title: "Parquet: Columnar Storage" + required: + - "format_type" + properties: + format_type: + title: "Format Type" + type: "string" + enum: + - "Parquet" + default: "Parquet" + compression_codec: + title: "Compression Codec" + description: "The compression algorithm used to compress data pages." + type: "string" + enum: + - "UNCOMPRESSED" + - "SNAPPY" + - "GZIP" + - "LZO" + - "BROTLI" + - "LZ4" + - "ZSTD" + default: "UNCOMPRESSED" + block_size_mb: + title: "Block Size (Row Group Size) (MB)" + description: "This is the size of a row group being buffered in memory.\ + \ It limits the memory usage when writing. Larger values will improve\ + \ the IO when reading, but consume more memory when writing. Default:\ + \ 128 MB." + type: "integer" + default: 128 + examples: + - 128 + max_padding_size_mb: + title: "Max Padding Size (MB)" + description: "Maximum size allowed as padding to align row groups.\ + \ This is also the minimum size of a row group. Default: 8 MB." + type: "integer" + default: 8 + examples: + - 8 + page_size_kb: + title: "Page Size (KB)" + description: "The page size is for compression. A block is composed\ + \ of pages. A page is the smallest unit that must be read fully\ + \ to access a single record. If this value is too small, the compression\ + \ will deteriorate. Default: 1024 KB." + type: "integer" + default: 1024 + examples: + - 1024 + dictionary_page_size_kb: + title: "Dictionary Page Size (KB)" + description: "There is one dictionary page per column per row group\ + \ when dictionary encoding is used. The dictionary page size works\ + \ like the page size but for dictionary. Default: 1024 KB." + type: "integer" + default: 1024 + examples: + - 1024 + dictionary_encoding: + title: "Dictionary Encoding" + description: "Default: true." + type: "boolean" + default: true + order: 5 + s3_endpoint: + title: "Endpoint" + type: "string" + default: "" + description: "Your S3 endpoint url. Read more here" + examples: + - "http://localhost:9000" + order: 6 + s3_path_format: + title: "S3 Path Format" + description: "Format string on how data will be organized inside the S3\ + \ bucket directory. Read more here" + type: "string" + examples: + - "${NAMESPACE}/${STREAM_NAME}/${YEAR}_${MONTH}_${DAY}_${EPOCH}_" + order: 7 + file_name_pattern: + type: "string" + description: "The pattern allows you to set the file-name format for the\ + \ S3 staging file(s)" + title: "S3 Filename pattern" + examples: + - "{date}" + - "{date:yyyy_MM}" + - "{timestamp}" + - "{part_number}" + - "{sync_id}" + order: 8 + destinationType: + title: "s3" + const: "s3" + enum: + - "s3" + order: 0 + type: "string" + destination-s3-update: + title: "S3 Destination Spec" + type: "object" + required: + - "s3_bucket_name" + - "s3_bucket_path" + - "s3_bucket_region" + - "format" + properties: + access_key_id: + type: "string" + description: "The access key ID to access the S3 bucket. Airbyte requires\ + \ Read and Write permissions to the given bucket. Read more here." + title: "S3 Key ID" + airbyte_secret: true + always_show: true + examples: + - "A012345678910EXAMPLE" + order: 0 + secret_access_key: + type: "string" + description: "The corresponding secret to the access key ID. Read more here" + title: "S3 Access Key" + airbyte_secret: true + always_show: true + examples: + - "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY" + order: 1 + s3_bucket_name: + title: "S3 Bucket Name" + type: "string" + description: "The name of the S3 bucket. Read more here." + examples: + - "airbyte_sync" + order: 2 + s3_bucket_path: + title: "S3 Bucket Path" + description: "Directory under the S3 bucket where data will be written.\ + \ Read more here" + type: "string" + examples: + - "data_sync/test" + order: 3 + s3_bucket_region: + title: "S3 Bucket Region" + type: "string" + default: "" + description: "The region of the S3 bucket. See here for all region codes." + enum: + - "" + - "af-south-1" + - "ap-east-1" + - "ap-northeast-1" + - "ap-northeast-2" + - "ap-northeast-3" + - "ap-south-1" + - "ap-south-2" + - "ap-southeast-1" + - "ap-southeast-2" + - "ap-southeast-3" + - "ap-southeast-4" + - "ca-central-1" + - "ca-west-1" + - "cn-north-1" + - "cn-northwest-1" + - "eu-central-1" + - "eu-central-2" + - "eu-north-1" + - "eu-south-1" + - "eu-south-2" + - "eu-west-1" + - "eu-west-2" + - "eu-west-3" + - "il-central-1" + - "me-central-1" + - "me-south-1" + - "sa-east-1" + - "us-east-1" + - "us-east-2" + - "us-gov-east-1" + - "us-gov-west-1" + - "us-west-1" + - "us-west-2" + order: 4 + format: + title: "Output Format" + type: "object" + description: "Format of the data output. See here for more details" + oneOf: + - title: "CSV: Comma-Separated Values" + required: + - "format_type" + - "flattening" + properties: + format_type: + title: "Format Type" + type: "string" + enum: + - "CSV" + default: "CSV" + flattening: + type: "string" + title: "Flattening" + description: "Whether the input json data should be normalized (flattened)\ + \ in the output CSV. Please refer to docs for details." + default: "No flattening" + enum: + - "No flattening" + - "Root level flattening" + compression: + title: "Compression" + type: "object" + description: "Whether the output files should be compressed. If compression\ + \ is selected, the output filename will have an extra extension\ + \ (GZIP: \".csv.gz\")." + oneOf: + - title: "No Compression" + requires: + - "compression_type" + properties: + compression_type: + type: "string" + enum: + - "No Compression" + default: "No Compression" + - title: "GZIP" + requires: + - "compression_type" + properties: + compression_type: + type: "string" + enum: + - "GZIP" + default: "GZIP" + - title: "JSON Lines: Newline-delimited JSON" + required: + - "format_type" + properties: + format_type: + title: "Format Type" + type: "string" + enum: + - "JSONL" + default: "JSONL" + flattening: + type: "string" + title: "Flattening" + description: "Whether the input json data should be normalized (flattened)\ + \ in the output JSON Lines. Please refer to docs for details." + default: "No flattening" + enum: + - "No flattening" + - "Root level flattening" + compression: + title: "Compression" + type: "object" + description: "Whether the output files should be compressed. If compression\ + \ is selected, the output filename will have an extra extension\ + \ (GZIP: \".jsonl.gz\")." + oneOf: + - title: "No Compression" + requires: "compression_type" + properties: + compression_type: + type: "string" + enum: + - "No Compression" + default: "No Compression" + - title: "GZIP" + requires: "compression_type" + properties: + compression_type: + type: "string" + enum: + - "GZIP" + default: "GZIP" + - title: "Avro: Apache Avro" + required: + - "format_type" + - "compression_codec" + properties: + format_type: + title: "Format Type" + type: "string" + enum: + - "Avro" + default: "Avro" + order: 0 + compression_codec: + title: "Compression Codec" + description: "The compression algorithm used to compress data. Default\ + \ to no compression." + type: "object" + oneOf: + - title: "No Compression" + required: + - "codec" + properties: + codec: + type: "string" + enum: + - "no compression" + default: "no compression" + - title: "Deflate" + required: + - "codec" + - "compression_level" + properties: + codec: + type: "string" + enum: + - "Deflate" + default: "Deflate" + compression_level: + title: "Deflate Level" + description: "0: no compression & fastest, 9: best compression\ + \ & slowest." + type: "integer" + default: 0 + minimum: 0 + maximum: 9 + - title: "bzip2" + required: + - "codec" + properties: + codec: + type: "string" + enum: + - "bzip2" + default: "bzip2" + - title: "xz" + required: + - "codec" + - "compression_level" + properties: + codec: + type: "string" + enum: + - "xz" + default: "xz" + compression_level: + title: "Compression Level" + description: "See here for details." + type: "integer" + default: 6 + minimum: 0 + maximum: 9 + - title: "zstandard" + required: + - "codec" + - "compression_level" + properties: + codec: + type: "string" + enum: + - "zstandard" + default: "zstandard" + compression_level: + title: "Compression Level" + description: "Negative levels are 'fast' modes akin to lz4 or\ + \ snappy, levels above 9 are generally for archival purposes,\ + \ and levels above 18 use a lot of memory." + type: "integer" + default: 3 + minimum: -5 + maximum: 22 + include_checksum: + title: "Include Checksum" + description: "If true, include a checksum with each data block." + type: "boolean" + default: false + - title: "snappy" + required: + - "codec" + properties: + codec: + type: "string" + enum: + - "snappy" + default: "snappy" + order: 1 + - title: "Parquet: Columnar Storage" + required: + - "format_type" + properties: + format_type: + title: "Format Type" + type: "string" + enum: + - "Parquet" + default: "Parquet" + compression_codec: + title: "Compression Codec" + description: "The compression algorithm used to compress data pages." + type: "string" + enum: + - "UNCOMPRESSED" + - "SNAPPY" + - "GZIP" + - "LZO" + - "BROTLI" + - "LZ4" + - "ZSTD" + default: "UNCOMPRESSED" + block_size_mb: + title: "Block Size (Row Group Size) (MB)" + description: "This is the size of a row group being buffered in memory.\ + \ It limits the memory usage when writing. Larger values will improve\ + \ the IO when reading, but consume more memory when writing. Default:\ + \ 128 MB." + type: "integer" + default: 128 + examples: + - 128 + max_padding_size_mb: + title: "Max Padding Size (MB)" + description: "Maximum size allowed as padding to align row groups.\ + \ This is also the minimum size of a row group. Default: 8 MB." + type: "integer" + default: 8 + examples: + - 8 + page_size_kb: + title: "Page Size (KB)" + description: "The page size is for compression. A block is composed\ + \ of pages. A page is the smallest unit that must be read fully\ + \ to access a single record. If this value is too small, the compression\ + \ will deteriorate. Default: 1024 KB." + type: "integer" + default: 1024 + examples: + - 1024 + dictionary_page_size_kb: + title: "Dictionary Page Size (KB)" + description: "There is one dictionary page per column per row group\ + \ when dictionary encoding is used. The dictionary page size works\ + \ like the page size but for dictionary. Default: 1024 KB." + type: "integer" + default: 1024 + examples: + - 1024 + dictionary_encoding: + title: "Dictionary Encoding" + description: "Default: true." + type: "boolean" + default: true + order: 5 + s3_endpoint: + title: "Endpoint" + type: "string" + default: "" + description: "Your S3 endpoint url. Read more here" + examples: + - "http://localhost:9000" + order: 6 + s3_path_format: + title: "S3 Path Format" + description: "Format string on how data will be organized inside the S3\ + \ bucket directory. Read more here" + type: "string" + examples: + - "${NAMESPACE}/${STREAM_NAME}/${YEAR}_${MONTH}_${DAY}_${EPOCH}_" + order: 7 + file_name_pattern: + type: "string" + description: "The pattern allows you to set the file-name format for the\ + \ S3 staging file(s)" + title: "S3 Filename pattern" + examples: + - "{date}" + - "{date:yyyy_MM}" + - "{timestamp}" + - "{part_number}" + - "{sync_id}" + order: 8 + destination-redis: + title: "Redis Destination Spec" + type: "object" + required: + - "host" + - "username" + - "port" + - "cache_type" + - "destinationType" + properties: + host: + title: "Host" + description: "Redis host to connect to." + type: "string" + examples: + - "localhost,127.0.0.1" + order: 1 + port: + title: "Port" + description: "Port of Redis." + type: "integer" + minimum: 0 + maximum: 65536 + default: 6379 + order: 2 + username: + title: "Username" + description: "Username associated with Redis." + type: "string" + order: 3 + password: + title: "Password" + description: "Password associated with Redis." + type: "string" + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + ssl: + title: "SSL Connection" + type: "boolean" + description: "Indicates whether SSL encryption protocol will be used to\ + \ connect to Redis. It is recommended to use SSL connection if possible." + default: false + order: 5 + ssl_mode: + title: "SSL Modes" + description: "SSL connection modes. \n
  • verify-full - This is\ + \ the most secure mode. Always require encryption and verifies the identity\ + \ of the source database server" + type: "object" + order: 6 + oneOf: + - title: "disable" + additionalProperties: false + description: "Disable SSL." + required: + - "mode" + properties: + mode: + type: "string" + const: "disable" + enum: + - "disable" + default: "disable" + order: 0 + - title: "verify-full" + additionalProperties: false + description: "Verify-full SSL mode." + required: + - "mode" + - "ca_certificate" + - "client_certificate" + - "client_key" + properties: + mode: + type: "string" + const: "verify-full" + enum: + - "verify-full" + default: "verify-full" + order: 0 + ca_certificate: + type: "string" + title: "CA Certificate" + description: "CA certificate" + airbyte_secret: true + multiline: true + order: 1 + client_certificate: + type: "string" + title: "Client Certificate" + description: "Client certificate" + airbyte_secret: true + multiline: true + order: 2 + client_key: + type: "string" + title: "Client Key" + description: "Client key" + airbyte_secret: true + multiline: true + order: 3 + x-speakeasy-param-sensitive: true + client_key_password: + type: "string" + title: "Client key password" + description: "Password for keystorage. If you do not add it - the\ + \ password will be generated automatically." + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + cache_type: + title: "Cache type" + type: "string" + default: "hash" + description: "Redis cache type to store data in." + enum: + - "hash" + order: 7 + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + x-speakeasy-param-sensitive: true + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + destinationType: + title: "redis" + const: "redis" + enum: + - "redis" + order: 0 + type: "string" + destination-redis-update: + title: "Redis Destination Spec" + type: "object" + required: + - "host" + - "username" + - "port" + - "cache_type" + properties: + host: + title: "Host" + description: "Redis host to connect to." + type: "string" + examples: + - "localhost,127.0.0.1" + order: 1 + port: + title: "Port" + description: "Port of Redis." + type: "integer" + minimum: 0 + maximum: 65536 + default: 6379 + order: 2 + username: + title: "Username" + description: "Username associated with Redis." + type: "string" + order: 3 + password: + title: "Password" + description: "Password associated with Redis." + type: "string" + airbyte_secret: true + order: 4 + ssl: + title: "SSL Connection" + type: "boolean" + description: "Indicates whether SSL encryption protocol will be used to\ + \ connect to Redis. It is recommended to use SSL connection if possible." + default: false + order: 5 + ssl_mode: + title: "SSL Modes" + description: "SSL connection modes. \n
  • verify-full - This is\ + \ the most secure mode. Always require encryption and verifies the identity\ + \ of the source database server" + type: "object" + order: 6 + oneOf: + - title: "disable" + additionalProperties: false + description: "Disable SSL." + required: + - "mode" + properties: + mode: + type: "string" + const: "disable" + enum: + - "disable" + default: "disable" + order: 0 + - title: "verify-full" + additionalProperties: false + description: "Verify-full SSL mode." + required: + - "mode" + - "ca_certificate" + - "client_certificate" + - "client_key" + properties: + mode: + type: "string" + const: "verify-full" + enum: + - "verify-full" + default: "verify-full" + order: 0 + ca_certificate: + type: "string" + title: "CA Certificate" + description: "CA certificate" + airbyte_secret: true + multiline: true + order: 1 + client_certificate: + type: "string" + title: "Client Certificate" + description: "Client certificate" + airbyte_secret: true + multiline: true + order: 2 + client_key: + type: "string" + title: "Client Key" + description: "Client key" + airbyte_secret: true + multiline: true + order: 3 + client_key_password: + type: "string" + title: "Client key password" + description: "Password for keystorage. If you do not add it - the\ + \ password will be generated automatically." + airbyte_secret: true + order: 4 + cache_type: + title: "Cache type" + type: "string" + default: "hash" + description: "Redis cache type to store data in." + enum: + - "hash" + order: 7 + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + destination-typesense: + title: "Destination Typesense" + type: "object" + required: + - "api_key" + - "host" + - "destinationType" + properties: + api_key: + title: "API Key" + type: "string" + description: "Typesense API Key" + order: 0 + x-speakeasy-param-sensitive: true + host: + title: "Host" + type: "string" + description: "Hostname of the Typesense instance without protocol." + order: 1 + port: + title: "Port" + type: "string" + description: "Port of the Typesense instance. Ex: 8108, 80, 443. Default\ + \ is 443" + order: 2 + protocol: + title: "Protocol" + type: "string" + description: "Protocol of the Typesense instance. Ex: http or https. Default\ + \ is https" + order: 3 + batch_size: + title: "Batch size" + type: "integer" + description: "How many documents should be imported together. Default 1000" + order: 4 + path: + title: "Path" + type: "string" + description: "Path of the Typesense instance. Default is none" + order: 5 + destinationType: + title: "typesense" + const: "typesense" + enum: + - "typesense" + order: 0 + type: "string" + destination-typesense-update: + title: "Destination Typesense" + type: "object" + required: + - "api_key" + - "host" + properties: + api_key: + title: "API Key" + type: "string" + description: "Typesense API Key" + order: 0 + host: + title: "Host" + type: "string" + description: "Hostname of the Typesense instance without protocol." + order: 1 + port: + title: "Port" + type: "string" + description: "Port of the Typesense instance. Ex: 8108, 80, 443. Default\ + \ is 443" + order: 2 + protocol: + title: "Protocol" + type: "string" + description: "Protocol of the Typesense instance. Ex: http or https. Default\ + \ is https" + order: 3 + batch_size: + title: "Batch size" + type: "integer" + description: "How many documents should be imported together. Default 1000" + order: 4 + path: + title: "Path" + type: "string" + description: "Path of the Typesense instance. Default is none" + order: 5 + destination-bigquery: + title: "BigQuery Destination Spec" + type: "object" + required: + - "project_id" + - "dataset_location" + - "dataset_id" + - "destinationType" + properties: + project_id: + type: "string" + description: "The GCP project ID for the project containing the target BigQuery\ + \ dataset. Read more here." + title: "Project ID" + group: "connection" + order: 0 + dataset_location: + type: "string" + description: "The location of the dataset. Warning: Changes made after creation\ + \ will not be applied. Read more here." + title: "Dataset Location" + group: "connection" + order: 1 + enum: + - "US" + - "EU" + - "asia-east1" + - "asia-east2" + - "asia-northeast1" + - "asia-northeast2" + - "asia-northeast3" + - "asia-south1" + - "asia-south2" + - "asia-southeast1" + - "asia-southeast2" + - "australia-southeast1" + - "australia-southeast2" + - "europe-central1" + - "europe-central2" + - "europe-north1" + - "europe-southwest1" + - "europe-west1" + - "europe-west2" + - "europe-west3" + - "europe-west4" + - "europe-west6" + - "europe-west7" + - "europe-west8" + - "europe-west9" + - "europe-west12" + - "me-central1" + - "me-central2" + - "me-west1" + - "northamerica-northeast1" + - "northamerica-northeast2" + - "southamerica-east1" + - "southamerica-west1" + - "us-central1" + - "us-east1" + - "us-east2" + - "us-east3" + - "us-east4" + - "us-east5" + - "us-south1" + - "us-west1" + - "us-west2" + - "us-west3" + - "us-west4" + dataset_id: + type: "string" + description: "The default BigQuery Dataset ID that tables are replicated\ + \ to if the source does not specify a namespace. Read more here." + title: "Default Dataset ID" + group: "connection" + order: 2 + loading_method: + type: "object" + title: "Loading Method" + description: "The way data will be uploaded to BigQuery." + display_type: "radio" + group: "connection" + order: 3 + oneOf: + - title: "GCS Staging" + description: "(recommended) Writes large batches of records to\ + \ a file, uploads the file to GCS, then uses COPY INTO to load your\ + \ data into BigQuery. Provides best-in-class speed, reliability and\ + \ scalability. Read more about GCS Staging here." + required: + - "method" + - "gcs_bucket_name" + - "gcs_bucket_path" + - "credential" + properties: + method: + type: "string" + const: "GCS Staging" + order: 0 + enum: + - "GCS Staging" + credential: + title: "Credential" + description: "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." + type: "object" + order: 1 + oneOf: + - title: "HMAC key" + required: + - "credential_type" + - "hmac_key_access_id" + - "hmac_key_secret" + properties: + credential_type: + type: "string" + const: "HMAC_KEY" + order: 0 + enum: + - "HMAC_KEY" + hmac_key_access_id: + type: "string" + description: "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." + title: "HMAC Key Access ID" + airbyte_secret: true + examples: + - "1234567890abcdefghij1234" + order: 1 + x-speakeasy-param-sensitive: true + hmac_key_secret: + type: "string" + description: "The corresponding secret for the access ID. It\ + \ is a 40-character base-64 encoded string." + title: "HMAC Key Secret" + airbyte_secret: true + examples: + - "1234567890abcdefghij1234567890ABCDEFGHIJ" + order: 2 + x-speakeasy-param-sensitive: true + gcs_bucket_name: + title: "GCS Bucket Name" + type: "string" + description: "The name of the GCS bucket. Read more here." + examples: + - "airbyte_sync" + order: 2 + gcs_bucket_path: + title: "GCS Bucket Path" + description: "Directory under the GCS bucket where data will be written." + type: "string" + examples: + - "data_sync/test" + order: 3 + keep_files_in_gcs-bucket: + type: "string" + description: "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." + title: "GCS Tmp Files Afterward Processing" + default: "Delete all tmp files from GCS" + enum: + - "Delete all tmp files from GCS" + - "Keep all tmp files in GCS" + order: 4 + - title: "Standard Inserts" + required: + - "method" + description: "(not recommended) Direct loading using SQL INSERT\ + \ statements. This method is extremely inefficient and provided only\ + \ for quick testing. In all other cases, you should use GCS staging." + properties: + method: + type: "string" + const: "Standard" + enum: + - "Standard" + credentials_json: + type: "string" + description: "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." + title: "Service Account Key JSON (Required for cloud, optional for open-source)" + airbyte_secret: true + group: "connection" + order: 4 + always_show: true + transformation_priority: + type: "string" + description: "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." + title: "Transformation Query Run Type" + default: "interactive" + enum: + - "interactive" + - "batch" + order: 5 + group: "advanced" + big_query_client_buffer_size_mb: + title: "Google BigQuery Client Chunk Size" + description: "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." + type: "integer" + minimum: 1 + maximum: 15 + default: 15 + examples: + - "15" + order: 6 + group: "advanced" + raw_data_dataset: + type: "string" + description: "The dataset to write raw tables into (default: airbyte_internal)" + title: "Raw Table Dataset Name" + order: 7 + group: "advanced" + disable_type_dedupe: + type: "boolean" + default: false + description: "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" + title: "Disable Final Tables. (WARNING! Unstable option; Columns in raw\ + \ table schema might change between versions)" + order: 8 + group: "advanced" + destinationType: + title: "bigquery" + const: "bigquery" + enum: + - "bigquery" + order: 0 + type: "string" + groups: + - id: "connection" + title: "Connection" + - id: "advanced" + title: "Advanced" + destination-bigquery-update: + title: "BigQuery Destination Spec" + type: "object" + required: + - "project_id" + - "dataset_location" + - "dataset_id" + properties: + project_id: + type: "string" + description: "The GCP project ID for the project containing the target BigQuery\ + \ dataset. Read more here." + title: "Project ID" + group: "connection" + order: 0 + dataset_location: + type: "string" + description: "The location of the dataset. Warning: Changes made after creation\ + \ will not be applied. Read more here." + title: "Dataset Location" + group: "connection" + order: 1 + enum: + - "US" + - "EU" + - "asia-east1" + - "asia-east2" + - "asia-northeast1" + - "asia-northeast2" + - "asia-northeast3" + - "asia-south1" + - "asia-south2" + - "asia-southeast1" + - "asia-southeast2" + - "australia-southeast1" + - "australia-southeast2" + - "europe-central1" + - "europe-central2" + - "europe-north1" + - "europe-southwest1" + - "europe-west1" + - "europe-west2" + - "europe-west3" + - "europe-west4" + - "europe-west6" + - "europe-west7" + - "europe-west8" + - "europe-west9" + - "europe-west12" + - "me-central1" + - "me-central2" + - "me-west1" + - "northamerica-northeast1" + - "northamerica-northeast2" + - "southamerica-east1" + - "southamerica-west1" + - "us-central1" + - "us-east1" + - "us-east2" + - "us-east3" + - "us-east4" + - "us-east5" + - "us-south1" + - "us-west1" + - "us-west2" + - "us-west3" + - "us-west4" + dataset_id: + type: "string" + description: "The default BigQuery Dataset ID that tables are replicated\ + \ to if the source does not specify a namespace. Read more here." + title: "Default Dataset ID" + group: "connection" + order: 2 + loading_method: + type: "object" + title: "Loading Method" + description: "The way data will be uploaded to BigQuery." + display_type: "radio" + group: "connection" + order: 3 + oneOf: + - title: "GCS Staging" + description: "(recommended) Writes large batches of records to\ + \ a file, uploads the file to GCS, then uses COPY INTO to load your\ + \ data into BigQuery. Provides best-in-class speed, reliability and\ + \ scalability. Read more about GCS Staging here." + required: + - "method" + - "gcs_bucket_name" + - "gcs_bucket_path" + - "credential" + properties: + method: + type: "string" + const: "GCS Staging" + order: 0 + enum: + - "GCS Staging" + credential: + title: "Credential" + description: "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." + type: "object" + order: 1 + oneOf: + - title: "HMAC key" + required: + - "credential_type" + - "hmac_key_access_id" + - "hmac_key_secret" + properties: + credential_type: + type: "string" + const: "HMAC_KEY" + order: 0 + enum: + - "HMAC_KEY" + hmac_key_access_id: + type: "string" + description: "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." + title: "HMAC Key Access ID" + airbyte_secret: true + examples: + - "1234567890abcdefghij1234" + order: 1 + hmac_key_secret: + type: "string" + description: "The corresponding secret for the access ID. It\ + \ is a 40-character base-64 encoded string." + title: "HMAC Key Secret" + airbyte_secret: true + examples: + - "1234567890abcdefghij1234567890ABCDEFGHIJ" + order: 2 + gcs_bucket_name: + title: "GCS Bucket Name" + type: "string" + description: "The name of the GCS bucket. Read more here." + examples: + - "airbyte_sync" + order: 2 + gcs_bucket_path: + title: "GCS Bucket Path" + description: "Directory under the GCS bucket where data will be written." + type: "string" + examples: + - "data_sync/test" + order: 3 + keep_files_in_gcs-bucket: + type: "string" + description: "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." + title: "GCS Tmp Files Afterward Processing" + default: "Delete all tmp files from GCS" + enum: + - "Delete all tmp files from GCS" + - "Keep all tmp files in GCS" + order: 4 + - title: "Standard Inserts" + required: + - "method" + description: "(not recommended) Direct loading using SQL INSERT\ + \ statements. This method is extremely inefficient and provided only\ + \ for quick testing. In all other cases, you should use GCS staging." + properties: + method: + type: "string" + const: "Standard" + enum: + - "Standard" + credentials_json: + type: "string" + description: "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." + title: "Service Account Key JSON (Required for cloud, optional for open-source)" + airbyte_secret: true + group: "connection" + order: 4 + always_show: true + transformation_priority: + type: "string" + description: "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." + title: "Transformation Query Run Type" + default: "interactive" + enum: + - "interactive" + - "batch" + order: 5 + group: "advanced" + big_query_client_buffer_size_mb: + title: "Google BigQuery Client Chunk Size" + description: "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." + type: "integer" + minimum: 1 + maximum: 15 + default: 15 + examples: + - "15" + order: 6 + group: "advanced" + raw_data_dataset: + type: "string" + description: "The dataset to write raw tables into (default: airbyte_internal)" + title: "Raw Table Dataset Name" + order: 7 + group: "advanced" + disable_type_dedupe: + type: "boolean" + default: false + description: "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" + title: "Disable Final Tables. (WARNING! Unstable option; Columns in raw\ + \ table schema might change between versions)" + order: 8 + group: "advanced" + groups: + - id: "connection" + title: "Connection" + - id: "advanced" + title: "Advanced" + destination-elasticsearch: + title: "Elasticsearch Connection Configuration" + type: "object" + required: + - "endpoint" + - "destinationType" + properties: + endpoint: + title: "Server Endpoint" + type: "string" + description: "The full url of the Elasticsearch server" + upsert: + type: "boolean" + title: "Upsert Records" + description: "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." + default: true + ca_certificate: + type: "string" + title: "CA certificate" + description: "CA certificate" + airbyte_secret: true + multiline: true + authenticationMethod: + title: "Authentication Method" + type: "object" + description: "The type of authentication to be used" + oneOf: + - title: "Api Key/Secret" + additionalProperties: false + description: "Use a api key and secret combination to authenticate" + required: + - "method" + - "apiKeyId" + - "apiKeySecret" + properties: + method: + type: "string" + const: "secret" + enum: + - "secret" + apiKeyId: + title: "API Key ID" + description: "The Key ID to used when accessing an enterprise Elasticsearch\ + \ instance." + type: "string" + apiKeySecret: + title: "API Key Secret" + description: "The secret associated with the API Key ID." + type: "string" + airbyte_secret: true + - title: "Username/Password" + additionalProperties: false + description: "Basic auth header with a username and password" + required: + - "method" + - "username" + - "password" + properties: + method: + type: "string" + const: "basic" + enum: + - "basic" + username: + title: "Username" + description: "Basic auth username to access a secure Elasticsearch\ + \ server" + type: "string" + password: + title: "Password" + description: "Basic auth password to access a secure Elasticsearch\ + \ server" + type: "string" + airbyte_secret: true + x-speakeasy-param-sensitive: true + destinationType: + title: "elasticsearch" + const: "elasticsearch" + enum: + - "elasticsearch" + order: 0 + type: "string" + destination-elasticsearch-update: + title: "Elasticsearch Connection Configuration" + type: "object" + required: + - "endpoint" + properties: + endpoint: + title: "Server Endpoint" + type: "string" + description: "The full url of the Elasticsearch server" + upsert: + type: "boolean" + title: "Upsert Records" + description: "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." + default: true + ca_certificate: + type: "string" + title: "CA certificate" + description: "CA certificate" + airbyte_secret: true + multiline: true + authenticationMethod: + title: "Authentication Method" + type: "object" + description: "The type of authentication to be used" + oneOf: + - title: "Api Key/Secret" + additionalProperties: false + description: "Use a api key and secret combination to authenticate" + required: + - "method" + - "apiKeyId" + - "apiKeySecret" + properties: + method: + type: "string" + const: "secret" + enum: + - "secret" + apiKeyId: + title: "API Key ID" + description: "The Key ID to used when accessing an enterprise Elasticsearch\ + \ instance." + type: "string" + apiKeySecret: + title: "API Key Secret" + description: "The secret associated with the API Key ID." + type: "string" + airbyte_secret: true + - title: "Username/Password" + additionalProperties: false + description: "Basic auth header with a username and password" + required: + - "method" + - "username" + - "password" + properties: + method: + type: "string" + const: "basic" + enum: + - "basic" + username: + title: "Username" + description: "Basic auth username to access a secure Elasticsearch\ + \ server" + type: "string" + password: + title: "Password" + description: "Basic auth password to access a secure Elasticsearch\ + \ server" + type: "string" + airbyte_secret: true + destination-azure-blob-storage: + title: "AzureBlobStorage Destination Spec" + type: "object" + required: + - "azure_blob_storage_account_name" + - "azure_blob_storage_account_key" + - "format" + - "destinationType" + properties: + azure_blob_storage_endpoint_domain_name: + title: "Endpoint Domain Name" + type: "string" + default: "blob.core.windows.net" + description: "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." + examples: + - "blob.core.windows.net" + azure_blob_storage_container_name: + title: "Azure blob storage container (Bucket) Name" + type: "string" + description: "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" + examples: + - "airbytetescontainername" + azure_blob_storage_account_name: + title: "Azure Blob Storage account name" + type: "string" + description: "The account's name of the Azure Blob Storage." + examples: + - "airbyte5storage" + azure_blob_storage_account_key: + title: "Azure Blob Storage account key" + description: "The Azure blob storage account key." + airbyte_secret: true + type: "string" + examples: + - "Z8ZkZpteggFx394vm+PJHnGTvdRncaYS+JhLKdj789YNmD+iyGTnG+PV+POiuYNhBg/ACS+LKjd%4FG3FHGN12Nd==" + x-speakeasy-param-sensitive: true + azure_blob_storage_output_buffer_size: + title: "Azure Blob Storage output buffer size (Megabytes)" + type: "integer" + description: "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." + minimum: 1 + maximum: 2047 + default: 5 + examples: + - 5 + azure_blob_storage_spill_size: + title: "Azure Blob Storage file spill size" + type: "integer" + description: "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" + default: 500 + examples: + - 500 + format: + title: "Output Format" + type: "object" + description: "Output data format" + oneOf: + - title: "CSV: Comma-Separated Values" + required: + - "format_type" + - "flattening" + properties: + format_type: + type: "string" + const: "CSV" + enum: + - "CSV" + flattening: + type: "string" + title: "Normalization (Flattening)" + description: "Whether the input json data should be normalized (flattened)\ + \ in the output CSV. Please refer to docs for details." + default: "No flattening" + enum: + - "No flattening" + - "Root level flattening" + - title: "JSON Lines: newline-delimited JSON" + required: + - "format_type" + properties: + format_type: + type: "string" + const: "JSONL" + enum: + - "JSONL" + destinationType: + title: "azure-blob-storage" + const: "azure-blob-storage" + enum: + - "azure-blob-storage" + order: 0 + type: "string" + destination-azure-blob-storage-update: + title: "AzureBlobStorage Destination Spec" + type: "object" + required: + - "azure_blob_storage_account_name" + - "azure_blob_storage_account_key" + - "format" + properties: + azure_blob_storage_endpoint_domain_name: + title: "Endpoint Domain Name" + type: "string" + default: "blob.core.windows.net" + description: "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." + examples: + - "blob.core.windows.net" + azure_blob_storage_container_name: + title: "Azure blob storage container (Bucket) Name" + type: "string" + description: "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" + examples: + - "airbytetescontainername" + azure_blob_storage_account_name: + title: "Azure Blob Storage account name" + type: "string" + description: "The account's name of the Azure Blob Storage." + examples: + - "airbyte5storage" + azure_blob_storage_account_key: + title: "Azure Blob Storage account key" + description: "The Azure blob storage account key." + airbyte_secret: true + type: "string" + examples: + - "Z8ZkZpteggFx394vm+PJHnGTvdRncaYS+JhLKdj789YNmD+iyGTnG+PV+POiuYNhBg/ACS+LKjd%4FG3FHGN12Nd==" + azure_blob_storage_output_buffer_size: + title: "Azure Blob Storage output buffer size (Megabytes)" + type: "integer" + description: "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." + minimum: 1 + maximum: 2047 + default: 5 + examples: + - 5 + azure_blob_storage_spill_size: + title: "Azure Blob Storage file spill size" + type: "integer" + description: "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" + default: 500 + examples: + - 500 + format: + title: "Output Format" + type: "object" + description: "Output data format" + oneOf: + - title: "CSV: Comma-Separated Values" + required: + - "format_type" + - "flattening" + properties: + format_type: + type: "string" + const: "CSV" + enum: + - "CSV" + flattening: + type: "string" + title: "Normalization (Flattening)" + description: "Whether the input json data should be normalized (flattened)\ + \ in the output CSV. Please refer to docs for details." + default: "No flattening" + enum: + - "No flattening" + - "Root level flattening" + - title: "JSON Lines: newline-delimited JSON" + required: + - "format_type" + properties: + format_type: + type: "string" + const: "JSONL" + enum: + - "JSONL" + destination-langchain: + title: "Langchain Destination Config" + type: "object" + properties: + processing: + title: "ProcessingConfigModel" + type: "object" + properties: + chunk_size: + title: "Chunk size" + description: "Size of chunks in tokens to store in vector store (make\ + \ sure it is not too big for the context if your LLM)" + maximum: 8191 + type: "integer" + chunk_overlap: + title: "Chunk overlap" + description: "Size of overlap between chunks in tokens to store in vector\ + \ store to better capture relevant context" + default: 0 + type: "integer" + text_fields: + title: "Text fields to embed" + description: "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." + always_show: true + examples: + - "text" + - "user.name" + - "users.*.name" + type: "array" + items: + type: "string" + required: + - "chunk_size" + - "text_fields" + group: "processing" + embedding: + title: "Embedding" + description: "Embedding configuration" + group: "embedding" + type: "object" + oneOf: + - title: "OpenAI" + type: "object" + properties: + mode: + title: "Mode" + default: "openai" + const: "openai" + enum: + - "openai" + type: "string" + openai_key: + title: "OpenAI API key" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + required: + - "openai_key" + description: "Use the OpenAI API to embed text. This option is using the\ + \ text-embedding-ada-002 model with 1536 embedding dimensions." + - title: "Fake" + type: "object" + properties: + mode: + title: "Mode" + default: "fake" + const: "fake" + enum: + - "fake" + type: "string" + description: "Use a fake embedding made out of random vectors with 1536\ + \ embedding dimensions. This is useful for testing the data pipeline\ + \ without incurring any costs." + indexing: + title: "Indexing" + description: "Indexing configuration" + group: "indexing" + type: "object" + oneOf: + - title: "Pinecone" + type: "object" + properties: + mode: + title: "Mode" + default: "pinecone" + const: "pinecone" + enum: + - "pinecone" + type: "string" + pinecone_key: + title: "Pinecone API key" + airbyte_secret: true + type: "string" + x-speakeasy-param-sensitive: true + pinecone_environment: + title: "Pinecone environment" + description: "Pinecone environment to use" + type: "string" + index: + title: "Index" + description: "Pinecone index to use" + type: "string" + required: + - "pinecone_key" + - "pinecone_environment" + - "index" + description: "Pinecone is a popular vector store that can be used to store\ + \ and retrieve embeddings. It is a managed service and can also be queried\ + \ from outside of langchain." + - title: "DocArrayHnswSearch" + type: "object" + properties: + mode: + title: "Mode" + default: "DocArrayHnswSearch" + const: "DocArrayHnswSearch" + enum: + - "DocArrayHnswSearch" + type: "string" + destination_path: + title: "Destination Path" + description: "Path to the directory where hnswlib and meta data files\ + \ will be written. The files will be placed inside that local mount.\ + \ All files in the specified destination directory will be deleted\ + \ on each run." + examples: + - "/local/my_hnswlib_index" + type: "string" + required: + - "destination_path" + description: "DocArrayHnswSearch is a lightweight Document Index implementation\ + \ provided by Docarray that runs fully locally and is best suited for\ + \ small- to medium-sized datasets. It stores vectors on disk in hnswlib,\ + \ and stores all other data in SQLite." + - title: "Chroma (local persistance)" + type: "object" + properties: + mode: + title: "Mode" + default: "chroma_local" + const: "chroma_local" + enum: + - "chroma_local" + type: "string" + destination_path: + title: "Destination Path" + description: "Path to the directory where chroma files will be written.\ + \ The files will be placed inside that local mount." + examples: + - "/local/my_chroma_db" + type: "string" + collection_name: + title: "Collection Name" + description: "Name of the collection to use." + default: "langchain" + type: "string" + required: + - "destination_path" + description: "Chroma is a popular vector store that can be used to store\ + \ and retrieve embeddings. It will build its index in memory and persist\ + \ it to disk by the end of the sync." + destinationType: + title: "langchain" + const: "langchain" + enum: + - "langchain" + order: 0 + type: "string" + required: + - "processing" + - "embedding" + - "indexing" + - "destinationType" + groups: + - id: "processing" + title: "Processing" + - id: "embedding" + title: "Embedding" + - id: "indexing" + title: "Indexing" + destination-langchain-update: + title: "Langchain Destination Config" + type: "object" + properties: + processing: + title: "ProcessingConfigModel" + type: "object" + properties: + chunk_size: + title: "Chunk size" + description: "Size of chunks in tokens to store in vector store (make\ + \ sure it is not too big for the context if your LLM)" + maximum: 8191 + type: "integer" + chunk_overlap: + title: "Chunk overlap" + description: "Size of overlap between chunks in tokens to store in vector\ + \ store to better capture relevant context" + default: 0 + type: "integer" + text_fields: + title: "Text fields to embed" + description: "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." + always_show: true + examples: + - "text" + - "user.name" + - "users.*.name" + type: "array" + items: + type: "string" + required: + - "chunk_size" + - "text_fields" + group: "processing" + embedding: + title: "Embedding" + description: "Embedding configuration" + group: "embedding" + type: "object" + oneOf: + - title: "OpenAI" + type: "object" + properties: + mode: + title: "Mode" + default: "openai" + const: "openai" + enum: + - "openai" + type: "string" + openai_key: + title: "OpenAI API key" + airbyte_secret: true + type: "string" + required: + - "openai_key" + description: "Use the OpenAI API to embed text. This option is using the\ + \ text-embedding-ada-002 model with 1536 embedding dimensions." + - title: "Fake" + type: "object" + properties: + mode: + title: "Mode" + default: "fake" + const: "fake" + enum: + - "fake" + type: "string" + description: "Use a fake embedding made out of random vectors with 1536\ + \ embedding dimensions. This is useful for testing the data pipeline\ + \ without incurring any costs." + indexing: + title: "Indexing" + description: "Indexing configuration" + group: "indexing" + type: "object" + oneOf: + - title: "Pinecone" + type: "object" + properties: + mode: + title: "Mode" + default: "pinecone" + const: "pinecone" + enum: + - "pinecone" + type: "string" + pinecone_key: + title: "Pinecone API key" + airbyte_secret: true + type: "string" + pinecone_environment: + title: "Pinecone environment" + description: "Pinecone environment to use" + type: "string" + index: + title: "Index" + description: "Pinecone index to use" + type: "string" + required: + - "pinecone_key" + - "pinecone_environment" + - "index" + description: "Pinecone is a popular vector store that can be used to store\ + \ and retrieve embeddings. It is a managed service and can also be queried\ + \ from outside of langchain." + - title: "DocArrayHnswSearch" + type: "object" + properties: + mode: + title: "Mode" + default: "DocArrayHnswSearch" + const: "DocArrayHnswSearch" + enum: + - "DocArrayHnswSearch" + type: "string" + destination_path: + title: "Destination Path" + description: "Path to the directory where hnswlib and meta data files\ + \ will be written. The files will be placed inside that local mount.\ + \ All files in the specified destination directory will be deleted\ + \ on each run." + examples: + - "/local/my_hnswlib_index" + type: "string" + required: + - "destination_path" + description: "DocArrayHnswSearch is a lightweight Document Index implementation\ + \ provided by Docarray that runs fully locally and is best suited for\ + \ small- to medium-sized datasets. It stores vectors on disk in hnswlib,\ + \ and stores all other data in SQLite." + - title: "Chroma (local persistance)" + type: "object" + properties: + mode: + title: "Mode" + default: "chroma_local" + const: "chroma_local" + enum: + - "chroma_local" + type: "string" + destination_path: + title: "Destination Path" + description: "Path to the directory where chroma files will be written.\ + \ The files will be placed inside that local mount." + examples: + - "/local/my_chroma_db" + type: "string" + collection_name: + title: "Collection Name" + description: "Name of the collection to use." + default: "langchain" + type: "string" + required: + - "destination_path" + description: "Chroma is a popular vector store that can be used to store\ + \ and retrieve embeddings. It will build its index in memory and persist\ + \ it to disk by the end of the sync." + required: + - "processing" + - "embedding" + - "indexing" + groups: + - id: "processing" + title: "Processing" + - id: "embedding" + title: "Embedding" + - id: "indexing" + title: "Indexing" + destination-postgres: + title: "Postgres Destination Spec" + type: "object" + required: + - "host" + - "port" + - "username" + - "database" + - "schema" + - "destinationType" + properties: + host: + title: "Host" + description: "Hostname of the database." + type: "string" + order: 0 + port: + title: "Port" + description: "Port of the database." + type: "integer" + minimum: 0 + maximum: 65536 + default: 5432 + examples: + - "5432" + order: 1 + database: + title: "DB Name" + description: "Name of the database." + type: "string" + order: 2 + schema: + title: "Default Schema" + description: "The default schema tables are written to if the source does\ + \ not specify a namespace. The usual value for this field is \"public\"\ + ." + type: "string" + examples: + - "public" + default: "public" + order: 3 + username: + title: "User" + description: "Username to use to access the database." + type: "string" + order: 4 + password: + title: "Password" + description: "Password associated with the username." + type: "string" + airbyte_secret: true + order: 5 + x-speakeasy-param-sensitive: true + ssl_mode: + title: "SSL modes" + description: "SSL connection modes. \n disable - Chose this mode\ + \ to disable encryption of communication between Airbyte and destination\ + \ database\n allow - Chose this mode to enable encryption only\ + \ when required by the source database\n prefer - Chose this mode\ + \ to allow unencrypted connection only if the source database does not\ + \ support encryption\n require - Chose this mode to always require\ + \ encryption. If the source database server does not support encryption,\ + \ connection will fail\n verify-ca - Chose this mode to always\ + \ require encryption and to verify that the source database server has\ + \ a valid SSL certificate\n 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\n See more information - in the\ + \ docs." + type: "object" + order: 7 + oneOf: + - title: "disable" + additionalProperties: false + description: "Disable SSL." + required: + - "mode" + properties: + mode: + type: "string" + const: "disable" + enum: + - "disable" + default: "disable" + order: 0 + - title: "allow" + additionalProperties: false + description: "Allow SSL mode." + required: + - "mode" + properties: + mode: + type: "string" + const: "allow" + enum: + - "allow" + default: "allow" + order: 0 + - title: "prefer" + additionalProperties: false + description: "Prefer SSL mode." + required: + - "mode" + properties: + mode: + type: "string" + const: "prefer" + enum: + - "prefer" + default: "prefer" + order: 0 + - title: "require" + additionalProperties: false + description: "Require SSL mode." + required: + - "mode" + properties: + mode: + type: "string" + const: "require" + enum: + - "require" + default: "require" + order: 0 + - title: "verify-ca" + additionalProperties: false + description: "Verify-ca SSL mode." + required: + - "mode" + - "ca_certificate" + properties: + mode: + type: "string" + const: "verify-ca" + enum: + - "verify-ca" + default: "verify-ca" + order: 0 + ca_certificate: + type: "string" + title: "CA certificate" + description: "CA certificate" + airbyte_secret: true + multiline: true + order: 1 + client_key_password: + type: "string" + title: "Client key password" + description: "Password for keystorage. This field is optional. If\ + \ you do not add it - the password will be generated automatically." + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + - title: "verify-full" + additionalProperties: false + description: "Verify-full SSL mode." + required: + - "mode" + - "ca_certificate" + - "client_certificate" + - "client_key" + properties: + mode: + type: "string" + const: "verify-full" + enum: + - "verify-full" + default: "verify-full" + order: 0 + ca_certificate: + type: "string" + title: "CA certificate" + description: "CA certificate" + airbyte_secret: true + multiline: true + order: 1 + client_certificate: + type: "string" + title: "Client certificate" + description: "Client certificate" + airbyte_secret: true + multiline: true + order: 2 + client_key: + type: "string" + title: "Client key" + description: "Client key" + airbyte_secret: true + multiline: true + order: 3 + x-speakeasy-param-sensitive: true + client_key_password: + type: "string" + title: "Client key password" + description: "Password for keystorage. This field is optional. If\ + \ you do not add it - the password will be generated automatically." + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + jdbc_url_params: + description: "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)." + title: "JDBC URL Params" + type: "string" + order: 8 + raw_data_schema: + type: "string" + description: "The schema to write raw tables into" + title: "Raw table schema (defaults to airbyte_internal)" + order: 9 + disable_type_dedupe: + type: "boolean" + default: false + description: "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" + title: "Disable Final Tables. (WARNING! Unstable option; Columns in raw\ + \ table schema might change between versions)" + order: 10 + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + x-speakeasy-param-sensitive: true + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + x-speakeasy-param-sensitive: true + destinationType: + title: "postgres" + const: "postgres" + enum: + - "postgres" + order: 0 + type: "string" + destination-postgres-update: + title: "Postgres Destination Spec" + type: "object" + required: + - "host" + - "port" + - "username" + - "database" + - "schema" + properties: + host: + title: "Host" + description: "Hostname of the database." + type: "string" + order: 0 + port: + title: "Port" + description: "Port of the database." + type: "integer" + minimum: 0 + maximum: 65536 + default: 5432 + examples: + - "5432" + order: 1 + database: + title: "DB Name" + description: "Name of the database." + type: "string" + order: 2 + schema: + title: "Default Schema" + description: "The default schema tables are written to if the source does\ + \ not specify a namespace. The usual value for this field is \"public\"\ + ." + type: "string" + examples: + - "public" + default: "public" + order: 3 + username: + title: "User" + description: "Username to use to access the database." + type: "string" + order: 4 + password: + title: "Password" + description: "Password associated with the username." + type: "string" + airbyte_secret: true + order: 5 + ssl_mode: + title: "SSL modes" + description: "SSL connection modes. \n disable - Chose this mode\ + \ to disable encryption of communication between Airbyte and destination\ + \ database\n allow - Chose this mode to enable encryption only\ + \ when required by the source database\n prefer - Chose this mode\ + \ to allow unencrypted connection only if the source database does not\ + \ support encryption\n require - Chose this mode to always require\ + \ encryption. If the source database server does not support encryption,\ + \ connection will fail\n verify-ca - Chose this mode to always\ + \ require encryption and to verify that the source database server has\ + \ a valid SSL certificate\n 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\n See more information - in the\ + \ docs." + type: "object" + order: 7 + oneOf: + - title: "disable" + additionalProperties: false + description: "Disable SSL." + required: + - "mode" + properties: + mode: + type: "string" + const: "disable" + enum: + - "disable" + default: "disable" + order: 0 + - title: "allow" + additionalProperties: false + description: "Allow SSL mode." + required: + - "mode" + properties: + mode: + type: "string" + const: "allow" + enum: + - "allow" + default: "allow" + order: 0 + - title: "prefer" + additionalProperties: false + description: "Prefer SSL mode." + required: + - "mode" + properties: + mode: + type: "string" + const: "prefer" + enum: + - "prefer" + default: "prefer" + order: 0 + - title: "require" + additionalProperties: false + description: "Require SSL mode." + required: + - "mode" + properties: + mode: + type: "string" + const: "require" + enum: + - "require" + default: "require" + order: 0 + - title: "verify-ca" + additionalProperties: false + description: "Verify-ca SSL mode." + required: + - "mode" + - "ca_certificate" + properties: + mode: + type: "string" + const: "verify-ca" + enum: + - "verify-ca" + default: "verify-ca" + order: 0 + ca_certificate: + type: "string" + title: "CA certificate" + description: "CA certificate" + airbyte_secret: true + multiline: true + order: 1 + client_key_password: + type: "string" + title: "Client key password" + description: "Password for keystorage. This field is optional. If\ + \ you do not add it - the password will be generated automatically." + airbyte_secret: true + order: 4 + - title: "verify-full" + additionalProperties: false + description: "Verify-full SSL mode." + required: + - "mode" + - "ca_certificate" + - "client_certificate" + - "client_key" + properties: + mode: + type: "string" + const: "verify-full" + enum: + - "verify-full" + default: "verify-full" + order: 0 + ca_certificate: + type: "string" + title: "CA certificate" + description: "CA certificate" + airbyte_secret: true + multiline: true + order: 1 + client_certificate: + type: "string" + title: "Client certificate" + description: "Client certificate" + airbyte_secret: true + multiline: true + order: 2 + client_key: + type: "string" + title: "Client key" + description: "Client key" + airbyte_secret: true + multiline: true + order: 3 + client_key_password: + type: "string" + title: "Client key password" + description: "Password for keystorage. This field is optional. If\ + \ you do not add it - the password will be generated automatically." + airbyte_secret: true + order: 4 + jdbc_url_params: + description: "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)." + title: "JDBC URL Params" + type: "string" + order: 8 + raw_data_schema: + type: "string" + description: "The schema to write raw tables into" + title: "Raw table schema (defaults to airbyte_internal)" + order: 9 + disable_type_dedupe: + type: "boolean" + default: false + description: "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" + title: "Disable Final Tables. (WARNING! Unstable option; Columns in raw\ + \ table schema might change between versions)" + order: 10 + tunnel_method: + type: "object" + title: "SSH Tunnel Method" + description: "Whether to initiate an SSH tunnel before connecting to the\ + \ database, and if so, which kind of authentication to use." + oneOf: + - title: "No Tunnel" + required: + - "tunnel_method" + properties: + tunnel_method: + description: "No ssh tunnel needed to connect to database" + type: "string" + const: "NO_TUNNEL" + order: 0 + enum: + - "NO_TUNNEL" + - title: "SSH Key Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "ssh_key" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and ssh key" + type: "string" + const: "SSH_KEY_AUTH" + order: 0 + enum: + - "SSH_KEY_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host." + type: "string" + order: 3 + ssh_key: + title: "SSH Private Key" + description: "OS-level user account ssh key credentials in RSA PEM\ + \ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )" + type: "string" + airbyte_secret: true + multiline: true + order: 4 + - title: "Password Authentication" + required: + - "tunnel_method" + - "tunnel_host" + - "tunnel_port" + - "tunnel_user" + - "tunnel_user_password" + properties: + tunnel_method: + description: "Connect through a jump server tunnel host using username\ + \ and password authentication" + type: "string" + const: "SSH_PASSWORD_AUTH" + order: 0 + enum: + - "SSH_PASSWORD_AUTH" + tunnel_host: + title: "SSH Tunnel Jump Server Host" + description: "Hostname of the jump server host that allows inbound\ + \ ssh tunnel." + type: "string" + order: 1 + tunnel_port: + title: "SSH Connection Port" + description: "Port on the proxy/jump server that accepts inbound ssh\ + \ connections." + type: "integer" + minimum: 0 + maximum: 65536 + default: 22 + examples: + - "22" + order: 2 + tunnel_user: + title: "SSH Login Username" + description: "OS-level username for logging into the jump server host" + type: "string" + order: 3 + tunnel_user_password: + title: "Password" + description: "OS-level password for logging into the jump server host" + type: "string" + airbyte_secret: true + order: 4 + SourceConfiguration: + description: The values required to configure the source. + example: { user: "charles" } + oneOf: + - title: source-aha + $ref: "#/components/schemas/source-aha" + - title: source-aircall + $ref: "#/components/schemas/source-aircall" + - title: source-airtable + $ref: "#/components/schemas/source-airtable" + - title: source-amazon-ads + $ref: "#/components/schemas/source-amazon-ads" + - title: source-amazon-seller-partner + $ref: "#/components/schemas/source-amazon-seller-partner" + - title: source-amazon-sqs + $ref: "#/components/schemas/source-amazon-sqs" + - title: source-amplitude + $ref: "#/components/schemas/source-amplitude" + - title: source-apify-dataset + $ref: "#/components/schemas/source-apify-dataset" + - title: source-appfollow + $ref: "#/components/schemas/source-appfollow" + - title: source-asana + $ref: "#/components/schemas/source-asana" + - title: source-auth0 + $ref: "#/components/schemas/source-auth0" + - title: source-aws-cloudtrail + $ref: "#/components/schemas/source-aws-cloudtrail" + - title: source-azure-blob-storage + $ref: "#/components/schemas/source-azure-blob-storage" + - title: source-azure-table + $ref: "#/components/schemas/source-azure-table" + - title: source-bamboo-hr + $ref: "#/components/schemas/source-bamboo-hr" + - title: source-bigquery + $ref: "#/components/schemas/source-bigquery" + - title: source-bing-ads + $ref: "#/components/schemas/source-bing-ads" + - title: source-braintree + $ref: "#/components/schemas/source-braintree" + - title: source-braze + $ref: "#/components/schemas/source-braze" + - title: source-cart + $ref: "#/components/schemas/source-cart" + - title: source-chargebee + $ref: "#/components/schemas/source-chargebee" + - title: source-chartmogul + $ref: "#/components/schemas/source-chartmogul" + - title: source-clickhouse + $ref: "#/components/schemas/source-clickhouse" + - title: source-clickup-api + $ref: "#/components/schemas/source-clickup-api" + - title: source-clockify + $ref: "#/components/schemas/source-clockify" + - title: source-close-com + $ref: "#/components/schemas/source-close-com" + - title: source-coda + $ref: "#/components/schemas/source-coda" + - title: source-coin-api + $ref: "#/components/schemas/source-coin-api" + - title: source-coinmarketcap + $ref: "#/components/schemas/source-coinmarketcap" + - title: source-configcat + $ref: "#/components/schemas/source-configcat" + - title: source-confluence + $ref: "#/components/schemas/source-confluence" + - title: source-convex + $ref: "#/components/schemas/source-convex" + - title: source-datascope + $ref: "#/components/schemas/source-datascope" + - title: source-delighted + $ref: "#/components/schemas/source-delighted" + - title: source-dixa + $ref: "#/components/schemas/source-dixa" + - title: source-dockerhub + $ref: "#/components/schemas/source-dockerhub" + - title: source-dremio + $ref: "#/components/schemas/source-dremio" + - title: source-dynamodb + $ref: "#/components/schemas/source-dynamodb" + - title: source-e2e-test-cloud + $ref: "#/components/schemas/source-e2e-test-cloud" + - title: source-emailoctopus + $ref: "#/components/schemas/source-emailoctopus" + - title: source-exchange-rates + $ref: "#/components/schemas/source-exchange-rates" + - title: source-facebook-marketing + $ref: "#/components/schemas/source-facebook-marketing" + - title: source-faker + $ref: "#/components/schemas/source-faker" + - title: source-fauna + $ref: "#/components/schemas/source-fauna" + - title: source-file + $ref: "#/components/schemas/source-file" + - title: source-firebolt + $ref: "#/components/schemas/source-firebolt" + - title: source-freshcaller + $ref: "#/components/schemas/source-freshcaller" + - title: source-freshdesk + $ref: "#/components/schemas/source-freshdesk" + - title: source-freshsales + $ref: "#/components/schemas/source-freshsales" + - title: source-gainsight-px + $ref: "#/components/schemas/source-gainsight-px" + - title: source-gcs + $ref: "#/components/schemas/source-gcs" + - title: source-getlago + $ref: "#/components/schemas/source-getlago" + - title: source-github + $ref: "#/components/schemas/source-github" + - title: source-gitlab + $ref: "#/components/schemas/source-gitlab" + - title: source-glassfrog + $ref: "#/components/schemas/source-glassfrog" + - title: source-gnews + $ref: "#/components/schemas/source-gnews" + - title: source-google-ads + $ref: "#/components/schemas/source-google-ads" + - title: source-google-analytics-data-api + $ref: "#/components/schemas/source-google-analytics-data-api" + - title: source-google-analytics-v4-service-account-only + $ref: "#/components/schemas/source-google-analytics-v4-service-account-only" + - title: source-google-directory + $ref: "#/components/schemas/source-google-directory" + - title: source-google-drive + $ref: "#/components/schemas/source-google-drive" + - title: source-google-pagespeed-insights + $ref: "#/components/schemas/source-google-pagespeed-insights" + - title: source-google-search-console + $ref: "#/components/schemas/source-google-search-console" + - title: source-google-sheets + $ref: "#/components/schemas/source-google-sheets" + - title: source-google-webfonts + $ref: "#/components/schemas/source-google-webfonts" + - title: source-greenhouse + $ref: "#/components/schemas/source-greenhouse" + - title: source-gridly + $ref: "#/components/schemas/source-gridly" + - title: source-harvest + $ref: "#/components/schemas/source-harvest" + - title: source-hubplanner + $ref: "#/components/schemas/source-hubplanner" + - title: source-hubspot + $ref: "#/components/schemas/source-hubspot" + - title: source-insightly + $ref: "#/components/schemas/source-insightly" + - title: source-instagram + $ref: "#/components/schemas/source-instagram" + - title: source-instatus + $ref: "#/components/schemas/source-instatus" + - title: source-intercom + $ref: "#/components/schemas/source-intercom" + - title: source-ip2whois + $ref: "#/components/schemas/source-ip2whois" + - title: source-iterable + $ref: "#/components/schemas/source-iterable" + - title: source-jira + $ref: "#/components/schemas/source-jira" + - title: source-k6-cloud + $ref: "#/components/schemas/source-k6-cloud" + - title: source-klarna + $ref: "#/components/schemas/source-klarna" + - title: source-klaviyo + $ref: "#/components/schemas/source-klaviyo" + - title: source-kyve + $ref: "#/components/schemas/source-kyve" + - title: source-launchdarkly + $ref: "#/components/schemas/source-launchdarkly" + - title: source-lemlist + $ref: "#/components/schemas/source-lemlist" + - title: source-lever-hiring + $ref: "#/components/schemas/source-lever-hiring" + - title: source-linkedin-ads + $ref: "#/components/schemas/source-linkedin-ads" + - title: source-linkedin-pages + $ref: "#/components/schemas/source-linkedin-pages" + - title: source-linnworks + $ref: "#/components/schemas/source-linnworks" + - title: source-lokalise + $ref: "#/components/schemas/source-lokalise" + - title: source-mailchimp + $ref: "#/components/schemas/source-mailchimp" + - title: source-mailgun + $ref: "#/components/schemas/source-mailgun" + - title: source-mailjet-sms + $ref: "#/components/schemas/source-mailjet-sms" + - title: source-marketo + $ref: "#/components/schemas/source-marketo" + - title: source-metabase + $ref: "#/components/schemas/source-metabase" + - title: source-microsoft-onedrive + $ref: "#/components/schemas/source-microsoft-onedrive" + - title: source-microsoft-sharepoint + $ref: "#/components/schemas/source-microsoft-sharepoint" + - title: source-microsoft-teams + $ref: "#/components/schemas/source-microsoft-teams" + - title: source-mixpanel + $ref: "#/components/schemas/source-mixpanel" + - title: source-monday + $ref: "#/components/schemas/source-monday" + - title: source-mongodb-internal-poc + $ref: "#/components/schemas/source-mongodb-internal-poc" + - title: source-mongodb-v2 + $ref: "#/components/schemas/source-mongodb-v2" + - title: source-mssql + $ref: "#/components/schemas/source-mssql" + - title: source-my-hours + $ref: "#/components/schemas/source-my-hours" + - title: source-mysql + $ref: "#/components/schemas/source-mysql" + - title: source-netsuite + $ref: "#/components/schemas/source-netsuite" + - title: source-notion + $ref: "#/components/schemas/source-notion" + - title: source-nytimes + $ref: "#/components/schemas/source-nytimes" + - title: source-okta + $ref: "#/components/schemas/source-okta" + - title: source-omnisend + $ref: "#/components/schemas/source-omnisend" + - title: source-onesignal + $ref: "#/components/schemas/source-onesignal" + - title: source-oracle + $ref: "#/components/schemas/source-oracle" + - title: source-orb + $ref: "#/components/schemas/source-orb" + - title: source-orbit + $ref: "#/components/schemas/source-orbit" + - title: source-outbrain-amplify + $ref: "#/components/schemas/source-outbrain-amplify" + - title: source-outreach + $ref: "#/components/schemas/source-outreach" + - title: source-paypal-transaction + $ref: "#/components/schemas/source-paypal-transaction" + - title: source-paystack + $ref: "#/components/schemas/source-paystack" + - title: source-pendo + $ref: "#/components/schemas/source-pendo" + - title: source-persistiq + $ref: "#/components/schemas/source-persistiq" + - title: source-pexels-api + $ref: "#/components/schemas/source-pexels-api" + - title: source-pinterest + $ref: "#/components/schemas/source-pinterest" + - title: source-pipedrive + $ref: "#/components/schemas/source-pipedrive" + - title: source-pocket + $ref: "#/components/schemas/source-pocket" + - title: source-pokeapi + $ref: "#/components/schemas/source-pokeapi" + - title: source-polygon-stock-api + $ref: "#/components/schemas/source-polygon-stock-api" + - title: source-postgres + $ref: "#/components/schemas/source-postgres" + - title: source-posthog + $ref: "#/components/schemas/source-posthog" + - title: source-postmarkapp + $ref: "#/components/schemas/source-postmarkapp" + - title: source-prestashop + $ref: "#/components/schemas/source-prestashop" + - title: source-punk-api + $ref: "#/components/schemas/source-punk-api" + - title: source-pypi + $ref: "#/components/schemas/source-pypi" + - title: source-qualaroo + $ref: "#/components/schemas/source-qualaroo" + - title: source-quickbooks + $ref: "#/components/schemas/source-quickbooks" + - title: source-railz + $ref: "#/components/schemas/source-railz" + - title: source-recharge + $ref: "#/components/schemas/source-recharge" + - title: source-recreation + $ref: "#/components/schemas/source-recreation" + - title: source-recruitee + $ref: "#/components/schemas/source-recruitee" + - title: source-recurly + $ref: "#/components/schemas/source-recurly" + - title: source-redshift + $ref: "#/components/schemas/source-redshift" + - title: source-retently + $ref: "#/components/schemas/source-retently" + - title: source-rki-covid + $ref: "#/components/schemas/source-rki-covid" + - title: source-rss + $ref: "#/components/schemas/source-rss" + - title: source-s3 + $ref: "#/components/schemas/source-s3" + - title: source-salesforce + $ref: "#/components/schemas/source-salesforce" + - title: source-salesloft + $ref: "#/components/schemas/source-salesloft" + - title: source-sap-fieldglass + $ref: "#/components/schemas/source-sap-fieldglass" + - title: source-secoda + $ref: "#/components/schemas/source-secoda" + - title: source-sendgrid + $ref: "#/components/schemas/source-sendgrid" + - title: source-sendinblue + $ref: "#/components/schemas/source-sendinblue" + - title: source-senseforce + $ref: "#/components/schemas/source-senseforce" + - title: source-sentry + $ref: "#/components/schemas/source-sentry" + - title: source-sftp + $ref: "#/components/schemas/source-sftp" + - title: source-sftp-bulk + $ref: "#/components/schemas/source-sftp-bulk" + - title: source-shopify + $ref: "#/components/schemas/source-shopify" + - title: source-shortio + $ref: "#/components/schemas/source-shortio" + - title: source-slack + $ref: "#/components/schemas/source-slack" + - title: source-smaily + $ref: "#/components/schemas/source-smaily" + - title: source-smartengage + $ref: "#/components/schemas/source-smartengage" + - title: source-smartsheets + $ref: "#/components/schemas/source-smartsheets" + - title: source-snapchat-marketing + $ref: "#/components/schemas/source-snapchat-marketing" + - title: source-snowflake + $ref: "#/components/schemas/source-snowflake" + - title: source-sonar-cloud + $ref: "#/components/schemas/source-sonar-cloud" + - title: source-spacex-api + $ref: "#/components/schemas/source-spacex-api" + - title: source-square + $ref: "#/components/schemas/source-square" + - title: source-strava + $ref: "#/components/schemas/source-strava" + - title: source-stripe + $ref: "#/components/schemas/source-stripe" + - title: source-survey-sparrow + $ref: "#/components/schemas/source-survey-sparrow" + - title: source-surveymonkey + $ref: "#/components/schemas/source-surveymonkey" + - title: source-tempo + $ref: "#/components/schemas/source-tempo" + - title: source-the-guardian-api + $ref: "#/components/schemas/source-the-guardian-api" + - title: source-tiktok-marketing + $ref: "#/components/schemas/source-tiktok-marketing" + - title: source-trello + $ref: "#/components/schemas/source-trello" + - title: source-trustpilot + $ref: "#/components/schemas/source-trustpilot" + - title: source-tvmaze-schedule + $ref: "#/components/schemas/source-tvmaze-schedule" + - title: source-twilio + $ref: "#/components/schemas/source-twilio" + - title: source-twilio-taskrouter + $ref: "#/components/schemas/source-twilio-taskrouter" + - title: source-twitter + $ref: "#/components/schemas/source-twitter" + - title: source-typeform + $ref: "#/components/schemas/source-typeform" + - title: source-us-census + $ref: "#/components/schemas/source-us-census" + - title: source-vantage + $ref: "#/components/schemas/source-vantage" + - title: source-webflow + $ref: "#/components/schemas/source-webflow" + - title: source-whisky-hunter + $ref: "#/components/schemas/source-whisky-hunter" + - title: source-wikipedia-pageviews + $ref: "#/components/schemas/source-wikipedia-pageviews" + - title: source-woocommerce + $ref: "#/components/schemas/source-woocommerce" + - title: source-xkcd + $ref: "#/components/schemas/source-xkcd" + - title: source-yandex-metrica + $ref: "#/components/schemas/source-yandex-metrica" + - title: source-yotpo + $ref: "#/components/schemas/source-yotpo" + - title: source-youtube-analytics + $ref: "#/components/schemas/source-youtube-analytics" + - title: source-zendesk-chat + $ref: "#/components/schemas/source-zendesk-chat" + - title: source-zendesk-sell + $ref: "#/components/schemas/source-zendesk-sell" + - title: source-zendesk-sunshine + $ref: "#/components/schemas/source-zendesk-sunshine" + - title: source-zendesk-support + $ref: "#/components/schemas/source-zendesk-support" + - title: source-zendesk-talk + $ref: "#/components/schemas/source-zendesk-talk" + - title: source-zenloop + $ref: "#/components/schemas/source-zenloop" + - title: source-zoho-crm + $ref: "#/components/schemas/source-zoho-crm" + - title: source-zoom + $ref: "#/components/schemas/source-zoom" + DestinationConfiguration: + description: The values required to configure the destination. + example: { user: "charles" } + oneOf: + - title: destination-google-sheets + $ref: "#/components/schemas/destination-google-sheets" + - title: destination-astra + $ref: "#/components/schemas/destination-astra" + - title: destination-aws-datalake + $ref: "#/components/schemas/destination-aws-datalake" + - title: destination-azure-blob-storage + $ref: "#/components/schemas/destination-azure-blob-storage" + - title: destination-bigquery + $ref: "#/components/schemas/destination-bigquery" + - title: destination-clickhouse + $ref: "#/components/schemas/destination-clickhouse" + - title: destination-convex + $ref: "#/components/schemas/destination-convex" + - title: destination-databricks + $ref: "#/components/schemas/destination-databricks" + - title: destination-dev-null + $ref: "#/components/schemas/destination-dev-null" + - title: destination-duckdb + $ref: "#/components/schemas/destination-duckdb" + - title: destination-dynamodb + $ref: "#/components/schemas/destination-dynamodb" + - title: destination-elasticsearch + $ref: "#/components/schemas/destination-elasticsearch" + - title: destination-firestore + $ref: "#/components/schemas/destination-firestore" + - title: destination-gcs + $ref: "#/components/schemas/destination-gcs" + - title: destination-langchain + $ref: "#/components/schemas/destination-langchain" + - title: destination-milvus + $ref: "#/components/schemas/destination-milvus" + - title: destination-mongodb + $ref: "#/components/schemas/destination-mongodb" + - title: destination-mssql + $ref: "#/components/schemas/destination-mssql" + - title: destination-mysql + $ref: "#/components/schemas/destination-mysql" + - title: destination-oracle + $ref: "#/components/schemas/destination-oracle" + - title: destination-pinecone + $ref: "#/components/schemas/destination-pinecone" + - title: destination-postgres + $ref: "#/components/schemas/destination-postgres" + - title: destination-pubsub + $ref: "#/components/schemas/destination-pubsub" + - title: destination-qdrant + $ref: "#/components/schemas/destination-qdrant" + - title: destination-redis + $ref: "#/components/schemas/destination-redis" + - title: destination-redshift + $ref: "#/components/schemas/destination-redshift" + - title: destination-s3 + $ref: "#/components/schemas/destination-s3" + - title: destination-s3-glue + $ref: "#/components/schemas/destination-s3-glue" + - title: destination-sftp-json + $ref: "#/components/schemas/destination-sftp-json" + - title: destination-snowflake + $ref: "#/components/schemas/destination-snowflake" + - title: destination-teradata + $ref: "#/components/schemas/destination-teradata" + - title: destination-typesense + $ref: "#/components/schemas/destination-typesense" + - title: destination-vectara + $ref: "#/components/schemas/destination-vectara" + - title: destination-weaviate + $ref: "#/components/schemas/destination-weaviate" + InitiateOauthRequest: + title: Root Type for initiate-oauth-post-body + description: POST body for initiating OAuth via the public API + required: + - redirectUrl + - workspaceId + - sourceType + type: object + example: + redirectUrl: "https://cloud.airbyte.io/v1/api/oauth/callback" + workspaceId: 871d9b60-11d1-44cb-8c92-c246d53bf87e + destinationId: 3d93b16c-ff5f-421c-8908-5a3c82088f14 + properties: + redirectUrl: + description: >- + The URL to redirect the user to with the OAuth secret stored in the secret_id query + string parameter after authentication is complete. + type: string + workspaceId: + format: uuid + description: The workspace to create the secret and eventually the full source. + type: string + oAuthInputConfiguration: + $ref: "#/components/schemas/OAuthInputConfiguration" + description: Input configuration for OAuth required by some sources. + sourceType: + $ref: "#/components/schemas/OAuthActorNames" + WorkspaceOAuthCredentialsRequest: + title: "Root Type for WorkspaceOAuthCredentials" + description: "POST body for creating/updating workspace level OAuth credentials" + required: + - "actorType" + - "name" + - "configuration" + type: "object" + properties: + actorType: + $ref: "#/components/schemas/ActorTypeEnum" + name: + $ref: "#/components/schemas/OAuthActorNames" + configuration: + $ref: "#/components/schemas/OAuthCredentialsConfiguration" + OAuthActorNames: + enum: + - airtable + - amazon-ads + - amazon-seller-partner + - asana + - bing-ads + - facebook-marketing + - github + - gitlab + - google-ads + - google-analytics-data-api + - google-drive + - google-search-console + - google-sheets + - harvest + - hubspot + - instagram + - intercom + - lever-hiring + - linkedin-ads + - mailchimp + - microsoft-onedrive + - microsoft-sharepoint + - microsoft-teams + - monday + - notion + - pinterest + - retently + - salesforce + - slack + - smartsheets + - snapchat-marketing + - snowflake + - square + - strava + - surveymonkey + - tiktok-marketing + - trello + - typeform + - youtube-analytics + - zendesk-chat + - zendesk-sunshine + - zendesk-support + - zendesk-talk + OAuthCredentialsConfiguration: + description: The values required to configure the source. + example: { user: "charles" } + oneOf: + - title: airtable + $ref: "#/components/schemas/airtable" + - title: amazon-ads + $ref: "#/components/schemas/amazon-ads" + - title: amazon-seller-partner + $ref: "#/components/schemas/amazon-seller-partner" + - title: asana + $ref: "#/components/schemas/asana" + - title: bing-ads + $ref: "#/components/schemas/bing-ads" + - title: facebook-marketing + $ref: "#/components/schemas/facebook-marketing" + - title: github + $ref: "#/components/schemas/github" + - title: gitlab + $ref: "#/components/schemas/gitlab" + - title: google-ads + $ref: "#/components/schemas/google-ads" + - title: google-analytics-data-api + $ref: "#/components/schemas/google-analytics-data-api" + - title: google-drive + $ref: "#/components/schemas/google-drive" + - title: google-search-console + $ref: "#/components/schemas/google-search-console" + - title: google-sheets + $ref: "#/components/schemas/google-sheets" + - title: harvest + $ref: "#/components/schemas/harvest" + - title: hubspot + $ref: "#/components/schemas/hubspot" + - title: instagram + $ref: "#/components/schemas/instagram" + - title: intercom + $ref: "#/components/schemas/intercom" + - title: lever-hiring + $ref: "#/components/schemas/lever-hiring" + - title: linkedin-ads + $ref: "#/components/schemas/linkedin-ads" + - title: mailchimp + $ref: "#/components/schemas/mailchimp" + - title: microsoft-onedrive + $ref: "#/components/schemas/microsoft-onedrive" + - title: microsoft-sharepoint + $ref: "#/components/schemas/microsoft-sharepoint" + - title: microsoft-teams + $ref: "#/components/schemas/microsoft-teams" + - title: monday + $ref: "#/components/schemas/monday" + - title: notion + $ref: "#/components/schemas/notion" + - title: pinterest + $ref: "#/components/schemas/pinterest" + - title: retently + $ref: "#/components/schemas/retently" + - title: salesforce + $ref: "#/components/schemas/salesforce" + - title: shopify + $ref: "#/components/schemas/shopify" + - title: slack + $ref: "#/components/schemas/slack" + - title: smartsheets + $ref: "#/components/schemas/smartsheets" + - title: snapchat-marketing + $ref: "#/components/schemas/snapchat-marketing" + - title: snowflake + $ref: "#/components/schemas/snowflake" + - title: square + $ref: "#/components/schemas/square" + - title: strava + $ref: "#/components/schemas/strava" + - title: surveymonkey + $ref: "#/components/schemas/surveymonkey" + - title: tiktok-marketing + $ref: "#/components/schemas/tiktok-marketing" + - title: trello + $ref: "#/components/schemas/trello" + - title: typeform + $ref: "#/components/schemas/typeform" + - title: youtube-analytics + $ref: "#/components/schemas/youtube-analytics" + - title: zendesk-chat + $ref: "#/components/schemas/zendesk-chat" + - title: zendesk-sunshine + $ref: "#/components/schemas/zendesk-sunshine" + - title: zendesk-support + $ref: "#/components/schemas/zendesk-support" + - title: zendesk-talk + $ref: "#/components/schemas/zendesk-talk" + securitySchemes: + bearerAuth: + type: http + scheme: bearer + bearerFormat: JWT + basicAuth: + type: http + scheme: basic +security: + - bearerAuth: [] + - basicAuth: [] diff --git a/docs/models/operations/canceljobrequest.md b/docs/api/canceljobrequest.md similarity index 100% rename from docs/models/operations/canceljobrequest.md rename to docs/api/canceljobrequest.md diff --git a/docs/models/operations/canceljobresponse.md b/docs/api/canceljobresponse.md similarity index 97% rename from docs/models/operations/canceljobresponse.md rename to docs/api/canceljobresponse.md index cc3236d2..83f13c26 100644 --- a/docs/models/operations/canceljobresponse.md +++ b/docs/api/canceljobresponse.md @@ -8,4 +8,4 @@ | `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 +| `job_response` | [Optional[models.JobResponse]](../models/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/createconnectionresponse.md b/docs/api/createconnectionresponse.md similarity index 94% rename from docs/models/operations/createconnectionresponse.md rename to docs/api/createconnectionresponse.md index 3467ea8a..6f733b5a 100644 --- a/docs/models/operations/createconnectionresponse.md +++ b/docs/api/createconnectionresponse.md @@ -8,4 +8,4 @@ | `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 | -| `connection_response` | [Optional[shared.ConnectionResponse]](../../models/shared/connectionresponse.md) | :heavy_minus_sign: | Successful operation | \ No newline at end of file +| `connection_response` | [Optional[models.ConnectionResponse]](../models/connectionresponse.md) | :heavy_minus_sign: | Successful operation | \ No newline at end of file diff --git a/docs/models/operations/createdestinationresponse.md b/docs/api/createdestinationresponse.md similarity index 97% rename from docs/models/operations/createdestinationresponse.md rename to docs/api/createdestinationresponse.md index 9405625f..2e0b6c6d 100644 --- a/docs/models/operations/createdestinationresponse.md +++ b/docs/api/createdestinationresponse.md @@ -8,4 +8,4 @@ | `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 +| `destination_response` | [Optional[models.DestinationResponse]](../models/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/api/createjobresponse.md similarity index 97% rename from docs/models/operations/createjobresponse.md rename to docs/api/createjobresponse.md index 7b90a9e3..3f7c1eae 100644 --- a/docs/models/operations/createjobresponse.md +++ b/docs/api/createjobresponse.md @@ -8,4 +8,4 @@ | `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 +| `job_response` | [Optional[models.JobResponse]](../models/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/api/createorupdateworkspaceoauthcredentialsrequest.md b/docs/api/createorupdateworkspaceoauthcredentialsrequest.md new file mode 100644 index 00000000..95b94751 --- /dev/null +++ b/docs/api/createorupdateworkspaceoauthcredentialsrequest.md @@ -0,0 +1,9 @@ +# CreateOrUpdateWorkspaceOAuthCredentialsRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `workspace_o_auth_credentials_request` | [models.WorkspaceOAuthCredentialsRequest](../models/workspaceoauthcredentialsrequest.md) | :heavy_check_mark: | N/A | +| `workspace_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/createorupdateworkspaceoauthcredentialsresponse.md b/docs/api/createorupdateworkspaceoauthcredentialsresponse.md similarity index 100% rename from docs/models/operations/createorupdateworkspaceoauthcredentialsresponse.md rename to docs/api/createorupdateworkspaceoauthcredentialsresponse.md diff --git a/docs/models/operations/createsourceresponse.md b/docs/api/createsourceresponse.md similarity index 97% rename from docs/models/operations/createsourceresponse.md rename to docs/api/createsourceresponse.md index 7c0b6899..8b7d4783 100644 --- a/docs/models/operations/createsourceresponse.md +++ b/docs/api/createsourceresponse.md @@ -8,4 +8,4 @@ | `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 +| `source_response` | [Optional[models.SourceResponse]](../models/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/createworkspaceresponse.md b/docs/api/createworkspaceresponse.md similarity index 94% rename from docs/models/operations/createworkspaceresponse.md rename to docs/api/createworkspaceresponse.md index a27a346d..3304dc99 100644 --- a/docs/models/operations/createworkspaceresponse.md +++ b/docs/api/createworkspaceresponse.md @@ -8,4 +8,4 @@ | `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 | -| `workspace_response` | [Optional[shared.WorkspaceResponse]](../../models/shared/workspaceresponse.md) | :heavy_minus_sign: | Successful operation | \ No newline at end of file +| `workspace_response` | [Optional[models.WorkspaceResponse]](../models/workspaceresponse.md) | :heavy_minus_sign: | Successful operation | \ No newline at end of file diff --git a/docs/models/operations/deleteconnectionrequest.md b/docs/api/deleteconnectionrequest.md similarity index 100% rename from docs/models/operations/deleteconnectionrequest.md rename to docs/api/deleteconnectionrequest.md diff --git a/docs/models/operations/deleteconnectionresponse.md b/docs/api/deleteconnectionresponse.md similarity index 100% rename from docs/models/operations/deleteconnectionresponse.md rename to docs/api/deleteconnectionresponse.md diff --git a/docs/models/operations/deletedestinationrequest.md b/docs/api/deletedestinationrequest.md similarity index 100% rename from docs/models/operations/deletedestinationrequest.md rename to docs/api/deletedestinationrequest.md diff --git a/docs/models/operations/deletedestinationresponse.md b/docs/api/deletedestinationresponse.md similarity index 100% rename from docs/models/operations/deletedestinationresponse.md rename to docs/api/deletedestinationresponse.md diff --git a/docs/models/operations/deletesourcerequest.md b/docs/api/deletesourcerequest.md similarity index 100% rename from docs/models/operations/deletesourcerequest.md rename to docs/api/deletesourcerequest.md diff --git a/docs/models/operations/deletesourceresponse.md b/docs/api/deletesourceresponse.md similarity index 100% rename from docs/models/operations/deletesourceresponse.md rename to docs/api/deletesourceresponse.md diff --git a/docs/models/operations/deleteworkspacerequest.md b/docs/api/deleteworkspacerequest.md similarity index 100% rename from docs/models/operations/deleteworkspacerequest.md rename to docs/api/deleteworkspacerequest.md diff --git a/docs/models/operations/deleteworkspaceresponse.md b/docs/api/deleteworkspaceresponse.md similarity index 100% rename from docs/models/operations/deleteworkspaceresponse.md rename to docs/api/deleteworkspaceresponse.md diff --git a/docs/models/operations/getconnectionrequest.md b/docs/api/getconnectionrequest.md similarity index 100% rename from docs/models/operations/getconnectionrequest.md rename to docs/api/getconnectionrequest.md diff --git a/docs/models/operations/getconnectionresponse.md b/docs/api/getconnectionresponse.md similarity index 94% rename from docs/models/operations/getconnectionresponse.md rename to docs/api/getconnectionresponse.md index 53faf956..bed1d9b4 100644 --- a/docs/models/operations/getconnectionresponse.md +++ b/docs/api/getconnectionresponse.md @@ -8,4 +8,4 @@ | `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 | -| `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 +| `connection_response` | [Optional[models.ConnectionResponse]](../models/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/getdestinationrequest.md b/docs/api/getdestinationrequest.md similarity index 100% rename from docs/models/operations/getdestinationrequest.md rename to docs/api/getdestinationrequest.md diff --git a/docs/models/operations/getdestinationresponse.md b/docs/api/getdestinationresponse.md similarity index 97% rename from docs/models/operations/getdestinationresponse.md rename to docs/api/getdestinationresponse.md index 55cde6a5..20ec66b6 100644 --- a/docs/models/operations/getdestinationresponse.md +++ b/docs/api/getdestinationresponse.md @@ -8,4 +8,4 @@ | `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 +| `destination_response` | [Optional[models.DestinationResponse]](../models/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/getjobrequest.md b/docs/api/getjobrequest.md similarity index 100% rename from docs/models/operations/getjobrequest.md rename to docs/api/getjobrequest.md diff --git a/docs/models/operations/getjobresponse.md b/docs/api/getjobresponse.md similarity index 97% rename from docs/models/operations/getjobresponse.md rename to docs/api/getjobresponse.md index d5eea6c2..bab4f5d5 100644 --- a/docs/models/operations/getjobresponse.md +++ b/docs/api/getjobresponse.md @@ -8,4 +8,4 @@ | `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 +| `job_response` | [Optional[models.JobResponse]](../models/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/getsourcerequest.md b/docs/api/getsourcerequest.md similarity index 100% rename from docs/models/operations/getsourcerequest.md rename to docs/api/getsourcerequest.md diff --git a/docs/models/operations/getsourceresponse.md b/docs/api/getsourceresponse.md similarity index 97% rename from docs/models/operations/getsourceresponse.md rename to docs/api/getsourceresponse.md index 7ca8881e..639f3abb 100644 --- a/docs/models/operations/getsourceresponse.md +++ b/docs/api/getsourceresponse.md @@ -8,4 +8,4 @@ | `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 +| `source_response` | [Optional[models.SourceResponse]](../models/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/getstreampropertiesrequest.md b/docs/api/getstreampropertiesrequest.md similarity index 100% rename from docs/models/operations/getstreampropertiesrequest.md rename to docs/api/getstreampropertiesrequest.md diff --git a/docs/api/getstreampropertiesresponse.md b/docs/api/getstreampropertiesresponse.md new file mode 100644 index 00000000..e3e7911d --- /dev/null +++ b/docs/api/getstreampropertiesresponse.md @@ -0,0 +1,11 @@ +# GetStreamPropertiesResponse + + +## 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 | +| `stream_properties_response` | [Optional[models.StreamPropertiesResponse]](../models/streampropertiesresponse.md) | :heavy_minus_sign: | Get the available streams properties for a source/destination pair. | \ No newline at end of file diff --git a/docs/models/operations/getworkspacerequest.md b/docs/api/getworkspacerequest.md similarity index 100% rename from docs/models/operations/getworkspacerequest.md rename to docs/api/getworkspacerequest.md diff --git a/docs/models/operations/getworkspaceresponse.md b/docs/api/getworkspaceresponse.md similarity index 94% rename from docs/models/operations/getworkspaceresponse.md rename to docs/api/getworkspaceresponse.md index 00760ef6..37c299d7 100644 --- a/docs/models/operations/getworkspaceresponse.md +++ b/docs/api/getworkspaceresponse.md @@ -8,4 +8,4 @@ | `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 | -| `workspace_response` | [Optional[shared.WorkspaceResponse]](../../models/shared/workspaceresponse.md) | :heavy_minus_sign: | Get a Workspace by the id in the path. | \ No newline at end of file +| `workspace_response` | [Optional[models.WorkspaceResponse]](../models/workspaceresponse.md) | :heavy_minus_sign: | Get a Workspace by the id in the path. | \ No newline at end of file diff --git a/docs/models/operations/initiateoauthresponse.md b/docs/api/initiateoauthresponse.md similarity index 100% rename from docs/models/operations/initiateoauthresponse.md rename to docs/api/initiateoauthresponse.md diff --git a/docs/models/operations/listconnectionsrequest.md b/docs/api/listconnectionsrequest.md similarity index 100% rename from docs/models/operations/listconnectionsrequest.md rename to docs/api/listconnectionsrequest.md diff --git a/docs/models/operations/listconnectionsresponse.md b/docs/api/listconnectionsresponse.md similarity index 99% rename from docs/models/operations/listconnectionsresponse.md rename to docs/api/listconnectionsresponse.md index abb9ae59..bde7ba9a 100644 --- a/docs/models/operations/listconnectionsresponse.md +++ b/docs/api/listconnectionsresponse.md @@ -8,4 +8,4 @@ | `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\u0026offset=10",
    "previous": "https://api.airbyte.com/v1/connections?limit=5\u0026offset=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 +| `connections_response` | [Optional[models.ConnectionsResponse]](../models/connectionsresponse.md) | :heavy_minus_sign: | Successful operation | {
    "next": "https://api.airbyte.com/v1/connections?limit=5\u0026offset=10",
    "previous": "https://api.airbyte.com/v1/connections?limit=5\u0026offset=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/listdestinationsrequest.md b/docs/api/listdestinationsrequest.md similarity index 100% rename from docs/models/operations/listdestinationsrequest.md rename to docs/api/listdestinationsrequest.md diff --git a/docs/models/operations/listdestinationsresponse.md b/docs/api/listdestinationsresponse.md similarity index 98% rename from docs/models/operations/listdestinationsresponse.md rename to docs/api/listdestinationsresponse.md index b441c467..37c86ca2 100644 --- a/docs/models/operations/listdestinationsresponse.md +++ b/docs/api/listdestinationsresponse.md @@ -8,4 +8,4 @@ | `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\u0026offset=10",
    "previous": "https://api.airbyte.com/v1/destinations?limit=5\u0026offset=0",
    "data": {
    "destinationId": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826",
    "name": "Analytics Team Postgres",
    "destinationType": "postgres",
    "workspaceId": "871d9b60-11d1-44cb-8c92-c246d53bf87e"
    }
    } | \ No newline at end of file +| `destinations_response` | [Optional[models.DestinationsResponse]](../models/destinationsresponse.md) | :heavy_minus_sign: | Successful operation | {
    "next": "https://api.airbyte.com/v1/destinations?limit=5\u0026offset=10",
    "previous": "https://api.airbyte.com/v1/destinations?limit=5\u0026offset=0",
    "data": {
    "destinationId": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826",
    "name": "Analytics Team Postgres",
    "destinationType": "postgres",
    "workspaceId": "871d9b60-11d1-44cb-8c92-c246d53bf87e"
    }
    } | \ No newline at end of file diff --git a/docs/models/operations/listjobsrequest.md b/docs/api/listjobsrequest.md similarity index 95% rename from docs/models/operations/listjobsrequest.md rename to docs/api/listjobsrequest.md index c0f2a0af..692f10bd 100644 --- a/docs/models/operations/listjobsrequest.md +++ b/docs/api/listjobsrequest.md @@ -8,11 +8,11 @@ | `connection_id` | *Optional[str]* | :heavy_minus_sign: | Filter the Jobs by connectionId. | | `created_at_end` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | The end date to filter by | | `created_at_start` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | The start date to filter by | -| `job_type` | [Optional[shared.JobTypeEnum]](../../models/shared/jobtypeenum.md) | :heavy_minus_sign: | Filter the Jobs by jobType. | +| `job_type` | [Optional[models.JobTypeEnum]](../models/jobtypeenum.md) | :heavy_minus_sign: | Filter the Jobs by jobType. | | `limit` | *Optional[int]* | :heavy_minus_sign: | Set the limit on the number of Jobs returned. The default is 20 Jobs. | | `offset` | *Optional[int]* | :heavy_minus_sign: | Set the offset to start at when returning Jobs. The default is 0. | | `order_by` | *Optional[str]* | :heavy_minus_sign: | The field and method to use for ordering. Currently allowed are createdAt and updatedAt. | -| `status` | [Optional[shared.JobStatusEnum]](../../models/shared/jobstatusenum.md) | :heavy_minus_sign: | The Job status you want to filter by | +| `status` | [Optional[models.JobStatusEnum]](../models/jobstatusenum.md) | :heavy_minus_sign: | The Job status you want to filter by | | `updated_at_end` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | The end date to filter by | | `updated_at_start` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | The start date to filter by | | `workspace_ids` | List[*str*] | :heavy_minus_sign: | The UUIDs of the workspaces you wish to list jobs for. Empty list will retrieve all allowed workspaces. | \ No newline at end of file diff --git a/docs/models/operations/listjobsresponse.md b/docs/api/listjobsresponse.md similarity index 98% rename from docs/models/operations/listjobsresponse.md rename to docs/api/listjobsresponse.md index 1ff35af4..91b40b17 100644 --- a/docs/models/operations/listjobsresponse.md +++ b/docs/api/listjobsresponse.md @@ -8,4 +8,4 @@ | `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\u0026offset=10",
    "previous": "https://api.airbyte.com/v1/jobs?limit=5\u0026offset=0",
    "data": [
    {
    "id": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826",
    "status": "running",
    "jobType": "sync",
    "startTime": "2023-03-25T01:30:50Z"
    }
    ]
    } | \ No newline at end of file +| `jobs_response` | [Optional[models.JobsResponse]](../models/jobsresponse.md) | :heavy_minus_sign: | List all the Jobs by connectionId. | {
    "next": "https://api.airbyte.com/v1/jobs?limit=5\u0026offset=10",
    "previous": "https://api.airbyte.com/v1/jobs?limit=5\u0026offset=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/listsourcesrequest.md b/docs/api/listsourcesrequest.md similarity index 100% rename from docs/models/operations/listsourcesrequest.md rename to docs/api/listsourcesrequest.md diff --git a/docs/models/operations/listsourcesresponse.md b/docs/api/listsourcesresponse.md similarity index 98% rename from docs/models/operations/listsourcesresponse.md rename to docs/api/listsourcesresponse.md index 689ec600..4740ce4e 100644 --- a/docs/models/operations/listsourcesresponse.md +++ b/docs/api/listsourcesresponse.md @@ -8,4 +8,4 @@ | `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\u0026offset=10",
    "previous": "https://api.airbyte.com/v1/sources?limit=5\u0026offset=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 +| `sources_response` | [Optional[models.SourcesResponse]](../models/sourcesresponse.md) | :heavy_minus_sign: | Successful operation | {
    "next": "https://api.airbyte.com/v1/sources?limit=5\u0026offset=10",
    "previous": "https://api.airbyte.com/v1/sources?limit=5\u0026offset=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/listworkspacesrequest.md b/docs/api/listworkspacesrequest.md similarity index 100% rename from docs/models/operations/listworkspacesrequest.md rename to docs/api/listworkspacesrequest.md diff --git a/docs/models/operations/listworkspacesresponse.md b/docs/api/listworkspacesresponse.md similarity index 98% rename from docs/models/operations/listworkspacesresponse.md rename to docs/api/listworkspacesresponse.md index f68a30ae..691880cb 100644 --- a/docs/models/operations/listworkspacesresponse.md +++ b/docs/api/listworkspacesresponse.md @@ -8,4 +8,4 @@ | `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\u0026offset=10",
    "previous": "https://api.airbyte.com/v1/workspaces?limit=5\u0026offset=0",
    "data": {
    "workspaceId": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826",
    "name": "Acme Company",
    "dataResidency": "auto"
    }
    } | \ No newline at end of file +| `workspaces_response` | [Optional[models.WorkspacesResponse]](../models/workspacesresponse.md) | :heavy_minus_sign: | Successful operation | {
    "next": "https://api.airbyte.com/v1/workspaces?limit=5\u0026offset=10",
    "previous": "https://api.airbyte.com/v1/workspaces?limit=5\u0026offset=0",
    "data": {
    "workspaceId": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826",
    "name": "Acme Company",
    "dataResidency": "auto"
    }
    } | \ No newline at end of file diff --git a/docs/api/patchconnectionrequest.md b/docs/api/patchconnectionrequest.md new file mode 100644 index 00000000..d0bf3c3d --- /dev/null +++ b/docs/api/patchconnectionrequest.md @@ -0,0 +1,9 @@ +# PatchConnectionRequest + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `connection_patch_request` | [models.ConnectionPatchRequest](../models/connectionpatchrequest.md) | :heavy_check_mark: | N/A | +| `connection_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/patchconnectionresponse.md b/docs/api/patchconnectionresponse.md similarity index 94% rename from docs/models/operations/patchconnectionresponse.md rename to docs/api/patchconnectionresponse.md index dfc3de6d..b4b05d1a 100644 --- a/docs/models/operations/patchconnectionresponse.md +++ b/docs/api/patchconnectionresponse.md @@ -8,4 +8,4 @@ | `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 | -| `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 +| `connection_response` | [Optional[models.ConnectionResponse]](../models/connectionresponse.md) | :heavy_minus_sign: | Update a Connection by the id in the path. | \ No newline at end of file diff --git a/docs/api/patchdestinationrequest.md b/docs/api/patchdestinationrequest.md new file mode 100644 index 00000000..ab805401 --- /dev/null +++ b/docs/api/patchdestinationrequest.md @@ -0,0 +1,9 @@ +# PatchDestinationRequest + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `destination_id` | *str* | :heavy_check_mark: | N/A | +| `destination_patch_request` | [Optional[models.DestinationPatchRequest]](../models/destinationpatchrequest.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/patchdestinationresponse.md b/docs/api/patchdestinationresponse.md similarity index 97% rename from docs/models/operations/patchdestinationresponse.md rename to docs/api/patchdestinationresponse.md index 291464ac..a0f255b2 100644 --- a/docs/models/operations/patchdestinationresponse.md +++ b/docs/api/patchdestinationresponse.md @@ -8,4 +8,4 @@ | `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 +| `destination_response` | [Optional[models.DestinationResponse]](../models/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/api/patchsourcerequest.md b/docs/api/patchsourcerequest.md new file mode 100644 index 00000000..9555225f --- /dev/null +++ b/docs/api/patchsourcerequest.md @@ -0,0 +1,9 @@ +# PatchSourceRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `source_id` | *str* | :heavy_check_mark: | N/A | +| `source_patch_request` | [Optional[models.SourcePatchRequest]](../models/sourcepatchrequest.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/patchsourceresponse.md b/docs/api/patchsourceresponse.md similarity index 97% rename from docs/models/operations/patchsourceresponse.md rename to docs/api/patchsourceresponse.md index 397526f7..8f9e6dd5 100644 --- a/docs/models/operations/patchsourceresponse.md +++ b/docs/api/patchsourceresponse.md @@ -8,4 +8,4 @@ | `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 +| `source_response` | [Optional[models.SourceResponse]](../models/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/api/putdestinationrequest.md b/docs/api/putdestinationrequest.md new file mode 100644 index 00000000..8a37f87f --- /dev/null +++ b/docs/api/putdestinationrequest.md @@ -0,0 +1,9 @@ +# PutDestinationRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `destination_id` | *str* | :heavy_check_mark: | N/A | +| `destination_put_request` | [Optional[models.DestinationPutRequest]](../models/destinationputrequest.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/putdestinationresponse.md b/docs/api/putdestinationresponse.md similarity index 97% rename from docs/models/operations/putdestinationresponse.md rename to docs/api/putdestinationresponse.md index 09312b00..39f8b796 100644 --- a/docs/models/operations/putdestinationresponse.md +++ b/docs/api/putdestinationresponse.md @@ -8,4 +8,4 @@ | `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 +| `destination_response` | [Optional[models.DestinationResponse]](../models/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/api/putsourcerequest.md b/docs/api/putsourcerequest.md new file mode 100644 index 00000000..ccbd54c2 --- /dev/null +++ b/docs/api/putsourcerequest.md @@ -0,0 +1,9 @@ +# PutSourceRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `source_id` | *str* | :heavy_check_mark: | N/A | +| `source_put_request` | [Optional[models.SourcePutRequest]](../models/sourceputrequest.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/putsourceresponse.md b/docs/api/putsourceresponse.md similarity index 97% rename from docs/models/operations/putsourceresponse.md rename to docs/api/putsourceresponse.md index 4028804e..03f64223 100644 --- a/docs/models/operations/putsourceresponse.md +++ b/docs/api/putsourceresponse.md @@ -8,4 +8,4 @@ | `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 +| `source_response` | [Optional[models.SourceResponse]](../models/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/api/updateworkspacerequest.md b/docs/api/updateworkspacerequest.md new file mode 100644 index 00000000..784686fa --- /dev/null +++ b/docs/api/updateworkspacerequest.md @@ -0,0 +1,9 @@ +# UpdateWorkspaceRequest + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `workspace_update_request` | [models.WorkspaceUpdateRequest](../models/workspaceupdaterequest.md) | :heavy_check_mark: | N/A | +| `workspace_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/updateworkspaceresponse.md b/docs/api/updateworkspaceresponse.md similarity index 94% rename from docs/models/operations/updateworkspaceresponse.md rename to docs/api/updateworkspaceresponse.md index 8ec9f53d..39fc6c64 100644 --- a/docs/models/operations/updateworkspaceresponse.md +++ b/docs/api/updateworkspaceresponse.md @@ -8,4 +8,4 @@ | `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 | -| `workspace_response` | [Optional[shared.WorkspaceResponse]](../../models/shared/workspaceresponse.md) | :heavy_minus_sign: | Successful operation | \ No newline at end of file +| `workspace_response` | [Optional[models.WorkspaceResponse]](../models/workspaceresponse.md) | :heavy_minus_sign: | Successful operation | \ No newline at end of file diff --git a/docs/models/shared/accesstoken.md b/docs/models/accesstoken.md similarity index 95% rename from docs/models/shared/accesstoken.md rename to docs/models/accesstoken.md index 7660a6f7..45698713 100644 --- a/docs/models/shared/accesstoken.md +++ b/docs/models/accesstoken.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `access_token` | *str* | :heavy_check_mark: | The access token generated for your developer application. Refer to our documentation for more information. | -| `auth_method` | [Optional[shared.SourceLinkedinAdsSchemasAuthMethod]](../../models/shared/sourcelinkedinadsschemasauthmethod.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `auth_method` | [Optional[models.SourceLinkedinAdsSchemasAuthMethod]](../models/sourcelinkedinadsschemasauthmethod.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/accesstokenisrequiredforauthenticationrequests.md b/docs/models/accesstokenisrequiredforauthenticationrequests.md similarity index 100% rename from docs/models/shared/accesstokenisrequiredforauthenticationrequests.md rename to docs/models/accesstokenisrequiredforauthenticationrequests.md diff --git a/docs/models/shared/accountnames.md b/docs/models/accountnames.md similarity index 97% rename from docs/models/shared/accountnames.md rename to docs/models/accountnames.md index e5ebd699..f747db47 100644 --- a/docs/models/shared/accountnames.md +++ b/docs/models/accountnames.md @@ -8,4 +8,4 @@ Account Names Predicates Config. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `name` | *str* | :heavy_check_mark: | Account Name is a string value for comparing with the specified predicate. | -| `operator` | [shared.Operator](../../models/shared/operator.md) | :heavy_check_mark: | An Operator that will be used to filter accounts. The Contains predicate has features for matching words, matching inflectional forms of words, searching using wildcard characters, and searching using proximity. The Equals is used to return all rows where account name is equal(=) to the string that you provided | \ No newline at end of file +| `operator` | [models.Operator](../models/operator.md) | :heavy_check_mark: | An Operator that will be used to filter accounts. The Contains predicate has features for matching words, matching inflectional forms of words, searching using wildcard characters, and searching using proximity. The Equals is used to return all rows where account name is equal(=) to the string that you provided | \ No newline at end of file diff --git a/docs/models/actionreporttime.md b/docs/models/actionreporttime.md new file mode 100644 index 00000000..99ef9e60 --- /dev/null +++ b/docs/models/actionreporttime.md @@ -0,0 +1,11 @@ +# ActionReportTime + +Specifies the principle for conversion reporting. + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `CONVERSION` | conversion | +| `IMPRESSION` | impression | \ No newline at end of file diff --git a/docs/models/shared/actortypeenum.md b/docs/models/actortypeenum.md similarity index 100% rename from docs/models/shared/actortypeenum.md rename to docs/models/actortypeenum.md diff --git a/docs/models/shared/adanalyticsreportconfiguration.md b/docs/models/adanalyticsreportconfiguration.md similarity index 96% rename from docs/models/shared/adanalyticsreportconfiguration.md rename to docs/models/adanalyticsreportconfiguration.md index cc5bb0d0..dd378549 100644 --- a/docs/models/shared/adanalyticsreportconfiguration.md +++ b/docs/models/adanalyticsreportconfiguration.md @@ -8,5 +8,5 @@ Config for custom ad Analytics Report | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | *str* | :heavy_check_mark: | The name for the custom report. | -| `pivot_by` | [shared.PivotCategory](../../models/shared/pivotcategory.md) | :heavy_check_mark: | Choose a category to pivot your analytics report around. This selection will organize your data based on the chosen attribute, allowing you to analyze trends and performance from different perspectives. | -| `time_granularity` | [shared.TimeGranularity](../../models/shared/timegranularity.md) | :heavy_check_mark: | Choose how to group the data in your report by time. The options are:
    - 'ALL': A single result summarizing the entire time range.
    - 'DAILY': Group results by each day.
    - 'MONTHLY': Group results by each month.
    - 'YEARLY': Group results by each year.
    Selecting a time grouping helps you analyze trends and patterns over different time periods. | \ No newline at end of file +| `pivot_by` | [models.PivotCategory](../models/pivotcategory.md) | :heavy_check_mark: | Choose a category to pivot your analytics report around. This selection will organize your data based on the chosen attribute, allowing you to analyze trends and performance from different perspectives. | +| `time_granularity` | [models.TimeGranularity](../models/timegranularity.md) | :heavy_check_mark: | Choose how to group the data in your report by time. The options are:
    - 'ALL': A single result summarizing the entire time range.
    - 'DAILY': Group results by each day.
    - 'MONTHLY': Group results by each month.
    - 'YEARLY': Group results by each year.
    Selecting a time grouping helps you analyze trends and patterns over different time periods. | \ No newline at end of file diff --git a/docs/models/shared/aescbcenvelopeencryption.md b/docs/models/aescbcenvelopeencryption.md similarity index 94% rename from docs/models/shared/aescbcenvelopeencryption.md rename to docs/models/aescbcenvelopeencryption.md index 8da32585..2e589491 100644 --- a/docs/models/shared/aescbcenvelopeencryption.md +++ b/docs/models/aescbcenvelopeencryption.md @@ -7,5 +7,5 @@ Staging data will be encrypted using AES-CBC envelope encryption. | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | -| `encryption_type` | [Optional[shared.DestinationRedshiftEncryptionType]](../../models/shared/destinationredshiftencryptiontype.md) | :heavy_minus_sign: | N/A | +| `encryption_type` | [Optional[models.DestinationRedshiftEncryptionType]](../models/destinationredshiftencryptiontype.md) | :heavy_minus_sign: | N/A | | `key_encrypting_key` | *Optional[str]* | :heavy_minus_sign: | The key, base64-encoded. Must be either 128, 192, or 256 bits. Leave blank to have Airbyte generate an ephemeral key for each sync. | \ No newline at end of file diff --git a/docs/models/shared/aha.md b/docs/models/aha.md similarity index 100% rename from docs/models/shared/aha.md rename to docs/models/aha.md diff --git a/docs/models/shared/aircall.md b/docs/models/aircall.md similarity index 100% rename from docs/models/shared/aircall.md rename to docs/models/aircall.md diff --git a/docs/models/airtable.md b/docs/models/airtable.md new file mode 100644 index 00000000..71ee2e45 --- /dev/null +++ b/docs/models/airtable.md @@ -0,0 +1,8 @@ +# Airtable + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | +| `credentials` | [Optional[models.Credentials]](../models/credentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/allow.md b/docs/models/allow.md new file mode 100644 index 00000000..ac57f0ae --- /dev/null +++ b/docs/models/allow.md @@ -0,0 +1,10 @@ +# Allow + +Allow SSL mode. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `mode` | [Optional[models.DestinationPostgresMode]](../models/destinationpostgresmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/amazonads.md b/docs/models/amazonads.md similarity index 100% rename from docs/models/shared/amazonads.md rename to docs/models/amazonads.md diff --git a/docs/models/shared/amazons3.md b/docs/models/amazons3.md similarity index 95% rename from docs/models/shared/amazons3.md rename to docs/models/amazons3.md index d868b0c8..52b0d727 100644 --- a/docs/models/shared/amazons3.md +++ b/docs/models/amazons3.md @@ -9,6 +9,6 @@ | `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_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 | | +| `data_source_type` | [models.DestinationDatabricksDataSourceType](../models/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 +| `s3_bucket_region` | [Optional[models.DestinationDatabricksS3BucketRegion]](../models/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/amazonsellerpartner.md b/docs/models/amazonsellerpartner.md similarity index 100% rename from docs/models/shared/amazonsellerpartner.md rename to docs/models/amazonsellerpartner.md diff --git a/docs/models/shared/amazonsqs.md b/docs/models/amazonsqs.md similarity index 100% rename from docs/models/shared/amazonsqs.md rename to docs/models/amazonsqs.md diff --git a/docs/models/shared/amplitude.md b/docs/models/amplitude.md similarity index 100% rename from docs/models/shared/amplitude.md rename to docs/models/amplitude.md diff --git a/docs/models/andgroup.md b/docs/models/andgroup.md new file mode 100644 index 00000000..89269132 --- /dev/null +++ b/docs/models/andgroup.md @@ -0,0 +1,11 @@ +# AndGroup + +The FilterExpressions in andGroup have an AND relationship. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | +| `expressions` | List[[models.Expression](../models/expression.md)] | :heavy_check_mark: | N/A | +| `filter_type` | [models.FilterType](../models/filtertype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/apiaccesstoken.md b/docs/models/apiaccesstoken.md similarity index 98% rename from docs/models/shared/apiaccesstoken.md rename to docs/models/apiaccesstoken.md index 92342ade..eb6c18bc 100644 --- a/docs/models/shared/apiaccesstoken.md +++ b/docs/models/apiaccesstoken.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `access_token` | *str* | :heavy_check_mark: | The access token to use for accessing your data from Smartsheets. This access token must be generated by a user with at least read access to the data you'd like to replicate. Generate an access token in the Smartsheets main menu by clicking Account > Apps & Integrations > API Access. See the setup guide for information on how to obtain this token. | -| `auth_type` | [Optional[shared.SourceSmartsheetsSchemasAuthType]](../../models/shared/sourcesmartsheetsschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `auth_type` | [Optional[models.SourceSmartsheetsSchemasAuthType]](../models/sourcesmartsheetsschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/apifydataset.md b/docs/models/apifydataset.md similarity index 100% rename from docs/models/shared/apifydataset.md rename to docs/models/apifydataset.md diff --git a/docs/models/shared/apikey.md b/docs/models/apikey.md similarity index 94% rename from docs/models/shared/apikey.md rename to docs/models/apikey.md index 6c0c21f9..c20d451f 100644 --- a/docs/models/shared/apikey.md +++ b/docs/models/apikey.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | | `apikey` | *str* | :heavy_check_mark: | Mailchimp API Key. See the docs for information on how to generate this key. | -| `auth_type` | [shared.SourceMailchimpSchemasAuthType](../../models/shared/sourcemailchimpschemasauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `auth_type` | [models.SourceMailchimpSchemasAuthType](../models/sourcemailchimpschemasauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/apikeyauth.md b/docs/models/apikeyauth.md new file mode 100644 index 00000000..558bcbe7 --- /dev/null +++ b/docs/models/apikeyauth.md @@ -0,0 +1,9 @@ +# APIKeyAuth + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `api_key` | *str* | :heavy_check_mark: | API Key for the Qdrant instance | +| `mode` | [Optional[models.DestinationQdrantSchemasIndexingMode]](../models/destinationqdrantschemasindexingmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/apikeysecret.md b/docs/models/apikeysecret.md new file mode 100644 index 00000000..89de7a8c --- /dev/null +++ b/docs/models/apikeysecret.md @@ -0,0 +1,12 @@ +# APIKeySecret + +Use a api key and secret combination to authenticate + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `api_key_id` | *str* | :heavy_check_mark: | The Key ID to used when accessing an enterprise Elasticsearch instance. | +| `api_key_secret` | *str* | :heavy_check_mark: | The secret associated with the API Key ID. | +| `method` | [models.DestinationElasticsearchMethod](../models/destinationelasticsearchmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/apipassword.md b/docs/models/apipassword.md new file mode 100644 index 00000000..db27f8cc --- /dev/null +++ b/docs/models/apipassword.md @@ -0,0 +1,11 @@ +# APIPassword + +API Password Auth + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `api_password` | *str* | :heavy_check_mark: | The API Password for your private application in the `Shopify` store. | +| `auth_method` | [models.SourceShopifySchemasAuthMethod](../models/sourceshopifyschemasauthmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/apitoken.md b/docs/models/apitoken.md new file mode 100644 index 00000000..41aa4ca9 --- /dev/null +++ b/docs/models/apitoken.md @@ -0,0 +1,9 @@ +# APIToken + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `api_token` | *str* | :heavy_check_mark: | API Token for making authenticated requests. | +| `auth_type` | [models.SourceMondaySchemasAuthType](../models/sourcemondayschemasauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/appfollow.md b/docs/models/appfollow.md similarity index 100% rename from docs/models/shared/appfollow.md rename to docs/models/appfollow.md diff --git a/docs/models/shared/applications.md b/docs/models/applications.md similarity index 100% rename from docs/models/shared/applications.md rename to docs/models/applications.md diff --git a/docs/models/asana.md b/docs/models/asana.md new file mode 100644 index 00000000..6afc9ecb --- /dev/null +++ b/docs/models/asana.md @@ -0,0 +1,8 @@ +# Asana + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `credentials` | [Optional[models.AsanaCredentials]](../models/asanacredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/asanacredentials.md b/docs/models/asanacredentials.md similarity index 100% rename from docs/models/shared/asanacredentials.md rename to docs/models/asanacredentials.md diff --git a/docs/models/shared/astra.md b/docs/models/astra.md similarity index 100% rename from docs/models/shared/astra.md rename to docs/models/astra.md diff --git a/docs/models/shared/auth0.md b/docs/models/auth0.md similarity index 100% rename from docs/models/shared/auth0.md rename to docs/models/auth0.md diff --git a/docs/models/shared/authenticateviaapikey.md b/docs/models/authenticateviaapikey.md similarity index 93% rename from docs/models/shared/authenticateviaapikey.md rename to docs/models/authenticateviaapikey.md index 5b4fafab..4cbdcdb7 100644 --- a/docs/models/shared/authenticateviaapikey.md +++ b/docs/models/authenticateviaapikey.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | API Key for making authenticated requests. More instruction on how to find this value in our docs | -| `auth_type` | [shared.SourceSalesloftSchemasAuthType](../../models/shared/sourcesalesloftschemasauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `auth_type` | [models.SourceSalesloftSchemasAuthType](../models/sourcesalesloftschemasauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/authenticateviaasanaoauth.md b/docs/models/authenticateviaasanaoauth.md new file mode 100644 index 00000000..3b1786cd --- /dev/null +++ b/docs/models/authenticateviaasanaoauth.md @@ -0,0 +1,11 @@ +# AuthenticateViaAsanaOauth + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `client_id` | *str* | :heavy_check_mark: | N/A | +| `client_secret` | *str* | :heavy_check_mark: | N/A | +| `refresh_token` | *str* | :heavy_check_mark: | N/A | +| `option_title` | [Optional[models.SourceAsanaCredentialsTitle]](../models/sourceasanacredentialstitle.md) | :heavy_minus_sign: | OAuth Credentials | \ No newline at end of file diff --git a/docs/models/authenticateviagoogleoauth.md b/docs/models/authenticateviagoogleoauth.md new file mode 100644 index 00000000..ab11ed56 --- /dev/null +++ b/docs/models/authenticateviagoogleoauth.md @@ -0,0 +1,12 @@ +# AuthenticateViaGoogleOauth + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `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. | +| `access_token` | *Optional[str]* | :heavy_minus_sign: | Access Token for making authenticated requests. | +| `auth_type` | [Optional[models.SourceGoogleAnalyticsDataAPIAuthType]](../models/sourcegoogleanalyticsdataapiauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/authenticateviaharvestoauth.md b/docs/models/authenticateviaharvestoauth.md new file mode 100644 index 00000000..35c8fc2a --- /dev/null +++ b/docs/models/authenticateviaharvestoauth.md @@ -0,0 +1,12 @@ +# AuthenticateViaHarvestOAuth + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `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. | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `auth_type` | [Optional[models.SourceHarvestAuthType]](../models/sourceharvestauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/authenticatevialeverapikey.md b/docs/models/authenticatevialeverapikey.md new file mode 100644 index 00000000..d91acb10 --- /dev/null +++ b/docs/models/authenticatevialeverapikey.md @@ -0,0 +1,9 @@ +# AuthenticateViaLeverAPIKey + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `api_key` | *str* | :heavy_check_mark: | The Api Key of your Lever Hiring account. | +| `auth_type` | [Optional[models.SourceLeverHiringSchemasAuthType]](../models/sourceleverhiringschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/authenticatevialeveroauth.md b/docs/models/authenticatevialeveroauth.md new file mode 100644 index 00000000..f1d17afb --- /dev/null +++ b/docs/models/authenticatevialeveroauth.md @@ -0,0 +1,11 @@ +# AuthenticateViaLeverOAuth + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `refresh_token` | *str* | :heavy_check_mark: | The token for obtaining new access token. | +| `auth_type` | [Optional[models.SourceLeverHiringAuthType]](../models/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. | \ No newline at end of file diff --git a/docs/models/shared/authenticateviamicrosoft.md b/docs/models/authenticateviamicrosoft.md similarity index 98% rename from docs/models/shared/authenticateviamicrosoft.md rename to docs/models/authenticateviamicrosoft.md index 316895a7..40dcfd56 100644 --- a/docs/models/shared/authenticateviamicrosoft.md +++ b/docs/models/authenticateviamicrosoft.md @@ -8,4 +8,4 @@ | `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 | -| `auth_type` | [Optional[shared.SourceMicrosoftTeamsSchemasAuthType]](../../models/shared/sourcemicrosoftteamsschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `auth_type` | [Optional[models.SourceMicrosoftTeamsSchemasAuthType]](../models/sourcemicrosoftteamsschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/authenticateviamicrosoftoauth.md b/docs/models/authenticateviamicrosoftoauth.md new file mode 100644 index 00000000..0e7b9fbc --- /dev/null +++ b/docs/models/authenticateviamicrosoftoauth.md @@ -0,0 +1,15 @@ +# AuthenticateViaMicrosoftOAuth + +OAuthCredentials class to hold authentication details for Microsoft OAuth authentication. +This class uses pydantic for data validation and settings management. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `client_id` | *str* | :heavy_check_mark: | Client ID of your Microsoft developer application | +| `client_secret` | *str* | :heavy_check_mark: | Client Secret of your Microsoft developer application | +| `refresh_token` | *str* | :heavy_check_mark: | Refresh Token of your Microsoft developer application | +| `tenant_id` | *str* | :heavy_check_mark: | Tenant ID of the Microsoft OneDrive user | +| `auth_type` | [Optional[models.SourceMicrosoftOnedriveAuthType]](../models/sourcemicrosoftonedriveauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/authenticateviamicrosoftoauth20.md b/docs/models/authenticateviamicrosoftoauth20.md similarity index 98% rename from docs/models/shared/authenticateviamicrosoftoauth20.md rename to docs/models/authenticateviamicrosoftoauth20.md index 7e4d4526..ccba3ac3 100644 --- a/docs/models/shared/authenticateviamicrosoftoauth20.md +++ b/docs/models/authenticateviamicrosoftoauth20.md @@ -9,4 +9,4 @@ | `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 | -| `auth_type` | [Optional[shared.SourceMicrosoftTeamsAuthType]](../../models/shared/sourcemicrosoftteamsauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `auth_type` | [Optional[models.SourceMicrosoftTeamsAuthType]](../models/sourcemicrosoftteamsauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/authenticateviaoauth.md b/docs/models/authenticateviaoauth.md new file mode 100644 index 00000000..13486394 --- /dev/null +++ b/docs/models/authenticateviaoauth.md @@ -0,0 +1,13 @@ +# AuthenticateViaOAuth + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `access_token` | *str* | :heavy_check_mark: | Access Token for making authenticated requests. | +| `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. | +| `auth_type` | [models.SourceSalesloftAuthType](../models/sourcesalesloftauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/authenticateviaoauth20.md b/docs/models/authenticateviaoauth20.md similarity index 100% rename from docs/models/shared/authenticateviaoauth20.md rename to docs/models/authenticateviaoauth20.md diff --git a/docs/models/shared/authenticateviaretentlyoauth.md b/docs/models/authenticateviaretentlyoauth.md similarity index 95% rename from docs/models/shared/authenticateviaretentlyoauth.md rename to docs/models/authenticateviaretentlyoauth.md index a0fc2813..4683fa8b 100644 --- a/docs/models/shared/authenticateviaretentlyoauth.md +++ b/docs/models/authenticateviaretentlyoauth.md @@ -9,4 +9,4 @@ | `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. | | `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 +| `auth_type` | [Optional[models.SourceRetentlyAuthType]](../models/sourceretentlyauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/authenticatewithapitoken.md b/docs/models/authenticatewithapitoken.md similarity index 95% rename from docs/models/shared/authenticatewithapitoken.md rename to docs/models/authenticatewithapitoken.md index 2ff33afc..63970c5a 100644 --- a/docs/models/shared/authenticatewithapitoken.md +++ b/docs/models/authenticatewithapitoken.md @@ -7,4 +7,4 @@ | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | `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 +| `auth_type` | [Optional[models.SourceRetentlySchemasAuthType]](../models/sourceretentlyschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/authenticatewithpersonalaccesstoken.md b/docs/models/authenticatewithpersonalaccesstoken.md new file mode 100644 index 00000000..a572357c --- /dev/null +++ b/docs/models/authenticatewithpersonalaccesstoken.md @@ -0,0 +1,9 @@ +# AuthenticateWithPersonalAccessToken + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `personal_access_token` | *str* | :heavy_check_mark: | Asana Personal Access Token (generate yours here). | +| `option_title` | [Optional[models.SourceAsanaSchemasCredentialsTitle]](../models/sourceasanaschemascredentialstitle.md) | :heavy_minus_sign: | PAT Credentials | \ No newline at end of file diff --git a/docs/models/shared/authentication.md b/docs/models/authentication.md similarity index 84% rename from docs/models/shared/authentication.md rename to docs/models/authentication.md index 560d76af..ce8f5d0e 100644 --- a/docs/models/shared/authentication.md +++ b/docs/models/authentication.md @@ -8,6 +8,6 @@ An HMAC key is a type of credential and can be associated with a service account ### HMACKey ```python -authentication: shared.HMACKey = /* values here */ +authentication: models.HMACKey = /* values here */ ``` diff --git a/docs/models/authenticationmechanism.md b/docs/models/authenticationmechanism.md new file mode 100644 index 00000000..fac33541 --- /dev/null +++ b/docs/models/authenticationmechanism.md @@ -0,0 +1,19 @@ +# AuthenticationMechanism + +Choose how to authenticate to Github + + +## Supported Types + +### AuthenticateViaAsanaOauth + +```python +authenticationMechanism: models.AuthenticateViaAsanaOauth = /* values here */ +``` + +### AuthenticateWithPersonalAccessToken + +```python +authenticationMechanism: models.AuthenticateWithPersonalAccessToken = /* values here */ +``` + diff --git a/docs/models/authenticationmethod.md b/docs/models/authenticationmethod.md new file mode 100644 index 00000000..02448ea8 --- /dev/null +++ b/docs/models/authenticationmethod.md @@ -0,0 +1,19 @@ +# AuthenticationMethod + +The type of authentication to be used + + +## Supported Types + +### APIKeySecret + +```python +authenticationMethod: models.APIKeySecret = /* values here */ +``` + +### UsernamePassword + +```python +authenticationMethod: models.UsernamePassword = /* values here */ +``` + diff --git a/docs/models/authenticationmode.md b/docs/models/authenticationmode.md new file mode 100644 index 00000000..e1a2a787 --- /dev/null +++ b/docs/models/authenticationmode.md @@ -0,0 +1,19 @@ +# AuthenticationMode + +Choose How to Authenticate to AWS. + + +## Supported Types + +### IAMRole + +```python +authenticationMode: models.IAMRole = /* values here */ +``` + +### IAMUser + +```python +authenticationMode: models.IAMUser = /* values here */ +``` + diff --git a/docs/models/authenticationtype.md b/docs/models/authenticationtype.md new file mode 100644 index 00000000..896bf28c --- /dev/null +++ b/docs/models/authenticationtype.md @@ -0,0 +1,17 @@ +# AuthenticationType + + +## Supported Types + +### SourceGoogleSearchConsoleOAuth + +```python +authenticationType: models.SourceGoogleSearchConsoleOAuth = /* values here */ +``` + +### SourceGoogleSearchConsoleServiceAccountKeyAuthentication + +```python +authenticationType: models.SourceGoogleSearchConsoleServiceAccountKeyAuthentication = /* values here */ +``` + diff --git a/docs/models/shared/authenticationviagoogleoauth.md b/docs/models/authenticationviagoogleoauth.md similarity index 100% rename from docs/models/shared/authenticationviagoogleoauth.md rename to docs/models/authenticationviagoogleoauth.md diff --git a/docs/models/authenticationwildcard.md b/docs/models/authenticationwildcard.md new file mode 100644 index 00000000..09b6e110 --- /dev/null +++ b/docs/models/authenticationwildcard.md @@ -0,0 +1,19 @@ +# AuthenticationWildcard + +Choose how to authenticate to Mixpanel + + +## Supported Types + +### ServiceAccount + +```python +authenticationWildcard: models.ServiceAccount = /* values here */ +``` + +### ProjectSecret + +```python +authenticationWildcard: models.ProjectSecret = /* values here */ +``` + diff --git a/docs/models/shared/authmethod.md b/docs/models/authmethod.md similarity index 100% rename from docs/models/shared/authmethod.md rename to docs/models/authmethod.md diff --git a/docs/models/shared/authorization.md b/docs/models/authorization.md similarity index 100% rename from docs/models/shared/authorization.md rename to docs/models/authorization.md diff --git a/docs/models/authorizationmethod.md b/docs/models/authorizationmethod.md new file mode 100644 index 00000000..d5105cdc --- /dev/null +++ b/docs/models/authorizationmethod.md @@ -0,0 +1,23 @@ +# AuthorizationMethod + + +## Supported Types + +### KeyPairAuthentication + +```python +authorizationMethod: models.KeyPairAuthentication = /* values here */ +``` + +### UsernameAndPassword + +```python +authorizationMethod: models.UsernameAndPassword = /* values here */ +``` + +### DestinationSnowflakeOAuth20 + +```python +authorizationMethod: models.DestinationSnowflakeOAuth20 = /* values here */ +``` + diff --git a/docs/models/authorizationtype.md b/docs/models/authorizationtype.md new file mode 100644 index 00000000..508bff82 --- /dev/null +++ b/docs/models/authorizationtype.md @@ -0,0 +1,19 @@ +# AuthorizationType + +Authorization type. + + +## Supported Types + +### NoneT + +```python +authorizationType: models.NoneT = /* values here */ +``` + +### LoginPassword + +```python +authorizationType: models.LoginPassword = /* values here */ +``` + diff --git a/docs/models/shared/authtype.md b/docs/models/authtype.md similarity index 100% rename from docs/models/shared/authtype.md rename to docs/models/authtype.md diff --git a/docs/models/autogenerated.md b/docs/models/autogenerated.md new file mode 100644 index 00000000..79fba66a --- /dev/null +++ b/docs/models/autogenerated.md @@ -0,0 +1,8 @@ +# Autogenerated + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `header_definition_type` | [Optional[models.SourceAzureBlobStorageHeaderDefinitionType]](../models/sourceazureblobstorageheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/avro.md b/docs/models/avro.md new file mode 100644 index 00000000..0b2b2104 --- /dev/null +++ b/docs/models/avro.md @@ -0,0 +1,10 @@ +# Avro + +This connector utilises fastavro for Avro parsing. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `filetype` | [Optional[models.SourceS3SchemasFiletype]](../models/sources3schemasfiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/avroapacheavro.md b/docs/models/avroapacheavro.md new file mode 100644 index 00000000..12821bd1 --- /dev/null +++ b/docs/models/avroapacheavro.md @@ -0,0 +1,9 @@ +# AvroApacheAvro + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| `compression_codec` | [Union[models.NoCompression, models.Deflate, models.Bzip2, models.Xz, models.Zstandard, models.Snappy]](../models/compressioncodec.md) | :heavy_check_mark: | The compression algorithm used to compress data. Default to no compression. | +| `format_type` | [Optional[models.DestinationGcsFormatType]](../models/destinationgcsformattype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/avroformat.md b/docs/models/avroformat.md similarity index 94% rename from docs/models/shared/avroformat.md rename to docs/models/avroformat.md index 579f8738..03d94531 100644 --- a/docs/models/shared/avroformat.md +++ b/docs/models/avroformat.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `double_as_string` | *Optional[bool]* | :heavy_minus_sign: | Whether to convert double fields to strings. This is recommended if you have decimal numbers with a high degree of precision because there can be a loss precision when handling floating point numbers. | -| `filetype` | [Optional[shared.SourceAzureBlobStorageSchemasStreamsFormatFormatFiletype]](../../models/shared/sourceazureblobstorageschemasstreamsformatformatfiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `filetype` | [Optional[models.SourceAzureBlobStorageSchemasStreamsFormatFormatFiletype]](../models/sourceazureblobstorageschemasstreamsformatformatfiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/awscloudtrail.md b/docs/models/awscloudtrail.md similarity index 100% rename from docs/models/shared/awscloudtrail.md rename to docs/models/awscloudtrail.md diff --git a/docs/models/shared/awsdatalake.md b/docs/models/awsdatalake.md similarity index 100% rename from docs/models/shared/awsdatalake.md rename to docs/models/awsdatalake.md diff --git a/docs/models/shared/awsenvironment.md b/docs/models/awsenvironment.md similarity index 100% rename from docs/models/shared/awsenvironment.md rename to docs/models/awsenvironment.md diff --git a/docs/models/shared/awsregion.md b/docs/models/awsregion.md similarity index 100% rename from docs/models/shared/awsregion.md rename to docs/models/awsregion.md diff --git a/docs/models/shared/awss3staging.md b/docs/models/awss3staging.md similarity index 89% rename from docs/models/shared/awss3staging.md rename to docs/models/awss3staging.md index 5c492055..ef605dc5 100644 --- a/docs/models/shared/awss3staging.md +++ b/docs/models/awss3staging.md @@ -10,10 +10,9 @@ | `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 | +| `encryption` | [Optional[Union[models.NoEncryption, models.AESCBCEnvelopeEncryption]]](../models/destinationredshiftencryption.md) | :heavy_minus_sign: | How to encrypt the staging data | | | `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 | | +| `method` | [models.DestinationRedshiftMethod](../models/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_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. | | \ No newline at end of file +| `s3_bucket_region` | [Optional[models.DestinationRedshiftS3BucketRegion]](../models/destinationredshifts3bucketregion.md) | :heavy_minus_sign: | The region of the S3 staging bucket. | | \ No newline at end of file diff --git a/docs/models/shared/awssellerpartneraccounttype.md b/docs/models/awssellerpartneraccounttype.md similarity index 100% rename from docs/models/shared/awssellerpartneraccounttype.md rename to docs/models/awssellerpartneraccounttype.md diff --git a/docs/models/shared/azblobazureblobstorage.md b/docs/models/azblobazureblobstorage.md similarity index 96% rename from docs/models/shared/azblobazureblobstorage.md rename to docs/models/azblobazureblobstorage.md index 5062c1af..2c54ad32 100644 --- a/docs/models/shared/azblobazureblobstorage.md +++ b/docs/models/azblobazureblobstorage.md @@ -8,4 +8,4 @@ | `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 | \ No newline at end of file +| `storage` | [models.SourceFileSchemasProviderStorage](../models/sourcefileschemasproviderstorage.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/azureblobstorage.md b/docs/models/azureblobstorage.md similarity index 100% rename from docs/models/shared/azureblobstorage.md rename to docs/models/azureblobstorage.md diff --git a/docs/models/shared/azureopenai.md b/docs/models/azureopenai.md similarity index 96% rename from docs/models/shared/azureopenai.md rename to docs/models/azureopenai.md index 5db69d58..6e384841 100644 --- a/docs/models/shared/azureopenai.md +++ b/docs/models/azureopenai.md @@ -10,4 +10,4 @@ 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 | | `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.DestinationAstraSchemasEmbeddingMode]](../../models/shared/destinationastraschemasembeddingmode.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `mode` | [Optional[models.DestinationAstraSchemasEmbeddingMode]](../models/destinationastraschemasembeddingmode.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/azuretable.md b/docs/models/azuretable.md similarity index 100% rename from docs/models/shared/azuretable.md rename to docs/models/azuretable.md diff --git a/docs/models/shared/bamboohr.md b/docs/models/bamboohr.md similarity index 100% rename from docs/models/shared/bamboohr.md rename to docs/models/bamboohr.md diff --git a/docs/models/baseurl.md b/docs/models/baseurl.md new file mode 100644 index 00000000..210ae994 --- /dev/null +++ b/docs/models/baseurl.md @@ -0,0 +1,19 @@ +# BaseURL + +Is your account location is EU based? If yes, the base url to retrieve data will be different. + + +## Supported Types + +### EUBasedAccount + +```python +baseURL: models.EUBasedAccount = /* values here */ +``` + +### GlobalAccount + +```python +baseURL: models.GlobalAccount = /* values here */ +``` + diff --git a/docs/models/betweenfilter.md b/docs/models/betweenfilter.md new file mode 100644 index 00000000..09712afd --- /dev/null +++ b/docs/models/betweenfilter.md @@ -0,0 +1,10 @@ +# BetweenFilter + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `from_value` | [Union[models.SourceGoogleAnalyticsDataAPIInt64Value, models.SourceGoogleAnalyticsDataAPIDoubleValue]](../models/fromvalue.md) | :heavy_check_mark: | N/A | +| `to_value` | [Union[models.SourceGoogleAnalyticsDataAPISchemasInt64Value, models.SourceGoogleAnalyticsDataAPISchemasDoubleValue]](../models/tovalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayFilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarrayfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/bigquery.md b/docs/models/bigquery.md similarity index 100% rename from docs/models/shared/bigquery.md rename to docs/models/bigquery.md diff --git a/docs/models/shared/bingads.md b/docs/models/bingads.md similarity index 100% rename from docs/models/shared/bingads.md rename to docs/models/bingads.md diff --git a/docs/models/shared/bothusernameandpasswordisrequiredforauthenticationrequest.md b/docs/models/bothusernameandpasswordisrequiredforauthenticationrequest.md similarity index 100% rename from docs/models/shared/bothusernameandpasswordisrequiredforauthenticationrequest.md rename to docs/models/bothusernameandpasswordisrequiredforauthenticationrequest.md diff --git a/docs/models/shared/braintree.md b/docs/models/braintree.md similarity index 100% rename from docs/models/shared/braintree.md rename to docs/models/braintree.md diff --git a/docs/models/shared/braze.md b/docs/models/braze.md similarity index 100% rename from docs/models/shared/braze.md rename to docs/models/braze.md diff --git a/docs/models/bymarkdownheader.md b/docs/models/bymarkdownheader.md new file mode 100644 index 00000000..33d6341d --- /dev/null +++ b/docs/models/bymarkdownheader.md @@ -0,0 +1,11 @@ +# ByMarkdownHeader + +Split the text by Markdown headers down to the specified header level. If the chunk size fits multiple sections, they will be combined into a single chunk. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `mode` | [Optional[models.DestinationAstraSchemasProcessingTextSplitterMode]](../models/destinationastraschemasprocessingtextsplittermode.md) | :heavy_minus_sign: | N/A | +| `split_level` | *Optional[int]* | :heavy_minus_sign: | Level of markdown headers to split text fields by. Headings down to the specified level will be used as split points | \ No newline at end of file diff --git a/docs/models/byprogramminglanguage.md b/docs/models/byprogramminglanguage.md new file mode 100644 index 00000000..ec4af881 --- /dev/null +++ b/docs/models/byprogramminglanguage.md @@ -0,0 +1,11 @@ +# ByProgrammingLanguage + +Split the text by suitable delimiters based on the programming language. This is useful for splitting code into chunks. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `language` | [models.DestinationAstraLanguage](../models/destinationastralanguage.md) | :heavy_check_mark: | Split code in suitable places based on the programming language | +| `mode` | [Optional[models.DestinationAstraSchemasProcessingTextSplitterTextSplitterMode]](../models/destinationastraschemasprocessingtextsplittertextsplittermode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/byseparator.md b/docs/models/byseparator.md similarity index 96% rename from docs/models/shared/byseparator.md rename to docs/models/byseparator.md index 318b8b50..13a53489 100644 --- a/docs/models/shared/byseparator.md +++ b/docs/models/byseparator.md @@ -8,5 +8,5 @@ Split the text by the list of separators until the chunk size is reached, using | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `keep_separator` | *Optional[bool]* | :heavy_minus_sign: | Whether to keep the separator in the resulting chunks | -| `mode` | [Optional[shared.DestinationAstraSchemasProcessingMode]](../../models/shared/destinationastraschemasprocessingmode.md) | :heavy_minus_sign: | N/A | +| `mode` | [Optional[models.DestinationAstraSchemasProcessingMode]](../models/destinationastraschemasprocessingmode.md) | :heavy_minus_sign: | N/A | | `separators` | List[*str*] | :heavy_minus_sign: | List of separator strings to split text fields by. The separator itself needs to be wrapped in double quotes, e.g. to split by the dot character, use ".". To split by a newline, use "\n". | \ No newline at end of file diff --git a/docs/models/bzip2.md b/docs/models/bzip2.md new file mode 100644 index 00000000..6e73cf33 --- /dev/null +++ b/docs/models/bzip2.md @@ -0,0 +1,8 @@ +# Bzip2 + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `codec` | [Optional[models.DestinationGcsSchemasCodec]](../models/destinationgcsschemascodec.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/cachetype.md b/docs/models/cachetype.md similarity index 100% rename from docs/models/shared/cachetype.md rename to docs/models/cachetype.md diff --git a/docs/models/shared/cart.md b/docs/models/cart.md similarity index 100% rename from docs/models/shared/cart.md rename to docs/models/cart.md diff --git a/docs/models/shared/categories.md b/docs/models/categories.md similarity index 100% rename from docs/models/shared/categories.md rename to docs/models/categories.md diff --git a/docs/models/shared/centralapirouter.md b/docs/models/centralapirouter.md similarity index 96% rename from docs/models/shared/centralapirouter.md rename to docs/models/centralapirouter.md index 8c6b2bd8..18ca4165 100644 --- a/docs/models/shared/centralapirouter.md +++ b/docs/models/centralapirouter.md @@ -8,4 +8,4 @@ | `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 | -| `auth_type` | [shared.SourceCartAuthType](../../models/shared/sourcecartauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `auth_type` | [models.SourceCartAuthType](../models/sourcecartauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/chargebee.md b/docs/models/chargebee.md similarity index 100% rename from docs/models/shared/chargebee.md rename to docs/models/chargebee.md diff --git a/docs/models/shared/chartmogul.md b/docs/models/chartmogul.md similarity index 100% rename from docs/models/shared/chartmogul.md rename to docs/models/chartmogul.md diff --git a/docs/models/shared/choosehowtopartitiondata.md b/docs/models/choosehowtopartitiondata.md similarity index 100% rename from docs/models/shared/choosehowtopartitiondata.md rename to docs/models/choosehowtopartitiondata.md diff --git a/docs/models/chromalocalpersistance.md b/docs/models/chromalocalpersistance.md new file mode 100644 index 00000000..a3192f26 --- /dev/null +++ b/docs/models/chromalocalpersistance.md @@ -0,0 +1,12 @@ +# ChromaLocalPersistance + +Chroma is a popular vector store that can be used to store and retrieve embeddings. It will build its index in memory and persist it to disk by the end of the sync. + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `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[models.DestinationLangchainSchemasIndexingIndexing3Mode]](../models/destinationlangchainschemasindexingindexing3mode.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/clickhouse.md b/docs/models/clickhouse.md similarity index 100% rename from docs/models/shared/clickhouse.md rename to docs/models/clickhouse.md diff --git a/docs/models/shared/clickupapi.md b/docs/models/clickupapi.md similarity index 100% rename from docs/models/shared/clickupapi.md rename to docs/models/clickupapi.md diff --git a/docs/models/shared/clickwindowdays.md b/docs/models/clickwindowdays.md similarity index 100% rename from docs/models/shared/clickwindowdays.md rename to docs/models/clickwindowdays.md diff --git a/docs/models/shared/clockify.md b/docs/models/clockify.md similarity index 100% rename from docs/models/shared/clockify.md rename to docs/models/clockify.md diff --git a/docs/models/shared/closecom.md b/docs/models/closecom.md similarity index 100% rename from docs/models/shared/closecom.md rename to docs/models/closecom.md diff --git a/docs/models/clustertype.md b/docs/models/clustertype.md new file mode 100644 index 00000000..bce578b2 --- /dev/null +++ b/docs/models/clustertype.md @@ -0,0 +1,19 @@ +# ClusterType + +Configures the MongoDB cluster type. + + +## Supported Types + +### MongoDBAtlasReplicaSet + +```python +clusterType: models.MongoDBAtlasReplicaSet = /* values here */ +``` + +### SelfManagedReplicaSet + +```python +clusterType: models.SelfManagedReplicaSet = /* values here */ +``` + diff --git a/docs/models/shared/coda.md b/docs/models/coda.md similarity index 100% rename from docs/models/shared/coda.md rename to docs/models/coda.md diff --git a/docs/models/shared/codec.md b/docs/models/codec.md similarity index 100% rename from docs/models/shared/codec.md rename to docs/models/codec.md diff --git a/docs/models/cohere.md b/docs/models/cohere.md new file mode 100644 index 00000000..d38e947a --- /dev/null +++ b/docs/models/cohere.md @@ -0,0 +1,11 @@ +# Cohere + +Use the Cohere API to embed text. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `cohere_key` | *str* | :heavy_check_mark: | N/A | +| `mode` | [Optional[models.DestinationAstraMode]](../models/destinationastramode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/cohortreports.md b/docs/models/cohortreports.md new file mode 100644 index 00000000..a138ce3b --- /dev/null +++ b/docs/models/cohortreports.md @@ -0,0 +1,19 @@ +# CohortReports + +Cohort reports creates a time series of user retention for the cohort. + + +## Supported Types + +### SourceGoogleAnalyticsDataAPIDisabled + +```python +cohortReports: models.SourceGoogleAnalyticsDataAPIDisabled = /* values here */ +``` + +### SourceGoogleAnalyticsDataAPISchemasEnabled + +```python +cohortReports: models.SourceGoogleAnalyticsDataAPISchemasEnabled = /* values here */ +``` + diff --git a/docs/models/shared/cohortreportsettings.md b/docs/models/cohortreportsettings.md similarity index 100% rename from docs/models/shared/cohortreportsettings.md rename to docs/models/cohortreportsettings.md diff --git a/docs/models/shared/cohorts.md b/docs/models/cohorts.md similarity index 88% rename from docs/models/shared/cohorts.md rename to docs/models/cohorts.md index 8ab162f6..cb3aa9d9 100644 --- a/docs/models/shared/cohorts.md +++ b/docs/models/cohorts.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| `date_range` | [shared.DateRange](../../models/shared/daterange.md) | :heavy_check_mark: | N/A | -| `dimension` | [shared.Dimension](../../models/shared/dimension.md) | :heavy_check_mark: | Dimension used by the cohort. Required and only supports `firstSessionDate` | +| `date_range` | [models.DateRange](../models/daterange.md) | :heavy_check_mark: | N/A | +| `dimension` | [models.Dimension](../models/dimension.md) | :heavy_check_mark: | Dimension used by the cohort. Required and only supports `firstSessionDate` | | `name` | *Optional[str]* | :heavy_minus_sign: | Assigns a name to this cohort. If not set, cohorts are named by their zero based index cohort_0, cohort_1, etc. | \ No newline at end of file diff --git a/docs/models/shared/cohortsrange.md b/docs/models/cohortsrange.md similarity index 94% rename from docs/models/shared/cohortsrange.md rename to docs/models/cohortsrange.md index 5d868fae..40826c0e 100644 --- a/docs/models/shared/cohortsrange.md +++ b/docs/models/cohortsrange.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `end_offset` | *int* | :heavy_check_mark: | Specifies the end date of the extended reporting date range for a cohort report. | -| `granularity` | [shared.SourceGoogleAnalyticsDataAPIGranularity](../../models/shared/sourcegoogleanalyticsdataapigranularity.md) | :heavy_check_mark: | The granularity used to interpret the startOffset and endOffset for the extended reporting date range for a cohort report. | +| `granularity` | [models.SourceGoogleAnalyticsDataAPIGranularity](../models/sourcegoogleanalyticsdataapigranularity.md) | :heavy_check_mark: | The granularity used to interpret the startOffset and endOffset for the extended reporting date range for a cohort report. | | `start_offset` | *Optional[int]* | :heavy_minus_sign: | Specifies the start date of the extended reporting date range for a cohort report. | \ No newline at end of file diff --git a/docs/models/shared/coinapi.md b/docs/models/coinapi.md similarity index 100% rename from docs/models/shared/coinapi.md rename to docs/models/coinapi.md diff --git a/docs/models/shared/coinmarketcap.md b/docs/models/coinmarketcap.md similarity index 100% rename from docs/models/shared/coinmarketcap.md rename to docs/models/coinmarketcap.md diff --git a/docs/models/shared/collection.md b/docs/models/collection.md similarity index 96% rename from docs/models/shared/collection.md rename to docs/models/collection.md index 456c1e1b..88ef02e2 100644 --- a/docs/models/shared/collection.md +++ b/docs/models/collection.md @@ -7,5 +7,5 @@ Settings for the Fauna Collection. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `deletions` | [Union[shared.Disabled, shared.Enabled]](../../models/shared/deletionmode.md) | :heavy_check_mark: | This only applies to incremental syncs.

    Enabling deletion mode informs your destination of deleted documents.

    Disabled - Leave this feature disabled, and ignore deleted documents.

    Enabled - Enables this feature. When a document is deleted, the connector exports a record with a "deleted at" column containing the time that the document was deleted. | +| `deletions` | [Union[models.Disabled, models.Enabled]](../models/deletionmode.md) | :heavy_check_mark: | This only applies to incremental syncs.

    Enabling deletion mode informs your destination of deleted documents.

    Disabled - Leave this feature disabled, and ignore deleted documents.

    Enabled - Enables this feature. When a document is deleted, the connector exports a record with a "deleted at" column containing the time that the document was deleted. | | `page_size` | *Optional[int]* | :heavy_minus_sign: | The page size used when reading documents from the database. The larger the page size, the faster the connector processes documents. However, if a page is too large, the connector may fail.

    Choose your page size based on how large the documents are.

    See the docs. | \ No newline at end of file diff --git a/docs/models/compression.md b/docs/models/compression.md new file mode 100644 index 00000000..1fb21970 --- /dev/null +++ b/docs/models/compression.md @@ -0,0 +1,19 @@ +# Compression + +Whether the output files should be compressed. If compression is selected, the output filename will have an extra extension (GZIP: ".csv.gz"). + + +## Supported Types + +### DestinationGcsNoCompression + +```python +compression: models.DestinationGcsNoCompression = /* values here */ +``` + +### Gzip + +```python +compression: models.Gzip = /* values here */ +``` + diff --git a/docs/models/compressioncodec.md b/docs/models/compressioncodec.md new file mode 100644 index 00000000..a1fd1ace --- /dev/null +++ b/docs/models/compressioncodec.md @@ -0,0 +1,43 @@ +# CompressionCodec + +The compression algorithm used to compress data. Default to no compression. + + +## Supported Types + +### NoCompression + +```python +compressionCodec: models.NoCompression = /* values here */ +``` + +### Deflate + +```python +compressionCodec: models.Deflate = /* values here */ +``` + +### Bzip2 + +```python +compressionCodec: models.Bzip2 = /* values here */ +``` + +### Xz + +```python +compressionCodec: models.Xz = /* values here */ +``` + +### Zstandard + +```python +compressionCodec: models.Zstandard = /* values here */ +``` + +### Snappy + +```python +compressionCodec: models.Snappy = /* values here */ +``` + diff --git a/docs/models/shared/compressioncodecoptional.md b/docs/models/compressioncodecoptional.md similarity index 100% rename from docs/models/shared/compressioncodecoptional.md rename to docs/models/compressioncodecoptional.md diff --git a/docs/models/shared/compressiontype.md b/docs/models/compressiontype.md similarity index 100% rename from docs/models/shared/compressiontype.md rename to docs/models/compressiontype.md diff --git a/docs/models/shared/configcat.md b/docs/models/configcat.md similarity index 100% rename from docs/models/shared/configcat.md rename to docs/models/configcat.md diff --git a/docs/models/shared/confluence.md b/docs/models/confluence.md similarity index 100% rename from docs/models/shared/confluence.md rename to docs/models/confluence.md diff --git a/docs/models/connectby.md b/docs/models/connectby.md new file mode 100644 index 00000000..6af5d914 --- /dev/null +++ b/docs/models/connectby.md @@ -0,0 +1,19 @@ +# ConnectBy + +Connect data that will be used for DB connection + + +## Supported Types + +### ServiceName + +```python +connectBy: models.ServiceName = /* values here */ +``` + +### SystemIDSID + +```python +connectBy: models.SystemIDSID = /* values here */ +``` + diff --git a/docs/models/shared/connectioncreaterequest.md b/docs/models/connectioncreaterequest.md similarity index 93% rename from docs/models/shared/connectioncreaterequest.md rename to docs/models/connectioncreaterequest.md index 9d96300e..204ca9a6 100644 --- a/docs/models/shared/connectioncreaterequest.md +++ b/docs/models/connectioncreaterequest.md @@ -7,12 +7,12 @@ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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 | | +| `configurations` | [Optional[models.StreamConfigurations]](../models/streamconfigurations.md) | :heavy_minus_sign: | A list of configured stream options for a connection. | | +| `data_residency` | [Optional[models.GeographyEnum]](../models/geographyenum.md) | :heavy_minus_sign: | 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_definition` | [Optional[models.NamespaceDefinitionEnum]](../models/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 | | +| `non_breaking_schema_updates_behavior` | [Optional[models.NonBreakingSchemaUpdatesBehaviorEnum]](../models/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 | | -| `status` | [Optional[shared.ConnectionStatusEnum]](../../models/shared/connectionstatusenum.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `schedule` | [Optional[models.ConnectionSchedule]](../models/connectionschedule.md) | :heavy_minus_sign: | schedule for when the the connection should run, per the schedule type | | +| `status` | [Optional[models.ConnectionStatusEnum]](../models/connectionstatusenum.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/connectionpatchrequest.md b/docs/models/connectionpatchrequest.md similarity index 92% rename from docs/models/shared/connectionpatchrequest.md rename to docs/models/connectionpatchrequest.md index 99a301a4..d7c71dd5 100644 --- a/docs/models/shared/connectionpatchrequest.md +++ b/docs/models/connectionpatchrequest.md @@ -5,12 +5,12 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `configurations` | [Optional[shared.StreamConfigurations]](../../models/shared/streamconfigurations.md) | :heavy_minus_sign: | A list of configured stream options for a connection. | | -| `data_residency` | [Optional[shared.GeographyEnumNoDefault]](../../models/shared/geographyenumnodefault.md) | :heavy_minus_sign: | N/A | | +| `configurations` | [Optional[models.StreamConfigurations]](../models/streamconfigurations.md) | :heavy_minus_sign: | A list of configured stream options for a connection. | | +| `data_residency` | [Optional[models.GeographyEnumNoDefault]](../models/geographyenumnodefault.md) | :heavy_minus_sign: | N/A | | | `name` | *Optional[str]* | :heavy_minus_sign: | Optional name of the connection | | -| `namespace_definition` | [Optional[shared.NamespaceDefinitionEnumNoDefault]](../../models/shared/namespacedefinitionenumnodefault.md) | :heavy_minus_sign: | Define the location where the data will be stored in the destination | | +| `namespace_definition` | [Optional[models.NamespaceDefinitionEnumNoDefault]](../models/namespacedefinitionenumnodefault.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.NonBreakingSchemaUpdatesBehaviorEnumNoDefault]](../../models/shared/nonbreakingschemaupdatesbehaviorenumnodefault.md) | :heavy_minus_sign: | Set how Airbyte handles syncs when it detects a non-breaking schema change in the source | | +| `non_breaking_schema_updates_behavior` | [Optional[models.NonBreakingSchemaUpdatesBehaviorEnumNoDefault]](../models/nonbreakingschemaupdatesbehaviorenumnodefault.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 | | -| `status` | [Optional[shared.ConnectionStatusEnum]](../../models/shared/connectionstatusenum.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `schedule` | [Optional[models.ConnectionSchedule]](../models/connectionschedule.md) | :heavy_minus_sign: | schedule for when the the connection should run, per the schedule type | | +| `status` | [Optional[models.ConnectionStatusEnum]](../models/connectionstatusenum.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/connectionresponse.md b/docs/models/connectionresponse.md new file mode 100644 index 00000000..e70fb876 --- /dev/null +++ b/docs/models/connectionresponse.md @@ -0,0 +1,22 @@ +# ConnectionResponse + +Provides details of a single connection. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `configurations` | [models.StreamConfigurations](../models/streamconfigurations.md) | :heavy_check_mark: | A list of configured stream options for a connection. | +| `connection_id` | *str* | :heavy_check_mark: | N/A | +| `destination_id` | *str* | :heavy_check_mark: | N/A | +| `name` | *str* | :heavy_check_mark: | N/A | +| `schedule` | [models.ConnectionScheduleResponse](../models/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` | [models.ConnectionStatusEnum](../models/connectionstatusenum.md) | :heavy_check_mark: | N/A | +| `workspace_id` | *str* | :heavy_check_mark: | N/A | +| `data_residency` | [Optional[models.GeographyEnum]](../models/geographyenum.md) | :heavy_minus_sign: | N/A | +| `namespace_definition` | [Optional[models.NamespaceDefinitionEnum]](../models/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[models.NonBreakingSchemaUpdatesBehaviorEnum]](../models/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/connectionschedule.md b/docs/models/connectionschedule.md new file mode 100644 index 00000000..7b80562c --- /dev/null +++ b/docs/models/connectionschedule.md @@ -0,0 +1,11 @@ +# ConnectionSchedule + +schedule for when the the connection should run, per the schedule type + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | +| `schedule_type` | [models.ScheduleTypeEnum](../models/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/connectionscheduleresponse.md b/docs/models/connectionscheduleresponse.md new file mode 100644 index 00000000..83826ea1 --- /dev/null +++ b/docs/models/connectionscheduleresponse.md @@ -0,0 +1,12 @@ +# ConnectionScheduleResponse + +schedule for when the the connection should run, per the schedule type + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `schedule_type` | [models.ScheduleTypeWithBasicEnum](../models/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 | \ No newline at end of file diff --git a/docs/models/connectionsresponse.md b/docs/models/connectionsresponse.md new file mode 100644 index 00000000..64e55c65 --- /dev/null +++ b/docs/models/connectionsresponse.md @@ -0,0 +1,10 @@ +# ConnectionsResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `data` | List[[models.ConnectionResponse](../models/connectionresponse.md)] | :heavy_check_mark: | N/A | +| `next` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `previous` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/connectionstatusenum.md b/docs/models/connectionstatusenum.md similarity index 100% rename from docs/models/shared/connectionstatusenum.md rename to docs/models/connectionstatusenum.md diff --git a/docs/models/shared/connectionsyncmodeenum.md b/docs/models/connectionsyncmodeenum.md similarity index 100% rename from docs/models/shared/connectionsyncmodeenum.md rename to docs/models/connectionsyncmodeenum.md diff --git a/docs/models/shared/connectiontype.md b/docs/models/connectiontype.md similarity index 100% rename from docs/models/shared/connectiontype.md rename to docs/models/connectiontype.md diff --git a/docs/models/shared/contenttype.md b/docs/models/contenttype.md similarity index 100% rename from docs/models/shared/contenttype.md rename to docs/models/contenttype.md diff --git a/docs/models/shared/continuousfeed.md b/docs/models/continuousfeed.md similarity index 91% rename from docs/models/shared/continuousfeed.md rename to docs/models/continuousfeed.md index e4c1aa35..8467f7e6 100644 --- a/docs/models/shared/continuousfeed.md +++ b/docs/models/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 | | +| `mock_catalog` | [Union[models.SingleSchema, models.MultiSchema]](../models/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). | | | `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 +| `source_type` | [Optional[models.E2eTestCloud]](../models/e2etestcloud.md) | :heavy_minus_sign: | N/A | | +| `type` | [Optional[models.Type]](../models/type.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/conversionreporttime.md b/docs/models/conversionreporttime.md similarity index 100% rename from docs/models/shared/conversionreporttime.md rename to docs/models/conversionreporttime.md diff --git a/docs/models/shared/convex.md b/docs/models/convex.md similarity index 100% rename from docs/models/shared/convex.md rename to docs/models/convex.md diff --git a/docs/models/shared/country.md b/docs/models/country.md similarity index 100% rename from docs/models/shared/country.md rename to docs/models/country.md diff --git a/docs/models/shared/credential.md b/docs/models/credential.md similarity index 82% rename from docs/models/shared/credential.md rename to docs/models/credential.md index c5c9cc6a..a2af0ddf 100644 --- a/docs/models/shared/credential.md +++ b/docs/models/credential.md @@ -8,6 +8,6 @@ An HMAC key is a type of credential and can be associated with a service account ### DestinationBigqueryHMACKey ```python -credential: shared.DestinationBigqueryHMACKey = /* values here */ +credential: models.DestinationBigqueryHMACKey = /* values here */ ``` diff --git a/docs/models/shared/credentials.md b/docs/models/credentials.md similarity index 100% rename from docs/models/shared/credentials.md rename to docs/models/credentials.md diff --git a/docs/models/shared/credentialstitle.md b/docs/models/credentialstitle.md similarity index 100% rename from docs/models/shared/credentialstitle.md rename to docs/models/credentialstitle.md diff --git a/docs/models/shared/credentialtype.md b/docs/models/credentialtype.md similarity index 100% rename from docs/models/shared/credentialtype.md rename to docs/models/credentialtype.md diff --git a/docs/models/shared/csv.md b/docs/models/csv.md similarity index 99% rename from docs/models/shared/csv.md rename to docs/models/csv.md index 4dda3998..38fa25fd 100644 --- a/docs/models/shared/csv.md +++ b/docs/models/csv.md @@ -14,7 +14,7 @@ This connector utilises list of python encodings for allowable options. | | | `escape_char` | *Optional[str]* | :heavy_minus_sign: | The character used for escaping special characters. To disallow escaping, leave this field blank. | | -| `filetype` | [Optional[shared.SourceS3SchemasFormatFileFormatFiletype]](../../models/shared/sources3schemasformatfileformatfiletype.md) | :heavy_minus_sign: | N/A | | +| `filetype` | [Optional[models.SourceS3SchemasFormatFileFormatFiletype]](../models/sources3schemasformatfileformatfiletype.md) | :heavy_minus_sign: | N/A | | | `infer_datatypes` | *Optional[bool]* | :heavy_minus_sign: | Configures whether a schema for the source should be inferred from the current data or not. If set to false and a custom schema is set, then the manually enforced schema is used. If a schema is not manually set, and this is set to false, then all fields will be read as strings | | | `newlines_in_values` | *Optional[bool]* | :heavy_minus_sign: | Whether newline characters are allowed in CSV values. Turning this on may affect performance. Leave blank to default to False. | | | `quote_char` | *Optional[str]* | :heavy_minus_sign: | The character used for quoting CSV values. To disallow quoting, make this field blank. | | \ No newline at end of file diff --git a/docs/models/shared/csvcommaseparatedvalues.md b/docs/models/csvcommaseparatedvalues.md similarity index 86% rename from docs/models/shared/csvcommaseparatedvalues.md rename to docs/models/csvcommaseparatedvalues.md index 5ab081b9..4e6b2d80 100644 --- a/docs/models/shared/csvcommaseparatedvalues.md +++ b/docs/models/csvcommaseparatedvalues.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `flattening` | [Optional[shared.NormalizationFlattening]](../../models/shared/normalizationflattening.md) | :heavy_minus_sign: | Whether the input json data should be normalized (flattened) in the output CSV. Please refer to docs for details. | -| `format_type` | [shared.FormatType](../../models/shared/formattype.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `flattening` | [Optional[models.NormalizationFlattening]](../models/normalizationflattening.md) | :heavy_minus_sign: | Whether the input json data should be normalized (flattened) in the output CSV. Please refer to docs for details. | +| `format_type` | [models.FormatType](../models/formattype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/csvformat.md b/docs/models/csvformat.md similarity index 92% rename from docs/models/shared/csvformat.md rename to docs/models/csvformat.md index d3da5e47..fa37d21a 100644 --- a/docs/models/shared/csvformat.md +++ b/docs/models/csvformat.md @@ -10,9 +10,10 @@ | `encoding` | *Optional[str]* | :heavy_minus_sign: | The character encoding of the CSV data. Leave blank to default to UTF8. See list of python encodings for allowable options. | | `escape_char` | *Optional[str]* | :heavy_minus_sign: | The character used for escaping special characters. To disallow escaping, leave this field blank. | | `false_values` | List[*str*] | :heavy_minus_sign: | A set of case-sensitive strings that should be interpreted as false values. | -| `filetype` | [Optional[shared.SourceAzureBlobStorageFiletype]](../../models/shared/sourceazureblobstoragefiletype.md) | :heavy_minus_sign: | N/A | -| `header_definition` | [Optional[Union[shared.FromCSV, shared.Autogenerated, shared.UserProvided]]](../../models/shared/csvheaderdefinition.md) | :heavy_minus_sign: | How headers will be defined. `User Provided` assumes the CSV does not have a header row and uses the headers provided and `Autogenerated` assumes the CSV does not have a header row and the CDK will generate headers using for `f{i}` where `i` is the index starting from 0. Else, the default behavior is to use the header from the CSV file. If a user wants to autogenerate or provide column names for a CSV having headers, they can skip rows. | -| `inference_type` | [Optional[shared.InferenceType]](../../models/shared/inferencetype.md) | :heavy_minus_sign: | How to infer the types of the columns. If none, inference default to strings. | +| `filetype` | [Optional[models.SourceAzureBlobStorageFiletype]](../models/sourceazureblobstoragefiletype.md) | :heavy_minus_sign: | N/A | +| `header_definition` | [Optional[Union[models.FromCSV, models.Autogenerated, models.UserProvided]]](../models/csvheaderdefinition.md) | :heavy_minus_sign: | How headers will be defined. `User Provided` assumes the CSV does not have a header row and uses the headers provided and `Autogenerated` assumes the CSV does not have a header row and the CDK will generate headers using for `f{i}` where `i` is the index starting from 0. Else, the default behavior is to use the header from the CSV file. If a user wants to autogenerate or provide column names for a CSV having headers, they can skip rows. | +| `ignore_errors_on_fields_mismatch` | *Optional[bool]* | :heavy_minus_sign: | Whether to ignore errors that occur when the number of fields in the CSV does not match the number of columns in the schema. | +| `inference_type` | [Optional[models.InferenceType]](../models/inferencetype.md) | :heavy_minus_sign: | How to infer the types of the columns. If none, inference default to strings. | | `null_values` | List[*str*] | :heavy_minus_sign: | A set of case-sensitive strings that should be interpreted as null values. For example, if the value 'NA' should be interpreted as null, enter 'NA' in this field. | | `quote_char` | *Optional[str]* | :heavy_minus_sign: | The character used for quoting CSV values. To disallow quoting, make this field blank. | | `skip_rows_after_header` | *Optional[int]* | :heavy_minus_sign: | The number of rows to skip after the header row. | diff --git a/docs/models/shared/csvheaderdefinition.md b/docs/models/csvheaderdefinition.md similarity index 76% rename from docs/models/shared/csvheaderdefinition.md rename to docs/models/csvheaderdefinition.md index a1df9bd9..4718cee3 100644 --- a/docs/models/shared/csvheaderdefinition.md +++ b/docs/models/csvheaderdefinition.md @@ -8,18 +8,18 @@ How headers will be defined. `User Provided` assumes the CSV does not have a hea ### FromCSV ```python -csvHeaderDefinition: shared.FromCSV = /* values here */ +csvHeaderDefinition: models.FromCSV = /* values here */ ``` ### Autogenerated ```python -csvHeaderDefinition: shared.Autogenerated = /* values here */ +csvHeaderDefinition: models.Autogenerated = /* values here */ ``` ### UserProvided ```python -csvHeaderDefinition: shared.UserProvided = /* values here */ +csvHeaderDefinition: models.UserProvided = /* values here */ ``` diff --git a/docs/models/shared/customerstatus.md b/docs/models/customerstatus.md similarity index 100% rename from docs/models/shared/customerstatus.md rename to docs/models/customerstatus.md diff --git a/docs/models/shared/customqueriesarray.md b/docs/models/customqueriesarray.md similarity index 100% rename from docs/models/shared/customqueriesarray.md rename to docs/models/customqueriesarray.md diff --git a/docs/models/shared/customreportconfig.md b/docs/models/customreportconfig.md similarity index 97% rename from docs/models/shared/customreportconfig.md rename to docs/models/customreportconfig.md index 6a251d81..c5cb309f 100644 --- a/docs/models/shared/customreportconfig.md +++ b/docs/models/customreportconfig.md @@ -7,5 +7,5 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `name` | *str* | :heavy_check_mark: | The name of the custom report, this name would be used as stream name | Account Performance | | `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. | | +| `reporting_object` | [models.ReportingDataObject](../models/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/databricks.md b/docs/models/databricks.md similarity index 100% rename from docs/models/shared/databricks.md rename to docs/models/databricks.md diff --git a/docs/models/shared/datacenterlocation.md b/docs/models/datacenterlocation.md similarity index 100% rename from docs/models/shared/datacenterlocation.md rename to docs/models/datacenterlocation.md diff --git a/docs/models/shared/datafreshness.md b/docs/models/datafreshness.md similarity index 100% rename from docs/models/shared/datafreshness.md rename to docs/models/datafreshness.md diff --git a/docs/models/shared/dataregion.md b/docs/models/dataregion.md similarity index 100% rename from docs/models/shared/dataregion.md rename to docs/models/dataregion.md diff --git a/docs/models/shared/datascope.md b/docs/models/datascope.md similarity index 100% rename from docs/models/shared/datascope.md rename to docs/models/datascope.md diff --git a/docs/models/shared/datasetlocation.md b/docs/models/datasetlocation.md similarity index 100% rename from docs/models/shared/datasetlocation.md rename to docs/models/datasetlocation.md diff --git a/docs/models/datasource.md b/docs/models/datasource.md new file mode 100644 index 00000000..8b339e39 --- /dev/null +++ b/docs/models/datasource.md @@ -0,0 +1,25 @@ +# DataSource + +Storage on which the delta lake is built. + + +## Supported Types + +### RecommendedManagedTables + +```python +dataSource: models.RecommendedManagedTables = /* values here */ +``` + +### AmazonS3 + +```python +dataSource: models.AmazonS3 = /* values here */ +``` + +### DestinationDatabricksAzureBlobStorage + +```python +dataSource: models.DestinationDatabricksAzureBlobStorage = /* values here */ +``` + diff --git a/docs/models/shared/datasourcetype.md b/docs/models/datasourcetype.md similarity index 100% rename from docs/models/shared/datasourcetype.md rename to docs/models/datasourcetype.md diff --git a/docs/models/shared/datatype.md b/docs/models/datatype.md similarity index 100% rename from docs/models/shared/datatype.md rename to docs/models/datatype.md diff --git a/docs/models/shared/daterange.md b/docs/models/daterange.md similarity index 100% rename from docs/models/shared/daterange.md rename to docs/models/daterange.md diff --git a/docs/models/shared/defaultvectorizer.md b/docs/models/defaultvectorizer.md similarity index 100% rename from docs/models/shared/defaultvectorizer.md rename to docs/models/defaultvectorizer.md diff --git a/docs/models/deflate.md b/docs/models/deflate.md new file mode 100644 index 00000000..44445080 --- /dev/null +++ b/docs/models/deflate.md @@ -0,0 +1,9 @@ +# Deflate + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `codec` | [Optional[models.DestinationGcsCodec]](../models/destinationgcscodec.md) | :heavy_minus_sign: | N/A | +| `compression_level` | *Optional[int]* | :heavy_minus_sign: | 0: no compression & fastest, 9: best compression & slowest. | \ No newline at end of file diff --git a/docs/models/shared/deletionmode.md b/docs/models/deletionmode.md similarity index 82% rename from docs/models/shared/deletionmode.md rename to docs/models/deletionmode.md index 7ed9817f..d4394d1c 100644 --- a/docs/models/shared/deletionmode.md +++ b/docs/models/deletionmode.md @@ -11,12 +11,12 @@ Enabled - Enables this feature. When a document is deleted, the connector export ### Disabled ```python -deletionMode: shared.Disabled = /* values here */ +deletionMode: models.Disabled = /* values here */ ``` ### Enabled ```python -deletionMode: shared.Enabled = /* values here */ +deletionMode: models.Enabled = /* values here */ ``` diff --git a/docs/models/shared/delighted.md b/docs/models/delighted.md similarity index 100% rename from docs/models/shared/delighted.md rename to docs/models/delighted.md diff --git a/docs/models/shared/destinationastra.md b/docs/models/destinationastra.md similarity index 92% rename from docs/models/shared/destinationastra.md rename to docs/models/destinationastra.md index e9c6d57e..6a11dfc0 100644 --- a/docs/models/shared/destinationastra.md +++ b/docs/models/destinationastra.md @@ -16,8 +16,8 @@ Processing, embedding and advanced configuration are provided by this base class | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `embedding` | [Union[shared.OpenAI, shared.Cohere, shared.Fake, shared.AzureOpenAI, shared.OpenAICompatible]](../../models/shared/embedding.md) | :heavy_check_mark: | Embedding configuration | -| `indexing` | [shared.Indexing](../../models/shared/indexing.md) | :heavy_check_mark: | Astra DB gives developers the APIs, real-time data and ecosystem integrations to put accurate RAG and Gen AI apps with fewer hallucinations in production. | -| `processing` | [shared.ProcessingConfigModel](../../models/shared/processingconfigmodel.md) | :heavy_check_mark: | N/A | -| `destination_type` | [shared.Astra](../../models/shared/astra.md) | :heavy_check_mark: | N/A | +| `embedding` | [Union[models.OpenAI, models.Cohere, models.Fake, models.AzureOpenAI, models.OpenAICompatible]](../models/embedding.md) | :heavy_check_mark: | Embedding configuration | +| `indexing` | [models.Indexing](../models/indexing.md) | :heavy_check_mark: | Astra DB gives developers the APIs, real-time data and ecosystem integrations to put accurate RAG and Gen AI apps with fewer hallucinations in production. | +| `processing` | [models.ProcessingConfigModel](../models/processingconfigmodel.md) | :heavy_check_mark: | N/A | +| `destination_type` | [models.Astra](../models/astra.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/destinationastralanguage.md b/docs/models/destinationastralanguage.md similarity index 100% rename from docs/models/shared/destinationastralanguage.md rename to docs/models/destinationastralanguage.md diff --git a/docs/models/shared/destinationastramode.md b/docs/models/destinationastramode.md similarity index 100% rename from docs/models/shared/destinationastramode.md rename to docs/models/destinationastramode.md diff --git a/docs/models/shared/destinationastraschemasembeddingembedding1mode.md b/docs/models/destinationastraschemasembeddingembedding1mode.md similarity index 100% rename from docs/models/shared/destinationastraschemasembeddingembedding1mode.md rename to docs/models/destinationastraschemasembeddingembedding1mode.md diff --git a/docs/models/shared/destinationastraschemasembeddingembeddingmode.md b/docs/models/destinationastraschemasembeddingembeddingmode.md similarity index 100% rename from docs/models/shared/destinationastraschemasembeddingembeddingmode.md rename to docs/models/destinationastraschemasembeddingembeddingmode.md diff --git a/docs/models/shared/destinationastraschemasembeddingmode.md b/docs/models/destinationastraschemasembeddingmode.md similarity index 100% rename from docs/models/shared/destinationastraschemasembeddingmode.md rename to docs/models/destinationastraschemasembeddingmode.md diff --git a/docs/models/shared/destinationastraschemasmode.md b/docs/models/destinationastraschemasmode.md similarity index 100% rename from docs/models/shared/destinationastraschemasmode.md rename to docs/models/destinationastraschemasmode.md diff --git a/docs/models/shared/destinationastraschemasprocessingmode.md b/docs/models/destinationastraschemasprocessingmode.md similarity index 100% rename from docs/models/shared/destinationastraschemasprocessingmode.md rename to docs/models/destinationastraschemasprocessingmode.md diff --git a/docs/models/shared/destinationastraschemasprocessingtextsplittermode.md b/docs/models/destinationastraschemasprocessingtextsplittermode.md similarity index 100% rename from docs/models/shared/destinationastraschemasprocessingtextsplittermode.md rename to docs/models/destinationastraschemasprocessingtextsplittermode.md diff --git a/docs/models/shared/destinationastraschemasprocessingtextsplittertextsplittermode.md b/docs/models/destinationastraschemasprocessingtextsplittertextsplittermode.md similarity index 100% rename from docs/models/shared/destinationastraschemasprocessingtextsplittertextsplittermode.md rename to docs/models/destinationastraschemasprocessingtextsplittertextsplittermode.md diff --git a/docs/models/shared/destinationawsdatalake.md b/docs/models/destinationawsdatalake.md similarity index 95% rename from docs/models/shared/destinationawsdatalake.md rename to docs/models/destinationawsdatalake.md index 818054df..9cfa3f26 100644 --- a/docs/models/shared/destinationawsdatalake.md +++ b/docs/models/destinationawsdatalake.md @@ -6,15 +6,15 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `bucket_name` | *str* | :heavy_check_mark: | The name of the S3 bucket. Read more here. | | -| `credentials` | [Union[shared.IAMRole, shared.IAMUser]](../../models/shared/authenticationmode.md) | :heavy_check_mark: | Choose How to Authenticate to AWS. | | +| `credentials` | [Union[models.IAMRole, models.IAMUser]](../models/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. | | +| `destination_type` | [models.AwsDatalake](../models/awsdatalake.md) | :heavy_check_mark: | N/A | | +| `format` | [Optional[Union[models.JSONLinesNewlineDelimitedJSON, models.ParquetColumnarStorage]]](../models/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_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 +| `partitioning` | [Optional[models.ChooseHowToPartitionData]](../models/choosehowtopartitiondata.md) | :heavy_minus_sign: | Partition data by cursor fields when a cursor field is a date | | +| `region` | [Optional[models.S3BucketRegion]](../models/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/destinationawsdatalakecompressioncodecoptional.md b/docs/models/destinationawsdatalakecompressioncodecoptional.md similarity index 100% rename from docs/models/shared/destinationawsdatalakecompressioncodecoptional.md rename to docs/models/destinationawsdatalakecompressioncodecoptional.md diff --git a/docs/models/shared/destinationawsdatalakecredentialstitle.md b/docs/models/destinationawsdatalakecredentialstitle.md similarity index 100% rename from docs/models/shared/destinationawsdatalakecredentialstitle.md rename to docs/models/destinationawsdatalakecredentialstitle.md diff --git a/docs/models/shared/destinationawsdatalakeformattypewildcard.md b/docs/models/destinationawsdatalakeformattypewildcard.md similarity index 100% rename from docs/models/shared/destinationawsdatalakeformattypewildcard.md rename to docs/models/destinationawsdatalakeformattypewildcard.md diff --git a/docs/models/shared/destinationazureblobstorage.md b/docs/models/destinationazureblobstorage.md similarity index 96% rename from docs/models/shared/destinationazureblobstorage.md rename to docs/models/destinationazureblobstorage.md index 2580fe47..22757ed5 100644 --- a/docs/models/shared/destinationazureblobstorage.md +++ b/docs/models/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 | | +| `format` | [Union[models.CSVCommaSeparatedValues, models.DestinationAzureBlobStorageJSONLinesNewlineDelimitedJSON]](../models/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 | | \ No newline at end of file +| `destination_type` | [models.AzureBlobStorage](../models/azureblobstorage.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/destinationazureblobstorageformattype.md b/docs/models/destinationazureblobstorageformattype.md similarity index 100% rename from docs/models/shared/destinationazureblobstorageformattype.md rename to docs/models/destinationazureblobstorageformattype.md diff --git a/docs/models/destinationazureblobstoragejsonlinesnewlinedelimitedjson.md b/docs/models/destinationazureblobstoragejsonlinesnewlinedelimitedjson.md new file mode 100644 index 00000000..f351a9ba --- /dev/null +++ b/docs/models/destinationazureblobstoragejsonlinesnewlinedelimitedjson.md @@ -0,0 +1,8 @@ +# DestinationAzureBlobStorageJSONLinesNewlineDelimitedJSON + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `format_type` | [models.DestinationAzureBlobStorageFormatType](../models/destinationazureblobstorageformattype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationbigquery.md b/docs/models/destinationbigquery.md similarity index 98% rename from docs/models/shared/destinationbigquery.md rename to docs/models/destinationbigquery.md index d703faf7..f8664885 100644 --- a/docs/models/shared/destinationbigquery.md +++ b/docs/models/destinationbigquery.md @@ -6,12 +6,12 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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. | | +| `dataset_location` | [models.DatasetLocation](../models/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 | | +| `destination_type` | [models.Bigquery](../models/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. | | +| `loading_method` | [Optional[Union[models.GCSStaging, models.StandardInserts]]](../models/loadingmethod.md) | :heavy_minus_sign: | The way data will be uploaded to BigQuery. | | | `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 +| `transformation_priority` | [Optional[models.TransformationQueryRunType]](../models/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/destinationbigquerycredentialtype.md b/docs/models/destinationbigquerycredentialtype.md similarity index 100% rename from docs/models/shared/destinationbigquerycredentialtype.md rename to docs/models/destinationbigquerycredentialtype.md diff --git a/docs/models/shared/destinationbigqueryhmackey.md b/docs/models/destinationbigqueryhmackey.md similarity index 96% rename from docs/models/shared/destinationbigqueryhmackey.md rename to docs/models/destinationbigqueryhmackey.md index f192db21..a32b60f2 100644 --- a/docs/models/shared/destinationbigqueryhmackey.md +++ b/docs/models/destinationbigqueryhmackey.md @@ -7,4 +7,4 @@ | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `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 | -| `credential_type` | [shared.DestinationBigqueryCredentialType](../../models/shared/destinationbigquerycredentialtype.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `credential_type` | [models.DestinationBigqueryCredentialType](../models/destinationbigquerycredentialtype.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/destinationbigquerymethod.md b/docs/models/destinationbigquerymethod.md similarity index 100% rename from docs/models/shared/destinationbigquerymethod.md rename to docs/models/destinationbigquerymethod.md diff --git a/docs/models/shared/destinationclickhouse.md b/docs/models/destinationclickhouse.md similarity index 88% rename from docs/models/shared/destinationclickhouse.md rename to docs/models/destinationclickhouse.md index 911e8575..d1e2315c 100644 --- a/docs/models/shared/destinationclickhouse.md +++ b/docs/models/destinationclickhouse.md @@ -8,8 +8,9 @@ | `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 use to access the database. | | -| `destination_type` | [shared.Clickhouse](../../models/shared/clickhouse.md) | :heavy_check_mark: | N/A | | +| `destination_type` | [models.Clickhouse](../models/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. | | \ No newline at end of file +| `raw_data_schema` | *Optional[str]* | :heavy_minus_sign: | The schema to write raw tables into (default: airbyte_internal) | | +| `tunnel_method` | [Optional[Union[models.NoTunnel, models.SSHKeyAuthentication, models.PasswordAuthentication]]](../models/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/destinationclickhouseschemastunnelmethod.md b/docs/models/destinationclickhouseschemastunnelmethod.md similarity index 100% rename from docs/models/shared/destinationclickhouseschemastunnelmethod.md rename to docs/models/destinationclickhouseschemastunnelmethod.md diff --git a/docs/models/shared/destinationclickhousetunnelmethod.md b/docs/models/destinationclickhousetunnelmethod.md similarity index 100% rename from docs/models/shared/destinationclickhousetunnelmethod.md rename to docs/models/destinationclickhousetunnelmethod.md diff --git a/docs/models/destinationconfiguration.md b/docs/models/destinationconfiguration.md new file mode 100644 index 00000000..a6308cd9 --- /dev/null +++ b/docs/models/destinationconfiguration.md @@ -0,0 +1,211 @@ +# DestinationConfiguration + +The values required to configure the destination. + + +## Supported Types + +### DestinationGoogleSheets + +```python +destinationConfiguration: models.DestinationGoogleSheets = /* values here */ +``` + +### DestinationAstra + +```python +destinationConfiguration: models.DestinationAstra = /* values here */ +``` + +### DestinationAwsDatalake + +```python +destinationConfiguration: models.DestinationAwsDatalake = /* values here */ +``` + +### DestinationAzureBlobStorage + +```python +destinationConfiguration: models.DestinationAzureBlobStorage = /* values here */ +``` + +### DestinationBigquery + +```python +destinationConfiguration: models.DestinationBigquery = /* values here */ +``` + +### DestinationClickhouse + +```python +destinationConfiguration: models.DestinationClickhouse = /* values here */ +``` + +### DestinationConvex + +```python +destinationConfiguration: models.DestinationConvex = /* values here */ +``` + +### DestinationDatabricks + +```python +destinationConfiguration: models.DestinationDatabricks = /* values here */ +``` + +### DestinationDevNull + +```python +destinationConfiguration: models.DestinationDevNull = /* values here */ +``` + +### DestinationDuckdb + +```python +destinationConfiguration: models.DestinationDuckdb = /* values here */ +``` + +### DestinationDynamodb + +```python +destinationConfiguration: models.DestinationDynamodb = /* values here */ +``` + +### DestinationElasticsearch + +```python +destinationConfiguration: models.DestinationElasticsearch = /* values here */ +``` + +### DestinationFirestore + +```python +destinationConfiguration: models.DestinationFirestore = /* values here */ +``` + +### DestinationGcs + +```python +destinationConfiguration: models.DestinationGcs = /* values here */ +``` + +### DestinationLangchain + +```python +destinationConfiguration: models.DestinationLangchain = /* values here */ +``` + +### DestinationMilvus + +```python +destinationConfiguration: models.DestinationMilvus = /* values here */ +``` + +### DestinationMongodb + +```python +destinationConfiguration: models.DestinationMongodb = /* values here */ +``` + +### DestinationMssql + +```python +destinationConfiguration: models.DestinationMssql = /* values here */ +``` + +### DestinationMysql + +```python +destinationConfiguration: models.DestinationMysql = /* values here */ +``` + +### DestinationOracle + +```python +destinationConfiguration: models.DestinationOracle = /* values here */ +``` + +### DestinationPinecone + +```python +destinationConfiguration: models.DestinationPinecone = /* values here */ +``` + +### DestinationPostgres + +```python +destinationConfiguration: models.DestinationPostgres = /* values here */ +``` + +### DestinationPubsub + +```python +destinationConfiguration: models.DestinationPubsub = /* values here */ +``` + +### DestinationQdrant + +```python +destinationConfiguration: models.DestinationQdrant = /* values here */ +``` + +### DestinationRedis + +```python +destinationConfiguration: models.DestinationRedis = /* values here */ +``` + +### DestinationRedshift + +```python +destinationConfiguration: models.DestinationRedshift = /* values here */ +``` + +### DestinationS3 + +```python +destinationConfiguration: models.DestinationS3 = /* values here */ +``` + +### DestinationS3Glue + +```python +destinationConfiguration: models.DestinationS3Glue = /* values here */ +``` + +### DestinationSftpJSON + +```python +destinationConfiguration: models.DestinationSftpJSON = /* values here */ +``` + +### DestinationSnowflake + +```python +destinationConfiguration: models.DestinationSnowflake = /* values here */ +``` + +### DestinationTeradata + +```python +destinationConfiguration: models.DestinationTeradata = /* values here */ +``` + +### DestinationTypesense + +```python +destinationConfiguration: models.DestinationTypesense = /* values here */ +``` + +### DestinationVectara + +```python +destinationConfiguration: models.DestinationVectara = /* values here */ +``` + +### DestinationWeaviate + +```python +destinationConfiguration: models.DestinationWeaviate = /* values here */ +``` + diff --git a/docs/models/shared/destinationconvex.md b/docs/models/destinationconvex.md similarity index 91% rename from docs/models/shared/destinationconvex.md rename to docs/models/destinationconvex.md index 4dd9b191..06d95f01 100644 --- a/docs/models/shared/destinationconvex.md +++ b/docs/models/destinationconvex.md @@ -7,4 +7,4 @@ | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `access_key` | *str* | :heavy_check_mark: | API access key used to send data to a Convex deployment. | | | `deployment_url` | *str* | :heavy_check_mark: | URL of the Convex deployment that is the destination | https://murky-swan-635.convex.cloud | -| `destination_type` | [shared.Convex](../../models/shared/convex.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `destination_type` | [models.Convex](../models/convex.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/destinationcreaterequest.md b/docs/models/destinationcreaterequest.md new file mode 100644 index 00000000..a909663c --- /dev/null +++ b/docs/models/destinationcreaterequest.md @@ -0,0 +1,11 @@ +# DestinationCreateRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `configuration` | [Union[models.DestinationGoogleSheets, models.DestinationAstra, models.DestinationAwsDatalake, models.DestinationAzureBlobStorage, models.DestinationBigquery, models.DestinationClickhouse, models.DestinationConvex, models.DestinationDatabricks, models.DestinationDevNull, models.DestinationDuckdb, models.DestinationDynamodb, models.DestinationElasticsearch, models.DestinationFirestore, models.DestinationGcs, models.DestinationLangchain, models.DestinationMilvus, models.DestinationMongodb, models.DestinationMssql, models.DestinationMysql, models.DestinationOracle, models.DestinationPinecone, models.DestinationPostgres, models.DestinationPubsub, models.DestinationQdrant, models.DestinationRedis, models.DestinationRedshift, models.DestinationS3, models.DestinationS3Glue, models.DestinationSftpJSON, models.DestinationSnowflake, models.DestinationTeradata, models.DestinationTypesense, models.DestinationVectara, models.DestinationWeaviate]](../models/destinationconfiguration.md) | :heavy_check_mark: | The values required to configure the destination. | {
    "user": "charles"
    } | +| `name` | *str* | :heavy_check_mark: | Name of the destination e.g. dev-mysql-instance. | | +| `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/destinationdatabricks.md b/docs/models/destinationdatabricks.md similarity index 96% rename from docs/models/shared/destinationdatabricks.md rename to docs/models/destinationdatabricks.md index a5d1f773..1831a847 100644 --- a/docs/models/shared/destinationdatabricks.md +++ b/docs/models/destinationdatabricks.md @@ -5,14 +5,14 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data_source` | [Union[shared.RecommendedManagedTables, shared.AmazonS3, shared.DestinationDatabricksAzureBlobStorage]](../../models/shared/datasource.md) | :heavy_check_mark: | Storage on which the delta lake is built. | | +| `data_source` | [Union[models.RecommendedManagedTables, models.AmazonS3, models.DestinationDatabricksAzureBlobStorage]](../models/datasource.md) | :heavy_check_mark: | Storage on which the delta lake is built. | | | `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_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 | | +| `destination_type` | [models.Databricks](../models/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. | | | `schema` | *Optional[str]* | :heavy_minus_sign: | The default schema tables are written. If not specified otherwise, the "default" will be used. | default | \ No newline at end of file diff --git a/docs/models/shared/destinationdatabricksazureblobstorage.md b/docs/models/destinationdatabricksazureblobstorage.md similarity index 96% rename from docs/models/shared/destinationdatabricksazureblobstorage.md rename to docs/models/destinationdatabricksazureblobstorage.md index 30154c6c..039f276e 100644 --- a/docs/models/shared/destinationdatabricksazureblobstorage.md +++ b/docs/models/destinationdatabricksazureblobstorage.md @@ -9,4 +9,4 @@ | `azure_blob_storage_container_name` | *str* | :heavy_check_mark: | The name of the Azure blob storage container. | airbytetestcontainername | | `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 +| `data_source_type` | [models.DestinationDatabricksSchemasDataSourceType](../models/destinationdatabricksschemasdatasourcetype.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/destinationdatabricksdatasourcetype.md b/docs/models/destinationdatabricksdatasourcetype.md similarity index 100% rename from docs/models/shared/destinationdatabricksdatasourcetype.md rename to docs/models/destinationdatabricksdatasourcetype.md diff --git a/docs/models/shared/destinationdatabrickss3bucketregion.md b/docs/models/destinationdatabrickss3bucketregion.md similarity index 100% rename from docs/models/shared/destinationdatabrickss3bucketregion.md rename to docs/models/destinationdatabrickss3bucketregion.md diff --git a/docs/models/shared/destinationdatabricksschemasdatasourcetype.md b/docs/models/destinationdatabricksschemasdatasourcetype.md similarity index 100% rename from docs/models/shared/destinationdatabricksschemasdatasourcetype.md rename to docs/models/destinationdatabricksschemasdatasourcetype.md diff --git a/docs/models/destinationdevnull.md b/docs/models/destinationdevnull.md new file mode 100644 index 00000000..2176623f --- /dev/null +++ b/docs/models/destinationdevnull.md @@ -0,0 +1,9 @@ +# DestinationDevNull + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | +| `test_destination` | [Union[models.Silent]](../models/testdestination.md) | :heavy_check_mark: | The type of destination to be used | +| `destination_type` | [models.DevNull](../models/devnull.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationduckdb.md b/docs/models/destinationduckdb.md similarity index 98% rename from docs/models/shared/destinationduckdb.md rename to docs/models/destinationduckdb.md index e3d1eded..30cddddb 100644 --- a/docs/models/shared/destinationduckdb.md +++ b/docs/models/destinationduckdb.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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 | | +| `destination_type` | [models.Duckdb](../models/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/destinationdynamodb.md similarity index 93% rename from docs/models/shared/destinationdynamodb.md rename to docs/models/destinationdynamodb.md index 176b7ea9..4a7d7064 100644 --- a/docs/models/shared/destinationdynamodb.md +++ b/docs/models/destinationdynamodb.md @@ -8,6 +8,6 @@ | `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 | | +| `destination_type` | [models.Dynamodb](../models/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. | | \ No newline at end of file +| `dynamodb_region` | [Optional[models.DynamoDBRegion]](../models/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/destinationelasticsearch.md similarity index 95% rename from docs/models/shared/destinationelasticsearch.md rename to docs/models/destinationelasticsearch.md index fd07f0e0..f4fd656c 100644 --- a/docs/models/shared/destinationelasticsearch.md +++ b/docs/models/destinationelasticsearch.md @@ -6,7 +6,7 @@ | 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 | +| `authentication_method` | [Optional[Union[models.APIKeySecret, models.UsernamePassword]]](../models/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 | +| `destination_type` | [models.Elasticsearch](../models/elasticsearch.md) | :heavy_check_mark: | N/A | | `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/destinationelasticsearchmethod.md b/docs/models/destinationelasticsearchmethod.md similarity index 100% rename from docs/models/shared/destinationelasticsearchmethod.md rename to docs/models/destinationelasticsearchmethod.md diff --git a/docs/models/shared/destinationelasticsearchschemasmethod.md b/docs/models/destinationelasticsearchschemasmethod.md similarity index 100% rename from docs/models/shared/destinationelasticsearchschemasmethod.md rename to docs/models/destinationelasticsearchschemasmethod.md diff --git a/docs/models/shared/destinationfirestore.md b/docs/models/destinationfirestore.md similarity index 97% rename from docs/models/shared/destinationfirestore.md rename to docs/models/destinationfirestore.md index 23c91b0e..6a7f0baf 100644 --- a/docs/models/shared/destinationfirestore.md +++ b/docs/models/destinationfirestore.md @@ -7,4 +7,4 @@ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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 | \ No newline at end of file +| `destination_type` | [models.Firestore](../models/firestore.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationgcs.md b/docs/models/destinationgcs.md similarity index 97% rename from docs/models/shared/destinationgcs.md rename to docs/models/destinationgcs.md index 9a65082f..c49beb6f 100644 --- a/docs/models/shared/destinationgcs.md +++ b/docs/models/destinationgcs.md @@ -5,9 +5,9 @@ | 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. | | -| `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. | | +| `credential` | [Union[models.HMACKey]](../models/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. | | +| `format` | [Union[models.AvroApacheAvro, models.DestinationGcsCSVCommaSeparatedValues, models.DestinationGcsJSONLinesNewlineDelimitedJSON, models.DestinationGcsParquetColumnarStorage]](../models/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 +| `destination_type` | [models.Gcs](../models/gcs.md) | :heavy_check_mark: | N/A | | +| `gcs_bucket_region` | [Optional[models.GCSBucketRegion]](../models/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/destinationgcscodec.md b/docs/models/destinationgcscodec.md similarity index 100% rename from docs/models/shared/destinationgcscodec.md rename to docs/models/destinationgcscodec.md diff --git a/docs/models/destinationgcscompression.md b/docs/models/destinationgcscompression.md new file mode 100644 index 00000000..d5fd48d8 --- /dev/null +++ b/docs/models/destinationgcscompression.md @@ -0,0 +1,19 @@ +# DestinationGcsCompression + +Whether the output files should be compressed. If compression is selected, the output filename will have an extra extension (GZIP: ".jsonl.gz"). + + +## Supported Types + +### DestinationGcsSchemasNoCompression + +```python +destinationGcsCompression: models.DestinationGcsSchemasNoCompression = /* values here */ +``` + +### DestinationGcsGZIP + +```python +destinationGcsCompression: models.DestinationGcsGZIP = /* values here */ +``` + diff --git a/docs/models/shared/destinationgcscompressioncodec.md b/docs/models/destinationgcscompressioncodec.md similarity index 100% rename from docs/models/shared/destinationgcscompressioncodec.md rename to docs/models/destinationgcscompressioncodec.md diff --git a/docs/models/shared/destinationgcscompressiontype.md b/docs/models/destinationgcscompressiontype.md similarity index 100% rename from docs/models/shared/destinationgcscompressiontype.md rename to docs/models/destinationgcscompressiontype.md diff --git a/docs/models/shared/destinationgcscsvcommaseparatedvalues.md b/docs/models/destinationgcscsvcommaseparatedvalues.md similarity index 87% rename from docs/models/shared/destinationgcscsvcommaseparatedvalues.md rename to docs/models/destinationgcscsvcommaseparatedvalues.md index 019fddf4..0b2271fc 100644 --- a/docs/models/shared/destinationgcscsvcommaseparatedvalues.md +++ b/docs/models/destinationgcscsvcommaseparatedvalues.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `compression` | [Optional[Union[shared.DestinationGcsNoCompression, shared.Gzip]]](../../models/shared/compression.md) | :heavy_minus_sign: | Whether the output files should be compressed. If compression is selected, the output filename will have an extra extension (GZIP: ".csv.gz"). | -| `flattening` | [Optional[shared.Normalization]](../../models/shared/normalization.md) | :heavy_minus_sign: | Whether the input JSON data should be normalized (flattened) in the output CSV. Please refer to docs for details. | -| `format_type` | [Optional[shared.DestinationGcsSchemasFormatType]](../../models/shared/destinationgcsschemasformattype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `compression` | [Optional[Union[models.DestinationGcsNoCompression, models.Gzip]]](../models/compression.md) | :heavy_minus_sign: | Whether the output files should be compressed. If compression is selected, the output filename will have an extra extension (GZIP: ".csv.gz"). | +| `flattening` | [Optional[models.Normalization]](../models/normalization.md) | :heavy_minus_sign: | Whether the input JSON data should be normalized (flattened) in the output CSV. Please refer to docs for details. | +| `format_type` | [Optional[models.DestinationGcsSchemasFormatType]](../models/destinationgcsschemasformattype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationgcsformattype.md b/docs/models/destinationgcsformattype.md similarity index 100% rename from docs/models/shared/destinationgcsformattype.md rename to docs/models/destinationgcsformattype.md diff --git a/docs/models/destinationgcsgzip.md b/docs/models/destinationgcsgzip.md new file mode 100644 index 00000000..9f4a568f --- /dev/null +++ b/docs/models/destinationgcsgzip.md @@ -0,0 +1,8 @@ +# DestinationGcsGZIP + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `compression_type` | [Optional[models.DestinationGcsSchemasFormatCompressionType]](../models/destinationgcsschemasformatcompressiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationgcsjsonlinesnewlinedelimitedjson.md b/docs/models/destinationgcsjsonlinesnewlinedelimitedjson.md similarity index 84% rename from docs/models/shared/destinationgcsjsonlinesnewlinedelimitedjson.md rename to docs/models/destinationgcsjsonlinesnewlinedelimitedjson.md index 29964744..0e3205ec 100644 --- a/docs/models/shared/destinationgcsjsonlinesnewlinedelimitedjson.md +++ b/docs/models/destinationgcsjsonlinesnewlinedelimitedjson.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `compression` | [Optional[Union[shared.DestinationGcsSchemasNoCompression, shared.DestinationGcsGZIP]]](../../models/shared/destinationgcscompression.md) | :heavy_minus_sign: | Whether the output files should be compressed. If compression is selected, the output filename will have an extra extension (GZIP: ".jsonl.gz"). | -| `format_type` | [Optional[shared.DestinationGcsSchemasFormatFormatType]](../../models/shared/destinationgcsschemasformatformattype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `compression` | [Optional[Union[models.DestinationGcsSchemasNoCompression, models.DestinationGcsGZIP]]](../models/destinationgcscompression.md) | :heavy_minus_sign: | Whether the output files should be compressed. If compression is selected, the output filename will have an extra extension (GZIP: ".jsonl.gz"). | +| `format_type` | [Optional[models.DestinationGcsSchemasFormatFormatType]](../models/destinationgcsschemasformatformattype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/destinationgcsnocompression.md b/docs/models/destinationgcsnocompression.md new file mode 100644 index 00000000..a30e66e4 --- /dev/null +++ b/docs/models/destinationgcsnocompression.md @@ -0,0 +1,8 @@ +# DestinationGcsNoCompression + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | +| `compression_type` | [Optional[models.CompressionType]](../models/compressiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationgcsoutputformat.md b/docs/models/destinationgcsoutputformat.md similarity index 78% rename from docs/models/shared/destinationgcsoutputformat.md rename to docs/models/destinationgcsoutputformat.md index 00ef4a3b..e8df9434 100644 --- a/docs/models/shared/destinationgcsoutputformat.md +++ b/docs/models/destinationgcsoutputformat.md @@ -8,24 +8,24 @@ Output data format. One of the following formats must be selected - "user": "charles"
    } | +| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/destinationpinecone.md b/docs/models/destinationpinecone.md similarity index 89% rename from docs/models/shared/destinationpinecone.md rename to docs/models/destinationpinecone.md index 04739cef..d46f588e 100644 --- a/docs/models/shared/destinationpinecone.md +++ b/docs/models/destinationpinecone.md @@ -16,8 +16,8 @@ Processing, embedding and advanced configuration are provided by this base class | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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. | -| `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 | +| `embedding` | [Union[models.DestinationPineconeOpenAI, models.DestinationPineconeCohere, models.DestinationPineconeFake, models.DestinationPineconeAzureOpenAI, models.DestinationPineconeOpenAICompatible]](../models/destinationpineconeembedding.md) | :heavy_check_mark: | Embedding configuration | +| `indexing` | [models.DestinationPineconeIndexing](../models/destinationpineconeindexing.md) | :heavy_check_mark: | Pinecone is a popular vector store that can be used to store and retrieve embeddings. | +| `processing` | [models.DestinationPineconeProcessingConfigModel](../models/destinationpineconeprocessingconfigmodel.md) | :heavy_check_mark: | N/A | +| `destination_type` | [models.Pinecone](../models/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/destinationpineconeazureopenai.md b/docs/models/destinationpineconeazureopenai.md new file mode 100644 index 00000000..3e32248a --- /dev/null +++ b/docs/models/destinationpineconeazureopenai.md @@ -0,0 +1,13 @@ +# DestinationPineconeAzureOpenAI + +Use the Azure-hosted OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions. + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `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 | +| `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[models.DestinationPineconeSchemasEmbeddingEmbeddingMode]](../models/destinationpineconeschemasembeddingembeddingmode.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/destinationpineconebymarkdownheader.md b/docs/models/destinationpineconebymarkdownheader.md new file mode 100644 index 00000000..7730011e --- /dev/null +++ b/docs/models/destinationpineconebymarkdownheader.md @@ -0,0 +1,11 @@ +# DestinationPineconeByMarkdownHeader + +Split the text by Markdown headers down to the specified header level. If the chunk size fits multiple sections, they will be combined into a single chunk. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | +| `mode` | [Optional[models.DestinationPineconeSchemasProcessingTextSplitterMode]](../models/destinationpineconeschemasprocessingtextsplittermode.md) | :heavy_minus_sign: | N/A | +| `split_level` | *Optional[int]* | :heavy_minus_sign: | Level of markdown headers to split text fields by. Headings down to the specified level will be used as split points | \ No newline at end of file diff --git a/docs/models/destinationpineconebyprogramminglanguage.md b/docs/models/destinationpineconebyprogramminglanguage.md new file mode 100644 index 00000000..186502dc --- /dev/null +++ b/docs/models/destinationpineconebyprogramminglanguage.md @@ -0,0 +1,11 @@ +# DestinationPineconeByProgrammingLanguage + +Split the text by suitable delimiters based on the programming language. This is useful for splitting code into chunks. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `language` | [models.DestinationPineconeLanguage](../models/destinationpineconelanguage.md) | :heavy_check_mark: | Split code in suitable places based on the programming language | +| `mode` | [Optional[models.DestinationPineconeSchemasProcessingTextSplitterTextSplitterMode]](../models/destinationpineconeschemasprocessingtextsplittertextsplittermode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationpineconebyseparator.md b/docs/models/destinationpineconebyseparator.md similarity index 96% rename from docs/models/shared/destinationpineconebyseparator.md rename to docs/models/destinationpineconebyseparator.md index 57267e66..81d6df9c 100644 --- a/docs/models/shared/destinationpineconebyseparator.md +++ b/docs/models/destinationpineconebyseparator.md @@ -8,5 +8,5 @@ Split the text by the list of separators until the chunk size is reached, using | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `keep_separator` | *Optional[bool]* | :heavy_minus_sign: | Whether to keep the separator in the resulting chunks | -| `mode` | [Optional[shared.DestinationPineconeSchemasProcessingMode]](../../models/shared/destinationpineconeschemasprocessingmode.md) | :heavy_minus_sign: | N/A | +| `mode` | [Optional[models.DestinationPineconeSchemasProcessingMode]](../models/destinationpineconeschemasprocessingmode.md) | :heavy_minus_sign: | N/A | | `separators` | List[*str*] | :heavy_minus_sign: | List of separator strings to split text fields by. The separator itself needs to be wrapped in double quotes, e.g. to split by the dot character, use ".". To split by a newline, use "\n". | \ No newline at end of file diff --git a/docs/models/destinationpineconecohere.md b/docs/models/destinationpineconecohere.md new file mode 100644 index 00000000..7243126c --- /dev/null +++ b/docs/models/destinationpineconecohere.md @@ -0,0 +1,11 @@ +# DestinationPineconeCohere + +Use the Cohere API to embed text. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `cohere_key` | *str* | :heavy_check_mark: | N/A | +| `mode` | [Optional[models.DestinationPineconeSchemasMode]](../models/destinationpineconeschemasmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/destinationpineconeembedding.md b/docs/models/destinationpineconeembedding.md new file mode 100644 index 00000000..bcfa1c3a --- /dev/null +++ b/docs/models/destinationpineconeembedding.md @@ -0,0 +1,37 @@ +# DestinationPineconeEmbedding + +Embedding configuration + + +## Supported Types + +### DestinationPineconeOpenAI + +```python +destinationPineconeEmbedding: models.DestinationPineconeOpenAI = /* values here */ +``` + +### DestinationPineconeCohere + +```python +destinationPineconeEmbedding: models.DestinationPineconeCohere = /* values here */ +``` + +### DestinationPineconeFake + +```python +destinationPineconeEmbedding: models.DestinationPineconeFake = /* values here */ +``` + +### DestinationPineconeAzureOpenAI + +```python +destinationPineconeEmbedding: models.DestinationPineconeAzureOpenAI = /* values here */ +``` + +### DestinationPineconeOpenAICompatible + +```python +destinationPineconeEmbedding: models.DestinationPineconeOpenAICompatible = /* values here */ +``` + diff --git a/docs/models/destinationpineconefake.md b/docs/models/destinationpineconefake.md new file mode 100644 index 00000000..9c70c087 --- /dev/null +++ b/docs/models/destinationpineconefake.md @@ -0,0 +1,10 @@ +# DestinationPineconeFake + +Use a fake embedding made out of random vectors with 1536 embedding dimensions. This is useful for testing the data pipeline without incurring any costs. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `mode` | [Optional[models.DestinationPineconeSchemasEmbeddingMode]](../models/destinationpineconeschemasembeddingmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationpineconefieldnamemappingconfigmodel.md b/docs/models/destinationpineconefieldnamemappingconfigmodel.md similarity index 100% rename from docs/models/shared/destinationpineconefieldnamemappingconfigmodel.md rename to docs/models/destinationpineconefieldnamemappingconfigmodel.md diff --git a/docs/models/shared/destinationpineconeindexing.md b/docs/models/destinationpineconeindexing.md similarity index 100% rename from docs/models/shared/destinationpineconeindexing.md rename to docs/models/destinationpineconeindexing.md diff --git a/docs/models/shared/destinationpineconelanguage.md b/docs/models/destinationpineconelanguage.md similarity index 100% rename from docs/models/shared/destinationpineconelanguage.md rename to docs/models/destinationpineconelanguage.md diff --git a/docs/models/shared/destinationpineconemode.md b/docs/models/destinationpineconemode.md similarity index 100% rename from docs/models/shared/destinationpineconemode.md rename to docs/models/destinationpineconemode.md diff --git a/docs/models/destinationpineconeopenai.md b/docs/models/destinationpineconeopenai.md new file mode 100644 index 00000000..0313da1a --- /dev/null +++ b/docs/models/destinationpineconeopenai.md @@ -0,0 +1,11 @@ +# DestinationPineconeOpenAI + +Use the OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `openai_key` | *str* | :heavy_check_mark: | N/A | +| `mode` | [Optional[models.DestinationPineconeMode]](../models/destinationpineconemode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/destinationpineconeopenaicompatible.md b/docs/models/destinationpineconeopenaicompatible.md new file mode 100644 index 00000000..234fe56a --- /dev/null +++ b/docs/models/destinationpineconeopenaicompatible.md @@ -0,0 +1,14 @@ +# DestinationPineconeOpenAICompatible + +Use a service that's compatible with the OpenAI API to embed text. + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `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[models.DestinationPineconeSchemasEmbeddingEmbedding5Mode]](../models/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/destinationpineconeprocessingconfigmodel.md similarity index 98% rename from docs/models/shared/destinationpineconeprocessingconfigmodel.md rename to docs/models/destinationpineconeprocessingconfigmodel.md index 6467c0fe..82807846 100644 --- a/docs/models/shared/destinationpineconeprocessingconfigmodel.md +++ b/docs/models/destinationpineconeprocessingconfigmodel.md @@ -7,7 +7,7 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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. | | +| `field_name_mappings` | List[[models.DestinationPineconeFieldNameMappingConfigModel](../models/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 | -| `text_splitter` | [Optional[Union[shared.DestinationPineconeBySeparator, shared.DestinationPineconeByMarkdownHeader, shared.DestinationPineconeByProgrammingLanguage]]](../../models/shared/destinationpineconetextsplitter.md) | :heavy_minus_sign: | Split text fields into chunks based on the specified method. | | \ No newline at end of file +| `text_splitter` | [Optional[Union[models.DestinationPineconeBySeparator, models.DestinationPineconeByMarkdownHeader, models.DestinationPineconeByProgrammingLanguage]]](../models/destinationpineconetextsplitter.md) | :heavy_minus_sign: | Split text fields into chunks based on the specified method. | | \ No newline at end of file diff --git a/docs/models/shared/destinationpineconeschemasembeddingembedding5mode.md b/docs/models/destinationpineconeschemasembeddingembedding5mode.md similarity index 100% rename from docs/models/shared/destinationpineconeschemasembeddingembedding5mode.md rename to docs/models/destinationpineconeschemasembeddingembedding5mode.md diff --git a/docs/models/shared/destinationpineconeschemasembeddingembeddingmode.md b/docs/models/destinationpineconeschemasembeddingembeddingmode.md similarity index 100% rename from docs/models/shared/destinationpineconeschemasembeddingembeddingmode.md rename to docs/models/destinationpineconeschemasembeddingembeddingmode.md diff --git a/docs/models/shared/destinationpineconeschemasembeddingmode.md b/docs/models/destinationpineconeschemasembeddingmode.md similarity index 100% rename from docs/models/shared/destinationpineconeschemasembeddingmode.md rename to docs/models/destinationpineconeschemasembeddingmode.md diff --git a/docs/models/shared/destinationpineconeschemasmode.md b/docs/models/destinationpineconeschemasmode.md similarity index 100% rename from docs/models/shared/destinationpineconeschemasmode.md rename to docs/models/destinationpineconeschemasmode.md diff --git a/docs/models/shared/destinationpineconeschemasprocessingmode.md b/docs/models/destinationpineconeschemasprocessingmode.md similarity index 100% rename from docs/models/shared/destinationpineconeschemasprocessingmode.md rename to docs/models/destinationpineconeschemasprocessingmode.md diff --git a/docs/models/shared/destinationpineconeschemasprocessingtextsplittermode.md b/docs/models/destinationpineconeschemasprocessingtextsplittermode.md similarity index 100% rename from docs/models/shared/destinationpineconeschemasprocessingtextsplittermode.md rename to docs/models/destinationpineconeschemasprocessingtextsplittermode.md diff --git a/docs/models/shared/destinationpineconeschemasprocessingtextsplittertextsplittermode.md b/docs/models/destinationpineconeschemasprocessingtextsplittertextsplittermode.md similarity index 100% rename from docs/models/shared/destinationpineconeschemasprocessingtextsplittertextsplittermode.md rename to docs/models/destinationpineconeschemasprocessingtextsplittertextsplittermode.md diff --git a/docs/models/destinationpineconetextsplitter.md b/docs/models/destinationpineconetextsplitter.md new file mode 100644 index 00000000..8e62bd56 --- /dev/null +++ b/docs/models/destinationpineconetextsplitter.md @@ -0,0 +1,25 @@ +# DestinationPineconeTextSplitter + +Split text fields into chunks based on the specified method. + + +## Supported Types + +### DestinationPineconeBySeparator + +```python +destinationPineconeTextSplitter: models.DestinationPineconeBySeparator = /* values here */ +``` + +### DestinationPineconeByMarkdownHeader + +```python +destinationPineconeTextSplitter: models.DestinationPineconeByMarkdownHeader = /* values here */ +``` + +### DestinationPineconeByProgrammingLanguage + +```python +destinationPineconeTextSplitter: models.DestinationPineconeByProgrammingLanguage = /* values here */ +``` + diff --git a/docs/models/shared/destinationpostgres.md b/docs/models/destinationpostgres.md similarity index 99% rename from docs/models/shared/destinationpostgres.md rename to docs/models/destinationpostgres.md index 18bb40a5..13d053f0 100644 --- a/docs/models/shared/destinationpostgres.md +++ b/docs/models/destinationpostgres.md @@ -8,12 +8,12 @@ | `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 use to access the database. | | -| `destination_type` | [shared.Postgres](../../models/shared/postgres.md) | :heavy_check_mark: | N/A | | +| `destination_type` | [models.Postgres](../models/postgres.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 | | | `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 | | `raw_data_schema` | *Optional[str]* | :heavy_minus_sign: | 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. 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. | | \ No newline at end of file +| `ssl_mode` | [Optional[Union[models.Disable, models.Allow, models.Prefer, models.Require, models.VerifyCa, models.VerifyFull]]](../models/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[models.DestinationPostgresNoTunnel, models.DestinationPostgresSSHKeyAuthentication, models.DestinationPostgresPasswordAuthentication]]](../models/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/destinationpostgresmode.md b/docs/models/destinationpostgresmode.md similarity index 100% rename from docs/models/shared/destinationpostgresmode.md rename to docs/models/destinationpostgresmode.md diff --git a/docs/models/destinationpostgresnotunnel.md b/docs/models/destinationpostgresnotunnel.md new file mode 100644 index 00000000..32209074 --- /dev/null +++ b/docs/models/destinationpostgresnotunnel.md @@ -0,0 +1,8 @@ +# DestinationPostgresNoTunnel + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `tunnel_method` | [models.DestinationPostgresTunnelMethod](../models/destinationpostgrestunnelmethod.md) | :heavy_check_mark: | No ssh tunnel needed to connect to database | \ No newline at end of file diff --git a/docs/models/destinationpostgrespasswordauthentication.md b/docs/models/destinationpostgrespasswordauthentication.md new file mode 100644 index 00000000..704065c8 --- /dev/null +++ b/docs/models/destinationpostgrespasswordauthentication.md @@ -0,0 +1,12 @@ +# DestinationPostgresPasswordAuthentication + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `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_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | +| `tunnel_method` | [models.DestinationPostgresSchemasTunnelMethodTunnelMethod](../models/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/destinationpostgresschemasmode.md b/docs/models/destinationpostgresschemasmode.md similarity index 100% rename from docs/models/shared/destinationpostgresschemasmode.md rename to docs/models/destinationpostgresschemasmode.md diff --git a/docs/models/shared/destinationpostgresschemassslmodemode.md b/docs/models/destinationpostgresschemassslmodemode.md similarity index 100% rename from docs/models/shared/destinationpostgresschemassslmodemode.md rename to docs/models/destinationpostgresschemassslmodemode.md diff --git a/docs/models/shared/destinationpostgresschemassslmodesslmodes6mode.md b/docs/models/destinationpostgresschemassslmodesslmodes6mode.md similarity index 100% rename from docs/models/shared/destinationpostgresschemassslmodesslmodes6mode.md rename to docs/models/destinationpostgresschemassslmodesslmodes6mode.md diff --git a/docs/models/shared/destinationpostgresschemassslmodesslmodesmode.md b/docs/models/destinationpostgresschemassslmodesslmodesmode.md similarity index 100% rename from docs/models/shared/destinationpostgresschemassslmodesslmodesmode.md rename to docs/models/destinationpostgresschemassslmodesslmodesmode.md diff --git a/docs/models/shared/destinationpostgresschemastunnelmethod.md b/docs/models/destinationpostgresschemastunnelmethod.md similarity index 100% rename from docs/models/shared/destinationpostgresschemastunnelmethod.md rename to docs/models/destinationpostgresschemastunnelmethod.md diff --git a/docs/models/shared/destinationpostgresschemastunnelmethodtunnelmethod.md b/docs/models/destinationpostgresschemastunnelmethodtunnelmethod.md similarity index 100% rename from docs/models/shared/destinationpostgresschemastunnelmethodtunnelmethod.md rename to docs/models/destinationpostgresschemastunnelmethodtunnelmethod.md diff --git a/docs/models/shared/destinationpostgressshkeyauthentication.md b/docs/models/destinationpostgressshkeyauthentication.md similarity index 95% rename from docs/models/shared/destinationpostgressshkeyauthentication.md rename to docs/models/destinationpostgressshkeyauthentication.md index 11cb2422..53db7662 100644 --- a/docs/models/shared/destinationpostgressshkeyauthentication.md +++ b/docs/models/destinationpostgressshkeyauthentication.md @@ -8,5 +8,5 @@ | `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_method` | [models.DestinationPostgresSchemasTunnelMethod](../models/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 | \ No newline at end of file diff --git a/docs/models/destinationpostgressshtunnelmethod.md b/docs/models/destinationpostgressshtunnelmethod.md new file mode 100644 index 00000000..edf40597 --- /dev/null +++ b/docs/models/destinationpostgressshtunnelmethod.md @@ -0,0 +1,25 @@ +# DestinationPostgresSSHTunnelMethod + +Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. + + +## Supported Types + +### DestinationPostgresNoTunnel + +```python +destinationPostgresSSHTunnelMethod: models.DestinationPostgresNoTunnel = /* values here */ +``` + +### DestinationPostgresSSHKeyAuthentication + +```python +destinationPostgresSSHTunnelMethod: models.DestinationPostgresSSHKeyAuthentication = /* values here */ +``` + +### DestinationPostgresPasswordAuthentication + +```python +destinationPostgresSSHTunnelMethod: models.DestinationPostgresPasswordAuthentication = /* values here */ +``` + diff --git a/docs/models/shared/destinationpostgrestunnelmethod.md b/docs/models/destinationpostgrestunnelmethod.md similarity index 100% rename from docs/models/shared/destinationpostgrestunnelmethod.md rename to docs/models/destinationpostgrestunnelmethod.md diff --git a/docs/models/shared/destinationpubsub.md b/docs/models/destinationpubsub.md similarity index 98% rename from docs/models/shared/destinationpubsub.md rename to docs/models/destinationpubsub.md index 8dfff8b2..2166c436 100644 --- a/docs/models/shared/destinationpubsub.md +++ b/docs/models/destinationpubsub.md @@ -12,5 +12,5 @@ | `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 | -| `destination_type` | [shared.Pubsub](../../models/shared/pubsub.md) | :heavy_check_mark: | N/A | +| `destination_type` | [models.Pubsub](../models/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 | \ No newline at end of file diff --git a/docs/models/destinationputrequest.md b/docs/models/destinationputrequest.md new file mode 100644 index 00000000..b49dd8ee --- /dev/null +++ b/docs/models/destinationputrequest.md @@ -0,0 +1,9 @@ +# DestinationPutRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `configuration` | [Union[models.DestinationGoogleSheets, models.DestinationAstra, models.DestinationAwsDatalake, models.DestinationAzureBlobStorage, models.DestinationBigquery, models.DestinationClickhouse, models.DestinationConvex, models.DestinationDatabricks, models.DestinationDevNull, models.DestinationDuckdb, models.DestinationDynamodb, models.DestinationElasticsearch, models.DestinationFirestore, models.DestinationGcs, models.DestinationLangchain, models.DestinationMilvus, models.DestinationMongodb, models.DestinationMssql, models.DestinationMysql, models.DestinationOracle, models.DestinationPinecone, models.DestinationPostgres, models.DestinationPubsub, models.DestinationQdrant, models.DestinationRedis, models.DestinationRedshift, models.DestinationS3, models.DestinationS3Glue, models.DestinationSftpJSON, models.DestinationSnowflake, models.DestinationTeradata, models.DestinationTypesense, models.DestinationVectara, models.DestinationWeaviate]](../models/destinationconfiguration.md) | :heavy_check_mark: | The values required to configure the destination. | {
    "user": "charles"
    } | +| `name` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/destinationqdrant.md b/docs/models/destinationqdrant.md similarity index 89% rename from docs/models/shared/destinationqdrant.md rename to docs/models/destinationqdrant.md index cd26e528..0bb03044 100644 --- a/docs/models/shared/destinationqdrant.md +++ b/docs/models/destinationqdrant.md @@ -16,8 +16,8 @@ Processing, embedding and advanced configuration are provided by this base class | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `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 | +| `embedding` | [Union[models.DestinationQdrantOpenAI, models.DestinationQdrantCohere, models.DestinationQdrantFake, models.DestinationQdrantAzureOpenAI, models.DestinationQdrantOpenAICompatible]](../models/destinationqdrantembedding.md) | :heavy_check_mark: | Embedding configuration | +| `indexing` | [models.DestinationQdrantIndexing](../models/destinationqdrantindexing.md) | :heavy_check_mark: | Indexing configuration | +| `processing` | [models.DestinationQdrantProcessingConfigModel](../models/destinationqdrantprocessingconfigmodel.md) | :heavy_check_mark: | N/A | +| `destination_type` | [models.Qdrant](../models/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/destinationqdrantauthenticationmethod.md b/docs/models/destinationqdrantauthenticationmethod.md new file mode 100644 index 00000000..2e6f6c64 --- /dev/null +++ b/docs/models/destinationqdrantauthenticationmethod.md @@ -0,0 +1,19 @@ +# DestinationQdrantAuthenticationMethod + +Method to authenticate with the Qdrant Instance + + +## Supported Types + +### APIKeyAuth + +```python +destinationQdrantAuthenticationMethod: models.APIKeyAuth = /* values here */ +``` + +### DestinationQdrantNoAuth + +```python +destinationQdrantAuthenticationMethod: models.DestinationQdrantNoAuth = /* values here */ +``` + diff --git a/docs/models/destinationqdrantazureopenai.md b/docs/models/destinationqdrantazureopenai.md new file mode 100644 index 00000000..58685fcd --- /dev/null +++ b/docs/models/destinationqdrantazureopenai.md @@ -0,0 +1,13 @@ +# DestinationQdrantAzureOpenAI + +Use the Azure-hosted OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions. + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `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 | +| `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[models.DestinationQdrantSchemasEmbeddingEmbeddingMode]](../models/destinationqdrantschemasembeddingembeddingmode.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/destinationqdrantbymarkdownheader.md b/docs/models/destinationqdrantbymarkdownheader.md new file mode 100644 index 00000000..89600e5d --- /dev/null +++ b/docs/models/destinationqdrantbymarkdownheader.md @@ -0,0 +1,11 @@ +# DestinationQdrantByMarkdownHeader + +Split the text by Markdown headers down to the specified header level. If the chunk size fits multiple sections, they will be combined into a single chunk. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| `mode` | [Optional[models.DestinationQdrantSchemasProcessingTextSplitterMode]](../models/destinationqdrantschemasprocessingtextsplittermode.md) | :heavy_minus_sign: | N/A | +| `split_level` | *Optional[int]* | :heavy_minus_sign: | Level of markdown headers to split text fields by. Headings down to the specified level will be used as split points | \ No newline at end of file diff --git a/docs/models/destinationqdrantbyprogramminglanguage.md b/docs/models/destinationqdrantbyprogramminglanguage.md new file mode 100644 index 00000000..b66f49a4 --- /dev/null +++ b/docs/models/destinationqdrantbyprogramminglanguage.md @@ -0,0 +1,11 @@ +# DestinationQdrantByProgrammingLanguage + +Split the text by suitable delimiters based on the programming language. This is useful for splitting code into chunks. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `language` | [models.DestinationQdrantLanguage](../models/destinationqdrantlanguage.md) | :heavy_check_mark: | Split code in suitable places based on the programming language | +| `mode` | [Optional[models.DestinationQdrantSchemasProcessingTextSplitterTextSplitterMode]](../models/destinationqdrantschemasprocessingtextsplittertextsplittermode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationqdrantbyseparator.md b/docs/models/destinationqdrantbyseparator.md similarity index 96% rename from docs/models/shared/destinationqdrantbyseparator.md rename to docs/models/destinationqdrantbyseparator.md index 72242dd2..ac89e4c1 100644 --- a/docs/models/shared/destinationqdrantbyseparator.md +++ b/docs/models/destinationqdrantbyseparator.md @@ -8,5 +8,5 @@ Split the text by the list of separators until the chunk size is reached, using | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `keep_separator` | *Optional[bool]* | :heavy_minus_sign: | Whether to keep the separator in the resulting chunks | -| `mode` | [Optional[shared.DestinationQdrantSchemasProcessingMode]](../../models/shared/destinationqdrantschemasprocessingmode.md) | :heavy_minus_sign: | N/A | +| `mode` | [Optional[models.DestinationQdrantSchemasProcessingMode]](../models/destinationqdrantschemasprocessingmode.md) | :heavy_minus_sign: | N/A | | `separators` | List[*str*] | :heavy_minus_sign: | List of separator strings to split text fields by. The separator itself needs to be wrapped in double quotes, e.g. to split by the dot character, use ".". To split by a newline, use "\n". | \ No newline at end of file diff --git a/docs/models/destinationqdrantcohere.md b/docs/models/destinationqdrantcohere.md new file mode 100644 index 00000000..4e5a8697 --- /dev/null +++ b/docs/models/destinationqdrantcohere.md @@ -0,0 +1,11 @@ +# DestinationQdrantCohere + +Use the Cohere API to embed text. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `cohere_key` | *str* | :heavy_check_mark: | N/A | +| `mode` | [Optional[models.DestinationQdrantSchemasMode]](../models/destinationqdrantschemasmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/destinationqdrantembedding.md b/docs/models/destinationqdrantembedding.md new file mode 100644 index 00000000..deb48560 --- /dev/null +++ b/docs/models/destinationqdrantembedding.md @@ -0,0 +1,37 @@ +# DestinationQdrantEmbedding + +Embedding configuration + + +## Supported Types + +### DestinationQdrantOpenAI + +```python +destinationQdrantEmbedding: models.DestinationQdrantOpenAI = /* values here */ +``` + +### DestinationQdrantCohere + +```python +destinationQdrantEmbedding: models.DestinationQdrantCohere = /* values here */ +``` + +### DestinationQdrantFake + +```python +destinationQdrantEmbedding: models.DestinationQdrantFake = /* values here */ +``` + +### DestinationQdrantAzureOpenAI + +```python +destinationQdrantEmbedding: models.DestinationQdrantAzureOpenAI = /* values here */ +``` + +### DestinationQdrantOpenAICompatible + +```python +destinationQdrantEmbedding: models.DestinationQdrantOpenAICompatible = /* values here */ +``` + diff --git a/docs/models/destinationqdrantfake.md b/docs/models/destinationqdrantfake.md new file mode 100644 index 00000000..8b8a5973 --- /dev/null +++ b/docs/models/destinationqdrantfake.md @@ -0,0 +1,10 @@ +# DestinationQdrantFake + +Use a fake embedding made out of random vectors with 1536 embedding dimensions. This is useful for testing the data pipeline without incurring any costs. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `mode` | [Optional[models.DestinationQdrantSchemasEmbeddingMode]](../models/destinationqdrantschemasembeddingmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationqdrantfieldnamemappingconfigmodel.md b/docs/models/destinationqdrantfieldnamemappingconfigmodel.md similarity index 100% rename from docs/models/shared/destinationqdrantfieldnamemappingconfigmodel.md rename to docs/models/destinationqdrantfieldnamemappingconfigmodel.md diff --git a/docs/models/shared/destinationqdrantindexing.md b/docs/models/destinationqdrantindexing.md similarity index 94% rename from docs/models/shared/destinationqdrantindexing.md rename to docs/models/destinationqdrantindexing.md index 63c36443..605de97c 100644 --- a/docs/models/shared/destinationqdrantindexing.md +++ b/docs/models/destinationqdrantindexing.md @@ -9,7 +9,7 @@ Indexing configuration | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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. | +| `auth_method` | [Optional[Union[models.APIKeyAuth, models.DestinationQdrantNoAuth]]](../models/destinationqdrantauthenticationmethod.md) | :heavy_minus_sign: | Method to authenticate with the Qdrant Instance | +| `distance_metric` | [Optional[models.DistanceMetric]](../models/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 | \ No newline at end of file diff --git a/docs/models/shared/destinationqdrantlanguage.md b/docs/models/destinationqdrantlanguage.md similarity index 100% rename from docs/models/shared/destinationqdrantlanguage.md rename to docs/models/destinationqdrantlanguage.md diff --git a/docs/models/shared/destinationqdrantmode.md b/docs/models/destinationqdrantmode.md similarity index 100% rename from docs/models/shared/destinationqdrantmode.md rename to docs/models/destinationqdrantmode.md diff --git a/docs/models/destinationqdrantnoauth.md b/docs/models/destinationqdrantnoauth.md new file mode 100644 index 00000000..d968f179 --- /dev/null +++ b/docs/models/destinationqdrantnoauth.md @@ -0,0 +1,8 @@ +# DestinationQdrantNoAuth + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `mode` | [Optional[models.DestinationQdrantSchemasIndexingAuthMethodMode]](../models/destinationqdrantschemasindexingauthmethodmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/destinationqdrantopenai.md b/docs/models/destinationqdrantopenai.md new file mode 100644 index 00000000..4eef42dd --- /dev/null +++ b/docs/models/destinationqdrantopenai.md @@ -0,0 +1,11 @@ +# DestinationQdrantOpenAI + +Use the OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `openai_key` | *str* | :heavy_check_mark: | N/A | +| `mode` | [Optional[models.DestinationQdrantMode]](../models/destinationqdrantmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/destinationqdrantopenaicompatible.md b/docs/models/destinationqdrantopenaicompatible.md new file mode 100644 index 00000000..b82ce562 --- /dev/null +++ b/docs/models/destinationqdrantopenaicompatible.md @@ -0,0 +1,14 @@ +# DestinationQdrantOpenAICompatible + +Use a service that's compatible with the OpenAI API to embed text. + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `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[models.DestinationQdrantSchemasEmbeddingEmbedding5Mode]](../models/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/destinationqdrantprocessingconfigmodel.md similarity index 98% rename from docs/models/shared/destinationqdrantprocessingconfigmodel.md rename to docs/models/destinationqdrantprocessingconfigmodel.md index 051196ed..7b2e2491 100644 --- a/docs/models/shared/destinationqdrantprocessingconfigmodel.md +++ b/docs/models/destinationqdrantprocessingconfigmodel.md @@ -7,7 +7,7 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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. | | +| `field_name_mappings` | List[[models.DestinationQdrantFieldNameMappingConfigModel](../models/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 | -| `text_splitter` | [Optional[Union[shared.DestinationQdrantBySeparator, shared.DestinationQdrantByMarkdownHeader, shared.DestinationQdrantByProgrammingLanguage]]](../../models/shared/destinationqdranttextsplitter.md) | :heavy_minus_sign: | Split text fields into chunks based on the specified method. | | \ No newline at end of file +| `text_splitter` | [Optional[Union[models.DestinationQdrantBySeparator, models.DestinationQdrantByMarkdownHeader, models.DestinationQdrantByProgrammingLanguage]]](../models/destinationqdranttextsplitter.md) | :heavy_minus_sign: | Split text fields into chunks based on the specified method. | | \ No newline at end of file diff --git a/docs/models/shared/destinationqdrantschemasembeddingembedding5mode.md b/docs/models/destinationqdrantschemasembeddingembedding5mode.md similarity index 100% rename from docs/models/shared/destinationqdrantschemasembeddingembedding5mode.md rename to docs/models/destinationqdrantschemasembeddingembedding5mode.md diff --git a/docs/models/shared/destinationqdrantschemasembeddingembeddingmode.md b/docs/models/destinationqdrantschemasembeddingembeddingmode.md similarity index 100% rename from docs/models/shared/destinationqdrantschemasembeddingembeddingmode.md rename to docs/models/destinationqdrantschemasembeddingembeddingmode.md diff --git a/docs/models/shared/destinationqdrantschemasembeddingmode.md b/docs/models/destinationqdrantschemasembeddingmode.md similarity index 100% rename from docs/models/shared/destinationqdrantschemasembeddingmode.md rename to docs/models/destinationqdrantschemasembeddingmode.md diff --git a/docs/models/shared/destinationqdrantschemasindexingauthmethodmode.md b/docs/models/destinationqdrantschemasindexingauthmethodmode.md similarity index 100% rename from docs/models/shared/destinationqdrantschemasindexingauthmethodmode.md rename to docs/models/destinationqdrantschemasindexingauthmethodmode.md diff --git a/docs/models/shared/destinationqdrantschemasindexingmode.md b/docs/models/destinationqdrantschemasindexingmode.md similarity index 100% rename from docs/models/shared/destinationqdrantschemasindexingmode.md rename to docs/models/destinationqdrantschemasindexingmode.md diff --git a/docs/models/shared/destinationqdrantschemasmode.md b/docs/models/destinationqdrantschemasmode.md similarity index 100% rename from docs/models/shared/destinationqdrantschemasmode.md rename to docs/models/destinationqdrantschemasmode.md diff --git a/docs/models/shared/destinationqdrantschemasprocessingmode.md b/docs/models/destinationqdrantschemasprocessingmode.md similarity index 100% rename from docs/models/shared/destinationqdrantschemasprocessingmode.md rename to docs/models/destinationqdrantschemasprocessingmode.md diff --git a/docs/models/shared/destinationqdrantschemasprocessingtextsplittermode.md b/docs/models/destinationqdrantschemasprocessingtextsplittermode.md similarity index 100% rename from docs/models/shared/destinationqdrantschemasprocessingtextsplittermode.md rename to docs/models/destinationqdrantschemasprocessingtextsplittermode.md diff --git a/docs/models/shared/destinationqdrantschemasprocessingtextsplittertextsplittermode.md b/docs/models/destinationqdrantschemasprocessingtextsplittertextsplittermode.md similarity index 100% rename from docs/models/shared/destinationqdrantschemasprocessingtextsplittertextsplittermode.md rename to docs/models/destinationqdrantschemasprocessingtextsplittertextsplittermode.md diff --git a/docs/models/destinationqdranttextsplitter.md b/docs/models/destinationqdranttextsplitter.md new file mode 100644 index 00000000..3bc6d6b0 --- /dev/null +++ b/docs/models/destinationqdranttextsplitter.md @@ -0,0 +1,25 @@ +# DestinationQdrantTextSplitter + +Split text fields into chunks based on the specified method. + + +## Supported Types + +### DestinationQdrantBySeparator + +```python +destinationQdrantTextSplitter: models.DestinationQdrantBySeparator = /* values here */ +``` + +### DestinationQdrantByMarkdownHeader + +```python +destinationQdrantTextSplitter: models.DestinationQdrantByMarkdownHeader = /* values here */ +``` + +### DestinationQdrantByProgrammingLanguage + +```python +destinationQdrantTextSplitter: models.DestinationQdrantByProgrammingLanguage = /* values here */ +``` + diff --git a/docs/models/destinationredis.md b/docs/models/destinationredis.md new file mode 100644 index 00000000..ea7be21a --- /dev/null +++ b/docs/models/destinationredis.md @@ -0,0 +1,16 @@ +# DestinationRedis + + +## Fields + +| 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[models.CacheType]](../models/cachetype.md) | :heavy_minus_sign: | Redis cache type to store data in. | | +| `destination_type` | [models.Redis](../models/redis.md) | :heavy_check_mark: | N/A | | +| `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[models.DestinationRedisDisable, models.DestinationRedisVerifyFull]]](../models/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[models.DestinationRedisNoTunnel, models.DestinationRedisSSHKeyAuthentication, models.DestinationRedisPasswordAuthentication]]](../models/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/destinationredisdisable.md b/docs/models/destinationredisdisable.md new file mode 100644 index 00000000..b86f95b5 --- /dev/null +++ b/docs/models/destinationredisdisable.md @@ -0,0 +1,10 @@ +# DestinationRedisDisable + +Disable SSL. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `mode` | [Optional[models.DestinationRedisMode]](../models/destinationredismode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationredismode.md b/docs/models/destinationredismode.md similarity index 100% rename from docs/models/shared/destinationredismode.md rename to docs/models/destinationredismode.md diff --git a/docs/models/destinationredisnotunnel.md b/docs/models/destinationredisnotunnel.md new file mode 100644 index 00000000..b64666d3 --- /dev/null +++ b/docs/models/destinationredisnotunnel.md @@ -0,0 +1,8 @@ +# DestinationRedisNoTunnel + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `tunnel_method` | [models.DestinationRedisTunnelMethod](../models/destinationredistunnelmethod.md) | :heavy_check_mark: | No ssh tunnel needed to connect to database | \ No newline at end of file diff --git a/docs/models/destinationredispasswordauthentication.md b/docs/models/destinationredispasswordauthentication.md new file mode 100644 index 00000000..4bcfd747 --- /dev/null +++ b/docs/models/destinationredispasswordauthentication.md @@ -0,0 +1,12 @@ +# DestinationRedisPasswordAuthentication + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `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_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | +| `tunnel_method` | [models.DestinationRedisSchemasTunnelMethodTunnelMethod](../models/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/destinationredisschemasmode.md b/docs/models/destinationredisschemasmode.md similarity index 100% rename from docs/models/shared/destinationredisschemasmode.md rename to docs/models/destinationredisschemasmode.md diff --git a/docs/models/shared/destinationredisschemastunnelmethod.md b/docs/models/destinationredisschemastunnelmethod.md similarity index 100% rename from docs/models/shared/destinationredisschemastunnelmethod.md rename to docs/models/destinationredisschemastunnelmethod.md diff --git a/docs/models/shared/destinationredisschemastunnelmethodtunnelmethod.md b/docs/models/destinationredisschemastunnelmethodtunnelmethod.md similarity index 100% rename from docs/models/shared/destinationredisschemastunnelmethodtunnelmethod.md rename to docs/models/destinationredisschemastunnelmethodtunnelmethod.md diff --git a/docs/models/shared/destinationredissshkeyauthentication.md b/docs/models/destinationredissshkeyauthentication.md similarity index 95% rename from docs/models/shared/destinationredissshkeyauthentication.md rename to docs/models/destinationredissshkeyauthentication.md index 7757aac3..583aaf44 100644 --- a/docs/models/shared/destinationredissshkeyauthentication.md +++ b/docs/models/destinationredissshkeyauthentication.md @@ -8,5 +8,5 @@ | `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_method` | [models.DestinationRedisSchemasTunnelMethod](../models/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 | \ No newline at end of file diff --git a/docs/models/destinationredissshtunnelmethod.md b/docs/models/destinationredissshtunnelmethod.md new file mode 100644 index 00000000..29775cf7 --- /dev/null +++ b/docs/models/destinationredissshtunnelmethod.md @@ -0,0 +1,25 @@ +# DestinationRedisSSHTunnelMethod + +Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. + + +## Supported Types + +### DestinationRedisNoTunnel + +```python +destinationRedisSSHTunnelMethod: models.DestinationRedisNoTunnel = /* values here */ +``` + +### DestinationRedisSSHKeyAuthentication + +```python +destinationRedisSSHTunnelMethod: models.DestinationRedisSSHKeyAuthentication = /* values here */ +``` + +### DestinationRedisPasswordAuthentication + +```python +destinationRedisSSHTunnelMethod: models.DestinationRedisPasswordAuthentication = /* values here */ +``` + diff --git a/docs/models/destinationredissslmodes.md b/docs/models/destinationredissslmodes.md new file mode 100644 index 00000000..2bf51b51 --- /dev/null +++ b/docs/models/destinationredissslmodes.md @@ -0,0 +1,20 @@ +# DestinationRedisSSLModes + +SSL connection modes. +
  • verify-full - This is the most secure mode. Always require encryption and verifies the identity of the source database server + + +## Supported Types + +### DestinationRedisDisable + +```python +destinationRedisSSLModes: models.DestinationRedisDisable = /* values here */ +``` + +### DestinationRedisVerifyFull + +```python +destinationRedisSSLModes: models.DestinationRedisVerifyFull = /* values here */ +``` + diff --git a/docs/models/shared/destinationredistunnelmethod.md b/docs/models/destinationredistunnelmethod.md similarity index 100% rename from docs/models/shared/destinationredistunnelmethod.md rename to docs/models/destinationredistunnelmethod.md diff --git a/docs/models/destinationredisverifyfull.md b/docs/models/destinationredisverifyfull.md new file mode 100644 index 00000000..8589d7b8 --- /dev/null +++ b/docs/models/destinationredisverifyfull.md @@ -0,0 +1,14 @@ +# DestinationRedisVerifyFull + +Verify-full SSL mode. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `ca_certificate` | *str* | :heavy_check_mark: | CA certificate | +| `client_certificate` | *str* | :heavy_check_mark: | Client certificate | +| `client_key` | *str* | :heavy_check_mark: | 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. | +| `mode` | [Optional[models.DestinationRedisSchemasMode]](../models/destinationredisschemasmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationredshift.md b/docs/models/destinationredshift.md similarity index 97% rename from docs/models/shared/destinationredshift.md rename to docs/models/destinationredshift.md index 2f139411..6b64b2b1 100644 --- a/docs/models/shared/destinationredshift.md +++ b/docs/models/destinationredshift.md @@ -9,12 +9,12 @@ | `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 | | +| `destination_type` | [models.Redshift](../models/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 | | | `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 | | `raw_data_schema` | *Optional[str]* | :heavy_minus_sign: | 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. | | \ No newline at end of file +| `tunnel_method` | [Optional[Union[models.DestinationRedshiftNoTunnel, models.DestinationRedshiftSSHKeyAuthentication, models.DestinationRedshiftPasswordAuthentication]]](../models/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[models.AWSS3Staging, models.Standard]]](../models/uploadingmethod.md) | :heavy_minus_sign: | The way data will be uploaded to Redshift. | | \ No newline at end of file diff --git a/docs/models/destinationredshiftencryption.md b/docs/models/destinationredshiftencryption.md new file mode 100644 index 00000000..27d69624 --- /dev/null +++ b/docs/models/destinationredshiftencryption.md @@ -0,0 +1,19 @@ +# DestinationRedshiftEncryption + +How to encrypt the staging data + + +## Supported Types + +### NoEncryption + +```python +destinationRedshiftEncryption: models.NoEncryption = /* values here */ +``` + +### AESCBCEnvelopeEncryption + +```python +destinationRedshiftEncryption: models.AESCBCEnvelopeEncryption = /* values here */ +``` + diff --git a/docs/models/shared/destinationredshiftencryptiontype.md b/docs/models/destinationredshiftencryptiontype.md similarity index 100% rename from docs/models/shared/destinationredshiftencryptiontype.md rename to docs/models/destinationredshiftencryptiontype.md diff --git a/docs/models/shared/destinationredshiftmethod.md b/docs/models/destinationredshiftmethod.md similarity index 100% rename from docs/models/shared/destinationredshiftmethod.md rename to docs/models/destinationredshiftmethod.md diff --git a/docs/models/destinationredshiftnotunnel.md b/docs/models/destinationredshiftnotunnel.md new file mode 100644 index 00000000..daf097d3 --- /dev/null +++ b/docs/models/destinationredshiftnotunnel.md @@ -0,0 +1,8 @@ +# DestinationRedshiftNoTunnel + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `tunnel_method` | [models.DestinationRedshiftTunnelMethod](../models/destinationredshifttunnelmethod.md) | :heavy_check_mark: | No ssh tunnel needed to connect to database | \ No newline at end of file diff --git a/docs/models/destinationredshiftpasswordauthentication.md b/docs/models/destinationredshiftpasswordauthentication.md new file mode 100644 index 00000000..2020a496 --- /dev/null +++ b/docs/models/destinationredshiftpasswordauthentication.md @@ -0,0 +1,12 @@ +# DestinationRedshiftPasswordAuthentication + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `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_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | +| `tunnel_method` | [models.DestinationRedshiftSchemasTunnelMethodTunnelMethod](../models/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/destinationredshifts3bucketregion.md b/docs/models/destinationredshifts3bucketregion.md similarity index 100% rename from docs/models/shared/destinationredshifts3bucketregion.md rename to docs/models/destinationredshifts3bucketregion.md diff --git a/docs/models/shared/destinationredshiftschemasmethod.md b/docs/models/destinationredshiftschemasmethod.md similarity index 100% rename from docs/models/shared/destinationredshiftschemasmethod.md rename to docs/models/destinationredshiftschemasmethod.md diff --git a/docs/models/shared/destinationredshiftschemastunnelmethod.md b/docs/models/destinationredshiftschemastunnelmethod.md similarity index 100% rename from docs/models/shared/destinationredshiftschemastunnelmethod.md rename to docs/models/destinationredshiftschemastunnelmethod.md diff --git a/docs/models/shared/destinationredshiftschemastunnelmethodtunnelmethod.md b/docs/models/destinationredshiftschemastunnelmethodtunnelmethod.md similarity index 100% rename from docs/models/shared/destinationredshiftschemastunnelmethodtunnelmethod.md rename to docs/models/destinationredshiftschemastunnelmethodtunnelmethod.md diff --git a/docs/models/shared/destinationredshiftsshkeyauthentication.md b/docs/models/destinationredshiftsshkeyauthentication.md similarity index 95% rename from docs/models/shared/destinationredshiftsshkeyauthentication.md rename to docs/models/destinationredshiftsshkeyauthentication.md index 831ef1f7..0bf7c47a 100644 --- a/docs/models/shared/destinationredshiftsshkeyauthentication.md +++ b/docs/models/destinationredshiftsshkeyauthentication.md @@ -8,5 +8,5 @@ | `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_method` | [models.DestinationRedshiftSchemasTunnelMethod](../models/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 | \ No newline at end of file diff --git a/docs/models/destinationredshiftsshtunnelmethod.md b/docs/models/destinationredshiftsshtunnelmethod.md new file mode 100644 index 00000000..68ee268d --- /dev/null +++ b/docs/models/destinationredshiftsshtunnelmethod.md @@ -0,0 +1,25 @@ +# DestinationRedshiftSSHTunnelMethod + +Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. + + +## Supported Types + +### DestinationRedshiftNoTunnel + +```python +destinationRedshiftSSHTunnelMethod: models.DestinationRedshiftNoTunnel = /* values here */ +``` + +### DestinationRedshiftSSHKeyAuthentication + +```python +destinationRedshiftSSHTunnelMethod: models.DestinationRedshiftSSHKeyAuthentication = /* values here */ +``` + +### DestinationRedshiftPasswordAuthentication + +```python +destinationRedshiftSSHTunnelMethod: models.DestinationRedshiftPasswordAuthentication = /* values here */ +``` + diff --git a/docs/models/shared/destinationredshifttunnelmethod.md b/docs/models/destinationredshifttunnelmethod.md similarity index 100% rename from docs/models/shared/destinationredshifttunnelmethod.md rename to docs/models/destinationredshifttunnelmethod.md diff --git a/docs/models/destinationresponse.md b/docs/models/destinationresponse.md new file mode 100644 index 00000000..a28c6156 --- /dev/null +++ b/docs/models/destinationresponse.md @@ -0,0 +1,14 @@ +# DestinationResponse + +Provides details of a single destination. + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `configuration` | [Union[models.DestinationGoogleSheets, models.DestinationAstra, models.DestinationAwsDatalake, models.DestinationAzureBlobStorage, models.DestinationBigquery, models.DestinationClickhouse, models.DestinationConvex, models.DestinationDatabricks, models.DestinationDevNull, models.DestinationDuckdb, models.DestinationDynamodb, models.DestinationElasticsearch, models.DestinationFirestore, models.DestinationGcs, models.DestinationLangchain, models.DestinationMilvus, models.DestinationMongodb, models.DestinationMssql, models.DestinationMysql, models.DestinationOracle, models.DestinationPinecone, models.DestinationPostgres, models.DestinationPubsub, models.DestinationQdrant, models.DestinationRedis, models.DestinationRedshift, models.DestinationS3, models.DestinationS3Glue, models.DestinationSftpJSON, models.DestinationSnowflake, models.DestinationTeradata, models.DestinationTypesense, models.DestinationVectara, models.DestinationWeaviate]](../models/destinationconfiguration.md) | :heavy_check_mark: | The values required to configure the destination. | {
    "user": "charles"
    } | +| `destination_id` | *str* | :heavy_check_mark: | N/A | | +| `destination_type` | *str* | :heavy_check_mark: | N/A | | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `workspace_id` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/destinations3.md b/docs/models/destinations3.md similarity index 97% rename from docs/models/shared/destinations3.md rename to docs/models/destinations3.md index fb6bb074..e86ada37 100644 --- a/docs/models/shared/destinations3.md +++ b/docs/models/destinations3.md @@ -5,13 +5,13 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | | +| `format` | [Union[models.DestinationS3CSVCommaSeparatedValues, models.DestinationS3JSONLinesNewlineDelimitedJSON, models.DestinationS3AvroApacheAvro, models.DestinationS3ParquetColumnarStorage]](../models/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 | | +| `destination_type` | [models.S3](../models/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_bucket_region` | [Optional[models.DestinationS3S3BucketRegion]](../models/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}_ | | `secret_access_key` | *Optional[str]* | :heavy_minus_sign: | The corresponding secret to the access key ID. Read more here | a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY | \ No newline at end of file diff --git a/docs/models/destinations3avroapacheavro.md b/docs/models/destinations3avroapacheavro.md new file mode 100644 index 00000000..1cdc7b41 --- /dev/null +++ b/docs/models/destinations3avroapacheavro.md @@ -0,0 +1,9 @@ +# DestinationS3AvroApacheAvro + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `compression_codec` | [Union[models.DestinationS3SchemasFormatNoCompression, models.DestinationS3Deflate, models.DestinationS3Bzip2, models.DestinationS3Xz, models.DestinationS3Zstandard, models.DestinationS3Snappy]](../models/destinations3compressioncodec.md) | :heavy_check_mark: | The compression algorithm used to compress data. Default to no compression. | +| `format_type` | [Optional[models.DestinationS3SchemasFormatFormatType]](../models/destinations3schemasformatformattype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/destinations3bzip2.md b/docs/models/destinations3bzip2.md new file mode 100644 index 00000000..0e064bac --- /dev/null +++ b/docs/models/destinations3bzip2.md @@ -0,0 +1,8 @@ +# DestinationS3Bzip2 + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `codec` | [Optional[models.DestinationS3SchemasFormatCodec]](../models/destinations3schemasformatcodec.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinations3codec.md b/docs/models/destinations3codec.md similarity index 100% rename from docs/models/shared/destinations3codec.md rename to docs/models/destinations3codec.md diff --git a/docs/models/destinations3compression.md b/docs/models/destinations3compression.md new file mode 100644 index 00000000..ceb37571 --- /dev/null +++ b/docs/models/destinations3compression.md @@ -0,0 +1,19 @@ +# DestinationS3Compression + +Whether the output files should be compressed. If compression is selected, the output filename will have an extra extension (GZIP: ".csv.gz"). + + +## Supported Types + +### DestinationS3NoCompression + +```python +destinationS3Compression: models.DestinationS3NoCompression = /* values here */ +``` + +### DestinationS3GZIP + +```python +destinationS3Compression: models.DestinationS3GZIP = /* values here */ +``` + diff --git a/docs/models/destinations3compressioncodec.md b/docs/models/destinations3compressioncodec.md new file mode 100644 index 00000000..51ff3f85 --- /dev/null +++ b/docs/models/destinations3compressioncodec.md @@ -0,0 +1,43 @@ +# DestinationS3CompressionCodec + +The compression algorithm used to compress data. Default to no compression. + + +## Supported Types + +### DestinationS3SchemasFormatNoCompression + +```python +destinationS3CompressionCodec: models.DestinationS3SchemasFormatNoCompression = /* values here */ +``` + +### DestinationS3Deflate + +```python +destinationS3CompressionCodec: models.DestinationS3Deflate = /* values here */ +``` + +### DestinationS3Bzip2 + +```python +destinationS3CompressionCodec: models.DestinationS3Bzip2 = /* values here */ +``` + +### DestinationS3Xz + +```python +destinationS3CompressionCodec: models.DestinationS3Xz = /* values here */ +``` + +### DestinationS3Zstandard + +```python +destinationS3CompressionCodec: models.DestinationS3Zstandard = /* values here */ +``` + +### DestinationS3Snappy + +```python +destinationS3CompressionCodec: models.DestinationS3Snappy = /* values here */ +``` + diff --git a/docs/models/shared/destinations3compressiontype.md b/docs/models/destinations3compressiontype.md similarity index 100% rename from docs/models/shared/destinations3compressiontype.md rename to docs/models/destinations3compressiontype.md diff --git a/docs/models/shared/destinations3csvcommaseparatedvalues.md b/docs/models/destinations3csvcommaseparatedvalues.md similarity index 84% rename from docs/models/shared/destinations3csvcommaseparatedvalues.md rename to docs/models/destinations3csvcommaseparatedvalues.md index f832e935..b6ac6daf 100644 --- a/docs/models/shared/destinations3csvcommaseparatedvalues.md +++ b/docs/models/destinations3csvcommaseparatedvalues.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `compression` | [Optional[Union[shared.DestinationS3NoCompression, shared.DestinationS3GZIP]]](../../models/shared/destinations3compression.md) | :heavy_minus_sign: | Whether the output files should be compressed. If compression is selected, the output filename will have an extra extension (GZIP: ".csv.gz"). | -| `flattening` | [Optional[shared.DestinationS3Flattening]](../../models/shared/destinations3flattening.md) | :heavy_minus_sign: | Whether the input json data should be normalized (flattened) in the output CSV. Please refer to docs for details. | -| `format_type` | [Optional[shared.DestinationS3FormatType]](../../models/shared/destinations3formattype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `compression` | [Optional[Union[models.DestinationS3NoCompression, models.DestinationS3GZIP]]](../models/destinations3compression.md) | :heavy_minus_sign: | Whether the output files should be compressed. If compression is selected, the output filename will have an extra extension (GZIP: ".csv.gz"). | +| `flattening` | [Optional[models.DestinationS3Flattening]](../models/destinations3flattening.md) | :heavy_minus_sign: | Whether the input json data should be normalized (flattened) in the output CSV. Please refer to docs for details. | +| `format_type` | [Optional[models.DestinationS3FormatType]](../models/destinations3formattype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/destinations3deflate.md b/docs/models/destinations3deflate.md new file mode 100644 index 00000000..a61cc431 --- /dev/null +++ b/docs/models/destinations3deflate.md @@ -0,0 +1,9 @@ +# DestinationS3Deflate + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `codec` | [Optional[models.DestinationS3SchemasCodec]](../models/destinations3schemascodec.md) | :heavy_minus_sign: | N/A | +| `compression_level` | *Optional[int]* | :heavy_minus_sign: | 0: no compression & fastest, 9: best compression & slowest. | \ No newline at end of file diff --git a/docs/models/shared/destinations3flattening.md b/docs/models/destinations3flattening.md similarity index 100% rename from docs/models/shared/destinations3flattening.md rename to docs/models/destinations3flattening.md diff --git a/docs/models/shared/destinations3formattype.md b/docs/models/destinations3formattype.md similarity index 100% rename from docs/models/shared/destinations3formattype.md rename to docs/models/destinations3formattype.md diff --git a/docs/models/shared/destinations3glue.md b/docs/models/destinations3glue.md similarity index 97% rename from docs/models/shared/destinations3glue.md rename to docs/models/destinations3glue.md index aa6906af..f721bc38 100644 --- a/docs/models/shared/destinations3glue.md +++ b/docs/models/destinations3glue.md @@ -5,15 +5,15 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `format` | [Union[shared.DestinationS3GlueJSONLinesNewlineDelimitedJSON]](../../models/shared/destinations3glueoutputformat.md) | :heavy_check_mark: | Format of the data output. See here for more details | | +| `format` | [Union[models.DestinationS3GlueJSONLinesNewlineDelimitedJSON]](../models/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 | | `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 | | +| `destination_type` | [models.S3Glue](../models/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. | | +| `glue_serialization_library` | [Optional[models.SerializationLibrary]](../models/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[models.DestinationS3GlueS3BucketRegion]](../models/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}_ | | `secret_access_key` | *Optional[str]* | :heavy_minus_sign: | The corresponding secret to the access key ID. Read more here | a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY | \ No newline at end of file diff --git a/docs/models/destinations3gluecompression.md b/docs/models/destinations3gluecompression.md new file mode 100644 index 00000000..6243e822 --- /dev/null +++ b/docs/models/destinations3gluecompression.md @@ -0,0 +1,19 @@ +# DestinationS3GlueCompression + +Whether the output files should be compressed. If compression is selected, the output filename will have an extra extension (GZIP: ".jsonl.gz"). + + +## Supported Types + +### DestinationS3GlueNoCompression + +```python +destinationS3GlueCompression: models.DestinationS3GlueNoCompression = /* values here */ +``` + +### DestinationS3GlueGZIP + +```python +destinationS3GlueCompression: models.DestinationS3GlueGZIP = /* values here */ +``` + diff --git a/docs/models/shared/destinations3gluecompressiontype.md b/docs/models/destinations3gluecompressiontype.md similarity index 100% rename from docs/models/shared/destinations3gluecompressiontype.md rename to docs/models/destinations3gluecompressiontype.md diff --git a/docs/models/shared/destinations3glueformattype.md b/docs/models/destinations3glueformattype.md similarity index 100% rename from docs/models/shared/destinations3glueformattype.md rename to docs/models/destinations3glueformattype.md diff --git a/docs/models/destinations3gluegzip.md b/docs/models/destinations3gluegzip.md new file mode 100644 index 00000000..48fe1ebb --- /dev/null +++ b/docs/models/destinations3gluegzip.md @@ -0,0 +1,8 @@ +# DestinationS3GlueGZIP + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `compression_type` | [Optional[models.DestinationS3GlueSchemasCompressionType]](../models/destinations3glueschemascompressiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinations3gluejsonlinesnewlinedelimitedjson.md b/docs/models/destinations3gluejsonlinesnewlinedelimitedjson.md similarity index 85% rename from docs/models/shared/destinations3gluejsonlinesnewlinedelimitedjson.md rename to docs/models/destinations3gluejsonlinesnewlinedelimitedjson.md index d3546328..3981a9d0 100644 --- a/docs/models/shared/destinations3gluejsonlinesnewlinedelimitedjson.md +++ b/docs/models/destinations3gluejsonlinesnewlinedelimitedjson.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `compression` | [Optional[Union[shared.DestinationS3GlueNoCompression, shared.DestinationS3GlueGZIP]]](../../models/shared/destinations3gluecompression.md) | :heavy_minus_sign: | Whether the output files should be compressed. If compression is selected, the output filename will have an extra extension (GZIP: ".jsonl.gz"). | -| `flattening` | [Optional[shared.Flattening]](../../models/shared/flattening.md) | :heavy_minus_sign: | Whether the input json data should be normalized (flattened) in the output JSON Lines. Please refer to docs for details. | -| `format_type` | [Optional[shared.DestinationS3GlueFormatType]](../../models/shared/destinations3glueformattype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `compression` | [Optional[Union[models.DestinationS3GlueNoCompression, models.DestinationS3GlueGZIP]]](../models/destinations3gluecompression.md) | :heavy_minus_sign: | Whether the output files should be compressed. If compression is selected, the output filename will have an extra extension (GZIP: ".jsonl.gz"). | +| `flattening` | [Optional[models.Flattening]](../models/flattening.md) | :heavy_minus_sign: | Whether the input json data should be normalized (flattened) in the output JSON Lines. Please refer to docs for details. | +| `format_type` | [Optional[models.DestinationS3GlueFormatType]](../models/destinations3glueformattype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/destinations3gluenocompression.md b/docs/models/destinations3gluenocompression.md new file mode 100644 index 00000000..719b810f --- /dev/null +++ b/docs/models/destinations3gluenocompression.md @@ -0,0 +1,8 @@ +# DestinationS3GlueNoCompression + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `compression_type` | [Optional[models.DestinationS3GlueCompressionType]](../models/destinations3gluecompressiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinations3glueoutputformat.md b/docs/models/destinations3glueoutputformat.md similarity index 82% rename from docs/models/shared/destinations3glueoutputformat.md rename to docs/models/destinations3glueoutputformat.md index 880f75f3..c20e683f 100644 --- a/docs/models/shared/destinations3glueoutputformat.md +++ b/docs/models/destinations3glueoutputformat.md @@ -8,6 +8,6 @@ Format of the data output. See here for more details + + +## Supported Types + +### DestinationS3CSVCommaSeparatedValues + +```python +destinationS3OutputFormat: models.DestinationS3CSVCommaSeparatedValues = /* values here */ +``` + +### DestinationS3JSONLinesNewlineDelimitedJSON + +```python +destinationS3OutputFormat: models.DestinationS3JSONLinesNewlineDelimitedJSON = /* values here */ +``` + +### DestinationS3AvroApacheAvro + +```python +destinationS3OutputFormat: models.DestinationS3AvroApacheAvro = /* values here */ +``` + +### DestinationS3ParquetColumnarStorage + +```python +destinationS3OutputFormat: models.DestinationS3ParquetColumnarStorage = /* values here */ +``` + diff --git a/docs/models/shared/destinations3parquetcolumnarstorage.md b/docs/models/destinations3parquetcolumnarstorage.md similarity index 96% rename from docs/models/shared/destinations3parquetcolumnarstorage.md rename to docs/models/destinations3parquetcolumnarstorage.md index a89f007b..84706181 100644 --- a/docs/models/shared/destinations3parquetcolumnarstorage.md +++ b/docs/models/destinations3parquetcolumnarstorage.md @@ -6,9 +6,9 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `block_size_mb` | *Optional[int]* | :heavy_minus_sign: | This is the size of a row group being buffered in memory. It limits the memory usage when writing. Larger values will improve the IO when reading, but consume more memory when writing. Default: 128 MB. | 128 | -| `compression_codec` | [Optional[shared.DestinationS3SchemasCompressionCodec]](../../models/shared/destinations3schemascompressioncodec.md) | :heavy_minus_sign: | The compression algorithm used to compress data pages. | | +| `compression_codec` | [Optional[models.DestinationS3SchemasCompressionCodec]](../models/destinations3schemascompressioncodec.md) | :heavy_minus_sign: | The compression algorithm used to compress data pages. | | | `dictionary_encoding` | *Optional[bool]* | :heavy_minus_sign: | Default: true. | | | `dictionary_page_size_kb` | *Optional[int]* | :heavy_minus_sign: | There is one dictionary page per column per row group when dictionary encoding is used. The dictionary page size works like the page size but for dictionary. Default: 1024 KB. | 1024 | -| `format_type` | [Optional[shared.DestinationS3SchemasFormatOutputFormatFormatType]](../../models/shared/destinations3schemasformatoutputformatformattype.md) | :heavy_minus_sign: | N/A | | +| `format_type` | [Optional[models.DestinationS3SchemasFormatOutputFormatFormatType]](../models/destinations3schemasformatoutputformatformattype.md) | :heavy_minus_sign: | N/A | | | `max_padding_size_mb` | *Optional[int]* | :heavy_minus_sign: | Maximum size allowed as padding to align row groups. This is also the minimum size of a row group. Default: 8 MB. | 8 | | `page_size_kb` | *Optional[int]* | :heavy_minus_sign: | The page size is for compression. A block is composed of pages. A page is the smallest unit that must be read fully to access a single record. If this value is too small, the compression will deteriorate. Default: 1024 KB. | 1024 | \ No newline at end of file diff --git a/docs/models/shared/destinations3s3bucketregion.md b/docs/models/destinations3s3bucketregion.md similarity index 100% rename from docs/models/shared/destinations3s3bucketregion.md rename to docs/models/destinations3s3bucketregion.md diff --git a/docs/models/shared/destinations3schemascodec.md b/docs/models/destinations3schemascodec.md similarity index 100% rename from docs/models/shared/destinations3schemascodec.md rename to docs/models/destinations3schemascodec.md diff --git a/docs/models/destinations3schemascompression.md b/docs/models/destinations3schemascompression.md new file mode 100644 index 00000000..5619ffe9 --- /dev/null +++ b/docs/models/destinations3schemascompression.md @@ -0,0 +1,19 @@ +# DestinationS3SchemasCompression + +Whether the output files should be compressed. If compression is selected, the output filename will have an extra extension (GZIP: ".jsonl.gz"). + + +## Supported Types + +### DestinationS3SchemasNoCompression + +```python +destinationS3SchemasCompression: models.DestinationS3SchemasNoCompression = /* values here */ +``` + +### DestinationS3SchemasGZIP + +```python +destinationS3SchemasCompression: models.DestinationS3SchemasGZIP = /* values here */ +``` + diff --git a/docs/models/shared/destinations3schemascompressioncodec.md b/docs/models/destinations3schemascompressioncodec.md similarity index 100% rename from docs/models/shared/destinations3schemascompressioncodec.md rename to docs/models/destinations3schemascompressioncodec.md diff --git a/docs/models/shared/destinations3schemascompressiontype.md b/docs/models/destinations3schemascompressiontype.md similarity index 100% rename from docs/models/shared/destinations3schemascompressiontype.md rename to docs/models/destinations3schemascompressiontype.md diff --git a/docs/models/shared/destinations3schemasflattening.md b/docs/models/destinations3schemasflattening.md similarity index 100% rename from docs/models/shared/destinations3schemasflattening.md rename to docs/models/destinations3schemasflattening.md diff --git a/docs/models/shared/destinations3schemasformatcodec.md b/docs/models/destinations3schemasformatcodec.md similarity index 100% rename from docs/models/shared/destinations3schemasformatcodec.md rename to docs/models/destinations3schemasformatcodec.md diff --git a/docs/models/shared/destinations3schemasformatcompressiontype.md b/docs/models/destinations3schemasformatcompressiontype.md similarity index 100% rename from docs/models/shared/destinations3schemasformatcompressiontype.md rename to docs/models/destinations3schemasformatcompressiontype.md diff --git a/docs/models/shared/destinations3schemasformatformattype.md b/docs/models/destinations3schemasformatformattype.md similarity index 100% rename from docs/models/shared/destinations3schemasformatformattype.md rename to docs/models/destinations3schemasformatformattype.md diff --git a/docs/models/destinations3schemasformatnocompression.md b/docs/models/destinations3schemasformatnocompression.md new file mode 100644 index 00000000..4d39eba8 --- /dev/null +++ b/docs/models/destinations3schemasformatnocompression.md @@ -0,0 +1,8 @@ +# DestinationS3SchemasFormatNoCompression + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `codec` | [Optional[models.DestinationS3Codec]](../models/destinations3codec.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinations3schemasformatoutputformat3codec.md b/docs/models/destinations3schemasformatoutputformat3codec.md similarity index 100% rename from docs/models/shared/destinations3schemasformatoutputformat3codec.md rename to docs/models/destinations3schemasformatoutputformat3codec.md diff --git a/docs/models/shared/destinations3schemasformatoutputformat3compressioncodeccodec.md b/docs/models/destinations3schemasformatoutputformat3compressioncodeccodec.md similarity index 100% rename from docs/models/shared/destinations3schemasformatoutputformat3compressioncodeccodec.md rename to docs/models/destinations3schemasformatoutputformat3compressioncodeccodec.md diff --git a/docs/models/shared/destinations3schemasformatoutputformatcodec.md b/docs/models/destinations3schemasformatoutputformatcodec.md similarity index 100% rename from docs/models/shared/destinations3schemasformatoutputformatcodec.md rename to docs/models/destinations3schemasformatoutputformatcodec.md diff --git a/docs/models/shared/destinations3schemasformatoutputformatcompressiontype.md b/docs/models/destinations3schemasformatoutputformatcompressiontype.md similarity index 100% rename from docs/models/shared/destinations3schemasformatoutputformatcompressiontype.md rename to docs/models/destinations3schemasformatoutputformatcompressiontype.md diff --git a/docs/models/shared/destinations3schemasformatoutputformatformattype.md b/docs/models/destinations3schemasformatoutputformatformattype.md similarity index 100% rename from docs/models/shared/destinations3schemasformatoutputformatformattype.md rename to docs/models/destinations3schemasformatoutputformatformattype.md diff --git a/docs/models/shared/destinations3schemasformattype.md b/docs/models/destinations3schemasformattype.md similarity index 100% rename from docs/models/shared/destinations3schemasformattype.md rename to docs/models/destinations3schemasformattype.md diff --git a/docs/models/destinations3schemasgzip.md b/docs/models/destinations3schemasgzip.md new file mode 100644 index 00000000..28783bb7 --- /dev/null +++ b/docs/models/destinations3schemasgzip.md @@ -0,0 +1,8 @@ +# DestinationS3SchemasGZIP + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `compression_type` | [Optional[models.DestinationS3SchemasFormatOutputFormatCompressionType]](../models/destinations3schemasformatoutputformatcompressiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/destinations3schemasnocompression.md b/docs/models/destinations3schemasnocompression.md new file mode 100644 index 00000000..d69da461 --- /dev/null +++ b/docs/models/destinations3schemasnocompression.md @@ -0,0 +1,8 @@ +# DestinationS3SchemasNoCompression + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `compression_type` | [Optional[models.DestinationS3SchemasFormatCompressionType]](../models/destinations3schemasformatcompressiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/destinations3snappy.md b/docs/models/destinations3snappy.md new file mode 100644 index 00000000..81bc4802 --- /dev/null +++ b/docs/models/destinations3snappy.md @@ -0,0 +1,8 @@ +# DestinationS3Snappy + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `codec` | [Optional[models.DestinationS3SchemasFormatOutputFormat3CompressionCodecCodec]](../models/destinations3schemasformatoutputformat3compressioncodeccodec.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinations3xz.md b/docs/models/destinations3xz.md similarity index 94% rename from docs/models/shared/destinations3xz.md rename to docs/models/destinations3xz.md index ce6e7735..fd5789ad 100644 --- a/docs/models/shared/destinations3xz.md +++ b/docs/models/destinations3xz.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `codec` | [Optional[shared.DestinationS3SchemasFormatOutputFormatCodec]](../../models/shared/destinations3schemasformatoutputformatcodec.md) | :heavy_minus_sign: | N/A | +| `codec` | [Optional[models.DestinationS3SchemasFormatOutputFormatCodec]](../models/destinations3schemasformatoutputformatcodec.md) | :heavy_minus_sign: | N/A | | `compression_level` | *Optional[int]* | :heavy_minus_sign: | See here for details. | \ No newline at end of file diff --git a/docs/models/shared/destinations3zstandard.md b/docs/models/destinations3zstandard.md similarity index 93% rename from docs/models/shared/destinations3zstandard.md rename to docs/models/destinations3zstandard.md index 8416e4cb..598eab0c 100644 --- a/docs/models/shared/destinations3zstandard.md +++ b/docs/models/destinations3zstandard.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `codec` | [Optional[shared.DestinationS3SchemasFormatOutputFormat3Codec]](../../models/shared/destinations3schemasformatoutputformat3codec.md) | :heavy_minus_sign: | N/A | +| `codec` | [Optional[models.DestinationS3SchemasFormatOutputFormat3Codec]](../models/destinations3schemasformatoutputformat3codec.md) | :heavy_minus_sign: | N/A | | `compression_level` | *Optional[int]* | :heavy_minus_sign: | Negative levels are 'fast' modes akin to lz4 or snappy, levels above 9 are generally for archival purposes, and levels above 18 use a lot of memory. | | `include_checksum` | *Optional[bool]* | :heavy_minus_sign: | If true, include a checksum with each data block. | \ No newline at end of file diff --git a/docs/models/shared/destinationsftpjson.md b/docs/models/destinationsftpjson.md similarity index 94% rename from docs/models/shared/destinationsftpjson.md rename to docs/models/destinationsftpjson.md index 96753513..81c2d356 100644 --- a/docs/models/shared/destinationsftpjson.md +++ b/docs/models/destinationsftpjson.md @@ -9,5 +9,5 @@ | `host` | *str* | :heavy_check_mark: | Hostname of the SFTP server. | | | `password` | *str* | :heavy_check_mark: | Password associated with the username. | | | `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 | | +| `destination_type` | [models.SftpJSON](../models/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/destinationsnowflake.md b/docs/models/destinationsnowflake.md new file mode 100644 index 00000000..7b92f98f --- /dev/null +++ b/docs/models/destinationsnowflake.md @@ -0,0 +1,20 @@ +# DestinationSnowflake + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `database` | *str* | :heavy_check_mark: | Enter the name of the database you want to sync data into | AIRBYTE_DATABASE | +| `host` | *str* | :heavy_check_mark: | Enter your Snowflake account's locator (in the format ...snowflakecomputing.com) | accountname.us-east-2.aws.snowflakecomputing.com | +| `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 | +| `credentials` | [Optional[Union[models.KeyPairAuthentication, models.UsernameAndPassword, models.DestinationSnowflakeOAuth20]]](../models/authorizationmethod.md) | :heavy_minus_sign: | N/A | | +| `destination_type` | [models.DestinationSnowflakeSnowflake](../models/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) | | +| `retention_period_days` | *Optional[int]* | :heavy_minus_sign: | The number of days of Snowflake Time Travel to enable on the tables. See Snowflake's documentation for more information. Setting a nonzero value will incur increased storage costs in your Snowflake instance. | | \ No newline at end of file diff --git a/docs/models/shared/destinationsnowflakeauthtype.md b/docs/models/destinationsnowflakeauthtype.md similarity index 100% rename from docs/models/shared/destinationsnowflakeauthtype.md rename to docs/models/destinationsnowflakeauthtype.md diff --git a/docs/models/destinationsnowflakeoauth20.md b/docs/models/destinationsnowflakeoauth20.md new file mode 100644 index 00000000..f5143c4e --- /dev/null +++ b/docs/models/destinationsnowflakeoauth20.md @@ -0,0 +1,12 @@ +# DestinationSnowflakeOAuth20 + + +## Fields + +| 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[models.DestinationSnowflakeSchemasAuthType]](../models/destinationsnowflakeschemasauthtype.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 | \ No newline at end of file diff --git a/docs/models/shared/destinationsnowflakeschemasauthtype.md b/docs/models/destinationsnowflakeschemasauthtype.md similarity index 100% rename from docs/models/shared/destinationsnowflakeschemasauthtype.md rename to docs/models/destinationsnowflakeschemasauthtype.md diff --git a/docs/models/shared/destinationsnowflakeschemascredentialsauthtype.md b/docs/models/destinationsnowflakeschemascredentialsauthtype.md similarity index 100% rename from docs/models/shared/destinationsnowflakeschemascredentialsauthtype.md rename to docs/models/destinationsnowflakeschemascredentialsauthtype.md diff --git a/docs/models/shared/destinationsnowflakesnowflake.md b/docs/models/destinationsnowflakesnowflake.md similarity index 100% rename from docs/models/shared/destinationsnowflakesnowflake.md rename to docs/models/destinationsnowflakesnowflake.md diff --git a/docs/models/destinationsresponse.md b/docs/models/destinationsresponse.md new file mode 100644 index 00000000..59bae3e5 --- /dev/null +++ b/docs/models/destinationsresponse.md @@ -0,0 +1,10 @@ +# DestinationsResponse + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `data` | List[[models.DestinationResponse](../models/destinationresponse.md)] | :heavy_check_mark: | N/A | +| `next` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `previous` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationteradata.md b/docs/models/destinationteradata.md similarity index 99% rename from docs/models/shared/destinationteradata.md rename to docs/models/destinationteradata.md index d22a99e6..fe99a3f6 100644 --- a/docs/models/shared/destinationteradata.md +++ b/docs/models/destinationteradata.md @@ -7,9 +7,9 @@ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `host` | *str* | :heavy_check_mark: | Hostname of the database. | | | `username` | *str* | :heavy_check_mark: | Username to use to access the database. | | -| `destination_type` | [shared.Teradata](../../models/shared/teradata.md) | :heavy_check_mark: | N/A | | +| `destination_type` | [models.Teradata](../models/teradata.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. | | | `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". | airbyte_td | | `ssl` | *Optional[bool]* | :heavy_minus_sign: | Encrypt data using SSL. When activating SSL, please select one of the connection modes. | | -| `ssl_mode` | [Optional[Union[shared.DestinationTeradataDisable, shared.DestinationTeradataAllow, shared.DestinationTeradataPrefer, shared.DestinationTeradataRequire, shared.DestinationTeradataVerifyCa, shared.DestinationTeradataVerifyFull]]](../../models/shared/destinationteradatasslmodes.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 destination database
    prefer - Chose this mode to allow unencrypted connection only if the destination database does not support encryption
    require - Chose this mode to always require encryption. If the destination database server does not support encryption, connection will fail
    verify-ca - Chose this mode to always require encryption and to verify that the destination 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 destination database server
    See more information - in the docs. | | \ No newline at end of file +| `ssl_mode` | [Optional[Union[models.DestinationTeradataDisable, models.DestinationTeradataAllow, models.DestinationTeradataPrefer, models.DestinationTeradataRequire, models.DestinationTeradataVerifyCa, models.DestinationTeradataVerifyFull]]](../models/destinationteradatasslmodes.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 destination database
    prefer - Chose this mode to allow unencrypted connection only if the destination database does not support encryption
    require - Chose this mode to always require encryption. If the destination database server does not support encryption, connection will fail
    verify-ca - Chose this mode to always require encryption and to verify that the destination 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 destination database server
    See more information - in the docs. | | \ No newline at end of file diff --git a/docs/models/destinationteradataallow.md b/docs/models/destinationteradataallow.md new file mode 100644 index 00000000..aa2f8db8 --- /dev/null +++ b/docs/models/destinationteradataallow.md @@ -0,0 +1,10 @@ +# DestinationTeradataAllow + +Allow SSL mode. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `mode` | [Optional[models.DestinationTeradataSchemasMode]](../models/destinationteradataschemasmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/destinationteradatadisable.md b/docs/models/destinationteradatadisable.md new file mode 100644 index 00000000..26d99730 --- /dev/null +++ b/docs/models/destinationteradatadisable.md @@ -0,0 +1,10 @@ +# DestinationTeradataDisable + +Disable SSL. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `mode` | [Optional[models.DestinationTeradataMode]](../models/destinationteradatamode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationteradatamode.md b/docs/models/destinationteradatamode.md similarity index 100% rename from docs/models/shared/destinationteradatamode.md rename to docs/models/destinationteradatamode.md diff --git a/docs/models/destinationteradataprefer.md b/docs/models/destinationteradataprefer.md new file mode 100644 index 00000000..c819b723 --- /dev/null +++ b/docs/models/destinationteradataprefer.md @@ -0,0 +1,10 @@ +# DestinationTeradataPrefer + +Prefer SSL mode. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `mode` | [Optional[models.DestinationTeradataSchemasSslModeMode]](../models/destinationteradataschemassslmodemode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/destinationteradatarequire.md b/docs/models/destinationteradatarequire.md new file mode 100644 index 00000000..89074d05 --- /dev/null +++ b/docs/models/destinationteradatarequire.md @@ -0,0 +1,10 @@ +# DestinationTeradataRequire + +Require SSL mode. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `mode` | [Optional[models.DestinationTeradataSchemasSSLModeSSLModesMode]](../models/destinationteradataschemassslmodesslmodesmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationteradataschemasmode.md b/docs/models/destinationteradataschemasmode.md similarity index 100% rename from docs/models/shared/destinationteradataschemasmode.md rename to docs/models/destinationteradataschemasmode.md diff --git a/docs/models/shared/destinationteradataschemassslmodemode.md b/docs/models/destinationteradataschemassslmodemode.md similarity index 100% rename from docs/models/shared/destinationteradataschemassslmodemode.md rename to docs/models/destinationteradataschemassslmodemode.md diff --git a/docs/models/shared/destinationteradataschemassslmodesslmodes5mode.md b/docs/models/destinationteradataschemassslmodesslmodes5mode.md similarity index 100% rename from docs/models/shared/destinationteradataschemassslmodesslmodes5mode.md rename to docs/models/destinationteradataschemassslmodesslmodes5mode.md diff --git a/docs/models/shared/destinationteradataschemassslmodesslmodes6mode.md b/docs/models/destinationteradataschemassslmodesslmodes6mode.md similarity index 100% rename from docs/models/shared/destinationteradataschemassslmodesslmodes6mode.md rename to docs/models/destinationteradataschemassslmodesslmodes6mode.md diff --git a/docs/models/shared/destinationteradataschemassslmodesslmodesmode.md b/docs/models/destinationteradataschemassslmodesslmodesmode.md similarity index 100% rename from docs/models/shared/destinationteradataschemassslmodesslmodesmode.md rename to docs/models/destinationteradataschemassslmodesslmodesmode.md diff --git a/docs/models/shared/destinationteradatasslmodes.md b/docs/models/destinationteradatasslmodes.md similarity index 78% rename from docs/models/shared/destinationteradatasslmodes.md rename to docs/models/destinationteradatasslmodes.md index 29f21406..4abfb23d 100644 --- a/docs/models/shared/destinationteradatasslmodes.md +++ b/docs/models/destinationteradatasslmodes.md @@ -15,36 +15,36 @@ SSL connection modes. ### DestinationTeradataDisable ```python -destinationTeradataSSLModes: shared.DestinationTeradataDisable = /* values here */ +destinationTeradataSSLModes: models.DestinationTeradataDisable = /* values here */ ``` ### DestinationTeradataAllow ```python -destinationTeradataSSLModes: shared.DestinationTeradataAllow = /* values here */ +destinationTeradataSSLModes: models.DestinationTeradataAllow = /* values here */ ``` ### DestinationTeradataPrefer ```python -destinationTeradataSSLModes: shared.DestinationTeradataPrefer = /* values here */ +destinationTeradataSSLModes: models.DestinationTeradataPrefer = /* values here */ ``` ### DestinationTeradataRequire ```python -destinationTeradataSSLModes: shared.DestinationTeradataRequire = /* values here */ +destinationTeradataSSLModes: models.DestinationTeradataRequire = /* values here */ ``` ### DestinationTeradataVerifyCa ```python -destinationTeradataSSLModes: shared.DestinationTeradataVerifyCa = /* values here */ +destinationTeradataSSLModes: models.DestinationTeradataVerifyCa = /* values here */ ``` ### DestinationTeradataVerifyFull ```python -destinationTeradataSSLModes: shared.DestinationTeradataVerifyFull = /* values here */ +destinationTeradataSSLModes: models.DestinationTeradataVerifyFull = /* values here */ ``` diff --git a/docs/models/shared/destinationteradataverifyca.md b/docs/models/destinationteradataverifyca.md similarity index 95% rename from docs/models/shared/destinationteradataverifyca.md rename to docs/models/destinationteradataverifyca.md index 8cb7f02c..1760cd82 100644 --- a/docs/models/shared/destinationteradataverifyca.md +++ b/docs/models/destinationteradataverifyca.md @@ -8,4 +8,4 @@ Verify-ca SSL mode. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ssl_ca_certificate` | *str* | :heavy_check_mark: | Specifies the file name of a PEM file that contains Certificate Authority (CA) certificates for use with SSLMODE=verify-ca.
    See more information - in the docs. | -| `mode` | [Optional[shared.DestinationTeradataSchemasSSLModeSSLModes5Mode]](../../models/shared/destinationteradataschemassslmodesslmodes5mode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `mode` | [Optional[models.DestinationTeradataSchemasSSLModeSSLModes5Mode]](../models/destinationteradataschemassslmodesslmodes5mode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationteradataverifyfull.md b/docs/models/destinationteradataverifyfull.md similarity index 95% rename from docs/models/shared/destinationteradataverifyfull.md rename to docs/models/destinationteradataverifyfull.md index b4d8fdc2..c8c1f715 100644 --- a/docs/models/shared/destinationteradataverifyfull.md +++ b/docs/models/destinationteradataverifyfull.md @@ -8,4 +8,4 @@ Verify-full SSL mode. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `ssl_ca_certificate` | *str* | :heavy_check_mark: | Specifies the file name of a PEM file that contains Certificate Authority (CA) certificates for use with SSLMODE=verify-full.
    See more information - in the docs. | -| `mode` | [Optional[shared.DestinationTeradataSchemasSSLModeSSLModes6Mode]](../../models/shared/destinationteradataschemassslmodesslmodes6mode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `mode` | [Optional[models.DestinationTeradataSchemasSSLModeSSLModes6Mode]](../models/destinationteradataschemassslmodesslmodes6mode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationtypesense.md b/docs/models/destinationtypesense.md similarity index 86% rename from docs/models/shared/destinationtypesense.md rename to docs/models/destinationtypesense.md index 983766fe..018c5339 100644 --- a/docs/models/shared/destinationtypesense.md +++ b/docs/models/destinationtypesense.md @@ -8,6 +8,7 @@ | `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 | +| `destination_type` | [models.Typesense](../models/typesense.md) | :heavy_check_mark: | N/A | +| `path` | *Optional[str]* | :heavy_minus_sign: | Path of the Typesense instance. Default is none | | `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/destinationvectara.md similarity index 99% rename from docs/models/shared/destinationvectara.md rename to docs/models/destinationvectara.md index 3b85042a..04e30835 100644 --- a/docs/models/shared/destinationvectara.md +++ b/docs/models/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 | | +| `oauth2` | [models.OAuth20Credentials](../models/oauth20credentials.md) | :heavy_check_mark: | OAuth2.0 credentials used to authenticate admin actions (creating/deleting corpora) | | +| `destination_type` | [models.Vectara](../models/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 | | `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 | diff --git a/docs/models/destinationweaviate.md b/docs/models/destinationweaviate.md new file mode 100644 index 00000000..9b65b727 --- /dev/null +++ b/docs/models/destinationweaviate.md @@ -0,0 +1,23 @@ +# DestinationWeaviate + +The configuration model for the Vector DB based destinations. This model is used to generate the UI for the destination configuration, +as well as to provide type safety for the configuration passed to the destination. + +The configuration model is composed of four parts: +* Processing configuration +* Embedding configuration +* Indexing configuration +* Advanced configuration + +Processing, embedding and advanced configuration are provided by this base class, while the indexing configuration is provided by the destination connector in the sub class. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `embedding` | [Union[models.NoExternalEmbedding, models.DestinationWeaviateAzureOpenAI, models.DestinationWeaviateOpenAI, models.DestinationWeaviateCohere, models.FromField, models.DestinationWeaviateFake, models.DestinationWeaviateOpenAICompatible]](../models/destinationweaviateembedding.md) | :heavy_check_mark: | Embedding configuration | +| `indexing` | [models.DestinationWeaviateIndexing](../models/destinationweaviateindexing.md) | :heavy_check_mark: | Indexing configuration | +| `processing` | [models.DestinationWeaviateProcessingConfigModel](../models/destinationweaviateprocessingconfigmodel.md) | :heavy_check_mark: | N/A | +| `destination_type` | [models.Weaviate](../models/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/destinationweaviateapitoken.md b/docs/models/destinationweaviateapitoken.md new file mode 100644 index 00000000..59302d80 --- /dev/null +++ b/docs/models/destinationweaviateapitoken.md @@ -0,0 +1,11 @@ +# DestinationWeaviateAPIToken + +Authenticate using an API token (suitable for Weaviate Cloud) + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `token` | *str* | :heavy_check_mark: | API Token for the Weaviate instance | +| `mode` | [Optional[models.DestinationWeaviateSchemasIndexingMode]](../models/destinationweaviateschemasindexingmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/destinationweaviateauthentication.md b/docs/models/destinationweaviateauthentication.md new file mode 100644 index 00000000..6ee84db1 --- /dev/null +++ b/docs/models/destinationweaviateauthentication.md @@ -0,0 +1,25 @@ +# DestinationWeaviateAuthentication + +Authentication method + + +## Supported Types + +### DestinationWeaviateAPIToken + +```python +destinationWeaviateAuthentication: models.DestinationWeaviateAPIToken = /* values here */ +``` + +### DestinationWeaviateUsernamePassword + +```python +destinationWeaviateAuthentication: models.DestinationWeaviateUsernamePassword = /* values here */ +``` + +### NoAuthentication + +```python +destinationWeaviateAuthentication: models.NoAuthentication = /* values here */ +``` + diff --git a/docs/models/shared/destinationweaviateazureopenai.md b/docs/models/destinationweaviateazureopenai.md similarity index 96% rename from docs/models/shared/destinationweaviateazureopenai.md rename to docs/models/destinationweaviateazureopenai.md index 1fba92ad..172eba62 100644 --- a/docs/models/shared/destinationweaviateazureopenai.md +++ b/docs/models/destinationweaviateazureopenai.md @@ -10,4 +10,4 @@ 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 | | `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 +| `mode` | [Optional[models.DestinationWeaviateSchemasMode]](../models/destinationweaviateschemasmode.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/destinationweaviatebymarkdownheader.md b/docs/models/destinationweaviatebymarkdownheader.md new file mode 100644 index 00000000..88112f8c --- /dev/null +++ b/docs/models/destinationweaviatebymarkdownheader.md @@ -0,0 +1,11 @@ +# DestinationWeaviateByMarkdownHeader + +Split the text by Markdown headers down to the specified header level. If the chunk size fits multiple sections, they will be combined into a single chunk. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | +| `mode` | [Optional[models.DestinationWeaviateSchemasProcessingTextSplitterMode]](../models/destinationweaviateschemasprocessingtextsplittermode.md) | :heavy_minus_sign: | N/A | +| `split_level` | *Optional[int]* | :heavy_minus_sign: | Level of markdown headers to split text fields by. Headings down to the specified level will be used as split points | \ No newline at end of file diff --git a/docs/models/destinationweaviatebyprogramminglanguage.md b/docs/models/destinationweaviatebyprogramminglanguage.md new file mode 100644 index 00000000..0193ac12 --- /dev/null +++ b/docs/models/destinationweaviatebyprogramminglanguage.md @@ -0,0 +1,11 @@ +# DestinationWeaviateByProgrammingLanguage + +Split the text by suitable delimiters based on the programming language. This is useful for splitting code into chunks. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `language` | [models.DestinationWeaviateLanguage](../models/destinationweaviatelanguage.md) | :heavy_check_mark: | Split code in suitable places based on the programming language | +| `mode` | [Optional[models.DestinationWeaviateSchemasProcessingTextSplitterTextSplitterMode]](../models/destinationweaviateschemasprocessingtextsplittertextsplittermode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationweaviatebyseparator.md b/docs/models/destinationweaviatebyseparator.md similarity index 96% rename from docs/models/shared/destinationweaviatebyseparator.md rename to docs/models/destinationweaviatebyseparator.md index c819a0c1..1c2155cd 100644 --- a/docs/models/shared/destinationweaviatebyseparator.md +++ b/docs/models/destinationweaviatebyseparator.md @@ -8,5 +8,5 @@ Split the text by the list of separators until the chunk size is reached, using | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `keep_separator` | *Optional[bool]* | :heavy_minus_sign: | Whether to keep the separator in the resulting chunks | -| `mode` | [Optional[shared.DestinationWeaviateSchemasProcessingMode]](../../models/shared/destinationweaviateschemasprocessingmode.md) | :heavy_minus_sign: | N/A | +| `mode` | [Optional[models.DestinationWeaviateSchemasProcessingMode]](../models/destinationweaviateschemasprocessingmode.md) | :heavy_minus_sign: | N/A | | `separators` | List[*str*] | :heavy_minus_sign: | List of separator strings to split text fields by. The separator itself needs to be wrapped in double quotes, e.g. to split by the dot character, use ".". To split by a newline, use "\n". | \ No newline at end of file diff --git a/docs/models/destinationweaviatecohere.md b/docs/models/destinationweaviatecohere.md new file mode 100644 index 00000000..c5d38afa --- /dev/null +++ b/docs/models/destinationweaviatecohere.md @@ -0,0 +1,11 @@ +# DestinationWeaviateCohere + +Use the Cohere API to embed text. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `cohere_key` | *str* | :heavy_check_mark: | N/A | +| `mode` | [Optional[models.DestinationWeaviateSchemasEmbeddingEmbeddingMode]](../models/destinationweaviateschemasembeddingembeddingmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/destinationweaviateembedding.md b/docs/models/destinationweaviateembedding.md new file mode 100644 index 00000000..e720b843 --- /dev/null +++ b/docs/models/destinationweaviateembedding.md @@ -0,0 +1,49 @@ +# DestinationWeaviateEmbedding + +Embedding configuration + + +## Supported Types + +### NoExternalEmbedding + +```python +destinationWeaviateEmbedding: models.NoExternalEmbedding = /* values here */ +``` + +### DestinationWeaviateAzureOpenAI + +```python +destinationWeaviateEmbedding: models.DestinationWeaviateAzureOpenAI = /* values here */ +``` + +### DestinationWeaviateOpenAI + +```python +destinationWeaviateEmbedding: models.DestinationWeaviateOpenAI = /* values here */ +``` + +### DestinationWeaviateCohere + +```python +destinationWeaviateEmbedding: models.DestinationWeaviateCohere = /* values here */ +``` + +### FromField + +```python +destinationWeaviateEmbedding: models.FromField = /* values here */ +``` + +### DestinationWeaviateFake + +```python +destinationWeaviateEmbedding: models.DestinationWeaviateFake = /* values here */ +``` + +### DestinationWeaviateOpenAICompatible + +```python +destinationWeaviateEmbedding: models.DestinationWeaviateOpenAICompatible = /* values here */ +``` + diff --git a/docs/models/destinationweaviatefake.md b/docs/models/destinationweaviatefake.md new file mode 100644 index 00000000..2c9e360b --- /dev/null +++ b/docs/models/destinationweaviatefake.md @@ -0,0 +1,10 @@ +# DestinationWeaviateFake + +Use a fake embedding made out of random vectors with 1536 embedding dimensions. This is useful for testing the data pipeline without incurring any costs. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `mode` | [Optional[models.DestinationWeaviateSchemasEmbeddingEmbedding6Mode]](../models/destinationweaviateschemasembeddingembedding6mode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationweaviatefieldnamemappingconfigmodel.md b/docs/models/destinationweaviatefieldnamemappingconfigmodel.md similarity index 100% rename from docs/models/shared/destinationweaviatefieldnamemappingconfigmodel.md rename to docs/models/destinationweaviatefieldnamemappingconfigmodel.md diff --git a/docs/models/destinationweaviateindexing.md b/docs/models/destinationweaviateindexing.md new file mode 100644 index 00000000..4ac4bab7 --- /dev/null +++ b/docs/models/destinationweaviateindexing.md @@ -0,0 +1,16 @@ +# DestinationWeaviateIndexing + +Indexing configuration + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `auth` | [Union[models.DestinationWeaviateAPIToken, models.DestinationWeaviateUsernamePassword, models.NoAuthentication]](../models/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[[models.Header](../models/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[models.DefaultVectorizer]](../models/defaultvectorizer.md) | :heavy_minus_sign: | The vectorizer to use if new classes need to be created | | +| `tenant_id` | *Optional[str]* | :heavy_minus_sign: | The tenant ID to use for multi tenancy | | +| `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/destinationweaviatelanguage.md b/docs/models/destinationweaviatelanguage.md similarity index 100% rename from docs/models/shared/destinationweaviatelanguage.md rename to docs/models/destinationweaviatelanguage.md diff --git a/docs/models/shared/destinationweaviatemode.md b/docs/models/destinationweaviatemode.md similarity index 100% rename from docs/models/shared/destinationweaviatemode.md rename to docs/models/destinationweaviatemode.md diff --git a/docs/models/destinationweaviateopenai.md b/docs/models/destinationweaviateopenai.md new file mode 100644 index 00000000..494d5203 --- /dev/null +++ b/docs/models/destinationweaviateopenai.md @@ -0,0 +1,11 @@ +# DestinationWeaviateOpenAI + +Use the OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `openai_key` | *str* | :heavy_check_mark: | N/A | +| `mode` | [Optional[models.DestinationWeaviateSchemasEmbeddingMode]](../models/destinationweaviateschemasembeddingmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/destinationweaviateopenaicompatible.md b/docs/models/destinationweaviateopenaicompatible.md new file mode 100644 index 00000000..dc142b7b --- /dev/null +++ b/docs/models/destinationweaviateopenaicompatible.md @@ -0,0 +1,14 @@ +# DestinationWeaviateOpenAICompatible + +Use a service that's compatible with the OpenAI API to embed text. + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `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[models.DestinationWeaviateSchemasEmbeddingEmbedding7Mode]](../models/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/destinationweaviateprocessingconfigmodel.md similarity index 98% rename from docs/models/shared/destinationweaviateprocessingconfigmodel.md rename to docs/models/destinationweaviateprocessingconfigmodel.md index 2450c349..635d6726 100644 --- a/docs/models/shared/destinationweaviateprocessingconfigmodel.md +++ b/docs/models/destinationweaviateprocessingconfigmodel.md @@ -7,7 +7,7 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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. | | +| `field_name_mappings` | List[[models.DestinationWeaviateFieldNameMappingConfigModel](../models/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 | -| `text_splitter` | [Optional[Union[shared.DestinationWeaviateBySeparator, shared.DestinationWeaviateByMarkdownHeader, shared.DestinationWeaviateByProgrammingLanguage]]](../../models/shared/destinationweaviatetextsplitter.md) | :heavy_minus_sign: | Split text fields into chunks based on the specified method. | | \ No newline at end of file +| `text_splitter` | [Optional[Union[models.DestinationWeaviateBySeparator, models.DestinationWeaviateByMarkdownHeader, models.DestinationWeaviateByProgrammingLanguage]]](../models/destinationweaviatetextsplitter.md) | :heavy_minus_sign: | Split text fields into chunks based on the specified method. | | \ No newline at end of file diff --git a/docs/models/shared/destinationweaviateschemasembeddingembedding5mode.md b/docs/models/destinationweaviateschemasembeddingembedding5mode.md similarity index 100% rename from docs/models/shared/destinationweaviateschemasembeddingembedding5mode.md rename to docs/models/destinationweaviateschemasembeddingembedding5mode.md diff --git a/docs/models/shared/destinationweaviateschemasembeddingembedding6mode.md b/docs/models/destinationweaviateschemasembeddingembedding6mode.md similarity index 100% rename from docs/models/shared/destinationweaviateschemasembeddingembedding6mode.md rename to docs/models/destinationweaviateschemasembeddingembedding6mode.md diff --git a/docs/models/shared/destinationweaviateschemasembeddingembedding7mode.md b/docs/models/destinationweaviateschemasembeddingembedding7mode.md similarity index 100% rename from docs/models/shared/destinationweaviateschemasembeddingembedding7mode.md rename to docs/models/destinationweaviateschemasembeddingembedding7mode.md diff --git a/docs/models/shared/destinationweaviateschemasembeddingembeddingmode.md b/docs/models/destinationweaviateschemasembeddingembeddingmode.md similarity index 100% rename from docs/models/shared/destinationweaviateschemasembeddingembeddingmode.md rename to docs/models/destinationweaviateschemasembeddingembeddingmode.md diff --git a/docs/models/shared/destinationweaviateschemasembeddingmode.md b/docs/models/destinationweaviateschemasembeddingmode.md similarity index 100% rename from docs/models/shared/destinationweaviateschemasembeddingmode.md rename to docs/models/destinationweaviateschemasembeddingmode.md diff --git a/docs/models/shared/destinationweaviateschemasindexingauthauthenticationmode.md b/docs/models/destinationweaviateschemasindexingauthauthenticationmode.md similarity index 100% rename from docs/models/shared/destinationweaviateschemasindexingauthauthenticationmode.md rename to docs/models/destinationweaviateschemasindexingauthauthenticationmode.md diff --git a/docs/models/shared/destinationweaviateschemasindexingauthmode.md b/docs/models/destinationweaviateschemasindexingauthmode.md similarity index 100% rename from docs/models/shared/destinationweaviateschemasindexingauthmode.md rename to docs/models/destinationweaviateschemasindexingauthmode.md diff --git a/docs/models/shared/destinationweaviateschemasindexingmode.md b/docs/models/destinationweaviateschemasindexingmode.md similarity index 100% rename from docs/models/shared/destinationweaviateschemasindexingmode.md rename to docs/models/destinationweaviateschemasindexingmode.md diff --git a/docs/models/shared/destinationweaviateschemasmode.md b/docs/models/destinationweaviateschemasmode.md similarity index 100% rename from docs/models/shared/destinationweaviateschemasmode.md rename to docs/models/destinationweaviateschemasmode.md diff --git a/docs/models/shared/destinationweaviateschemasprocessingmode.md b/docs/models/destinationweaviateschemasprocessingmode.md similarity index 100% rename from docs/models/shared/destinationweaviateschemasprocessingmode.md rename to docs/models/destinationweaviateschemasprocessingmode.md diff --git a/docs/models/shared/destinationweaviateschemasprocessingtextsplittermode.md b/docs/models/destinationweaviateschemasprocessingtextsplittermode.md similarity index 100% rename from docs/models/shared/destinationweaviateschemasprocessingtextsplittermode.md rename to docs/models/destinationweaviateschemasprocessingtextsplittermode.md diff --git a/docs/models/shared/destinationweaviateschemasprocessingtextsplittertextsplittermode.md b/docs/models/destinationweaviateschemasprocessingtextsplittertextsplittermode.md similarity index 100% rename from docs/models/shared/destinationweaviateschemasprocessingtextsplittertextsplittermode.md rename to docs/models/destinationweaviateschemasprocessingtextsplittertextsplittermode.md diff --git a/docs/models/destinationweaviatetextsplitter.md b/docs/models/destinationweaviatetextsplitter.md new file mode 100644 index 00000000..04862cde --- /dev/null +++ b/docs/models/destinationweaviatetextsplitter.md @@ -0,0 +1,25 @@ +# DestinationWeaviateTextSplitter + +Split text fields into chunks based on the specified method. + + +## Supported Types + +### DestinationWeaviateBySeparator + +```python +destinationWeaviateTextSplitter: models.DestinationWeaviateBySeparator = /* values here */ +``` + +### DestinationWeaviateByMarkdownHeader + +```python +destinationWeaviateTextSplitter: models.DestinationWeaviateByMarkdownHeader = /* values here */ +``` + +### DestinationWeaviateByProgrammingLanguage + +```python +destinationWeaviateTextSplitter: models.DestinationWeaviateByProgrammingLanguage = /* values here */ +``` + diff --git a/docs/models/destinationweaviateusernamepassword.md b/docs/models/destinationweaviateusernamepassword.md new file mode 100644 index 00000000..809de65e --- /dev/null +++ b/docs/models/destinationweaviateusernamepassword.md @@ -0,0 +1,12 @@ +# DestinationWeaviateUsernamePassword + +Authenticate using username and password (suitable for self-managed Weaviate clusters) + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `password` | *str* | :heavy_check_mark: | Password for the Weaviate cluster | +| `username` | *str* | :heavy_check_mark: | Username for the Weaviate cluster | +| `mode` | [Optional[models.DestinationWeaviateSchemasIndexingAuthMode]](../models/destinationweaviateschemasindexingauthmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/detailtype.md b/docs/models/detailtype.md similarity index 100% rename from docs/models/shared/detailtype.md rename to docs/models/detailtype.md diff --git a/docs/models/detectchangeswithxminsystemcolumn.md b/docs/models/detectchangeswithxminsystemcolumn.md new file mode 100644 index 00000000..29f87320 --- /dev/null +++ b/docs/models/detectchangeswithxminsystemcolumn.md @@ -0,0 +1,10 @@ +# DetectChangesWithXminSystemColumn + +Recommended - Incrementally reads new inserts and updates via Postgres Xmin system column. Only recommended for tables up to 500GB. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `method` | [models.SourcePostgresSchemasMethod](../models/sourcepostgresschemasmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/devnull.md b/docs/models/devnull.md similarity index 100% rename from docs/models/shared/devnull.md rename to docs/models/devnull.md diff --git a/docs/models/shared/dimension.md b/docs/models/dimension.md similarity index 100% rename from docs/models/shared/dimension.md rename to docs/models/dimension.md diff --git a/docs/models/dimensionsfilter.md b/docs/models/dimensionsfilter.md new file mode 100644 index 00000000..62005abd --- /dev/null +++ b/docs/models/dimensionsfilter.md @@ -0,0 +1,31 @@ +# DimensionsFilter + +Dimensions filter + + +## Supported Types + +### AndGroup + +```python +dimensionsFilter: models.AndGroup = /* values here */ +``` + +### OrGroup + +```python +dimensionsFilter: models.OrGroup = /* values here */ +``` + +### NotExpression + +```python +dimensionsFilter: models.NotExpression = /* values here */ +``` + +### Filter + +```python +dimensionsFilter: models.Filter = /* values here */ +``` + diff --git a/docs/models/disable.md b/docs/models/disable.md new file mode 100644 index 00000000..6d743fda --- /dev/null +++ b/docs/models/disable.md @@ -0,0 +1,10 @@ +# Disable + +Disable SSL. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | +| `mode` | [Optional[models.Mode]](../models/mode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/disabled.md b/docs/models/disabled.md new file mode 100644 index 00000000..f5a60c63 --- /dev/null +++ b/docs/models/disabled.md @@ -0,0 +1,8 @@ +# Disabled + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `deletion_mode` | [models.SourceFaunaDeletionMode](../models/sourcefaunadeletionmode.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/distancemetric.md b/docs/models/distancemetric.md similarity index 100% rename from docs/models/shared/distancemetric.md rename to docs/models/distancemetric.md diff --git a/docs/models/shared/dixa.md b/docs/models/dixa.md similarity index 100% rename from docs/models/shared/dixa.md rename to docs/models/dixa.md diff --git a/docs/models/shared/docarrayhnswsearch.md b/docs/models/docarrayhnswsearch.md similarity index 95% rename from docs/models/shared/docarrayhnswsearch.md rename to docs/models/docarrayhnswsearch.md index 0a252022..c66d5252 100644 --- a/docs/models/shared/docarrayhnswsearch.md +++ b/docs/models/docarrayhnswsearch.md @@ -8,4 +8,4 @@ DocArrayHnswSearch is a lightweight Document Index implementation provided by Do | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `destination_path` | *str* | :heavy_check_mark: | Path to the directory where hnswlib and meta data files will be written. The files will be placed inside that local mount. All files in the specified destination directory will be deleted on each run. | /local/my_hnswlib_index | -| `mode` | [Optional[shared.DestinationLangchainSchemasIndexingIndexingMode]](../../models/shared/destinationlangchainschemasindexingindexingmode.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `mode` | [Optional[models.DestinationLangchainSchemasIndexingIndexingMode]](../models/destinationlangchainschemasindexingindexingmode.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/dockerhub.md b/docs/models/dockerhub.md similarity index 100% rename from docs/models/shared/dockerhub.md rename to docs/models/dockerhub.md diff --git a/docs/models/shared/documentfiletypeformatexperimental.md b/docs/models/documentfiletypeformatexperimental.md similarity index 95% rename from docs/models/shared/documentfiletypeformatexperimental.md rename to docs/models/documentfiletypeformatexperimental.md index 5866ad11..386871fc 100644 --- a/docs/models/shared/documentfiletypeformatexperimental.md +++ b/docs/models/documentfiletypeformatexperimental.md @@ -7,7 +7,7 @@ Extract text from document formats (.pdf, .docx, .md, .pptx) and emit as one rec | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `filetype` | [Optional[shared.SourceAzureBlobStorageSchemasStreamsFormatFiletype]](../../models/shared/sourceazureblobstorageschemasstreamsformatfiletype.md) | :heavy_minus_sign: | N/A | -| `processing` | [Optional[Union[shared.Local]]](../../models/shared/processing.md) | :heavy_minus_sign: | Processing configuration | +| `filetype` | [Optional[models.SourceAzureBlobStorageSchemasStreamsFormatFiletype]](../models/sourceazureblobstorageschemasstreamsformatfiletype.md) | :heavy_minus_sign: | N/A | +| `processing` | [Optional[Union[models.Local]]](../models/processing.md) | :heavy_minus_sign: | Processing configuration | | `skip_unprocessable_files` | *Optional[bool]* | :heavy_minus_sign: | If true, skip files that cannot be parsed and pass the error message along as the _ab_source_file_parse_error field. If false, fail the sync. | -| `strategy` | [Optional[shared.ParsingStrategy]](../../models/shared/parsingstrategy.md) | :heavy_minus_sign: | The strategy used to parse documents. `fast` extracts text directly from the document which doesn't work for all files. `ocr_only` is more reliable, but slower. `hi_res` is the most reliable, but requires an API key and a hosted instance of unstructured and can't be used with local mode. See the unstructured.io documentation for more details: https://unstructured-io.github.io/unstructured/core/partition.html#partition-pdf | \ No newline at end of file +| `strategy` | [Optional[models.ParsingStrategy]](../models/parsingstrategy.md) | :heavy_minus_sign: | The strategy used to parse documents. `fast` extracts text directly from the document which doesn't work for all files. `ocr_only` is more reliable, but slower. `hi_res` is the most reliable, but requires an API key and a hosted instance of unstructured and can't be used with local mode. See the unstructured.io documentation for more details: https://unstructured-io.github.io/unstructured/core/partition.html#partition-pdf | \ No newline at end of file diff --git a/docs/models/doublevalue.md b/docs/models/doublevalue.md new file mode 100644 index 00000000..6b20b913 --- /dev/null +++ b/docs/models/doublevalue.md @@ -0,0 +1,9 @@ +# DoubleValue + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `value` | *float* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPIValueType](../models/sourcegoogleanalyticsdataapivaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/dremio.md b/docs/models/dremio.md similarity index 100% rename from docs/models/shared/dremio.md rename to docs/models/dremio.md diff --git a/docs/models/shared/duckdb.md b/docs/models/duckdb.md similarity index 100% rename from docs/models/shared/duckdb.md rename to docs/models/duckdb.md diff --git a/docs/models/shared/dynamodb.md b/docs/models/dynamodb.md similarity index 100% rename from docs/models/shared/dynamodb.md rename to docs/models/dynamodb.md diff --git a/docs/models/shared/dynamodbregion.md b/docs/models/dynamodbregion.md similarity index 100% rename from docs/models/shared/dynamodbregion.md rename to docs/models/dynamodbregion.md diff --git a/docs/models/shared/e2etestcloud.md b/docs/models/e2etestcloud.md similarity index 100% rename from docs/models/shared/e2etestcloud.md rename to docs/models/e2etestcloud.md diff --git a/docs/models/shared/elasticsearch.md b/docs/models/elasticsearch.md similarity index 100% rename from docs/models/shared/elasticsearch.md rename to docs/models/elasticsearch.md diff --git a/docs/models/shared/emailoctopus.md b/docs/models/emailoctopus.md similarity index 100% rename from docs/models/shared/emailoctopus.md rename to docs/models/emailoctopus.md diff --git a/docs/models/embedding.md b/docs/models/embedding.md new file mode 100644 index 00000000..8123ed4d --- /dev/null +++ b/docs/models/embedding.md @@ -0,0 +1,37 @@ +# Embedding + +Embedding configuration + + +## Supported Types + +### OpenAI + +```python +embedding: models.OpenAI = /* values here */ +``` + +### Cohere + +```python +embedding: models.Cohere = /* values here */ +``` + +### Fake + +```python +embedding: models.Fake = /* values here */ +``` + +### AzureOpenAI + +```python +embedding: models.AzureOpenAI = /* values here */ +``` + +### OpenAICompatible + +```python +embedding: models.OpenAICompatible = /* values here */ +``` + diff --git a/docs/models/enabled.md b/docs/models/enabled.md new file mode 100644 index 00000000..07a0b05c --- /dev/null +++ b/docs/models/enabled.md @@ -0,0 +1,9 @@ +# Enabled + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `column` | *Optional[str]* | :heavy_minus_sign: | Name of the "deleted at" column. | +| `deletion_mode` | [models.SourceFaunaSchemasDeletionMode](../models/sourcefaunaschemasdeletionmode.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/encryptedtrustservercertificate.md b/docs/models/encryptedtrustservercertificate.md new file mode 100644 index 00000000..9d21029e --- /dev/null +++ b/docs/models/encryptedtrustservercertificate.md @@ -0,0 +1,10 @@ +# EncryptedTrustServerCertificate + +Use the certificate provided by the server without verification. (For testing purposes only!) + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `ssl_method` | [Optional[models.DestinationMssqlSslMethod]](../models/destinationmssqlsslmethod.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/encryptedverifycertificate.md b/docs/models/encryptedverifycertificate.md similarity index 93% rename from docs/models/shared/encryptedverifycertificate.md rename to docs/models/encryptedverifycertificate.md index 9c1dd474..afd3f3e2 100644 --- a/docs/models/shared/encryptedverifycertificate.md +++ b/docs/models/encryptedverifycertificate.md @@ -8,4 +8,4 @@ Verify and use the certificate provided by the server. | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | `host_name_in_certificate` | *Optional[str]* | :heavy_minus_sign: | Specifies the host name of the server. The value of this property must match the subject property of the certificate. | -| `ssl_method` | [Optional[shared.DestinationMssqlSchemasSslMethod]](../../models/shared/destinationmssqlschemassslmethod.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `ssl_method` | [Optional[models.DestinationMssqlSchemasSslMethod]](../models/destinationmssqlschemassslmethod.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/encryption.md b/docs/models/encryption.md new file mode 100644 index 00000000..160221fb --- /dev/null +++ b/docs/models/encryption.md @@ -0,0 +1,19 @@ +# Encryption + +The encryption method with is used when communicating with the database. + + +## Supported Types + +### NativeNetworkEncryptionNNE + +```python +encryption: models.NativeNetworkEncryptionNNE = /* values here */ +``` + +### TLSEncryptedVerifyCertificate + +```python +encryption: models.TLSEncryptedVerifyCertificate = /* values here */ +``` + diff --git a/docs/models/shared/encryptionalgorithm.md b/docs/models/encryptionalgorithm.md similarity index 100% rename from docs/models/shared/encryptionalgorithm.md rename to docs/models/encryptionalgorithm.md diff --git a/docs/models/shared/encryptionmethod.md b/docs/models/encryptionmethod.md similarity index 100% rename from docs/models/shared/encryptionmethod.md rename to docs/models/encryptionmethod.md diff --git a/docs/models/shared/encryptiontype.md b/docs/models/encryptiontype.md similarity index 100% rename from docs/models/shared/encryptiontype.md rename to docs/models/encryptiontype.md diff --git a/docs/models/shared/engagementwindowdays.md b/docs/models/engagementwindowdays.md similarity index 100% rename from docs/models/shared/engagementwindowdays.md rename to docs/models/engagementwindowdays.md diff --git a/docs/models/shared/environment.md b/docs/models/environment.md similarity index 100% rename from docs/models/shared/environment.md rename to docs/models/environment.md diff --git a/docs/models/eubasedaccount.md b/docs/models/eubasedaccount.md new file mode 100644 index 00000000..c9357614 --- /dev/null +++ b/docs/models/eubasedaccount.md @@ -0,0 +1,8 @@ +# EUBasedAccount + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | +| `url_base` | [Optional[models.URLBase]](../models/urlbase.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/exchangerates.md b/docs/models/exchangerates.md similarity index 100% rename from docs/models/shared/exchangerates.md rename to docs/models/exchangerates.md diff --git a/docs/models/shared/expression.md b/docs/models/expression.md similarity index 75% rename from docs/models/shared/expression.md rename to docs/models/expression.md index e6658a96..ddad33b2 100644 --- a/docs/models/shared/expression.md +++ b/docs/models/expression.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `field_name` | *str* | :heavy_check_mark: | N/A | -| `filter_` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayStringFilter, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayInListFilter, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayNumericFilter, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayBetweenFilter]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1filter.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `field_name` | *str* | :heavy_check_mark: | N/A | +| `filter_` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayStringFilter, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayInListFilter, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayNumericFilter, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayBetweenFilter]](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1filter.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/facebookmarketing.md b/docs/models/facebookmarketing.md similarity index 100% rename from docs/models/shared/facebookmarketing.md rename to docs/models/facebookmarketing.md diff --git a/docs/models/fake.md b/docs/models/fake.md new file mode 100644 index 00000000..393b164c --- /dev/null +++ b/docs/models/fake.md @@ -0,0 +1,10 @@ +# Fake + +Use a fake embedding made out of random vectors with 1536 embedding dimensions. This is useful for testing the data pipeline without incurring any costs. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `mode` | [Optional[models.DestinationAstraSchemasMode]](../models/destinationastraschemasmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/faker.md b/docs/models/faker.md similarity index 100% rename from docs/models/shared/faker.md rename to docs/models/faker.md diff --git a/docs/models/shared/fauna.md b/docs/models/fauna.md similarity index 100% rename from docs/models/shared/fauna.md rename to docs/models/fauna.md diff --git a/docs/models/shared/fieldnamemappingconfigmodel.md b/docs/models/fieldnamemappingconfigmodel.md similarity index 100% rename from docs/models/shared/fieldnamemappingconfigmodel.md rename to docs/models/fieldnamemappingconfigmodel.md diff --git a/docs/models/shared/file.md b/docs/models/file.md similarity index 100% rename from docs/models/shared/file.md rename to docs/models/file.md diff --git a/docs/models/shared/filebasedstreamconfig.md b/docs/models/filebasedstreamconfig.md similarity index 96% rename from docs/models/shared/filebasedstreamconfig.md rename to docs/models/filebasedstreamconfig.md index 2f15a413..c9d5ea0f 100644 --- a/docs/models/shared/filebasedstreamconfig.md +++ b/docs/models/filebasedstreamconfig.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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. | +| `format` | [Union[models.AvroFormat, models.CSVFormat, models.JsonlFormat, models.ParquetFormat, models.DocumentFileTypeFormatExperimental]](../models/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. | @@ -13,4 +13,4 @@ | `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. | | `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 +| `validation_policy` | [Optional[models.ValidationPolicy]](../models/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/fileformat.md b/docs/models/fileformat.md similarity index 100% rename from docs/models/shared/fileformat.md rename to docs/models/fileformat.md diff --git a/docs/models/shared/filetype.md b/docs/models/filetype.md similarity index 100% rename from docs/models/shared/filetype.md rename to docs/models/filetype.md diff --git a/docs/models/filter_.md b/docs/models/filter_.md new file mode 100644 index 00000000..ced8bbac --- /dev/null +++ b/docs/models/filter_.md @@ -0,0 +1,12 @@ +# Filter + +A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `field_name` | *str* | :heavy_check_mark: | N/A | +| `filter_` | [Union[models.StringFilter, models.InListFilter, models.NumericFilter, models.BetweenFilter]](../models/sourcegoogleanalyticsdataapischemasfilter.md) | :heavy_check_mark: | N/A | +| `filter_type` | [Optional[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayFilterType]](../models/sourcegoogleanalyticsdataapischemascustomreportsarrayfiltertype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/filtername.md b/docs/models/filtername.md similarity index 100% rename from docs/models/shared/filtername.md rename to docs/models/filtername.md diff --git a/docs/models/shared/filtertype.md b/docs/models/filtertype.md similarity index 100% rename from docs/models/shared/filtertype.md rename to docs/models/filtertype.md diff --git a/docs/models/shared/firebolt.md b/docs/models/firebolt.md similarity index 100% rename from docs/models/shared/firebolt.md rename to docs/models/firebolt.md diff --git a/docs/models/shared/firestore.md b/docs/models/firestore.md similarity index 100% rename from docs/models/shared/firestore.md rename to docs/models/firestore.md diff --git a/docs/models/shared/flattening.md b/docs/models/flattening.md similarity index 100% rename from docs/models/shared/flattening.md rename to docs/models/flattening.md diff --git a/docs/models/format.md b/docs/models/format.md new file mode 100644 index 00000000..3d16ca67 --- /dev/null +++ b/docs/models/format.md @@ -0,0 +1,37 @@ +# Format + +The configuration options that are used to alter how to read incoming files that deviate from the standard formatting. + + +## Supported Types + +### AvroFormat + +```python +format: models.AvroFormat = /* values here */ +``` + +### CSVFormat + +```python +format: models.CSVFormat = /* values here */ +``` + +### JsonlFormat + +```python +format: models.JsonlFormat = /* values here */ +``` + +### ParquetFormat + +```python +format: models.ParquetFormat = /* values here */ +``` + +### DocumentFileTypeFormatExperimental + +```python +format: models.DocumentFileTypeFormatExperimental = /* values here */ +``` + diff --git a/docs/models/shared/formattype.md b/docs/models/formattype.md similarity index 100% rename from docs/models/shared/formattype.md rename to docs/models/formattype.md diff --git a/docs/models/shared/formattypewildcard.md b/docs/models/formattypewildcard.md similarity index 100% rename from docs/models/shared/formattypewildcard.md rename to docs/models/formattypewildcard.md diff --git a/docs/models/shared/freshcaller.md b/docs/models/freshcaller.md similarity index 100% rename from docs/models/shared/freshcaller.md rename to docs/models/freshcaller.md diff --git a/docs/models/shared/freshdesk.md b/docs/models/freshdesk.md similarity index 100% rename from docs/models/shared/freshdesk.md rename to docs/models/freshdesk.md diff --git a/docs/models/shared/freshsales.md b/docs/models/freshsales.md similarity index 100% rename from docs/models/shared/freshsales.md rename to docs/models/freshsales.md diff --git a/docs/models/fromcsv.md b/docs/models/fromcsv.md new file mode 100644 index 00000000..1858758f --- /dev/null +++ b/docs/models/fromcsv.md @@ -0,0 +1,8 @@ +# FromCSV + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `header_definition_type` | [Optional[models.HeaderDefinitionType]](../models/headerdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/fromfield.md b/docs/models/fromfield.md new file mode 100644 index 00000000..37064d07 --- /dev/null +++ b/docs/models/fromfield.md @@ -0,0 +1,12 @@ +# FromField + +Use a field in the record as the embedding. This is useful if you already have an embedding for your data and want to store it in the vector store. + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `dimensions` | *int* | :heavy_check_mark: | The number of dimensions the embedding model is generating | 1536 | +| `field_name` | *str* | :heavy_check_mark: | Name of the field in the record that contains the embedding | embedding | +| `mode` | [Optional[models.DestinationWeaviateSchemasEmbeddingEmbedding5Mode]](../models/destinationweaviateschemasembeddingembedding5mode.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/fromvalue.md b/docs/models/fromvalue.md new file mode 100644 index 00000000..4af54e8e --- /dev/null +++ b/docs/models/fromvalue.md @@ -0,0 +1,17 @@ +# FromValue + + +## Supported Types + +### SourceGoogleAnalyticsDataAPIInt64Value + +```python +fromValue: models.SourceGoogleAnalyticsDataAPIInt64Value = /* values here */ +``` + +### SourceGoogleAnalyticsDataAPIDoubleValue + +```python +fromValue: models.SourceGoogleAnalyticsDataAPIDoubleValue = /* values here */ +``` + diff --git a/docs/models/shared/gainsightpx.md b/docs/models/gainsightpx.md similarity index 100% rename from docs/models/shared/gainsightpx.md rename to docs/models/gainsightpx.md diff --git a/docs/models/shared/gcs.md b/docs/models/gcs.md similarity index 100% rename from docs/models/shared/gcs.md rename to docs/models/gcs.md diff --git a/docs/models/shared/gcsbucketregion.md b/docs/models/gcsbucketregion.md similarity index 100% rename from docs/models/shared/gcsbucketregion.md rename to docs/models/gcsbucketregion.md diff --git a/docs/models/shared/gcsgooglecloudstorage.md b/docs/models/gcsgooglecloudstorage.md similarity index 98% rename from docs/models/shared/gcsgooglecloudstorage.md rename to docs/models/gcsgooglecloudstorage.md index 08143476..89a9f560 100644 --- a/docs/models/shared/gcsgooglecloudstorage.md +++ b/docs/models/gcsgooglecloudstorage.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `service_account_json` | *Optional[str]* | :heavy_minus_sign: | 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` | [shared.SourceFileStorage](../../models/shared/sourcefilestorage.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `storage` | [models.SourceFileStorage](../models/sourcefilestorage.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/gcsstaging.md b/docs/models/gcsstaging.md similarity index 96% rename from docs/models/shared/gcsstaging.md rename to docs/models/gcsstaging.md index 6933abc1..1afbe946 100644 --- a/docs/models/shared/gcsstaging.md +++ b/docs/models/gcsstaging.md @@ -7,8 +7,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `credential` | [Union[shared.DestinationBigqueryHMACKey]](../../models/shared/credential.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. | | +| `credential` | [Union[models.DestinationBigqueryHMACKey]](../models/credential.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. | | | `gcs_bucket_name` | *str* | :heavy_check_mark: | The name of the GCS bucket. Read more here. | airbyte_sync | | `gcs_bucket_path` | *str* | :heavy_check_mark: | Directory under the GCS bucket where data will be written. | data_sync/test | -| `keep_files_in_gcs_bucket` | [Optional[shared.GCSTmpFilesAfterwardProcessing]](../../models/shared/gcstmpfilesafterwardprocessing.md) | :heavy_minus_sign: | 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` | [shared.Method](../../models/shared/method.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `keep_files_in_gcs_bucket` | [Optional[models.GCSTmpFilesAfterwardProcessing]](../models/gcstmpfilesafterwardprocessing.md) | :heavy_minus_sign: | 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` | [models.Method](../models/method.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/gcstmpfilesafterwardprocessing.md b/docs/models/gcstmpfilesafterwardprocessing.md similarity index 100% rename from docs/models/shared/gcstmpfilesafterwardprocessing.md rename to docs/models/gcstmpfilesafterwardprocessing.md diff --git a/docs/models/shared/geographyenum.md b/docs/models/geographyenum.md similarity index 100% rename from docs/models/shared/geographyenum.md rename to docs/models/geographyenum.md diff --git a/docs/models/shared/geographyenumnodefault.md b/docs/models/geographyenumnodefault.md similarity index 100% rename from docs/models/shared/geographyenumnodefault.md rename to docs/models/geographyenumnodefault.md diff --git a/docs/models/shared/getlago.md b/docs/models/getlago.md similarity index 100% rename from docs/models/shared/getlago.md rename to docs/models/getlago.md diff --git a/docs/models/github.md b/docs/models/github.md new file mode 100644 index 00000000..1cbd8ae1 --- /dev/null +++ b/docs/models/github.md @@ -0,0 +1,8 @@ +# Github + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `credentials` | [Optional[models.GithubCredentials]](../models/githubcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/githubcredentials.md b/docs/models/githubcredentials.md similarity index 100% rename from docs/models/shared/githubcredentials.md rename to docs/models/githubcredentials.md diff --git a/docs/models/gitlab.md b/docs/models/gitlab.md new file mode 100644 index 00000000..9aa225e6 --- /dev/null +++ b/docs/models/gitlab.md @@ -0,0 +1,8 @@ +# Gitlab + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `credentials` | [Optional[models.GitlabCredentials]](../models/gitlabcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/gitlabcredentials.md b/docs/models/gitlabcredentials.md similarity index 100% rename from docs/models/shared/gitlabcredentials.md rename to docs/models/gitlabcredentials.md diff --git a/docs/models/shared/glassfrog.md b/docs/models/glassfrog.md similarity index 100% rename from docs/models/shared/glassfrog.md rename to docs/models/glassfrog.md diff --git a/docs/models/globalaccount.md b/docs/models/globalaccount.md new file mode 100644 index 00000000..18c08d70 --- /dev/null +++ b/docs/models/globalaccount.md @@ -0,0 +1,8 @@ +# GlobalAccount + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `url_base` | [Optional[models.SourceSurveySparrowURLBase]](../models/sourcesurveysparrowurlbase.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/gnews.md b/docs/models/gnews.md similarity index 100% rename from docs/models/shared/gnews.md rename to docs/models/gnews.md diff --git a/docs/models/googleads.md b/docs/models/googleads.md new file mode 100644 index 00000000..d37162b3 --- /dev/null +++ b/docs/models/googleads.md @@ -0,0 +1,8 @@ +# GoogleAds + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `credentials` | [Optional[models.GoogleAdsCredentials]](../models/googleadscredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/googleadscredentials.md b/docs/models/googleadscredentials.md similarity index 100% rename from docs/models/shared/googleadscredentials.md rename to docs/models/googleadscredentials.md diff --git a/docs/models/googleanalyticsdataapi.md b/docs/models/googleanalyticsdataapi.md new file mode 100644 index 00000000..d738798e --- /dev/null +++ b/docs/models/googleanalyticsdataapi.md @@ -0,0 +1,8 @@ +# GoogleAnalyticsDataAPI + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `credentials` | [Optional[models.GoogleAnalyticsDataAPICredentials]](../models/googleanalyticsdataapicredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/googleanalyticsdataapicredentials.md b/docs/models/googleanalyticsdataapicredentials.md similarity index 100% rename from docs/models/shared/googleanalyticsdataapicredentials.md rename to docs/models/googleanalyticsdataapicredentials.md diff --git a/docs/models/shared/googleanalyticsv4serviceaccountonly.md b/docs/models/googleanalyticsv4serviceaccountonly.md similarity index 100% rename from docs/models/shared/googleanalyticsv4serviceaccountonly.md rename to docs/models/googleanalyticsv4serviceaccountonly.md diff --git a/docs/models/shared/googlecredentials.md b/docs/models/googlecredentials.md similarity index 100% rename from docs/models/shared/googlecredentials.md rename to docs/models/googlecredentials.md diff --git a/docs/models/shared/googledirectory.md b/docs/models/googledirectory.md similarity index 100% rename from docs/models/shared/googledirectory.md rename to docs/models/googledirectory.md diff --git a/docs/models/googledrive.md b/docs/models/googledrive.md new file mode 100644 index 00000000..a3f2fc58 --- /dev/null +++ b/docs/models/googledrive.md @@ -0,0 +1,8 @@ +# GoogleDrive + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `credentials` | [Optional[models.GoogleDriveCredentials]](../models/googledrivecredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/googledrivecredentials.md b/docs/models/googledrivecredentials.md similarity index 100% rename from docs/models/shared/googledrivecredentials.md rename to docs/models/googledrivecredentials.md diff --git a/docs/models/shared/googlepagespeedinsights.md b/docs/models/googlepagespeedinsights.md similarity index 100% rename from docs/models/shared/googlepagespeedinsights.md rename to docs/models/googlepagespeedinsights.md diff --git a/docs/models/googlesearchconsole.md b/docs/models/googlesearchconsole.md new file mode 100644 index 00000000..406acc06 --- /dev/null +++ b/docs/models/googlesearchconsole.md @@ -0,0 +1,8 @@ +# GoogleSearchConsole + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `authorization` | [Optional[models.Authorization]](../models/authorization.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/googlesheets.md b/docs/models/googlesheets.md new file mode 100644 index 00000000..7afda30f --- /dev/null +++ b/docs/models/googlesheets.md @@ -0,0 +1,8 @@ +# GoogleSheets + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `credentials` | [Optional[models.GoogleSheetsCredentials]](../models/googlesheetscredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/googlesheetscredentials.md b/docs/models/googlesheetscredentials.md similarity index 100% rename from docs/models/shared/googlesheetscredentials.md rename to docs/models/googlesheetscredentials.md diff --git a/docs/models/shared/googlewebfonts.md b/docs/models/googlewebfonts.md similarity index 100% rename from docs/models/shared/googlewebfonts.md rename to docs/models/googlewebfonts.md diff --git a/docs/models/shared/granularity.md b/docs/models/granularity.md similarity index 100% rename from docs/models/shared/granularity.md rename to docs/models/granularity.md diff --git a/docs/models/shared/granularityforgeolocationregion.md b/docs/models/granularityforgeolocationregion.md similarity index 100% rename from docs/models/shared/granularityforgeolocationregion.md rename to docs/models/granularityforgeolocationregion.md diff --git a/docs/models/shared/granularityforperiodicreports.md b/docs/models/granularityforperiodicreports.md similarity index 100% rename from docs/models/shared/granularityforperiodicreports.md rename to docs/models/granularityforperiodicreports.md diff --git a/docs/models/shared/greenhouse.md b/docs/models/greenhouse.md similarity index 100% rename from docs/models/shared/greenhouse.md rename to docs/models/greenhouse.md diff --git a/docs/models/shared/gridly.md b/docs/models/gridly.md similarity index 100% rename from docs/models/shared/gridly.md rename to docs/models/gridly.md diff --git a/docs/models/gzip.md b/docs/models/gzip.md new file mode 100644 index 00000000..a2c7eb89 --- /dev/null +++ b/docs/models/gzip.md @@ -0,0 +1,8 @@ +# Gzip + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `compression_type` | [Optional[models.DestinationGcsCompressionType]](../models/destinationgcscompressiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/harvest.md b/docs/models/harvest.md new file mode 100644 index 00000000..2de79ed0 --- /dev/null +++ b/docs/models/harvest.md @@ -0,0 +1,8 @@ +# Harvest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `credentials` | [Optional[models.HarvestCredentials]](../models/harvestcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/harvestcredentials.md b/docs/models/harvestcredentials.md similarity index 100% rename from docs/models/shared/harvestcredentials.md rename to docs/models/harvestcredentials.md diff --git a/docs/models/shared/header.md b/docs/models/header.md similarity index 100% rename from docs/models/shared/header.md rename to docs/models/header.md diff --git a/docs/models/shared/headerdefinitiontype.md b/docs/models/headerdefinitiontype.md similarity index 100% rename from docs/models/shared/headerdefinitiontype.md rename to docs/models/headerdefinitiontype.md diff --git a/docs/models/shared/hmackey.md b/docs/models/hmackey.md similarity index 97% rename from docs/models/shared/hmackey.md rename to docs/models/hmackey.md index ace3b3af..3efe5509 100644 --- a/docs/models/shared/hmackey.md +++ b/docs/models/hmackey.md @@ -7,4 +7,4 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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 | -| `credential_type` | [Optional[shared.CredentialType]](../../models/shared/credentialtype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `credential_type` | [Optional[models.CredentialType]](../models/credentialtype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/httpspublicweb.md b/docs/models/httpspublicweb.md new file mode 100644 index 00000000..51136782 --- /dev/null +++ b/docs/models/httpspublicweb.md @@ -0,0 +1,9 @@ +# HTTPSPublicWeb + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | +| `storage` | [models.Storage](../models/storage.md) | :heavy_check_mark: | N/A | +| `user_agent` | *Optional[bool]* | :heavy_minus_sign: | Add User-Agent to request | \ No newline at end of file diff --git a/docs/models/shared/hubplanner.md b/docs/models/hubplanner.md similarity index 100% rename from docs/models/shared/hubplanner.md rename to docs/models/hubplanner.md diff --git a/docs/models/hubspot.md b/docs/models/hubspot.md new file mode 100644 index 00000000..dd789431 --- /dev/null +++ b/docs/models/hubspot.md @@ -0,0 +1,8 @@ +# Hubspot + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `credentials` | [Optional[models.HubspotCredentials]](../models/hubspotcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/hubspotcredentials.md b/docs/models/hubspotcredentials.md similarity index 100% rename from docs/models/shared/hubspotcredentials.md rename to docs/models/hubspotcredentials.md diff --git a/docs/models/iamrole.md b/docs/models/iamrole.md new file mode 100644 index 00000000..55ddd71d --- /dev/null +++ b/docs/models/iamrole.md @@ -0,0 +1,9 @@ +# IAMRole + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `role_arn` | *str* | :heavy_check_mark: | Will assume this role to write data to s3 | +| `credentials_title` | [Optional[models.CredentialsTitle]](../models/credentialstitle.md) | :heavy_minus_sign: | Name of the credentials | \ No newline at end of file diff --git a/docs/models/iamuser.md b/docs/models/iamuser.md new file mode 100644 index 00000000..649e98ef --- /dev/null +++ b/docs/models/iamuser.md @@ -0,0 +1,10 @@ +# IAMUser + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `aws_access_key_id` | *str* | :heavy_check_mark: | AWS User Access Key Id | +| `aws_secret_access_key` | *str* | :heavy_check_mark: | Secret Access Key | +| `credentials_title` | [Optional[models.DestinationAwsDatalakeCredentialsTitle]](../models/destinationawsdatalakecredentialstitle.md) | :heavy_minus_sign: | Name of the credentials | \ No newline at end of file diff --git a/docs/models/shared/in_.md b/docs/models/in_.md similarity index 100% rename from docs/models/shared/in_.md rename to docs/models/in_.md diff --git a/docs/models/shared/indexing.md b/docs/models/indexing.md similarity index 100% rename from docs/models/shared/indexing.md rename to docs/models/indexing.md diff --git a/docs/models/shared/inferencetype.md b/docs/models/inferencetype.md similarity index 100% rename from docs/models/shared/inferencetype.md rename to docs/models/inferencetype.md diff --git a/docs/models/shared/initiateoauthrequest.md b/docs/models/initiateoauthrequest.md similarity index 93% rename from docs/models/shared/initiateoauthrequest.md rename to docs/models/initiateoauthrequest.md index 954f9adf..96e8e71e 100644 --- a/docs/models/shared/initiateoauthrequest.md +++ b/docs/models/initiateoauthrequest.md @@ -8,6 +8,6 @@ POST body for initiating OAuth via the public API | 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 | | +| `source_type` | [models.OAuthActorNames](../models/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 +| `o_auth_input_configuration` | [Optional[models.OAuthInputConfiguration]](../models/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/models/inlistfilter.md b/docs/models/inlistfilter.md new file mode 100644 index 00000000..4075cb70 --- /dev/null +++ b/docs/models/inlistfilter.md @@ -0,0 +1,10 @@ +# InListFilter + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `values` | List[*str*] | :heavy_check_mark: | N/A | +| `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPIFilterName](../models/sourcegoogleanalyticsdataapifiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/insightconfig.md b/docs/models/insightconfig.md similarity index 98% rename from docs/models/shared/insightconfig.md rename to docs/models/insightconfig.md index 3b854e34..abf8e097 100644 --- a/docs/models/shared/insightconfig.md +++ b/docs/models/insightconfig.md @@ -8,13 +8,13 @@ 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 | | +| `action_breakdowns` | List[[models.ValidActionBreakdowns](../models/validactionbreakdowns.md)] | :heavy_minus_sign: | A list of chosen action_breakdowns for action_breakdowns | | +| `action_report_time` | [Optional[models.SourceFacebookMarketingActionReportTime]](../models/sourcefacebookmarketingactionreporttime.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[[models.ValidBreakdowns](../models/validbreakdowns.md)] | :heavy_minus_sign: | A list of chosen breakdowns for breakdowns | | | `end_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | The date until which you'd like to replicate data for this stream, in the format YYYY-MM-DDT00:00:00Z. All data generated between the start date and this end date will be replicated. Not setting this option will result in always syncing the latest data. | 2017-01-26T00:00:00Z | -| `fields` | List[[shared.SourceFacebookMarketingValidEnums](../../models/shared/sourcefacebookmarketingvalidenums.md)] | :heavy_minus_sign: | A list of chosen fields for fields parameter | | +| `fields` | List[[models.SourceFacebookMarketingValidEnums](../models/sourcefacebookmarketingvalidenums.md)] | :heavy_minus_sign: | A list of chosen fields for fields parameter | | | `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 | | +| `level` | [Optional[models.Level]](../models/level.md) | :heavy_minus_sign: | Chosen level for API | | | `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/insightly.md b/docs/models/insightly.md similarity index 100% rename from docs/models/shared/insightly.md rename to docs/models/insightly.md diff --git a/docs/models/shared/instagram.md b/docs/models/instagram.md similarity index 100% rename from docs/models/shared/instagram.md rename to docs/models/instagram.md diff --git a/docs/models/shared/instance.md b/docs/models/instance.md similarity index 100% rename from docs/models/shared/instance.md rename to docs/models/instance.md diff --git a/docs/models/shared/instatus.md b/docs/models/instatus.md similarity index 100% rename from docs/models/shared/instatus.md rename to docs/models/instatus.md diff --git a/docs/models/int64value.md b/docs/models/int64value.md new file mode 100644 index 00000000..ab77b593 --- /dev/null +++ b/docs/models/int64value.md @@ -0,0 +1,9 @@ +# Int64Value + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | +| `value` | *str* | :heavy_check_mark: | N/A | +| `value_type` | [models.ValueType](../models/valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/intercom.md b/docs/models/intercom.md similarity index 100% rename from docs/models/shared/intercom.md rename to docs/models/intercom.md diff --git a/docs/models/invalidcdcpositionbehavioradvanced.md b/docs/models/invalidcdcpositionbehavioradvanced.md new file mode 100644 index 00000000..ffd8d6ed --- /dev/null +++ b/docs/models/invalidcdcpositionbehavioradvanced.md @@ -0,0 +1,11 @@ +# InvalidCDCPositionBehaviorAdvanced + +Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value into the WAL. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss. + + +## Values + +| Name | Value | +| -------------- | -------------- | +| `FAIL_SYNC` | Fail sync | +| `RE_SYNC_DATA` | Re-sync data | \ No newline at end of file diff --git a/docs/models/shared/ip2whois.md b/docs/models/ip2whois.md similarity index 100% rename from docs/models/shared/ip2whois.md rename to docs/models/ip2whois.md diff --git a/docs/models/shared/issuesstreamexpandwith.md b/docs/models/issuesstreamexpandwith.md similarity index 100% rename from docs/models/shared/issuesstreamexpandwith.md rename to docs/models/issuesstreamexpandwith.md diff --git a/docs/models/shared/iterable.md b/docs/models/iterable.md similarity index 100% rename from docs/models/shared/iterable.md rename to docs/models/iterable.md diff --git a/docs/models/shared/jira.md b/docs/models/jira.md similarity index 100% rename from docs/models/shared/jira.md rename to docs/models/jira.md diff --git a/docs/models/shared/jobcreaterequest.md b/docs/models/jobcreaterequest.md similarity index 90% rename from docs/models/shared/jobcreaterequest.md rename to docs/models/jobcreaterequest.md index d032d009..9643c226 100644 --- a/docs/models/shared/jobcreaterequest.md +++ b/docs/models/jobcreaterequest.md @@ -8,4 +8,4 @@ Creates a new Job from the configuration provided in the request body. | Field | Type | Required | Description | | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | | `connection_id` | *str* | :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. | \ No newline at end of file +| `job_type` | [models.JobTypeEnum](../models/jobtypeenum.md) | :heavy_check_mark: | Enum that describes the different types of jobs that the platform runs. | \ No newline at end of file diff --git a/docs/models/shared/jobresponse.md b/docs/models/jobresponse.md similarity index 92% rename from docs/models/shared/jobresponse.md rename to docs/models/jobresponse.md index d024f76b..91a1f0b6 100644 --- a/docs/models/shared/jobresponse.md +++ b/docs/models/jobresponse.md @@ -9,9 +9,9 @@ Provides details of a single job. | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | | `connection_id` | *str* | :heavy_check_mark: | N/A | | `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. | +| `job_type` | [models.JobTypeEnum](../models/jobtypeenum.md) | :heavy_check_mark: | Enum that describes the different types of jobs that the platform runs. | | `start_time` | *str* | :heavy_check_mark: | N/A | -| `status` | [shared.JobStatusEnum](../../models/shared/jobstatusenum.md) | :heavy_check_mark: | N/A | +| `status` | [models.JobStatusEnum](../models/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 | diff --git a/docs/models/jobsresponse.md b/docs/models/jobsresponse.md new file mode 100644 index 00000000..1a1d4067 --- /dev/null +++ b/docs/models/jobsresponse.md @@ -0,0 +1,10 @@ +# JobsResponse + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | +| `data` | List[[models.JobResponse](../models/jobresponse.md)] | :heavy_check_mark: | N/A | +| `next` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `previous` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/jobstatusenum.md b/docs/models/jobstatusenum.md similarity index 100% rename from docs/models/shared/jobstatusenum.md rename to docs/models/jobstatusenum.md diff --git a/docs/models/shared/jobtypeenum.md b/docs/models/jobtypeenum.md similarity index 100% rename from docs/models/shared/jobtypeenum.md rename to docs/models/jobtypeenum.md diff --git a/docs/models/shared/jsonl.md b/docs/models/jsonl.md similarity index 94% rename from docs/models/shared/jsonl.md rename to docs/models/jsonl.md index 63e1cbf3..0bdb858d 100644 --- a/docs/models/shared/jsonl.md +++ b/docs/models/jsonl.md @@ -8,6 +8,6 @@ This connector uses PyArrow documentation for details | ignore | \ No newline at end of file +| `unexpected_field_behavior` | [Optional[models.UnexpectedFieldBehavior]](../models/unexpectedfieldbehavior.md) | :heavy_minus_sign: | How JSON fields outside of explicit_schema (if given) are treated. Check PyArrow documentation for details | ignore | \ No newline at end of file diff --git a/docs/models/jsonlformat.md b/docs/models/jsonlformat.md new file mode 100644 index 00000000..8c434236 --- /dev/null +++ b/docs/models/jsonlformat.md @@ -0,0 +1,8 @@ +# JsonlFormat + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `filetype` | [Optional[models.SourceAzureBlobStorageSchemasFiletype]](../models/sourceazureblobstorageschemasfiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/jsonlinesnewlinedelimitedjson.md b/docs/models/jsonlinesnewlinedelimitedjson.md new file mode 100644 index 00000000..a9a421ca --- /dev/null +++ b/docs/models/jsonlinesnewlinedelimitedjson.md @@ -0,0 +1,9 @@ +# JSONLinesNewlineDelimitedJSON + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `compression_codec` | [Optional[models.CompressionCodecOptional]](../models/compressioncodecoptional.md) | :heavy_minus_sign: | The compression algorithm used to compress data. | +| `format_type` | [Optional[models.FormatTypeWildcard]](../models/formattypewildcard.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/k6cloud.md b/docs/models/k6cloud.md similarity index 100% rename from docs/models/shared/k6cloud.md rename to docs/models/k6cloud.md diff --git a/docs/models/shared/keypairauthentication.md b/docs/models/keypairauthentication.md similarity index 94% rename from docs/models/shared/keypairauthentication.md rename to docs/models/keypairauthentication.md index d118fc22..22eac980 100644 --- a/docs/models/shared/keypairauthentication.md +++ b/docs/models/keypairauthentication.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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.DestinationSnowflakeSchemasCredentialsAuthType]](../../models/shared/destinationsnowflakeschemascredentialsauthtype.md) | :heavy_minus_sign: | N/A | +| `auth_type` | [Optional[models.DestinationSnowflakeSchemasCredentialsAuthType]](../models/destinationsnowflakeschemascredentialsauthtype.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/klarna.md b/docs/models/klarna.md similarity index 100% rename from docs/models/shared/klarna.md rename to docs/models/klarna.md diff --git a/docs/models/shared/klaviyo.md b/docs/models/klaviyo.md similarity index 100% rename from docs/models/shared/klaviyo.md rename to docs/models/klaviyo.md diff --git a/docs/models/shared/kyve.md b/docs/models/kyve.md similarity index 100% rename from docs/models/shared/kyve.md rename to docs/models/kyve.md diff --git a/docs/models/shared/langchain.md b/docs/models/langchain.md similarity index 100% rename from docs/models/shared/langchain.md rename to docs/models/langchain.md diff --git a/docs/models/shared/language.md b/docs/models/language.md similarity index 100% rename from docs/models/shared/language.md rename to docs/models/language.md diff --git a/docs/models/shared/launchdarkly.md b/docs/models/launchdarkly.md similarity index 100% rename from docs/models/shared/launchdarkly.md rename to docs/models/launchdarkly.md diff --git a/docs/models/shared/lemlist.md b/docs/models/lemlist.md similarity index 100% rename from docs/models/shared/lemlist.md rename to docs/models/lemlist.md diff --git a/docs/models/shared/level.md b/docs/models/level.md similarity index 100% rename from docs/models/shared/level.md rename to docs/models/level.md diff --git a/docs/models/leverhiring.md b/docs/models/leverhiring.md new file mode 100644 index 00000000..32ca6d9b --- /dev/null +++ b/docs/models/leverhiring.md @@ -0,0 +1,8 @@ +# LeverHiring + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `credentials` | [Optional[models.LeverHiringCredentials]](../models/leverhiringcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/leverhiringcredentials.md b/docs/models/leverhiringcredentials.md similarity index 100% rename from docs/models/shared/leverhiringcredentials.md rename to docs/models/leverhiringcredentials.md diff --git a/docs/models/linkedinads.md b/docs/models/linkedinads.md new file mode 100644 index 00000000..ff4e4123 --- /dev/null +++ b/docs/models/linkedinads.md @@ -0,0 +1,8 @@ +# LinkedinAds + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `credentials` | [Optional[models.LinkedinAdsCredentials]](../models/linkedinadscredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/linkedinadscredentials.md b/docs/models/linkedinadscredentials.md similarity index 100% rename from docs/models/shared/linkedinadscredentials.md rename to docs/models/linkedinadscredentials.md diff --git a/docs/models/shared/linkedinpages.md b/docs/models/linkedinpages.md similarity index 100% rename from docs/models/shared/linkedinpages.md rename to docs/models/linkedinpages.md diff --git a/docs/models/linnworks.md b/docs/models/linnworks.md new file mode 100644 index 00000000..5e0766b8 --- /dev/null +++ b/docs/models/linnworks.md @@ -0,0 +1,8 @@ +# Linnworks + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `LINNWORKS` | linnworks | \ No newline at end of file diff --git a/docs/models/loadingmethod.md b/docs/models/loadingmethod.md new file mode 100644 index 00000000..5c0ff2c6 --- /dev/null +++ b/docs/models/loadingmethod.md @@ -0,0 +1,19 @@ +# LoadingMethod + +The way data will be uploaded to BigQuery. + + +## Supported Types + +### GCSStaging + +```python +loadingMethod: models.GCSStaging = /* values here */ +``` + +### StandardInserts + +```python +loadingMethod: models.StandardInserts = /* values here */ +``` + diff --git a/docs/models/local.md b/docs/models/local.md new file mode 100644 index 00000000..e39977e9 --- /dev/null +++ b/docs/models/local.md @@ -0,0 +1,10 @@ +# Local + +Process files locally, supporting `fast` and `ocr` modes. This is the default option. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `mode` | [Optional[models.SourceAzureBlobStorageMode]](../models/sourceazureblobstoragemode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/loginpassword.md b/docs/models/loginpassword.md new file mode 100644 index 00000000..7925f190 --- /dev/null +++ b/docs/models/loginpassword.md @@ -0,0 +1,12 @@ +# LoginPassword + +Login/Password. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `password` | *str* | :heavy_check_mark: | Password associated with the username. | +| `username` | *str* | :heavy_check_mark: | Username to use to access the database. | +| `authorization` | [models.DestinationMongodbAuthorization](../models/destinationmongodbauthorization.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/lokalise.md b/docs/models/lokalise.md similarity index 100% rename from docs/models/shared/lokalise.md rename to docs/models/lokalise.md diff --git a/docs/models/shared/lsncommitbehaviour.md b/docs/models/lsncommitbehaviour.md similarity index 100% rename from docs/models/shared/lsncommitbehaviour.md rename to docs/models/lsncommitbehaviour.md diff --git a/docs/models/mailchimp.md b/docs/models/mailchimp.md new file mode 100644 index 00000000..d08ddf4a --- /dev/null +++ b/docs/models/mailchimp.md @@ -0,0 +1,8 @@ +# Mailchimp + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `credentials` | [Optional[models.MailchimpCredentials]](../models/mailchimpcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/mailchimpcredentials.md b/docs/models/mailchimpcredentials.md similarity index 100% rename from docs/models/shared/mailchimpcredentials.md rename to docs/models/mailchimpcredentials.md diff --git a/docs/models/shared/mailgun.md b/docs/models/mailgun.md similarity index 100% rename from docs/models/shared/mailgun.md rename to docs/models/mailgun.md diff --git a/docs/models/shared/mailjetsms.md b/docs/models/mailjetsms.md similarity index 100% rename from docs/models/shared/mailjetsms.md rename to docs/models/mailjetsms.md diff --git a/docs/models/shared/marketo.md b/docs/models/marketo.md similarity index 100% rename from docs/models/shared/marketo.md rename to docs/models/marketo.md diff --git a/docs/models/shared/metabase.md b/docs/models/metabase.md similarity index 100% rename from docs/models/shared/metabase.md rename to docs/models/metabase.md diff --git a/docs/models/shared/method.md b/docs/models/method.md similarity index 100% rename from docs/models/shared/method.md rename to docs/models/method.md diff --git a/docs/models/metricsfilter.md b/docs/models/metricsfilter.md new file mode 100644 index 00000000..97518e33 --- /dev/null +++ b/docs/models/metricsfilter.md @@ -0,0 +1,31 @@ +# MetricsFilter + +Metrics filter + + +## Supported Types + +### SourceGoogleAnalyticsDataAPIAndGroup + +```python +metricsFilter: models.SourceGoogleAnalyticsDataAPIAndGroup = /* values here */ +``` + +### SourceGoogleAnalyticsDataAPIOrGroup + +```python +metricsFilter: models.SourceGoogleAnalyticsDataAPIOrGroup = /* values here */ +``` + +### SourceGoogleAnalyticsDataAPINotExpression + +```python +metricsFilter: models.SourceGoogleAnalyticsDataAPINotExpression = /* values here */ +``` + +### SourceGoogleAnalyticsDataAPIFilter + +```python +metricsFilter: models.SourceGoogleAnalyticsDataAPIFilter = /* values here */ +``` + diff --git a/docs/models/microsoftonedrive.md b/docs/models/microsoftonedrive.md new file mode 100644 index 00000000..f71b078d --- /dev/null +++ b/docs/models/microsoftonedrive.md @@ -0,0 +1,8 @@ +# MicrosoftOnedrive + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `credentials` | [Optional[models.MicrosoftOnedriveCredentials]](../models/microsoftonedrivecredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/microsoftonedrivecredentials.md b/docs/models/microsoftonedrivecredentials.md new file mode 100644 index 00000000..2be5c616 --- /dev/null +++ b/docs/models/microsoftonedrivecredentials.md @@ -0,0 +1,9 @@ +# MicrosoftOnedriveCredentials + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | +| `client_id` | *Optional[str]* | :heavy_minus_sign: | Client ID of your Microsoft developer application | +| `client_secret` | *Optional[str]* | :heavy_minus_sign: | Client Secret of your Microsoft developer application | \ No newline at end of file diff --git a/docs/models/microsoftsharepoint.md b/docs/models/microsoftsharepoint.md new file mode 100644 index 00000000..af4360f6 --- /dev/null +++ b/docs/models/microsoftsharepoint.md @@ -0,0 +1,8 @@ +# MicrosoftSharepoint + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `credentials` | [Optional[models.MicrosoftSharepointCredentials]](../models/microsoftsharepointcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/microsoftsharepointcredentials.md b/docs/models/microsoftsharepointcredentials.md similarity index 100% rename from docs/models/shared/microsoftsharepointcredentials.md rename to docs/models/microsoftsharepointcredentials.md diff --git a/docs/models/microsoftteams.md b/docs/models/microsoftteams.md new file mode 100644 index 00000000..cd2a3e8e --- /dev/null +++ b/docs/models/microsoftteams.md @@ -0,0 +1,8 @@ +# MicrosoftTeams + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `credentials` | [Optional[models.MicrosoftTeamsCredentials]](../models/microsoftteamscredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/microsoftteamscredentials.md b/docs/models/microsoftteamscredentials.md similarity index 100% rename from docs/models/shared/microsoftteamscredentials.md rename to docs/models/microsoftteamscredentials.md diff --git a/docs/models/shared/milvus.md b/docs/models/milvus.md similarity index 100% rename from docs/models/shared/milvus.md rename to docs/models/milvus.md diff --git a/docs/models/shared/mixpanel.md b/docs/models/mixpanel.md similarity index 100% rename from docs/models/shared/mixpanel.md rename to docs/models/mixpanel.md diff --git a/docs/models/mockcatalog.md b/docs/models/mockcatalog.md new file mode 100644 index 00000000..8eb995c1 --- /dev/null +++ b/docs/models/mockcatalog.md @@ -0,0 +1,17 @@ +# MockCatalog + + +## Supported Types + +### SingleSchema + +```python +mockCatalog: models.SingleSchema = /* values here */ +``` + +### MultiSchema + +```python +mockCatalog: models.MultiSchema = /* values here */ +``` + diff --git a/docs/models/shared/mode.md b/docs/models/mode.md similarity index 100% rename from docs/models/shared/mode.md rename to docs/models/mode.md diff --git a/docs/models/monday.md b/docs/models/monday.md new file mode 100644 index 00000000..1ad82309 --- /dev/null +++ b/docs/models/monday.md @@ -0,0 +1,8 @@ +# Monday + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `credentials` | [Optional[models.MondayCredentials]](../models/mondaycredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/mondaycredentials.md b/docs/models/mondaycredentials.md similarity index 100% rename from docs/models/shared/mondaycredentials.md rename to docs/models/mondaycredentials.md diff --git a/docs/models/shared/mongodb.md b/docs/models/mongodb.md similarity index 100% rename from docs/models/shared/mongodb.md rename to docs/models/mongodb.md diff --git a/docs/models/mongodbatlas.md b/docs/models/mongodbatlas.md new file mode 100644 index 00000000..d0383f4a --- /dev/null +++ b/docs/models/mongodbatlas.md @@ -0,0 +1,9 @@ +# MongoDBAtlas + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `cluster_url` | *str* | :heavy_check_mark: | URL of a cluster to connect to. | +| `instance` | [Optional[models.DestinationMongodbSchemasInstance]](../models/destinationmongodbschemasinstance.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/mongodbatlasreplicaset.md b/docs/models/mongodbatlasreplicaset.md similarity index 98% rename from docs/models/shared/mongodbatlasreplicaset.md rename to docs/models/mongodbatlasreplicaset.md index d60bd4b3..c0a3fabf 100644 --- a/docs/models/shared/mongodbatlasreplicaset.md +++ b/docs/models/mongodbatlasreplicaset.md @@ -13,5 +13,5 @@ MongoDB Atlas-hosted cluster configured as a replica set | `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 | | +| `cluster_type` | [models.SourceMongodbV2ClusterType](../models/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/mongodbinstancetype.md b/docs/models/mongodbinstancetype.md new file mode 100644 index 00000000..f71d7846 --- /dev/null +++ b/docs/models/mongodbinstancetype.md @@ -0,0 +1,25 @@ +# MongoDbInstanceType + +MongoDb instance to connect to. For MongoDB Atlas and Replica Set TLS connection is used by default. + + +## Supported Types + +### StandaloneMongoDbInstance + +```python +mongoDbInstanceType: models.StandaloneMongoDbInstance = /* values here */ +``` + +### ReplicaSet + +```python +mongoDbInstanceType: models.ReplicaSet = /* values here */ +``` + +### MongoDBAtlas + +```python +mongoDbInstanceType: models.MongoDBAtlas = /* values here */ +``` + diff --git a/docs/models/shared/mongodbinternalpoc.md b/docs/models/mongodbinternalpoc.md similarity index 100% rename from docs/models/shared/mongodbinternalpoc.md rename to docs/models/mongodbinternalpoc.md diff --git a/docs/models/shared/mongodbv2.md b/docs/models/mongodbv2.md similarity index 100% rename from docs/models/shared/mongodbv2.md rename to docs/models/mongodbv2.md diff --git a/docs/models/shared/mssql.md b/docs/models/mssql.md similarity index 100% rename from docs/models/shared/mssql.md rename to docs/models/mssql.md diff --git a/docs/models/shared/multischema.md b/docs/models/multischema.md similarity index 97% rename from docs/models/shared/multischema.md rename to docs/models/multischema.md index 3c88fdcd..4f2ac963 100644 --- a/docs/models/shared/multischema.md +++ b/docs/models/multischema.md @@ -8,4 +8,4 @@ A catalog with multiple data streams, each with a different schema. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `stream_schemas` | *Optional[str]* | :heavy_minus_sign: | A Json object specifying multiple data streams and their schemas. Each key in this object is one stream name. Each value is the schema for that stream. The schema should be compatible with draft-07. See this doc for examples. | -| `type` | [Optional[shared.SourceE2eTestCloudType]](../../models/shared/sourcee2etestcloudtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | [Optional[models.SourceE2eTestCloudType]](../models/sourcee2etestcloudtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/myhours.md b/docs/models/myhours.md similarity index 100% rename from docs/models/shared/myhours.md rename to docs/models/myhours.md diff --git a/docs/models/shared/mysql.md b/docs/models/mysql.md similarity index 100% rename from docs/models/shared/mysql.md rename to docs/models/mysql.md diff --git a/docs/models/shared/namespacedefinitionenum.md b/docs/models/namespacedefinitionenum.md similarity index 100% rename from docs/models/shared/namespacedefinitionenum.md rename to docs/models/namespacedefinitionenum.md diff --git a/docs/models/shared/namespacedefinitionenumnodefault.md b/docs/models/namespacedefinitionenumnodefault.md similarity index 100% rename from docs/models/shared/namespacedefinitionenumnodefault.md rename to docs/models/namespacedefinitionenumnodefault.md diff --git a/docs/models/nativenetworkencryptionnne.md b/docs/models/nativenetworkencryptionnne.md new file mode 100644 index 00000000..e08ff481 --- /dev/null +++ b/docs/models/nativenetworkencryptionnne.md @@ -0,0 +1,11 @@ +# NativeNetworkEncryptionNNE + +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. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `encryption_algorithm` | [Optional[models.EncryptionAlgorithm]](../models/encryptionalgorithm.md) | :heavy_minus_sign: | This parameter defines what encryption algorithm is used. | +| `encryption_method` | [models.EncryptionMethod](../models/encryptionmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/netsuite.md b/docs/models/netsuite.md similarity index 100% rename from docs/models/shared/netsuite.md rename to docs/models/netsuite.md diff --git a/docs/models/noauth.md b/docs/models/noauth.md new file mode 100644 index 00000000..fd02c971 --- /dev/null +++ b/docs/models/noauth.md @@ -0,0 +1,10 @@ +# NoAuth + +Do not authenticate (suitable for locally running test clusters, do not use for clusters with public IP addresses) + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| `mode` | [Optional[models.DestinationMilvusSchemasIndexingAuthAuthenticationMode]](../models/destinationmilvusschemasindexingauthauthenticationmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/noauthentication.md b/docs/models/noauthentication.md new file mode 100644 index 00000000..3bdfa44b --- /dev/null +++ b/docs/models/noauthentication.md @@ -0,0 +1,10 @@ +# NoAuthentication + +Do not authenticate (suitable for locally running test clusters, do not use for clusters with public IP addresses) + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | +| `mode` | [Optional[models.DestinationWeaviateSchemasIndexingAuthAuthenticationMode]](../models/destinationweaviateschemasindexingauthauthenticationmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/nocompression.md b/docs/models/nocompression.md new file mode 100644 index 00000000..ca00addf --- /dev/null +++ b/docs/models/nocompression.md @@ -0,0 +1,8 @@ +# NoCompression + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | +| `codec` | [Optional[models.Codec]](../models/codec.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/noencryption.md b/docs/models/noencryption.md new file mode 100644 index 00000000..56318d40 --- /dev/null +++ b/docs/models/noencryption.md @@ -0,0 +1,10 @@ +# NoEncryption + +Staging data will be stored in plaintext. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | +| `encryption_type` | [Optional[models.EncryptionType]](../models/encryptiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/noexternalembedding.md b/docs/models/noexternalembedding.md new file mode 100644 index 00000000..34236b41 --- /dev/null +++ b/docs/models/noexternalembedding.md @@ -0,0 +1,10 @@ +# NoExternalEmbedding + +Do not calculate and pass embeddings to Weaviate. Suitable for clusters with configured vectorizers to calculate embeddings within Weaviate or for classes that should only support regular text search. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `mode` | [Optional[models.DestinationWeaviateMode]](../models/destinationweaviatemode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/nonbreakingschemaupdatesbehaviorenum.md b/docs/models/nonbreakingschemaupdatesbehaviorenum.md similarity index 100% rename from docs/models/shared/nonbreakingschemaupdatesbehaviorenum.md rename to docs/models/nonbreakingschemaupdatesbehaviorenum.md diff --git a/docs/models/shared/nonbreakingschemaupdatesbehaviorenumnodefault.md b/docs/models/nonbreakingschemaupdatesbehaviorenumnodefault.md similarity index 100% rename from docs/models/shared/nonbreakingschemaupdatesbehaviorenumnodefault.md rename to docs/models/nonbreakingschemaupdatesbehaviorenumnodefault.md diff --git a/docs/models/nonet.md b/docs/models/nonet.md new file mode 100644 index 00000000..587c4105 --- /dev/null +++ b/docs/models/nonet.md @@ -0,0 +1,10 @@ +# NoneT + +None. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `authorization` | [models.DestinationMongodbSchemasAuthorization](../models/destinationmongodbschemasauthorization.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/normalization.md b/docs/models/normalization.md similarity index 100% rename from docs/models/shared/normalization.md rename to docs/models/normalization.md diff --git a/docs/models/shared/normalizationflattening.md b/docs/models/normalizationflattening.md similarity index 100% rename from docs/models/shared/normalizationflattening.md rename to docs/models/normalizationflattening.md diff --git a/docs/models/notexpression.md b/docs/models/notexpression.md new file mode 100644 index 00000000..7c60e29f --- /dev/null +++ b/docs/models/notexpression.md @@ -0,0 +1,11 @@ +# NotExpression + +The FilterExpression is NOT of notExpression. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `expression` | [Optional[models.SourceGoogleAnalyticsDataAPISchemasExpression]](../models/sourcegoogleanalyticsdataapischemasexpression.md) | :heavy_minus_sign: | N/A | +| `filter_type` | [Optional[models.SourceGoogleAnalyticsDataAPISchemasFilterType]](../models/sourcegoogleanalyticsdataapischemasfiltertype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/notion.md b/docs/models/notion.md new file mode 100644 index 00000000..0a1fb741 --- /dev/null +++ b/docs/models/notion.md @@ -0,0 +1,8 @@ +# Notion + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `credentials` | [Optional[models.NotionCredentials]](../models/notioncredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/notioncredentials.md b/docs/models/notioncredentials.md similarity index 100% rename from docs/models/shared/notioncredentials.md rename to docs/models/notioncredentials.md diff --git a/docs/models/notunnel.md b/docs/models/notunnel.md new file mode 100644 index 00000000..de3dff89 --- /dev/null +++ b/docs/models/notunnel.md @@ -0,0 +1,8 @@ +# NoTunnel + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | +| `tunnel_method` | [models.TunnelMethod](../models/tunnelmethod.md) | :heavy_check_mark: | No ssh tunnel needed to connect to database | \ No newline at end of file diff --git a/docs/models/shared/nullable.md b/docs/models/nullable.md similarity index 100% rename from docs/models/shared/nullable.md rename to docs/models/nullable.md diff --git a/docs/models/numericfilter.md b/docs/models/numericfilter.md new file mode 100644 index 00000000..c8c67724 --- /dev/null +++ b/docs/models/numericfilter.md @@ -0,0 +1,10 @@ +# NumericFilter + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `operation` | List[[models.SourceGoogleAnalyticsDataAPISchemasValidEnums](../models/sourcegoogleanalyticsdataapischemasvalidenums.md)] | :heavy_check_mark: | N/A | +| `value` | [Union[models.Int64Value, models.DoubleValue]](../models/value.md) | :heavy_check_mark: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasFilterName](../models/sourcegoogleanalyticsdataapischemasfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/nytimes.md b/docs/models/nytimes.md similarity index 100% rename from docs/models/shared/nytimes.md rename to docs/models/nytimes.md diff --git a/docs/models/oauth.md b/docs/models/oauth.md new file mode 100644 index 00000000..9f531510 --- /dev/null +++ b/docs/models/oauth.md @@ -0,0 +1,11 @@ +# OAuth + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | +| `access_token` | *str* | :heavy_check_mark: | OAuth access token | +| `client_id` | *Optional[str]* | :heavy_minus_sign: | OAuth Client Id | +| `client_secret` | *Optional[str]* | :heavy_minus_sign: | OAuth Client secret | +| `option_title` | [Optional[models.OptionTitle]](../models/optiontitle.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/oauth20.md b/docs/models/oauth20.md new file mode 100644 index 00000000..c3f4160e --- /dev/null +++ b/docs/models/oauth20.md @@ -0,0 +1,11 @@ +# OAuth20 + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `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. | +| `auth_method` | [models.SourcePinterestAuthMethod](../models/sourcepinterestauthmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/oauth20credentials.md b/docs/models/oauth20credentials.md similarity index 100% rename from docs/models/shared/oauth20credentials.md rename to docs/models/oauth20credentials.md diff --git a/docs/models/shared/oauth2accesstoken.md b/docs/models/oauth2accesstoken.md similarity index 96% rename from docs/models/shared/oauth2accesstoken.md rename to docs/models/oauth2accesstoken.md index 3b6236ec..e5d7d5f2 100644 --- a/docs/models/shared/oauth2accesstoken.md +++ b/docs/models/oauth2accesstoken.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `access_token` | *str* | :heavy_check_mark: | Also called API Access Token The access token used to call the Auth0 Management API Token. It's a JWT that contains specific grant permissions knowns as scopes. | | -| `auth_type` | [shared.SourceAuth0SchemasCredentialsAuthenticationMethod](../../models/shared/sourceauth0schemascredentialsauthenticationmethod.md) | :heavy_check_mark: | N/A | oauth2_access_token | \ No newline at end of file +| `auth_type` | [models.SourceAuth0SchemasCredentialsAuthenticationMethod](../models/sourceauth0schemascredentialsauthenticationmethod.md) | :heavy_check_mark: | N/A | oauth2_access_token | \ No newline at end of file diff --git a/docs/models/shared/oauth2confidentialapplication.md b/docs/models/oauth2confidentialapplication.md similarity index 96% rename from docs/models/shared/oauth2confidentialapplication.md rename to docs/models/oauth2confidentialapplication.md index 18b3c675..df03da4a 100644 --- a/docs/models/shared/oauth2confidentialapplication.md +++ b/docs/models/oauth2confidentialapplication.md @@ -8,4 +8,4 @@ | `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/ | | `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 | -| `auth_type` | [shared.SourceAuth0SchemasAuthenticationMethod](../../models/shared/sourceauth0schemasauthenticationmethod.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `auth_type` | [models.SourceAuth0SchemasAuthenticationMethod](../models/sourceauth0schemasauthenticationmethod.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/oauthactornames.md b/docs/models/oauthactornames.md similarity index 97% rename from docs/models/shared/oauthactornames.md rename to docs/models/oauthactornames.md index 0983d85c..a98ed275 100644 --- a/docs/models/shared/oauthactornames.md +++ b/docs/models/oauthactornames.md @@ -25,6 +25,7 @@ | `LEVER_HIRING` | lever-hiring | | `LINKEDIN_ADS` | linkedin-ads | | `MAILCHIMP` | mailchimp | +| `MICROSOFT_ONEDRIVE` | microsoft-onedrive | | `MICROSOFT_SHAREPOINT` | microsoft-sharepoint | | `MICROSOFT_TEAMS` | microsoft-teams | | `MONDAY` | monday | diff --git a/docs/models/oauthauthentication.md b/docs/models/oauthauthentication.md new file mode 100644 index 00000000..201528ac --- /dev/null +++ b/docs/models/oauthauthentication.md @@ -0,0 +1,11 @@ +# OauthAuthentication + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | +| `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 | +| `auth_type` | [models.SourceSquareAuthType](../models/sourcesquareauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/oauthcredentialsconfiguration.md b/docs/models/oauthcredentialsconfiguration.md new file mode 100644 index 00000000..4245eaa6 --- /dev/null +++ b/docs/models/oauthcredentialsconfiguration.md @@ -0,0 +1,271 @@ +# OAuthCredentialsConfiguration + +The values required to configure the source. + + +## Supported Types + +### Airtable + +```python +oAuthCredentialsConfiguration: models.Airtable = /* values here */ +``` + +### AmazonAds + +```python +oAuthCredentialsConfiguration: models.AmazonAds = /* values here */ +``` + +### AmazonSellerPartner + +```python +oAuthCredentialsConfiguration: models.AmazonSellerPartner = /* values here */ +``` + +### Asana + +```python +oAuthCredentialsConfiguration: models.Asana = /* values here */ +``` + +### BingAds + +```python +oAuthCredentialsConfiguration: models.BingAds = /* values here */ +``` + +### FacebookMarketing + +```python +oAuthCredentialsConfiguration: models.FacebookMarketing = /* values here */ +``` + +### Github + +```python +oAuthCredentialsConfiguration: models.Github = /* values here */ +``` + +### Gitlab + +```python +oAuthCredentialsConfiguration: models.Gitlab = /* values here */ +``` + +### GoogleAds + +```python +oAuthCredentialsConfiguration: models.GoogleAds = /* values here */ +``` + +### GoogleAnalyticsDataAPI + +```python +oAuthCredentialsConfiguration: models.GoogleAnalyticsDataAPI = /* values here */ +``` + +### GoogleDrive + +```python +oAuthCredentialsConfiguration: models.GoogleDrive = /* values here */ +``` + +### GoogleSearchConsole + +```python +oAuthCredentialsConfiguration: models.GoogleSearchConsole = /* values here */ +``` + +### GoogleSheets + +```python +oAuthCredentialsConfiguration: models.GoogleSheets = /* values here */ +``` + +### Harvest + +```python +oAuthCredentialsConfiguration: models.Harvest = /* values here */ +``` + +### Hubspot + +```python +oAuthCredentialsConfiguration: models.Hubspot = /* values here */ +``` + +### Instagram + +```python +oAuthCredentialsConfiguration: models.Instagram = /* values here */ +``` + +### Intercom + +```python +oAuthCredentialsConfiguration: models.Intercom = /* values here */ +``` + +### LeverHiring + +```python +oAuthCredentialsConfiguration: models.LeverHiring = /* values here */ +``` + +### LinkedinAds + +```python +oAuthCredentialsConfiguration: models.LinkedinAds = /* values here */ +``` + +### Mailchimp + +```python +oAuthCredentialsConfiguration: models.Mailchimp = /* values here */ +``` + +### MicrosoftOnedrive + +```python +oAuthCredentialsConfiguration: models.MicrosoftOnedrive = /* values here */ +``` + +### MicrosoftSharepoint + +```python +oAuthCredentialsConfiguration: models.MicrosoftSharepoint = /* values here */ +``` + +### MicrosoftTeams + +```python +oAuthCredentialsConfiguration: models.MicrosoftTeams = /* values here */ +``` + +### Monday + +```python +oAuthCredentialsConfiguration: models.Monday = /* values here */ +``` + +### Notion + +```python +oAuthCredentialsConfiguration: models.Notion = /* values here */ +``` + +### Pinterest + +```python +oAuthCredentialsConfiguration: models.Pinterest = /* values here */ +``` + +### Retently + +```python +oAuthCredentialsConfiguration: models.Retently = /* values here */ +``` + +### Salesforce + +```python +oAuthCredentialsConfiguration: models.Salesforce = /* values here */ +``` + +### Shopify + +```python +oAuthCredentialsConfiguration: models.Shopify = /* values here */ +``` + +### Slack + +```python +oAuthCredentialsConfiguration: models.Slack = /* values here */ +``` + +### Smartsheets + +```python +oAuthCredentialsConfiguration: models.Smartsheets = /* values here */ +``` + +### SnapchatMarketing + +```python +oAuthCredentialsConfiguration: models.SnapchatMarketing = /* values here */ +``` + +### Snowflake + +```python +oAuthCredentialsConfiguration: models.Snowflake = /* values here */ +``` + +### Square + +```python +oAuthCredentialsConfiguration: models.Square = /* values here */ +``` + +### Strava + +```python +oAuthCredentialsConfiguration: models.Strava = /* values here */ +``` + +### Surveymonkey + +```python +oAuthCredentialsConfiguration: models.Surveymonkey = /* values here */ +``` + +### TiktokMarketing + +```python +oAuthCredentialsConfiguration: models.TiktokMarketing = /* values here */ +``` + +### + +```python +oAuthCredentialsConfiguration: Any = /* values here */ +``` + +### Typeform + +```python +oAuthCredentialsConfiguration: models.Typeform = /* values here */ +``` + +### YoutubeAnalytics + +```python +oAuthCredentialsConfiguration: models.YoutubeAnalytics = /* values here */ +``` + +### ZendeskChat + +```python +oAuthCredentialsConfiguration: models.ZendeskChat = /* values here */ +``` + +### ZendeskSunshine + +```python +oAuthCredentialsConfiguration: models.ZendeskSunshine = /* values here */ +``` + +### ZendeskSupport + +```python +oAuthCredentialsConfiguration: models.ZendeskSupport = /* values here */ +``` + +### ZendeskTalk + +```python +oAuthCredentialsConfiguration: models.ZendeskTalk = /* values here */ +``` + diff --git a/docs/models/shared/oauthinputconfiguration.md b/docs/models/oauthinputconfiguration.md similarity index 100% rename from docs/models/shared/oauthinputconfiguration.md rename to docs/models/oauthinputconfiguration.md diff --git a/docs/models/shared/okta.md b/docs/models/okta.md similarity index 100% rename from docs/models/shared/okta.md rename to docs/models/okta.md diff --git a/docs/models/shared/omnisend.md b/docs/models/omnisend.md similarity index 100% rename from docs/models/shared/omnisend.md rename to docs/models/omnisend.md diff --git a/docs/models/shared/onesignal.md b/docs/models/onesignal.md similarity index 100% rename from docs/models/shared/onesignal.md rename to docs/models/onesignal.md diff --git a/docs/models/openai.md b/docs/models/openai.md new file mode 100644 index 00000000..4c9b0cae --- /dev/null +++ b/docs/models/openai.md @@ -0,0 +1,11 @@ +# OpenAI + +Use the OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `openai_key` | *str* | :heavy_check_mark: | N/A | +| `mode` | [Optional[models.DestinationAstraSchemasEmbeddingEmbedding1Mode]](../models/destinationastraschemasembeddingembedding1mode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/openaicompatible.md b/docs/models/openaicompatible.md new file mode 100644 index 00000000..5245b4aa --- /dev/null +++ b/docs/models/openaicompatible.md @@ -0,0 +1,14 @@ +# OpenAICompatible + +Use a service that's compatible with the OpenAI API to embed text. + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `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[models.DestinationAstraSchemasEmbeddingEmbeddingMode]](../models/destinationastraschemasembeddingembeddingmode.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/operations/createorupdateworkspaceoauthcredentialsrequest.md b/docs/models/operations/createorupdateworkspaceoauthcredentialsrequest.md deleted file mode 100644 index a8fe6d81..00000000 --- a/docs/models/operations/createorupdateworkspaceoauthcredentialsrequest.md +++ /dev/null @@ -1,9 +0,0 @@ -# CreateOrUpdateWorkspaceOAuthCredentialsRequest - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `workspace_o_auth_credentials_request` | [shared.WorkspaceOAuthCredentialsRequest](../../models/shared/workspaceoauthcredentialsrequest.md) | :heavy_check_mark: | N/A | -| `workspace_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getstreampropertiesresponse.md b/docs/models/operations/getstreampropertiesresponse.md deleted file mode 100644 index 04e2c23b..00000000 --- a/docs/models/operations/getstreampropertiesresponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetStreamPropertiesResponse - - -## 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 | -| `stream_properties_response` | [Optional[shared.StreamPropertiesResponse]](../../models/shared/streampropertiesresponse.md) | :heavy_minus_sign: | Get the available streams properties for a source/destination pair. | \ No newline at end of file diff --git a/docs/models/operations/patchconnectionrequest.md b/docs/models/operations/patchconnectionrequest.md deleted file mode 100644 index a6d47c2d..00000000 --- a/docs/models/operations/patchconnectionrequest.md +++ /dev/null @@ -1,9 +0,0 @@ -# PatchConnectionRequest - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `connection_patch_request` | [shared.ConnectionPatchRequest](../../models/shared/connectionpatchrequest.md) | :heavy_check_mark: | N/A | -| `connection_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/patchdestinationrequest.md b/docs/models/operations/patchdestinationrequest.md deleted file mode 100644 index 78ba063c..00000000 --- a/docs/models/operations/patchdestinationrequest.md +++ /dev/null @@ -1,9 +0,0 @@ -# PatchDestinationRequest - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `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/patchsourcerequest.md b/docs/models/operations/patchsourcerequest.md deleted file mode 100644 index 23c8c84f..00000000 --- a/docs/models/operations/patchsourcerequest.md +++ /dev/null @@ -1,9 +0,0 @@ -# PatchSourceRequest - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `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/putdestinationrequest.md b/docs/models/operations/putdestinationrequest.md deleted file mode 100644 index 93f7ae1d..00000000 --- a/docs/models/operations/putdestinationrequest.md +++ /dev/null @@ -1,9 +0,0 @@ -# PutDestinationRequest - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `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/putsourcerequest.md b/docs/models/operations/putsourcerequest.md deleted file mode 100644 index ba170e0c..00000000 --- a/docs/models/operations/putsourcerequest.md +++ /dev/null @@ -1,9 +0,0 @@ -# PutSourceRequest - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `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/updateworkspacerequest.md b/docs/models/operations/updateworkspacerequest.md deleted file mode 100644 index 96350b87..00000000 --- a/docs/models/operations/updateworkspacerequest.md +++ /dev/null @@ -1,9 +0,0 @@ -# UpdateWorkspaceRequest - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `workspace_update_request` | [shared.WorkspaceUpdateRequest](../../models/shared/workspaceupdaterequest.md) | :heavy_check_mark: | N/A | -| `workspace_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/operator.md b/docs/models/operator.md similarity index 100% rename from docs/models/shared/operator.md rename to docs/models/operator.md diff --git a/docs/models/shared/optionslist.md b/docs/models/optionslist.md similarity index 100% rename from docs/models/shared/optionslist.md rename to docs/models/optionslist.md diff --git a/docs/models/shared/optiontitle.md b/docs/models/optiontitle.md similarity index 100% rename from docs/models/shared/optiontitle.md rename to docs/models/optiontitle.md diff --git a/docs/models/shared/oracle.md b/docs/models/oracle.md similarity index 100% rename from docs/models/shared/oracle.md rename to docs/models/oracle.md diff --git a/docs/models/shared/orb.md b/docs/models/orb.md similarity index 100% rename from docs/models/shared/orb.md rename to docs/models/orb.md diff --git a/docs/models/shared/orbit.md b/docs/models/orbit.md similarity index 100% rename from docs/models/shared/orbit.md rename to docs/models/orbit.md diff --git a/docs/models/orgroup.md b/docs/models/orgroup.md new file mode 100644 index 00000000..aacd9a4c --- /dev/null +++ b/docs/models/orgroup.md @@ -0,0 +1,11 @@ +# OrGroup + +The FilterExpressions in orGroup have an OR relationship. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `expressions` | List[[models.SourceGoogleAnalyticsDataAPIExpression](../models/sourcegoogleanalyticsdataapiexpression.md)] | :heavy_check_mark: | N/A | +| `filter_type` | [models.SourceGoogleAnalyticsDataAPIFilterType](../models/sourcegoogleanalyticsdataapifiltertype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/origindatacenterofthesurveymonkeyaccount.md b/docs/models/origindatacenterofthesurveymonkeyaccount.md similarity index 100% rename from docs/models/shared/origindatacenterofthesurveymonkeyaccount.md rename to docs/models/origindatacenterofthesurveymonkeyaccount.md diff --git a/docs/models/shared/outbrainamplify.md b/docs/models/outbrainamplify.md similarity index 100% rename from docs/models/shared/outbrainamplify.md rename to docs/models/outbrainamplify.md diff --git a/docs/models/outputformat.md b/docs/models/outputformat.md new file mode 100644 index 00000000..60307129 --- /dev/null +++ b/docs/models/outputformat.md @@ -0,0 +1,19 @@ +# OutputFormat + +Output data format + + +## Supported Types + +### CSVCommaSeparatedValues + +```python +outputFormat: models.CSVCommaSeparatedValues = /* values here */ +``` + +### DestinationAzureBlobStorageJSONLinesNewlineDelimitedJSON + +```python +outputFormat: models.DestinationAzureBlobStorageJSONLinesNewlineDelimitedJSON = /* values here */ +``` + diff --git a/docs/models/outputformatwildcard.md b/docs/models/outputformatwildcard.md new file mode 100644 index 00000000..6638398f --- /dev/null +++ b/docs/models/outputformatwildcard.md @@ -0,0 +1,19 @@ +# OutputFormatWildcard + +Format of the data output. + + +## Supported Types + +### JSONLinesNewlineDelimitedJSON + +```python +outputFormatWildcard: models.JSONLinesNewlineDelimitedJSON = /* values here */ +``` + +### ParquetColumnarStorage + +```python +outputFormatWildcard: models.ParquetColumnarStorage = /* values here */ +``` + diff --git a/docs/models/shared/outreach.md b/docs/models/outreach.md similarity index 100% rename from docs/models/shared/outreach.md rename to docs/models/outreach.md diff --git a/docs/models/shared/parquet.md b/docs/models/parquet.md similarity index 97% rename from docs/models/shared/parquet.md rename to docs/models/parquet.md index b311527c..9811e687 100644 --- a/docs/models/shared/parquet.md +++ b/docs/models/parquet.md @@ -10,4 +10,4 @@ This connector utilises Support Guide for more information on how to obtain this token. | key1234567890 | -| `auth_method` | [Optional[shared.SourceAirtableAuthMethod]](../../models/shared/sourceairtableauthmethod.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `auth_method` | [Optional[models.SourceAirtableAuthMethod]](../models/sourceairtableauthmethod.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/pexelsapi.md b/docs/models/pexelsapi.md similarity index 100% rename from docs/models/shared/pexelsapi.md rename to docs/models/pexelsapi.md diff --git a/docs/models/shared/pinecone.md b/docs/models/pinecone.md similarity index 100% rename from docs/models/shared/pinecone.md rename to docs/models/pinecone.md diff --git a/docs/models/pinterest.md b/docs/models/pinterest.md new file mode 100644 index 00000000..3fb71e3f --- /dev/null +++ b/docs/models/pinterest.md @@ -0,0 +1,8 @@ +# Pinterest + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `credentials` | [Optional[models.PinterestCredentials]](../models/pinterestcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/pinterestcredentials.md b/docs/models/pinterestcredentials.md similarity index 100% rename from docs/models/shared/pinterestcredentials.md rename to docs/models/pinterestcredentials.md diff --git a/docs/models/shared/pipedrive.md b/docs/models/pipedrive.md similarity index 100% rename from docs/models/shared/pipedrive.md rename to docs/models/pipedrive.md diff --git a/docs/models/shared/pivotcategory.md b/docs/models/pivotcategory.md similarity index 100% rename from docs/models/shared/pivotcategory.md rename to docs/models/pivotcategory.md diff --git a/docs/models/shared/plugin.md b/docs/models/plugin.md similarity index 100% rename from docs/models/shared/plugin.md rename to docs/models/plugin.md diff --git a/docs/models/shared/pocket.md b/docs/models/pocket.md similarity index 100% rename from docs/models/shared/pocket.md rename to docs/models/pocket.md diff --git a/docs/models/shared/pokeapi.md b/docs/models/pokeapi.md similarity index 100% rename from docs/models/shared/pokeapi.md rename to docs/models/pokeapi.md diff --git a/docs/models/shared/pokemonname.md b/docs/models/pokemonname.md similarity index 100% rename from docs/models/shared/pokemonname.md rename to docs/models/pokemonname.md diff --git a/docs/models/shared/polygonstockapi.md b/docs/models/polygonstockapi.md similarity index 100% rename from docs/models/shared/polygonstockapi.md rename to docs/models/polygonstockapi.md diff --git a/docs/models/shared/postgres.md b/docs/models/postgres.md similarity index 100% rename from docs/models/shared/postgres.md rename to docs/models/postgres.md diff --git a/docs/models/shared/posthog.md b/docs/models/posthog.md similarity index 100% rename from docs/models/shared/posthog.md rename to docs/models/posthog.md diff --git a/docs/models/shared/postmarkapp.md b/docs/models/postmarkapp.md similarity index 100% rename from docs/models/shared/postmarkapp.md rename to docs/models/postmarkapp.md diff --git a/docs/models/prefer.md b/docs/models/prefer.md new file mode 100644 index 00000000..50a46c22 --- /dev/null +++ b/docs/models/prefer.md @@ -0,0 +1,10 @@ +# Prefer + +Prefer SSL mode. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `mode` | [Optional[models.DestinationPostgresSchemasMode]](../models/destinationpostgresschemasmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/preferred.md b/docs/models/preferred.md new file mode 100644 index 00000000..3436785e --- /dev/null +++ b/docs/models/preferred.md @@ -0,0 +1,10 @@ +# Preferred + +Automatically attempt SSL connection. If the MySQL server does not support SSL, continue with a regular connection. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | +| `mode` | [models.SourceMysqlMode](../models/sourcemysqlmode.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/prestashop.md b/docs/models/prestashop.md similarity index 100% rename from docs/models/shared/prestashop.md rename to docs/models/prestashop.md diff --git a/docs/models/shared/privateapp.md b/docs/models/privateapp.md similarity index 94% rename from docs/models/shared/privateapp.md rename to docs/models/privateapp.md index 99320163..3fc80ddc 100644 --- a/docs/models/shared/privateapp.md +++ b/docs/models/privateapp.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | | `access_token` | *str* | :heavy_check_mark: | HubSpot Access token. See the Hubspot docs if you need help finding this token. | -| `credentials_title` | [shared.SourceHubspotSchemasAuthType](../../models/shared/sourcehubspotschemasauthtype.md) | :heavy_check_mark: | Name of the credentials set | \ No newline at end of file +| `credentials_title` | [models.SourceHubspotSchemasAuthType](../models/sourcehubspotschemasauthtype.md) | :heavy_check_mark: | Name of the credentials set | \ No newline at end of file diff --git a/docs/models/privatetoken.md b/docs/models/privatetoken.md new file mode 100644 index 00000000..bf59974e --- /dev/null +++ b/docs/models/privatetoken.md @@ -0,0 +1,9 @@ +# PrivateToken + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `access_token` | *str* | :heavy_check_mark: | Log into your Gitlab account and then generate a personal Access Token. | +| `auth_type` | [Optional[models.SourceGitlabSchemasAuthType]](../models/sourcegitlabschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/processing.md b/docs/models/processing.md new file mode 100644 index 00000000..827afa06 --- /dev/null +++ b/docs/models/processing.md @@ -0,0 +1,13 @@ +# Processing + +Processing configuration + + +## Supported Types + +### Local + +```python +processing: models.Local = /* values here */ +``` + diff --git a/docs/models/shared/processingconfigmodel.md b/docs/models/processingconfigmodel.md similarity index 98% rename from docs/models/shared/processingconfigmodel.md rename to docs/models/processingconfigmodel.md index b6e437b9..c303ecc3 100644 --- a/docs/models/shared/processingconfigmodel.md +++ b/docs/models/processingconfigmodel.md @@ -7,7 +7,7 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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. | | +| `field_name_mappings` | List[[models.FieldNameMappingConfigModel](../models/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 | -| `text_splitter` | [Optional[Union[shared.BySeparator, shared.ByMarkdownHeader, shared.ByProgrammingLanguage]]](../../models/shared/textsplitter.md) | :heavy_minus_sign: | Split text fields into chunks based on the specified method. | | \ No newline at end of file +| `text_splitter` | [Optional[Union[models.BySeparator, models.ByMarkdownHeader, models.ByProgrammingLanguage]]](../models/textsplitter.md) | :heavy_minus_sign: | Split text fields into chunks based on the specified method. | | \ No newline at end of file diff --git a/docs/models/shared/productcatalog.md b/docs/models/productcatalog.md similarity index 100% rename from docs/models/shared/productcatalog.md rename to docs/models/productcatalog.md diff --git a/docs/models/shared/projectsecret.md b/docs/models/projectsecret.md similarity index 95% rename from docs/models/shared/projectsecret.md rename to docs/models/projectsecret.md index 293d60bd..8c1d0c42 100644 --- a/docs/models/shared/projectsecret.md +++ b/docs/models/projectsecret.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `api_secret` | *str* | :heavy_check_mark: | Mixpanel project secret. See the docs for more information on how to obtain this. | -| `option_title` | [Optional[shared.SourceMixpanelSchemasOptionTitle]](../../models/shared/sourcemixpanelschemasoptiontitle.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `option_title` | [Optional[models.SourceMixpanelSchemasOptionTitle]](../models/sourcemixpanelschemasoptiontitle.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/pubsub.md b/docs/models/pubsub.md similarity index 100% rename from docs/models/shared/pubsub.md rename to docs/models/pubsub.md diff --git a/docs/models/shared/punkapi.md b/docs/models/punkapi.md similarity index 100% rename from docs/models/shared/punkapi.md rename to docs/models/punkapi.md diff --git a/docs/models/shared/pypi.md b/docs/models/pypi.md similarity index 100% rename from docs/models/shared/pypi.md rename to docs/models/pypi.md diff --git a/docs/models/shared/qdrant.md b/docs/models/qdrant.md similarity index 100% rename from docs/models/shared/qdrant.md rename to docs/models/qdrant.md diff --git a/docs/models/shared/qualaroo.md b/docs/models/qualaroo.md similarity index 100% rename from docs/models/shared/qualaroo.md rename to docs/models/qualaroo.md diff --git a/docs/models/shared/quickbooks.md b/docs/models/quickbooks.md similarity index 100% rename from docs/models/shared/quickbooks.md rename to docs/models/quickbooks.md diff --git a/docs/models/shared/railz.md b/docs/models/railz.md similarity index 100% rename from docs/models/shared/railz.md rename to docs/models/railz.md diff --git a/docs/models/readchangesusingbinarylogcdc.md b/docs/models/readchangesusingbinarylogcdc.md new file mode 100644 index 00000000..fd2d8089 --- /dev/null +++ b/docs/models/readchangesusingbinarylogcdc.md @@ -0,0 +1,13 @@ +# ReadChangesUsingBinaryLogCDC + +Recommended - Incrementally reads new inserts, updates, and deletes using the MySQL binary log. This must be enabled on your database. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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. | +| `invalid_cdc_cursor_position_behavior` | [Optional[models.SourceMysqlInvalidCDCPositionBehaviorAdvanced]](../models/sourcemysqlinvalidcdcpositionbehavioradvanced.md) | :heavy_minus_sign: | Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value into the WAL. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss. | +| `method` | [models.SourceMysqlMethod](../models/sourcemysqlmethod.md) | :heavy_check_mark: | N/A | +| `server_time_zone` | *Optional[str]* | :heavy_minus_sign: | 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. | \ No newline at end of file diff --git a/docs/models/readchangesusingchangedatacapturecdc.md b/docs/models/readchangesusingchangedatacapturecdc.md new file mode 100644 index 00000000..928fd81a --- /dev/null +++ b/docs/models/readchangesusingchangedatacapturecdc.md @@ -0,0 +1,13 @@ +# ReadChangesUsingChangeDataCaptureCDC + +Recommended - Incrementally reads new inserts, updates, and deletes using the SQL Server's change data capture feature. This must be enabled on your database. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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 2400 seconds. Read about initial waiting time. | +| `invalid_cdc_cursor_position_behavior` | [Optional[models.SourceMssqlInvalidCDCPositionBehaviorAdvanced]](../models/sourcemssqlinvalidcdcpositionbehavioradvanced.md) | :heavy_minus_sign: | Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value into the WAL. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss. | +| `method` | [models.SourceMssqlMethod](../models/sourcemssqlmethod.md) | :heavy_check_mark: | N/A | +| `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/readchangesusingwriteaheadlogcdc.md b/docs/models/readchangesusingwriteaheadlogcdc.md new file mode 100644 index 00000000..cb61a1e3 --- /dev/null +++ b/docs/models/readchangesusingwriteaheadlogcdc.md @@ -0,0 +1,19 @@ +# ReadChangesUsingWriteAheadLogCDC + +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. + + +## Fields + +| 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 | +| `heartbeat_action_query` | *Optional[str]* | :heavy_minus_sign: | Specifies a query that the connector executes on the source database when the connector sends a heartbeat message. Please see the setup guide for how and when to configure this setting. | +| `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. | +| `invalid_cdc_cursor_position_behavior` | [Optional[models.SourcePostgresInvalidCDCPositionBehaviorAdvanced]](../models/sourcepostgresinvalidcdcpositionbehavioradvanced.md) | :heavy_minus_sign: | Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value into the WAL. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss. | +| `lsn_commit_behaviour` | [Optional[models.LSNCommitBehaviour]](../models/lsncommitbehaviour.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` | [models.SourcePostgresMethod](../models/sourcepostgresmethod.md) | :heavy_check_mark: | N/A | +| `plugin` | [Optional[models.Plugin]](../models/plugin.md) | :heavy_minus_sign: | A logical decoding plugin installed on the PostgreSQL server. | +| `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/recharge.md b/docs/models/recharge.md similarity index 100% rename from docs/models/shared/recharge.md rename to docs/models/recharge.md diff --git a/docs/models/recommendedmanagedtables.md b/docs/models/recommendedmanagedtables.md new file mode 100644 index 00000000..44d05502 --- /dev/null +++ b/docs/models/recommendedmanagedtables.md @@ -0,0 +1,8 @@ +# RecommendedManagedTables + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | +| `data_source_type` | [models.DataSourceType](../models/datasourcetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/recreation.md b/docs/models/recreation.md similarity index 100% rename from docs/models/shared/recreation.md rename to docs/models/recreation.md diff --git a/docs/models/shared/recruitee.md b/docs/models/recruitee.md similarity index 100% rename from docs/models/shared/recruitee.md rename to docs/models/recruitee.md diff --git a/docs/models/recurly.md b/docs/models/recurly.md new file mode 100644 index 00000000..718d9a2c --- /dev/null +++ b/docs/models/recurly.md @@ -0,0 +1,8 @@ +# Recurly + + +## Values + +| Name | Value | +| --------- | --------- | +| `RECURLY` | recurly | \ No newline at end of file diff --git a/docs/models/shared/redis.md b/docs/models/redis.md similarity index 100% rename from docs/models/shared/redis.md rename to docs/models/redis.md diff --git a/docs/models/shared/redshift.md b/docs/models/redshift.md similarity index 100% rename from docs/models/shared/redshift.md rename to docs/models/redshift.md diff --git a/docs/models/shared/region.md b/docs/models/region.md similarity index 100% rename from docs/models/shared/region.md rename to docs/models/region.md diff --git a/docs/models/replicaset.md b/docs/models/replicaset.md new file mode 100644 index 00000000..dac85769 --- /dev/null +++ b/docs/models/replicaset.md @@ -0,0 +1,10 @@ +# ReplicaSet + + +## Fields + +| 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[models.DestinationMongodbInstance]](../models/destinationmongodbinstance.md) | :heavy_minus_sign: | N/A | | +| `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/reportconfig.md similarity index 94% rename from docs/models/shared/reportconfig.md rename to docs/models/reportconfig.md index 840f342b..d3d0ac04 100644 --- a/docs/models/shared/reportconfig.md +++ b/docs/models/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 | | +| `columns` | List[[models.SourcePinterestSchemasValidEnums](../models/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. | | -| `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 | | +| `attribution_types` | List[[models.SourcePinterestValidEnums](../models/sourcepinterestvalidenums.md)] | :heavy_minus_sign: | List of types of attribution for the conversion report | | +| `click_window_days` | [Optional[models.ClickWindowDays]](../models/clickwindowdays.md) | :heavy_minus_sign: | Number of days to use as the conversion attribution window for a pin click action. | | +| `conversion_report_time` | [Optional[models.ConversionReportTime]](../models/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[models.EngagementWindowDays]](../models/engagementwindowdays.md) | :heavy_minus_sign: | Number of days to use as the conversion attribution window for an engagement action. | | +| `granularity` | [Optional[models.Granularity]](../models/granularity.md) | :heavy_minus_sign: | Chosen granularity for API | | +| `level` | [Optional[models.SourcePinterestLevel]](../models/sourcepinterestlevel.md) | :heavy_minus_sign: | Chosen level for API | | | `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 +| `view_window_days` | [Optional[models.ViewWindowDays]](../models/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/reportingdataobject.md b/docs/models/reportingdataobject.md similarity index 100% rename from docs/models/shared/reportingdataobject.md rename to docs/models/reportingdataobject.md diff --git a/docs/models/reportoptions.md b/docs/models/reportoptions.md new file mode 100644 index 00000000..b7a866bc --- /dev/null +++ b/docs/models/reportoptions.md @@ -0,0 +1,9 @@ +# ReportOptions + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | +| `options_list` | List[[models.OptionsList](../models/optionslist.md)] | :heavy_check_mark: | List of options | +| `stream_name` | [models.StreamName](../models/streamname.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/reportrecordtypes.md b/docs/models/reportrecordtypes.md similarity index 100% rename from docs/models/shared/reportrecordtypes.md rename to docs/models/reportrecordtypes.md diff --git a/docs/models/require.md b/docs/models/require.md new file mode 100644 index 00000000..d71cb4cc --- /dev/null +++ b/docs/models/require.md @@ -0,0 +1,10 @@ +# Require + +Require SSL mode. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `mode` | [Optional[models.DestinationPostgresSchemasSslModeMode]](../models/destinationpostgresschemassslmodemode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/required.md b/docs/models/required.md new file mode 100644 index 00000000..1f891bbe --- /dev/null +++ b/docs/models/required.md @@ -0,0 +1,10 @@ +# Required + +Always connect with SSL. If the MySQL server doesn’t support SSL, the connection will not be established. Certificate Authority (CA) and Hostname are not verified. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `mode` | [models.SourceMysqlSchemasMode](../models/sourcemysqlschemasmode.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/retently.md b/docs/models/retently.md new file mode 100644 index 00000000..7cad6217 --- /dev/null +++ b/docs/models/retently.md @@ -0,0 +1,8 @@ +# Retently + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `credentials` | [Optional[models.RetentlyCredentials]](../models/retentlycredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/retentlycredentials.md b/docs/models/retentlycredentials.md similarity index 100% rename from docs/models/shared/retentlycredentials.md rename to docs/models/retentlycredentials.md diff --git a/docs/models/shared/rkicovid.md b/docs/models/rkicovid.md similarity index 100% rename from docs/models/shared/rkicovid.md rename to docs/models/rkicovid.md diff --git a/docs/models/shared/rss.md b/docs/models/rss.md similarity index 100% rename from docs/models/shared/rss.md rename to docs/models/rss.md diff --git a/docs/models/shared/s3.md b/docs/models/s3.md similarity index 100% rename from docs/models/shared/s3.md rename to docs/models/s3.md diff --git a/docs/models/shared/s3amazonwebservices.md b/docs/models/s3amazonwebservices.md similarity index 90% rename from docs/models/shared/s3amazonwebservices.md rename to docs/models/s3amazonwebservices.md index b06c940f..4c00e027 100644 --- a/docs/models/shared/s3amazonwebservices.md +++ b/docs/models/s3amazonwebservices.md @@ -12,5 +12,6 @@ Deprecated and will be removed soon. Please do not use this field anymore and us | `bucket` | *Optional[str]* | :heavy_minus_sign: | Name of the S3 bucket where the file(s) exist. | | | `endpoint` | *Optional[str]* | :heavy_minus_sign: | Endpoint to an S3 compatible service. Leave empty to use AWS. | | | `path_prefix` | *Optional[str]* | :heavy_minus_sign: | By providing a path-like prefix (e.g. myFolder/thisTable/) under which all the relevant files sit, we can optimize finding these in S3. This is optional but recommended if your bucket contains many folders/files which you don't need to replicate. | | +| `region_name` | *Optional[str]* | :heavy_minus_sign: | AWS region where the S3 bucket is located. If not provided, the region will be determined automatically. | | | `role_arn` | *Optional[str]* | :heavy_minus_sign: | Specifies the Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations requested using this profile. Set the External ID to the Airbyte workspace ID, which can be found in the URL of this page. | | | `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 file modified before this date will not be replicated. | 2021-01-01T00:00:00Z | \ No newline at end of file diff --git a/docs/models/shared/s3bucketregion.md b/docs/models/s3bucketregion.md similarity index 100% rename from docs/models/shared/s3bucketregion.md rename to docs/models/s3bucketregion.md diff --git a/docs/models/shared/s3glue.md b/docs/models/s3glue.md similarity index 100% rename from docs/models/shared/s3glue.md rename to docs/models/s3glue.md diff --git a/docs/models/shared/salesforce.md b/docs/models/salesforce.md similarity index 100% rename from docs/models/shared/salesforce.md rename to docs/models/salesforce.md diff --git a/docs/models/shared/salesloft.md b/docs/models/salesloft.md similarity index 100% rename from docs/models/shared/salesloft.md rename to docs/models/salesloft.md diff --git a/docs/models/sandboxaccesstoken.md b/docs/models/sandboxaccesstoken.md new file mode 100644 index 00000000..fa1de60f --- /dev/null +++ b/docs/models/sandboxaccesstoken.md @@ -0,0 +1,10 @@ +# SandboxAccessToken + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `access_token` | *str* | :heavy_check_mark: | The long-term authorized access token. | +| `advertiser_id` | *str* | :heavy_check_mark: | The Advertiser ID which generated for the developer's Sandbox application. | +| `auth_type` | [Optional[models.SourceTiktokMarketingSchemasAuthType]](../models/sourcetiktokmarketingschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sapfieldglass.md b/docs/models/sapfieldglass.md similarity index 100% rename from docs/models/shared/sapfieldglass.md rename to docs/models/sapfieldglass.md diff --git a/docs/models/scanchangeswithuserdefinedcursor.md b/docs/models/scanchangeswithuserdefinedcursor.md new file mode 100644 index 00000000..b74b0731 --- /dev/null +++ b/docs/models/scanchangeswithuserdefinedcursor.md @@ -0,0 +1,10 @@ +# ScanChangesWithUserDefinedCursor + +Incrementally detects new inserts and updates using the cursor column chosen when configuring a connection (e.g. created_at, updated_at). + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `method` | [models.SourceMssqlSchemasMethod](../models/sourcemssqlschemasmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/scheduletypeenum.md b/docs/models/scheduletypeenum.md similarity index 100% rename from docs/models/shared/scheduletypeenum.md rename to docs/models/scheduletypeenum.md diff --git a/docs/models/shared/scheduletypewithbasicenum.md b/docs/models/scheduletypewithbasicenum.md similarity index 100% rename from docs/models/shared/scheduletypewithbasicenum.md rename to docs/models/scheduletypewithbasicenum.md diff --git a/docs/models/shared/schemebasicauth.md b/docs/models/schemebasicauth.md similarity index 100% rename from docs/models/shared/schemebasicauth.md rename to docs/models/schemebasicauth.md diff --git a/docs/models/scpsecurecopyprotocol.md b/docs/models/scpsecurecopyprotocol.md new file mode 100644 index 00000000..427e0f0c --- /dev/null +++ b/docs/models/scpsecurecopyprotocol.md @@ -0,0 +1,12 @@ +# SCPSecureCopyProtocol + + +## Fields + +| 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` | [models.SourceFileSchemasProviderStorageProvider6Storage](../models/sourcefileschemasproviderstorageprovider6storage.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/searchcriteria.md b/docs/models/searchcriteria.md similarity index 100% rename from docs/models/shared/searchcriteria.md rename to docs/models/searchcriteria.md diff --git a/docs/models/searchscope.md b/docs/models/searchscope.md new file mode 100644 index 00000000..58ac60de --- /dev/null +++ b/docs/models/searchscope.md @@ -0,0 +1,12 @@ +# SearchScope + +Specifies the location(s) to search for files. Valid options are 'ACCESSIBLE_DRIVES' to search in the selected OneDrive drive, 'SHARED_ITEMS' for shared items the user has access to, and 'ALL' to search both. + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `ACCESSIBLE_DRIVES` | ACCESSIBLE_DRIVES | +| `SHARED_ITEMS` | SHARED_ITEMS | +| `ALL` | ALL | \ No newline at end of file diff --git a/docs/models/shared/secoda.md b/docs/models/secoda.md similarity index 100% rename from docs/models/shared/secoda.md rename to docs/models/secoda.md diff --git a/docs/models/security.md b/docs/models/security.md new file mode 100644 index 00000000..cc5acea4 --- /dev/null +++ b/docs/models/security.md @@ -0,0 +1,9 @@ +# Security + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | +| `basic_auth` | [Optional[models.SchemeBasicAuth]](../models/schemebasicauth.md) | :heavy_minus_sign: | N/A | +| `bearer_auth` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/selfmanagedreplicaset.md b/docs/models/selfmanagedreplicaset.md similarity index 98% rename from docs/models/shared/selfmanagedreplicaset.md rename to docs/models/selfmanagedreplicaset.md index 18682afa..b5d3899a 100644 --- a/docs/models/shared/selfmanagedreplicaset.md +++ b/docs/models/selfmanagedreplicaset.md @@ -11,7 +11,7 @@ MongoDB self-hosted cluster configured as a replica set | `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 | | +| `cluster_type` | [models.SourceMongodbV2SchemasClusterType](../models/sourcemongodbv2schemasclustertype.md) | :heavy_check_mark: | N/A | | | `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/sendgrid.md b/docs/models/sendgrid.md similarity index 100% rename from docs/models/shared/sendgrid.md rename to docs/models/sendgrid.md diff --git a/docs/models/shared/sendinblue.md b/docs/models/sendinblue.md similarity index 100% rename from docs/models/shared/sendinblue.md rename to docs/models/sendinblue.md diff --git a/docs/models/shared/senseforce.md b/docs/models/senseforce.md similarity index 100% rename from docs/models/shared/senseforce.md rename to docs/models/senseforce.md diff --git a/docs/models/shared/sentry.md b/docs/models/sentry.md similarity index 100% rename from docs/models/shared/sentry.md rename to docs/models/sentry.md diff --git a/docs/models/shared/serializationlibrary.md b/docs/models/serializationlibrary.md similarity index 100% rename from docs/models/shared/serializationlibrary.md rename to docs/models/serializationlibrary.md diff --git a/docs/models/shared/serviceaccount.md b/docs/models/serviceaccount.md similarity index 97% rename from docs/models/shared/serviceaccount.md rename to docs/models/serviceaccount.md index 9415a753..79183867 100644 --- a/docs/models/shared/serviceaccount.md +++ b/docs/models/serviceaccount.md @@ -8,4 +8,4 @@ | `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. | -| `option_title` | [Optional[shared.SourceMixpanelOptionTitle]](../../models/shared/sourcemixpaneloptiontitle.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `option_title` | [Optional[models.SourceMixpanelOptionTitle]](../models/sourcemixpaneloptiontitle.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/serviceaccountkey.md b/docs/models/serviceaccountkey.md similarity index 95% rename from docs/models/shared/serviceaccountkey.md rename to docs/models/serviceaccountkey.md index 4ead0f7f..116c70f6 100644 --- a/docs/models/shared/serviceaccountkey.md +++ b/docs/models/serviceaccountkey.md @@ -9,4 +9,4 @@ For these scenario user should obtain service account's credentials from the Goo | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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. | | `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 +| `credentials_title` | [Optional[models.SourceGoogleDirectorySchemasCredentialsTitle]](../models/sourcegoogledirectoryschemascredentialstitle.md) | :heavy_minus_sign: | Authentication Scenario | \ No newline at end of file diff --git a/docs/models/shared/serviceaccountkeyauthentication.md b/docs/models/serviceaccountkeyauthentication.md similarity index 95% rename from docs/models/shared/serviceaccountkeyauthentication.md rename to docs/models/serviceaccountkeyauthentication.md index 38f56040..531606b1 100644 --- a/docs/models/shared/serviceaccountkeyauthentication.md +++ b/docs/models/serviceaccountkeyauthentication.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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 +| `auth_type` | [Optional[models.SourceGoogleAnalyticsDataAPISchemasAuthType]](../models/sourcegoogleanalyticsdataapischemasauthtype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/servicekeyauthentication.md b/docs/models/servicekeyauthentication.md similarity index 96% rename from docs/models/shared/servicekeyauthentication.md rename to docs/models/servicekeyauthentication.md index 841b73b6..736540ec 100644 --- a/docs/models/shared/servicekeyauthentication.md +++ b/docs/models/servicekeyauthentication.md @@ -10,6 +10,6 @@ This class is structured similarly to OAuthCredentials but for a different authe | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `client_id` | *str* | :heavy_check_mark: | Client ID of your Microsoft developer application | | `client_secret` | *str* | :heavy_check_mark: | Client Secret of your Microsoft developer application | -| `tenant_id` | *str* | :heavy_check_mark: | Tenant ID of the Microsoft SharePoint user | +| `tenant_id` | *str* | :heavy_check_mark: | Tenant ID of the Microsoft OneDrive user | | `user_principal_name` | *str* | :heavy_check_mark: | Special characters such as a period, comma, space, and the at sign (@) are converted to underscores (_). More details: https://learn.microsoft.com/en-us/sharepoint/list-onedrive-urls | -| `auth_type` | [Optional[shared.SourceMicrosoftSharepointSchemasAuthType]](../../models/shared/sourcemicrosoftsharepointschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `auth_type` | [Optional[models.SourceMicrosoftOnedriveSchemasAuthType]](../models/sourcemicrosoftonedriveschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/servicename.md b/docs/models/servicename.md new file mode 100644 index 00000000..034cfa74 --- /dev/null +++ b/docs/models/servicename.md @@ -0,0 +1,11 @@ +# ServiceName + +Use service name + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | +| `service_name` | *str* | :heavy_check_mark: | N/A | +| `connection_type` | [Optional[models.ConnectionType]](../models/connectiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sftp.md b/docs/models/sftp.md similarity index 100% rename from docs/models/shared/sftp.md rename to docs/models/sftp.md diff --git a/docs/models/shared/sftpbulk.md b/docs/models/sftpbulk.md similarity index 100% rename from docs/models/shared/sftpbulk.md rename to docs/models/sftpbulk.md diff --git a/docs/models/shared/sftpjson.md b/docs/models/sftpjson.md similarity index 100% rename from docs/models/shared/sftpjson.md rename to docs/models/sftpjson.md diff --git a/docs/models/sftpsecurefiletransferprotocol.md b/docs/models/sftpsecurefiletransferprotocol.md new file mode 100644 index 00000000..0d213e3c --- /dev/null +++ b/docs/models/sftpsecurefiletransferprotocol.md @@ -0,0 +1,12 @@ +# SFTPSecureFileTransferProtocol + + +## Fields + +| 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` | [models.SourceFileSchemasProviderStorageProvider7Storage](../models/sourcefileschemasproviderstorageprovider7storage.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/actionreporttime.md b/docs/models/shared/actionreporttime.md deleted file mode 100644 index e18b165f..00000000 --- a/docs/models/shared/actionreporttime.md +++ /dev/null @@ -1,12 +0,0 @@ -# ActionReportTime - -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. - - -## Values - -| Name | Value | -| ------------ | ------------ | -| `CONVERSION` | conversion | -| `IMPRESSION` | impression | -| `MIXED` | mixed | \ No newline at end of file diff --git a/docs/models/shared/airtable.md b/docs/models/shared/airtable.md deleted file mode 100644 index 86319011..00000000 --- a/docs/models/shared/airtable.md +++ /dev/null @@ -1,8 +0,0 @@ -# Airtable - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `credentials` | [Optional[shared.Credentials]](../../models/shared/credentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/allow.md b/docs/models/shared/allow.md deleted file mode 100644 index 8016adc3..00000000 --- a/docs/models/shared/allow.md +++ /dev/null @@ -1,10 +0,0 @@ -# Allow - -Allow SSL mode. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `mode` | [Optional[shared.DestinationPostgresMode]](../../models/shared/destinationpostgresmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/andgroup.md b/docs/models/shared/andgroup.md deleted file mode 100644 index a2d54f1c..00000000 --- a/docs/models/shared/andgroup.md +++ /dev/null @@ -1,11 +0,0 @@ -# AndGroup - -The FilterExpressions in andGroup have an AND relationship. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `expressions` | List[[shared.Expression](../../models/shared/expression.md)] | :heavy_check_mark: | N/A | -| `filter_type` | [shared.FilterType](../../models/shared/filtertype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/apikeyauth.md b/docs/models/shared/apikeyauth.md deleted file mode 100644 index 1db6d115..00000000 --- a/docs/models/shared/apikeyauth.md +++ /dev/null @@ -1,9 +0,0 @@ -# APIKeyAuth - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | API Key for the Qdrant instance | -| `mode` | [Optional[shared.DestinationQdrantSchemasIndexingMode]](../../models/shared/destinationqdrantschemasindexingmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/apikeysecret.md b/docs/models/shared/apikeysecret.md deleted file mode 100644 index b043a914..00000000 --- a/docs/models/shared/apikeysecret.md +++ /dev/null @@ -1,12 +0,0 @@ -# APIKeySecret - -Use a api key and secret combination to authenticate - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `api_key_id` | *str* | :heavy_check_mark: | The Key ID to used when accessing an enterprise Elasticsearch instance. | -| `api_key_secret` | *str* | :heavy_check_mark: | The secret associated with the API Key ID. | -| `method` | [shared.DestinationElasticsearchMethod](../../models/shared/destinationelasticsearchmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/apipassword.md b/docs/models/shared/apipassword.md deleted file mode 100644 index 298cea5f..00000000 --- a/docs/models/shared/apipassword.md +++ /dev/null @@ -1,11 +0,0 @@ -# APIPassword - -API Password Auth - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `api_password` | *str* | :heavy_check_mark: | The API Password for your private application in the `Shopify` store. | -| `auth_method` | [shared.SourceShopifySchemasAuthMethod](../../models/shared/sourceshopifyschemasauthmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/apitoken.md b/docs/models/shared/apitoken.md deleted file mode 100644 index daadaa2c..00000000 --- a/docs/models/shared/apitoken.md +++ /dev/null @@ -1,9 +0,0 @@ -# APIToken - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `api_token` | *str* | :heavy_check_mark: | API Token for making authenticated requests. | -| `auth_type` | [shared.SourceMondaySchemasAuthType](../../models/shared/sourcemondayschemasauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/asana.md b/docs/models/shared/asana.md deleted file mode 100644 index fbc3a2b9..00000000 --- a/docs/models/shared/asana.md +++ /dev/null @@ -1,8 +0,0 @@ -# Asana - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `credentials` | [Optional[shared.AsanaCredentials]](../../models/shared/asanacredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/authenticateviaasanaoauth.md b/docs/models/shared/authenticateviaasanaoauth.md deleted file mode 100644 index 897cab89..00000000 --- a/docs/models/shared/authenticateviaasanaoauth.md +++ /dev/null @@ -1,11 +0,0 @@ -# AuthenticateViaAsanaOauth - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `client_id` | *str* | :heavy_check_mark: | N/A | -| `client_secret` | *str* | :heavy_check_mark: | N/A | -| `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 deleted file mode 100644 index 05e63d25..00000000 --- a/docs/models/shared/authenticateviagoogleoauth.md +++ /dev/null @@ -1,12 +0,0 @@ -# AuthenticateViaGoogleOauth - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `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. | -| `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 deleted file mode 100644 index bfe06a97..00000000 --- a/docs/models/shared/authenticateviaharvestoauth.md +++ /dev/null @@ -1,12 +0,0 @@ -# AuthenticateViaHarvestOAuth - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `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. | -| `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/authenticatevialeverapikey.md b/docs/models/shared/authenticatevialeverapikey.md deleted file mode 100644 index bdb98050..00000000 --- a/docs/models/shared/authenticatevialeverapikey.md +++ /dev/null @@ -1,9 +0,0 @@ -# AuthenticateViaLeverAPIKey - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `api_key` | *str* | :heavy_check_mark: | The Api Key of your Lever Hiring account. | -| `auth_type` | [Optional[shared.SourceLeverHiringSchemasAuthType]](../../models/shared/sourceleverhiringschemasauthtype.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 deleted file mode 100644 index 61e028a8..00000000 --- a/docs/models/shared/authenticatevialeveroauth.md +++ /dev/null @@ -1,11 +0,0 @@ -# AuthenticateViaLeverOAuth - - -## Fields - -| 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. | \ No newline at end of file diff --git a/docs/models/shared/authenticateviamicrosoftoauth.md b/docs/models/shared/authenticateviamicrosoftoauth.md deleted file mode 100644 index c9b445ac..00000000 --- a/docs/models/shared/authenticateviamicrosoftoauth.md +++ /dev/null @@ -1,15 +0,0 @@ -# AuthenticateViaMicrosoftOAuth - -OAuthCredentials class to hold authentication details for Microsoft OAuth authentication. -This class uses pydantic for data validation and settings management. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `client_id` | *str* | :heavy_check_mark: | Client ID of your Microsoft developer application | -| `client_secret` | *str* | :heavy_check_mark: | Client Secret of your Microsoft developer application | -| `refresh_token` | *str* | :heavy_check_mark: | Refresh Token of your Microsoft developer application | -| `tenant_id` | *str* | :heavy_check_mark: | Tenant ID of the Microsoft SharePoint user | -| `auth_type` | [Optional[shared.SourceMicrosoftSharepointAuthType]](../../models/shared/sourcemicrosoftsharepointauthtype.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 deleted file mode 100644 index e2c0d9cc..00000000 --- a/docs/models/shared/authenticateviaoauth.md +++ /dev/null @@ -1,13 +0,0 @@ -# AuthenticateViaOAuth - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `access_token` | *str* | :heavy_check_mark: | Access Token for making authenticated requests. | -| `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. | -| `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/authenticatewithpersonalaccesstoken.md b/docs/models/shared/authenticatewithpersonalaccesstoken.md deleted file mode 100644 index 14c6c23b..00000000 --- a/docs/models/shared/authenticatewithpersonalaccesstoken.md +++ /dev/null @@ -1,9 +0,0 @@ -# AuthenticateWithPersonalAccessToken - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `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/authenticationmechanism.md b/docs/models/shared/authenticationmechanism.md deleted file mode 100644 index c3cb0b39..00000000 --- a/docs/models/shared/authenticationmechanism.md +++ /dev/null @@ -1,19 +0,0 @@ -# AuthenticationMechanism - -Choose how to authenticate to Github - - -## Supported Types - -### AuthenticateViaAsanaOauth - -```python -authenticationMechanism: shared.AuthenticateViaAsanaOauth = /* values here */ -``` - -### AuthenticateWithPersonalAccessToken - -```python -authenticationMechanism: shared.AuthenticateWithPersonalAccessToken = /* values here */ -``` - diff --git a/docs/models/shared/authenticationmethod.md b/docs/models/shared/authenticationmethod.md deleted file mode 100644 index 0e7657a6..00000000 --- a/docs/models/shared/authenticationmethod.md +++ /dev/null @@ -1,19 +0,0 @@ -# AuthenticationMethod - -The type of authentication to be used - - -## Supported Types - -### APIKeySecret - -```python -authenticationMethod: shared.APIKeySecret = /* values here */ -``` - -### UsernamePassword - -```python -authenticationMethod: shared.UsernamePassword = /* values here */ -``` - diff --git a/docs/models/shared/authenticationmode.md b/docs/models/shared/authenticationmode.md deleted file mode 100644 index 582639b1..00000000 --- a/docs/models/shared/authenticationmode.md +++ /dev/null @@ -1,19 +0,0 @@ -# AuthenticationMode - -Choose How to Authenticate to AWS. - - -## Supported Types - -### IAMRole - -```python -authenticationMode: shared.IAMRole = /* values here */ -``` - -### IAMUser - -```python -authenticationMode: shared.IAMUser = /* values here */ -``` - diff --git a/docs/models/shared/authenticationtype.md b/docs/models/shared/authenticationtype.md deleted file mode 100644 index 26fba799..00000000 --- a/docs/models/shared/authenticationtype.md +++ /dev/null @@ -1,17 +0,0 @@ -# AuthenticationType - - -## Supported Types - -### SourceGoogleSearchConsoleOAuth - -```python -authenticationType: shared.SourceGoogleSearchConsoleOAuth = /* values here */ -``` - -### SourceGoogleSearchConsoleServiceAccountKeyAuthentication - -```python -authenticationType: shared.SourceGoogleSearchConsoleServiceAccountKeyAuthentication = /* values here */ -``` - diff --git a/docs/models/shared/authenticationwildcard.md b/docs/models/shared/authenticationwildcard.md deleted file mode 100644 index 621a978c..00000000 --- a/docs/models/shared/authenticationwildcard.md +++ /dev/null @@ -1,19 +0,0 @@ -# AuthenticationWildcard - -Choose how to authenticate to Mixpanel - - -## Supported Types - -### ServiceAccount - -```python -authenticationWildcard: shared.ServiceAccount = /* values here */ -``` - -### ProjectSecret - -```python -authenticationWildcard: shared.ProjectSecret = /* values here */ -``` - diff --git a/docs/models/shared/authorizationmethod.md b/docs/models/shared/authorizationmethod.md deleted file mode 100644 index 1436869f..00000000 --- a/docs/models/shared/authorizationmethod.md +++ /dev/null @@ -1,23 +0,0 @@ -# AuthorizationMethod - - -## Supported Types - -### KeyPairAuthentication - -```python -authorizationMethod: shared.KeyPairAuthentication = /* values here */ -``` - -### UsernameAndPassword - -```python -authorizationMethod: shared.UsernameAndPassword = /* values here */ -``` - -### DestinationSnowflakeOAuth20 - -```python -authorizationMethod: shared.DestinationSnowflakeOAuth20 = /* values here */ -``` - diff --git a/docs/models/shared/authorizationtype.md b/docs/models/shared/authorizationtype.md deleted file mode 100644 index 2cb866a7..00000000 --- a/docs/models/shared/authorizationtype.md +++ /dev/null @@ -1,19 +0,0 @@ -# AuthorizationType - -Authorization type. - - -## Supported Types - -### NoneT - -```python -authorizationType: shared.NoneT = /* values here */ -``` - -### LoginPassword - -```python -authorizationType: shared.LoginPassword = /* values here */ -``` - diff --git a/docs/models/shared/autogenerated.md b/docs/models/shared/autogenerated.md deleted file mode 100644 index 6f5b2741..00000000 --- a/docs/models/shared/autogenerated.md +++ /dev/null @@ -1,8 +0,0 @@ -# Autogenerated - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `header_definition_type` | [Optional[shared.SourceAzureBlobStorageHeaderDefinitionType]](../../models/shared/sourceazureblobstorageheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/avro.md b/docs/models/shared/avro.md deleted file mode 100644 index 781b43a4..00000000 --- a/docs/models/shared/avro.md +++ /dev/null @@ -1,10 +0,0 @@ -# Avro - -This connector utilises fastavro for Avro parsing. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `filetype` | [Optional[shared.SourceS3SchemasFiletype]](../../models/shared/sources3schemasfiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/avroapacheavro.md b/docs/models/shared/avroapacheavro.md deleted file mode 100644 index ead9343b..00000000 --- a/docs/models/shared/avroapacheavro.md +++ /dev/null @@ -1,9 +0,0 @@ -# AvroApacheAvro - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `compression_codec` | [Union[shared.NoCompression, shared.Deflate, shared.Bzip2, shared.Xz, shared.Zstandard, shared.Snappy]](../../models/shared/compressioncodec.md) | :heavy_check_mark: | The compression algorithm used to compress data. Default to no compression. | -| `format_type` | [Optional[shared.DestinationGcsFormatType]](../../models/shared/destinationgcsformattype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/baseurl.md b/docs/models/shared/baseurl.md deleted file mode 100644 index cc1ee7e9..00000000 --- a/docs/models/shared/baseurl.md +++ /dev/null @@ -1,19 +0,0 @@ -# BaseURL - -Is your account location is EU based? If yes, the base url to retrieve data will be different. - - -## Supported Types - -### EUBasedAccount - -```python -baseURL: shared.EUBasedAccount = /* values here */ -``` - -### GlobalAccount - -```python -baseURL: shared.GlobalAccount = /* values here */ -``` - diff --git a/docs/models/shared/betweenfilter.md b/docs/models/shared/betweenfilter.md deleted file mode 100644 index e6893fe7..00000000 --- a/docs/models/shared/betweenfilter.md +++ /dev/null @@ -1,10 +0,0 @@ -# BetweenFilter - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `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/bymarkdownheader.md b/docs/models/shared/bymarkdownheader.md deleted file mode 100644 index 0f3bdb73..00000000 --- a/docs/models/shared/bymarkdownheader.md +++ /dev/null @@ -1,11 +0,0 @@ -# ByMarkdownHeader - -Split the text by Markdown headers down to the specified header level. If the chunk size fits multiple sections, they will be combined into a single chunk. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `mode` | [Optional[shared.DestinationAstraSchemasProcessingTextSplitterMode]](../../models/shared/destinationastraschemasprocessingtextsplittermode.md) | :heavy_minus_sign: | N/A | -| `split_level` | *Optional[int]* | :heavy_minus_sign: | Level of markdown headers to split text fields by. Headings down to the specified level will be used as split points | \ No newline at end of file diff --git a/docs/models/shared/byprogramminglanguage.md b/docs/models/shared/byprogramminglanguage.md deleted file mode 100644 index f7ca0048..00000000 --- a/docs/models/shared/byprogramminglanguage.md +++ /dev/null @@ -1,11 +0,0 @@ -# ByProgrammingLanguage - -Split the text by suitable delimiters based on the programming language. This is useful for splitting code into chunks. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `language` | [shared.DestinationAstraLanguage](../../models/shared/destinationastralanguage.md) | :heavy_check_mark: | Split code in suitable places based on the programming language | -| `mode` | [Optional[shared.DestinationAstraSchemasProcessingTextSplitterTextSplitterMode]](../../models/shared/destinationastraschemasprocessingtextsplittertextsplittermode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/bzip2.md b/docs/models/shared/bzip2.md deleted file mode 100644 index d7ef4757..00000000 --- a/docs/models/shared/bzip2.md +++ /dev/null @@ -1,8 +0,0 @@ -# Bzip2 - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `codec` | [Optional[shared.DestinationGcsSchemasCodec]](../../models/shared/destinationgcsschemascodec.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/chromalocalpersistance.md b/docs/models/shared/chromalocalpersistance.md deleted file mode 100644 index 6fe31206..00000000 --- a/docs/models/shared/chromalocalpersistance.md +++ /dev/null @@ -1,12 +0,0 @@ -# ChromaLocalPersistance - -Chroma is a popular vector store that can be used to store and retrieve embeddings. It will build its index in memory and persist it to disk by the end of the sync. - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `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.DestinationLangchainSchemasIndexingIndexing3Mode]](../../models/shared/destinationlangchainschemasindexingindexing3mode.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/clustertype.md b/docs/models/shared/clustertype.md deleted file mode 100644 index 3cbe341a..00000000 --- a/docs/models/shared/clustertype.md +++ /dev/null @@ -1,19 +0,0 @@ -# ClusterType - -Configures the MongoDB cluster type. - - -## Supported Types - -### MongoDBAtlasReplicaSet - -```python -clusterType: shared.MongoDBAtlasReplicaSet = /* values here */ -``` - -### SelfManagedReplicaSet - -```python -clusterType: shared.SelfManagedReplicaSet = /* values here */ -``` - diff --git a/docs/models/shared/cohere.md b/docs/models/shared/cohere.md deleted file mode 100644 index 5bd80633..00000000 --- a/docs/models/shared/cohere.md +++ /dev/null @@ -1,11 +0,0 @@ -# Cohere - -Use the Cohere API to embed text. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `cohere_key` | *str* | :heavy_check_mark: | N/A | -| `mode` | [Optional[shared.DestinationAstraMode]](../../models/shared/destinationastramode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/cohortreports.md b/docs/models/shared/cohortreports.md deleted file mode 100644 index 0c4f3fa0..00000000 --- a/docs/models/shared/cohortreports.md +++ /dev/null @@ -1,19 +0,0 @@ -# CohortReports - -Cohort reports creates a time series of user retention for the cohort. - - -## Supported Types - -### SourceGoogleAnalyticsDataAPIDisabled - -```python -cohortReports: shared.SourceGoogleAnalyticsDataAPIDisabled = /* values here */ -``` - -### SourceGoogleAnalyticsDataAPISchemasEnabled - -```python -cohortReports: shared.SourceGoogleAnalyticsDataAPISchemasEnabled = /* values here */ -``` - diff --git a/docs/models/shared/compression.md b/docs/models/shared/compression.md deleted file mode 100644 index be17ad89..00000000 --- a/docs/models/shared/compression.md +++ /dev/null @@ -1,19 +0,0 @@ -# Compression - -Whether the output files should be compressed. If compression is selected, the output filename will have an extra extension (GZIP: ".csv.gz"). - - -## Supported Types - -### DestinationGcsNoCompression - -```python -compression: shared.DestinationGcsNoCompression = /* values here */ -``` - -### Gzip - -```python -compression: shared.Gzip = /* values here */ -``` - diff --git a/docs/models/shared/compressioncodec.md b/docs/models/shared/compressioncodec.md deleted file mode 100644 index ec44df35..00000000 --- a/docs/models/shared/compressioncodec.md +++ /dev/null @@ -1,43 +0,0 @@ -# CompressionCodec - -The compression algorithm used to compress data. Default to no compression. - - -## Supported Types - -### NoCompression - -```python -compressionCodec: shared.NoCompression = /* values here */ -``` - -### Deflate - -```python -compressionCodec: shared.Deflate = /* values here */ -``` - -### Bzip2 - -```python -compressionCodec: shared.Bzip2 = /* values here */ -``` - -### Xz - -```python -compressionCodec: shared.Xz = /* values here */ -``` - -### Zstandard - -```python -compressionCodec: shared.Zstandard = /* values here */ -``` - -### Snappy - -```python -compressionCodec: shared.Snappy = /* values here */ -``` - diff --git a/docs/models/shared/connectby.md b/docs/models/shared/connectby.md deleted file mode 100644 index edb49e21..00000000 --- a/docs/models/shared/connectby.md +++ /dev/null @@ -1,19 +0,0 @@ -# ConnectBy - -Connect data that will be used for DB connection - - -## Supported Types - -### ServiceName - -```python -connectBy: shared.ServiceName = /* values here */ -``` - -### SystemIDSID - -```python -connectBy: shared.SystemIDSID = /* values here */ -``` - diff --git a/docs/models/shared/connectionresponse.md b/docs/models/shared/connectionresponse.md deleted file mode 100644 index b7ae038d..00000000 --- a/docs/models/shared/connectionresponse.md +++ /dev/null @@ -1,22 +0,0 @@ -# ConnectionResponse - -Provides details of a single connection. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `destination_id` | *str* | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | 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 | -| `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 deleted file mode 100644 index c6322857..00000000 --- a/docs/models/shared/connectionschedule.md +++ /dev/null @@ -1,11 +0,0 @@ -# ConnectionSchedule - -schedule for when the the connection should run, per the schedule type - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `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 deleted file mode 100644 index 70132466..00000000 --- a/docs/models/shared/connectionscheduleresponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ConnectionScheduleResponse - -schedule for when the the connection should run, per the schedule type - - -## Fields - -| 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 | \ No newline at end of file diff --git a/docs/models/shared/connectionsresponse.md b/docs/models/shared/connectionsresponse.md deleted file mode 100644 index bb043640..00000000 --- a/docs/models/shared/connectionsresponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# ConnectionsResponse - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `data` | List[[shared.ConnectionResponse](../../models/shared/connectionresponse.md)] | :heavy_check_mark: | N/A | -| `next` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `previous` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/cumulio.md b/docs/models/shared/cumulio.md deleted file mode 100644 index 17279e0f..00000000 --- a/docs/models/shared/cumulio.md +++ /dev/null @@ -1,8 +0,0 @@ -# Cumulio - - -## Values - -| Name | Value | -| --------- | --------- | -| `CUMULIO` | cumulio | \ No newline at end of file diff --git a/docs/models/shared/databend.md b/docs/models/shared/databend.md deleted file mode 100644 index dd0f8c69..00000000 --- a/docs/models/shared/databend.md +++ /dev/null @@ -1,8 +0,0 @@ -# Databend - - -## Values - -| Name | Value | -| ---------- | ---------- | -| `DATABEND` | databend | \ No newline at end of file diff --git a/docs/models/shared/datasource.md b/docs/models/shared/datasource.md deleted file mode 100644 index d904af5b..00000000 --- a/docs/models/shared/datasource.md +++ /dev/null @@ -1,25 +0,0 @@ -# DataSource - -Storage on which the delta lake is built. - - -## Supported Types - -### RecommendedManagedTables - -```python -dataSource: shared.RecommendedManagedTables = /* values here */ -``` - -### AmazonS3 - -```python -dataSource: shared.AmazonS3 = /* values here */ -``` - -### DestinationDatabricksAzureBlobStorage - -```python -dataSource: shared.DestinationDatabricksAzureBlobStorage = /* values here */ -``` - diff --git a/docs/models/shared/deflate.md b/docs/models/shared/deflate.md deleted file mode 100644 index 9d5ebf78..00000000 --- a/docs/models/shared/deflate.md +++ /dev/null @@ -1,9 +0,0 @@ -# Deflate - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `codec` | [Optional[shared.DestinationGcsCodec]](../../models/shared/destinationgcscodec.md) | :heavy_minus_sign: | N/A | -| `compression_level` | *Optional[int]* | :heavy_minus_sign: | 0: no compression & fastest, 9: best compression & slowest. | \ No newline at end of file diff --git a/docs/models/shared/destinationazureblobstoragejsonlinesnewlinedelimitedjson.md b/docs/models/shared/destinationazureblobstoragejsonlinesnewlinedelimitedjson.md deleted file mode 100644 index 978cbc23..00000000 --- a/docs/models/shared/destinationazureblobstoragejsonlinesnewlinedelimitedjson.md +++ /dev/null @@ -1,8 +0,0 @@ -# DestinationAzureBlobStorageJSONLinesNewlineDelimitedJSON - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `format_type` | [shared.DestinationAzureBlobStorageFormatType](../../models/shared/destinationazureblobstorageformattype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationconfiguration.md b/docs/models/shared/destinationconfiguration.md deleted file mode 100644 index 696f3184..00000000 --- a/docs/models/shared/destinationconfiguration.md +++ /dev/null @@ -1,259 +0,0 @@ -# DestinationConfiguration - -The values required to configure the destination. - - -## Supported Types - -### DestinationGoogleSheets - -```python -destinationConfiguration: shared.DestinationGoogleSheets = /* values here */ -``` - -### DestinationAstra - -```python -destinationConfiguration: shared.DestinationAstra = /* values here */ -``` - -### DestinationAwsDatalake - -```python -destinationConfiguration: shared.DestinationAwsDatalake = /* values here */ -``` - -### DestinationAzureBlobStorage - -```python -destinationConfiguration: shared.DestinationAzureBlobStorage = /* values here */ -``` - -### DestinationBigquery - -```python -destinationConfiguration: shared.DestinationBigquery = /* values here */ -``` - -### DestinationClickhouse - -```python -destinationConfiguration: shared.DestinationClickhouse = /* values here */ -``` - -### DestinationConvex - -```python -destinationConfiguration: shared.DestinationConvex = /* values here */ -``` - -### DestinationCumulio - -```python -destinationConfiguration: shared.DestinationCumulio = /* values here */ -``` - -### DestinationDatabend - -```python -destinationConfiguration: shared.DestinationDatabend = /* values here */ -``` - -### DestinationDatabricks - -```python -destinationConfiguration: shared.DestinationDatabricks = /* values here */ -``` - -### DestinationDevNull - -```python -destinationConfiguration: shared.DestinationDevNull = /* values here */ -``` - -### DestinationDuckdb - -```python -destinationConfiguration: shared.DestinationDuckdb = /* values here */ -``` - -### DestinationDynamodb - -```python -destinationConfiguration: shared.DestinationDynamodb = /* values here */ -``` - -### DestinationElasticsearch - -```python -destinationConfiguration: shared.DestinationElasticsearch = /* values here */ -``` - -### DestinationFirebolt - -```python -destinationConfiguration: shared.DestinationFirebolt = /* values here */ -``` - -### DestinationFirestore - -```python -destinationConfiguration: shared.DestinationFirestore = /* values here */ -``` - -### DestinationGcs - -```python -destinationConfiguration: shared.DestinationGcs = /* values here */ -``` - -### DestinationKeen - -```python -destinationConfiguration: shared.DestinationKeen = /* values here */ -``` - -### DestinationKinesis - -```python -destinationConfiguration: shared.DestinationKinesis = /* values here */ -``` - -### DestinationLangchain - -```python -destinationConfiguration: shared.DestinationLangchain = /* values here */ -``` - -### DestinationMilvus - -```python -destinationConfiguration: shared.DestinationMilvus = /* values here */ -``` - -### DestinationMongodb - -```python -destinationConfiguration: shared.DestinationMongodb = /* values here */ -``` - -### DestinationMssql - -```python -destinationConfiguration: shared.DestinationMssql = /* values here */ -``` - -### DestinationMysql - -```python -destinationConfiguration: shared.DestinationMysql = /* values here */ -``` - -### DestinationOracle - -```python -destinationConfiguration: shared.DestinationOracle = /* values here */ -``` - -### DestinationPinecone - -```python -destinationConfiguration: shared.DestinationPinecone = /* values here */ -``` - -### DestinationPostgres - -```python -destinationConfiguration: shared.DestinationPostgres = /* values here */ -``` - -### DestinationPubsub - -```python -destinationConfiguration: shared.DestinationPubsub = /* values here */ -``` - -### DestinationQdrant - -```python -destinationConfiguration: shared.DestinationQdrant = /* values here */ -``` - -### DestinationRedis - -```python -destinationConfiguration: shared.DestinationRedis = /* values here */ -``` - -### DestinationRedshift - -```python -destinationConfiguration: shared.DestinationRedshift = /* values here */ -``` - -### DestinationS3 - -```python -destinationConfiguration: shared.DestinationS3 = /* values here */ -``` - -### DestinationS3Glue - -```python -destinationConfiguration: shared.DestinationS3Glue = /* values here */ -``` - -### DestinationSftpJSON - -```python -destinationConfiguration: shared.DestinationSftpJSON = /* values here */ -``` - -### DestinationSnowflake - -```python -destinationConfiguration: shared.DestinationSnowflake = /* values here */ -``` - -### DestinationTeradata - -```python -destinationConfiguration: shared.DestinationTeradata = /* values here */ -``` - -### DestinationTimeplus - -```python -destinationConfiguration: shared.DestinationTimeplus = /* values here */ -``` - -### DestinationTypesense - -```python -destinationConfiguration: shared.DestinationTypesense = /* values here */ -``` - -### DestinationVectara - -```python -destinationConfiguration: shared.DestinationVectara = /* values here */ -``` - -### DestinationVertica - -```python -destinationConfiguration: shared.DestinationVertica = /* values here */ -``` - -### DestinationWeaviate - -```python -destinationConfiguration: shared.DestinationWeaviate = /* values here */ -``` - -### DestinationXata - -```python -destinationConfiguration: shared.DestinationXata = /* values here */ -``` - diff --git a/docs/models/shared/destinationcreaterequest.md b/docs/models/shared/destinationcreaterequest.md deleted file mode 100644 index dce6dfcc..00000000 --- a/docs/models/shared/destinationcreaterequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# DestinationCreateRequest - - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `configuration` | [Union[shared.DestinationGoogleSheets, shared.DestinationAstra, 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.DestinationTeradata, 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"
    } | -| `name` | *str* | :heavy_check_mark: | Name of the destination e.g. dev-mysql-instance. | | -| `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 deleted file mode 100644 index 2dd1616c..00000000 --- a/docs/models/shared/destinationcumulio.md +++ /dev/null @@ -1,11 +0,0 @@ -# DestinationCumulio - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 deleted file mode 100644 index dac88f4a..00000000 --- a/docs/models/shared/destinationdatabend.md +++ /dev/null @@ -1,14 +0,0 @@ -# DestinationDatabend - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `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 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 | \ No newline at end of file diff --git a/docs/models/shared/destinationdevnull.md b/docs/models/shared/destinationdevnull.md deleted file mode 100644 index 3f70e443..00000000 --- a/docs/models/shared/destinationdevnull.md +++ /dev/null @@ -1,9 +0,0 @@ -# DestinationDevNull - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `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/destinationfirebolt.md b/docs/models/shared/destinationfirebolt.md deleted file mode 100644 index eaf82dde..00000000 --- a/docs/models/shared/destinationfirebolt.md +++ /dev/null @@ -1,15 +0,0 @@ -# DestinationFirebolt - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `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 | | \ No newline at end of file diff --git a/docs/models/shared/destinationfireboltloadingmethod.md b/docs/models/shared/destinationfireboltloadingmethod.md deleted file mode 100644 index c665aae9..00000000 --- a/docs/models/shared/destinationfireboltloadingmethod.md +++ /dev/null @@ -1,19 +0,0 @@ -# DestinationFireboltLoadingMethod - -Loading method used to select the way data will be uploaded to Firebolt - - -## Supported Types - -### SQLInserts - -```python -destinationFireboltLoadingMethod: shared.SQLInserts = /* values here */ -``` - -### ExternalTableViaS3 - -```python -destinationFireboltLoadingMethod: shared.ExternalTableViaS3 = /* values here */ -``` - diff --git a/docs/models/shared/destinationfireboltmethod.md b/docs/models/shared/destinationfireboltmethod.md deleted file mode 100644 index e81d89c8..00000000 --- a/docs/models/shared/destinationfireboltmethod.md +++ /dev/null @@ -1,8 +0,0 @@ -# DestinationFireboltMethod - - -## Values - -| Name | Value | -| ----- | ----- | -| `SQL` | SQL | \ No newline at end of file diff --git a/docs/models/shared/destinationfireboltschemasmethod.md b/docs/models/shared/destinationfireboltschemasmethod.md deleted file mode 100644 index 029a6ce8..00000000 --- a/docs/models/shared/destinationfireboltschemasmethod.md +++ /dev/null @@ -1,8 +0,0 @@ -# DestinationFireboltSchemasMethod - - -## Values - -| Name | Value | -| ----- | ----- | -| `S3` | S3 | \ No newline at end of file diff --git a/docs/models/shared/destinationgcscompression.md b/docs/models/shared/destinationgcscompression.md deleted file mode 100644 index 5430478e..00000000 --- a/docs/models/shared/destinationgcscompression.md +++ /dev/null @@ -1,19 +0,0 @@ -# DestinationGcsCompression - -Whether the output files should be compressed. If compression is selected, the output filename will have an extra extension (GZIP: ".jsonl.gz"). - - -## Supported Types - -### DestinationGcsSchemasNoCompression - -```python -destinationGcsCompression: shared.DestinationGcsSchemasNoCompression = /* values here */ -``` - -### DestinationGcsGZIP - -```python -destinationGcsCompression: shared.DestinationGcsGZIP = /* values here */ -``` - diff --git a/docs/models/shared/destinationgcsgzip.md b/docs/models/shared/destinationgcsgzip.md deleted file mode 100644 index 41699fae..00000000 --- a/docs/models/shared/destinationgcsgzip.md +++ /dev/null @@ -1,8 +0,0 @@ -# DestinationGcsGZIP - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `compression_type` | [Optional[shared.DestinationGcsSchemasFormatCompressionType]](../../models/shared/destinationgcsschemasformatcompressiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationgcsnocompression.md b/docs/models/shared/destinationgcsnocompression.md deleted file mode 100644 index ed5666ba..00000000 --- a/docs/models/shared/destinationgcsnocompression.md +++ /dev/null @@ -1,8 +0,0 @@ -# DestinationGcsNoCompression - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `compression_type` | [Optional[shared.CompressionType]](../../models/shared/compressiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationgcsschemasnocompression.md b/docs/models/shared/destinationgcsschemasnocompression.md deleted file mode 100644 index 3393586a..00000000 --- a/docs/models/shared/destinationgcsschemasnocompression.md +++ /dev/null @@ -1,8 +0,0 @@ -# DestinationGcsSchemasNoCompression - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `compression_type` | [Optional[shared.DestinationGcsSchemasCompressionType]](../../models/shared/destinationgcsschemascompressiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationkeen.md b/docs/models/shared/destinationkeen.md deleted file mode 100644 index 1573adb2..00000000 --- a/docs/models/shared/destinationkeen.md +++ /dev/null @@ -1,11 +0,0 @@ -# DestinationKeen - - -## Fields - -| 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. | | \ No newline at end of file diff --git a/docs/models/shared/destinationkinesis.md b/docs/models/shared/destinationkinesis.md deleted file mode 100644 index 5c2127ed..00000000 --- a/docs/models/shared/destinationkinesis.md +++ /dev/null @@ -1,14 +0,0 @@ -# DestinationKinesis - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `access_key` | *str* | :heavy_check_mark: | Generate the AWS Access Key for current user. | | -| `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 deleted file mode 100644 index 505a0344..00000000 --- a/docs/models/shared/destinationlangchain.md +++ /dev/null @@ -1,11 +0,0 @@ -# DestinationLangchain - - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `embedding` | [Union[shared.DestinationLangchainOpenAI, shared.DestinationLangchainFake]](../../models/shared/destinationlangchainembedding.md) | :heavy_check_mark: | Embedding configuration | -| `indexing` | [Union[shared.DestinationLangchainPinecone, shared.DocArrayHnswSearch, shared.ChromaLocalPersistance]](../../models/shared/destinationlangchainindexing.md) | :heavy_check_mark: | Indexing configuration | -| `processing` | [shared.DestinationLangchainProcessingConfigModel](../../models/shared/destinationlangchainprocessingconfigmodel.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/destinationlangchainembedding.md b/docs/models/shared/destinationlangchainembedding.md deleted file mode 100644 index 72bd5ae1..00000000 --- a/docs/models/shared/destinationlangchainembedding.md +++ /dev/null @@ -1,19 +0,0 @@ -# DestinationLangchainEmbedding - -Embedding configuration - - -## Supported Types - -### DestinationLangchainOpenAI - -```python -destinationLangchainEmbedding: shared.DestinationLangchainOpenAI = /* values here */ -``` - -### DestinationLangchainFake - -```python -destinationLangchainEmbedding: shared.DestinationLangchainFake = /* values here */ -``` - diff --git a/docs/models/shared/destinationlangchainfake.md b/docs/models/shared/destinationlangchainfake.md deleted file mode 100644 index 29d3a21c..00000000 --- a/docs/models/shared/destinationlangchainfake.md +++ /dev/null @@ -1,10 +0,0 @@ -# DestinationLangchainFake - -Use a fake embedding made out of random vectors with 1536 embedding dimensions. This is useful for testing the data pipeline without incurring any costs. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `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/destinationlangchainindexing.md b/docs/models/shared/destinationlangchainindexing.md deleted file mode 100644 index 61162b09..00000000 --- a/docs/models/shared/destinationlangchainindexing.md +++ /dev/null @@ -1,25 +0,0 @@ -# DestinationLangchainIndexing - -Indexing configuration - - -## Supported Types - -### DestinationLangchainPinecone - -```python -destinationLangchainIndexing: shared.DestinationLangchainPinecone = /* values here */ -``` - -### DocArrayHnswSearch - -```python -destinationLangchainIndexing: shared.DocArrayHnswSearch = /* values here */ -``` - -### ChromaLocalPersistance - -```python -destinationLangchainIndexing: shared.ChromaLocalPersistance = /* values here */ -``` - diff --git a/docs/models/shared/destinationlangchainopenai.md b/docs/models/shared/destinationlangchainopenai.md deleted file mode 100644 index e0299001..00000000 --- a/docs/models/shared/destinationlangchainopenai.md +++ /dev/null @@ -1,11 +0,0 @@ -# DestinationLangchainOpenAI - -Use the OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `openai_key` | *str* | :heavy_check_mark: | N/A | -| `mode` | [Optional[shared.DestinationLangchainMode]](../../models/shared/destinationlangchainmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationlangchainpinecone.md b/docs/models/shared/destinationlangchainpinecone.md deleted file mode 100644 index c1f39842..00000000 --- a/docs/models/shared/destinationlangchainpinecone.md +++ /dev/null @@ -1,13 +0,0 @@ -# DestinationLangchainPinecone - -Pinecone is a popular vector store that can be used to store and retrieve embeddings. It is a managed service and can also be queried from outside of langchain. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `index` | *str* | :heavy_check_mark: | Pinecone index to use | -| `pinecone_environment` | *str* | :heavy_check_mark: | Pinecone environment to use | -| `pinecone_key` | *str* | :heavy_check_mark: | N/A | -| `mode` | [Optional[shared.DestinationLangchainSchemasIndexingMode]](../../models/shared/destinationlangchainschemasindexingmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationmilvusapitoken.md b/docs/models/shared/destinationmilvusapitoken.md deleted file mode 100644 index 8903e150..00000000 --- a/docs/models/shared/destinationmilvusapitoken.md +++ /dev/null @@ -1,11 +0,0 @@ -# DestinationMilvusAPIToken - -Authenticate using an API token (suitable for Zilliz Cloud) - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `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/destinationmilvusauthentication.md b/docs/models/shared/destinationmilvusauthentication.md deleted file mode 100644 index 0d0594fb..00000000 --- a/docs/models/shared/destinationmilvusauthentication.md +++ /dev/null @@ -1,25 +0,0 @@ -# DestinationMilvusAuthentication - -Authentication method - - -## Supported Types - -### DestinationMilvusAPIToken - -```python -destinationMilvusAuthentication: shared.DestinationMilvusAPIToken = /* values here */ -``` - -### DestinationMilvusUsernamePassword - -```python -destinationMilvusAuthentication: shared.DestinationMilvusUsernamePassword = /* values here */ -``` - -### NoAuth - -```python -destinationMilvusAuthentication: shared.NoAuth = /* values here */ -``` - diff --git a/docs/models/shared/destinationmilvusazureopenai.md b/docs/models/shared/destinationmilvusazureopenai.md deleted file mode 100644 index b2b773ec..00000000 --- a/docs/models/shared/destinationmilvusazureopenai.md +++ /dev/null @@ -1,13 +0,0 @@ -# DestinationMilvusAzureOpenAI - -Use the Azure-hosted OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions. - - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `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/destinationmilvusbymarkdownheader.md b/docs/models/shared/destinationmilvusbymarkdownheader.md deleted file mode 100644 index af7d850c..00000000 --- a/docs/models/shared/destinationmilvusbymarkdownheader.md +++ /dev/null @@ -1,11 +0,0 @@ -# DestinationMilvusByMarkdownHeader - -Split the text by Markdown headers down to the specified header level. If the chunk size fits multiple sections, they will be combined into a single chunk. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `mode` | [Optional[shared.DestinationMilvusSchemasProcessingTextSplitterMode]](../../models/shared/destinationmilvusschemasprocessingtextsplittermode.md) | :heavy_minus_sign: | N/A | -| `split_level` | *Optional[int]* | :heavy_minus_sign: | Level of markdown headers to split text fields by. Headings down to the specified level will be used as split points | \ No newline at end of file diff --git a/docs/models/shared/destinationmilvusbyprogramminglanguage.md b/docs/models/shared/destinationmilvusbyprogramminglanguage.md deleted file mode 100644 index 072b5db6..00000000 --- a/docs/models/shared/destinationmilvusbyprogramminglanguage.md +++ /dev/null @@ -1,11 +0,0 @@ -# DestinationMilvusByProgrammingLanguage - -Split the text by suitable delimiters based on the programming language. This is useful for splitting code into chunks. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `language` | [shared.DestinationMilvusLanguage](../../models/shared/destinationmilvuslanguage.md) | :heavy_check_mark: | Split code in suitable places based on the programming language | -| `mode` | [Optional[shared.DestinationMilvusSchemasProcessingTextSplitterTextSplitterMode]](../../models/shared/destinationmilvusschemasprocessingtextsplittertextsplittermode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationmilvuscohere.md b/docs/models/shared/destinationmilvuscohere.md deleted file mode 100644 index c5b7f109..00000000 --- a/docs/models/shared/destinationmilvuscohere.md +++ /dev/null @@ -1,11 +0,0 @@ -# DestinationMilvusCohere - -Use the Cohere API to embed text. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `cohere_key` | *str* | :heavy_check_mark: | N/A | -| `mode` | [Optional[shared.DestinationMilvusSchemasMode]](../../models/shared/destinationmilvusschemasmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationmilvusembedding.md b/docs/models/shared/destinationmilvusembedding.md deleted file mode 100644 index 2cf23f55..00000000 --- a/docs/models/shared/destinationmilvusembedding.md +++ /dev/null @@ -1,37 +0,0 @@ -# DestinationMilvusEmbedding - -Embedding configuration - - -## Supported Types - -### DestinationMilvusOpenAI - -```python -destinationMilvusEmbedding: shared.DestinationMilvusOpenAI = /* values here */ -``` - -### DestinationMilvusCohere - -```python -destinationMilvusEmbedding: shared.DestinationMilvusCohere = /* values here */ -``` - -### DestinationMilvusFake - -```python -destinationMilvusEmbedding: shared.DestinationMilvusFake = /* values here */ -``` - -### DestinationMilvusAzureOpenAI - -```python -destinationMilvusEmbedding: shared.DestinationMilvusAzureOpenAI = /* values here */ -``` - -### DestinationMilvusOpenAICompatible - -```python -destinationMilvusEmbedding: shared.DestinationMilvusOpenAICompatible = /* values here */ -``` - diff --git a/docs/models/shared/destinationmilvusfake.md b/docs/models/shared/destinationmilvusfake.md deleted file mode 100644 index 9e4ed83e..00000000 --- a/docs/models/shared/destinationmilvusfake.md +++ /dev/null @@ -1,10 +0,0 @@ -# DestinationMilvusFake - -Use a fake embedding made out of random vectors with 1536 embedding dimensions. This is useful for testing the data pipeline without incurring any costs. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `mode` | [Optional[shared.DestinationMilvusSchemasEmbeddingMode]](../../models/shared/destinationmilvusschemasembeddingmode.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 deleted file mode 100644 index fe3eaddc..00000000 --- a/docs/models/shared/destinationmilvusindexing.md +++ /dev/null @@ -1,15 +0,0 @@ -# DestinationMilvusIndexing - -Indexing configuration - - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | | -| `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 deleted file mode 100644 index b53263c4..00000000 --- a/docs/models/shared/destinationmilvusopenai.md +++ /dev/null @@ -1,11 +0,0 @@ -# DestinationMilvusOpenAI - -Use the OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `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/destinationmilvusopenaicompatible.md b/docs/models/shared/destinationmilvusopenaicompatible.md deleted file mode 100644 index 2b620173..00000000 --- a/docs/models/shared/destinationmilvusopenaicompatible.md +++ /dev/null @@ -1,14 +0,0 @@ -# DestinationMilvusOpenAICompatible - -Use a service that's compatible with the OpenAI API to embed text. - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `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/destinationmilvustextsplitter.md b/docs/models/shared/destinationmilvustextsplitter.md deleted file mode 100644 index a8e59f31..00000000 --- a/docs/models/shared/destinationmilvustextsplitter.md +++ /dev/null @@ -1,25 +0,0 @@ -# DestinationMilvusTextSplitter - -Split text fields into chunks based on the specified method. - - -## Supported Types - -### DestinationMilvusBySeparator - -```python -destinationMilvusTextSplitter: shared.DestinationMilvusBySeparator = /* values here */ -``` - -### DestinationMilvusByMarkdownHeader - -```python -destinationMilvusTextSplitter: shared.DestinationMilvusByMarkdownHeader = /* values here */ -``` - -### DestinationMilvusByProgrammingLanguage - -```python -destinationMilvusTextSplitter: shared.DestinationMilvusByProgrammingLanguage = /* values here */ -``` - diff --git a/docs/models/shared/destinationmilvususernamepassword.md b/docs/models/shared/destinationmilvususernamepassword.md deleted file mode 100644 index 6d46607f..00000000 --- a/docs/models/shared/destinationmilvususernamepassword.md +++ /dev/null @@ -1,12 +0,0 @@ -# DestinationMilvusUsernamePassword - -Authenticate using username and password (suitable for self-managed Milvus clusters) - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `password` | *str* | :heavy_check_mark: | Password for the Milvus instance | -| `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/destinationmongodb.md b/docs/models/shared/destinationmongodb.md deleted file mode 100644 index c1aa2d34..00000000 --- a/docs/models/shared/destinationmongodb.md +++ /dev/null @@ -1,12 +0,0 @@ -# DestinationMongodb - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `auth_type` | [Union[shared.NoneT, shared.LoginPassword]](../../models/shared/authorizationtype.md) | :heavy_check_mark: | Authorization type. | -| `database` | *str* | :heavy_check_mark: | Name of the database. | -| `destination_type` | [shared.Mongodb](../../models/shared/mongodb.md) | :heavy_check_mark: | N/A | -| `instance_type` | [Optional[Union[shared.StandaloneMongoDbInstance, shared.ReplicaSet, shared.MongoDBAtlas]]](../../models/shared/mongodbinstancetype.md) | :heavy_minus_sign: | MongoDb instance to connect to. For MongoDB Atlas and Replica Set TLS connection is used by default. | -| `tunnel_method` | [Optional[Union[shared.DestinationMongodbNoTunnel, shared.DestinationMongodbSSHKeyAuthentication, shared.DestinationMongodbPasswordAuthentication]]](../../models/shared/destinationmongodbsshtunnelmethod.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/destinationmongodbnotunnel.md b/docs/models/shared/destinationmongodbnotunnel.md deleted file mode 100644 index c79b299c..00000000 --- a/docs/models/shared/destinationmongodbnotunnel.md +++ /dev/null @@ -1,8 +0,0 @@ -# DestinationMongodbNoTunnel - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `tunnel_method` | [shared.DestinationMongodbTunnelMethod](../../models/shared/destinationmongodbtunnelmethod.md) | :heavy_check_mark: | No ssh tunnel needed to connect to database | \ No newline at end of file diff --git a/docs/models/shared/destinationmongodbpasswordauthentication.md b/docs/models/shared/destinationmongodbpasswordauthentication.md deleted file mode 100644 index 79d42ff7..00000000 --- a/docs/models/shared/destinationmongodbpasswordauthentication.md +++ /dev/null @@ -1,12 +0,0 @@ -# DestinationMongodbPasswordAuthentication - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `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_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/destinationmongodbsshtunnelmethod.md b/docs/models/shared/destinationmongodbsshtunnelmethod.md deleted file mode 100644 index 1de37b7a..00000000 --- a/docs/models/shared/destinationmongodbsshtunnelmethod.md +++ /dev/null @@ -1,25 +0,0 @@ -# DestinationMongodbSSHTunnelMethod - -Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. - - -## Supported Types - -### DestinationMongodbNoTunnel - -```python -destinationMongodbSSHTunnelMethod: shared.DestinationMongodbNoTunnel = /* values here */ -``` - -### DestinationMongodbSSHKeyAuthentication - -```python -destinationMongodbSSHTunnelMethod: shared.DestinationMongodbSSHKeyAuthentication = /* values here */ -``` - -### DestinationMongodbPasswordAuthentication - -```python -destinationMongodbSSHTunnelMethod: shared.DestinationMongodbPasswordAuthentication = /* values here */ -``` - diff --git a/docs/models/shared/destinationmssql.md b/docs/models/shared/destinationmssql.md deleted file mode 100644 index 9b82506e..00000000 --- a/docs/models/shared/destinationmssql.md +++ /dev/null @@ -1,17 +0,0 @@ -# DestinationMssql - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `database` | *str* | :heavy_check_mark: | The name of the MSSQL database. | | -| `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. | | \ No newline at end of file diff --git a/docs/models/shared/destinationmssqlnotunnel.md b/docs/models/shared/destinationmssqlnotunnel.md deleted file mode 100644 index cc812d99..00000000 --- a/docs/models/shared/destinationmssqlnotunnel.md +++ /dev/null @@ -1,8 +0,0 @@ -# DestinationMssqlNoTunnel - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `tunnel_method` | [shared.DestinationMssqlTunnelMethod](../../models/shared/destinationmssqltunnelmethod.md) | :heavy_check_mark: | No ssh tunnel needed to connect to database | \ No newline at end of file diff --git a/docs/models/shared/destinationmssqlpasswordauthentication.md b/docs/models/shared/destinationmssqlpasswordauthentication.md deleted file mode 100644 index 83dc78fa..00000000 --- a/docs/models/shared/destinationmssqlpasswordauthentication.md +++ /dev/null @@ -1,12 +0,0 @@ -# DestinationMssqlPasswordAuthentication - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `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_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/destinationmssqlsshtunnelmethod.md b/docs/models/shared/destinationmssqlsshtunnelmethod.md deleted file mode 100644 index f2ec7897..00000000 --- a/docs/models/shared/destinationmssqlsshtunnelmethod.md +++ /dev/null @@ -1,25 +0,0 @@ -# DestinationMssqlSSHTunnelMethod - -Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. - - -## Supported Types - -### DestinationMssqlNoTunnel - -```python -destinationMssqlSSHTunnelMethod: shared.DestinationMssqlNoTunnel = /* values here */ -``` - -### DestinationMssqlSSHKeyAuthentication - -```python -destinationMssqlSSHTunnelMethod: shared.DestinationMssqlSSHKeyAuthentication = /* values here */ -``` - -### DestinationMssqlPasswordAuthentication - -```python -destinationMssqlSSHTunnelMethod: shared.DestinationMssqlPasswordAuthentication = /* values here */ -``` - diff --git a/docs/models/shared/destinationmysql.md b/docs/models/shared/destinationmysql.md deleted file mode 100644 index e95bb482..00000000 --- a/docs/models/shared/destinationmysql.md +++ /dev/null @@ -1,15 +0,0 @@ -# DestinationMysql - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `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 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. | | \ No newline at end of file diff --git a/docs/models/shared/destinationmysqlnotunnel.md b/docs/models/shared/destinationmysqlnotunnel.md deleted file mode 100644 index 737c92e3..00000000 --- a/docs/models/shared/destinationmysqlnotunnel.md +++ /dev/null @@ -1,8 +0,0 @@ -# DestinationMysqlNoTunnel - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `tunnel_method` | [shared.DestinationMysqlTunnelMethod](../../models/shared/destinationmysqltunnelmethod.md) | :heavy_check_mark: | No ssh tunnel needed to connect to database | \ No newline at end of file diff --git a/docs/models/shared/destinationmysqlpasswordauthentication.md b/docs/models/shared/destinationmysqlpasswordauthentication.md deleted file mode 100644 index 71c5929f..00000000 --- a/docs/models/shared/destinationmysqlpasswordauthentication.md +++ /dev/null @@ -1,12 +0,0 @@ -# DestinationMysqlPasswordAuthentication - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `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_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/destinationmysqlsshtunnelmethod.md b/docs/models/shared/destinationmysqlsshtunnelmethod.md deleted file mode 100644 index 3cba61ba..00000000 --- a/docs/models/shared/destinationmysqlsshtunnelmethod.md +++ /dev/null @@ -1,25 +0,0 @@ -# DestinationMysqlSSHTunnelMethod - -Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. - - -## Supported Types - -### DestinationMysqlNoTunnel - -```python -destinationMysqlSSHTunnelMethod: shared.DestinationMysqlNoTunnel = /* values here */ -``` - -### DestinationMysqlSSHKeyAuthentication - -```python -destinationMysqlSSHTunnelMethod: shared.DestinationMysqlSSHKeyAuthentication = /* values here */ -``` - -### DestinationMysqlPasswordAuthentication - -```python -destinationMysqlSSHTunnelMethod: shared.DestinationMysqlPasswordAuthentication = /* values here */ -``` - diff --git a/docs/models/shared/destinationoraclenotunnel.md b/docs/models/shared/destinationoraclenotunnel.md deleted file mode 100644 index 506546e3..00000000 --- a/docs/models/shared/destinationoraclenotunnel.md +++ /dev/null @@ -1,8 +0,0 @@ -# DestinationOracleNoTunnel - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `tunnel_method` | [shared.DestinationOracleTunnelMethod](../../models/shared/destinationoracletunnelmethod.md) | :heavy_check_mark: | No ssh tunnel needed to connect to database | \ No newline at end of file diff --git a/docs/models/shared/destinationoraclepasswordauthentication.md b/docs/models/shared/destinationoraclepasswordauthentication.md deleted file mode 100644 index 0b571546..00000000 --- a/docs/models/shared/destinationoraclepasswordauthentication.md +++ /dev/null @@ -1,12 +0,0 @@ -# DestinationOraclePasswordAuthentication - - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `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_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/destinationoraclesshtunnelmethod.md b/docs/models/shared/destinationoraclesshtunnelmethod.md deleted file mode 100644 index 8fe70eda..00000000 --- a/docs/models/shared/destinationoraclesshtunnelmethod.md +++ /dev/null @@ -1,25 +0,0 @@ -# DestinationOracleSSHTunnelMethod - -Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. - - -## Supported Types - -### DestinationOracleNoTunnel - -```python -destinationOracleSSHTunnelMethod: shared.DestinationOracleNoTunnel = /* values here */ -``` - -### DestinationOracleSSHKeyAuthentication - -```python -destinationOracleSSHTunnelMethod: shared.DestinationOracleSSHKeyAuthentication = /* values here */ -``` - -### DestinationOraclePasswordAuthentication - -```python -destinationOracleSSHTunnelMethod: shared.DestinationOraclePasswordAuthentication = /* values here */ -``` - diff --git a/docs/models/shared/destinationpatchrequest.md b/docs/models/shared/destinationpatchrequest.md deleted file mode 100644 index e6b0544d..00000000 --- a/docs/models/shared/destinationpatchrequest.md +++ /dev/null @@ -1,9 +0,0 @@ -# DestinationPatchRequest - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `configuration` | [Optional[Union[shared.DestinationGoogleSheets, shared.DestinationAstra, 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.DestinationTeradata, shared.DestinationTimeplus, shared.DestinationTypesense, shared.DestinationVectara, shared.DestinationVertica, shared.DestinationWeaviate, shared.DestinationXata]]](../../models/shared/destinationconfiguration.md) | :heavy_minus_sign: | The values required to configure the destination. | {
    "user": "charles"
    } | -| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/destinationpineconeazureopenai.md b/docs/models/shared/destinationpineconeazureopenai.md deleted file mode 100644 index 1b6967da..00000000 --- a/docs/models/shared/destinationpineconeazureopenai.md +++ /dev/null @@ -1,13 +0,0 @@ -# DestinationPineconeAzureOpenAI - -Use the Azure-hosted OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions. - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `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/destinationpineconebymarkdownheader.md b/docs/models/shared/destinationpineconebymarkdownheader.md deleted file mode 100644 index f2c6f54f..00000000 --- a/docs/models/shared/destinationpineconebymarkdownheader.md +++ /dev/null @@ -1,11 +0,0 @@ -# DestinationPineconeByMarkdownHeader - -Split the text by Markdown headers down to the specified header level. If the chunk size fits multiple sections, they will be combined into a single chunk. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `mode` | [Optional[shared.DestinationPineconeSchemasProcessingTextSplitterMode]](../../models/shared/destinationpineconeschemasprocessingtextsplittermode.md) | :heavy_minus_sign: | N/A | -| `split_level` | *Optional[int]* | :heavy_minus_sign: | Level of markdown headers to split text fields by. Headings down to the specified level will be used as split points | \ No newline at end of file diff --git a/docs/models/shared/destinationpineconebyprogramminglanguage.md b/docs/models/shared/destinationpineconebyprogramminglanguage.md deleted file mode 100644 index fc7c8422..00000000 --- a/docs/models/shared/destinationpineconebyprogramminglanguage.md +++ /dev/null @@ -1,11 +0,0 @@ -# DestinationPineconeByProgrammingLanguage - -Split the text by suitable delimiters based on the programming language. This is useful for splitting code into chunks. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `language` | [shared.DestinationPineconeLanguage](../../models/shared/destinationpineconelanguage.md) | :heavy_check_mark: | Split code in suitable places based on the programming language | -| `mode` | [Optional[shared.DestinationPineconeSchemasProcessingTextSplitterTextSplitterMode]](../../models/shared/destinationpineconeschemasprocessingtextsplittertextsplittermode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationpineconecohere.md b/docs/models/shared/destinationpineconecohere.md deleted file mode 100644 index a9854139..00000000 --- a/docs/models/shared/destinationpineconecohere.md +++ /dev/null @@ -1,11 +0,0 @@ -# DestinationPineconeCohere - -Use the Cohere API to embed text. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `cohere_key` | *str* | :heavy_check_mark: | N/A | -| `mode` | [Optional[shared.DestinationPineconeSchemasMode]](../../models/shared/destinationpineconeschemasmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationpineconeembedding.md b/docs/models/shared/destinationpineconeembedding.md deleted file mode 100644 index 3b5d9211..00000000 --- a/docs/models/shared/destinationpineconeembedding.md +++ /dev/null @@ -1,37 +0,0 @@ -# DestinationPineconeEmbedding - -Embedding configuration - - -## Supported Types - -### DestinationPineconeOpenAI - -```python -destinationPineconeEmbedding: shared.DestinationPineconeOpenAI = /* values here */ -``` - -### DestinationPineconeCohere - -```python -destinationPineconeEmbedding: shared.DestinationPineconeCohere = /* values here */ -``` - -### DestinationPineconeFake - -```python -destinationPineconeEmbedding: shared.DestinationPineconeFake = /* values here */ -``` - -### DestinationPineconeAzureOpenAI - -```python -destinationPineconeEmbedding: shared.DestinationPineconeAzureOpenAI = /* values here */ -``` - -### DestinationPineconeOpenAICompatible - -```python -destinationPineconeEmbedding: shared.DestinationPineconeOpenAICompatible = /* values here */ -``` - diff --git a/docs/models/shared/destinationpineconefake.md b/docs/models/shared/destinationpineconefake.md deleted file mode 100644 index d5428cd7..00000000 --- a/docs/models/shared/destinationpineconefake.md +++ /dev/null @@ -1,10 +0,0 @@ -# DestinationPineconeFake - -Use a fake embedding made out of random vectors with 1536 embedding dimensions. This is useful for testing the data pipeline without incurring any costs. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `mode` | [Optional[shared.DestinationPineconeSchemasEmbeddingMode]](../../models/shared/destinationpineconeschemasembeddingmode.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 deleted file mode 100644 index b07376a6..00000000 --- a/docs/models/shared/destinationpineconeopenai.md +++ /dev/null @@ -1,11 +0,0 @@ -# DestinationPineconeOpenAI - -Use the OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `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 deleted file mode 100644 index 5d31bbff..00000000 --- a/docs/models/shared/destinationpineconeopenaicompatible.md +++ /dev/null @@ -1,14 +0,0 @@ -# DestinationPineconeOpenAICompatible - -Use a service that's compatible with the OpenAI API to embed text. - - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `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/destinationpineconetextsplitter.md b/docs/models/shared/destinationpineconetextsplitter.md deleted file mode 100644 index 0a46b7aa..00000000 --- a/docs/models/shared/destinationpineconetextsplitter.md +++ /dev/null @@ -1,25 +0,0 @@ -# DestinationPineconeTextSplitter - -Split text fields into chunks based on the specified method. - - -## Supported Types - -### DestinationPineconeBySeparator - -```python -destinationPineconeTextSplitter: shared.DestinationPineconeBySeparator = /* values here */ -``` - -### DestinationPineconeByMarkdownHeader - -```python -destinationPineconeTextSplitter: shared.DestinationPineconeByMarkdownHeader = /* values here */ -``` - -### DestinationPineconeByProgrammingLanguage - -```python -destinationPineconeTextSplitter: shared.DestinationPineconeByProgrammingLanguage = /* values here */ -``` - diff --git a/docs/models/shared/destinationpostgresnotunnel.md b/docs/models/shared/destinationpostgresnotunnel.md deleted file mode 100644 index db027d24..00000000 --- a/docs/models/shared/destinationpostgresnotunnel.md +++ /dev/null @@ -1,8 +0,0 @@ -# DestinationPostgresNoTunnel - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `tunnel_method` | [shared.DestinationPostgresTunnelMethod](../../models/shared/destinationpostgrestunnelmethod.md) | :heavy_check_mark: | No ssh tunnel needed to connect to database | \ No newline at end of file diff --git a/docs/models/shared/destinationpostgrespasswordauthentication.md b/docs/models/shared/destinationpostgrespasswordauthentication.md deleted file mode 100644 index 0846d1fd..00000000 --- a/docs/models/shared/destinationpostgrespasswordauthentication.md +++ /dev/null @@ -1,12 +0,0 @@ -# DestinationPostgresPasswordAuthentication - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `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_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/destinationpostgressshtunnelmethod.md b/docs/models/shared/destinationpostgressshtunnelmethod.md deleted file mode 100644 index 9510aaf8..00000000 --- a/docs/models/shared/destinationpostgressshtunnelmethod.md +++ /dev/null @@ -1,25 +0,0 @@ -# DestinationPostgresSSHTunnelMethod - -Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. - - -## Supported Types - -### DestinationPostgresNoTunnel - -```python -destinationPostgresSSHTunnelMethod: shared.DestinationPostgresNoTunnel = /* values here */ -``` - -### DestinationPostgresSSHKeyAuthentication - -```python -destinationPostgresSSHTunnelMethod: shared.DestinationPostgresSSHKeyAuthentication = /* values here */ -``` - -### DestinationPostgresPasswordAuthentication - -```python -destinationPostgresSSHTunnelMethod: shared.DestinationPostgresPasswordAuthentication = /* values here */ -``` - diff --git a/docs/models/shared/destinationputrequest.md b/docs/models/shared/destinationputrequest.md deleted file mode 100644 index 39c09573..00000000 --- a/docs/models/shared/destinationputrequest.md +++ /dev/null @@ -1,9 +0,0 @@ -# DestinationPutRequest - - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `configuration` | [Union[shared.DestinationGoogleSheets, shared.DestinationAstra, 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.DestinationTeradata, 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"
    } | -| `name` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/destinationqdrantauthenticationmethod.md b/docs/models/shared/destinationqdrantauthenticationmethod.md deleted file mode 100644 index c223766e..00000000 --- a/docs/models/shared/destinationqdrantauthenticationmethod.md +++ /dev/null @@ -1,19 +0,0 @@ -# DestinationQdrantAuthenticationMethod - -Method to authenticate with the Qdrant Instance - - -## Supported Types - -### APIKeyAuth - -```python -destinationQdrantAuthenticationMethod: shared.APIKeyAuth = /* values here */ -``` - -### DestinationQdrantNoAuth - -```python -destinationQdrantAuthenticationMethod: shared.DestinationQdrantNoAuth = /* values here */ -``` - diff --git a/docs/models/shared/destinationqdrantazureopenai.md b/docs/models/shared/destinationqdrantazureopenai.md deleted file mode 100644 index f79fec13..00000000 --- a/docs/models/shared/destinationqdrantazureopenai.md +++ /dev/null @@ -1,13 +0,0 @@ -# DestinationQdrantAzureOpenAI - -Use the Azure-hosted OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions. - - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `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/destinationqdrantbymarkdownheader.md b/docs/models/shared/destinationqdrantbymarkdownheader.md deleted file mode 100644 index 4fef3497..00000000 --- a/docs/models/shared/destinationqdrantbymarkdownheader.md +++ /dev/null @@ -1,11 +0,0 @@ -# DestinationQdrantByMarkdownHeader - -Split the text by Markdown headers down to the specified header level. If the chunk size fits multiple sections, they will be combined into a single chunk. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `mode` | [Optional[shared.DestinationQdrantSchemasProcessingTextSplitterMode]](../../models/shared/destinationqdrantschemasprocessingtextsplittermode.md) | :heavy_minus_sign: | N/A | -| `split_level` | *Optional[int]* | :heavy_minus_sign: | Level of markdown headers to split text fields by. Headings down to the specified level will be used as split points | \ No newline at end of file diff --git a/docs/models/shared/destinationqdrantbyprogramminglanguage.md b/docs/models/shared/destinationqdrantbyprogramminglanguage.md deleted file mode 100644 index 8358589d..00000000 --- a/docs/models/shared/destinationqdrantbyprogramminglanguage.md +++ /dev/null @@ -1,11 +0,0 @@ -# DestinationQdrantByProgrammingLanguage - -Split the text by suitable delimiters based on the programming language. This is useful for splitting code into chunks. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `language` | [shared.DestinationQdrantLanguage](../../models/shared/destinationqdrantlanguage.md) | :heavy_check_mark: | Split code in suitable places based on the programming language | -| `mode` | [Optional[shared.DestinationQdrantSchemasProcessingTextSplitterTextSplitterMode]](../../models/shared/destinationqdrantschemasprocessingtextsplittertextsplittermode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationqdrantcohere.md b/docs/models/shared/destinationqdrantcohere.md deleted file mode 100644 index b4fbcdca..00000000 --- a/docs/models/shared/destinationqdrantcohere.md +++ /dev/null @@ -1,11 +0,0 @@ -# DestinationQdrantCohere - -Use the Cohere API to embed text. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `cohere_key` | *str* | :heavy_check_mark: | N/A | -| `mode` | [Optional[shared.DestinationQdrantSchemasMode]](../../models/shared/destinationqdrantschemasmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationqdrantembedding.md b/docs/models/shared/destinationqdrantembedding.md deleted file mode 100644 index 7968e898..00000000 --- a/docs/models/shared/destinationqdrantembedding.md +++ /dev/null @@ -1,37 +0,0 @@ -# DestinationQdrantEmbedding - -Embedding configuration - - -## Supported Types - -### DestinationQdrantOpenAI - -```python -destinationQdrantEmbedding: shared.DestinationQdrantOpenAI = /* values here */ -``` - -### DestinationQdrantCohere - -```python -destinationQdrantEmbedding: shared.DestinationQdrantCohere = /* values here */ -``` - -### DestinationQdrantFake - -```python -destinationQdrantEmbedding: shared.DestinationQdrantFake = /* values here */ -``` - -### DestinationQdrantAzureOpenAI - -```python -destinationQdrantEmbedding: shared.DestinationQdrantAzureOpenAI = /* values here */ -``` - -### DestinationQdrantOpenAICompatible - -```python -destinationQdrantEmbedding: shared.DestinationQdrantOpenAICompatible = /* values here */ -``` - diff --git a/docs/models/shared/destinationqdrantfake.md b/docs/models/shared/destinationqdrantfake.md deleted file mode 100644 index 2ceef154..00000000 --- a/docs/models/shared/destinationqdrantfake.md +++ /dev/null @@ -1,10 +0,0 @@ -# DestinationQdrantFake - -Use a fake embedding made out of random vectors with 1536 embedding dimensions. This is useful for testing the data pipeline without incurring any costs. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `mode` | [Optional[shared.DestinationQdrantSchemasEmbeddingMode]](../../models/shared/destinationqdrantschemasembeddingmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationqdrantnoauth.md b/docs/models/shared/destinationqdrantnoauth.md deleted file mode 100644 index b94ee06c..00000000 --- a/docs/models/shared/destinationqdrantnoauth.md +++ /dev/null @@ -1,8 +0,0 @@ -# DestinationQdrantNoAuth - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `mode` | [Optional[shared.DestinationQdrantSchemasIndexingAuthMethodMode]](../../models/shared/destinationqdrantschemasindexingauthmethodmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationqdrantopenai.md b/docs/models/shared/destinationqdrantopenai.md deleted file mode 100644 index 3bf95d5b..00000000 --- a/docs/models/shared/destinationqdrantopenai.md +++ /dev/null @@ -1,11 +0,0 @@ -# DestinationQdrantOpenAI - -Use the OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `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 deleted file mode 100644 index 93e0b821..00000000 --- a/docs/models/shared/destinationqdrantopenaicompatible.md +++ /dev/null @@ -1,14 +0,0 @@ -# DestinationQdrantOpenAICompatible - -Use a service that's compatible with the OpenAI API to embed text. - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `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/destinationqdranttextsplitter.md b/docs/models/shared/destinationqdranttextsplitter.md deleted file mode 100644 index 2d087ebb..00000000 --- a/docs/models/shared/destinationqdranttextsplitter.md +++ /dev/null @@ -1,25 +0,0 @@ -# DestinationQdrantTextSplitter - -Split text fields into chunks based on the specified method. - - -## Supported Types - -### DestinationQdrantBySeparator - -```python -destinationQdrantTextSplitter: shared.DestinationQdrantBySeparator = /* values here */ -``` - -### DestinationQdrantByMarkdownHeader - -```python -destinationQdrantTextSplitter: shared.DestinationQdrantByMarkdownHeader = /* values here */ -``` - -### DestinationQdrantByProgrammingLanguage - -```python -destinationQdrantTextSplitter: shared.DestinationQdrantByProgrammingLanguage = /* values here */ -``` - diff --git a/docs/models/shared/destinationredis.md b/docs/models/shared/destinationredis.md deleted file mode 100644 index bf53f0f0..00000000 --- a/docs/models/shared/destinationredis.md +++ /dev/null @@ -1,16 +0,0 @@ -# DestinationRedis - - -## Fields - -| 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 | | -| `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. | | \ No newline at end of file diff --git a/docs/models/shared/destinationredisdisable.md b/docs/models/shared/destinationredisdisable.md deleted file mode 100644 index d1f07f3b..00000000 --- a/docs/models/shared/destinationredisdisable.md +++ /dev/null @@ -1,10 +0,0 @@ -# DestinationRedisDisable - -Disable SSL. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `mode` | [Optional[shared.DestinationRedisMode]](../../models/shared/destinationredismode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationredisnotunnel.md b/docs/models/shared/destinationredisnotunnel.md deleted file mode 100644 index 1f80c2ce..00000000 --- a/docs/models/shared/destinationredisnotunnel.md +++ /dev/null @@ -1,8 +0,0 @@ -# DestinationRedisNoTunnel - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `tunnel_method` | [shared.DestinationRedisTunnelMethod](../../models/shared/destinationredistunnelmethod.md) | :heavy_check_mark: | No ssh tunnel needed to connect to database | \ No newline at end of file diff --git a/docs/models/shared/destinationredispasswordauthentication.md b/docs/models/shared/destinationredispasswordauthentication.md deleted file mode 100644 index 9db91c41..00000000 --- a/docs/models/shared/destinationredispasswordauthentication.md +++ /dev/null @@ -1,12 +0,0 @@ -# DestinationRedisPasswordAuthentication - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `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_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/destinationredissshtunnelmethod.md b/docs/models/shared/destinationredissshtunnelmethod.md deleted file mode 100644 index e8f02ec4..00000000 --- a/docs/models/shared/destinationredissshtunnelmethod.md +++ /dev/null @@ -1,25 +0,0 @@ -# DestinationRedisSSHTunnelMethod - -Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. - - -## Supported Types - -### DestinationRedisNoTunnel - -```python -destinationRedisSSHTunnelMethod: shared.DestinationRedisNoTunnel = /* values here */ -``` - -### DestinationRedisSSHKeyAuthentication - -```python -destinationRedisSSHTunnelMethod: shared.DestinationRedisSSHKeyAuthentication = /* values here */ -``` - -### DestinationRedisPasswordAuthentication - -```python -destinationRedisSSHTunnelMethod: shared.DestinationRedisPasswordAuthentication = /* values here */ -``` - diff --git a/docs/models/shared/destinationredissslmodes.md b/docs/models/shared/destinationredissslmodes.md deleted file mode 100644 index 553d0896..00000000 --- a/docs/models/shared/destinationredissslmodes.md +++ /dev/null @@ -1,20 +0,0 @@ -# DestinationRedisSSLModes - -SSL connection modes. -
  • verify-full - This is the most secure mode. Always require encryption and verifies the identity of the source database server - - -## Supported Types - -### DestinationRedisDisable - -```python -destinationRedisSSLModes: shared.DestinationRedisDisable = /* values here */ -``` - -### DestinationRedisVerifyFull - -```python -destinationRedisSSLModes: shared.DestinationRedisVerifyFull = /* values here */ -``` - diff --git a/docs/models/shared/destinationredisverifyfull.md b/docs/models/shared/destinationredisverifyfull.md deleted file mode 100644 index b83bba30..00000000 --- a/docs/models/shared/destinationredisverifyfull.md +++ /dev/null @@ -1,14 +0,0 @@ -# DestinationRedisVerifyFull - -Verify-full SSL mode. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `ca_certificate` | *str* | :heavy_check_mark: | CA certificate | -| `client_certificate` | *str* | :heavy_check_mark: | Client certificate | -| `client_key` | *str* | :heavy_check_mark: | 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. | -| `mode` | [Optional[shared.DestinationRedisSchemasMode]](../../models/shared/destinationredisschemasmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationredshiftencryption.md b/docs/models/shared/destinationredshiftencryption.md deleted file mode 100644 index d5500ed9..00000000 --- a/docs/models/shared/destinationredshiftencryption.md +++ /dev/null @@ -1,19 +0,0 @@ -# DestinationRedshiftEncryption - -How to encrypt the staging data - - -## Supported Types - -### NoEncryption - -```python -destinationRedshiftEncryption: shared.NoEncryption = /* values here */ -``` - -### AESCBCEnvelopeEncryption - -```python -destinationRedshiftEncryption: shared.AESCBCEnvelopeEncryption = /* values here */ -``` - diff --git a/docs/models/shared/destinationredshiftnotunnel.md b/docs/models/shared/destinationredshiftnotunnel.md deleted file mode 100644 index 6d58aec3..00000000 --- a/docs/models/shared/destinationredshiftnotunnel.md +++ /dev/null @@ -1,8 +0,0 @@ -# DestinationRedshiftNoTunnel - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `tunnel_method` | [shared.DestinationRedshiftTunnelMethod](../../models/shared/destinationredshifttunnelmethod.md) | :heavy_check_mark: | No ssh tunnel needed to connect to database | \ No newline at end of file diff --git a/docs/models/shared/destinationredshiftpasswordauthentication.md b/docs/models/shared/destinationredshiftpasswordauthentication.md deleted file mode 100644 index c7735332..00000000 --- a/docs/models/shared/destinationredshiftpasswordauthentication.md +++ /dev/null @@ -1,12 +0,0 @@ -# DestinationRedshiftPasswordAuthentication - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `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_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/destinationredshiftsshtunnelmethod.md b/docs/models/shared/destinationredshiftsshtunnelmethod.md deleted file mode 100644 index b7b7a017..00000000 --- a/docs/models/shared/destinationredshiftsshtunnelmethod.md +++ /dev/null @@ -1,25 +0,0 @@ -# DestinationRedshiftSSHTunnelMethod - -Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. - - -## Supported Types - -### DestinationRedshiftNoTunnel - -```python -destinationRedshiftSSHTunnelMethod: shared.DestinationRedshiftNoTunnel = /* values here */ -``` - -### DestinationRedshiftSSHKeyAuthentication - -```python -destinationRedshiftSSHTunnelMethod: shared.DestinationRedshiftSSHKeyAuthentication = /* values here */ -``` - -### DestinationRedshiftPasswordAuthentication - -```python -destinationRedshiftSSHTunnelMethod: shared.DestinationRedshiftPasswordAuthentication = /* values here */ -``` - diff --git a/docs/models/shared/destinationresponse.md b/docs/models/shared/destinationresponse.md deleted file mode 100644 index b2ffef8a..00000000 --- a/docs/models/shared/destinationresponse.md +++ /dev/null @@ -1,14 +0,0 @@ -# DestinationResponse - -Provides details of a single destination. - - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `configuration` | [Union[shared.DestinationGoogleSheets, shared.DestinationAstra, 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.DestinationTeradata, 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"
    } | -| `destination_id` | *str* | :heavy_check_mark: | N/A | | -| `destination_type` | *str* | :heavy_check_mark: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `workspace_id` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/destinations3avroapacheavro.md b/docs/models/shared/destinations3avroapacheavro.md deleted file mode 100644 index b2f9fadd..00000000 --- a/docs/models/shared/destinations3avroapacheavro.md +++ /dev/null @@ -1,9 +0,0 @@ -# DestinationS3AvroApacheAvro - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `compression_codec` | [Union[shared.DestinationS3SchemasFormatNoCompression, shared.DestinationS3Deflate, shared.DestinationS3Bzip2, shared.DestinationS3Xz, shared.DestinationS3Zstandard, shared.DestinationS3Snappy]](../../models/shared/destinations3compressioncodec.md) | :heavy_check_mark: | The compression algorithm used to compress data. Default to no compression. | -| `format_type` | [Optional[shared.DestinationS3SchemasFormatFormatType]](../../models/shared/destinations3schemasformatformattype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinations3bzip2.md b/docs/models/shared/destinations3bzip2.md deleted file mode 100644 index edffab1a..00000000 --- a/docs/models/shared/destinations3bzip2.md +++ /dev/null @@ -1,8 +0,0 @@ -# DestinationS3Bzip2 - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `codec` | [Optional[shared.DestinationS3SchemasFormatCodec]](../../models/shared/destinations3schemasformatcodec.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinations3compression.md b/docs/models/shared/destinations3compression.md deleted file mode 100644 index 821f90a2..00000000 --- a/docs/models/shared/destinations3compression.md +++ /dev/null @@ -1,19 +0,0 @@ -# DestinationS3Compression - -Whether the output files should be compressed. If compression is selected, the output filename will have an extra extension (GZIP: ".csv.gz"). - - -## Supported Types - -### DestinationS3NoCompression - -```python -destinationS3Compression: shared.DestinationS3NoCompression = /* values here */ -``` - -### DestinationS3GZIP - -```python -destinationS3Compression: shared.DestinationS3GZIP = /* values here */ -``` - diff --git a/docs/models/shared/destinations3compressioncodec.md b/docs/models/shared/destinations3compressioncodec.md deleted file mode 100644 index 69644c6c..00000000 --- a/docs/models/shared/destinations3compressioncodec.md +++ /dev/null @@ -1,43 +0,0 @@ -# DestinationS3CompressionCodec - -The compression algorithm used to compress data. Default to no compression. - - -## Supported Types - -### DestinationS3SchemasFormatNoCompression - -```python -destinationS3CompressionCodec: shared.DestinationS3SchemasFormatNoCompression = /* values here */ -``` - -### DestinationS3Deflate - -```python -destinationS3CompressionCodec: shared.DestinationS3Deflate = /* values here */ -``` - -### DestinationS3Bzip2 - -```python -destinationS3CompressionCodec: shared.DestinationS3Bzip2 = /* values here */ -``` - -### DestinationS3Xz - -```python -destinationS3CompressionCodec: shared.DestinationS3Xz = /* values here */ -``` - -### DestinationS3Zstandard - -```python -destinationS3CompressionCodec: shared.DestinationS3Zstandard = /* values here */ -``` - -### DestinationS3Snappy - -```python -destinationS3CompressionCodec: shared.DestinationS3Snappy = /* values here */ -``` - diff --git a/docs/models/shared/destinations3deflate.md b/docs/models/shared/destinations3deflate.md deleted file mode 100644 index 6b4c1119..00000000 --- a/docs/models/shared/destinations3deflate.md +++ /dev/null @@ -1,9 +0,0 @@ -# DestinationS3Deflate - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `codec` | [Optional[shared.DestinationS3SchemasCodec]](../../models/shared/destinations3schemascodec.md) | :heavy_minus_sign: | N/A | -| `compression_level` | *Optional[int]* | :heavy_minus_sign: | 0: no compression & fastest, 9: best compression & slowest. | \ No newline at end of file diff --git a/docs/models/shared/destinations3gluecompression.md b/docs/models/shared/destinations3gluecompression.md deleted file mode 100644 index 64a298c2..00000000 --- a/docs/models/shared/destinations3gluecompression.md +++ /dev/null @@ -1,19 +0,0 @@ -# DestinationS3GlueCompression - -Whether the output files should be compressed. If compression is selected, the output filename will have an extra extension (GZIP: ".jsonl.gz"). - - -## Supported Types - -### DestinationS3GlueNoCompression - -```python -destinationS3GlueCompression: shared.DestinationS3GlueNoCompression = /* values here */ -``` - -### DestinationS3GlueGZIP - -```python -destinationS3GlueCompression: shared.DestinationS3GlueGZIP = /* values here */ -``` - diff --git a/docs/models/shared/destinations3gluegzip.md b/docs/models/shared/destinations3gluegzip.md deleted file mode 100644 index c20ef281..00000000 --- a/docs/models/shared/destinations3gluegzip.md +++ /dev/null @@ -1,8 +0,0 @@ -# DestinationS3GlueGZIP - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `compression_type` | [Optional[shared.DestinationS3GlueSchemasCompressionType]](../../models/shared/destinations3glueschemascompressiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinations3gluenocompression.md b/docs/models/shared/destinations3gluenocompression.md deleted file mode 100644 index 2ff11855..00000000 --- a/docs/models/shared/destinations3gluenocompression.md +++ /dev/null @@ -1,8 +0,0 @@ -# DestinationS3GlueNoCompression - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `compression_type` | [Optional[shared.DestinationS3GlueCompressionType]](../../models/shared/destinations3gluecompressiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinations3gzip.md b/docs/models/shared/destinations3gzip.md deleted file mode 100644 index 666a30ec..00000000 --- a/docs/models/shared/destinations3gzip.md +++ /dev/null @@ -1,8 +0,0 @@ -# DestinationS3GZIP - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `compression_type` | [Optional[shared.DestinationS3SchemasCompressionType]](../../models/shared/destinations3schemascompressiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinations3jsonlinesnewlinedelimitedjson.md b/docs/models/shared/destinations3jsonlinesnewlinedelimitedjson.md deleted file mode 100644 index 7be0fa79..00000000 --- a/docs/models/shared/destinations3jsonlinesnewlinedelimitedjson.md +++ /dev/null @@ -1,10 +0,0 @@ -# DestinationS3JSONLinesNewlineDelimitedJSON - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `compression` | [Optional[Union[shared.DestinationS3SchemasNoCompression, shared.DestinationS3SchemasGZIP]]](../../models/shared/destinations3schemascompression.md) | :heavy_minus_sign: | Whether the output files should be compressed. If compression is selected, the output filename will have an extra extension (GZIP: ".jsonl.gz"). | -| `flattening` | [Optional[shared.DestinationS3SchemasFlattening]](../../models/shared/destinations3schemasflattening.md) | :heavy_minus_sign: | Whether the input json data should be normalized (flattened) in the output JSON Lines. Please refer to docs for details. | -| `format_type` | [Optional[shared.DestinationS3SchemasFormatType]](../../models/shared/destinations3schemasformattype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinations3nocompression.md b/docs/models/shared/destinations3nocompression.md deleted file mode 100644 index 35a9deb1..00000000 --- a/docs/models/shared/destinations3nocompression.md +++ /dev/null @@ -1,8 +0,0 @@ -# DestinationS3NoCompression - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `compression_type` | [Optional[shared.DestinationS3CompressionType]](../../models/shared/destinations3compressiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinations3outputformat.md b/docs/models/shared/destinations3outputformat.md deleted file mode 100644 index 62264227..00000000 --- a/docs/models/shared/destinations3outputformat.md +++ /dev/null @@ -1,31 +0,0 @@ -# DestinationS3OutputFormat - -Format of the data output. See here for more details - - -## Supported Types - -### DestinationS3CSVCommaSeparatedValues - -```python -destinationS3OutputFormat: shared.DestinationS3CSVCommaSeparatedValues = /* values here */ -``` - -### DestinationS3JSONLinesNewlineDelimitedJSON - -```python -destinationS3OutputFormat: shared.DestinationS3JSONLinesNewlineDelimitedJSON = /* values here */ -``` - -### DestinationS3AvroApacheAvro - -```python -destinationS3OutputFormat: shared.DestinationS3AvroApacheAvro = /* values here */ -``` - -### DestinationS3ParquetColumnarStorage - -```python -destinationS3OutputFormat: shared.DestinationS3ParquetColumnarStorage = /* values here */ -``` - diff --git a/docs/models/shared/destinations3schemascompression.md b/docs/models/shared/destinations3schemascompression.md deleted file mode 100644 index 41ebaa86..00000000 --- a/docs/models/shared/destinations3schemascompression.md +++ /dev/null @@ -1,19 +0,0 @@ -# DestinationS3SchemasCompression - -Whether the output files should be compressed. If compression is selected, the output filename will have an extra extension (GZIP: ".jsonl.gz"). - - -## Supported Types - -### DestinationS3SchemasNoCompression - -```python -destinationS3SchemasCompression: shared.DestinationS3SchemasNoCompression = /* values here */ -``` - -### DestinationS3SchemasGZIP - -```python -destinationS3SchemasCompression: shared.DestinationS3SchemasGZIP = /* values here */ -``` - diff --git a/docs/models/shared/destinations3schemasformatnocompression.md b/docs/models/shared/destinations3schemasformatnocompression.md deleted file mode 100644 index a35a3857..00000000 --- a/docs/models/shared/destinations3schemasformatnocompression.md +++ /dev/null @@ -1,8 +0,0 @@ -# DestinationS3SchemasFormatNoCompression - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `codec` | [Optional[shared.DestinationS3Codec]](../../models/shared/destinations3codec.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinations3schemasgzip.md b/docs/models/shared/destinations3schemasgzip.md deleted file mode 100644 index 3edf79e8..00000000 --- a/docs/models/shared/destinations3schemasgzip.md +++ /dev/null @@ -1,8 +0,0 @@ -# DestinationS3SchemasGZIP - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `compression_type` | [Optional[shared.DestinationS3SchemasFormatOutputFormatCompressionType]](../../models/shared/destinations3schemasformatoutputformatcompressiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinations3schemasnocompression.md b/docs/models/shared/destinations3schemasnocompression.md deleted file mode 100644 index 0b1947af..00000000 --- a/docs/models/shared/destinations3schemasnocompression.md +++ /dev/null @@ -1,8 +0,0 @@ -# DestinationS3SchemasNoCompression - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -| `compression_type` | [Optional[shared.DestinationS3SchemasFormatCompressionType]](../../models/shared/destinations3schemasformatcompressiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinations3snappy.md b/docs/models/shared/destinations3snappy.md deleted file mode 100644 index 725262db..00000000 --- a/docs/models/shared/destinations3snappy.md +++ /dev/null @@ -1,8 +0,0 @@ -# DestinationS3Snappy - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `codec` | [Optional[shared.DestinationS3SchemasFormatOutputFormat3CompressionCodecCodec]](../../models/shared/destinations3schemasformatoutputformat3compressioncodeccodec.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationsnowflake.md b/docs/models/shared/destinationsnowflake.md deleted file mode 100644 index 7027bde0..00000000 --- a/docs/models/shared/destinationsnowflake.md +++ /dev/null @@ -1,19 +0,0 @@ -# DestinationSnowflake - - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `database` | *str* | :heavy_check_mark: | Enter the name of the database you want to sync data into | AIRBYTE_DATABASE | -| `host` | *str* | :heavy_check_mark: | Enter your Snowflake account's locator (in the format ...snowflakecomputing.com) | accountname.us-east-2.aws.snowflakecomputing.com | -| `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 | -| `credentials` | [Optional[Union[shared.KeyPairAuthentication, shared.UsernameAndPassword, shared.DestinationSnowflakeOAuth20]]](../../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 deleted file mode 100644 index 56096d8e..00000000 --- a/docs/models/shared/destinationsnowflakeoauth20.md +++ /dev/null @@ -1,12 +0,0 @@ -# DestinationSnowflakeOAuth20 - - -## Fields - -| 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.DestinationSnowflakeSchemasAuthType]](../../models/shared/destinationsnowflakeschemasauthtype.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 | \ No newline at end of file diff --git a/docs/models/shared/destinationsresponse.md b/docs/models/shared/destinationsresponse.md deleted file mode 100644 index def3ed54..00000000 --- a/docs/models/shared/destinationsresponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# DestinationsResponse - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `data` | List[[shared.DestinationResponse](../../models/shared/destinationresponse.md)] | :heavy_check_mark: | N/A | -| `next` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `previous` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationteradataallow.md b/docs/models/shared/destinationteradataallow.md deleted file mode 100644 index 9041e001..00000000 --- a/docs/models/shared/destinationteradataallow.md +++ /dev/null @@ -1,10 +0,0 @@ -# DestinationTeradataAllow - -Allow SSL mode. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `mode` | [Optional[shared.DestinationTeradataSchemasMode]](../../models/shared/destinationteradataschemasmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationteradatadisable.md b/docs/models/shared/destinationteradatadisable.md deleted file mode 100644 index c01ad1ca..00000000 --- a/docs/models/shared/destinationteradatadisable.md +++ /dev/null @@ -1,10 +0,0 @@ -# DestinationTeradataDisable - -Disable SSL. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `mode` | [Optional[shared.DestinationTeradataMode]](../../models/shared/destinationteradatamode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationteradataprefer.md b/docs/models/shared/destinationteradataprefer.md deleted file mode 100644 index d6fb930a..00000000 --- a/docs/models/shared/destinationteradataprefer.md +++ /dev/null @@ -1,10 +0,0 @@ -# DestinationTeradataPrefer - -Prefer SSL mode. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `mode` | [Optional[shared.DestinationTeradataSchemasSslModeMode]](../../models/shared/destinationteradataschemassslmodemode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationteradatarequire.md b/docs/models/shared/destinationteradatarequire.md deleted file mode 100644 index 81b857a2..00000000 --- a/docs/models/shared/destinationteradatarequire.md +++ /dev/null @@ -1,10 +0,0 @@ -# DestinationTeradataRequire - -Require SSL mode. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `mode` | [Optional[shared.DestinationTeradataSchemasSSLModeSSLModesMode]](../../models/shared/destinationteradataschemassslmodesslmodesmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationtimeplus.md b/docs/models/shared/destinationtimeplus.md deleted file mode 100644 index 4c087759..00000000 --- a/docs/models/shared/destinationtimeplus.md +++ /dev/null @@ -1,10 +0,0 @@ -# DestinationTimeplus - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `apikey` | *str* | :heavy_check_mark: | Personal API key | | -| `destination_type` | [shared.Timeplus](../../models/shared/timeplus.md) | :heavy_check_mark: | N/A | | -| `endpoint` | *Optional[str]* | :heavy_minus_sign: | Timeplus workspace endpoint | https://us.timeplus.cloud/workspace_id | \ No newline at end of file diff --git a/docs/models/shared/destinationvertica.md b/docs/models/shared/destinationvertica.md deleted file mode 100644 index 4e0329a7..00000000 --- a/docs/models/shared/destinationvertica.md +++ /dev/null @@ -1,16 +0,0 @@ -# DestinationVertica - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `database` | *str* | :heavy_check_mark: | Name of the database. | | -| `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 | -| `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/destinationverticanotunnel.md b/docs/models/shared/destinationverticanotunnel.md deleted file mode 100644 index cfb5bb97..00000000 --- a/docs/models/shared/destinationverticanotunnel.md +++ /dev/null @@ -1,8 +0,0 @@ -# DestinationVerticaNoTunnel - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `tunnel_method` | [shared.DestinationVerticaTunnelMethod](../../models/shared/destinationverticatunnelmethod.md) | :heavy_check_mark: | No ssh tunnel needed to connect to database | \ No newline at end of file diff --git a/docs/models/shared/destinationverticapasswordauthentication.md b/docs/models/shared/destinationverticapasswordauthentication.md deleted file mode 100644 index 1d01cc29..00000000 --- a/docs/models/shared/destinationverticapasswordauthentication.md +++ /dev/null @@ -1,12 +0,0 @@ -# DestinationVerticaPasswordAuthentication - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `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_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/destinationverticaschemastunnelmethod.md b/docs/models/shared/destinationverticaschemastunnelmethod.md deleted file mode 100644 index c90ee17a..00000000 --- a/docs/models/shared/destinationverticaschemastunnelmethod.md +++ /dev/null @@ -1,10 +0,0 @@ -# DestinationVerticaSchemasTunnelMethod - -Connect through a jump server tunnel host using username and ssh key - - -## Values - -| Name | Value | -| -------------- | -------------- | -| `SSH_KEY_AUTH` | SSH_KEY_AUTH | \ No newline at end of file diff --git a/docs/models/shared/destinationverticaschemastunnelmethodtunnelmethod.md b/docs/models/shared/destinationverticaschemastunnelmethodtunnelmethod.md deleted file mode 100644 index 4570c2ef..00000000 --- a/docs/models/shared/destinationverticaschemastunnelmethodtunnelmethod.md +++ /dev/null @@ -1,10 +0,0 @@ -# DestinationVerticaSchemasTunnelMethodTunnelMethod - -Connect through a jump server tunnel host using username and password authentication - - -## Values - -| Name | Value | -| ------------------- | ------------------- | -| `SSH_PASSWORD_AUTH` | SSH_PASSWORD_AUTH | \ No newline at end of file diff --git a/docs/models/shared/destinationverticasshkeyauthentication.md b/docs/models/shared/destinationverticasshkeyauthentication.md deleted file mode 100644 index 1f607241..00000000 --- a/docs/models/shared/destinationverticasshkeyauthentication.md +++ /dev/null @@ -1,12 +0,0 @@ -# DestinationVerticaSSHKeyAuthentication - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `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 | \ No newline at end of file diff --git a/docs/models/shared/destinationverticasshtunnelmethod.md b/docs/models/shared/destinationverticasshtunnelmethod.md deleted file mode 100644 index dac4f18f..00000000 --- a/docs/models/shared/destinationverticasshtunnelmethod.md +++ /dev/null @@ -1,25 +0,0 @@ -# DestinationVerticaSSHTunnelMethod - -Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. - - -## Supported Types - -### DestinationVerticaNoTunnel - -```python -destinationVerticaSSHTunnelMethod: shared.DestinationVerticaNoTunnel = /* values here */ -``` - -### DestinationVerticaSSHKeyAuthentication - -```python -destinationVerticaSSHTunnelMethod: shared.DestinationVerticaSSHKeyAuthentication = /* values here */ -``` - -### DestinationVerticaPasswordAuthentication - -```python -destinationVerticaSSHTunnelMethod: shared.DestinationVerticaPasswordAuthentication = /* values here */ -``` - diff --git a/docs/models/shared/destinationverticatunnelmethod.md b/docs/models/shared/destinationverticatunnelmethod.md deleted file mode 100644 index 72233468..00000000 --- a/docs/models/shared/destinationverticatunnelmethod.md +++ /dev/null @@ -1,10 +0,0 @@ -# DestinationVerticaTunnelMethod - -No ssh tunnel needed to connect to database - - -## Values - -| Name | Value | -| ----------- | ----------- | -| `NO_TUNNEL` | NO_TUNNEL | \ No newline at end of file diff --git a/docs/models/shared/destinationweaviate.md b/docs/models/shared/destinationweaviate.md deleted file mode 100644 index 7dd836ca..00000000 --- a/docs/models/shared/destinationweaviate.md +++ /dev/null @@ -1,23 +0,0 @@ -# DestinationWeaviate - -The configuration model for the Vector DB based destinations. This model is used to generate the UI for the destination configuration, -as well as to provide type safety for the configuration passed to the destination. - -The configuration model is composed of four parts: -* Processing configuration -* Embedding configuration -* Indexing configuration -* Advanced configuration - -Processing, embedding and advanced configuration are provided by this base class, while the indexing configuration is provided by the destination connector in the sub class. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `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 deleted file mode 100644 index d4bd18b4..00000000 --- a/docs/models/shared/destinationweaviateapitoken.md +++ /dev/null @@ -1,11 +0,0 @@ -# DestinationWeaviateAPIToken - -Authenticate using an API token (suitable for Weaviate Cloud) - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `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/destinationweaviateauthentication.md b/docs/models/shared/destinationweaviateauthentication.md deleted file mode 100644 index b7926dc7..00000000 --- a/docs/models/shared/destinationweaviateauthentication.md +++ /dev/null @@ -1,25 +0,0 @@ -# DestinationWeaviateAuthentication - -Authentication method - - -## Supported Types - -### DestinationWeaviateAPIToken - -```python -destinationWeaviateAuthentication: shared.DestinationWeaviateAPIToken = /* values here */ -``` - -### DestinationWeaviateUsernamePassword - -```python -destinationWeaviateAuthentication: shared.DestinationWeaviateUsernamePassword = /* values here */ -``` - -### NoAuthentication - -```python -destinationWeaviateAuthentication: shared.NoAuthentication = /* values here */ -``` - diff --git a/docs/models/shared/destinationweaviatebymarkdownheader.md b/docs/models/shared/destinationweaviatebymarkdownheader.md deleted file mode 100644 index 9c8c08dd..00000000 --- a/docs/models/shared/destinationweaviatebymarkdownheader.md +++ /dev/null @@ -1,11 +0,0 @@ -# DestinationWeaviateByMarkdownHeader - -Split the text by Markdown headers down to the specified header level. If the chunk size fits multiple sections, they will be combined into a single chunk. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `mode` | [Optional[shared.DestinationWeaviateSchemasProcessingTextSplitterMode]](../../models/shared/destinationweaviateschemasprocessingtextsplittermode.md) | :heavy_minus_sign: | N/A | -| `split_level` | *Optional[int]* | :heavy_minus_sign: | Level of markdown headers to split text fields by. Headings down to the specified level will be used as split points | \ No newline at end of file diff --git a/docs/models/shared/destinationweaviatebyprogramminglanguage.md b/docs/models/shared/destinationweaviatebyprogramminglanguage.md deleted file mode 100644 index 781e1a76..00000000 --- a/docs/models/shared/destinationweaviatebyprogramminglanguage.md +++ /dev/null @@ -1,11 +0,0 @@ -# DestinationWeaviateByProgrammingLanguage - -Split the text by suitable delimiters based on the programming language. This is useful for splitting code into chunks. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `language` | [shared.DestinationWeaviateLanguage](../../models/shared/destinationweaviatelanguage.md) | :heavy_check_mark: | Split code in suitable places based on the programming language | -| `mode` | [Optional[shared.DestinationWeaviateSchemasProcessingTextSplitterTextSplitterMode]](../../models/shared/destinationweaviateschemasprocessingtextsplittertextsplittermode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationweaviatecohere.md b/docs/models/shared/destinationweaviatecohere.md deleted file mode 100644 index 7bdc2eba..00000000 --- a/docs/models/shared/destinationweaviatecohere.md +++ /dev/null @@ -1,11 +0,0 @@ -# DestinationWeaviateCohere - -Use the Cohere API to embed text. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `cohere_key` | *str* | :heavy_check_mark: | N/A | -| `mode` | [Optional[shared.DestinationWeaviateSchemasEmbeddingEmbeddingMode]](../../models/shared/destinationweaviateschemasembeddingembeddingmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationweaviateembedding.md b/docs/models/shared/destinationweaviateembedding.md deleted file mode 100644 index 5c8326cf..00000000 --- a/docs/models/shared/destinationweaviateembedding.md +++ /dev/null @@ -1,49 +0,0 @@ -# DestinationWeaviateEmbedding - -Embedding configuration - - -## Supported Types - -### NoExternalEmbedding - -```python -destinationWeaviateEmbedding: shared.NoExternalEmbedding = /* values here */ -``` - -### DestinationWeaviateAzureOpenAI - -```python -destinationWeaviateEmbedding: shared.DestinationWeaviateAzureOpenAI = /* values here */ -``` - -### DestinationWeaviateOpenAI - -```python -destinationWeaviateEmbedding: shared.DestinationWeaviateOpenAI = /* values here */ -``` - -### DestinationWeaviateCohere - -```python -destinationWeaviateEmbedding: shared.DestinationWeaviateCohere = /* values here */ -``` - -### FromField - -```python -destinationWeaviateEmbedding: shared.FromField = /* values here */ -``` - -### DestinationWeaviateFake - -```python -destinationWeaviateEmbedding: shared.DestinationWeaviateFake = /* values here */ -``` - -### DestinationWeaviateOpenAICompatible - -```python -destinationWeaviateEmbedding: shared.DestinationWeaviateOpenAICompatible = /* values here */ -``` - diff --git a/docs/models/shared/destinationweaviatefake.md b/docs/models/shared/destinationweaviatefake.md deleted file mode 100644 index a3a4ed27..00000000 --- a/docs/models/shared/destinationweaviatefake.md +++ /dev/null @@ -1,10 +0,0 @@ -# DestinationWeaviateFake - -Use a fake embedding made out of random vectors with 1536 embedding dimensions. This is useful for testing the data pipeline without incurring any costs. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `mode` | [Optional[shared.DestinationWeaviateSchemasEmbeddingEmbedding6Mode]](../../models/shared/destinationweaviateschemasembeddingembedding6mode.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 deleted file mode 100644 index 2b8db80f..00000000 --- a/docs/models/shared/destinationweaviateindexing.md +++ /dev/null @@ -1,16 +0,0 @@ -# DestinationWeaviateIndexing - -Indexing configuration - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | | -| `tenant_id` | *Optional[str]* | :heavy_minus_sign: | The tenant ID to use for multi tenancy | | -| `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 deleted file mode 100644 index 535349dc..00000000 --- a/docs/models/shared/destinationweaviateopenai.md +++ /dev/null @@ -1,11 +0,0 @@ -# DestinationWeaviateOpenAI - -Use the OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `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 deleted file mode 100644 index 9831a5ff..00000000 --- a/docs/models/shared/destinationweaviateopenaicompatible.md +++ /dev/null @@ -1,14 +0,0 @@ -# DestinationWeaviateOpenAICompatible - -Use a service that's compatible with the OpenAI API to embed text. - - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `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/destinationweaviatetextsplitter.md b/docs/models/shared/destinationweaviatetextsplitter.md deleted file mode 100644 index 22a86fe6..00000000 --- a/docs/models/shared/destinationweaviatetextsplitter.md +++ /dev/null @@ -1,25 +0,0 @@ -# DestinationWeaviateTextSplitter - -Split text fields into chunks based on the specified method. - - -## Supported Types - -### DestinationWeaviateBySeparator - -```python -destinationWeaviateTextSplitter: shared.DestinationWeaviateBySeparator = /* values here */ -``` - -### DestinationWeaviateByMarkdownHeader - -```python -destinationWeaviateTextSplitter: shared.DestinationWeaviateByMarkdownHeader = /* values here */ -``` - -### DestinationWeaviateByProgrammingLanguage - -```python -destinationWeaviateTextSplitter: shared.DestinationWeaviateByProgrammingLanguage = /* values here */ -``` - diff --git a/docs/models/shared/destinationweaviateusernamepassword.md b/docs/models/shared/destinationweaviateusernamepassword.md deleted file mode 100644 index 57e1c1e1..00000000 --- a/docs/models/shared/destinationweaviateusernamepassword.md +++ /dev/null @@ -1,12 +0,0 @@ -# DestinationWeaviateUsernamePassword - -Authenticate using username and password (suitable for self-managed Weaviate clusters) - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `password` | *str* | :heavy_check_mark: | Password for the Weaviate cluster | -| `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/destinationxata.md b/docs/models/shared/destinationxata.md deleted file mode 100644 index 1be9c695..00000000 --- a/docs/models/shared/destinationxata.md +++ /dev/null @@ -1,10 +0,0 @@ -# DestinationXata - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | API Key to connect. | | -| `db_url` | *str* | :heavy_check_mark: | URL pointing to your workspace. | https://my-workspace-abc123.us-east-1.xata.sh/db/nyc-taxi-fares:main | -| `destination_type` | [shared.Xata](../../models/shared/xata.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/detectchangeswithxminsystemcolumn.md b/docs/models/shared/detectchangeswithxminsystemcolumn.md deleted file mode 100644 index 0bad389a..00000000 --- a/docs/models/shared/detectchangeswithxminsystemcolumn.md +++ /dev/null @@ -1,10 +0,0 @@ -# DetectChangesWithXminSystemColumn - -Recommended - Incrementally reads new inserts and updates via Postgres Xmin system column. Only recommended for tables up to 500GB. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `method` | [shared.SourcePostgresSchemasMethod](../../models/shared/sourcepostgresschemasmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/dimensionsfilter.md b/docs/models/shared/dimensionsfilter.md deleted file mode 100644 index 1ff626ac..00000000 --- a/docs/models/shared/dimensionsfilter.md +++ /dev/null @@ -1,31 +0,0 @@ -# DimensionsFilter - -Dimensions filter - - -## Supported Types - -### AndGroup - -```python -dimensionsFilter: shared.AndGroup = /* values here */ -``` - -### OrGroup - -```python -dimensionsFilter: shared.OrGroup = /* values here */ -``` - -### NotExpression - -```python -dimensionsFilter: shared.NotExpression = /* values here */ -``` - -### Filter - -```python -dimensionsFilter: shared.Filter = /* values here */ -``` - diff --git a/docs/models/shared/disable.md b/docs/models/shared/disable.md deleted file mode 100644 index ec90220f..00000000 --- a/docs/models/shared/disable.md +++ /dev/null @@ -1,10 +0,0 @@ -# Disable - -Disable SSL. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `mode` | [Optional[shared.Mode]](../../models/shared/mode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/disabled.md b/docs/models/shared/disabled.md deleted file mode 100644 index 7d5615d0..00000000 --- a/docs/models/shared/disabled.md +++ /dev/null @@ -1,8 +0,0 @@ -# Disabled - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `deletion_mode` | [shared.SourceFaunaDeletionMode](../../models/shared/sourcefaunadeletionmode.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/doublevalue.md b/docs/models/shared/doublevalue.md deleted file mode 100644 index 5303a10e..00000000 --- a/docs/models/shared/doublevalue.md +++ /dev/null @@ -1,9 +0,0 @@ -# DoubleValue - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `value` | *float* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPIValueType](../../models/shared/sourcegoogleanalyticsdataapivaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/embedding.md b/docs/models/shared/embedding.md deleted file mode 100644 index 6d9c8ef7..00000000 --- a/docs/models/shared/embedding.md +++ /dev/null @@ -1,37 +0,0 @@ -# Embedding - -Embedding configuration - - -## Supported Types - -### OpenAI - -```python -embedding: shared.OpenAI = /* values here */ -``` - -### Cohere - -```python -embedding: shared.Cohere = /* values here */ -``` - -### Fake - -```python -embedding: shared.Fake = /* values here */ -``` - -### AzureOpenAI - -```python -embedding: shared.AzureOpenAI = /* values here */ -``` - -### OpenAICompatible - -```python -embedding: shared.OpenAICompatible = /* values here */ -``` - diff --git a/docs/models/shared/enabled.md b/docs/models/shared/enabled.md deleted file mode 100644 index d0fa1123..00000000 --- a/docs/models/shared/enabled.md +++ /dev/null @@ -1,9 +0,0 @@ -# Enabled - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `column` | *Optional[str]* | :heavy_minus_sign: | Name of the "deleted at" column. | -| `deletion_mode` | [shared.SourceFaunaSchemasDeletionMode](../../models/shared/sourcefaunaschemasdeletionmode.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/encryptedtrustservercertificate.md b/docs/models/shared/encryptedtrustservercertificate.md deleted file mode 100644 index 7b1fb62d..00000000 --- a/docs/models/shared/encryptedtrustservercertificate.md +++ /dev/null @@ -1,10 +0,0 @@ -# EncryptedTrustServerCertificate - -Use the certificate provided by the server without verification. (For testing purposes only!) - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `ssl_method` | [Optional[shared.DestinationMssqlSslMethod]](../../models/shared/destinationmssqlsslmethod.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/encryption.md b/docs/models/shared/encryption.md deleted file mode 100644 index a7270215..00000000 --- a/docs/models/shared/encryption.md +++ /dev/null @@ -1,19 +0,0 @@ -# Encryption - -The encryption method with is used when communicating with the database. - - -## Supported Types - -### NativeNetworkEncryptionNNE - -```python -encryption: shared.NativeNetworkEncryptionNNE = /* values here */ -``` - -### TLSEncryptedVerifyCertificate - -```python -encryption: shared.TLSEncryptedVerifyCertificate = /* values here */ -``` - diff --git a/docs/models/shared/eubasedaccount.md b/docs/models/shared/eubasedaccount.md deleted file mode 100644 index e1da3d36..00000000 --- a/docs/models/shared/eubasedaccount.md +++ /dev/null @@ -1,8 +0,0 @@ -# EUBasedAccount - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `url_base` | [Optional[shared.URLBase]](../../models/shared/urlbase.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 deleted file mode 100644 index 647d1393..00000000 --- a/docs/models/shared/externaltablevias3.md +++ /dev/null @@ -1,12 +0,0 @@ -# ExternalTableViaS3 - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `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 | | -| `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 | -| `method` | [shared.DestinationFireboltSchemasMethod](../../models/shared/destinationfireboltschemasmethod.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/fake.md b/docs/models/shared/fake.md deleted file mode 100644 index cba692db..00000000 --- a/docs/models/shared/fake.md +++ /dev/null @@ -1,10 +0,0 @@ -# Fake - -Use a fake embedding made out of random vectors with 1536 embedding dimensions. This is useful for testing the data pipeline without incurring any costs. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `mode` | [Optional[shared.DestinationAstraSchemasMode]](../../models/shared/destinationastraschemasmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/filter_.md b/docs/models/shared/filter_.md deleted file mode 100644 index 963fb5ae..00000000 --- a/docs/models/shared/filter_.md +++ /dev/null @@ -1,12 +0,0 @@ -# Filter - -A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `field_name` | *str* | :heavy_check_mark: | N/A | -| `filter_` | [Union[shared.StringFilter, shared.InListFilter, shared.NumericFilter, shared.BetweenFilter]](../../models/shared/sourcegoogleanalyticsdataapischemasfilter.md) | :heavy_check_mark: | N/A | -| `filter_type` | [Optional[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayFilterType]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayfiltertype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/format.md b/docs/models/shared/format.md deleted file mode 100644 index 4c67f329..00000000 --- a/docs/models/shared/format.md +++ /dev/null @@ -1,37 +0,0 @@ -# Format - -The configuration options that are used to alter how to read incoming files that deviate from the standard formatting. - - -## Supported Types - -### AvroFormat - -```python -format: shared.AvroFormat = /* values here */ -``` - -### CSVFormat - -```python -format: shared.CSVFormat = /* values here */ -``` - -### JsonlFormat - -```python -format: shared.JsonlFormat = /* values here */ -``` - -### ParquetFormat - -```python -format: shared.ParquetFormat = /* values here */ -``` - -### DocumentFileTypeFormatExperimental - -```python -format: shared.DocumentFileTypeFormatExperimental = /* values here */ -``` - diff --git a/docs/models/shared/fromcsv.md b/docs/models/shared/fromcsv.md deleted file mode 100644 index 7a87b5b3..00000000 --- a/docs/models/shared/fromcsv.md +++ /dev/null @@ -1,8 +0,0 @@ -# FromCSV - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `header_definition_type` | [Optional[shared.HeaderDefinitionType]](../../models/shared/headerdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/fromfield.md b/docs/models/shared/fromfield.md deleted file mode 100644 index 24e5796a..00000000 --- a/docs/models/shared/fromfield.md +++ /dev/null @@ -1,12 +0,0 @@ -# FromField - -Use a field in the record as the embedding. This is useful if you already have an embedding for your data and want to store it in the vector store. - - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `dimensions` | *int* | :heavy_check_mark: | The number of dimensions the embedding model is generating | 1536 | -| `field_name` | *str* | :heavy_check_mark: | Name of the field in the record that contains the embedding | embedding | -| `mode` | [Optional[shared.DestinationWeaviateSchemasEmbeddingEmbedding5Mode]](../../models/shared/destinationweaviateschemasembeddingembedding5mode.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/fromvalue.md b/docs/models/shared/fromvalue.md deleted file mode 100644 index d732ecf5..00000000 --- a/docs/models/shared/fromvalue.md +++ /dev/null @@ -1,17 +0,0 @@ -# FromValue - - -## Supported Types - -### SourceGoogleAnalyticsDataAPIInt64Value - -```python -fromValue: shared.SourceGoogleAnalyticsDataAPIInt64Value = /* values here */ -``` - -### SourceGoogleAnalyticsDataAPIDoubleValue - -```python -fromValue: shared.SourceGoogleAnalyticsDataAPIDoubleValue = /* values here */ -``` - diff --git a/docs/models/shared/github.md b/docs/models/shared/github.md deleted file mode 100644 index 3c700ebb..00000000 --- a/docs/models/shared/github.md +++ /dev/null @@ -1,8 +0,0 @@ -# Github - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `credentials` | [Optional[shared.GithubCredentials]](../../models/shared/githubcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/gitlab.md b/docs/models/shared/gitlab.md deleted file mode 100644 index 5f33397f..00000000 --- a/docs/models/shared/gitlab.md +++ /dev/null @@ -1,8 +0,0 @@ -# Gitlab - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `credentials` | [Optional[shared.GitlabCredentials]](../../models/shared/gitlabcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/globalaccount.md b/docs/models/shared/globalaccount.md deleted file mode 100644 index 0dd3c682..00000000 --- a/docs/models/shared/globalaccount.md +++ /dev/null @@ -1,8 +0,0 @@ -# GlobalAccount - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `url_base` | [Optional[shared.SourceSurveySparrowURLBase]](../../models/shared/sourcesurveysparrowurlbase.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/googleads.md b/docs/models/shared/googleads.md deleted file mode 100644 index 2b1738fb..00000000 --- a/docs/models/shared/googleads.md +++ /dev/null @@ -1,8 +0,0 @@ -# GoogleAds - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `credentials` | [Optional[shared.GoogleAdsCredentials]](../../models/shared/googleadscredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/googleanalyticsdataapi.md b/docs/models/shared/googleanalyticsdataapi.md deleted file mode 100644 index a3ce6607..00000000 --- a/docs/models/shared/googleanalyticsdataapi.md +++ /dev/null @@ -1,8 +0,0 @@ -# GoogleAnalyticsDataAPI - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `credentials` | [Optional[shared.GoogleAnalyticsDataAPICredentials]](../../models/shared/googleanalyticsdataapicredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/googledrive.md b/docs/models/shared/googledrive.md deleted file mode 100644 index e535859d..00000000 --- a/docs/models/shared/googledrive.md +++ /dev/null @@ -1,8 +0,0 @@ -# GoogleDrive - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `credentials` | [Optional[shared.GoogleDriveCredentials]](../../models/shared/googledrivecredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/googlesearchconsole.md b/docs/models/shared/googlesearchconsole.md deleted file mode 100644 index ed4d8d29..00000000 --- a/docs/models/shared/googlesearchconsole.md +++ /dev/null @@ -1,8 +0,0 @@ -# GoogleSearchConsole - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `authorization` | [Optional[shared.Authorization]](../../models/shared/authorization.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/googlesheets.md b/docs/models/shared/googlesheets.md deleted file mode 100644 index b43386f1..00000000 --- a/docs/models/shared/googlesheets.md +++ /dev/null @@ -1,8 +0,0 @@ -# GoogleSheets - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `credentials` | [Optional[shared.GoogleSheetsCredentials]](../../models/shared/googlesheetscredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/googleworkspaceadminreports.md b/docs/models/shared/googleworkspaceadminreports.md deleted file mode 100644 index 806049a3..00000000 --- a/docs/models/shared/googleworkspaceadminreports.md +++ /dev/null @@ -1,8 +0,0 @@ -# GoogleWorkspaceAdminReports - - -## Values - -| Name | Value | -| -------------------------------- | -------------------------------- | -| `GOOGLE_WORKSPACE_ADMIN_REPORTS` | google-workspace-admin-reports | \ No newline at end of file diff --git a/docs/models/shared/gzip.md b/docs/models/shared/gzip.md deleted file mode 100644 index a6655bd5..00000000 --- a/docs/models/shared/gzip.md +++ /dev/null @@ -1,8 +0,0 @@ -# Gzip - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `compression_type` | [Optional[shared.DestinationGcsCompressionType]](../../models/shared/destinationgcscompressiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/harvest.md b/docs/models/shared/harvest.md deleted file mode 100644 index bbd91298..00000000 --- a/docs/models/shared/harvest.md +++ /dev/null @@ -1,8 +0,0 @@ -# Harvest - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `credentials` | [Optional[shared.HarvestCredentials]](../../models/shared/harvestcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/httpspublicweb.md b/docs/models/shared/httpspublicweb.md deleted file mode 100644 index 19769ff8..00000000 --- a/docs/models/shared/httpspublicweb.md +++ /dev/null @@ -1,9 +0,0 @@ -# HTTPSPublicWeb - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `storage` | [shared.Storage](../../models/shared/storage.md) | :heavy_check_mark: | N/A | -| `user_agent` | *Optional[bool]* | :heavy_minus_sign: | Add User-Agent to request | \ No newline at end of file diff --git a/docs/models/shared/hubspot.md b/docs/models/shared/hubspot.md deleted file mode 100644 index daaa145f..00000000 --- a/docs/models/shared/hubspot.md +++ /dev/null @@ -1,8 +0,0 @@ -# Hubspot - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `credentials` | [Optional[shared.HubspotCredentials]](../../models/shared/hubspotcredentials.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 deleted file mode 100644 index 335a0e39..00000000 --- a/docs/models/shared/iamrole.md +++ /dev/null @@ -1,9 +0,0 @@ -# IAMRole - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `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/iamuser.md b/docs/models/shared/iamuser.md deleted file mode 100644 index 8dfa815a..00000000 --- a/docs/models/shared/iamuser.md +++ /dev/null @@ -1,10 +0,0 @@ -# IAMUser - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `aws_access_key_id` | *str* | :heavy_check_mark: | AWS User Access Key Id | -| `aws_secret_access_key` | *str* | :heavy_check_mark: | Secret Access Key | -| `credentials_title` | [Optional[shared.DestinationAwsDatalakeCredentialsTitle]](../../models/shared/destinationawsdatalakecredentialstitle.md) | :heavy_minus_sign: | Name of the credentials | \ No newline at end of file diff --git a/docs/models/shared/inlistfilter.md b/docs/models/shared/inlistfilter.md deleted file mode 100644 index 297a796d..00000000 --- a/docs/models/shared/inlistfilter.md +++ /dev/null @@ -1,10 +0,0 @@ -# InListFilter - - -## Fields - -| 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 | \ No newline at end of file diff --git a/docs/models/shared/int64value.md b/docs/models/shared/int64value.md deleted file mode 100644 index 2630f732..00000000 --- a/docs/models/shared/int64value.md +++ /dev/null @@ -1,9 +0,0 @@ -# Int64Value - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `value` | *str* | :heavy_check_mark: | N/A | -| `value_type` | [shared.ValueType](../../models/shared/valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/jobsresponse.md b/docs/models/shared/jobsresponse.md deleted file mode 100644 index 87fc5a38..00000000 --- a/docs/models/shared/jobsresponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# JobsResponse - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `data` | List[[shared.JobResponse](../../models/shared/jobresponse.md)] | :heavy_check_mark: | N/A | -| `next` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `previous` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/jsonlformat.md b/docs/models/shared/jsonlformat.md deleted file mode 100644 index 2d37c798..00000000 --- a/docs/models/shared/jsonlformat.md +++ /dev/null @@ -1,8 +0,0 @@ -# JsonlFormat - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `filetype` | [Optional[shared.SourceAzureBlobStorageSchemasFiletype]](../../models/shared/sourceazureblobstorageschemasfiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/jsonlinesnewlinedelimitedjson.md b/docs/models/shared/jsonlinesnewlinedelimitedjson.md deleted file mode 100644 index bff242ce..00000000 --- a/docs/models/shared/jsonlinesnewlinedelimitedjson.md +++ /dev/null @@ -1,9 +0,0 @@ -# JSONLinesNewlineDelimitedJSON - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `compression_codec` | [Optional[shared.CompressionCodecOptional]](../../models/shared/compressioncodecoptional.md) | :heavy_minus_sign: | The compression algorithm used to compress data. | -| `format_type` | [Optional[shared.FormatTypeWildcard]](../../models/shared/formattypewildcard.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/keen.md b/docs/models/shared/keen.md deleted file mode 100644 index 52077473..00000000 --- a/docs/models/shared/keen.md +++ /dev/null @@ -1,8 +0,0 @@ -# Keen - - -## Values - -| Name | Value | -| ------ | ------ | -| `KEEN` | keen | \ No newline at end of file diff --git a/docs/models/shared/kinesis.md b/docs/models/shared/kinesis.md deleted file mode 100644 index a228f2a9..00000000 --- a/docs/models/shared/kinesis.md +++ /dev/null @@ -1,8 +0,0 @@ -# Kinesis - - -## Values - -| Name | Value | -| --------- | --------- | -| `KINESIS` | kinesis | \ No newline at end of file diff --git a/docs/models/shared/leverhiring.md b/docs/models/shared/leverhiring.md deleted file mode 100644 index ff75686d..00000000 --- a/docs/models/shared/leverhiring.md +++ /dev/null @@ -1,8 +0,0 @@ -# LeverHiring - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `credentials` | [Optional[shared.LeverHiringCredentials]](../../models/shared/leverhiringcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/linkedinads.md b/docs/models/shared/linkedinads.md deleted file mode 100644 index cebaa2e8..00000000 --- a/docs/models/shared/linkedinads.md +++ /dev/null @@ -1,8 +0,0 @@ -# LinkedinAds - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `credentials` | [Optional[shared.LinkedinAdsCredentials]](../../models/shared/linkedinadscredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/loadingmethod.md b/docs/models/shared/loadingmethod.md deleted file mode 100644 index 874f0d69..00000000 --- a/docs/models/shared/loadingmethod.md +++ /dev/null @@ -1,19 +0,0 @@ -# LoadingMethod - -The way data will be uploaded to BigQuery. - - -## Supported Types - -### GCSStaging - -```python -loadingMethod: shared.GCSStaging = /* values here */ -``` - -### StandardInserts - -```python -loadingMethod: shared.StandardInserts = /* values here */ -``` - diff --git a/docs/models/shared/local.md b/docs/models/shared/local.md deleted file mode 100644 index 41c650ec..00000000 --- a/docs/models/shared/local.md +++ /dev/null @@ -1,10 +0,0 @@ -# Local - -Process files locally, supporting `fast` and `ocr` modes. This is the default option. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `mode` | [Optional[shared.SourceAzureBlobStorageMode]](../../models/shared/sourceazureblobstoragemode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/loginpassword.md b/docs/models/shared/loginpassword.md deleted file mode 100644 index 350694e2..00000000 --- a/docs/models/shared/loginpassword.md +++ /dev/null @@ -1,12 +0,0 @@ -# LoginPassword - -Login/Password. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `password` | *str* | :heavy_check_mark: | Password associated with the username. | -| `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/mailchimp.md b/docs/models/shared/mailchimp.md deleted file mode 100644 index c288e479..00000000 --- a/docs/models/shared/mailchimp.md +++ /dev/null @@ -1,8 +0,0 @@ -# Mailchimp - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `credentials` | [Optional[shared.MailchimpCredentials]](../../models/shared/mailchimpcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/metricsfilter.md b/docs/models/shared/metricsfilter.md deleted file mode 100644 index 25605e91..00000000 --- a/docs/models/shared/metricsfilter.md +++ /dev/null @@ -1,31 +0,0 @@ -# MetricsFilter - -Metrics filter - - -## Supported Types - -### SourceGoogleAnalyticsDataAPIAndGroup - -```python -metricsFilter: shared.SourceGoogleAnalyticsDataAPIAndGroup = /* values here */ -``` - -### SourceGoogleAnalyticsDataAPIOrGroup - -```python -metricsFilter: shared.SourceGoogleAnalyticsDataAPIOrGroup = /* values here */ -``` - -### SourceGoogleAnalyticsDataAPINotExpression - -```python -metricsFilter: shared.SourceGoogleAnalyticsDataAPINotExpression = /* values here */ -``` - -### SourceGoogleAnalyticsDataAPIFilter - -```python -metricsFilter: shared.SourceGoogleAnalyticsDataAPIFilter = /* values here */ -``` - diff --git a/docs/models/shared/microsoftsharepoint.md b/docs/models/shared/microsoftsharepoint.md deleted file mode 100644 index 7d344aa5..00000000 --- a/docs/models/shared/microsoftsharepoint.md +++ /dev/null @@ -1,8 +0,0 @@ -# MicrosoftSharepoint - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `credentials` | [Optional[shared.MicrosoftSharepointCredentials]](../../models/shared/microsoftsharepointcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/microsoftteams.md b/docs/models/shared/microsoftteams.md deleted file mode 100644 index e8ffa26f..00000000 --- a/docs/models/shared/microsoftteams.md +++ /dev/null @@ -1,8 +0,0 @@ -# MicrosoftTeams - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `credentials` | [Optional[shared.MicrosoftTeamsCredentials]](../../models/shared/microsoftteamscredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/mockcatalog.md b/docs/models/shared/mockcatalog.md deleted file mode 100644 index 011e0c8e..00000000 --- a/docs/models/shared/mockcatalog.md +++ /dev/null @@ -1,17 +0,0 @@ -# MockCatalog - - -## Supported Types - -### SingleSchema - -```python -mockCatalog: shared.SingleSchema = /* values here */ -``` - -### MultiSchema - -```python -mockCatalog: shared.MultiSchema = /* values here */ -``` - diff --git a/docs/models/shared/monday.md b/docs/models/shared/monday.md deleted file mode 100644 index 390ae687..00000000 --- a/docs/models/shared/monday.md +++ /dev/null @@ -1,8 +0,0 @@ -# Monday - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `credentials` | [Optional[shared.MondayCredentials]](../../models/shared/mondaycredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/mongodbatlas.md b/docs/models/shared/mongodbatlas.md deleted file mode 100644 index 3598cf4a..00000000 --- a/docs/models/shared/mongodbatlas.md +++ /dev/null @@ -1,9 +0,0 @@ -# MongoDBAtlas - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `cluster_url` | *str* | :heavy_check_mark: | URL of a cluster to connect to. | -| `instance` | [Optional[shared.DestinationMongodbSchemasInstance]](../../models/shared/destinationmongodbschemasinstance.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/mongodbinstancetype.md b/docs/models/shared/mongodbinstancetype.md deleted file mode 100644 index e748b1a7..00000000 --- a/docs/models/shared/mongodbinstancetype.md +++ /dev/null @@ -1,25 +0,0 @@ -# MongoDbInstanceType - -MongoDb instance to connect to. For MongoDB Atlas and Replica Set TLS connection is used by default. - - -## Supported Types - -### StandaloneMongoDbInstance - -```python -mongoDbInstanceType: shared.StandaloneMongoDbInstance = /* values here */ -``` - -### ReplicaSet - -```python -mongoDbInstanceType: shared.ReplicaSet = /* values here */ -``` - -### MongoDBAtlas - -```python -mongoDbInstanceType: shared.MongoDBAtlas = /* values here */ -``` - diff --git a/docs/models/shared/nativenetworkencryptionnne.md b/docs/models/shared/nativenetworkencryptionnne.md deleted file mode 100644 index eb9d71fd..00000000 --- a/docs/models/shared/nativenetworkencryptionnne.md +++ /dev/null @@ -1,11 +0,0 @@ -# NativeNetworkEncryptionNNE - -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. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `encryption_algorithm` | [Optional[shared.EncryptionAlgorithm]](../../models/shared/encryptionalgorithm.md) | :heavy_minus_sign: | This parameter defines what encryption algorithm is used. | -| `encryption_method` | [shared.EncryptionMethod](../../models/shared/encryptionmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/noauth.md b/docs/models/shared/noauth.md deleted file mode 100644 index 34f5242f..00000000 --- a/docs/models/shared/noauth.md +++ /dev/null @@ -1,10 +0,0 @@ -# NoAuth - -Do not authenticate (suitable for locally running test clusters, do not use for clusters with public IP addresses) - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `mode` | [Optional[shared.DestinationMilvusSchemasIndexingAuthAuthenticationMode]](../../models/shared/destinationmilvusschemasindexingauthauthenticationmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/noauthentication.md b/docs/models/shared/noauthentication.md deleted file mode 100644 index d94fb710..00000000 --- a/docs/models/shared/noauthentication.md +++ /dev/null @@ -1,10 +0,0 @@ -# NoAuthentication - -Do not authenticate (suitable for locally running test clusters, do not use for clusters with public IP addresses) - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `mode` | [Optional[shared.DestinationWeaviateSchemasIndexingAuthAuthenticationMode]](../../models/shared/destinationweaviateschemasindexingauthauthenticationmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/nocompression.md b/docs/models/shared/nocompression.md deleted file mode 100644 index 8447947e..00000000 --- a/docs/models/shared/nocompression.md +++ /dev/null @@ -1,8 +0,0 @@ -# NoCompression - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `codec` | [Optional[shared.Codec]](../../models/shared/codec.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/noencryption.md b/docs/models/shared/noencryption.md deleted file mode 100644 index 73465ed6..00000000 --- a/docs/models/shared/noencryption.md +++ /dev/null @@ -1,10 +0,0 @@ -# NoEncryption - -Staging data will be stored in plaintext. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `encryption_type` | [Optional[shared.EncryptionType]](../../models/shared/encryptiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/noexternalembedding.md b/docs/models/shared/noexternalembedding.md deleted file mode 100644 index c7ea1814..00000000 --- a/docs/models/shared/noexternalembedding.md +++ /dev/null @@ -1,10 +0,0 @@ -# NoExternalEmbedding - -Do not calculate and pass embeddings to Weaviate. Suitable for clusters with configured vectorizers to calculate embeddings within Weaviate or for classes that should only support regular text search. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `mode` | [Optional[shared.DestinationWeaviateMode]](../../models/shared/destinationweaviatemode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/nonet.md b/docs/models/shared/nonet.md deleted file mode 100644 index 3e3268b1..00000000 --- a/docs/models/shared/nonet.md +++ /dev/null @@ -1,10 +0,0 @@ -# NoneT - -None. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `authorization` | [shared.DestinationMongodbSchemasAuthorization](../../models/shared/destinationmongodbschemasauthorization.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/notexpression.md b/docs/models/shared/notexpression.md deleted file mode 100644 index afa53278..00000000 --- a/docs/models/shared/notexpression.md +++ /dev/null @@ -1,11 +0,0 @@ -# NotExpression - -The FilterExpression is NOT of notExpression. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `expression` | [Optional[shared.SourceGoogleAnalyticsDataAPISchemasExpression]](../../models/shared/sourcegoogleanalyticsdataapischemasexpression.md) | :heavy_minus_sign: | N/A | -| `filter_type` | [Optional[shared.SourceGoogleAnalyticsDataAPISchemasFilterType]](../../models/shared/sourcegoogleanalyticsdataapischemasfiltertype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/notion.md b/docs/models/shared/notion.md deleted file mode 100644 index 5d9a7651..00000000 --- a/docs/models/shared/notion.md +++ /dev/null @@ -1,8 +0,0 @@ -# Notion - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `credentials` | [Optional[shared.NotionCredentials]](../../models/shared/notioncredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/notunnel.md b/docs/models/shared/notunnel.md deleted file mode 100644 index 351f1d06..00000000 --- a/docs/models/shared/notunnel.md +++ /dev/null @@ -1,8 +0,0 @@ -# NoTunnel - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `tunnel_method` | [shared.TunnelMethod](../../models/shared/tunnelmethod.md) | :heavy_check_mark: | No ssh tunnel needed to connect to database | \ No newline at end of file diff --git a/docs/models/shared/numericfilter.md b/docs/models/shared/numericfilter.md deleted file mode 100644 index 2bcd1381..00000000 --- a/docs/models/shared/numericfilter.md +++ /dev/null @@ -1,10 +0,0 @@ -# NumericFilter - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `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/oauth.md b/docs/models/shared/oauth.md deleted file mode 100644 index 775bc9bd..00000000 --- a/docs/models/shared/oauth.md +++ /dev/null @@ -1,11 +0,0 @@ -# OAuth - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `access_token` | *str* | :heavy_check_mark: | OAuth access token | -| `client_id` | *Optional[str]* | :heavy_minus_sign: | OAuth Client Id | -| `client_secret` | *Optional[str]* | :heavy_minus_sign: | OAuth Client secret | -| `option_title` | [Optional[shared.OptionTitle]](../../models/shared/optiontitle.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/oauth20.md b/docs/models/shared/oauth20.md deleted file mode 100644 index 8b4bcd92..00000000 --- a/docs/models/shared/oauth20.md +++ /dev/null @@ -1,11 +0,0 @@ -# OAuth20 - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `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. | -| `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/oauthauthentication.md b/docs/models/shared/oauthauthentication.md deleted file mode 100644 index 8d66cf8b..00000000 --- a/docs/models/shared/oauthauthentication.md +++ /dev/null @@ -1,11 +0,0 @@ -# OauthAuthentication - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `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 | -| `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/oauthcredentialsconfiguration.md b/docs/models/shared/oauthcredentialsconfiguration.md deleted file mode 100644 index 38c6eb3c..00000000 --- a/docs/models/shared/oauthcredentialsconfiguration.md +++ /dev/null @@ -1,265 +0,0 @@ -# OAuthCredentialsConfiguration - -The values required to configure the source. - - -## Supported Types - -### Airtable - -```python -oAuthCredentialsConfiguration: shared.Airtable = /* values here */ -``` - -### AmazonAds - -```python -oAuthCredentialsConfiguration: shared.AmazonAds = /* values here */ -``` - -### AmazonSellerPartner - -```python -oAuthCredentialsConfiguration: shared.AmazonSellerPartner = /* values here */ -``` - -### Asana - -```python -oAuthCredentialsConfiguration: shared.Asana = /* values here */ -``` - -### BingAds - -```python -oAuthCredentialsConfiguration: shared.BingAds = /* values here */ -``` - -### FacebookMarketing - -```python -oAuthCredentialsConfiguration: shared.FacebookMarketing = /* values here */ -``` - -### Github - -```python -oAuthCredentialsConfiguration: shared.Github = /* values here */ -``` - -### Gitlab - -```python -oAuthCredentialsConfiguration: shared.Gitlab = /* values here */ -``` - -### GoogleAds - -```python -oAuthCredentialsConfiguration: shared.GoogleAds = /* values here */ -``` - -### GoogleAnalyticsDataAPI - -```python -oAuthCredentialsConfiguration: shared.GoogleAnalyticsDataAPI = /* values here */ -``` - -### GoogleDrive - -```python -oAuthCredentialsConfiguration: shared.GoogleDrive = /* values here */ -``` - -### GoogleSearchConsole - -```python -oAuthCredentialsConfiguration: shared.GoogleSearchConsole = /* values here */ -``` - -### GoogleSheets - -```python -oAuthCredentialsConfiguration: shared.GoogleSheets = /* values here */ -``` - -### Harvest - -```python -oAuthCredentialsConfiguration: shared.Harvest = /* values here */ -``` - -### Hubspot - -```python -oAuthCredentialsConfiguration: shared.Hubspot = /* values here */ -``` - -### Instagram - -```python -oAuthCredentialsConfiguration: shared.Instagram = /* values here */ -``` - -### Intercom - -```python -oAuthCredentialsConfiguration: shared.Intercom = /* values here */ -``` - -### LeverHiring - -```python -oAuthCredentialsConfiguration: shared.LeverHiring = /* values here */ -``` - -### LinkedinAds - -```python -oAuthCredentialsConfiguration: shared.LinkedinAds = /* values here */ -``` - -### Mailchimp - -```python -oAuthCredentialsConfiguration: shared.Mailchimp = /* values here */ -``` - -### MicrosoftSharepoint - -```python -oAuthCredentialsConfiguration: shared.MicrosoftSharepoint = /* values here */ -``` - -### MicrosoftTeams - -```python -oAuthCredentialsConfiguration: shared.MicrosoftTeams = /* values here */ -``` - -### Monday - -```python -oAuthCredentialsConfiguration: shared.Monday = /* values here */ -``` - -### Notion - -```python -oAuthCredentialsConfiguration: shared.Notion = /* values here */ -``` - -### Pinterest - -```python -oAuthCredentialsConfiguration: shared.Pinterest = /* values here */ -``` - -### Retently - -```python -oAuthCredentialsConfiguration: shared.Retently = /* values here */ -``` - -### Salesforce - -```python -oAuthCredentialsConfiguration: shared.Salesforce = /* values here */ -``` - -### Shopify - -```python -oAuthCredentialsConfiguration: shared.Shopify = /* values here */ -``` - -### Slack - -```python -oAuthCredentialsConfiguration: shared.Slack = /* values here */ -``` - -### Smartsheets - -```python -oAuthCredentialsConfiguration: shared.Smartsheets = /* values here */ -``` - -### SnapchatMarketing - -```python -oAuthCredentialsConfiguration: shared.SnapchatMarketing = /* values here */ -``` - -### Snowflake - -```python -oAuthCredentialsConfiguration: shared.Snowflake = /* values here */ -``` - -### Square - -```python -oAuthCredentialsConfiguration: shared.Square = /* values here */ -``` - -### Strava - -```python -oAuthCredentialsConfiguration: shared.Strava = /* values here */ -``` - -### Surveymonkey - -```python -oAuthCredentialsConfiguration: shared.Surveymonkey = /* values here */ -``` - -### TiktokMarketing - -```python -oAuthCredentialsConfiguration: shared.TiktokMarketing = /* values here */ -``` - -### - -```python -oAuthCredentialsConfiguration: Any = /* values here */ -``` - -### Typeform - -```python -oAuthCredentialsConfiguration: shared.Typeform = /* values here */ -``` - -### YoutubeAnalytics - -```python -oAuthCredentialsConfiguration: shared.YoutubeAnalytics = /* values here */ -``` - -### ZendeskChat - -```python -oAuthCredentialsConfiguration: shared.ZendeskChat = /* values here */ -``` - -### ZendeskSunshine - -```python -oAuthCredentialsConfiguration: shared.ZendeskSunshine = /* values here */ -``` - -### ZendeskSupport - -```python -oAuthCredentialsConfiguration: shared.ZendeskSupport = /* values here */ -``` - -### ZendeskTalk - -```python -oAuthCredentialsConfiguration: shared.ZendeskTalk = /* values here */ -``` - diff --git a/docs/models/shared/openai.md b/docs/models/shared/openai.md deleted file mode 100644 index 83f17926..00000000 --- a/docs/models/shared/openai.md +++ /dev/null @@ -1,11 +0,0 @@ -# OpenAI - -Use the OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `openai_key` | *str* | :heavy_check_mark: | N/A | -| `mode` | [Optional[shared.DestinationAstraSchemasEmbeddingEmbedding1Mode]](../../models/shared/destinationastraschemasembeddingembedding1mode.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 deleted file mode 100644 index a23de367..00000000 --- a/docs/models/shared/openaicompatible.md +++ /dev/null @@ -1,14 +0,0 @@ -# OpenAICompatible - -Use a service that's compatible with the OpenAI API to embed text. - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `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.DestinationAstraSchemasEmbeddingEmbeddingMode]](../../models/shared/destinationastraschemasembeddingembeddingmode.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/orgroup.md b/docs/models/shared/orgroup.md deleted file mode 100644 index 52482e3a..00000000 --- a/docs/models/shared/orgroup.md +++ /dev/null @@ -1,11 +0,0 @@ -# OrGroup - -The FilterExpressions in orGroup have an OR relationship. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `expressions` | List[[shared.SourceGoogleAnalyticsDataAPIExpression](../../models/shared/sourcegoogleanalyticsdataapiexpression.md)] | :heavy_check_mark: | N/A | -| `filter_type` | [shared.SourceGoogleAnalyticsDataAPIFilterType](../../models/shared/sourcegoogleanalyticsdataapifiltertype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/outputformat.md b/docs/models/shared/outputformat.md deleted file mode 100644 index eb2e2edc..00000000 --- a/docs/models/shared/outputformat.md +++ /dev/null @@ -1,19 +0,0 @@ -# OutputFormat - -Output data format - - -## Supported Types - -### CSVCommaSeparatedValues - -```python -outputFormat: shared.CSVCommaSeparatedValues = /* values here */ -``` - -### DestinationAzureBlobStorageJSONLinesNewlineDelimitedJSON - -```python -outputFormat: shared.DestinationAzureBlobStorageJSONLinesNewlineDelimitedJSON = /* values here */ -``` - diff --git a/docs/models/shared/outputformatwildcard.md b/docs/models/shared/outputformatwildcard.md deleted file mode 100644 index 2000e715..00000000 --- a/docs/models/shared/outputformatwildcard.md +++ /dev/null @@ -1,19 +0,0 @@ -# OutputFormatWildcard - -Format of the data output. - - -## Supported Types - -### JSONLinesNewlineDelimitedJSON - -```python -outputFormatWildcard: shared.JSONLinesNewlineDelimitedJSON = /* values here */ -``` - -### ParquetColumnarStorage - -```python -outputFormatWildcard: shared.ParquetColumnarStorage = /* values here */ -``` - diff --git a/docs/models/shared/parquetcolumnarstorage.md b/docs/models/shared/parquetcolumnarstorage.md deleted file mode 100644 index f1d6b5f7..00000000 --- a/docs/models/shared/parquetcolumnarstorage.md +++ /dev/null @@ -1,9 +0,0 @@ -# ParquetColumnarStorage - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `compression_codec` | [Optional[shared.DestinationAwsDatalakeCompressionCodecOptional]](../../models/shared/destinationawsdatalakecompressioncodecoptional.md) | :heavy_minus_sign: | The compression algorithm used to compress data. | -| `format_type` | [Optional[shared.DestinationAwsDatalakeFormatTypeWildcard]](../../models/shared/destinationawsdatalakeformattypewildcard.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/passwordauthentication.md b/docs/models/shared/passwordauthentication.md deleted file mode 100644 index b77537af..00000000 --- a/docs/models/shared/passwordauthentication.md +++ /dev/null @@ -1,12 +0,0 @@ -# PasswordAuthentication - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `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_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/pinterest.md b/docs/models/shared/pinterest.md deleted file mode 100644 index a6a4f524..00000000 --- a/docs/models/shared/pinterest.md +++ /dev/null @@ -1,8 +0,0 @@ -# Pinterest - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `credentials` | [Optional[shared.PinterestCredentials]](../../models/shared/pinterestcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/prefer.md b/docs/models/shared/prefer.md deleted file mode 100644 index 644105b4..00000000 --- a/docs/models/shared/prefer.md +++ /dev/null @@ -1,10 +0,0 @@ -# Prefer - -Prefer SSL mode. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `mode` | [Optional[shared.DestinationPostgresSchemasMode]](../../models/shared/destinationpostgresschemasmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/preferred.md b/docs/models/shared/preferred.md deleted file mode 100644 index 45e461cb..00000000 --- a/docs/models/shared/preferred.md +++ /dev/null @@ -1,10 +0,0 @@ -# Preferred - -Automatically attempt SSL connection. If the MySQL server does not support SSL, continue with a regular connection. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `mode` | [shared.SourceMysqlMode](../../models/shared/sourcemysqlmode.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/privatetoken.md b/docs/models/shared/privatetoken.md deleted file mode 100644 index e65e67e5..00000000 --- a/docs/models/shared/privatetoken.md +++ /dev/null @@ -1,9 +0,0 @@ -# PrivateToken - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `access_token` | *str* | :heavy_check_mark: | Log into your Gitlab account and then generate a personal Access Token. | -| `auth_type` | [Optional[shared.SourceGitlabSchemasAuthType]](../../models/shared/sourcegitlabschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/processing.md b/docs/models/shared/processing.md deleted file mode 100644 index c03117cf..00000000 --- a/docs/models/shared/processing.md +++ /dev/null @@ -1,13 +0,0 @@ -# Processing - -Processing configuration - - -## Supported Types - -### Local - -```python -processing: shared.Local = /* values here */ -``` - diff --git a/docs/models/shared/readchangesusingbinarylogcdc.md b/docs/models/shared/readchangesusingbinarylogcdc.md deleted file mode 100644 index a9fdfe2a..00000000 --- a/docs/models/shared/readchangesusingbinarylogcdc.md +++ /dev/null @@ -1,12 +0,0 @@ -# ReadChangesUsingBinaryLogCDC - -Recommended - Incrementally reads new inserts, updates, and deletes using the MySQL binary log. This must be enabled on your database. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `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. | -| `method` | [shared.SourceMysqlMethod](../../models/shared/sourcemysqlmethod.md) | :heavy_check_mark: | N/A | -| `server_time_zone` | *Optional[str]* | :heavy_minus_sign: | 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. | \ No newline at end of file diff --git a/docs/models/shared/readchangesusingchangedatacapturecdc.md b/docs/models/shared/readchangesusingchangedatacapturecdc.md deleted file mode 100644 index 2f24c9b3..00000000 --- a/docs/models/shared/readchangesusingchangedatacapturecdc.md +++ /dev/null @@ -1,11 +0,0 @@ -# ReadChangesUsingChangeDataCaptureCDC - -Recommended - Incrementally reads new inserts, updates, and deletes using the SQL Server's change data capture feature. This must be enabled on your database. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `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. | -| `method` | [shared.SourceMssqlMethod](../../models/shared/sourcemssqlmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/readchangesusingwriteaheadlogcdc.md b/docs/models/shared/readchangesusingwriteaheadlogcdc.md deleted file mode 100644 index b1325b00..00000000 --- a/docs/models/shared/readchangesusingwriteaheadlogcdc.md +++ /dev/null @@ -1,18 +0,0 @@ -# ReadChangesUsingWriteAheadLogCDC - -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. - - -## Fields - -| 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 | -| `heartbeat_action_query` | *Optional[str]* | :heavy_minus_sign: | Specifies a query that the connector executes on the source database when the connector sends a heartbeat message. Please see the setup guide for how and when to configure this setting. | -| `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.LSNCommitBehaviour]](../../models/shared/lsncommitbehaviour.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.Plugin]](../../models/shared/plugin.md) | :heavy_minus_sign: | A logical decoding plugin installed on the PostgreSQL server. | -| `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/recommendedmanagedtables.md b/docs/models/shared/recommendedmanagedtables.md deleted file mode 100644 index 71e6a9bd..00000000 --- a/docs/models/shared/recommendedmanagedtables.md +++ /dev/null @@ -1,8 +0,0 @@ -# RecommendedManagedTables - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `data_source_type` | [shared.DataSourceType](../../models/shared/datasourcetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/replicaset.md b/docs/models/shared/replicaset.md deleted file mode 100644 index 42548a6a..00000000 --- a/docs/models/shared/replicaset.md +++ /dev/null @@ -1,10 +0,0 @@ -# ReplicaSet - - -## Fields - -| 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. | | \ No newline at end of file diff --git a/docs/models/shared/reportoptions.md b/docs/models/shared/reportoptions.md deleted file mode 100644 index 0280fbc1..00000000 --- a/docs/models/shared/reportoptions.md +++ /dev/null @@ -1,9 +0,0 @@ -# ReportOptions - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `options_list` | List[[shared.OptionsList](../../models/shared/optionslist.md)] | :heavy_check_mark: | List of options | -| `stream_name` | [shared.StreamName](../../models/shared/streamname.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/require.md b/docs/models/shared/require.md deleted file mode 100644 index fa8b8350..00000000 --- a/docs/models/shared/require.md +++ /dev/null @@ -1,10 +0,0 @@ -# Require - -Require SSL mode. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `mode` | [Optional[shared.DestinationPostgresSchemasSslModeMode]](../../models/shared/destinationpostgresschemassslmodemode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/required.md b/docs/models/shared/required.md deleted file mode 100644 index 0ec00c01..00000000 --- a/docs/models/shared/required.md +++ /dev/null @@ -1,10 +0,0 @@ -# Required - -Always connect with SSL. If the MySQL server doesn’t support SSL, the connection will not be established. Certificate Authority (CA) and Hostname are not verified. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `mode` | [shared.SourceMysqlSchemasMode](../../models/shared/sourcemysqlschemasmode.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/retently.md b/docs/models/shared/retently.md deleted file mode 100644 index c4166a15..00000000 --- a/docs/models/shared/retently.md +++ /dev/null @@ -1,8 +0,0 @@ -# Retently - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `credentials` | [Optional[shared.RetentlyCredentials]](../../models/shared/retentlycredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sandboxaccesstoken.md b/docs/models/shared/sandboxaccesstoken.md deleted file mode 100644 index bbbb2d64..00000000 --- a/docs/models/shared/sandboxaccesstoken.md +++ /dev/null @@ -1,10 +0,0 @@ -# SandboxAccessToken - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `access_token` | *str* | :heavy_check_mark: | The long-term authorized access token. | -| `advertiser_id` | *str* | :heavy_check_mark: | The Advertiser ID which generated for the developer's Sandbox application. | -| `auth_type` | [Optional[shared.SourceTiktokMarketingSchemasAuthType]](../../models/shared/sourcetiktokmarketingschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/scanchangeswithuserdefinedcursor.md b/docs/models/shared/scanchangeswithuserdefinedcursor.md deleted file mode 100644 index 0bebd81a..00000000 --- a/docs/models/shared/scanchangeswithuserdefinedcursor.md +++ /dev/null @@ -1,10 +0,0 @@ -# ScanChangesWithUserDefinedCursor - -Incrementally detects new inserts and updates using the cursor column chosen when configuring a connection (e.g. created_at, updated_at). - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `method` | [shared.SourceMssqlSchemasMethod](../../models/shared/sourcemssqlschemasmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/scpsecurecopyprotocol.md b/docs/models/shared/scpsecurecopyprotocol.md deleted file mode 100644 index 747e727c..00000000 --- a/docs/models/shared/scpsecurecopyprotocol.md +++ /dev/null @@ -1,12 +0,0 @@ -# SCPSecureCopyProtocol - - -## Fields - -| 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 | \ No newline at end of file diff --git a/docs/models/shared/security.md b/docs/models/shared/security.md deleted file mode 100644 index 38fa7311..00000000 --- a/docs/models/shared/security.md +++ /dev/null @@ -1,9 +0,0 @@ -# Security - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `basic_auth` | [Optional[shared.SchemeBasicAuth]](../../models/shared/schemebasicauth.md) | :heavy_minus_sign: | N/A | -| `bearer_auth` | *Optional[str]* | :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 deleted file mode 100644 index 6e35c4c3..00000000 --- a/docs/models/shared/servicename.md +++ /dev/null @@ -1,11 +0,0 @@ -# ServiceName - -Use service name - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `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 deleted file mode 100644 index c1dbb0c7..00000000 --- a/docs/models/shared/sftpsecurefiletransferprotocol.md +++ /dev/null @@ -1,12 +0,0 @@ -# SFTPSecureFileTransferProtocol - - -## Fields - -| 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 | \ No newline at end of file diff --git a/docs/models/shared/shopify.md b/docs/models/shared/shopify.md deleted file mode 100644 index 4370c872..00000000 --- a/docs/models/shared/shopify.md +++ /dev/null @@ -1,8 +0,0 @@ -# Shopify - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `credentials` | [Optional[shared.ShopifyCredentials]](../../models/shared/shopifycredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/shopifyauthorizationmethod.md b/docs/models/shared/shopifyauthorizationmethod.md deleted file mode 100644 index 81b46585..00000000 --- a/docs/models/shared/shopifyauthorizationmethod.md +++ /dev/null @@ -1,19 +0,0 @@ -# ShopifyAuthorizationMethod - -The authorization method to use to retrieve data from Shopify - - -## Supported Types - -### SourceShopifyOAuth20 - -```python -shopifyAuthorizationMethod: shared.SourceShopifyOAuth20 = /* values here */ -``` - -### APIPassword - -```python -shopifyAuthorizationMethod: shared.APIPassword = /* values here */ -``` - diff --git a/docs/models/shared/signinviagoogleoauth.md b/docs/models/shared/signinviagoogleoauth.md deleted file mode 100644 index c752c0f7..00000000 --- a/docs/models/shared/signinviagoogleoauth.md +++ /dev/null @@ -1,13 +0,0 @@ -# SignInViaGoogleOAuth - -For these scenario user only needs to give permission to read Google Directory data. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `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. | -| `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/silent.md b/docs/models/shared/silent.md deleted file mode 100644 index 8a61f34e..00000000 --- a/docs/models/shared/silent.md +++ /dev/null @@ -1,8 +0,0 @@ -# Silent - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `test_destination_type` | [Optional[shared.TestDestinationType]](../../models/shared/testdestinationtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/slack.md b/docs/models/shared/slack.md deleted file mode 100644 index 89783af6..00000000 --- a/docs/models/shared/slack.md +++ /dev/null @@ -1,8 +0,0 @@ -# Slack - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `credentials` | [Optional[shared.SlackCredentials]](../../models/shared/slackcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/smartsheets.md b/docs/models/shared/smartsheets.md deleted file mode 100644 index 0dbc2ccb..00000000 --- a/docs/models/shared/smartsheets.md +++ /dev/null @@ -1,8 +0,0 @@ -# Smartsheets - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `credentials` | [Optional[shared.SmartsheetsCredentials]](../../models/shared/smartsheetscredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/snappy.md b/docs/models/shared/snappy.md deleted file mode 100644 index 44c6631b..00000000 --- a/docs/models/shared/snappy.md +++ /dev/null @@ -1,8 +0,0 @@ -# Snappy - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `codec` | [Optional[shared.DestinationGcsSchemasFormatOutputFormat1Codec]](../../models/shared/destinationgcsschemasformatoutputformat1codec.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/snowflake.md b/docs/models/shared/snowflake.md deleted file mode 100644 index 56c92a6d..00000000 --- a/docs/models/shared/snowflake.md +++ /dev/null @@ -1,8 +0,0 @@ -# Snowflake - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `credentials` | [Optional[shared.SnowflakeCredentials]](../../models/shared/snowflakecredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceaha.md b/docs/models/shared/sourceaha.md deleted file mode 100644 index 04dfae38..00000000 --- a/docs/models/shared/sourceaha.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceAha - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | API Key | -| `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/sourceairtable.md b/docs/models/shared/sourceairtable.md deleted file mode 100644 index 1c065578..00000000 --- a/docs/models/shared/sourceairtable.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceAirtable - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `credentials` | [Optional[Union[shared.SourceAirtableOAuth20, shared.PersonalAccessToken]]](../../models/shared/sourceairtableauthentication.md) | :heavy_minus_sign: | N/A | -| `source_type` | [Optional[shared.SourceAirtableAirtable]](../../models/shared/sourceairtableairtable.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceairtableauthentication.md b/docs/models/shared/sourceairtableauthentication.md deleted file mode 100644 index 73fe1cd1..00000000 --- a/docs/models/shared/sourceairtableauthentication.md +++ /dev/null @@ -1,17 +0,0 @@ -# SourceAirtableAuthentication - - -## Supported Types - -### SourceAirtableOAuth20 - -```python -sourceAirtableAuthentication: shared.SourceAirtableOAuth20 = /* values here */ -``` - -### PersonalAccessToken - -```python -sourceAirtableAuthentication: shared.PersonalAccessToken = /* values here */ -``` - diff --git a/docs/models/shared/sourceairtableoauth20.md b/docs/models/shared/sourceairtableoauth20.md deleted file mode 100644 index d72b521d..00000000 --- a/docs/models/shared/sourceairtableoauth20.md +++ /dev/null @@ -1,13 +0,0 @@ -# SourceAirtableOAuth20 - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `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/sourceappfollow.md b/docs/models/shared/sourceappfollow.md deleted file mode 100644 index a6fff497..00000000 --- a/docs/models/shared/sourceappfollow.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceAppfollow - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `api_secret` | *Optional[str]* | :heavy_minus_sign: | API Key provided by Appfollow | -| `source_type` | [shared.Appfollow](../../models/shared/appfollow.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceasana.md b/docs/models/shared/sourceasana.md deleted file mode 100644 index 3fa7feba..00000000 --- a/docs/models/shared/sourceasana.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceAsana - - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -| `credentials` | [Optional[Union[shared.AuthenticateViaAsanaOauth, shared.AuthenticateWithPersonalAccessToken]]](../../models/shared/authenticationmechanism.md) | :heavy_minus_sign: | Choose how to authenticate to Github | -| `organization_export_ids` | List[*Any*] | :heavy_minus_sign: | Globally unique identifiers for the organization exports | -| `source_type` | [Optional[shared.SourceAsanaAsana]](../../models/shared/sourceasanaasana.md) | :heavy_minus_sign: | N/A | -| `test_mode` | *Optional[bool]* | :heavy_minus_sign: | This flag is used for testing purposes for certain streams that return a lot of data. This flag is not meant to be enabled for prod. | \ No newline at end of file diff --git a/docs/models/shared/sourceauth0authenticationmethod.md b/docs/models/shared/sourceauth0authenticationmethod.md deleted file mode 100644 index 85064382..00000000 --- a/docs/models/shared/sourceauth0authenticationmethod.md +++ /dev/null @@ -1,17 +0,0 @@ -# SourceAuth0AuthenticationMethod - - -## Supported Types - -### OAuth2ConfidentialApplication - -```python -sourceAuth0AuthenticationMethod: shared.OAuth2ConfidentialApplication = /* values here */ -``` - -### OAuth2AccessToken - -```python -sourceAuth0AuthenticationMethod: shared.OAuth2AccessToken = /* values here */ -``` - diff --git a/docs/models/shared/sourcecart.md b/docs/models/shared/sourcecart.md deleted file mode 100644 index b589c35f..00000000 --- a/docs/models/shared/sourcecart.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceCart - - -## Fields - -| 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 | | \ No newline at end of file diff --git a/docs/models/shared/sourcecartauthorizationmethod.md b/docs/models/shared/sourcecartauthorizationmethod.md deleted file mode 100644 index d4cc4e05..00000000 --- a/docs/models/shared/sourcecartauthorizationmethod.md +++ /dev/null @@ -1,17 +0,0 @@ -# SourceCartAuthorizationMethod - - -## Supported Types - -### CentralAPIRouter - -```python -sourceCartAuthorizationMethod: shared.CentralAPIRouter = /* values here */ -``` - -### SingleStoreAccessToken - -```python -sourceCartAuthorizationMethod: shared.SingleStoreAccessToken = /* values here */ -``` - diff --git a/docs/models/shared/sourceclickhousenotunnel.md b/docs/models/shared/sourceclickhousenotunnel.md deleted file mode 100644 index 1087c6d9..00000000 --- a/docs/models/shared/sourceclickhousenotunnel.md +++ /dev/null @@ -1,8 +0,0 @@ -# SourceClickhouseNoTunnel - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `tunnel_method` | [shared.SourceClickhouseTunnelMethod](../../models/shared/sourceclickhousetunnelmethod.md) | :heavy_check_mark: | No ssh tunnel needed to connect to database | \ No newline at end of file diff --git a/docs/models/shared/sourceclickhousepasswordauthentication.md b/docs/models/shared/sourceclickhousepasswordauthentication.md deleted file mode 100644 index 30db4460..00000000 --- a/docs/models/shared/sourceclickhousepasswordauthentication.md +++ /dev/null @@ -1,12 +0,0 @@ -# SourceClickhousePasswordAuthentication - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `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_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/sourceclickhousesshtunnelmethod.md b/docs/models/shared/sourceclickhousesshtunnelmethod.md deleted file mode 100644 index 7a3ced28..00000000 --- a/docs/models/shared/sourceclickhousesshtunnelmethod.md +++ /dev/null @@ -1,25 +0,0 @@ -# SourceClickhouseSSHTunnelMethod - -Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. - - -## Supported Types - -### SourceClickhouseNoTunnel - -```python -sourceClickhouseSSHTunnelMethod: shared.SourceClickhouseNoTunnel = /* values here */ -``` - -### SourceClickhouseSSHKeyAuthentication - -```python -sourceClickhouseSSHTunnelMethod: shared.SourceClickhouseSSHKeyAuthentication = /* values here */ -``` - -### SourceClickhousePasswordAuthentication - -```python -sourceClickhouseSSHTunnelMethod: shared.SourceClickhousePasswordAuthentication = /* values here */ -``` - diff --git a/docs/models/shared/sourcecoda.md b/docs/models/shared/sourcecoda.md deleted file mode 100644 index f94b4060..00000000 --- a/docs/models/shared/sourcecoda.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceCoda - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `auth_token` | *str* | :heavy_check_mark: | Bearer token | -| `source_type` | [shared.Coda](../../models/shared/coda.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceconfiguration.md b/docs/models/shared/sourceconfiguration.md deleted file mode 100644 index 8adbe75b..00000000 --- a/docs/models/shared/sourceconfiguration.md +++ /dev/null @@ -1,1165 +0,0 @@ -# SourceConfiguration - -The values required to configure the source. - - -## Supported Types - -### SourceAha - -```python -sourceConfiguration: shared.SourceAha = /* values here */ -``` - -### SourceAircall - -```python -sourceConfiguration: shared.SourceAircall = /* values here */ -``` - -### SourceAirtable - -```python -sourceConfiguration: shared.SourceAirtable = /* values here */ -``` - -### SourceAmazonAds - -```python -sourceConfiguration: shared.SourceAmazonAds = /* values here */ -``` - -### SourceAmazonSellerPartner - -```python -sourceConfiguration: shared.SourceAmazonSellerPartner = /* values here */ -``` - -### SourceAmazonSqs - -```python -sourceConfiguration: shared.SourceAmazonSqs = /* values here */ -``` - -### SourceAmplitude - -```python -sourceConfiguration: shared.SourceAmplitude = /* values here */ -``` - -### SourceApifyDataset - -```python -sourceConfiguration: shared.SourceApifyDataset = /* values here */ -``` - -### SourceAppfollow - -```python -sourceConfiguration: shared.SourceAppfollow = /* values here */ -``` - -### SourceAsana - -```python -sourceConfiguration: shared.SourceAsana = /* values here */ -``` - -### SourceAuth0 - -```python -sourceConfiguration: shared.SourceAuth0 = /* values here */ -``` - -### SourceAwsCloudtrail - -```python -sourceConfiguration: shared.SourceAwsCloudtrail = /* values here */ -``` - -### SourceAzureBlobStorage - -```python -sourceConfiguration: shared.SourceAzureBlobStorage = /* values here */ -``` - -### SourceAzureTable - -```python -sourceConfiguration: shared.SourceAzureTable = /* values here */ -``` - -### SourceBambooHr - -```python -sourceConfiguration: shared.SourceBambooHr = /* values here */ -``` - -### SourceBigquery - -```python -sourceConfiguration: shared.SourceBigquery = /* values here */ -``` - -### SourceBingAds - -```python -sourceConfiguration: shared.SourceBingAds = /* values here */ -``` - -### SourceBraintree - -```python -sourceConfiguration: shared.SourceBraintree = /* values here */ -``` - -### SourceBraze - -```python -sourceConfiguration: shared.SourceBraze = /* values here */ -``` - -### SourceCart - -```python -sourceConfiguration: shared.SourceCart = /* values here */ -``` - -### SourceChargebee - -```python -sourceConfiguration: shared.SourceChargebee = /* values here */ -``` - -### SourceChartmogul - -```python -sourceConfiguration: shared.SourceChartmogul = /* values here */ -``` - -### SourceClickhouse - -```python -sourceConfiguration: shared.SourceClickhouse = /* values here */ -``` - -### SourceClickupAPI - -```python -sourceConfiguration: shared.SourceClickupAPI = /* values here */ -``` - -### SourceClockify - -```python -sourceConfiguration: shared.SourceClockify = /* values here */ -``` - -### SourceCloseCom - -```python -sourceConfiguration: shared.SourceCloseCom = /* values here */ -``` - -### SourceCoda - -```python -sourceConfiguration: shared.SourceCoda = /* values here */ -``` - -### SourceCoinAPI - -```python -sourceConfiguration: shared.SourceCoinAPI = /* values here */ -``` - -### SourceCoinmarketcap - -```python -sourceConfiguration: shared.SourceCoinmarketcap = /* values here */ -``` - -### SourceConfigcat - -```python -sourceConfiguration: shared.SourceConfigcat = /* values here */ -``` - -### SourceConfluence - -```python -sourceConfiguration: shared.SourceConfluence = /* values here */ -``` - -### SourceConvex - -```python -sourceConfiguration: shared.SourceConvex = /* values here */ -``` - -### SourceDatascope - -```python -sourceConfiguration: shared.SourceDatascope = /* values here */ -``` - -### SourceDelighted - -```python -sourceConfiguration: shared.SourceDelighted = /* values here */ -``` - -### SourceDixa - -```python -sourceConfiguration: shared.SourceDixa = /* values here */ -``` - -### SourceDockerhub - -```python -sourceConfiguration: shared.SourceDockerhub = /* values here */ -``` - -### SourceDremio - -```python -sourceConfiguration: shared.SourceDremio = /* values here */ -``` - -### SourceDynamodb - -```python -sourceConfiguration: shared.SourceDynamodb = /* values here */ -``` - -### SourceE2eTestCloud - -```python -sourceConfiguration: Union[shared.ContinuousFeed] = /* values here */ -``` - -### SourceEmailoctopus - -```python -sourceConfiguration: shared.SourceEmailoctopus = /* values here */ -``` - -### SourceExchangeRates - -```python -sourceConfiguration: shared.SourceExchangeRates = /* values here */ -``` - -### SourceFacebookMarketing - -```python -sourceConfiguration: shared.SourceFacebookMarketing = /* values here */ -``` - -### SourceFaker - -```python -sourceConfiguration: shared.SourceFaker = /* values here */ -``` - -### SourceFauna - -```python -sourceConfiguration: shared.SourceFauna = /* values here */ -``` - -### SourceFile - -```python -sourceConfiguration: shared.SourceFile = /* values here */ -``` - -### SourceFirebolt - -```python -sourceConfiguration: shared.SourceFirebolt = /* values here */ -``` - -### SourceFreshcaller - -```python -sourceConfiguration: shared.SourceFreshcaller = /* values here */ -``` - -### SourceFreshdesk - -```python -sourceConfiguration: shared.SourceFreshdesk = /* values here */ -``` - -### SourceFreshsales - -```python -sourceConfiguration: shared.SourceFreshsales = /* values here */ -``` - -### SourceGainsightPx - -```python -sourceConfiguration: shared.SourceGainsightPx = /* values here */ -``` - -### SourceGcs - -```python -sourceConfiguration: shared.SourceGcs = /* values here */ -``` - -### SourceGetlago - -```python -sourceConfiguration: shared.SourceGetlago = /* values here */ -``` - -### SourceGithub - -```python -sourceConfiguration: shared.SourceGithub = /* values here */ -``` - -### SourceGitlab - -```python -sourceConfiguration: shared.SourceGitlab = /* values here */ -``` - -### SourceGlassfrog - -```python -sourceConfiguration: shared.SourceGlassfrog = /* values here */ -``` - -### SourceGnews - -```python -sourceConfiguration: shared.SourceGnews = /* values here */ -``` - -### SourceGoogleAds - -```python -sourceConfiguration: shared.SourceGoogleAds = /* values here */ -``` - -### SourceGoogleAnalyticsDataAPI - -```python -sourceConfiguration: shared.SourceGoogleAnalyticsDataAPI = /* values here */ -``` - -### SourceGoogleAnalyticsV4ServiceAccountOnly - -```python -sourceConfiguration: shared.SourceGoogleAnalyticsV4ServiceAccountOnly = /* values here */ -``` - -### SourceGoogleDirectory - -```python -sourceConfiguration: shared.SourceGoogleDirectory = /* values here */ -``` - -### SourceGoogleDrive - -```python -sourceConfiguration: shared.SourceGoogleDrive = /* values here */ -``` - -### SourceGooglePagespeedInsights - -```python -sourceConfiguration: shared.SourceGooglePagespeedInsights = /* values here */ -``` - -### SourceGoogleSearchConsole - -```python -sourceConfiguration: shared.SourceGoogleSearchConsole = /* values here */ -``` - -### SourceGoogleSheets - -```python -sourceConfiguration: shared.SourceGoogleSheets = /* values here */ -``` - -### SourceGoogleWebfonts - -```python -sourceConfiguration: shared.SourceGoogleWebfonts = /* values here */ -``` - -### SourceGoogleWorkspaceAdminReports - -```python -sourceConfiguration: shared.SourceGoogleWorkspaceAdminReports = /* values here */ -``` - -### SourceGreenhouse - -```python -sourceConfiguration: shared.SourceGreenhouse = /* values here */ -``` - -### SourceGridly - -```python -sourceConfiguration: shared.SourceGridly = /* values here */ -``` - -### SourceHarvest - -```python -sourceConfiguration: shared.SourceHarvest = /* values here */ -``` - -### SourceHubplanner - -```python -sourceConfiguration: shared.SourceHubplanner = /* values here */ -``` - -### SourceHubspot - -```python -sourceConfiguration: shared.SourceHubspot = /* values here */ -``` - -### SourceInsightly - -```python -sourceConfiguration: shared.SourceInsightly = /* values here */ -``` - -### SourceInstagram - -```python -sourceConfiguration: shared.SourceInstagram = /* values here */ -``` - -### SourceInstatus - -```python -sourceConfiguration: shared.SourceInstatus = /* values here */ -``` - -### SourceIntercom - -```python -sourceConfiguration: shared.SourceIntercom = /* values here */ -``` - -### SourceIp2whois - -```python -sourceConfiguration: shared.SourceIp2whois = /* values here */ -``` - -### SourceIterable - -```python -sourceConfiguration: shared.SourceIterable = /* values here */ -``` - -### SourceJira - -```python -sourceConfiguration: shared.SourceJira = /* values here */ -``` - -### SourceK6Cloud - -```python -sourceConfiguration: shared.SourceK6Cloud = /* values here */ -``` - -### SourceKlarna - -```python -sourceConfiguration: shared.SourceKlarna = /* values here */ -``` - -### SourceKlaviyo - -```python -sourceConfiguration: shared.SourceKlaviyo = /* values here */ -``` - -### SourceKyve - -```python -sourceConfiguration: shared.SourceKyve = /* values here */ -``` - -### SourceLaunchdarkly - -```python -sourceConfiguration: shared.SourceLaunchdarkly = /* values here */ -``` - -### SourceLemlist - -```python -sourceConfiguration: shared.SourceLemlist = /* values here */ -``` - -### SourceLeverHiring - -```python -sourceConfiguration: shared.SourceLeverHiring = /* values here */ -``` - -### SourceLinkedinAds - -```python -sourceConfiguration: shared.SourceLinkedinAds = /* values here */ -``` - -### SourceLinkedinPages - -```python -sourceConfiguration: shared.SourceLinkedinPages = /* values here */ -``` - -### SourceLokalise - -```python -sourceConfiguration: shared.SourceLokalise = /* values here */ -``` - -### SourceMailchimp - -```python -sourceConfiguration: shared.SourceMailchimp = /* values here */ -``` - -### SourceMailgun - -```python -sourceConfiguration: shared.SourceMailgun = /* values here */ -``` - -### SourceMailjetSms - -```python -sourceConfiguration: shared.SourceMailjetSms = /* values here */ -``` - -### SourceMarketo - -```python -sourceConfiguration: shared.SourceMarketo = /* values here */ -``` - -### SourceMetabase - -```python -sourceConfiguration: shared.SourceMetabase = /* values here */ -``` - -### SourceMicrosoftSharepoint - -```python -sourceConfiguration: shared.SourceMicrosoftSharepoint = /* values here */ -``` - -### SourceMicrosoftTeams - -```python -sourceConfiguration: shared.SourceMicrosoftTeams = /* values here */ -``` - -### SourceMixpanel - -```python -sourceConfiguration: shared.SourceMixpanel = /* values here */ -``` - -### SourceMonday - -```python -sourceConfiguration: shared.SourceMonday = /* values here */ -``` - -### SourceMongodbInternalPoc - -```python -sourceConfiguration: shared.SourceMongodbInternalPoc = /* values here */ -``` - -### SourceMongodbV2 - -```python -sourceConfiguration: shared.SourceMongodbV2 = /* values here */ -``` - -### SourceMssql - -```python -sourceConfiguration: shared.SourceMssql = /* values here */ -``` - -### SourceMyHours - -```python -sourceConfiguration: shared.SourceMyHours = /* values here */ -``` - -### SourceMysql - -```python -sourceConfiguration: shared.SourceMysql = /* values here */ -``` - -### SourceNetsuite - -```python -sourceConfiguration: shared.SourceNetsuite = /* values here */ -``` - -### SourceNotion - -```python -sourceConfiguration: shared.SourceNotion = /* values here */ -``` - -### SourceNytimes - -```python -sourceConfiguration: shared.SourceNytimes = /* values here */ -``` - -### SourceOkta - -```python -sourceConfiguration: shared.SourceOkta = /* values here */ -``` - -### SourceOmnisend - -```python -sourceConfiguration: shared.SourceOmnisend = /* values here */ -``` - -### SourceOnesignal - -```python -sourceConfiguration: shared.SourceOnesignal = /* values here */ -``` - -### SourceOracle - -```python -sourceConfiguration: shared.SourceOracle = /* values here */ -``` - -### SourceOrb - -```python -sourceConfiguration: shared.SourceOrb = /* values here */ -``` - -### SourceOrbit - -```python -sourceConfiguration: shared.SourceOrbit = /* values here */ -``` - -### SourceOutbrainAmplify - -```python -sourceConfiguration: shared.SourceOutbrainAmplify = /* values here */ -``` - -### SourceOutreach - -```python -sourceConfiguration: shared.SourceOutreach = /* values here */ -``` - -### SourcePaypalTransaction - -```python -sourceConfiguration: shared.SourcePaypalTransaction = /* values here */ -``` - -### SourcePaystack - -```python -sourceConfiguration: shared.SourcePaystack = /* values here */ -``` - -### SourcePendo - -```python -sourceConfiguration: shared.SourcePendo = /* values here */ -``` - -### SourcePersistiq - -```python -sourceConfiguration: shared.SourcePersistiq = /* values here */ -``` - -### SourcePexelsAPI - -```python -sourceConfiguration: shared.SourcePexelsAPI = /* values here */ -``` - -### SourcePinterest - -```python -sourceConfiguration: shared.SourcePinterest = /* values here */ -``` - -### SourcePipedrive - -```python -sourceConfiguration: shared.SourcePipedrive = /* values here */ -``` - -### SourcePocket - -```python -sourceConfiguration: shared.SourcePocket = /* values here */ -``` - -### SourcePokeapi - -```python -sourceConfiguration: shared.SourcePokeapi = /* values here */ -``` - -### SourcePolygonStockAPI - -```python -sourceConfiguration: shared.SourcePolygonStockAPI = /* values here */ -``` - -### SourcePostgres - -```python -sourceConfiguration: shared.SourcePostgres = /* values here */ -``` - -### SourcePosthog - -```python -sourceConfiguration: shared.SourcePosthog = /* values here */ -``` - -### SourcePostmarkapp - -```python -sourceConfiguration: shared.SourcePostmarkapp = /* values here */ -``` - -### SourcePrestashop - -```python -sourceConfiguration: shared.SourcePrestashop = /* values here */ -``` - -### SourcePunkAPI - -```python -sourceConfiguration: shared.SourcePunkAPI = /* values here */ -``` - -### SourcePypi - -```python -sourceConfiguration: shared.SourcePypi = /* values here */ -``` - -### SourceQualaroo - -```python -sourceConfiguration: shared.SourceQualaroo = /* values here */ -``` - -### SourceQuickbooks - -```python -sourceConfiguration: shared.SourceQuickbooks = /* values here */ -``` - -### SourceRailz - -```python -sourceConfiguration: shared.SourceRailz = /* values here */ -``` - -### SourceRecharge - -```python -sourceConfiguration: shared.SourceRecharge = /* values here */ -``` - -### SourceRecreation - -```python -sourceConfiguration: shared.SourceRecreation = /* values here */ -``` - -### SourceRecruitee - -```python -sourceConfiguration: shared.SourceRecruitee = /* values here */ -``` - -### SourceRedshift - -```python -sourceConfiguration: shared.SourceRedshift = /* values here */ -``` - -### SourceRetently - -```python -sourceConfiguration: shared.SourceRetently = /* values here */ -``` - -### SourceRkiCovid - -```python -sourceConfiguration: shared.SourceRkiCovid = /* values here */ -``` - -### SourceRss - -```python -sourceConfiguration: shared.SourceRss = /* values here */ -``` - -### SourceS3 - -```python -sourceConfiguration: shared.SourceS3 = /* values here */ -``` - -### SourceSalesforce - -```python -sourceConfiguration: shared.SourceSalesforce = /* values here */ -``` - -### SourceSalesloft - -```python -sourceConfiguration: shared.SourceSalesloft = /* values here */ -``` - -### SourceSapFieldglass - -```python -sourceConfiguration: shared.SourceSapFieldglass = /* values here */ -``` - -### SourceSecoda - -```python -sourceConfiguration: shared.SourceSecoda = /* values here */ -``` - -### SourceSendgrid - -```python -sourceConfiguration: shared.SourceSendgrid = /* values here */ -``` - -### SourceSendinblue - -```python -sourceConfiguration: shared.SourceSendinblue = /* values here */ -``` - -### SourceSenseforce - -```python -sourceConfiguration: shared.SourceSenseforce = /* values here */ -``` - -### SourceSentry - -```python -sourceConfiguration: shared.SourceSentry = /* values here */ -``` - -### SourceSftp - -```python -sourceConfiguration: shared.SourceSftp = /* values here */ -``` - -### SourceSftpBulk - -```python -sourceConfiguration: shared.SourceSftpBulk = /* values here */ -``` - -### SourceShopify - -```python -sourceConfiguration: shared.SourceShopify = /* values here */ -``` - -### SourceShortio - -```python -sourceConfiguration: shared.SourceShortio = /* values here */ -``` - -### SourceSlack - -```python -sourceConfiguration: shared.SourceSlack = /* values here */ -``` - -### SourceSmaily - -```python -sourceConfiguration: shared.SourceSmaily = /* values here */ -``` - -### SourceSmartengage - -```python -sourceConfiguration: shared.SourceSmartengage = /* values here */ -``` - -### SourceSmartsheets - -```python -sourceConfiguration: shared.SourceSmartsheets = /* values here */ -``` - -### SourceSnapchatMarketing - -```python -sourceConfiguration: shared.SourceSnapchatMarketing = /* values here */ -``` - -### SourceSnowflake - -```python -sourceConfiguration: shared.SourceSnowflake = /* values here */ -``` - -### SourceSonarCloud - -```python -sourceConfiguration: shared.SourceSonarCloud = /* values here */ -``` - -### SourceSpacexAPI - -```python -sourceConfiguration: shared.SourceSpacexAPI = /* values here */ -``` - -### SourceSquare - -```python -sourceConfiguration: shared.SourceSquare = /* values here */ -``` - -### SourceStrava - -```python -sourceConfiguration: shared.SourceStrava = /* values here */ -``` - -### SourceStripe - -```python -sourceConfiguration: shared.SourceStripe = /* values here */ -``` - -### SourceSurveySparrow - -```python -sourceConfiguration: shared.SourceSurveySparrow = /* values here */ -``` - -### SourceSurveymonkey - -```python -sourceConfiguration: shared.SourceSurveymonkey = /* values here */ -``` - -### SourceTempo - -```python -sourceConfiguration: shared.SourceTempo = /* values here */ -``` - -### SourceTheGuardianAPI - -```python -sourceConfiguration: shared.SourceTheGuardianAPI = /* values here */ -``` - -### SourceTiktokMarketing - -```python -sourceConfiguration: shared.SourceTiktokMarketing = /* values here */ -``` - -### SourceTrello - -```python -sourceConfiguration: shared.SourceTrello = /* values here */ -``` - -### SourceTrustpilot - -```python -sourceConfiguration: shared.SourceTrustpilot = /* values here */ -``` - -### SourceTvmazeSchedule - -```python -sourceConfiguration: shared.SourceTvmazeSchedule = /* values here */ -``` - -### SourceTwilio - -```python -sourceConfiguration: shared.SourceTwilio = /* values here */ -``` - -### SourceTwilioTaskrouter - -```python -sourceConfiguration: shared.SourceTwilioTaskrouter = /* values here */ -``` - -### SourceTwitter - -```python -sourceConfiguration: shared.SourceTwitter = /* values here */ -``` - -### SourceTypeform - -```python -sourceConfiguration: shared.SourceTypeform = /* values here */ -``` - -### SourceUsCensus - -```python -sourceConfiguration: shared.SourceUsCensus = /* values here */ -``` - -### SourceVantage - -```python -sourceConfiguration: shared.SourceVantage = /* values here */ -``` - -### SourceWebflow - -```python -sourceConfiguration: shared.SourceWebflow = /* values here */ -``` - -### SourceWhiskyHunter - -```python -sourceConfiguration: shared.SourceWhiskyHunter = /* values here */ -``` - -### SourceWikipediaPageviews - -```python -sourceConfiguration: shared.SourceWikipediaPageviews = /* values here */ -``` - -### SourceWoocommerce - -```python -sourceConfiguration: shared.SourceWoocommerce = /* values here */ -``` - -### SourceXkcd - -```python -sourceConfiguration: shared.SourceXkcd = /* values here */ -``` - -### SourceYandexMetrica - -```python -sourceConfiguration: shared.SourceYandexMetrica = /* values here */ -``` - -### SourceYotpo - -```python -sourceConfiguration: shared.SourceYotpo = /* values here */ -``` - -### SourceYoutubeAnalytics - -```python -sourceConfiguration: shared.SourceYoutubeAnalytics = /* values here */ -``` - -### SourceZendeskChat - -```python -sourceConfiguration: shared.SourceZendeskChat = /* values here */ -``` - -### SourceZendeskSell - -```python -sourceConfiguration: shared.SourceZendeskSell = /* values here */ -``` - -### SourceZendeskSunshine - -```python -sourceConfiguration: shared.SourceZendeskSunshine = /* values here */ -``` - -### SourceZendeskSupport - -```python -sourceConfiguration: shared.SourceZendeskSupport = /* values here */ -``` - -### SourceZendeskTalk - -```python -sourceConfiguration: shared.SourceZendeskTalk = /* values here */ -``` - -### SourceZenloop - -```python -sourceConfiguration: shared.SourceZenloop = /* values here */ -``` - -### SourceZohoCrm - -```python -sourceConfiguration: shared.SourceZohoCrm = /* values here */ -``` - -### SourceZoom - -```python -sourceConfiguration: shared.SourceZoom = /* values here */ -``` - diff --git a/docs/models/shared/sourceconvex.md b/docs/models/shared/sourceconvex.md deleted file mode 100644 index 177fb5cd..00000000 --- a/docs/models/shared/sourceconvex.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceConvex - - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `access_key` | *str* | :heavy_check_mark: | API access key used to retrieve data from Convex. | | -| `deployment_url` | *str* | :heavy_check_mark: | N/A | https://murky-swan-635.convex.cloud | -| `source_type` | [shared.SourceConvexConvex](../../models/shared/sourceconvexconvex.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcedatascope.md b/docs/models/shared/sourcedatascope.md deleted file mode 100644 index bb036bbd..00000000 --- a/docs/models/shared/sourcedatascope.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceDatascope - - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | API Key | | -| `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/sourcedynamodb.md b/docs/models/shared/sourcedynamodb.md deleted file mode 100644 index 8fa9aece..00000000 --- a/docs/models/shared/sourcedynamodb.md +++ /dev/null @@ -1,13 +0,0 @@ -# SourceDynamodb - - -## Fields - -| 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 | -| `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/sourcee2etestcloud.md b/docs/models/shared/sourcee2etestcloud.md deleted file mode 100644 index e3e21c32..00000000 --- a/docs/models/shared/sourcee2etestcloud.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceE2eTestCloud - - -## Supported Types - -### ContinuousFeed - -```python -sourceE2eTestCloud: shared.ContinuousFeed = /* values here */ -``` - diff --git a/docs/models/shared/sourcefaker.md b/docs/models/shared/sourcefaker.md deleted file mode 100644 index 9d67dbd8..00000000 --- a/docs/models/shared/sourcefaker.md +++ /dev/null @@ -1,13 +0,0 @@ -# SourceFaker - - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `always_updated` | *Optional[bool]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | How many users should be generated in total. This setting does not apply to the purchases or products stream. | -| `parallelism` | *Optional[int]* | :heavy_minus_sign: | How many parallel workers should we use to generate fake data? Choose a value equal to the number of CPUs you will allocate to this source. | -| `records_per_slice` | *Optional[int]* | :heavy_minus_sign: | How many fake records will be in each page (stream slice), before a state message is emitted? | -| `seed` | *Optional[int]* | :heavy_minus_sign: | Manually control the faker random seed to return the same values on subsequent runs (leave -1 for random) | -| `source_type` | [shared.Faker](../../models/shared/faker.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 deleted file mode 100644 index 08e4ca3a..00000000 --- a/docs/models/shared/sourcefile.md +++ /dev/null @@ -1,13 +0,0 @@ -# SourceFile - - -## Fields - -| 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). | | -| `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 | | \ No newline at end of file diff --git a/docs/models/shared/sourcefirebolt.md b/docs/models/shared/sourcefirebolt.md deleted file mode 100644 index cffa4c2f..00000000 --- a/docs/models/shared/sourcefirebolt.md +++ /dev/null @@ -1,14 +0,0 @@ -# SourceFirebolt - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `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 | -| `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/sourcefireboltfirebolt.md b/docs/models/shared/sourcefireboltfirebolt.md deleted file mode 100644 index 26214fad..00000000 --- a/docs/models/shared/sourcefireboltfirebolt.md +++ /dev/null @@ -1,8 +0,0 @@ -# SourceFireboltFirebolt - - -## Values - -| Name | Value | -| ---------- | ---------- | -| `FIREBOLT` | firebolt | \ No newline at end of file diff --git a/docs/models/shared/sourcegcsautogenerated.md b/docs/models/shared/sourcegcsautogenerated.md deleted file mode 100644 index a78dc2ec..00000000 --- a/docs/models/shared/sourcegcsautogenerated.md +++ /dev/null @@ -1,8 +0,0 @@ -# SourceGcsAutogenerated - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `header_definition_type` | [Optional[shared.SourceGcsSchemasHeaderDefinitionType]](../../models/shared/sourcegcsschemasheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegcsfromcsv.md b/docs/models/shared/sourcegcsfromcsv.md deleted file mode 100644 index 331f22b8..00000000 --- a/docs/models/shared/sourcegcsfromcsv.md +++ /dev/null @@ -1,8 +0,0 @@ -# SourceGcsFromCSV - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `header_definition_type` | [Optional[shared.SourceGcsHeaderDefinitionType]](../../models/shared/sourcegcsheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegcsuserprovided.md b/docs/models/shared/sourcegcsuserprovided.md deleted file mode 100644 index 1c18fa9b..00000000 --- a/docs/models/shared/sourcegcsuserprovided.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGcsUserProvided - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `column_names` | List[*str*] | :heavy_check_mark: | The column names that will be used while emitting the CSV records | -| `header_definition_type` | [Optional[shared.SourceGcsSchemasStreamsHeaderDefinitionType]](../../models/shared/sourcegcsschemasstreamsheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegithubauthentication.md b/docs/models/shared/sourcegithubauthentication.md deleted file mode 100644 index a16b5028..00000000 --- a/docs/models/shared/sourcegithubauthentication.md +++ /dev/null @@ -1,19 +0,0 @@ -# SourceGithubAuthentication - -Choose how to authenticate to GitHub - - -## Supported Types - -### OAuth - -```python -sourceGithubAuthentication: shared.OAuth = /* values here */ -``` - -### SourceGithubPersonalAccessToken - -```python -sourceGithubAuthentication: shared.SourceGithubPersonalAccessToken = /* values here */ -``` - diff --git a/docs/models/shared/sourcegitlabauthorizationmethod.md b/docs/models/shared/sourcegitlabauthorizationmethod.md deleted file mode 100644 index 34a3789b..00000000 --- a/docs/models/shared/sourcegitlabauthorizationmethod.md +++ /dev/null @@ -1,17 +0,0 @@ -# SourceGitlabAuthorizationMethod - - -## Supported Types - -### SourceGitlabOAuth20 - -```python -sourceGitlabAuthorizationMethod: shared.SourceGitlabOAuth20 = /* values here */ -``` - -### PrivateToken - -```python -sourceGitlabAuthorizationMethod: shared.PrivateToken = /* values here */ -``` - diff --git a/docs/models/shared/sourcegitlaboauth20.md b/docs/models/shared/sourcegitlaboauth20.md deleted file mode 100644 index 9db495d3..00000000 --- a/docs/models/shared/sourcegitlaboauth20.md +++ /dev/null @@ -1,13 +0,0 @@ -# SourceGitlabOAuth20 - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `access_token` | *str* | :heavy_check_mark: | Access Token for making authenticated requests. | -| `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. | -| `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/sourceglassfrog.md b/docs/models/shared/sourceglassfrog.md deleted file mode 100644 index eb3d1e20..00000000 --- a/docs/models/shared/sourceglassfrog.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGlassfrog - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | API key provided by Glassfrog | -| `source_type` | [shared.Glassfrog](../../models/shared/glassfrog.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapiandgroup.md b/docs/models/shared/sourcegoogleanalyticsdataapiandgroup.md deleted file mode 100644 index a8ebf7df..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapiandgroup.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceGoogleAnalyticsDataAPIAndGroup - -The FilterExpressions in andGroup have an AND relationship. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `expressions` | List[[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayExpression](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayexpression.md)] | :heavy_check_mark: | N/A | -| `filter_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterFilterType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfiltertype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapibetweenfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapibetweenfilter.md deleted file mode 100644 index 8d959fe1..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapibetweenfilter.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceGoogleAnalyticsDataAPIBetweenFilter - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `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/sourcegoogleanalyticsdataapicredentials.md b/docs/models/shared/sourcegoogleanalyticsdataapicredentials.md deleted file mode 100644 index d596562b..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapicredentials.md +++ /dev/null @@ -1,19 +0,0 @@ -# SourceGoogleAnalyticsDataAPICredentials - -Credentials for the service - - -## Supported Types - -### AuthenticateViaGoogleOauth - -```python -sourceGoogleAnalyticsDataAPICredentials: shared.AuthenticateViaGoogleOauth = /* values here */ -``` - -### ServiceAccountKeyAuthentication - -```python -sourceGoogleAnalyticsDataAPICredentials: shared.ServiceAccountKeyAuthentication = /* values here */ -``` - diff --git a/docs/models/shared/sourcegoogleanalyticsdataapicustomreportconfig.md b/docs/models/shared/sourcegoogleanalyticsdataapicustomreportconfig.md deleted file mode 100644 index 3da1cde4..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapicustomreportconfig.md +++ /dev/null @@ -1,13 +0,0 @@ -# SourceGoogleAnalyticsDataAPICustomReportConfig - - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dimensions` | List[*str*] | :heavy_check_mark: | A list of dimensions. | -| `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. | -| `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/sourcegoogleanalyticsdataapidisabled.md b/docs/models/shared/sourcegoogleanalyticsdataapidisabled.md deleted file mode 100644 index 1f93fe07..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapidisabled.md +++ /dev/null @@ -1,8 +0,0 @@ -# SourceGoogleAnalyticsDataAPIDisabled - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `enabled` | [Optional[shared.SourceGoogleAnalyticsDataAPIEnabled]](../../models/shared/sourcegoogleanalyticsdataapienabled.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapidoublevalue.md b/docs/models/shared/sourcegoogleanalyticsdataapidoublevalue.md deleted file mode 100644 index e06ddbb2..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapidoublevalue.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPIDoubleValue - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *float* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayvaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapifilter.md b/docs/models/shared/sourcegoogleanalyticsdataapifilter.md deleted file mode 100644 index efc4d8be..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapifilter.md +++ /dev/null @@ -1,12 +0,0 @@ -# SourceGoogleAnalyticsDataAPIFilter - -A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all metrics. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `field_name` | *str* | :heavy_check_mark: | N/A | -| `filter_` | [Union[shared.SourceGoogleAnalyticsDataAPIStringFilter, shared.SourceGoogleAnalyticsDataAPIInListFilter, shared.SourceGoogleAnalyticsDataAPINumericFilter, shared.SourceGoogleAnalyticsDataAPIBetweenFilter]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayfilter.md) | :heavy_check_mark: | N/A | -| `filter_type` | [Optional[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterType]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtertype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapiinlistfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapiinlistfilter.md deleted file mode 100644 index 51beb7aa..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapiinlistfilter.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceGoogleAnalyticsDataAPIInListFilter - - -## Fields - -| 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 | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapiint64value.md b/docs/models/shared/sourcegoogleanalyticsdataapiint64value.md deleted file mode 100644 index c19e0782..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapiint64value.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPIInt64Value - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `value` | *str* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasValueType](../../models/shared/sourcegoogleanalyticsdataapischemasvaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapinotexpression.md b/docs/models/shared/sourcegoogleanalyticsdataapinotexpression.md deleted file mode 100644 index 386342c4..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapinotexpression.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceGoogleAnalyticsDataAPINotExpression - -The FilterExpression is NOT of notExpression. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `expression` | [Optional[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterExpression]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterexpression.md) | :heavy_minus_sign: | N/A | -| `filter_type` | [Optional[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3FilterType]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filtertype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapinumericfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapinumericfilter.md deleted file mode 100644 index 8317f4fd..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapinumericfilter.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceGoogleAnalyticsDataAPINumericFilter - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `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/sourcegoogleanalyticsdataapiorgroup.md b/docs/models/shared/sourcegoogleanalyticsdataapiorgroup.md deleted file mode 100644 index 061a11bb..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapiorgroup.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceGoogleAnalyticsDataAPIOrGroup - -The FilterExpressions in orGroup have an OR relationship. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `expressions` | List[[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterExpression](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterexpression.md)] | :heavy_check_mark: | N/A | -| `filter_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFilterType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfiltertype.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 deleted file mode 100644 index 85d4a1f5..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemasbetweenfilter.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasBetweenFilter - - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `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 deleted file mode 100644 index 8fd027a6..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraybetweenfilter.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayBetweenFilter - - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `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 deleted file mode 100644 index c26df207..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterbetweenfilter.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterBetweenFilter - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `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/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1doublevalue.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1doublevalue.md deleted file mode 100644 index a32e4f38..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1doublevalue.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1DoubleValue - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *float* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsvaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsdoublevalue.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsdoublevalue.md deleted file mode 100644 index fde9a3e0..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsdoublevalue.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsDoubleValue - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *float* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterFilterValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterdoublevalue.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterdoublevalue.md deleted file mode 100644 index d1cecfca..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterdoublevalue.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterDoubleValue - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *float* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterFilter4ToValueValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilter4tovaluevaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterint64value.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterint64value.md deleted file mode 100644 index 99f8324d..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterint64value.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterInt64Value - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `value` | *str* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterFilter4ValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilter4valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsint64value.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsint64value.md deleted file mode 100644 index 289275f0..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsint64value.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsInt64Value - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *str* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1int64value.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1int64value.md deleted file mode 100644 index 3b59644d..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1int64value.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1Int64Value - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `value` | *str* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2doublevalue.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2doublevalue.md deleted file mode 100644 index 056cbeb1..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2doublevalue.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2DoubleValue - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *float* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsvaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2int64value.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2int64value.md deleted file mode 100644 index ecff1712..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2int64value.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2Int64Value - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `value` | *str* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3doublevalue.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3doublevalue.md deleted file mode 100644 index 67cae199..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3doublevalue.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3DoubleValue - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *float* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionvaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressiondoublevalue.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressiondoublevalue.md deleted file mode 100644 index 231f5c21..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressiondoublevalue.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionDoubleValue - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *float* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterFilterValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterdoublevalue.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterdoublevalue.md deleted file mode 100644 index c5fcfe32..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterdoublevalue.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterDoubleValue - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `value` | *float* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterFilter4ToValueValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilter4tovaluevaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterint64value.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterint64value.md deleted file mode 100644 index d7a4efb3..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterint64value.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterInt64Value - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *str* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterFilter4ValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilter4valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionint64value.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionint64value.md deleted file mode 100644 index cd96b7b9..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionint64value.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionInt64Value - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *str* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3int64value.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3int64value.md deleted file mode 100644 index 39efed74..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3int64value.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3Int64Value - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `value` | *str* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterdoublevalue.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterdoublevalue.md deleted file mode 100644 index b73c0285..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterdoublevalue.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterDoubleValue - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *float* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsFilterFilter4ToValueValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfilterfilter4tovaluevaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterint64value.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterint64value.md deleted file mode 100644 index 05195330..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterint64value.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterInt64Value - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `value` | *str* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsFilterFilter4ValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfilterfilter4valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdoublevalue.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdoublevalue.md deleted file mode 100644 index 9502b536..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdoublevalue.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDoubleValue - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *float* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsFilterFilterValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfilterfiltervaluetype.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 deleted file mode 100644 index e338d373..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterinlistfilter.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterInListFilter - - -## Fields - -| 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 | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterint64value.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterint64value.md deleted file mode 100644 index 7f86ba24..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterint64value.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterInt64Value - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *str* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsFilterValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfiltervaluetype.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 deleted file mode 100644 index 38a10acc..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilternumericfilter.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterNumericFilter - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `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 deleted file mode 100644 index dfa91657..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterstringfilter.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterStringFilter - - -## Fields - -| 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 | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydoublevalue.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydoublevalue.md deleted file mode 100644 index 4c70dc38..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydoublevalue.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDoubleValue - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *float* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayfilter.md deleted file mode 100644 index c240324e..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayfilter.md +++ /dev/null @@ -1,29 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayFilter - - -## Supported Types - -### SourceGoogleAnalyticsDataAPIStringFilter - -```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayFilter: shared.SourceGoogleAnalyticsDataAPIStringFilter = /* values here */ -``` - -### SourceGoogleAnalyticsDataAPIInListFilter - -```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayFilter: shared.SourceGoogleAnalyticsDataAPIInListFilter = /* values here */ -``` - -### SourceGoogleAnalyticsDataAPINumericFilter - -```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayFilter: shared.SourceGoogleAnalyticsDataAPINumericFilter = /* values here */ -``` - -### SourceGoogleAnalyticsDataAPIBetweenFilter - -```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayFilter: shared.SourceGoogleAnalyticsDataAPIBetweenFilter = /* values here */ -``` - diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayinlistfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayinlistfilter.md deleted file mode 100644 index 9cb6652d..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayinlistfilter.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayInListFilter - - -## Fields - -| 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 | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayint64value.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayint64value.md deleted file mode 100644 index d26971d2..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayint64value.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayInt64Value - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *str* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervaluetype.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 deleted file mode 100644 index aed7f559..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterbetweenfilter.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterBetweenFilter - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `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/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterdoublevalue.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterdoublevalue.md deleted file mode 100644 index 4682b46b..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterdoublevalue.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterDoubleValue - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `value` | *float* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtervaluetype.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 deleted file mode 100644 index fc3f47e2..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterinlistfilter.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterInListFilter - - -## Fields - -| 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 | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterint64value.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterint64value.md deleted file mode 100644 index ce936c5c..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterint64value.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterInt64Value - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `value` | *str* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4ValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1doublevalue.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1doublevalue.md deleted file mode 100644 index 39d41f06..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1doublevalue.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1DoubleValue - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *float* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilterValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsdoublevalue.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsdoublevalue.md deleted file mode 100644 index 73813165..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsdoublevalue.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsDoubleValue - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *float* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilter3ValueValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilter3valuevaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterdoublevalue.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterdoublevalue.md deleted file mode 100644 index a06e66ca..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterdoublevalue.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterDoubleValue - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *float* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsvaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterint64value.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterint64value.md deleted file mode 100644 index b1de37f6..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterint64value.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterInt64Value - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `value` | *str* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsint64value.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsint64value.md deleted file mode 100644 index 9ff3414d..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsint64value.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsInt64Value - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `value` | *str* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilter3ValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilter3valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1int64value.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1int64value.md deleted file mode 100644 index 28930f2b..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1int64value.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1Int64Value - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *str* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2doublevalue.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2doublevalue.md deleted file mode 100644 index 8969da86..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2doublevalue.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2DoubleValue - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *float* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsvaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsdoublevalue.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsdoublevalue.md deleted file mode 100644 index e4a4bf66..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsdoublevalue.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsDoubleValue - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *float* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterFilterValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterdoublevalue.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterdoublevalue.md deleted file mode 100644 index de77063d..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterdoublevalue.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterDoubleValue - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *float* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterFilter4ToValueValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilter4tovaluevaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterint64value.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterint64value.md deleted file mode 100644 index c5764c42..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterint64value.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterInt64Value - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `value` | *str* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterFilter4ValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilter4valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsint64value.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsint64value.md deleted file mode 100644 index 7bdad075..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsint64value.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsInt64Value - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *str* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2int64value.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2int64value.md deleted file mode 100644 index fc797152..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2int64value.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2Int64Value - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `value` | *str* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2valuetype.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 deleted file mode 100644 index e5bdba57..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3betweenfilter.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3BetweenFilter - - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `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/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3doublevalue.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3doublevalue.md deleted file mode 100644 index 70d1b2d2..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3doublevalue.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3DoubleValue - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *float* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionvaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressiondoublevalue.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressiondoublevalue.md deleted file mode 100644 index e01dee51..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressiondoublevalue.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionDoubleValue - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *float* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterFilterValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterdoublevalue.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterdoublevalue.md deleted file mode 100644 index cd06a584..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterdoublevalue.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterDoubleValue - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `value` | *float* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterFilter4ToValueValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilter4tovaluevaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterint64value.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterint64value.md deleted file mode 100644 index fdab0311..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterint64value.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterInt64Value - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *str* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterFilter4ValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilter4valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionint64value.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionint64value.md deleted file mode 100644 index 877dbf6f..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionint64value.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionInt64Value - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *str* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfiltervaluetype.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 deleted file mode 100644 index 5d2b55b9..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3inlistfilter.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3InListFilter - - -## Fields - -| 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 | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3int64value.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3int64value.md deleted file mode 100644 index 5f9bf8f1..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3int64value.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3Int64Value - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `value` | *str* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3valuetype.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 deleted file mode 100644 index 01dca394..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3numericfilter.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3NumericFilter - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `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 deleted file mode 100644 index 72fa6018..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3stringfilter.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3StringFilter - - -## Fields - -| 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 | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterbetweenfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterbetweenfilter.md deleted file mode 100644 index 88377e96..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterbetweenfilter.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterBetweenFilter - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `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 | -| `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/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterdoublevalue.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterdoublevalue.md deleted file mode 100644 index f44b6735..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterdoublevalue.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterDoubleValue - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *float* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterFilter4ValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfilter4valuetype.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 deleted file mode 100644 index dca63eb3..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterinlistfilter.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterInListFilter - - -## Fields - -| 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 | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterint64value.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterint64value.md deleted file mode 100644 index ff7f950c..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterint64value.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterInt64Value - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `value` | *str* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterFilterValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfiltervaluetype.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 deleted file mode 100644 index 06bf6cb1..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilternumericfilter.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterNumericFilter - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `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 | -| `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 deleted file mode 100644 index 42c81164..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterstringfilter.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterStringFilter - - -## Fields - -| 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 | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilternumericfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilternumericfilter.md deleted file mode 100644 index 4cb5a664..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilternumericfilter.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterNumericFilter - - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `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 deleted file mode 100644 index 8e2ee3f3..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterstringfilter.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterStringFilter - - -## Fields - -| 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 | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraynumericfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraynumericfilter.md deleted file mode 100644 index 7edfe2e1..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraynumericfilter.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayNumericFilter - - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `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 deleted file mode 100644 index a4373d9f..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraystringfilter.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayStringFilter - - -## Fields - -| 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 | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraytovalue.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraytovalue.md deleted file mode 100644 index ccf2e34d..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraytovalue.md +++ /dev/null @@ -1,17 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayToValue - - -## Supported Types - -### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterInt64Value - -```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayToValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterInt64Value = /* values here */ -``` - -### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterDoubleValue - -```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayToValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterDoubleValue = /* values here */ -``` - diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayvalue.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayvalue.md deleted file mode 100644 index 61cddc2d..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayvalue.md +++ /dev/null @@ -1,17 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayValue - - -## Supported Types - -### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1Int64Value - -```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1Int64Value = /* values here */ -``` - -### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1DoubleValue - -```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1DoubleValue = /* values here */ -``` - diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemasdoublevalue.md b/docs/models/shared/sourcegoogleanalyticsdataapischemasdoublevalue.md deleted file mode 100644 index 04305105..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemasdoublevalue.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasDoubleValue - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *float* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemasenabled.md b/docs/models/shared/sourcegoogleanalyticsdataapischemasenabled.md deleted file mode 100644 index 8cacfd14..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemasenabled.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasEnabled - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cohort_report_settings` | [Optional[shared.CohortReportSettings]](../../models/shared/cohortreportsettings.md) | :heavy_minus_sign: | Optional settings for a cohort report. | -| `cohorts` | List[[shared.Cohorts](../../models/shared/cohorts.md)] | :heavy_minus_sign: | N/A | -| `cohorts_range` | [Optional[shared.CohortsRange]](../../models/shared/cohortsrange.md) | :heavy_minus_sign: | N/A | -| `enabled` | [Optional[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayEnabled]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayenabled.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemasexpression.md b/docs/models/shared/sourcegoogleanalyticsdataapischemasexpression.md deleted file mode 100644 index 9af3d2c6..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemasexpression.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasExpression - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `field_name` | *str* | :heavy_check_mark: | N/A | -| `filter_` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasStringFilter, shared.SourceGoogleAnalyticsDataAPISchemasInListFilter, shared.SourceGoogleAnalyticsDataAPISchemasNumericFilter, shared.SourceGoogleAnalyticsDataAPISchemasBetweenFilter]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterfilter.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemasfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemasfilter.md deleted file mode 100644 index d1edb9fe..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemasfilter.md +++ /dev/null @@ -1,29 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasFilter - - -## Supported Types - -### StringFilter - -```python -sourceGoogleAnalyticsDataAPISchemasFilter: shared.StringFilter = /* values here */ -``` - -### InListFilter - -```python -sourceGoogleAnalyticsDataAPISchemasFilter: shared.InListFilter = /* values here */ -``` - -### NumericFilter - -```python -sourceGoogleAnalyticsDataAPISchemasFilter: shared.NumericFilter = /* values here */ -``` - -### BetweenFilter - -```python -sourceGoogleAnalyticsDataAPISchemasFilter: shared.BetweenFilter = /* values here */ -``` - diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemasinlistfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemasinlistfilter.md deleted file mode 100644 index 99a30c7d..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemasinlistfilter.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasInListFilter - - -## Fields - -| 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 | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemasint64value.md b/docs/models/shared/sourcegoogleanalyticsdataapischemasint64value.md deleted file mode 100644 index 2ed49eef..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemasint64value.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasInt64Value - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `value` | *str* | :heavy_check_mark: | N/A | -| `value_type` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterValueType](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervaluetype.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 deleted file mode 100644 index 7d80a74a..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemasnumericfilter.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasNumericFilter - - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `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 deleted file mode 100644 index bbbb0ef4..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemasstringfilter.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceGoogleAnalyticsDataAPISchemasStringFilter - - -## Fields - -| 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 | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapistringfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapistringfilter.md deleted file mode 100644 index fe335564..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapistringfilter.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceGoogleAnalyticsDataAPIStringFilter - - -## Fields - -| 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 | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapivalue.md b/docs/models/shared/sourcegoogleanalyticsdataapivalue.md deleted file mode 100644 index 17088114..00000000 --- a/docs/models/shared/sourcegoogleanalyticsdataapivalue.md +++ /dev/null @@ -1,17 +0,0 @@ -# SourceGoogleAnalyticsDataAPIValue - - -## Supported Types - -### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayInt64Value - -```python -sourceGoogleAnalyticsDataAPIValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayInt64Value = /* values here */ -``` - -### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDoubleValue - -```python -sourceGoogleAnalyticsDataAPIValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDoubleValue = /* values here */ -``` - diff --git a/docs/models/shared/sourcegoogleanalyticsv4serviceaccountonlyserviceaccountkeyauthentication.md b/docs/models/shared/sourcegoogleanalyticsv4serviceaccountonlyserviceaccountkeyauthentication.md deleted file mode 100644 index 3d8914b1..00000000 --- a/docs/models/shared/sourcegoogleanalyticsv4serviceaccountonlyserviceaccountkeyauthentication.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleAnalyticsV4ServiceAccountOnlyServiceAccountKeyAuthentication - - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `credentials_json` | *str* | :heavy_check_mark: | The JSON key of the service account to use for authorization | { "type": "service_account", "project_id": YOUR_PROJECT_ID, "private_key_id": YOUR_PRIVATE_KEY, ... } | -| `auth_type` | [Optional[shared.SourceGoogleAnalyticsV4ServiceAccountOnlyAuthType]](../../models/shared/sourcegoogleanalyticsv4serviceaccountonlyauthtype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogledriveauthenticateviagoogleoauth.md b/docs/models/shared/sourcegoogledriveauthenticateviagoogleoauth.md deleted file mode 100644 index 5b5047bf..00000000 --- a/docs/models/shared/sourcegoogledriveauthenticateviagoogleoauth.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceGoogleDriveAuthenticateViaGoogleOAuth - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `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 | -| `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/sourcegoogledriveauthentication.md b/docs/models/shared/sourcegoogledriveauthentication.md deleted file mode 100644 index ae8fb0ec..00000000 --- a/docs/models/shared/sourcegoogledriveauthentication.md +++ /dev/null @@ -1,19 +0,0 @@ -# SourceGoogleDriveAuthentication - -Credentials for connecting to the Google Drive API - - -## Supported Types - -### SourceGoogleDriveAuthenticateViaGoogleOAuth - -```python -sourceGoogleDriveAuthentication: shared.SourceGoogleDriveAuthenticateViaGoogleOAuth = /* values here */ -``` - -### SourceGoogleDriveServiceAccountKeyAuthentication - -```python -sourceGoogleDriveAuthentication: shared.SourceGoogleDriveServiceAccountKeyAuthentication = /* values here */ -``` - diff --git a/docs/models/shared/sourcegoogledriveautogenerated.md b/docs/models/shared/sourcegoogledriveautogenerated.md deleted file mode 100644 index c795d804..00000000 --- a/docs/models/shared/sourcegoogledriveautogenerated.md +++ /dev/null @@ -1,8 +0,0 @@ -# SourceGoogleDriveAutogenerated - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `header_definition_type` | [Optional[shared.SourceGoogleDriveSchemasHeaderDefinitionType]](../../models/shared/sourcegoogledriveschemasheaderdefinitiontype.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 deleted file mode 100644 index f865dd4e..00000000 --- a/docs/models/shared/sourcegoogledrivefilebasedstreamconfig.md +++ /dev/null @@ -1,15 +0,0 @@ -# SourceGoogleDriveFileBasedStreamConfig - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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. | -| `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/sourcegoogledriveformat.md b/docs/models/shared/sourcegoogledriveformat.md deleted file mode 100644 index 88fbcf22..00000000 --- a/docs/models/shared/sourcegoogledriveformat.md +++ /dev/null @@ -1,37 +0,0 @@ -# SourceGoogleDriveFormat - -The configuration options that are used to alter how to read incoming files that deviate from the standard formatting. - - -## Supported Types - -### SourceGoogleDriveAvroFormat - -```python -sourceGoogleDriveFormat: shared.SourceGoogleDriveAvroFormat = /* values here */ -``` - -### SourceGoogleDriveCSVFormat - -```python -sourceGoogleDriveFormat: shared.SourceGoogleDriveCSVFormat = /* values here */ -``` - -### SourceGoogleDriveJsonlFormat - -```python -sourceGoogleDriveFormat: shared.SourceGoogleDriveJsonlFormat = /* values here */ -``` - -### SourceGoogleDriveParquetFormat - -```python -sourceGoogleDriveFormat: shared.SourceGoogleDriveParquetFormat = /* values here */ -``` - -### SourceGoogleDriveDocumentFileTypeFormatExperimental - -```python -sourceGoogleDriveFormat: shared.SourceGoogleDriveDocumentFileTypeFormatExperimental = /* values here */ -``` - diff --git a/docs/models/shared/sourcegoogledrivefromcsv.md b/docs/models/shared/sourcegoogledrivefromcsv.md deleted file mode 100644 index 7d386601..00000000 --- a/docs/models/shared/sourcegoogledrivefromcsv.md +++ /dev/null @@ -1,8 +0,0 @@ -# SourceGoogleDriveFromCSV - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `header_definition_type` | [Optional[shared.SourceGoogleDriveHeaderDefinitionType]](../../models/shared/sourcegoogledriveheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogledrivejsonlformat.md b/docs/models/shared/sourcegoogledrivejsonlformat.md deleted file mode 100644 index fc7e57cc..00000000 --- a/docs/models/shared/sourcegoogledrivejsonlformat.md +++ /dev/null @@ -1,8 +0,0 @@ -# SourceGoogleDriveJsonlFormat - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `filetype` | [Optional[shared.SourceGoogleDriveSchemasStreamsFiletype]](../../models/shared/sourcegoogledriveschemasstreamsfiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogledrivelocal.md b/docs/models/shared/sourcegoogledrivelocal.md deleted file mode 100644 index 81e33710..00000000 --- a/docs/models/shared/sourcegoogledrivelocal.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceGoogleDriveLocal - -Process files locally, supporting `fast` and `ocr` modes. This is the default option. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `mode` | [Optional[shared.SourceGoogleDriveMode]](../../models/shared/sourcegoogledrivemode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogledriveprocessing.md b/docs/models/shared/sourcegoogledriveprocessing.md deleted file mode 100644 index 3ea9abfe..00000000 --- a/docs/models/shared/sourcegoogledriveprocessing.md +++ /dev/null @@ -1,13 +0,0 @@ -# SourceGoogleDriveProcessing - -Processing configuration - - -## Supported Types - -### SourceGoogleDriveLocal - -```python -sourceGoogleDriveProcessing: shared.SourceGoogleDriveLocal = /* values here */ -``` - diff --git a/docs/models/shared/sourcegoogledriveuserprovided.md b/docs/models/shared/sourcegoogledriveuserprovided.md deleted file mode 100644 index 9a30ecc1..00000000 --- a/docs/models/shared/sourcegoogledriveuserprovided.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceGoogleDriveUserProvided - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `column_names` | List[*str*] | :heavy_check_mark: | The column names that will be used while emitting the CSV records | -| `header_definition_type` | [Optional[shared.SourceGoogleDriveSchemasStreamsHeaderDefinitionType]](../../models/shared/sourcegoogledriveschemasstreamsheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegooglesheets.md b/docs/models/shared/sourcegooglesheets.md deleted file mode 100644 index 38a19671..00000000 --- a/docs/models/shared/sourcegooglesheets.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceGoogleSheets - - -## Fields - -| 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 | | \ No newline at end of file diff --git a/docs/models/shared/sourcegooglesheetsauthentication.md b/docs/models/shared/sourcegooglesheetsauthentication.md deleted file mode 100644 index b0e4aef7..00000000 --- a/docs/models/shared/sourcegooglesheetsauthentication.md +++ /dev/null @@ -1,19 +0,0 @@ -# SourceGoogleSheetsAuthentication - -Credentials for connecting to the Google Sheets API - - -## Supported Types - -### SourceGoogleSheetsAuthenticateViaGoogleOAuth - -```python -sourceGoogleSheetsAuthentication: shared.SourceGoogleSheetsAuthenticateViaGoogleOAuth = /* values here */ -``` - -### SourceGoogleSheetsServiceAccountKeyAuthentication - -```python -sourceGoogleSheetsAuthentication: shared.SourceGoogleSheetsServiceAccountKeyAuthentication = /* values here */ -``` - diff --git a/docs/models/shared/sourcegoogleworkspaceadminreports.md b/docs/models/shared/sourcegoogleworkspaceadminreports.md deleted file mode 100644 index 7af79b07..00000000 --- a/docs/models/shared/sourcegoogleworkspaceadminreports.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceGoogleWorkspaceAdminReports - - -## Fields - -| 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. | -| `email` | *str* | :heavy_check_mark: | The email of the user, which has permissions to access the Google Workspace Admin APIs. | -| `lookback` | *Optional[int]* | :heavy_minus_sign: | Sets the range of time shown in the report. Reports API allows from up to 180 days ago. | -| `source_type` | [shared.GoogleWorkspaceAdminReports](../../models/shared/googleworkspaceadminreports.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegridly.md b/docs/models/shared/sourcegridly.md deleted file mode 100644 index b4b1d335..00000000 --- a/docs/models/shared/sourcegridly.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceGridly - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | N/A | -| `grid_id` | *str* | :heavy_check_mark: | ID of a grid, or can be ID of a branch | -| `source_type` | [shared.Gridly](../../models/shared/gridly.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 deleted file mode 100644 index e9a6b891..00000000 --- a/docs/models/shared/sourceharvest.md +++ /dev/null @@ -1,12 +0,0 @@ -# SourceHarvest - - -## Fields - -| 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 | -| `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/sourceharvestauthenticationmechanism.md b/docs/models/shared/sourceharvestauthenticationmechanism.md deleted file mode 100644 index 6526f3fd..00000000 --- a/docs/models/shared/sourceharvestauthenticationmechanism.md +++ /dev/null @@ -1,19 +0,0 @@ -# SourceHarvestAuthenticationMechanism - -Choose how to authenticate to Harvest. - - -## Supported Types - -### AuthenticateViaHarvestOAuth - -```python -sourceHarvestAuthenticationMechanism: shared.AuthenticateViaHarvestOAuth = /* values here */ -``` - -### SourceHarvestAuthenticateWithPersonalAccessToken - -```python -sourceHarvestAuthenticationMechanism: shared.SourceHarvestAuthenticateWithPersonalAccessToken = /* values here */ -``` - diff --git a/docs/models/shared/sourcehubspot.md b/docs/models/shared/sourcehubspot.md deleted file mode 100644 index 79b82eff..00000000 --- a/docs/models/shared/sourcehubspot.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceHubspot - - -## Fields - -| 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 | | \ No newline at end of file diff --git a/docs/models/shared/sourcehubspotauthentication.md b/docs/models/shared/sourcehubspotauthentication.md deleted file mode 100644 index 0c891491..00000000 --- a/docs/models/shared/sourcehubspotauthentication.md +++ /dev/null @@ -1,19 +0,0 @@ -# SourceHubspotAuthentication - -Choose how to authenticate to HubSpot. - - -## Supported Types - -### SourceHubspotOAuth - -```python -sourceHubspotAuthentication: shared.SourceHubspotOAuth = /* values here */ -``` - -### PrivateApp - -```python -sourceHubspotAuthentication: shared.PrivateApp = /* values here */ -``` - diff --git a/docs/models/shared/sourceinstatus.md b/docs/models/shared/sourceinstatus.md deleted file mode 100644 index 2d3689f4..00000000 --- a/docs/models/shared/sourceinstatus.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceInstatus - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | Instatus REST API key | -| `source_type` | [shared.Instatus](../../models/shared/instatus.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcelemlist.md b/docs/models/shared/sourcelemlist.md deleted file mode 100644 index 0b6f2dbb..00000000 --- a/docs/models/shared/sourcelemlist.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceLemlist - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `api_key` | *str* | :heavy_check_mark: | Lemlist API key, | -| `source_type` | [shared.Lemlist](../../models/shared/lemlist.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceleverhiringauthenticationmechanism.md b/docs/models/shared/sourceleverhiringauthenticationmechanism.md deleted file mode 100644 index 478ff9ba..00000000 --- a/docs/models/shared/sourceleverhiringauthenticationmechanism.md +++ /dev/null @@ -1,19 +0,0 @@ -# SourceLeverHiringAuthenticationMechanism - -Choose how to authenticate to Lever Hiring. - - -## Supported Types - -### AuthenticateViaLeverOAuth - -```python -sourceLeverHiringAuthenticationMechanism: shared.AuthenticateViaLeverOAuth = /* values here */ -``` - -### AuthenticateViaLeverAPIKey - -```python -sourceLeverHiringAuthenticationMechanism: shared.AuthenticateViaLeverAPIKey = /* values here */ -``` - diff --git a/docs/models/shared/sourcelinkedinadsauthentication.md b/docs/models/shared/sourcelinkedinadsauthentication.md deleted file mode 100644 index 15a0d518..00000000 --- a/docs/models/shared/sourcelinkedinadsauthentication.md +++ /dev/null @@ -1,17 +0,0 @@ -# SourceLinkedinAdsAuthentication - - -## Supported Types - -### SourceLinkedinAdsOAuth20 - -```python -sourceLinkedinAdsAuthentication: shared.SourceLinkedinAdsOAuth20 = /* values here */ -``` - -### AccessToken - -```python -sourceLinkedinAdsAuthentication: shared.AccessToken = /* values here */ -``` - diff --git a/docs/models/shared/sourcelinkedinpages.md b/docs/models/shared/sourcelinkedinpages.md deleted file mode 100644 index 348f3c45..00000000 --- a/docs/models/shared/sourcelinkedinpages.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceLinkedinPages - - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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/sourcelinkedinpagesauthentication.md b/docs/models/shared/sourcelinkedinpagesauthentication.md deleted file mode 100644 index 47f871f5..00000000 --- a/docs/models/shared/sourcelinkedinpagesauthentication.md +++ /dev/null @@ -1,17 +0,0 @@ -# SourceLinkedinPagesAuthentication - - -## Supported Types - -### SourceLinkedinPagesOAuth20 - -```python -sourceLinkedinPagesAuthentication: shared.SourceLinkedinPagesOAuth20 = /* values here */ -``` - -### SourceLinkedinPagesAccessToken - -```python -sourceLinkedinPagesAuthentication: shared.SourceLinkedinPagesAccessToken = /* values here */ -``` - diff --git a/docs/models/shared/sourcemailchimpauthentication.md b/docs/models/shared/sourcemailchimpauthentication.md deleted file mode 100644 index 4353dde1..00000000 --- a/docs/models/shared/sourcemailchimpauthentication.md +++ /dev/null @@ -1,17 +0,0 @@ -# SourceMailchimpAuthentication - - -## Supported Types - -### SourceMailchimpOAuth20 - -```python -sourceMailchimpAuthentication: shared.SourceMailchimpOAuth20 = /* values here */ -``` - -### APIKey - -```python -sourceMailchimpAuthentication: shared.APIKey = /* values here */ -``` - diff --git a/docs/models/shared/sourcemailchimpoauth20.md b/docs/models/shared/sourcemailchimpoauth20.md deleted file mode 100644 index 32eb9102..00000000 --- a/docs/models/shared/sourcemailchimpoauth20.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceMailchimpOAuth20 - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `access_token` | *str* | :heavy_check_mark: | An access token generated using the above client ID and secret. | -| `auth_type` | [shared.SourceMailchimpAuthType](../../models/shared/sourcemailchimpauthtype.md) | :heavy_check_mark: | N/A | -| `client_id` | *Optional[str]* | :heavy_minus_sign: | The Client ID of your OAuth application. | -| `client_secret` | *Optional[str]* | :heavy_minus_sign: | The Client Secret of your OAuth application. | \ No newline at end of file diff --git a/docs/models/shared/sourcemicrosoftsharepointauthentication.md b/docs/models/shared/sourcemicrosoftsharepointauthentication.md deleted file mode 100644 index 901a94d7..00000000 --- a/docs/models/shared/sourcemicrosoftsharepointauthentication.md +++ /dev/null @@ -1,19 +0,0 @@ -# SourceMicrosoftSharepointAuthentication - -Credentials for connecting to the One Drive API - - -## Supported Types - -### AuthenticateViaMicrosoftOAuth - -```python -sourceMicrosoftSharepointAuthentication: shared.AuthenticateViaMicrosoftOAuth = /* values here */ -``` - -### ServiceKeyAuthentication - -```python -sourceMicrosoftSharepointAuthentication: shared.ServiceKeyAuthentication = /* values here */ -``` - diff --git a/docs/models/shared/sourcemicrosoftsharepointautogenerated.md b/docs/models/shared/sourcemicrosoftsharepointautogenerated.md deleted file mode 100644 index cb2348fe..00000000 --- a/docs/models/shared/sourcemicrosoftsharepointautogenerated.md +++ /dev/null @@ -1,8 +0,0 @@ -# SourceMicrosoftSharepointAutogenerated - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `header_definition_type` | [Optional[shared.SourceMicrosoftSharepointSchemasHeaderDefinitionType]](../../models/shared/sourcemicrosoftsharepointschemasheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcemicrosoftsharepointfilebasedstreamconfig.md b/docs/models/shared/sourcemicrosoftsharepointfilebasedstreamconfig.md deleted file mode 100644 index 9203f701..00000000 --- a/docs/models/shared/sourcemicrosoftsharepointfilebasedstreamconfig.md +++ /dev/null @@ -1,15 +0,0 @@ -# SourceMicrosoftSharepointFileBasedStreamConfig - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `format` | [Union[shared.SourceMicrosoftSharepointAvroFormat, shared.SourceMicrosoftSharepointCSVFormat, shared.SourceMicrosoftSharepointJsonlFormat, shared.SourceMicrosoftSharepointParquetFormat, shared.SourceMicrosoftSharepointDocumentFileTypeFormatExperimental]](../../models/shared/sourcemicrosoftsharepointformat.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. | -| `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.SourceMicrosoftSharepointValidationPolicy]](../../models/shared/sourcemicrosoftsharepointvalidationpolicy.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/sourcemicrosoftsharepointformat.md b/docs/models/shared/sourcemicrosoftsharepointformat.md deleted file mode 100644 index 20826954..00000000 --- a/docs/models/shared/sourcemicrosoftsharepointformat.md +++ /dev/null @@ -1,37 +0,0 @@ -# SourceMicrosoftSharepointFormat - -The configuration options that are used to alter how to read incoming files that deviate from the standard formatting. - - -## Supported Types - -### SourceMicrosoftSharepointAvroFormat - -```python -sourceMicrosoftSharepointFormat: shared.SourceMicrosoftSharepointAvroFormat = /* values here */ -``` - -### SourceMicrosoftSharepointCSVFormat - -```python -sourceMicrosoftSharepointFormat: shared.SourceMicrosoftSharepointCSVFormat = /* values here */ -``` - -### SourceMicrosoftSharepointJsonlFormat - -```python -sourceMicrosoftSharepointFormat: shared.SourceMicrosoftSharepointJsonlFormat = /* values here */ -``` - -### SourceMicrosoftSharepointParquetFormat - -```python -sourceMicrosoftSharepointFormat: shared.SourceMicrosoftSharepointParquetFormat = /* values here */ -``` - -### SourceMicrosoftSharepointDocumentFileTypeFormatExperimental - -```python -sourceMicrosoftSharepointFormat: shared.SourceMicrosoftSharepointDocumentFileTypeFormatExperimental = /* values here */ -``` - diff --git a/docs/models/shared/sourcemicrosoftsharepointfromcsv.md b/docs/models/shared/sourcemicrosoftsharepointfromcsv.md deleted file mode 100644 index 7c2d3cf3..00000000 --- a/docs/models/shared/sourcemicrosoftsharepointfromcsv.md +++ /dev/null @@ -1,8 +0,0 @@ -# SourceMicrosoftSharepointFromCSV - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `header_definition_type` | [Optional[shared.SourceMicrosoftSharepointHeaderDefinitionType]](../../models/shared/sourcemicrosoftsharepointheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcemicrosoftsharepointjsonlformat.md b/docs/models/shared/sourcemicrosoftsharepointjsonlformat.md deleted file mode 100644 index 0ed07d85..00000000 --- a/docs/models/shared/sourcemicrosoftsharepointjsonlformat.md +++ /dev/null @@ -1,8 +0,0 @@ -# SourceMicrosoftSharepointJsonlFormat - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `filetype` | [Optional[shared.SourceMicrosoftSharepointSchemasStreamsFiletype]](../../models/shared/sourcemicrosoftsharepointschemasstreamsfiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcemicrosoftsharepointlocal.md b/docs/models/shared/sourcemicrosoftsharepointlocal.md deleted file mode 100644 index b5ac9335..00000000 --- a/docs/models/shared/sourcemicrosoftsharepointlocal.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceMicrosoftSharepointLocal - -Process files locally, supporting `fast` and `ocr` modes. This is the default option. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `mode` | [Optional[shared.SourceMicrosoftSharepointMode]](../../models/shared/sourcemicrosoftsharepointmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcemicrosoftsharepointparquetformat.md b/docs/models/shared/sourcemicrosoftsharepointparquetformat.md deleted file mode 100644 index 1fdc44b9..00000000 --- a/docs/models/shared/sourcemicrosoftsharepointparquetformat.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceMicrosoftSharepointParquetFormat - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `decimal_as_float` | *Optional[bool]* | :heavy_minus_sign: | Whether to convert decimal fields to floats. There is a loss of precision when converting decimals to floats, so this is not recommended. | -| `filetype` | [Optional[shared.SourceMicrosoftSharepointSchemasStreamsFormatFiletype]](../../models/shared/sourcemicrosoftsharepointschemasstreamsformatfiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcemicrosoftsharepointprocessing.md b/docs/models/shared/sourcemicrosoftsharepointprocessing.md deleted file mode 100644 index 26b2ded7..00000000 --- a/docs/models/shared/sourcemicrosoftsharepointprocessing.md +++ /dev/null @@ -1,13 +0,0 @@ -# SourceMicrosoftSharepointProcessing - -Processing configuration - - -## Supported Types - -### SourceMicrosoftSharepointLocal - -```python -sourceMicrosoftSharepointProcessing: shared.SourceMicrosoftSharepointLocal = /* values here */ -``` - diff --git a/docs/models/shared/sourcemicrosoftsharepointuserprovided.md b/docs/models/shared/sourcemicrosoftsharepointuserprovided.md deleted file mode 100644 index 5fef5b9a..00000000 --- a/docs/models/shared/sourcemicrosoftsharepointuserprovided.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceMicrosoftSharepointUserProvided - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `column_names` | List[*str*] | :heavy_check_mark: | The column names that will be used while emitting the CSV records | -| `header_definition_type` | [Optional[shared.SourceMicrosoftSharepointSchemasStreamsHeaderDefinitionType]](../../models/shared/sourcemicrosoftsharepointschemasstreamsheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcemicrosoftteams.md b/docs/models/shared/sourcemicrosoftteams.md deleted file mode 100644 index ecd115f3..00000000 --- a/docs/models/shared/sourcemicrosoftteams.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceMicrosoftTeams - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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/sourcemicrosoftteamsauthenticationmechanism.md b/docs/models/shared/sourcemicrosoftteamsauthenticationmechanism.md deleted file mode 100644 index c77fca6e..00000000 --- a/docs/models/shared/sourcemicrosoftteamsauthenticationmechanism.md +++ /dev/null @@ -1,19 +0,0 @@ -# SourceMicrosoftTeamsAuthenticationMechanism - -Choose how to authenticate to Microsoft - - -## Supported Types - -### AuthenticateViaMicrosoftOAuth20 - -```python -sourceMicrosoftTeamsAuthenticationMechanism: shared.AuthenticateViaMicrosoftOAuth20 = /* values here */ -``` - -### AuthenticateViaMicrosoft - -```python -sourceMicrosoftTeamsAuthenticationMechanism: shared.AuthenticateViaMicrosoft = /* values here */ -``` - diff --git a/docs/models/shared/sourcemonday.md b/docs/models/shared/sourcemonday.md deleted file mode 100644 index 28cf6bc2..00000000 --- a/docs/models/shared/sourcemonday.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceMonday - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `credentials` | [Optional[Union[shared.SourceMondayOAuth20, shared.APIToken]]](../../models/shared/sourcemondayauthorizationmethod.md) | :heavy_minus_sign: | N/A | -| `source_type` | [shared.SourceMondayMonday](../../models/shared/sourcemondaymonday.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcemondayauthorizationmethod.md b/docs/models/shared/sourcemondayauthorizationmethod.md deleted file mode 100644 index 5c530314..00000000 --- a/docs/models/shared/sourcemondayauthorizationmethod.md +++ /dev/null @@ -1,17 +0,0 @@ -# SourceMondayAuthorizationMethod - - -## Supported Types - -### SourceMondayOAuth20 - -```python -sourceMondayAuthorizationMethod: shared.SourceMondayOAuth20 = /* values here */ -``` - -### APIToken - -```python -sourceMondayAuthorizationMethod: shared.APIToken = /* values here */ -``` - diff --git a/docs/models/shared/sourcemongodbinternalpoc.md b/docs/models/shared/sourcemongodbinternalpoc.md deleted file mode 100644 index d71ac7a2..00000000 --- a/docs/models/shared/sourcemongodbinternalpoc.md +++ /dev/null @@ -1,13 +0,0 @@ -# SourceMongodbInternalPoc - - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `auth_source` | *Optional[str]* | :heavy_minus_sign: | The authentication source where the user information is stored. | admin | -| `connection_string` | *Optional[str]* | :heavy_minus_sign: | The connection string of the database that you want to replicate.. | mongodb+srv://example.mongodb.net | -| `password` | *Optional[str]* | :heavy_minus_sign: | The password associated with this username. | | -| `replica_set` | *Optional[str]* | :heavy_minus_sign: | The name of the replica set to be replicated. | | -| `source_type` | [shared.MongodbInternalPoc](../../models/shared/mongodbinternalpoc.md) | :heavy_check_mark: | N/A | | -| `user` | *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/sourcemongodbv2.md b/docs/models/shared/sourcemongodbv2.md deleted file mode 100644 index cdf12f76..00000000 --- a/docs/models/shared/sourcemongodbv2.md +++ /dev/null @@ -1,12 +0,0 @@ -# SourceMongodbV2 - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `database_config` | [Union[shared.MongoDBAtlasReplicaSet, shared.SelfManagedReplicaSet]](../../models/shared/clustertype.md) | :heavy_check_mark: | Configures the MongoDB cluster type. | -| `discover_sample_size` | *Optional[int]* | :heavy_minus_sign: | The maximum number of documents to sample when attempting to discover the unique fields for a collection. | -| `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. | -| `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. | -| `source_type` | [shared.MongodbV2](../../models/shared/mongodbv2.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcemssqlencryptedtrustservercertificate.md b/docs/models/shared/sourcemssqlencryptedtrustservercertificate.md deleted file mode 100644 index 7f1427af..00000000 --- a/docs/models/shared/sourcemssqlencryptedtrustservercertificate.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceMssqlEncryptedTrustServerCertificate - -Use the certificate provided by the server without verification. (For testing purposes only!) - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `ssl_method` | [shared.SourceMssqlSchemasSslMethodSslMethod](../../models/shared/sourcemssqlschemassslmethodsslmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcemssqlencryptedverifycertificate.md b/docs/models/shared/sourcemssqlencryptedverifycertificate.md deleted file mode 100644 index d73fdc1d..00000000 --- a/docs/models/shared/sourcemssqlencryptedverifycertificate.md +++ /dev/null @@ -1,12 +0,0 @@ -# SourceMssqlEncryptedVerifyCertificate - -Verify and use the certificate provided by the server. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `certificate` | *Optional[str]* | :heavy_minus_sign: | certificate of the server, or of the CA that signed the server certificate | -| `host_name_in_certificate` | *Optional[str]* | :heavy_minus_sign: | Specifies the host name of the server. The value of this property must match the subject property of the certificate. | -| `ssl_method` | [shared.SourceMssqlSchemasSSLMethodSSLMethodSSLMethod](../../models/shared/sourcemssqlschemassslmethodsslmethodsslmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcemssqlnotunnel.md b/docs/models/shared/sourcemssqlnotunnel.md deleted file mode 100644 index 49f223e8..00000000 --- a/docs/models/shared/sourcemssqlnotunnel.md +++ /dev/null @@ -1,8 +0,0 @@ -# SourceMssqlNoTunnel - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `tunnel_method` | [shared.SourceMssqlTunnelMethod](../../models/shared/sourcemssqltunnelmethod.md) | :heavy_check_mark: | No ssh tunnel needed to connect to database | \ No newline at end of file diff --git a/docs/models/shared/sourcemssqlpasswordauthentication.md b/docs/models/shared/sourcemssqlpasswordauthentication.md deleted file mode 100644 index 44bbae14..00000000 --- a/docs/models/shared/sourcemssqlpasswordauthentication.md +++ /dev/null @@ -1,12 +0,0 @@ -# SourceMssqlPasswordAuthentication - - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `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_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/sourcemssqlsshtunnelmethod.md b/docs/models/shared/sourcemssqlsshtunnelmethod.md deleted file mode 100644 index 0cb3b306..00000000 --- a/docs/models/shared/sourcemssqlsshtunnelmethod.md +++ /dev/null @@ -1,25 +0,0 @@ -# SourceMssqlSSHTunnelMethod - -Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. - - -## Supported Types - -### SourceMssqlNoTunnel - -```python -sourceMssqlSSHTunnelMethod: shared.SourceMssqlNoTunnel = /* values here */ -``` - -### SourceMssqlSSHKeyAuthentication - -```python -sourceMssqlSSHTunnelMethod: shared.SourceMssqlSSHKeyAuthentication = /* values here */ -``` - -### SourceMssqlPasswordAuthentication - -```python -sourceMssqlSSHTunnelMethod: shared.SourceMssqlPasswordAuthentication = /* values here */ -``` - diff --git a/docs/models/shared/sourcemssqlsslmethod.md b/docs/models/shared/sourcemssqlsslmethod.md deleted file mode 100644 index 8716a639..00000000 --- a/docs/models/shared/sourcemssqlsslmethod.md +++ /dev/null @@ -1,25 +0,0 @@ -# SourceMssqlSSLMethod - -The encryption method which is used when communicating with the database. - - -## Supported Types - -### Unencrypted - -```python -sourceMssqlSSLMethod: shared.Unencrypted = /* values here */ -``` - -### SourceMssqlEncryptedTrustServerCertificate - -```python -sourceMssqlSSLMethod: shared.SourceMssqlEncryptedTrustServerCertificate = /* values here */ -``` - -### SourceMssqlEncryptedVerifyCertificate - -```python -sourceMssqlSSLMethod: shared.SourceMssqlEncryptedVerifyCertificate = /* values here */ -``` - diff --git a/docs/models/shared/sourcemysqlnotunnel.md b/docs/models/shared/sourcemysqlnotunnel.md deleted file mode 100644 index 4df4f2d5..00000000 --- a/docs/models/shared/sourcemysqlnotunnel.md +++ /dev/null @@ -1,8 +0,0 @@ -# SourceMysqlNoTunnel - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `tunnel_method` | [shared.SourceMysqlTunnelMethod](../../models/shared/sourcemysqltunnelmethod.md) | :heavy_check_mark: | No ssh tunnel needed to connect to database | \ No newline at end of file diff --git a/docs/models/shared/sourcemysqlpasswordauthentication.md b/docs/models/shared/sourcemysqlpasswordauthentication.md deleted file mode 100644 index 615dc0f5..00000000 --- a/docs/models/shared/sourcemysqlpasswordauthentication.md +++ /dev/null @@ -1,12 +0,0 @@ -# SourceMysqlPasswordAuthentication - - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `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_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/sourcemysqlscanchangeswithuserdefinedcursor.md b/docs/models/shared/sourcemysqlscanchangeswithuserdefinedcursor.md deleted file mode 100644 index f34678dc..00000000 --- a/docs/models/shared/sourcemysqlscanchangeswithuserdefinedcursor.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceMysqlScanChangesWithUserDefinedCursor - -Incrementally detects new inserts and updates using the cursor column chosen when configuring a connection (e.g. created_at, updated_at). - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `method` | [shared.SourceMysqlSchemasMethod](../../models/shared/sourcemysqlschemasmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcemysqlsshtunnelmethod.md b/docs/models/shared/sourcemysqlsshtunnelmethod.md deleted file mode 100644 index 39c2fb36..00000000 --- a/docs/models/shared/sourcemysqlsshtunnelmethod.md +++ /dev/null @@ -1,25 +0,0 @@ -# SourceMysqlSSHTunnelMethod - -Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. - - -## Supported Types - -### SourceMysqlNoTunnel - -```python -sourceMysqlSSHTunnelMethod: shared.SourceMysqlNoTunnel = /* values here */ -``` - -### SourceMysqlSSHKeyAuthentication - -```python -sourceMysqlSSHTunnelMethod: shared.SourceMysqlSSHKeyAuthentication = /* values here */ -``` - -### SourceMysqlPasswordAuthentication - -```python -sourceMysqlSSHTunnelMethod: shared.SourceMysqlPasswordAuthentication = /* values here */ -``` - diff --git a/docs/models/shared/sourcemysqlsslmodes.md b/docs/models/shared/sourcemysqlsslmodes.md deleted file mode 100644 index 4db044ed..00000000 --- a/docs/models/shared/sourcemysqlsslmodes.md +++ /dev/null @@ -1,31 +0,0 @@ -# SourceMysqlSSLModes - -SSL connection modes. Read more in the docs. - - -## Supported Types - -### Preferred - -```python -sourceMysqlSSLModes: shared.Preferred = /* values here */ -``` - -### Required - -```python -sourceMysqlSSLModes: shared.Required = /* values here */ -``` - -### SourceMysqlVerifyCA - -```python -sourceMysqlSSLModes: shared.SourceMysqlVerifyCA = /* values here */ -``` - -### VerifyIdentity - -```python -sourceMysqlSSLModes: shared.VerifyIdentity = /* values here */ -``` - diff --git a/docs/models/shared/sourcemysqlupdatemethod.md b/docs/models/shared/sourcemysqlupdatemethod.md deleted file mode 100644 index 92bcbfca..00000000 --- a/docs/models/shared/sourcemysqlupdatemethod.md +++ /dev/null @@ -1,19 +0,0 @@ -# SourceMysqlUpdateMethod - -Configures how data is extracted from the database. - - -## Supported Types - -### ReadChangesUsingBinaryLogCDC - -```python -sourceMysqlUpdateMethod: shared.ReadChangesUsingBinaryLogCDC = /* values here */ -``` - -### SourceMysqlScanChangesWithUserDefinedCursor - -```python -sourceMysqlUpdateMethod: shared.SourceMysqlScanChangesWithUserDefinedCursor = /* values here */ -``` - diff --git a/docs/models/shared/sourcenotionauthenticationmethod.md b/docs/models/shared/sourcenotionauthenticationmethod.md deleted file mode 100644 index eb1263fc..00000000 --- a/docs/models/shared/sourcenotionauthenticationmethod.md +++ /dev/null @@ -1,19 +0,0 @@ -# SourceNotionAuthenticationMethod - -Choose either OAuth (recommended for Airbyte Cloud) or Access Token. See our docs for more information. - - -## Supported Types - -### SourceNotionOAuth20 - -```python -sourceNotionAuthenticationMethod: shared.SourceNotionOAuth20 = /* values here */ -``` - -### SourceNotionAccessToken - -```python -sourceNotionAuthenticationMethod: shared.SourceNotionAccessToken = /* values here */ -``` - diff --git a/docs/models/shared/sourcenytimes.md b/docs/models/shared/sourcenytimes.md deleted file mode 100644 index e677073c..00000000 --- a/docs/models/shared/sourcenytimes.md +++ /dev/null @@ -1,13 +0,0 @@ -# SourceNytimes - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | API Key | | -| `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 | | \ No newline at end of file diff --git a/docs/models/shared/sourceoktaauthorizationmethod.md b/docs/models/shared/sourceoktaauthorizationmethod.md deleted file mode 100644 index 1b60c88d..00000000 --- a/docs/models/shared/sourceoktaauthorizationmethod.md +++ /dev/null @@ -1,17 +0,0 @@ -# SourceOktaAuthorizationMethod - - -## Supported Types - -### SourceOktaOAuth20 - -```python -sourceOktaAuthorizationMethod: shared.SourceOktaOAuth20 = /* values here */ -``` - -### SourceOktaAPIToken - -```python -sourceOktaAuthorizationMethod: shared.SourceOktaAPIToken = /* values here */ -``` - diff --git a/docs/models/shared/sourceoktaoauth20.md b/docs/models/shared/sourceoktaoauth20.md deleted file mode 100644 index db692930..00000000 --- a/docs/models/shared/sourceoktaoauth20.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceOktaOAuth20 - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `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. | -| `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/sourceomnisend.md b/docs/models/shared/sourceomnisend.md deleted file mode 100644 index 00145602..00000000 --- a/docs/models/shared/sourceomnisend.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceOmnisend - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | API Key | -| `source_type` | [shared.Omnisend](../../models/shared/omnisend.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceoraclenotunnel.md b/docs/models/shared/sourceoraclenotunnel.md deleted file mode 100644 index c2fdbd70..00000000 --- a/docs/models/shared/sourceoraclenotunnel.md +++ /dev/null @@ -1,8 +0,0 @@ -# SourceOracleNoTunnel - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `tunnel_method` | [shared.SourceOracleTunnelMethod](../../models/shared/sourceoracletunnelmethod.md) | :heavy_check_mark: | No ssh tunnel needed to connect to database | \ No newline at end of file diff --git a/docs/models/shared/sourceoraclepasswordauthentication.md b/docs/models/shared/sourceoraclepasswordauthentication.md deleted file mode 100644 index 64c3c5ac..00000000 --- a/docs/models/shared/sourceoraclepasswordauthentication.md +++ /dev/null @@ -1,12 +0,0 @@ -# SourceOraclePasswordAuthentication - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `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_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/sourceoraclesshtunnelmethod.md b/docs/models/shared/sourceoraclesshtunnelmethod.md deleted file mode 100644 index 66c15a10..00000000 --- a/docs/models/shared/sourceoraclesshtunnelmethod.md +++ /dev/null @@ -1,25 +0,0 @@ -# SourceOracleSSHTunnelMethod - -Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. - - -## Supported Types - -### SourceOracleNoTunnel - -```python -sourceOracleSSHTunnelMethod: shared.SourceOracleNoTunnel = /* values here */ -``` - -### SourceOracleSSHKeyAuthentication - -```python -sourceOracleSSHTunnelMethod: shared.SourceOracleSSHKeyAuthentication = /* values here */ -``` - -### SourceOraclePasswordAuthentication - -```python -sourceOracleSSHTunnelMethod: shared.SourceOraclePasswordAuthentication = /* values here */ -``` - diff --git a/docs/models/shared/sourceoutbrainamplifyaccesstoken.md b/docs/models/shared/sourceoutbrainamplifyaccesstoken.md deleted file mode 100644 index 20a52a8e..00000000 --- a/docs/models/shared/sourceoutbrainamplifyaccesstoken.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceOutbrainAmplifyAccessToken - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -| `access_token` | *str* | :heavy_check_mark: | Access Token for making authenticated requests. | -| `type` | [shared.AccessTokenIsRequiredForAuthenticationRequests](../../models/shared/accesstokenisrequiredforauthenticationrequests.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceoutbrainamplifyauthenticationmethod.md b/docs/models/shared/sourceoutbrainamplifyauthenticationmethod.md deleted file mode 100644 index 19427bdb..00000000 --- a/docs/models/shared/sourceoutbrainamplifyauthenticationmethod.md +++ /dev/null @@ -1,19 +0,0 @@ -# SourceOutbrainAmplifyAuthenticationMethod - -Credentials for making authenticated requests requires either username/password or access_token. - - -## Supported Types - -### SourceOutbrainAmplifyAccessToken - -```python -sourceOutbrainAmplifyAuthenticationMethod: shared.SourceOutbrainAmplifyAccessToken = /* values here */ -``` - -### SourceOutbrainAmplifyUsernamePassword - -```python -sourceOutbrainAmplifyAuthenticationMethod: shared.SourceOutbrainAmplifyUsernamePassword = /* values here */ -``` - diff --git a/docs/models/shared/sourceoutbrainamplifyusernamepassword.md b/docs/models/shared/sourceoutbrainamplifyusernamepassword.md deleted file mode 100644 index 4f5f4b54..00000000 --- a/docs/models/shared/sourceoutbrainamplifyusernamepassword.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceOutbrainAmplifyUsernamePassword - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `password` | *str* | :heavy_check_mark: | Add Password for authentication. | -| `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/sourcepaypaltransaction.md b/docs/models/shared/sourcepaypaltransaction.md deleted file mode 100644 index edebd8f6..00000000 --- a/docs/models/shared/sourcepaypaltransaction.md +++ /dev/null @@ -1,14 +0,0 @@ -# SourcePaypalTransaction - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | | -| `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/sourcependo.md b/docs/models/shared/sourcependo.md deleted file mode 100644 index b7b91cf1..00000000 --- a/docs/models/shared/sourcependo.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourcePendo - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | N/A | -| `source_type` | [shared.Pendo](../../models/shared/pendo.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcepokeapi.md b/docs/models/shared/sourcepokeapi.md deleted file mode 100644 index 09e17028..00000000 --- a/docs/models/shared/sourcepokeapi.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourcePokeapi - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `pokemon_name` | [shared.PokemonName](../../models/shared/pokemonname.md) | :heavy_check_mark: | Pokemon requested from the API. | ditto | -| `source_type` | [shared.Pokeapi](../../models/shared/pokeapi.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcepostgresallow.md b/docs/models/shared/sourcepostgresallow.md deleted file mode 100644 index e3f75171..00000000 --- a/docs/models/shared/sourcepostgresallow.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourcePostgresAllow - -Enables encryption only when required by the source database. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `mode` | [shared.SourcePostgresSchemasMode](../../models/shared/sourcepostgresschemasmode.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcepostgresdisable.md b/docs/models/shared/sourcepostgresdisable.md deleted file mode 100644 index 9c096274..00000000 --- a/docs/models/shared/sourcepostgresdisable.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourcePostgresDisable - -Disables encryption of communication between Airbyte and source database. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `mode` | [shared.SourcePostgresMode](../../models/shared/sourcepostgresmode.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcepostgresnotunnel.md b/docs/models/shared/sourcepostgresnotunnel.md deleted file mode 100644 index 16e5ec63..00000000 --- a/docs/models/shared/sourcepostgresnotunnel.md +++ /dev/null @@ -1,8 +0,0 @@ -# SourcePostgresNoTunnel - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `tunnel_method` | [shared.SourcePostgresTunnelMethod](../../models/shared/sourcepostgrestunnelmethod.md) | :heavy_check_mark: | No ssh tunnel needed to connect to database | \ No newline at end of file diff --git a/docs/models/shared/sourcepostgrespasswordauthentication.md b/docs/models/shared/sourcepostgrespasswordauthentication.md deleted file mode 100644 index 7ae1344b..00000000 --- a/docs/models/shared/sourcepostgrespasswordauthentication.md +++ /dev/null @@ -1,12 +0,0 @@ -# SourcePostgresPasswordAuthentication - - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `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_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/sourcepostgresprefer.md b/docs/models/shared/sourcepostgresprefer.md deleted file mode 100644 index 682866e2..00000000 --- a/docs/models/shared/sourcepostgresprefer.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourcePostgresPrefer - -Allows unencrypted connection only if the source database does not support encryption. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `mode` | [shared.SourcePostgresSchemasSslModeMode](../../models/shared/sourcepostgresschemassslmodemode.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcepostgresrequire.md b/docs/models/shared/sourcepostgresrequire.md deleted file mode 100644 index 969e04eb..00000000 --- a/docs/models/shared/sourcepostgresrequire.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourcePostgresRequire - -Always require encryption. If the source database server does not support encryption, connection will fail. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `mode` | [shared.SourcePostgresSchemasSSLModeSSLModesMode](../../models/shared/sourcepostgresschemassslmodesslmodesmode.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcepostgresscanchangeswithuserdefinedcursor.md b/docs/models/shared/sourcepostgresscanchangeswithuserdefinedcursor.md deleted file mode 100644 index ffa6c236..00000000 --- a/docs/models/shared/sourcepostgresscanchangeswithuserdefinedcursor.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourcePostgresScanChangesWithUserDefinedCursor - -Incrementally detects new inserts and updates using the cursor column chosen when configuring a connection (e.g. created_at, updated_at). - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `method` | [shared.SourcePostgresSchemasReplicationMethodMethod](../../models/shared/sourcepostgresschemasreplicationmethodmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcepostgressshtunnelmethod.md b/docs/models/shared/sourcepostgressshtunnelmethod.md deleted file mode 100644 index c8d7e14d..00000000 --- a/docs/models/shared/sourcepostgressshtunnelmethod.md +++ /dev/null @@ -1,25 +0,0 @@ -# SourcePostgresSSHTunnelMethod - -Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. - - -## Supported Types - -### SourcePostgresNoTunnel - -```python -sourcePostgresSSHTunnelMethod: shared.SourcePostgresNoTunnel = /* values here */ -``` - -### SourcePostgresSSHKeyAuthentication - -```python -sourcePostgresSSHTunnelMethod: shared.SourcePostgresSSHKeyAuthentication = /* values here */ -``` - -### SourcePostgresPasswordAuthentication - -```python -sourcePostgresSSHTunnelMethod: shared.SourcePostgresPasswordAuthentication = /* values here */ -``` - diff --git a/docs/models/shared/sourcepostgressslmodes.md b/docs/models/shared/sourcepostgressslmodes.md deleted file mode 100644 index 7101fcc7..00000000 --- a/docs/models/shared/sourcepostgressslmodes.md +++ /dev/null @@ -1,44 +0,0 @@ -# SourcePostgresSSLModes - -SSL connection modes. - Read more in the docs. - - -## Supported Types - -### SourcePostgresDisable - -```python -sourcePostgresSSLModes: shared.SourcePostgresDisable = /* values here */ -``` - -### SourcePostgresAllow - -```python -sourcePostgresSSLModes: shared.SourcePostgresAllow = /* values here */ -``` - -### SourcePostgresPrefer - -```python -sourcePostgresSSLModes: shared.SourcePostgresPrefer = /* values here */ -``` - -### SourcePostgresRequire - -```python -sourcePostgresSSLModes: shared.SourcePostgresRequire = /* values here */ -``` - -### SourcePostgresVerifyCa - -```python -sourcePostgresSSLModes: shared.SourcePostgresVerifyCa = /* values here */ -``` - -### SourcePostgresVerifyFull - -```python -sourcePostgresSSLModes: shared.SourcePostgresVerifyFull = /* values here */ -``` - diff --git a/docs/models/shared/sourcepostgresupdatemethod.md b/docs/models/shared/sourcepostgresupdatemethod.md deleted file mode 100644 index 9f33eb91..00000000 --- a/docs/models/shared/sourcepostgresupdatemethod.md +++ /dev/null @@ -1,25 +0,0 @@ -# SourcePostgresUpdateMethod - -Configures how data is extracted from the database. - - -## Supported Types - -### ReadChangesUsingWriteAheadLogCDC - -```python -sourcePostgresUpdateMethod: shared.ReadChangesUsingWriteAheadLogCDC = /* values here */ -``` - -### DetectChangesWithXminSystemColumn - -```python -sourcePostgresUpdateMethod: shared.DetectChangesWithXminSystemColumn = /* values here */ -``` - -### SourcePostgresScanChangesWithUserDefinedCursor - -```python -sourcePostgresUpdateMethod: shared.SourcePostgresScanChangesWithUserDefinedCursor = /* values here */ -``` - diff --git a/docs/models/shared/sourcepostgresverifyca.md b/docs/models/shared/sourcepostgresverifyca.md deleted file mode 100644 index 04fa53a3..00000000 --- a/docs/models/shared/sourcepostgresverifyca.md +++ /dev/null @@ -1,15 +0,0 @@ -# SourcePostgresVerifyCa - -Always require encryption and verifies that the source database server has a valid SSL certificate. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `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. | -| `mode` | [shared.SourcePostgresSchemasSSLModeSSLModes5Mode](../../models/shared/sourcepostgresschemassslmodesslmodes5mode.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcepostgresverifyfull.md b/docs/models/shared/sourcepostgresverifyfull.md deleted file mode 100644 index e998ee3e..00000000 --- a/docs/models/shared/sourcepostgresverifyfull.md +++ /dev/null @@ -1,15 +0,0 @@ -# SourcePostgresVerifyFull - -This is the most secure mode. Always require encryption and verifies the identity of the source database server. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `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. | -| `mode` | [shared.SourcePostgresSchemasSSLModeSSLModes6Mode](../../models/shared/sourcepostgresschemassslmodesslmodes6mode.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcepostmarkapp.md b/docs/models/shared/sourcepostmarkapp.md deleted file mode 100644 index 9c650be2..00000000 --- a/docs/models/shared/sourcepostmarkapp.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourcePostmarkapp - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `x_postmark_account_token` | *str* | :heavy_check_mark: | API Key for account | -| `x_postmark_server_token` | *str* | :heavy_check_mark: | API Key for server | -| `source_type` | [shared.Postmarkapp](../../models/shared/postmarkapp.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcepunkapi.md b/docs/models/shared/sourcepunkapi.md deleted file mode 100644 index c498f57b..00000000 --- a/docs/models/shared/sourcepunkapi.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourcePunkAPI - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `brewed_after` | *str* | :heavy_check_mark: | To extract specific data with Unique ID | MM-YYYY | -| `brewed_before` | *str* | :heavy_check_mark: | To extract specific data with Unique ID | MM-YYYY | -| `id` | *Optional[str]* | :heavy_minus_sign: | To extract specific data with Unique ID | 1 | -| `source_type` | [shared.PunkAPI](../../models/shared/punkapi.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcequickbooksauthorizationmethod.md b/docs/models/shared/sourcequickbooksauthorizationmethod.md deleted file mode 100644 index cd781b2e..00000000 --- a/docs/models/shared/sourcequickbooksauthorizationmethod.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceQuickbooksAuthorizationMethod - - -## Supported Types - -### SourceQuickbooksOAuth20 - -```python -sourceQuickbooksAuthorizationMethod: shared.SourceQuickbooksOAuth20 = /* values here */ -``` - diff --git a/docs/models/shared/sourcerailz.md b/docs/models/shared/sourcerailz.md deleted file mode 100644 index 0521ee08..00000000 --- a/docs/models/shared/sourcerailz.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceRailz - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `client_id` | *str* | :heavy_check_mark: | Client ID (client_id) | -| `secret_key` | *str* | :heavy_check_mark: | Secret key (secret_key) | -| `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/sourcerecreation.md b/docs/models/shared/sourcerecreation.md deleted file mode 100644 index f861f646..00000000 --- a/docs/models/shared/sourcerecreation.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceRecreation - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `apikey` | *str* | :heavy_check_mark: | API Key | -| `query_campsites` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `source_type` | [shared.Recreation](../../models/shared/recreation.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceretently.md b/docs/models/shared/sourceretently.md deleted file mode 100644 index 482e3cd7..00000000 --- a/docs/models/shared/sourceretently.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceRetently - - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `credentials` | [Optional[Union[shared.AuthenticateViaRetentlyOAuth, shared.AuthenticateWithAPIToken]]](../../models/shared/sourceretentlyauthenticationmechanism.md) | :heavy_minus_sign: | Choose how to authenticate to Retently | -| `source_type` | [Optional[shared.SourceRetentlyRetently]](../../models/shared/sourceretentlyretently.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceretentlyauthenticationmechanism.md b/docs/models/shared/sourceretentlyauthenticationmechanism.md deleted file mode 100644 index 3d5270dc..00000000 --- a/docs/models/shared/sourceretentlyauthenticationmechanism.md +++ /dev/null @@ -1,19 +0,0 @@ -# SourceRetentlyAuthenticationMechanism - -Choose how to authenticate to Retently - - -## Supported Types - -### AuthenticateViaRetentlyOAuth - -```python -sourceRetentlyAuthenticationMechanism: shared.AuthenticateViaRetentlyOAuth = /* values here */ -``` - -### AuthenticateWithAPIToken - -```python -sourceRetentlyAuthenticationMechanism: shared.AuthenticateWithAPIToken = /* values here */ -``` - diff --git a/docs/models/shared/sourcerss.md b/docs/models/shared/sourcerss.md deleted file mode 100644 index 884c6343..00000000 --- a/docs/models/shared/sourcerss.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceRss - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `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/sources3autogenerated.md b/docs/models/shared/sources3autogenerated.md deleted file mode 100644 index 00ea0e01..00000000 --- a/docs/models/shared/sources3autogenerated.md +++ /dev/null @@ -1,8 +0,0 @@ -# SourceS3Autogenerated - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `header_definition_type` | [Optional[shared.SourceS3SchemasHeaderDefinitionType]](../../models/shared/sources3schemasheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sources3filebasedstreamconfig.md b/docs/models/shared/sources3filebasedstreamconfig.md deleted file mode 100644 index d044e73a..00000000 --- a/docs/models/shared/sources3filebasedstreamconfig.md +++ /dev/null @@ -1,16 +0,0 @@ -# SourceS3FileBasedStreamConfig - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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. | -| `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/sources3fileformat.md b/docs/models/shared/sources3fileformat.md deleted file mode 100644 index ffd2097d..00000000 --- a/docs/models/shared/sources3fileformat.md +++ /dev/null @@ -1,31 +0,0 @@ -# SourceS3FileFormat - -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 - - -## Supported Types - -### Csv - -```python -sourceS3FileFormat: shared.Csv = /* values here */ -``` - -### Parquet - -```python -sourceS3FileFormat: shared.Parquet = /* values here */ -``` - -### Avro - -```python -sourceS3FileFormat: shared.Avro = /* values here */ -``` - -### Jsonl - -```python -sourceS3FileFormat: shared.Jsonl = /* values here */ -``` - diff --git a/docs/models/shared/sources3format.md b/docs/models/shared/sources3format.md deleted file mode 100644 index 7fa7d11b..00000000 --- a/docs/models/shared/sources3format.md +++ /dev/null @@ -1,37 +0,0 @@ -# SourceS3Format - -The configuration options that are used to alter how to read incoming files that deviate from the standard formatting. - - -## Supported Types - -### SourceS3AvroFormat - -```python -sourceS3Format: shared.SourceS3AvroFormat = /* values here */ -``` - -### SourceS3CSVFormat - -```python -sourceS3Format: shared.SourceS3CSVFormat = /* values here */ -``` - -### SourceS3JsonlFormat - -```python -sourceS3Format: shared.SourceS3JsonlFormat = /* values here */ -``` - -### SourceS3ParquetFormat - -```python -sourceS3Format: shared.SourceS3ParquetFormat = /* values here */ -``` - -### SourceS3DocumentFileTypeFormatExperimental - -```python -sourceS3Format: shared.SourceS3DocumentFileTypeFormatExperimental = /* values here */ -``` - diff --git a/docs/models/shared/sources3fromcsv.md b/docs/models/shared/sources3fromcsv.md deleted file mode 100644 index 4e89d3d3..00000000 --- a/docs/models/shared/sources3fromcsv.md +++ /dev/null @@ -1,8 +0,0 @@ -# SourceS3FromCSV - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `header_definition_type` | [Optional[shared.SourceS3HeaderDefinitionType]](../../models/shared/sources3headerdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sources3jsonlformat.md b/docs/models/shared/sources3jsonlformat.md deleted file mode 100644 index 6a9f4592..00000000 --- a/docs/models/shared/sources3jsonlformat.md +++ /dev/null @@ -1,8 +0,0 @@ -# SourceS3JsonlFormat - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `filetype` | [Optional[shared.SourceS3SchemasStreamsFormatFormatFiletype]](../../models/shared/sources3schemasstreamsformatformatfiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sources3local.md b/docs/models/shared/sources3local.md deleted file mode 100644 index aa08df2e..00000000 --- a/docs/models/shared/sources3local.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceS3Local - -Process files locally, supporting `fast` and `ocr` modes. This is the default option. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `mode` | [Optional[shared.SourceS3Mode]](../../models/shared/sources3mode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sources3processing.md b/docs/models/shared/sources3processing.md deleted file mode 100644 index e9473bfa..00000000 --- a/docs/models/shared/sources3processing.md +++ /dev/null @@ -1,13 +0,0 @@ -# SourceS3Processing - -Processing configuration - - -## Supported Types - -### SourceS3Local - -```python -sourceS3Processing: shared.SourceS3Local = /* values here */ -``` - diff --git a/docs/models/shared/sources3userprovided.md b/docs/models/shared/sources3userprovided.md deleted file mode 100644 index 5ea5d4c9..00000000 --- a/docs/models/shared/sources3userprovided.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceS3UserProvided - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `column_names` | List[*str*] | :heavy_check_mark: | The column names that will be used while emitting the CSV records | -| `header_definition_type` | [Optional[shared.SourceS3SchemasStreamsHeaderDefinitionType]](../../models/shared/sources3schemasstreamsheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcesalesloftcredentials.md b/docs/models/shared/sourcesalesloftcredentials.md deleted file mode 100644 index 33cf7aeb..00000000 --- a/docs/models/shared/sourcesalesloftcredentials.md +++ /dev/null @@ -1,17 +0,0 @@ -# SourceSalesloftCredentials - - -## Supported Types - -### AuthenticateViaOAuth - -```python -sourceSalesloftCredentials: shared.AuthenticateViaOAuth = /* values here */ -``` - -### AuthenticateViaAPIKey - -```python -sourceSalesloftCredentials: shared.AuthenticateViaAPIKey = /* values here */ -``` - diff --git a/docs/models/shared/sourcesapfieldglass.md b/docs/models/shared/sourcesapfieldglass.md deleted file mode 100644 index 1bf747f0..00000000 --- a/docs/models/shared/sourcesapfieldglass.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceSapFieldglass - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `api_key` | *str* | :heavy_check_mark: | API Key | -| `source_type` | [shared.SapFieldglass](../../models/shared/sapfieldglass.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 deleted file mode 100644 index 052b9fda..00000000 --- a/docs/models/shared/sourcesftp.md +++ /dev/null @@ -1,15 +0,0 @@ -# SourceSftp - - -## Fields - -| 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/sourcesftpauthentication.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 | -| `port` | *Optional[int]* | :heavy_minus_sign: | The server port | 22 | -| `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/sourcesftpauthentication.md b/docs/models/shared/sourcesftpauthentication.md deleted file mode 100644 index 68da99d0..00000000 --- a/docs/models/shared/sourcesftpauthentication.md +++ /dev/null @@ -1,19 +0,0 @@ -# SourceSftpAuthentication - -The server authentication method - - -## Supported Types - -### SourceSftpPasswordAuthentication - -```python -sourceSftpAuthentication: shared.SourceSftpPasswordAuthentication = /* values here */ -``` - -### SourceSftpSSHKeyAuthentication - -```python -sourceSftpAuthentication: shared.SourceSftpSSHKeyAuthentication = /* values here */ -``` - diff --git a/docs/models/shared/sourcesftppasswordauthentication.md b/docs/models/shared/sourcesftppasswordauthentication.md deleted file mode 100644 index 3eb2e1c4..00000000 --- a/docs/models/shared/sourcesftppasswordauthentication.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceSftpPasswordAuthentication - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `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/sourceshopify.md b/docs/models/shared/sourceshopify.md deleted file mode 100644 index 6a6f1da6..00000000 --- a/docs/models/shared/sourceshopify.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceShopify - - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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/sourceshopifyoauth20.md b/docs/models/shared/sourceshopifyoauth20.md deleted file mode 100644 index 2037f223..00000000 --- a/docs/models/shared/sourceshopifyoauth20.md +++ /dev/null @@ -1,13 +0,0 @@ -# SourceShopifyOAuth20 - -OAuth2.0 - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `access_token` | *Optional[str]* | :heavy_minus_sign: | The Access Token for making authenticated requests. | -| `auth_method` | [shared.SourceShopifyAuthMethod](../../models/shared/sourceshopifyauthmethod.md) | :heavy_check_mark: | N/A | -| `client_id` | *Optional[str]* | :heavy_minus_sign: | The Client ID of the Shopify developer application. | -| `client_secret` | *Optional[str]* | :heavy_minus_sign: | The Client Secret of the Shopify developer application. | \ No newline at end of file diff --git a/docs/models/shared/sourceslackauthenticationmechanism.md b/docs/models/shared/sourceslackauthenticationmechanism.md deleted file mode 100644 index 4050f0c4..00000000 --- a/docs/models/shared/sourceslackauthenticationmechanism.md +++ /dev/null @@ -1,19 +0,0 @@ -# SourceSlackAuthenticationMechanism - -Choose how to authenticate into Slack - - -## Supported Types - -### SignInViaSlackOAuth - -```python -sourceSlackAuthenticationMechanism: shared.SignInViaSlackOAuth = /* values here */ -``` - -### SourceSlackAPIToken - -```python -sourceSlackAuthenticationMechanism: shared.SourceSlackAPIToken = /* values here */ -``` - diff --git a/docs/models/shared/sourcesmartengage.md b/docs/models/shared/sourcesmartengage.md deleted file mode 100644 index b526d263..00000000 --- a/docs/models/shared/sourcesmartengage.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceSmartengage - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | API Key | -| `source_type` | [shared.Smartengage](../../models/shared/smartengage.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcesmartsheetsauthorizationmethod.md b/docs/models/shared/sourcesmartsheetsauthorizationmethod.md deleted file mode 100644 index 6952c087..00000000 --- a/docs/models/shared/sourcesmartsheetsauthorizationmethod.md +++ /dev/null @@ -1,17 +0,0 @@ -# SourceSmartsheetsAuthorizationMethod - - -## Supported Types - -### SourceSmartsheetsOAuth20 - -```python -sourceSmartsheetsAuthorizationMethod: shared.SourceSmartsheetsOAuth20 = /* values here */ -``` - -### APIAccessToken - -```python -sourceSmartsheetsAuthorizationMethod: shared.APIAccessToken = /* values here */ -``` - diff --git a/docs/models/shared/sourcesmartsheetsoauth20.md b/docs/models/shared/sourcesmartsheetsoauth20.md deleted file mode 100644 index c50f93b2..00000000 --- a/docs/models/shared/sourcesmartsheetsoauth20.md +++ /dev/null @@ -1,13 +0,0 @@ -# SourceSmartsheetsOAuth20 - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `access_token` | *str* | :heavy_check_mark: | Access Token for making authenticated requests. | -| `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. | -| `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 deleted file mode 100644 index 80feb064..00000000 --- a/docs/models/shared/sourcesnapchatmarketing.md +++ /dev/null @@ -1,13 +0,0 @@ -# SourceSnapchatMarketing - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `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. | | -| `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/sourcesnowflakeauthorizationmethod.md b/docs/models/shared/sourcesnowflakeauthorizationmethod.md deleted file mode 100644 index 676b72f6..00000000 --- a/docs/models/shared/sourcesnowflakeauthorizationmethod.md +++ /dev/null @@ -1,17 +0,0 @@ -# SourceSnowflakeAuthorizationMethod - - -## Supported Types - -### SourceSnowflakeOAuth20 - -```python -sourceSnowflakeAuthorizationMethod: shared.SourceSnowflakeOAuth20 = /* values here */ -``` - -### SourceSnowflakeUsernameAndPassword - -```python -sourceSnowflakeAuthorizationMethod: shared.SourceSnowflakeUsernameAndPassword = /* values here */ -``` - diff --git a/docs/models/shared/sourcesnowflakeoauth20.md b/docs/models/shared/sourcesnowflakeoauth20.md deleted file mode 100644 index 23b67539..00000000 --- a/docs/models/shared/sourcesnowflakeoauth20.md +++ /dev/null @@ -1,12 +0,0 @@ -# SourceSnowflakeOAuth20 - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `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 deleted file mode 100644 index 20587118..00000000 --- a/docs/models/shared/sourcesnowflakeusernameandpassword.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceSnowflakeUsernameAndPassword - - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `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 | -| `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/sourcespacexapi.md b/docs/models/shared/sourcespacexapi.md deleted file mode 100644 index d92d35e2..00000000 --- a/docs/models/shared/sourcespacexapi.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceSpacexAPI - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `options` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `source_type` | [shared.SpacexAPI](../../models/shared/spacexapi.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcesquareapikey.md b/docs/models/shared/sourcesquareapikey.md deleted file mode 100644 index 44da95f9..00000000 --- a/docs/models/shared/sourcesquareapikey.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceSquareAPIKey - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | The API key for a Square application | -| `auth_type` | [shared.SourceSquareSchemasAuthType](../../models/shared/sourcesquareschemasauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcesquareauthentication.md b/docs/models/shared/sourcesquareauthentication.md deleted file mode 100644 index d1bd6582..00000000 --- a/docs/models/shared/sourcesquareauthentication.md +++ /dev/null @@ -1,19 +0,0 @@ -# SourceSquareAuthentication - -Choose how to authenticate to Square. - - -## Supported Types - -### OauthAuthentication - -```python -sourceSquareAuthentication: shared.OauthAuthentication = /* values here */ -``` - -### SourceSquareAPIKey - -```python -sourceSquareAuthentication: shared.SourceSquareAPIKey = /* values here */ -``` - diff --git a/docs/models/shared/sourcesresponse.md b/docs/models/shared/sourcesresponse.md deleted file mode 100644 index f618e686..00000000 --- a/docs/models/shared/sourcesresponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourcesResponse - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `data` | List[[shared.SourceResponse](../../models/shared/sourceresponse.md)] | :heavy_check_mark: | N/A | -| `next` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `previous` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcestrava.md b/docs/models/shared/sourcestrava.md deleted file mode 100644 index 5862be9d..00000000 --- a/docs/models/shared/sourcestrava.md +++ /dev/null @@ -1,14 +0,0 @@ -# SourceStrava - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `athlete_id` | *int* | :heavy_check_mark: | The Athlete ID of your Strava developer application. | 17831421 | -| `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 | -| `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/sourcetiktokmarketingauthenticationmethod.md b/docs/models/shared/sourcetiktokmarketingauthenticationmethod.md deleted file mode 100644 index 7357ec8f..00000000 --- a/docs/models/shared/sourcetiktokmarketingauthenticationmethod.md +++ /dev/null @@ -1,19 +0,0 @@ -# SourceTiktokMarketingAuthenticationMethod - -Authentication method - - -## Supported Types - -### SourceTiktokMarketingOAuth20 - -```python -sourceTiktokMarketingAuthenticationMethod: shared.SourceTiktokMarketingOAuth20 = /* values here */ -``` - -### SandboxAccessToken - -```python -sourceTiktokMarketingAuthenticationMethod: shared.SandboxAccessToken = /* values here */ -``` - diff --git a/docs/models/shared/sourcetiktokmarketingoauth20.md b/docs/models/shared/sourcetiktokmarketingoauth20.md deleted file mode 100644 index 5d37f8e4..00000000 --- a/docs/models/shared/sourcetiktokmarketingoauth20.md +++ /dev/null @@ -1,12 +0,0 @@ -# SourceTiktokMarketingOAuth20 - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `access_token` | *str* | :heavy_check_mark: | Long-term Authorized Access Token. | -| `app_id` | *str* | :heavy_check_mark: | The Developer Application App ID. | -| `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/sourcetrustpilotapikey.md b/docs/models/shared/sourcetrustpilotapikey.md deleted file mode 100644 index dc8db4ee..00000000 --- a/docs/models/shared/sourcetrustpilotapikey.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceTrustpilotAPIKey - -The API key authentication method gives you access to only the streams which are part of the Public API. When you want to get streams available via the Consumer API (e.g. the private reviews) you need to use authentication method OAuth 2.0. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `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/sourcetrustpilotauthorizationmethod.md b/docs/models/shared/sourcetrustpilotauthorizationmethod.md deleted file mode 100644 index 26fc7bd8..00000000 --- a/docs/models/shared/sourcetrustpilotauthorizationmethod.md +++ /dev/null @@ -1,17 +0,0 @@ -# SourceTrustpilotAuthorizationMethod - - -## Supported Types - -### SourceTrustpilotOAuth20 - -```python -sourceTrustpilotAuthorizationMethod: shared.SourceTrustpilotOAuth20 = /* values here */ -``` - -### SourceTrustpilotAPIKey - -```python -sourceTrustpilotAuthorizationMethod: shared.SourceTrustpilotAPIKey = /* values here */ -``` - diff --git a/docs/models/shared/sourcetrustpilotoauth20.md b/docs/models/shared/sourcetrustpilotoauth20.md deleted file mode 100644 index 936e36d6..00000000 --- a/docs/models/shared/sourcetrustpilotoauth20.md +++ /dev/null @@ -1,13 +0,0 @@ -# SourceTrustpilotOAuth20 - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `access_token` | *str* | :heavy_check_mark: | Access Token for making authenticated requests. | -| `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. | -| `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/sourcetwiliotaskrouter.md b/docs/models/shared/sourcetwiliotaskrouter.md deleted file mode 100644 index 96e273aa..00000000 --- a/docs/models/shared/sourcetwiliotaskrouter.md +++ /dev/null @@ -1,10 +0,0 @@ -# SourceTwilioTaskrouter - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `account_sid` | *str* | :heavy_check_mark: | Twilio Account ID | -| `auth_token` | *str* | :heavy_check_mark: | Twilio Auth Token | -| `source_type` | [shared.TwilioTaskrouter](../../models/shared/twiliotaskrouter.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcetypeformauthorizationmethod.md b/docs/models/shared/sourcetypeformauthorizationmethod.md deleted file mode 100644 index 3d6d0688..00000000 --- a/docs/models/shared/sourcetypeformauthorizationmethod.md +++ /dev/null @@ -1,17 +0,0 @@ -# SourceTypeformAuthorizationMethod - - -## Supported Types - -### SourceTypeformOAuth20 - -```python -sourceTypeformAuthorizationMethod: shared.SourceTypeformOAuth20 = /* values here */ -``` - -### SourceTypeformPrivateToken - -```python -sourceTypeformAuthorizationMethod: shared.SourceTypeformPrivateToken = /* values here */ -``` - diff --git a/docs/models/shared/sourcetypeformoauth20.md b/docs/models/shared/sourcetypeformoauth20.md deleted file mode 100644 index 56d45bc1..00000000 --- a/docs/models/shared/sourcetypeformoauth20.md +++ /dev/null @@ -1,13 +0,0 @@ -# SourceTypeformOAuth20 - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `access_token` | *str* | :heavy_check_mark: | Access Token for making authenticated requests. | -| `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. | -| `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/sourcetypeformprivatetoken.md b/docs/models/shared/sourcetypeformprivatetoken.md deleted file mode 100644 index b64acab8..00000000 --- a/docs/models/shared/sourcetypeformprivatetoken.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceTypeformPrivateToken - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `access_token` | *str* | :heavy_check_mark: | Log into your Typeform account and then generate a personal Access Token. | -| `auth_type` | [Optional[shared.SourceTypeformSchemasAuthType]](../../models/shared/sourcetypeformschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcewhiskyhunter.md b/docs/models/shared/sourcewhiskyhunter.md deleted file mode 100644 index 564412f6..00000000 --- a/docs/models/shared/sourcewhiskyhunter.md +++ /dev/null @@ -1,8 +0,0 @@ -# SourceWhiskyHunter - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `source_type` | [Optional[shared.WhiskyHunter]](../../models/shared/whiskyhunter.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcexkcd.md b/docs/models/shared/sourcexkcd.md deleted file mode 100644 index 153c6a71..00000000 --- a/docs/models/shared/sourcexkcd.md +++ /dev/null @@ -1,8 +0,0 @@ -# SourceXkcd - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `source_type` | [Optional[shared.Xkcd]](../../models/shared/xkcd.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceyoutubeanalytics.md b/docs/models/shared/sourceyoutubeanalytics.md deleted file mode 100644 index 2f80dfbd..00000000 --- a/docs/models/shared/sourceyoutubeanalytics.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceYoutubeAnalytics - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `credentials` | [shared.AuthenticateViaOAuth20](../../models/shared/authenticateviaoauth20.md) | :heavy_check_mark: | N/A | -| `source_type` | [shared.SourceYoutubeAnalyticsYoutubeAnalytics](../../models/shared/sourceyoutubeanalyticsyoutubeanalytics.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 deleted file mode 100644 index 8b9209ff..00000000 --- a/docs/models/shared/sourcezendeskchat.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceZendeskChat - - -## Fields - -| 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 | | -| `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/sourcezendeskchataccesstoken.md b/docs/models/shared/sourcezendeskchataccesstoken.md deleted file mode 100644 index d61471bc..00000000 --- a/docs/models/shared/sourcezendeskchataccesstoken.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceZendeskChatAccessToken - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `access_token` | *str* | :heavy_check_mark: | The Access Token to make authenticated requests. | -| `credentials` | [shared.SourceZendeskChatSchemasCredentials](../../models/shared/sourcezendeskchatschemascredentials.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcezendeskchatauthorizationmethod.md b/docs/models/shared/sourcezendeskchatauthorizationmethod.md deleted file mode 100644 index dddaf404..00000000 --- a/docs/models/shared/sourcezendeskchatauthorizationmethod.md +++ /dev/null @@ -1,17 +0,0 @@ -# SourceZendeskChatAuthorizationMethod - - -## Supported Types - -### SourceZendeskChatOAuth20 - -```python -sourceZendeskChatAuthorizationMethod: shared.SourceZendeskChatOAuth20 = /* values here */ -``` - -### SourceZendeskChatAccessToken - -```python -sourceZendeskChatAuthorizationMethod: shared.SourceZendeskChatAccessToken = /* values here */ -``` - diff --git a/docs/models/shared/sourcezendeskchatoauth20.md b/docs/models/shared/sourcezendeskchatoauth20.md deleted file mode 100644 index df8d75bc..00000000 --- a/docs/models/shared/sourcezendeskchatoauth20.md +++ /dev/null @@ -1,12 +0,0 @@ -# SourceZendeskChatOAuth20 - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `access_token` | *Optional[str]* | :heavy_minus_sign: | Access Token for making authenticated requests. | -| `client_id` | *Optional[str]* | :heavy_minus_sign: | The Client ID of your OAuth application | -| `client_secret` | *Optional[str]* | :heavy_minus_sign: | The Client Secret of your OAuth application. | -| `credentials` | [shared.SourceZendeskChatCredentials](../../models/shared/sourcezendeskchatcredentials.md) | :heavy_check_mark: | N/A | -| `refresh_token` | *Optional[str]* | :heavy_minus_sign: | Refresh Token to obtain new Access Token, when it's expired. | \ No newline at end of file diff --git a/docs/models/shared/sourcezendesksunshine.md b/docs/models/shared/sourcezendesksunshine.md deleted file mode 100644 index 64c505ea..00000000 --- a/docs/models/shared/sourcezendesksunshine.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceZendeskSunshine - - -## Fields - -| 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 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. | | -| `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/sourcezendesksunshineauthorizationmethod.md b/docs/models/shared/sourcezendesksunshineauthorizationmethod.md deleted file mode 100644 index 8e3034f4..00000000 --- a/docs/models/shared/sourcezendesksunshineauthorizationmethod.md +++ /dev/null @@ -1,17 +0,0 @@ -# SourceZendeskSunshineAuthorizationMethod - - -## Supported Types - -### SourceZendeskSunshineOAuth20 - -```python -sourceZendeskSunshineAuthorizationMethod: shared.SourceZendeskSunshineOAuth20 = /* values here */ -``` - -### SourceZendeskSunshineAPIToken - -```python -sourceZendeskSunshineAuthorizationMethod: shared.SourceZendeskSunshineAPIToken = /* values here */ -``` - diff --git a/docs/models/shared/sourcezendesksunshineoauth20.md b/docs/models/shared/sourcezendesksunshineoauth20.md deleted file mode 100644 index 9b9d7765..00000000 --- a/docs/models/shared/sourcezendesksunshineoauth20.md +++ /dev/null @@ -1,11 +0,0 @@ -# SourceZendeskSunshineOAuth20 - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `access_token` | *str* | :heavy_check_mark: | Long-term access Token for making authenticated requests. | -| `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_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/sourcezendesksupportauthentication.md b/docs/models/shared/sourcezendesksupportauthentication.md deleted file mode 100644 index 5b1a805d..00000000 --- a/docs/models/shared/sourcezendesksupportauthentication.md +++ /dev/null @@ -1,19 +0,0 @@ -# SourceZendeskSupportAuthentication - -Zendesk allows two authentication methods. We recommend using `OAuth2.0` for Airbyte Cloud users and `API token` for Airbyte Open Source users. - - -## Supported Types - -### SourceZendeskSupportOAuth20 - -```python -sourceZendeskSupportAuthentication: shared.SourceZendeskSupportOAuth20 = /* values here */ -``` - -### SourceZendeskSupportAPIToken - -```python -sourceZendeskSupportAuthentication: shared.SourceZendeskSupportAPIToken = /* values here */ -``` - diff --git a/docs/models/shared/sourcezendesktalkauthentication.md b/docs/models/shared/sourcezendesktalkauthentication.md deleted file mode 100644 index d3c13105..00000000 --- a/docs/models/shared/sourcezendesktalkauthentication.md +++ /dev/null @@ -1,19 +0,0 @@ -# SourceZendeskTalkAuthentication - -Zendesk service provides two authentication methods. Choose between: `OAuth2.0` or `API token`. - - -## Supported Types - -### SourceZendeskTalkAPIToken - -```python -sourceZendeskTalkAuthentication: shared.SourceZendeskTalkAPIToken = /* values here */ -``` - -### SourceZendeskTalkOAuth20 - -```python -sourceZendeskTalkAuthentication: shared.SourceZendeskTalkOAuth20 = /* values here */ -``` - diff --git a/docs/models/shared/sourcezendesktalkauthtype.md b/docs/models/shared/sourcezendesktalkauthtype.md deleted file mode 100644 index 42090da6..00000000 --- a/docs/models/shared/sourcezendesktalkauthtype.md +++ /dev/null @@ -1,8 +0,0 @@ -# SourceZendeskTalkAuthType - - -## Values - -| Name | Value | -| ----------- | ----------- | -| `API_TOKEN` | api_token | \ No newline at end of file diff --git a/docs/models/shared/sourcezendesktalkschemasauthtype.md b/docs/models/shared/sourcezendesktalkschemasauthtype.md deleted file mode 100644 index 862fecac..00000000 --- a/docs/models/shared/sourcezendesktalkschemasauthtype.md +++ /dev/null @@ -1,8 +0,0 @@ -# SourceZendeskTalkSchemasAuthType - - -## Values - -| Name | Value | -| ---------- | ---------- | -| `OAUTH2_0` | oauth2.0 | \ No newline at end of file diff --git a/docs/models/shared/sourcezoom.md b/docs/models/shared/sourcezoom.md deleted file mode 100644 index b4b54a83..00000000 --- a/docs/models/shared/sourcezoom.md +++ /dev/null @@ -1,9 +0,0 @@ -# SourceZoom - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `jwt_token` | *str* | :heavy_check_mark: | JWT Token | -| `source_type` | [shared.Zoom](../../models/shared/zoom.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sqlinserts.md b/docs/models/shared/sqlinserts.md deleted file mode 100644 index 3e8c9d35..00000000 --- a/docs/models/shared/sqlinserts.md +++ /dev/null @@ -1,8 +0,0 @@ -# SQLInserts - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `method` | [shared.DestinationFireboltMethod](../../models/shared/destinationfireboltmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/square.md b/docs/models/shared/square.md deleted file mode 100644 index 06ee092a..00000000 --- a/docs/models/shared/square.md +++ /dev/null @@ -1,8 +0,0 @@ -# Square - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `credentials` | [Optional[shared.SquareCredentials]](../../models/shared/squarecredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sshsecureshell.md b/docs/models/shared/sshsecureshell.md deleted file mode 100644 index 23a20873..00000000 --- a/docs/models/shared/sshsecureshell.md +++ /dev/null @@ -1,12 +0,0 @@ -# SSHSecureShell - - -## Fields - -| 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 | \ No newline at end of file diff --git a/docs/models/shared/sshtunnelmethod.md b/docs/models/shared/sshtunnelmethod.md deleted file mode 100644 index f8a391d3..00000000 --- a/docs/models/shared/sshtunnelmethod.md +++ /dev/null @@ -1,25 +0,0 @@ -# SSHTunnelMethod - -Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. - - -## Supported Types - -### NoTunnel - -```python -sshTunnelMethod: shared.NoTunnel = /* values here */ -``` - -### SSHKeyAuthentication - -```python -sshTunnelMethod: shared.SSHKeyAuthentication = /* values here */ -``` - -### PasswordAuthentication - -```python -sshTunnelMethod: shared.PasswordAuthentication = /* values here */ -``` - diff --git a/docs/models/shared/sslmethod.md b/docs/models/shared/sslmethod.md deleted file mode 100644 index 6eadc113..00000000 --- a/docs/models/shared/sslmethod.md +++ /dev/null @@ -1,19 +0,0 @@ -# SSLMethod - -The encryption method which is used to communicate with the database. - - -## Supported Types - -### EncryptedTrustServerCertificate - -```python -sslMethod: shared.EncryptedTrustServerCertificate = /* values here */ -``` - -### EncryptedVerifyCertificate - -```python -sslMethod: shared.EncryptedVerifyCertificate = /* values here */ -``` - diff --git a/docs/models/shared/standalonemongodbinstance.md b/docs/models/shared/standalonemongodbinstance.md deleted file mode 100644 index d4b1e924..00000000 --- a/docs/models/shared/standalonemongodbinstance.md +++ /dev/null @@ -1,10 +0,0 @@ -# StandaloneMongoDbInstance - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `host` | *str* | :heavy_check_mark: | The Host of a Mongo database to be replicated. | | -| `instance` | [Optional[shared.Instance]](../../models/shared/instance.md) | :heavy_minus_sign: | N/A | | -| `port` | *Optional[int]* | :heavy_minus_sign: | The Port of a Mongo database to be replicated. | 27017 | \ No newline at end of file diff --git a/docs/models/shared/standard.md b/docs/models/shared/standard.md deleted file mode 100644 index 7a1ba989..00000000 --- a/docs/models/shared/standard.md +++ /dev/null @@ -1,10 +0,0 @@ -# Standard - -(not recommended) Direct loading using SQL INSERT statements. This method is extremely inefficient and provided only for quick testing. In all other cases, you should use S3 uploading. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `method` | [shared.DestinationRedshiftSchemasMethod](../../models/shared/destinationredshiftschemasmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/standardinserts.md b/docs/models/shared/standardinserts.md deleted file mode 100644 index 72024313..00000000 --- a/docs/models/shared/standardinserts.md +++ /dev/null @@ -1,10 +0,0 @@ -# StandardInserts - -(not recommended) Direct loading using SQL INSERT statements. This method is extremely inefficient and provided only for quick testing. In all other cases, you should use GCS staging. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `method` | [shared.DestinationBigqueryMethod](../../models/shared/destinationbigquerymethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/storageprovider.md b/docs/models/shared/storageprovider.md deleted file mode 100644 index 0596982d..00000000 --- a/docs/models/shared/storageprovider.md +++ /dev/null @@ -1,49 +0,0 @@ -# StorageProvider - -The storage Provider or Location of the file(s) which should be replicated. - - -## Supported Types - -### HTTPSPublicWeb - -```python -storageProvider: shared.HTTPSPublicWeb = /* values here */ -``` - -### GCSGoogleCloudStorage - -```python -storageProvider: shared.GCSGoogleCloudStorage = /* values here */ -``` - -### SourceFileS3AmazonWebServices - -```python -storageProvider: shared.SourceFileS3AmazonWebServices = /* values here */ -``` - -### AzBlobAzureBlobStorage - -```python -storageProvider: shared.AzBlobAzureBlobStorage = /* values here */ -``` - -### SSHSecureShell - -```python -storageProvider: shared.SSHSecureShell = /* values here */ -``` - -### SCPSecureCopyProtocol - -```python -storageProvider: shared.SCPSecureCopyProtocol = /* values here */ -``` - -### SFTPSecureFileTransferProtocol - -```python -storageProvider: shared.SFTPSecureFileTransferProtocol = /* values here */ -``` - diff --git a/docs/models/shared/streamconfigurations.md b/docs/models/shared/streamconfigurations.md deleted file mode 100644 index a4b29752..00000000 --- a/docs/models/shared/streamconfigurations.md +++ /dev/null @@ -1,10 +0,0 @@ -# StreamConfigurations - -A list of configured stream options for a connection. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `streams` | List[[shared.StreamConfiguration](../../models/shared/streamconfiguration.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/streamproperties.md b/docs/models/shared/streamproperties.md deleted file mode 100644 index bf5bd7ca..00000000 --- a/docs/models/shared/streamproperties.md +++ /dev/null @@ -1,15 +0,0 @@ -# StreamProperties - -The stream properties associated with a connection. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `default_cursor_field` | List[*str*] | :heavy_minus_sign: | N/A | -| `property_fields` | List[List[*str*]] | :heavy_minus_sign: | N/A | -| `source_defined_cursor_field` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `source_defined_primary_key` | List[List[*str*]] | :heavy_minus_sign: | N/A | -| `stream_name` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `sync_modes` | List[[shared.ConnectionSyncModeEnum](../../models/shared/connectionsyncmodeenum.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/streampropertiesresponse.md b/docs/models/shared/streampropertiesresponse.md deleted file mode 100644 index 9c448f74..00000000 --- a/docs/models/shared/streampropertiesresponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# StreamPropertiesResponse - -A list of stream properties. - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `streams` | List[[shared.StreamProperties](../../models/shared/streamproperties.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 deleted file mode 100644 index ac7fada4..00000000 --- a/docs/models/shared/streamscriteria.md +++ /dev/null @@ -1,9 +0,0 @@ -# StreamsCriteria - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `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 deleted file mode 100644 index 965f5fc0..00000000 --- a/docs/models/shared/stringfilter.md +++ /dev/null @@ -1,11 +0,0 @@ -# StringFilter - - -## Fields - -| 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 | \ No newline at end of file diff --git a/docs/models/shared/surveymonkey.md b/docs/models/shared/surveymonkey.md deleted file mode 100644 index 61569ba4..00000000 --- a/docs/models/shared/surveymonkey.md +++ /dev/null @@ -1,8 +0,0 @@ -# Surveymonkey - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `credentials` | [Optional[shared.SurveymonkeyCredentials]](../../models/shared/surveymonkeycredentials.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 deleted file mode 100644 index 08aafd1e..00000000 --- a/docs/models/shared/systemidsid.md +++ /dev/null @@ -1,11 +0,0 @@ -# SystemIDSID - -Use SID (Oracle System Identifier) - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `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/testdestination.md b/docs/models/shared/testdestination.md deleted file mode 100644 index 8a2469a5..00000000 --- a/docs/models/shared/testdestination.md +++ /dev/null @@ -1,13 +0,0 @@ -# TestDestination - -The type of destination to be used - - -## Supported Types - -### Silent - -```python -testDestination: shared.Silent = /* values here */ -``` - diff --git a/docs/models/shared/textsplitter.md b/docs/models/shared/textsplitter.md deleted file mode 100644 index 660d21bf..00000000 --- a/docs/models/shared/textsplitter.md +++ /dev/null @@ -1,25 +0,0 @@ -# TextSplitter - -Split text fields into chunks based on the specified method. - - -## Supported Types - -### BySeparator - -```python -textSplitter: shared.BySeparator = /* values here */ -``` - -### ByMarkdownHeader - -```python -textSplitter: shared.ByMarkdownHeader = /* values here */ -``` - -### ByProgrammingLanguage - -```python -textSplitter: shared.ByProgrammingLanguage = /* values here */ -``` - diff --git a/docs/models/shared/tiktokmarketing.md b/docs/models/shared/tiktokmarketing.md deleted file mode 100644 index 6e809878..00000000 --- a/docs/models/shared/tiktokmarketing.md +++ /dev/null @@ -1,8 +0,0 @@ -# TiktokMarketing - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `credentials` | [Optional[shared.TiktokMarketingCredentials]](../../models/shared/tiktokmarketingcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/timeplus.md b/docs/models/shared/timeplus.md deleted file mode 100644 index 5c73c4c9..00000000 --- a/docs/models/shared/timeplus.md +++ /dev/null @@ -1,8 +0,0 @@ -# Timeplus - - -## Values - -| Name | Value | -| ---------- | ---------- | -| `TIMEPLUS` | timeplus | \ No newline at end of file diff --git a/docs/models/shared/tovalue.md b/docs/models/shared/tovalue.md deleted file mode 100644 index 388c48a7..00000000 --- a/docs/models/shared/tovalue.md +++ /dev/null @@ -1,17 +0,0 @@ -# ToValue - - -## Supported Types - -### SourceGoogleAnalyticsDataAPISchemasInt64Value - -```python -toValue: shared.SourceGoogleAnalyticsDataAPISchemasInt64Value = /* values here */ -``` - -### SourceGoogleAnalyticsDataAPISchemasDoubleValue - -```python -toValue: shared.SourceGoogleAnalyticsDataAPISchemasDoubleValue = /* values here */ -``` - diff --git a/docs/models/shared/typeform.md b/docs/models/shared/typeform.md deleted file mode 100644 index 0fd2d13c..00000000 --- a/docs/models/shared/typeform.md +++ /dev/null @@ -1,8 +0,0 @@ -# Typeform - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `credentials` | [Optional[shared.TypeformCredentials]](../../models/shared/typeformcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/unencrypted.md b/docs/models/shared/unencrypted.md deleted file mode 100644 index db09795e..00000000 --- a/docs/models/shared/unencrypted.md +++ /dev/null @@ -1,10 +0,0 @@ -# Unencrypted - -Data transfer will not be encrypted. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ssl_method` | [shared.SourceMssqlSchemasSslMethod](../../models/shared/sourcemssqlschemassslmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/updatemethod.md b/docs/models/shared/updatemethod.md deleted file mode 100644 index 83bda521..00000000 --- a/docs/models/shared/updatemethod.md +++ /dev/null @@ -1,19 +0,0 @@ -# UpdateMethod - -Configures how data is extracted from the database. - - -## Supported Types - -### ReadChangesUsingChangeDataCaptureCDC - -```python -updateMethod: shared.ReadChangesUsingChangeDataCaptureCDC = /* values here */ -``` - -### ScanChangesWithUserDefinedCursor - -```python -updateMethod: shared.ScanChangesWithUserDefinedCursor = /* values here */ -``` - diff --git a/docs/models/shared/uploadingmethod.md b/docs/models/shared/uploadingmethod.md deleted file mode 100644 index f3fa7aee..00000000 --- a/docs/models/shared/uploadingmethod.md +++ /dev/null @@ -1,19 +0,0 @@ -# UploadingMethod - -The way data will be uploaded to Redshift. - - -## Supported Types - -### AWSS3Staging - -```python -uploadingMethod: shared.AWSS3Staging = /* values here */ -``` - -### Standard - -```python -uploadingMethod: shared.Standard = /* values here */ -``` - diff --git a/docs/models/shared/usernameandpassword.md b/docs/models/shared/usernameandpassword.md deleted file mode 100644 index 427ad1ce..00000000 --- a/docs/models/shared/usernameandpassword.md +++ /dev/null @@ -1,9 +0,0 @@ -# UsernameAndPassword - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `password` | *str* | :heavy_check_mark: | Enter the password associated with the username. | -| `auth_type` | [Optional[shared.DestinationSnowflakeAuthType]](../../models/shared/destinationsnowflakeauthtype.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 deleted file mode 100644 index 29c57ddb..00000000 --- a/docs/models/shared/usernamepassword.md +++ /dev/null @@ -1,12 +0,0 @@ -# UsernamePassword - -Basic auth header with a username and password - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `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 | -| `method` | [shared.DestinationElasticsearchSchemasMethod](../../models/shared/destinationelasticsearchschemasmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/userprovided.md b/docs/models/shared/userprovided.md deleted file mode 100644 index 154a0eb5..00000000 --- a/docs/models/shared/userprovided.md +++ /dev/null @@ -1,9 +0,0 @@ -# UserProvided - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `column_names` | List[*str*] | :heavy_check_mark: | The column names that will be used while emitting the CSV records | -| `header_definition_type` | [Optional[shared.SourceAzureBlobStorageSchemasHeaderDefinitionType]](../../models/shared/sourceazureblobstorageschemasheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/value.md b/docs/models/shared/value.md deleted file mode 100644 index 6202b63f..00000000 --- a/docs/models/shared/value.md +++ /dev/null @@ -1,17 +0,0 @@ -# Value - - -## Supported Types - -### Int64Value - -```python -value: shared.Int64Value = /* values here */ -``` - -### DoubleValue - -```python -value: shared.DoubleValue = /* values here */ -``` - diff --git a/docs/models/shared/verifyca.md b/docs/models/shared/verifyca.md deleted file mode 100644 index c7c9a54f..00000000 --- a/docs/models/shared/verifyca.md +++ /dev/null @@ -1,12 +0,0 @@ -# VerifyCa - -Verify-ca SSL mode. - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `ca_certificate` | *str* | :heavy_check_mark: | CA certificate | -| `client_key_password` | *Optional[str]* | :heavy_minus_sign: | Password for keystorage. This field is optional. If you do not add it - the password will be generated automatically. | -| `mode` | [Optional[shared.DestinationPostgresSchemasSSLModeSSLModesMode]](../../models/shared/destinationpostgresschemassslmodesslmodesmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/verifyfull.md b/docs/models/shared/verifyfull.md deleted file mode 100644 index 0f47b323..00000000 --- a/docs/models/shared/verifyfull.md +++ /dev/null @@ -1,14 +0,0 @@ -# VerifyFull - -Verify-full SSL mode. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `ca_certificate` | *str* | :heavy_check_mark: | CA certificate | -| `client_certificate` | *str* | :heavy_check_mark: | Client certificate | -| `client_key` | *str* | :heavy_check_mark: | Client key | -| `client_key_password` | *Optional[str]* | :heavy_minus_sign: | Password for keystorage. This field is optional. If you do not add it - the password will be generated automatically. | -| `mode` | [Optional[shared.DestinationPostgresSchemasSSLModeSSLModes6Mode]](../../models/shared/destinationpostgresschemassslmodesslmodes6mode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/vertica.md b/docs/models/shared/vertica.md deleted file mode 100644 index 5c855f06..00000000 --- a/docs/models/shared/vertica.md +++ /dev/null @@ -1,8 +0,0 @@ -# Vertica - - -## Values - -| Name | Value | -| --------- | --------- | -| `VERTICA` | vertica | \ No newline at end of file diff --git a/docs/models/shared/workspaceresponse.md b/docs/models/shared/workspaceresponse.md deleted file mode 100644 index 7cc8720b..00000000 --- a/docs/models/shared/workspaceresponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# WorkspaceResponse - -Provides details of a single workspace. - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `name` | *str* | :heavy_check_mark: | N/A | -| `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/models/shared/workspacesresponse.md b/docs/models/shared/workspacesresponse.md deleted file mode 100644 index 70c8b164..00000000 --- a/docs/models/shared/workspacesresponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# WorkspacesResponse - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `data` | List[[shared.WorkspaceResponse](../../models/shared/workspaceresponse.md)] | :heavy_check_mark: | N/A | -| `next` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `previous` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/xata.md b/docs/models/shared/xata.md deleted file mode 100644 index fbbcccb9..00000000 --- a/docs/models/shared/xata.md +++ /dev/null @@ -1,8 +0,0 @@ -# Xata - - -## Values - -| Name | Value | -| ------ | ------ | -| `XATA` | xata | \ No newline at end of file diff --git a/docs/models/shared/youtubeanalytics.md b/docs/models/shared/youtubeanalytics.md deleted file mode 100644 index a2fe69c5..00000000 --- a/docs/models/shared/youtubeanalytics.md +++ /dev/null @@ -1,8 +0,0 @@ -# YoutubeAnalytics - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `credentials` | [Optional[shared.YoutubeAnalyticsCredentials]](../../models/shared/youtubeanalyticscredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/zendeskchat.md b/docs/models/shared/zendeskchat.md deleted file mode 100644 index 23b33587..00000000 --- a/docs/models/shared/zendeskchat.md +++ /dev/null @@ -1,8 +0,0 @@ -# ZendeskChat - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `credentials` | [Optional[shared.ZendeskChatCredentials]](../../models/shared/zendeskchatcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/zendesksunshine.md b/docs/models/shared/zendesksunshine.md deleted file mode 100644 index dcb4b3a2..00000000 --- a/docs/models/shared/zendesksunshine.md +++ /dev/null @@ -1,8 +0,0 @@ -# ZendeskSunshine - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `credentials` | [Optional[shared.ZendeskSunshineCredentials]](../../models/shared/zendesksunshinecredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/zendesksupport.md b/docs/models/shared/zendesksupport.md deleted file mode 100644 index 71ed0ea2..00000000 --- a/docs/models/shared/zendesksupport.md +++ /dev/null @@ -1,8 +0,0 @@ -# ZendeskSupport - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `credentials` | [Optional[shared.ZendeskSupportCredentials]](../../models/shared/zendesksupportcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/zendesktalk.md b/docs/models/shared/zendesktalk.md deleted file mode 100644 index b9e38290..00000000 --- a/docs/models/shared/zendesktalk.md +++ /dev/null @@ -1,8 +0,0 @@ -# ZendeskTalk - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `credentials` | [Optional[shared.ZendeskTalkCredentials]](../../models/shared/zendesktalkcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sharetypeusedformostpopularsharedstream.md b/docs/models/sharetypeusedformostpopularsharedstream.md similarity index 100% rename from docs/models/shared/sharetypeusedformostpopularsharedstream.md rename to docs/models/sharetypeusedformostpopularsharedstream.md diff --git a/docs/models/shopify.md b/docs/models/shopify.md new file mode 100644 index 00000000..bd2f89a5 --- /dev/null +++ b/docs/models/shopify.md @@ -0,0 +1,8 @@ +# Shopify + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `credentials` | [Optional[models.ShopifyCredentials]](../models/shopifycredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shopifyauthorizationmethod.md b/docs/models/shopifyauthorizationmethod.md new file mode 100644 index 00000000..933af2a7 --- /dev/null +++ b/docs/models/shopifyauthorizationmethod.md @@ -0,0 +1,19 @@ +# ShopifyAuthorizationMethod + +The authorization method to use to retrieve data from Shopify + + +## Supported Types + +### SourceShopifyOAuth20 + +```python +shopifyAuthorizationMethod: models.SourceShopifyOAuth20 = /* values here */ +``` + +### APIPassword + +```python +shopifyAuthorizationMethod: models.APIPassword = /* values here */ +``` + diff --git a/docs/models/shared/shopifycredentials.md b/docs/models/shopifycredentials.md similarity index 100% rename from docs/models/shared/shopifycredentials.md rename to docs/models/shopifycredentials.md diff --git a/docs/models/shared/shortio.md b/docs/models/shortio.md similarity index 100% rename from docs/models/shared/shortio.md rename to docs/models/shortio.md diff --git a/docs/models/signinviagoogleoauth.md b/docs/models/signinviagoogleoauth.md new file mode 100644 index 00000000..9aa5986d --- /dev/null +++ b/docs/models/signinviagoogleoauth.md @@ -0,0 +1,13 @@ +# SignInViaGoogleOAuth + +For these scenario user only needs to give permission to read Google Directory data. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `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. | +| `refresh_token` | *str* | :heavy_check_mark: | The Token for obtaining a new access token. | +| `credentials_title` | [Optional[models.SourceGoogleDirectoryCredentialsTitle]](../models/sourcegoogledirectorycredentialstitle.md) | :heavy_minus_sign: | Authentication Scenario | \ No newline at end of file diff --git a/docs/models/shared/signinviaslackoauth.md b/docs/models/signinviaslackoauth.md similarity index 96% rename from docs/models/shared/signinviaslackoauth.md rename to docs/models/signinviaslackoauth.md index b07a2f56..bd68a508 100644 --- a/docs/models/shared/signinviaslackoauth.md +++ b/docs/models/signinviaslackoauth.md @@ -8,4 +8,4 @@ | `access_token` | *str* | :heavy_check_mark: | Slack access_token. See our docs if you need help generating the token. | | `client_id` | *str* | :heavy_check_mark: | Slack client_id. See our docs if you need help finding this id. | | `client_secret` | *str* | :heavy_check_mark: | Slack client_secret. See our docs if you need help finding this secret. | -| `option_title` | [shared.SourceSlackOptionTitle](../../models/shared/sourceslackoptiontitle.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `option_title` | [models.SourceSlackOptionTitle](../models/sourceslackoptiontitle.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/silent.md b/docs/models/silent.md new file mode 100644 index 00000000..6c70a3fd --- /dev/null +++ b/docs/models/silent.md @@ -0,0 +1,8 @@ +# Silent + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `test_destination_type` | [Optional[models.TestDestinationType]](../models/testdestinationtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/singleschema.md b/docs/models/singleschema.md similarity index 97% rename from docs/models/shared/singleschema.md rename to docs/models/singleschema.md index 016e549a..5a38f24d 100644 --- a/docs/models/shared/singleschema.md +++ b/docs/models/singleschema.md @@ -10,4 +10,4 @@ A catalog with one or multiple streams that share the same schema. | `stream_duplication` | *Optional[int]* | :heavy_minus_sign: | Duplicate the stream for easy load testing. Each stream name will have a number suffix. For example, if the stream name is "ds", the duplicated streams will be "ds_0", "ds_1", etc. | | `stream_name` | *Optional[str]* | :heavy_minus_sign: | Name of the data stream. | | `stream_schema` | *Optional[str]* | :heavy_minus_sign: | A Json schema for the stream. The schema should be compatible with draft-07. See this doc for examples. | -| `type` | [Optional[shared.SourceE2eTestCloudSchemasType]](../../models/shared/sourcee2etestcloudschemastype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | [Optional[models.SourceE2eTestCloudSchemasType]](../models/sourcee2etestcloudschemastype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/singlestoreaccesstoken.md b/docs/models/singlestoreaccesstoken.md similarity index 95% rename from docs/models/shared/singlestoreaccesstoken.md rename to docs/models/singlestoreaccesstoken.md index ae58f6cb..c04bba87 100644 --- a/docs/models/shared/singlestoreaccesstoken.md +++ b/docs/models/singlestoreaccesstoken.md @@ -7,4 +7,4 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `access_token` | *str* | :heavy_check_mark: | Access Token for making authenticated requests. | | `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 +| `auth_type` | [models.SourceCartSchemasAuthType](../models/sourcecartschemasauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/slack.md b/docs/models/slack.md new file mode 100644 index 00000000..acd0ff2d --- /dev/null +++ b/docs/models/slack.md @@ -0,0 +1,8 @@ +# Slack + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `credentials` | [Optional[models.SlackCredentials]](../models/slackcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/slackcredentials.md b/docs/models/slackcredentials.md similarity index 100% rename from docs/models/shared/slackcredentials.md rename to docs/models/slackcredentials.md diff --git a/docs/models/shared/smaily.md b/docs/models/smaily.md similarity index 100% rename from docs/models/shared/smaily.md rename to docs/models/smaily.md diff --git a/docs/models/shared/smartengage.md b/docs/models/smartengage.md similarity index 100% rename from docs/models/shared/smartengage.md rename to docs/models/smartengage.md diff --git a/docs/models/smartsheets.md b/docs/models/smartsheets.md new file mode 100644 index 00000000..ac75c6fc --- /dev/null +++ b/docs/models/smartsheets.md @@ -0,0 +1,8 @@ +# Smartsheets + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `credentials` | [Optional[models.SmartsheetsCredentials]](../models/smartsheetscredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/smartsheetscredentials.md b/docs/models/smartsheetscredentials.md similarity index 100% rename from docs/models/shared/smartsheetscredentials.md rename to docs/models/smartsheetscredentials.md diff --git a/docs/models/shared/snapchatmarketing.md b/docs/models/snapchatmarketing.md similarity index 100% rename from docs/models/shared/snapchatmarketing.md rename to docs/models/snapchatmarketing.md diff --git a/docs/models/snappy.md b/docs/models/snappy.md new file mode 100644 index 00000000..541ddf80 --- /dev/null +++ b/docs/models/snappy.md @@ -0,0 +1,8 @@ +# Snappy + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `codec` | [Optional[models.DestinationGcsSchemasFormatOutputFormat1Codec]](../models/destinationgcsschemasformatoutputformat1codec.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/snowflake.md b/docs/models/snowflake.md new file mode 100644 index 00000000..989bcfdb --- /dev/null +++ b/docs/models/snowflake.md @@ -0,0 +1,8 @@ +# Snowflake + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `credentials` | [Optional[models.SnowflakeCredentials]](../models/snowflakecredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/snowflakecredentials.md b/docs/models/snowflakecredentials.md similarity index 100% rename from docs/models/shared/snowflakecredentials.md rename to docs/models/snowflakecredentials.md diff --git a/docs/models/shared/sonarcloud.md b/docs/models/sonarcloud.md similarity index 100% rename from docs/models/shared/sonarcloud.md rename to docs/models/sonarcloud.md diff --git a/docs/models/shared/sortby.md b/docs/models/sortby.md similarity index 100% rename from docs/models/shared/sortby.md rename to docs/models/sortby.md diff --git a/docs/models/sourceaha.md b/docs/models/sourceaha.md new file mode 100644 index 00000000..fa60a8e9 --- /dev/null +++ b/docs/models/sourceaha.md @@ -0,0 +1,10 @@ +# SourceAha + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `api_key` | *str* | :heavy_check_mark: | API Key | +| `url` | *str* | :heavy_check_mark: | URL | +| `source_type` | [models.Aha](../models/aha.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceaircall.md b/docs/models/sourceaircall.md similarity index 95% rename from docs/models/shared/sourceaircall.md rename to docs/models/sourceaircall.md index f6b55284..1aae8672 100644 --- a/docs/models/shared/sourceaircall.md +++ b/docs/models/sourceaircall.md @@ -8,4 +8,4 @@ | `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) | | | `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 +| `source_type` | [models.Aircall](../models/aircall.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/sourceairtable.md b/docs/models/sourceairtable.md new file mode 100644 index 00000000..42b2af98 --- /dev/null +++ b/docs/models/sourceairtable.md @@ -0,0 +1,9 @@ +# SourceAirtable + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `credentials` | [Optional[Union[models.SourceAirtableOAuth20, models.PersonalAccessToken]]](../models/sourceairtableauthentication.md) | :heavy_minus_sign: | N/A | +| `source_type` | [Optional[models.SourceAirtableAirtable]](../models/sourceairtableairtable.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceairtableairtable.md b/docs/models/sourceairtableairtable.md similarity index 100% rename from docs/models/shared/sourceairtableairtable.md rename to docs/models/sourceairtableairtable.md diff --git a/docs/models/sourceairtableauthentication.md b/docs/models/sourceairtableauthentication.md new file mode 100644 index 00000000..3c196e14 --- /dev/null +++ b/docs/models/sourceairtableauthentication.md @@ -0,0 +1,17 @@ +# SourceAirtableAuthentication + + +## Supported Types + +### SourceAirtableOAuth20 + +```python +sourceAirtableAuthentication: models.SourceAirtableOAuth20 = /* values here */ +``` + +### PersonalAccessToken + +```python +sourceAirtableAuthentication: models.PersonalAccessToken = /* values here */ +``` + diff --git a/docs/models/shared/sourceairtableauthmethod.md b/docs/models/sourceairtableauthmethod.md similarity index 100% rename from docs/models/shared/sourceairtableauthmethod.md rename to docs/models/sourceairtableauthmethod.md diff --git a/docs/models/sourceairtableoauth20.md b/docs/models/sourceairtableoauth20.md new file mode 100644 index 00000000..192c56b3 --- /dev/null +++ b/docs/models/sourceairtableoauth20.md @@ -0,0 +1,13 @@ +# SourceAirtableOAuth20 + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `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[models.SourceAirtableSchemasAuthMethod]](../models/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/sourceairtableschemasauthmethod.md b/docs/models/sourceairtableschemasauthmethod.md similarity index 100% rename from docs/models/shared/sourceairtableschemasauthmethod.md rename to docs/models/sourceairtableschemasauthmethod.md diff --git a/docs/models/shared/sourceamazonads.md b/docs/models/sourceamazonads.md similarity index 97% rename from docs/models/shared/sourceamazonads.md rename to docs/models/sourceamazonads.md index 25a40821..2cf20622 100644 --- a/docs/models/shared/sourceamazonads.md +++ b/docs/models/sourceamazonads.md @@ -8,12 +8,12 @@ | `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 | | +| `auth_type` | [Optional[models.SourceAmazonAdsAuthType]](../models/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. | | -| `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 | | +| `region` | [Optional[models.Region]](../models/region.md) | :heavy_minus_sign: | Region to pull data from (EU/NA/FE). See docs for more details. | | +| `report_record_types` | List[[models.ReportRecordTypes](../models/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` | [models.SourceAmazonAdsAmazonAds](../models/sourceamazonadsamazonads.md) | :heavy_check_mark: | N/A | | | `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The Start date for collecting reports, should not be more than 60 days in the past. In YYYY-MM-DD format | 2022-10-10 | -| `state_filter` | List[[shared.StateFilter](../../models/shared/statefilter.md)] | :heavy_minus_sign: | Reflects the state of the Display, Product, and Brand Campaign streams as enabled, paused, or archived. If you do not populate this field, it will be ignored completely. | | \ No newline at end of file +| `state_filter` | List[[models.StateFilter](../models/statefilter.md)] | :heavy_minus_sign: | Reflects the state of the Display, Product, and Brand Campaign streams as enabled, paused, or archived. If you do not populate this field, it will be ignored completely. | | \ No newline at end of file diff --git a/docs/models/shared/sourceamazonadsamazonads.md b/docs/models/sourceamazonadsamazonads.md similarity index 100% rename from docs/models/shared/sourceamazonadsamazonads.md rename to docs/models/sourceamazonadsamazonads.md diff --git a/docs/models/shared/sourceamazonadsauthtype.md b/docs/models/sourceamazonadsauthtype.md similarity index 100% rename from docs/models/shared/sourceamazonadsauthtype.md rename to docs/models/sourceamazonadsauthtype.md diff --git a/docs/models/shared/sourceamazonsellerpartner.md b/docs/models/sourceamazonsellerpartner.md similarity index 94% rename from docs/models/shared/sourceamazonsellerpartner.md rename to docs/models/sourceamazonsellerpartner.md index d8f802b5..12bff9ee 100644 --- a/docs/models/shared/sourceamazonsellerpartner.md +++ b/docs/models/sourceamazonsellerpartner.md @@ -8,12 +8,12 @@ | `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. | | +| `account_type` | [Optional[models.AWSSellerPartnerAccountType]](../models/awssellerpartneraccounttype.md) | :heavy_minus_sign: | Type of the Account you're going to authorize the Airbyte application by | | +| `auth_type` | [Optional[models.SourceAmazonSellerPartnerAuthType]](../models/sourceamazonsellerpartnerauthtype.md) | :heavy_minus_sign: | N/A | | +| `aws_environment` | [Optional[models.AWSEnvironment]](../models/awsenvironment.md) | :heavy_minus_sign: | Select the AWS Environment. | | | `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. | | -| `region` | [Optional[shared.AWSRegion]](../../models/shared/awsregion.md) | :heavy_minus_sign: | Select the AWS Region. | | +| `region` | [Optional[models.AWSRegion]](../models/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 | -| `report_options_list` | List[[shared.ReportOptions](../../models/shared/reportoptions.md)] | :heavy_minus_sign: | Additional information passed to reports. This varies by report type. | | -| `source_type` | [shared.SourceAmazonSellerPartnerAmazonSellerPartner](../../models/shared/sourceamazonsellerpartneramazonsellerpartner.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `report_options_list` | List[[models.ReportOptions](../models/reportoptions.md)] | :heavy_minus_sign: | Additional information passed to reports. This varies by report type. | | +| `source_type` | [models.SourceAmazonSellerPartnerAmazonSellerPartner](../models/sourceamazonsellerpartneramazonsellerpartner.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceamazonsellerpartneramazonsellerpartner.md b/docs/models/sourceamazonsellerpartneramazonsellerpartner.md similarity index 100% rename from docs/models/shared/sourceamazonsellerpartneramazonsellerpartner.md rename to docs/models/sourceamazonsellerpartneramazonsellerpartner.md diff --git a/docs/models/shared/sourceamazonsellerpartnerauthtype.md b/docs/models/sourceamazonsellerpartnerauthtype.md similarity index 100% rename from docs/models/shared/sourceamazonsellerpartnerauthtype.md rename to docs/models/sourceamazonsellerpartnerauthtype.md diff --git a/docs/models/shared/sourceamazonsqs.md b/docs/models/sourceamazonsqs.md similarity index 98% rename from docs/models/shared/sourceamazonsqs.md rename to docs/models/sourceamazonsqs.md index b9f95a15..fb920dd6 100644 --- a/docs/models/shared/sourceamazonsqs.md +++ b/docs/models/sourceamazonsqs.md @@ -6,12 +6,12 @@ | 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 | | +| `region` | [models.SourceAmazonSqsAWSRegion](../models/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 | | `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 | | +| `source_type` | [models.AmazonSqs](../models/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/sourceamazonsqsawsregion.md b/docs/models/sourceamazonsqsawsregion.md similarity index 100% rename from docs/models/shared/sourceamazonsqsawsregion.md rename to docs/models/sourceamazonsqsawsregion.md diff --git a/docs/models/shared/sourceamplitude.md b/docs/models/sourceamplitude.md similarity index 97% rename from docs/models/shared/sourceamplitude.md rename to docs/models/sourceamplitude.md index de0602df..78462d9d 100644 --- a/docs/models/shared/sourceamplitude.md +++ b/docs/models/sourceamplitude.md @@ -8,6 +8,6 @@ | `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 | | +| `data_region` | [Optional[models.DataRegion]](../models/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. | | -| `source_type` | [shared.Amplitude](../../models/shared/amplitude.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `source_type` | [models.Amplitude](../models/amplitude.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceapifydataset.md b/docs/models/sourceapifydataset.md similarity index 98% rename from docs/models/shared/sourceapifydataset.md rename to docs/models/sourceapifydataset.md index e68ec127..38d4793d 100644 --- a/docs/models/shared/sourceapifydataset.md +++ b/docs/models/sourceapifydataset.md @@ -7,4 +7,4 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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 | | `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 +| `source_type` | [models.ApifyDataset](../models/apifydataset.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/sourceappfollow.md b/docs/models/sourceappfollow.md new file mode 100644 index 00000000..5b8b5c46 --- /dev/null +++ b/docs/models/sourceappfollow.md @@ -0,0 +1,9 @@ +# SourceAppfollow + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | +| `api_secret` | *Optional[str]* | :heavy_minus_sign: | API Key provided by Appfollow | +| `source_type` | [models.Appfollow](../models/appfollow.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourceasana.md b/docs/models/sourceasana.md new file mode 100644 index 00000000..05a0bd4b --- /dev/null +++ b/docs/models/sourceasana.md @@ -0,0 +1,11 @@ +# SourceAsana + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| `credentials` | [Optional[Union[models.AuthenticateViaAsanaOauth, models.AuthenticateWithPersonalAccessToken]]](../models/authenticationmechanism.md) | :heavy_minus_sign: | Choose how to authenticate to Github | +| `organization_export_ids` | List[*Any*] | :heavy_minus_sign: | Globally unique identifiers for the organization exports | +| `source_type` | [Optional[models.SourceAsanaAsana]](../models/sourceasanaasana.md) | :heavy_minus_sign: | N/A | +| `test_mode` | *Optional[bool]* | :heavy_minus_sign: | This flag is used for testing purposes for certain streams that return a lot of data. This flag is not meant to be enabled for prod. | \ No newline at end of file diff --git a/docs/models/shared/sourceasanaasana.md b/docs/models/sourceasanaasana.md similarity index 100% rename from docs/models/shared/sourceasanaasana.md rename to docs/models/sourceasanaasana.md diff --git a/docs/models/shared/sourceasanacredentialstitle.md b/docs/models/sourceasanacredentialstitle.md similarity index 100% rename from docs/models/shared/sourceasanacredentialstitle.md rename to docs/models/sourceasanacredentialstitle.md diff --git a/docs/models/shared/sourceasanaschemascredentialstitle.md b/docs/models/sourceasanaschemascredentialstitle.md similarity index 100% rename from docs/models/shared/sourceasanaschemascredentialstitle.md rename to docs/models/sourceasanaschemascredentialstitle.md diff --git a/docs/models/shared/sourceauth0.md b/docs/models/sourceauth0.md similarity index 93% rename from docs/models/shared/sourceauth0.md rename to docs/models/sourceauth0.md index 0779f51d..6a1b7a09 100644 --- a/docs/models/shared/sourceauth0.md +++ b/docs/models/sourceauth0.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | `base_url` | *str* | :heavy_check_mark: | The Authentication API is served over HTTPS. All URLs referenced in the documentation have the following base `https://YOUR_DOMAIN` | https://dev-yourOrg.us.auth0.com/ | -| `credentials` | [Union[shared.OAuth2ConfidentialApplication, shared.OAuth2AccessToken]](../../models/shared/sourceauth0authenticationmethod.md) | :heavy_check_mark: | N/A | | -| `source_type` | [shared.Auth0](../../models/shared/auth0.md) | :heavy_check_mark: | N/A | | +| `credentials` | [Union[models.OAuth2ConfidentialApplication, models.OAuth2AccessToken]](../models/sourceauth0authenticationmethod.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.Auth0](../models/auth0.md) | :heavy_check_mark: | N/A | | | `start_date` | *Optional[str]* | :heavy_minus_sign: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. | 2023-08-05T00:43:59.244Z | \ No newline at end of file diff --git a/docs/models/sourceauth0authenticationmethod.md b/docs/models/sourceauth0authenticationmethod.md new file mode 100644 index 00000000..e13064b9 --- /dev/null +++ b/docs/models/sourceauth0authenticationmethod.md @@ -0,0 +1,17 @@ +# SourceAuth0AuthenticationMethod + + +## Supported Types + +### OAuth2ConfidentialApplication + +```python +sourceAuth0AuthenticationMethod: models.OAuth2ConfidentialApplication = /* values here */ +``` + +### OAuth2AccessToken + +```python +sourceAuth0AuthenticationMethod: models.OAuth2AccessToken = /* values here */ +``` + diff --git a/docs/models/shared/sourceauth0schemasauthenticationmethod.md b/docs/models/sourceauth0schemasauthenticationmethod.md similarity index 100% rename from docs/models/shared/sourceauth0schemasauthenticationmethod.md rename to docs/models/sourceauth0schemasauthenticationmethod.md diff --git a/docs/models/shared/sourceauth0schemascredentialsauthenticationmethod.md b/docs/models/sourceauth0schemascredentialsauthenticationmethod.md similarity index 100% rename from docs/models/shared/sourceauth0schemascredentialsauthenticationmethod.md rename to docs/models/sourceauth0schemascredentialsauthenticationmethod.md diff --git a/docs/models/shared/sourceawscloudtrail.md b/docs/models/sourceawscloudtrail.md similarity index 97% rename from docs/models/shared/sourceawscloudtrail.md rename to docs/models/sourceawscloudtrail.md index a05d2e77..335449fa 100644 --- a/docs/models/shared/sourceawscloudtrail.md +++ b/docs/models/sourceawscloudtrail.md @@ -8,5 +8,5 @@ | `aws_key_id` | *str* | :heavy_check_mark: | AWS CloudTrail Access Key ID. See the docs for more information on how to obtain this key. | | | `aws_region_name` | *str* | :heavy_check_mark: | The default AWS Region to use, for example, us-west-1 or us-west-2. When specifying a Region inline during client initialization, this property is named region_name. | | | `aws_secret_key` | *str* | :heavy_check_mark: | AWS CloudTrail Access Key ID. See the docs for more information on how to obtain this key. | | -| `source_type` | [shared.AwsCloudtrail](../../models/shared/awscloudtrail.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.AwsCloudtrail](../models/awscloudtrail.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. Data in AWS CloudTrail is available for last 90 days only. Format: YYYY-MM-DD. | 2021-01-01 | \ No newline at end of file diff --git a/docs/models/shared/sourceazureblobstorage.md b/docs/models/sourceazureblobstorage.md similarity index 97% rename from docs/models/shared/sourceazureblobstorage.md rename to docs/models/sourceazureblobstorage.md index d8407a60..ffa33aa1 100644 --- a/docs/models/shared/sourceazureblobstorage.md +++ b/docs/models/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. | | +| `streams` | List[[models.FileBasedStreamConfig](../models/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 | | +| `source_type` | [models.SourceAzureBlobStorageAzureBlobStorage](../models/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 | \ No newline at end of file diff --git a/docs/models/shared/sourceazureblobstorageazureblobstorage.md b/docs/models/sourceazureblobstorageazureblobstorage.md similarity index 100% rename from docs/models/shared/sourceazureblobstorageazureblobstorage.md rename to docs/models/sourceazureblobstorageazureblobstorage.md diff --git a/docs/models/shared/sourceazureblobstoragefiletype.md b/docs/models/sourceazureblobstoragefiletype.md similarity index 100% rename from docs/models/shared/sourceazureblobstoragefiletype.md rename to docs/models/sourceazureblobstoragefiletype.md diff --git a/docs/models/shared/sourceazureblobstorageheaderdefinitiontype.md b/docs/models/sourceazureblobstorageheaderdefinitiontype.md similarity index 100% rename from docs/models/shared/sourceazureblobstorageheaderdefinitiontype.md rename to docs/models/sourceazureblobstorageheaderdefinitiontype.md diff --git a/docs/models/shared/sourceazureblobstoragemode.md b/docs/models/sourceazureblobstoragemode.md similarity index 100% rename from docs/models/shared/sourceazureblobstoragemode.md rename to docs/models/sourceazureblobstoragemode.md diff --git a/docs/models/shared/sourceazureblobstorageschemasfiletype.md b/docs/models/sourceazureblobstorageschemasfiletype.md similarity index 100% rename from docs/models/shared/sourceazureblobstorageschemasfiletype.md rename to docs/models/sourceazureblobstorageschemasfiletype.md diff --git a/docs/models/shared/sourceazureblobstorageschemasheaderdefinitiontype.md b/docs/models/sourceazureblobstorageschemasheaderdefinitiontype.md similarity index 100% rename from docs/models/shared/sourceazureblobstorageschemasheaderdefinitiontype.md rename to docs/models/sourceazureblobstorageschemasheaderdefinitiontype.md diff --git a/docs/models/shared/sourceazureblobstorageschemasstreamsfiletype.md b/docs/models/sourceazureblobstorageschemasstreamsfiletype.md similarity index 100% rename from docs/models/shared/sourceazureblobstorageschemasstreamsfiletype.md rename to docs/models/sourceazureblobstorageschemasstreamsfiletype.md diff --git a/docs/models/shared/sourceazureblobstorageschemasstreamsformatfiletype.md b/docs/models/sourceazureblobstorageschemasstreamsformatfiletype.md similarity index 100% rename from docs/models/shared/sourceazureblobstorageschemasstreamsformatfiletype.md rename to docs/models/sourceazureblobstorageschemasstreamsformatfiletype.md diff --git a/docs/models/shared/sourceazureblobstorageschemasstreamsformatformatfiletype.md b/docs/models/sourceazureblobstorageschemasstreamsformatformatfiletype.md similarity index 100% rename from docs/models/shared/sourceazureblobstorageschemasstreamsformatformatfiletype.md rename to docs/models/sourceazureblobstorageschemasstreamsformatformatfiletype.md diff --git a/docs/models/shared/sourceazuretable.md b/docs/models/sourceazuretable.md similarity index 98% rename from docs/models/shared/sourceazuretable.md rename to docs/models/sourceazuretable.md index 49ff7ded..87e76bf6 100644 --- a/docs/models/shared/sourceazuretable.md +++ b/docs/models/sourceazuretable.md @@ -7,5 +7,5 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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 | | +| `source_type` | [models.AzureTable](../models/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/sourcebamboohr.md similarity index 96% rename from docs/models/shared/sourcebamboohr.md rename to docs/models/sourcebamboohr.md index c2381cb3..257a944e 100644 --- a/docs/models/shared/sourcebamboohr.md +++ b/docs/models/sourcebamboohr.md @@ -9,4 +9,4 @@ | `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 | \ No newline at end of file +| `source_type` | [models.BambooHr](../models/bamboohr.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcebigquery.md b/docs/models/sourcebigquery.md similarity index 97% rename from docs/models/shared/sourcebigquery.md rename to docs/models/sourcebigquery.md index 542225cb..2ac14a6b 100644 --- a/docs/models/shared/sourcebigquery.md +++ b/docs/models/sourcebigquery.md @@ -8,4 +8,4 @@ | `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. | | `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 +| `source_type` | [models.SourceBigqueryBigquery](../models/sourcebigquerybigquery.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcebigquerybigquery.md b/docs/models/sourcebigquerybigquery.md similarity index 100% rename from docs/models/shared/sourcebigquerybigquery.md rename to docs/models/sourcebigquerybigquery.md diff --git a/docs/models/shared/sourcebingads.md b/docs/models/sourcebingads.md similarity index 96% rename from docs/models/shared/sourcebingads.md rename to docs/models/sourcebingads.md index c7ce408b..4defe26f 100644 --- a/docs/models/shared/sourcebingads.md +++ b/docs/models/sourcebingads.md @@ -8,11 +8,11 @@ | `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 | +| `account_names` | List[[models.AccountNames](../models/accountnames.md)] | :heavy_minus_sign: | Predicates that will be used to sync data by specific accounts. | +| `auth_method` | [Optional[models.AuthMethod]](../models/authmethod.md) | :heavy_minus_sign: | N/A | | `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. | +| `custom_reports` | List[[models.CustomReportConfig](../models/customreportconfig.md)] | :heavy_minus_sign: | You can add your Custom Bing Ads report by creating one. | | `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. | | `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 | +| `source_type` | [models.SourceBingAdsBingAds](../models/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/sourcebingadsbingads.md b/docs/models/sourcebingadsbingads.md similarity index 100% rename from docs/models/shared/sourcebingadsbingads.md rename to docs/models/sourcebingadsbingads.md diff --git a/docs/models/shared/sourcebraintree.md b/docs/models/sourcebraintree.md similarity index 95% rename from docs/models/shared/sourcebraintree.md rename to docs/models/sourcebraintree.md index baa8c248..a5574fb9 100644 --- a/docs/models/shared/sourcebraintree.md +++ b/docs/models/sourcebraintree.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `environment` | [shared.SourceBraintreeEnvironment](../../models/shared/sourcebraintreeenvironment.md) | :heavy_check_mark: | Environment specifies where the data will come from. | sandbox | +| `environment` | [models.SourceBraintreeEnvironment](../models/sourcebraintreeenvironment.md) | :heavy_check_mark: | Environment specifies where the data will come from. | sandbox | | `merchant_id` | *str* | :heavy_check_mark: | The unique identifier for your entire gateway account. See the docs for more information on how to obtain this ID. | | | `private_key` | *str* | :heavy_check_mark: | Braintree Private Key. See the docs for more information on how to obtain this key. | | | `public_key` | *str* | :heavy_check_mark: | Braintree Public Key. See the docs for more information on how to obtain this key. | | -| `source_type` | [shared.Braintree](../../models/shared/braintree.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.Braintree](../models/braintree.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:00Z. Any data before this date will not be replicated. | 2020 | \ No newline at end of file diff --git a/docs/models/shared/sourcebraintreeenvironment.md b/docs/models/sourcebraintreeenvironment.md similarity index 100% rename from docs/models/shared/sourcebraintreeenvironment.md rename to docs/models/sourcebraintreeenvironment.md diff --git a/docs/models/shared/sourcebraze.md b/docs/models/sourcebraze.md similarity index 96% rename from docs/models/shared/sourcebraze.md rename to docs/models/sourcebraze.md index 932e1c41..f4bf7047 100644 --- a/docs/models/shared/sourcebraze.md +++ b/docs/models/sourcebraze.md @@ -8,4 +8,4 @@ | `api_key` | *str* | :heavy_check_mark: | Braze REST API key | | `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 | -| `source_type` | [shared.Braze](../../models/shared/braze.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `source_type` | [models.Braze](../models/braze.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcecart.md b/docs/models/sourcecart.md new file mode 100644 index 00000000..87fbc524 --- /dev/null +++ b/docs/models/sourcecart.md @@ -0,0 +1,10 @@ +# SourceCart + + +## Fields + +| 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[models.CentralAPIRouter, models.SingleStoreAccessToken]]](../models/sourcecartauthorizationmethod.md) | :heavy_minus_sign: | N/A | | +| `source_type` | [models.Cart](../models/cart.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/sourcecartauthorizationmethod.md b/docs/models/sourcecartauthorizationmethod.md new file mode 100644 index 00000000..56d7a82e --- /dev/null +++ b/docs/models/sourcecartauthorizationmethod.md @@ -0,0 +1,17 @@ +# SourceCartAuthorizationMethod + + +## Supported Types + +### CentralAPIRouter + +```python +sourceCartAuthorizationMethod: models.CentralAPIRouter = /* values here */ +``` + +### SingleStoreAccessToken + +```python +sourceCartAuthorizationMethod: models.SingleStoreAccessToken = /* values here */ +``` + diff --git a/docs/models/shared/sourcecartauthtype.md b/docs/models/sourcecartauthtype.md similarity index 100% rename from docs/models/shared/sourcecartauthtype.md rename to docs/models/sourcecartauthtype.md diff --git a/docs/models/shared/sourcecartschemasauthtype.md b/docs/models/sourcecartschemasauthtype.md similarity index 100% rename from docs/models/shared/sourcecartschemasauthtype.md rename to docs/models/sourcecartschemasauthtype.md diff --git a/docs/models/shared/sourcechargebee.md b/docs/models/sourcechargebee.md similarity index 97% rename from docs/models/shared/sourcechargebee.md rename to docs/models/sourcechargebee.md index fa52f0df..62552826 100644 --- a/docs/models/shared/sourcechargebee.md +++ b/docs/models/sourcechargebee.md @@ -8,5 +8,5 @@ | `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. | | | `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:00.000Z. Any data before this date will not be replicated. | 2021-01-25T00:00:00Z | -| `product_catalog` | [Optional[shared.ProductCatalog]](../../models/shared/productcatalog.md) | :heavy_minus_sign: | Product Catalog version of your Chargebee site. Instructions on how to find your version you may find here under `API Version` section. If left blank, the product catalog version will be set to 2.0. | | -| `source_type` | [shared.Chargebee](../../models/shared/chargebee.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `product_catalog` | [Optional[models.ProductCatalog]](../models/productcatalog.md) | :heavy_minus_sign: | Product Catalog version of your Chargebee site. Instructions on how to find your version you may find here under `API Version` section. If left blank, the product catalog version will be set to 2.0. | | +| `source_type` | [models.Chargebee](../models/chargebee.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcechartmogul.md b/docs/models/sourcechartmogul.md similarity index 98% rename from docs/models/shared/sourcechartmogul.md rename to docs/models/sourcechartmogul.md index b5984106..cf7969cd 100644 --- a/docs/models/shared/sourcechartmogul.md +++ b/docs/models/sourcechartmogul.md @@ -7,4 +7,4 @@ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | Your Chartmogul API key. See the docs for info on how to obtain this. | | | `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 +| `source_type` | [models.Chartmogul](../models/chartmogul.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceclickhouse.md b/docs/models/sourceclickhouse.md similarity index 97% rename from docs/models/shared/sourceclickhouse.md rename to docs/models/sourceclickhouse.md index 73bc687a..b541ad72 100644 --- a/docs/models/shared/sourceclickhouse.md +++ b/docs/models/sourceclickhouse.md @@ -11,5 +11,5 @@ | `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. | | \ No newline at end of file +| `source_type` | [models.SourceClickhouseClickhouse](../models/sourceclickhouseclickhouse.md) | :heavy_check_mark: | N/A | | +| `tunnel_method` | [Optional[Union[models.SourceClickhouseNoTunnel, models.SourceClickhouseSSHKeyAuthentication, models.SourceClickhousePasswordAuthentication]]](../models/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/sourceclickhouseclickhouse.md b/docs/models/sourceclickhouseclickhouse.md similarity index 100% rename from docs/models/shared/sourceclickhouseclickhouse.md rename to docs/models/sourceclickhouseclickhouse.md diff --git a/docs/models/sourceclickhousenotunnel.md b/docs/models/sourceclickhousenotunnel.md new file mode 100644 index 00000000..c5368954 --- /dev/null +++ b/docs/models/sourceclickhousenotunnel.md @@ -0,0 +1,8 @@ +# SourceClickhouseNoTunnel + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `tunnel_method` | [models.SourceClickhouseTunnelMethod](../models/sourceclickhousetunnelmethod.md) | :heavy_check_mark: | No ssh tunnel needed to connect to database | \ No newline at end of file diff --git a/docs/models/sourceclickhousepasswordauthentication.md b/docs/models/sourceclickhousepasswordauthentication.md new file mode 100644 index 00000000..d6e1c25b --- /dev/null +++ b/docs/models/sourceclickhousepasswordauthentication.md @@ -0,0 +1,12 @@ +# SourceClickhousePasswordAuthentication + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `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_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | +| `tunnel_method` | [models.SourceClickhouseSchemasTunnelMethodTunnelMethod](../models/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/sourceclickhouseschemastunnelmethod.md b/docs/models/sourceclickhouseschemastunnelmethod.md similarity index 100% rename from docs/models/shared/sourceclickhouseschemastunnelmethod.md rename to docs/models/sourceclickhouseschemastunnelmethod.md diff --git a/docs/models/shared/sourceclickhouseschemastunnelmethodtunnelmethod.md b/docs/models/sourceclickhouseschemastunnelmethodtunnelmethod.md similarity index 100% rename from docs/models/shared/sourceclickhouseschemastunnelmethodtunnelmethod.md rename to docs/models/sourceclickhouseschemastunnelmethodtunnelmethod.md diff --git a/docs/models/shared/sourceclickhousesshkeyauthentication.md b/docs/models/sourceclickhousesshkeyauthentication.md similarity index 95% rename from docs/models/shared/sourceclickhousesshkeyauthentication.md rename to docs/models/sourceclickhousesshkeyauthentication.md index eb5ae078..adcadc84 100644 --- a/docs/models/shared/sourceclickhousesshkeyauthentication.md +++ b/docs/models/sourceclickhousesshkeyauthentication.md @@ -8,5 +8,5 @@ | `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_method` | [models.SourceClickhouseSchemasTunnelMethod](../models/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 | \ No newline at end of file diff --git a/docs/models/sourceclickhousesshtunnelmethod.md b/docs/models/sourceclickhousesshtunnelmethod.md new file mode 100644 index 00000000..27ac3fe3 --- /dev/null +++ b/docs/models/sourceclickhousesshtunnelmethod.md @@ -0,0 +1,25 @@ +# SourceClickhouseSSHTunnelMethod + +Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. + + +## Supported Types + +### SourceClickhouseNoTunnel + +```python +sourceClickhouseSSHTunnelMethod: models.SourceClickhouseNoTunnel = /* values here */ +``` + +### SourceClickhouseSSHKeyAuthentication + +```python +sourceClickhouseSSHTunnelMethod: models.SourceClickhouseSSHKeyAuthentication = /* values here */ +``` + +### SourceClickhousePasswordAuthentication + +```python +sourceClickhouseSSHTunnelMethod: models.SourceClickhousePasswordAuthentication = /* values here */ +``` + diff --git a/docs/models/shared/sourceclickhousetunnelmethod.md b/docs/models/sourceclickhousetunnelmethod.md similarity index 100% rename from docs/models/shared/sourceclickhousetunnelmethod.md rename to docs/models/sourceclickhousetunnelmethod.md diff --git a/docs/models/shared/sourceclickupapi.md b/docs/models/sourceclickupapi.md similarity index 99% rename from docs/models/shared/sourceclickupapi.md rename to docs/models/sourceclickupapi.md index 7b8aba34..0f223bf0 100644 --- a/docs/models/shared/sourceclickupapi.md +++ b/docs/models/sourceclickupapi.md @@ -9,6 +9,6 @@ | `folder_id` | *Optional[str]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | Include or exclude closed tasks. By default, they are excluded. See here. | | `list_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your list in your folder. Retrieve it from the `/folder/{folder_id}/list` of the ClickUp API. See here. | -| `source_type` | [shared.ClickupAPI](../../models/shared/clickupapi.md) | :heavy_check_mark: | N/A | +| `source_type` | [models.ClickupAPI](../models/clickupapi.md) | :heavy_check_mark: | N/A | | `space_id` | *Optional[str]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | The ID of your team in ClickUp. Retrieve it from the `/team` of the ClickUp API. See here. | \ No newline at end of file diff --git a/docs/models/shared/sourceclockify.md b/docs/models/sourceclockify.md similarity index 95% rename from docs/models/shared/sourceclockify.md rename to docs/models/sourceclockify.md index a3fad4fc..385ae5fc 100644 --- a/docs/models/shared/sourceclockify.md +++ b/docs/models/sourceclockify.md @@ -8,4 +8,4 @@ | `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 | \ No newline at end of file +| `source_type` | [models.Clockify](../models/clockify.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceclosecom.md b/docs/models/sourceclosecom.md similarity index 96% rename from docs/models/shared/sourceclosecom.md rename to docs/models/sourceclosecom.md index f5c4a82c..589cba94 100644 --- a/docs/models/shared/sourceclosecom.md +++ b/docs/models/sourceclosecom.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `api_key` | *str* | :heavy_check_mark: | Close.com API key (usually starts with 'api_'; find yours here). | | -| `source_type` | [shared.CloseCom](../../models/shared/closecom.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.CloseCom](../models/closecom.md) | :heavy_check_mark: | N/A | | | `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The start date to sync data; all data after this date will be replicated. Leave blank to retrieve all the data available in the account. Format: YYYY-MM-DD. | 2021-01-01 | \ No newline at end of file diff --git a/docs/models/sourcecoda.md b/docs/models/sourcecoda.md new file mode 100644 index 00000000..be594140 --- /dev/null +++ b/docs/models/sourcecoda.md @@ -0,0 +1,9 @@ +# SourceCoda + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | +| `auth_token` | *str* | :heavy_check_mark: | Bearer token | +| `source_type` | [models.Coda](../models/coda.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcecoinapi.md b/docs/models/sourcecoinapi.md similarity index 98% rename from docs/models/shared/sourcecoinapi.md rename to docs/models/sourcecoinapi.md index 98a2527c..8556f9ec 100644 --- a/docs/models/shared/sourcecoinapi.md +++ b/docs/models/sourcecoinapi.md @@ -10,6 +10,6 @@ | `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.
    | | +| `environment` | [Optional[models.Environment]](../models/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.
    | | -| `source_type` | [shared.CoinAPI](../../models/shared/coinapi.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `source_type` | [models.CoinAPI](../models/coinapi.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcecoinmarketcap.md b/docs/models/sourcecoinmarketcap.md similarity index 97% rename from docs/models/shared/sourcecoinmarketcap.md rename to docs/models/sourcecoinmarketcap.md index 31ef8810..863478d1 100644 --- a/docs/models/shared/sourcecoinmarketcap.md +++ b/docs/models/sourcecoinmarketcap.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | Your API Key. See here. The token is case sensitive. | | -| `data_type` | [shared.DataType](../../models/shared/datatype.md) | :heavy_check_mark: | /latest: Latest market ticker quotes and averages for cryptocurrencies and exchanges. /historical: Intervals of historic market data like OHLCV data or data for use in charting libraries. See here. | | -| `source_type` | [shared.Coinmarketcap](../../models/shared/coinmarketcap.md) | :heavy_check_mark: | N/A | | +| `data_type` | [models.DataType](../models/datatype.md) | :heavy_check_mark: | /latest: Latest market ticker quotes and averages for cryptocurrencies and exchanges. /historical: Intervals of historic market data like OHLCV data or data for use in charting libraries. See here. | | +| `source_type` | [models.Coinmarketcap](../models/coinmarketcap.md) | :heavy_check_mark: | N/A | | | `symbols` | List[*str*] | :heavy_minus_sign: | Cryptocurrency symbols. (only used for quotes stream) | AVAX | \ No newline at end of file diff --git a/docs/models/shared/sourceconfigcat.md b/docs/models/sourceconfigcat.md similarity index 93% rename from docs/models/shared/sourceconfigcat.md rename to docs/models/sourceconfigcat.md index 262387ed..1fef8ec0 100644 --- a/docs/models/shared/sourceconfigcat.md +++ b/docs/models/sourceconfigcat.md @@ -7,4 +7,4 @@ | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | `password` | *str* | :heavy_check_mark: | Basic auth password. See here. | | `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 +| `source_type` | [models.Configcat](../models/configcat.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourceconfiguration.md b/docs/models/sourceconfiguration.md new file mode 100644 index 00000000..b2109e11 --- /dev/null +++ b/docs/models/sourceconfiguration.md @@ -0,0 +1,1177 @@ +# SourceConfiguration + +The values required to configure the source. + + +## Supported Types + +### SourceAha + +```python +sourceConfiguration: models.SourceAha = /* values here */ +``` + +### SourceAircall + +```python +sourceConfiguration: models.SourceAircall = /* values here */ +``` + +### SourceAirtable + +```python +sourceConfiguration: models.SourceAirtable = /* values here */ +``` + +### SourceAmazonAds + +```python +sourceConfiguration: models.SourceAmazonAds = /* values here */ +``` + +### SourceAmazonSellerPartner + +```python +sourceConfiguration: models.SourceAmazonSellerPartner = /* values here */ +``` + +### SourceAmazonSqs + +```python +sourceConfiguration: models.SourceAmazonSqs = /* values here */ +``` + +### SourceAmplitude + +```python +sourceConfiguration: models.SourceAmplitude = /* values here */ +``` + +### SourceApifyDataset + +```python +sourceConfiguration: models.SourceApifyDataset = /* values here */ +``` + +### SourceAppfollow + +```python +sourceConfiguration: models.SourceAppfollow = /* values here */ +``` + +### SourceAsana + +```python +sourceConfiguration: models.SourceAsana = /* values here */ +``` + +### SourceAuth0 + +```python +sourceConfiguration: models.SourceAuth0 = /* values here */ +``` + +### SourceAwsCloudtrail + +```python +sourceConfiguration: models.SourceAwsCloudtrail = /* values here */ +``` + +### SourceAzureBlobStorage + +```python +sourceConfiguration: models.SourceAzureBlobStorage = /* values here */ +``` + +### SourceAzureTable + +```python +sourceConfiguration: models.SourceAzureTable = /* values here */ +``` + +### SourceBambooHr + +```python +sourceConfiguration: models.SourceBambooHr = /* values here */ +``` + +### SourceBigquery + +```python +sourceConfiguration: models.SourceBigquery = /* values here */ +``` + +### SourceBingAds + +```python +sourceConfiguration: models.SourceBingAds = /* values here */ +``` + +### SourceBraintree + +```python +sourceConfiguration: models.SourceBraintree = /* values here */ +``` + +### SourceBraze + +```python +sourceConfiguration: models.SourceBraze = /* values here */ +``` + +### SourceCart + +```python +sourceConfiguration: models.SourceCart = /* values here */ +``` + +### SourceChargebee + +```python +sourceConfiguration: models.SourceChargebee = /* values here */ +``` + +### SourceChartmogul + +```python +sourceConfiguration: models.SourceChartmogul = /* values here */ +``` + +### SourceClickhouse + +```python +sourceConfiguration: models.SourceClickhouse = /* values here */ +``` + +### SourceClickupAPI + +```python +sourceConfiguration: models.SourceClickupAPI = /* values here */ +``` + +### SourceClockify + +```python +sourceConfiguration: models.SourceClockify = /* values here */ +``` + +### SourceCloseCom + +```python +sourceConfiguration: models.SourceCloseCom = /* values here */ +``` + +### SourceCoda + +```python +sourceConfiguration: models.SourceCoda = /* values here */ +``` + +### SourceCoinAPI + +```python +sourceConfiguration: models.SourceCoinAPI = /* values here */ +``` + +### SourceCoinmarketcap + +```python +sourceConfiguration: models.SourceCoinmarketcap = /* values here */ +``` + +### SourceConfigcat + +```python +sourceConfiguration: models.SourceConfigcat = /* values here */ +``` + +### SourceConfluence + +```python +sourceConfiguration: models.SourceConfluence = /* values here */ +``` + +### SourceConvex + +```python +sourceConfiguration: models.SourceConvex = /* values here */ +``` + +### SourceDatascope + +```python +sourceConfiguration: models.SourceDatascope = /* values here */ +``` + +### SourceDelighted + +```python +sourceConfiguration: models.SourceDelighted = /* values here */ +``` + +### SourceDixa + +```python +sourceConfiguration: models.SourceDixa = /* values here */ +``` + +### SourceDockerhub + +```python +sourceConfiguration: models.SourceDockerhub = /* values here */ +``` + +### SourceDremio + +```python +sourceConfiguration: models.SourceDremio = /* values here */ +``` + +### SourceDynamodb + +```python +sourceConfiguration: models.SourceDynamodb = /* values here */ +``` + +### SourceE2eTestCloud + +```python +sourceConfiguration: Union[models.ContinuousFeed] = /* values here */ +``` + +### SourceEmailoctopus + +```python +sourceConfiguration: models.SourceEmailoctopus = /* values here */ +``` + +### SourceExchangeRates + +```python +sourceConfiguration: models.SourceExchangeRates = /* values here */ +``` + +### SourceFacebookMarketing + +```python +sourceConfiguration: models.SourceFacebookMarketing = /* values here */ +``` + +### SourceFaker + +```python +sourceConfiguration: models.SourceFaker = /* values here */ +``` + +### SourceFauna + +```python +sourceConfiguration: models.SourceFauna = /* values here */ +``` + +### SourceFile + +```python +sourceConfiguration: models.SourceFile = /* values here */ +``` + +### SourceFirebolt + +```python +sourceConfiguration: models.SourceFirebolt = /* values here */ +``` + +### SourceFreshcaller + +```python +sourceConfiguration: models.SourceFreshcaller = /* values here */ +``` + +### SourceFreshdesk + +```python +sourceConfiguration: models.SourceFreshdesk = /* values here */ +``` + +### SourceFreshsales + +```python +sourceConfiguration: models.SourceFreshsales = /* values here */ +``` + +### SourceGainsightPx + +```python +sourceConfiguration: models.SourceGainsightPx = /* values here */ +``` + +### SourceGcs + +```python +sourceConfiguration: models.SourceGcs = /* values here */ +``` + +### SourceGetlago + +```python +sourceConfiguration: models.SourceGetlago = /* values here */ +``` + +### SourceGithub + +```python +sourceConfiguration: models.SourceGithub = /* values here */ +``` + +### SourceGitlab + +```python +sourceConfiguration: models.SourceGitlab = /* values here */ +``` + +### SourceGlassfrog + +```python +sourceConfiguration: models.SourceGlassfrog = /* values here */ +``` + +### SourceGnews + +```python +sourceConfiguration: models.SourceGnews = /* values here */ +``` + +### SourceGoogleAds + +```python +sourceConfiguration: models.SourceGoogleAds = /* values here */ +``` + +### SourceGoogleAnalyticsDataAPI + +```python +sourceConfiguration: models.SourceGoogleAnalyticsDataAPI = /* values here */ +``` + +### SourceGoogleAnalyticsV4ServiceAccountOnly + +```python +sourceConfiguration: models.SourceGoogleAnalyticsV4ServiceAccountOnly = /* values here */ +``` + +### SourceGoogleDirectory + +```python +sourceConfiguration: models.SourceGoogleDirectory = /* values here */ +``` + +### SourceGoogleDrive + +```python +sourceConfiguration: models.SourceGoogleDrive = /* values here */ +``` + +### SourceGooglePagespeedInsights + +```python +sourceConfiguration: models.SourceGooglePagespeedInsights = /* values here */ +``` + +### SourceGoogleSearchConsole + +```python +sourceConfiguration: models.SourceGoogleSearchConsole = /* values here */ +``` + +### SourceGoogleSheets + +```python +sourceConfiguration: models.SourceGoogleSheets = /* values here */ +``` + +### SourceGoogleWebfonts + +```python +sourceConfiguration: models.SourceGoogleWebfonts = /* values here */ +``` + +### SourceGreenhouse + +```python +sourceConfiguration: models.SourceGreenhouse = /* values here */ +``` + +### SourceGridly + +```python +sourceConfiguration: models.SourceGridly = /* values here */ +``` + +### SourceHarvest + +```python +sourceConfiguration: models.SourceHarvest = /* values here */ +``` + +### SourceHubplanner + +```python +sourceConfiguration: models.SourceHubplanner = /* values here */ +``` + +### SourceHubspot + +```python +sourceConfiguration: models.SourceHubspot = /* values here */ +``` + +### SourceInsightly + +```python +sourceConfiguration: models.SourceInsightly = /* values here */ +``` + +### SourceInstagram + +```python +sourceConfiguration: models.SourceInstagram = /* values here */ +``` + +### SourceInstatus + +```python +sourceConfiguration: models.SourceInstatus = /* values here */ +``` + +### SourceIntercom + +```python +sourceConfiguration: models.SourceIntercom = /* values here */ +``` + +### SourceIp2whois + +```python +sourceConfiguration: models.SourceIp2whois = /* values here */ +``` + +### SourceIterable + +```python +sourceConfiguration: models.SourceIterable = /* values here */ +``` + +### SourceJira + +```python +sourceConfiguration: models.SourceJira = /* values here */ +``` + +### SourceK6Cloud + +```python +sourceConfiguration: models.SourceK6Cloud = /* values here */ +``` + +### SourceKlarna + +```python +sourceConfiguration: models.SourceKlarna = /* values here */ +``` + +### SourceKlaviyo + +```python +sourceConfiguration: models.SourceKlaviyo = /* values here */ +``` + +### SourceKyve + +```python +sourceConfiguration: models.SourceKyve = /* values here */ +``` + +### SourceLaunchdarkly + +```python +sourceConfiguration: models.SourceLaunchdarkly = /* values here */ +``` + +### SourceLemlist + +```python +sourceConfiguration: models.SourceLemlist = /* values here */ +``` + +### SourceLeverHiring + +```python +sourceConfiguration: models.SourceLeverHiring = /* values here */ +``` + +### SourceLinkedinAds + +```python +sourceConfiguration: models.SourceLinkedinAds = /* values here */ +``` + +### SourceLinkedinPages + +```python +sourceConfiguration: models.SourceLinkedinPages = /* values here */ +``` + +### SourceLinnworks + +```python +sourceConfiguration: models.SourceLinnworks = /* values here */ +``` + +### SourceLokalise + +```python +sourceConfiguration: models.SourceLokalise = /* values here */ +``` + +### SourceMailchimp + +```python +sourceConfiguration: models.SourceMailchimp = /* values here */ +``` + +### SourceMailgun + +```python +sourceConfiguration: models.SourceMailgun = /* values here */ +``` + +### SourceMailjetSms + +```python +sourceConfiguration: models.SourceMailjetSms = /* values here */ +``` + +### SourceMarketo + +```python +sourceConfiguration: models.SourceMarketo = /* values here */ +``` + +### SourceMetabase + +```python +sourceConfiguration: models.SourceMetabase = /* values here */ +``` + +### SourceMicrosoftOnedrive + +```python +sourceConfiguration: models.SourceMicrosoftOnedrive = /* values here */ +``` + +### SourceMicrosoftSharepoint + +```python +sourceConfiguration: models.SourceMicrosoftSharepoint = /* values here */ +``` + +### SourceMicrosoftTeams + +```python +sourceConfiguration: models.SourceMicrosoftTeams = /* values here */ +``` + +### SourceMixpanel + +```python +sourceConfiguration: models.SourceMixpanel = /* values here */ +``` + +### SourceMonday + +```python +sourceConfiguration: models.SourceMonday = /* values here */ +``` + +### SourceMongodbInternalPoc + +```python +sourceConfiguration: models.SourceMongodbInternalPoc = /* values here */ +``` + +### SourceMongodbV2 + +```python +sourceConfiguration: models.SourceMongodbV2 = /* values here */ +``` + +### SourceMssql + +```python +sourceConfiguration: models.SourceMssql = /* values here */ +``` + +### SourceMyHours + +```python +sourceConfiguration: models.SourceMyHours = /* values here */ +``` + +### SourceMysql + +```python +sourceConfiguration: models.SourceMysql = /* values here */ +``` + +### SourceNetsuite + +```python +sourceConfiguration: models.SourceNetsuite = /* values here */ +``` + +### SourceNotion + +```python +sourceConfiguration: models.SourceNotion = /* values here */ +``` + +### SourceNytimes + +```python +sourceConfiguration: models.SourceNytimes = /* values here */ +``` + +### SourceOkta + +```python +sourceConfiguration: models.SourceOkta = /* values here */ +``` + +### SourceOmnisend + +```python +sourceConfiguration: models.SourceOmnisend = /* values here */ +``` + +### SourceOnesignal + +```python +sourceConfiguration: models.SourceOnesignal = /* values here */ +``` + +### SourceOracle + +```python +sourceConfiguration: models.SourceOracle = /* values here */ +``` + +### SourceOrb + +```python +sourceConfiguration: models.SourceOrb = /* values here */ +``` + +### SourceOrbit + +```python +sourceConfiguration: models.SourceOrbit = /* values here */ +``` + +### SourceOutbrainAmplify + +```python +sourceConfiguration: models.SourceOutbrainAmplify = /* values here */ +``` + +### SourceOutreach + +```python +sourceConfiguration: models.SourceOutreach = /* values here */ +``` + +### SourcePaypalTransaction + +```python +sourceConfiguration: models.SourcePaypalTransaction = /* values here */ +``` + +### SourcePaystack + +```python +sourceConfiguration: models.SourcePaystack = /* values here */ +``` + +### SourcePendo + +```python +sourceConfiguration: models.SourcePendo = /* values here */ +``` + +### SourcePersistiq + +```python +sourceConfiguration: models.SourcePersistiq = /* values here */ +``` + +### SourcePexelsAPI + +```python +sourceConfiguration: models.SourcePexelsAPI = /* values here */ +``` + +### SourcePinterest + +```python +sourceConfiguration: models.SourcePinterest = /* values here */ +``` + +### SourcePipedrive + +```python +sourceConfiguration: models.SourcePipedrive = /* values here */ +``` + +### SourcePocket + +```python +sourceConfiguration: models.SourcePocket = /* values here */ +``` + +### SourcePokeapi + +```python +sourceConfiguration: models.SourcePokeapi = /* values here */ +``` + +### SourcePolygonStockAPI + +```python +sourceConfiguration: models.SourcePolygonStockAPI = /* values here */ +``` + +### SourcePostgres + +```python +sourceConfiguration: models.SourcePostgres = /* values here */ +``` + +### SourcePosthog + +```python +sourceConfiguration: models.SourcePosthog = /* values here */ +``` + +### SourcePostmarkapp + +```python +sourceConfiguration: models.SourcePostmarkapp = /* values here */ +``` + +### SourcePrestashop + +```python +sourceConfiguration: models.SourcePrestashop = /* values here */ +``` + +### SourcePunkAPI + +```python +sourceConfiguration: models.SourcePunkAPI = /* values here */ +``` + +### SourcePypi + +```python +sourceConfiguration: models.SourcePypi = /* values here */ +``` + +### SourceQualaroo + +```python +sourceConfiguration: models.SourceQualaroo = /* values here */ +``` + +### SourceQuickbooks + +```python +sourceConfiguration: models.SourceQuickbooks = /* values here */ +``` + +### SourceRailz + +```python +sourceConfiguration: models.SourceRailz = /* values here */ +``` + +### SourceRecharge + +```python +sourceConfiguration: models.SourceRecharge = /* values here */ +``` + +### SourceRecreation + +```python +sourceConfiguration: models.SourceRecreation = /* values here */ +``` + +### SourceRecruitee + +```python +sourceConfiguration: models.SourceRecruitee = /* values here */ +``` + +### SourceRecurly + +```python +sourceConfiguration: models.SourceRecurly = /* values here */ +``` + +### SourceRedshift + +```python +sourceConfiguration: models.SourceRedshift = /* values here */ +``` + +### SourceRetently + +```python +sourceConfiguration: models.SourceRetently = /* values here */ +``` + +### SourceRkiCovid + +```python +sourceConfiguration: models.SourceRkiCovid = /* values here */ +``` + +### SourceRss + +```python +sourceConfiguration: models.SourceRss = /* values here */ +``` + +### SourceS3 + +```python +sourceConfiguration: models.SourceS3 = /* values here */ +``` + +### SourceSalesforce + +```python +sourceConfiguration: models.SourceSalesforce = /* values here */ +``` + +### SourceSalesloft + +```python +sourceConfiguration: models.SourceSalesloft = /* values here */ +``` + +### SourceSapFieldglass + +```python +sourceConfiguration: models.SourceSapFieldglass = /* values here */ +``` + +### SourceSecoda + +```python +sourceConfiguration: models.SourceSecoda = /* values here */ +``` + +### SourceSendgrid + +```python +sourceConfiguration: models.SourceSendgrid = /* values here */ +``` + +### SourceSendinblue + +```python +sourceConfiguration: models.SourceSendinblue = /* values here */ +``` + +### SourceSenseforce + +```python +sourceConfiguration: models.SourceSenseforce = /* values here */ +``` + +### SourceSentry + +```python +sourceConfiguration: models.SourceSentry = /* values here */ +``` + +### SourceSftp + +```python +sourceConfiguration: models.SourceSftp = /* values here */ +``` + +### SourceSftpBulk + +```python +sourceConfiguration: models.SourceSftpBulk = /* values here */ +``` + +### SourceShopify + +```python +sourceConfiguration: models.SourceShopify = /* values here */ +``` + +### SourceShortio + +```python +sourceConfiguration: models.SourceShortio = /* values here */ +``` + +### SourceSlack + +```python +sourceConfiguration: models.SourceSlack = /* values here */ +``` + +### SourceSmaily + +```python +sourceConfiguration: models.SourceSmaily = /* values here */ +``` + +### SourceSmartengage + +```python +sourceConfiguration: models.SourceSmartengage = /* values here */ +``` + +### SourceSmartsheets + +```python +sourceConfiguration: models.SourceSmartsheets = /* values here */ +``` + +### SourceSnapchatMarketing + +```python +sourceConfiguration: models.SourceSnapchatMarketing = /* values here */ +``` + +### SourceSnowflake + +```python +sourceConfiguration: models.SourceSnowflake = /* values here */ +``` + +### SourceSonarCloud + +```python +sourceConfiguration: models.SourceSonarCloud = /* values here */ +``` + +### SourceSpacexAPI + +```python +sourceConfiguration: models.SourceSpacexAPI = /* values here */ +``` + +### SourceSquare + +```python +sourceConfiguration: models.SourceSquare = /* values here */ +``` + +### SourceStrava + +```python +sourceConfiguration: models.SourceStrava = /* values here */ +``` + +### SourceStripe + +```python +sourceConfiguration: models.SourceStripe = /* values here */ +``` + +### SourceSurveySparrow + +```python +sourceConfiguration: models.SourceSurveySparrow = /* values here */ +``` + +### SourceSurveymonkey + +```python +sourceConfiguration: models.SourceSurveymonkey = /* values here */ +``` + +### SourceTempo + +```python +sourceConfiguration: models.SourceTempo = /* values here */ +``` + +### SourceTheGuardianAPI + +```python +sourceConfiguration: models.SourceTheGuardianAPI = /* values here */ +``` + +### SourceTiktokMarketing + +```python +sourceConfiguration: models.SourceTiktokMarketing = /* values here */ +``` + +### SourceTrello + +```python +sourceConfiguration: models.SourceTrello = /* values here */ +``` + +### SourceTrustpilot + +```python +sourceConfiguration: models.SourceTrustpilot = /* values here */ +``` + +### SourceTvmazeSchedule + +```python +sourceConfiguration: models.SourceTvmazeSchedule = /* values here */ +``` + +### SourceTwilio + +```python +sourceConfiguration: models.SourceTwilio = /* values here */ +``` + +### SourceTwilioTaskrouter + +```python +sourceConfiguration: models.SourceTwilioTaskrouter = /* values here */ +``` + +### SourceTwitter + +```python +sourceConfiguration: models.SourceTwitter = /* values here */ +``` + +### SourceTypeform + +```python +sourceConfiguration: models.SourceTypeform = /* values here */ +``` + +### SourceUsCensus + +```python +sourceConfiguration: models.SourceUsCensus = /* values here */ +``` + +### SourceVantage + +```python +sourceConfiguration: models.SourceVantage = /* values here */ +``` + +### SourceWebflow + +```python +sourceConfiguration: models.SourceWebflow = /* values here */ +``` + +### SourceWhiskyHunter + +```python +sourceConfiguration: models.SourceWhiskyHunter = /* values here */ +``` + +### SourceWikipediaPageviews + +```python +sourceConfiguration: models.SourceWikipediaPageviews = /* values here */ +``` + +### SourceWoocommerce + +```python +sourceConfiguration: models.SourceWoocommerce = /* values here */ +``` + +### SourceXkcd + +```python +sourceConfiguration: models.SourceXkcd = /* values here */ +``` + +### SourceYandexMetrica + +```python +sourceConfiguration: models.SourceYandexMetrica = /* values here */ +``` + +### SourceYotpo + +```python +sourceConfiguration: models.SourceYotpo = /* values here */ +``` + +### SourceYoutubeAnalytics + +```python +sourceConfiguration: models.SourceYoutubeAnalytics = /* values here */ +``` + +### SourceZendeskChat + +```python +sourceConfiguration: models.SourceZendeskChat = /* values here */ +``` + +### SourceZendeskSell + +```python +sourceConfiguration: models.SourceZendeskSell = /* values here */ +``` + +### SourceZendeskSunshine + +```python +sourceConfiguration: models.SourceZendeskSunshine = /* values here */ +``` + +### SourceZendeskSupport + +```python +sourceConfiguration: models.SourceZendeskSupport = /* values here */ +``` + +### SourceZendeskTalk + +```python +sourceConfiguration: models.SourceZendeskTalk = /* values here */ +``` + +### SourceZenloop + +```python +sourceConfiguration: models.SourceZenloop = /* values here */ +``` + +### SourceZohoCrm + +```python +sourceConfiguration: models.SourceZohoCrm = /* values here */ +``` + +### SourceZoom + +```python +sourceConfiguration: models.SourceZoom = /* values here */ +``` + diff --git a/docs/models/shared/sourceconfluence.md b/docs/models/sourceconfluence.md similarity index 97% rename from docs/models/shared/sourceconfluence.md rename to docs/models/sourceconfluence.md index ca99febd..1d37b2cb 100644 --- a/docs/models/shared/sourceconfluence.md +++ b/docs/models/sourceconfluence.md @@ -8,4 +8,4 @@ | `api_token` | *str* | :heavy_check_mark: | Please follow the Jira confluence for generating an API token: generating an API token. | | | `domain_name` | *str* | :heavy_check_mark: | Your Confluence domain name | | | `email` | *str* | :heavy_check_mark: | Your Confluence login email | abc@example.com | -| `source_type` | [shared.Confluence](../../models/shared/confluence.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `source_type` | [models.Confluence](../models/confluence.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/sourceconvex.md b/docs/models/sourceconvex.md new file mode 100644 index 00000000..855d07d7 --- /dev/null +++ b/docs/models/sourceconvex.md @@ -0,0 +1,10 @@ +# SourceConvex + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `access_key` | *str* | :heavy_check_mark: | API access key used to retrieve data from Convex. | | +| `deployment_url` | *str* | :heavy_check_mark: | N/A | https://murky-swan-635.convex.cloud | +| `source_type` | [models.SourceConvexConvex](../models/sourceconvexconvex.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceconvexconvex.md b/docs/models/sourceconvexconvex.md similarity index 100% rename from docs/models/shared/sourceconvexconvex.md rename to docs/models/sourceconvexconvex.md diff --git a/docs/models/shared/sourcecreaterequest.md b/docs/models/sourcecreaterequest.md similarity index 94% rename from docs/models/shared/sourcecreaterequest.md rename to docs/models/sourcecreaterequest.md index 84881ab1..fa355a57 100644 --- a/docs/models/shared/sourcecreaterequest.md +++ b/docs/models/sourcecreaterequest.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `configuration` | [Union[shared.SourceAha, shared.SourceAircall, shared.SourceAirtable, 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.SourceGoogleAnalyticsV4ServiceAccountOnly, 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.SourceKyve, shared.SourceLaunchdarkly, shared.SourceLemlist, shared.SourceLeverHiring, shared.SourceLinkedinAds, shared.SourceLinkedinPages, shared.SourceLokalise, shared.SourceMailchimp, shared.SourceMailgun, shared.SourceMailjetSms, shared.SourceMarketo, shared.SourceMetabase, shared.SourceMicrosoftSharepoint, 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.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]](../../models/shared/sourceconfiguration.md) | :heavy_check_mark: | The values required to configure the source. | {
    "user": "charles"
    } | -| `name` | *str* | :heavy_check_mark: | Name of the source e.g. dev-mysql-instance. | | -| `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 +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `configuration` | [Union[models.SourceAha, models.SourceAircall, models.SourceAirtable, models.SourceAmazonAds, models.SourceAmazonSellerPartner, models.SourceAmazonSqs, models.SourceAmplitude, models.SourceApifyDataset, models.SourceAppfollow, models.SourceAsana, models.SourceAuth0, models.SourceAwsCloudtrail, models.SourceAzureBlobStorage, models.SourceAzureTable, models.SourceBambooHr, models.SourceBigquery, models.SourceBingAds, models.SourceBraintree, models.SourceBraze, models.SourceCart, models.SourceChargebee, models.SourceChartmogul, models.SourceClickhouse, models.SourceClickupAPI, models.SourceClockify, models.SourceCloseCom, models.SourceCoda, models.SourceCoinAPI, models.SourceCoinmarketcap, models.SourceConfigcat, models.SourceConfluence, models.SourceConvex, models.SourceDatascope, models.SourceDelighted, models.SourceDixa, models.SourceDockerhub, models.SourceDremio, models.SourceDynamodb, Union[models.ContinuousFeed], models.SourceEmailoctopus, models.SourceExchangeRates, models.SourceFacebookMarketing, models.SourceFaker, models.SourceFauna, models.SourceFile, models.SourceFirebolt, models.SourceFreshcaller, models.SourceFreshdesk, models.SourceFreshsales, models.SourceGainsightPx, models.SourceGcs, models.SourceGetlago, models.SourceGithub, models.SourceGitlab, models.SourceGlassfrog, models.SourceGnews, models.SourceGoogleAds, models.SourceGoogleAnalyticsDataAPI, models.SourceGoogleAnalyticsV4ServiceAccountOnly, models.SourceGoogleDirectory, models.SourceGoogleDrive, models.SourceGooglePagespeedInsights, models.SourceGoogleSearchConsole, models.SourceGoogleSheets, models.SourceGoogleWebfonts, models.SourceGreenhouse, models.SourceGridly, models.SourceHarvest, models.SourceHubplanner, models.SourceHubspot, models.SourceInsightly, models.SourceInstagram, models.SourceInstatus, models.SourceIntercom, models.SourceIp2whois, models.SourceIterable, models.SourceJira, models.SourceK6Cloud, models.SourceKlarna, models.SourceKlaviyo, models.SourceKyve, models.SourceLaunchdarkly, models.SourceLemlist, models.SourceLeverHiring, models.SourceLinkedinAds, models.SourceLinkedinPages, models.SourceLinnworks, models.SourceLokalise, models.SourceMailchimp, models.SourceMailgun, models.SourceMailjetSms, models.SourceMarketo, models.SourceMetabase, models.SourceMicrosoftOnedrive, models.SourceMicrosoftSharepoint, models.SourceMicrosoftTeams, models.SourceMixpanel, models.SourceMonday, models.SourceMongodbInternalPoc, models.SourceMongodbV2, models.SourceMssql, models.SourceMyHours, models.SourceMysql, models.SourceNetsuite, models.SourceNotion, models.SourceNytimes, models.SourceOkta, models.SourceOmnisend, models.SourceOnesignal, models.SourceOracle, models.SourceOrb, models.SourceOrbit, models.SourceOutbrainAmplify, models.SourceOutreach, models.SourcePaypalTransaction, models.SourcePaystack, models.SourcePendo, models.SourcePersistiq, models.SourcePexelsAPI, models.SourcePinterest, models.SourcePipedrive, models.SourcePocket, models.SourcePokeapi, models.SourcePolygonStockAPI, models.SourcePostgres, models.SourcePosthog, models.SourcePostmarkapp, models.SourcePrestashop, models.SourcePunkAPI, models.SourcePypi, models.SourceQualaroo, models.SourceQuickbooks, models.SourceRailz, models.SourceRecharge, models.SourceRecreation, models.SourceRecruitee, models.SourceRecurly, models.SourceRedshift, models.SourceRetently, models.SourceRkiCovid, models.SourceRss, models.SourceS3, models.SourceSalesforce, models.SourceSalesloft, models.SourceSapFieldglass, models.SourceSecoda, models.SourceSendgrid, models.SourceSendinblue, models.SourceSenseforce, models.SourceSentry, models.SourceSftp, models.SourceSftpBulk, models.SourceShopify, models.SourceShortio, models.SourceSlack, models.SourceSmaily, models.SourceSmartengage, models.SourceSmartsheets, models.SourceSnapchatMarketing, models.SourceSnowflake, models.SourceSonarCloud, models.SourceSpacexAPI, models.SourceSquare, models.SourceStrava, models.SourceStripe, models.SourceSurveySparrow, models.SourceSurveymonkey, models.SourceTempo, models.SourceTheGuardianAPI, models.SourceTiktokMarketing, models.SourceTrello, models.SourceTrustpilot, models.SourceTvmazeSchedule, models.SourceTwilio, models.SourceTwilioTaskrouter, models.SourceTwitter, models.SourceTypeform, models.SourceUsCensus, models.SourceVantage, models.SourceWebflow, models.SourceWhiskyHunter, models.SourceWikipediaPageviews, models.SourceWoocommerce, models.SourceXkcd, models.SourceYandexMetrica, models.SourceYotpo, models.SourceYoutubeAnalytics, models.SourceZendeskChat, models.SourceZendeskSell, models.SourceZendeskSunshine, models.SourceZendeskSupport, models.SourceZendeskTalk, models.SourceZenloop, models.SourceZohoCrm, models.SourceZoom]](../models/sourceconfiguration.md) | :heavy_check_mark: | The values required to configure the source. | {
    "user": "charles"
    } | +| `name` | *str* | :heavy_check_mark: | Name of the source e.g. dev-mysql-instance. | | +| `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/sourcedatascope.md b/docs/models/sourcedatascope.md new file mode 100644 index 00000000..8c18aee7 --- /dev/null +++ b/docs/models/sourcedatascope.md @@ -0,0 +1,10 @@ +# SourceDatascope + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | +| `api_key` | *str* | :heavy_check_mark: | API Key | | +| `start_date` | *str* | :heavy_check_mark: | Start date for the data to be replicated | dd/mm/YYYY HH:MM | +| `source_type` | [models.Datascope](../models/datascope.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcedelighted.md b/docs/models/sourcedelighted.md similarity index 96% rename from docs/models/shared/sourcedelighted.md rename to docs/models/sourcedelighted.md index e356f8fd..fb0780e5 100644 --- a/docs/models/shared/sourcedelighted.md +++ b/docs/models/sourcedelighted.md @@ -7,4 +7,4 @@ | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | A Delighted API key. | | | `since` | [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 | 2022-05-30T04:50:23Z | -| `source_type` | [shared.Delighted](../../models/shared/delighted.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `source_type` | [models.Delighted](../models/delighted.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcedixa.md b/docs/models/sourcedixa.md similarity index 97% rename from docs/models/shared/sourcedixa.md rename to docs/models/sourcedixa.md index a7c19df1..dad137e7 100644 --- a/docs/models/shared/sourcedixa.md +++ b/docs/models/sourcedixa.md @@ -8,4 +8,4 @@ | `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 | | \ No newline at end of file +| `source_type` | [models.Dixa](../models/dixa.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcedockerhub.md b/docs/models/sourcedockerhub.md similarity index 94% rename from docs/models/shared/sourcedockerhub.md rename to docs/models/sourcedockerhub.md index ef0faca7..e7eee56b 100644 --- a/docs/models/shared/sourcedockerhub.md +++ b/docs/models/sourcedockerhub.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `docker_username` | *str* | :heavy_check_mark: | Username of DockerHub person or organization (for https://hub.docker.com/v2/repositories/USERNAME/ API call) | airbyte | -| `source_type` | [shared.Dockerhub](../../models/shared/dockerhub.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `source_type` | [models.Dockerhub](../models/dockerhub.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcedremio.md b/docs/models/sourcedremio.md similarity index 95% rename from docs/models/shared/sourcedremio.md rename to docs/models/sourcedremio.md index 67fcb8b9..cfce51c4 100644 --- a/docs/models/shared/sourcedremio.md +++ b/docs/models/sourcedremio.md @@ -7,4 +7,4 @@ | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | API Key that is generated when you authenticate to Dremio API | | `base_url` | *Optional[str]* | :heavy_minus_sign: | URL of your Dremio instance | -| `source_type` | [shared.Dremio](../../models/shared/dremio.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `source_type` | [models.Dremio](../models/dremio.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcedynamodb.md b/docs/models/sourcedynamodb.md new file mode 100644 index 00000000..54c57493 --- /dev/null +++ b/docs/models/sourcedynamodb.md @@ -0,0 +1,13 @@ +# SourceDynamodb + + +## Fields + +| 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[models.SourceDynamodbDynamodbRegion]](../models/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 | +| `source_type` | [models.SourceDynamodbDynamodb](../models/sourcedynamodbdynamodb.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcedynamodbdynamodb.md b/docs/models/sourcedynamodbdynamodb.md similarity index 100% rename from docs/models/shared/sourcedynamodbdynamodb.md rename to docs/models/sourcedynamodbdynamodb.md diff --git a/docs/models/shared/sourcedynamodbdynamodbregion.md b/docs/models/sourcedynamodbdynamodbregion.md similarity index 100% rename from docs/models/shared/sourcedynamodbdynamodbregion.md rename to docs/models/sourcedynamodbdynamodbregion.md diff --git a/docs/models/sourcee2etestcloud.md b/docs/models/sourcee2etestcloud.md new file mode 100644 index 00000000..f2f949ba --- /dev/null +++ b/docs/models/sourcee2etestcloud.md @@ -0,0 +1,11 @@ +# SourceE2eTestCloud + + +## Supported Types + +### ContinuousFeed + +```python +sourceE2eTestCloud: models.ContinuousFeed = /* values here */ +``` + diff --git a/docs/models/shared/sourcee2etestcloudschemastype.md b/docs/models/sourcee2etestcloudschemastype.md similarity index 100% rename from docs/models/shared/sourcee2etestcloudschemastype.md rename to docs/models/sourcee2etestcloudschemastype.md diff --git a/docs/models/shared/sourcee2etestcloudtype.md b/docs/models/sourcee2etestcloudtype.md similarity index 100% rename from docs/models/shared/sourcee2etestcloudtype.md rename to docs/models/sourcee2etestcloudtype.md diff --git a/docs/models/shared/sourceemailoctopus.md b/docs/models/sourceemailoctopus.md similarity index 95% rename from docs/models/shared/sourceemailoctopus.md rename to docs/models/sourceemailoctopus.md index fe4d3840..9b0915ab 100644 --- a/docs/models/shared/sourceemailoctopus.md +++ b/docs/models/sourceemailoctopus.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | EmailOctopus API Key. See the docs for information on how to generate this key. | -| `source_type` | [shared.Emailoctopus](../../models/shared/emailoctopus.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `source_type` | [models.Emailoctopus](../models/emailoctopus.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceexchangerates.md b/docs/models/sourceexchangerates.md similarity index 98% rename from docs/models/shared/sourceexchangerates.md rename to docs/models/sourceexchangerates.md index 97b6aa55..21d22144 100644 --- a/docs/models/shared/sourceexchangerates.md +++ b/docs/models/sourceexchangerates.md @@ -9,4 +9,4 @@ | `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 | | \ No newline at end of file +| `source_type` | [models.ExchangeRates](../models/exchangerates.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcefacebookmarketing.md b/docs/models/sourcefacebookmarketing.md similarity index 87% rename from docs/models/shared/sourcefacebookmarketing.md rename to docs/models/sourcefacebookmarketing.md index 13841b7b..63178aef 100644 --- a/docs/models/shared/sourcefacebookmarketing.md +++ b/docs/models/sourcefacebookmarketing.md @@ -8,14 +8,16 @@ | `access_token` | *str* | :heavy_check_mark: | 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*] | :heavy_check_mark: | 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. | 111111111111111 | | `action_breakdowns_allow_empty` | *Optional[bool]* | :heavy_minus_sign: | Allows action_breakdowns to be an empty list | | +| `ad_statuses` | List[[models.ValidAdStatuses](../models/validadstatuses.md)] | :heavy_minus_sign: | Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out. | | +| `adset_statuses` | List[[models.ValidAdSetStatuses](../models/validadsetstatuses.md)] | :heavy_minus_sign: | Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out. | | +| `campaign_statuses` | List[[models.ValidCampaignStatuses](../models/validcampaignstatuses.md)] | :heavy_minus_sign: | Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out. | | | `client_id` | *Optional[str]* | :heavy_minus_sign: | The Client Id for your OAuth app | | | `client_secret` | *Optional[str]* | :heavy_minus_sign: | The Client Secret for your OAuth app | | -| `custom_insights` | List[[shared.InsightConfig](../../models/shared/insightconfig.md)] | :heavy_minus_sign: | 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. | | +| `custom_insights` | List[[models.InsightConfig](../models/insightconfig.md)] | :heavy_minus_sign: | 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. | | | `end_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | The date until which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. All data generated between the start date and this end date will be replicated. Not setting this option will result in always syncing the latest data. | 2017-01-26T00:00:00Z | | `fetch_thumbnail_images` | *Optional[bool]* | :heavy_minus_sign: | Set to active if you want to fetch the thumbnail_url and store the result in thumbnail_data_url for each Ad Creative. | | -| `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | Set to active if you want to include data from deleted Campaigns, Ads, and AdSets. | | | `insights_job_timeout` | *Optional[int]* | :heavy_minus_sign: | Insights Job Timeout establishes the maximum amount of time (in minutes) of waiting for the report job to complete. When timeout is reached the job is considered failed and we are trying to request smaller amount of data by breaking the job to few smaller ones. If you definitely know that 60 minutes is not enough for your report to be processed then you can decrease the timeout value, so we start breaking job to smaller parts faster. | | | `insights_lookback_window` | *Optional[int]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | 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` | [shared.SourceFacebookMarketingFacebookMarketing](../../models/shared/sourcefacebookmarketingfacebookmarketing.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.SourceFacebookMarketingFacebookMarketing](../models/sourcefacebookmarketingfacebookmarketing.md) | :heavy_check_mark: | N/A | | | `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 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. | 2017-01-25T00:00:00Z | \ No newline at end of file diff --git a/docs/models/sourcefacebookmarketingactionreporttime.md b/docs/models/sourcefacebookmarketingactionreporttime.md new file mode 100644 index 00000000..259fa78a --- /dev/null +++ b/docs/models/sourcefacebookmarketingactionreporttime.md @@ -0,0 +1,12 @@ +# SourceFacebookMarketingActionReportTime + +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. + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `CONVERSION` | conversion | +| `IMPRESSION` | impression | +| `MIXED` | mixed | \ No newline at end of file diff --git a/docs/models/shared/sourcefacebookmarketingfacebookmarketing.md b/docs/models/sourcefacebookmarketingfacebookmarketing.md similarity index 100% rename from docs/models/shared/sourcefacebookmarketingfacebookmarketing.md rename to docs/models/sourcefacebookmarketingfacebookmarketing.md diff --git a/docs/models/shared/sourcefacebookmarketingvalidenums.md b/docs/models/sourcefacebookmarketingvalidenums.md similarity index 96% rename from docs/models/shared/sourcefacebookmarketingvalidenums.md rename to docs/models/sourcefacebookmarketingvalidenums.md index c6607c39..e3c28552 100644 --- a/docs/models/shared/sourcefacebookmarketingvalidenums.md +++ b/docs/models/sourcefacebookmarketingvalidenums.md @@ -36,6 +36,7 @@ An enumeration. | `CATALOG_SEGMENT_VALUE_OMNI_PURCHASE_ROAS` | catalog_segment_value_omni_purchase_roas | | `CATALOG_SEGMENT_VALUE_WEBSITE_PURCHASE_ROAS` | catalog_segment_value_website_purchase_roas | | `CLICKS` | clicks | +| `CONVERSION_LEAD_RATE` | conversion_lead_rate | | `CONVERSION_RATE_RANKING` | conversion_rate_ranking | | `CONVERSION_VALUES` | conversion_values | | `CONVERSIONS` | conversions | @@ -46,6 +47,7 @@ An enumeration. | `COST_PER_ACTION_TYPE` | cost_per_action_type | | `COST_PER_AD_CLICK` | cost_per_ad_click | | `COST_PER_CONVERSION` | cost_per_conversion | +| `COST_PER_CONVERSION_LEAD` | cost_per_conversion_lead | | `COST_PER_DDA_COUNTBY_CONVS` | cost_per_dda_countby_convs | | `COST_PER_ESTIMATED_AD_RECALLERS` | cost_per_estimated_ad_recallers | | `COST_PER_INLINE_LINK_CLICK` | cost_per_inline_link_click | @@ -90,6 +92,9 @@ An enumeration. | `INTERACTIVE_COMPONENT_TAP` | interactive_component_tap | | `LABELS` | labels | | `LOCATION` | location | +| `MARKETING_MESSAGES_COST_PER_DELIVERED` | marketing_messages_cost_per_delivered | +| `MARKETING_MESSAGES_COST_PER_LINK_BTN_CLICK` | marketing_messages_cost_per_link_btn_click | +| `MARKETING_MESSAGES_SPEND` | marketing_messages_spend | | `MOBILE_APP_PURCHASE_ROAS` | mobile_app_purchase_roas | | `OBJECTIVE` | objective | | `OPTIMIZATION_GOAL` | optimization_goal | @@ -99,9 +104,6 @@ An enumeration. | `PURCHASE_ROAS` | purchase_roas | | `QUALIFYING_QUESTION_QUALIFY_ANSWER_RATE` | qualifying_question_qualify_answer_rate | | `QUALITY_RANKING` | quality_ranking | -| `QUALITY_SCORE_ECTR` | quality_score_ectr | -| `QUALITY_SCORE_ECVR` | quality_score_ecvr | -| `QUALITY_SCORE_ORGANIC` | quality_score_organic | | `REACH` | reach | | `SOCIAL_SPEND` | social_spend | | `SPEND` | spend | diff --git a/docs/models/sourcefaker.md b/docs/models/sourcefaker.md new file mode 100644 index 00000000..f3afe26e --- /dev/null +++ b/docs/models/sourcefaker.md @@ -0,0 +1,13 @@ +# SourceFaker + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `always_updated` | *Optional[bool]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | How many users should be generated in total. The purchases table will be scaled to match, with 10 purchases created per 10 users. This setting does not apply to the products stream. | +| `parallelism` | *Optional[int]* | :heavy_minus_sign: | How many parallel workers should we use to generate fake data? Choose a value equal to the number of CPUs you will allocate to this source. | +| `records_per_slice` | *Optional[int]* | :heavy_minus_sign: | How many fake records will be in each page (stream slice), before a state message is emitted? | +| `seed` | *Optional[int]* | :heavy_minus_sign: | Manually control the faker random seed to return the same values on subsequent runs (leave -1 for random) | +| `source_type` | [models.Faker](../models/faker.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcefauna.md b/docs/models/sourcefauna.md similarity index 95% rename from docs/models/shared/sourcefauna.md rename to docs/models/sourcefauna.md index 5d1e9cf9..9fdc6c5d 100644 --- a/docs/models/shared/sourcefauna.md +++ b/docs/models/sourcefauna.md @@ -6,8 +6,8 @@ | 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. | +| `collection` | [Optional[models.Collection]](../models/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. | -| `source_type` | [shared.Fauna](../../models/shared/fauna.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `source_type` | [models.Fauna](../models/fauna.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcefaunadeletionmode.md b/docs/models/sourcefaunadeletionmode.md similarity index 100% rename from docs/models/shared/sourcefaunadeletionmode.md rename to docs/models/sourcefaunadeletionmode.md diff --git a/docs/models/shared/sourcefaunaschemasdeletionmode.md b/docs/models/sourcefaunaschemasdeletionmode.md similarity index 100% rename from docs/models/shared/sourcefaunaschemasdeletionmode.md rename to docs/models/sourcefaunaschemasdeletionmode.md diff --git a/docs/models/sourcefile.md b/docs/models/sourcefile.md new file mode 100644 index 00000000..70060a58 --- /dev/null +++ b/docs/models/sourcefile.md @@ -0,0 +1,13 @@ +# SourceFile + + +## Fields + +| 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). | | +| `provider` | [Union[models.HTTPSPublicWeb, models.GCSGoogleCloudStorage, models.SourceFileS3AmazonWebServices, models.AzBlobAzureBlobStorage, models.SSHSecureShell, models.SCPSecureCopyProtocol, models.SFTPSecureFileTransferProtocol]](../models/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[models.FileFormat]](../models/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` | [models.File](../models/file.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcefiles3amazonwebservices.md b/docs/models/sourcefiles3amazonwebservices.md similarity index 96% rename from docs/models/shared/sourcefiles3amazonwebservices.md rename to docs/models/sourcefiles3amazonwebservices.md index 5464e619..4a02222a 100644 --- a/docs/models/shared/sourcefiles3amazonwebservices.md +++ b/docs/models/sourcefiles3amazonwebservices.md @@ -7,4 +7,4 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `aws_access_key_id` | *Optional[str]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | 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` | [shared.SourceFileSchemasStorage](../../models/shared/sourcefileschemasstorage.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `storage` | [models.SourceFileSchemasStorage](../models/sourcefileschemasstorage.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcefileschemasproviderstorage.md b/docs/models/sourcefileschemasproviderstorage.md similarity index 100% rename from docs/models/shared/sourcefileschemasproviderstorage.md rename to docs/models/sourcefileschemasproviderstorage.md diff --git a/docs/models/shared/sourcefileschemasproviderstorageprovider6storage.md b/docs/models/sourcefileschemasproviderstorageprovider6storage.md similarity index 100% rename from docs/models/shared/sourcefileschemasproviderstorageprovider6storage.md rename to docs/models/sourcefileschemasproviderstorageprovider6storage.md diff --git a/docs/models/shared/sourcefileschemasproviderstorageprovider7storage.md b/docs/models/sourcefileschemasproviderstorageprovider7storage.md similarity index 100% rename from docs/models/shared/sourcefileschemasproviderstorageprovider7storage.md rename to docs/models/sourcefileschemasproviderstorageprovider7storage.md diff --git a/docs/models/shared/sourcefileschemasproviderstorageproviderstorage.md b/docs/models/sourcefileschemasproviderstorageproviderstorage.md similarity index 100% rename from docs/models/shared/sourcefileschemasproviderstorageproviderstorage.md rename to docs/models/sourcefileschemasproviderstorageproviderstorage.md diff --git a/docs/models/shared/sourcefileschemasstorage.md b/docs/models/sourcefileschemasstorage.md similarity index 100% rename from docs/models/shared/sourcefileschemasstorage.md rename to docs/models/sourcefileschemasstorage.md diff --git a/docs/models/shared/sourcefilestorage.md b/docs/models/sourcefilestorage.md similarity index 100% rename from docs/models/shared/sourcefilestorage.md rename to docs/models/sourcefilestorage.md diff --git a/docs/models/sourcefirebolt.md b/docs/models/sourcefirebolt.md new file mode 100644 index 00000000..34f7a97d --- /dev/null +++ b/docs/models/sourcefirebolt.md @@ -0,0 +1,14 @@ +# SourceFirebolt + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| `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 | +| `source_type` | [models.Firebolt](../models/firebolt.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcefreshcaller.md b/docs/models/sourcefreshcaller.md similarity index 97% rename from docs/models/shared/sourcefreshcaller.md rename to docs/models/sourcefreshcaller.md index d7ba20bb..4a05329b 100644 --- a/docs/models/shared/sourcefreshcaller.md +++ b/docs/models/sourcefreshcaller.md @@ -8,6 +8,6 @@ | `api_key` | *str* | :heavy_check_mark: | Freshcaller API Key. See the docs for more information on how to obtain this key. | | | `domain` | *str* | :heavy_check_mark: | Used to construct Base URL for the Freshcaller APIs | snaptravel | | `requests_per_minute` | *Optional[int]* | :heavy_minus_sign: | 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` | [shared.Freshcaller](../../models/shared/freshcaller.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.Freshcaller](../models/freshcaller.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. Any data created after this date will be replicated. | 2022-01-01T12:00:00Z | | `sync_lag_minutes` | *Optional[int]* | :heavy_minus_sign: | Lag in minutes for each sync, i.e., at time T, data for the time range [prev_sync_time, T-30] will be fetched | | \ No newline at end of file diff --git a/docs/models/shared/sourcefreshdesk.md b/docs/models/sourcefreshdesk.md similarity index 85% rename from docs/models/shared/sourcefreshdesk.md rename to docs/models/sourcefreshdesk.md index 0ef1cfe1..0e3bd68e 100644 --- a/docs/models/shared/sourcefreshdesk.md +++ b/docs/models/sourcefreshdesk.md @@ -7,6 +7,7 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | Freshdesk API Key. See the docs for more information on how to obtain this key. | | | `domain` | *str* | :heavy_check_mark: | Freshdesk domain | myaccount.freshdesk.com | +| `lookback_window_in_days` | *Optional[int]* | :heavy_minus_sign: | Number of days for lookback window for the stream Satisfaction Ratings | | | `requests_per_minute` | *Optional[int]* | :heavy_minus_sign: | 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` | [shared.Freshdesk](../../models/shared/freshdesk.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.Freshdesk](../models/freshdesk.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. Any data created after this date will be replicated. If this parameter is not set, all data will be replicated. | 2020-12-01T00:00:00Z | \ No newline at end of file diff --git a/docs/models/shared/sourcefreshsales.md b/docs/models/sourcefreshsales.md similarity index 97% rename from docs/models/shared/sourcefreshsales.md rename to docs/models/sourcefreshsales.md index da5abf77..781bb334 100644 --- a/docs/models/shared/sourcefreshsales.md +++ b/docs/models/sourcefreshsales.md @@ -7,4 +7,4 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | Freshsales API Key. See here. The key is case sensitive. | | | `domain_name` | *str* | :heavy_check_mark: | The Name of your Freshsales domain | mydomain.myfreshworks.com | -| `source_type` | [shared.Freshsales](../../models/shared/freshsales.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `source_type` | [models.Freshsales](../models/freshsales.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcegainsightpx.md b/docs/models/sourcegainsightpx.md similarity index 93% rename from docs/models/shared/sourcegainsightpx.md rename to docs/models/sourcegainsightpx.md index cef6d183..2abb15ed 100644 --- a/docs/models/shared/sourcegainsightpx.md +++ b/docs/models/sourcegainsightpx.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | The Aptrinsic API Key which is recieved from the dashboard settings (ref - https://app.aptrinsic.com/settings/api-keys) | -| `source_type` | [shared.GainsightPx](../../models/shared/gainsightpx.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `source_type` | [models.GainsightPx](../models/gainsightpx.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegcs.md b/docs/models/sourcegcs.md similarity index 97% rename from docs/models/shared/sourcegcs.md rename to docs/models/sourcegcs.md index 7b24d138..5efa8794 100644 --- a/docs/models/shared/sourcegcs.md +++ b/docs/models/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 | | +| `streams` | List[[models.SourceGCSStreamConfig](../models/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` | [models.SourceGcsGcs](../models/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 | \ No newline at end of file diff --git a/docs/models/sourcegcsautogenerated.md b/docs/models/sourcegcsautogenerated.md new file mode 100644 index 00000000..ab2a7c2c --- /dev/null +++ b/docs/models/sourcegcsautogenerated.md @@ -0,0 +1,8 @@ +# SourceGcsAutogenerated + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `header_definition_type` | [Optional[models.SourceGcsSchemasHeaderDefinitionType]](../models/sourcegcsschemasheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegcscsvformat.md b/docs/models/sourcegcscsvformat.md similarity index 92% rename from docs/models/shared/sourcegcscsvformat.md rename to docs/models/sourcegcscsvformat.md index 59c2e0ed..13e5497f 100644 --- a/docs/models/shared/sourcegcscsvformat.md +++ b/docs/models/sourcegcscsvformat.md @@ -10,9 +10,10 @@ | `encoding` | *Optional[str]* | :heavy_minus_sign: | The character encoding of the CSV data. Leave blank to default to UTF8. See list of python encodings for allowable options. | | `escape_char` | *Optional[str]* | :heavy_minus_sign: | The character used for escaping special characters. To disallow escaping, leave this field blank. | | `false_values` | List[*str*] | :heavy_minus_sign: | A set of case-sensitive strings that should be interpreted as false values. | -| `filetype` | [Optional[shared.SourceGcsFiletype]](../../models/shared/sourcegcsfiletype.md) | :heavy_minus_sign: | N/A | -| `header_definition` | [Optional[Union[shared.SourceGcsFromCSV, shared.SourceGcsAutogenerated, shared.SourceGcsUserProvided]]](../../models/shared/sourcegcscsvheaderdefinition.md) | :heavy_minus_sign: | How headers will be defined. `User Provided` assumes the CSV does not have a header row and uses the headers provided and `Autogenerated` assumes the CSV does not have a header row and the CDK will generate headers using for `f{i}` where `i` is the index starting from 0. Else, the default behavior is to use the header from the CSV file. If a user wants to autogenerate or provide column names for a CSV having headers, they can skip rows. | -| `inference_type` | [Optional[shared.SourceGcsInferenceType]](../../models/shared/sourcegcsinferencetype.md) | :heavy_minus_sign: | How to infer the types of the columns. If none, inference default to strings. | +| `filetype` | [Optional[models.SourceGcsFiletype]](../models/sourcegcsfiletype.md) | :heavy_minus_sign: | N/A | +| `header_definition` | [Optional[Union[models.SourceGcsFromCSV, models.SourceGcsAutogenerated, models.SourceGcsUserProvided]]](../models/sourcegcscsvheaderdefinition.md) | :heavy_minus_sign: | How headers will be defined. `User Provided` assumes the CSV does not have a header row and uses the headers provided and `Autogenerated` assumes the CSV does not have a header row and the CDK will generate headers using for `f{i}` where `i` is the index starting from 0. Else, the default behavior is to use the header from the CSV file. If a user wants to autogenerate or provide column names for a CSV having headers, they can skip rows. | +| `ignore_errors_on_fields_mismatch` | *Optional[bool]* | :heavy_minus_sign: | Whether to ignore errors that occur when the number of fields in the CSV does not match the number of columns in the schema. | +| `inference_type` | [Optional[models.SourceGcsInferenceType]](../models/sourcegcsinferencetype.md) | :heavy_minus_sign: | How to infer the types of the columns. If none, inference default to strings. | | `null_values` | List[*str*] | :heavy_minus_sign: | A set of case-sensitive strings that should be interpreted as null values. For example, if the value 'NA' should be interpreted as null, enter 'NA' in this field. | | `quote_char` | *Optional[str]* | :heavy_minus_sign: | The character used for quoting CSV values. To disallow quoting, make this field blank. | | `skip_rows_after_header` | *Optional[int]* | :heavy_minus_sign: | The number of rows to skip after the header row. | diff --git a/docs/models/shared/sourcegcscsvheaderdefinition.md b/docs/models/sourcegcscsvheaderdefinition.md similarity index 77% rename from docs/models/shared/sourcegcscsvheaderdefinition.md rename to docs/models/sourcegcscsvheaderdefinition.md index 47b20472..db49630d 100644 --- a/docs/models/shared/sourcegcscsvheaderdefinition.md +++ b/docs/models/sourcegcscsvheaderdefinition.md @@ -8,18 +8,18 @@ How headers will be defined. `User Provided` assumes the CSV does not have a hea ### SourceGcsFromCSV ```python -sourceGcsCSVHeaderDefinition: shared.SourceGcsFromCSV = /* values here */ +sourceGcsCSVHeaderDefinition: models.SourceGcsFromCSV = /* values here */ ``` ### SourceGcsAutogenerated ```python -sourceGcsCSVHeaderDefinition: shared.SourceGcsAutogenerated = /* values here */ +sourceGcsCSVHeaderDefinition: models.SourceGcsAutogenerated = /* values here */ ``` ### SourceGcsUserProvided ```python -sourceGcsCSVHeaderDefinition: shared.SourceGcsUserProvided = /* values here */ +sourceGcsCSVHeaderDefinition: models.SourceGcsUserProvided = /* values here */ ``` diff --git a/docs/models/shared/sourcegcsfiletype.md b/docs/models/sourcegcsfiletype.md similarity index 100% rename from docs/models/shared/sourcegcsfiletype.md rename to docs/models/sourcegcsfiletype.md diff --git a/docs/models/shared/sourcegcsformat.md b/docs/models/sourcegcsformat.md similarity index 75% rename from docs/models/shared/sourcegcsformat.md rename to docs/models/sourcegcsformat.md index 0029bd10..d067ef0f 100644 --- a/docs/models/shared/sourcegcsformat.md +++ b/docs/models/sourcegcsformat.md @@ -8,6 +8,6 @@ The configuration options that are used to alter how to read incoming files that ### SourceGcsCSVFormat ```python -sourceGcsFormat: shared.SourceGcsCSVFormat = /* values here */ +sourceGcsFormat: models.SourceGcsCSVFormat = /* values here */ ``` diff --git a/docs/models/sourcegcsfromcsv.md b/docs/models/sourcegcsfromcsv.md new file mode 100644 index 00000000..e7bd2a80 --- /dev/null +++ b/docs/models/sourcegcsfromcsv.md @@ -0,0 +1,8 @@ +# SourceGcsFromCSV + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `header_definition_type` | [Optional[models.SourceGcsHeaderDefinitionType]](../models/sourcegcsheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegcsgcs.md b/docs/models/sourcegcsgcs.md similarity index 100% rename from docs/models/shared/sourcegcsgcs.md rename to docs/models/sourcegcsgcs.md diff --git a/docs/models/shared/sourcegcsheaderdefinitiontype.md b/docs/models/sourcegcsheaderdefinitiontype.md similarity index 100% rename from docs/models/shared/sourcegcsheaderdefinitiontype.md rename to docs/models/sourcegcsheaderdefinitiontype.md diff --git a/docs/models/shared/sourcegcsinferencetype.md b/docs/models/sourcegcsinferencetype.md similarity index 100% rename from docs/models/shared/sourcegcsinferencetype.md rename to docs/models/sourcegcsinferencetype.md diff --git a/docs/models/shared/sourcegcsschemasheaderdefinitiontype.md b/docs/models/sourcegcsschemasheaderdefinitiontype.md similarity index 100% rename from docs/models/shared/sourcegcsschemasheaderdefinitiontype.md rename to docs/models/sourcegcsschemasheaderdefinitiontype.md diff --git a/docs/models/shared/sourcegcsschemasstreamsheaderdefinitiontype.md b/docs/models/sourcegcsschemasstreamsheaderdefinitiontype.md similarity index 100% rename from docs/models/shared/sourcegcsschemasstreamsheaderdefinitiontype.md rename to docs/models/sourcegcsschemasstreamsheaderdefinitiontype.md diff --git a/docs/models/shared/sourcegcsstreamconfig.md b/docs/models/sourcegcsstreamconfig.md similarity index 97% rename from docs/models/shared/sourcegcsstreamconfig.md rename to docs/models/sourcegcsstreamconfig.md index 63c59da2..58063a51 100644 --- a/docs/models/shared/sourcegcsstreamconfig.md +++ b/docs/models/sourcegcsstreamconfig.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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. | +| `format` | [Union[models.SourceGcsCSVFormat]](../models/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. | @@ -13,4 +13,4 @@ | `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. | | `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 +| `validation_policy` | [Optional[models.SourceGcsValidationPolicy]](../models/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/sourcegcsuserprovided.md b/docs/models/sourcegcsuserprovided.md new file mode 100644 index 00000000..bb4860c8 --- /dev/null +++ b/docs/models/sourcegcsuserprovided.md @@ -0,0 +1,9 @@ +# SourceGcsUserProvided + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `column_names` | List[*str*] | :heavy_check_mark: | The column names that will be used while emitting the CSV records | +| `header_definition_type` | [Optional[models.SourceGcsSchemasStreamsHeaderDefinitionType]](../models/sourcegcsschemasstreamsheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegcsvalidationpolicy.md b/docs/models/sourcegcsvalidationpolicy.md similarity index 100% rename from docs/models/shared/sourcegcsvalidationpolicy.md rename to docs/models/sourcegcsvalidationpolicy.md diff --git a/docs/models/shared/sourcegetlago.md b/docs/models/sourcegetlago.md similarity index 92% rename from docs/models/shared/sourcegetlago.md rename to docs/models/sourcegetlago.md index 61ecea5f..e2dd0f9c 100644 --- a/docs/models/shared/sourcegetlago.md +++ b/docs/models/sourcegetlago.md @@ -7,4 +7,4 @@ | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | Your API Key. See here. | | `api_url` | *Optional[str]* | :heavy_minus_sign: | Your Lago API URL | -| `source_type` | [shared.Getlago](../../models/shared/getlago.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `source_type` | [models.Getlago](../models/getlago.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegithub.md b/docs/models/sourcegithub.md similarity index 96% rename from docs/models/shared/sourcegithub.md rename to docs/models/sourcegithub.md index c47578a1..776a7e1d 100644 --- a/docs/models/shared/sourcegithub.md +++ b/docs/models/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 | +| `credentials` | [Union[models.OAuth, models.SourceGithubPersonalAccessToken]](../models/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/a* for matching multiple repositories by pattern. | airbytehq/airbyte | | `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 | +| `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 | | `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 | -| `source_type` | [shared.SourceGithubGithub](../../models/shared/sourcegithubgithub.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.SourceGithubGithub](../models/sourcegithubgithub.md) | :heavy_check_mark: | N/A | | | `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 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 | 2021-03-01T00:00:00Z | \ No newline at end of file diff --git a/docs/models/sourcegithubauthentication.md b/docs/models/sourcegithubauthentication.md new file mode 100644 index 00000000..f8f90ddc --- /dev/null +++ b/docs/models/sourcegithubauthentication.md @@ -0,0 +1,19 @@ +# SourceGithubAuthentication + +Choose how to authenticate to GitHub + + +## Supported Types + +### OAuth + +```python +sourceGithubAuthentication: models.OAuth = /* values here */ +``` + +### SourceGithubPersonalAccessToken + +```python +sourceGithubAuthentication: models.SourceGithubPersonalAccessToken = /* values here */ +``` + diff --git a/docs/models/shared/sourcegithubgithub.md b/docs/models/sourcegithubgithub.md similarity index 100% rename from docs/models/shared/sourcegithubgithub.md rename to docs/models/sourcegithubgithub.md diff --git a/docs/models/shared/sourcegithuboptiontitle.md b/docs/models/sourcegithuboptiontitle.md similarity index 100% rename from docs/models/shared/sourcegithuboptiontitle.md rename to docs/models/sourcegithuboptiontitle.md diff --git a/docs/models/shared/sourcegithubpersonalaccesstoken.md b/docs/models/sourcegithubpersonalaccesstoken.md similarity index 96% rename from docs/models/shared/sourcegithubpersonalaccesstoken.md rename to docs/models/sourcegithubpersonalaccesstoken.md index 7e01d9ed..b3374a66 100644 --- a/docs/models/shared/sourcegithubpersonalaccesstoken.md +++ b/docs/models/sourcegithubpersonalaccesstoken.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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 +| `option_title` | [Optional[models.SourceGithubOptionTitle]](../models/sourcegithuboptiontitle.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegitlab.md b/docs/models/sourcegitlab.md similarity index 96% rename from docs/models/shared/sourcegitlab.md rename to docs/models/sourcegitlab.md index 00e9b9e4..abbc7d35 100644 --- a/docs/models/shared/sourcegitlab.md +++ b/docs/models/sourcegitlab.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `credentials` | [Union[shared.SourceGitlabOAuth20, shared.PrivateToken]](../../models/shared/sourcegitlabauthorizationmethod.md) | :heavy_check_mark: | N/A | | +| `credentials` | [Union[models.SourceGitlabOAuth20, models.PrivateToken]](../models/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 | | `projects_list` | List[*str*] | :heavy_minus_sign: | Space-delimited list of projects. e.g. airbyte.io/documentation meltano/tap-gitlab. | airbyte.io/documentation | -| `source_type` | [shared.SourceGitlabGitlab](../../models/shared/sourcegitlabgitlab.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.SourceGitlabGitlab](../models/sourcegitlabgitlab.md) | :heavy_check_mark: | N/A | | | `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 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. | 2021-03-01T00:00:00Z | \ No newline at end of file diff --git a/docs/models/sourcegitlabauthorizationmethod.md b/docs/models/sourcegitlabauthorizationmethod.md new file mode 100644 index 00000000..f7d58d73 --- /dev/null +++ b/docs/models/sourcegitlabauthorizationmethod.md @@ -0,0 +1,17 @@ +# SourceGitlabAuthorizationMethod + + +## Supported Types + +### SourceGitlabOAuth20 + +```python +sourceGitlabAuthorizationMethod: models.SourceGitlabOAuth20 = /* values here */ +``` + +### PrivateToken + +```python +sourceGitlabAuthorizationMethod: models.PrivateToken = /* values here */ +``` + diff --git a/docs/models/shared/sourcegitlabauthtype.md b/docs/models/sourcegitlabauthtype.md similarity index 100% rename from docs/models/shared/sourcegitlabauthtype.md rename to docs/models/sourcegitlabauthtype.md diff --git a/docs/models/shared/sourcegitlabgitlab.md b/docs/models/sourcegitlabgitlab.md similarity index 100% rename from docs/models/shared/sourcegitlabgitlab.md rename to docs/models/sourcegitlabgitlab.md diff --git a/docs/models/sourcegitlaboauth20.md b/docs/models/sourcegitlaboauth20.md new file mode 100644 index 00000000..7d62731e --- /dev/null +++ b/docs/models/sourcegitlaboauth20.md @@ -0,0 +1,13 @@ +# SourceGitlabOAuth20 + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `access_token` | *str* | :heavy_check_mark: | Access Token for making authenticated requests. | +| `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. | +| `auth_type` | [Optional[models.SourceGitlabAuthType]](../models/sourcegitlabauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegitlabschemasauthtype.md b/docs/models/sourcegitlabschemasauthtype.md similarity index 100% rename from docs/models/shared/sourcegitlabschemasauthtype.md rename to docs/models/sourcegitlabschemasauthtype.md diff --git a/docs/models/sourceglassfrog.md b/docs/models/sourceglassfrog.md new file mode 100644 index 00000000..acaa3385 --- /dev/null +++ b/docs/models/sourceglassfrog.md @@ -0,0 +1,9 @@ +# SourceGlassfrog + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | +| `api_key` | *str* | :heavy_check_mark: | API key provided by Glassfrog | +| `source_type` | [models.Glassfrog](../models/glassfrog.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegnews.md b/docs/models/sourcegnews.md similarity index 99% rename from docs/models/shared/sourcegnews.md rename to docs/models/sourcegnews.md index a98386f7..3499c553 100644 --- a/docs/models/shared/sourcegnews.md +++ b/docs/models/sourcegnews.md @@ -7,13 +7,13 @@ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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. | | +| `country` | [Optional[models.Country]](../models/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 | | -| `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 | | +| `in_` | List[[models.In](../models/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[models.Language]](../models/language.md) | :heavy_minus_sign: | N/A | | +| `nullable` | List[[models.Nullable](../models/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 | | +| `sortby` | [Optional[models.SortBy]](../models/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` | [models.Gnews](../models/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 | | `top_headlines_query` | *Optional[str]* | :heavy_minus_sign: | 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 | -| `top_headlines_topic` | [Optional[shared.TopHeadlinesTopic]](../../models/shared/topheadlinestopic.md) | :heavy_minus_sign: | This parameter allows you to change the category for the request. | | \ No newline at end of file +| `top_headlines_topic` | [Optional[models.TopHeadlinesTopic]](../models/topheadlinestopic.md) | :heavy_minus_sign: | This parameter allows you to change the category for the request. | | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleads.md b/docs/models/sourcegoogleads.md similarity index 96% rename from docs/models/shared/sourcegoogleads.md rename to docs/models/sourcegoogleads.md index 92260c05..8bcf2939 100644 --- a/docs/models/shared/sourcegoogleads.md +++ b/docs/models/sourcegoogleads.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `credentials` | [shared.GoogleCredentials](../../models/shared/googlecredentials.md) | :heavy_check_mark: | N/A | | +| `credentials` | [models.GoogleCredentials](../models/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 | | +| `custom_queries_array` | List[[models.CustomQueriesArray](../models/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. | | +| `customer_status_filter` | List[[models.CustomerStatus](../models/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. | | | `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 after this date will not be replicated. (Default value of today is used if not set) | 2017-01-30 | -| `source_type` | [shared.SourceGoogleAdsGoogleAds](../../models/shared/sourcegoogleadsgoogleads.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.SourceGoogleAdsGoogleAds](../models/sourcegoogleadsgoogleads.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. (Default value of two years ago is used if not set) | 2017-01-25 | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleadsgoogleads.md b/docs/models/sourcegoogleadsgoogleads.md similarity index 100% rename from docs/models/shared/sourcegoogleadsgoogleads.md rename to docs/models/sourcegoogleadsgoogleads.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapi.md b/docs/models/sourcegoogleanalyticsdataapi.md similarity index 97% rename from docs/models/shared/sourcegoogleanalyticsdataapi.md rename to docs/models/sourcegoogleanalyticsdataapi.md index fa6279c0..f2b3c4cc 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapi.md +++ b/docs/models/sourcegoogleanalyticsdataapi.md @@ -7,9 +7,9 @@ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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"
    ] | | `convert_conversions_event` | *Optional[bool]* | :heavy_minus_sign: | Enables conversion of `conversions:*` event metrics from integers to floats. This is beneficial for preventing data rounding when the API returns float values for any `conversions:*` fields. | | -| `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. | | +| `credentials` | [Optional[Union[models.AuthenticateViaGoogleOauth, models.ServiceAccountKeyAuthentication]]](../models/sourcegoogleanalyticsdataapicredentials.md) | :heavy_minus_sign: | Credentials for the service | | +| `custom_reports_array` | List[[models.SourceGoogleAnalyticsDataAPICustomReportConfig](../models/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. | | -| `source_type` | [shared.SourceGoogleAnalyticsDataAPIGoogleAnalyticsDataAPI](../../models/shared/sourcegoogleanalyticsdataapigoogleanalyticsdataapi.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.SourceGoogleAnalyticsDataAPIGoogleAnalyticsDataAPI](../models/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/sourcegoogleanalyticsdataapiandgroup.md b/docs/models/sourcegoogleanalyticsdataapiandgroup.md new file mode 100644 index 00000000..878b8fe2 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapiandgroup.md @@ -0,0 +1,11 @@ +# SourceGoogleAnalyticsDataAPIAndGroup + +The FilterExpressions in andGroup have an AND relationship. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `expressions` | List[[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayExpression](../models/sourcegoogleanalyticsdataapischemascustomreportsarrayexpression.md)] | :heavy_check_mark: | N/A | +| `filter_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterFilterType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfiltertype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapiauthtype.md b/docs/models/sourcegoogleanalyticsdataapiauthtype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapiauthtype.md rename to docs/models/sourcegoogleanalyticsdataapiauthtype.md diff --git a/docs/models/sourcegoogleanalyticsdataapibetweenfilter.md b/docs/models/sourcegoogleanalyticsdataapibetweenfilter.md new file mode 100644 index 00000000..8a8f8974 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapibetweenfilter.md @@ -0,0 +1,10 @@ +# SourceGoogleAnalyticsDataAPIBetweenFilter + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `from_value` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterInt64Value, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterDoubleValue]](../models/sourcegoogleanalyticsdataapifromvalue.md) | :heavy_check_mark: | N/A | +| `to_value` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterInt64Value, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterDoubleValue]](../models/sourcegoogleanalyticsdataapitovalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterFilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapicredentials.md b/docs/models/sourcegoogleanalyticsdataapicredentials.md new file mode 100644 index 00000000..9d5a2ae2 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapicredentials.md @@ -0,0 +1,19 @@ +# SourceGoogleAnalyticsDataAPICredentials + +Credentials for the service + + +## Supported Types + +### AuthenticateViaGoogleOauth + +```python +sourceGoogleAnalyticsDataAPICredentials: models.AuthenticateViaGoogleOauth = /* values here */ +``` + +### ServiceAccountKeyAuthentication + +```python +sourceGoogleAnalyticsDataAPICredentials: models.ServiceAccountKeyAuthentication = /* values here */ +``` + diff --git a/docs/models/sourcegoogleanalyticsdataapicustomreportconfig.md b/docs/models/sourcegoogleanalyticsdataapicustomreportconfig.md new file mode 100644 index 00000000..d35cde56 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapicustomreportconfig.md @@ -0,0 +1,13 @@ +# SourceGoogleAnalyticsDataAPICustomReportConfig + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `dimensions` | List[*str*] | :heavy_check_mark: | A list of dimensions. | +| `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. | +| `cohort_spec` | [Optional[Union[models.SourceGoogleAnalyticsDataAPIDisabled, models.SourceGoogleAnalyticsDataAPISchemasEnabled]]](../models/cohortreports.md) | :heavy_minus_sign: | Cohort reports creates a time series of user retention for the cohort. | +| `dimension_filter` | [Optional[Union[models.AndGroup, models.OrGroup, models.NotExpression, models.Filter]]](../models/dimensionsfilter.md) | :heavy_minus_sign: | Dimensions filter | +| `metric_filter` | [Optional[Union[models.SourceGoogleAnalyticsDataAPIAndGroup, models.SourceGoogleAnalyticsDataAPIOrGroup, models.SourceGoogleAnalyticsDataAPINotExpression, models.SourceGoogleAnalyticsDataAPIFilter]]](../models/metricsfilter.md) | :heavy_minus_sign: | Metrics filter | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapidisabled.md b/docs/models/sourcegoogleanalyticsdataapidisabled.md new file mode 100644 index 00000000..10cfbee2 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapidisabled.md @@ -0,0 +1,8 @@ +# SourceGoogleAnalyticsDataAPIDisabled + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `enabled` | [Optional[models.SourceGoogleAnalyticsDataAPIEnabled]](../models/sourcegoogleanalyticsdataapienabled.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapidoublevalue.md b/docs/models/sourcegoogleanalyticsdataapidoublevalue.md new file mode 100644 index 00000000..633472de --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapidoublevalue.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPIDoubleValue + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *float* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarrayvaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapienabled.md b/docs/models/sourcegoogleanalyticsdataapienabled.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapienabled.md rename to docs/models/sourcegoogleanalyticsdataapienabled.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapiexpression.md b/docs/models/sourcegoogleanalyticsdataapiexpression.md similarity index 80% rename from docs/models/shared/sourcegoogleanalyticsdataapiexpression.md rename to docs/models/sourcegoogleanalyticsdataapiexpression.md index 0ed55ccf..000162c2 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapiexpression.md +++ b/docs/models/sourcegoogleanalyticsdataapiexpression.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `field_name` | *str* | :heavy_check_mark: | N/A | -| `filter_` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterStringFilter, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterInListFilter, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterNumericFilter, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterBetweenFilter]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfilter.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `field_name` | *str* | :heavy_check_mark: | N/A | +| `filter_` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterStringFilter, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterInListFilter, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterNumericFilter, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterBetweenFilter]](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfilter.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapifilter.md b/docs/models/sourcegoogleanalyticsdataapifilter.md new file mode 100644 index 00000000..8bc4a6e8 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapifilter.md @@ -0,0 +1,12 @@ +# SourceGoogleAnalyticsDataAPIFilter + +A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all metrics. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `field_name` | *str* | :heavy_check_mark: | N/A | +| `filter_` | [Union[models.SourceGoogleAnalyticsDataAPIStringFilter, models.SourceGoogleAnalyticsDataAPIInListFilter, models.SourceGoogleAnalyticsDataAPINumericFilter, models.SourceGoogleAnalyticsDataAPIBetweenFilter]](../models/sourcegoogleanalyticsdataapischemascustomreportsarrayfilter.md) | :heavy_check_mark: | N/A | +| `filter_type` | [Optional[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterType]](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtertype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapifiltername.md b/docs/models/sourcegoogleanalyticsdataapifiltername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapifiltername.md rename to docs/models/sourcegoogleanalyticsdataapifiltername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapifiltertype.md b/docs/models/sourcegoogleanalyticsdataapifiltertype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapifiltertype.md rename to docs/models/sourcegoogleanalyticsdataapifiltertype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapifromvalue.md b/docs/models/sourcegoogleanalyticsdataapifromvalue.md similarity index 76% rename from docs/models/shared/sourcegoogleanalyticsdataapifromvalue.md rename to docs/models/sourcegoogleanalyticsdataapifromvalue.md index 831a6784..bc442ea3 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapifromvalue.md +++ b/docs/models/sourcegoogleanalyticsdataapifromvalue.md @@ -6,12 +6,12 @@ ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterInt64Value ```python -sourceGoogleAnalyticsDataAPIFromValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterInt64Value = /* values here */ +sourceGoogleAnalyticsDataAPIFromValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterInt64Value = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterDoubleValue ```python -sourceGoogleAnalyticsDataAPIFromValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterDoubleValue = /* values here */ +sourceGoogleAnalyticsDataAPIFromValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterDoubleValue = /* values here */ ``` diff --git a/docs/models/shared/sourcegoogleanalyticsdataapigoogleanalyticsdataapi.md b/docs/models/sourcegoogleanalyticsdataapigoogleanalyticsdataapi.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapigoogleanalyticsdataapi.md rename to docs/models/sourcegoogleanalyticsdataapigoogleanalyticsdataapi.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapigranularity.md b/docs/models/sourcegoogleanalyticsdataapigranularity.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapigranularity.md rename to docs/models/sourcegoogleanalyticsdataapigranularity.md diff --git a/docs/models/sourcegoogleanalyticsdataapiinlistfilter.md b/docs/models/sourcegoogleanalyticsdataapiinlistfilter.md new file mode 100644 index 00000000..0c650c45 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapiinlistfilter.md @@ -0,0 +1,10 @@ +# SourceGoogleAnalyticsDataAPIInListFilter + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `values` | List[*str*] | :heavy_check_mark: | N/A | +| `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapiint64value.md b/docs/models/sourcegoogleanalyticsdataapiint64value.md new file mode 100644 index 00000000..339c0efc --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapiint64value.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPIInt64Value + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasValueType](../models/sourcegoogleanalyticsdataapischemasvaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapinotexpression.md b/docs/models/sourcegoogleanalyticsdataapinotexpression.md new file mode 100644 index 00000000..02bd1bfc --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapinotexpression.md @@ -0,0 +1,11 @@ +# SourceGoogleAnalyticsDataAPINotExpression + +The FilterExpression is NOT of notExpression. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `expression` | [Optional[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterExpression]](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterexpression.md) | :heavy_minus_sign: | N/A | +| `filter_type` | [Optional[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3FilterType]](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filtertype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapinumericfilter.md b/docs/models/sourcegoogleanalyticsdataapinumericfilter.md new file mode 100644 index 00000000..45d55c14 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapinumericfilter.md @@ -0,0 +1,10 @@ +# SourceGoogleAnalyticsDataAPINumericFilter + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `operation` | List[[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterValidEnums](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervalidenums.md)] | :heavy_check_mark: | N/A | +| `value` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayInt64Value, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDoubleValue]](../models/sourcegoogleanalyticsdataapivalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapiorgroup.md b/docs/models/sourcegoogleanalyticsdataapiorgroup.md new file mode 100644 index 00000000..8bcfaff6 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapiorgroup.md @@ -0,0 +1,11 @@ +# SourceGoogleAnalyticsDataAPIOrGroup + +The FilterExpressions in orGroup have an OR relationship. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `expressions` | List[[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterExpression](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterexpression.md)] | :heavy_check_mark: | N/A | +| `filter_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFilterType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfiltertype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemasauthtype.md b/docs/models/sourcegoogleanalyticsdataapischemasauthtype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemasauthtype.md rename to docs/models/sourcegoogleanalyticsdataapischemasauthtype.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemasbetweenfilter.md b/docs/models/sourcegoogleanalyticsdataapischemasbetweenfilter.md new file mode 100644 index 00000000..02d97a31 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemasbetweenfilter.md @@ -0,0 +1,10 @@ +# SourceGoogleAnalyticsDataAPISchemasBetweenFilter + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `from_value` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionInt64Value, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionDoubleValue]](../models/sourcegoogleanalyticsdataapischemasfromvalue.md) | :heavy_check_mark: | N/A | +| `to_value` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterInt64Value, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterDoubleValue]](../models/sourcegoogleanalyticsdataapischemastovalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterFilterFilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilterfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraybetweenfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraybetweenfilter.md new file mode 100644 index 00000000..224ea9ec --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraybetweenfilter.md @@ -0,0 +1,10 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayBetweenFilter + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `from_value` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsInt64Value, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsDoubleValue]](../models/sourcegoogleanalyticsdataapischemascustomreportsarrayfromvalue.md) | :heavy_check_mark: | N/A | +| `to_value` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterInt64Value, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterDoubleValue]](../models/sourcegoogleanalyticsdataapischemascustomreportsarraytovalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterFilterFilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilterfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterbetweenfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterbetweenfilter.md new file mode 100644 index 00000000..57bceffa --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterbetweenfilter.md @@ -0,0 +1,10 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterBetweenFilter + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `from_value` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterInt64Value, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDoubleValue]](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfromvalue.md) | :heavy_check_mark: | N/A | +| `to_value` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterInt64Value, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterDoubleValue]](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltertovalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsFilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1doublevalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1doublevalue.md new file mode 100644 index 00000000..71e6a60b --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1doublevalue.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1DoubleValue + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `value` | *float* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsvaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsdoublevalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsdoublevalue.md new file mode 100644 index 00000000..49db33ee --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsdoublevalue.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsDoubleValue + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `value` | *float* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterFilterValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterdoublevalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterdoublevalue.md new file mode 100644 index 00000000..3e9d0a51 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterdoublevalue.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterDoubleValue + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *float* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterFilter4ToValueValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilter4tovaluevaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilter4tovaluevaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilter4tovaluevaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilter4tovaluevaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilter4tovaluevaluetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilter4valuetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilter4valuetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilter4valuetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilter4valuetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilterfiltername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilterfiltername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilterfiltername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilterfiltername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfiltername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfiltername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfiltername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfiltername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfiltervaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfiltervaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfiltervaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfiltervaluetype.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterint64value.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterint64value.md new file mode 100644 index 00000000..7797b0bf --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterint64value.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterInt64Value + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterFilter4ValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilter4valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfiltername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfiltername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfiltername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfiltername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfiltervaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfiltervaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfiltervaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfiltervaluetype.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsint64value.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsint64value.md new file mode 100644 index 00000000..69e81786 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsint64value.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsInt64Value + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `value` | *str* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsvalidenums.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsvalidenums.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsvalidenums.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsvalidenums.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsvaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsvaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsvaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsvaluetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1filter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1filter.md similarity index 78% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1filter.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1filter.md index 91d999e3..a7f50a7b 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1filter.md +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1filter.md @@ -6,24 +6,24 @@ ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayStringFilter ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1Filter: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayStringFilter = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1Filter: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayStringFilter = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayInListFilter ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1Filter: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayInListFilter = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1Filter: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayInListFilter = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayNumericFilter ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1Filter: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayNumericFilter = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1Filter: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayNumericFilter = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayBetweenFilter ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1Filter: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayBetweenFilter = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1Filter: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayBetweenFilter = /* values here */ ``` diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1filtername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1filtername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1filtername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1filtername.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1int64value.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1int64value.md new file mode 100644 index 00000000..af6f6b23 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1int64value.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1Int64Value + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1validenums.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1validenums.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1validenums.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1validenums.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1valuetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1valuetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1valuetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1valuetype.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2doublevalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2doublevalue.md new file mode 100644 index 00000000..90f852c0 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2doublevalue.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2DoubleValue + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `value` | *float* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsvaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfilterfilter4tovaluevaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfilterfilter4tovaluevaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfilterfilter4tovaluevaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfilterfilter4tovaluevaluetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfilterfilter4valuetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfilterfilter4valuetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfilterfilter4valuetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfilterfilter4valuetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfilterfiltervaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfilterfiltervaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfilterfiltervaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfilterfiltervaluetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfiltername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfiltername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfiltername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfiltername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfiltervaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfiltervaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfiltervaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfiltervaluetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsvaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsvaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsvaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsvaluetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2filtername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2filtername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2filtername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2filtername.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2int64value.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2int64value.md new file mode 100644 index 00000000..feee9d59 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2int64value.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2Int64Value + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2validenums.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2validenums.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2validenums.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2validenums.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2valuetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2valuetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2valuetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2valuetype.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3doublevalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3doublevalue.md new file mode 100644 index 00000000..f1de7577 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3doublevalue.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3DoubleValue + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *float* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionvaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressiondoublevalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressiondoublevalue.md new file mode 100644 index 00000000..7d80f78d --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressiondoublevalue.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionDoubleValue + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *float* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterFilterValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterdoublevalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterdoublevalue.md new file mode 100644 index 00000000..313fc76f --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterdoublevalue.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterDoubleValue + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *float* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterFilter4ToValueValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilter4tovaluevaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilter4tovaluevaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilter4tovaluevaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilter4tovaluevaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilter4tovaluevaluetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilter4valuetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilter4valuetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilter4valuetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilter4valuetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilterfiltername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilterfiltername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilterfiltername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilterfiltername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfiltername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfiltername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfiltername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfiltername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfiltervaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfiltervaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfiltervaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfiltervaluetype.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterint64value.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterint64value.md new file mode 100644 index 00000000..3c47e552 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterint64value.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterInt64Value + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `value` | *str* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterFilter4ValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilter4valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfiltername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfiltername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfiltername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfiltername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfiltervaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfiltervaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfiltervaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfiltervaluetype.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionint64value.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionint64value.md new file mode 100644 index 00000000..105452e3 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionint64value.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionInt64Value + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionvaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionvaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionvaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionvaluetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3filtername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3filtername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3filtername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3filtername.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3int64value.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3int64value.md new file mode 100644 index 00000000..f0aa416e --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3int64value.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3Int64Value + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3validenums.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3validenums.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3validenums.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3validenums.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3valuetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3valuetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3valuetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3valuetype.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterdoublevalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterdoublevalue.md new file mode 100644 index 00000000..7198118a --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterdoublevalue.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterDoubleValue + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *float* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsFilterFilter4ToValueValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfilterfilter4tovaluevaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterfilter.md similarity index 75% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterfilter.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterfilter.md index 4419ee4e..931f3831 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterfilter.md +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterfilter.md @@ -6,24 +6,24 @@ ### SourceGoogleAnalyticsDataAPISchemasStringFilter ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterFilter: shared.SourceGoogleAnalyticsDataAPISchemasStringFilter = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterFilter: models.SourceGoogleAnalyticsDataAPISchemasStringFilter = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasInListFilter ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterFilter: shared.SourceGoogleAnalyticsDataAPISchemasInListFilter = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterFilter: models.SourceGoogleAnalyticsDataAPISchemasInListFilter = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasNumericFilter ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterFilter: shared.SourceGoogleAnalyticsDataAPISchemasNumericFilter = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterFilter: models.SourceGoogleAnalyticsDataAPISchemasNumericFilter = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasBetweenFilter ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterFilter: shared.SourceGoogleAnalyticsDataAPISchemasBetweenFilter = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterFilter: models.SourceGoogleAnalyticsDataAPISchemasBetweenFilter = /* values here */ ``` diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterfiltername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterfiltername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterfiltername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterfiltername.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterint64value.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterint64value.md new file mode 100644 index 00000000..cd286074 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterint64value.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterInt64Value + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsFilterFilter4ValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfilterfilter4valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfiltervalidenums.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfiltervalidenums.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfiltervalidenums.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfiltervalidenums.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfiltervaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfiltervaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfiltervaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfiltervaluetype.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdoublevalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdoublevalue.md new file mode 100644 index 00000000..beecd7c9 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdoublevalue.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDoubleValue + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `value` | *float* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsFilterFilterValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfilterfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfilter.md similarity index 79% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfilter.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfilter.md index ca13b09a..3ad9b682 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfilter.md +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfilter.md @@ -6,24 +6,24 @@ ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterStringFilter ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterFilter: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterStringFilter = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterFilter: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterStringFilter = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterInListFilter ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterFilter: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterInListFilter = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterFilter: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterInListFilter = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterNumericFilter ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterFilter: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterNumericFilter = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterFilter: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterNumericFilter = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterBetweenFilter ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterFilter: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterBetweenFilter = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterFilter: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterBetweenFilter = /* values here */ ``` diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfiltername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfiltername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfiltername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfiltername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfromvalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfromvalue.md similarity index 80% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfromvalue.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfromvalue.md index 40543b8a..d59cd7e9 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfromvalue.md +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfromvalue.md @@ -6,12 +6,12 @@ ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterInt64Value ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterFromValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterInt64Value = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterFromValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterInt64Value = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDoubleValue ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterFromValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDoubleValue = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterFromValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDoubleValue = /* values here */ ``` diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterinlistfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterinlistfilter.md new file mode 100644 index 00000000..dc839657 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterinlistfilter.md @@ -0,0 +1,10 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterInListFilter + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `values` | List[*str*] | :heavy_check_mark: | N/A | +| `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterFilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterint64value.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterint64value.md new file mode 100644 index 00000000..bb0bc7ed --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterint64value.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterInt64Value + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `value` | *str* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsFilterValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilternumericfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilternumericfilter.md new file mode 100644 index 00000000..da9b49fe --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilternumericfilter.md @@ -0,0 +1,10 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterNumericFilter + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `operation` | List[[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterValidEnums](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervalidenums.md)] | :heavy_check_mark: | N/A | +| `value` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2Int64Value, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2DoubleValue]](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2FilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2filtername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterstringfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterstringfilter.md new file mode 100644 index 00000000..d82e12a6 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterstringfilter.md @@ -0,0 +1,11 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterStringFilter + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterFilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfiltername.md) | :heavy_check_mark: | N/A | +| `match_type` | List[[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ValidEnums](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2validenums.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltertovalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltertovalue.md similarity index 82% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltertovalue.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltertovalue.md index adc2bb0d..0548f99b 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltertovalue.md +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltertovalue.md @@ -6,12 +6,12 @@ ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterInt64Value ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterToValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterInt64Value = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterToValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterInt64Value = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterDoubleValue ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterToValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterDoubleValue = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterToValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterDoubleValue = /* values here */ ``` diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervalidenums.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervalidenums.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervalidenums.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervalidenums.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervalue.md similarity index 82% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervalue.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervalue.md index f5f7c066..1055b14f 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervalue.md +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervalue.md @@ -6,12 +6,12 @@ ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2Int64Value ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2Int64Value = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2Int64Value = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2DoubleValue ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2DoubleValue = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2DoubleValue = /* values here */ ``` diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervaluetype.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydoublevalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydoublevalue.md new file mode 100644 index 00000000..cdc881f1 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraydoublevalue.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDoubleValue + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `value` | *float* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayenabled.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayenabled.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayenabled.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayenabled.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayexpression.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayexpression.md similarity index 77% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayexpression.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayexpression.md index 920a23b4..36ba0f48 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayexpression.md +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayexpression.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `field_name` | *str* | :heavy_check_mark: | N/A | -| `filter_` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterStringFilter, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterInListFilter, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterNumericFilter, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterBetweenFilter]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfilter.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `field_name` | *str* | :heavy_check_mark: | N/A | +| `filter_` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterStringFilter, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterInListFilter, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterNumericFilter, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterBetweenFilter]](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfilter.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayfilter.md new file mode 100644 index 00000000..838ee2ce --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayfilter.md @@ -0,0 +1,29 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayFilter + + +## Supported Types + +### SourceGoogleAnalyticsDataAPIStringFilter + +```python +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayFilter: models.SourceGoogleAnalyticsDataAPIStringFilter = /* values here */ +``` + +### SourceGoogleAnalyticsDataAPIInListFilter + +```python +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayFilter: models.SourceGoogleAnalyticsDataAPIInListFilter = /* values here */ +``` + +### SourceGoogleAnalyticsDataAPINumericFilter + +```python +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayFilter: models.SourceGoogleAnalyticsDataAPINumericFilter = /* values here */ +``` + +### SourceGoogleAnalyticsDataAPIBetweenFilter + +```python +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayFilter: models.SourceGoogleAnalyticsDataAPIBetweenFilter = /* values here */ +``` + diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayfiltername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayfiltername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayfiltername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayfiltername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayfiltertype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayfiltertype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayfiltertype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayfiltertype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayfromvalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayfromvalue.md similarity index 82% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayfromvalue.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayfromvalue.md index 473d269a..8fd3cdec 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayfromvalue.md +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayfromvalue.md @@ -6,12 +6,12 @@ ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsInt64Value ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayFromValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsInt64Value = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayFromValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsInt64Value = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsDoubleValue ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayFromValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsDoubleValue = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayFromValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsDoubleValue = /* values here */ ``` diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayinlistfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayinlistfilter.md new file mode 100644 index 00000000..7fbba7c6 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayinlistfilter.md @@ -0,0 +1,10 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayInListFilter + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `values` | List[*str*] | :heavy_check_mark: | N/A | +| `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayint64value.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayint64value.md new file mode 100644 index 00000000..e221f5b0 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayint64value.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayInt64Value + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterbetweenfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterbetweenfilter.md new file mode 100644 index 00000000..86f164b2 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterbetweenfilter.md @@ -0,0 +1,10 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterBetweenFilter + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `from_value` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterInt64Value, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterDoubleValue]](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfromvalue.md) | :heavy_check_mark: | N/A | +| `to_value` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1Int64Value, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1DoubleValue]](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltertovalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterdoublevalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterdoublevalue.md new file mode 100644 index 00000000..97ce2360 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterdoublevalue.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterDoubleValue + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *float* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterexpression.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterexpression.md similarity index 78% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterexpression.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterexpression.md index 97c1f671..bcbca796 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterexpression.md +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterexpression.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `field_name` | *str* | :heavy_check_mark: | N/A | -| `filter_` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterStringFilter, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterInListFilter, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterNumericFilter, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterBetweenFilter]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfilter.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `field_name` | *str* | :heavy_check_mark: | N/A | +| `filter_` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterStringFilter, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterInListFilter, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterNumericFilter, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterBetweenFilter]](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfilter.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfilter.md similarity index 78% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfilter.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfilter.md index 9149ebec..ee04b22c 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfilter.md +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfilter.md @@ -6,24 +6,24 @@ ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterStringFilter ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterFilter: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterStringFilter = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterFilter: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterStringFilter = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterInListFilter ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterFilter: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterInListFilter = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterFilter: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterInListFilter = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterNumericFilter ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterFilter: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterNumericFilter = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterFilter: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterNumericFilter = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterBetweenFilter ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterFilter: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterBetweenFilter = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterFilter: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterBetweenFilter = /* values here */ ``` diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfiltername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfiltername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfiltername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfiltername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfiltertype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfiltertype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfiltertype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfiltertype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfromvalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfromvalue.md similarity index 83% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfromvalue.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfromvalue.md index ad28c516..51af0b3c 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfromvalue.md +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfromvalue.md @@ -6,12 +6,12 @@ ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterInt64Value ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterFromValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterInt64Value = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterFromValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterInt64Value = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterDoubleValue ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterFromValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterDoubleValue = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterFromValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterDoubleValue = /* values here */ ``` diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterinlistfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterinlistfilter.md new file mode 100644 index 00000000..a90c550a --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterinlistfilter.md @@ -0,0 +1,10 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterInListFilter + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `values` | List[*str*] | :heavy_check_mark: | N/A | +| `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilterFilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilterfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterint64value.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterint64value.md new file mode 100644 index 00000000..61a702b8 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterint64value.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterInt64Value + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4ValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1doublevalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1doublevalue.md new file mode 100644 index 00000000..bdb1850e --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1doublevalue.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1DoubleValue + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `value` | *float* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilterValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsdoublevalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsdoublevalue.md new file mode 100644 index 00000000..f189f0dd --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsdoublevalue.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsDoubleValue + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `value` | *float* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilter3ValueValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilter3valuevaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterdoublevalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterdoublevalue.md new file mode 100644 index 00000000..16ecf1a7 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterdoublevalue.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterDoubleValue + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `value` | *float* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsvaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilter3valuetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilter3valuetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilter3valuetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilter3valuetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilter3valuevaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilter3valuevaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilter3valuevaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilter3valuevaluetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilterfiltername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilterfiltername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilterfiltername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilterfiltername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfiltername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfiltername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfiltername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfiltername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfiltervaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfiltervaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfiltervaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfiltervaluetype.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterint64value.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterint64value.md new file mode 100644 index 00000000..26bc7d17 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterint64value.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterInt64Value + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfiltername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfiltername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfiltername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfiltername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfiltervaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfiltervaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfiltervaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfiltervaluetype.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsint64value.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsint64value.md new file mode 100644 index 00000000..a4e8ec93 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsint64value.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsInt64Value + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilter3ValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilter3valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsvaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsvaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsvaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsvaluetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1filtername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1filtername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1filtername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1filtername.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1int64value.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1int64value.md new file mode 100644 index 00000000..f0b7caf3 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1int64value.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1Int64Value + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `value` | *str* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1validenums.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1validenums.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1validenums.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1validenums.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1valuetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1valuetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1valuetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1valuetype.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2doublevalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2doublevalue.md new file mode 100644 index 00000000..575e02c3 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2doublevalue.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2DoubleValue + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `value` | *float* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsvaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsdoublevalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsdoublevalue.md new file mode 100644 index 00000000..7c2f8efa --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsdoublevalue.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsDoubleValue + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `value` | *float* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterFilterValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterdoublevalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterdoublevalue.md new file mode 100644 index 00000000..0ab0191d --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterdoublevalue.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterDoubleValue + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *float* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterFilter4ToValueValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilter4tovaluevaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilter4tovaluevaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilter4tovaluevaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilter4tovaluevaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilter4tovaluevaluetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilter4valuetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilter4valuetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilter4valuetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilter4valuetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilterfiltername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilterfiltername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilterfiltername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilterfiltername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfiltername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfiltername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfiltername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfiltername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfiltervaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfiltervaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfiltervaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfiltervaluetype.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterint64value.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterint64value.md new file mode 100644 index 00000000..b6d1b509 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterint64value.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterInt64Value + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterFilter4ValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilter4valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfiltername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfiltername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfiltername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfiltername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfiltervaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfiltervaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfiltervaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfiltervaluetype.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsint64value.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsint64value.md new file mode 100644 index 00000000..18e9af41 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsint64value.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsInt64Value + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `value` | *str* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsvalidenums.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsvalidenums.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsvalidenums.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsvalidenums.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsvaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsvaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsvaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsvaluetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2filtername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2filtername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2filtername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2filtername.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2int64value.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2int64value.md new file mode 100644 index 00000000..d03bbc9d --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2int64value.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2Int64Value + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2validenums.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2validenums.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2validenums.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2validenums.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2valuetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2valuetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2valuetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2valuetype.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3betweenfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3betweenfilter.md new file mode 100644 index 00000000..e273432b --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3betweenfilter.md @@ -0,0 +1,10 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3BetweenFilter + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `from_value` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionInt64Value, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionDoubleValue]](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3fromvalue.md) | :heavy_check_mark: | N/A | +| `to_value` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterInt64Value, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterDoubleValue]](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3tovalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterFilterFilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilterfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3doublevalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3doublevalue.md new file mode 100644 index 00000000..6b8ac04e --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3doublevalue.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3DoubleValue + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *float* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionvaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressiondoublevalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressiondoublevalue.md new file mode 100644 index 00000000..43843999 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressiondoublevalue.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionDoubleValue + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *float* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterFilterValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterdoublevalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterdoublevalue.md new file mode 100644 index 00000000..744d52f2 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterdoublevalue.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterDoubleValue + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *float* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterFilter4ToValueValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilter4tovaluevaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilter4tovaluevaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilter4tovaluevaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilter4tovaluevaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilter4tovaluevaluetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilter4valuetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilter4valuetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilter4valuetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilter4valuetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilterfiltername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilterfiltername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilterfiltername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilterfiltername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfiltername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfiltername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfiltername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfiltername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfiltervaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfiltervaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfiltervaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfiltervaluetype.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterint64value.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterint64value.md new file mode 100644 index 00000000..0247e4eb --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterint64value.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterInt64Value + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `value` | *str* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterFilter4ValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilter4valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfiltername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfiltername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfiltername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfiltername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfiltervaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfiltervaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfiltervaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfiltervaluetype.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionint64value.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionint64value.md new file mode 100644 index 00000000..36d62f5f --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionint64value.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionInt64Value + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionvalidenums.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionvalidenums.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionvalidenums.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionvalidenums.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionvaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionvaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionvaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionvaluetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filter.md similarity index 81% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filter.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filter.md index ac2bc404..cf74e57a 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filter.md +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filter.md @@ -6,24 +6,24 @@ ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3StringFilter ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3Filter: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3StringFilter = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3Filter: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3StringFilter = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3InListFilter ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3Filter: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3InListFilter = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3Filter: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3InListFilter = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3NumericFilter ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3Filter: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3NumericFilter = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3Filter: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3NumericFilter = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3BetweenFilter ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3Filter: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3BetweenFilter = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3Filter: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3BetweenFilter = /* values here */ ``` diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filtername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filtername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filtername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filtername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filtertype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filtertype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filtertype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filtertype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3fromvalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3fromvalue.md similarity index 83% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3fromvalue.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3fromvalue.md index 00803911..b83b5948 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3fromvalue.md +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3fromvalue.md @@ -6,12 +6,12 @@ ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionInt64Value ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3FromValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionInt64Value = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3FromValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionInt64Value = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionDoubleValue ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3FromValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionDoubleValue = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3FromValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionDoubleValue = /* values here */ ``` diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3inlistfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3inlistfilter.md new file mode 100644 index 00000000..bf446f69 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3inlistfilter.md @@ -0,0 +1,10 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3InListFilter + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `values` | List[*str*] | :heavy_check_mark: | N/A | +| `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3int64value.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3int64value.md new file mode 100644 index 00000000..26df2f32 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3int64value.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3Int64Value + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3numericfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3numericfilter.md new file mode 100644 index 00000000..4ecd09a6 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3numericfilter.md @@ -0,0 +1,10 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3NumericFilter + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `operation` | List[[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionValidEnums](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionvalidenums.md)] | :heavy_check_mark: | N/A | +| `value` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3Int64Value, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3DoubleValue]](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3value.md) | :heavy_check_mark: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterFilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3stringfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3stringfilter.md new file mode 100644 index 00000000..a1b19ed9 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3stringfilter.md @@ -0,0 +1,11 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3StringFilter + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3FilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filtername.md) | :heavy_check_mark: | N/A | +| `match_type` | List[[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ValidEnums](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3validenums.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3tovalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3tovalue.md similarity index 84% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3tovalue.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3tovalue.md index 4a1dc293..4919b9f1 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3tovalue.md +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3tovalue.md @@ -6,12 +6,12 @@ ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterInt64Value ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ToValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterInt64Value = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ToValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterInt64Value = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterDoubleValue ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ToValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterDoubleValue = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ToValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterDoubleValue = /* values here */ ``` diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3validenums.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3validenums.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3validenums.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3validenums.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3value.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3value.md similarity index 82% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3value.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3value.md index 53544c31..5f12d8dd 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3value.md +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3value.md @@ -6,12 +6,12 @@ ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3Int64Value ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3Value: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3Int64Value = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3Value: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3Int64Value = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3DoubleValue ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3Value: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3DoubleValue = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3Value: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3DoubleValue = /* values here */ ``` diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3valuetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3valuetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3valuetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3valuetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfilter4valuetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfilter4valuetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfilter4valuetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfilter4valuetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfiltername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfiltername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfiltername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfiltername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfiltervaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfiltervaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfiltervaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfiltervaluetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtertype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtertype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtertype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtertype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtervaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtervaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtervaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtervaluetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4valuetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4valuetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4valuetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4valuetype.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterbetweenfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterbetweenfilter.md new file mode 100644 index 00000000..fd0e731d --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterbetweenfilter.md @@ -0,0 +1,10 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterBetweenFilter + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `from_value` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsInt64Value, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsDoubleValue]](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfromvalue.md) | :heavy_check_mark: | N/A | +| `to_value` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterInt64Value, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterDoubleValue]](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltertovalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterFilterFilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilterfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterdoublevalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterdoublevalue.md new file mode 100644 index 00000000..bfb53b6a --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterdoublevalue.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterDoubleValue + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *float* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterFilter4ValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfilter4valuetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterexpression.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterexpression.md similarity index 80% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterexpression.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterexpression.md index f3653e61..c8b85dab 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterexpression.md +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterexpression.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `field_name` | *str* | :heavy_check_mark: | N/A | -| `filter_` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3StringFilter, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3InListFilter, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3NumericFilter, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3BetweenFilter]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filter.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `field_name` | *str* | :heavy_check_mark: | N/A | +| `filter_` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3StringFilter, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3InListFilter, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3NumericFilter, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3BetweenFilter]](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filter.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfilter.md similarity index 81% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfilter.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfilter.md index fdf4db7a..982e0452 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfilter.md +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfilter.md @@ -6,24 +6,24 @@ ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterStringFilter ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFilter: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterStringFilter = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFilter: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterStringFilter = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterInListFilter ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFilter: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterInListFilter = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFilter: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterInListFilter = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterNumericFilter ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFilter: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterNumericFilter = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFilter: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterNumericFilter = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterBetweenFilter ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFilter: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterBetweenFilter = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFilter: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterBetweenFilter = /* values here */ ``` diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfiltername.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfiltername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfiltername.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfiltername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfiltertype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfiltertype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfiltertype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfiltertype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfromvalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfromvalue.md similarity index 83% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfromvalue.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfromvalue.md index 0ca858c3..d04850f9 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfromvalue.md +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfromvalue.md @@ -6,12 +6,12 @@ ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsInt64Value ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFromValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsInt64Value = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFromValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsInt64Value = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsDoubleValue ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFromValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsDoubleValue = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFromValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsDoubleValue = /* values here */ ``` diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterinlistfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterinlistfilter.md new file mode 100644 index 00000000..c5778981 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterinlistfilter.md @@ -0,0 +1,10 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterInListFilter + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `values` | List[*str*] | :heavy_check_mark: | N/A | +| `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterint64value.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterint64value.md new file mode 100644 index 00000000..12b62a5d --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterint64value.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterInt64Value + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterFilterValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilternumericfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilternumericfilter.md new file mode 100644 index 00000000..69fb6875 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilternumericfilter.md @@ -0,0 +1,10 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterNumericFilter + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `operation` | List[[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsValidEnums](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsvalidenums.md)] | :heavy_check_mark: | N/A | +| `value` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2Int64Value, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2DoubleValue]](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterFilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterstringfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterstringfilter.md new file mode 100644 index 00000000..909d36c6 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterstringfilter.md @@ -0,0 +1,11 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterStringFilter + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2FilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2filtername.md) | :heavy_check_mark: | N/A | +| `match_type` | List[[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ValidEnums](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2validenums.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltertovalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltertovalue.md similarity index 84% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltertovalue.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltertovalue.md index 57c51781..f4c2b0d7 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltertovalue.md +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltertovalue.md @@ -6,12 +6,12 @@ ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterInt64Value ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterToValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterInt64Value = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterToValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterInt64Value = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterDoubleValue ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterToValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterDoubleValue = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterToValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterDoubleValue = /* values here */ ``` diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervalidenums.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervalidenums.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervalidenums.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervalidenums.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervalue.md similarity index 82% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervalue.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervalue.md index 69a87635..750088fa 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervalue.md +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervalue.md @@ -6,12 +6,12 @@ ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2Int64Value ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2Int64Value = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2Int64Value = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2DoubleValue ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2DoubleValue = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2DoubleValue = /* values here */ ``` diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervaluetype.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilternumericfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilternumericfilter.md new file mode 100644 index 00000000..4cb41b7a --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilternumericfilter.md @@ -0,0 +1,10 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterNumericFilter + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `operation` | List[[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterValidEnums](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervalidenums.md)] | :heavy_check_mark: | N/A | +| `value` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsInt64Value, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsDoubleValue]](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1FilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1filtername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterstringfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterstringfilter.md new file mode 100644 index 00000000..70598406 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterstringfilter.md @@ -0,0 +1,11 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterStringFilter + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfiltername.md) | :heavy_check_mark: | N/A | +| `match_type` | List[[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ValidEnums](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1validenums.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltertovalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltertovalue.md similarity index 81% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltertovalue.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltertovalue.md index 48a7b328..77c03a22 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltertovalue.md +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltertovalue.md @@ -6,12 +6,12 @@ ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1Int64Value ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterToValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1Int64Value = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterToValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1Int64Value = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1DoubleValue ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterToValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1DoubleValue = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterToValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1DoubleValue = /* values here */ ``` diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervalidenums.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervalidenums.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervalidenums.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervalidenums.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervalue.md similarity index 82% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervalue.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervalue.md index 6823ada4..d17bc837 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervalue.md +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervalue.md @@ -6,12 +6,12 @@ ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsInt64Value ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsInt64Value = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsInt64Value = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsDoubleValue ```python -sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsDoubleValue = /* values here */ +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsDoubleValue = /* values here */ ``` diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervaluetype.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraynumericfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraynumericfilter.md new file mode 100644 index 00000000..fa6d39bc --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraynumericfilter.md @@ -0,0 +1,10 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayNumericFilter + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `operation` | List[[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsValidEnums](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsvalidenums.md)] | :heavy_check_mark: | N/A | +| `value` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1Int64Value, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1DoubleValue]](../models/sourcegoogleanalyticsdataapischemascustomreportsarrayvalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterFilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraystringfilter.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraystringfilter.md new file mode 100644 index 00000000..fe4d926d --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraystringfilter.md @@ -0,0 +1,11 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayStringFilter + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1FilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1filtername.md) | :heavy_check_mark: | N/A | +| `match_type` | List[[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ValidEnums](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1validenums.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraytovalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraytovalue.md new file mode 100644 index 00000000..a7d3ac8a --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarraytovalue.md @@ -0,0 +1,17 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayToValue + + +## Supported Types + +### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterInt64Value + +```python +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayToValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterInt64Value = /* values here */ +``` + +### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterDoubleValue + +```python +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayToValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterDoubleValue = /* values here */ +``` + diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayvalidenums.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayvalidenums.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayvalidenums.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayvalidenums.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayvalue.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayvalue.md new file mode 100644 index 00000000..c6554c86 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayvalue.md @@ -0,0 +1,17 @@ +# SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayValue + + +## Supported Types + +### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1Int64Value + +```python +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1Int64Value = /* values here */ +``` + +### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1DoubleValue + +```python +sourceGoogleAnalyticsDataAPISchemasCustomReportsArrayValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1DoubleValue = /* values here */ +``` + diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayvaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayvaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayvaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemascustomreportsarrayvaluetype.md diff --git a/docs/models/sourcegoogleanalyticsdataapischemasdoublevalue.md b/docs/models/sourcegoogleanalyticsdataapischemasdoublevalue.md new file mode 100644 index 00000000..d355a5ef --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemasdoublevalue.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasDoubleValue + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `value` | *float* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemasenabled.md b/docs/models/sourcegoogleanalyticsdataapischemasenabled.md new file mode 100644 index 00000000..c64581dd --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemasenabled.md @@ -0,0 +1,11 @@ +# SourceGoogleAnalyticsDataAPISchemasEnabled + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `cohort_report_settings` | [Optional[models.CohortReportSettings]](../models/cohortreportsettings.md) | :heavy_minus_sign: | Optional settings for a cohort report. | +| `cohorts` | List[[models.Cohorts](../models/cohorts.md)] | :heavy_minus_sign: | N/A | +| `cohorts_range` | [Optional[models.CohortsRange]](../models/cohortsrange.md) | :heavy_minus_sign: | N/A | +| `enabled` | [Optional[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayEnabled]](../models/sourcegoogleanalyticsdataapischemascustomreportsarrayenabled.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemasexpression.md b/docs/models/sourcegoogleanalyticsdataapischemasexpression.md new file mode 100644 index 00000000..d92e6a10 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemasexpression.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasExpression + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `field_name` | *str* | :heavy_check_mark: | N/A | +| `filter_` | [Union[models.SourceGoogleAnalyticsDataAPISchemasStringFilter, models.SourceGoogleAnalyticsDataAPISchemasInListFilter, models.SourceGoogleAnalyticsDataAPISchemasNumericFilter, models.SourceGoogleAnalyticsDataAPISchemasBetweenFilter]](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterfilter.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemasfilter.md b/docs/models/sourcegoogleanalyticsdataapischemasfilter.md new file mode 100644 index 00000000..560f0b94 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemasfilter.md @@ -0,0 +1,29 @@ +# SourceGoogleAnalyticsDataAPISchemasFilter + + +## Supported Types + +### StringFilter + +```python +sourceGoogleAnalyticsDataAPISchemasFilter: models.StringFilter = /* values here */ +``` + +### InListFilter + +```python +sourceGoogleAnalyticsDataAPISchemasFilter: models.InListFilter = /* values here */ +``` + +### NumericFilter + +```python +sourceGoogleAnalyticsDataAPISchemasFilter: models.NumericFilter = /* values here */ +``` + +### BetweenFilter + +```python +sourceGoogleAnalyticsDataAPISchemasFilter: models.BetweenFilter = /* values here */ +``` + diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemasfiltername.md b/docs/models/sourcegoogleanalyticsdataapischemasfiltername.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemasfiltername.md rename to docs/models/sourcegoogleanalyticsdataapischemasfiltername.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemasfiltertype.md b/docs/models/sourcegoogleanalyticsdataapischemasfiltertype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemasfiltertype.md rename to docs/models/sourcegoogleanalyticsdataapischemasfiltertype.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemasfromvalue.md b/docs/models/sourcegoogleanalyticsdataapischemasfromvalue.md similarity index 81% rename from docs/models/shared/sourcegoogleanalyticsdataapischemasfromvalue.md rename to docs/models/sourcegoogleanalyticsdataapischemasfromvalue.md index 66862b19..c3ff694e 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemasfromvalue.md +++ b/docs/models/sourcegoogleanalyticsdataapischemasfromvalue.md @@ -6,12 +6,12 @@ ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionInt64Value ```python -sourceGoogleAnalyticsDataAPISchemasFromValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionInt64Value = /* values here */ +sourceGoogleAnalyticsDataAPISchemasFromValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionInt64Value = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionDoubleValue ```python -sourceGoogleAnalyticsDataAPISchemasFromValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionDoubleValue = /* values here */ +sourceGoogleAnalyticsDataAPISchemasFromValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionDoubleValue = /* values here */ ``` diff --git a/docs/models/sourcegoogleanalyticsdataapischemasinlistfilter.md b/docs/models/sourcegoogleanalyticsdataapischemasinlistfilter.md new file mode 100644 index 00000000..56f91b1d --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemasinlistfilter.md @@ -0,0 +1,10 @@ +# SourceGoogleAnalyticsDataAPISchemasInListFilter + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `values` | List[*str*] | :heavy_check_mark: | N/A | +| `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemasint64value.md b/docs/models/sourcegoogleanalyticsdataapischemasint64value.md new file mode 100644 index 00000000..ac6d1790 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemasint64value.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsDataAPISchemasInt64Value + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `value_type` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterValueType](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervaluetype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemasnumericfilter.md b/docs/models/sourcegoogleanalyticsdataapischemasnumericfilter.md new file mode 100644 index 00000000..62a36508 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemasnumericfilter.md @@ -0,0 +1,10 @@ +# SourceGoogleAnalyticsDataAPISchemasNumericFilter + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `operation` | List[[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ValidEnums](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3validenums.md)] | :heavy_check_mark: | N/A | +| `value` | [Union[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3Int64Value, models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3DoubleValue]](../models/sourcegoogleanalyticsdataapischemasvalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterFilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogleanalyticsdataapischemasstringfilter.md b/docs/models/sourcegoogleanalyticsdataapischemasstringfilter.md new file mode 100644 index 00000000..85fb6ee9 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapischemasstringfilter.md @@ -0,0 +1,11 @@ +# SourceGoogleAnalyticsDataAPISchemasStringFilter + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3FilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3filtername.md) | :heavy_check_mark: | N/A | +| `match_type` | List[[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterValidEnums](../models/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfiltervalidenums.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemastovalue.md b/docs/models/sourcegoogleanalyticsdataapischemastovalue.md similarity index 81% rename from docs/models/shared/sourcegoogleanalyticsdataapischemastovalue.md rename to docs/models/sourcegoogleanalyticsdataapischemastovalue.md index 178b5f4e..2f5a91df 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemastovalue.md +++ b/docs/models/sourcegoogleanalyticsdataapischemastovalue.md @@ -6,12 +6,12 @@ ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterInt64Value ```python -sourceGoogleAnalyticsDataAPISchemasToValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterInt64Value = /* values here */ +sourceGoogleAnalyticsDataAPISchemasToValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterInt64Value = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterDoubleValue ```python -sourceGoogleAnalyticsDataAPISchemasToValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterDoubleValue = /* values here */ +sourceGoogleAnalyticsDataAPISchemasToValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterDoubleValue = /* values here */ ``` diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemasvalidenums.md b/docs/models/sourcegoogleanalyticsdataapischemasvalidenums.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemasvalidenums.md rename to docs/models/sourcegoogleanalyticsdataapischemasvalidenums.md diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemasvalue.md b/docs/models/sourcegoogleanalyticsdataapischemasvalue.md similarity index 79% rename from docs/models/shared/sourcegoogleanalyticsdataapischemasvalue.md rename to docs/models/sourcegoogleanalyticsdataapischemasvalue.md index fcf984ec..8d675b40 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemasvalue.md +++ b/docs/models/sourcegoogleanalyticsdataapischemasvalue.md @@ -6,12 +6,12 @@ ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3Int64Value ```python -sourceGoogleAnalyticsDataAPISchemasValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3Int64Value = /* values here */ +sourceGoogleAnalyticsDataAPISchemasValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3Int64Value = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3DoubleValue ```python -sourceGoogleAnalyticsDataAPISchemasValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3DoubleValue = /* values here */ +sourceGoogleAnalyticsDataAPISchemasValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3DoubleValue = /* values here */ ``` diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemasvaluetype.md b/docs/models/sourcegoogleanalyticsdataapischemasvaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapischemasvaluetype.md rename to docs/models/sourcegoogleanalyticsdataapischemasvaluetype.md diff --git a/docs/models/sourcegoogleanalyticsdataapistringfilter.md b/docs/models/sourcegoogleanalyticsdataapistringfilter.md new file mode 100644 index 00000000..04a29d69 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapistringfilter.md @@ -0,0 +1,11 @@ +# SourceGoogleAnalyticsDataAPIStringFilter + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `value` | *str* | :heavy_check_mark: | N/A | +| `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `filter_name` | [models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterFilterName](../models/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfiltername.md) | :heavy_check_mark: | N/A | +| `match_type` | List[[models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayValidEnums](../models/sourcegoogleanalyticsdataapischemascustomreportsarrayvalidenums.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapitovalue.md b/docs/models/sourcegoogleanalyticsdataapitovalue.md similarity index 78% rename from docs/models/shared/sourcegoogleanalyticsdataapitovalue.md rename to docs/models/sourcegoogleanalyticsdataapitovalue.md index 93497661..d96a3618 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapitovalue.md +++ b/docs/models/sourcegoogleanalyticsdataapitovalue.md @@ -6,12 +6,12 @@ ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterInt64Value ```python -sourceGoogleAnalyticsDataAPIToValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterInt64Value = /* values here */ +sourceGoogleAnalyticsDataAPIToValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterInt64Value = /* values here */ ``` ### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterDoubleValue ```python -sourceGoogleAnalyticsDataAPIToValue: shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterDoubleValue = /* values here */ +sourceGoogleAnalyticsDataAPIToValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterDoubleValue = /* values here */ ``` diff --git a/docs/models/shared/sourcegoogleanalyticsdataapivalidenums.md b/docs/models/sourcegoogleanalyticsdataapivalidenums.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapivalidenums.md rename to docs/models/sourcegoogleanalyticsdataapivalidenums.md diff --git a/docs/models/sourcegoogleanalyticsdataapivalue.md b/docs/models/sourcegoogleanalyticsdataapivalue.md new file mode 100644 index 00000000..462821f3 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsdataapivalue.md @@ -0,0 +1,17 @@ +# SourceGoogleAnalyticsDataAPIValue + + +## Supported Types + +### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayInt64Value + +```python +sourceGoogleAnalyticsDataAPIValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayInt64Value = /* values here */ +``` + +### SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDoubleValue + +```python +sourceGoogleAnalyticsDataAPIValue: models.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDoubleValue = /* values here */ +``` + diff --git a/docs/models/shared/sourcegoogleanalyticsdataapivaluetype.md b/docs/models/sourcegoogleanalyticsdataapivaluetype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsdataapivaluetype.md rename to docs/models/sourcegoogleanalyticsdataapivaluetype.md diff --git a/docs/models/shared/sourcegoogleanalyticsv4serviceaccountonly.md b/docs/models/sourcegoogleanalyticsv4serviceaccountonly.md similarity index 98% rename from docs/models/shared/sourcegoogleanalyticsv4serviceaccountonly.md rename to docs/models/sourcegoogleanalyticsv4serviceaccountonly.md index 0c9d5354..4e042706 100644 --- a/docs/models/shared/sourcegoogleanalyticsv4serviceaccountonly.md +++ b/docs/models/sourcegoogleanalyticsv4serviceaccountonly.md @@ -7,8 +7,8 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | The date in the format YYYY-MM-DD. Any data before this date will not be replicated. | 2020-06-01 | | `view_id` | *str* | :heavy_check_mark: | The ID for the Google Analytics View you want to fetch data from. This can be found from the Google Analytics Account Explorer. | | -| `credentials` | [Optional[Union[shared.SourceGoogleAnalyticsV4ServiceAccountOnlyServiceAccountKeyAuthentication]]](../../models/shared/sourcegoogleanalyticsv4serviceaccountonlycredentials.md) | :heavy_minus_sign: | Credentials for the service | | +| `credentials` | [Optional[Union[models.SourceGoogleAnalyticsV4ServiceAccountOnlyServiceAccountKeyAuthentication]]](../models/sourcegoogleanalyticsv4serviceaccountonlycredentials.md) | :heavy_minus_sign: | Credentials for the service | | | `custom_reports` | *Optional[str]* | :heavy_minus_sign: | A JSON array describing the custom reports you want to sync from Google Analytics. See the docs for more information about the exact format you can use to fill out this field. | | | `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. | 2020-06-01 | -| `source_type` | [shared.GoogleAnalyticsV4ServiceAccountOnly](../../models/shared/googleanalyticsv4serviceaccountonly.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.GoogleAnalyticsV4ServiceAccountOnly](../models/googleanalyticsv4serviceaccountonly.md) | :heavy_check_mark: | N/A | | | `window_in_days` | *Optional[int]* | :heavy_minus_sign: | The time increment used by the connector when requesting data from the Google Analytics API. More information is available in the the docs. The bigger this value is, the faster the sync will be, but the more likely that sampling will be applied to your data, potentially causing inaccuracies in the returned results. We recommend setting this to 1 unless you have a hard requirement to make the sync faster at the expense of accuracy. The minimum allowed value for this field is 1, and the maximum is 364. | 30 | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsv4serviceaccountonlyauthtype.md b/docs/models/sourcegoogleanalyticsv4serviceaccountonlyauthtype.md similarity index 100% rename from docs/models/shared/sourcegoogleanalyticsv4serviceaccountonlyauthtype.md rename to docs/models/sourcegoogleanalyticsv4serviceaccountonlyauthtype.md diff --git a/docs/models/shared/sourcegoogleanalyticsv4serviceaccountonlycredentials.md b/docs/models/sourcegoogleanalyticsv4serviceaccountonlycredentials.md similarity index 81% rename from docs/models/shared/sourcegoogleanalyticsv4serviceaccountonlycredentials.md rename to docs/models/sourcegoogleanalyticsv4serviceaccountonlycredentials.md index fc802fca..d7163194 100644 --- a/docs/models/shared/sourcegoogleanalyticsv4serviceaccountonlycredentials.md +++ b/docs/models/sourcegoogleanalyticsv4serviceaccountonlycredentials.md @@ -8,6 +8,6 @@ Credentials for the service ### SourceGoogleAnalyticsV4ServiceAccountOnlyServiceAccountKeyAuthentication ```python -sourceGoogleAnalyticsV4ServiceAccountOnlyCredentials: shared.SourceGoogleAnalyticsV4ServiceAccountOnlyServiceAccountKeyAuthentication = /* values here */ +sourceGoogleAnalyticsV4ServiceAccountOnlyCredentials: models.SourceGoogleAnalyticsV4ServiceAccountOnlyServiceAccountKeyAuthentication = /* values here */ ``` diff --git a/docs/models/sourcegoogleanalyticsv4serviceaccountonlyserviceaccountkeyauthentication.md b/docs/models/sourcegoogleanalyticsv4serviceaccountonlyserviceaccountkeyauthentication.md new file mode 100644 index 00000000..896dc9e5 --- /dev/null +++ b/docs/models/sourcegoogleanalyticsv4serviceaccountonlyserviceaccountkeyauthentication.md @@ -0,0 +1,9 @@ +# SourceGoogleAnalyticsV4ServiceAccountOnlyServiceAccountKeyAuthentication + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `credentials_json` | *str* | :heavy_check_mark: | The JSON key of the service account to use for authorization | { "type": "service_account", "project_id": YOUR_PROJECT_ID, "private_key_id": YOUR_PRIVATE_KEY, ... } | +| `auth_type` | [Optional[models.SourceGoogleAnalyticsV4ServiceAccountOnlyAuthType]](../models/sourcegoogleanalyticsv4serviceaccountonlyauthtype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogledirectory.md b/docs/models/sourcegoogledirectory.md similarity index 94% rename from docs/models/shared/sourcegoogledirectory.md rename to docs/models/sourcegoogledirectory.md index 162c61f5..408c443b 100644 --- a/docs/models/shared/sourcegoogledirectory.md +++ b/docs/models/sourcegoogledirectory.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `credentials` | [Optional[Union[shared.SignInViaGoogleOAuth, shared.ServiceAccountKey]]](../../models/shared/sourcegoogledirectorygooglecredentials.md) | :heavy_minus_sign: | Google APIs use the OAuth 2.0 protocol for authentication and authorization. The Source supports Web server application and Service accounts scenarios. | -| `source_type` | [shared.GoogleDirectory](../../models/shared/googledirectory.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `credentials` | [Optional[Union[models.SignInViaGoogleOAuth, models.ServiceAccountKey]]](../models/sourcegoogledirectorygooglecredentials.md) | :heavy_minus_sign: | Google APIs use the OAuth 2.0 protocol for authentication and authorization. The Source supports Web server application and Service accounts scenarios. | +| `source_type` | [models.GoogleDirectory](../models/googledirectory.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogledirectorycredentialstitle.md b/docs/models/sourcegoogledirectorycredentialstitle.md similarity index 100% rename from docs/models/shared/sourcegoogledirectorycredentialstitle.md rename to docs/models/sourcegoogledirectorycredentialstitle.md diff --git a/docs/models/shared/sourcegoogledirectorygooglecredentials.md b/docs/models/sourcegoogledirectorygooglecredentials.md similarity index 80% rename from docs/models/shared/sourcegoogledirectorygooglecredentials.md rename to docs/models/sourcegoogledirectorygooglecredentials.md index e7233253..946beef1 100644 --- a/docs/models/shared/sourcegoogledirectorygooglecredentials.md +++ b/docs/models/sourcegoogledirectorygooglecredentials.md @@ -8,12 +8,12 @@ Google APIs use the OAuth 2.0 protocol for authentication and authorization. The ### SignInViaGoogleOAuth ```python -sourceGoogleDirectoryGoogleCredentials: shared.SignInViaGoogleOAuth = /* values here */ +sourceGoogleDirectoryGoogleCredentials: models.SignInViaGoogleOAuth = /* values here */ ``` ### ServiceAccountKey ```python -sourceGoogleDirectoryGoogleCredentials: shared.ServiceAccountKey = /* values here */ +sourceGoogleDirectoryGoogleCredentials: models.ServiceAccountKey = /* values here */ ``` diff --git a/docs/models/shared/sourcegoogledirectoryschemascredentialstitle.md b/docs/models/sourcegoogledirectoryschemascredentialstitle.md similarity index 100% rename from docs/models/shared/sourcegoogledirectoryschemascredentialstitle.md rename to docs/models/sourcegoogledirectoryschemascredentialstitle.md diff --git a/docs/models/shared/sourcegoogledrive.md b/docs/models/sourcegoogledrive.md similarity index 95% rename from docs/models/shared/sourcegoogledrive.md rename to docs/models/sourcegoogledrive.md index 92ee5d68..3fea2e07 100644 --- a/docs/models/shared/sourcegoogledrive.md +++ b/docs/models/sourcegoogledrive.md @@ -8,8 +8,8 @@ that are needed when users configure a file-based source. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `credentials` | [Union[shared.SourceGoogleDriveAuthenticateViaGoogleOAuth, shared.SourceGoogleDriveServiceAccountKeyAuthentication]](../../models/shared/sourcegoogledriveauthentication.md) | :heavy_check_mark: | Credentials for connecting to the Google Drive API | | +| `credentials` | [Union[models.SourceGoogleDriveAuthenticateViaGoogleOAuth, models.SourceGoogleDriveServiceAccountKeyAuthentication]](../models/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 | | +| `streams` | List[[models.SourceGoogleDriveFileBasedStreamConfig](../models/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` | [models.SourceGoogleDriveGoogleDrive](../models/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 | \ No newline at end of file diff --git a/docs/models/sourcegoogledriveauthenticateviagoogleoauth.md b/docs/models/sourcegoogledriveauthenticateviagoogleoauth.md new file mode 100644 index 00000000..a87df1a6 --- /dev/null +++ b/docs/models/sourcegoogledriveauthenticateviagoogleoauth.md @@ -0,0 +1,11 @@ +# SourceGoogleDriveAuthenticateViaGoogleOAuth + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `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 | +| `auth_type` | [Optional[models.SourceGoogleDriveAuthType]](../models/sourcegoogledriveauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogledriveauthentication.md b/docs/models/sourcegoogledriveauthentication.md new file mode 100644 index 00000000..7f37c9b9 --- /dev/null +++ b/docs/models/sourcegoogledriveauthentication.md @@ -0,0 +1,19 @@ +# SourceGoogleDriveAuthentication + +Credentials for connecting to the Google Drive API + + +## Supported Types + +### SourceGoogleDriveAuthenticateViaGoogleOAuth + +```python +sourceGoogleDriveAuthentication: models.SourceGoogleDriveAuthenticateViaGoogleOAuth = /* values here */ +``` + +### SourceGoogleDriveServiceAccountKeyAuthentication + +```python +sourceGoogleDriveAuthentication: models.SourceGoogleDriveServiceAccountKeyAuthentication = /* values here */ +``` + diff --git a/docs/models/shared/sourcegoogledriveauthtype.md b/docs/models/sourcegoogledriveauthtype.md similarity index 100% rename from docs/models/shared/sourcegoogledriveauthtype.md rename to docs/models/sourcegoogledriveauthtype.md diff --git a/docs/models/sourcegoogledriveautogenerated.md b/docs/models/sourcegoogledriveautogenerated.md new file mode 100644 index 00000000..7c4034eb --- /dev/null +++ b/docs/models/sourcegoogledriveautogenerated.md @@ -0,0 +1,8 @@ +# SourceGoogleDriveAutogenerated + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `header_definition_type` | [Optional[models.SourceGoogleDriveSchemasHeaderDefinitionType]](../models/sourcegoogledriveschemasheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogledriveavroformat.md b/docs/models/sourcegoogledriveavroformat.md similarity index 96% rename from docs/models/shared/sourcegoogledriveavroformat.md rename to docs/models/sourcegoogledriveavroformat.md index 06f900cb..2a674ed1 100644 --- a/docs/models/shared/sourcegoogledriveavroformat.md +++ b/docs/models/sourcegoogledriveavroformat.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `double_as_string` | *Optional[bool]* | :heavy_minus_sign: | Whether to convert double fields to strings. This is recommended if you have decimal numbers with a high degree of precision because there can be a loss precision when handling floating point numbers. | -| `filetype` | [Optional[shared.SourceGoogleDriveFiletype]](../../models/shared/sourcegoogledrivefiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `filetype` | [Optional[models.SourceGoogleDriveFiletype]](../models/sourcegoogledrivefiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogledrivecsvformat.md b/docs/models/sourcegoogledrivecsvformat.md similarity index 98% rename from docs/models/shared/sourcegoogledrivecsvformat.md rename to docs/models/sourcegoogledrivecsvformat.md index a03b71f4..5e1f1266 100644 --- a/docs/models/shared/sourcegoogledrivecsvformat.md +++ b/docs/models/sourcegoogledrivecsvformat.md @@ -10,8 +10,8 @@ | `encoding` | *Optional[str]* | :heavy_minus_sign: | The character encoding of the CSV data. Leave blank to default to UTF8. See list of python encodings for allowable options. | | `escape_char` | *Optional[str]* | :heavy_minus_sign: | The character used for escaping special characters. To disallow escaping, leave this field blank. | | `false_values` | List[*str*] | :heavy_minus_sign: | A set of case-sensitive strings that should be interpreted as false values. | -| `filetype` | [Optional[shared.SourceGoogleDriveSchemasFiletype]](../../models/shared/sourcegoogledriveschemasfiletype.md) | :heavy_minus_sign: | N/A | -| `header_definition` | [Optional[Union[shared.SourceGoogleDriveFromCSV, shared.SourceGoogleDriveAutogenerated, shared.SourceGoogleDriveUserProvided]]](../../models/shared/sourcegoogledrivecsvheaderdefinition.md) | :heavy_minus_sign: | How headers will be defined. `User Provided` assumes the CSV does not have a header row and uses the headers provided and `Autogenerated` assumes the CSV does not have a header row and the CDK will generate headers using for `f{i}` where `i` is the index starting from 0. Else, the default behavior is to use the header from the CSV file. If a user wants to autogenerate or provide column names for a CSV having headers, they can skip rows. | +| `filetype` | [Optional[models.SourceGoogleDriveSchemasFiletype]](../models/sourcegoogledriveschemasfiletype.md) | :heavy_minus_sign: | N/A | +| `header_definition` | [Optional[Union[models.SourceGoogleDriveFromCSV, models.SourceGoogleDriveAutogenerated, models.SourceGoogleDriveUserProvided]]](../models/sourcegoogledrivecsvheaderdefinition.md) | :heavy_minus_sign: | How headers will be defined. `User Provided` assumes the CSV does not have a header row and uses the headers provided and `Autogenerated` assumes the CSV does not have a header row and the CDK will generate headers using for `f{i}` where `i` is the index starting from 0. Else, the default behavior is to use the header from the CSV file. If a user wants to autogenerate or provide column names for a CSV having headers, they can skip rows. | | `null_values` | List[*str*] | :heavy_minus_sign: | A set of case-sensitive strings that should be interpreted as null values. For example, if the value 'NA' should be interpreted as null, enter 'NA' in this field. | | `quote_char` | *Optional[str]* | :heavy_minus_sign: | The character used for quoting CSV values. To disallow quoting, make this field blank. | | `skip_rows_after_header` | *Optional[int]* | :heavy_minus_sign: | The number of rows to skip after the header row. | diff --git a/docs/models/shared/sourcegoogledrivecsvheaderdefinition.md b/docs/models/sourcegoogledrivecsvheaderdefinition.md similarity index 79% rename from docs/models/shared/sourcegoogledrivecsvheaderdefinition.md rename to docs/models/sourcegoogledrivecsvheaderdefinition.md index 8caf1497..693e9d38 100644 --- a/docs/models/shared/sourcegoogledrivecsvheaderdefinition.md +++ b/docs/models/sourcegoogledrivecsvheaderdefinition.md @@ -8,18 +8,18 @@ How headers will be defined. `User Provided` assumes the CSV does not have a hea ### SourceGoogleDriveFromCSV ```python -sourceGoogleDriveCSVHeaderDefinition: shared.SourceGoogleDriveFromCSV = /* values here */ +sourceGoogleDriveCSVHeaderDefinition: models.SourceGoogleDriveFromCSV = /* values here */ ``` ### SourceGoogleDriveAutogenerated ```python -sourceGoogleDriveCSVHeaderDefinition: shared.SourceGoogleDriveAutogenerated = /* values here */ +sourceGoogleDriveCSVHeaderDefinition: models.SourceGoogleDriveAutogenerated = /* values here */ ``` ### SourceGoogleDriveUserProvided ```python -sourceGoogleDriveCSVHeaderDefinition: shared.SourceGoogleDriveUserProvided = /* values here */ +sourceGoogleDriveCSVHeaderDefinition: models.SourceGoogleDriveUserProvided = /* values here */ ``` diff --git a/docs/models/shared/sourcegoogledrivedocumentfiletypeformatexperimental.md b/docs/models/sourcegoogledrivedocumentfiletypeformatexperimental.md similarity index 94% rename from docs/models/shared/sourcegoogledrivedocumentfiletypeformatexperimental.md rename to docs/models/sourcegoogledrivedocumentfiletypeformatexperimental.md index 874cb3d5..1533e128 100644 --- a/docs/models/shared/sourcegoogledrivedocumentfiletypeformatexperimental.md +++ b/docs/models/sourcegoogledrivedocumentfiletypeformatexperimental.md @@ -7,7 +7,7 @@ Extract text from document formats (.pdf, .docx, .md, .pptx) and emit as one rec | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `filetype` | [Optional[shared.SourceGoogleDriveSchemasStreamsFormatFormatFiletype]](../../models/shared/sourcegoogledriveschemasstreamsformatformatfiletype.md) | :heavy_minus_sign: | N/A | -| `processing` | [Optional[Union[shared.SourceGoogleDriveLocal]]](../../models/shared/sourcegoogledriveprocessing.md) | :heavy_minus_sign: | Processing configuration | +| `filetype` | [Optional[models.SourceGoogleDriveSchemasStreamsFormatFormatFiletype]](../models/sourcegoogledriveschemasstreamsformatformatfiletype.md) | :heavy_minus_sign: | N/A | +| `processing` | [Optional[Union[models.SourceGoogleDriveLocal]]](../models/sourcegoogledriveprocessing.md) | :heavy_minus_sign: | Processing configuration | | `skip_unprocessable_files` | *Optional[bool]* | :heavy_minus_sign: | If true, skip files that cannot be parsed and pass the error message along as the _ab_source_file_parse_error field. If false, fail the sync. | -| `strategy` | [Optional[shared.SourceGoogleDriveParsingStrategy]](../../models/shared/sourcegoogledriveparsingstrategy.md) | :heavy_minus_sign: | The strategy used to parse documents. `fast` extracts text directly from the document which doesn't work for all files. `ocr_only` is more reliable, but slower. `hi_res` is the most reliable, but requires an API key and a hosted instance of unstructured and can't be used with local mode. See the unstructured.io documentation for more details: https://unstructured-io.github.io/unstructured/core/partition.html#partition-pdf | \ No newline at end of file +| `strategy` | [Optional[models.SourceGoogleDriveParsingStrategy]](../models/sourcegoogledriveparsingstrategy.md) | :heavy_minus_sign: | The strategy used to parse documents. `fast` extracts text directly from the document which doesn't work for all files. `ocr_only` is more reliable, but slower. `hi_res` is the most reliable, but requires an API key and a hosted instance of unstructured and can't be used with local mode. See the unstructured.io documentation for more details: https://unstructured-io.github.io/unstructured/core/partition.html#partition-pdf | \ No newline at end of file diff --git a/docs/models/sourcegoogledrivefilebasedstreamconfig.md b/docs/models/sourcegoogledrivefilebasedstreamconfig.md new file mode 100644 index 00000000..57d6c64f --- /dev/null +++ b/docs/models/sourcegoogledrivefilebasedstreamconfig.md @@ -0,0 +1,15 @@ +# SourceGoogleDriveFileBasedStreamConfig + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `format` | [Union[models.SourceGoogleDriveAvroFormat, models.SourceGoogleDriveCSVFormat, models.SourceGoogleDriveJsonlFormat, models.SourceGoogleDriveParquetFormat, models.SourceGoogleDriveDocumentFileTypeFormatExperimental]](../models/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. | +| `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[models.SourceGoogleDriveValidationPolicy]](../models/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/sourcegoogledrivefiletype.md b/docs/models/sourcegoogledrivefiletype.md similarity index 100% rename from docs/models/shared/sourcegoogledrivefiletype.md rename to docs/models/sourcegoogledrivefiletype.md diff --git a/docs/models/sourcegoogledriveformat.md b/docs/models/sourcegoogledriveformat.md new file mode 100644 index 00000000..5ed61033 --- /dev/null +++ b/docs/models/sourcegoogledriveformat.md @@ -0,0 +1,37 @@ +# SourceGoogleDriveFormat + +The configuration options that are used to alter how to read incoming files that deviate from the standard formatting. + + +## Supported Types + +### SourceGoogleDriveAvroFormat + +```python +sourceGoogleDriveFormat: models.SourceGoogleDriveAvroFormat = /* values here */ +``` + +### SourceGoogleDriveCSVFormat + +```python +sourceGoogleDriveFormat: models.SourceGoogleDriveCSVFormat = /* values here */ +``` + +### SourceGoogleDriveJsonlFormat + +```python +sourceGoogleDriveFormat: models.SourceGoogleDriveJsonlFormat = /* values here */ +``` + +### SourceGoogleDriveParquetFormat + +```python +sourceGoogleDriveFormat: models.SourceGoogleDriveParquetFormat = /* values here */ +``` + +### SourceGoogleDriveDocumentFileTypeFormatExperimental + +```python +sourceGoogleDriveFormat: models.SourceGoogleDriveDocumentFileTypeFormatExperimental = /* values here */ +``` + diff --git a/docs/models/sourcegoogledrivefromcsv.md b/docs/models/sourcegoogledrivefromcsv.md new file mode 100644 index 00000000..e9eae6a1 --- /dev/null +++ b/docs/models/sourcegoogledrivefromcsv.md @@ -0,0 +1,8 @@ +# SourceGoogleDriveFromCSV + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `header_definition_type` | [Optional[models.SourceGoogleDriveHeaderDefinitionType]](../models/sourcegoogledriveheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogledrivegoogledrive.md b/docs/models/sourcegoogledrivegoogledrive.md similarity index 100% rename from docs/models/shared/sourcegoogledrivegoogledrive.md rename to docs/models/sourcegoogledrivegoogledrive.md diff --git a/docs/models/shared/sourcegoogledriveheaderdefinitiontype.md b/docs/models/sourcegoogledriveheaderdefinitiontype.md similarity index 100% rename from docs/models/shared/sourcegoogledriveheaderdefinitiontype.md rename to docs/models/sourcegoogledriveheaderdefinitiontype.md diff --git a/docs/models/sourcegoogledrivejsonlformat.md b/docs/models/sourcegoogledrivejsonlformat.md new file mode 100644 index 00000000..e53f57dc --- /dev/null +++ b/docs/models/sourcegoogledrivejsonlformat.md @@ -0,0 +1,8 @@ +# SourceGoogleDriveJsonlFormat + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `filetype` | [Optional[models.SourceGoogleDriveSchemasStreamsFiletype]](../models/sourcegoogledriveschemasstreamsfiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogledrivelocal.md b/docs/models/sourcegoogledrivelocal.md new file mode 100644 index 00000000..05340bd7 --- /dev/null +++ b/docs/models/sourcegoogledrivelocal.md @@ -0,0 +1,10 @@ +# SourceGoogleDriveLocal + +Process files locally, supporting `fast` and `ocr` modes. This is the default option. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `mode` | [Optional[models.SourceGoogleDriveMode]](../models/sourcegoogledrivemode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogledrivemode.md b/docs/models/sourcegoogledrivemode.md similarity index 100% rename from docs/models/shared/sourcegoogledrivemode.md rename to docs/models/sourcegoogledrivemode.md diff --git a/docs/models/shared/sourcegoogledriveparquetformat.md b/docs/models/sourcegoogledriveparquetformat.md similarity index 91% rename from docs/models/shared/sourcegoogledriveparquetformat.md rename to docs/models/sourcegoogledriveparquetformat.md index 5a182639..bae81417 100644 --- a/docs/models/shared/sourcegoogledriveparquetformat.md +++ b/docs/models/sourcegoogledriveparquetformat.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `decimal_as_float` | *Optional[bool]* | :heavy_minus_sign: | Whether to convert decimal fields to floats. There is a loss of precision when converting decimals to floats, so this is not recommended. | -| `filetype` | [Optional[shared.SourceGoogleDriveSchemasStreamsFormatFiletype]](../../models/shared/sourcegoogledriveschemasstreamsformatfiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `filetype` | [Optional[models.SourceGoogleDriveSchemasStreamsFormatFiletype]](../models/sourcegoogledriveschemasstreamsformatfiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogledriveparsingstrategy.md b/docs/models/sourcegoogledriveparsingstrategy.md similarity index 100% rename from docs/models/shared/sourcegoogledriveparsingstrategy.md rename to docs/models/sourcegoogledriveparsingstrategy.md diff --git a/docs/models/sourcegoogledriveprocessing.md b/docs/models/sourcegoogledriveprocessing.md new file mode 100644 index 00000000..669ac025 --- /dev/null +++ b/docs/models/sourcegoogledriveprocessing.md @@ -0,0 +1,13 @@ +# SourceGoogleDriveProcessing + +Processing configuration + + +## Supported Types + +### SourceGoogleDriveLocal + +```python +sourceGoogleDriveProcessing: models.SourceGoogleDriveLocal = /* values here */ +``` + diff --git a/docs/models/shared/sourcegoogledriveschemasauthtype.md b/docs/models/sourcegoogledriveschemasauthtype.md similarity index 100% rename from docs/models/shared/sourcegoogledriveschemasauthtype.md rename to docs/models/sourcegoogledriveschemasauthtype.md diff --git a/docs/models/shared/sourcegoogledriveschemasfiletype.md b/docs/models/sourcegoogledriveschemasfiletype.md similarity index 100% rename from docs/models/shared/sourcegoogledriveschemasfiletype.md rename to docs/models/sourcegoogledriveschemasfiletype.md diff --git a/docs/models/shared/sourcegoogledriveschemasheaderdefinitiontype.md b/docs/models/sourcegoogledriveschemasheaderdefinitiontype.md similarity index 100% rename from docs/models/shared/sourcegoogledriveschemasheaderdefinitiontype.md rename to docs/models/sourcegoogledriveschemasheaderdefinitiontype.md diff --git a/docs/models/shared/sourcegoogledriveschemasstreamsfiletype.md b/docs/models/sourcegoogledriveschemasstreamsfiletype.md similarity index 100% rename from docs/models/shared/sourcegoogledriveschemasstreamsfiletype.md rename to docs/models/sourcegoogledriveschemasstreamsfiletype.md diff --git a/docs/models/shared/sourcegoogledriveschemasstreamsformatfiletype.md b/docs/models/sourcegoogledriveschemasstreamsformatfiletype.md similarity index 100% rename from docs/models/shared/sourcegoogledriveschemasstreamsformatfiletype.md rename to docs/models/sourcegoogledriveschemasstreamsformatfiletype.md diff --git a/docs/models/shared/sourcegoogledriveschemasstreamsformatformatfiletype.md b/docs/models/sourcegoogledriveschemasstreamsformatformatfiletype.md similarity index 100% rename from docs/models/shared/sourcegoogledriveschemasstreamsformatformatfiletype.md rename to docs/models/sourcegoogledriveschemasstreamsformatformatfiletype.md diff --git a/docs/models/shared/sourcegoogledriveschemasstreamsheaderdefinitiontype.md b/docs/models/sourcegoogledriveschemasstreamsheaderdefinitiontype.md similarity index 100% rename from docs/models/shared/sourcegoogledriveschemasstreamsheaderdefinitiontype.md rename to docs/models/sourcegoogledriveschemasstreamsheaderdefinitiontype.md diff --git a/docs/models/shared/sourcegoogledriveserviceaccountkeyauthentication.md b/docs/models/sourcegoogledriveserviceaccountkeyauthentication.md similarity index 96% rename from docs/models/shared/sourcegoogledriveserviceaccountkeyauthentication.md rename to docs/models/sourcegoogledriveserviceaccountkeyauthentication.md index 0331a63e..73feba43 100644 --- a/docs/models/shared/sourcegoogledriveserviceaccountkeyauthentication.md +++ b/docs/models/sourcegoogledriveserviceaccountkeyauthentication.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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 +| `auth_type` | [Optional[models.SourceGoogleDriveSchemasAuthType]](../models/sourcegoogledriveschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegoogledriveuserprovided.md b/docs/models/sourcegoogledriveuserprovided.md new file mode 100644 index 00000000..b4e77b94 --- /dev/null +++ b/docs/models/sourcegoogledriveuserprovided.md @@ -0,0 +1,9 @@ +# SourceGoogleDriveUserProvided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| `column_names` | List[*str*] | :heavy_check_mark: | The column names that will be used while emitting the CSV records | +| `header_definition_type` | [Optional[models.SourceGoogleDriveSchemasStreamsHeaderDefinitionType]](../models/sourcegoogledriveschemasstreamsheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogledrivevalidationpolicy.md b/docs/models/sourcegoogledrivevalidationpolicy.md similarity index 100% rename from docs/models/shared/sourcegoogledrivevalidationpolicy.md rename to docs/models/sourcegoogledrivevalidationpolicy.md diff --git a/docs/models/shared/sourcegooglepagespeedinsights.md b/docs/models/sourcegooglepagespeedinsights.md similarity index 96% rename from docs/models/shared/sourcegooglepagespeedinsights.md rename to docs/models/sourcegooglepagespeedinsights.md index 2200faa2..0f60c111 100644 --- a/docs/models/shared/sourcegooglepagespeedinsights.md +++ b/docs/models/sourcegooglepagespeedinsights.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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". | | -| `strategies` | List[[shared.Strategies](../../models/shared/strategies.md)] | :heavy_check_mark: | The analyses strategy to use. Either "desktop" or "mobile". | | +| `categories` | List[[models.Categories](../models/categories.md)] | :heavy_check_mark: | Defines which Lighthouse category to run. One or many of: "accessibility", "best-practices", "performance", "pwa", "seo". | | +| `strategies` | List[[models.Strategies](../models/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 | | `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 +| `source_type` | [models.GooglePagespeedInsights](../models/googlepagespeedinsights.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcegooglesearchconsole.md b/docs/models/sourcegooglesearchconsole.md similarity index 96% rename from docs/models/shared/sourcegooglesearchconsole.md rename to docs/models/sourcegooglesearchconsole.md index b7024410..1632e5fc 100644 --- a/docs/models/shared/sourcegooglesearchconsole.md +++ b/docs/models/sourcegooglesearchconsole.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `authorization` | [Union[shared.SourceGoogleSearchConsoleOAuth, shared.SourceGoogleSearchConsoleServiceAccountKeyAuthentication]](../../models/shared/authenticationtype.md) | :heavy_check_mark: | N/A | | +| `authorization` | [Union[models.SourceGoogleSearchConsoleOAuth, models.SourceGoogleSearchConsoleServiceAccountKeyAuthentication]](../models/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 | +| `custom_reports_array` | List[[models.SourceGoogleSearchConsoleCustomReportConfig](../models/sourcegooglesearchconsolecustomreportconfig.md)] | :heavy_minus_sign: | You can add your Custom Analytics report by creating one. | | +| `data_state` | [Optional[models.DataFreshness]](../models/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 | -| `source_type` | [shared.SourceGoogleSearchConsoleGoogleSearchConsole](../../models/shared/sourcegooglesearchconsolegooglesearchconsole.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.SourceGoogleSearchConsoleGoogleSearchConsole](../models/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/sourcegooglesearchconsoleauthtype.md b/docs/models/sourcegooglesearchconsoleauthtype.md similarity index 100% rename from docs/models/shared/sourcegooglesearchconsoleauthtype.md rename to docs/models/sourcegooglesearchconsoleauthtype.md diff --git a/docs/models/shared/sourcegooglesearchconsolecustomreportconfig.md b/docs/models/sourcegooglesearchconsolecustomreportconfig.md similarity index 95% rename from docs/models/shared/sourcegooglesearchconsolecustomreportconfig.md rename to docs/models/sourcegooglesearchconsolecustomreportconfig.md index 3b4d4a19..8b8c12d9 100644 --- a/docs/models/shared/sourcegooglesearchconsolecustomreportconfig.md +++ b/docs/models/sourcegooglesearchconsolecustomreportconfig.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dimensions` | List[[shared.SourceGoogleSearchConsoleValidEnums](../../models/shared/sourcegooglesearchconsolevalidenums.md)] | :heavy_check_mark: | A list of available dimensions. Please note, that for technical reasons `date` is the default dimension which will be included in your query whether you specify it or not. Primary key will consist of your custom dimensions and the default dimension along with `site_url` and `search_type`. | +| `dimensions` | List[[models.SourceGoogleSearchConsoleValidEnums](../models/sourcegooglesearchconsolevalidenums.md)] | :heavy_check_mark: | A list of available dimensions. Please note, that for technical reasons `date` is the default dimension which will be included in your query whether you specify it or not. Primary key will consist of your custom dimensions and the default dimension along with `site_url` and `search_type`. | | `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 diff --git a/docs/models/shared/sourcegooglesearchconsolegooglesearchconsole.md b/docs/models/sourcegooglesearchconsolegooglesearchconsole.md similarity index 100% rename from docs/models/shared/sourcegooglesearchconsolegooglesearchconsole.md rename to docs/models/sourcegooglesearchconsolegooglesearchconsole.md diff --git a/docs/models/shared/sourcegooglesearchconsoleoauth.md b/docs/models/sourcegooglesearchconsoleoauth.md similarity index 96% rename from docs/models/shared/sourcegooglesearchconsoleoauth.md rename to docs/models/sourcegooglesearchconsoleoauth.md index a85ad8af..0dba411e 100644 --- a/docs/models/shared/sourcegooglesearchconsoleoauth.md +++ b/docs/models/sourcegooglesearchconsoleoauth.md @@ -9,4 +9,4 @@ | `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. | | `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 +| `auth_type` | [models.SourceGoogleSearchConsoleAuthType](../models/sourcegooglesearchconsoleauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegooglesearchconsoleschemasauthtype.md b/docs/models/sourcegooglesearchconsoleschemasauthtype.md similarity index 100% rename from docs/models/shared/sourcegooglesearchconsoleschemasauthtype.md rename to docs/models/sourcegooglesearchconsoleschemasauthtype.md diff --git a/docs/models/shared/sourcegooglesearchconsoleserviceaccountkeyauthentication.md b/docs/models/sourcegooglesearchconsoleserviceaccountkeyauthentication.md similarity index 95% rename from docs/models/shared/sourcegooglesearchconsoleserviceaccountkeyauthentication.md rename to docs/models/sourcegooglesearchconsoleserviceaccountkeyauthentication.md index baf92e46..7cf38c46 100644 --- a/docs/models/shared/sourcegooglesearchconsoleserviceaccountkeyauthentication.md +++ b/docs/models/sourcegooglesearchconsoleserviceaccountkeyauthentication.md @@ -7,4 +7,4 @@ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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, ... } | -| `auth_type` | [shared.SourceGoogleSearchConsoleSchemasAuthType](../../models/shared/sourcegooglesearchconsoleschemasauthtype.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `auth_type` | [models.SourceGoogleSearchConsoleSchemasAuthType](../models/sourcegooglesearchconsoleschemasauthtype.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcegooglesearchconsolevalidenums.md b/docs/models/sourcegooglesearchconsolevalidenums.md similarity index 100% rename from docs/models/shared/sourcegooglesearchconsolevalidenums.md rename to docs/models/sourcegooglesearchconsolevalidenums.md diff --git a/docs/models/sourcegooglesheets.md b/docs/models/sourcegooglesheets.md new file mode 100644 index 00000000..fe2c6728 --- /dev/null +++ b/docs/models/sourcegooglesheets.md @@ -0,0 +1,11 @@ +# SourceGoogleSheets + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `credentials` | [Union[models.SourceGoogleSheetsAuthenticateViaGoogleOAuth, models.SourceGoogleSheetsServiceAccountKeyAuthentication]](../models/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` | [models.SourceGoogleSheetsGoogleSheets](../models/sourcegooglesheetsgooglesheets.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcegooglesheetsauthenticateviagoogleoauth.md b/docs/models/sourcegooglesheetsauthenticateviagoogleoauth.md similarity index 96% rename from docs/models/shared/sourcegooglesheetsauthenticateviagoogleoauth.md rename to docs/models/sourcegooglesheetsauthenticateviagoogleoauth.md index ab336f7a..400d9f71 100644 --- a/docs/models/shared/sourcegooglesheetsauthenticateviagoogleoauth.md +++ b/docs/models/sourcegooglesheetsauthenticateviagoogleoauth.md @@ -8,4 +8,4 @@ | `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. | -| `auth_type` | [shared.SourceGoogleSheetsAuthType](../../models/shared/sourcegooglesheetsauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `auth_type` | [models.SourceGoogleSheetsAuthType](../models/sourcegooglesheetsauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegooglesheetsauthentication.md b/docs/models/sourcegooglesheetsauthentication.md new file mode 100644 index 00000000..7808a8e2 --- /dev/null +++ b/docs/models/sourcegooglesheetsauthentication.md @@ -0,0 +1,19 @@ +# SourceGoogleSheetsAuthentication + +Credentials for connecting to the Google Sheets API + + +## Supported Types + +### SourceGoogleSheetsAuthenticateViaGoogleOAuth + +```python +sourceGoogleSheetsAuthentication: models.SourceGoogleSheetsAuthenticateViaGoogleOAuth = /* values here */ +``` + +### SourceGoogleSheetsServiceAccountKeyAuthentication + +```python +sourceGoogleSheetsAuthentication: models.SourceGoogleSheetsServiceAccountKeyAuthentication = /* values here */ +``` + diff --git a/docs/models/shared/sourcegooglesheetsauthtype.md b/docs/models/sourcegooglesheetsauthtype.md similarity index 100% rename from docs/models/shared/sourcegooglesheetsauthtype.md rename to docs/models/sourcegooglesheetsauthtype.md diff --git a/docs/models/shared/sourcegooglesheetsgooglesheets.md b/docs/models/sourcegooglesheetsgooglesheets.md similarity index 100% rename from docs/models/shared/sourcegooglesheetsgooglesheets.md rename to docs/models/sourcegooglesheetsgooglesheets.md diff --git a/docs/models/shared/sourcegooglesheetsschemasauthtype.md b/docs/models/sourcegooglesheetsschemasauthtype.md similarity index 100% rename from docs/models/shared/sourcegooglesheetsschemasauthtype.md rename to docs/models/sourcegooglesheetsschemasauthtype.md diff --git a/docs/models/shared/sourcegooglesheetsserviceaccountkeyauthentication.md b/docs/models/sourcegooglesheetsserviceaccountkeyauthentication.md similarity index 96% rename from docs/models/shared/sourcegooglesheetsserviceaccountkeyauthentication.md rename to docs/models/sourcegooglesheetsserviceaccountkeyauthentication.md index 14922631..bc7513f6 100644 --- a/docs/models/shared/sourcegooglesheetsserviceaccountkeyauthentication.md +++ b/docs/models/sourcegooglesheetsserviceaccountkeyauthentication.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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 +| `auth_type` | [models.SourceGoogleSheetsSchemasAuthType](../models/sourcegooglesheetsschemasauthtype.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcegooglewebfonts.md b/docs/models/sourcegooglewebfonts.md similarity index 96% rename from docs/models/shared/sourcegooglewebfonts.md rename to docs/models/sourcegooglewebfonts.md index 71efb89f..bd71ef34 100644 --- a/docs/models/shared/sourcegooglewebfonts.md +++ b/docs/models/sourcegooglewebfonts.md @@ -9,4 +9,4 @@ | `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 +| `source_type` | [models.GoogleWebfonts](../models/googlewebfonts.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegreenhouse.md b/docs/models/sourcegreenhouse.md similarity index 94% rename from docs/models/shared/sourcegreenhouse.md rename to docs/models/sourcegreenhouse.md index c6f34c50..f6123e17 100644 --- a/docs/models/shared/sourcegreenhouse.md +++ b/docs/models/sourcegreenhouse.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | Greenhouse API Key. See the docs for more information on how to generate this key. | -| `source_type` | [shared.Greenhouse](../../models/shared/greenhouse.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `source_type` | [models.Greenhouse](../models/greenhouse.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcegridly.md b/docs/models/sourcegridly.md new file mode 100644 index 00000000..9d525c42 --- /dev/null +++ b/docs/models/sourcegridly.md @@ -0,0 +1,10 @@ +# SourceGridly + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | +| `api_key` | *str* | :heavy_check_mark: | N/A | +| `grid_id` | *str* | :heavy_check_mark: | ID of a grid, or can be ID of a branch | +| `source_type` | [models.Gridly](../models/gridly.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourceharvest.md b/docs/models/sourceharvest.md new file mode 100644 index 00000000..c55df5f0 --- /dev/null +++ b/docs/models/sourceharvest.md @@ -0,0 +1,12 @@ +# SourceHarvest + + +## Fields + +| 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[models.AuthenticateViaHarvestOAuth, models.SourceHarvestAuthenticateWithPersonalAccessToken]]](../models/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 | +| `source_type` | [models.SourceHarvestHarvest](../models/sourceharvestharvest.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceharvestauthenticatewithpersonalaccesstoken.md b/docs/models/sourceharvestauthenticatewithpersonalaccesstoken.md similarity index 91% rename from docs/models/shared/sourceharvestauthenticatewithpersonalaccesstoken.md rename to docs/models/sourceharvestauthenticatewithpersonalaccesstoken.md index 065e37a0..c0e1b939 100644 --- a/docs/models/shared/sourceharvestauthenticatewithpersonalaccesstoken.md +++ b/docs/models/sourceharvestauthenticatewithpersonalaccesstoken.md @@ -7,4 +7,4 @@ | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | | `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 +| `auth_type` | [Optional[models.SourceHarvestSchemasAuthType]](../models/sourceharvestschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourceharvestauthenticationmechanism.md b/docs/models/sourceharvestauthenticationmechanism.md new file mode 100644 index 00000000..e4057dc4 --- /dev/null +++ b/docs/models/sourceharvestauthenticationmechanism.md @@ -0,0 +1,19 @@ +# SourceHarvestAuthenticationMechanism + +Choose how to authenticate to Harvest. + + +## Supported Types + +### AuthenticateViaHarvestOAuth + +```python +sourceHarvestAuthenticationMechanism: models.AuthenticateViaHarvestOAuth = /* values here */ +``` + +### SourceHarvestAuthenticateWithPersonalAccessToken + +```python +sourceHarvestAuthenticationMechanism: models.SourceHarvestAuthenticateWithPersonalAccessToken = /* values here */ +``` + diff --git a/docs/models/shared/sourceharvestauthtype.md b/docs/models/sourceharvestauthtype.md similarity index 100% rename from docs/models/shared/sourceharvestauthtype.md rename to docs/models/sourceharvestauthtype.md diff --git a/docs/models/shared/sourceharvestharvest.md b/docs/models/sourceharvestharvest.md similarity index 100% rename from docs/models/shared/sourceharvestharvest.md rename to docs/models/sourceharvestharvest.md diff --git a/docs/models/shared/sourceharvestschemasauthtype.md b/docs/models/sourceharvestschemasauthtype.md similarity index 100% rename from docs/models/shared/sourceharvestschemasauthtype.md rename to docs/models/sourceharvestschemasauthtype.md diff --git a/docs/models/shared/sourcehubplanner.md b/docs/models/sourcehubplanner.md similarity index 91% rename from docs/models/shared/sourcehubplanner.md rename to docs/models/sourcehubplanner.md index 8b146181..29af05be 100644 --- a/docs/models/shared/sourcehubplanner.md +++ b/docs/models/sourcehubplanner.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `api_key` | *str* | :heavy_check_mark: | Hubplanner API key. See https://github.com/hubplanner/API#authentication for more details. | -| `source_type` | [shared.Hubplanner](../../models/shared/hubplanner.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `source_type` | [models.Hubplanner](../models/hubplanner.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcehubspot.md b/docs/models/sourcehubspot.md new file mode 100644 index 00000000..3654ceb7 --- /dev/null +++ b/docs/models/sourcehubspot.md @@ -0,0 +1,11 @@ +# SourceHubspot + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `credentials` | [Union[models.SourceHubspotOAuth, models.PrivateApp]](../models/sourcehubspotauthentication.md) | :heavy_check_mark: | Choose how to authenticate to HubSpot. | | +| `enable_experimental_streams` | *Optional[bool]* | :heavy_minus_sign: | If enabled then experimental streams become available for sync. | | +| `source_type` | [models.SourceHubspotHubspot](../models/sourcehubspothubspot.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:00Z. Any data before this date will not be replicated. If not set, "2006-06-01T00:00:00Z" (Hubspot creation date) will be used as start date. It's recommended to provide relevant to your data start date value to optimize synchronization. | 2017-01-25T00:00:00Z | \ No newline at end of file diff --git a/docs/models/sourcehubspotauthentication.md b/docs/models/sourcehubspotauthentication.md new file mode 100644 index 00000000..eb2bbccd --- /dev/null +++ b/docs/models/sourcehubspotauthentication.md @@ -0,0 +1,19 @@ +# SourceHubspotAuthentication + +Choose how to authenticate to HubSpot. + + +## Supported Types + +### SourceHubspotOAuth + +```python +sourceHubspotAuthentication: models.SourceHubspotOAuth = /* values here */ +``` + +### PrivateApp + +```python +sourceHubspotAuthentication: models.PrivateApp = /* values here */ +``` + diff --git a/docs/models/shared/sourcehubspotauthtype.md b/docs/models/sourcehubspotauthtype.md similarity index 100% rename from docs/models/shared/sourcehubspotauthtype.md rename to docs/models/sourcehubspotauthtype.md diff --git a/docs/models/shared/sourcehubspothubspot.md b/docs/models/sourcehubspothubspot.md similarity index 100% rename from docs/models/shared/sourcehubspothubspot.md rename to docs/models/sourcehubspothubspot.md diff --git a/docs/models/shared/sourcehubspotoauth.md b/docs/models/sourcehubspotoauth.md similarity index 97% rename from docs/models/shared/sourcehubspotoauth.md rename to docs/models/sourcehubspotoauth.md index e09159e9..1ceb32ad 100644 --- a/docs/models/shared/sourcehubspotoauth.md +++ b/docs/models/sourcehubspotoauth.md @@ -8,4 +8,4 @@ | `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 | | `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 +| `credentials_title` | [models.SourceHubspotAuthType](../models/sourcehubspotauthtype.md) | :heavy_check_mark: | Name of the credentials | | \ No newline at end of file diff --git a/docs/models/shared/sourcehubspotschemasauthtype.md b/docs/models/sourcehubspotschemasauthtype.md similarity index 100% rename from docs/models/shared/sourcehubspotschemasauthtype.md rename to docs/models/sourcehubspotschemasauthtype.md diff --git a/docs/models/shared/sourceinsightly.md b/docs/models/sourceinsightly.md similarity index 97% rename from docs/models/shared/sourceinsightly.md rename to docs/models/sourceinsightly.md index 85c09bfd..7f907cca 100644 --- a/docs/models/shared/sourceinsightly.md +++ b/docs/models/sourceinsightly.md @@ -7,4 +7,4 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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. | | -| `source_type` | [shared.Insightly](../../models/shared/insightly.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `source_type` | [models.Insightly](../models/insightly.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceinstagram.md b/docs/models/sourceinstagram.md similarity index 98% rename from docs/models/shared/sourceinstagram.md rename to docs/models/sourceinstagram.md index b26803b2..6de538c7 100644 --- a/docs/models/shared/sourceinstagram.md +++ b/docs/models/sourceinstagram.md @@ -8,5 +8,5 @@ | `access_token` | *str* | :heavy_check_mark: | 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 | | | `client_id` | *Optional[str]* | :heavy_minus_sign: | The Client ID for your Oauth application | | | `client_secret` | *Optional[str]* | :heavy_minus_sign: | The Client Secret for your Oauth application | | -| `source_type` | [shared.SourceInstagramInstagram](../../models/shared/sourceinstagraminstagram.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.SourceInstagramInstagram](../models/sourceinstagraminstagram.md) | :heavy_check_mark: | N/A | | | `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 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. | 2017-01-25T00:00:00Z | \ No newline at end of file diff --git a/docs/models/shared/sourceinstagraminstagram.md b/docs/models/sourceinstagraminstagram.md similarity index 100% rename from docs/models/shared/sourceinstagraminstagram.md rename to docs/models/sourceinstagraminstagram.md diff --git a/docs/models/sourceinstatus.md b/docs/models/sourceinstatus.md new file mode 100644 index 00000000..6a1b7153 --- /dev/null +++ b/docs/models/sourceinstatus.md @@ -0,0 +1,9 @@ +# SourceInstatus + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| `api_key` | *str* | :heavy_check_mark: | Instatus REST API key | +| `source_type` | [models.Instatus](../models/instatus.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceintercom.md b/docs/models/sourceintercom.md similarity index 98% rename from docs/models/shared/sourceintercom.md rename to docs/models/sourceintercom.md index 4cd7e7a3..1e0f5e43 100644 --- a/docs/models/shared/sourceintercom.md +++ b/docs/models/sourceintercom.md @@ -9,4 +9,4 @@ | `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 | | \ No newline at end of file +| `source_type` | [models.SourceIntercomIntercom](../models/sourceintercomintercom.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceintercomintercom.md b/docs/models/sourceintercomintercom.md similarity index 100% rename from docs/models/shared/sourceintercomintercom.md rename to docs/models/sourceintercomintercom.md diff --git a/docs/models/shared/sourceip2whois.md b/docs/models/sourceip2whois.md similarity index 93% rename from docs/models/shared/sourceip2whois.md rename to docs/models/sourceip2whois.md index 0c84a9a9..9ef21848 100644 --- a/docs/models/shared/sourceip2whois.md +++ b/docs/models/sourceip2whois.md @@ -7,4 +7,4 @@ | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | | `api_key` | *Optional[str]* | :heavy_minus_sign: | Your API Key. See here. | | | `domain` | *Optional[str]* | :heavy_minus_sign: | Domain name. See here. | www.google.com | -| `source_type` | [Optional[shared.Ip2whois]](../../models/shared/ip2whois.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `source_type` | [Optional[models.Ip2whois]](../models/ip2whois.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceiterable.md b/docs/models/sourceiterable.md similarity index 96% rename from docs/models/shared/sourceiterable.md rename to docs/models/sourceiterable.md index f56ecf3f..63c49369 100644 --- a/docs/models/shared/sourceiterable.md +++ b/docs/models/sourceiterable.md @@ -7,4 +7,4 @@ | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | Iterable API Key. See the docs 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: | 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 +| `source_type` | [models.Iterable](../models/iterable.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcejira.md b/docs/models/sourcejira.md similarity index 99% rename from docs/models/shared/sourcejira.md rename to docs/models/sourcejira.md index 80e12107..9492c0d8 100644 --- a/docs/models/shared/sourcejira.md +++ b/docs/models/sourcejira.md @@ -11,9 +11,9 @@ | `enable_experimental_streams` | *Optional[bool]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | (DEPRECATED) Expand the changelog when replicating issues. | | | `expand_issue_transition` | *Optional[bool]* | :heavy_minus_sign: | (DEPRECATED) Expand the transitions when replicating issues. | | -| `issues_stream_expand_with` | List[[shared.IssuesStreamExpandWith](../../models/shared/issuesstreamexpandwith.md)] | :heavy_minus_sign: | Select fields to Expand the `Issues` stream when replicating with: | | +| `issues_stream_expand_with` | List[[models.IssuesStreamExpandWith](../models/issuesstreamexpandwith.md)] | :heavy_minus_sign: | Select fields to Expand the `Issues` stream when replicating with: | | | `lookback_window_minutes` | *Optional[int]* | :heavy_minus_sign: | When set to N, the connector will always refresh resources created within the past N minutes. By default, updated objects that are not newly created are not incrementally synced. | 60 | | `projects` | List[*str*] | :heavy_minus_sign: | List of Jira project keys to replicate data for, or leave it empty if you want to replicate data for all projects. | PROJ1 | | `render_fields` | *Optional[bool]* | :heavy_minus_sign: | (DEPRECATED) Render issue fields in HTML format in addition to Jira JSON-like format. | | -| `source_type` | [shared.Jira](../../models/shared/jira.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.Jira](../models/jira.md) | :heavy_check_mark: | N/A | | | `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | 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. | 2021-03-01T00:00:00Z | \ No newline at end of file diff --git a/docs/models/shared/sourcek6cloud.md b/docs/models/sourcek6cloud.md similarity index 93% rename from docs/models/shared/sourcek6cloud.md rename to docs/models/sourcek6cloud.md index 123d79eb..14bcba8c 100644 --- a/docs/models/shared/sourcek6cloud.md +++ b/docs/models/sourcek6cloud.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | | `api_token` | *str* | :heavy_check_mark: | Your API Token. See here. The key is case sensitive. | -| `source_type` | [shared.K6Cloud](../../models/shared/k6cloud.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `source_type` | [models.K6Cloud](../models/k6cloud.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceklarna.md b/docs/models/sourceklarna.md similarity index 94% rename from docs/models/shared/sourceklarna.md rename to docs/models/sourceklarna.md index c9707dcf..061b6138 100644 --- a/docs/models/shared/sourceklarna.md +++ b/docs/models/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) | -| `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' | +| `region` | [models.SourceKlarnaRegion](../models/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' | | `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 +| `source_type` | [models.Klarna](../models/klarna.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceklarnaregion.md b/docs/models/sourceklarnaregion.md similarity index 100% rename from docs/models/shared/sourceklarnaregion.md rename to docs/models/sourceklarnaregion.md diff --git a/docs/models/shared/sourceklaviyo.md b/docs/models/sourceklaviyo.md similarity index 97% rename from docs/models/shared/sourceklaviyo.md rename to docs/models/sourceklaviyo.md index a0126fda..c8069b3d 100644 --- a/docs/models/shared/sourceklaviyo.md +++ b/docs/models/sourceklaviyo.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `api_key` | *str* | :heavy_check_mark: | Klaviyo API Key. See our docs if you need help finding this key. | | -| `source_type` | [shared.Klaviyo](../../models/shared/klaviyo.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.Klaviyo](../models/klaviyo.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:00Z. Any data before this date will not be replicated. This field is optional - if not provided, all data will be replicated. | 2017-01-25T00:00:00Z | \ No newline at end of file diff --git a/docs/models/shared/sourcekyve.md b/docs/models/sourcekyve.md similarity index 97% rename from docs/models/shared/sourcekyve.md rename to docs/models/sourcekyve.md index 218ab254..bd2aae2e 100644 --- a/docs/models/shared/sourcekyve.md +++ b/docs/models/sourcekyve.md @@ -9,5 +9,5 @@ | `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. | | -| `source_type` | [shared.Kyve](../../models/shared/kyve.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.Kyve](../models/kyve.md) | :heavy_check_mark: | N/A | | | `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/sourcelaunchdarkly.md b/docs/models/sourcelaunchdarkly.md similarity index 92% rename from docs/models/shared/sourcelaunchdarkly.md rename to docs/models/sourcelaunchdarkly.md index 6c2c4cec..cb96c0a8 100644 --- a/docs/models/shared/sourcelaunchdarkly.md +++ b/docs/models/sourcelaunchdarkly.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `access_token` | *str* | :heavy_check_mark: | Your Access token. See here. | -| `source_type` | [shared.Launchdarkly](../../models/shared/launchdarkly.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `source_type` | [models.Launchdarkly](../models/launchdarkly.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcelemlist.md b/docs/models/sourcelemlist.md new file mode 100644 index 00000000..5d7a24ad --- /dev/null +++ b/docs/models/sourcelemlist.md @@ -0,0 +1,9 @@ +# SourceLemlist + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | +| `api_key` | *str* | :heavy_check_mark: | Lemlist API key, | +| `source_type` | [models.Lemlist](../models/lemlist.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceleverhiring.md b/docs/models/sourceleverhiring.md similarity index 92% rename from docs/models/shared/sourceleverhiring.md rename to docs/models/sourceleverhiring.md index 44b3422a..d9b3eb93 100644 --- a/docs/models/shared/sourceleverhiring.md +++ b/docs/models/sourceleverhiring.md @@ -6,6 +6,6 @@ | 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 | | \ No newline at end of file +| `credentials` | [Optional[Union[models.AuthenticateViaLeverOAuth, models.AuthenticateViaLeverAPIKey]]](../models/sourceleverhiringauthenticationmechanism.md) | :heavy_minus_sign: | Choose how to authenticate to Lever Hiring. | | +| `environment` | [Optional[models.SourceLeverHiringEnvironment]](../models/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` | [models.SourceLeverHiringLeverHiring](../models/sourceleverhiringleverhiring.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/sourceleverhiringauthenticationmechanism.md b/docs/models/sourceleverhiringauthenticationmechanism.md new file mode 100644 index 00000000..9e39636d --- /dev/null +++ b/docs/models/sourceleverhiringauthenticationmechanism.md @@ -0,0 +1,19 @@ +# SourceLeverHiringAuthenticationMechanism + +Choose how to authenticate to Lever Hiring. + + +## Supported Types + +### AuthenticateViaLeverOAuth + +```python +sourceLeverHiringAuthenticationMechanism: models.AuthenticateViaLeverOAuth = /* values here */ +``` + +### AuthenticateViaLeverAPIKey + +```python +sourceLeverHiringAuthenticationMechanism: models.AuthenticateViaLeverAPIKey = /* values here */ +``` + diff --git a/docs/models/shared/sourceleverhiringauthtype.md b/docs/models/sourceleverhiringauthtype.md similarity index 100% rename from docs/models/shared/sourceleverhiringauthtype.md rename to docs/models/sourceleverhiringauthtype.md diff --git a/docs/models/shared/sourceleverhiringenvironment.md b/docs/models/sourceleverhiringenvironment.md similarity index 100% rename from docs/models/shared/sourceleverhiringenvironment.md rename to docs/models/sourceleverhiringenvironment.md diff --git a/docs/models/shared/sourceleverhiringleverhiring.md b/docs/models/sourceleverhiringleverhiring.md similarity index 100% rename from docs/models/shared/sourceleverhiringleverhiring.md rename to docs/models/sourceleverhiringleverhiring.md diff --git a/docs/models/shared/sourceleverhiringschemasauthtype.md b/docs/models/sourceleverhiringschemasauthtype.md similarity index 100% rename from docs/models/shared/sourceleverhiringschemasauthtype.md rename to docs/models/sourceleverhiringschemasauthtype.md diff --git a/docs/models/shared/sourcelinkedinads.md b/docs/models/sourcelinkedinads.md similarity index 96% rename from docs/models/shared/sourcelinkedinads.md rename to docs/models/sourcelinkedinads.md index 3ba07928..37af2697 100644 --- a/docs/models/shared/sourcelinkedinads.md +++ b/docs/models/sourcelinkedinads.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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 | | \ No newline at end of file +| `ad_analytics_reports` | List[[models.AdAnalyticsReportConfiguration](../models/adanalyticsreportconfiguration.md)] | :heavy_minus_sign: | N/A | | +| `credentials` | [Optional[Union[models.SourceLinkedinAdsOAuth20, models.AccessToken]]](../models/sourcelinkedinadsauthentication.md) | :heavy_minus_sign: | N/A | | +| `source_type` | [models.SourceLinkedinAdsLinkedinAds](../models/sourcelinkedinadslinkedinads.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/sourcelinkedinadsauthentication.md b/docs/models/sourcelinkedinadsauthentication.md new file mode 100644 index 00000000..25e9bf84 --- /dev/null +++ b/docs/models/sourcelinkedinadsauthentication.md @@ -0,0 +1,17 @@ +# SourceLinkedinAdsAuthentication + + +## Supported Types + +### SourceLinkedinAdsOAuth20 + +```python +sourceLinkedinAdsAuthentication: models.SourceLinkedinAdsOAuth20 = /* values here */ +``` + +### AccessToken + +```python +sourceLinkedinAdsAuthentication: models.AccessToken = /* values here */ +``` + diff --git a/docs/models/shared/sourcelinkedinadsauthmethod.md b/docs/models/sourcelinkedinadsauthmethod.md similarity index 100% rename from docs/models/shared/sourcelinkedinadsauthmethod.md rename to docs/models/sourcelinkedinadsauthmethod.md diff --git a/docs/models/shared/sourcelinkedinadslinkedinads.md b/docs/models/sourcelinkedinadslinkedinads.md similarity index 100% rename from docs/models/shared/sourcelinkedinadslinkedinads.md rename to docs/models/sourcelinkedinadslinkedinads.md diff --git a/docs/models/shared/sourcelinkedinadsoauth20.md b/docs/models/sourcelinkedinadsoauth20.md similarity index 97% rename from docs/models/shared/sourcelinkedinadsoauth20.md rename to docs/models/sourcelinkedinadsoauth20.md index 0ecda3ac..52d55719 100644 --- a/docs/models/shared/sourcelinkedinadsoauth20.md +++ b/docs/models/sourcelinkedinadsoauth20.md @@ -8,4 +8,4 @@ | `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. | -| `auth_method` | [Optional[shared.SourceLinkedinAdsAuthMethod]](../../models/shared/sourcelinkedinadsauthmethod.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `auth_method` | [Optional[models.SourceLinkedinAdsAuthMethod]](../models/sourcelinkedinadsauthmethod.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcelinkedinadsschemasauthmethod.md b/docs/models/sourcelinkedinadsschemasauthmethod.md similarity index 100% rename from docs/models/shared/sourcelinkedinadsschemasauthmethod.md rename to docs/models/sourcelinkedinadsschemasauthmethod.md diff --git a/docs/models/sourcelinkedinpages.md b/docs/models/sourcelinkedinpages.md new file mode 100644 index 00000000..1e42025c --- /dev/null +++ b/docs/models/sourcelinkedinpages.md @@ -0,0 +1,10 @@ +# SourceLinkedinPages + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | +| `org_id` | *str* | :heavy_check_mark: | Specify the Organization ID | 123456789 | +| `credentials` | [Optional[Union[models.SourceLinkedinPagesOAuth20, models.SourceLinkedinPagesAccessToken]]](../models/sourcelinkedinpagesauthentication.md) | :heavy_minus_sign: | N/A | | +| `source_type` | [models.LinkedinPages](../models/linkedinpages.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcelinkedinpagesaccesstoken.md b/docs/models/sourcelinkedinpagesaccesstoken.md similarity index 95% rename from docs/models/shared/sourcelinkedinpagesaccesstoken.md rename to docs/models/sourcelinkedinpagesaccesstoken.md index 0e7cf7c7..07cdd581 100644 --- a/docs/models/shared/sourcelinkedinpagesaccesstoken.md +++ b/docs/models/sourcelinkedinpagesaccesstoken.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `access_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.SourceLinkedinPagesSchemasAuthMethod]](../../models/shared/sourcelinkedinpagesschemasauthmethod.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `auth_method` | [Optional[models.SourceLinkedinPagesSchemasAuthMethod]](../models/sourcelinkedinpagesschemasauthmethod.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourcelinkedinpagesauthentication.md b/docs/models/sourcelinkedinpagesauthentication.md new file mode 100644 index 00000000..542fa99e --- /dev/null +++ b/docs/models/sourcelinkedinpagesauthentication.md @@ -0,0 +1,17 @@ +# SourceLinkedinPagesAuthentication + + +## Supported Types + +### SourceLinkedinPagesOAuth20 + +```python +sourceLinkedinPagesAuthentication: models.SourceLinkedinPagesOAuth20 = /* values here */ +``` + +### SourceLinkedinPagesAccessToken + +```python +sourceLinkedinPagesAuthentication: models.SourceLinkedinPagesAccessToken = /* values here */ +``` + diff --git a/docs/models/shared/sourcelinkedinpagesauthmethod.md b/docs/models/sourcelinkedinpagesauthmethod.md similarity index 100% rename from docs/models/shared/sourcelinkedinpagesauthmethod.md rename to docs/models/sourcelinkedinpagesauthmethod.md diff --git a/docs/models/shared/sourcelinkedinpagesoauth20.md b/docs/models/sourcelinkedinpagesoauth20.md similarity index 97% rename from docs/models/shared/sourcelinkedinpagesoauth20.md rename to docs/models/sourcelinkedinpagesoauth20.md index 3ed62d4a..8431fe4b 100644 --- a/docs/models/shared/sourcelinkedinpagesoauth20.md +++ b/docs/models/sourcelinkedinpagesoauth20.md @@ -8,4 +8,4 @@ | `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. | -| `auth_method` | [Optional[shared.SourceLinkedinPagesAuthMethod]](../../models/shared/sourcelinkedinpagesauthmethod.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `auth_method` | [Optional[models.SourceLinkedinPagesAuthMethod]](../models/sourcelinkedinpagesauthmethod.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcelinkedinpagesschemasauthmethod.md b/docs/models/sourcelinkedinpagesschemasauthmethod.md similarity index 100% rename from docs/models/shared/sourcelinkedinpagesschemasauthmethod.md rename to docs/models/sourcelinkedinpagesschemasauthmethod.md diff --git a/docs/models/sourcelinnworks.md b/docs/models/sourcelinnworks.md new file mode 100644 index 00000000..d567fde5 --- /dev/null +++ b/docs/models/sourcelinnworks.md @@ -0,0 +1,12 @@ +# SourceLinnworks + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `application_id` | *str* | :heavy_check_mark: | Linnworks Application ID | +| `application_secret` | *str* | :heavy_check_mark: | Linnworks Application Secret | +| `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 | +| `source_type` | [models.Linnworks](../models/linnworks.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcelokalise.md b/docs/models/sourcelokalise.md similarity index 96% rename from docs/models/shared/sourcelokalise.md rename to docs/models/sourcelokalise.md index 78cde4f9..dc743395 100644 --- a/docs/models/shared/sourcelokalise.md +++ b/docs/models/sourcelokalise.md @@ -7,4 +7,4 @@ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | Lokalise API Key with read-access. Available at Profile settings > API tokens. See here. | | `project_id` | *str* | :heavy_check_mark: | Lokalise project ID. Available at Project Settings > General. | -| `source_type` | [shared.Lokalise](../../models/shared/lokalise.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `source_type` | [models.Lokalise](../models/lokalise.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcemailchimp.md b/docs/models/sourcemailchimp.md similarity index 92% rename from docs/models/shared/sourcemailchimp.md rename to docs/models/sourcemailchimp.md index f069c127..4629e9e6 100644 --- a/docs/models/shared/sourcemailchimp.md +++ b/docs/models/sourcemailchimp.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `campaign_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `credentials` | [Optional[Union[shared.SourceMailchimpOAuth20, shared.APIKey]]](../../models/shared/sourcemailchimpauthentication.md) | :heavy_minus_sign: | N/A | | -| `source_type` | [shared.SourceMailchimpMailchimp](../../models/shared/sourcemailchimpmailchimp.md) | :heavy_check_mark: | N/A | | +| `credentials` | [Optional[Union[models.SourceMailchimpOAuth20, models.APIKey]]](../models/sourcemailchimpauthentication.md) | :heavy_minus_sign: | N/A | | +| `data_center` | *Optional[str]* | :heavy_minus_sign: | Technical fields used to identify datacenter to send request to | | +| `source_type` | [models.SourceMailchimpMailchimp](../models/sourcemailchimpmailchimp.md) | :heavy_check_mark: | N/A | | | `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | 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. | 2020-01-01T00:00:00.000Z | \ No newline at end of file diff --git a/docs/models/sourcemailchimpauthentication.md b/docs/models/sourcemailchimpauthentication.md new file mode 100644 index 00000000..30a146cf --- /dev/null +++ b/docs/models/sourcemailchimpauthentication.md @@ -0,0 +1,17 @@ +# SourceMailchimpAuthentication + + +## Supported Types + +### SourceMailchimpOAuth20 + +```python +sourceMailchimpAuthentication: models.SourceMailchimpOAuth20 = /* values here */ +``` + +### APIKey + +```python +sourceMailchimpAuthentication: models.APIKey = /* values here */ +``` + diff --git a/docs/models/shared/sourcemailchimpauthtype.md b/docs/models/sourcemailchimpauthtype.md similarity index 100% rename from docs/models/shared/sourcemailchimpauthtype.md rename to docs/models/sourcemailchimpauthtype.md diff --git a/docs/models/shared/sourcemailchimpmailchimp.md b/docs/models/sourcemailchimpmailchimp.md similarity index 100% rename from docs/models/shared/sourcemailchimpmailchimp.md rename to docs/models/sourcemailchimpmailchimp.md diff --git a/docs/models/sourcemailchimpoauth20.md b/docs/models/sourcemailchimpoauth20.md new file mode 100644 index 00000000..3eec4774 --- /dev/null +++ b/docs/models/sourcemailchimpoauth20.md @@ -0,0 +1,11 @@ +# SourceMailchimpOAuth20 + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `access_token` | *str* | :heavy_check_mark: | An access token generated using the above client ID and secret. | +| `auth_type` | [models.SourceMailchimpAuthType](../models/sourcemailchimpauthtype.md) | :heavy_check_mark: | N/A | +| `client_id` | *Optional[str]* | :heavy_minus_sign: | The Client ID of your OAuth application. | +| `client_secret` | *Optional[str]* | :heavy_minus_sign: | The Client Secret of your OAuth application. | \ No newline at end of file diff --git a/docs/models/shared/sourcemailchimpschemasauthtype.md b/docs/models/sourcemailchimpschemasauthtype.md similarity index 100% rename from docs/models/shared/sourcemailchimpschemasauthtype.md rename to docs/models/sourcemailchimpschemasauthtype.md diff --git a/docs/models/shared/sourcemailgun.md b/docs/models/sourcemailgun.md similarity index 98% rename from docs/models/shared/sourcemailgun.md rename to docs/models/sourcemailgun.md index e8efa2f7..cdfd6bdc 100644 --- a/docs/models/shared/sourcemailgun.md +++ b/docs/models/sourcemailgun.md @@ -7,5 +7,5 @@ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | | `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 | | +| `source_type` | [models.Mailgun](../models/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/sourcemailjetsms.md similarity index 96% rename from docs/models/shared/sourcemailjetsms.md rename to docs/models/sourcemailjetsms.md index 59ff9638..ab189383 100644 --- a/docs/models/shared/sourcemailjetsms.md +++ b/docs/models/sourcemailjetsms.md @@ -7,5 +7,5 @@ | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | | `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 | | +| `source_type` | [models.MailjetSms](../models/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 | \ No newline at end of file diff --git a/docs/models/shared/sourcemarketo.md b/docs/models/sourcemarketo.md similarity index 97% rename from docs/models/shared/sourcemarketo.md rename to docs/models/sourcemarketo.md index b3ee50b3..e0de7968 100644 --- a/docs/models/shared/sourcemarketo.md +++ b/docs/models/sourcemarketo.md @@ -9,4 +9,4 @@ | `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 | | `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 +| `source_type` | [models.Marketo](../models/marketo.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcemetabase.md b/docs/models/sourcemetabase.md similarity index 99% rename from docs/models/shared/sourcemetabase.md rename to docs/models/sourcemetabase.md index b21a2b0d..bd68fef4 100644 --- a/docs/models/shared/sourcemetabase.md +++ b/docs/models/sourcemetabase.md @@ -8,5 +8,5 @@ | `instance_api_url` | *str* | :heavy_check_mark: | URL to your metabase instance API | https://localhost:3000/api/ | | `password` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `session_token` | *Optional[str]* | :heavy_minus_sign: | To generate your session token, you need to run the following command: ``` curl -X POST \
    -H "Content-Type: application/json" \
    -d '{"username": "person@metabase.com", "password": "fakepassword"}' \
    http://localhost:3000/api/session
    ``` 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` | [shared.Metabase](../../models/shared/metabase.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.Metabase](../models/metabase.md) | :heavy_check_mark: | N/A | | | `username` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftonedrive.md b/docs/models/sourcemicrosoftonedrive.md new file mode 100644 index 00000000..b2f38f89 --- /dev/null +++ b/docs/models/sourcemicrosoftonedrive.md @@ -0,0 +1,17 @@ +# SourceMicrosoftOnedrive + +SourceMicrosoftOneDriveSpec class for Microsoft OneDrive Source Specification. +This class combines the authentication details with additional configuration for the OneDrive API. + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `credentials` | [Union[models.AuthenticateViaMicrosoftOAuth, models.ServiceKeyAuthentication]](../models/sourcemicrosoftonedriveauthentication.md) | :heavy_check_mark: | Credentials for connecting to the One Drive API | | +| `streams` | List[[models.SourceMicrosoftOnedriveFileBasedStreamConfig](../models/sourcemicrosoftonedrivefilebasedstreamconfig.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. | | +| `drive_name` | *Optional[str]* | :heavy_minus_sign: | Name of the Microsoft OneDrive drive where the file(s) exist. | | +| `folder_path` | *Optional[str]* | :heavy_minus_sign: | Path to a specific folder within the drives to search for files. Leave empty to search all folders of the drives. This does not apply to shared items. | | +| `search_scope` | [Optional[models.SearchScope]](../models/searchscope.md) | :heavy_minus_sign: | Specifies the location(s) to search for files. Valid options are 'ACCESSIBLE_DRIVES' to search in the selected OneDrive drive, 'SHARED_ITEMS' for shared items the user has access to, and 'ALL' to search both. | | +| `source_type` | [models.SourceMicrosoftOnedriveMicrosoftOnedrive](../models/sourcemicrosoftonedrivemicrosoftonedrive.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 | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftonedriveauthentication.md b/docs/models/sourcemicrosoftonedriveauthentication.md new file mode 100644 index 00000000..8a4611e1 --- /dev/null +++ b/docs/models/sourcemicrosoftonedriveauthentication.md @@ -0,0 +1,19 @@ +# SourceMicrosoftOnedriveAuthentication + +Credentials for connecting to the One Drive API + + +## Supported Types + +### AuthenticateViaMicrosoftOAuth + +```python +sourceMicrosoftOnedriveAuthentication: models.AuthenticateViaMicrosoftOAuth = /* values here */ +``` + +### ServiceKeyAuthentication + +```python +sourceMicrosoftOnedriveAuthentication: models.ServiceKeyAuthentication = /* values here */ +``` + diff --git a/docs/models/sourcemicrosoftonedriveauthtype.md b/docs/models/sourcemicrosoftonedriveauthtype.md new file mode 100644 index 00000000..dc7b3c8d --- /dev/null +++ b/docs/models/sourcemicrosoftonedriveauthtype.md @@ -0,0 +1,8 @@ +# SourceMicrosoftOnedriveAuthType + + +## Values + +| Name | Value | +| -------- | -------- | +| `CLIENT` | Client | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftonedriveautogenerated.md b/docs/models/sourcemicrosoftonedriveautogenerated.md new file mode 100644 index 00000000..a0920a5b --- /dev/null +++ b/docs/models/sourcemicrosoftonedriveautogenerated.md @@ -0,0 +1,8 @@ +# SourceMicrosoftOnedriveAutogenerated + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| `header_definition_type` | [Optional[models.SourceMicrosoftOnedriveSchemasHeaderDefinitionType]](../models/sourcemicrosoftonedriveschemasheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftonedriveavroformat.md b/docs/models/sourcemicrosoftonedriveavroformat.md new file mode 100644 index 00000000..b388179a --- /dev/null +++ b/docs/models/sourcemicrosoftonedriveavroformat.md @@ -0,0 +1,9 @@ +# SourceMicrosoftOnedriveAvroFormat + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `double_as_string` | *Optional[bool]* | :heavy_minus_sign: | Whether to convert double fields to strings. This is recommended if you have decimal numbers with a high degree of precision because there can be a loss precision when handling floating point numbers. | +| `filetype` | [Optional[models.SourceMicrosoftOnedriveFiletype]](../models/sourcemicrosoftonedrivefiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftonedrivecsvformat.md b/docs/models/sourcemicrosoftonedrivecsvformat.md new file mode 100644 index 00000000..625b65b0 --- /dev/null +++ b/docs/models/sourcemicrosoftonedrivecsvformat.md @@ -0,0 +1,20 @@ +# SourceMicrosoftOnedriveCSVFormat + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `delimiter` | *Optional[str]* | :heavy_minus_sign: | The character delimiting individual cells in the CSV data. This may only be a 1-character string. For tab-delimited data enter '\t'. | +| `double_quote` | *Optional[bool]* | :heavy_minus_sign: | Whether two quotes in a quoted CSV value denote a single quote in the data. | +| `encoding` | *Optional[str]* | :heavy_minus_sign: | The character encoding of the CSV data. Leave blank to default to UTF8. See list of python encodings for allowable options. | +| `escape_char` | *Optional[str]* | :heavy_minus_sign: | The character used for escaping special characters. To disallow escaping, leave this field blank. | +| `false_values` | List[*str*] | :heavy_minus_sign: | A set of case-sensitive strings that should be interpreted as false values. | +| `filetype` | [Optional[models.SourceMicrosoftOnedriveSchemasFiletype]](../models/sourcemicrosoftonedriveschemasfiletype.md) | :heavy_minus_sign: | N/A | +| `header_definition` | [Optional[Union[models.SourceMicrosoftOnedriveFromCSV, models.SourceMicrosoftOnedriveAutogenerated, models.SourceMicrosoftOnedriveUserProvided]]](../models/sourcemicrosoftonedrivecsvheaderdefinition.md) | :heavy_minus_sign: | How headers will be defined. `User Provided` assumes the CSV does not have a header row and uses the headers provided and `Autogenerated` assumes the CSV does not have a header row and the CDK will generate headers using for `f{i}` where `i` is the index starting from 0. Else, the default behavior is to use the header from the CSV file. If a user wants to autogenerate or provide column names for a CSV having headers, they can skip rows. | +| `null_values` | List[*str*] | :heavy_minus_sign: | A set of case-sensitive strings that should be interpreted as null values. For example, if the value 'NA' should be interpreted as null, enter 'NA' in this field. | +| `quote_char` | *Optional[str]* | :heavy_minus_sign: | The character used for quoting CSV values. To disallow quoting, make this field blank. | +| `skip_rows_after_header` | *Optional[int]* | :heavy_minus_sign: | The number of rows to skip after the header row. | +| `skip_rows_before_header` | *Optional[int]* | :heavy_minus_sign: | The number of rows to skip before the header row. For example, if the header row is on the 3rd row, enter 2 in this field. | +| `strings_can_be_null` | *Optional[bool]* | :heavy_minus_sign: | Whether strings can be interpreted as null values. If true, strings that match the null_values set will be interpreted as null. If false, strings that match the null_values set will be interpreted as the string itself. | +| `true_values` | List[*str*] | :heavy_minus_sign: | A set of case-sensitive strings that should be interpreted as true values. | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftonedrivecsvheaderdefinition.md b/docs/models/sourcemicrosoftonedrivecsvheaderdefinition.md new file mode 100644 index 00000000..5a1fb600 --- /dev/null +++ b/docs/models/sourcemicrosoftonedrivecsvheaderdefinition.md @@ -0,0 +1,25 @@ +# SourceMicrosoftOnedriveCSVHeaderDefinition + +How headers will be defined. `User Provided` assumes the CSV does not have a header row and uses the headers provided and `Autogenerated` assumes the CSV does not have a header row and the CDK will generate headers using for `f{i}` where `i` is the index starting from 0. Else, the default behavior is to use the header from the CSV file. If a user wants to autogenerate or provide column names for a CSV having headers, they can skip rows. + + +## Supported Types + +### SourceMicrosoftOnedriveFromCSV + +```python +sourceMicrosoftOnedriveCSVHeaderDefinition: models.SourceMicrosoftOnedriveFromCSV = /* values here */ +``` + +### SourceMicrosoftOnedriveAutogenerated + +```python +sourceMicrosoftOnedriveCSVHeaderDefinition: models.SourceMicrosoftOnedriveAutogenerated = /* values here */ +``` + +### SourceMicrosoftOnedriveUserProvided + +```python +sourceMicrosoftOnedriveCSVHeaderDefinition: models.SourceMicrosoftOnedriveUserProvided = /* values here */ +``` + diff --git a/docs/models/sourcemicrosoftonedrivedocumentfiletypeformatexperimental.md b/docs/models/sourcemicrosoftonedrivedocumentfiletypeformatexperimental.md new file mode 100644 index 00000000..7172ecc2 --- /dev/null +++ b/docs/models/sourcemicrosoftonedrivedocumentfiletypeformatexperimental.md @@ -0,0 +1,13 @@ +# SourceMicrosoftOnedriveDocumentFileTypeFormatExperimental + +Extract text from document formats (.pdf, .docx, .md, .pptx) and emit as one record per file. + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `filetype` | [Optional[models.SourceMicrosoftOnedriveSchemasStreamsFormatFormatFiletype]](../models/sourcemicrosoftonedriveschemasstreamsformatformatfiletype.md) | :heavy_minus_sign: | N/A | +| `processing` | [Optional[Union[models.SourceMicrosoftOnedriveLocal]]](../models/sourcemicrosoftonedriveprocessing.md) | :heavy_minus_sign: | Processing configuration | +| `skip_unprocessable_files` | *Optional[bool]* | :heavy_minus_sign: | If true, skip files that cannot be parsed and pass the error message along as the _ab_source_file_parse_error field. If false, fail the sync. | +| `strategy` | [Optional[models.SourceMicrosoftOnedriveParsingStrategy]](../models/sourcemicrosoftonedriveparsingstrategy.md) | :heavy_minus_sign: | The strategy used to parse documents. `fast` extracts text directly from the document which doesn't work for all files. `ocr_only` is more reliable, but slower. `hi_res` is the most reliable, but requires an API key and a hosted instance of unstructured and can't be used with local mode. See the unstructured.io documentation for more details: https://unstructured-io.github.io/unstructured/core/partition.html#partition-pdf | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftonedrivefilebasedstreamconfig.md b/docs/models/sourcemicrosoftonedrivefilebasedstreamconfig.md new file mode 100644 index 00000000..25cf0644 --- /dev/null +++ b/docs/models/sourcemicrosoftonedrivefilebasedstreamconfig.md @@ -0,0 +1,15 @@ +# SourceMicrosoftOnedriveFileBasedStreamConfig + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `format` | [Union[models.SourceMicrosoftOnedriveAvroFormat, models.SourceMicrosoftOnedriveCSVFormat, models.SourceMicrosoftOnedriveJsonlFormat, models.SourceMicrosoftOnedriveParquetFormat, models.SourceMicrosoftOnedriveDocumentFileTypeFormatExperimental]](../models/sourcemicrosoftonedriveformat.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. | +| `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[models.SourceMicrosoftOnedriveValidationPolicy]](../models/sourcemicrosoftonedrivevalidationpolicy.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/sourcemicrosoftonedrivefiletype.md b/docs/models/sourcemicrosoftonedrivefiletype.md new file mode 100644 index 00000000..6d428bdd --- /dev/null +++ b/docs/models/sourcemicrosoftonedrivefiletype.md @@ -0,0 +1,8 @@ +# SourceMicrosoftOnedriveFiletype + + +## Values + +| Name | Value | +| ------ | ------ | +| `AVRO` | avro | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftonedriveformat.md b/docs/models/sourcemicrosoftonedriveformat.md new file mode 100644 index 00000000..3ccc0672 --- /dev/null +++ b/docs/models/sourcemicrosoftonedriveformat.md @@ -0,0 +1,37 @@ +# SourceMicrosoftOnedriveFormat + +The configuration options that are used to alter how to read incoming files that deviate from the standard formatting. + + +## Supported Types + +### SourceMicrosoftOnedriveAvroFormat + +```python +sourceMicrosoftOnedriveFormat: models.SourceMicrosoftOnedriveAvroFormat = /* values here */ +``` + +### SourceMicrosoftOnedriveCSVFormat + +```python +sourceMicrosoftOnedriveFormat: models.SourceMicrosoftOnedriveCSVFormat = /* values here */ +``` + +### SourceMicrosoftOnedriveJsonlFormat + +```python +sourceMicrosoftOnedriveFormat: models.SourceMicrosoftOnedriveJsonlFormat = /* values here */ +``` + +### SourceMicrosoftOnedriveParquetFormat + +```python +sourceMicrosoftOnedriveFormat: models.SourceMicrosoftOnedriveParquetFormat = /* values here */ +``` + +### SourceMicrosoftOnedriveDocumentFileTypeFormatExperimental + +```python +sourceMicrosoftOnedriveFormat: models.SourceMicrosoftOnedriveDocumentFileTypeFormatExperimental = /* values here */ +``` + diff --git a/docs/models/sourcemicrosoftonedrivefromcsv.md b/docs/models/sourcemicrosoftonedrivefromcsv.md new file mode 100644 index 00000000..16a014ce --- /dev/null +++ b/docs/models/sourcemicrosoftonedrivefromcsv.md @@ -0,0 +1,8 @@ +# SourceMicrosoftOnedriveFromCSV + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `header_definition_type` | [Optional[models.SourceMicrosoftOnedriveHeaderDefinitionType]](../models/sourcemicrosoftonedriveheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftonedriveheaderdefinitiontype.md b/docs/models/sourcemicrosoftonedriveheaderdefinitiontype.md new file mode 100644 index 00000000..1c8931ec --- /dev/null +++ b/docs/models/sourcemicrosoftonedriveheaderdefinitiontype.md @@ -0,0 +1,8 @@ +# SourceMicrosoftOnedriveHeaderDefinitionType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `FROM_CSV` | From CSV | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftonedrivejsonlformat.md b/docs/models/sourcemicrosoftonedrivejsonlformat.md new file mode 100644 index 00000000..789b03c8 --- /dev/null +++ b/docs/models/sourcemicrosoftonedrivejsonlformat.md @@ -0,0 +1,8 @@ +# SourceMicrosoftOnedriveJsonlFormat + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `filetype` | [Optional[models.SourceMicrosoftOnedriveSchemasStreamsFiletype]](../models/sourcemicrosoftonedriveschemasstreamsfiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftonedrivelocal.md b/docs/models/sourcemicrosoftonedrivelocal.md new file mode 100644 index 00000000..573c29a9 --- /dev/null +++ b/docs/models/sourcemicrosoftonedrivelocal.md @@ -0,0 +1,10 @@ +# SourceMicrosoftOnedriveLocal + +Process files locally, supporting `fast` and `ocr` modes. This is the default option. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `mode` | [Optional[models.SourceMicrosoftOnedriveMode]](../models/sourcemicrosoftonedrivemode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftonedrivemicrosoftonedrive.md b/docs/models/sourcemicrosoftonedrivemicrosoftonedrive.md new file mode 100644 index 00000000..757febcb --- /dev/null +++ b/docs/models/sourcemicrosoftonedrivemicrosoftonedrive.md @@ -0,0 +1,8 @@ +# SourceMicrosoftOnedriveMicrosoftOnedrive + + +## Values + +| Name | Value | +| -------------------- | -------------------- | +| `MICROSOFT_ONEDRIVE` | microsoft-onedrive | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftonedrivemode.md b/docs/models/sourcemicrosoftonedrivemode.md new file mode 100644 index 00000000..0781966f --- /dev/null +++ b/docs/models/sourcemicrosoftonedrivemode.md @@ -0,0 +1,8 @@ +# SourceMicrosoftOnedriveMode + + +## Values + +| Name | Value | +| ------- | ------- | +| `LOCAL` | local | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftonedriveparquetformat.md b/docs/models/sourcemicrosoftonedriveparquetformat.md new file mode 100644 index 00000000..5faebc8b --- /dev/null +++ b/docs/models/sourcemicrosoftonedriveparquetformat.md @@ -0,0 +1,9 @@ +# SourceMicrosoftOnedriveParquetFormat + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| `decimal_as_float` | *Optional[bool]* | :heavy_minus_sign: | Whether to convert decimal fields to floats. There is a loss of precision when converting decimals to floats, so this is not recommended. | +| `filetype` | [Optional[models.SourceMicrosoftOnedriveSchemasStreamsFormatFiletype]](../models/sourcemicrosoftonedriveschemasstreamsformatfiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftonedriveparsingstrategy.md b/docs/models/sourcemicrosoftonedriveparsingstrategy.md new file mode 100644 index 00000000..163684f2 --- /dev/null +++ b/docs/models/sourcemicrosoftonedriveparsingstrategy.md @@ -0,0 +1,13 @@ +# SourceMicrosoftOnedriveParsingStrategy + +The strategy used to parse documents. `fast` extracts text directly from the document which doesn't work for all files. `ocr_only` is more reliable, but slower. `hi_res` is the most reliable, but requires an API key and a hosted instance of unstructured and can't be used with local mode. See the unstructured.io documentation for more details: https://unstructured-io.github.io/unstructured/core/partition.html#partition-pdf + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `AUTO` | auto | +| `FAST` | fast | +| `OCR_ONLY` | ocr_only | +| `HI_RES` | hi_res | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftonedriveprocessing.md b/docs/models/sourcemicrosoftonedriveprocessing.md new file mode 100644 index 00000000..3bce263d --- /dev/null +++ b/docs/models/sourcemicrosoftonedriveprocessing.md @@ -0,0 +1,13 @@ +# SourceMicrosoftOnedriveProcessing + +Processing configuration + + +## Supported Types + +### SourceMicrosoftOnedriveLocal + +```python +sourceMicrosoftOnedriveProcessing: models.SourceMicrosoftOnedriveLocal = /* values here */ +``` + diff --git a/docs/models/sourcemicrosoftonedriveschemasauthtype.md b/docs/models/sourcemicrosoftonedriveschemasauthtype.md new file mode 100644 index 00000000..d19ed066 --- /dev/null +++ b/docs/models/sourcemicrosoftonedriveschemasauthtype.md @@ -0,0 +1,8 @@ +# SourceMicrosoftOnedriveSchemasAuthType + + +## Values + +| Name | Value | +| --------- | --------- | +| `SERVICE` | Service | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftonedriveschemasfiletype.md b/docs/models/sourcemicrosoftonedriveschemasfiletype.md new file mode 100644 index 00000000..73f59463 --- /dev/null +++ b/docs/models/sourcemicrosoftonedriveschemasfiletype.md @@ -0,0 +1,8 @@ +# SourceMicrosoftOnedriveSchemasFiletype + + +## Values + +| Name | Value | +| ----- | ----- | +| `CSV` | csv | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftonedriveschemasheaderdefinitiontype.md b/docs/models/sourcemicrosoftonedriveschemasheaderdefinitiontype.md new file mode 100644 index 00000000..2516a69a --- /dev/null +++ b/docs/models/sourcemicrosoftonedriveschemasheaderdefinitiontype.md @@ -0,0 +1,8 @@ +# SourceMicrosoftOnedriveSchemasHeaderDefinitionType + + +## Values + +| Name | Value | +| --------------- | --------------- | +| `AUTOGENERATED` | Autogenerated | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftonedriveschemasstreamsfiletype.md b/docs/models/sourcemicrosoftonedriveschemasstreamsfiletype.md new file mode 100644 index 00000000..4ea8c2b9 --- /dev/null +++ b/docs/models/sourcemicrosoftonedriveschemasstreamsfiletype.md @@ -0,0 +1,8 @@ +# SourceMicrosoftOnedriveSchemasStreamsFiletype + + +## Values + +| Name | Value | +| ------- | ------- | +| `JSONL` | jsonl | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftonedriveschemasstreamsformatfiletype.md b/docs/models/sourcemicrosoftonedriveschemasstreamsformatfiletype.md new file mode 100644 index 00000000..11b9e7c7 --- /dev/null +++ b/docs/models/sourcemicrosoftonedriveschemasstreamsformatfiletype.md @@ -0,0 +1,8 @@ +# SourceMicrosoftOnedriveSchemasStreamsFormatFiletype + + +## Values + +| Name | Value | +| --------- | --------- | +| `PARQUET` | parquet | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftonedriveschemasstreamsformatformatfiletype.md b/docs/models/sourcemicrosoftonedriveschemasstreamsformatformatfiletype.md new file mode 100644 index 00000000..0d88d17a --- /dev/null +++ b/docs/models/sourcemicrosoftonedriveschemasstreamsformatformatfiletype.md @@ -0,0 +1,8 @@ +# SourceMicrosoftOnedriveSchemasStreamsFormatFormatFiletype + + +## Values + +| Name | Value | +| -------------- | -------------- | +| `UNSTRUCTURED` | unstructured | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftonedriveschemasstreamsheaderdefinitiontype.md b/docs/models/sourcemicrosoftonedriveschemasstreamsheaderdefinitiontype.md new file mode 100644 index 00000000..bfd1a89e --- /dev/null +++ b/docs/models/sourcemicrosoftonedriveschemasstreamsheaderdefinitiontype.md @@ -0,0 +1,8 @@ +# SourceMicrosoftOnedriveSchemasStreamsHeaderDefinitionType + + +## Values + +| Name | Value | +| --------------- | --------------- | +| `USER_PROVIDED` | User Provided | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftonedriveuserprovided.md b/docs/models/sourcemicrosoftonedriveuserprovided.md new file mode 100644 index 00000000..a18b062a --- /dev/null +++ b/docs/models/sourcemicrosoftonedriveuserprovided.md @@ -0,0 +1,9 @@ +# SourceMicrosoftOnedriveUserProvided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `column_names` | List[*str*] | :heavy_check_mark: | The column names that will be used while emitting the CSV records | +| `header_definition_type` | [Optional[models.SourceMicrosoftOnedriveSchemasStreamsHeaderDefinitionType]](../models/sourcemicrosoftonedriveschemasstreamsheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftonedrivevalidationpolicy.md b/docs/models/sourcemicrosoftonedrivevalidationpolicy.md new file mode 100644 index 00000000..579d3166 --- /dev/null +++ b/docs/models/sourcemicrosoftonedrivevalidationpolicy.md @@ -0,0 +1,12 @@ +# SourceMicrosoftOnedriveValidationPolicy + +The name of the validation policy that dictates sync behavior when a record does not adhere to the stream schema. + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `EMIT_RECORD` | Emit Record | +| `SKIP_RECORD` | Skip Record | +| `WAIT_FOR_DISCOVER` | Wait for Discover | \ No newline at end of file diff --git a/docs/models/shared/sourcemicrosoftsharepoint.md b/docs/models/sourcemicrosoftsharepoint.md similarity index 81% rename from docs/models/shared/sourcemicrosoftsharepoint.md rename to docs/models/sourcemicrosoftsharepoint.md index 2ce61d00..e320a822 100644 --- a/docs/models/shared/sourcemicrosoftsharepoint.md +++ b/docs/models/sourcemicrosoftsharepoint.md @@ -8,8 +8,9 @@ This class combines the authentication details with additional configuration for | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `credentials` | [Union[shared.AuthenticateViaMicrosoftOAuth, shared.ServiceKeyAuthentication]](../../models/shared/sourcemicrosoftsharepointauthentication.md) | :heavy_check_mark: | Credentials for connecting to the One Drive API | | -| `folder_path` | *str* | :heavy_check_mark: | Path to folder of the Microsoft SharePoint drive where the file(s) exist. | | -| `streams` | List[[shared.SourceMicrosoftSharepointFileBasedStreamConfig](../../models/shared/sourcemicrosoftsharepointfilebasedstreamconfig.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.SourceMicrosoftSharepointMicrosoftSharepoint](../../models/shared/sourcemicrosoftsharepointmicrosoftsharepoint.md) | :heavy_check_mark: | N/A | | +| `credentials` | [Union[models.SourceMicrosoftSharepointAuthenticateViaMicrosoftOAuth, models.SourceMicrosoftSharepointServiceKeyAuthentication]](../models/sourcemicrosoftsharepointauthentication.md) | :heavy_check_mark: | Credentials for connecting to the One Drive API | | +| `streams` | List[[models.SourceMicrosoftSharepointFileBasedStreamConfig](../models/sourcemicrosoftsharepointfilebasedstreamconfig.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. | | +| `folder_path` | *Optional[str]* | :heavy_minus_sign: | Path to a specific folder within the drives to search for files. Leave empty to search all folders of the drives. This does not apply to shared items. | | +| `search_scope` | [Optional[models.SourceMicrosoftSharepointSearchScope]](../models/sourcemicrosoftsharepointsearchscope.md) | :heavy_minus_sign: | Specifies the location(s) to search for files. Valid options are 'ACCESSIBLE_DRIVES' for all SharePoint drives the user can access, 'SHARED_ITEMS' for shared items the user has access to, and 'ALL' to search both. | | +| `source_type` | [models.SourceMicrosoftSharepointMicrosoftSharepoint](../models/sourcemicrosoftsharepointmicrosoftsharepoint.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 | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftsharepointauthenticateviamicrosoftoauth.md b/docs/models/sourcemicrosoftsharepointauthenticateviamicrosoftoauth.md new file mode 100644 index 00000000..0fcfbf57 --- /dev/null +++ b/docs/models/sourcemicrosoftsharepointauthenticateviamicrosoftoauth.md @@ -0,0 +1,15 @@ +# SourceMicrosoftSharepointAuthenticateViaMicrosoftOAuth + +OAuthCredentials class to hold authentication details for Microsoft OAuth authentication. +This class uses pydantic for data validation and settings management. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `client_id` | *str* | :heavy_check_mark: | Client ID of your Microsoft developer application | +| `client_secret` | *str* | :heavy_check_mark: | Client Secret of your Microsoft developer application | +| `refresh_token` | *str* | :heavy_check_mark: | Refresh Token of your Microsoft developer application | +| `tenant_id` | *str* | :heavy_check_mark: | Tenant ID of the Microsoft SharePoint user | +| `auth_type` | [Optional[models.SourceMicrosoftSharepointAuthType]](../models/sourcemicrosoftsharepointauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftsharepointauthentication.md b/docs/models/sourcemicrosoftsharepointauthentication.md new file mode 100644 index 00000000..6f529926 --- /dev/null +++ b/docs/models/sourcemicrosoftsharepointauthentication.md @@ -0,0 +1,19 @@ +# SourceMicrosoftSharepointAuthentication + +Credentials for connecting to the One Drive API + + +## Supported Types + +### SourceMicrosoftSharepointAuthenticateViaMicrosoftOAuth + +```python +sourceMicrosoftSharepointAuthentication: models.SourceMicrosoftSharepointAuthenticateViaMicrosoftOAuth = /* values here */ +``` + +### SourceMicrosoftSharepointServiceKeyAuthentication + +```python +sourceMicrosoftSharepointAuthentication: models.SourceMicrosoftSharepointServiceKeyAuthentication = /* values here */ +``` + diff --git a/docs/models/shared/sourcemicrosoftsharepointauthtype.md b/docs/models/sourcemicrosoftsharepointauthtype.md similarity index 100% rename from docs/models/shared/sourcemicrosoftsharepointauthtype.md rename to docs/models/sourcemicrosoftsharepointauthtype.md diff --git a/docs/models/sourcemicrosoftsharepointautogenerated.md b/docs/models/sourcemicrosoftsharepointautogenerated.md new file mode 100644 index 00000000..3d875c31 --- /dev/null +++ b/docs/models/sourcemicrosoftsharepointautogenerated.md @@ -0,0 +1,8 @@ +# SourceMicrosoftSharepointAutogenerated + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | +| `header_definition_type` | [Optional[models.SourceMicrosoftSharepointSchemasHeaderDefinitionType]](../models/sourcemicrosoftsharepointschemasheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcemicrosoftsharepointavroformat.md b/docs/models/sourcemicrosoftsharepointavroformat.md similarity index 96% rename from docs/models/shared/sourcemicrosoftsharepointavroformat.md rename to docs/models/sourcemicrosoftsharepointavroformat.md index 6eafeb0c..083ad0b8 100644 --- a/docs/models/shared/sourcemicrosoftsharepointavroformat.md +++ b/docs/models/sourcemicrosoftsharepointavroformat.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `double_as_string` | *Optional[bool]* | :heavy_minus_sign: | Whether to convert double fields to strings. This is recommended if you have decimal numbers with a high degree of precision because there can be a loss precision when handling floating point numbers. | -| `filetype` | [Optional[shared.SourceMicrosoftSharepointFiletype]](../../models/shared/sourcemicrosoftsharepointfiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `filetype` | [Optional[models.SourceMicrosoftSharepointFiletype]](../models/sourcemicrosoftsharepointfiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcemicrosoftsharepointcsvformat.md b/docs/models/sourcemicrosoftsharepointcsvformat.md similarity index 92% rename from docs/models/shared/sourcemicrosoftsharepointcsvformat.md rename to docs/models/sourcemicrosoftsharepointcsvformat.md index 4da5746d..859494da 100644 --- a/docs/models/shared/sourcemicrosoftsharepointcsvformat.md +++ b/docs/models/sourcemicrosoftsharepointcsvformat.md @@ -10,8 +10,9 @@ | `encoding` | *Optional[str]* | :heavy_minus_sign: | The character encoding of the CSV data. Leave blank to default to UTF8. See list of python encodings for allowable options. | | `escape_char` | *Optional[str]* | :heavy_minus_sign: | The character used for escaping special characters. To disallow escaping, leave this field blank. | | `false_values` | List[*str*] | :heavy_minus_sign: | A set of case-sensitive strings that should be interpreted as false values. | -| `filetype` | [Optional[shared.SourceMicrosoftSharepointSchemasFiletype]](../../models/shared/sourcemicrosoftsharepointschemasfiletype.md) | :heavy_minus_sign: | N/A | -| `header_definition` | [Optional[Union[shared.SourceMicrosoftSharepointFromCSV, shared.SourceMicrosoftSharepointAutogenerated, shared.SourceMicrosoftSharepointUserProvided]]](../../models/shared/sourcemicrosoftsharepointcsvheaderdefinition.md) | :heavy_minus_sign: | How headers will be defined. `User Provided` assumes the CSV does not have a header row and uses the headers provided and `Autogenerated` assumes the CSV does not have a header row and the CDK will generate headers using for `f{i}` where `i` is the index starting from 0. Else, the default behavior is to use the header from the CSV file. If a user wants to autogenerate or provide column names for a CSV having headers, they can skip rows. | +| `filetype` | [Optional[models.SourceMicrosoftSharepointSchemasFiletype]](../models/sourcemicrosoftsharepointschemasfiletype.md) | :heavy_minus_sign: | N/A | +| `header_definition` | [Optional[Union[models.SourceMicrosoftSharepointFromCSV, models.SourceMicrosoftSharepointAutogenerated, models.SourceMicrosoftSharepointUserProvided]]](../models/sourcemicrosoftsharepointcsvheaderdefinition.md) | :heavy_minus_sign: | How headers will be defined. `User Provided` assumes the CSV does not have a header row and uses the headers provided and `Autogenerated` assumes the CSV does not have a header row and the CDK will generate headers using for `f{i}` where `i` is the index starting from 0. Else, the default behavior is to use the header from the CSV file. If a user wants to autogenerate or provide column names for a CSV having headers, they can skip rows. | +| `ignore_errors_on_fields_mismatch` | *Optional[bool]* | :heavy_minus_sign: | Whether to ignore errors that occur when the number of fields in the CSV does not match the number of columns in the schema. | | `null_values` | List[*str*] | :heavy_minus_sign: | A set of case-sensitive strings that should be interpreted as null values. For example, if the value 'NA' should be interpreted as null, enter 'NA' in this field. | | `quote_char` | *Optional[str]* | :heavy_minus_sign: | The character used for quoting CSV values. To disallow quoting, make this field blank. | | `skip_rows_after_header` | *Optional[int]* | :heavy_minus_sign: | The number of rows to skip after the header row. | diff --git a/docs/models/shared/sourcemicrosoftsharepointcsvheaderdefinition.md b/docs/models/sourcemicrosoftsharepointcsvheaderdefinition.md similarity index 80% rename from docs/models/shared/sourcemicrosoftsharepointcsvheaderdefinition.md rename to docs/models/sourcemicrosoftsharepointcsvheaderdefinition.md index f7827e9e..0773bf5d 100644 --- a/docs/models/shared/sourcemicrosoftsharepointcsvheaderdefinition.md +++ b/docs/models/sourcemicrosoftsharepointcsvheaderdefinition.md @@ -8,18 +8,18 @@ How headers will be defined. `User Provided` assumes the CSV does not have a hea ### SourceMicrosoftSharepointFromCSV ```python -sourceMicrosoftSharepointCSVHeaderDefinition: shared.SourceMicrosoftSharepointFromCSV = /* values here */ +sourceMicrosoftSharepointCSVHeaderDefinition: models.SourceMicrosoftSharepointFromCSV = /* values here */ ``` ### SourceMicrosoftSharepointAutogenerated ```python -sourceMicrosoftSharepointCSVHeaderDefinition: shared.SourceMicrosoftSharepointAutogenerated = /* values here */ +sourceMicrosoftSharepointCSVHeaderDefinition: models.SourceMicrosoftSharepointAutogenerated = /* values here */ ``` ### SourceMicrosoftSharepointUserProvided ```python -sourceMicrosoftSharepointCSVHeaderDefinition: shared.SourceMicrosoftSharepointUserProvided = /* values here */ +sourceMicrosoftSharepointCSVHeaderDefinition: models.SourceMicrosoftSharepointUserProvided = /* values here */ ``` diff --git a/docs/models/shared/sourcemicrosoftsharepointdocumentfiletypeformatexperimental.md b/docs/models/sourcemicrosoftsharepointdocumentfiletypeformatexperimental.md similarity index 94% rename from docs/models/shared/sourcemicrosoftsharepointdocumentfiletypeformatexperimental.md rename to docs/models/sourcemicrosoftsharepointdocumentfiletypeformatexperimental.md index 6aedab38..1c9cac43 100644 --- a/docs/models/shared/sourcemicrosoftsharepointdocumentfiletypeformatexperimental.md +++ b/docs/models/sourcemicrosoftsharepointdocumentfiletypeformatexperimental.md @@ -7,7 +7,7 @@ Extract text from document formats (.pdf, .docx, .md, .pptx) and emit as one rec | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `filetype` | [Optional[shared.SourceMicrosoftSharepointSchemasStreamsFormatFormatFiletype]](../../models/shared/sourcemicrosoftsharepointschemasstreamsformatformatfiletype.md) | :heavy_minus_sign: | N/A | -| `processing` | [Optional[Union[shared.SourceMicrosoftSharepointLocal]]](../../models/shared/sourcemicrosoftsharepointprocessing.md) | :heavy_minus_sign: | Processing configuration | +| `filetype` | [Optional[models.SourceMicrosoftSharepointSchemasStreamsFormatFormatFiletype]](../models/sourcemicrosoftsharepointschemasstreamsformatformatfiletype.md) | :heavy_minus_sign: | N/A | +| `processing` | [Optional[Union[models.SourceMicrosoftSharepointLocal]]](../models/sourcemicrosoftsharepointprocessing.md) | :heavy_minus_sign: | Processing configuration | | `skip_unprocessable_files` | *Optional[bool]* | :heavy_minus_sign: | If true, skip files that cannot be parsed and pass the error message along as the _ab_source_file_parse_error field. If false, fail the sync. | -| `strategy` | [Optional[shared.SourceMicrosoftSharepointParsingStrategy]](../../models/shared/sourcemicrosoftsharepointparsingstrategy.md) | :heavy_minus_sign: | The strategy used to parse documents. `fast` extracts text directly from the document which doesn't work for all files. `ocr_only` is more reliable, but slower. `hi_res` is the most reliable, but requires an API key and a hosted instance of unstructured and can't be used with local mode. See the unstructured.io documentation for more details: https://unstructured-io.github.io/unstructured/core/partition.html#partition-pdf | \ No newline at end of file +| `strategy` | [Optional[models.SourceMicrosoftSharepointParsingStrategy]](../models/sourcemicrosoftsharepointparsingstrategy.md) | :heavy_minus_sign: | The strategy used to parse documents. `fast` extracts text directly from the document which doesn't work for all files. `ocr_only` is more reliable, but slower. `hi_res` is the most reliable, but requires an API key and a hosted instance of unstructured and can't be used with local mode. See the unstructured.io documentation for more details: https://unstructured-io.github.io/unstructured/core/partition.html#partition-pdf | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftsharepointfilebasedstreamconfig.md b/docs/models/sourcemicrosoftsharepointfilebasedstreamconfig.md new file mode 100644 index 00000000..598429c6 --- /dev/null +++ b/docs/models/sourcemicrosoftsharepointfilebasedstreamconfig.md @@ -0,0 +1,15 @@ +# SourceMicrosoftSharepointFileBasedStreamConfig + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `format` | [Union[models.SourceMicrosoftSharepointAvroFormat, models.SourceMicrosoftSharepointCSVFormat, models.SourceMicrosoftSharepointJsonlFormat, models.SourceMicrosoftSharepointParquetFormat, models.SourceMicrosoftSharepointDocumentFileTypeFormatExperimental]](../models/sourcemicrosoftsharepointformat.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. | +| `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[models.SourceMicrosoftSharepointValidationPolicy]](../models/sourcemicrosoftsharepointvalidationpolicy.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/sourcemicrosoftsharepointfiletype.md b/docs/models/sourcemicrosoftsharepointfiletype.md similarity index 100% rename from docs/models/shared/sourcemicrosoftsharepointfiletype.md rename to docs/models/sourcemicrosoftsharepointfiletype.md diff --git a/docs/models/sourcemicrosoftsharepointformat.md b/docs/models/sourcemicrosoftsharepointformat.md new file mode 100644 index 00000000..16995664 --- /dev/null +++ b/docs/models/sourcemicrosoftsharepointformat.md @@ -0,0 +1,37 @@ +# SourceMicrosoftSharepointFormat + +The configuration options that are used to alter how to read incoming files that deviate from the standard formatting. + + +## Supported Types + +### SourceMicrosoftSharepointAvroFormat + +```python +sourceMicrosoftSharepointFormat: models.SourceMicrosoftSharepointAvroFormat = /* values here */ +``` + +### SourceMicrosoftSharepointCSVFormat + +```python +sourceMicrosoftSharepointFormat: models.SourceMicrosoftSharepointCSVFormat = /* values here */ +``` + +### SourceMicrosoftSharepointJsonlFormat + +```python +sourceMicrosoftSharepointFormat: models.SourceMicrosoftSharepointJsonlFormat = /* values here */ +``` + +### SourceMicrosoftSharepointParquetFormat + +```python +sourceMicrosoftSharepointFormat: models.SourceMicrosoftSharepointParquetFormat = /* values here */ +``` + +### SourceMicrosoftSharepointDocumentFileTypeFormatExperimental + +```python +sourceMicrosoftSharepointFormat: models.SourceMicrosoftSharepointDocumentFileTypeFormatExperimental = /* values here */ +``` + diff --git a/docs/models/sourcemicrosoftsharepointfromcsv.md b/docs/models/sourcemicrosoftsharepointfromcsv.md new file mode 100644 index 00000000..b564bf31 --- /dev/null +++ b/docs/models/sourcemicrosoftsharepointfromcsv.md @@ -0,0 +1,8 @@ +# SourceMicrosoftSharepointFromCSV + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `header_definition_type` | [Optional[models.SourceMicrosoftSharepointHeaderDefinitionType]](../models/sourcemicrosoftsharepointheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcemicrosoftsharepointheaderdefinitiontype.md b/docs/models/sourcemicrosoftsharepointheaderdefinitiontype.md similarity index 100% rename from docs/models/shared/sourcemicrosoftsharepointheaderdefinitiontype.md rename to docs/models/sourcemicrosoftsharepointheaderdefinitiontype.md diff --git a/docs/models/sourcemicrosoftsharepointjsonlformat.md b/docs/models/sourcemicrosoftsharepointjsonlformat.md new file mode 100644 index 00000000..a6a581c0 --- /dev/null +++ b/docs/models/sourcemicrosoftsharepointjsonlformat.md @@ -0,0 +1,8 @@ +# SourceMicrosoftSharepointJsonlFormat + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `filetype` | [Optional[models.SourceMicrosoftSharepointSchemasStreamsFiletype]](../models/sourcemicrosoftsharepointschemasstreamsfiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftsharepointlocal.md b/docs/models/sourcemicrosoftsharepointlocal.md new file mode 100644 index 00000000..6827f926 --- /dev/null +++ b/docs/models/sourcemicrosoftsharepointlocal.md @@ -0,0 +1,10 @@ +# SourceMicrosoftSharepointLocal + +Process files locally, supporting `fast` and `ocr` modes. This is the default option. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `mode` | [Optional[models.SourceMicrosoftSharepointMode]](../models/sourcemicrosoftsharepointmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcemicrosoftsharepointmicrosoftsharepoint.md b/docs/models/sourcemicrosoftsharepointmicrosoftsharepoint.md similarity index 100% rename from docs/models/shared/sourcemicrosoftsharepointmicrosoftsharepoint.md rename to docs/models/sourcemicrosoftsharepointmicrosoftsharepoint.md diff --git a/docs/models/shared/sourcemicrosoftsharepointmode.md b/docs/models/sourcemicrosoftsharepointmode.md similarity index 100% rename from docs/models/shared/sourcemicrosoftsharepointmode.md rename to docs/models/sourcemicrosoftsharepointmode.md diff --git a/docs/models/sourcemicrosoftsharepointparquetformat.md b/docs/models/sourcemicrosoftsharepointparquetformat.md new file mode 100644 index 00000000..f77130bd --- /dev/null +++ b/docs/models/sourcemicrosoftsharepointparquetformat.md @@ -0,0 +1,9 @@ +# SourceMicrosoftSharepointParquetFormat + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `decimal_as_float` | *Optional[bool]* | :heavy_minus_sign: | Whether to convert decimal fields to floats. There is a loss of precision when converting decimals to floats, so this is not recommended. | +| `filetype` | [Optional[models.SourceMicrosoftSharepointSchemasStreamsFormatFiletype]](../models/sourcemicrosoftsharepointschemasstreamsformatfiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcemicrosoftsharepointparsingstrategy.md b/docs/models/sourcemicrosoftsharepointparsingstrategy.md similarity index 100% rename from docs/models/shared/sourcemicrosoftsharepointparsingstrategy.md rename to docs/models/sourcemicrosoftsharepointparsingstrategy.md diff --git a/docs/models/sourcemicrosoftsharepointprocessing.md b/docs/models/sourcemicrosoftsharepointprocessing.md new file mode 100644 index 00000000..7a7f5f58 --- /dev/null +++ b/docs/models/sourcemicrosoftsharepointprocessing.md @@ -0,0 +1,13 @@ +# SourceMicrosoftSharepointProcessing + +Processing configuration + + +## Supported Types + +### SourceMicrosoftSharepointLocal + +```python +sourceMicrosoftSharepointProcessing: models.SourceMicrosoftSharepointLocal = /* values here */ +``` + diff --git a/docs/models/shared/sourcemicrosoftsharepointschemasauthtype.md b/docs/models/sourcemicrosoftsharepointschemasauthtype.md similarity index 100% rename from docs/models/shared/sourcemicrosoftsharepointschemasauthtype.md rename to docs/models/sourcemicrosoftsharepointschemasauthtype.md diff --git a/docs/models/shared/sourcemicrosoftsharepointschemasfiletype.md b/docs/models/sourcemicrosoftsharepointschemasfiletype.md similarity index 100% rename from docs/models/shared/sourcemicrosoftsharepointschemasfiletype.md rename to docs/models/sourcemicrosoftsharepointschemasfiletype.md diff --git a/docs/models/shared/sourcemicrosoftsharepointschemasheaderdefinitiontype.md b/docs/models/sourcemicrosoftsharepointschemasheaderdefinitiontype.md similarity index 100% rename from docs/models/shared/sourcemicrosoftsharepointschemasheaderdefinitiontype.md rename to docs/models/sourcemicrosoftsharepointschemasheaderdefinitiontype.md diff --git a/docs/models/shared/sourcemicrosoftsharepointschemasstreamsfiletype.md b/docs/models/sourcemicrosoftsharepointschemasstreamsfiletype.md similarity index 100% rename from docs/models/shared/sourcemicrosoftsharepointschemasstreamsfiletype.md rename to docs/models/sourcemicrosoftsharepointschemasstreamsfiletype.md diff --git a/docs/models/shared/sourcemicrosoftsharepointschemasstreamsformatfiletype.md b/docs/models/sourcemicrosoftsharepointschemasstreamsformatfiletype.md similarity index 100% rename from docs/models/shared/sourcemicrosoftsharepointschemasstreamsformatfiletype.md rename to docs/models/sourcemicrosoftsharepointschemasstreamsformatfiletype.md diff --git a/docs/models/shared/sourcemicrosoftsharepointschemasstreamsformatformatfiletype.md b/docs/models/sourcemicrosoftsharepointschemasstreamsformatformatfiletype.md similarity index 100% rename from docs/models/shared/sourcemicrosoftsharepointschemasstreamsformatformatfiletype.md rename to docs/models/sourcemicrosoftsharepointschemasstreamsformatformatfiletype.md diff --git a/docs/models/shared/sourcemicrosoftsharepointschemasstreamsheaderdefinitiontype.md b/docs/models/sourcemicrosoftsharepointschemasstreamsheaderdefinitiontype.md similarity index 100% rename from docs/models/shared/sourcemicrosoftsharepointschemasstreamsheaderdefinitiontype.md rename to docs/models/sourcemicrosoftsharepointschemasstreamsheaderdefinitiontype.md diff --git a/docs/models/sourcemicrosoftsharepointsearchscope.md b/docs/models/sourcemicrosoftsharepointsearchscope.md new file mode 100644 index 00000000..f91017d5 --- /dev/null +++ b/docs/models/sourcemicrosoftsharepointsearchscope.md @@ -0,0 +1,12 @@ +# SourceMicrosoftSharepointSearchScope + +Specifies the location(s) to search for files. Valid options are 'ACCESSIBLE_DRIVES' for all SharePoint drives the user can access, 'SHARED_ITEMS' for shared items the user has access to, and 'ALL' to search both. + + +## Values + +| Name | Value | +| ------------------- | ------------------- | +| `ACCESSIBLE_DRIVES` | ACCESSIBLE_DRIVES | +| `SHARED_ITEMS` | SHARED_ITEMS | +| `ALL` | ALL | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftsharepointservicekeyauthentication.md b/docs/models/sourcemicrosoftsharepointservicekeyauthentication.md new file mode 100644 index 00000000..f7f72929 --- /dev/null +++ b/docs/models/sourcemicrosoftsharepointservicekeyauthentication.md @@ -0,0 +1,15 @@ +# SourceMicrosoftSharepointServiceKeyAuthentication + +ServiceCredentials class for service key authentication. +This class is structured similarly to OAuthCredentials but for a different authentication method. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `client_id` | *str* | :heavy_check_mark: | Client ID of your Microsoft developer application | +| `client_secret` | *str* | :heavy_check_mark: | Client Secret of your Microsoft developer application | +| `tenant_id` | *str* | :heavy_check_mark: | Tenant ID of the Microsoft SharePoint user | +| `user_principal_name` | *str* | :heavy_check_mark: | Special characters such as a period, comma, space, and the at sign (@) are converted to underscores (_). More details: https://learn.microsoft.com/en-us/sharepoint/list-onedrive-urls | +| `auth_type` | [Optional[models.SourceMicrosoftSharepointSchemasAuthType]](../models/sourcemicrosoftsharepointschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftsharepointuserprovided.md b/docs/models/sourcemicrosoftsharepointuserprovided.md new file mode 100644 index 00000000..9dc6ce82 --- /dev/null +++ b/docs/models/sourcemicrosoftsharepointuserprovided.md @@ -0,0 +1,9 @@ +# SourceMicrosoftSharepointUserProvided + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `column_names` | List[*str*] | :heavy_check_mark: | The column names that will be used while emitting the CSV records | +| `header_definition_type` | [Optional[models.SourceMicrosoftSharepointSchemasStreamsHeaderDefinitionType]](../models/sourcemicrosoftsharepointschemasstreamsheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcemicrosoftsharepointvalidationpolicy.md b/docs/models/sourcemicrosoftsharepointvalidationpolicy.md similarity index 100% rename from docs/models/shared/sourcemicrosoftsharepointvalidationpolicy.md rename to docs/models/sourcemicrosoftsharepointvalidationpolicy.md diff --git a/docs/models/sourcemicrosoftteams.md b/docs/models/sourcemicrosoftteams.md new file mode 100644 index 00000000..2945e077 --- /dev/null +++ b/docs/models/sourcemicrosoftteams.md @@ -0,0 +1,10 @@ +# SourceMicrosoftTeams + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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[models.AuthenticateViaMicrosoftOAuth20, models.AuthenticateViaMicrosoft]]](../models/sourcemicrosoftteamsauthenticationmechanism.md) | :heavy_minus_sign: | Choose how to authenticate to Microsoft | | +| `source_type` | [models.SourceMicrosoftTeamsMicrosoftTeams](../models/sourcemicrosoftteamsmicrosoftteams.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/sourcemicrosoftteamsauthenticationmechanism.md b/docs/models/sourcemicrosoftteamsauthenticationmechanism.md new file mode 100644 index 00000000..f020e44e --- /dev/null +++ b/docs/models/sourcemicrosoftteamsauthenticationmechanism.md @@ -0,0 +1,19 @@ +# SourceMicrosoftTeamsAuthenticationMechanism + +Choose how to authenticate to Microsoft + + +## Supported Types + +### AuthenticateViaMicrosoftOAuth20 + +```python +sourceMicrosoftTeamsAuthenticationMechanism: models.AuthenticateViaMicrosoftOAuth20 = /* values here */ +``` + +### AuthenticateViaMicrosoft + +```python +sourceMicrosoftTeamsAuthenticationMechanism: models.AuthenticateViaMicrosoft = /* values here */ +``` + diff --git a/docs/models/shared/sourcemicrosoftteamsauthtype.md b/docs/models/sourcemicrosoftteamsauthtype.md similarity index 100% rename from docs/models/shared/sourcemicrosoftteamsauthtype.md rename to docs/models/sourcemicrosoftteamsauthtype.md diff --git a/docs/models/shared/sourcemicrosoftteamsmicrosoftteams.md b/docs/models/sourcemicrosoftteamsmicrosoftteams.md similarity index 100% rename from docs/models/shared/sourcemicrosoftteamsmicrosoftteams.md rename to docs/models/sourcemicrosoftteamsmicrosoftteams.md diff --git a/docs/models/shared/sourcemicrosoftteamsschemasauthtype.md b/docs/models/sourcemicrosoftteamsschemasauthtype.md similarity index 100% rename from docs/models/shared/sourcemicrosoftteamsschemasauthtype.md rename to docs/models/sourcemicrosoftteamsschemasauthtype.md diff --git a/docs/models/shared/sourcemixpanel.md b/docs/models/sourcemixpanel.md similarity index 97% rename from docs/models/shared/sourcemixpanel.md rename to docs/models/sourcemixpanel.md index 59f21672..f7488e98 100644 --- a/docs/models/shared/sourcemixpanel.md +++ b/docs/models/sourcemixpanel.md @@ -5,12 +5,12 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `credentials` | [Union[shared.ServiceAccount, shared.ProjectSecret]](../../models/shared/authenticationwildcard.md) | :heavy_check_mark: | Choose how to authenticate to Mixpanel | | +| `credentials` | [Union[models.ServiceAccount, models.ProjectSecret]](../models/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 | -| `region` | [Optional[shared.SourceMixpanelRegion]](../../models/shared/sourcemixpanelregion.md) | :heavy_minus_sign: | The region of mixpanel domain instance either US or EU. | | +| `region` | [Optional[models.SourceMixpanelRegion]](../models/sourcemixpanelregion.md) | :heavy_minus_sign: | The region of mixpanel domain instance either US or EU. | | | `select_properties_by_default` | *Optional[bool]* | :heavy_minus_sign: | 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` | [shared.Mixpanel](../../models/shared/mixpanel.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.Mixpanel](../models/mixpanel.md) | :heavy_check_mark: | N/A | | | `start_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 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. | 2021-11-16 | \ No newline at end of file diff --git a/docs/models/shared/sourcemixpaneloptiontitle.md b/docs/models/sourcemixpaneloptiontitle.md similarity index 100% rename from docs/models/shared/sourcemixpaneloptiontitle.md rename to docs/models/sourcemixpaneloptiontitle.md diff --git a/docs/models/shared/sourcemixpanelregion.md b/docs/models/sourcemixpanelregion.md similarity index 100% rename from docs/models/shared/sourcemixpanelregion.md rename to docs/models/sourcemixpanelregion.md diff --git a/docs/models/shared/sourcemixpanelschemasoptiontitle.md b/docs/models/sourcemixpanelschemasoptiontitle.md similarity index 100% rename from docs/models/shared/sourcemixpanelschemasoptiontitle.md rename to docs/models/sourcemixpanelschemasoptiontitle.md diff --git a/docs/models/sourcemonday.md b/docs/models/sourcemonday.md new file mode 100644 index 00000000..8a385e3d --- /dev/null +++ b/docs/models/sourcemonday.md @@ -0,0 +1,9 @@ +# SourceMonday + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `credentials` | [Optional[Union[models.SourceMondayOAuth20, models.APIToken]]](../models/sourcemondayauthorizationmethod.md) | :heavy_minus_sign: | N/A | +| `source_type` | [models.SourceMondayMonday](../models/sourcemondaymonday.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcemondayauthorizationmethod.md b/docs/models/sourcemondayauthorizationmethod.md new file mode 100644 index 00000000..b66cfb9b --- /dev/null +++ b/docs/models/sourcemondayauthorizationmethod.md @@ -0,0 +1,17 @@ +# SourceMondayAuthorizationMethod + + +## Supported Types + +### SourceMondayOAuth20 + +```python +sourceMondayAuthorizationMethod: models.SourceMondayOAuth20 = /* values here */ +``` + +### APIToken + +```python +sourceMondayAuthorizationMethod: models.APIToken = /* values here */ +``` + diff --git a/docs/models/shared/sourcemondayauthtype.md b/docs/models/sourcemondayauthtype.md similarity index 100% rename from docs/models/shared/sourcemondayauthtype.md rename to docs/models/sourcemondayauthtype.md diff --git a/docs/models/shared/sourcemondaymonday.md b/docs/models/sourcemondaymonday.md similarity index 100% rename from docs/models/shared/sourcemondaymonday.md rename to docs/models/sourcemondaymonday.md diff --git a/docs/models/shared/sourcemondayoauth20.md b/docs/models/sourcemondayoauth20.md similarity index 95% rename from docs/models/shared/sourcemondayoauth20.md rename to docs/models/sourcemondayoauth20.md index 048731c1..769dff70 100644 --- a/docs/models/shared/sourcemondayoauth20.md +++ b/docs/models/sourcemondayoauth20.md @@ -8,5 +8,5 @@ | `access_token` | *str* | :heavy_check_mark: | Access Token for making authenticated requests. | | `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 | +| `auth_type` | [models.SourceMondayAuthType](../models/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/sourcemondayschemasauthtype.md b/docs/models/sourcemondayschemasauthtype.md similarity index 100% rename from docs/models/shared/sourcemondayschemasauthtype.md rename to docs/models/sourcemondayschemasauthtype.md diff --git a/docs/models/sourcemongodbinternalpoc.md b/docs/models/sourcemongodbinternalpoc.md new file mode 100644 index 00000000..e0e0f9df --- /dev/null +++ b/docs/models/sourcemongodbinternalpoc.md @@ -0,0 +1,13 @@ +# SourceMongodbInternalPoc + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `auth_source` | *Optional[str]* | :heavy_minus_sign: | The authentication source where the user information is stored. | admin | +| `connection_string` | *Optional[str]* | :heavy_minus_sign: | The connection string of the database that you want to replicate.. | mongodb+srv://example.mongodb.net | +| `password` | *Optional[str]* | :heavy_minus_sign: | The password associated with this username. | | +| `replica_set` | *Optional[str]* | :heavy_minus_sign: | The name of the replica set to be replicated. | | +| `source_type` | [models.MongodbInternalPoc](../models/mongodbinternalpoc.md) | :heavy_check_mark: | N/A | | +| `user` | *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/sourcemongodbv2.md b/docs/models/sourcemongodbv2.md new file mode 100644 index 00000000..1418e6a4 --- /dev/null +++ b/docs/models/sourcemongodbv2.md @@ -0,0 +1,13 @@ +# SourceMongodbV2 + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `database_config` | [Union[models.MongoDBAtlasReplicaSet, models.SelfManagedReplicaSet]](../models/clustertype.md) | :heavy_check_mark: | Configures the MongoDB cluster type. | +| `discover_sample_size` | *Optional[int]* | :heavy_minus_sign: | The maximum number of documents to sample when attempting to discover the unique fields for a collection. | +| `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. | +| `invalid_cdc_cursor_position_behavior` | [Optional[models.InvalidCDCPositionBehaviorAdvanced]](../models/invalidcdcpositionbehavioradvanced.md) | :heavy_minus_sign: | Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value into the WAL. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss. | +| `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. | +| `source_type` | [models.MongodbV2](../models/mongodbv2.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcemongodbv2clustertype.md b/docs/models/sourcemongodbv2clustertype.md similarity index 100% rename from docs/models/shared/sourcemongodbv2clustertype.md rename to docs/models/sourcemongodbv2clustertype.md diff --git a/docs/models/shared/sourcemongodbv2schemasclustertype.md b/docs/models/sourcemongodbv2schemasclustertype.md similarity index 100% rename from docs/models/shared/sourcemongodbv2schemasclustertype.md rename to docs/models/sourcemongodbv2schemasclustertype.md diff --git a/docs/models/shared/sourcemssql.md b/docs/models/sourcemssql.md similarity index 94% rename from docs/models/shared/sourcemssql.md rename to docs/models/sourcemssql.md index d9909877..a7c47d4b 100644 --- a/docs/models/shared/sourcemssql.md +++ b/docs/models/sourcemssql.md @@ -11,8 +11,8 @@ | `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. | | +| `replication_method` | [Optional[Union[models.ReadChangesUsingChangeDataCaptureCDC, models.ScanChangesWithUserDefinedCursor]]](../models/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. | | \ No newline at end of file +| `source_type` | [models.SourceMssqlMssql](../models/sourcemssqlmssql.md) | :heavy_check_mark: | N/A | | +| `ssl_method` | [Optional[Union[models.Unencrypted, models.SourceMssqlEncryptedTrustServerCertificate, models.SourceMssqlEncryptedVerifyCertificate]]](../models/sourcemssqlsslmethod.md) | :heavy_minus_sign: | The encryption method which is used when communicating with the database. | | +| `tunnel_method` | [Optional[Union[models.SourceMssqlNoTunnel, models.SourceMssqlSSHKeyAuthentication, models.SourceMssqlPasswordAuthentication]]](../models/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/sourcemssqlencryptedtrustservercertificate.md b/docs/models/sourcemssqlencryptedtrustservercertificate.md new file mode 100644 index 00000000..34cdf11a --- /dev/null +++ b/docs/models/sourcemssqlencryptedtrustservercertificate.md @@ -0,0 +1,10 @@ +# SourceMssqlEncryptedTrustServerCertificate + +Use the certificate provided by the server without verification. (For testing purposes only!) + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `ssl_method` | [models.SourceMssqlSchemasSslMethodSslMethod](../models/sourcemssqlschemassslmethodsslmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcemssqlencryptedverifycertificate.md b/docs/models/sourcemssqlencryptedverifycertificate.md new file mode 100644 index 00000000..72420250 --- /dev/null +++ b/docs/models/sourcemssqlencryptedverifycertificate.md @@ -0,0 +1,12 @@ +# SourceMssqlEncryptedVerifyCertificate + +Verify and use the certificate provided by the server. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `certificate` | *Optional[str]* | :heavy_minus_sign: | certificate of the server, or of the CA that signed the server certificate | +| `host_name_in_certificate` | *Optional[str]* | :heavy_minus_sign: | Specifies the host name of the server. The value of this property must match the subject property of the certificate. | +| `ssl_method` | [models.SourceMssqlSchemasSSLMethodSSLMethodSSLMethod](../models/sourcemssqlschemassslmethodsslmethodsslmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcemssqlinvalidcdcpositionbehavioradvanced.md b/docs/models/sourcemssqlinvalidcdcpositionbehavioradvanced.md new file mode 100644 index 00000000..2729c76e --- /dev/null +++ b/docs/models/sourcemssqlinvalidcdcpositionbehavioradvanced.md @@ -0,0 +1,11 @@ +# SourceMssqlInvalidCDCPositionBehaviorAdvanced + +Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value into the WAL. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss. + + +## Values + +| Name | Value | +| -------------- | -------------- | +| `FAIL_SYNC` | Fail sync | +| `RE_SYNC_DATA` | Re-sync data | \ No newline at end of file diff --git a/docs/models/shared/sourcemssqlmethod.md b/docs/models/sourcemssqlmethod.md similarity index 100% rename from docs/models/shared/sourcemssqlmethod.md rename to docs/models/sourcemssqlmethod.md diff --git a/docs/models/shared/sourcemssqlmssql.md b/docs/models/sourcemssqlmssql.md similarity index 100% rename from docs/models/shared/sourcemssqlmssql.md rename to docs/models/sourcemssqlmssql.md diff --git a/docs/models/sourcemssqlnotunnel.md b/docs/models/sourcemssqlnotunnel.md new file mode 100644 index 00000000..4ba8988d --- /dev/null +++ b/docs/models/sourcemssqlnotunnel.md @@ -0,0 +1,8 @@ +# SourceMssqlNoTunnel + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `tunnel_method` | [models.SourceMssqlTunnelMethod](../models/sourcemssqltunnelmethod.md) | :heavy_check_mark: | No ssh tunnel needed to connect to database | \ No newline at end of file diff --git a/docs/models/sourcemssqlpasswordauthentication.md b/docs/models/sourcemssqlpasswordauthentication.md new file mode 100644 index 00000000..45b63920 --- /dev/null +++ b/docs/models/sourcemssqlpasswordauthentication.md @@ -0,0 +1,12 @@ +# SourceMssqlPasswordAuthentication + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `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_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | +| `tunnel_method` | [models.SourceMssqlSchemasTunnelMethodTunnelMethod](../models/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/sourcemssqlschemasmethod.md b/docs/models/sourcemssqlschemasmethod.md similarity index 100% rename from docs/models/shared/sourcemssqlschemasmethod.md rename to docs/models/sourcemssqlschemasmethod.md diff --git a/docs/models/shared/sourcemssqlschemassslmethod.md b/docs/models/sourcemssqlschemassslmethod.md similarity index 100% rename from docs/models/shared/sourcemssqlschemassslmethod.md rename to docs/models/sourcemssqlschemassslmethod.md diff --git a/docs/models/shared/sourcemssqlschemassslmethodsslmethod.md b/docs/models/sourcemssqlschemassslmethodsslmethod.md similarity index 100% rename from docs/models/shared/sourcemssqlschemassslmethodsslmethod.md rename to docs/models/sourcemssqlschemassslmethodsslmethod.md diff --git a/docs/models/shared/sourcemssqlschemassslmethodsslmethodsslmethod.md b/docs/models/sourcemssqlschemassslmethodsslmethodsslmethod.md similarity index 100% rename from docs/models/shared/sourcemssqlschemassslmethodsslmethodsslmethod.md rename to docs/models/sourcemssqlschemassslmethodsslmethodsslmethod.md diff --git a/docs/models/shared/sourcemssqlschemastunnelmethod.md b/docs/models/sourcemssqlschemastunnelmethod.md similarity index 100% rename from docs/models/shared/sourcemssqlschemastunnelmethod.md rename to docs/models/sourcemssqlschemastunnelmethod.md diff --git a/docs/models/shared/sourcemssqlschemastunnelmethodtunnelmethod.md b/docs/models/sourcemssqlschemastunnelmethodtunnelmethod.md similarity index 100% rename from docs/models/shared/sourcemssqlschemastunnelmethodtunnelmethod.md rename to docs/models/sourcemssqlschemastunnelmethodtunnelmethod.md diff --git a/docs/models/shared/sourcemssqlsshkeyauthentication.md b/docs/models/sourcemssqlsshkeyauthentication.md similarity index 95% rename from docs/models/shared/sourcemssqlsshkeyauthentication.md rename to docs/models/sourcemssqlsshkeyauthentication.md index 1415d257..38f4fab8 100644 --- a/docs/models/shared/sourcemssqlsshkeyauthentication.md +++ b/docs/models/sourcemssqlsshkeyauthentication.md @@ -8,5 +8,5 @@ | `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_method` | [models.SourceMssqlSchemasTunnelMethod](../models/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 | \ No newline at end of file diff --git a/docs/models/sourcemssqlsshtunnelmethod.md b/docs/models/sourcemssqlsshtunnelmethod.md new file mode 100644 index 00000000..6561e20e --- /dev/null +++ b/docs/models/sourcemssqlsshtunnelmethod.md @@ -0,0 +1,25 @@ +# SourceMssqlSSHTunnelMethod + +Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. + + +## Supported Types + +### SourceMssqlNoTunnel + +```python +sourceMssqlSSHTunnelMethod: models.SourceMssqlNoTunnel = /* values here */ +``` + +### SourceMssqlSSHKeyAuthentication + +```python +sourceMssqlSSHTunnelMethod: models.SourceMssqlSSHKeyAuthentication = /* values here */ +``` + +### SourceMssqlPasswordAuthentication + +```python +sourceMssqlSSHTunnelMethod: models.SourceMssqlPasswordAuthentication = /* values here */ +``` + diff --git a/docs/models/sourcemssqlsslmethod.md b/docs/models/sourcemssqlsslmethod.md new file mode 100644 index 00000000..aeda2ded --- /dev/null +++ b/docs/models/sourcemssqlsslmethod.md @@ -0,0 +1,25 @@ +# SourceMssqlSSLMethod + +The encryption method which is used when communicating with the database. + + +## Supported Types + +### Unencrypted + +```python +sourceMssqlSSLMethod: models.Unencrypted = /* values here */ +``` + +### SourceMssqlEncryptedTrustServerCertificate + +```python +sourceMssqlSSLMethod: models.SourceMssqlEncryptedTrustServerCertificate = /* values here */ +``` + +### SourceMssqlEncryptedVerifyCertificate + +```python +sourceMssqlSSLMethod: models.SourceMssqlEncryptedVerifyCertificate = /* values here */ +``` + diff --git a/docs/models/shared/sourcemssqltunnelmethod.md b/docs/models/sourcemssqltunnelmethod.md similarity index 100% rename from docs/models/shared/sourcemssqltunnelmethod.md rename to docs/models/sourcemssqltunnelmethod.md diff --git a/docs/models/shared/sourcemyhours.md b/docs/models/sourcemyhours.md similarity index 92% rename from docs/models/shared/sourcemyhours.md rename to docs/models/sourcemyhours.md index c4675fab..c12e6818 100644 --- a/docs/models/shared/sourcemyhours.md +++ b/docs/models/sourcemyhours.md @@ -9,4 +9,4 @@ | `password` | *str* | :heavy_check_mark: | The password associated to the username | | | `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 +| `source_type` | [models.MyHours](../models/myhours.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcemysql.md b/docs/models/sourcemysql.md similarity index 96% rename from docs/models/shared/sourcemysql.md rename to docs/models/sourcemysql.md index a88bf7f1..65887e35 100644 --- a/docs/models/shared/sourcemysql.md +++ b/docs/models/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. | | +| `replication_method` | [Union[models.ReadChangesUsingBinaryLogCDC, models.SourceMysqlScanChangesWithUserDefinedCursor]](../models/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 | -| `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. | | \ No newline at end of file +| `source_type` | [models.SourceMysqlMysql](../models/sourcemysqlmysql.md) | :heavy_check_mark: | N/A | | +| `ssl_mode` | [Optional[Union[models.Preferred, models.Required, models.SourceMysqlVerifyCA, models.VerifyIdentity]]](../models/sourcemysqlsslmodes.md) | :heavy_minus_sign: | SSL connection modes. Read more in the docs. | | +| `tunnel_method` | [Optional[Union[models.SourceMysqlNoTunnel, models.SourceMysqlSSHKeyAuthentication, models.SourceMysqlPasswordAuthentication]]](../models/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/sourcemysqlinvalidcdcpositionbehavioradvanced.md b/docs/models/sourcemysqlinvalidcdcpositionbehavioradvanced.md new file mode 100644 index 00000000..5baf754b --- /dev/null +++ b/docs/models/sourcemysqlinvalidcdcpositionbehavioradvanced.md @@ -0,0 +1,11 @@ +# SourceMysqlInvalidCDCPositionBehaviorAdvanced + +Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value into the WAL. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss. + + +## Values + +| Name | Value | +| -------------- | -------------- | +| `FAIL_SYNC` | Fail sync | +| `RE_SYNC_DATA` | Re-sync data | \ No newline at end of file diff --git a/docs/models/shared/sourcemysqlmethod.md b/docs/models/sourcemysqlmethod.md similarity index 100% rename from docs/models/shared/sourcemysqlmethod.md rename to docs/models/sourcemysqlmethod.md diff --git a/docs/models/shared/sourcemysqlmode.md b/docs/models/sourcemysqlmode.md similarity index 100% rename from docs/models/shared/sourcemysqlmode.md rename to docs/models/sourcemysqlmode.md diff --git a/docs/models/shared/sourcemysqlmysql.md b/docs/models/sourcemysqlmysql.md similarity index 100% rename from docs/models/shared/sourcemysqlmysql.md rename to docs/models/sourcemysqlmysql.md diff --git a/docs/models/sourcemysqlnotunnel.md b/docs/models/sourcemysqlnotunnel.md new file mode 100644 index 00000000..24380a31 --- /dev/null +++ b/docs/models/sourcemysqlnotunnel.md @@ -0,0 +1,8 @@ +# SourceMysqlNoTunnel + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `tunnel_method` | [models.SourceMysqlTunnelMethod](../models/sourcemysqltunnelmethod.md) | :heavy_check_mark: | No ssh tunnel needed to connect to database | \ No newline at end of file diff --git a/docs/models/sourcemysqlpasswordauthentication.md b/docs/models/sourcemysqlpasswordauthentication.md new file mode 100644 index 00000000..183ab030 --- /dev/null +++ b/docs/models/sourcemysqlpasswordauthentication.md @@ -0,0 +1,12 @@ +# SourceMysqlPasswordAuthentication + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `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_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | +| `tunnel_method` | [models.SourceMysqlSchemasTunnelMethodTunnelMethod](../models/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/sourcemysqlscanchangeswithuserdefinedcursor.md b/docs/models/sourcemysqlscanchangeswithuserdefinedcursor.md new file mode 100644 index 00000000..13daa05f --- /dev/null +++ b/docs/models/sourcemysqlscanchangeswithuserdefinedcursor.md @@ -0,0 +1,10 @@ +# SourceMysqlScanChangesWithUserDefinedCursor + +Incrementally detects new inserts and updates using the cursor column chosen when configuring a connection (e.g. created_at, updated_at). + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `method` | [models.SourceMysqlSchemasMethod](../models/sourcemysqlschemasmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcemysqlschemasmethod.md b/docs/models/sourcemysqlschemasmethod.md similarity index 100% rename from docs/models/shared/sourcemysqlschemasmethod.md rename to docs/models/sourcemysqlschemasmethod.md diff --git a/docs/models/shared/sourcemysqlschemasmode.md b/docs/models/sourcemysqlschemasmode.md similarity index 100% rename from docs/models/shared/sourcemysqlschemasmode.md rename to docs/models/sourcemysqlschemasmode.md diff --git a/docs/models/shared/sourcemysqlschemassslmodemode.md b/docs/models/sourcemysqlschemassslmodemode.md similarity index 100% rename from docs/models/shared/sourcemysqlschemassslmodemode.md rename to docs/models/sourcemysqlschemassslmodemode.md diff --git a/docs/models/shared/sourcemysqlschemassslmodesslmodesmode.md b/docs/models/sourcemysqlschemassslmodesslmodesmode.md similarity index 100% rename from docs/models/shared/sourcemysqlschemassslmodesslmodesmode.md rename to docs/models/sourcemysqlschemassslmodesslmodesmode.md diff --git a/docs/models/shared/sourcemysqlschemastunnelmethod.md b/docs/models/sourcemysqlschemastunnelmethod.md similarity index 100% rename from docs/models/shared/sourcemysqlschemastunnelmethod.md rename to docs/models/sourcemysqlschemastunnelmethod.md diff --git a/docs/models/shared/sourcemysqlschemastunnelmethodtunnelmethod.md b/docs/models/sourcemysqlschemastunnelmethodtunnelmethod.md similarity index 100% rename from docs/models/shared/sourcemysqlschemastunnelmethodtunnelmethod.md rename to docs/models/sourcemysqlschemastunnelmethodtunnelmethod.md diff --git a/docs/models/shared/sourcemysqlsshkeyauthentication.md b/docs/models/sourcemysqlsshkeyauthentication.md similarity index 95% rename from docs/models/shared/sourcemysqlsshkeyauthentication.md rename to docs/models/sourcemysqlsshkeyauthentication.md index 9923c40a..47461e75 100644 --- a/docs/models/shared/sourcemysqlsshkeyauthentication.md +++ b/docs/models/sourcemysqlsshkeyauthentication.md @@ -8,5 +8,5 @@ | `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_method` | [models.SourceMysqlSchemasTunnelMethod](../models/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 | \ No newline at end of file diff --git a/docs/models/sourcemysqlsshtunnelmethod.md b/docs/models/sourcemysqlsshtunnelmethod.md new file mode 100644 index 00000000..587935db --- /dev/null +++ b/docs/models/sourcemysqlsshtunnelmethod.md @@ -0,0 +1,25 @@ +# SourceMysqlSSHTunnelMethod + +Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. + + +## Supported Types + +### SourceMysqlNoTunnel + +```python +sourceMysqlSSHTunnelMethod: models.SourceMysqlNoTunnel = /* values here */ +``` + +### SourceMysqlSSHKeyAuthentication + +```python +sourceMysqlSSHTunnelMethod: models.SourceMysqlSSHKeyAuthentication = /* values here */ +``` + +### SourceMysqlPasswordAuthentication + +```python +sourceMysqlSSHTunnelMethod: models.SourceMysqlPasswordAuthentication = /* values here */ +``` + diff --git a/docs/models/sourcemysqlsslmodes.md b/docs/models/sourcemysqlsslmodes.md new file mode 100644 index 00000000..c88d85f4 --- /dev/null +++ b/docs/models/sourcemysqlsslmodes.md @@ -0,0 +1,31 @@ +# SourceMysqlSSLModes + +SSL connection modes. Read more in the docs. + + +## Supported Types + +### Preferred + +```python +sourceMysqlSSLModes: models.Preferred = /* values here */ +``` + +### Required + +```python +sourceMysqlSSLModes: models.Required = /* values here */ +``` + +### SourceMysqlVerifyCA + +```python +sourceMysqlSSLModes: models.SourceMysqlVerifyCA = /* values here */ +``` + +### VerifyIdentity + +```python +sourceMysqlSSLModes: models.VerifyIdentity = /* values here */ +``` + diff --git a/docs/models/shared/sourcemysqltunnelmethod.md b/docs/models/sourcemysqltunnelmethod.md similarity index 100% rename from docs/models/shared/sourcemysqltunnelmethod.md rename to docs/models/sourcemysqltunnelmethod.md diff --git a/docs/models/sourcemysqlupdatemethod.md b/docs/models/sourcemysqlupdatemethod.md new file mode 100644 index 00000000..7f522138 --- /dev/null +++ b/docs/models/sourcemysqlupdatemethod.md @@ -0,0 +1,19 @@ +# SourceMysqlUpdateMethod + +Configures how data is extracted from the database. + + +## Supported Types + +### ReadChangesUsingBinaryLogCDC + +```python +sourceMysqlUpdateMethod: models.ReadChangesUsingBinaryLogCDC = /* values here */ +``` + +### SourceMysqlScanChangesWithUserDefinedCursor + +```python +sourceMysqlUpdateMethod: models.SourceMysqlScanChangesWithUserDefinedCursor = /* values here */ +``` + diff --git a/docs/models/shared/sourcemysqlverifyca.md b/docs/models/sourcemysqlverifyca.md similarity index 96% rename from docs/models/shared/sourcemysqlverifyca.md rename to docs/models/sourcemysqlverifyca.md index 0811acdc..a521c2ff 100644 --- a/docs/models/shared/sourcemysqlverifyca.md +++ b/docs/models/sourcemysqlverifyca.md @@ -11,4 +11,4 @@ Always connect with SSL. Verifies CA, but allows connection even if Hostname doe | `client_certificate` | *Optional[str]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | Password for keystorage. This field is optional. If you do not add it - the password will be generated automatically. | -| `mode` | [shared.SourceMysqlSchemasSslModeMode](../../models/shared/sourcemysqlschemassslmodemode.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `mode` | [models.SourceMysqlSchemasSslModeMode](../models/sourcemysqlschemassslmodemode.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcenetsuite.md b/docs/models/sourcenetsuite.md similarity index 98% rename from docs/models/shared/sourcenetsuite.md rename to docs/models/sourcenetsuite.md index f324f262..3d21d492 100644 --- a/docs/models/shared/sourcenetsuite.md +++ b/docs/models/sourcenetsuite.md @@ -12,5 +12,5 @@ | `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 | | +| `source_type` | [models.Netsuite](../models/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/sourcenotion.md b/docs/models/sourcenotion.md similarity index 94% rename from docs/models/shared/sourcenotion.md rename to docs/models/sourcenotion.md index 9ffe0b5e..0b478f59 100644 --- a/docs/models/shared/sourcenotion.md +++ b/docs/models/sourcenotion.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `credentials` | [Union[shared.SourceNotionOAuth20, shared.SourceNotionAccessToken]](../../models/shared/sourcenotionauthenticationmethod.md) | :heavy_check_mark: | Choose either OAuth (recommended for Airbyte Cloud) or Access Token. See our docs for more information. | | -| `source_type` | [shared.SourceNotionNotion](../../models/shared/sourcenotionnotion.md) | :heavy_check_mark: | N/A | | +| `credentials` | [Union[models.SourceNotionOAuth20, models.SourceNotionAccessToken]](../models/sourcenotionauthenticationmethod.md) | :heavy_check_mark: | Choose either OAuth (recommended for Airbyte Cloud) or Access Token. See our docs for more information. | | +| `source_type` | [models.SourceNotionNotion](../models/sourcenotionnotion.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 YYYY-MM-DDTHH:MM:SS.000Z. During incremental sync, any data generated before this date will not be replicated. If left blank, the start date will be set to 2 years before the present date. | 2020-11-16T00:00:00.000Z | \ No newline at end of file diff --git a/docs/models/shared/sourcenotionaccesstoken.md b/docs/models/sourcenotionaccesstoken.md similarity index 96% rename from docs/models/shared/sourcenotionaccesstoken.md rename to docs/models/sourcenotionaccesstoken.md index b0bfa153..12fcd275 100644 --- a/docs/models/shared/sourcenotionaccesstoken.md +++ b/docs/models/sourcenotionaccesstoken.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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 +| `auth_type` | [models.SourceNotionSchemasAuthType](../models/sourcenotionschemasauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcenotionauthenticationmethod.md b/docs/models/sourcenotionauthenticationmethod.md new file mode 100644 index 00000000..497e601c --- /dev/null +++ b/docs/models/sourcenotionauthenticationmethod.md @@ -0,0 +1,19 @@ +# SourceNotionAuthenticationMethod + +Choose either OAuth (recommended for Airbyte Cloud) or Access Token. See our docs for more information. + + +## Supported Types + +### SourceNotionOAuth20 + +```python +sourceNotionAuthenticationMethod: models.SourceNotionOAuth20 = /* values here */ +``` + +### SourceNotionAccessToken + +```python +sourceNotionAuthenticationMethod: models.SourceNotionAccessToken = /* values here */ +``` + diff --git a/docs/models/shared/sourcenotionauthtype.md b/docs/models/sourcenotionauthtype.md similarity index 100% rename from docs/models/shared/sourcenotionauthtype.md rename to docs/models/sourcenotionauthtype.md diff --git a/docs/models/shared/sourcenotionnotion.md b/docs/models/sourcenotionnotion.md similarity index 100% rename from docs/models/shared/sourcenotionnotion.md rename to docs/models/sourcenotionnotion.md diff --git a/docs/models/shared/sourcenotionoauth20.md b/docs/models/sourcenotionoauth20.md similarity index 96% rename from docs/models/shared/sourcenotionoauth20.md rename to docs/models/sourcenotionoauth20.md index bdacef95..43cb4908 100644 --- a/docs/models/shared/sourcenotionoauth20.md +++ b/docs/models/sourcenotionoauth20.md @@ -8,4 +8,4 @@ | `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. | | `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. | -| `auth_type` | [shared.SourceNotionAuthType](../../models/shared/sourcenotionauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `auth_type` | [models.SourceNotionAuthType](../models/sourcenotionauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcenotionschemasauthtype.md b/docs/models/sourcenotionschemasauthtype.md similarity index 100% rename from docs/models/shared/sourcenotionschemasauthtype.md rename to docs/models/sourcenotionschemasauthtype.md diff --git a/docs/models/sourcenytimes.md b/docs/models/sourcenytimes.md new file mode 100644 index 00000000..aa8658b6 --- /dev/null +++ b/docs/models/sourcenytimes.md @@ -0,0 +1,13 @@ +# SourceNytimes + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `api_key` | *str* | :heavy_check_mark: | API Key | | +| `period` | [models.PeriodUsedForMostPopularStreams](../models/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[models.ShareTypeUsedForMostPopularSharedStream]](../models/sharetypeusedformostpopularsharedstream.md) | :heavy_minus_sign: | Share Type | | +| `source_type` | [models.Nytimes](../models/nytimes.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceokta.md b/docs/models/sourceokta.md similarity index 93% rename from docs/models/shared/sourceokta.md rename to docs/models/sourceokta.md index 8be5c677..416bc67f 100644 --- a/docs/models/shared/sourceokta.md +++ b/docs/models/sourceokta.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `credentials` | [Optional[Union[shared.SourceOktaOAuth20, shared.SourceOktaAPIToken]]](../../models/shared/sourceoktaauthorizationmethod.md) | :heavy_minus_sign: | N/A | | +| `credentials` | [Optional[Union[models.SourceOktaOAuth20, models.SourceOktaAPIToken]]](../models/sourceoktaauthorizationmethod.md) | :heavy_minus_sign: | N/A | | | `domain` | *Optional[str]* | :heavy_minus_sign: | The Okta domain. See the docs for instructions on how to find it. | | -| `source_type` | [shared.Okta](../../models/shared/okta.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.Okta](../models/okta.md) | :heavy_check_mark: | N/A | | | `start_date` | *Optional[str]* | :heavy_minus_sign: | UTC date and time in the format YYYY-MM-DDTHH:MM:SSZ. Any data before this date will not be replicated. | 2022-07-22T00:00:00Z | \ No newline at end of file diff --git a/docs/models/shared/sourceoktaapitoken.md b/docs/models/sourceoktaapitoken.md similarity index 94% rename from docs/models/shared/sourceoktaapitoken.md rename to docs/models/sourceoktaapitoken.md index f2f498dd..67591648 100644 --- a/docs/models/shared/sourceoktaapitoken.md +++ b/docs/models/sourceoktaapitoken.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | | `api_token` | *str* | :heavy_check_mark: | An Okta token. See the docs for instructions on how to generate it. | -| `auth_type` | [shared.SourceOktaSchemasAuthType](../../models/shared/sourceoktaschemasauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `auth_type` | [models.SourceOktaSchemasAuthType](../models/sourceoktaschemasauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourceoktaauthorizationmethod.md b/docs/models/sourceoktaauthorizationmethod.md new file mode 100644 index 00000000..14596b3d --- /dev/null +++ b/docs/models/sourceoktaauthorizationmethod.md @@ -0,0 +1,17 @@ +# SourceOktaAuthorizationMethod + + +## Supported Types + +### SourceOktaOAuth20 + +```python +sourceOktaAuthorizationMethod: models.SourceOktaOAuth20 = /* values here */ +``` + +### SourceOktaAPIToken + +```python +sourceOktaAuthorizationMethod: models.SourceOktaAPIToken = /* values here */ +``` + diff --git a/docs/models/shared/sourceoktaauthtype.md b/docs/models/sourceoktaauthtype.md similarity index 100% rename from docs/models/shared/sourceoktaauthtype.md rename to docs/models/sourceoktaauthtype.md diff --git a/docs/models/sourceoktaoauth20.md b/docs/models/sourceoktaoauth20.md new file mode 100644 index 00000000..888cfa47 --- /dev/null +++ b/docs/models/sourceoktaoauth20.md @@ -0,0 +1,11 @@ +# SourceOktaOAuth20 + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `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. | +| `auth_type` | [models.SourceOktaAuthType](../models/sourceoktaauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceoktaschemasauthtype.md b/docs/models/sourceoktaschemasauthtype.md similarity index 100% rename from docs/models/shared/sourceoktaschemasauthtype.md rename to docs/models/sourceoktaschemasauthtype.md diff --git a/docs/models/sourceomnisend.md b/docs/models/sourceomnisend.md new file mode 100644 index 00000000..7f49f5c6 --- /dev/null +++ b/docs/models/sourceomnisend.md @@ -0,0 +1,9 @@ +# SourceOmnisend + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| `api_key` | *str* | :heavy_check_mark: | API Key | +| `source_type` | [models.Omnisend](../models/omnisend.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceonesignal.md b/docs/models/sourceonesignal.md similarity index 97% rename from docs/models/shared/sourceonesignal.md rename to docs/models/sourceonesignal.md index b5b422e0..c11b58fd 100644 --- a/docs/models/shared/sourceonesignal.md +++ b/docs/models/sourceonesignal.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | | +| `applications` | List[[models.Applications](../models/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 | | `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. | | -| `source_type` | [shared.Onesignal](../../models/shared/onesignal.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `source_type` | [models.Onesignal](../models/onesignal.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceoracle.md b/docs/models/sourceoracle.md similarity index 94% rename from docs/models/shared/sourceoracle.md rename to docs/models/sourceoracle.md index 648a6d61..6ce1069c 100644 --- a/docs/models/shared/sourceoracle.md +++ b/docs/models/sourceoracle.md @@ -5,13 +5,13 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `encryption` | [Union[shared.NativeNetworkEncryptionNNE, shared.TLSEncryptedVerifyCertificate]](../../models/shared/encryption.md) | :heavy_check_mark: | The encryption method with is used when communicating with the database. | +| `encryption` | [Union[models.NativeNetworkEncryptionNNE, models.TLSEncryptedVerifyCertificate]](../models/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 | +| `connection_data` | [Optional[Union[models.ServiceName, models.SystemIDSID]]](../models/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. | \ No newline at end of file +| `source_type` | [models.SourceOracleOracle](../models/sourceoracleoracle.md) | :heavy_check_mark: | N/A | +| `tunnel_method` | [Optional[Union[models.SourceOracleNoTunnel, models.SourceOracleSSHKeyAuthentication, models.SourceOraclePasswordAuthentication]]](../models/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/sourceoracleconnectiontype.md b/docs/models/sourceoracleconnectiontype.md similarity index 100% rename from docs/models/shared/sourceoracleconnectiontype.md rename to docs/models/sourceoracleconnectiontype.md diff --git a/docs/models/shared/sourceoracleencryptionmethod.md b/docs/models/sourceoracleencryptionmethod.md similarity index 100% rename from docs/models/shared/sourceoracleencryptionmethod.md rename to docs/models/sourceoracleencryptionmethod.md diff --git a/docs/models/sourceoraclenotunnel.md b/docs/models/sourceoraclenotunnel.md new file mode 100644 index 00000000..16c4108e --- /dev/null +++ b/docs/models/sourceoraclenotunnel.md @@ -0,0 +1,8 @@ +# SourceOracleNoTunnel + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `tunnel_method` | [models.SourceOracleTunnelMethod](../models/sourceoracletunnelmethod.md) | :heavy_check_mark: | No ssh tunnel needed to connect to database | \ No newline at end of file diff --git a/docs/models/shared/sourceoracleoracle.md b/docs/models/sourceoracleoracle.md similarity index 100% rename from docs/models/shared/sourceoracleoracle.md rename to docs/models/sourceoracleoracle.md diff --git a/docs/models/sourceoraclepasswordauthentication.md b/docs/models/sourceoraclepasswordauthentication.md new file mode 100644 index 00000000..4e46fc55 --- /dev/null +++ b/docs/models/sourceoraclepasswordauthentication.md @@ -0,0 +1,12 @@ +# SourceOraclePasswordAuthentication + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `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_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | +| `tunnel_method` | [models.SourceOracleSchemasTunnelMethodTunnelMethod](../models/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/sourceoracleschemastunnelmethod.md b/docs/models/sourceoracleschemastunnelmethod.md similarity index 100% rename from docs/models/shared/sourceoracleschemastunnelmethod.md rename to docs/models/sourceoracleschemastunnelmethod.md diff --git a/docs/models/shared/sourceoracleschemastunnelmethodtunnelmethod.md b/docs/models/sourceoracleschemastunnelmethodtunnelmethod.md similarity index 100% rename from docs/models/shared/sourceoracleschemastunnelmethodtunnelmethod.md rename to docs/models/sourceoracleschemastunnelmethodtunnelmethod.md diff --git a/docs/models/shared/sourceoraclesshkeyauthentication.md b/docs/models/sourceoraclesshkeyauthentication.md similarity index 95% rename from docs/models/shared/sourceoraclesshkeyauthentication.md rename to docs/models/sourceoraclesshkeyauthentication.md index 9660ac72..a0ebcffb 100644 --- a/docs/models/shared/sourceoraclesshkeyauthentication.md +++ b/docs/models/sourceoraclesshkeyauthentication.md @@ -8,5 +8,5 @@ | `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_method` | [models.SourceOracleSchemasTunnelMethod](../models/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 | \ No newline at end of file diff --git a/docs/models/sourceoraclesshtunnelmethod.md b/docs/models/sourceoraclesshtunnelmethod.md new file mode 100644 index 00000000..a99c43e6 --- /dev/null +++ b/docs/models/sourceoraclesshtunnelmethod.md @@ -0,0 +1,25 @@ +# SourceOracleSSHTunnelMethod + +Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. + + +## Supported Types + +### SourceOracleNoTunnel + +```python +sourceOracleSSHTunnelMethod: models.SourceOracleNoTunnel = /* values here */ +``` + +### SourceOracleSSHKeyAuthentication + +```python +sourceOracleSSHTunnelMethod: models.SourceOracleSSHKeyAuthentication = /* values here */ +``` + +### SourceOraclePasswordAuthentication + +```python +sourceOracleSSHTunnelMethod: models.SourceOraclePasswordAuthentication = /* values here */ +``` + diff --git a/docs/models/shared/sourceoracletunnelmethod.md b/docs/models/sourceoracletunnelmethod.md similarity index 100% rename from docs/models/shared/sourceoracletunnelmethod.md rename to docs/models/sourceoracletunnelmethod.md diff --git a/docs/models/shared/sourceorb.md b/docs/models/sourceorb.md similarity index 90% rename from docs/models/shared/sourceorb.md rename to docs/models/sourceorb.md index 939adf14..68497e88 100644 --- a/docs/models/shared/sourceorb.md +++ b/docs/models/sourceorb.md @@ -7,9 +7,10 @@ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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 | +| `end_date` | *Optional[str]* | :heavy_minus_sign: | UTC date and time in the format 2022-03-01T00:00:00Z. Any data with created_at after this data will not be synced. For Subscription Usage, this becomes the `timeframe_start` API parameter. | 2024-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 | | +| `source_type` | [models.Orb](../models/orb.md) | :heavy_check_mark: | N/A | | | `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/sourceorbit.md similarity index 94% rename from docs/models/shared/sourceorbit.md rename to docs/models/sourceorbit.md index 9c1fab51..26c4d84f 100644 --- a/docs/models/shared/sourceorbit.md +++ b/docs/models/sourceorbit.md @@ -7,5 +7,5 @@ | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | | `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 | +| `source_type` | [models.Orbit](../models/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. | \ No newline at end of file diff --git a/docs/models/shared/sourceoutbrainamplify.md b/docs/models/sourceoutbrainamplify.md similarity index 89% rename from docs/models/shared/sourceoutbrainamplify.md rename to docs/models/sourceoutbrainamplify.md index 18aaf0e8..ae1a4520 100644 --- a/docs/models/shared/sourceoutbrainamplify.md +++ b/docs/models/sourceoutbrainamplify.md @@ -5,9 +5,9 @@ | 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. | +| `credentials` | [Union[models.SourceOutbrainAmplifyAccessToken, models.SourceOutbrainAmplifyUsernamePassword]](../models/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 | \ No newline at end of file +| `geo_location_breakdown` | [Optional[models.GranularityForGeoLocationRegion]](../models/granularityforgeolocationregion.md) | :heavy_minus_sign: | The granularity used for geo location data in reports. | +| `report_granularity` | [Optional[models.GranularityForPeriodicReports]](../models/granularityforperiodicreports.md) | :heavy_minus_sign: | The granularity used for periodic data in reports. See the docs. | +| `source_type` | [models.OutbrainAmplify](../models/outbrainamplify.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourceoutbrainamplifyaccesstoken.md b/docs/models/sourceoutbrainamplifyaccesstoken.md new file mode 100644 index 00000000..2a6acd80 --- /dev/null +++ b/docs/models/sourceoutbrainamplifyaccesstoken.md @@ -0,0 +1,9 @@ +# SourceOutbrainAmplifyAccessToken + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `access_token` | *str* | :heavy_check_mark: | Access Token for making authenticated requests. | +| `type` | [models.AccessTokenIsRequiredForAuthenticationRequests](../models/accesstokenisrequiredforauthenticationrequests.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourceoutbrainamplifyauthenticationmethod.md b/docs/models/sourceoutbrainamplifyauthenticationmethod.md new file mode 100644 index 00000000..2d0da0ed --- /dev/null +++ b/docs/models/sourceoutbrainamplifyauthenticationmethod.md @@ -0,0 +1,19 @@ +# SourceOutbrainAmplifyAuthenticationMethod + +Credentials for making authenticated requests requires either username/password or access_token. + + +## Supported Types + +### SourceOutbrainAmplifyAccessToken + +```python +sourceOutbrainAmplifyAuthenticationMethod: models.SourceOutbrainAmplifyAccessToken = /* values here */ +``` + +### SourceOutbrainAmplifyUsernamePassword + +```python +sourceOutbrainAmplifyAuthenticationMethod: models.SourceOutbrainAmplifyUsernamePassword = /* values here */ +``` + diff --git a/docs/models/sourceoutbrainamplifyusernamepassword.md b/docs/models/sourceoutbrainamplifyusernamepassword.md new file mode 100644 index 00000000..b15933bf --- /dev/null +++ b/docs/models/sourceoutbrainamplifyusernamepassword.md @@ -0,0 +1,10 @@ +# SourceOutbrainAmplifyUsernamePassword + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | +| `password` | *str* | :heavy_check_mark: | Add Password for authentication. | +| `username` | *str* | :heavy_check_mark: | Add Username for authentication. | +| `type` | [models.BothUsernameAndPasswordIsRequiredForAuthenticationRequest](../models/bothusernameandpasswordisrequiredforauthenticationrequest.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceoutreach.md b/docs/models/sourceoutreach.md similarity index 98% rename from docs/models/shared/sourceoutreach.md rename to docs/models/sourceoutreach.md index d90b2814..97a20934 100644 --- a/docs/models/shared/sourceoutreach.md +++ b/docs/models/sourceoutreach.md @@ -10,4 +10,4 @@ | `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. | | | `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 +| `source_type` | [models.Outreach](../models/outreach.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcepatchrequest.md b/docs/models/sourcepatchrequest.md similarity index 95% rename from docs/models/shared/sourcepatchrequest.md rename to docs/models/sourcepatchrequest.md index 5244405d..5b36b5db 100644 --- a/docs/models/shared/sourcepatchrequest.md +++ b/docs/models/sourcepatchrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `configuration` | [Optional[Union[shared.SourceAha, shared.SourceAircall, shared.SourceAirtable, 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.SourceGoogleAnalyticsV4ServiceAccountOnly, 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.SourceKyve, shared.SourceLaunchdarkly, shared.SourceLemlist, shared.SourceLeverHiring, shared.SourceLinkedinAds, shared.SourceLinkedinPages, shared.SourceLokalise, shared.SourceMailchimp, shared.SourceMailgun, shared.SourceMailjetSms, shared.SourceMarketo, shared.SourceMetabase, shared.SourceMicrosoftSharepoint, 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.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]]](../../models/shared/sourceconfiguration.md) | :heavy_minus_sign: | The values required to configure the source. | {
    "user": "charles"
    } | -| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | My source | -| `secret_id` | *Optional[str]* | :heavy_minus_sign: | Optional secretID obtained through the public API OAuth redirect flow. | | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `configuration` | [Optional[Union[models.SourceAha, models.SourceAircall, models.SourceAirtable, models.SourceAmazonAds, models.SourceAmazonSellerPartner, models.SourceAmazonSqs, models.SourceAmplitude, models.SourceApifyDataset, models.SourceAppfollow, models.SourceAsana, models.SourceAuth0, models.SourceAwsCloudtrail, models.SourceAzureBlobStorage, models.SourceAzureTable, models.SourceBambooHr, models.SourceBigquery, models.SourceBingAds, models.SourceBraintree, models.SourceBraze, models.SourceCart, models.SourceChargebee, models.SourceChartmogul, models.SourceClickhouse, models.SourceClickupAPI, models.SourceClockify, models.SourceCloseCom, models.SourceCoda, models.SourceCoinAPI, models.SourceCoinmarketcap, models.SourceConfigcat, models.SourceConfluence, models.SourceConvex, models.SourceDatascope, models.SourceDelighted, models.SourceDixa, models.SourceDockerhub, models.SourceDremio, models.SourceDynamodb, Union[models.ContinuousFeed], models.SourceEmailoctopus, models.SourceExchangeRates, models.SourceFacebookMarketing, models.SourceFaker, models.SourceFauna, models.SourceFile, models.SourceFirebolt, models.SourceFreshcaller, models.SourceFreshdesk, models.SourceFreshsales, models.SourceGainsightPx, models.SourceGcs, models.SourceGetlago, models.SourceGithub, models.SourceGitlab, models.SourceGlassfrog, models.SourceGnews, models.SourceGoogleAds, models.SourceGoogleAnalyticsDataAPI, models.SourceGoogleAnalyticsV4ServiceAccountOnly, models.SourceGoogleDirectory, models.SourceGoogleDrive, models.SourceGooglePagespeedInsights, models.SourceGoogleSearchConsole, models.SourceGoogleSheets, models.SourceGoogleWebfonts, models.SourceGreenhouse, models.SourceGridly, models.SourceHarvest, models.SourceHubplanner, models.SourceHubspot, models.SourceInsightly, models.SourceInstagram, models.SourceInstatus, models.SourceIntercom, models.SourceIp2whois, models.SourceIterable, models.SourceJira, models.SourceK6Cloud, models.SourceKlarna, models.SourceKlaviyo, models.SourceKyve, models.SourceLaunchdarkly, models.SourceLemlist, models.SourceLeverHiring, models.SourceLinkedinAds, models.SourceLinkedinPages, models.SourceLinnworks, models.SourceLokalise, models.SourceMailchimp, models.SourceMailgun, models.SourceMailjetSms, models.SourceMarketo, models.SourceMetabase, models.SourceMicrosoftOnedrive, models.SourceMicrosoftSharepoint, models.SourceMicrosoftTeams, models.SourceMixpanel, models.SourceMonday, models.SourceMongodbInternalPoc, models.SourceMongodbV2, models.SourceMssql, models.SourceMyHours, models.SourceMysql, models.SourceNetsuite, models.SourceNotion, models.SourceNytimes, models.SourceOkta, models.SourceOmnisend, models.SourceOnesignal, models.SourceOracle, models.SourceOrb, models.SourceOrbit, models.SourceOutbrainAmplify, models.SourceOutreach, models.SourcePaypalTransaction, models.SourcePaystack, models.SourcePendo, models.SourcePersistiq, models.SourcePexelsAPI, models.SourcePinterest, models.SourcePipedrive, models.SourcePocket, models.SourcePokeapi, models.SourcePolygonStockAPI, models.SourcePostgres, models.SourcePosthog, models.SourcePostmarkapp, models.SourcePrestashop, models.SourcePunkAPI, models.SourcePypi, models.SourceQualaroo, models.SourceQuickbooks, models.SourceRailz, models.SourceRecharge, models.SourceRecreation, models.SourceRecruitee, models.SourceRecurly, models.SourceRedshift, models.SourceRetently, models.SourceRkiCovid, models.SourceRss, models.SourceS3, models.SourceSalesforce, models.SourceSalesloft, models.SourceSapFieldglass, models.SourceSecoda, models.SourceSendgrid, models.SourceSendinblue, models.SourceSenseforce, models.SourceSentry, models.SourceSftp, models.SourceSftpBulk, models.SourceShopify, models.SourceShortio, models.SourceSlack, models.SourceSmaily, models.SourceSmartengage, models.SourceSmartsheets, models.SourceSnapchatMarketing, models.SourceSnowflake, models.SourceSonarCloud, models.SourceSpacexAPI, models.SourceSquare, models.SourceStrava, models.SourceStripe, models.SourceSurveySparrow, models.SourceSurveymonkey, models.SourceTempo, models.SourceTheGuardianAPI, models.SourceTiktokMarketing, models.SourceTrello, models.SourceTrustpilot, models.SourceTvmazeSchedule, models.SourceTwilio, models.SourceTwilioTaskrouter, models.SourceTwitter, models.SourceTypeform, models.SourceUsCensus, models.SourceVantage, models.SourceWebflow, models.SourceWhiskyHunter, models.SourceWikipediaPageviews, models.SourceWoocommerce, models.SourceXkcd, models.SourceYandexMetrica, models.SourceYotpo, models.SourceYoutubeAnalytics, models.SourceZendeskChat, models.SourceZendeskSell, models.SourceZendeskSunshine, models.SourceZendeskSupport, models.SourceZendeskTalk, models.SourceZenloop, models.SourceZohoCrm, models.SourceZoom]]](../models/sourceconfiguration.md) | :heavy_minus_sign: | The values required to configure the source. | {
    "user": "charles"
    } | +| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | My source | +| `secret_id` | *Optional[str]* | :heavy_minus_sign: | Optional secretID obtained through the public API OAuth redirect flow. | | +| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sourcepaypaltransaction.md b/docs/models/sourcepaypaltransaction.md new file mode 100644 index 00000000..05870c30 --- /dev/null +++ b/docs/models/sourcepaypaltransaction.md @@ -0,0 +1,16 @@ +# SourcePaypalTransaction + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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:59Z | +| `dispute_start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Start Date parameter for the list dispute endpoint in ISO format. This Start Date must be in range within 180 days before present time, and requires ONLY 3 miliseconds(mandatory). If you don't use this option, it defaults to a start date set 180 days in the past. | 2021-06-11T23:59:59.000Z | +| `end_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | End Date for data extraction in ISO format. This can be help you select specific range of time, mainly for test purposes or data integrity tests. When this is not used, now_utc() is used by the streams. This does not apply to Disputes and Product streams. | 2021-06-11T23:59:59Z | +| `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` | [models.PaypalTransaction](../models/paypaltransaction.md) | :heavy_check_mark: | N/A | | +| `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/sourcepaystack.md similarity index 97% rename from docs/models/shared/sourcepaystack.md rename to docs/models/sourcepaystack.md index ea26c8d4..a1098ca0 100644 --- a/docs/models/shared/sourcepaystack.md +++ b/docs/models/sourcepaystack.md @@ -8,4 +8,4 @@ | `secret_key` | *str* | :heavy_check_mark: | The Paystack API key (usually starts with 'sk_live_'; find yours here). | | | `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 +| `source_type` | [models.Paystack](../models/paystack.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/sourcependo.md b/docs/models/sourcependo.md new file mode 100644 index 00000000..3091df41 --- /dev/null +++ b/docs/models/sourcependo.md @@ -0,0 +1,9 @@ +# SourcePendo + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | +| `api_key` | *str* | :heavy_check_mark: | N/A | +| `source_type` | [models.Pendo](../models/pendo.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcepersistiq.md b/docs/models/sourcepersistiq.md similarity index 94% rename from docs/models/shared/sourcepersistiq.md rename to docs/models/sourcepersistiq.md index 931f3fba..95741464 100644 --- a/docs/models/shared/sourcepersistiq.md +++ b/docs/models/sourcepersistiq.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | PersistIq API Key. See the docs for more information on where to find that key. | -| `source_type` | [shared.Persistiq](../../models/shared/persistiq.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `source_type` | [models.Persistiq](../models/persistiq.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcepexelsapi.md b/docs/models/sourcepexelsapi.md similarity index 99% rename from docs/models/shared/sourcepexelsapi.md rename to docs/models/sourcepexelsapi.md index 8aaaebbf..c3bb846b 100644 --- a/docs/models/shared/sourcepexelsapi.md +++ b/docs/models/sourcepexelsapi.md @@ -11,4 +11,4 @@ | `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 | | `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 +| `source_type` | [models.PexelsAPI](../models/pexelsapi.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcepinterest.md b/docs/models/sourcepinterest.md similarity index 93% rename from docs/models/shared/sourcepinterest.md rename to docs/models/sourcepinterest.md index f1a49c25..258d524c 100644 --- a/docs/models/shared/sourcepinterest.md +++ b/docs/models/sourcepinterest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `credentials` | [Optional[shared.OAuth20]](../../models/shared/oauth20.md) | :heavy_minus_sign: | N/A | | -| `custom_reports` | List[[shared.ReportConfig](../../models/shared/reportconfig.md)] | :heavy_minus_sign: | 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` | [Optional[shared.SourcePinterestPinterest]](../../models/shared/sourcepinterestpinterest.md) | :heavy_minus_sign: | N/A | | +| `credentials` | [Optional[models.OAuth20]](../models/oauth20.md) | :heavy_minus_sign: | N/A | | +| `custom_reports` | List[[models.ReportConfig](../models/reportconfig.md)] | :heavy_minus_sign: | 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` | [Optional[models.SourcePinterestPinterest]](../models/sourcepinterestpinterest.md) | :heavy_minus_sign: | N/A | | | `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 api (89 days from today). | 2022-07-28 | -| `status` | List[[shared.Status](../../models/shared/status.md)] | :heavy_minus_sign: | 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. | | \ No newline at end of file +| `status` | List[[models.Status](../models/status.md)] | :heavy_minus_sign: | 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. | | \ No newline at end of file diff --git a/docs/models/shared/sourcepinterestauthmethod.md b/docs/models/sourcepinterestauthmethod.md similarity index 100% rename from docs/models/shared/sourcepinterestauthmethod.md rename to docs/models/sourcepinterestauthmethod.md diff --git a/docs/models/shared/sourcepinterestlevel.md b/docs/models/sourcepinterestlevel.md similarity index 100% rename from docs/models/shared/sourcepinterestlevel.md rename to docs/models/sourcepinterestlevel.md diff --git a/docs/models/shared/sourcepinterestpinterest.md b/docs/models/sourcepinterestpinterest.md similarity index 100% rename from docs/models/shared/sourcepinterestpinterest.md rename to docs/models/sourcepinterestpinterest.md diff --git a/docs/models/shared/sourcepinterestschemasvalidenums.md b/docs/models/sourcepinterestschemasvalidenums.md similarity index 100% rename from docs/models/shared/sourcepinterestschemasvalidenums.md rename to docs/models/sourcepinterestschemasvalidenums.md diff --git a/docs/models/shared/sourcepinterestvalidenums.md b/docs/models/sourcepinterestvalidenums.md similarity index 100% rename from docs/models/shared/sourcepinterestvalidenums.md rename to docs/models/sourcepinterestvalidenums.md diff --git a/docs/models/shared/sourcepipedrive.md b/docs/models/sourcepipedrive.md similarity index 97% rename from docs/models/shared/sourcepipedrive.md rename to docs/models/sourcepipedrive.md index c47efc9c..54229110 100644 --- a/docs/models/shared/sourcepipedrive.md +++ b/docs/models/sourcepipedrive.md @@ -7,4 +7,4 @@ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `api_token` | *str* | :heavy_check_mark: | The Pipedrive API Token. | | | `replication_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. When specified and not None, then stream will behave as incremental | 2017-01-25 00:00:00Z | -| `source_type` | [shared.Pipedrive](../../models/shared/pipedrive.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `source_type` | [models.Pipedrive](../models/pipedrive.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcepocket.md b/docs/models/sourcepocket.md similarity index 90% rename from docs/models/shared/sourcepocket.md rename to docs/models/sourcepocket.md index 1df2a510..b7d75d4d 100644 --- a/docs/models/shared/sourcepocket.md +++ b/docs/models/sourcepocket.md @@ -7,13 +7,13 @@ | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | | `access_token` | *str* | :heavy_check_mark: | The user's Pocket access token. | | | `consumer_key` | *str* | :heavy_check_mark: | Your application's Consumer Key. | | -| `content_type` | [Optional[shared.ContentType]](../../models/shared/contenttype.md) | :heavy_minus_sign: | Select the content type of the items to retrieve. | | -| `detail_type` | [Optional[shared.DetailType]](../../models/shared/detailtype.md) | :heavy_minus_sign: | Select the granularity of the information about each item. | | +| `content_type` | [Optional[models.ContentType]](../models/contenttype.md) | :heavy_minus_sign: | Select the content type of the items to retrieve. | | +| `detail_type` | [Optional[models.DetailType]](../models/detailtype.md) | :heavy_minus_sign: | Select the granularity of the information about each item. | | | `domain` | *Optional[str]* | :heavy_minus_sign: | Only return items from a particular `domain`. | | | `favorite` | *Optional[bool]* | :heavy_minus_sign: | Retrieve only favorited items. | | | `search` | *Optional[str]* | :heavy_minus_sign: | Only return items whose title or url contain the `search` string. | | | `since` | *Optional[str]* | :heavy_minus_sign: | Only return items modified since the given timestamp. | 2022-10-20 14:14:14 | -| `sort` | [Optional[shared.SourcePocketSortBy]](../../models/shared/sourcepocketsortby.md) | :heavy_minus_sign: | Sort retrieved items by the given criteria. | | -| `source_type` | [shared.Pocket](../../models/shared/pocket.md) | :heavy_check_mark: | N/A | | -| `state` | [Optional[shared.State]](../../models/shared/state.md) | :heavy_minus_sign: | Select the state of the items to retrieve. | | +| `sort` | [Optional[models.SourcePocketSortBy]](../models/sourcepocketsortby.md) | :heavy_minus_sign: | Sort retrieved items by the given criteria. | | +| `source_type` | [models.Pocket](../models/pocket.md) | :heavy_check_mark: | N/A | | +| `state` | [Optional[models.State]](../models/state.md) | :heavy_minus_sign: | Select the state of the items to retrieve. | | | `tag` | *Optional[str]* | :heavy_minus_sign: | Return only items tagged with this tag name. Use _untagged_ for retrieving only untagged items. | | \ No newline at end of file diff --git a/docs/models/shared/sourcepocketsortby.md b/docs/models/sourcepocketsortby.md similarity index 100% rename from docs/models/shared/sourcepocketsortby.md rename to docs/models/sourcepocketsortby.md diff --git a/docs/models/sourcepokeapi.md b/docs/models/sourcepokeapi.md new file mode 100644 index 00000000..24549c2d --- /dev/null +++ b/docs/models/sourcepokeapi.md @@ -0,0 +1,9 @@ +# SourcePokeapi + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| `pokemon_name` | [models.PokemonName](../models/pokemonname.md) | :heavy_check_mark: | Pokemon requested from the API. | ditto | +| `source_type` | [models.Pokeapi](../models/pokeapi.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcepolygonstockapi.md b/docs/models/sourcepolygonstockapi.md similarity index 98% rename from docs/models/shared/sourcepolygonstockapi.md rename to docs/models/sourcepolygonstockapi.md index 9c68a2f9..cb614bea 100644 --- a/docs/models/shared/sourcepolygonstockapi.md +++ b/docs/models/sourcepolygonstockapi.md @@ -14,4 +14,4 @@ | `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 +| `source_type` | [models.PolygonStockAPI](../models/polygonstockapi.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcepostgres.md b/docs/models/sourcepostgres.md similarity index 95% rename from docs/models/shared/sourcepostgres.md rename to docs/models/sourcepostgres.md index 468dd206..e7765867 100644 --- a/docs/models/shared/sourcepostgres.md +++ b/docs/models/sourcepostgres.md @@ -11,8 +11,8 @@ | `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 | -| `replication_method` | [Optional[Union[shared.ReadChangesUsingWriteAheadLogCDC, shared.DetectChangesWithXminSystemColumn, shared.SourcePostgresScanChangesWithUserDefinedCursor]]](../../models/shared/sourcepostgresupdatemethod.md) | :heavy_minus_sign: | Configures how data is extracted from the database. | | +| `replication_method` | [Optional[Union[models.ReadChangesUsingWriteAheadLogCDC, models.DetectChangesWithXminSystemColumn, models.SourcePostgresScanChangesWithUserDefinedCursor]]](../models/sourcepostgresupdatemethod.md) | :heavy_minus_sign: | Configures how data is extracted from the database. | | | `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. | | \ No newline at end of file +| `source_type` | [models.SourcePostgresPostgres](../models/sourcepostgrespostgres.md) | :heavy_check_mark: | N/A | | +| `ssl_mode` | [Optional[Union[models.SourcePostgresDisable, models.SourcePostgresAllow, models.SourcePostgresPrefer, models.SourcePostgresRequire, models.SourcePostgresVerifyCa, models.SourcePostgresVerifyFull]]](../models/sourcepostgressslmodes.md) | :heavy_minus_sign: | SSL connection modes.
    Read more in the docs. | | +| `tunnel_method` | [Optional[Union[models.SourcePostgresNoTunnel, models.SourcePostgresSSHKeyAuthentication, models.SourcePostgresPasswordAuthentication]]](../models/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/sourcepostgresallow.md b/docs/models/sourcepostgresallow.md new file mode 100644 index 00000000..6034bbc1 --- /dev/null +++ b/docs/models/sourcepostgresallow.md @@ -0,0 +1,11 @@ +# SourcePostgresAllow + +Enables encryption only when required by the source database. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `mode` | [models.SourcePostgresSchemasMode](../models/sourcepostgresschemasmode.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcepostgresdisable.md b/docs/models/sourcepostgresdisable.md new file mode 100644 index 00000000..4326ca2f --- /dev/null +++ b/docs/models/sourcepostgresdisable.md @@ -0,0 +1,11 @@ +# SourcePostgresDisable + +Disables encryption of communication between Airbyte and source database. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `mode` | [models.SourcePostgresMode](../models/sourcepostgresmode.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcepostgresinvalidcdcpositionbehavioradvanced.md b/docs/models/sourcepostgresinvalidcdcpositionbehavioradvanced.md new file mode 100644 index 00000000..6f252fb3 --- /dev/null +++ b/docs/models/sourcepostgresinvalidcdcpositionbehavioradvanced.md @@ -0,0 +1,11 @@ +# SourcePostgresInvalidCDCPositionBehaviorAdvanced + +Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value into the WAL. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss. + + +## Values + +| Name | Value | +| -------------- | -------------- | +| `FAIL_SYNC` | Fail sync | +| `RE_SYNC_DATA` | Re-sync data | \ No newline at end of file diff --git a/docs/models/shared/sourcepostgresmethod.md b/docs/models/sourcepostgresmethod.md similarity index 100% rename from docs/models/shared/sourcepostgresmethod.md rename to docs/models/sourcepostgresmethod.md diff --git a/docs/models/shared/sourcepostgresmode.md b/docs/models/sourcepostgresmode.md similarity index 100% rename from docs/models/shared/sourcepostgresmode.md rename to docs/models/sourcepostgresmode.md diff --git a/docs/models/sourcepostgresnotunnel.md b/docs/models/sourcepostgresnotunnel.md new file mode 100644 index 00000000..2a6e4dd0 --- /dev/null +++ b/docs/models/sourcepostgresnotunnel.md @@ -0,0 +1,8 @@ +# SourcePostgresNoTunnel + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `tunnel_method` | [models.SourcePostgresTunnelMethod](../models/sourcepostgrestunnelmethod.md) | :heavy_check_mark: | No ssh tunnel needed to connect to database | \ No newline at end of file diff --git a/docs/models/sourcepostgrespasswordauthentication.md b/docs/models/sourcepostgrespasswordauthentication.md new file mode 100644 index 00000000..85a4d7a5 --- /dev/null +++ b/docs/models/sourcepostgrespasswordauthentication.md @@ -0,0 +1,12 @@ +# SourcePostgresPasswordAuthentication + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `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_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | +| `tunnel_method` | [models.SourcePostgresSchemasTunnelMethodTunnelMethod](../models/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/sourcepostgrespostgres.md b/docs/models/sourcepostgrespostgres.md similarity index 100% rename from docs/models/shared/sourcepostgrespostgres.md rename to docs/models/sourcepostgrespostgres.md diff --git a/docs/models/sourcepostgresprefer.md b/docs/models/sourcepostgresprefer.md new file mode 100644 index 00000000..f05a80a3 --- /dev/null +++ b/docs/models/sourcepostgresprefer.md @@ -0,0 +1,11 @@ +# SourcePostgresPrefer + +Allows unencrypted connection only if the source database does not support encryption. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `mode` | [models.SourcePostgresSchemasSslModeMode](../models/sourcepostgresschemassslmodemode.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcepostgresrequire.md b/docs/models/sourcepostgresrequire.md new file mode 100644 index 00000000..92b6e6c5 --- /dev/null +++ b/docs/models/sourcepostgresrequire.md @@ -0,0 +1,11 @@ +# SourcePostgresRequire + +Always require encryption. If the source database server does not support encryption, connection will fail. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `mode` | [models.SourcePostgresSchemasSSLModeSSLModesMode](../models/sourcepostgresschemassslmodesslmodesmode.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcepostgresscanchangeswithuserdefinedcursor.md b/docs/models/sourcepostgresscanchangeswithuserdefinedcursor.md new file mode 100644 index 00000000..cc98abab --- /dev/null +++ b/docs/models/sourcepostgresscanchangeswithuserdefinedcursor.md @@ -0,0 +1,10 @@ +# SourcePostgresScanChangesWithUserDefinedCursor + +Incrementally detects new inserts and updates using the cursor column chosen when configuring a connection (e.g. created_at, updated_at). + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `method` | [models.SourcePostgresSchemasReplicationMethodMethod](../models/sourcepostgresschemasreplicationmethodmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcepostgresschemasmethod.md b/docs/models/sourcepostgresschemasmethod.md similarity index 100% rename from docs/models/shared/sourcepostgresschemasmethod.md rename to docs/models/sourcepostgresschemasmethod.md diff --git a/docs/models/shared/sourcepostgresschemasmode.md b/docs/models/sourcepostgresschemasmode.md similarity index 100% rename from docs/models/shared/sourcepostgresschemasmode.md rename to docs/models/sourcepostgresschemasmode.md diff --git a/docs/models/shared/sourcepostgresschemasreplicationmethodmethod.md b/docs/models/sourcepostgresschemasreplicationmethodmethod.md similarity index 100% rename from docs/models/shared/sourcepostgresschemasreplicationmethodmethod.md rename to docs/models/sourcepostgresschemasreplicationmethodmethod.md diff --git a/docs/models/shared/sourcepostgresschemassslmodemode.md b/docs/models/sourcepostgresschemassslmodemode.md similarity index 100% rename from docs/models/shared/sourcepostgresschemassslmodemode.md rename to docs/models/sourcepostgresschemassslmodemode.md diff --git a/docs/models/shared/sourcepostgresschemassslmodesslmodes5mode.md b/docs/models/sourcepostgresschemassslmodesslmodes5mode.md similarity index 100% rename from docs/models/shared/sourcepostgresschemassslmodesslmodes5mode.md rename to docs/models/sourcepostgresschemassslmodesslmodes5mode.md diff --git a/docs/models/shared/sourcepostgresschemassslmodesslmodes6mode.md b/docs/models/sourcepostgresschemassslmodesslmodes6mode.md similarity index 100% rename from docs/models/shared/sourcepostgresschemassslmodesslmodes6mode.md rename to docs/models/sourcepostgresschemassslmodesslmodes6mode.md diff --git a/docs/models/shared/sourcepostgresschemassslmodesslmodesmode.md b/docs/models/sourcepostgresschemassslmodesslmodesmode.md similarity index 100% rename from docs/models/shared/sourcepostgresschemassslmodesslmodesmode.md rename to docs/models/sourcepostgresschemassslmodesslmodesmode.md diff --git a/docs/models/shared/sourcepostgresschemastunnelmethod.md b/docs/models/sourcepostgresschemastunnelmethod.md similarity index 100% rename from docs/models/shared/sourcepostgresschemastunnelmethod.md rename to docs/models/sourcepostgresschemastunnelmethod.md diff --git a/docs/models/shared/sourcepostgresschemastunnelmethodtunnelmethod.md b/docs/models/sourcepostgresschemastunnelmethodtunnelmethod.md similarity index 100% rename from docs/models/shared/sourcepostgresschemastunnelmethodtunnelmethod.md rename to docs/models/sourcepostgresschemastunnelmethodtunnelmethod.md diff --git a/docs/models/shared/sourcepostgressshkeyauthentication.md b/docs/models/sourcepostgressshkeyauthentication.md similarity index 95% rename from docs/models/shared/sourcepostgressshkeyauthentication.md rename to docs/models/sourcepostgressshkeyauthentication.md index ece7e5ba..b9c0bf6c 100644 --- a/docs/models/shared/sourcepostgressshkeyauthentication.md +++ b/docs/models/sourcepostgressshkeyauthentication.md @@ -8,5 +8,5 @@ | `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_method` | [models.SourcePostgresSchemasTunnelMethod](../models/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 | \ No newline at end of file diff --git a/docs/models/sourcepostgressshtunnelmethod.md b/docs/models/sourcepostgressshtunnelmethod.md new file mode 100644 index 00000000..5ee3d9aa --- /dev/null +++ b/docs/models/sourcepostgressshtunnelmethod.md @@ -0,0 +1,25 @@ +# SourcePostgresSSHTunnelMethod + +Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. + + +## Supported Types + +### SourcePostgresNoTunnel + +```python +sourcePostgresSSHTunnelMethod: models.SourcePostgresNoTunnel = /* values here */ +``` + +### SourcePostgresSSHKeyAuthentication + +```python +sourcePostgresSSHTunnelMethod: models.SourcePostgresSSHKeyAuthentication = /* values here */ +``` + +### SourcePostgresPasswordAuthentication + +```python +sourcePostgresSSHTunnelMethod: models.SourcePostgresPasswordAuthentication = /* values here */ +``` + diff --git a/docs/models/sourcepostgressslmodes.md b/docs/models/sourcepostgressslmodes.md new file mode 100644 index 00000000..af6d42d8 --- /dev/null +++ b/docs/models/sourcepostgressslmodes.md @@ -0,0 +1,44 @@ +# SourcePostgresSSLModes + +SSL connection modes. + Read more in the docs. + + +## Supported Types + +### SourcePostgresDisable + +```python +sourcePostgresSSLModes: models.SourcePostgresDisable = /* values here */ +``` + +### SourcePostgresAllow + +```python +sourcePostgresSSLModes: models.SourcePostgresAllow = /* values here */ +``` + +### SourcePostgresPrefer + +```python +sourcePostgresSSLModes: models.SourcePostgresPrefer = /* values here */ +``` + +### SourcePostgresRequire + +```python +sourcePostgresSSLModes: models.SourcePostgresRequire = /* values here */ +``` + +### SourcePostgresVerifyCa + +```python +sourcePostgresSSLModes: models.SourcePostgresVerifyCa = /* values here */ +``` + +### SourcePostgresVerifyFull + +```python +sourcePostgresSSLModes: models.SourcePostgresVerifyFull = /* values here */ +``` + diff --git a/docs/models/shared/sourcepostgrestunnelmethod.md b/docs/models/sourcepostgrestunnelmethod.md similarity index 100% rename from docs/models/shared/sourcepostgrestunnelmethod.md rename to docs/models/sourcepostgrestunnelmethod.md diff --git a/docs/models/sourcepostgresupdatemethod.md b/docs/models/sourcepostgresupdatemethod.md new file mode 100644 index 00000000..329764d7 --- /dev/null +++ b/docs/models/sourcepostgresupdatemethod.md @@ -0,0 +1,25 @@ +# SourcePostgresUpdateMethod + +Configures how data is extracted from the database. + + +## Supported Types + +### ReadChangesUsingWriteAheadLogCDC + +```python +sourcePostgresUpdateMethod: models.ReadChangesUsingWriteAheadLogCDC = /* values here */ +``` + +### DetectChangesWithXminSystemColumn + +```python +sourcePostgresUpdateMethod: models.DetectChangesWithXminSystemColumn = /* values here */ +``` + +### SourcePostgresScanChangesWithUserDefinedCursor + +```python +sourcePostgresUpdateMethod: models.SourcePostgresScanChangesWithUserDefinedCursor = /* values here */ +``` + diff --git a/docs/models/sourcepostgresverifyca.md b/docs/models/sourcepostgresverifyca.md new file mode 100644 index 00000000..d73be023 --- /dev/null +++ b/docs/models/sourcepostgresverifyca.md @@ -0,0 +1,15 @@ +# SourcePostgresVerifyCa + +Always require encryption and verifies that the source database server has a valid SSL certificate. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `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. | +| `mode` | [models.SourcePostgresSchemasSSLModeSSLModes5Mode](../models/sourcepostgresschemassslmodesslmodes5mode.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcepostgresverifyfull.md b/docs/models/sourcepostgresverifyfull.md new file mode 100644 index 00000000..e4598dd1 --- /dev/null +++ b/docs/models/sourcepostgresverifyfull.md @@ -0,0 +1,15 @@ +# SourcePostgresVerifyFull + +This is the most secure mode. Always require encryption and verifies the identity of the source database server. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `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. | +| `mode` | [models.SourcePostgresSchemasSSLModeSSLModes6Mode](../models/sourcepostgresschemassslmodesslmodes6mode.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceposthog.md b/docs/models/sourceposthog.md similarity index 98% rename from docs/models/shared/sourceposthog.md rename to docs/models/sourceposthog.md index a0ff2923..79bb4578 100644 --- a/docs/models/shared/sourceposthog.md +++ b/docs/models/sourceposthog.md @@ -9,4 +9,4 @@ | `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 | | \ No newline at end of file +| `source_type` | [models.Posthog](../models/posthog.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/sourcepostmarkapp.md b/docs/models/sourcepostmarkapp.md new file mode 100644 index 00000000..1f0de832 --- /dev/null +++ b/docs/models/sourcepostmarkapp.md @@ -0,0 +1,10 @@ +# SourcePostmarkapp + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| `x_postmark_account_token` | *str* | :heavy_check_mark: | API Key for account | +| `x_postmark_server_token` | *str* | :heavy_check_mark: | API Key for server | +| `source_type` | [models.Postmarkapp](../models/postmarkapp.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceprestashop.md b/docs/models/sourceprestashop.md similarity index 97% rename from docs/models/shared/sourceprestashop.md rename to docs/models/sourceprestashop.md index 4046a3f3..331090e1 100644 --- a/docs/models/shared/sourceprestashop.md +++ b/docs/models/sourceprestashop.md @@ -8,4 +8,4 @@ | `access_key` | *str* | :heavy_check_mark: | Your PrestaShop access key. See the docs for info on how to obtain this. | | | `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. | | -| `source_type` | [shared.Prestashop](../../models/shared/prestashop.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `source_type` | [models.Prestashop](../models/prestashop.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/sourcepunkapi.md b/docs/models/sourcepunkapi.md new file mode 100644 index 00000000..03eb5635 --- /dev/null +++ b/docs/models/sourcepunkapi.md @@ -0,0 +1,11 @@ +# SourcePunkAPI + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | +| `brewed_after` | *str* | :heavy_check_mark: | To extract specific data with Unique ID | MM-YYYY | +| `brewed_before` | *str* | :heavy_check_mark: | To extract specific data with Unique ID | MM-YYYY | +| `id` | *Optional[str]* | :heavy_minus_sign: | To extract specific data with Unique ID | 1 | +| `source_type` | [models.PunkAPI](../models/punkapi.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceputrequest.md b/docs/models/sourceputrequest.md similarity index 93% rename from docs/models/shared/sourceputrequest.md rename to docs/models/sourceputrequest.md index d8e94ae2..d58e5f47 100644 --- a/docs/models/shared/sourceputrequest.md +++ b/docs/models/sourceputrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `configuration` | [Union[shared.SourceAha, shared.SourceAircall, shared.SourceAirtable, 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.SourceGoogleAnalyticsV4ServiceAccountOnly, 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.SourceKyve, shared.SourceLaunchdarkly, shared.SourceLemlist, shared.SourceLeverHiring, shared.SourceLinkedinAds, shared.SourceLinkedinPages, shared.SourceLokalise, shared.SourceMailchimp, shared.SourceMailgun, shared.SourceMailjetSms, shared.SourceMarketo, shared.SourceMetabase, shared.SourceMicrosoftSharepoint, 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.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]](../../models/shared/sourceconfiguration.md) | :heavy_check_mark: | The values required to configure the source. | {
    "user": "charles"
    } | -| `name` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `configuration` | [Union[models.SourceAha, models.SourceAircall, models.SourceAirtable, models.SourceAmazonAds, models.SourceAmazonSellerPartner, models.SourceAmazonSqs, models.SourceAmplitude, models.SourceApifyDataset, models.SourceAppfollow, models.SourceAsana, models.SourceAuth0, models.SourceAwsCloudtrail, models.SourceAzureBlobStorage, models.SourceAzureTable, models.SourceBambooHr, models.SourceBigquery, models.SourceBingAds, models.SourceBraintree, models.SourceBraze, models.SourceCart, models.SourceChargebee, models.SourceChartmogul, models.SourceClickhouse, models.SourceClickupAPI, models.SourceClockify, models.SourceCloseCom, models.SourceCoda, models.SourceCoinAPI, models.SourceCoinmarketcap, models.SourceConfigcat, models.SourceConfluence, models.SourceConvex, models.SourceDatascope, models.SourceDelighted, models.SourceDixa, models.SourceDockerhub, models.SourceDremio, models.SourceDynamodb, Union[models.ContinuousFeed], models.SourceEmailoctopus, models.SourceExchangeRates, models.SourceFacebookMarketing, models.SourceFaker, models.SourceFauna, models.SourceFile, models.SourceFirebolt, models.SourceFreshcaller, models.SourceFreshdesk, models.SourceFreshsales, models.SourceGainsightPx, models.SourceGcs, models.SourceGetlago, models.SourceGithub, models.SourceGitlab, models.SourceGlassfrog, models.SourceGnews, models.SourceGoogleAds, models.SourceGoogleAnalyticsDataAPI, models.SourceGoogleAnalyticsV4ServiceAccountOnly, models.SourceGoogleDirectory, models.SourceGoogleDrive, models.SourceGooglePagespeedInsights, models.SourceGoogleSearchConsole, models.SourceGoogleSheets, models.SourceGoogleWebfonts, models.SourceGreenhouse, models.SourceGridly, models.SourceHarvest, models.SourceHubplanner, models.SourceHubspot, models.SourceInsightly, models.SourceInstagram, models.SourceInstatus, models.SourceIntercom, models.SourceIp2whois, models.SourceIterable, models.SourceJira, models.SourceK6Cloud, models.SourceKlarna, models.SourceKlaviyo, models.SourceKyve, models.SourceLaunchdarkly, models.SourceLemlist, models.SourceLeverHiring, models.SourceLinkedinAds, models.SourceLinkedinPages, models.SourceLinnworks, models.SourceLokalise, models.SourceMailchimp, models.SourceMailgun, models.SourceMailjetSms, models.SourceMarketo, models.SourceMetabase, models.SourceMicrosoftOnedrive, models.SourceMicrosoftSharepoint, models.SourceMicrosoftTeams, models.SourceMixpanel, models.SourceMonday, models.SourceMongodbInternalPoc, models.SourceMongodbV2, models.SourceMssql, models.SourceMyHours, models.SourceMysql, models.SourceNetsuite, models.SourceNotion, models.SourceNytimes, models.SourceOkta, models.SourceOmnisend, models.SourceOnesignal, models.SourceOracle, models.SourceOrb, models.SourceOrbit, models.SourceOutbrainAmplify, models.SourceOutreach, models.SourcePaypalTransaction, models.SourcePaystack, models.SourcePendo, models.SourcePersistiq, models.SourcePexelsAPI, models.SourcePinterest, models.SourcePipedrive, models.SourcePocket, models.SourcePokeapi, models.SourcePolygonStockAPI, models.SourcePostgres, models.SourcePosthog, models.SourcePostmarkapp, models.SourcePrestashop, models.SourcePunkAPI, models.SourcePypi, models.SourceQualaroo, models.SourceQuickbooks, models.SourceRailz, models.SourceRecharge, models.SourceRecreation, models.SourceRecruitee, models.SourceRecurly, models.SourceRedshift, models.SourceRetently, models.SourceRkiCovid, models.SourceRss, models.SourceS3, models.SourceSalesforce, models.SourceSalesloft, models.SourceSapFieldglass, models.SourceSecoda, models.SourceSendgrid, models.SourceSendinblue, models.SourceSenseforce, models.SourceSentry, models.SourceSftp, models.SourceSftpBulk, models.SourceShopify, models.SourceShortio, models.SourceSlack, models.SourceSmaily, models.SourceSmartengage, models.SourceSmartsheets, models.SourceSnapchatMarketing, models.SourceSnowflake, models.SourceSonarCloud, models.SourceSpacexAPI, models.SourceSquare, models.SourceStrava, models.SourceStripe, models.SourceSurveySparrow, models.SourceSurveymonkey, models.SourceTempo, models.SourceTheGuardianAPI, models.SourceTiktokMarketing, models.SourceTrello, models.SourceTrustpilot, models.SourceTvmazeSchedule, models.SourceTwilio, models.SourceTwilioTaskrouter, models.SourceTwitter, models.SourceTypeform, models.SourceUsCensus, models.SourceVantage, models.SourceWebflow, models.SourceWhiskyHunter, models.SourceWikipediaPageviews, models.SourceWoocommerce, models.SourceXkcd, models.SourceYandexMetrica, models.SourceYotpo, models.SourceYoutubeAnalytics, models.SourceZendeskChat, models.SourceZendeskSell, models.SourceZendeskSunshine, models.SourceZendeskSupport, models.SourceZendeskTalk, models.SourceZenloop, models.SourceZohoCrm, models.SourceZoom]](../models/sourceconfiguration.md) | :heavy_check_mark: | The values required to configure the source. | {
    "user": "charles"
    } | +| `name` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcepypi.md b/docs/models/sourcepypi.md similarity index 98% rename from docs/models/shared/sourcepypi.md rename to docs/models/sourcepypi.md index ac247f39..4babf09d 100644 --- a/docs/models/shared/sourcepypi.md +++ b/docs/models/sourcepypi.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | | `project_name` | *str* | :heavy_check_mark: | Name of the project/package. Can only be in lowercase with hyphen. This is the name used using pip command for installing the package. | sampleproject | -| `source_type` | [shared.Pypi](../../models/shared/pypi.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.Pypi](../models/pypi.md) | :heavy_check_mark: | N/A | | | `version` | *Optional[str]* | :heavy_minus_sign: | Version of the project/package. Use it to find a particular release instead of all releases. | 1.2.0 | \ No newline at end of file diff --git a/docs/models/shared/sourcequalaroo.md b/docs/models/sourcequalaroo.md similarity index 97% rename from docs/models/shared/sourcequalaroo.md rename to docs/models/sourcequalaroo.md index 25b28dd5..4953baca 100644 --- a/docs/models/shared/sourcequalaroo.md +++ b/docs/models/sourcequalaroo.md @@ -8,5 +8,5 @@ | `key` | *str* | :heavy_check_mark: | A Qualaroo token. See the docs for instructions on how to generate it. | | | `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 | | `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 | | +| `source_type` | [models.Qualaroo](../models/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/sourcequickbooks.md similarity index 93% rename from docs/models/shared/sourcequickbooks.md rename to docs/models/sourcequickbooks.md index 47581ef4..a044c1f0 100644 --- a/docs/models/shared/sourcequickbooks.md +++ b/docs/models/sourcequickbooks.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `credentials` | [Union[shared.SourceQuickbooksOAuth20]](../../models/shared/sourcequickbooksauthorizationmethod.md) | :heavy_check_mark: | N/A | | +| `credentials` | [Union[models.SourceQuickbooksOAuth20]](../models/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 | | \ No newline at end of file +| `source_type` | [models.Quickbooks](../models/quickbooks.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/sourcequickbooksauthorizationmethod.md b/docs/models/sourcequickbooksauthorizationmethod.md new file mode 100644 index 00000000..f66970fb --- /dev/null +++ b/docs/models/sourcequickbooksauthorizationmethod.md @@ -0,0 +1,11 @@ +# SourceQuickbooksAuthorizationMethod + + +## Supported Types + +### SourceQuickbooksOAuth20 + +```python +sourceQuickbooksAuthorizationMethod: models.SourceQuickbooksOAuth20 = /* values here */ +``` + diff --git a/docs/models/shared/sourcequickbooksauthtype.md b/docs/models/sourcequickbooksauthtype.md similarity index 100% rename from docs/models/shared/sourcequickbooksauthtype.md rename to docs/models/sourcequickbooksauthtype.md diff --git a/docs/models/shared/sourcequickbooksoauth20.md b/docs/models/sourcequickbooksoauth20.md similarity index 97% rename from docs/models/shared/sourcequickbooksoauth20.md rename to docs/models/sourcequickbooksoauth20.md index 08c2d42b..cd533c98 100644 --- a/docs/models/shared/sourcequickbooksoauth20.md +++ b/docs/models/sourcequickbooksoauth20.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `access_token` | *str* | :heavy_check_mark: | Access token fot making authenticated requests. | +| `access_token` | *str* | :heavy_check_mark: | Access token for making authenticated requests. | | `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. | -| `auth_type` | [Optional[shared.SourceQuickbooksAuthType]](../../models/shared/sourcequickbooksauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `auth_type` | [Optional[models.SourceQuickbooksAuthType]](../models/sourcequickbooksauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourcerailz.md b/docs/models/sourcerailz.md new file mode 100644 index 00000000..97d4e1fe --- /dev/null +++ b/docs/models/sourcerailz.md @@ -0,0 +1,11 @@ +# SourceRailz + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | +| `client_id` | *str* | :heavy_check_mark: | Client ID (client_id) | +| `secret_key` | *str* | :heavy_check_mark: | Secret key (secret_key) | +| `start_date` | *str* | :heavy_check_mark: | Start date | +| `source_type` | [models.Railz](../models/railz.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcerecharge.md b/docs/models/sourcerecharge.md similarity index 97% rename from docs/models/shared/sourcerecharge.md rename to docs/models/sourcerecharge.md index fea6e80d..0387e544 100644 --- a/docs/models/shared/sourcerecharge.md +++ b/docs/models/sourcerecharge.md @@ -7,5 +7,5 @@ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | | `access_token` | *str* | :heavy_check_mark: | The value of the Access Token generated. See the docs for more information. | | | `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 | | +| `source_type` | [models.Recharge](../models/recharge.md) | :heavy_check_mark: | N/A | | | `use_orders_deprecated_api` | *Optional[bool]* | :heavy_minus_sign: | Define whether or not the `Orders` stream should use the deprecated `2021-01` API version, or use `2021-11`, otherwise. | | \ No newline at end of file diff --git a/docs/models/sourcerecreation.md b/docs/models/sourcerecreation.md new file mode 100644 index 00000000..eccb75bd --- /dev/null +++ b/docs/models/sourcerecreation.md @@ -0,0 +1,10 @@ +# SourceRecreation + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | +| `apikey` | *str* | :heavy_check_mark: | API Key | +| `query_campsites` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `source_type` | [models.Recreation](../models/recreation.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcerecruitee.md b/docs/models/sourcerecruitee.md similarity index 95% rename from docs/models/shared/sourcerecruitee.md rename to docs/models/sourcerecruitee.md index 2d926cc2..c7795962 100644 --- a/docs/models/shared/sourcerecruitee.md +++ b/docs/models/sourcerecruitee.md @@ -7,4 +7,4 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | Recruitee API Key. See here. | | `company_id` | *int* | :heavy_check_mark: | Recruitee Company ID. You can also find this ID on the Recruitee API tokens page. | -| `source_type` | [shared.Recruitee](../../models/shared/recruitee.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `source_type` | [models.Recruitee](../models/recruitee.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcerecurly.md b/docs/models/sourcerecurly.md new file mode 100644 index 00000000..00158959 --- /dev/null +++ b/docs/models/sourcerecurly.md @@ -0,0 +1,11 @@ +# SourceRecurly + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `api_key` | *str* | :heavy_check_mark: | Recurly API Key. See the docs for more information on how to generate this key. | | +| `begin_time` | *Optional[str]* | :heavy_minus_sign: | ISO8601 timestamp from which the replication from Recurly API will start from. | 2021-12-01T00:00:00 | +| `end_time` | *Optional[str]* | :heavy_minus_sign: | ISO8601 timestamp to which the replication from Recurly API will stop. Records after that date won't be imported. | 2021-12-01T00:00:00 | +| `source_type` | [models.Recurly](../models/recurly.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceredshift.md b/docs/models/sourceredshift.md similarity index 98% rename from docs/models/shared/sourceredshift.md rename to docs/models/sourceredshift.md index 52f19b32..5320fd93 100644 --- a/docs/models/shared/sourceredshift.md +++ b/docs/models/sourceredshift.md @@ -12,4 +12,4 @@ | `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 | | \ No newline at end of file +| `source_type` | [models.SourceRedshiftRedshift](../models/sourceredshiftredshift.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceredshiftredshift.md b/docs/models/sourceredshiftredshift.md similarity index 100% rename from docs/models/shared/sourceredshiftredshift.md rename to docs/models/sourceredshiftredshift.md diff --git a/docs/models/shared/sourceresponse.md b/docs/models/sourceresponse.md similarity index 95% rename from docs/models/shared/sourceresponse.md rename to docs/models/sourceresponse.md index 0830e858..519c91fb 100644 --- a/docs/models/shared/sourceresponse.md +++ b/docs/models/sourceresponse.md @@ -5,10 +5,10 @@ Provides details of a single source. ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `configuration` | [Union[shared.SourceAha, shared.SourceAircall, shared.SourceAirtable, 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.SourceGoogleAnalyticsV4ServiceAccountOnly, 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.SourceKyve, shared.SourceLaunchdarkly, shared.SourceLemlist, shared.SourceLeverHiring, shared.SourceLinkedinAds, shared.SourceLinkedinPages, shared.SourceLokalise, shared.SourceMailchimp, shared.SourceMailgun, shared.SourceMailjetSms, shared.SourceMarketo, shared.SourceMetabase, shared.SourceMicrosoftSharepoint, 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.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]](../../models/shared/sourceconfiguration.md) | :heavy_check_mark: | The values required to configure the source. | {
    "user": "charles"
    } | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `source_id` | *str* | :heavy_check_mark: | N/A | | -| `source_type` | *str* | :heavy_check_mark: | N/A | | -| `workspace_id` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `configuration` | [Union[models.SourceAha, models.SourceAircall, models.SourceAirtable, models.SourceAmazonAds, models.SourceAmazonSellerPartner, models.SourceAmazonSqs, models.SourceAmplitude, models.SourceApifyDataset, models.SourceAppfollow, models.SourceAsana, models.SourceAuth0, models.SourceAwsCloudtrail, models.SourceAzureBlobStorage, models.SourceAzureTable, models.SourceBambooHr, models.SourceBigquery, models.SourceBingAds, models.SourceBraintree, models.SourceBraze, models.SourceCart, models.SourceChargebee, models.SourceChartmogul, models.SourceClickhouse, models.SourceClickupAPI, models.SourceClockify, models.SourceCloseCom, models.SourceCoda, models.SourceCoinAPI, models.SourceCoinmarketcap, models.SourceConfigcat, models.SourceConfluence, models.SourceConvex, models.SourceDatascope, models.SourceDelighted, models.SourceDixa, models.SourceDockerhub, models.SourceDremio, models.SourceDynamodb, Union[models.ContinuousFeed], models.SourceEmailoctopus, models.SourceExchangeRates, models.SourceFacebookMarketing, models.SourceFaker, models.SourceFauna, models.SourceFile, models.SourceFirebolt, models.SourceFreshcaller, models.SourceFreshdesk, models.SourceFreshsales, models.SourceGainsightPx, models.SourceGcs, models.SourceGetlago, models.SourceGithub, models.SourceGitlab, models.SourceGlassfrog, models.SourceGnews, models.SourceGoogleAds, models.SourceGoogleAnalyticsDataAPI, models.SourceGoogleAnalyticsV4ServiceAccountOnly, models.SourceGoogleDirectory, models.SourceGoogleDrive, models.SourceGooglePagespeedInsights, models.SourceGoogleSearchConsole, models.SourceGoogleSheets, models.SourceGoogleWebfonts, models.SourceGreenhouse, models.SourceGridly, models.SourceHarvest, models.SourceHubplanner, models.SourceHubspot, models.SourceInsightly, models.SourceInstagram, models.SourceInstatus, models.SourceIntercom, models.SourceIp2whois, models.SourceIterable, models.SourceJira, models.SourceK6Cloud, models.SourceKlarna, models.SourceKlaviyo, models.SourceKyve, models.SourceLaunchdarkly, models.SourceLemlist, models.SourceLeverHiring, models.SourceLinkedinAds, models.SourceLinkedinPages, models.SourceLinnworks, models.SourceLokalise, models.SourceMailchimp, models.SourceMailgun, models.SourceMailjetSms, models.SourceMarketo, models.SourceMetabase, models.SourceMicrosoftOnedrive, models.SourceMicrosoftSharepoint, models.SourceMicrosoftTeams, models.SourceMixpanel, models.SourceMonday, models.SourceMongodbInternalPoc, models.SourceMongodbV2, models.SourceMssql, models.SourceMyHours, models.SourceMysql, models.SourceNetsuite, models.SourceNotion, models.SourceNytimes, models.SourceOkta, models.SourceOmnisend, models.SourceOnesignal, models.SourceOracle, models.SourceOrb, models.SourceOrbit, models.SourceOutbrainAmplify, models.SourceOutreach, models.SourcePaypalTransaction, models.SourcePaystack, models.SourcePendo, models.SourcePersistiq, models.SourcePexelsAPI, models.SourcePinterest, models.SourcePipedrive, models.SourcePocket, models.SourcePokeapi, models.SourcePolygonStockAPI, models.SourcePostgres, models.SourcePosthog, models.SourcePostmarkapp, models.SourcePrestashop, models.SourcePunkAPI, models.SourcePypi, models.SourceQualaroo, models.SourceQuickbooks, models.SourceRailz, models.SourceRecharge, models.SourceRecreation, models.SourceRecruitee, models.SourceRecurly, models.SourceRedshift, models.SourceRetently, models.SourceRkiCovid, models.SourceRss, models.SourceS3, models.SourceSalesforce, models.SourceSalesloft, models.SourceSapFieldglass, models.SourceSecoda, models.SourceSendgrid, models.SourceSendinblue, models.SourceSenseforce, models.SourceSentry, models.SourceSftp, models.SourceSftpBulk, models.SourceShopify, models.SourceShortio, models.SourceSlack, models.SourceSmaily, models.SourceSmartengage, models.SourceSmartsheets, models.SourceSnapchatMarketing, models.SourceSnowflake, models.SourceSonarCloud, models.SourceSpacexAPI, models.SourceSquare, models.SourceStrava, models.SourceStripe, models.SourceSurveySparrow, models.SourceSurveymonkey, models.SourceTempo, models.SourceTheGuardianAPI, models.SourceTiktokMarketing, models.SourceTrello, models.SourceTrustpilot, models.SourceTvmazeSchedule, models.SourceTwilio, models.SourceTwilioTaskrouter, models.SourceTwitter, models.SourceTypeform, models.SourceUsCensus, models.SourceVantage, models.SourceWebflow, models.SourceWhiskyHunter, models.SourceWikipediaPageviews, models.SourceWoocommerce, models.SourceXkcd, models.SourceYandexMetrica, models.SourceYotpo, models.SourceYoutubeAnalytics, models.SourceZendeskChat, models.SourceZendeskSell, models.SourceZendeskSunshine, models.SourceZendeskSupport, models.SourceZendeskTalk, models.SourceZenloop, models.SourceZohoCrm, models.SourceZoom]](../models/sourceconfiguration.md) | :heavy_check_mark: | The values required to configure the source. | {
    "user": "charles"
    } | +| `name` | *str* | :heavy_check_mark: | N/A | | +| `source_id` | *str* | :heavy_check_mark: | N/A | | +| `source_type` | *str* | :heavy_check_mark: | N/A | | +| `workspace_id` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/sourceretently.md b/docs/models/sourceretently.md new file mode 100644 index 00000000..e1bb22af --- /dev/null +++ b/docs/models/sourceretently.md @@ -0,0 +1,9 @@ +# SourceRetently + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | +| `credentials` | [Optional[Union[models.AuthenticateViaRetentlyOAuth, models.AuthenticateWithAPIToken]]](../models/sourceretentlyauthenticationmechanism.md) | :heavy_minus_sign: | Choose how to authenticate to Retently | +| `source_type` | [Optional[models.SourceRetentlyRetently]](../models/sourceretentlyretently.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourceretentlyauthenticationmechanism.md b/docs/models/sourceretentlyauthenticationmechanism.md new file mode 100644 index 00000000..381356f7 --- /dev/null +++ b/docs/models/sourceretentlyauthenticationmechanism.md @@ -0,0 +1,19 @@ +# SourceRetentlyAuthenticationMechanism + +Choose how to authenticate to Retently + + +## Supported Types + +### AuthenticateViaRetentlyOAuth + +```python +sourceRetentlyAuthenticationMechanism: models.AuthenticateViaRetentlyOAuth = /* values here */ +``` + +### AuthenticateWithAPIToken + +```python +sourceRetentlyAuthenticationMechanism: models.AuthenticateWithAPIToken = /* values here */ +``` + diff --git a/docs/models/shared/sourceretentlyauthtype.md b/docs/models/sourceretentlyauthtype.md similarity index 100% rename from docs/models/shared/sourceretentlyauthtype.md rename to docs/models/sourceretentlyauthtype.md diff --git a/docs/models/shared/sourceretentlyretently.md b/docs/models/sourceretentlyretently.md similarity index 100% rename from docs/models/shared/sourceretentlyretently.md rename to docs/models/sourceretentlyretently.md diff --git a/docs/models/shared/sourceretentlyschemasauthtype.md b/docs/models/sourceretentlyschemasauthtype.md similarity index 100% rename from docs/models/shared/sourceretentlyschemasauthtype.md rename to docs/models/sourceretentlyschemasauthtype.md diff --git a/docs/models/shared/sourcerkicovid.md b/docs/models/sourcerkicovid.md similarity index 91% rename from docs/models/shared/sourcerkicovid.md rename to docs/models/sourcerkicovid.md index e2a46f18..4005648a 100644 --- a/docs/models/shared/sourcerkicovid.md +++ b/docs/models/sourcerkicovid.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | | `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 +| `source_type` | [models.RkiCovid](../models/rkicovid.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcerss.md b/docs/models/sourcerss.md new file mode 100644 index 00000000..30e0ad09 --- /dev/null +++ b/docs/models/sourcerss.md @@ -0,0 +1,9 @@ +# SourceRss + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | +| `url` | *str* | :heavy_check_mark: | RSS Feed URL | +| `source_type` | [models.Rss](../models/rss.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sources3.md b/docs/models/sources3.md similarity index 92% rename from docs/models/shared/sources3.md rename to docs/models/sources3.md index 7a5a5dfe..78653cea 100644 --- a/docs/models/shared/sources3.md +++ b/docs/models/sources3.md @@ -9,15 +9,16 @@ 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. | | +| `streams` | List[[models.SourceS3FileBasedStreamConfig](../models/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. | | | `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 | | +| `format` | [Optional[Union[models.Csv, models.Parquet, models.Avro, models.Jsonl]]](../models/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 | | | `path_pattern` | *Optional[str]* | :heavy_minus_sign: | Deprecated and will be removed soon. Please do not use this field anymore and use streams.globs instead. A regular expression which tells the connector which files to replicate. All files which match this pattern will be replicated. Use \| to separate multiple patterns. See this page to understand pattern syntax (GLOBSTAR and SPLIT flags are enabled). Use pattern ** to pick up all files. | ** | -| `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 | | +| `provider` | [Optional[models.S3AmazonWebServices]](../models/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 | | +| `region_name` | *Optional[str]* | :heavy_minus_sign: | AWS region where the S3 bucket is located. If not provided, the region will be determined automatically. | | | `role_arn` | *Optional[str]* | :heavy_minus_sign: | Specifies the Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations requested using this profile. Set the External ID to the Airbyte workspace ID, which can be found in the URL of this page. | | | `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 | | +| `source_type` | [models.SourceS3S3](../models/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 | \ No newline at end of file diff --git a/docs/models/sources3autogenerated.md b/docs/models/sources3autogenerated.md new file mode 100644 index 00000000..eabe4ddb --- /dev/null +++ b/docs/models/sources3autogenerated.md @@ -0,0 +1,8 @@ +# SourceS3Autogenerated + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `header_definition_type` | [Optional[models.SourceS3SchemasHeaderDefinitionType]](../models/sources3schemasheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sources3avroformat.md b/docs/models/sources3avroformat.md similarity index 96% rename from docs/models/shared/sources3avroformat.md rename to docs/models/sources3avroformat.md index c14feffb..9948e0dc 100644 --- a/docs/models/shared/sources3avroformat.md +++ b/docs/models/sources3avroformat.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `double_as_string` | *Optional[bool]* | :heavy_minus_sign: | Whether to convert double fields to strings. This is recommended if you have decimal numbers with a high degree of precision because there can be a loss precision when handling floating point numbers. | -| `filetype` | [Optional[shared.SourceS3SchemasStreamsFiletype]](../../models/shared/sources3schemasstreamsfiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `filetype` | [Optional[models.SourceS3SchemasStreamsFiletype]](../models/sources3schemasstreamsfiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sources3csvformat.md b/docs/models/sources3csvformat.md similarity index 98% rename from docs/models/shared/sources3csvformat.md rename to docs/models/sources3csvformat.md index 4df5e592..76822a21 100644 --- a/docs/models/shared/sources3csvformat.md +++ b/docs/models/sources3csvformat.md @@ -10,9 +10,9 @@ | `encoding` | *Optional[str]* | :heavy_minus_sign: | The character encoding of the CSV data. Leave blank to default to UTF8. See list of python encodings for allowable options. | | `escape_char` | *Optional[str]* | :heavy_minus_sign: | The character used for escaping special characters. To disallow escaping, leave this field blank. | | `false_values` | List[*str*] | :heavy_minus_sign: | A set of case-sensitive strings that should be interpreted as false values. | -| `filetype` | [Optional[shared.SourceS3SchemasStreamsFormatFiletype]](../../models/shared/sources3schemasstreamsformatfiletype.md) | :heavy_minus_sign: | N/A | -| `header_definition` | [Optional[Union[shared.SourceS3FromCSV, shared.SourceS3Autogenerated, shared.SourceS3UserProvided]]](../../models/shared/sources3csvheaderdefinition.md) | :heavy_minus_sign: | How headers will be defined. `User Provided` assumes the CSV does not have a header row and uses the headers provided and `Autogenerated` assumes the CSV does not have a header row and the CDK will generate headers using for `f{i}` where `i` is the index starting from 0. Else, the default behavior is to use the header from the CSV file. If a user wants to autogenerate or provide column names for a CSV having headers, they can skip rows. | -| `inference_type` | [Optional[shared.SourceS3InferenceType]](../../models/shared/sources3inferencetype.md) | :heavy_minus_sign: | How to infer the types of the columns. If none, inference default to strings. | +| `filetype` | [Optional[models.SourceS3SchemasStreamsFormatFiletype]](../models/sources3schemasstreamsformatfiletype.md) | :heavy_minus_sign: | N/A | +| `header_definition` | [Optional[Union[models.SourceS3FromCSV, models.SourceS3Autogenerated, models.SourceS3UserProvided]]](../models/sources3csvheaderdefinition.md) | :heavy_minus_sign: | How headers will be defined. `User Provided` assumes the CSV does not have a header row and uses the headers provided and `Autogenerated` assumes the CSV does not have a header row and the CDK will generate headers using for `f{i}` where `i` is the index starting from 0. Else, the default behavior is to use the header from the CSV file. If a user wants to autogenerate or provide column names for a CSV having headers, they can skip rows. | +| `inference_type` | [Optional[models.SourceS3InferenceType]](../models/sources3inferencetype.md) | :heavy_minus_sign: | How to infer the types of the columns. If none, inference default to strings. | | `null_values` | List[*str*] | :heavy_minus_sign: | A set of case-sensitive strings that should be interpreted as null values. For example, if the value 'NA' should be interpreted as null, enter 'NA' in this field. | | `quote_char` | *Optional[str]* | :heavy_minus_sign: | The character used for quoting CSV values. To disallow quoting, make this field blank. | | `skip_rows_after_header` | *Optional[int]* | :heavy_minus_sign: | The number of rows to skip after the header row. | diff --git a/docs/models/shared/sources3csvheaderdefinition.md b/docs/models/sources3csvheaderdefinition.md similarity index 77% rename from docs/models/shared/sources3csvheaderdefinition.md rename to docs/models/sources3csvheaderdefinition.md index 126875f3..bca36eaa 100644 --- a/docs/models/shared/sources3csvheaderdefinition.md +++ b/docs/models/sources3csvheaderdefinition.md @@ -8,18 +8,18 @@ How headers will be defined. `User Provided` assumes the CSV does not have a hea ### SourceS3FromCSV ```python -sourceS3CSVHeaderDefinition: shared.SourceS3FromCSV = /* values here */ +sourceS3CSVHeaderDefinition: models.SourceS3FromCSV = /* values here */ ``` ### SourceS3Autogenerated ```python -sourceS3CSVHeaderDefinition: shared.SourceS3Autogenerated = /* values here */ +sourceS3CSVHeaderDefinition: models.SourceS3Autogenerated = /* values here */ ``` ### SourceS3UserProvided ```python -sourceS3CSVHeaderDefinition: shared.SourceS3UserProvided = /* values here */ +sourceS3CSVHeaderDefinition: models.SourceS3UserProvided = /* values here */ ``` diff --git a/docs/models/shared/sources3documentfiletypeformatexperimental.md b/docs/models/sources3documentfiletypeformatexperimental.md similarity index 95% rename from docs/models/shared/sources3documentfiletypeformatexperimental.md rename to docs/models/sources3documentfiletypeformatexperimental.md index 3751ce60..772d6898 100644 --- a/docs/models/shared/sources3documentfiletypeformatexperimental.md +++ b/docs/models/sources3documentfiletypeformatexperimental.md @@ -7,7 +7,7 @@ Extract text from document formats (.pdf, .docx, .md, .pptx) and emit as one rec | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `filetype` | [Optional[shared.SourceS3SchemasStreamsFormatFormat5Filetype]](../../models/shared/sources3schemasstreamsformatformat5filetype.md) | :heavy_minus_sign: | N/A | -| `processing` | [Optional[Union[shared.SourceS3Local]]](../../models/shared/sources3processing.md) | :heavy_minus_sign: | Processing configuration | +| `filetype` | [Optional[models.SourceS3SchemasStreamsFormatFormat5Filetype]](../models/sources3schemasstreamsformatformat5filetype.md) | :heavy_minus_sign: | N/A | +| `processing` | [Optional[Union[models.SourceS3Local]]](../models/sources3processing.md) | :heavy_minus_sign: | Processing configuration | | `skip_unprocessable_files` | *Optional[bool]* | :heavy_minus_sign: | If true, skip files that cannot be parsed and pass the error message along as the _ab_source_file_parse_error field. If false, fail the sync. | -| `strategy` | [Optional[shared.SourceS3ParsingStrategy]](../../models/shared/sources3parsingstrategy.md) | :heavy_minus_sign: | The strategy used to parse documents. `fast` extracts text directly from the document which doesn't work for all files. `ocr_only` is more reliable, but slower. `hi_res` is the most reliable, but requires an API key and a hosted instance of unstructured and can't be used with local mode. See the unstructured.io documentation for more details: https://unstructured-io.github.io/unstructured/core/partition.html#partition-pdf | \ No newline at end of file +| `strategy` | [Optional[models.SourceS3ParsingStrategy]](../models/sources3parsingstrategy.md) | :heavy_minus_sign: | The strategy used to parse documents. `fast` extracts text directly from the document which doesn't work for all files. `ocr_only` is more reliable, but slower. `hi_res` is the most reliable, but requires an API key and a hosted instance of unstructured and can't be used with local mode. See the unstructured.io documentation for more details: https://unstructured-io.github.io/unstructured/core/partition.html#partition-pdf | \ No newline at end of file diff --git a/docs/models/sources3filebasedstreamconfig.md b/docs/models/sources3filebasedstreamconfig.md new file mode 100644 index 00000000..c44ba718 --- /dev/null +++ b/docs/models/sources3filebasedstreamconfig.md @@ -0,0 +1,16 @@ +# SourceS3FileBasedStreamConfig + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `format` | [Union[models.SourceS3AvroFormat, models.SourceS3CSVFormat, models.SourceS3JsonlFormat, models.SourceS3ParquetFormat, models.SourceS3DocumentFileTypeFormatExperimental]](../models/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. | +| `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[models.SourceS3ValidationPolicy]](../models/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/sources3fileformat.md b/docs/models/sources3fileformat.md new file mode 100644 index 00000000..e9e8cd83 --- /dev/null +++ b/docs/models/sources3fileformat.md @@ -0,0 +1,31 @@ +# SourceS3FileFormat + +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 + + +## Supported Types + +### Csv + +```python +sourceS3FileFormat: models.Csv = /* values here */ +``` + +### Parquet + +```python +sourceS3FileFormat: models.Parquet = /* values here */ +``` + +### Avro + +```python +sourceS3FileFormat: models.Avro = /* values here */ +``` + +### Jsonl + +```python +sourceS3FileFormat: models.Jsonl = /* values here */ +``` + diff --git a/docs/models/shared/sources3filetype.md b/docs/models/sources3filetype.md similarity index 100% rename from docs/models/shared/sources3filetype.md rename to docs/models/sources3filetype.md diff --git a/docs/models/sources3format.md b/docs/models/sources3format.md new file mode 100644 index 00000000..6b577f85 --- /dev/null +++ b/docs/models/sources3format.md @@ -0,0 +1,37 @@ +# SourceS3Format + +The configuration options that are used to alter how to read incoming files that deviate from the standard formatting. + + +## Supported Types + +### SourceS3AvroFormat + +```python +sourceS3Format: models.SourceS3AvroFormat = /* values here */ +``` + +### SourceS3CSVFormat + +```python +sourceS3Format: models.SourceS3CSVFormat = /* values here */ +``` + +### SourceS3JsonlFormat + +```python +sourceS3Format: models.SourceS3JsonlFormat = /* values here */ +``` + +### SourceS3ParquetFormat + +```python +sourceS3Format: models.SourceS3ParquetFormat = /* values here */ +``` + +### SourceS3DocumentFileTypeFormatExperimental + +```python +sourceS3Format: models.SourceS3DocumentFileTypeFormatExperimental = /* values here */ +``` + diff --git a/docs/models/sources3fromcsv.md b/docs/models/sources3fromcsv.md new file mode 100644 index 00000000..c4fdcd69 --- /dev/null +++ b/docs/models/sources3fromcsv.md @@ -0,0 +1,8 @@ +# SourceS3FromCSV + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `header_definition_type` | [Optional[models.SourceS3HeaderDefinitionType]](../models/sources3headerdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sources3headerdefinitiontype.md b/docs/models/sources3headerdefinitiontype.md similarity index 100% rename from docs/models/shared/sources3headerdefinitiontype.md rename to docs/models/sources3headerdefinitiontype.md diff --git a/docs/models/shared/sources3inferencetype.md b/docs/models/sources3inferencetype.md similarity index 100% rename from docs/models/shared/sources3inferencetype.md rename to docs/models/sources3inferencetype.md diff --git a/docs/models/sources3jsonlformat.md b/docs/models/sources3jsonlformat.md new file mode 100644 index 00000000..0c7ad310 --- /dev/null +++ b/docs/models/sources3jsonlformat.md @@ -0,0 +1,8 @@ +# SourceS3JsonlFormat + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `filetype` | [Optional[models.SourceS3SchemasStreamsFormatFormatFiletype]](../models/sources3schemasstreamsformatformatfiletype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sources3local.md b/docs/models/sources3local.md new file mode 100644 index 00000000..b92d262a --- /dev/null +++ b/docs/models/sources3local.md @@ -0,0 +1,10 @@ +# SourceS3Local + +Process files locally, supporting `fast` and `ocr` modes. This is the default option. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `mode` | [Optional[models.SourceS3Mode]](../models/sources3mode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sources3mode.md b/docs/models/sources3mode.md similarity index 100% rename from docs/models/shared/sources3mode.md rename to docs/models/sources3mode.md diff --git a/docs/models/shared/sources3parquetformat.md b/docs/models/sources3parquetformat.md similarity index 91% rename from docs/models/shared/sources3parquetformat.md rename to docs/models/sources3parquetformat.md index 7c239204..6c035105 100644 --- a/docs/models/shared/sources3parquetformat.md +++ b/docs/models/sources3parquetformat.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `decimal_as_float` | *Optional[bool]* | :heavy_minus_sign: | Whether to convert decimal fields to floats. There is a loss of precision when converting decimals to floats, so this is not recommended. | -| `filetype` | [Optional[shared.SourceS3SchemasStreamsFormatFormat4Filetype]](../../models/shared/sources3schemasstreamsformatformat4filetype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `filetype` | [Optional[models.SourceS3SchemasStreamsFormatFormat4Filetype]](../models/sources3schemasstreamsformatformat4filetype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sources3parsingstrategy.md b/docs/models/sources3parsingstrategy.md similarity index 100% rename from docs/models/shared/sources3parsingstrategy.md rename to docs/models/sources3parsingstrategy.md diff --git a/docs/models/sources3processing.md b/docs/models/sources3processing.md new file mode 100644 index 00000000..a16a2a69 --- /dev/null +++ b/docs/models/sources3processing.md @@ -0,0 +1,13 @@ +# SourceS3Processing + +Processing configuration + + +## Supported Types + +### SourceS3Local + +```python +sourceS3Processing: models.SourceS3Local = /* values here */ +``` + diff --git a/docs/models/shared/sources3s3.md b/docs/models/sources3s3.md similarity index 100% rename from docs/models/shared/sources3s3.md rename to docs/models/sources3s3.md diff --git a/docs/models/shared/sources3schemasfiletype.md b/docs/models/sources3schemasfiletype.md similarity index 100% rename from docs/models/shared/sources3schemasfiletype.md rename to docs/models/sources3schemasfiletype.md diff --git a/docs/models/shared/sources3schemasformatfileformatfiletype.md b/docs/models/sources3schemasformatfileformatfiletype.md similarity index 100% rename from docs/models/shared/sources3schemasformatfileformatfiletype.md rename to docs/models/sources3schemasformatfileformatfiletype.md diff --git a/docs/models/shared/sources3schemasformatfiletype.md b/docs/models/sources3schemasformatfiletype.md similarity index 100% rename from docs/models/shared/sources3schemasformatfiletype.md rename to docs/models/sources3schemasformatfiletype.md diff --git a/docs/models/shared/sources3schemasheaderdefinitiontype.md b/docs/models/sources3schemasheaderdefinitiontype.md similarity index 100% rename from docs/models/shared/sources3schemasheaderdefinitiontype.md rename to docs/models/sources3schemasheaderdefinitiontype.md diff --git a/docs/models/shared/sources3schemasstreamsfiletype.md b/docs/models/sources3schemasstreamsfiletype.md similarity index 100% rename from docs/models/shared/sources3schemasstreamsfiletype.md rename to docs/models/sources3schemasstreamsfiletype.md diff --git a/docs/models/shared/sources3schemasstreamsformatfiletype.md b/docs/models/sources3schemasstreamsformatfiletype.md similarity index 100% rename from docs/models/shared/sources3schemasstreamsformatfiletype.md rename to docs/models/sources3schemasstreamsformatfiletype.md diff --git a/docs/models/shared/sources3schemasstreamsformatformat4filetype.md b/docs/models/sources3schemasstreamsformatformat4filetype.md similarity index 100% rename from docs/models/shared/sources3schemasstreamsformatformat4filetype.md rename to docs/models/sources3schemasstreamsformatformat4filetype.md diff --git a/docs/models/shared/sources3schemasstreamsformatformat5filetype.md b/docs/models/sources3schemasstreamsformatformat5filetype.md similarity index 100% rename from docs/models/shared/sources3schemasstreamsformatformat5filetype.md rename to docs/models/sources3schemasstreamsformatformat5filetype.md diff --git a/docs/models/shared/sources3schemasstreamsformatformatfiletype.md b/docs/models/sources3schemasstreamsformatformatfiletype.md similarity index 100% rename from docs/models/shared/sources3schemasstreamsformatformatfiletype.md rename to docs/models/sources3schemasstreamsformatformatfiletype.md diff --git a/docs/models/shared/sources3schemasstreamsheaderdefinitiontype.md b/docs/models/sources3schemasstreamsheaderdefinitiontype.md similarity index 100% rename from docs/models/shared/sources3schemasstreamsheaderdefinitiontype.md rename to docs/models/sources3schemasstreamsheaderdefinitiontype.md diff --git a/docs/models/sources3userprovided.md b/docs/models/sources3userprovided.md new file mode 100644 index 00000000..7f5ef6a6 --- /dev/null +++ b/docs/models/sources3userprovided.md @@ -0,0 +1,9 @@ +# SourceS3UserProvided + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `column_names` | List[*str*] | :heavy_check_mark: | The column names that will be used while emitting the CSV records | +| `header_definition_type` | [Optional[models.SourceS3SchemasStreamsHeaderDefinitionType]](../models/sources3schemasstreamsheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sources3validationpolicy.md b/docs/models/sources3validationpolicy.md similarity index 100% rename from docs/models/shared/sources3validationpolicy.md rename to docs/models/sources3validationpolicy.md diff --git a/docs/models/shared/sourcesalesforce.md b/docs/models/sourcesalesforce.md similarity index 89% rename from docs/models/shared/sourcesalesforce.md rename to docs/models/sourcesalesforce.md index 8d21818c..b0af206c 100644 --- a/docs/models/shared/sourcesalesforce.md +++ b/docs/models/sourcesalesforce.md @@ -8,9 +8,10 @@ | `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 | | +| `auth_type` | [Optional[models.AuthType]](../models/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 | | -| `source_type` | [shared.SourceSalesforceSalesforce](../../models/shared/sourcesalesforcesalesforce.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.SourceSalesforceSalesforce](../models/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 +| `stream_slice_step` | *Optional[str]* | :heavy_minus_sign: | The size of the time window (ISO8601 duration) to slice requests. | PT12H | +| `streams_criteria` | List[[models.StreamsCriteria](../models/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/sourcesalesforcesalesforce.md b/docs/models/sourcesalesforcesalesforce.md similarity index 100% rename from docs/models/shared/sourcesalesforcesalesforce.md rename to docs/models/sourcesalesforcesalesforce.md diff --git a/docs/models/shared/sourcesalesloft.md b/docs/models/sourcesalesloft.md similarity index 92% rename from docs/models/shared/sourcesalesloft.md rename to docs/models/sourcesalesloft.md index d00ec169..4cee82a4 100644 --- a/docs/models/shared/sourcesalesloft.md +++ b/docs/models/sourcesalesloft.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `credentials` | [Union[shared.AuthenticateViaOAuth, shared.AuthenticateViaAPIKey]](../../models/shared/sourcesalesloftcredentials.md) | :heavy_check_mark: | N/A | | +| `credentials` | [Union[models.AuthenticateViaOAuth, models.AuthenticateViaAPIKey]](../models/sourcesalesloftcredentials.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 | -| `source_type` | [shared.Salesloft](../../models/shared/salesloft.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `source_type` | [models.Salesloft](../models/salesloft.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcesalesloftauthtype.md b/docs/models/sourcesalesloftauthtype.md similarity index 100% rename from docs/models/shared/sourcesalesloftauthtype.md rename to docs/models/sourcesalesloftauthtype.md diff --git a/docs/models/sourcesalesloftcredentials.md b/docs/models/sourcesalesloftcredentials.md new file mode 100644 index 00000000..874edda2 --- /dev/null +++ b/docs/models/sourcesalesloftcredentials.md @@ -0,0 +1,17 @@ +# SourceSalesloftCredentials + + +## Supported Types + +### AuthenticateViaOAuth + +```python +sourceSalesloftCredentials: models.AuthenticateViaOAuth = /* values here */ +``` + +### AuthenticateViaAPIKey + +```python +sourceSalesloftCredentials: models.AuthenticateViaAPIKey = /* values here */ +``` + diff --git a/docs/models/shared/sourcesalesloftschemasauthtype.md b/docs/models/sourcesalesloftschemasauthtype.md similarity index 100% rename from docs/models/shared/sourcesalesloftschemasauthtype.md rename to docs/models/sourcesalesloftschemasauthtype.md diff --git a/docs/models/sourcesapfieldglass.md b/docs/models/sourcesapfieldglass.md new file mode 100644 index 00000000..12f010a0 --- /dev/null +++ b/docs/models/sourcesapfieldglass.md @@ -0,0 +1,9 @@ +# SourceSapFieldglass + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | +| `api_key` | *str* | :heavy_check_mark: | API Key | +| `source_type` | [models.SapFieldglass](../models/sapfieldglass.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcesecoda.md b/docs/models/sourcesecoda.md similarity index 93% rename from docs/models/shared/sourcesecoda.md rename to docs/models/sourcesecoda.md index ae1ffa57..062389b2 100644 --- a/docs/models/shared/sourcesecoda.md +++ b/docs/models/sourcesecoda.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | | `api_key` | *str* | :heavy_check_mark: | Your API Access Key. See here. The key is case sensitive. | -| `source_type` | [shared.Secoda](../../models/shared/secoda.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `source_type` | [models.Secoda](../models/secoda.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcesendgrid.md b/docs/models/sourcesendgrid.md similarity index 95% rename from docs/models/shared/sourcesendgrid.md rename to docs/models/sourcesendgrid.md index 0210ffd0..a996e927 100644 --- a/docs/models/shared/sourcesendgrid.md +++ b/docs/models/sourcesendgrid.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | | `apikey` | *str* | :heavy_check_mark: | API Key, use admin to generate this key. | | -| `source_type` | [shared.Sendgrid](../../models/shared/sendgrid.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.Sendgrid](../models/sendgrid.md) | :heavy_check_mark: | N/A | | | `start_time` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Start time in ISO8601 format. Any data before this time point will not be replicated. | 2020-01-01T01:01:01Z | \ No newline at end of file diff --git a/docs/models/shared/sourcesendinblue.md b/docs/models/sourcesendinblue.md similarity index 91% rename from docs/models/shared/sourcesendinblue.md rename to docs/models/sourcesendinblue.md index ac0a1f91..cb773231 100644 --- a/docs/models/shared/sourcesendinblue.md +++ b/docs/models/sourcesendinblue.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | Your API Key. See here. | -| `source_type` | [shared.Sendinblue](../../models/shared/sendinblue.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `source_type` | [models.Sendinblue](../models/sendinblue.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcesenseforce.md b/docs/models/sourcesenseforce.md similarity index 99% rename from docs/models/shared/sourcesenseforce.md rename to docs/models/sourcesenseforce.md index 420fb5dc..f8eae00d 100644 --- a/docs/models/shared/sourcesenseforce.md +++ b/docs/models/sourcesenseforce.md @@ -10,4 +10,4 @@ | `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 | | \ No newline at end of file +| `source_type` | [models.Senseforce](../models/senseforce.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcesentry.md b/docs/models/sourcesentry.md similarity index 99% rename from docs/models/shared/sourcesentry.md rename to docs/models/sourcesentry.md index 10a11393..5117bfeb 100644 --- a/docs/models/shared/sourcesentry.md +++ b/docs/models/sourcesentry.md @@ -10,4 +10,4 @@ | `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 +| `source_type` | [models.Sentry](../models/sentry.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcesftp.md b/docs/models/sourcesftp.md new file mode 100644 index 00000000..e9acafad --- /dev/null +++ b/docs/models/sourcesftp.md @@ -0,0 +1,15 @@ +# SourceSftp + + +## Fields + +| 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[models.SourceSftpPasswordAuthentication, models.SourceSftpSSHKeyAuthentication]]](../models/sourcesftpauthentication.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 | +| `port` | *Optional[int]* | :heavy_minus_sign: | The server port | 22 | +| `source_type` | [models.Sftp](../models/sftp.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/sourcesftpauthentication.md b/docs/models/sourcesftpauthentication.md new file mode 100644 index 00000000..e70069db --- /dev/null +++ b/docs/models/sourcesftpauthentication.md @@ -0,0 +1,19 @@ +# SourceSftpAuthentication + +The server authentication method + + +## Supported Types + +### SourceSftpPasswordAuthentication + +```python +sourceSftpAuthentication: models.SourceSftpPasswordAuthentication = /* values here */ +``` + +### SourceSftpSSHKeyAuthentication + +```python +sourceSftpAuthentication: models.SourceSftpSSHKeyAuthentication = /* values here */ +``` + diff --git a/docs/models/shared/sourcesftpauthmethod.md b/docs/models/sourcesftpauthmethod.md similarity index 100% rename from docs/models/shared/sourcesftpauthmethod.md rename to docs/models/sourcesftpauthmethod.md diff --git a/docs/models/shared/sourcesftpbulk.md b/docs/models/sourcesftpbulk.md similarity index 98% rename from docs/models/shared/sourcesftpbulk.md rename to docs/models/sourcesftpbulk.md index 927f9f20..bea2789b 100644 --- a/docs/models/shared/sourcesftpbulk.md +++ b/docs/models/sourcesftpbulk.md @@ -11,10 +11,10 @@ | `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 | +| `file_type` | [Optional[models.FileType]](../models/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 | | `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 | | \ No newline at end of file +| `source_type` | [models.SftpBulk](../models/sftpbulk.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/sourcesftppasswordauthentication.md b/docs/models/sourcesftppasswordauthentication.md new file mode 100644 index 00000000..136e0b65 --- /dev/null +++ b/docs/models/sourcesftppasswordauthentication.md @@ -0,0 +1,9 @@ +# SourceSftpPasswordAuthentication + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | +| `auth_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | +| `auth_method` | [models.SourceSftpAuthMethod](../models/sourcesftpauthmethod.md) | :heavy_check_mark: | Connect through password authentication | \ No newline at end of file diff --git a/docs/models/shared/sourcesftpschemasauthmethod.md b/docs/models/sourcesftpschemasauthmethod.md similarity index 100% rename from docs/models/shared/sourcesftpschemasauthmethod.md rename to docs/models/sourcesftpschemasauthmethod.md diff --git a/docs/models/shared/sourcesftpsshkeyauthentication.md b/docs/models/sourcesftpsshkeyauthentication.md similarity index 90% rename from docs/models/shared/sourcesftpsshkeyauthentication.md rename to docs/models/sourcesftpsshkeyauthentication.md index 2dfb2801..d35c38d3 100644 --- a/docs/models/shared/sourcesftpsshkeyauthentication.md +++ b/docs/models/sourcesftpsshkeyauthentication.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | `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 +| `auth_method` | [models.SourceSftpSchemasAuthMethod](../models/sourcesftpschemasauthmethod.md) | :heavy_check_mark: | Connect through ssh key | \ No newline at end of file diff --git a/docs/models/sourceshopify.md b/docs/models/sourceshopify.md new file mode 100644 index 00000000..d81168c4 --- /dev/null +++ b/docs/models/sourceshopify.md @@ -0,0 +1,13 @@ +# SourceShopify + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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 | +| `bulk_window_in_days` | *Optional[int]* | :heavy_minus_sign: | Defines what would be a date range per single BULK Job | | +| `credentials` | [Optional[Union[models.SourceShopifyOAuth20, models.APIPassword]]](../models/shopifyauthorizationmethod.md) | :heavy_minus_sign: | The authorization method to use to retrieve data from Shopify | | +| `fetch_transactions_user_id` | *Optional[bool]* | :heavy_minus_sign: | Defines which API type (REST/BULK) to use to fetch `Transactions` data. If you are a `Shopify Plus` user, leave the default value to speed up the fetch. | | +| `source_type` | [models.SourceShopifyShopify](../models/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/sourceshopifyauthmethod.md b/docs/models/sourceshopifyauthmethod.md similarity index 100% rename from docs/models/shared/sourceshopifyauthmethod.md rename to docs/models/sourceshopifyauthmethod.md diff --git a/docs/models/sourceshopifyoauth20.md b/docs/models/sourceshopifyoauth20.md new file mode 100644 index 00000000..89efba6c --- /dev/null +++ b/docs/models/sourceshopifyoauth20.md @@ -0,0 +1,13 @@ +# SourceShopifyOAuth20 + +OAuth2.0 + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `access_token` | *Optional[str]* | :heavy_minus_sign: | The Access Token for making authenticated requests. | +| `auth_method` | [models.SourceShopifyAuthMethod](../models/sourceshopifyauthmethod.md) | :heavy_check_mark: | N/A | +| `client_id` | *Optional[str]* | :heavy_minus_sign: | The Client ID of the Shopify developer application. | +| `client_secret` | *Optional[str]* | :heavy_minus_sign: | The Client Secret of the Shopify developer application. | \ No newline at end of file diff --git a/docs/models/shared/sourceshopifyschemasauthmethod.md b/docs/models/sourceshopifyschemasauthmethod.md similarity index 100% rename from docs/models/shared/sourceshopifyschemasauthmethod.md rename to docs/models/sourceshopifyschemasauthmethod.md diff --git a/docs/models/shared/sourceshopifyshopify.md b/docs/models/sourceshopifyshopify.md similarity index 100% rename from docs/models/shared/sourceshopifyshopify.md rename to docs/models/sourceshopifyshopify.md diff --git a/docs/models/shared/sourceshortio.md b/docs/models/sourceshortio.md similarity index 96% rename from docs/models/shared/sourceshortio.md rename to docs/models/sourceshortio.md index dadac010..7c28c04d 100644 --- a/docs/models/shared/sourceshortio.md +++ b/docs/models/sourceshortio.md @@ -8,4 +8,4 @@ | `domain_id` | *str* | :heavy_check_mark: | N/A | | | `secret_key` | *str* | :heavy_check_mark: | Short.io Secret Key | | | `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 +| `source_type` | [models.Shortio](../models/shortio.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceslack.md b/docs/models/sourceslack.md similarity index 95% rename from docs/models/shared/sourceslack.md rename to docs/models/sourceslack.md index 5fb2fbb5..3af0a32c 100644 --- a/docs/models/shared/sourceslack.md +++ b/docs/models/sourceslack.md @@ -7,7 +7,7 @@ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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 | | +| `credentials` | [Optional[Union[models.SignInViaSlackOAuth, models.SourceSlackAPIToken]]](../models/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 | | \ No newline at end of file +| `source_type` | [models.SourceSlackSlack](../models/sourceslackslack.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceslackapitoken.md b/docs/models/sourceslackapitoken.md similarity index 94% rename from docs/models/shared/sourceslackapitoken.md rename to docs/models/sourceslackapitoken.md index 97ec39d8..2a00cd7b 100644 --- a/docs/models/shared/sourceslackapitoken.md +++ b/docs/models/sourceslackapitoken.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `api_token` | *str* | :heavy_check_mark: | A Slack bot token. See the docs for instructions on how to generate it. | -| `option_title` | [shared.SourceSlackSchemasOptionTitle](../../models/shared/sourceslackschemasoptiontitle.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `option_title` | [models.SourceSlackSchemasOptionTitle](../models/sourceslackschemasoptiontitle.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourceslackauthenticationmechanism.md b/docs/models/sourceslackauthenticationmechanism.md new file mode 100644 index 00000000..1d22c6f0 --- /dev/null +++ b/docs/models/sourceslackauthenticationmechanism.md @@ -0,0 +1,19 @@ +# SourceSlackAuthenticationMechanism + +Choose how to authenticate into Slack + + +## Supported Types + +### SignInViaSlackOAuth + +```python +sourceSlackAuthenticationMechanism: models.SignInViaSlackOAuth = /* values here */ +``` + +### SourceSlackAPIToken + +```python +sourceSlackAuthenticationMechanism: models.SourceSlackAPIToken = /* values here */ +``` + diff --git a/docs/models/shared/sourceslackoptiontitle.md b/docs/models/sourceslackoptiontitle.md similarity index 100% rename from docs/models/shared/sourceslackoptiontitle.md rename to docs/models/sourceslackoptiontitle.md diff --git a/docs/models/shared/sourceslackschemasoptiontitle.md b/docs/models/sourceslackschemasoptiontitle.md similarity index 100% rename from docs/models/shared/sourceslackschemasoptiontitle.md rename to docs/models/sourceslackschemasoptiontitle.md diff --git a/docs/models/shared/sourceslackslack.md b/docs/models/sourceslackslack.md similarity index 100% rename from docs/models/shared/sourceslackslack.md rename to docs/models/sourceslackslack.md diff --git a/docs/models/shared/sourcesmaily.md b/docs/models/sourcesmaily.md similarity index 96% rename from docs/models/shared/sourcesmaily.md rename to docs/models/sourcesmaily.md index 54dc4160..3154f4aa 100644 --- a/docs/models/shared/sourcesmaily.md +++ b/docs/models/sourcesmaily.md @@ -8,4 +8,4 @@ | `api_password` | *str* | :heavy_check_mark: | API user password. See https://smaily.com/help/api/general/create-api-user/ | | `api_subdomain` | *str* | :heavy_check_mark: | API Subdomain. See https://smaily.com/help/api/general/create-api-user/ | | `api_username` | *str* | :heavy_check_mark: | API user username. See https://smaily.com/help/api/general/create-api-user/ | -| `source_type` | [shared.Smaily](../../models/shared/smaily.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `source_type` | [models.Smaily](../models/smaily.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcesmartengage.md b/docs/models/sourcesmartengage.md new file mode 100644 index 00000000..bae5b127 --- /dev/null +++ b/docs/models/sourcesmartengage.md @@ -0,0 +1,9 @@ +# SourceSmartengage + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| `api_key` | *str* | :heavy_check_mark: | API Key | +| `source_type` | [models.Smartengage](../models/smartengage.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcesmartsheets.md b/docs/models/sourcesmartsheets.md similarity index 90% rename from docs/models/shared/sourcesmartsheets.md rename to docs/models/sourcesmartsheets.md index 266d7c7f..db8f7c36 100644 --- a/docs/models/shared/sourcesmartsheets.md +++ b/docs/models/sourcesmartsheets.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `credentials` | [Union[shared.SourceSmartsheetsOAuth20, shared.APIAccessToken]](../../models/shared/sourcesmartsheetsauthorizationmethod.md) | :heavy_check_mark: | N/A | | +| `credentials` | [Union[models.SourceSmartsheetsOAuth20, models.APIAccessToken]](../models/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 | | +| `metadata_fields` | List[[models.Validenums](../models/validenums.md)] | :heavy_minus_sign: | A List of available columns which metadata can be pulled from. | | +| `source_type` | [models.SourceSmartsheetsSmartsheets](../models/sourcesmartsheetssmartsheets.md) | :heavy_check_mark: | N/A | | | `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/sourcesmartsheetsauthorizationmethod.md b/docs/models/sourcesmartsheetsauthorizationmethod.md new file mode 100644 index 00000000..db47be1c --- /dev/null +++ b/docs/models/sourcesmartsheetsauthorizationmethod.md @@ -0,0 +1,17 @@ +# SourceSmartsheetsAuthorizationMethod + + +## Supported Types + +### SourceSmartsheetsOAuth20 + +```python +sourceSmartsheetsAuthorizationMethod: models.SourceSmartsheetsOAuth20 = /* values here */ +``` + +### APIAccessToken + +```python +sourceSmartsheetsAuthorizationMethod: models.APIAccessToken = /* values here */ +``` + diff --git a/docs/models/shared/sourcesmartsheetsauthtype.md b/docs/models/sourcesmartsheetsauthtype.md similarity index 100% rename from docs/models/shared/sourcesmartsheetsauthtype.md rename to docs/models/sourcesmartsheetsauthtype.md diff --git a/docs/models/sourcesmartsheetsoauth20.md b/docs/models/sourcesmartsheetsoauth20.md new file mode 100644 index 00000000..211c13e3 --- /dev/null +++ b/docs/models/sourcesmartsheetsoauth20.md @@ -0,0 +1,13 @@ +# SourceSmartsheetsOAuth20 + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `access_token` | *str* | :heavy_check_mark: | Access Token for making authenticated requests. | +| `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. | +| `auth_type` | [Optional[models.SourceSmartsheetsAuthType]](../models/sourcesmartsheetsauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcesmartsheetsschemasauthtype.md b/docs/models/sourcesmartsheetsschemasauthtype.md similarity index 100% rename from docs/models/shared/sourcesmartsheetsschemasauthtype.md rename to docs/models/sourcesmartsheetsschemasauthtype.md diff --git a/docs/models/shared/sourcesmartsheetssmartsheets.md b/docs/models/sourcesmartsheetssmartsheets.md similarity index 100% rename from docs/models/shared/sourcesmartsheetssmartsheets.md rename to docs/models/sourcesmartsheetssmartsheets.md diff --git a/docs/models/sourcesnapchatmarketing.md b/docs/models/sourcesnapchatmarketing.md new file mode 100644 index 00000000..460c7374 --- /dev/null +++ b/docs/models/sourcesnapchatmarketing.md @@ -0,0 +1,16 @@ +# SourceSnapchatMarketing + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `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. | | +| `refresh_token` | *str* | :heavy_check_mark: | Refresh Token to renew the expired Access Token. | | +| `action_report_time` | [Optional[models.ActionReportTime]](../models/actionreporttime.md) | :heavy_minus_sign: | Specifies the principle for conversion reporting. | | +| `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` | [models.SourceSnapchatMarketingSnapchatMarketing](../models/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 | +| `swipe_up_attribution_window` | [Optional[models.SwipeUpAttributionWindow]](../models/swipeupattributionwindow.md) | :heavy_minus_sign: | Attribution window for swipe ups. | | +| `view_attribution_window` | [Optional[models.ViewAttributionWindow]](../models/viewattributionwindow.md) | :heavy_minus_sign: | Attribution window for views. | | \ No newline at end of file diff --git a/docs/models/shared/sourcesnapchatmarketingsnapchatmarketing.md b/docs/models/sourcesnapchatmarketingsnapchatmarketing.md similarity index 100% rename from docs/models/shared/sourcesnapchatmarketingsnapchatmarketing.md rename to docs/models/sourcesnapchatmarketingsnapchatmarketing.md diff --git a/docs/models/shared/sourcesnowflake.md b/docs/models/sourcesnowflake.md similarity index 96% rename from docs/models/shared/sourcesnowflake.md rename to docs/models/sourcesnowflake.md index faae3492..20b87f5d 100644 --- a/docs/models/shared/sourcesnowflake.md +++ b/docs/models/sourcesnowflake.md @@ -9,7 +9,7 @@ | `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 | | `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 | | +| `credentials` | [Optional[Union[models.SourceSnowflakeOAuth20, models.SourceSnowflakeUsernameAndPassword]]](../models/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 | | \ No newline at end of file +| `source_type` | [models.SourceSnowflakeSnowflake](../models/sourcesnowflakesnowflake.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/sourcesnowflakeauthorizationmethod.md b/docs/models/sourcesnowflakeauthorizationmethod.md new file mode 100644 index 00000000..87f2e641 --- /dev/null +++ b/docs/models/sourcesnowflakeauthorizationmethod.md @@ -0,0 +1,17 @@ +# SourceSnowflakeAuthorizationMethod + + +## Supported Types + +### SourceSnowflakeOAuth20 + +```python +sourceSnowflakeAuthorizationMethod: models.SourceSnowflakeOAuth20 = /* values here */ +``` + +### SourceSnowflakeUsernameAndPassword + +```python +sourceSnowflakeAuthorizationMethod: models.SourceSnowflakeUsernameAndPassword = /* values here */ +``` + diff --git a/docs/models/shared/sourcesnowflakeauthtype.md b/docs/models/sourcesnowflakeauthtype.md similarity index 100% rename from docs/models/shared/sourcesnowflakeauthtype.md rename to docs/models/sourcesnowflakeauthtype.md diff --git a/docs/models/sourcesnowflakeoauth20.md b/docs/models/sourcesnowflakeoauth20.md new file mode 100644 index 00000000..b4776531 --- /dev/null +++ b/docs/models/sourcesnowflakeoauth20.md @@ -0,0 +1,12 @@ +# SourceSnowflakeOAuth20 + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `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` | [models.SourceSnowflakeAuthType](../models/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/sourcesnowflakeschemasauthtype.md b/docs/models/sourcesnowflakeschemasauthtype.md similarity index 100% rename from docs/models/shared/sourcesnowflakeschemasauthtype.md rename to docs/models/sourcesnowflakeschemasauthtype.md diff --git a/docs/models/shared/sourcesnowflakesnowflake.md b/docs/models/sourcesnowflakesnowflake.md similarity index 100% rename from docs/models/shared/sourcesnowflakesnowflake.md rename to docs/models/sourcesnowflakesnowflake.md diff --git a/docs/models/sourcesnowflakeusernameandpassword.md b/docs/models/sourcesnowflakeusernameandpassword.md new file mode 100644 index 00000000..4a867e75 --- /dev/null +++ b/docs/models/sourcesnowflakeusernameandpassword.md @@ -0,0 +1,10 @@ +# SourceSnowflakeUsernameAndPassword + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `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 | +| `auth_type` | [models.SourceSnowflakeSchemasAuthType](../models/sourcesnowflakeschemasauthtype.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcesonarcloud.md b/docs/models/sourcesonarcloud.md similarity index 98% rename from docs/models/shared/sourcesonarcloud.md rename to docs/models/sourcesonarcloud.md index 0b5e1b04..87ce6b85 100644 --- a/docs/models/shared/sourcesonarcloud.md +++ b/docs/models/sourcesonarcloud.md @@ -9,5 +9,5 @@ | `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 | | +| `source_type` | [models.SonarCloud](../models/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 | \ No newline at end of file diff --git a/docs/models/sourcespacexapi.md b/docs/models/sourcespacexapi.md new file mode 100644 index 00000000..c891e6d5 --- /dev/null +++ b/docs/models/sourcespacexapi.md @@ -0,0 +1,10 @@ +# SourceSpacexAPI + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `options` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `source_type` | [models.SpacexAPI](../models/spacexapi.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcesquare.md b/docs/models/sourcesquare.md similarity index 92% rename from docs/models/shared/sourcesquare.md rename to docs/models/sourcesquare.md index e12fa775..fe4118fd 100644 --- a/docs/models/shared/sourcesquare.md +++ b/docs/models/sourcesquare.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `credentials` | [Optional[Union[shared.OauthAuthentication, shared.SourceSquareAPIKey]]](../../models/shared/sourcesquareauthentication.md) | :heavy_minus_sign: | Choose how to authenticate to Square. | +| `credentials` | [Optional[Union[models.OauthAuthentication, models.SourceSquareAPIKey]]](../models/sourcesquareauthentication.md) | :heavy_minus_sign: | Choose how to authenticate to Square. | | `include_deleted_objects` | *Optional[bool]* | :heavy_minus_sign: | In some streams there is an option to include deleted objects (Items, Categories, Discounts, Taxes) | | `is_sandbox` | *Optional[bool]* | :heavy_minus_sign: | Determines whether to use the sandbox or production environment. | -| `source_type` | [shared.SourceSquareSquare](../../models/shared/sourcesquaresquare.md) | :heavy_check_mark: | N/A | +| `source_type` | [models.SourceSquareSquare](../models/sourcesquaresquare.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. If not set, all data will be replicated. | \ No newline at end of file diff --git a/docs/models/sourcesquareapikey.md b/docs/models/sourcesquareapikey.md new file mode 100644 index 00000000..ba6491c7 --- /dev/null +++ b/docs/models/sourcesquareapikey.md @@ -0,0 +1,9 @@ +# SourceSquareAPIKey + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `api_key` | *str* | :heavy_check_mark: | The API key for a Square application | +| `auth_type` | [models.SourceSquareSchemasAuthType](../models/sourcesquareschemasauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcesquareauthentication.md b/docs/models/sourcesquareauthentication.md new file mode 100644 index 00000000..1a7f119e --- /dev/null +++ b/docs/models/sourcesquareauthentication.md @@ -0,0 +1,19 @@ +# SourceSquareAuthentication + +Choose how to authenticate to Square. + + +## Supported Types + +### OauthAuthentication + +```python +sourceSquareAuthentication: models.OauthAuthentication = /* values here */ +``` + +### SourceSquareAPIKey + +```python +sourceSquareAuthentication: models.SourceSquareAPIKey = /* values here */ +``` + diff --git a/docs/models/shared/sourcesquareauthtype.md b/docs/models/sourcesquareauthtype.md similarity index 100% rename from docs/models/shared/sourcesquareauthtype.md rename to docs/models/sourcesquareauthtype.md diff --git a/docs/models/shared/sourcesquareschemasauthtype.md b/docs/models/sourcesquareschemasauthtype.md similarity index 100% rename from docs/models/shared/sourcesquareschemasauthtype.md rename to docs/models/sourcesquareschemasauthtype.md diff --git a/docs/models/shared/sourcesquaresquare.md b/docs/models/sourcesquaresquare.md similarity index 100% rename from docs/models/shared/sourcesquaresquare.md rename to docs/models/sourcesquaresquare.md diff --git a/docs/models/sourcesresponse.md b/docs/models/sourcesresponse.md new file mode 100644 index 00000000..251a0706 --- /dev/null +++ b/docs/models/sourcesresponse.md @@ -0,0 +1,10 @@ +# SourcesResponse + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `data` | List[[models.SourceResponse](../models/sourceresponse.md)] | :heavy_check_mark: | N/A | +| `next` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `previous` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourcestrava.md b/docs/models/sourcestrava.md new file mode 100644 index 00000000..15d027e9 --- /dev/null +++ b/docs/models/sourcestrava.md @@ -0,0 +1,14 @@ +# SourceStrava + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `athlete_id` | *int* | :heavy_check_mark: | The Athlete ID of your Strava developer application. | 17831421 | +| `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 | +| `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[models.SourceStravaAuthType]](../models/sourcestravaauthtype.md) | :heavy_minus_sign: | N/A | | +| `source_type` | [models.SourceStravaStrava](../models/sourcestravastrava.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcestravaauthtype.md b/docs/models/sourcestravaauthtype.md similarity index 100% rename from docs/models/shared/sourcestravaauthtype.md rename to docs/models/sourcestravaauthtype.md diff --git a/docs/models/shared/sourcestravastrava.md b/docs/models/sourcestravastrava.md similarity index 100% rename from docs/models/shared/sourcestravastrava.md rename to docs/models/sourcestravastrava.md diff --git a/docs/models/shared/sourcestripe.md b/docs/models/sourcestripe.md similarity index 99% rename from docs/models/shared/sourcestripe.md rename to docs/models/sourcestripe.md index c48c18cd..dd31d487 100644 --- a/docs/models/shared/sourcestripe.md +++ b/docs/models/sourcestripe.md @@ -11,5 +11,5 @@ | `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 | -| `source_type` | [shared.Stripe](../../models/shared/stripe.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.Stripe](../models/stripe.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:00Z. Only data generated after this date will be replicated. | 2017-01-25T00:00:00Z | \ No newline at end of file diff --git a/docs/models/shared/sourcesurveymonkey.md b/docs/models/sourcesurveymonkey.md similarity index 89% rename from docs/models/shared/sourcesurveymonkey.md rename to docs/models/sourcesurveymonkey.md index 3df2f871..8b244e67 100644 --- a/docs/models/shared/sourcesurveymonkey.md +++ b/docs/models/sourcesurveymonkey.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `credentials` | [models.SurveyMonkeyAuthorizationMethod](../models/surveymonkeyauthorizationmethod.md) | :heavy_check_mark: | The authorization method to use to retrieve data from SurveyMonkey | | | `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 | | +| `origin` | [Optional[models.OriginDatacenterOfTheSurveyMonkeyAccount]](../models/origindatacenterofthesurveymonkeyaccount.md) | :heavy_minus_sign: | Depending on the originating datacenter of the SurveyMonkey account, the API access URL may be different. | | +| `source_type` | [models.SourceSurveymonkeySurveymonkey](../models/sourcesurveymonkeysurveymonkey.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 boards to which you have access will be replicated. | | \ No newline at end of file diff --git a/docs/models/shared/sourcesurveymonkeyauthmethod.md b/docs/models/sourcesurveymonkeyauthmethod.md similarity index 100% rename from docs/models/shared/sourcesurveymonkeyauthmethod.md rename to docs/models/sourcesurveymonkeyauthmethod.md diff --git a/docs/models/shared/sourcesurveymonkeysurveymonkey.md b/docs/models/sourcesurveymonkeysurveymonkey.md similarity index 100% rename from docs/models/shared/sourcesurveymonkeysurveymonkey.md rename to docs/models/sourcesurveymonkeysurveymonkey.md diff --git a/docs/models/shared/sourcesurveysparrow.md b/docs/models/sourcesurveysparrow.md similarity index 92% rename from docs/models/shared/sourcesurveysparrow.md rename to docs/models/sourcesurveysparrow.md index ca3a1f21..57d95b10 100644 --- a/docs/models/shared/sourcesurveysparrow.md +++ b/docs/models/sourcesurveysparrow.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | `access_token` | *str* | :heavy_check_mark: | Your access token. See here. The key is case sensitive. | -| `region` | [Optional[Union[shared.EUBasedAccount, shared.GlobalAccount]]](../../models/shared/baseurl.md) | :heavy_minus_sign: | Is your account location is EU based? If yes, the base url to retrieve data will be different. | -| `source_type` | [shared.SurveySparrow](../../models/shared/surveysparrow.md) | :heavy_check_mark: | N/A | +| `region` | [Optional[Union[models.EUBasedAccount, models.GlobalAccount]]](../models/baseurl.md) | :heavy_minus_sign: | Is your account location is EU based? If yes, the base url to retrieve data will be different. | +| `source_type` | [models.SurveySparrow](../models/surveysparrow.md) | :heavy_check_mark: | N/A | | `survey_id` | List[*Any*] | :heavy_minus_sign: | A List of your survey ids for survey-specific stream | \ No newline at end of file diff --git a/docs/models/shared/sourcesurveysparrowurlbase.md b/docs/models/sourcesurveysparrowurlbase.md similarity index 100% rename from docs/models/shared/sourcesurveysparrowurlbase.md rename to docs/models/sourcesurveysparrowurlbase.md diff --git a/docs/models/shared/sourcetempo.md b/docs/models/sourcetempo.md similarity index 91% rename from docs/models/shared/sourcetempo.md rename to docs/models/sourcetempo.md index 74d7f887..76721a2f 100644 --- a/docs/models/shared/sourcetempo.md +++ b/docs/models/sourcetempo.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | | `api_token` | *str* | :heavy_check_mark: | Tempo API Token. Go to Tempo>Settings, scroll down to Data Access and select API integration. | -| `source_type` | [shared.Tempo](../../models/shared/tempo.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `source_type` | [models.Tempo](../models/tempo.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcetheguardianapi.md b/docs/models/sourcetheguardianapi.md similarity index 99% rename from docs/models/shared/sourcetheguardianapi.md rename to docs/models/sourcetheguardianapi.md index a92d8189..e799ddaf 100644 --- a/docs/models/shared/sourcetheguardianapi.md +++ b/docs/models/sourcetheguardianapi.md @@ -10,5 +10,5 @@ | `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 | | +| `source_type` | [models.TheGuardianAPI](../models/theguardianapi.md) | :heavy_check_mark: | N/A | | | `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/sourcetiktokmarketing.md b/docs/models/sourcetiktokmarketing.md similarity index 96% rename from docs/models/shared/sourcetiktokmarketing.md rename to docs/models/sourcetiktokmarketing.md index 0a004afc..a21b742e 100644 --- a/docs/models/shared/sourcetiktokmarketing.md +++ b/docs/models/sourcetiktokmarketing.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `attribution_window` | *Optional[int]* | :heavy_minus_sign: | The attribution window in days. | -| `credentials` | [Optional[Union[shared.SourceTiktokMarketingOAuth20, shared.SandboxAccessToken]]](../../models/shared/sourcetiktokmarketingauthenticationmethod.md) | :heavy_minus_sign: | Authentication method | +| `credentials` | [Optional[Union[models.SourceTiktokMarketingOAuth20, models.SandboxAccessToken]]](../models/sourcetiktokmarketingauthenticationmethod.md) | :heavy_minus_sign: | Authentication method | | `end_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date until which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DD. All data generated between start_date and this date will be replicated. Not setting this option will result in always syncing the data till the current date. | | `include_deleted` | *Optional[bool]* | :heavy_minus_sign: | Set to active if you want to include deleted data in reports. | -| `source_type` | [Optional[shared.SourceTiktokMarketingTiktokMarketing]](../../models/shared/sourcetiktokmarketingtiktokmarketing.md) | :heavy_minus_sign: | N/A | +| `source_type` | [Optional[models.SourceTiktokMarketingTiktokMarketing]](../models/sourcetiktokmarketingtiktokmarketing.md) | :heavy_minus_sign: | N/A | | `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The Start Date in format: YYYY-MM-DD. Any data before this date will not be replicated. If this parameter is not set, all data will be replicated. | \ No newline at end of file diff --git a/docs/models/sourcetiktokmarketingauthenticationmethod.md b/docs/models/sourcetiktokmarketingauthenticationmethod.md new file mode 100644 index 00000000..3eb09e1e --- /dev/null +++ b/docs/models/sourcetiktokmarketingauthenticationmethod.md @@ -0,0 +1,19 @@ +# SourceTiktokMarketingAuthenticationMethod + +Authentication method + + +## Supported Types + +### SourceTiktokMarketingOAuth20 + +```python +sourceTiktokMarketingAuthenticationMethod: models.SourceTiktokMarketingOAuth20 = /* values here */ +``` + +### SandboxAccessToken + +```python +sourceTiktokMarketingAuthenticationMethod: models.SandboxAccessToken = /* values here */ +``` + diff --git a/docs/models/shared/sourcetiktokmarketingauthtype.md b/docs/models/sourcetiktokmarketingauthtype.md similarity index 100% rename from docs/models/shared/sourcetiktokmarketingauthtype.md rename to docs/models/sourcetiktokmarketingauthtype.md diff --git a/docs/models/sourcetiktokmarketingoauth20.md b/docs/models/sourcetiktokmarketingoauth20.md new file mode 100644 index 00000000..76911413 --- /dev/null +++ b/docs/models/sourcetiktokmarketingoauth20.md @@ -0,0 +1,12 @@ +# SourceTiktokMarketingOAuth20 + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `access_token` | *str* | :heavy_check_mark: | Long-term Authorized Access Token. | +| `app_id` | *str* | :heavy_check_mark: | The Developer Application App ID. | +| `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[models.SourceTiktokMarketingAuthType]](../models/sourcetiktokmarketingauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcetiktokmarketingschemasauthtype.md b/docs/models/sourcetiktokmarketingschemasauthtype.md similarity index 100% rename from docs/models/shared/sourcetiktokmarketingschemasauthtype.md rename to docs/models/sourcetiktokmarketingschemasauthtype.md diff --git a/docs/models/shared/sourcetiktokmarketingtiktokmarketing.md b/docs/models/sourcetiktokmarketingtiktokmarketing.md similarity index 100% rename from docs/models/shared/sourcetiktokmarketingtiktokmarketing.md rename to docs/models/sourcetiktokmarketingtiktokmarketing.md diff --git a/docs/models/shared/sourcetrello.md b/docs/models/sourcetrello.md similarity index 98% rename from docs/models/shared/sourcetrello.md rename to docs/models/sourcetrello.md index 7e3c5e16..723f0d84 100644 --- a/docs/models/shared/sourcetrello.md +++ b/docs/models/sourcetrello.md @@ -9,4 +9,4 @@ | `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. | | | `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 +| `source_type` | [models.Trello](../models/trello.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcetrustpilot.md b/docs/models/sourcetrustpilot.md similarity index 92% rename from docs/models/shared/sourcetrustpilot.md rename to docs/models/sourcetrustpilot.md index 40418860..f46c6602 100644 --- a/docs/models/shared/sourcetrustpilot.md +++ b/docs/models/sourcetrustpilot.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | `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 | | +| `credentials` | [Union[models.SourceTrustpilotOAuth20, models.SourceTrustpilotAPIKey]](../models/sourcetrustpilotauthorizationmethod.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 | -| `source_type` | [shared.Trustpilot](../../models/shared/trustpilot.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `source_type` | [models.Trustpilot](../models/trustpilot.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/sourcetrustpilotapikey.md b/docs/models/sourcetrustpilotapikey.md new file mode 100644 index 00000000..b62c29dc --- /dev/null +++ b/docs/models/sourcetrustpilotapikey.md @@ -0,0 +1,11 @@ +# SourceTrustpilotAPIKey + +The API key authentication method gives you access to only the streams which are part of the Public API. When you want to get streams available via the Consumer API (e.g. the private reviews) you need to use authentication method OAuth 2.0. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `client_id` | *str* | :heavy_check_mark: | The API key of the Trustpilot API application. | +| `auth_type` | [Optional[models.SourceTrustpilotSchemasAuthType]](../models/sourcetrustpilotschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourcetrustpilotauthorizationmethod.md b/docs/models/sourcetrustpilotauthorizationmethod.md new file mode 100644 index 00000000..cc139377 --- /dev/null +++ b/docs/models/sourcetrustpilotauthorizationmethod.md @@ -0,0 +1,17 @@ +# SourceTrustpilotAuthorizationMethod + + +## Supported Types + +### SourceTrustpilotOAuth20 + +```python +sourceTrustpilotAuthorizationMethod: models.SourceTrustpilotOAuth20 = /* values here */ +``` + +### SourceTrustpilotAPIKey + +```python +sourceTrustpilotAuthorizationMethod: models.SourceTrustpilotAPIKey = /* values here */ +``` + diff --git a/docs/models/shared/sourcetrustpilotauthtype.md b/docs/models/sourcetrustpilotauthtype.md similarity index 100% rename from docs/models/shared/sourcetrustpilotauthtype.md rename to docs/models/sourcetrustpilotauthtype.md diff --git a/docs/models/sourcetrustpilotoauth20.md b/docs/models/sourcetrustpilotoauth20.md new file mode 100644 index 00000000..f410ec42 --- /dev/null +++ b/docs/models/sourcetrustpilotoauth20.md @@ -0,0 +1,13 @@ +# SourceTrustpilotOAuth20 + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `access_token` | *str* | :heavy_check_mark: | Access Token for making authenticated requests. | +| `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. | +| `auth_type` | [Optional[models.SourceTrustpilotAuthType]](../models/sourcetrustpilotauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcetrustpilotschemasauthtype.md b/docs/models/sourcetrustpilotschemasauthtype.md similarity index 100% rename from docs/models/shared/sourcetrustpilotschemasauthtype.md rename to docs/models/sourcetrustpilotschemasauthtype.md diff --git a/docs/models/shared/sourcetvmazeschedule.md b/docs/models/sourcetvmazeschedule.md similarity index 99% rename from docs/models/shared/sourcetvmazeschedule.md rename to docs/models/sourcetvmazeschedule.md index 466cc031..6ee153a1 100644 --- a/docs/models/shared/sourcetvmazeschedule.md +++ b/docs/models/sourcetvmazeschedule.md @@ -8,5 +8,5 @@ | `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 | | +| `source_type` | [models.TvmazeSchedule](../models/tvmazeschedule.md) | :heavy_check_mark: | N/A | | | `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/sourcetwilio.md similarity index 96% rename from docs/models/shared/sourcetwilio.md rename to docs/models/sourcetwilio.md index ff28bff9..8ad39708 100644 --- a/docs/models/shared/sourcetwilio.md +++ b/docs/models/sourcetwilio.md @@ -9,4 +9,4 @@ | `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 | | \ No newline at end of file +| `source_type` | [models.Twilio](../models/twilio.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/sourcetwiliotaskrouter.md b/docs/models/sourcetwiliotaskrouter.md new file mode 100644 index 00000000..5d671400 --- /dev/null +++ b/docs/models/sourcetwiliotaskrouter.md @@ -0,0 +1,10 @@ +# SourceTwilioTaskrouter + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | +| `account_sid` | *str* | :heavy_check_mark: | Twilio Account ID | +| `auth_token` | *str* | :heavy_check_mark: | Twilio Auth Token | +| `source_type` | [models.TwilioTaskrouter](../models/twiliotaskrouter.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcetwitter.md b/docs/models/sourcetwitter.md similarity index 98% rename from docs/models/shared/sourcetwitter.md rename to docs/models/sourcetwitter.md index c0ba340f..1840b203 100644 --- a/docs/models/shared/sourcetwitter.md +++ b/docs/models/sourcetwitter.md @@ -8,5 +8,5 @@ | `api_key` | *str* | :heavy_check_mark: | App only Bearer Token. See the docs for more information on how to obtain this token. | | `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 | +| `source_type` | [models.Twitter](../models/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/sourcetypeform.md b/docs/models/sourcetypeform.md similarity index 96% rename from docs/models/shared/sourcetypeform.md rename to docs/models/sourcetypeform.md index 73fc08cb..8c3045b6 100644 --- a/docs/models/shared/sourcetypeform.md +++ b/docs/models/sourcetypeform.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `credentials` | [Union[shared.SourceTypeformOAuth20, shared.SourceTypeformPrivateToken]](../../models/shared/sourcetypeformauthorizationmethod.md) | :heavy_check_mark: | N/A | | +| `credentials` | [Union[models.SourceTypeformOAuth20, models.SourceTypeformPrivateToken]](../models/sourcetypeformauthorizationmethod.md) | :heavy_check_mark: | N/A | | | `form_ids` | List[*str*] | :heavy_minus_sign: | 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` | [shared.SourceTypeformTypeform](../../models/shared/sourcetypeformtypeform.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.SourceTypeformTypeform](../models/sourcetypeformtypeform.md) | :heavy_check_mark: | N/A | | | `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 Typeform API, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. | 2021-03-01T00:00:00Z | \ No newline at end of file diff --git a/docs/models/sourcetypeformauthorizationmethod.md b/docs/models/sourcetypeformauthorizationmethod.md new file mode 100644 index 00000000..59dbcada --- /dev/null +++ b/docs/models/sourcetypeformauthorizationmethod.md @@ -0,0 +1,17 @@ +# SourceTypeformAuthorizationMethod + + +## Supported Types + +### SourceTypeformOAuth20 + +```python +sourceTypeformAuthorizationMethod: models.SourceTypeformOAuth20 = /* values here */ +``` + +### SourceTypeformPrivateToken + +```python +sourceTypeformAuthorizationMethod: models.SourceTypeformPrivateToken = /* values here */ +``` + diff --git a/docs/models/shared/sourcetypeformauthtype.md b/docs/models/sourcetypeformauthtype.md similarity index 100% rename from docs/models/shared/sourcetypeformauthtype.md rename to docs/models/sourcetypeformauthtype.md diff --git a/docs/models/sourcetypeformoauth20.md b/docs/models/sourcetypeformoauth20.md new file mode 100644 index 00000000..cc9bec9a --- /dev/null +++ b/docs/models/sourcetypeformoauth20.md @@ -0,0 +1,13 @@ +# SourceTypeformOAuth20 + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `access_token` | *str* | :heavy_check_mark: | Access Token for making authenticated requests. | +| `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. | +| `auth_type` | [Optional[models.SourceTypeformAuthType]](../models/sourcetypeformauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourcetypeformprivatetoken.md b/docs/models/sourcetypeformprivatetoken.md new file mode 100644 index 00000000..f9ef517f --- /dev/null +++ b/docs/models/sourcetypeformprivatetoken.md @@ -0,0 +1,9 @@ +# SourceTypeformPrivateToken + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `access_token` | *str* | :heavy_check_mark: | Log into your Typeform account and then generate a personal Access Token. | +| `auth_type` | [Optional[models.SourceTypeformSchemasAuthType]](../models/sourcetypeformschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcetypeformschemasauthtype.md b/docs/models/sourcetypeformschemasauthtype.md similarity index 100% rename from docs/models/shared/sourcetypeformschemasauthtype.md rename to docs/models/sourcetypeformschemasauthtype.md diff --git a/docs/models/shared/sourcetypeformtypeform.md b/docs/models/sourcetypeformtypeform.md similarity index 100% rename from docs/models/shared/sourcetypeformtypeform.md rename to docs/models/sourcetypeformtypeform.md diff --git a/docs/models/shared/sourceuscensus.md b/docs/models/sourceuscensus.md similarity index 96% rename from docs/models/shared/sourceuscensus.md rename to docs/models/sourceuscensus.md index 58ed260e..821e8630 100644 --- a/docs/models/shared/sourceuscensus.md +++ b/docs/models/sourceuscensus.md @@ -8,4 +8,4 @@ | `api_key` | *str* | :heavy_check_mark: | Your API Key. Get your key here. | | | `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 +| `source_type` | [models.UsCensus](../models/uscensus.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcevantage.md b/docs/models/sourcevantage.md similarity index 92% rename from docs/models/shared/sourcevantage.md rename to docs/models/sourcevantage.md index cd0a4883..96462b86 100644 --- a/docs/models/shared/sourcevantage.md +++ b/docs/models/sourcevantage.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | | `access_token` | *str* | :heavy_check_mark: | Your API Access token. See here. | -| `source_type` | [shared.Vantage](../../models/shared/vantage.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `source_type` | [models.Vantage](../models/vantage.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcewebflow.md b/docs/models/sourcewebflow.md similarity index 96% rename from docs/models/shared/sourcewebflow.md rename to docs/models/sourcewebflow.md index 2a9be1f7..7d5b77f0 100644 --- a/docs/models/shared/sourcewebflow.md +++ b/docs/models/sourcewebflow.md @@ -8,4 +8,4 @@ | `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 +| `source_type` | [models.Webflow](../models/webflow.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/sourcewhiskyhunter.md b/docs/models/sourcewhiskyhunter.md new file mode 100644 index 00000000..d056125c --- /dev/null +++ b/docs/models/sourcewhiskyhunter.md @@ -0,0 +1,8 @@ +# SourceWhiskyHunter + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `source_type` | [Optional[models.WhiskyHunter]](../models/whiskyhunter.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcewikipediapageviews.md b/docs/models/sourcewikipediapageviews.md similarity index 98% rename from docs/models/shared/sourcewikipediapageviews.md rename to docs/models/sourcewikipediapageviews.md index fb8a444b..d399d5a6 100644 --- a/docs/models/shared/sourcewikipediapageviews.md +++ b/docs/models/sourcewikipediapageviews.md @@ -12,4 +12,4 @@ | `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 | | `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 +| `source_type` | [models.WikipediaPageviews](../models/wikipediapageviews.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcewoocommerce.md b/docs/models/sourcewoocommerce.md similarity index 95% rename from docs/models/shared/sourcewoocommerce.md rename to docs/models/sourcewoocommerce.md index fdb3f9a9..b72f3a55 100644 --- a/docs/models/shared/sourcewoocommerce.md +++ b/docs/models/sourcewoocommerce.md @@ -9,4 +9,4 @@ | `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'. | | | `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 +| `source_type` | [models.Woocommerce](../models/woocommerce.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/sourcexkcd.md b/docs/models/sourcexkcd.md new file mode 100644 index 00000000..04909974 --- /dev/null +++ b/docs/models/sourcexkcd.md @@ -0,0 +1,8 @@ +# SourceXkcd + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | +| `source_type` | [Optional[models.Xkcd]](../models/xkcd.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceyandexmetrica.md b/docs/models/sourceyandexmetrica.md similarity index 96% rename from docs/models/shared/sourceyandexmetrica.md rename to docs/models/sourceyandexmetrica.md index 089d248d..d2d7ec58 100644 --- a/docs/models/shared/sourceyandexmetrica.md +++ b/docs/models/sourceyandexmetrica.md @@ -9,4 +9,4 @@ | `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 | | \ No newline at end of file +| `source_type` | [models.YandexMetrica](../models/yandexmetrica.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceyotpo.md b/docs/models/sourceyotpo.md similarity index 97% rename from docs/models/shared/sourceyotpo.md rename to docs/models/sourceyotpo.md index 209c44e8..00149eca 100644 --- a/docs/models/shared/sourceyotpo.md +++ b/docs/models/sourceyotpo.md @@ -9,4 +9,4 @@ | `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 | | \ No newline at end of file +| `source_type` | [models.Yotpo](../models/yotpo.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/sourceyoutubeanalytics.md b/docs/models/sourceyoutubeanalytics.md new file mode 100644 index 00000000..8c8ff10f --- /dev/null +++ b/docs/models/sourceyoutubeanalytics.md @@ -0,0 +1,9 @@ +# SourceYoutubeAnalytics + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `credentials` | [models.AuthenticateViaOAuth20](../models/authenticateviaoauth20.md) | :heavy_check_mark: | N/A | +| `source_type` | [models.SourceYoutubeAnalyticsYoutubeAnalytics](../models/sourceyoutubeanalyticsyoutubeanalytics.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceyoutubeanalyticsyoutubeanalytics.md b/docs/models/sourceyoutubeanalyticsyoutubeanalytics.md similarity index 100% rename from docs/models/shared/sourceyoutubeanalyticsyoutubeanalytics.md rename to docs/models/sourceyoutubeanalyticsyoutubeanalytics.md diff --git a/docs/models/sourcezendeskchat.md b/docs/models/sourcezendeskchat.md new file mode 100644 index 00000000..4b92cd29 --- /dev/null +++ b/docs/models/sourcezendeskchat.md @@ -0,0 +1,11 @@ +# SourceZendeskChat + + +## Fields + +| 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[models.SourceZendeskChatOAuth20, models.SourceZendeskChatAccessToken]]](../models/sourcezendeskchatauthorizationmethod.md) | :heavy_minus_sign: | N/A | | +| `source_type` | [models.SourceZendeskChatZendeskChat](../models/sourcezendeskchatzendeskchat.md) | :heavy_check_mark: | N/A | | +| `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/sourcezendeskchataccesstoken.md b/docs/models/sourcezendeskchataccesstoken.md new file mode 100644 index 00000000..17ef93fc --- /dev/null +++ b/docs/models/sourcezendeskchataccesstoken.md @@ -0,0 +1,9 @@ +# SourceZendeskChatAccessToken + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `access_token` | *str* | :heavy_check_mark: | The Access Token to make authenticated requests. | +| `credentials` | [models.SourceZendeskChatSchemasCredentials](../models/sourcezendeskchatschemascredentials.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sourcezendeskchatauthorizationmethod.md b/docs/models/sourcezendeskchatauthorizationmethod.md new file mode 100644 index 00000000..379e9572 --- /dev/null +++ b/docs/models/sourcezendeskchatauthorizationmethod.md @@ -0,0 +1,17 @@ +# SourceZendeskChatAuthorizationMethod + + +## Supported Types + +### SourceZendeskChatOAuth20 + +```python +sourceZendeskChatAuthorizationMethod: models.SourceZendeskChatOAuth20 = /* values here */ +``` + +### SourceZendeskChatAccessToken + +```python +sourceZendeskChatAuthorizationMethod: models.SourceZendeskChatAccessToken = /* values here */ +``` + diff --git a/docs/models/shared/sourcezendeskchatcredentials.md b/docs/models/sourcezendeskchatcredentials.md similarity index 100% rename from docs/models/shared/sourcezendeskchatcredentials.md rename to docs/models/sourcezendeskchatcredentials.md diff --git a/docs/models/sourcezendeskchatoauth20.md b/docs/models/sourcezendeskchatoauth20.md new file mode 100644 index 00000000..5efeb466 --- /dev/null +++ b/docs/models/sourcezendeskchatoauth20.md @@ -0,0 +1,12 @@ +# SourceZendeskChatOAuth20 + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `access_token` | *Optional[str]* | :heavy_minus_sign: | Access Token for making authenticated requests. | +| `client_id` | *Optional[str]* | :heavy_minus_sign: | The Client ID of your OAuth application | +| `client_secret` | *Optional[str]* | :heavy_minus_sign: | The Client Secret of your OAuth application. | +| `credentials` | [models.SourceZendeskChatCredentials](../models/sourcezendeskchatcredentials.md) | :heavy_check_mark: | N/A | +| `refresh_token` | *Optional[str]* | :heavy_minus_sign: | Refresh Token to obtain new Access Token, when it's expired. | \ No newline at end of file diff --git a/docs/models/shared/sourcezendeskchatschemascredentials.md b/docs/models/sourcezendeskchatschemascredentials.md similarity index 100% rename from docs/models/shared/sourcezendeskchatschemascredentials.md rename to docs/models/sourcezendeskchatschemascredentials.md diff --git a/docs/models/shared/sourcezendeskchatzendeskchat.md b/docs/models/sourcezendeskchatzendeskchat.md similarity index 100% rename from docs/models/shared/sourcezendeskchatzendeskchat.md rename to docs/models/sourcezendeskchatzendeskchat.md diff --git a/docs/models/shared/sourcezendesksell.md b/docs/models/sourcezendesksell.md similarity index 95% rename from docs/models/shared/sourcezendesksell.md rename to docs/models/sourcezendesksell.md index 6f014f41..1e6d534d 100644 --- a/docs/models/shared/sourcezendesksell.md +++ b/docs/models/sourcezendesksell.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | | `api_token` | *str* | :heavy_check_mark: | The API token for authenticating to Zendesk Sell | f23yhd630otl94y85a8bf384958473pto95847fd006da49382716or937ruw059 | -| `source_type` | [shared.ZendeskSell](../../models/shared/zendesksell.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `source_type` | [models.ZendeskSell](../models/zendesksell.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/sourcezendesksunshine.md b/docs/models/sourcezendesksunshine.md new file mode 100644 index 00000000..93eb8bd4 --- /dev/null +++ b/docs/models/sourcezendesksunshine.md @@ -0,0 +1,11 @@ +# SourceZendeskSunshine + + +## Fields + +| 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 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. | | +| `credentials` | [Optional[Union[models.SourceZendeskSunshineOAuth20, models.SourceZendeskSunshineAPIToken]]](../models/sourcezendesksunshineauthorizationmethod.md) | :heavy_minus_sign: | N/A | | +| `source_type` | [models.SourceZendeskSunshineZendeskSunshine](../models/sourcezendesksunshinezendesksunshine.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcezendesksunshineapitoken.md b/docs/models/sourcezendesksunshineapitoken.md similarity index 93% rename from docs/models/shared/sourcezendesksunshineapitoken.md rename to docs/models/sourcezendesksunshineapitoken.md index 2ceb61ea..ab1a09af 100644 --- a/docs/models/shared/sourcezendesksunshineapitoken.md +++ b/docs/models/sourcezendesksunshineapitoken.md @@ -7,4 +7,4 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `api_token` | *str* | :heavy_check_mark: | API Token. See the docs for information on how to generate this key. | | `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 +| `auth_method` | [Optional[models.SourceZendeskSunshineSchemasAuthMethod]](../models/sourcezendesksunshineschemasauthmethod.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcezendesksunshineauthmethod.md b/docs/models/sourcezendesksunshineauthmethod.md similarity index 100% rename from docs/models/shared/sourcezendesksunshineauthmethod.md rename to docs/models/sourcezendesksunshineauthmethod.md diff --git a/docs/models/sourcezendesksunshineauthorizationmethod.md b/docs/models/sourcezendesksunshineauthorizationmethod.md new file mode 100644 index 00000000..c0efaa74 --- /dev/null +++ b/docs/models/sourcezendesksunshineauthorizationmethod.md @@ -0,0 +1,17 @@ +# SourceZendeskSunshineAuthorizationMethod + + +## Supported Types + +### SourceZendeskSunshineOAuth20 + +```python +sourceZendeskSunshineAuthorizationMethod: models.SourceZendeskSunshineOAuth20 = /* values here */ +``` + +### SourceZendeskSunshineAPIToken + +```python +sourceZendeskSunshineAuthorizationMethod: models.SourceZendeskSunshineAPIToken = /* values here */ +``` + diff --git a/docs/models/sourcezendesksunshineoauth20.md b/docs/models/sourcezendesksunshineoauth20.md new file mode 100644 index 00000000..761f2d43 --- /dev/null +++ b/docs/models/sourcezendesksunshineoauth20.md @@ -0,0 +1,11 @@ +# SourceZendeskSunshineOAuth20 + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `access_token` | *str* | :heavy_check_mark: | Long-term access Token for making authenticated requests. | +| `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_method` | [Optional[models.SourceZendeskSunshineAuthMethod]](../models/sourcezendesksunshineauthmethod.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcezendesksunshineschemasauthmethod.md b/docs/models/sourcezendesksunshineschemasauthmethod.md similarity index 100% rename from docs/models/shared/sourcezendesksunshineschemasauthmethod.md rename to docs/models/sourcezendesksunshineschemasauthmethod.md diff --git a/docs/models/shared/sourcezendesksunshinezendesksunshine.md b/docs/models/sourcezendesksunshinezendesksunshine.md similarity index 100% rename from docs/models/shared/sourcezendesksunshinezendesksunshine.md rename to docs/models/sourcezendesksunshinezendesksunshine.md diff --git a/docs/models/shared/sourcezendesksupport.md b/docs/models/sourcezendesksupport.md similarity index 93% rename from docs/models/shared/sourcezendesksupport.md rename to docs/models/sourcezendesksupport.md index d946b9fd..2bbe4b48 100644 --- a/docs/models/shared/sourcezendesksupport.md +++ b/docs/models/sourcezendesksupport.md @@ -6,7 +6,7 @@ | 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. | | +| `credentials` | [Optional[Union[models.SourceZendeskSupportOAuth20, models.SourceZendeskSupportAPIToken]]](../models/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 | | +| `source_type` | [models.SourceZendeskSupportZendeskSupport](../models/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 | \ No newline at end of file diff --git a/docs/models/shared/sourcezendesksupportapitoken.md b/docs/models/sourcezendesksupportapitoken.md similarity index 96% rename from docs/models/shared/sourcezendesksupportapitoken.md rename to docs/models/sourcezendesksupportapitoken.md index 961ccf04..59775077 100644 --- a/docs/models/shared/sourcezendesksupportapitoken.md +++ b/docs/models/sourcezendesksupportapitoken.md @@ -8,4 +8,4 @@ | `api_token` | *str* | :heavy_check_mark: | The value of the API token generated. See our full documentation for more information on generating this token. | | `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 +| `credentials` | [Optional[models.SourceZendeskSupportSchemasCredentials]](../models/sourcezendesksupportschemascredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourcezendesksupportauthentication.md b/docs/models/sourcezendesksupportauthentication.md new file mode 100644 index 00000000..75b7dd55 --- /dev/null +++ b/docs/models/sourcezendesksupportauthentication.md @@ -0,0 +1,19 @@ +# SourceZendeskSupportAuthentication + +Zendesk allows two authentication methods. We recommend using `OAuth2.0` for Airbyte Cloud users and `API token` for Airbyte Open Source users. + + +## Supported Types + +### SourceZendeskSupportOAuth20 + +```python +sourceZendeskSupportAuthentication: models.SourceZendeskSupportOAuth20 = /* values here */ +``` + +### SourceZendeskSupportAPIToken + +```python +sourceZendeskSupportAuthentication: models.SourceZendeskSupportAPIToken = /* values here */ +``` + diff --git a/docs/models/shared/sourcezendesksupportcredentials.md b/docs/models/sourcezendesksupportcredentials.md similarity index 100% rename from docs/models/shared/sourcezendesksupportcredentials.md rename to docs/models/sourcezendesksupportcredentials.md diff --git a/docs/models/shared/sourcezendesksupportoauth20.md b/docs/models/sourcezendesksupportoauth20.md similarity index 97% rename from docs/models/shared/sourcezendesksupportoauth20.md rename to docs/models/sourcezendesksupportoauth20.md index 6c58962b..03fb99f0 100644 --- a/docs/models/shared/sourcezendesksupportoauth20.md +++ b/docs/models/sourcezendesksupportoauth20.md @@ -9,4 +9,4 @@ | `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 +| `credentials` | [Optional[models.SourceZendeskSupportCredentials]](../models/sourcezendesksupportcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcezendesksupportschemascredentials.md b/docs/models/sourcezendesksupportschemascredentials.md similarity index 100% rename from docs/models/shared/sourcezendesksupportschemascredentials.md rename to docs/models/sourcezendesksupportschemascredentials.md diff --git a/docs/models/shared/sourcezendesksupportzendesksupport.md b/docs/models/sourcezendesksupportzendesksupport.md similarity index 100% rename from docs/models/shared/sourcezendesksupportzendesksupport.md rename to docs/models/sourcezendesksupportzendesksupport.md diff --git a/docs/models/shared/sourcezendesktalk.md b/docs/models/sourcezendesktalk.md similarity index 93% rename from docs/models/shared/sourcezendesktalk.md rename to docs/models/sourcezendesktalk.md index e9d9ef97..79aad799 100644 --- a/docs/models/shared/sourcezendesktalk.md +++ b/docs/models/sourcezendesktalk.md @@ -7,5 +7,5 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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. | | -| `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 +| `credentials` | [Optional[Union[models.SourceZendeskTalkOAuth20, models.SourceZendeskTalkAPIToken]]](../models/sourcezendesktalkauthentication.md) | :heavy_minus_sign: | Zendesk service provides two authentication methods. Choose between: `OAuth2.0` or `API token`. | | +| `source_type` | [models.SourceZendeskTalkZendeskTalk](../models/sourcezendesktalkzendesktalk.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcezendesktalkapitoken.md b/docs/models/sourcezendesktalkapitoken.md similarity index 96% rename from docs/models/shared/sourcezendesktalkapitoken.md rename to docs/models/sourcezendesktalkapitoken.md index 4b9b7462..0f29e7b0 100644 --- a/docs/models/shared/sourcezendesktalkapitoken.md +++ b/docs/models/sourcezendesktalkapitoken.md @@ -8,4 +8,4 @@ | `api_token` | *str* | :heavy_check_mark: | The value of the API token generated. See the docs for more information. | | `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 +| `auth_type` | [Optional[models.SourceZendeskTalkSchemasAuthType]](../models/sourcezendesktalkschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/sourcezendesktalkauthentication.md b/docs/models/sourcezendesktalkauthentication.md new file mode 100644 index 00000000..2136cd98 --- /dev/null +++ b/docs/models/sourcezendesktalkauthentication.md @@ -0,0 +1,19 @@ +# SourceZendeskTalkAuthentication + +Zendesk service provides two authentication methods. Choose between: `OAuth2.0` or `API token`. + + +## Supported Types + +### SourceZendeskTalkOAuth20 + +```python +sourceZendeskTalkAuthentication: models.SourceZendeskTalkOAuth20 = /* values here */ +``` + +### SourceZendeskTalkAPIToken + +```python +sourceZendeskTalkAuthentication: models.SourceZendeskTalkAPIToken = /* values here */ +``` + diff --git a/docs/models/sourcezendesktalkauthtype.md b/docs/models/sourcezendesktalkauthtype.md new file mode 100644 index 00000000..5c74d1dd --- /dev/null +++ b/docs/models/sourcezendesktalkauthtype.md @@ -0,0 +1,8 @@ +# SourceZendeskTalkAuthType + + +## Values + +| Name | Value | +| ---------- | ---------- | +| `OAUTH2_0` | oauth2.0 | \ No newline at end of file diff --git a/docs/models/shared/sourcezendesktalkoauth20.md b/docs/models/sourcezendesktalkoauth20.md similarity index 95% rename from docs/models/shared/sourcezendesktalkoauth20.md rename to docs/models/sourcezendesktalkoauth20.md index a47ab592..30b46c63 100644 --- a/docs/models/shared/sourcezendesktalkoauth20.md +++ b/docs/models/sourcezendesktalkoauth20.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `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 | +| `auth_type` | [Optional[models.SourceZendeskTalkAuthType]](../models/sourcezendesktalkauthtype.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/sourcezendesktalkschemasauthtype.md b/docs/models/sourcezendesktalkschemasauthtype.md new file mode 100644 index 00000000..98713553 --- /dev/null +++ b/docs/models/sourcezendesktalkschemasauthtype.md @@ -0,0 +1,8 @@ +# SourceZendeskTalkSchemasAuthType + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `API_TOKEN` | api_token | \ No newline at end of file diff --git a/docs/models/shared/sourcezendesktalkzendesktalk.md b/docs/models/sourcezendesktalkzendesktalk.md similarity index 100% rename from docs/models/shared/sourcezendesktalkzendesktalk.md rename to docs/models/sourcezendesktalkzendesktalk.md diff --git a/docs/models/shared/sourcezenloop.md b/docs/models/sourcezenloop.md similarity index 97% rename from docs/models/shared/sourcezenloop.md rename to docs/models/sourcezenloop.md index 23b88e3a..b64943db 100644 --- a/docs/models/shared/sourcezenloop.md +++ b/docs/models/sourcezenloop.md @@ -7,6 +7,6 @@ | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `api_token` | *str* | :heavy_check_mark: | Zenloop API Token. You can get the API token in settings page here | | | `date_from` | *Optional[str]* | :heavy_minus_sign: | Zenloop date_from. Format: 2021-10-24T03:30:30Z or 2021-10-24. Leave empty if only data from current data should be synced | 2021-10-24T03:30:30Z | -| `source_type` | [shared.Zenloop](../../models/shared/zenloop.md) | :heavy_check_mark: | N/A | | +| `source_type` | [models.Zenloop](../models/zenloop.md) | :heavy_check_mark: | N/A | | | `survey_group_id` | *Optional[str]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | Zenloop Survey ID. Can be found here. Leave empty to pull answers from all surveys | | \ No newline at end of file diff --git a/docs/models/shared/sourcezohocrm.md b/docs/models/sourcezohocrm.md similarity index 93% rename from docs/models/shared/sourcezohocrm.md rename to docs/models/sourcezohocrm.md index d7f5f45e..337208b2 100644 --- a/docs/models/shared/sourcezohocrm.md +++ b/docs/models/sourcezohocrm.md @@ -7,9 +7,9 @@ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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 | | -| `environment` | [shared.SourceZohoCrmEnvironment](../../models/shared/sourcezohocrmenvironment.md) | :heavy_check_mark: | Please choose the environment | | +| `dc_region` | [models.DataCenterLocation](../models/datacenterlocation.md) | :heavy_check_mark: | Please choose the region of your Data Center location. More info by this Link | | +| `environment` | [models.SourceZohoCrmEnvironment](../models/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 | | +| `edition` | [Optional[models.ZohoCRMEdition]](../models/zohocrmedition.md) | :heavy_minus_sign: | Choose your Edition of Zoho CRM to determine API Concurrency Limits | | +| `source_type` | [models.ZohoCrm](../models/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/sourcezohocrmenvironment.md b/docs/models/sourcezohocrmenvironment.md similarity index 100% rename from docs/models/shared/sourcezohocrmenvironment.md rename to docs/models/sourcezohocrmenvironment.md diff --git a/docs/models/sourcezoom.md b/docs/models/sourcezoom.md new file mode 100644 index 00000000..158ec3ea --- /dev/null +++ b/docs/models/sourcezoom.md @@ -0,0 +1,12 @@ +# SourceZoom + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `account_id` | *str* | :heavy_check_mark: | The account ID for your Zoom account. You can find this in the Zoom Marketplace under the "Manage" tab for your app. | +| `client_id` | *str* | :heavy_check_mark: | The client ID for your Zoom app. You can find this in the Zoom Marketplace under the "Manage" tab for your app. | +| `client_secret` | *str* | :heavy_check_mark: | The client secret for your Zoom app. You can find this in the Zoom Marketplace under the "Manage" tab for your app. | +| `authorization_endpoint` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `source_type` | [models.Zoom](../models/zoom.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/spacexapi.md b/docs/models/spacexapi.md similarity index 100% rename from docs/models/shared/spacexapi.md rename to docs/models/spacexapi.md diff --git a/docs/models/square.md b/docs/models/square.md new file mode 100644 index 00000000..7f990efa --- /dev/null +++ b/docs/models/square.md @@ -0,0 +1,8 @@ +# Square + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `credentials` | [Optional[models.SquareCredentials]](../models/squarecredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/squarecredentials.md b/docs/models/squarecredentials.md similarity index 100% rename from docs/models/shared/squarecredentials.md rename to docs/models/squarecredentials.md diff --git a/docs/models/shared/sshkeyauthentication.md b/docs/models/sshkeyauthentication.md similarity index 95% rename from docs/models/shared/sshkeyauthentication.md rename to docs/models/sshkeyauthentication.md index 0e547d02..c865955b 100644 --- a/docs/models/shared/sshkeyauthentication.md +++ b/docs/models/sshkeyauthentication.md @@ -8,5 +8,5 @@ | `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_method` | [models.DestinationClickhouseTunnelMethod](../models/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 | \ No newline at end of file diff --git a/docs/models/sshsecureshell.md b/docs/models/sshsecureshell.md new file mode 100644 index 00000000..17a955cb --- /dev/null +++ b/docs/models/sshsecureshell.md @@ -0,0 +1,12 @@ +# SSHSecureShell + + +## Fields + +| 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` | [models.SourceFileSchemasProviderStorageProviderStorage](../models/sourcefileschemasproviderstorageproviderstorage.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/sshtunnelmethod.md b/docs/models/sshtunnelmethod.md new file mode 100644 index 00000000..35d628ed --- /dev/null +++ b/docs/models/sshtunnelmethod.md @@ -0,0 +1,25 @@ +# SSHTunnelMethod + +Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. + + +## Supported Types + +### NoTunnel + +```python +sshTunnelMethod: models.NoTunnel = /* values here */ +``` + +### SSHKeyAuthentication + +```python +sshTunnelMethod: models.SSHKeyAuthentication = /* values here */ +``` + +### PasswordAuthentication + +```python +sshTunnelMethod: models.PasswordAuthentication = /* values here */ +``` + diff --git a/docs/models/sslmethod.md b/docs/models/sslmethod.md new file mode 100644 index 00000000..00e956df --- /dev/null +++ b/docs/models/sslmethod.md @@ -0,0 +1,19 @@ +# SSLMethod + +The encryption method which is used to communicate with the database. + + +## Supported Types + +### EncryptedTrustServerCertificate + +```python +sslMethod: models.EncryptedTrustServerCertificate = /* values here */ +``` + +### EncryptedVerifyCertificate + +```python +sslMethod: models.EncryptedVerifyCertificate = /* values here */ +``` + diff --git a/docs/models/shared/sslmodes.md b/docs/models/sslmodes.md similarity index 80% rename from docs/models/shared/sslmodes.md rename to docs/models/sslmodes.md index 4d8722b2..a2934b3b 100644 --- a/docs/models/shared/sslmodes.md +++ b/docs/models/sslmodes.md @@ -15,36 +15,36 @@ SSL connection modes. ### Disable ```python -sslModes: shared.Disable = /* values here */ +sslModes: models.Disable = /* values here */ ``` ### Allow ```python -sslModes: shared.Allow = /* values here */ +sslModes: models.Allow = /* values here */ ``` ### Prefer ```python -sslModes: shared.Prefer = /* values here */ +sslModes: models.Prefer = /* values here */ ``` ### Require ```python -sslModes: shared.Require = /* values here */ +sslModes: models.Require = /* values here */ ``` ### VerifyCa ```python -sslModes: shared.VerifyCa = /* values here */ +sslModes: models.VerifyCa = /* values here */ ``` ### VerifyFull ```python -sslModes: shared.VerifyFull = /* values here */ +sslModes: models.VerifyFull = /* values here */ ``` diff --git a/docs/models/standalonemongodbinstance.md b/docs/models/standalonemongodbinstance.md new file mode 100644 index 00000000..632e0f70 --- /dev/null +++ b/docs/models/standalonemongodbinstance.md @@ -0,0 +1,10 @@ +# StandaloneMongoDbInstance + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | +| `host` | *str* | :heavy_check_mark: | The Host of a Mongo database to be replicated. | | +| `instance` | [Optional[models.Instance]](../models/instance.md) | :heavy_minus_sign: | N/A | | +| `port` | *Optional[int]* | :heavy_minus_sign: | The Port of a Mongo database to be replicated. | 27017 | \ No newline at end of file diff --git a/docs/models/standard.md b/docs/models/standard.md new file mode 100644 index 00000000..5d342dbe --- /dev/null +++ b/docs/models/standard.md @@ -0,0 +1,10 @@ +# Standard + +(not recommended) Direct loading using SQL INSERT statements. This method is extremely inefficient and provided only for quick testing. In all other cases, you should use S3 uploading. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `method` | [models.DestinationRedshiftSchemasMethod](../models/destinationredshiftschemasmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/standardinserts.md b/docs/models/standardinserts.md new file mode 100644 index 00000000..ba23af86 --- /dev/null +++ b/docs/models/standardinserts.md @@ -0,0 +1,10 @@ +# StandardInserts + +(not recommended) Direct loading using SQL INSERT statements. This method is extremely inefficient and provided only for quick testing. In all other cases, you should use GCS staging. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `method` | [models.DestinationBigqueryMethod](../models/destinationbigquerymethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/state.md b/docs/models/state.md similarity index 100% rename from docs/models/shared/state.md rename to docs/models/state.md diff --git a/docs/models/shared/statefilter.md b/docs/models/statefilter.md similarity index 100% rename from docs/models/shared/statefilter.md rename to docs/models/statefilter.md diff --git a/docs/models/shared/status.md b/docs/models/status.md similarity index 100% rename from docs/models/shared/status.md rename to docs/models/status.md diff --git a/docs/models/shared/storage.md b/docs/models/storage.md similarity index 100% rename from docs/models/shared/storage.md rename to docs/models/storage.md diff --git a/docs/models/storageprovider.md b/docs/models/storageprovider.md new file mode 100644 index 00000000..eab78e94 --- /dev/null +++ b/docs/models/storageprovider.md @@ -0,0 +1,49 @@ +# StorageProvider + +The storage Provider or Location of the file(s) which should be replicated. + + +## Supported Types + +### HTTPSPublicWeb + +```python +storageProvider: models.HTTPSPublicWeb = /* values here */ +``` + +### GCSGoogleCloudStorage + +```python +storageProvider: models.GCSGoogleCloudStorage = /* values here */ +``` + +### SourceFileS3AmazonWebServices + +```python +storageProvider: models.SourceFileS3AmazonWebServices = /* values here */ +``` + +### AzBlobAzureBlobStorage + +```python +storageProvider: models.AzBlobAzureBlobStorage = /* values here */ +``` + +### SSHSecureShell + +```python +storageProvider: models.SSHSecureShell = /* values here */ +``` + +### SCPSecureCopyProtocol + +```python +storageProvider: models.SCPSecureCopyProtocol = /* values here */ +``` + +### SFTPSecureFileTransferProtocol + +```python +storageProvider: models.SFTPSecureFileTransferProtocol = /* values here */ +``` + diff --git a/docs/models/shared/strategies.md b/docs/models/strategies.md similarity index 100% rename from docs/models/shared/strategies.md rename to docs/models/strategies.md diff --git a/docs/models/shared/strava.md b/docs/models/strava.md similarity index 100% rename from docs/models/shared/strava.md rename to docs/models/strava.md diff --git a/docs/models/shared/streamconfiguration.md b/docs/models/streamconfiguration.md similarity index 97% rename from docs/models/shared/streamconfiguration.md rename to docs/models/streamconfiguration.md index 7d9f1681..d2d6248c 100644 --- a/docs/models/shared/streamconfiguration.md +++ b/docs/models/streamconfiguration.md @@ -10,4 +10,4 @@ Configurations for a single stream. | `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 +| `sync_mode` | [Optional[models.ConnectionSyncModeEnum]](../models/connectionsyncmodeenum.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/streamconfigurations.md b/docs/models/streamconfigurations.md new file mode 100644 index 00000000..b04c6c5f --- /dev/null +++ b/docs/models/streamconfigurations.md @@ -0,0 +1,10 @@ +# StreamConfigurations + +A list of configured stream options for a connection. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `streams` | List[[models.StreamConfiguration](../models/streamconfiguration.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/streamname.md b/docs/models/streamname.md similarity index 100% rename from docs/models/shared/streamname.md rename to docs/models/streamname.md diff --git a/docs/models/streamproperties.md b/docs/models/streamproperties.md new file mode 100644 index 00000000..d10968ed --- /dev/null +++ b/docs/models/streamproperties.md @@ -0,0 +1,15 @@ +# StreamProperties + +The stream properties associated with a connection. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `default_cursor_field` | List[*str*] | :heavy_minus_sign: | N/A | +| `property_fields` | List[List[*str*]] | :heavy_minus_sign: | N/A | +| `source_defined_cursor_field` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `source_defined_primary_key` | List[List[*str*]] | :heavy_minus_sign: | N/A | +| `stream_name` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `sync_modes` | List[[models.ConnectionSyncModeEnum](../models/connectionsyncmodeenum.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/streampropertiesresponse.md b/docs/models/streampropertiesresponse.md new file mode 100644 index 00000000..5ee46b0b --- /dev/null +++ b/docs/models/streampropertiesresponse.md @@ -0,0 +1,10 @@ +# StreamPropertiesResponse + +A list of stream properties. + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | +| `streams` | List[[models.StreamProperties](../models/streamproperties.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/streamscriteria.md b/docs/models/streamscriteria.md new file mode 100644 index 00000000..3d3b70fe --- /dev/null +++ b/docs/models/streamscriteria.md @@ -0,0 +1,9 @@ +# StreamsCriteria + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `criteria` | [Optional[models.SearchCriteria]](../models/searchcriteria.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/stringfilter.md b/docs/models/stringfilter.md new file mode 100644 index 00000000..0441d0ce --- /dev/null +++ b/docs/models/stringfilter.md @@ -0,0 +1,11 @@ +# StringFilter + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | +| `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | +| `filter_name` | [models.FilterName](../models/filtername.md) | :heavy_check_mark: | N/A | +| `match_type` | List[[models.SourceGoogleAnalyticsDataAPIValidEnums](../models/sourcegoogleanalyticsdataapivalidenums.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/stripe.md b/docs/models/stripe.md similarity index 100% rename from docs/models/shared/stripe.md rename to docs/models/stripe.md diff --git a/docs/models/surveymonkey.md b/docs/models/surveymonkey.md new file mode 100644 index 00000000..275582ba --- /dev/null +++ b/docs/models/surveymonkey.md @@ -0,0 +1,8 @@ +# Surveymonkey + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `credentials` | [Optional[models.SurveymonkeyCredentials]](../models/surveymonkeycredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/surveymonkeyauthorizationmethod.md b/docs/models/surveymonkeyauthorizationmethod.md similarity index 95% rename from docs/models/shared/surveymonkeyauthorizationmethod.md rename to docs/models/surveymonkeyauthorizationmethod.md index b14949ee..f8cb87bc 100644 --- a/docs/models/shared/surveymonkeyauthorizationmethod.md +++ b/docs/models/surveymonkeyauthorizationmethod.md @@ -8,6 +8,6 @@ The authorization method to use to retrieve data from SurveyMonkey | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `access_token` | *str* | :heavy_check_mark: | Access Token for making authenticated requests. See the docs for information on how to generate this key. | -| `auth_method` | [shared.SourceSurveymonkeyAuthMethod](../../models/shared/sourcesurveymonkeyauthmethod.md) | :heavy_check_mark: | N/A | +| `auth_method` | [models.SourceSurveymonkeyAuthMethod](../models/sourcesurveymonkeyauthmethod.md) | :heavy_check_mark: | N/A | | `client_id` | *Optional[str]* | :heavy_minus_sign: | The Client ID of the SurveyMonkey developer application. | | `client_secret` | *Optional[str]* | :heavy_minus_sign: | The Client Secret of the SurveyMonkey developer application. | \ No newline at end of file diff --git a/docs/models/shared/surveymonkeycredentials.md b/docs/models/surveymonkeycredentials.md similarity index 100% rename from docs/models/shared/surveymonkeycredentials.md rename to docs/models/surveymonkeycredentials.md diff --git a/docs/models/shared/surveysparrow.md b/docs/models/surveysparrow.md similarity index 100% rename from docs/models/shared/surveysparrow.md rename to docs/models/surveysparrow.md diff --git a/docs/models/swipeupattributionwindow.md b/docs/models/swipeupattributionwindow.md new file mode 100644 index 00000000..75c3fc7c --- /dev/null +++ b/docs/models/swipeupattributionwindow.md @@ -0,0 +1,12 @@ +# SwipeUpAttributionWindow + +Attribution window for swipe ups. + + +## Values + +| Name | Value | +| ------------------ | ------------------ | +| `ONE_DAY` | 1_DAY | +| `SEVEN_DAY` | 7_DAY | +| `TWENTY_EIGHT_DAY` | 28_DAY | \ No newline at end of file diff --git a/docs/models/systemidsid.md b/docs/models/systemidsid.md new file mode 100644 index 00000000..f0da34da --- /dev/null +++ b/docs/models/systemidsid.md @@ -0,0 +1,11 @@ +# SystemIDSID + +Use SID (Oracle System Identifier) + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `sid` | *str* | :heavy_check_mark: | N/A | +| `connection_type` | [Optional[models.SourceOracleConnectionType]](../models/sourceoracleconnectiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/tempo.md b/docs/models/tempo.md similarity index 100% rename from docs/models/shared/tempo.md rename to docs/models/tempo.md diff --git a/docs/models/shared/teradata.md b/docs/models/teradata.md similarity index 100% rename from docs/models/shared/teradata.md rename to docs/models/teradata.md diff --git a/docs/models/testdestination.md b/docs/models/testdestination.md new file mode 100644 index 00000000..37c80457 --- /dev/null +++ b/docs/models/testdestination.md @@ -0,0 +1,13 @@ +# TestDestination + +The type of destination to be used + + +## Supported Types + +### Silent + +```python +testDestination: models.Silent = /* values here */ +``` + diff --git a/docs/models/shared/testdestinationtype.md b/docs/models/testdestinationtype.md similarity index 100% rename from docs/models/shared/testdestinationtype.md rename to docs/models/testdestinationtype.md diff --git a/docs/models/textsplitter.md b/docs/models/textsplitter.md new file mode 100644 index 00000000..f214577a --- /dev/null +++ b/docs/models/textsplitter.md @@ -0,0 +1,25 @@ +# TextSplitter + +Split text fields into chunks based on the specified method. + + +## Supported Types + +### BySeparator + +```python +textSplitter: models.BySeparator = /* values here */ +``` + +### ByMarkdownHeader + +```python +textSplitter: models.ByMarkdownHeader = /* values here */ +``` + +### ByProgrammingLanguage + +```python +textSplitter: models.ByProgrammingLanguage = /* values here */ +``` + diff --git a/docs/models/shared/theguardianapi.md b/docs/models/theguardianapi.md similarity index 100% rename from docs/models/shared/theguardianapi.md rename to docs/models/theguardianapi.md diff --git a/docs/models/tiktokmarketing.md b/docs/models/tiktokmarketing.md new file mode 100644 index 00000000..7b905ff8 --- /dev/null +++ b/docs/models/tiktokmarketing.md @@ -0,0 +1,8 @@ +# TiktokMarketing + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `credentials` | [Optional[models.TiktokMarketingCredentials]](../models/tiktokmarketingcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/tiktokmarketingcredentials.md b/docs/models/tiktokmarketingcredentials.md similarity index 100% rename from docs/models/shared/tiktokmarketingcredentials.md rename to docs/models/tiktokmarketingcredentials.md diff --git a/docs/models/shared/timegranularity.md b/docs/models/timegranularity.md similarity index 100% rename from docs/models/shared/timegranularity.md rename to docs/models/timegranularity.md diff --git a/docs/models/shared/tlsencryptedverifycertificate.md b/docs/models/tlsencryptedverifycertificate.md similarity index 90% rename from docs/models/shared/tlsencryptedverifycertificate.md rename to docs/models/tlsencryptedverifycertificate.md index 2f6f9dbf..41dfe16b 100644 --- a/docs/models/shared/tlsencryptedverifycertificate.md +++ b/docs/models/tlsencryptedverifycertificate.md @@ -8,4 +8,4 @@ Verify and use the certificate provided by the server. | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | | `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 +| `encryption_method` | [models.SourceOracleEncryptionMethod](../models/sourceoracleencryptionmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/topheadlinestopic.md b/docs/models/topheadlinestopic.md similarity index 100% rename from docs/models/shared/topheadlinestopic.md rename to docs/models/topheadlinestopic.md diff --git a/docs/models/tovalue.md b/docs/models/tovalue.md new file mode 100644 index 00000000..1cc3bce0 --- /dev/null +++ b/docs/models/tovalue.md @@ -0,0 +1,17 @@ +# ToValue + + +## Supported Types + +### SourceGoogleAnalyticsDataAPISchemasInt64Value + +```python +toValue: models.SourceGoogleAnalyticsDataAPISchemasInt64Value = /* values here */ +``` + +### SourceGoogleAnalyticsDataAPISchemasDoubleValue + +```python +toValue: models.SourceGoogleAnalyticsDataAPISchemasDoubleValue = /* values here */ +``` + diff --git a/docs/models/shared/transformationqueryruntype.md b/docs/models/transformationqueryruntype.md similarity index 100% rename from docs/models/shared/transformationqueryruntype.md rename to docs/models/transformationqueryruntype.md diff --git a/docs/models/shared/trello.md b/docs/models/trello.md similarity index 100% rename from docs/models/shared/trello.md rename to docs/models/trello.md diff --git a/docs/models/shared/trustpilot.md b/docs/models/trustpilot.md similarity index 100% rename from docs/models/shared/trustpilot.md rename to docs/models/trustpilot.md diff --git a/docs/models/shared/tunnelmethod.md b/docs/models/tunnelmethod.md similarity index 100% rename from docs/models/shared/tunnelmethod.md rename to docs/models/tunnelmethod.md diff --git a/docs/models/shared/tvmazeschedule.md b/docs/models/tvmazeschedule.md similarity index 100% rename from docs/models/shared/tvmazeschedule.md rename to docs/models/tvmazeschedule.md diff --git a/docs/models/shared/twilio.md b/docs/models/twilio.md similarity index 100% rename from docs/models/shared/twilio.md rename to docs/models/twilio.md diff --git a/docs/models/shared/twiliotaskrouter.md b/docs/models/twiliotaskrouter.md similarity index 100% rename from docs/models/shared/twiliotaskrouter.md rename to docs/models/twiliotaskrouter.md diff --git a/docs/models/shared/twitter.md b/docs/models/twitter.md similarity index 100% rename from docs/models/shared/twitter.md rename to docs/models/twitter.md diff --git a/docs/models/shared/type.md b/docs/models/type.md similarity index 100% rename from docs/models/shared/type.md rename to docs/models/type.md diff --git a/docs/models/typeform.md b/docs/models/typeform.md new file mode 100644 index 00000000..da50592d --- /dev/null +++ b/docs/models/typeform.md @@ -0,0 +1,8 @@ +# Typeform + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `credentials` | [Optional[models.TypeformCredentials]](../models/typeformcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/typeformcredentials.md b/docs/models/typeformcredentials.md similarity index 100% rename from docs/models/shared/typeformcredentials.md rename to docs/models/typeformcredentials.md diff --git a/docs/models/shared/typesense.md b/docs/models/typesense.md similarity index 100% rename from docs/models/shared/typesense.md rename to docs/models/typesense.md diff --git a/docs/models/unencrypted.md b/docs/models/unencrypted.md new file mode 100644 index 00000000..28c5d145 --- /dev/null +++ b/docs/models/unencrypted.md @@ -0,0 +1,10 @@ +# Unencrypted + +Data transfer will not be encrypted. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `ssl_method` | [models.SourceMssqlSchemasSslMethod](../models/sourcemssqlschemassslmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/unexpectedfieldbehavior.md b/docs/models/unexpectedfieldbehavior.md similarity index 100% rename from docs/models/shared/unexpectedfieldbehavior.md rename to docs/models/unexpectedfieldbehavior.md diff --git a/docs/models/updatemethod.md b/docs/models/updatemethod.md new file mode 100644 index 00000000..f3450c7f --- /dev/null +++ b/docs/models/updatemethod.md @@ -0,0 +1,19 @@ +# UpdateMethod + +Configures how data is extracted from the database. + + +## Supported Types + +### ReadChangesUsingChangeDataCaptureCDC + +```python +updateMethod: models.ReadChangesUsingChangeDataCaptureCDC = /* values here */ +``` + +### ScanChangesWithUserDefinedCursor + +```python +updateMethod: models.ScanChangesWithUserDefinedCursor = /* values here */ +``` + diff --git a/docs/models/uploadingmethod.md b/docs/models/uploadingmethod.md new file mode 100644 index 00000000..79127778 --- /dev/null +++ b/docs/models/uploadingmethod.md @@ -0,0 +1,19 @@ +# UploadingMethod + +The way data will be uploaded to Redshift. + + +## Supported Types + +### AWSS3Staging + +```python +uploadingMethod: models.AWSS3Staging = /* values here */ +``` + +### Standard + +```python +uploadingMethod: models.Standard = /* values here */ +``` + diff --git a/docs/models/shared/urlbase.md b/docs/models/urlbase.md similarity index 100% rename from docs/models/shared/urlbase.md rename to docs/models/urlbase.md diff --git a/docs/models/shared/uscensus.md b/docs/models/uscensus.md similarity index 100% rename from docs/models/shared/uscensus.md rename to docs/models/uscensus.md diff --git a/docs/models/usernameandpassword.md b/docs/models/usernameandpassword.md new file mode 100644 index 00000000..943a66b8 --- /dev/null +++ b/docs/models/usernameandpassword.md @@ -0,0 +1,9 @@ +# UsernameAndPassword + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `password` | *str* | :heavy_check_mark: | Enter the password associated with the username. | +| `auth_type` | [Optional[models.DestinationSnowflakeAuthType]](../models/destinationsnowflakeauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/usernamepassword.md b/docs/models/usernamepassword.md new file mode 100644 index 00000000..2aedc445 --- /dev/null +++ b/docs/models/usernamepassword.md @@ -0,0 +1,12 @@ +# UsernamePassword + +Basic auth header with a username and password + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `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 | +| `method` | [models.DestinationElasticsearchSchemasMethod](../models/destinationelasticsearchschemasmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/userprovided.md b/docs/models/userprovided.md new file mode 100644 index 00000000..f4219d27 --- /dev/null +++ b/docs/models/userprovided.md @@ -0,0 +1,9 @@ +# UserProvided + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `column_names` | List[*str*] | :heavy_check_mark: | The column names that will be used while emitting the CSV records | +| `header_definition_type` | [Optional[models.SourceAzureBlobStorageSchemasHeaderDefinitionType]](../models/sourceazureblobstorageschemasheaderdefinitiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/validactionbreakdowns.md b/docs/models/validactionbreakdowns.md similarity index 92% rename from docs/models/shared/validactionbreakdowns.md rename to docs/models/validactionbreakdowns.md index 3a66b399..f51cd943 100644 --- a/docs/models/shared/validactionbreakdowns.md +++ b/docs/models/validactionbreakdowns.md @@ -16,4 +16,5 @@ An enumeration. | `ACTION_TARGET_ID` | action_target_id | | `ACTION_TYPE` | action_type | | `ACTION_VIDEO_SOUND` | action_video_sound | -| `ACTION_VIDEO_TYPE` | action_video_type | \ No newline at end of file +| `ACTION_VIDEO_TYPE` | action_video_type | +| `STANDARD_EVENT_CONTENT_TYPE` | standard_event_content_type | \ No newline at end of file diff --git a/docs/models/validadsetstatuses.md b/docs/models/validadsetstatuses.md new file mode 100644 index 00000000..ea587758 --- /dev/null +++ b/docs/models/validadsetstatuses.md @@ -0,0 +1,16 @@ +# ValidAdSetStatuses + +An enumeration. + + +## Values + +| Name | Value | +| ----------------- | ----------------- | +| `ACTIVE` | ACTIVE | +| `ARCHIVED` | ARCHIVED | +| `CAMPAIGN_PAUSED` | CAMPAIGN_PAUSED | +| `DELETED` | DELETED | +| `IN_PROCESS` | IN_PROCESS | +| `PAUSED` | PAUSED | +| `WITH_ISSUES` | WITH_ISSUES | \ No newline at end of file diff --git a/docs/models/validadstatuses.md b/docs/models/validadstatuses.md new file mode 100644 index 00000000..f038848b --- /dev/null +++ b/docs/models/validadstatuses.md @@ -0,0 +1,21 @@ +# ValidAdStatuses + +An enumeration. + + +## Values + +| Name | Value | +| ---------------------- | ---------------------- | +| `ACTIVE` | ACTIVE | +| `ADSET_PAUSED` | ADSET_PAUSED | +| `ARCHIVED` | ARCHIVED | +| `CAMPAIGN_PAUSED` | CAMPAIGN_PAUSED | +| `DELETED` | DELETED | +| `DISAPPROVED` | DISAPPROVED | +| `IN_PROCESS` | IN_PROCESS | +| `PAUSED` | PAUSED | +| `PENDING_BILLING_INFO` | PENDING_BILLING_INFO | +| `PENDING_REVIEW` | PENDING_REVIEW | +| `PREAPPROVED` | PREAPPROVED | +| `WITH_ISSUES` | WITH_ISSUES | \ No newline at end of file diff --git a/docs/models/shared/validationpolicy.md b/docs/models/validationpolicy.md similarity index 100% rename from docs/models/shared/validationpolicy.md rename to docs/models/validationpolicy.md diff --git a/docs/models/shared/validbreakdowns.md b/docs/models/validbreakdowns.md similarity index 75% rename from docs/models/shared/validbreakdowns.md rename to docs/models/validbreakdowns.md index 47fc4583..afc8fd59 100644 --- a/docs/models/shared/validbreakdowns.md +++ b/docs/models/validbreakdowns.md @@ -26,7 +26,16 @@ An enumeration. | `IMAGE_ASSET` | image_asset | | `IMPRESSION_DEVICE` | impression_device | | `IS_CONVERSION_ID_MODELED` | is_conversion_id_modeled | +| `LANDING_DESTINATION` | landing_destination | | `LINK_URL_ASSET` | link_url_asset | +| `MARKETING_MESSAGES_BTN_NAME` | marketing_messages_btn_name | +| `MDSA_LANDING_DESTINATION` | mdsa_landing_destination | +| `MEDIA_ASSET_URL` | media_asset_url | +| `MEDIA_CREATOR` | media_creator | +| `MEDIA_DESTINATION_URL` | media_destination_url | +| `MEDIA_FORMAT` | media_format | +| `MEDIA_ORIGIN_URL` | media_origin_url | +| `MEDIA_TEXT_CONTENT` | media_text_content | | `MMM` | mmm | | `PLACE_PAGE_ID` | place_page_id | | `PLATFORM_POSITION` | platform_position | @@ -37,5 +46,7 @@ An enumeration. | `REGION` | region | | `SKAN_CAMPAIGN_ID` | skan_campaign_id | | `SKAN_CONVERSION_ID` | skan_conversion_id | +| `SKAN_VERSION` | skan_version | +| `STANDARD_EVENT_CONTENT_TYPE` | standard_event_content_type | | `TITLE_ASSET` | title_asset | | `VIDEO_ASSET` | video_asset | \ No newline at end of file diff --git a/docs/models/validcampaignstatuses.md b/docs/models/validcampaignstatuses.md new file mode 100644 index 00000000..db58aa0d --- /dev/null +++ b/docs/models/validcampaignstatuses.md @@ -0,0 +1,15 @@ +# ValidCampaignStatuses + +An enumeration. + + +## Values + +| Name | Value | +| ------------- | ------------- | +| `ACTIVE` | ACTIVE | +| `ARCHIVED` | ARCHIVED | +| `DELETED` | DELETED | +| `IN_PROCESS` | IN_PROCESS | +| `PAUSED` | PAUSED | +| `WITH_ISSUES` | WITH_ISSUES | \ No newline at end of file diff --git a/docs/models/shared/validenums.md b/docs/models/validenums.md similarity index 100% rename from docs/models/shared/validenums.md rename to docs/models/validenums.md diff --git a/docs/models/value.md b/docs/models/value.md new file mode 100644 index 00000000..7a8093ea --- /dev/null +++ b/docs/models/value.md @@ -0,0 +1,17 @@ +# Value + + +## Supported Types + +### Int64Value + +```python +value: models.Int64Value = /* values here */ +``` + +### DoubleValue + +```python +value: models.DoubleValue = /* values here */ +``` + diff --git a/docs/models/shared/valuetype.md b/docs/models/valuetype.md similarity index 100% rename from docs/models/shared/valuetype.md rename to docs/models/valuetype.md diff --git a/docs/models/shared/vantage.md b/docs/models/vantage.md similarity index 100% rename from docs/models/shared/vantage.md rename to docs/models/vantage.md diff --git a/docs/models/shared/vectara.md b/docs/models/vectara.md similarity index 100% rename from docs/models/shared/vectara.md rename to docs/models/vectara.md diff --git a/docs/models/verifyca.md b/docs/models/verifyca.md new file mode 100644 index 00000000..42724e7d --- /dev/null +++ b/docs/models/verifyca.md @@ -0,0 +1,12 @@ +# VerifyCa + +Verify-ca SSL mode. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `ca_certificate` | *str* | :heavy_check_mark: | CA certificate | +| `client_key_password` | *Optional[str]* | :heavy_minus_sign: | Password for keystorage. This field is optional. If you do not add it - the password will be generated automatically. | +| `mode` | [Optional[models.DestinationPostgresSchemasSSLModeSSLModesMode]](../models/destinationpostgresschemassslmodesslmodesmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/verifyfull.md b/docs/models/verifyfull.md new file mode 100644 index 00000000..2c92e8d5 --- /dev/null +++ b/docs/models/verifyfull.md @@ -0,0 +1,14 @@ +# VerifyFull + +Verify-full SSL mode. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `ca_certificate` | *str* | :heavy_check_mark: | CA certificate | +| `client_certificate` | *str* | :heavy_check_mark: | Client certificate | +| `client_key` | *str* | :heavy_check_mark: | Client key | +| `client_key_password` | *Optional[str]* | :heavy_minus_sign: | Password for keystorage. This field is optional. If you do not add it - the password will be generated automatically. | +| `mode` | [Optional[models.DestinationPostgresSchemasSSLModeSSLModes6Mode]](../models/destinationpostgresschemassslmodesslmodes6mode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/verifyidentity.md b/docs/models/verifyidentity.md similarity index 96% rename from docs/models/shared/verifyidentity.md rename to docs/models/verifyidentity.md index a635416d..0bc95a00 100644 --- a/docs/models/shared/verifyidentity.md +++ b/docs/models/verifyidentity.md @@ -11,4 +11,4 @@ Always connect with SSL. Verify both CA and Hostname. | `client_certificate` | *Optional[str]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | Password for keystorage. This field is optional. If you do not add it - the password will be generated automatically. | -| `mode` | [shared.SourceMysqlSchemasSSLModeSSLModesMode](../../models/shared/sourcemysqlschemassslmodesslmodesmode.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `mode` | [models.SourceMysqlSchemasSSLModeSSLModesMode](../models/sourcemysqlschemassslmodesslmodesmode.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/viewattributionwindow.md b/docs/models/viewattributionwindow.md new file mode 100644 index 00000000..96dcd3fe --- /dev/null +++ b/docs/models/viewattributionwindow.md @@ -0,0 +1,14 @@ +# ViewAttributionWindow + +Attribution window for views. + + +## Values + +| Name | Value | +| ------------ | ------------ | +| `ONE_HOUR` | 1_HOUR | +| `THREE_HOUR` | 3_HOUR | +| `SIX_HOUR` | 6_HOUR | +| `ONE_DAY` | 1_DAY | +| `SEVEN_DAY` | 7_DAY | \ No newline at end of file diff --git a/docs/models/shared/viewwindowdays.md b/docs/models/viewwindowdays.md similarity index 100% rename from docs/models/shared/viewwindowdays.md rename to docs/models/viewwindowdays.md diff --git a/docs/models/shared/weaviate.md b/docs/models/weaviate.md similarity index 100% rename from docs/models/shared/weaviate.md rename to docs/models/weaviate.md diff --git a/docs/models/shared/webflow.md b/docs/models/webflow.md similarity index 100% rename from docs/models/shared/webflow.md rename to docs/models/webflow.md diff --git a/docs/models/shared/whiskyhunter.md b/docs/models/whiskyhunter.md similarity index 100% rename from docs/models/shared/whiskyhunter.md rename to docs/models/whiskyhunter.md diff --git a/docs/models/shared/wikipediapageviews.md b/docs/models/wikipediapageviews.md similarity index 100% rename from docs/models/shared/wikipediapageviews.md rename to docs/models/wikipediapageviews.md diff --git a/docs/models/shared/woocommerce.md b/docs/models/woocommerce.md similarity index 100% rename from docs/models/shared/woocommerce.md rename to docs/models/woocommerce.md diff --git a/docs/models/shared/workspacecreaterequest.md b/docs/models/workspacecreaterequest.md similarity index 100% rename from docs/models/shared/workspacecreaterequest.md rename to docs/models/workspacecreaterequest.md diff --git a/docs/models/shared/workspaceoauthcredentialsrequest.md b/docs/models/workspaceoauthcredentialsrequest.md similarity index 86% rename from docs/models/shared/workspaceoauthcredentialsrequest.md rename to docs/models/workspaceoauthcredentialsrequest.md index 7186b083..27f05bdf 100644 --- a/docs/models/shared/workspaceoauthcredentialsrequest.md +++ b/docs/models/workspaceoauthcredentialsrequest.md @@ -5,8 +5,8 @@ POST body for creating/updating workspace level OAuth credentials ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `actor_type` | [shared.ActorTypeEnum](../../models/shared/actortypeenum.md) | :heavy_check_mark: | Whether you're setting this override for a source or destination | | -| `configuration` | [Union[shared.Airtable, shared.AmazonAds, shared.AmazonSellerPartner, shared.Asana, shared.BingAds, shared.FacebookMarketing, shared.Github, shared.Gitlab, shared.GoogleAds, shared.GoogleAnalyticsDataAPI, shared.GoogleDrive, shared.GoogleSearchConsole, shared.GoogleSheets, shared.Harvest, shared.Hubspot, shared.Instagram, shared.Intercom, shared.LeverHiring, shared.LinkedinAds, shared.Mailchimp, shared.MicrosoftSharepoint, shared.MicrosoftTeams, shared.Monday, shared.Notion, shared.Pinterest, shared.Retently, shared.Salesforce, shared.Shopify, shared.Slack, shared.Smartsheets, shared.SnapchatMarketing, shared.Snowflake, shared.Square, shared.Strava, shared.Surveymonkey, shared.TiktokMarketing, Any, shared.Typeform, shared.YoutubeAnalytics, shared.ZendeskChat, shared.ZendeskSunshine, shared.ZendeskSupport, shared.ZendeskTalk]](../../models/shared/oauthcredentialsconfiguration.md) | :heavy_check_mark: | The values required to configure the source. | {
    "user": "charles"
    } | -| `name` | [shared.OAuthActorNames](../../models/shared/oauthactornames.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `actor_type` | [models.ActorTypeEnum](../models/actortypeenum.md) | :heavy_check_mark: | Whether you're setting this override for a source or destination | | +| `configuration` | [Union[models.Airtable, models.AmazonAds, models.AmazonSellerPartner, models.Asana, models.BingAds, models.FacebookMarketing, models.Github, models.Gitlab, models.GoogleAds, models.GoogleAnalyticsDataAPI, models.GoogleDrive, models.GoogleSearchConsole, models.GoogleSheets, models.Harvest, models.Hubspot, models.Instagram, models.Intercom, models.LeverHiring, models.LinkedinAds, models.Mailchimp, models.MicrosoftOnedrive, models.MicrosoftSharepoint, models.MicrosoftTeams, models.Monday, models.Notion, models.Pinterest, models.Retently, models.Salesforce, models.Shopify, models.Slack, models.Smartsheets, models.SnapchatMarketing, models.Snowflake, models.Square, models.Strava, models.Surveymonkey, models.TiktokMarketing, Any, models.Typeform, models.YoutubeAnalytics, models.ZendeskChat, models.ZendeskSunshine, models.ZendeskSupport, models.ZendeskTalk]](../models/oauthcredentialsconfiguration.md) | :heavy_check_mark: | The values required to configure the source. | {
    "user": "charles"
    } | +| `name` | [models.OAuthActorNames](../models/oauthactornames.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/workspaceresponse.md b/docs/models/workspaceresponse.md new file mode 100644 index 00000000..6cb7b18a --- /dev/null +++ b/docs/models/workspaceresponse.md @@ -0,0 +1,12 @@ +# WorkspaceResponse + +Provides details of a single workspace. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `name` | *str* | :heavy_check_mark: | N/A | +| `workspace_id` | *str* | :heavy_check_mark: | N/A | +| `data_residency` | [Optional[models.GeographyEnum]](../models/geographyenum.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/workspacesresponse.md b/docs/models/workspacesresponse.md new file mode 100644 index 00000000..c6df70ed --- /dev/null +++ b/docs/models/workspacesresponse.md @@ -0,0 +1,10 @@ +# WorkspacesResponse + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | +| `data` | List[[models.WorkspaceResponse](../models/workspaceresponse.md)] | :heavy_check_mark: | N/A | +| `next` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `previous` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/workspaceupdaterequest.md b/docs/models/workspaceupdaterequest.md similarity index 100% rename from docs/models/shared/workspaceupdaterequest.md rename to docs/models/workspaceupdaterequest.md diff --git a/docs/models/shared/xkcd.md b/docs/models/xkcd.md similarity index 100% rename from docs/models/shared/xkcd.md rename to docs/models/xkcd.md diff --git a/docs/models/shared/xz.md b/docs/models/xz.md similarity index 98% rename from docs/models/shared/xz.md rename to docs/models/xz.md index 535eba78..1c091ab8 100644 --- a/docs/models/shared/xz.md +++ b/docs/models/xz.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `codec` | [Optional[shared.DestinationGcsSchemasFormatCodec]](../../models/shared/destinationgcsschemasformatcodec.md) | :heavy_minus_sign: | N/A | +| `codec` | [Optional[models.DestinationGcsSchemasFormatCodec]](../models/destinationgcsschemasformatcodec.md) | :heavy_minus_sign: | N/A | | `compression_level` | *Optional[int]* | :heavy_minus_sign: | The presets 0-3 are fast presets with medium compression. The presets 4-6 are fairly slow presets with high compression. The default preset is 6. The presets 7-9 are like the preset 6 but use bigger dictionaries and have higher compressor and decompressor memory requirements. Unless the uncompressed size of the file exceeds 8 MiB, 16 MiB, or 32 MiB, it is waste of memory to use the presets 7, 8, or 9, respectively. Read more here for details. | \ No newline at end of file diff --git a/docs/models/shared/yandexmetrica.md b/docs/models/yandexmetrica.md similarity index 100% rename from docs/models/shared/yandexmetrica.md rename to docs/models/yandexmetrica.md diff --git a/docs/models/shared/yotpo.md b/docs/models/yotpo.md similarity index 100% rename from docs/models/shared/yotpo.md rename to docs/models/yotpo.md diff --git a/docs/models/youtubeanalytics.md b/docs/models/youtubeanalytics.md new file mode 100644 index 00000000..d55a97cb --- /dev/null +++ b/docs/models/youtubeanalytics.md @@ -0,0 +1,8 @@ +# YoutubeAnalytics + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `credentials` | [Optional[models.YoutubeAnalyticsCredentials]](../models/youtubeanalyticscredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/youtubeanalyticscredentials.md b/docs/models/youtubeanalyticscredentials.md similarity index 100% rename from docs/models/shared/youtubeanalyticscredentials.md rename to docs/models/youtubeanalyticscredentials.md diff --git a/docs/models/zendeskchat.md b/docs/models/zendeskchat.md new file mode 100644 index 00000000..5e633975 --- /dev/null +++ b/docs/models/zendeskchat.md @@ -0,0 +1,8 @@ +# ZendeskChat + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `credentials` | [Optional[models.ZendeskChatCredentials]](../models/zendeskchatcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/zendeskchatcredentials.md b/docs/models/zendeskchatcredentials.md similarity index 100% rename from docs/models/shared/zendeskchatcredentials.md rename to docs/models/zendeskchatcredentials.md diff --git a/docs/models/shared/zendesksell.md b/docs/models/zendesksell.md similarity index 100% rename from docs/models/shared/zendesksell.md rename to docs/models/zendesksell.md diff --git a/docs/models/zendesksunshine.md b/docs/models/zendesksunshine.md new file mode 100644 index 00000000..3441ca75 --- /dev/null +++ b/docs/models/zendesksunshine.md @@ -0,0 +1,8 @@ +# ZendeskSunshine + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `credentials` | [Optional[models.ZendeskSunshineCredentials]](../models/zendesksunshinecredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/zendesksunshinecredentials.md b/docs/models/zendesksunshinecredentials.md similarity index 100% rename from docs/models/shared/zendesksunshinecredentials.md rename to docs/models/zendesksunshinecredentials.md diff --git a/docs/models/zendesksupport.md b/docs/models/zendesksupport.md new file mode 100644 index 00000000..016cc460 --- /dev/null +++ b/docs/models/zendesksupport.md @@ -0,0 +1,8 @@ +# ZendeskSupport + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `credentials` | [Optional[models.ZendeskSupportCredentials]](../models/zendesksupportcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/zendesksupportcredentials.md b/docs/models/zendesksupportcredentials.md similarity index 100% rename from docs/models/shared/zendesksupportcredentials.md rename to docs/models/zendesksupportcredentials.md diff --git a/docs/models/zendesktalk.md b/docs/models/zendesktalk.md new file mode 100644 index 00000000..92a0b3a7 --- /dev/null +++ b/docs/models/zendesktalk.md @@ -0,0 +1,8 @@ +# ZendeskTalk + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `credentials` | [Optional[models.ZendeskTalkCredentials]](../models/zendesktalkcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/zendesktalkcredentials.md b/docs/models/zendesktalkcredentials.md similarity index 100% rename from docs/models/shared/zendesktalkcredentials.md rename to docs/models/zendesktalkcredentials.md diff --git a/docs/models/shared/zenloop.md b/docs/models/zenloop.md similarity index 100% rename from docs/models/shared/zenloop.md rename to docs/models/zenloop.md diff --git a/docs/models/shared/zohocrm.md b/docs/models/zohocrm.md similarity index 100% rename from docs/models/shared/zohocrm.md rename to docs/models/zohocrm.md diff --git a/docs/models/shared/zohocrmedition.md b/docs/models/zohocrmedition.md similarity index 100% rename from docs/models/shared/zohocrmedition.md rename to docs/models/zohocrmedition.md diff --git a/docs/models/shared/zoom.md b/docs/models/zoom.md similarity index 100% rename from docs/models/shared/zoom.md rename to docs/models/zoom.md diff --git a/docs/models/shared/zstandard.md b/docs/models/zstandard.md similarity index 93% rename from docs/models/shared/zstandard.md rename to docs/models/zstandard.md index 60e97120..0209044b 100644 --- a/docs/models/shared/zstandard.md +++ b/docs/models/zstandard.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `codec` | [Optional[shared.DestinationGcsSchemasFormatOutputFormatCodec]](../../models/shared/destinationgcsschemasformatoutputformatcodec.md) | :heavy_minus_sign: | N/A | +| `codec` | [Optional[models.DestinationGcsSchemasFormatOutputFormatCodec]](../models/destinationgcsschemasformatoutputformatcodec.md) | :heavy_minus_sign: | N/A | | `compression_level` | *Optional[int]* | :heavy_minus_sign: | Negative levels are 'fast' modes akin to lz4 or snappy, levels above 9 are generally for archival purposes, and levels above 18 use a lot of memory. | | `include_checksum` | *Optional[bool]* | :heavy_minus_sign: | If true, include a checksum with each data block. | \ No newline at end of file diff --git a/docs/sdks/airbyte/README.md b/docs/sdks/airbyte/README.md deleted file mode 100644 index 084117b3..00000000 --- a/docs/sdks/airbyte/README.md +++ /dev/null @@ -1,9 +0,0 @@ -# Airbyte SDK - - -## Overview - -airbyte-api: Programatically control Airbyte Cloud, OSS & Enterprise. - -### Available Operations - diff --git a/docs/sdks/airbyteapi/README.md b/docs/sdks/airbyteapi/README.md new file mode 100644 index 00000000..d29ba0f9 --- /dev/null +++ b/docs/sdks/airbyteapi/README.md @@ -0,0 +1,9 @@ +# AirbyteAPI SDK + + +## Overview + +airbyte-api: Programmatically control Airbyte Cloud, OSS & Enterprise. + +### Available Operations + diff --git a/docs/sdks/connections/README.md b/docs/sdks/connections/README.md index 9e751c64..b8c7c0f3 100644 --- a/docs/sdks/connections/README.md +++ b/docs/sdks/connections/README.md @@ -16,19 +16,19 @@ Create a connection ### Example Usage ```python -import airbyte -from airbyte.models import shared +import airbyte_api +from airbyte_api import models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = shared.ConnectionCreateRequest( +req = models.ConnectionCreateRequest( destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', source_id='6dd427d8-3a55-4584-b835-842325b6c7b3', namespace_format='${SOURCE_NAMESPACE}', @@ -39,23 +39,24 @@ res = s.connections.create_connection(req) if res.connection_response is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `request` | [shared.ConnectionCreateRequest](../../models/shared/connectioncreaterequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `request` | [models.ConnectionCreateRequest](../../models/connectioncreaterequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.CreateConnectionResponse](../../models/operations/createconnectionresponse.md)** +**[api.CreateConnectionResponse](../../api/createconnectionresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | ## delete_connection @@ -64,44 +65,45 @@ Delete a Connection ### Example Usage ```python -import airbyte -from airbyte.models import operations, shared +import airbyte_api +from airbyte_api import api, models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = operations.DeleteConnectionRequest( +req = api.DeleteConnectionRequest( connection_id='', ) res = s.connections.delete_connection(req) -if res.status_code == 200: +if res is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `request` | [operations.DeleteConnectionRequest](../../models/operations/deleteconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `request` | [api.DeleteConnectionRequest](../../api/deleteconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.DeleteConnectionResponse](../../models/operations/deleteconnectionresponse.md)** +**[api.DeleteConnectionResponse](../../api/deleteconnectionresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | ## get_connection @@ -110,19 +112,19 @@ Get Connection details ### Example Usage ```python -import airbyte -from airbyte.models import operations, shared +import airbyte_api +from airbyte_api import api, models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = operations.GetConnectionRequest( +req = api.GetConnectionRequest( connection_id='', ) @@ -131,23 +133,24 @@ res = s.connections.get_connection(req) if res.connection_response is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `request` | [operations.GetConnectionRequest](../../models/operations/getconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | +| `request` | [api.GetConnectionRequest](../../api/getconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.GetConnectionResponse](../../models/operations/getconnectionresponse.md)** +**[api.GetConnectionResponse](../../api/getconnectionresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | ## list_connections @@ -156,42 +159,43 @@ List connections ### Example Usage ```python -import airbyte -from airbyte.models import operations, shared +import airbyte_api +from airbyte_api import api, models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = operations.ListConnectionsRequest() +req = api.ListConnectionsRequest() res = s.connections.list_connections(req) if res.connections_response is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `request` | [operations.ListConnectionsRequest](../../models/operations/listconnectionsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | +| `request` | [api.ListConnectionsRequest](../../api/listconnectionsrequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.ListConnectionsResponse](../../models/operations/listconnectionsresponse.md)** +**[api.ListConnectionsResponse](../../api/listconnectionsresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | ## patch_connection @@ -200,20 +204,20 @@ Update Connection details ### Example Usage ```python -import airbyte -from airbyte.models import operations, shared +import airbyte_api +from airbyte_api import api, models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = operations.PatchConnectionRequest( - connection_patch_request=shared.ConnectionPatchRequest( +req = api.PatchConnectionRequest( + connection_patch_request=models.ConnectionPatchRequest( namespace_format='${SOURCE_NAMESPACE}', ), connection_id='', @@ -224,20 +228,21 @@ res = s.connections.patch_connection(req) if res.connection_response is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `request` | [operations.PatchConnectionRequest](../../models/operations/patchconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | +| `request` | [api.PatchConnectionRequest](../../api/patchconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.PatchConnectionResponse](../../models/operations/patchconnectionresponse.md)** +**[api.PatchConnectionResponse](../../api/patchconnectionresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | diff --git a/docs/sdks/destinations/README.md b/docs/sdks/destinations/README.md index a50bdb73..e57d837c 100644 --- a/docs/sdks/destinations/README.md +++ b/docs/sdks/destinations/README.md @@ -17,21 +17,21 @@ Creates a destination given a name, workspace id, and a json blob containing the ### Example Usage ```python -import airbyte -from airbyte.models import shared +import airbyte_api +from airbyte_api import models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = shared.DestinationCreateRequest( - configuration=shared.DestinationGoogleSheets( - credentials=shared.AuthenticationViaGoogleOAuth( +req = models.DestinationCreateRequest( + configuration=models.DestinationGoogleSheets( + credentials=models.AuthenticationViaGoogleOAuth( client_id='', client_secret='', refresh_token='', @@ -47,23 +47,24 @@ res = s.destinations.create_destination(req) if res.destination_response is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `request` | [shared.DestinationCreateRequest](../../models/shared/destinationcreaterequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| `request` | [models.DestinationCreateRequest](../../models/destinationcreaterequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.CreateDestinationResponse](../../models/operations/createdestinationresponse.md)** +**[api.CreateDestinationResponse](../../api/createdestinationresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | ## delete_destination @@ -72,44 +73,45 @@ Delete a Destination ### Example Usage ```python -import airbyte -from airbyte.models import operations, shared +import airbyte_api +from airbyte_api import api, models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = operations.DeleteDestinationRequest( +req = api.DeleteDestinationRequest( destination_id='', ) res = s.destinations.delete_destination(req) -if res.status_code == 200: +if res is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteDestinationRequest](../../models/operations/deletedestinationrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | +| `request` | [api.DeleteDestinationRequest](../../api/deletedestinationrequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.DeleteDestinationResponse](../../models/operations/deletedestinationresponse.md)** +**[api.DeleteDestinationResponse](../../api/deletedestinationresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | ## get_destination @@ -118,19 +120,19 @@ Get Destination details ### Example Usage ```python -import airbyte -from airbyte.models import operations, shared +import airbyte_api +from airbyte_api import api, models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = operations.GetDestinationRequest( +req = api.GetDestinationRequest( destination_id='', ) @@ -139,23 +141,24 @@ res = s.destinations.get_destination(req) if res.destination_response is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `request` | [operations.GetDestinationRequest](../../models/operations/getdestinationrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | +| `request` | [api.GetDestinationRequest](../../api/getdestinationrequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.GetDestinationResponse](../../models/operations/getdestinationresponse.md)** +**[api.GetDestinationResponse](../../api/getdestinationresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | ## list_destinations @@ -164,42 +167,43 @@ List destinations ### Example Usage ```python -import airbyte -from airbyte.models import operations, shared +import airbyte_api +from airbyte_api import api, models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = operations.ListDestinationsRequest() +req = api.ListDestinationsRequest() res = s.destinations.list_destinations(req) if res.destinations_response is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `request` | [operations.ListDestinationsRequest](../../models/operations/listdestinationsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `request` | [api.ListDestinationsRequest](../../api/listdestinationsrequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.ListDestinationsResponse](../../models/operations/listdestinationsresponse.md)** +**[api.ListDestinationsResponse](../../api/listdestinationsresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | ## patch_destination @@ -208,19 +212,19 @@ Update a Destination ### Example Usage ```python -import airbyte -from airbyte.models import operations, shared +import airbyte_api +from airbyte_api import api, models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = operations.PatchDestinationRequest( +req = api.PatchDestinationRequest( destination_id='', ) @@ -229,23 +233,24 @@ res = s.destinations.patch_destination(req) if res.destination_response is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `request` | [operations.PatchDestinationRequest](../../models/operations/patchdestinationrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `request` | [api.PatchDestinationRequest](../../api/patchdestinationrequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.PatchDestinationResponse](../../models/operations/patchdestinationresponse.md)** +**[api.PatchDestinationResponse](../../api/patchdestinationresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | ## put_destination @@ -254,19 +259,19 @@ Update a Destination and fully overwrite it ### Example Usage ```python -import airbyte -from airbyte.models import operations, shared +import airbyte_api +from airbyte_api import api, models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = operations.PutDestinationRequest( +req = api.PutDestinationRequest( destination_id='', ) @@ -275,20 +280,21 @@ res = s.destinations.put_destination(req) if res.destination_response is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `request` | [operations.PutDestinationRequest](../../models/operations/putdestinationrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | +| `request` | [api.PutDestinationRequest](../../api/putdestinationrequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.PutDestinationResponse](../../models/operations/putdestinationresponse.md)** +**[api.PutDestinationResponse](../../api/putdestinationresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | diff --git a/docs/sdks/jobs/README.md b/docs/sdks/jobs/README.md index 81dc3c09..b34e8b4c 100644 --- a/docs/sdks/jobs/README.md +++ b/docs/sdks/jobs/README.md @@ -15,19 +15,19 @@ Cancel a running Job ### Example Usage ```python -import airbyte -from airbyte.models import operations, shared +import airbyte_api +from airbyte_api import api, models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = operations.CancelJobRequest( +req = api.CancelJobRequest( job_id=801771, ) @@ -36,23 +36,24 @@ res = s.jobs.cancel_job(req) if res.job_response is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `request` | [operations.CancelJobRequest](../../models/operations/canceljobrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | +| `request` | [api.CancelJobRequest](../../api/canceljobrequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.CancelJobResponse](../../models/operations/canceljobresponse.md)** +**[api.CancelJobResponse](../../api/canceljobresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | ## create_job @@ -61,21 +62,21 @@ Trigger a sync or reset job of a connection ### Example Usage ```python -import airbyte -from airbyte.models import shared +import airbyte_api +from airbyte_api import models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = shared.JobCreateRequest( +req = models.JobCreateRequest( connection_id='18dccc91-0ab1-4f72-9ed7-0b8fc27c5826', - job_type=shared.JobTypeEnum.SYNC, + job_type=models.JobTypeEnum.SYNC, ) res = s.jobs.create_job(req) @@ -83,23 +84,24 @@ res = s.jobs.create_job(req) if res.job_response is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `request` | [shared.JobCreateRequest](../../models/shared/jobcreaterequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `request` | [models.JobCreateRequest](../../models/jobcreaterequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.CreateJobResponse](../../models/operations/createjobresponse.md)** +**[api.CreateJobResponse](../../api/createjobresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | ## get_job @@ -108,19 +110,19 @@ Get Job status and details ### Example Usage ```python -import airbyte -from airbyte.models import operations, shared +import airbyte_api +from airbyte_api import api, models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = operations.GetJobRequest( +req = api.GetJobRequest( job_id=131101, ) @@ -129,23 +131,24 @@ res = s.jobs.get_job(req) if res.job_response is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `request` | [operations.GetJobRequest](../../models/operations/getjobrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | +| `request` | [api.GetJobRequest](../../api/getjobrequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.GetJobResponse](../../models/operations/getjobresponse.md)** +**[api.GetJobResponse](../../api/getjobresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | ## list_jobs @@ -154,39 +157,40 @@ List Jobs by sync type ### Example Usage ```python -import airbyte -from airbyte.models import operations, shared +import airbyte_api +from airbyte_api import api, models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = operations.ListJobsRequest() +req = api.ListJobsRequest() res = s.jobs.list_jobs(req) if res.jobs_response is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `request` | [operations.ListJobsRequest](../../models/operations/listjobsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | +| `request` | [api.ListJobsRequest](../../api/listjobsrequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.ListJobsResponse](../../models/operations/listjobsresponse.md)** +**[api.ListJobsResponse](../../api/listjobsresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | diff --git a/docs/sdks/sources/README.md b/docs/sdks/sources/README.md index f9de55da..d684b3b3 100644 --- a/docs/sdks/sources/README.md +++ b/docs/sdks/sources/README.md @@ -18,20 +18,20 @@ Creates a source given a name, workspace id, and a json blob containing the conf ### Example Usage ```python -import airbyte -from airbyte.models import shared +import airbyte_api +from airbyte_api import models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = shared.SourceCreateRequest( - configuration=shared.SourceAha( +req = models.SourceCreateRequest( + configuration=models.SourceAha( api_key='', url='https://complicated-seat.org', ), @@ -44,23 +44,24 @@ res = s.sources.create_source(req) if res.source_response is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `request` | [shared.SourceCreateRequest](../../models/shared/sourcecreaterequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | +| `request` | [models.SourceCreateRequest](../../models/sourcecreaterequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.CreateSourceResponse](../../models/operations/createsourceresponse.md)** +**[api.CreateSourceResponse](../../api/createsourceresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | ## delete_source @@ -69,44 +70,45 @@ Delete a Source ### Example Usage ```python -import airbyte -from airbyte.models import operations, shared +import airbyte_api +from airbyte_api import api, models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = operations.DeleteSourceRequest( +req = api.DeleteSourceRequest( source_id='', ) res = s.sources.delete_source(req) -if res.status_code == 200: +if res is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `request` | [operations.DeleteSourceRequest](../../models/operations/deletesourcerequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `request` | [api.DeleteSourceRequest](../../api/deletesourcerequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.DeleteSourceResponse](../../models/operations/deletesourceresponse.md)** +**[api.DeleteSourceResponse](../../api/deletesourceresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | ## get_source @@ -115,19 +117,19 @@ Get Source details ### Example Usage ```python -import airbyte -from airbyte.models import operations, shared +import airbyte_api +from airbyte_api import api, models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = operations.GetSourceRequest( +req = api.GetSourceRequest( source_id='', ) @@ -136,23 +138,24 @@ res = s.sources.get_source(req) if res.source_response is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `request` | [operations.GetSourceRequest](../../models/operations/getsourcerequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | +| `request` | [api.GetSourceRequest](../../api/getsourcerequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.GetSourceResponse](../../models/operations/getsourceresponse.md)** +**[api.GetSourceResponse](../../api/getsourceresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | ## initiate_o_auth @@ -165,47 +168,48 @@ That secret ID can be used to create a source with credentials in place of actua ### Example Usage ```python -import airbyte -from airbyte.models import shared +import airbyte_api +from airbyte_api import models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = shared.InitiateOauthRequest( +req = models.InitiateOauthRequest( redirect_url='https://cloud.airbyte.io/v1/api/oauth/callback', - source_type=shared.OAuthActorNames.GOOGLE_ADS, + source_type=models.OAuthActorNames.GOOGLE_ADS, workspace_id='871d9b60-11d1-44cb-8c92-c246d53bf87e', - o_auth_input_configuration=shared.OAuthInputConfiguration(), + o_auth_input_configuration=models.OAuthInputConfiguration(), ) res = s.sources.initiate_o_auth(req) -if res.status_code == 200: +if res is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `request` | [shared.InitiateOauthRequest](../../models/shared/initiateoauthrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `request` | [models.InitiateOauthRequest](../../models/initiateoauthrequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.InitiateOAuthResponse](../../models/operations/initiateoauthresponse.md)** +**[api.InitiateOAuthResponse](../../api/initiateoauthresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | ## list_sources @@ -214,42 +218,43 @@ List sources ### Example Usage ```python -import airbyte -from airbyte.models import operations, shared +import airbyte_api +from airbyte_api import api, models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = operations.ListSourcesRequest() +req = api.ListSourcesRequest() res = s.sources.list_sources(req) if res.sources_response is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `request` | [operations.ListSourcesRequest](../../models/operations/listsourcesrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | +| `request` | [api.ListSourcesRequest](../../api/listsourcesrequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.ListSourcesResponse](../../models/operations/listsourcesresponse.md)** +**[api.ListSourcesResponse](../../api/listsourcesresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | ## patch_source @@ -258,19 +263,19 @@ Update a Source ### Example Usage ```python -import airbyte -from airbyte.models import operations, shared +import airbyte_api +from airbyte_api import api, models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = operations.PatchSourceRequest( +req = api.PatchSourceRequest( source_id='', ) @@ -279,23 +284,24 @@ res = s.sources.patch_source(req) if res.source_response is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `request` | [operations.PatchSourceRequest](../../models/operations/patchsourcerequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | +| `request` | [api.PatchSourceRequest](../../api/patchsourcerequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.PatchSourceResponse](../../models/operations/patchsourceresponse.md)** +**[api.PatchSourceResponse](../../api/patchsourceresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | ## put_source @@ -304,19 +310,19 @@ Update a Source and fully overwrite it ### Example Usage ```python -import airbyte -from airbyte.models import operations, shared +import airbyte_api +from airbyte_api import api, models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = operations.PutSourceRequest( +req = api.PutSourceRequest( source_id='', ) @@ -325,20 +331,21 @@ res = s.sources.put_source(req) if res.source_response is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `request` | [operations.PutSourceRequest](../../models/operations/putsourcerequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | +| `request` | [api.PutSourceRequest](../../api/putsourcerequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.PutSourceResponse](../../models/operations/putsourceresponse.md)** +**[api.PutSourceResponse](../../api/putsourceresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | diff --git a/docs/sdks/streams/README.md b/docs/sdks/streams/README.md index 84d3f9ec..983561b1 100644 --- a/docs/sdks/streams/README.md +++ b/docs/sdks/streams/README.md @@ -12,19 +12,19 @@ Get stream properties ### Example Usage ```python -import airbyte -from airbyte.models import operations, shared +import airbyte_api +from airbyte_api import api, models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = operations.GetStreamPropertiesRequest( +req = api.GetStreamPropertiesRequest( destination_id='', source_id='', ) @@ -34,20 +34,21 @@ res = s.streams.get_stream_properties(req) if res.stream_properties_response is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `request` | [operations.GetStreamPropertiesRequest](../../models/operations/getstreampropertiesrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `request` | [api.GetStreamPropertiesRequest](../../api/getstreampropertiesrequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.GetStreamPropertiesResponse](../../models/operations/getstreampropertiesresponse.md)** +**[api.GetStreamPropertiesResponse](../../api/getstreampropertiesresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | diff --git a/docs/sdks/workspaces/README.md b/docs/sdks/workspaces/README.md index 55ac5e35..7cd611a9 100644 --- a/docs/sdks/workspaces/README.md +++ b/docs/sdks/workspaces/README.md @@ -18,49 +18,50 @@ In order to determine what the credential configuration needs to be, please see ### Example Usage ```python -import airbyte -from airbyte.models import operations, shared +import airbyte_api +from airbyte_api import api, models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = operations.CreateOrUpdateWorkspaceOAuthCredentialsRequest( - workspace_o_auth_credentials_request=shared.WorkspaceOAuthCredentialsRequest( - actor_type=shared.ActorTypeEnum.DESTINATION, - configuration=shared.Airtable(), - name=shared.OAuthActorNames.AMAZON_ADS, +req = api.CreateOrUpdateWorkspaceOAuthCredentialsRequest( + workspace_o_auth_credentials_request=models.WorkspaceOAuthCredentialsRequest( + actor_type=models.ActorTypeEnum.DESTINATION, + configuration=models.Airtable(), + name=models.OAuthActorNames.AMAZON_ADS, ), workspace_id='', ) res = s.workspaces.create_or_update_workspace_o_auth_credentials(req) -if res.status_code == 200: +if res is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `request` | [operations.CreateOrUpdateWorkspaceOAuthCredentialsRequest](../../models/operations/createorupdateworkspaceoauthcredentialsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | +| `request` | [api.CreateOrUpdateWorkspaceOAuthCredentialsRequest](../../api/createorupdateworkspaceoauthcredentialsrequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.CreateOrUpdateWorkspaceOAuthCredentialsResponse](../../models/operations/createorupdateworkspaceoauthcredentialsresponse.md)** +**[api.CreateOrUpdateWorkspaceOAuthCredentialsResponse](../../api/createorupdateworkspaceoauthcredentialsresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | ## create_workspace @@ -69,19 +70,19 @@ Create a workspace ### Example Usage ```python -import airbyte -from airbyte.models import shared +import airbyte_api +from airbyte_api import models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = shared.WorkspaceCreateRequest( +req = models.WorkspaceCreateRequest( name='', ) @@ -90,23 +91,24 @@ res = s.workspaces.create_workspace(req) if res.workspace_response is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `request` | [shared.WorkspaceCreateRequest](../../models/shared/workspacecreaterequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| `request` | [models.WorkspaceCreateRequest](../../models/workspacecreaterequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.CreateWorkspaceResponse](../../models/operations/createworkspaceresponse.md)** +**[api.CreateWorkspaceResponse](../../api/createworkspaceresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | ## delete_workspace @@ -115,44 +117,45 @@ Delete a Workspace ### Example Usage ```python -import airbyte -from airbyte.models import operations, shared +import airbyte_api +from airbyte_api import api, models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = operations.DeleteWorkspaceRequest( +req = api.DeleteWorkspaceRequest( workspace_id='', ) res = s.workspaces.delete_workspace(req) -if res.status_code == 200: +if res is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `request` | [operations.DeleteWorkspaceRequest](../../models/operations/deleteworkspacerequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | +| `request` | [api.DeleteWorkspaceRequest](../../api/deleteworkspacerequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.DeleteWorkspaceResponse](../../models/operations/deleteworkspaceresponse.md)** +**[api.DeleteWorkspaceResponse](../../api/deleteworkspaceresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | ## get_workspace @@ -161,19 +164,19 @@ Get Workspace details ### Example Usage ```python -import airbyte -from airbyte.models import operations, shared +import airbyte_api +from airbyte_api import api, models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = operations.GetWorkspaceRequest( +req = api.GetWorkspaceRequest( workspace_id='', ) @@ -182,23 +185,24 @@ res = s.workspaces.get_workspace(req) if res.workspace_response is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `request` | [operations.GetWorkspaceRequest](../../models/operations/getworkspacerequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `request` | [api.GetWorkspaceRequest](../../api/getworkspacerequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.GetWorkspaceResponse](../../models/operations/getworkspaceresponse.md)** +**[api.GetWorkspaceResponse](../../api/getworkspaceresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | ## list_workspaces @@ -207,42 +211,43 @@ List workspaces ### Example Usage ```python -import airbyte -from airbyte.models import operations, shared +import airbyte_api +from airbyte_api import api, models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = operations.ListWorkspacesRequest() +req = api.ListWorkspacesRequest() res = s.workspaces.list_workspaces(req) if res.workspaces_response is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `request` | [operations.ListWorkspacesRequest](../../models/operations/listworkspacesrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | +| `request` | [api.ListWorkspacesRequest](../../api/listworkspacesrequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.ListWorkspacesResponse](../../models/operations/listworkspacesresponse.md)** +**[api.ListWorkspacesResponse](../../api/listworkspacesresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | ## update_workspace @@ -251,20 +256,20 @@ Update a workspace ### Example Usage ```python -import airbyte -from airbyte.models import operations, shared +import airbyte_api +from airbyte_api import api, models -s = airbyte.Airbyte( - security=shared.Security( - basic_auth=shared.SchemeBasicAuth( +s = airbyte_api.AirbyteAPI( + security=models.Security( + basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) -req = operations.UpdateWorkspaceRequest( - workspace_update_request=shared.WorkspaceUpdateRequest( +req = api.UpdateWorkspaceRequest( + workspace_update_request=models.WorkspaceUpdateRequest( name='', ), workspace_id='', @@ -275,20 +280,21 @@ res = s.workspaces.update_workspace(req) if res.workspace_response is not None: # handle response pass + ``` ### Parameters -| Parameter | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `request` | [operations.UpdateWorkspaceRequest](../../models/operations/updateworkspacerequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | +| `request` | [api.UpdateWorkspaceRequest](../../api/updateworkspacerequest.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[operations.UpdateWorkspaceResponse](../../models/operations/updateworkspaceresponse.md)** +**[api.UpdateWorkspaceResponse](../../api/updateworkspaceresponse.md)** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4x-5xx | */* | +| errors.SDKError | 4xx-5xx | */* | diff --git a/gen.yaml b/gen.yaml index fb18c736..e5bee77d 100644 --- a/gen.yaml +++ b/gen.yaml @@ -11,7 +11,11 @@ generation: auth: oAuth2ClientCredentialsEnabled: false python: - version: 0.48.0 + version: 0.49.1 + additionalDependencies: + dependencies: {} + extraDependencies: + dev: {} author: Airbyte clientServerStatusCodesAsErrors: true description: Python Client SDK for Airbyte API @@ -19,12 +23,14 @@ python: imports: option: openapi paths: - callbacks: "" - errors: "" - operations: "" - shared: "" - webhooks: "" + callbacks: api + errors: errors + operations: api + shared: models + webhooks: api inputModelSuffix: input maxMethodParams: 0 outputModelSuffix: output packageName: airbyte-api + projectUrls: {} + responseFormat: envelope diff --git a/py.typed b/py.typed new file mode 100644 index 00000000..3e38f1a9 --- /dev/null +++ b/py.typed @@ -0,0 +1 @@ +# Marker file for PEP 561. The package enables type hints. diff --git a/pylintrc b/pylintrc index 2f59cabc..48dca5e8 100644 --- a/pylintrc +++ b/pylintrc @@ -180,6 +180,7 @@ good-names=i, ex, Run, _, + e, db, id @@ -442,7 +443,8 @@ disable=raw-checker-failed, too-many-nested-blocks, too-many-boolean-expressions, no-else-raise, - bare-except + bare-except, + broad-exception-caught # 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 66aaa388..1abb14b5 100644 --- a/setup.py +++ b/setup.py @@ -1,27 +1,37 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" import setuptools +import re try: - with open("README.md", "r") as fh: + with open('README.md', 'r') as fh: long_description = fh.read() + GITHUB_URL = 'https://github.com/airbytehq/airbyte-api-python-sdk.git' + GITHUB_URL = GITHUB_URL[: -len('.git')] if GITHUB_URL.endswith('.git') else GITHUB_URL + # links on PyPI should have absolute URLs + long_description = re.sub( + r'(\[[^\]]+\]\()((?!https?:)[^\)]+)(\))', + lambda m: m.group(1) + GITHUB_URL + '/blob/master/' + m.group(2) + m.group(3), + long_description, + ) except FileNotFoundError: - long_description = "" + long_description = '' setuptools.setup( - name="airbyte-api", - version="0.47.3", - author="Airbyte", - description="Python Client SDK for Airbyte API", + name='airbyte-api', + version='0.49.1', + author='Airbyte', + description='Python Client SDK for Airbyte API', + url='https://github.com/airbytehq/airbyte-api-python-sdk.git', long_description=long_description, - long_description_content_type="text/markdown", - packages=setuptools.find_packages(where="src"), + long_description_content_type='text/markdown', + packages=setuptools.find_packages(where='src'), install_requires=[ "certifi>=2023.7.22", "charset-normalizer>=3.2.0", - "dataclasses-json-speakeasy>=0.5.11", + "dataclasses-json>=0.6.4", "idna>=3.4", - "jsonpath-python>=1.0.6 ", + "jsonpath-python>=1.0.6", "marshmallow>=3.19.0", "mypy-extensions>=1.0.0", "packaging>=23.1", @@ -33,9 +43,13 @@ "urllib3>=1.26.18", ], extras_require={ - "dev":["pylint==2.16.2"] + "dev": [ + "pylint==3.1.0", + ], }, package_dir={'': 'src'}, python_requires='>=3.8', - package_data={"airbyte-api": ["py.typed"]}, + package_data={ + 'airbyte-api': ['py.typed'] + }, ) diff --git a/src/airbyte/connections.py b/src/airbyte/connections.py deleted file mode 100644 index 0e86e9fa..00000000 --- a/src/airbyte/connections.py +++ /dev/null @@ -1,181 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from .sdkconfiguration import SDKConfiguration -from airbyte import utils -from airbyte.models import errors, operations, shared -from typing import Optional - -class Connections: - sdk_configuration: SDKConfiguration - - def __init__(self, sdk_config: SDKConfiguration) -> None: - self.sdk_configuration = sdk_config - - - - def create_connection(self, request: shared.ConnectionCreateRequest) -> operations.CreateConnectionResponse: - r"""Create a connection""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = base_url + '/connections' - headers = {} - req_content_type, data, form = utils.serialize_request_body(request, shared.ConnectionCreateRequest, "request", False, False, 'json') - if req_content_type not in ('multipart/form-data', 'multipart/mixed'): - headers['content-type'] = req_content_type - if data is None and form is None: - raise Exception('request body is required') - headers['Accept'] = 'application/json' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('POST', url, data=data, files=form, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.CreateConnectionResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ConnectionResponse]) - res.connection_response = out - else: - raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code == 400 or http_res.status_code == 403 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - - - def delete_connection(self, request: operations.DeleteConnectionRequest) -> operations.DeleteConnectionResponse: - r"""Delete a Connection""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = utils.generate_url(operations.DeleteConnectionRequest, base_url, '/connections/{connectionId}', request) - headers = {} - headers['Accept'] = '*/*' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('DELETE', url, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.DeleteConnectionResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 204: - pass - elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - - - def get_connection(self, request: operations.GetConnectionRequest) -> operations.GetConnectionResponse: - r"""Get Connection details""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = utils.generate_url(operations.GetConnectionRequest, base_url, '/connections/{connectionId}', request) - headers = {} - headers['Accept'] = 'application/json' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('GET', url, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.GetConnectionResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ConnectionResponse]) - res.connection_response = out - else: - raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - - - def list_connections(self, request: operations.ListConnectionsRequest) -> operations.ListConnectionsResponse: - r"""List connections""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = base_url + '/connections' - headers = {} - query_params = utils.get_query_params(operations.ListConnectionsRequest, request) - headers['Accept'] = 'application/json' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('GET', url, params=query_params, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.ListConnectionsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ConnectionsResponse]) - res.connections_response = out - else: - raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - - - def patch_connection(self, request: operations.PatchConnectionRequest) -> operations.PatchConnectionResponse: - r"""Update Connection details""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = utils.generate_url(operations.PatchConnectionRequest, base_url, '/connections/{connectionId}', request) - headers = {} - req_content_type, data, form = utils.serialize_request_body(request, operations.PatchConnectionRequest, "connection_patch_request", False, False, 'json') - if req_content_type not in ('multipart/form-data', 'multipart/mixed'): - headers['content-type'] = req_content_type - if data is None and form is None: - raise Exception('request body is required') - headers['Accept'] = 'application/json' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('PATCH', url, data=data, files=form, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.PatchConnectionResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ConnectionResponse]) - res.connection_response = out - else: - raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - \ No newline at end of file diff --git a/src/airbyte/destinations.py b/src/airbyte/destinations.py deleted file mode 100644 index 80d95337..00000000 --- a/src/airbyte/destinations.py +++ /dev/null @@ -1,214 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from .sdkconfiguration import SDKConfiguration -from airbyte import utils -from airbyte.models import errors, operations, shared -from typing import Optional - -class Destinations: - sdk_configuration: SDKConfiguration - - def __init__(self, sdk_config: SDKConfiguration) -> None: - self.sdk_configuration = sdk_config - - - - def create_destination(self, request: Optional[shared.DestinationCreateRequest]) -> operations.CreateDestinationResponse: - r"""Create a destination - Creates a destination given a name, workspace id, and a json blob containing the configuration for the source. - """ - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = base_url + '/destinations' - headers = {} - req_content_type, data, form = utils.serialize_request_body(request, Optional[shared.DestinationCreateRequest], "request", False, True, 'json') - if req_content_type not in ('multipart/form-data', 'multipart/mixed'): - headers['content-type'] = req_content_type - headers['Accept'] = 'application/json' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('POST', url, data=data, files=form, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.CreateDestinationResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.DestinationResponse]) - res.destination_response = out - else: - raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code == 400 or http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - - - def delete_destination(self, request: operations.DeleteDestinationRequest) -> operations.DeleteDestinationResponse: - r"""Delete a Destination""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = utils.generate_url(operations.DeleteDestinationRequest, base_url, '/destinations/{destinationId}', request) - headers = {} - headers['Accept'] = '*/*' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('DELETE', url, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.DeleteDestinationResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 204: - pass - elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - - - def get_destination(self, request: operations.GetDestinationRequest) -> operations.GetDestinationResponse: - r"""Get Destination details""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = utils.generate_url(operations.GetDestinationRequest, base_url, '/destinations/{destinationId}', request) - headers = {} - headers['Accept'] = 'application/json' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('GET', url, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.GetDestinationResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.DestinationResponse]) - res.destination_response = out - else: - raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - - - def list_destinations(self, request: operations.ListDestinationsRequest) -> operations.ListDestinationsResponse: - r"""List destinations""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = base_url + '/destinations' - headers = {} - query_params = utils.get_query_params(operations.ListDestinationsRequest, request) - headers['Accept'] = 'application/json' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('GET', url, params=query_params, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.ListDestinationsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.DestinationsResponse]) - res.destinations_response = out - else: - raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - - - def patch_destination(self, request: operations.PatchDestinationRequest) -> operations.PatchDestinationResponse: - r"""Update a Destination""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = utils.generate_url(operations.PatchDestinationRequest, base_url, '/destinations/{destinationId}', request) - headers = {} - req_content_type, data, form = utils.serialize_request_body(request, operations.PatchDestinationRequest, "destination_patch_request", False, True, 'json') - if req_content_type not in ('multipart/form-data', 'multipart/mixed'): - headers['content-type'] = req_content_type - headers['Accept'] = 'application/json' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('PATCH', url, data=data, files=form, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.PatchDestinationResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.DestinationResponse]) - res.destination_response = out - else: - raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - - - def put_destination(self, request: operations.PutDestinationRequest) -> operations.PutDestinationResponse: - r"""Update a Destination and fully overwrite it""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = utils.generate_url(operations.PutDestinationRequest, base_url, '/destinations/{destinationId}', request) - headers = {} - req_content_type, data, form = utils.serialize_request_body(request, operations.PutDestinationRequest, "destination_put_request", False, True, 'json') - if req_content_type not in ('multipart/form-data', 'multipart/mixed'): - headers['content-type'] = req_content_type - headers['Accept'] = 'application/json' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('PUT', url, data=data, files=form, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.PutDestinationResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.DestinationResponse]) - res.destination_response = out - else: - raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - \ No newline at end of file diff --git a/src/airbyte/jobs.py b/src/airbyte/jobs.py deleted file mode 100644 index 3fb96f73..00000000 --- a/src/airbyte/jobs.py +++ /dev/null @@ -1,148 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from .sdkconfiguration import SDKConfiguration -from airbyte import utils -from airbyte.models import errors, operations, shared -from typing import Optional - -class Jobs: - sdk_configuration: SDKConfiguration - - def __init__(self, sdk_config: SDKConfiguration) -> None: - self.sdk_configuration = sdk_config - - - - def cancel_job(self, request: operations.CancelJobRequest) -> operations.CancelJobResponse: - r"""Cancel a running Job""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = utils.generate_url(operations.CancelJobRequest, base_url, '/jobs/{jobId}', request) - headers = {} - headers['Accept'] = 'application/json' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('DELETE', url, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.CancelJobResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.JobResponse]) - res.job_response = out - else: - raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - - - def create_job(self, request: shared.JobCreateRequest) -> operations.CreateJobResponse: - r"""Trigger a sync or reset job of a connection""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = base_url + '/jobs' - headers = {} - req_content_type, data, form = utils.serialize_request_body(request, shared.JobCreateRequest, "request", False, False, 'json') - if req_content_type not in ('multipart/form-data', 'multipart/mixed'): - headers['content-type'] = req_content_type - if data is None and form is None: - raise Exception('request body is required') - headers['Accept'] = 'application/json' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('POST', url, data=data, files=form, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.CreateJobResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.JobResponse]) - res.job_response = out - else: - raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code == 400 or http_res.status_code == 403 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - - - def get_job(self, request: operations.GetJobRequest) -> operations.GetJobResponse: - r"""Get Job status and details""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = utils.generate_url(operations.GetJobRequest, base_url, '/jobs/{jobId}', request) - headers = {} - headers['Accept'] = 'application/json' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('GET', url, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.GetJobResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.JobResponse]) - res.job_response = out - else: - raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - - - def list_jobs(self, request: operations.ListJobsRequest) -> operations.ListJobsResponse: - r"""List Jobs by sync type""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = base_url + '/jobs' - headers = {} - query_params = utils.get_query_params(operations.ListJobsRequest, request) - headers['Accept'] = 'application/json' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('GET', url, params=query_params, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.ListJobsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.JobsResponse]) - res.jobs_response = out - else: - raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code == 403 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - \ No newline at end of file diff --git a/src/airbyte/models/__init__.py b/src/airbyte/models/__init__.py deleted file mode 100644 index 722bb998..00000000 --- a/src/airbyte/models/__init__.py +++ /dev/null @@ -1,4 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - - -# package diff --git a/src/airbyte/models/shared/__init__.py b/src/airbyte/models/shared/__init__.py deleted file mode 100644 index 179d252d..00000000 --- a/src/airbyte/models/shared/__init__.py +++ /dev/null @@ -1,327 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from .actortypeenum import * -from .airtable import * -from .amazon_ads import * -from .amazon_seller_partner import * -from .asana import * -from .bing_ads import * -from .connectioncreaterequest import * -from .connectionpatchrequest import * -from .connectionresponse import * -from .connectionschedule import * -from .connectionscheduleresponse import * -from .connectionsresponse import * -from .connectionstatusenum import * -from .connectionsyncmodeenum import * -from .destination_astra import * -from .destination_aws_datalake import * -from .destination_azure_blob_storage import * -from .destination_bigquery import * -from .destination_clickhouse import * -from .destination_convex import * -from .destination_cumulio import * -from .destination_databend import * -from .destination_databricks import * -from .destination_dev_null import * -from .destination_duckdb import * -from .destination_dynamodb import * -from .destination_elasticsearch import * -from .destination_firebolt import * -from .destination_firestore import * -from .destination_gcs import * -from .destination_google_sheets import * -from .destination_keen import * -from .destination_kinesis import * -from .destination_langchain import * -from .destination_milvus import * -from .destination_mongodb import * -from .destination_mssql import * -from .destination_mysql import * -from .destination_oracle import * -from .destination_pinecone import * -from .destination_postgres import * -from .destination_pubsub import * -from .destination_qdrant import * -from .destination_redis import * -from .destination_redshift import * -from .destination_s3 import * -from .destination_s3_glue import * -from .destination_sftp_json import * -from .destination_snowflake import * -from .destination_teradata import * -from .destination_timeplus import * -from .destination_typesense import * -from .destination_vectara import * -from .destination_vertica import * -from .destination_weaviate import * -from .destination_xata import * -from .destinationcreaterequest import * -from .destinationpatchrequest import * -from .destinationputrequest import * -from .destinationresponse import * -from .destinationsresponse import * -from .facebook_marketing import * -from .geographyenum import * -from .geographyenumnodefault import * -from .github import * -from .gitlab import * -from .google_ads import * -from .google_analytics_data_api import * -from .google_drive import * -from .google_search_console import * -from .google_sheets import * -from .harvest import * -from .hubspot import * -from .initiateoauthrequest import * -from .instagram import * -from .intercom import * -from .jobcreaterequest import * -from .jobresponse import * -from .jobsresponse import * -from .jobstatusenum import * -from .jobtypeenum import * -from .lever_hiring import * -from .linkedin_ads import * -from .mailchimp import * -from .microsoft_sharepoint import * -from .microsoft_teams import * -from .monday import * -from .namespacedefinitionenum import * -from .namespacedefinitionenumnodefault import * -from .nonbreakingschemaupdatesbehaviorenum import * -from .nonbreakingschemaupdatesbehaviorenumnodefault import * -from .notion import * -from .oauthactornames import * -from .oauthinputconfiguration import * -from .pinterest import * -from .retently import * -from .salesforce import * -from .scheduletypeenum import * -from .scheduletypewithbasicenum import * -from .schemebasicauth import * -from .security import * -from .shopify import * -from .slack import * -from .smartsheets import * -from .snapchat_marketing import * -from .snowflake import * -from .source_aha import * -from .source_aircall import * -from .source_airtable import * -from .source_amazon_ads import * -from .source_amazon_seller_partner import * -from .source_amazon_sqs import * -from .source_amplitude import * -from .source_apify_dataset import * -from .source_appfollow import * -from .source_asana import * -from .source_auth0 import * -from .source_aws_cloudtrail import * -from .source_azure_blob_storage import * -from .source_azure_table import * -from .source_bamboo_hr import * -from .source_bigquery import * -from .source_bing_ads import * -from .source_braintree import * -from .source_braze import * -from .source_cart import * -from .source_chargebee import * -from .source_chartmogul import * -from .source_clickhouse import * -from .source_clickup_api import * -from .source_clockify import * -from .source_close_com import * -from .source_coda import * -from .source_coin_api import * -from .source_coinmarketcap import * -from .source_configcat import * -from .source_confluence import * -from .source_convex import * -from .source_datascope import * -from .source_delighted import * -from .source_dixa import * -from .source_dockerhub import * -from .source_dremio import * -from .source_dynamodb import * -from .source_e2e_test_cloud import * -from .source_emailoctopus import * -from .source_exchange_rates import * -from .source_facebook_marketing import * -from .source_faker import * -from .source_fauna import * -from .source_file import * -from .source_firebolt import * -from .source_freshcaller import * -from .source_freshdesk import * -from .source_freshsales import * -from .source_gainsight_px import * -from .source_gcs import * -from .source_getlago import * -from .source_github import * -from .source_gitlab import * -from .source_glassfrog import * -from .source_gnews import * -from .source_google_ads import * -from .source_google_analytics_data_api import * -from .source_google_analytics_v4_service_account_only import * -from .source_google_directory import * -from .source_google_drive import * -from .source_google_pagespeed_insights import * -from .source_google_search_console import * -from .source_google_sheets import * -from .source_google_webfonts import * -from .source_google_workspace_admin_reports import * -from .source_greenhouse import * -from .source_gridly import * -from .source_harvest import * -from .source_hubplanner import * -from .source_hubspot import * -from .source_insightly import * -from .source_instagram import * -from .source_instatus import * -from .source_intercom import * -from .source_ip2whois import * -from .source_iterable import * -from .source_jira import * -from .source_k6_cloud import * -from .source_klarna import * -from .source_klaviyo import * -from .source_kyve import * -from .source_launchdarkly import * -from .source_lemlist import * -from .source_lever_hiring import * -from .source_linkedin_ads import * -from .source_linkedin_pages import * -from .source_lokalise import * -from .source_mailchimp import * -from .source_mailgun import * -from .source_mailjet_sms import * -from .source_marketo import * -from .source_metabase import * -from .source_microsoft_sharepoint import * -from .source_microsoft_teams import * -from .source_mixpanel import * -from .source_monday import * -from .source_mongodb_internal_poc import * -from .source_mongodb_v2 import * -from .source_mssql import * -from .source_my_hours import * -from .source_mysql import * -from .source_netsuite import * -from .source_notion import * -from .source_nytimes import * -from .source_okta import * -from .source_omnisend import * -from .source_onesignal import * -from .source_oracle import * -from .source_orb import * -from .source_orbit import * -from .source_outbrain_amplify import * -from .source_outreach import * -from .source_paypal_transaction import * -from .source_paystack import * -from .source_pendo import * -from .source_persistiq import * -from .source_pexels_api import * -from .source_pinterest import * -from .source_pipedrive import * -from .source_pocket import * -from .source_pokeapi import * -from .source_polygon_stock_api import * -from .source_postgres import * -from .source_posthog import * -from .source_postmarkapp import * -from .source_prestashop import * -from .source_punk_api import * -from .source_pypi import * -from .source_qualaroo import * -from .source_quickbooks import * -from .source_railz import * -from .source_recharge import * -from .source_recreation import * -from .source_recruitee import * -from .source_redshift import * -from .source_retently import * -from .source_rki_covid import * -from .source_rss import * -from .source_s3 import * -from .source_salesforce import * -from .source_salesloft import * -from .source_sap_fieldglass import * -from .source_secoda import * -from .source_sendgrid import * -from .source_sendinblue import * -from .source_senseforce import * -from .source_sentry import * -from .source_sftp import * -from .source_sftp_bulk import * -from .source_shopify import * -from .source_shortio import * -from .source_slack import * -from .source_smaily import * -from .source_smartengage import * -from .source_smartsheets import * -from .source_snapchat_marketing import * -from .source_snowflake import * -from .source_sonar_cloud import * -from .source_spacex_api import * -from .source_square import * -from .source_strava import * -from .source_stripe import * -from .source_survey_sparrow import * -from .source_surveymonkey import * -from .source_tempo import * -from .source_the_guardian_api import * -from .source_tiktok_marketing import * -from .source_trello import * -from .source_trustpilot import * -from .source_tvmaze_schedule import * -from .source_twilio import * -from .source_twilio_taskrouter import * -from .source_twitter import * -from .source_typeform import * -from .source_us_census import * -from .source_vantage import * -from .source_webflow import * -from .source_whisky_hunter import * -from .source_wikipedia_pageviews import * -from .source_woocommerce import * -from .source_xkcd import * -from .source_yandex_metrica import * -from .source_yotpo import * -from .source_youtube_analytics import * -from .source_zendesk_chat import * -from .source_zendesk_sell import * -from .source_zendesk_sunshine import * -from .source_zendesk_support import * -from .source_zendesk_talk import * -from .source_zenloop import * -from .source_zoho_crm import * -from .source_zoom import * -from .sourcecreaterequest import * -from .sourcepatchrequest import * -from .sourceputrequest import * -from .sourceresponse import * -from .sourcesresponse import * -from .square import * -from .strava import * -from .streamconfiguration import * -from .streamconfigurations import * -from .streamproperties import * -from .streampropertiesresponse import * -from .surveymonkey import * -from .tiktok_marketing import * -from .typeform import * -from .workspacecreaterequest import * -from .workspaceoauthcredentialsrequest import * -from .workspaceresponse import * -from .workspacesresponse import * -from .workspaceupdaterequest import * -from .youtube_analytics import * -from .zendesk_chat import * -from .zendesk_sunshine import * -from .zendesk_support import * -from .zendesk_talk import * - -__all__ = ["AESCBCEnvelopeEncryption","APIAccessToken","APIKey","APIKeyAuth","APIKeySecret","APIPassword","APIToken","AWSEnvironment","AWSRegion","AWSS3Staging","AWSSellerPartnerAccountType","AccessToken","AccessTokenIsRequiredForAuthenticationRequests","AccountNames","ActionReportTime","ActorTypeEnum","AdAnalyticsReportConfiguration","Aha","Aircall","Airtable","Allow","AmazonAds","AmazonS3","AmazonSellerPartner","AmazonSqs","Amplitude","AndGroup","ApifyDataset","Appfollow","Applications","Asana","AsanaCredentials","Astra","Auth0","AuthMethod","AuthType","AuthenticateViaAPIKey","AuthenticateViaAsanaOauth","AuthenticateViaGoogleOauth","AuthenticateViaHarvestOAuth","AuthenticateViaLeverAPIKey","AuthenticateViaLeverOAuth","AuthenticateViaMicrosoft","AuthenticateViaMicrosoftOAuth","AuthenticateViaMicrosoftOAuth20","AuthenticateViaOAuth","AuthenticateViaOAuth20","AuthenticateViaRetentlyOAuth","AuthenticateWithAPIToken","AuthenticateWithPersonalAccessToken","AuthenticationViaGoogleOAuth","Authorization","Autogenerated","Avro","AvroApacheAvro","AvroFormat","AwsCloudtrail","AwsDatalake","AzBlobAzureBlobStorage","AzureBlobStorage","AzureOpenAI","AzureTable","BambooHr","BetweenFilter","Bigquery","BingAds","BothUsernameAndPasswordIsRequiredForAuthenticationRequest","Braintree","Braze","ByMarkdownHeader","ByProgrammingLanguage","BySeparator","Bzip2","CSVCommaSeparatedValues","CSVFormat","CacheType","Cart","Categories","CentralAPIRouter","Chargebee","Chartmogul","ChooseHowToPartitionData","ChromaLocalPersistance","ClickWindowDays","Clickhouse","ClickupAPI","Clockify","CloseCom","Coda","Codec","Cohere","CohortReportSettings","Cohorts","CohortsRange","CoinAPI","Coinmarketcap","Collection","CompressionCodecOptional","CompressionType","Configcat","Confluence","ConnectionCreateRequest","ConnectionPatchRequest","ConnectionResponse","ConnectionSchedule","ConnectionScheduleResponse","ConnectionStatusEnum","ConnectionSyncModeEnum","ConnectionType","ConnectionsResponse","ContentType","ContinuousFeed","ConversionReportTime","Convex","Country","CredentialType","Credentials","CredentialsTitle","Csv","Cumulio","CustomQueriesArray","CustomReportConfig","CustomerStatus","DataCenterLocation","DataFreshness","DataRegion","DataSourceType","DataType","Databend","Databricks","Datascope","DatasetLocation","DateRange","DefaultVectorizer","Deflate","Delighted","DestinationAstra","DestinationAstraLanguage","DestinationAstraMode","DestinationAstraSchemasEmbeddingEmbedding1Mode","DestinationAstraSchemasEmbeddingEmbeddingMode","DestinationAstraSchemasEmbeddingMode","DestinationAstraSchemasMode","DestinationAstraSchemasProcessingMode","DestinationAstraSchemasProcessingTextSplitterMode","DestinationAstraSchemasProcessingTextSplitterTextSplitterMode","DestinationAwsDatalake","DestinationAwsDatalakeCompressionCodecOptional","DestinationAwsDatalakeCredentialsTitle","DestinationAwsDatalakeFormatTypeWildcard","DestinationAzureBlobStorage","DestinationAzureBlobStorageFormatType","DestinationAzureBlobStorageJSONLinesNewlineDelimitedJSON","DestinationBigquery","DestinationBigqueryCredentialType","DestinationBigqueryHMACKey","DestinationBigqueryMethod","DestinationClickhouse","DestinationClickhouseSchemasTunnelMethod","DestinationClickhouseTunnelMethod","DestinationConvex","DestinationCreateRequest","DestinationCumulio","DestinationDatabend","DestinationDatabricks","DestinationDatabricksAzureBlobStorage","DestinationDatabricksDataSourceType","DestinationDatabricksS3BucketRegion","DestinationDatabricksSchemasDataSourceType","DestinationDevNull","DestinationDuckdb","DestinationDynamodb","DestinationElasticsearch","DestinationElasticsearchMethod","DestinationElasticsearchSchemasMethod","DestinationFirebolt","DestinationFireboltMethod","DestinationFireboltSchemasMethod","DestinationFirestore","DestinationGcs","DestinationGcsCSVCommaSeparatedValues","DestinationGcsCodec","DestinationGcsCompressionCodec","DestinationGcsCompressionType","DestinationGcsFormatType","DestinationGcsGZIP","DestinationGcsJSONLinesNewlineDelimitedJSON","DestinationGcsNoCompression","DestinationGcsParquetColumnarStorage","DestinationGcsSchemasCodec","DestinationGcsSchemasCompressionType","DestinationGcsSchemasFormatCodec","DestinationGcsSchemasFormatCompressionType","DestinationGcsSchemasFormatFormatType","DestinationGcsSchemasFormatOutputFormat1Codec","DestinationGcsSchemasFormatOutputFormatCodec","DestinationGcsSchemasFormatOutputFormatFormatType","DestinationGcsSchemasFormatType","DestinationGcsSchemasNoCompression","DestinationGoogleSheets","DestinationGoogleSheetsGoogleSheets","DestinationKeen","DestinationKinesis","DestinationLangchain","DestinationLangchainFake","DestinationLangchainMode","DestinationLangchainOpenAI","DestinationLangchainPinecone","DestinationLangchainProcessingConfigModel","DestinationLangchainSchemasIndexingIndexing3Mode","DestinationLangchainSchemasIndexingIndexingMode","DestinationLangchainSchemasIndexingMode","DestinationLangchainSchemasMode","DestinationMilvus","DestinationMilvusAPIToken","DestinationMilvusAzureOpenAI","DestinationMilvusByMarkdownHeader","DestinationMilvusByProgrammingLanguage","DestinationMilvusBySeparator","DestinationMilvusCohere","DestinationMilvusFake","DestinationMilvusFieldNameMappingConfigModel","DestinationMilvusIndexing","DestinationMilvusLanguage","DestinationMilvusMode","DestinationMilvusOpenAI","DestinationMilvusOpenAICompatible","DestinationMilvusProcessingConfigModel","DestinationMilvusSchemasEmbeddingEmbedding5Mode","DestinationMilvusSchemasEmbeddingEmbeddingMode","DestinationMilvusSchemasEmbeddingMode","DestinationMilvusSchemasIndexingAuthAuthenticationMode","DestinationMilvusSchemasIndexingAuthMode","DestinationMilvusSchemasIndexingMode","DestinationMilvusSchemasMode","DestinationMilvusSchemasProcessingMode","DestinationMilvusSchemasProcessingTextSplitterMode","DestinationMilvusSchemasProcessingTextSplitterTextSplitterMode","DestinationMilvusUsernamePassword","DestinationMongodb","DestinationMongodbAuthorization","DestinationMongodbInstance","DestinationMongodbNoTunnel","DestinationMongodbPasswordAuthentication","DestinationMongodbSSHKeyAuthentication","DestinationMongodbSchemasAuthorization","DestinationMongodbSchemasInstance","DestinationMongodbSchemasTunnelMethod","DestinationMongodbSchemasTunnelMethodTunnelMethod","DestinationMongodbTunnelMethod","DestinationMssql","DestinationMssqlNoTunnel","DestinationMssqlPasswordAuthentication","DestinationMssqlSSHKeyAuthentication","DestinationMssqlSchemasSslMethod","DestinationMssqlSchemasTunnelMethod","DestinationMssqlSchemasTunnelMethodTunnelMethod","DestinationMssqlSslMethod","DestinationMssqlTunnelMethod","DestinationMysql","DestinationMysqlNoTunnel","DestinationMysqlPasswordAuthentication","DestinationMysqlSSHKeyAuthentication","DestinationMysqlSchemasTunnelMethod","DestinationMysqlSchemasTunnelMethodTunnelMethod","DestinationMysqlTunnelMethod","DestinationOracle","DestinationOracleNoTunnel","DestinationOraclePasswordAuthentication","DestinationOracleSSHKeyAuthentication","DestinationOracleSchemasTunnelMethod","DestinationOracleSchemasTunnelMethodTunnelMethod","DestinationOracleTunnelMethod","DestinationPatchRequest","DestinationPinecone","DestinationPineconeAzureOpenAI","DestinationPineconeByMarkdownHeader","DestinationPineconeByProgrammingLanguage","DestinationPineconeBySeparator","DestinationPineconeCohere","DestinationPineconeFake","DestinationPineconeFieldNameMappingConfigModel","DestinationPineconeIndexing","DestinationPineconeLanguage","DestinationPineconeMode","DestinationPineconeOpenAI","DestinationPineconeOpenAICompatible","DestinationPineconeProcessingConfigModel","DestinationPineconeSchemasEmbeddingEmbedding5Mode","DestinationPineconeSchemasEmbeddingEmbeddingMode","DestinationPineconeSchemasEmbeddingMode","DestinationPineconeSchemasMode","DestinationPineconeSchemasProcessingMode","DestinationPineconeSchemasProcessingTextSplitterMode","DestinationPineconeSchemasProcessingTextSplitterTextSplitterMode","DestinationPostgres","DestinationPostgresMode","DestinationPostgresNoTunnel","DestinationPostgresPasswordAuthentication","DestinationPostgresSSHKeyAuthentication","DestinationPostgresSchemasMode","DestinationPostgresSchemasSSLModeSSLModes6Mode","DestinationPostgresSchemasSSLModeSSLModesMode","DestinationPostgresSchemasSslModeMode","DestinationPostgresSchemasTunnelMethod","DestinationPostgresSchemasTunnelMethodTunnelMethod","DestinationPostgresTunnelMethod","DestinationPubsub","DestinationPutRequest","DestinationQdrant","DestinationQdrantAzureOpenAI","DestinationQdrantByMarkdownHeader","DestinationQdrantByProgrammingLanguage","DestinationQdrantBySeparator","DestinationQdrantCohere","DestinationQdrantFake","DestinationQdrantFieldNameMappingConfigModel","DestinationQdrantIndexing","DestinationQdrantLanguage","DestinationQdrantMode","DestinationQdrantNoAuth","DestinationQdrantOpenAI","DestinationQdrantOpenAICompatible","DestinationQdrantProcessingConfigModel","DestinationQdrantSchemasEmbeddingEmbedding5Mode","DestinationQdrantSchemasEmbeddingEmbeddingMode","DestinationQdrantSchemasEmbeddingMode","DestinationQdrantSchemasIndexingAuthMethodMode","DestinationQdrantSchemasIndexingMode","DestinationQdrantSchemasMode","DestinationQdrantSchemasProcessingMode","DestinationQdrantSchemasProcessingTextSplitterMode","DestinationQdrantSchemasProcessingTextSplitterTextSplitterMode","DestinationRedis","DestinationRedisDisable","DestinationRedisMode","DestinationRedisNoTunnel","DestinationRedisPasswordAuthentication","DestinationRedisSSHKeyAuthentication","DestinationRedisSchemasMode","DestinationRedisSchemasTunnelMethod","DestinationRedisSchemasTunnelMethodTunnelMethod","DestinationRedisTunnelMethod","DestinationRedisVerifyFull","DestinationRedshift","DestinationRedshiftEncryptionType","DestinationRedshiftMethod","DestinationRedshiftNoTunnel","DestinationRedshiftPasswordAuthentication","DestinationRedshiftS3BucketRegion","DestinationRedshiftSSHKeyAuthentication","DestinationRedshiftSchemasMethod","DestinationRedshiftSchemasTunnelMethod","DestinationRedshiftSchemasTunnelMethodTunnelMethod","DestinationRedshiftTunnelMethod","DestinationResponse","DestinationS3","DestinationS3AvroApacheAvro","DestinationS3Bzip2","DestinationS3CSVCommaSeparatedValues","DestinationS3Codec","DestinationS3CompressionType","DestinationS3Deflate","DestinationS3Flattening","DestinationS3FormatType","DestinationS3GZIP","DestinationS3Glue","DestinationS3GlueCompressionType","DestinationS3GlueFormatType","DestinationS3GlueGZIP","DestinationS3GlueJSONLinesNewlineDelimitedJSON","DestinationS3GlueNoCompression","DestinationS3GlueS3BucketRegion","DestinationS3GlueSchemasCompressionType","DestinationS3JSONLinesNewlineDelimitedJSON","DestinationS3NoCompression","DestinationS3ParquetColumnarStorage","DestinationS3S3BucketRegion","DestinationS3SchemasCodec","DestinationS3SchemasCompressionCodec","DestinationS3SchemasCompressionType","DestinationS3SchemasFlattening","DestinationS3SchemasFormatCodec","DestinationS3SchemasFormatCompressionType","DestinationS3SchemasFormatFormatType","DestinationS3SchemasFormatNoCompression","DestinationS3SchemasFormatOutputFormat3Codec","DestinationS3SchemasFormatOutputFormat3CompressionCodecCodec","DestinationS3SchemasFormatOutputFormatCodec","DestinationS3SchemasFormatOutputFormatCompressionType","DestinationS3SchemasFormatOutputFormatFormatType","DestinationS3SchemasFormatType","DestinationS3SchemasGZIP","DestinationS3SchemasNoCompression","DestinationS3Snappy","DestinationS3Xz","DestinationS3Zstandard","DestinationSftpJSON","DestinationSnowflake","DestinationSnowflakeAuthType","DestinationSnowflakeOAuth20","DestinationSnowflakeSchemasAuthType","DestinationSnowflakeSchemasCredentialsAuthType","DestinationSnowflakeSnowflake","DestinationTeradata","DestinationTeradataAllow","DestinationTeradataDisable","DestinationTeradataMode","DestinationTeradataPrefer","DestinationTeradataRequire","DestinationTeradataSchemasMode","DestinationTeradataSchemasSSLModeSSLModes5Mode","DestinationTeradataSchemasSSLModeSSLModes6Mode","DestinationTeradataSchemasSSLModeSSLModesMode","DestinationTeradataSchemasSslModeMode","DestinationTeradataVerifyCa","DestinationTeradataVerifyFull","DestinationTimeplus","DestinationTypesense","DestinationVectara","DestinationVertica","DestinationVerticaNoTunnel","DestinationVerticaPasswordAuthentication","DestinationVerticaSSHKeyAuthentication","DestinationVerticaSchemasTunnelMethod","DestinationVerticaSchemasTunnelMethodTunnelMethod","DestinationVerticaTunnelMethod","DestinationWeaviate","DestinationWeaviateAPIToken","DestinationWeaviateAzureOpenAI","DestinationWeaviateByMarkdownHeader","DestinationWeaviateByProgrammingLanguage","DestinationWeaviateBySeparator","DestinationWeaviateCohere","DestinationWeaviateFake","DestinationWeaviateFieldNameMappingConfigModel","DestinationWeaviateIndexing","DestinationWeaviateLanguage","DestinationWeaviateMode","DestinationWeaviateOpenAI","DestinationWeaviateOpenAICompatible","DestinationWeaviateProcessingConfigModel","DestinationWeaviateSchemasEmbeddingEmbedding5Mode","DestinationWeaviateSchemasEmbeddingEmbedding6Mode","DestinationWeaviateSchemasEmbeddingEmbedding7Mode","DestinationWeaviateSchemasEmbeddingEmbeddingMode","DestinationWeaviateSchemasEmbeddingMode","DestinationWeaviateSchemasIndexingAuthAuthenticationMode","DestinationWeaviateSchemasIndexingAuthMode","DestinationWeaviateSchemasIndexingMode","DestinationWeaviateSchemasMode","DestinationWeaviateSchemasProcessingMode","DestinationWeaviateSchemasProcessingTextSplitterMode","DestinationWeaviateSchemasProcessingTextSplitterTextSplitterMode","DestinationWeaviateUsernamePassword","DestinationXata","DestinationsResponse","DetailType","DetectChangesWithXminSystemColumn","DevNull","Dimension","Disable","Disabled","DistanceMetric","Dixa","DocArrayHnswSearch","Dockerhub","DocumentFileTypeFormatExperimental","DoubleValue","Dremio","Duckdb","DynamoDBRegion","Dynamodb","E2eTestCloud","EUBasedAccount","Elasticsearch","Emailoctopus","Enabled","EncryptedTrustServerCertificate","EncryptedVerifyCertificate","EncryptionAlgorithm","EncryptionMethod","EncryptionType","EngagementWindowDays","Environment","ExchangeRates","Expression","ExternalTableViaS3","FacebookMarketing","Fake","Faker","Fauna","FieldNameMappingConfigModel","File","FileBasedStreamConfig","FileFormat","FileType","Filter","FilterName","FilterType","Firebolt","Firestore","Flattening","FormatType","FormatTypeWildcard","Freshcaller","Freshdesk","Freshsales","FromCSV","FromField","GCSBucketRegion","GCSGoogleCloudStorage","GCSStaging","GCSTmpFilesAfterwardProcessing","GainsightPx","Gcs","GeographyEnum","GeographyEnumNoDefault","Getlago","Github","GithubCredentials","Gitlab","GitlabCredentials","Glassfrog","GlobalAccount","Gnews","GoogleAds","GoogleAdsCredentials","GoogleAnalyticsDataAPI","GoogleAnalyticsDataAPICredentials","GoogleAnalyticsV4ServiceAccountOnly","GoogleCredentials","GoogleDirectory","GoogleDrive","GoogleDriveCredentials","GooglePagespeedInsights","GoogleSearchConsole","GoogleSheets","GoogleSheetsCredentials","GoogleWebfonts","GoogleWorkspaceAdminReports","Granularity","GranularityForGeoLocationRegion","GranularityForPeriodicReports","Greenhouse","Gridly","Gzip","HMACKey","HTTPSPublicWeb","Harvest","HarvestCredentials","Header","HeaderDefinitionType","Hubplanner","Hubspot","HubspotCredentials","IAMRole","IAMUser","In","InListFilter","Indexing","InferenceType","InitiateOauthRequest","InsightConfig","Insightly","Instagram","Instance","Instatus","Int64Value","Intercom","Ip2whois","IssuesStreamExpandWith","Iterable","JSONLinesNewlineDelimitedJSON","Jira","JobCreateRequest","JobResponse","JobStatusEnum","JobTypeEnum","JobsResponse","Jsonl","JsonlFormat","K6Cloud","Keen","KeyPairAuthentication","Kinesis","Klarna","Klaviyo","Kyve","LSNCommitBehaviour","Langchain","Language","Launchdarkly","Lemlist","Level","LeverHiring","LeverHiringCredentials","LinkedinAds","LinkedinAdsCredentials","LinkedinPages","Local","LoginPassword","Lokalise","Mailchimp","MailchimpCredentials","Mailgun","MailjetSms","Marketo","Metabase","Method","MicrosoftSharepoint","MicrosoftSharepointCredentials","MicrosoftTeams","MicrosoftTeamsCredentials","Milvus","Mixpanel","Mode","Monday","MondayCredentials","MongoDBAtlas","MongoDBAtlasReplicaSet","Mongodb","MongodbInternalPoc","MongodbV2","Mssql","MultiSchema","MyHours","Mysql","NamespaceDefinitionEnum","NamespaceDefinitionEnumNoDefault","NativeNetworkEncryptionNNE","Netsuite","NoAuth","NoAuthentication","NoCompression","NoEncryption","NoExternalEmbedding","NoTunnel","NonBreakingSchemaUpdatesBehaviorEnum","NonBreakingSchemaUpdatesBehaviorEnumNoDefault","NoneT","Normalization","NormalizationFlattening","NotExpression","Notion","NotionCredentials","Nullable","NumericFilter","Nytimes","OAuth","OAuth20","OAuth20Credentials","OAuth2AccessToken","OAuth2ConfidentialApplication","OAuthActorNames","OAuthInputConfiguration","OauthAuthentication","Okta","Omnisend","Onesignal","OpenAI","OpenAICompatible","Operator","OptionTitle","OptionsList","OrGroup","Oracle","Orb","Orbit","OriginDatacenterOfTheSurveyMonkeyAccount","OutbrainAmplify","Outreach","Parquet","ParquetColumnarStorage","ParquetFormat","ParsingStrategy","PasswordAuthentication","PaypalTransaction","Paystack","Pendo","PeriodUsedForMostPopularStreams","Persistiq","PersonalAccessToken","PexelsAPI","Pinecone","Pinterest","PinterestCredentials","Pipedrive","PivotCategory","Plugin","Pocket","Pokeapi","PokemonName","PolygonStockAPI","Postgres","Posthog","Postmarkapp","Prefer","Preferred","Prestashop","PrivateApp","PrivateToken","ProcessingConfigModel","ProductCatalog","ProjectSecret","Pubsub","PunkAPI","Pypi","Qdrant","Qualaroo","Quickbooks","Railz","ReadChangesUsingBinaryLogCDC","ReadChangesUsingChangeDataCaptureCDC","ReadChangesUsingWriteAheadLogCDC","Recharge","RecommendedManagedTables","Recreation","Recruitee","Redis","Redshift","Region","ReplicaSet","ReportConfig","ReportOptions","ReportRecordTypes","ReportingDataObject","Require","Required","Retently","RetentlyCredentials","RkiCovid","Rss","S3","S3AmazonWebServices","S3BucketRegion","S3Glue","SCPSecureCopyProtocol","SFTPSecureFileTransferProtocol","SQLInserts","SSHKeyAuthentication","SSHSecureShell","Salesforce","Salesloft","SandboxAccessToken","SapFieldglass","ScanChangesWithUserDefinedCursor","ScheduleTypeEnum","ScheduleTypeWithBasicEnum","SchemeBasicAuth","SearchCriteria","Secoda","Security","SelfManagedReplicaSet","Sendgrid","Sendinblue","Senseforce","Sentry","SerializationLibrary","ServiceAccount","ServiceAccountKey","ServiceAccountKeyAuthentication","ServiceKeyAuthentication","ServiceName","Sftp","SftpBulk","SftpJSON","ShareTypeUsedForMostPopularSharedStream","Shopify","ShopifyCredentials","Shortio","SignInViaGoogleOAuth","SignInViaSlackOAuth","Silent","SingleSchema","SingleStoreAccessToken","Slack","SlackCredentials","Smaily","Smartengage","Smartsheets","SmartsheetsCredentials","SnapchatMarketing","Snappy","Snowflake","SnowflakeCredentials","SonarCloud","SortBy","SourceAha","SourceAircall","SourceAirtable","SourceAirtableAirtable","SourceAirtableAuthMethod","SourceAirtableOAuth20","SourceAirtableSchemasAuthMethod","SourceAmazonAds","SourceAmazonAdsAmazonAds","SourceAmazonAdsAuthType","SourceAmazonSellerPartner","SourceAmazonSellerPartnerAmazonSellerPartner","SourceAmazonSellerPartnerAuthType","SourceAmazonSqs","SourceAmazonSqsAWSRegion","SourceAmplitude","SourceApifyDataset","SourceAppfollow","SourceAsana","SourceAsanaAsana","SourceAsanaCredentialsTitle","SourceAsanaSchemasCredentialsTitle","SourceAuth0","SourceAuth0SchemasAuthenticationMethod","SourceAuth0SchemasCredentialsAuthenticationMethod","SourceAwsCloudtrail","SourceAzureBlobStorage","SourceAzureBlobStorageAzureBlobStorage","SourceAzureBlobStorageFiletype","SourceAzureBlobStorageHeaderDefinitionType","SourceAzureBlobStorageMode","SourceAzureBlobStorageSchemasFiletype","SourceAzureBlobStorageSchemasHeaderDefinitionType","SourceAzureBlobStorageSchemasStreamsFiletype","SourceAzureBlobStorageSchemasStreamsFormatFiletype","SourceAzureBlobStorageSchemasStreamsFormatFormatFiletype","SourceAzureTable","SourceBambooHr","SourceBigquery","SourceBigqueryBigquery","SourceBingAds","SourceBingAdsBingAds","SourceBraintree","SourceBraintreeEnvironment","SourceBraze","SourceCart","SourceCartAuthType","SourceCartSchemasAuthType","SourceChargebee","SourceChartmogul","SourceClickhouse","SourceClickhouseClickhouse","SourceClickhouseNoTunnel","SourceClickhousePasswordAuthentication","SourceClickhouseSSHKeyAuthentication","SourceClickhouseSchemasTunnelMethod","SourceClickhouseSchemasTunnelMethodTunnelMethod","SourceClickhouseTunnelMethod","SourceClickupAPI","SourceClockify","SourceCloseCom","SourceCoda","SourceCoinAPI","SourceCoinmarketcap","SourceConfigcat","SourceConfluence","SourceConvex","SourceConvexConvex","SourceCreateRequest","SourceDatascope","SourceDelighted","SourceDixa","SourceDockerhub","SourceDremio","SourceDynamodb","SourceDynamodbDynamodb","SourceDynamodbDynamodbRegion","SourceE2eTestCloudSchemasType","SourceE2eTestCloudType","SourceEmailoctopus","SourceExchangeRates","SourceFacebookMarketing","SourceFacebookMarketingFacebookMarketing","SourceFacebookMarketingValidEnums","SourceFaker","SourceFauna","SourceFaunaDeletionMode","SourceFaunaSchemasDeletionMode","SourceFile","SourceFileS3AmazonWebServices","SourceFileSchemasProviderStorage","SourceFileSchemasProviderStorageProvider6Storage","SourceFileSchemasProviderStorageProvider7Storage","SourceFileSchemasProviderStorageProviderStorage","SourceFileSchemasStorage","SourceFileStorage","SourceFirebolt","SourceFireboltFirebolt","SourceFreshcaller","SourceFreshdesk","SourceFreshsales","SourceGCSStreamConfig","SourceGainsightPx","SourceGcs","SourceGcsAutogenerated","SourceGcsCSVFormat","SourceGcsFiletype","SourceGcsFromCSV","SourceGcsGcs","SourceGcsHeaderDefinitionType","SourceGcsInferenceType","SourceGcsSchemasHeaderDefinitionType","SourceGcsSchemasStreamsHeaderDefinitionType","SourceGcsUserProvided","SourceGcsValidationPolicy","SourceGetlago","SourceGithub","SourceGithubGithub","SourceGithubOptionTitle","SourceGithubPersonalAccessToken","SourceGitlab","SourceGitlabAuthType","SourceGitlabGitlab","SourceGitlabOAuth20","SourceGitlabSchemasAuthType","SourceGlassfrog","SourceGnews","SourceGoogleAds","SourceGoogleAdsGoogleAds","SourceGoogleAnalyticsDataAPI","SourceGoogleAnalyticsDataAPIAndGroup","SourceGoogleAnalyticsDataAPIAuthType","SourceGoogleAnalyticsDataAPIBetweenFilter","SourceGoogleAnalyticsDataAPICustomReportConfig","SourceGoogleAnalyticsDataAPIDisabled","SourceGoogleAnalyticsDataAPIDoubleValue","SourceGoogleAnalyticsDataAPIEnabled","SourceGoogleAnalyticsDataAPIExpression","SourceGoogleAnalyticsDataAPIFilter","SourceGoogleAnalyticsDataAPIFilterName","SourceGoogleAnalyticsDataAPIFilterType","SourceGoogleAnalyticsDataAPIGoogleAnalyticsDataAPI","SourceGoogleAnalyticsDataAPIGranularity","SourceGoogleAnalyticsDataAPIInListFilter","SourceGoogleAnalyticsDataAPIInt64Value","SourceGoogleAnalyticsDataAPINotExpression","SourceGoogleAnalyticsDataAPINumericFilter","SourceGoogleAnalyticsDataAPIOrGroup","SourceGoogleAnalyticsDataAPISchemasAuthType","SourceGoogleAnalyticsDataAPISchemasBetweenFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayBetweenFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterBetweenFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1DoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterFilter4ToValueValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterFilter4ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1FilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1Int64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2DoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsFilterFilter4ToValueValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsFilterFilter4ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsFilterFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2FilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2Int64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3DoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterFilter4ToValueValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterFilter4ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3FilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3Int64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterInListFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterNumericFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterStringFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayEnabled","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayExpression","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayFilterType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayInListFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterBetweenFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterExpression","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterFilterType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterInListFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1DoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilter3ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilter3ValueValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1FilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1Int64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2DoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterFilter4ToValueValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterFilter4ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2FilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2Int64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3BetweenFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3DoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterFilter4ToValueValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterFilter4ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3FilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3FilterType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3InListFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3Int64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3NumericFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3StringFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterFilter4ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterBetweenFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterExpression","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFilterType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterInListFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterNumericFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterStringFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterNumericFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterStringFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayNumericFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayStringFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayValueType","SourceGoogleAnalyticsDataAPISchemasDoubleValue","SourceGoogleAnalyticsDataAPISchemasEnabled","SourceGoogleAnalyticsDataAPISchemasExpression","SourceGoogleAnalyticsDataAPISchemasFilterName","SourceGoogleAnalyticsDataAPISchemasFilterType","SourceGoogleAnalyticsDataAPISchemasInListFilter","SourceGoogleAnalyticsDataAPISchemasInt64Value","SourceGoogleAnalyticsDataAPISchemasNumericFilter","SourceGoogleAnalyticsDataAPISchemasStringFilter","SourceGoogleAnalyticsDataAPISchemasValidEnums","SourceGoogleAnalyticsDataAPISchemasValueType","SourceGoogleAnalyticsDataAPIStringFilter","SourceGoogleAnalyticsDataAPIValidEnums","SourceGoogleAnalyticsDataAPIValueType","SourceGoogleAnalyticsV4ServiceAccountOnly","SourceGoogleAnalyticsV4ServiceAccountOnlyAuthType","SourceGoogleAnalyticsV4ServiceAccountOnlyServiceAccountKeyAuthentication","SourceGoogleDirectory","SourceGoogleDirectoryCredentialsTitle","SourceGoogleDirectorySchemasCredentialsTitle","SourceGoogleDrive","SourceGoogleDriveAuthType","SourceGoogleDriveAuthenticateViaGoogleOAuth","SourceGoogleDriveAutogenerated","SourceGoogleDriveAvroFormat","SourceGoogleDriveCSVFormat","SourceGoogleDriveDocumentFileTypeFormatExperimental","SourceGoogleDriveFileBasedStreamConfig","SourceGoogleDriveFiletype","SourceGoogleDriveFromCSV","SourceGoogleDriveGoogleDrive","SourceGoogleDriveHeaderDefinitionType","SourceGoogleDriveJsonlFormat","SourceGoogleDriveLocal","SourceGoogleDriveMode","SourceGoogleDriveParquetFormat","SourceGoogleDriveParsingStrategy","SourceGoogleDriveSchemasAuthType","SourceGoogleDriveSchemasFiletype","SourceGoogleDriveSchemasHeaderDefinitionType","SourceGoogleDriveSchemasStreamsFiletype","SourceGoogleDriveSchemasStreamsFormatFiletype","SourceGoogleDriveSchemasStreamsFormatFormatFiletype","SourceGoogleDriveSchemasStreamsHeaderDefinitionType","SourceGoogleDriveServiceAccountKeyAuthentication","SourceGoogleDriveUserProvided","SourceGoogleDriveValidationPolicy","SourceGooglePagespeedInsights","SourceGoogleSearchConsole","SourceGoogleSearchConsoleAuthType","SourceGoogleSearchConsoleCustomReportConfig","SourceGoogleSearchConsoleGoogleSearchConsole","SourceGoogleSearchConsoleOAuth","SourceGoogleSearchConsoleSchemasAuthType","SourceGoogleSearchConsoleServiceAccountKeyAuthentication","SourceGoogleSearchConsoleValidEnums","SourceGoogleSheets","SourceGoogleSheetsAuthType","SourceGoogleSheetsAuthenticateViaGoogleOAuth","SourceGoogleSheetsGoogleSheets","SourceGoogleSheetsSchemasAuthType","SourceGoogleSheetsServiceAccountKeyAuthentication","SourceGoogleWebfonts","SourceGoogleWorkspaceAdminReports","SourceGreenhouse","SourceGridly","SourceHarvest","SourceHarvestAuthType","SourceHarvestAuthenticateWithPersonalAccessToken","SourceHarvestHarvest","SourceHarvestSchemasAuthType","SourceHubplanner","SourceHubspot","SourceHubspotAuthType","SourceHubspotHubspot","SourceHubspotOAuth","SourceHubspotSchemasAuthType","SourceInsightly","SourceInstagram","SourceInstagramInstagram","SourceInstatus","SourceIntercom","SourceIntercomIntercom","SourceIp2whois","SourceIterable","SourceJira","SourceK6Cloud","SourceKlarna","SourceKlarnaRegion","SourceKlaviyo","SourceKyve","SourceLaunchdarkly","SourceLemlist","SourceLeverHiring","SourceLeverHiringAuthType","SourceLeverHiringEnvironment","SourceLeverHiringLeverHiring","SourceLeverHiringSchemasAuthType","SourceLinkedinAds","SourceLinkedinAdsAuthMethod","SourceLinkedinAdsLinkedinAds","SourceLinkedinAdsOAuth20","SourceLinkedinAdsSchemasAuthMethod","SourceLinkedinPages","SourceLinkedinPagesAccessToken","SourceLinkedinPagesAuthMethod","SourceLinkedinPagesOAuth20","SourceLinkedinPagesSchemasAuthMethod","SourceLokalise","SourceMailchimp","SourceMailchimpAuthType","SourceMailchimpMailchimp","SourceMailchimpOAuth20","SourceMailchimpSchemasAuthType","SourceMailgun","SourceMailjetSms","SourceMarketo","SourceMetabase","SourceMicrosoftSharepoint","SourceMicrosoftSharepointAuthType","SourceMicrosoftSharepointAutogenerated","SourceMicrosoftSharepointAvroFormat","SourceMicrosoftSharepointCSVFormat","SourceMicrosoftSharepointDocumentFileTypeFormatExperimental","SourceMicrosoftSharepointFileBasedStreamConfig","SourceMicrosoftSharepointFiletype","SourceMicrosoftSharepointFromCSV","SourceMicrosoftSharepointHeaderDefinitionType","SourceMicrosoftSharepointJsonlFormat","SourceMicrosoftSharepointLocal","SourceMicrosoftSharepointMicrosoftSharepoint","SourceMicrosoftSharepointMode","SourceMicrosoftSharepointParquetFormat","SourceMicrosoftSharepointParsingStrategy","SourceMicrosoftSharepointSchemasAuthType","SourceMicrosoftSharepointSchemasFiletype","SourceMicrosoftSharepointSchemasHeaderDefinitionType","SourceMicrosoftSharepointSchemasStreamsFiletype","SourceMicrosoftSharepointSchemasStreamsFormatFiletype","SourceMicrosoftSharepointSchemasStreamsFormatFormatFiletype","SourceMicrosoftSharepointSchemasStreamsHeaderDefinitionType","SourceMicrosoftSharepointUserProvided","SourceMicrosoftSharepointValidationPolicy","SourceMicrosoftTeams","SourceMicrosoftTeamsAuthType","SourceMicrosoftTeamsMicrosoftTeams","SourceMicrosoftTeamsSchemasAuthType","SourceMixpanel","SourceMixpanelOptionTitle","SourceMixpanelRegion","SourceMixpanelSchemasOptionTitle","SourceMonday","SourceMondayAuthType","SourceMondayMonday","SourceMondayOAuth20","SourceMondaySchemasAuthType","SourceMongodbInternalPoc","SourceMongodbV2","SourceMongodbV2ClusterType","SourceMongodbV2SchemasClusterType","SourceMssql","SourceMssqlEncryptedTrustServerCertificate","SourceMssqlEncryptedVerifyCertificate","SourceMssqlMethod","SourceMssqlMssql","SourceMssqlNoTunnel","SourceMssqlPasswordAuthentication","SourceMssqlSSHKeyAuthentication","SourceMssqlSchemasMethod","SourceMssqlSchemasSSLMethodSSLMethodSSLMethod","SourceMssqlSchemasSslMethod","SourceMssqlSchemasSslMethodSslMethod","SourceMssqlSchemasTunnelMethod","SourceMssqlSchemasTunnelMethodTunnelMethod","SourceMssqlTunnelMethod","SourceMyHours","SourceMysql","SourceMysqlMethod","SourceMysqlMode","SourceMysqlMysql","SourceMysqlNoTunnel","SourceMysqlPasswordAuthentication","SourceMysqlSSHKeyAuthentication","SourceMysqlScanChangesWithUserDefinedCursor","SourceMysqlSchemasMethod","SourceMysqlSchemasMode","SourceMysqlSchemasSSLModeSSLModesMode","SourceMysqlSchemasSslModeMode","SourceMysqlSchemasTunnelMethod","SourceMysqlSchemasTunnelMethodTunnelMethod","SourceMysqlTunnelMethod","SourceMysqlVerifyCA","SourceNetsuite","SourceNotion","SourceNotionAccessToken","SourceNotionAuthType","SourceNotionNotion","SourceNotionOAuth20","SourceNotionSchemasAuthType","SourceNytimes","SourceOkta","SourceOktaAPIToken","SourceOktaAuthType","SourceOktaOAuth20","SourceOktaSchemasAuthType","SourceOmnisend","SourceOnesignal","SourceOracle","SourceOracleConnectionType","SourceOracleEncryptionMethod","SourceOracleNoTunnel","SourceOracleOracle","SourceOraclePasswordAuthentication","SourceOracleSSHKeyAuthentication","SourceOracleSchemasTunnelMethod","SourceOracleSchemasTunnelMethodTunnelMethod","SourceOracleTunnelMethod","SourceOrb","SourceOrbit","SourceOutbrainAmplify","SourceOutbrainAmplifyAccessToken","SourceOutbrainAmplifyUsernamePassword","SourceOutreach","SourcePatchRequest","SourcePaypalTransaction","SourcePaystack","SourcePendo","SourcePersistiq","SourcePexelsAPI","SourcePinterest","SourcePinterestAuthMethod","SourcePinterestLevel","SourcePinterestPinterest","SourcePinterestSchemasValidEnums","SourcePinterestValidEnums","SourcePipedrive","SourcePocket","SourcePocketSortBy","SourcePokeapi","SourcePolygonStockAPI","SourcePostgres","SourcePostgresAllow","SourcePostgresDisable","SourcePostgresMethod","SourcePostgresMode","SourcePostgresNoTunnel","SourcePostgresPasswordAuthentication","SourcePostgresPostgres","SourcePostgresPrefer","SourcePostgresRequire","SourcePostgresSSHKeyAuthentication","SourcePostgresScanChangesWithUserDefinedCursor","SourcePostgresSchemasMethod","SourcePostgresSchemasMode","SourcePostgresSchemasReplicationMethodMethod","SourcePostgresSchemasSSLModeSSLModes5Mode","SourcePostgresSchemasSSLModeSSLModes6Mode","SourcePostgresSchemasSSLModeSSLModesMode","SourcePostgresSchemasSslModeMode","SourcePostgresSchemasTunnelMethod","SourcePostgresSchemasTunnelMethodTunnelMethod","SourcePostgresTunnelMethod","SourcePostgresVerifyCa","SourcePostgresVerifyFull","SourcePosthog","SourcePostmarkapp","SourcePrestashop","SourcePunkAPI","SourcePutRequest","SourcePypi","SourceQualaroo","SourceQuickbooks","SourceQuickbooksAuthType","SourceQuickbooksOAuth20","SourceRailz","SourceRecharge","SourceRecreation","SourceRecruitee","SourceRedshift","SourceRedshiftRedshift","SourceResponse","SourceRetently","SourceRetentlyAuthType","SourceRetentlyRetently","SourceRetentlySchemasAuthType","SourceRkiCovid","SourceRss","SourceS3","SourceS3Autogenerated","SourceS3AvroFormat","SourceS3CSVFormat","SourceS3DocumentFileTypeFormatExperimental","SourceS3FileBasedStreamConfig","SourceS3Filetype","SourceS3FromCSV","SourceS3HeaderDefinitionType","SourceS3InferenceType","SourceS3JsonlFormat","SourceS3Local","SourceS3Mode","SourceS3ParquetFormat","SourceS3ParsingStrategy","SourceS3S3","SourceS3SchemasFiletype","SourceS3SchemasFormatFileFormatFiletype","SourceS3SchemasFormatFiletype","SourceS3SchemasHeaderDefinitionType","SourceS3SchemasStreamsFiletype","SourceS3SchemasStreamsFormatFiletype","SourceS3SchemasStreamsFormatFormat4Filetype","SourceS3SchemasStreamsFormatFormat5Filetype","SourceS3SchemasStreamsFormatFormatFiletype","SourceS3SchemasStreamsHeaderDefinitionType","SourceS3UserProvided","SourceS3ValidationPolicy","SourceSalesforce","SourceSalesforceSalesforce","SourceSalesloft","SourceSalesloftAuthType","SourceSalesloftSchemasAuthType","SourceSapFieldglass","SourceSecoda","SourceSendgrid","SourceSendinblue","SourceSenseforce","SourceSentry","SourceSftp","SourceSftpAuthMethod","SourceSftpBulk","SourceSftpPasswordAuthentication","SourceSftpSSHKeyAuthentication","SourceSftpSchemasAuthMethod","SourceShopify","SourceShopifyAuthMethod","SourceShopifyOAuth20","SourceShopifySchemasAuthMethod","SourceShopifyShopify","SourceShortio","SourceSlack","SourceSlackAPIToken","SourceSlackOptionTitle","SourceSlackSchemasOptionTitle","SourceSlackSlack","SourceSmaily","SourceSmartengage","SourceSmartsheets","SourceSmartsheetsAuthType","SourceSmartsheetsOAuth20","SourceSmartsheetsSchemasAuthType","SourceSmartsheetsSmartsheets","SourceSnapchatMarketing","SourceSnapchatMarketingSnapchatMarketing","SourceSnowflake","SourceSnowflakeAuthType","SourceSnowflakeOAuth20","SourceSnowflakeSchemasAuthType","SourceSnowflakeSnowflake","SourceSnowflakeUsernameAndPassword","SourceSonarCloud","SourceSpacexAPI","SourceSquare","SourceSquareAPIKey","SourceSquareAuthType","SourceSquareSchemasAuthType","SourceSquareSquare","SourceStrava","SourceStravaAuthType","SourceStravaStrava","SourceStripe","SourceSurveySparrow","SourceSurveySparrowURLBase","SourceSurveymonkey","SourceSurveymonkeyAuthMethod","SourceSurveymonkeySurveymonkey","SourceTempo","SourceTheGuardianAPI","SourceTiktokMarketing","SourceTiktokMarketingAuthType","SourceTiktokMarketingOAuth20","SourceTiktokMarketingSchemasAuthType","SourceTiktokMarketingTiktokMarketing","SourceTrello","SourceTrustpilot","SourceTrustpilotAPIKey","SourceTrustpilotAuthType","SourceTrustpilotOAuth20","SourceTrustpilotSchemasAuthType","SourceTvmazeSchedule","SourceTwilio","SourceTwilioTaskrouter","SourceTwitter","SourceTypeform","SourceTypeformAuthType","SourceTypeformOAuth20","SourceTypeformPrivateToken","SourceTypeformSchemasAuthType","SourceTypeformTypeform","SourceUsCensus","SourceVantage","SourceWebflow","SourceWhiskyHunter","SourceWikipediaPageviews","SourceWoocommerce","SourceXkcd","SourceYandexMetrica","SourceYotpo","SourceYoutubeAnalytics","SourceYoutubeAnalyticsYoutubeAnalytics","SourceZendeskChat","SourceZendeskChatAccessToken","SourceZendeskChatCredentials","SourceZendeskChatOAuth20","SourceZendeskChatSchemasCredentials","SourceZendeskChatZendeskChat","SourceZendeskSell","SourceZendeskSunshine","SourceZendeskSunshineAPIToken","SourceZendeskSunshineAuthMethod","SourceZendeskSunshineOAuth20","SourceZendeskSunshineSchemasAuthMethod","SourceZendeskSunshineZendeskSunshine","SourceZendeskSupport","SourceZendeskSupportAPIToken","SourceZendeskSupportCredentials","SourceZendeskSupportOAuth20","SourceZendeskSupportSchemasCredentials","SourceZendeskSupportZendeskSupport","SourceZendeskTalk","SourceZendeskTalkAPIToken","SourceZendeskTalkAuthType","SourceZendeskTalkOAuth20","SourceZendeskTalkSchemasAuthType","SourceZendeskTalkZendeskTalk","SourceZenloop","SourceZohoCrm","SourceZohoCrmEnvironment","SourceZoom","SourcesResponse","SpacexAPI","Square","SquareCredentials","StandaloneMongoDbInstance","Standard","StandardInserts","State","StateFilter","Status","Storage","Strategies","Strava","StreamConfiguration","StreamConfigurations","StreamName","StreamProperties","StreamPropertiesResponse","StreamsCriteria","StringFilter","Stripe","SurveyMonkeyAuthorizationMethod","SurveySparrow","Surveymonkey","SurveymonkeyCredentials","SystemIDSID","TLSEncryptedVerifyCertificate","Tempo","Teradata","TestDestinationType","TheGuardianAPI","TiktokMarketing","TiktokMarketingCredentials","TimeGranularity","Timeplus","TopHeadlinesTopic","TransformationQueryRunType","Trello","Trustpilot","TunnelMethod","TvmazeSchedule","Twilio","TwilioTaskrouter","Twitter","Type","Typeform","TypeformCredentials","Typesense","URLBase","Unencrypted","UnexpectedFieldBehavior","UsCensus","UserProvided","UsernameAndPassword","UsernamePassword","ValidActionBreakdowns","ValidBreakdowns","ValidationPolicy","Validenums","ValueType","Vantage","Vectara","VerifyCa","VerifyFull","VerifyIdentity","Vertica","ViewWindowDays","Weaviate","Webflow","WhiskyHunter","WikipediaPageviews","Woocommerce","WorkspaceCreateRequest","WorkspaceOAuthCredentialsRequest","WorkspaceResponse","WorkspaceUpdateRequest","WorkspacesResponse","Xata","Xkcd","Xz","YandexMetrica","Yotpo","YoutubeAnalytics","YoutubeAnalyticsCredentials","ZendeskChat","ZendeskChatCredentials","ZendeskSell","ZendeskSunshine","ZendeskSunshineCredentials","ZendeskSupport","ZendeskSupportCredentials","ZendeskTalk","ZendeskTalkCredentials","Zenloop","ZohoCRMEdition","ZohoCrm","Zoom","Zstandard"] diff --git a/src/airbyte/models/shared/destination_cumulio.py b/src/airbyte/models/shared/destination_cumulio.py deleted file mode 100644 index 68c50de4..00000000 --- a/src/airbyte/models/shared/destination_cumulio.py +++ /dev/null @@ -1,25 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from airbyte import utils -from dataclasses_json import Undefined, dataclass_json -from enum import Enum -from typing import Final, Optional - -class Cumulio(str, Enum): - CUMULIO = 'cumulio' - - -@dataclass_json(undefined=Undefined.EXCLUDE) -@dataclasses.dataclass -class DestinationCumulio: - api_key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('api_key') }}) - 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).""" - 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_databend.py b/src/airbyte/models/shared/destination_databend.py deleted file mode 100644 index 6c7411cf..00000000 --- a/src/airbyte/models/shared/destination_databend.py +++ /dev/null @@ -1,31 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from airbyte import utils -from dataclasses_json import Undefined, dataclass_json -from enum import Enum -from typing import Final, Optional - -class Databend(str, Enum): - DATABEND = 'databend' - - -@dataclass_json(undefined=Undefined.EXCLUDE) -@dataclasses.dataclass -class DestinationDatabend: - database: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('database') }}) - r"""Name of the database.""" - host: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('host') }}) - r"""Hostname of the database.""" - username: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('username') }}) - r"""Username to use to access the database.""" - DESTINATION_TYPE: Final[Databend] = dataclasses.field(default=Databend.DATABEND, 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 the username.""" - port: Optional[int] = dataclasses.field(default=443, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('port'), 'exclude': lambda f: f is None }}) - r"""Port of the database.""" - table: Optional[str] = dataclasses.field(default='default', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('table'), 'exclude': lambda f: f is None }}) - r"""The default table was written to.""" - - diff --git a/src/airbyte/models/shared/destination_firebolt.py b/src/airbyte/models/shared/destination_firebolt.py deleted file mode 100644 index e2bfd4d8..00000000 --- a/src/airbyte/models/shared/destination_firebolt.py +++ /dev/null @@ -1,63 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from airbyte import utils -from dataclasses_json import Undefined, dataclass_json -from enum import Enum -from typing import Final, Optional, Union - -class Firebolt(str, Enum): - FIREBOLT = 'firebolt' - -class DestinationFireboltSchemasMethod(str, Enum): - S3 = 'S3' - - -@dataclass_json(undefined=Undefined.EXCLUDE) -@dataclasses.dataclass -class ExternalTableViaS3: - aws_key_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('aws_key_id') }}) - r"""AWS access key granting read and write access to S3.""" - aws_key_secret: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('aws_key_secret') }}) - r"""Corresponding secret part of the AWS Key""" - s3_bucket: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('s3_bucket') }}) - r"""The name of the S3 bucket.""" - s3_region: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('s3_region') }}) - r"""Region name of the S3 bucket.""" - METHOD: Final[DestinationFireboltSchemasMethod] = dataclasses.field(default=DestinationFireboltSchemasMethod.S3, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('method') }}) - - - -class DestinationFireboltMethod(str, Enum): - SQL = 'SQL' - - -@dataclass_json(undefined=Undefined.EXCLUDE) -@dataclasses.dataclass -class SQLInserts: - METHOD: Final[DestinationFireboltMethod] = dataclasses.field(default=DestinationFireboltMethod.SQL, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('method') }}) - - - - -@dataclass_json(undefined=Undefined.EXCLUDE) -@dataclasses.dataclass -class DestinationFirebolt: - database: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('database') }}) - r"""The database to connect to.""" - password: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('password') }}) - 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.""" - 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 }}) - r"""The host name of your Firebolt database.""" - loading_method: Optional[Union[SQLInserts, ExternalTableViaS3]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('loading_method'), 'exclude': lambda f: f is None }}) - r"""Loading method used to select the way data will be uploaded to Firebolt""" - - diff --git a/src/airbyte/models/shared/destination_keen.py b/src/airbyte/models/shared/destination_keen.py deleted file mode 100644 index 1bccb775..00000000 --- a/src/airbyte/models/shared/destination_keen.py +++ /dev/null @@ -1,25 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from airbyte import utils -from dataclasses_json import Undefined, dataclass_json -from enum import Enum -from typing import Final, Optional - -class Keen(str, Enum): - KEEN = 'keen' - - -@dataclass_json(undefined=Undefined.EXCLUDE) -@dataclasses.dataclass -class DestinationKeen: - api_key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('api_key') }}) - r"""To get Keen Master API Key, navigate to the Access tab from the left-hand, side panel and check the Project Details section.""" - project_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('project_id') }}) - r"""To get Keen Project ID, navigate to the Access tab from the left-hand, side panel and check the Project Details section.""" - DESTINATION_TYPE: Final[Keen] = dataclasses.field(default=Keen.KEEN, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) - infer_timestamp: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('infer_timestamp'), 'exclude': lambda f: f is None }}) - r"""Allow connector to guess keen.timestamp value based on the streamed data.""" - - diff --git a/src/airbyte/models/shared/destination_kinesis.py b/src/airbyte/models/shared/destination_kinesis.py deleted file mode 100644 index 4490f52e..00000000 --- a/src/airbyte/models/shared/destination_kinesis.py +++ /dev/null @@ -1,31 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from airbyte import utils -from dataclasses_json import Undefined, dataclass_json -from enum import Enum -from typing import Final, Optional - -class Kinesis(str, Enum): - KINESIS = 'kinesis' - - -@dataclass_json(undefined=Undefined.EXCLUDE) -@dataclasses.dataclass -class DestinationKinesis: - access_key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accessKey') }}) - r"""Generate the AWS Access Key for current user.""" - endpoint: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('endpoint') }}) - r"""AWS Kinesis endpoint.""" - private_key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('privateKey') }}) - 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.""" - 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_timeplus.py b/src/airbyte/models/shared/destination_timeplus.py deleted file mode 100644 index 379e5dd8..00000000 --- a/src/airbyte/models/shared/destination_timeplus.py +++ /dev/null @@ -1,23 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from airbyte import utils -from dataclasses_json import Undefined, dataclass_json -from enum import Enum -from typing import Final, Optional - -class Timeplus(str, Enum): - TIMEPLUS = 'timeplus' - - -@dataclass_json(undefined=Undefined.EXCLUDE) -@dataclasses.dataclass -class DestinationTimeplus: - apikey: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('apikey') }}) - r"""Personal API key""" - DESTINATION_TYPE: Final[Timeplus] = dataclasses.field(default=Timeplus.TIMEPLUS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) - endpoint: Optional[str] = dataclasses.field(default='https://us.timeplus.cloud/', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('endpoint'), 'exclude': lambda f: f is None }}) - r"""Timeplus workspace endpoint""" - - diff --git a/src/airbyte/models/shared/destination_vertica.py b/src/airbyte/models/shared/destination_vertica.py deleted file mode 100644 index b4fd28a5..00000000 --- a/src/airbyte/models/shared/destination_vertica.py +++ /dev/null @@ -1,90 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from airbyte import utils -from dataclasses_json import Undefined, dataclass_json -from enum import Enum -from typing import Final, Optional, Union - -class Vertica(str, Enum): - VERTICA = 'vertica' - -class DestinationVerticaSchemasTunnelMethodTunnelMethod(str, Enum): - r"""Connect through a jump server tunnel host using username and password authentication""" - SSH_PASSWORD_AUTH = 'SSH_PASSWORD_AUTH' - - -@dataclass_json(undefined=Undefined.EXCLUDE) -@dataclasses.dataclass -class DestinationVerticaPasswordAuthentication: - tunnel_host: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tunnel_host') }}) - r"""Hostname of the jump server host that allows inbound ssh tunnel.""" - tunnel_user: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tunnel_user') }}) - r"""OS-level username for logging into the jump server host""" - tunnel_user_password: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tunnel_user_password') }}) - r"""OS-level password for logging into the jump server host""" - TUNNEL_METHOD: Final[DestinationVerticaSchemasTunnelMethodTunnelMethod] = dataclasses.field(default=DestinationVerticaSchemasTunnelMethodTunnelMethod.SSH_PASSWORD_AUTH, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tunnel_method') }}) - r"""Connect through a jump server tunnel host using username and password authentication""" - tunnel_port: Optional[int] = dataclasses.field(default=22, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tunnel_port'), 'exclude': lambda f: f is None }}) - r"""Port on the proxy/jump server that accepts inbound ssh connections.""" - - - -class DestinationVerticaSchemasTunnelMethod(str, Enum): - r"""Connect through a jump server tunnel host using username and ssh key""" - SSH_KEY_AUTH = 'SSH_KEY_AUTH' - - -@dataclass_json(undefined=Undefined.EXCLUDE) -@dataclasses.dataclass -class DestinationVerticaSSHKeyAuthentication: - ssh_key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ssh_key') }}) - r"""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 = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tunnel_host') }}) - r"""Hostname of the jump server host that allows inbound ssh tunnel.""" - tunnel_user: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tunnel_user') }}) - r"""OS-level username for logging into the jump server host.""" - TUNNEL_METHOD: Final[DestinationVerticaSchemasTunnelMethod] = dataclasses.field(default=DestinationVerticaSchemasTunnelMethod.SSH_KEY_AUTH, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tunnel_method') }}) - r"""Connect through a jump server tunnel host using username and ssh key""" - tunnel_port: Optional[int] = dataclasses.field(default=22, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tunnel_port'), 'exclude': lambda f: f is None }}) - r"""Port on the proxy/jump server that accepts inbound ssh connections.""" - - - -class DestinationVerticaTunnelMethod(str, Enum): - r"""No ssh tunnel needed to connect to database""" - NO_TUNNEL = 'NO_TUNNEL' - - -@dataclass_json(undefined=Undefined.EXCLUDE) -@dataclasses.dataclass -class DestinationVerticaNoTunnel: - TUNNEL_METHOD: Final[DestinationVerticaTunnelMethod] = dataclasses.field(default=DestinationVerticaTunnelMethod.NO_TUNNEL, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tunnel_method') }}) - r"""No ssh tunnel needed to connect to database""" - - - - -@dataclass_json(undefined=Undefined.EXCLUDE) -@dataclasses.dataclass -class DestinationVertica: - database: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('database') }}) - r"""Name of the database.""" - host: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('host') }}) - r"""Hostname of the database.""" - schema: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('schema') }}) - r"""Schema for vertica destination""" - username: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('username') }}) - r"""Username to use to access the database.""" - DESTINATION_TYPE: Final[Vertica] = dataclasses.field(default=Vertica.VERTICA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) - 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).""" - 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 the username.""" - port: Optional[int] = dataclasses.field(default=5433, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('port'), 'exclude': lambda f: f is None }}) - r"""Port of the database.""" - tunnel_method: Optional[Union[DestinationVerticaNoTunnel, DestinationVerticaSSHKeyAuthentication, DestinationVerticaPasswordAuthentication]] = 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/destination_xata.py b/src/airbyte/models/shared/destination_xata.py deleted file mode 100644 index e7c6dcdf..00000000 --- a/src/airbyte/models/shared/destination_xata.py +++ /dev/null @@ -1,23 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from airbyte import utils -from dataclasses_json import Undefined, dataclass_json -from enum import Enum -from typing import Final - -class Xata(str, Enum): - XATA = 'xata' - - -@dataclass_json(undefined=Undefined.EXCLUDE) -@dataclasses.dataclass -class DestinationXata: - api_key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('api_key') }}) - r"""API Key to connect.""" - db_url: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('db_url') }}) - r"""URL pointing to your workspace.""" - DESTINATION_TYPE: Final[Xata] = dataclasses.field(default=Xata.XATA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) - - diff --git a/src/airbyte/models/shared/destinationcreaterequest.py b/src/airbyte/models/shared/destinationcreaterequest.py deleted file mode 100644 index 2f862d12..00000000 --- a/src/airbyte/models/shared/destinationcreaterequest.py +++ /dev/null @@ -1,63 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from .destination_astra import DestinationAstra -from .destination_aws_datalake import DestinationAwsDatalake -from .destination_azure_blob_storage import DestinationAzureBlobStorage -from .destination_bigquery import DestinationBigquery -from .destination_clickhouse import DestinationClickhouse -from .destination_convex import DestinationConvex -from .destination_cumulio import DestinationCumulio -from .destination_databend import DestinationDatabend -from .destination_databricks import DestinationDatabricks -from .destination_dev_null import DestinationDevNull -from .destination_duckdb import DestinationDuckdb -from .destination_dynamodb import DestinationDynamodb -from .destination_elasticsearch import DestinationElasticsearch -from .destination_firebolt import DestinationFirebolt -from .destination_firestore import DestinationFirestore -from .destination_gcs import DestinationGcs -from .destination_google_sheets import DestinationGoogleSheets -from .destination_keen import DestinationKeen -from .destination_kinesis import DestinationKinesis -from .destination_langchain import DestinationLangchain -from .destination_milvus import DestinationMilvus -from .destination_mongodb import DestinationMongodb -from .destination_mssql import DestinationMssql -from .destination_mysql import DestinationMysql -from .destination_oracle import DestinationOracle -from .destination_pinecone import DestinationPinecone -from .destination_postgres import DestinationPostgres -from .destination_pubsub import DestinationPubsub -from .destination_qdrant import DestinationQdrant -from .destination_redis import DestinationRedis -from .destination_redshift import DestinationRedshift -from .destination_s3 import DestinationS3 -from .destination_s3_glue import DestinationS3Glue -from .destination_sftp_json import DestinationSftpJSON -from .destination_snowflake import DestinationSnowflake -from .destination_teradata import DestinationTeradata -from .destination_timeplus import DestinationTimeplus -from .destination_typesense import DestinationTypesense -from .destination_vectara import DestinationVectara -from .destination_vertica import DestinationVertica -from .destination_weaviate import DestinationWeaviate -from .destination_xata import DestinationXata -from airbyte import utils -from dataclasses_json import Undefined, dataclass_json -from typing import Optional, Union - - -@dataclass_json(undefined=Undefined.EXCLUDE) -@dataclasses.dataclass -class DestinationCreateRequest: - configuration: Union[DestinationGoogleSheets, DestinationAstra, DestinationAwsDatalake, DestinationAzureBlobStorage, DestinationBigquery, DestinationClickhouse, DestinationConvex, DestinationCumulio, DestinationDatabend, DestinationDatabricks, DestinationDevNull, DestinationDuckdb, DestinationDynamodb, DestinationElasticsearch, DestinationFirebolt, DestinationFirestore, DestinationGcs, DestinationKeen, DestinationKinesis, DestinationLangchain, DestinationMilvus, DestinationMongodb, DestinationMssql, DestinationMysql, DestinationOracle, DestinationPinecone, DestinationPostgres, DestinationPubsub, DestinationQdrant, DestinationRedis, DestinationRedshift, DestinationS3, DestinationS3Glue, DestinationSftpJSON, DestinationSnowflake, DestinationTeradata, DestinationTimeplus, DestinationTypesense, DestinationVectara, DestinationVertica, DestinationWeaviate, DestinationXata] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('configuration') }}) - r"""The values required to configure the destination.""" - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - r"""Name of the destination e.g. dev-mysql-instance.""" - workspace_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('workspaceId') }}) - definition_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('definitionId'), 'exclude': lambda f: f is None }}) - r"""The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided.""" - - diff --git a/src/airbyte/models/shared/destinationpatchrequest.py b/src/airbyte/models/shared/destinationpatchrequest.py deleted file mode 100644 index 8beca8cd..00000000 --- a/src/airbyte/models/shared/destinationpatchrequest.py +++ /dev/null @@ -1,59 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from .destination_astra import DestinationAstra -from .destination_aws_datalake import DestinationAwsDatalake -from .destination_azure_blob_storage import DestinationAzureBlobStorage -from .destination_bigquery import DestinationBigquery -from .destination_clickhouse import DestinationClickhouse -from .destination_convex import DestinationConvex -from .destination_cumulio import DestinationCumulio -from .destination_databend import DestinationDatabend -from .destination_databricks import DestinationDatabricks -from .destination_dev_null import DestinationDevNull -from .destination_duckdb import DestinationDuckdb -from .destination_dynamodb import DestinationDynamodb -from .destination_elasticsearch import DestinationElasticsearch -from .destination_firebolt import DestinationFirebolt -from .destination_firestore import DestinationFirestore -from .destination_gcs import DestinationGcs -from .destination_google_sheets import DestinationGoogleSheets -from .destination_keen import DestinationKeen -from .destination_kinesis import DestinationKinesis -from .destination_langchain import DestinationLangchain -from .destination_milvus import DestinationMilvus -from .destination_mongodb import DestinationMongodb -from .destination_mssql import DestinationMssql -from .destination_mysql import DestinationMysql -from .destination_oracle import DestinationOracle -from .destination_pinecone import DestinationPinecone -from .destination_postgres import DestinationPostgres -from .destination_pubsub import DestinationPubsub -from .destination_qdrant import DestinationQdrant -from .destination_redis import DestinationRedis -from .destination_redshift import DestinationRedshift -from .destination_s3 import DestinationS3 -from .destination_s3_glue import DestinationS3Glue -from .destination_sftp_json import DestinationSftpJSON -from .destination_snowflake import DestinationSnowflake -from .destination_teradata import DestinationTeradata -from .destination_timeplus import DestinationTimeplus -from .destination_typesense import DestinationTypesense -from .destination_vectara import DestinationVectara -from .destination_vertica import DestinationVertica -from .destination_weaviate import DestinationWeaviate -from .destination_xata import DestinationXata -from airbyte import utils -from dataclasses_json import Undefined, dataclass_json -from typing import Optional, Union - - -@dataclass_json(undefined=Undefined.EXCLUDE) -@dataclasses.dataclass -class DestinationPatchRequest: - configuration: Optional[Union[DestinationGoogleSheets, DestinationAstra, DestinationAwsDatalake, DestinationAzureBlobStorage, DestinationBigquery, DestinationClickhouse, DestinationConvex, DestinationCumulio, DestinationDatabend, DestinationDatabricks, DestinationDevNull, DestinationDuckdb, DestinationDynamodb, DestinationElasticsearch, DestinationFirebolt, DestinationFirestore, DestinationGcs, DestinationKeen, DestinationKinesis, DestinationLangchain, DestinationMilvus, DestinationMongodb, DestinationMssql, DestinationMysql, DestinationOracle, DestinationPinecone, DestinationPostgres, DestinationPubsub, DestinationQdrant, DestinationRedis, DestinationRedshift, DestinationS3, DestinationS3Glue, DestinationSftpJSON, DestinationSnowflake, DestinationTeradata, DestinationTimeplus, DestinationTypesense, DestinationVectara, DestinationVertica, DestinationWeaviate, DestinationXata]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('configuration'), 'exclude': lambda f: f is None }}) - r"""The values required to configure the destination.""" - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) - - diff --git a/src/airbyte/models/shared/destinationputrequest.py b/src/airbyte/models/shared/destinationputrequest.py deleted file mode 100644 index 0e869064..00000000 --- a/src/airbyte/models/shared/destinationputrequest.py +++ /dev/null @@ -1,59 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from .destination_astra import DestinationAstra -from .destination_aws_datalake import DestinationAwsDatalake -from .destination_azure_blob_storage import DestinationAzureBlobStorage -from .destination_bigquery import DestinationBigquery -from .destination_clickhouse import DestinationClickhouse -from .destination_convex import DestinationConvex -from .destination_cumulio import DestinationCumulio -from .destination_databend import DestinationDatabend -from .destination_databricks import DestinationDatabricks -from .destination_dev_null import DestinationDevNull -from .destination_duckdb import DestinationDuckdb -from .destination_dynamodb import DestinationDynamodb -from .destination_elasticsearch import DestinationElasticsearch -from .destination_firebolt import DestinationFirebolt -from .destination_firestore import DestinationFirestore -from .destination_gcs import DestinationGcs -from .destination_google_sheets import DestinationGoogleSheets -from .destination_keen import DestinationKeen -from .destination_kinesis import DestinationKinesis -from .destination_langchain import DestinationLangchain -from .destination_milvus import DestinationMilvus -from .destination_mongodb import DestinationMongodb -from .destination_mssql import DestinationMssql -from .destination_mysql import DestinationMysql -from .destination_oracle import DestinationOracle -from .destination_pinecone import DestinationPinecone -from .destination_postgres import DestinationPostgres -from .destination_pubsub import DestinationPubsub -from .destination_qdrant import DestinationQdrant -from .destination_redis import DestinationRedis -from .destination_redshift import DestinationRedshift -from .destination_s3 import DestinationS3 -from .destination_s3_glue import DestinationS3Glue -from .destination_sftp_json import DestinationSftpJSON -from .destination_snowflake import DestinationSnowflake -from .destination_teradata import DestinationTeradata -from .destination_timeplus import DestinationTimeplus -from .destination_typesense import DestinationTypesense -from .destination_vectara import DestinationVectara -from .destination_vertica import DestinationVertica -from .destination_weaviate import DestinationWeaviate -from .destination_xata import DestinationXata -from airbyte import utils -from dataclasses_json import Undefined, dataclass_json -from typing import Union - - -@dataclass_json(undefined=Undefined.EXCLUDE) -@dataclasses.dataclass -class DestinationPutRequest: - configuration: Union[DestinationGoogleSheets, DestinationAstra, DestinationAwsDatalake, DestinationAzureBlobStorage, DestinationBigquery, DestinationClickhouse, DestinationConvex, DestinationCumulio, DestinationDatabend, DestinationDatabricks, DestinationDevNull, DestinationDuckdb, DestinationDynamodb, DestinationElasticsearch, DestinationFirebolt, DestinationFirestore, DestinationGcs, DestinationKeen, DestinationKinesis, DestinationLangchain, DestinationMilvus, DestinationMongodb, DestinationMssql, DestinationMysql, DestinationOracle, DestinationPinecone, DestinationPostgres, DestinationPubsub, DestinationQdrant, DestinationRedis, DestinationRedshift, DestinationS3, DestinationS3Glue, DestinationSftpJSON, DestinationSnowflake, DestinationTeradata, DestinationTimeplus, DestinationTypesense, DestinationVectara, DestinationVertica, DestinationWeaviate, DestinationXata] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('configuration') }}) - r"""The values required to configure the destination.""" - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - - diff --git a/src/airbyte/models/shared/destinationresponse.py b/src/airbyte/models/shared/destinationresponse.py deleted file mode 100644 index 071b354c..00000000 --- a/src/airbyte/models/shared/destinationresponse.py +++ /dev/null @@ -1,63 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from .destination_astra import DestinationAstra -from .destination_aws_datalake import DestinationAwsDatalake -from .destination_azure_blob_storage import DestinationAzureBlobStorage -from .destination_bigquery import DestinationBigquery -from .destination_clickhouse import DestinationClickhouse -from .destination_convex import DestinationConvex -from .destination_cumulio import DestinationCumulio -from .destination_databend import DestinationDatabend -from .destination_databricks import DestinationDatabricks -from .destination_dev_null import DestinationDevNull -from .destination_duckdb import DestinationDuckdb -from .destination_dynamodb import DestinationDynamodb -from .destination_elasticsearch import DestinationElasticsearch -from .destination_firebolt import DestinationFirebolt -from .destination_firestore import DestinationFirestore -from .destination_gcs import DestinationGcs -from .destination_google_sheets import DestinationGoogleSheets -from .destination_keen import DestinationKeen -from .destination_kinesis import DestinationKinesis -from .destination_langchain import DestinationLangchain -from .destination_milvus import DestinationMilvus -from .destination_mongodb import DestinationMongodb -from .destination_mssql import DestinationMssql -from .destination_mysql import DestinationMysql -from .destination_oracle import DestinationOracle -from .destination_pinecone import DestinationPinecone -from .destination_postgres import DestinationPostgres -from .destination_pubsub import DestinationPubsub -from .destination_qdrant import DestinationQdrant -from .destination_redis import DestinationRedis -from .destination_redshift import DestinationRedshift -from .destination_s3 import DestinationS3 -from .destination_s3_glue import DestinationS3Glue -from .destination_sftp_json import DestinationSftpJSON -from .destination_snowflake import DestinationSnowflake -from .destination_teradata import DestinationTeradata -from .destination_timeplus import DestinationTimeplus -from .destination_typesense import DestinationTypesense -from .destination_vectara import DestinationVectara -from .destination_vertica import DestinationVertica -from .destination_weaviate import DestinationWeaviate -from .destination_xata import DestinationXata -from airbyte import utils -from dataclasses_json import Undefined, dataclass_json -from typing import Union - - -@dataclass_json(undefined=Undefined.EXCLUDE) -@dataclasses.dataclass -class DestinationResponse: - r"""Provides details of a single destination.""" - configuration: Union[DestinationGoogleSheets, DestinationAstra, DestinationAwsDatalake, DestinationAzureBlobStorage, DestinationBigquery, DestinationClickhouse, DestinationConvex, DestinationCumulio, DestinationDatabend, DestinationDatabricks, DestinationDevNull, DestinationDuckdb, DestinationDynamodb, DestinationElasticsearch, DestinationFirebolt, DestinationFirestore, DestinationGcs, DestinationKeen, DestinationKinesis, DestinationLangchain, DestinationMilvus, DestinationMongodb, DestinationMssql, DestinationMysql, DestinationOracle, DestinationPinecone, DestinationPostgres, DestinationPubsub, DestinationQdrant, DestinationRedis, DestinationRedshift, DestinationS3, DestinationS3Glue, DestinationSftpJSON, DestinationSnowflake, DestinationTeradata, DestinationTimeplus, DestinationTypesense, DestinationVectara, DestinationVertica, DestinationWeaviate, DestinationXata] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('configuration') }}) - r"""The values required to configure the destination.""" - destination_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationId') }}) - destination_type: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - workspace_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('workspaceId') }}) - - diff --git a/src/airbyte/models/shared/source_google_workspace_admin_reports.py b/src/airbyte/models/shared/source_google_workspace_admin_reports.py deleted file mode 100644 index 63c4aac1..00000000 --- a/src/airbyte/models/shared/source_google_workspace_admin_reports.py +++ /dev/null @@ -1,25 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from airbyte import utils -from dataclasses_json import Undefined, dataclass_json -from enum import Enum -from typing import Final, Optional - -class GoogleWorkspaceAdminReports(str, Enum): - GOOGLE_WORKSPACE_ADMIN_REPORTS = 'google-workspace-admin-reports' - - -@dataclass_json(undefined=Undefined.EXCLUDE) -@dataclasses.dataclass -class SourceGoogleWorkspaceAdminReports: - credentials_json: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials_json') }}) - 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.""" - 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_paypal_transaction.py b/src/airbyte/models/shared/source_paypal_transaction.py deleted file mode 100644 index 630fda79..00000000 --- a/src/airbyte/models/shared/source_paypal_transaction.py +++ /dev/null @@ -1,33 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -import dateutil.parser -from airbyte import utils -from dataclasses_json import Undefined, dataclass_json -from datetime import datetime -from enum import Enum -from typing import Final, Optional - -class PaypalTransaction(str, Enum): - PAYPAL_TRANSACTION = 'paypal-transaction' - - -@dataclass_json(undefined=Undefined.EXCLUDE) -@dataclasses.dataclass -class SourcePaypalTransaction: - client_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_id') }}) - r"""The Client ID of your Paypal developer application.""" - client_secret: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_secret') }}) - 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.""" - 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_snapchat_marketing.py b/src/airbyte/models/shared/source_snapchat_marketing.py deleted file mode 100644 index 305cab14..00000000 --- a/src/airbyte/models/shared/source_snapchat_marketing.py +++ /dev/null @@ -1,31 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -import dateutil.parser -from airbyte import utils -from dataclasses_json import Undefined, dataclass_json -from datetime import date -from enum import Enum -from typing import Final, Optional - -class SourceSnapchatMarketingSnapchatMarketing(str, Enum): - SNAPCHAT_MARKETING = 'snapchat-marketing' - - -@dataclass_json(undefined=Undefined.EXCLUDE) -@dataclasses.dataclass -class SourceSnapchatMarketing: - client_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_id') }}) - r"""The Client ID of your Snapchat developer application.""" - client_secret: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_secret') }}) - 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.""" - 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_zoom.py b/src/airbyte/models/shared/source_zoom.py deleted file mode 100644 index 5bc7cb8e..00000000 --- a/src/airbyte/models/shared/source_zoom.py +++ /dev/null @@ -1,21 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from airbyte import utils -from dataclasses_json import Undefined, dataclass_json -from enum import Enum -from typing import Final - -class Zoom(str, Enum): - ZOOM = 'zoom' - - -@dataclass_json(undefined=Undefined.EXCLUDE) -@dataclasses.dataclass -class SourceZoom: - jwt_token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('jwt_token') }}) - r"""JWT Token""" - SOURCE_TYPE: Final[Zoom] = dataclasses.field(default=Zoom.ZOOM, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) - - diff --git a/src/airbyte/sdk.py b/src/airbyte/sdk.py deleted file mode 100644 index 1c5233bc..00000000 --- a/src/airbyte/sdk.py +++ /dev/null @@ -1,67 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -import requests as requests_http -from .connections import Connections -from .destinations import Destinations -from .jobs import Jobs -from .sdkconfiguration import SDKConfiguration -from .sources import Sources -from .streams import Streams -from .workspaces import Workspaces -from airbyte import utils -from airbyte.models import shared -from typing import Callable, Dict, Union - -class Airbyte: - r"""airbyte-api: Programatically control Airbyte Cloud, OSS & Enterprise.""" - connections: Connections - destinations: Destinations - jobs: Jobs - sources: Sources - streams: Streams - workspaces: Workspaces - - sdk_configuration: SDKConfiguration - - def __init__(self, - security: Union[shared.Security,Callable[[], shared.Security]] = None, - server_idx: int = None, - server_url: str = None, - url_params: Dict[str, str] = None, - client: requests_http.Session = None, - retry_config: utils.RetryConfig = None - ) -> None: - """Instantiates the SDK configuring it with the provided parameters. - - :param security: The security details required for authentication - :type security: Union[shared.Security,Callable[[], shared.Security]] - :param server_idx: The index of the server to use for all operations - :type server_idx: int - :param server_url: The server URL to use for all operations - :type server_url: str - :param url_params: Parameters to optionally template the server URL with - :type url_params: Dict[str, str] - :param client: The requests.Session HTTP client to use for all operations - :type client: requests_http.Session - :param retry_config: The utils.RetryConfig to use globally - :type retry_config: utils.RetryConfig - """ - if client is None: - client = requests_http.Session() - - if server_url is not None: - if url_params is not None: - server_url = utils.template_url(server_url, url_params) - - self.sdk_configuration = SDKConfiguration(client, security, server_url, server_idx, retry_config=retry_config) - - self._init_sdks() - - def _init_sdks(self): - self.connections = Connections(self.sdk_configuration) - self.destinations = Destinations(self.sdk_configuration) - self.jobs = Jobs(self.sdk_configuration) - self.sources = Sources(self.sdk_configuration) - self.streams = Streams(self.sdk_configuration) - self.workspaces = Workspaces(self.sdk_configuration) - \ No newline at end of file diff --git a/src/airbyte/sdkconfiguration.py b/src/airbyte/sdkconfiguration.py deleted file mode 100644 index 788a3227..00000000 --- a/src/airbyte/sdkconfiguration.py +++ /dev/null @@ -1,37 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - - -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 = [ - 'https://api.airbyte.com/v1', - # Airbyte API v1 -] -"""Contains the list of servers available to the SDK""" - -@dataclass -class SDKConfiguration: - 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.3' - gen_version: str = '2.272.4' - user_agent: str = 'speakeasy-sdk/python 0.47.3 2.272.4 1.0.0 airbyte-api' - retry_config: RetryConfig = None - - def get_server_details(self) -> Tuple[str, Dict[str, str]]: - if self.server_url: - return utils.remove_suffix(self.server_url, '/'), {} - if self.server_idx is None: - self.server_idx = 0 - - return SERVERS[self.server_idx], {} diff --git a/src/airbyte/sources.py b/src/airbyte/sources.py deleted file mode 100644 index 1bdb06fd..00000000 --- a/src/airbyte/sources.py +++ /dev/null @@ -1,253 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from .sdkconfiguration import SDKConfiguration -from airbyte import utils -from airbyte.models import errors, operations, shared -from typing import Optional - -class Sources: - sdk_configuration: SDKConfiguration - - def __init__(self, sdk_config: SDKConfiguration) -> None: - self.sdk_configuration = sdk_config - - - - def create_source(self, request: Optional[shared.SourceCreateRequest]) -> operations.CreateSourceResponse: - r"""Create a source - Creates a source given a name, workspace id, and a json blob containing the configuration for the source. - """ - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = base_url + '/sources' - headers = {} - req_content_type, data, form = utils.serialize_request_body(request, Optional[shared.SourceCreateRequest], "request", False, True, 'json') - if req_content_type not in ('multipart/form-data', 'multipart/mixed'): - headers['content-type'] = req_content_type - headers['Accept'] = 'application/json' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('POST', url, data=data, files=form, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.CreateSourceResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.SourceResponse]) - res.source_response = out - else: - raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code == 400 or http_res.status_code == 403 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - - - def delete_source(self, request: operations.DeleteSourceRequest) -> operations.DeleteSourceResponse: - r"""Delete a Source""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = utils.generate_url(operations.DeleteSourceRequest, base_url, '/sources/{sourceId}', request) - headers = {} - headers['Accept'] = '*/*' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('DELETE', url, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.DeleteSourceResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 204: - pass - elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - - - def get_source(self, request: operations.GetSourceRequest) -> operations.GetSourceResponse: - r"""Get Source details""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = utils.generate_url(operations.GetSourceRequest, base_url, '/sources/{sourceId}', request) - headers = {} - headers['Accept'] = 'application/json' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('GET', url, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.GetSourceResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.SourceResponse]) - res.source_response = out - else: - raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - - - def initiate_o_auth(self, request: shared.InitiateOauthRequest) -> operations.InitiateOAuthResponse: - r"""Initiate OAuth for a source - Given a source ID, workspace ID, and redirect URL, initiates OAuth for the source. - - This returns a fully formed URL for performing user authentication against the relevant source identity provider (IdP). Once authentication has been completed, the IdP will redirect to an Airbyte endpoint which will save the access and refresh tokens off as a secret and return the secret ID to the redirect URL specified in the `secret_id` query string parameter. - - That secret ID can be used to create a source with credentials in place of actual tokens. - """ - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = base_url + '/sources/initiateOAuth' - headers = {} - req_content_type, data, form = utils.serialize_request_body(request, shared.InitiateOauthRequest, "request", False, False, 'json') - if req_content_type not in ('multipart/form-data', 'multipart/mixed'): - headers['content-type'] = req_content_type - if data is None and form is None: - raise Exception('request body is required') - headers['Accept'] = '*/*' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('POST', url, data=data, files=form, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.InitiateOAuthResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - pass - elif http_res.status_code == 400 or http_res.status_code == 403 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - - - def list_sources(self, request: operations.ListSourcesRequest) -> operations.ListSourcesResponse: - r"""List sources""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = base_url + '/sources' - headers = {} - query_params = utils.get_query_params(operations.ListSourcesRequest, request) - headers['Accept'] = 'application/json' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('GET', url, params=query_params, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.ListSourcesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.SourcesResponse]) - res.sources_response = out - else: - raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - - - def patch_source(self, request: operations.PatchSourceRequest) -> operations.PatchSourceResponse: - r"""Update a Source""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = utils.generate_url(operations.PatchSourceRequest, base_url, '/sources/{sourceId}', request) - headers = {} - req_content_type, data, form = utils.serialize_request_body(request, operations.PatchSourceRequest, "source_patch_request", False, True, 'json') - if req_content_type not in ('multipart/form-data', 'multipart/mixed'): - headers['content-type'] = req_content_type - headers['Accept'] = 'application/json' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('PATCH', url, data=data, files=form, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.PatchSourceResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.SourceResponse]) - res.source_response = out - else: - raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - - - def put_source(self, request: operations.PutSourceRequest) -> operations.PutSourceResponse: - r"""Update a Source and fully overwrite it""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = utils.generate_url(operations.PutSourceRequest, base_url, '/sources/{sourceId}', request) - headers = {} - req_content_type, data, form = utils.serialize_request_body(request, operations.PutSourceRequest, "source_put_request", False, True, 'json') - if req_content_type not in ('multipart/form-data', 'multipart/mixed'): - headers['content-type'] = req_content_type - headers['Accept'] = 'application/json' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('PUT', url, data=data, files=form, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.PutSourceResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.SourceResponse]) - res.source_response = out - else: - raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - \ No newline at end of file diff --git a/src/airbyte/streams.py b/src/airbyte/streams.py deleted file mode 100644 index 081e2a88..00000000 --- a/src/airbyte/streams.py +++ /dev/null @@ -1,47 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from .sdkconfiguration import SDKConfiguration -from airbyte import utils -from airbyte.models import errors, operations, shared -from typing import Optional - -class Streams: - sdk_configuration: SDKConfiguration - - def __init__(self, sdk_config: SDKConfiguration) -> None: - self.sdk_configuration = sdk_config - - - - def get_stream_properties(self, request: operations.GetStreamPropertiesRequest) -> operations.GetStreamPropertiesResponse: - r"""Get stream properties""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = base_url + '/streams' - headers = {} - query_params = utils.get_query_params(operations.GetStreamPropertiesRequest, request) - headers['Accept'] = 'application/json' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('GET', url, params=query_params, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.GetStreamPropertiesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.StreamPropertiesResponse]) - res.stream_properties_response = out - else: - raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code == 400 or http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - \ No newline at end of file diff --git a/src/airbyte/utils/utils.py b/src/airbyte/utils/utils.py deleted file mode 100644 index 52434025..00000000 --- a/src/airbyte/utils/utils.py +++ /dev/null @@ -1,897 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -import base64 -import json -import re -import sys -from dataclasses import Field, dataclass, fields, is_dataclass, make_dataclass -from datetime import date, datetime -from decimal import Decimal -from email.message import Message -from enum import Enum -from typing import (Any, Callable, Dict, List, Optional, Tuple, Union, - get_args, get_origin) -from xmlrpc.client import boolean -from typing_inspect import is_optional_type -import dateutil.parser -import requests -from dataclasses_json import DataClassJsonMixin - - -class SecurityClient: - client: requests.Session - query_params: Dict[str, str] = {} - - def __init__(self, client: requests.Session): - self.client = client - - def request(self, method, url, **kwargs): - params = kwargs.get('params', {}) - kwargs["params"] = {**self.query_params, **params} - - return self.client.request(method, url, **kwargs) - - -def configure_security_client(client: requests.Session, security: dataclass): - client = SecurityClient(client) - - if security is None: - return client - - sec_fields: Tuple[Field, ...] = fields(security) - for sec_field in sec_fields: - value = getattr(security, sec_field.name) - if value is None: - continue - - metadata = sec_field.metadata.get('security') - if metadata is None: - continue - if metadata.get('option'): - _parse_security_option(client, value) - return client - if metadata.get('scheme'): - # Special case for basic auth which could be a flattened struct - if metadata.get("sub_type") == "basic" and not is_dataclass(value): - _parse_security_scheme(client, metadata, security) - else: - _parse_security_scheme(client, metadata, value) - - return client - - -def _parse_security_option(client: SecurityClient, option: dataclass): - opt_fields: Tuple[Field, ...] = fields(option) - for opt_field in opt_fields: - metadata = opt_field.metadata.get('security') - if metadata is None or metadata.get('scheme') is None: - continue - _parse_security_scheme( - client, metadata, getattr(option, opt_field.name)) - - -def _parse_security_scheme(client: SecurityClient, scheme_metadata: Dict, scheme: any): - scheme_type = scheme_metadata.get('type') - sub_type = scheme_metadata.get('sub_type') - - if is_dataclass(scheme): - if scheme_type == 'http' and sub_type == 'basic': - _parse_basic_auth_scheme(client, scheme) - return - - scheme_fields: Tuple[Field, ...] = fields(scheme) - for scheme_field in scheme_fields: - metadata = scheme_field.metadata.get('security') - if metadata is None or metadata.get('field_name') is None: - continue - - value = getattr(scheme, scheme_field.name) - - _parse_security_scheme_value( - client, scheme_metadata, metadata, value) - else: - _parse_security_scheme_value( - client, scheme_metadata, scheme_metadata, scheme) - - -def _parse_security_scheme_value(client: SecurityClient, scheme_metadata: Dict, security_metadata: Dict, value: any): - scheme_type = scheme_metadata.get('type') - sub_type = scheme_metadata.get('sub_type') - - header_name = security_metadata.get('field_name') - - if scheme_type == "apiKey": - if sub_type == 'header': - client.client.headers[header_name] = value - elif sub_type == 'query': - client.query_params[header_name] = value - elif sub_type == 'cookie': - client.client.cookies[header_name] = value - else: - raise Exception('not supported') - elif scheme_type == "openIdConnect": - client.client.headers[header_name] = _apply_bearer(value) - elif scheme_type == 'oauth2': - client.client.headers[header_name] = _apply_bearer(value) - elif scheme_type == 'http': - if sub_type == 'bearer': - client.client.headers[header_name] = _apply_bearer(value) - else: - raise Exception('not supported') - else: - raise Exception('not supported') - - -def _apply_bearer(token: str) -> str: - return token.lower().startswith('bearer ') and token or f'Bearer {token}' - - -def _parse_basic_auth_scheme(client: SecurityClient, scheme: dataclass): - username = "" - password = "" - - scheme_fields: Tuple[Field, ...] = fields(scheme) - for scheme_field in scheme_fields: - metadata = scheme_field.metadata.get('security') - if metadata is None or metadata.get('field_name') is None: - continue - - field_name = metadata.get('field_name') - value = getattr(scheme, scheme_field.name) - - if field_name == 'username': - username = value - if field_name == 'password': - password = value - - data = f'{username}:{password}'.encode() - client.client.headers['Authorization'] = f'Basic {base64.b64encode(data).decode()}' - - -def generate_url(clazz: type, server_url: str, path: str, path_params: dataclass, - gbls: Dict[str, Dict[str, Dict[str, Any]]] = None) -> str: - path_param_fields: Tuple[Field, ...] = fields(clazz) - for field in path_param_fields: - request_metadata = field.metadata.get('request') - if request_metadata is not None: - continue - - param_metadata = field.metadata.get('path_param') - if param_metadata is None: - continue - - param = getattr( - path_params, field.name) if path_params is not None else None - param = _populate_from_globals( - field.name, param, 'pathParam', gbls) - - if param is None: - continue - - f_name = param_metadata.get("field_name", field.name) - serialization = param_metadata.get('serialization', '') - if serialization != '': - serialized_params = _get_serialized_params( - param_metadata, field.type, f_name, param) - for key, value in serialized_params.items(): - path = path.replace( - '{' + key + '}', value, 1) - else: - if param_metadata.get('style', 'simple') == 'simple': - if isinstance(param, List): - pp_vals: List[str] = [] - for pp_val in param: - if pp_val is None: - continue - pp_vals.append(_val_to_string(pp_val)) - path = path.replace( - '{' + param_metadata.get('field_name', field.name) + '}', ",".join(pp_vals), 1) - elif isinstance(param, Dict): - pp_vals: List[str] = [] - for pp_key in param: - if param[pp_key] is None: - continue - if param_metadata.get('explode'): - pp_vals.append( - f"{pp_key}={_val_to_string(param[pp_key])}") - else: - pp_vals.append( - f"{pp_key},{_val_to_string(param[pp_key])}") - path = path.replace( - '{' + param_metadata.get('field_name', field.name) + '}', ",".join(pp_vals), 1) - elif not isinstance(param, (str, int, float, complex, bool, Decimal)): - pp_vals: List[str] = [] - param_fields: Tuple[Field, ...] = fields(param) - for param_field in param_fields: - param_value_metadata = param_field.metadata.get( - 'path_param') - if not param_value_metadata: - continue - - parm_name = param_value_metadata.get( - 'field_name', field.name) - - param_field_val = getattr(param, param_field.name) - if param_field_val is None: - continue - if param_metadata.get('explode'): - pp_vals.append( - f"{parm_name}={_val_to_string(param_field_val)}") - else: - pp_vals.append( - f"{parm_name},{_val_to_string(param_field_val)}") - path = path.replace( - '{' + param_metadata.get('field_name', field.name) + '}', ",".join(pp_vals), 1) - else: - path = path.replace( - '{' + param_metadata.get('field_name', field.name) + '}', _val_to_string(param), 1) - - return remove_suffix(server_url, '/') + path - - -def is_optional(field): - return get_origin(field) is Union and type(None) in get_args(field) - - -def template_url(url_with_params: str, params: Dict[str, str]) -> str: - for key, value in params.items(): - url_with_params = url_with_params.replace( - '{' + key + '}', value) - - return url_with_params - - -def get_query_params(clazz: type, query_params: dataclass, gbls: Dict[str, Dict[str, Dict[str, Any]]] = None) -> Dict[ - str, List[str]]: - params: Dict[str, List[str]] = {} - - param_fields: Tuple[Field, ...] = fields(clazz) - for field in param_fields: - request_metadata = field.metadata.get('request') - if request_metadata is not None: - continue - - metadata = field.metadata.get('query_param') - if not metadata: - continue - - param_name = field.name - value = getattr( - query_params, param_name) if query_params is not None else None - - value = _populate_from_globals(param_name, value, 'queryParam', gbls) - - f_name = metadata.get("field_name") - serialization = metadata.get('serialization', '') - if serialization != '': - serialized_parms = _get_serialized_params(metadata, field.type, f_name, value) - for key, value in serialized_parms.items(): - if key in params: - params[key].extend(value) - else: - params[key] = [value] - else: - style = metadata.get('style', 'form') - if style == 'deepObject': - params = {**params, **_get_deep_object_query_params( - metadata, f_name, value)} - elif style == 'form': - params = {**params, **_get_delimited_query_params( - metadata, f_name, value, ",")} - elif style == 'pipeDelimited': - params = {**params, **_get_delimited_query_params( - metadata, f_name, value, "|")} - else: - raise Exception('not yet implemented') - return params - - -def get_headers(headers_params: dataclass) -> Dict[str, str]: - if headers_params is None: - return {} - - headers: Dict[str, str] = {} - - param_fields: Tuple[Field, ...] = fields(headers_params) - for field in param_fields: - metadata = field.metadata.get('header') - if not metadata: - continue - - value = _serialize_header(metadata.get( - 'explode', False), getattr(headers_params, field.name)) - - if value != '': - headers[metadata.get('field_name', field.name)] = value - - return headers - - -def _get_serialized_params(metadata: Dict, field_type: type, field_name: str, obj: any) -> Dict[str, str]: - params: Dict[str, str] = {} - - serialization = metadata.get('serialization', '') - if serialization == 'json': - params[metadata.get("field_name", field_name)] = marshal_json(obj, field_type) - - return params - - -def _get_deep_object_query_params(metadata: Dict, field_name: str, obj: any) -> Dict[str, List[str]]: - params: Dict[str, List[str]] = {} - - if obj is None: - return params - - if is_dataclass(obj): - obj_fields: Tuple[Field, ...] = fields(obj) - for obj_field in obj_fields: - obj_param_metadata = obj_field.metadata.get('query_param') - if not obj_param_metadata: - continue - - obj_val = getattr(obj, obj_field.name) - if obj_val is None: - continue - - if isinstance(obj_val, List): - for val in obj_val: - if val is None: - continue - - if params.get( - f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]') is None: - params[ - f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]'] = [ - ] - - params[ - f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]'].append( - _val_to_string(val)) - else: - params[ - f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]'] = [ - _val_to_string(obj_val)] - elif isinstance(obj, Dict): - for key, value in obj.items(): - if value is None: - continue - - if isinstance(value, List): - for val in value: - if val is None: - continue - - if params.get(f'{metadata.get("field_name", field_name)}[{key}]') is None: - params[f'{metadata.get("field_name", field_name)}[{key}]'] = [ - ] - - params[ - f'{metadata.get("field_name", field_name)}[{key}]'].append(_val_to_string(val)) - else: - params[f'{metadata.get("field_name", field_name)}[{key}]'] = [ - _val_to_string(value)] - return params - - -def _get_query_param_field_name(obj_field: Field) -> str: - obj_param_metadata = obj_field.metadata.get('query_param') - - if not obj_param_metadata: - return "" - - return obj_param_metadata.get("field_name", obj_field.name) - - -def _get_delimited_query_params(metadata: Dict, field_name: str, obj: any, delimiter: str) -> Dict[ - str, List[str]]: - return _populate_form(field_name, metadata.get("explode", True), obj, _get_query_param_field_name, delimiter) - - -SERIALIZATION_METHOD_TO_CONTENT_TYPE = { - 'json': 'application/json', - 'form': 'application/x-www-form-urlencoded', - 'multipart': 'multipart/form-data', - 'raw': 'application/octet-stream', - 'string': 'text/plain', -} - - -def serialize_request_body(request: dataclass, request_type: type, request_field_name: str, nullable: bool, optional: bool, serialization_method: str, encoder=None) -> Tuple[ - str, any, any]: - if request is None: - if not nullable and optional: - return None, None, None - - if not is_dataclass(request) or not hasattr(request, request_field_name): - return serialize_content_type(request_field_name, request_type, SERIALIZATION_METHOD_TO_CONTENT_TYPE[serialization_method], - request, encoder) - - request_val = getattr(request, request_field_name) - - if request_val is None: - if not nullable and optional: - return None, None, None - - request_fields: Tuple[Field, ...] = fields(request) - request_metadata = None - - for field in request_fields: - if field.name == request_field_name: - request_metadata = field.metadata.get('request') - break - - if request_metadata is None: - raise Exception('invalid request type') - - return serialize_content_type(request_field_name, request_type, request_metadata.get('media_type', 'application/octet-stream'), - request_val) - - -def serialize_content_type(field_name: str, request_type: any, media_type: str, request: dataclass, encoder=None) -> Tuple[str, any, List[List[any]]]: - if re.match(r'(application|text)\/.*?\+*json.*', media_type) is not None: - return media_type, marshal_json(request, request_type, encoder), None - if re.match(r'multipart\/.*', media_type) is not None: - return serialize_multipart_form(media_type, request) - if re.match(r'application\/x-www-form-urlencoded.*', media_type) is not None: - return media_type, serialize_form_data(field_name, request), None - if isinstance(request, (bytes, bytearray)): - return media_type, request, None - if isinstance(request, str): - return media_type, request, None - - raise Exception( - f"invalid request body type {type(request)} for mediaType {media_type}") - - -def serialize_multipart_form(media_type: str, request: dataclass) -> Tuple[str, any, List[List[any]]]: - form: List[List[any]] = [] - request_fields = fields(request) - - for field in request_fields: - val = getattr(request, field.name) - if val is None: - continue - - field_metadata = field.metadata.get('multipart_form') - if not field_metadata: - continue - - if field_metadata.get("file") is True: - file_fields = fields(val) - - file_name = "" - field_name = "" - content = bytes() - - for file_field in file_fields: - file_metadata = file_field.metadata.get('multipart_form') - if file_metadata is None: - continue - - if file_metadata.get("content") is True: - content = getattr(val, file_field.name) - else: - field_name = file_metadata.get( - "field_name", file_field.name) - file_name = getattr(val, file_field.name) - if field_name == "" or file_name == "" or content == bytes(): - raise Exception('invalid multipart/form-data file') - - form.append([field_name, [file_name, content]]) - elif field_metadata.get("json") is True: - to_append = [field_metadata.get("field_name", field.name), [ - None, marshal_json(val, field.type), "application/json"]] - form.append(to_append) - else: - field_name = field_metadata.get( - "field_name", field.name) - if isinstance(val, List): - for value in val: - if value is None: - continue - form.append( - [field_name + "[]", [None, _val_to_string(value)]]) - else: - form.append([field_name, [None, _val_to_string(val)]]) - return media_type, None, form - - -def serialize_dict(original: Dict, explode: bool, field_name, existing: Optional[Dict[str, List[str]]]) -> Dict[ - str, List[str]]: - if existing is None: - existing = [] - - if explode is True: - for key, val in original.items(): - if key not in existing: - existing[key] = [] - existing[key].append(val) - else: - temp = [] - for key, val in original.items(): - temp.append(str(key)) - temp.append(str(val)) - if field_name not in existing: - existing[field_name] = [] - existing[field_name].append(",".join(temp)) - return existing - - -def serialize_form_data(field_name: str, data: dataclass) -> Dict[str, any]: - form: Dict[str, List[str]] = {} - - if is_dataclass(data): - for field in fields(data): - val = getattr(data, field.name) - if val is None: - continue - - metadata = field.metadata.get('form') - if metadata is None: - continue - - field_name = metadata.get('field_name', field.name) - - if metadata.get('json'): - form[field_name] = [marshal_json(val, field.type)] - else: - if metadata.get('style', 'form') == 'form': - form = {**form, **_populate_form( - field_name, metadata.get('explode', True), val, _get_form_field_name, ",")} - else: - raise Exception( - f'Invalid form style for field {field.name}') - elif isinstance(data, Dict): - for key, value in data.items(): - form[key] = [_val_to_string(value)] - else: - raise Exception(f'Invalid request body type for field {field_name}') - - return form - - -def _get_form_field_name(obj_field: Field) -> str: - obj_param_metadata = obj_field.metadata.get('form') - - if not obj_param_metadata: - return "" - - return obj_param_metadata.get("field_name", obj_field.name) - - -def _populate_form(field_name: str, explode: boolean, obj: any, get_field_name_func: Callable, delimiter: str) -> \ - Dict[str, List[str]]: - params: Dict[str, List[str]] = {} - - if obj is None: - return params - - if is_dataclass(obj): - items = [] - - obj_fields: Tuple[Field, ...] = fields(obj) - for obj_field in obj_fields: - obj_field_name = get_field_name_func(obj_field) - if obj_field_name == '': - continue - - val = getattr(obj, obj_field.name) - if val is None: - continue - - if explode: - params[obj_field_name] = [_val_to_string(val)] - else: - items.append( - f'{obj_field_name}{delimiter}{_val_to_string(val)}') - - if len(items) > 0: - params[field_name] = [delimiter.join(items)] - elif isinstance(obj, Dict): - items = [] - for key, value in obj.items(): - if value is None: - continue - - if explode: - params[key] = _val_to_string(value) - else: - items.append(f'{key}{delimiter}{_val_to_string(value)}') - - if len(items) > 0: - params[field_name] = [delimiter.join(items)] - elif isinstance(obj, List): - items = [] - - for value in obj: - if value is None: - continue - - if explode: - if not field_name in params: - params[field_name] = [] - params[field_name].append(_val_to_string(value)) - else: - items.append(_val_to_string(value)) - - if len(items) > 0: - params[field_name] = [delimiter.join( - [str(item) for item in items])] - else: - params[field_name] = [_val_to_string(obj)] - - return params - - -def _serialize_header(explode: bool, obj: any) -> str: - if obj is None: - return '' - - if is_dataclass(obj): - items = [] - obj_fields: Tuple[Field, ...] = fields(obj) - for obj_field in obj_fields: - obj_param_metadata = obj_field.metadata.get('header') - - if not obj_param_metadata: - continue - - obj_field_name = obj_param_metadata.get( - 'field_name', obj_field.name) - if obj_field_name == '': - continue - - val = getattr(obj, obj_field.name) - if val is None: - continue - - if explode: - items.append( - f'{obj_field_name}={_val_to_string(val)}') - else: - items.append(obj_field_name) - items.append(_val_to_string(val)) - - if len(items) > 0: - return ','.join(items) - elif isinstance(obj, Dict): - items = [] - - for key, value in obj.items(): - if value is None: - continue - - if explode: - items.append(f'{key}={_val_to_string(value)}') - else: - items.append(key) - items.append(_val_to_string(value)) - - if len(items) > 0: - return ','.join([str(item) for item in items]) - elif isinstance(obj, List): - items = [] - - for value in obj: - if value is None: - continue - - items.append(_val_to_string(value)) - - if len(items) > 0: - return ','.join(items) - else: - return f'{_val_to_string(obj)}' - - return '' - - -def unmarshal_json(data, typ, decoder=None): - unmarshal = make_dataclass('Unmarshal', [('res', typ)], - bases=(DataClassJsonMixin,)) - json_dict = json.loads(data) - try: - out = unmarshal.from_dict({"res": json_dict}) - except AttributeError as attr_err: - raise AttributeError( - f'unable to unmarshal {data} as {typ} - {attr_err}') from attr_err - - return out.res if decoder is None else decoder(out.res) - - -def marshal_json(val, typ, encoder=None): - if not is_optional_type(typ) and val is None: - raise ValueError(f"Could not marshal None into non-optional type: {typ}") - - marshal = make_dataclass('Marshal', [('res', typ)], - bases=(DataClassJsonMixin,)) - marshaller = marshal(res=val) - json_dict = marshaller.to_dict() - val = json_dict["res"] if encoder is None else encoder(json_dict["res"]) - - return json.dumps(val, separators=(',', ':'), sort_keys=True) - - -def match_content_type(content_type: str, pattern: str) -> boolean: - if pattern in (content_type, "*", "*/*"): - return True - - msg = Message() - msg['content-type'] = content_type - media_type = msg.get_content_type() - - if media_type == pattern: - return True - - parts = media_type.split("/") - if len(parts) == 2: - if pattern in (f'{parts[0]}/*', f'*/{parts[1]}'): - return True - - return False - - -def datetimeisoformat(optional: bool): - def isoformatoptional(val): - if optional and val is None: - return None - return _val_to_string(val) - - return isoformatoptional - - -def dateisoformat(optional: bool): - def isoformatoptional(val): - if optional and val is None: - return None - return date.isoformat(val) - - return isoformatoptional - - -def datefromisoformat(date_str: str): - return dateutil.parser.parse(date_str).date() - - -def bigintencoder(optional: bool): - def bigintencode(val: int): - if optional and val is None: - return None - return str(val) - - return bigintencode - - -def bigintdecoder(val): - if isinstance(val, float): - raise ValueError(f"{val} is a float") - return int(val) - - -def decimalencoder(optional: bool, as_str: bool): - def decimalencode(val: Decimal): - if optional and val is None: - return None - - if as_str: - return str(val) - - return float(val) - - return decimalencode - - -def decimaldecoder(val): - return Decimal(str(val)) - - -def map_encoder(optional: bool, value_encoder: Callable): - def map_encode(val: Dict): - if optional and val is None: - return None - - encoded = {} - for key, value in val.items(): - encoded[key] = value_encoder(value) - - return encoded - - return map_encode - - -def map_decoder(value_decoder: Callable): - def map_decode(val: Dict): - decoded = {} - for key, value in val.items(): - decoded[key] = value_decoder(value) - - return decoded - - return map_decode - - -def list_encoder(optional: bool, value_encoder: Callable): - def list_encode(val: List): - if optional and val is None: - return None - - encoded = [] - for value in val: - encoded.append(value_encoder(value)) - - return encoded - - return list_encode - - -def list_decoder(value_decoder: Callable): - def list_decode(val: List): - decoded = [] - for value in val: - decoded.append(value_decoder(value)) - - return decoded - - return list_decode - -def union_encoder(all_encoders: Dict[str, Callable]): - def selective_encoder(val: any): - if type(val) in all_encoders: - return all_encoders[type(val)](val) - return val - return selective_encoder - -def union_decoder(all_decoders: List[Callable]): - def selective_decoder(val: any): - decoded = val - for decoder in all_decoders: - try: - decoded = decoder(val) - break - except (TypeError, ValueError): - continue - return decoded - return selective_decoder - -def get_field_name(name): - def override(_, _field_name=name): - return _field_name - - return override - - -def _val_to_string(val): - if isinstance(val, bool): - return str(val).lower() - if isinstance(val, datetime): - return val.isoformat().replace('+00:00', 'Z') - if isinstance(val, Enum): - return str(val.value) - - return str(val) - - -def _populate_from_globals(param_name: str, value: any, param_type: str, gbls: Dict[str, Dict[str, Dict[str, Any]]]): - if value is None and gbls is not None: - if 'parameters' in gbls: - if param_type in gbls['parameters']: - if param_name in gbls['parameters'][param_type]: - global_value = gbls['parameters'][param_type][param_name] - if global_value is not None: - value = global_value - - return value - - -def decoder_with_discriminator(field_name): - def decode_fx(obj): - kls = getattr(sys.modules['sdk.models.shared'], obj[field_name]) - return unmarshal_json(json.dumps(obj), kls) - return decode_fx - - -def remove_suffix(input_string, suffix): - if suffix and input_string.endswith(suffix): - return input_string[:-len(suffix)] - return input_string diff --git a/src/airbyte/workspaces.py b/src/airbyte/workspaces.py deleted file mode 100644 index 222882e7..00000000 --- a/src/airbyte/workspaces.py +++ /dev/null @@ -1,217 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from .sdkconfiguration import SDKConfiguration -from airbyte import utils -from airbyte.models import errors, operations, shared -from typing import Optional - -class Workspaces: - sdk_configuration: SDKConfiguration - - def __init__(self, sdk_config: SDKConfiguration) -> None: - self.sdk_configuration = sdk_config - - - - def create_or_update_workspace_o_auth_credentials(self, request: operations.CreateOrUpdateWorkspaceOAuthCredentialsRequest) -> operations.CreateOrUpdateWorkspaceOAuthCredentialsResponse: - r"""Create OAuth override credentials for a workspace and source type. - Create/update a set of OAuth credentials to override the Airbyte-provided OAuth credentials used for source/destination OAuth. - In order to determine what the credential configuration needs to be, please see the connector specification of the relevant source/destination. - """ - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = utils.generate_url(operations.CreateOrUpdateWorkspaceOAuthCredentialsRequest, base_url, '/workspaces/{workspaceId}/oauthCredentials', request) - headers = {} - req_content_type, data, form = utils.serialize_request_body(request, operations.CreateOrUpdateWorkspaceOAuthCredentialsRequest, "workspace_o_auth_credentials_request", False, False, 'json') - if req_content_type not in ('multipart/form-data', 'multipart/mixed'): - headers['content-type'] = req_content_type - if data is None and form is None: - raise Exception('request body is required') - headers['Accept'] = '*/*' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('PUT', url, data=data, files=form, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.CreateOrUpdateWorkspaceOAuthCredentialsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - pass - elif http_res.status_code == 400 or http_res.status_code == 403 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - - - def create_workspace(self, request: shared.WorkspaceCreateRequest) -> operations.CreateWorkspaceResponse: - r"""Create a workspace""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = base_url + '/workspaces' - headers = {} - req_content_type, data, form = utils.serialize_request_body(request, shared.WorkspaceCreateRequest, "request", False, False, 'json') - if req_content_type not in ('multipart/form-data', 'multipart/mixed'): - headers['content-type'] = req_content_type - if data is None and form is None: - raise Exception('request body is required') - headers['Accept'] = 'application/json' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('POST', url, data=data, files=form, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.CreateWorkspaceResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.WorkspaceResponse]) - res.workspace_response = out - else: - raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code == 400 or http_res.status_code == 403 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - - - def delete_workspace(self, request: operations.DeleteWorkspaceRequest) -> operations.DeleteWorkspaceResponse: - r"""Delete a Workspace""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = utils.generate_url(operations.DeleteWorkspaceRequest, base_url, '/workspaces/{workspaceId}', request) - headers = {} - headers['Accept'] = '*/*' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('DELETE', url, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.DeleteWorkspaceResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 204: - pass - elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - - - def get_workspace(self, request: operations.GetWorkspaceRequest) -> operations.GetWorkspaceResponse: - r"""Get Workspace details""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = utils.generate_url(operations.GetWorkspaceRequest, base_url, '/workspaces/{workspaceId}', request) - headers = {} - headers['Accept'] = 'application/json' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('GET', url, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.GetWorkspaceResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.WorkspaceResponse]) - res.workspace_response = out - else: - raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - - - def list_workspaces(self, request: operations.ListWorkspacesRequest) -> operations.ListWorkspacesResponse: - r"""List workspaces""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = base_url + '/workspaces' - headers = {} - query_params = utils.get_query_params(operations.ListWorkspacesRequest, request) - headers['Accept'] = 'application/json' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('GET', url, params=query_params, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.ListWorkspacesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.WorkspacesResponse]) - res.workspaces_response = out - else: - raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - - - def update_workspace(self, request: operations.UpdateWorkspaceRequest) -> operations.UpdateWorkspaceResponse: - r"""Update a workspace""" - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = utils.generate_url(operations.UpdateWorkspaceRequest, base_url, '/workspaces/{workspaceId}', request) - headers = {} - req_content_type, data, form = utils.serialize_request_body(request, operations.UpdateWorkspaceRequest, "workspace_update_request", False, False, 'json') - if req_content_type not in ('multipart/form-data', 'multipart/mixed'): - headers['content-type'] = req_content_type - if data is None and form is None: - raise Exception('request body is required') - headers['Accept'] = 'application/json' - headers['user-agent'] = self.sdk_configuration.user_agent - - if callable(self.sdk_configuration.security): - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) - else: - client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) - - http_res = client.request('PATCH', url, data=data, files=form, headers=headers) - content_type = http_res.headers.get('Content-Type') - - res = operations.UpdateWorkspaceResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.WorkspaceResponse]) - res.workspace_response = out - else: - raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) - elif http_res.status_code == 400 or http_res.status_code == 403 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: - raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) - - return res - - \ No newline at end of file diff --git a/src/airbyte/__init__.py b/src/airbyte_api/__init__.py similarity index 100% rename from src/airbyte/__init__.py rename to src/airbyte_api/__init__.py diff --git a/src/airbyte_api/_hooks/__init__.py b/src/airbyte_api/_hooks/__init__.py new file mode 100644 index 00000000..b2ab14b3 --- /dev/null +++ b/src/airbyte_api/_hooks/__init__.py @@ -0,0 +1,4 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from .sdkhooks import * +from .types import * diff --git a/src/airbyte_api/_hooks/sdkhooks.py b/src/airbyte_api/_hooks/sdkhooks.py new file mode 100644 index 00000000..1bd70b2a --- /dev/null +++ b/src/airbyte_api/_hooks/sdkhooks.py @@ -0,0 +1,55 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +import requests +from .types import SDKInitHook, BeforeRequestContext, BeforeRequestHook, AfterSuccessContext, AfterSuccessHook, AfterErrorContext, AfterErrorHook, Hooks +from typing import List, Optional, Tuple + + +class SDKHooks(Hooks): + def __init__(self): + self.sdk_init_hooks: List[SDKInitHook] = [] + self.before_request_hooks: List[BeforeRequestHook] = [] + self.after_success_hooks: List[AfterSuccessHook] = [] + self.after_error_hooks: List[AfterErrorHook] = [] + + def register_sdk_init_hook(self, hook: SDKInitHook) -> None: + self.sdk_init_hooks.append(hook) + + def register_before_request_hook(self, hook: BeforeRequestHook) -> None: + self.before_request_hooks.append(hook) + + def register_after_success_hook(self, hook: AfterSuccessHook) -> None: + self.after_success_hooks.append(hook) + + def register_after_error_hook(self, hook: AfterErrorHook) -> None: + self.after_error_hooks.append(hook) + + def sdk_init(self, base_url: str, client: requests.Session) -> Tuple[str, requests.Session]: + for hook in self.sdk_init_hooks: + base_url, client = hook.sdk_init(base_url, client) + return base_url, client + + def before_request(self, hook_ctx: BeforeRequestContext, request: requests.PreparedRequest) -> requests.PreparedRequest: + for hook in self.before_request_hooks: + out = hook.before_request(hook_ctx, request) + if isinstance(out, Exception): + raise out + request = out + + return request + + def after_success(self, hook_ctx: AfterSuccessContext, response: requests.Response) -> requests.Response: + for hook in self.after_success_hooks: + out = hook.after_success(hook_ctx, response) + if isinstance(out, Exception): + raise out + response = out + return response + + def after_error(self, hook_ctx: AfterErrorContext, response: Optional[requests.Response], error: Optional[Exception]) -> Tuple[Optional[requests.Response], Optional[Exception]]: + for hook in self.after_error_hooks: + result = hook.after_error(hook_ctx, response, error) + if isinstance(result, Exception): + raise result + response, error = result + return response, error diff --git a/src/airbyte_api/_hooks/types.py b/src/airbyte_api/_hooks/types.py new file mode 100644 index 00000000..b24c1414 --- /dev/null +++ b/src/airbyte_api/_hooks/types.py @@ -0,0 +1,74 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +import requests as requests_http +from abc import ABC, abstractmethod +from typing import Any, Callable, List, Optional, Tuple, Union + + +class HookContext: + operation_id: str + oauth2_scopes: Optional[List[str]] = None + security_source: Optional[Union[Any, Callable[[], Any]]] = None + + def __init__(self, operation_id: str, oauth2_scopes: Optional[List[str]], security_source: Optional[Union[Any, Callable[[], Any]]]): + self.operation_id = operation_id + self.oauth2_scopes = oauth2_scopes + self.security_source = security_source + + +class BeforeRequestContext(HookContext): + def __init__(self, hook_ctx: HookContext): + super().__init__(hook_ctx.operation_id, hook_ctx.oauth2_scopes, hook_ctx.security_source) + + +class AfterSuccessContext(HookContext): + def __init__(self, hook_ctx: HookContext): + super().__init__(hook_ctx.operation_id, hook_ctx.oauth2_scopes, hook_ctx.security_source) + + + +class AfterErrorContext(HookContext): + def __init__(self, hook_ctx: HookContext): + super().__init__(hook_ctx.operation_id, hook_ctx.oauth2_scopes, hook_ctx.security_source) + + +class SDKInitHook(ABC): + @abstractmethod + def sdk_init(self, base_url: str, client: requests_http.Session) -> Tuple[str, requests_http.Session]: + pass + + +class BeforeRequestHook(ABC): + @abstractmethod + def before_request(self, hook_ctx: BeforeRequestContext, request: requests_http.PreparedRequest) -> Union[requests_http.PreparedRequest, Exception]: + pass + + +class AfterSuccessHook(ABC): + @abstractmethod + def after_success(self, hook_ctx: AfterSuccessContext, response: requests_http.Response) -> Union[requests_http.Response, Exception]: + pass + + +class AfterErrorHook(ABC): + @abstractmethod + def after_error(self, hook_ctx: AfterErrorContext, response: Optional[requests_http.Response], error: Optional[Exception]) -> Union[Tuple[Optional[requests_http.Response], Optional[Exception]], Exception]: + pass + + +class Hooks(ABC): + @abstractmethod + def register_sdk_init_hook(self, hook: SDKInitHook): + pass + + @abstractmethod + def register_before_request_hook(self, hook: BeforeRequestHook): + pass + + @abstractmethod + def register_after_success_hook(self, hook: AfterSuccessHook): + pass + + @abstractmethod + def register_after_error_hook(self, hook: AfterErrorHook): + pass diff --git a/src/airbyte/models/operations/__init__.py b/src/airbyte_api/api/__init__.py similarity index 100% rename from src/airbyte/models/operations/__init__.py rename to src/airbyte_api/api/__init__.py diff --git a/src/airbyte/models/operations/canceljob.py b/src/airbyte_api/api/canceljob.py similarity index 86% rename from src/airbyte/models/operations/canceljob.py rename to src/airbyte_api/api/canceljob.py index dcb69f3d..449dbe61 100644 --- a/src/airbyte/models/operations/canceljob.py +++ b/src/airbyte_api/api/canceljob.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ...models.shared import jobresponse as shared_jobresponse +from ..models import jobresponse as models_jobresponse from typing import Optional @@ -22,7 +22,7 @@ class CancelJobResponse: 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) + job_response: Optional[models_jobresponse.JobResponse] = dataclasses.field(default=None) r"""Cancel a Job.""" diff --git a/src/airbyte/models/operations/createconnection.py b/src/airbyte_api/api/createconnection.py similarity index 82% rename from src/airbyte/models/operations/createconnection.py rename to src/airbyte_api/api/createconnection.py index ae961e57..3ab1cc5d 100644 --- a/src/airbyte/models/operations/createconnection.py +++ b/src/airbyte_api/api/createconnection.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ...models.shared import connectionresponse as shared_connectionresponse +from ..models import connectionresponse as models_connectionresponse from typing import Optional @@ -15,7 +15,7 @@ class CreateConnectionResponse: 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) + connection_response: Optional[models_connectionresponse.ConnectionResponse] = dataclasses.field(default=None) r"""Successful operation""" diff --git a/src/airbyte/models/operations/createdestination.py b/src/airbyte_api/api/createdestination.py similarity index 82% rename from src/airbyte/models/operations/createdestination.py rename to src/airbyte_api/api/createdestination.py index d9d37872..e0370df6 100644 --- a/src/airbyte/models/operations/createdestination.py +++ b/src/airbyte_api/api/createdestination.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ...models.shared import destinationresponse as shared_destinationresponse +from ..models import destinationresponse as models_destinationresponse from typing import Optional @@ -15,7 +15,7 @@ class CreateDestinationResponse: 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) + destination_response: Optional[models_destinationresponse.DestinationResponse] = dataclasses.field(default=None) r"""Successful operation""" diff --git a/src/airbyte/models/operations/createjob.py b/src/airbyte_api/api/createjob.py similarity index 84% rename from src/airbyte/models/operations/createjob.py rename to src/airbyte_api/api/createjob.py index 0dcc5211..d458d28f 100644 --- a/src/airbyte/models/operations/createjob.py +++ b/src/airbyte_api/api/createjob.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ...models.shared import jobresponse as shared_jobresponse +from ..models import jobresponse as models_jobresponse from typing import Optional @@ -15,7 +15,7 @@ class CreateJobResponse: 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) + job_response: Optional[models_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_api/api/createorupdateworkspaceoauthcredentials.py similarity index 84% rename from src/airbyte/models/operations/createorupdateworkspaceoauthcredentials.py rename to src/airbyte_api/api/createorupdateworkspaceoauthcredentials.py index 45d2ec9c..96f0f86e 100644 --- a/src/airbyte/models/operations/createorupdateworkspaceoauthcredentials.py +++ b/src/airbyte_api/api/createorupdateworkspaceoauthcredentials.py @@ -3,12 +3,12 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ...models.shared import workspaceoauthcredentialsrequest as shared_workspaceoauthcredentialsrequest +from ..models import workspaceoauthcredentialsrequest as models_workspaceoauthcredentialsrequest @dataclasses.dataclass class CreateOrUpdateWorkspaceOAuthCredentialsRequest: - workspace_o_auth_credentials_request: shared_workspaceoauthcredentialsrequest.WorkspaceOAuthCredentialsRequest = dataclasses.field(metadata={'request': { 'media_type': 'application/json' }}) + workspace_o_auth_credentials_request: models_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 }}) diff --git a/src/airbyte/models/operations/createsource.py b/src/airbyte_api/api/createsource.py similarity index 83% rename from src/airbyte/models/operations/createsource.py rename to src/airbyte_api/api/createsource.py index 1d50c9df..01b280c5 100644 --- a/src/airbyte/models/operations/createsource.py +++ b/src/airbyte_api/api/createsource.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ...models.shared import sourceresponse as shared_sourceresponse +from ..models import sourceresponse as models_sourceresponse from typing import Optional @@ -15,7 +15,7 @@ class CreateSourceResponse: 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) + source_response: Optional[models_sourceresponse.SourceResponse] = dataclasses.field(default=None) r"""Successful operation""" diff --git a/src/airbyte/models/operations/createworkspace.py b/src/airbyte_api/api/createworkspace.py similarity index 82% rename from src/airbyte/models/operations/createworkspace.py rename to src/airbyte_api/api/createworkspace.py index 37828857..7856844c 100644 --- a/src/airbyte/models/operations/createworkspace.py +++ b/src/airbyte_api/api/createworkspace.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ...models.shared import workspaceresponse as shared_workspaceresponse +from ..models import workspaceresponse as models_workspaceresponse from typing import Optional @@ -15,7 +15,7 @@ class CreateWorkspaceResponse: 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) + workspace_response: Optional[models_workspaceresponse.WorkspaceResponse] = dataclasses.field(default=None) r"""Successful operation""" diff --git a/src/airbyte/models/operations/deleteconnection.py b/src/airbyte_api/api/deleteconnection.py similarity index 100% rename from src/airbyte/models/operations/deleteconnection.py rename to src/airbyte_api/api/deleteconnection.py diff --git a/src/airbyte/models/operations/deletedestination.py b/src/airbyte_api/api/deletedestination.py similarity index 100% rename from src/airbyte/models/operations/deletedestination.py rename to src/airbyte_api/api/deletedestination.py diff --git a/src/airbyte/models/operations/deletesource.py b/src/airbyte_api/api/deletesource.py similarity index 100% rename from src/airbyte/models/operations/deletesource.py rename to src/airbyte_api/api/deletesource.py diff --git a/src/airbyte/models/operations/deleteworkspace.py b/src/airbyte_api/api/deleteworkspace.py similarity index 100% rename from src/airbyte/models/operations/deleteworkspace.py rename to src/airbyte_api/api/deleteworkspace.py diff --git a/src/airbyte/models/operations/getconnection.py b/src/airbyte_api/api/getconnection.py similarity index 86% rename from src/airbyte/models/operations/getconnection.py rename to src/airbyte_api/api/getconnection.py index 5fa67ed1..c49bdd76 100644 --- a/src/airbyte/models/operations/getconnection.py +++ b/src/airbyte_api/api/getconnection.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ...models.shared import connectionresponse as shared_connectionresponse +from ..models import connectionresponse as models_connectionresponse from typing import Optional @@ -22,7 +22,7 @@ class GetConnectionResponse: 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) + connection_response: Optional[models_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_api/api/getdestination.py similarity index 86% rename from src/airbyte/models/operations/getdestination.py rename to src/airbyte_api/api/getdestination.py index 376cda67..16bd9960 100644 --- a/src/airbyte/models/operations/getdestination.py +++ b/src/airbyte_api/api/getdestination.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ...models.shared import destinationresponse as shared_destinationresponse +from ..models import destinationresponse as models_destinationresponse from typing import Optional @@ -22,7 +22,7 @@ class GetDestinationResponse: 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) + destination_response: Optional[models_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_api/api/getjob.py similarity index 86% rename from src/airbyte/models/operations/getjob.py rename to src/airbyte_api/api/getjob.py index 0388f194..a218fd71 100644 --- a/src/airbyte/models/operations/getjob.py +++ b/src/airbyte_api/api/getjob.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ...models.shared import jobresponse as shared_jobresponse +from ..models import jobresponse as models_jobresponse from typing import Optional @@ -22,7 +22,7 @@ class GetJobResponse: 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) + job_response: Optional[models_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_api/api/getsource.py similarity index 86% rename from src/airbyte/models/operations/getsource.py rename to src/airbyte_api/api/getsource.py index 5041abc4..347f000a 100644 --- a/src/airbyte/models/operations/getsource.py +++ b/src/airbyte_api/api/getsource.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ...models.shared import sourceresponse as shared_sourceresponse +from ..models import sourceresponse as models_sourceresponse from typing import Optional @@ -22,7 +22,7 @@ class GetSourceResponse: 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) + source_response: Optional[models_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_api/api/getstreamproperties.py similarity index 90% rename from src/airbyte/models/operations/getstreamproperties.py rename to src/airbyte_api/api/getstreamproperties.py index 8a17c4e4..1f906eef 100644 --- a/src/airbyte/models/operations/getstreamproperties.py +++ b/src/airbyte_api/api/getstreamproperties.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ...models.shared import streampropertiesresponse as shared_streampropertiesresponse +from ..models import streampropertiesresponse as models_streampropertiesresponse from typing import Optional @@ -27,7 +27,7 @@ class GetStreamPropertiesResponse: 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) + stream_properties_response: Optional[models_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_api/api/getworkspace.py similarity index 86% rename from src/airbyte/models/operations/getworkspace.py rename to src/airbyte_api/api/getworkspace.py index 01cbd395..9f4822cd 100644 --- a/src/airbyte/models/operations/getworkspace.py +++ b/src/airbyte_api/api/getworkspace.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ...models.shared import workspaceresponse as shared_workspaceresponse +from ..models import workspaceresponse as models_workspaceresponse from typing import Optional @@ -22,7 +22,7 @@ class GetWorkspaceResponse: 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) + workspace_response: Optional[models_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_api/api/initiateoauth.py similarity index 100% rename from src/airbyte/models/operations/initiateoauth.py rename to src/airbyte_api/api/initiateoauth.py diff --git a/src/airbyte/models/operations/listconnections.py b/src/airbyte_api/api/listconnections.py similarity index 92% rename from src/airbyte/models/operations/listconnections.py rename to src/airbyte_api/api/listconnections.py index 58b4990f..92a490c2 100644 --- a/src/airbyte/models/operations/listconnections.py +++ b/src/airbyte_api/api/listconnections.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ...models.shared import connectionsresponse as shared_connectionsresponse +from ..models import connectionsresponse as models_connectionsresponse from typing import List, Optional @@ -29,7 +29,7 @@ class ListConnectionsResponse: 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) + connections_response: Optional[models_connectionsresponse.ConnectionsResponse] = dataclasses.field(default=None) r"""Successful operation""" diff --git a/src/airbyte/models/operations/listdestinations.py b/src/airbyte_api/api/listdestinations.py similarity index 92% rename from src/airbyte/models/operations/listdestinations.py rename to src/airbyte_api/api/listdestinations.py index 34b96ec5..f9365882 100644 --- a/src/airbyte/models/operations/listdestinations.py +++ b/src/airbyte_api/api/listdestinations.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ...models.shared import destinationsresponse as shared_destinationsresponse +from ..models import destinationsresponse as models_destinationsresponse from typing import List, Optional @@ -29,7 +29,7 @@ class ListDestinationsResponse: 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) + destinations_response: Optional[models_destinationsresponse.DestinationsResponse] = dataclasses.field(default=None) r"""Successful operation""" diff --git a/src/airbyte/models/operations/listjobs.py b/src/airbyte_api/api/listjobs.py similarity index 88% rename from src/airbyte/models/operations/listjobs.py rename to src/airbyte_api/api/listjobs.py index da35e25b..d6c89461 100644 --- a/src/airbyte/models/operations/listjobs.py +++ b/src/airbyte_api/api/listjobs.py @@ -3,9 +3,9 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ...models.shared import jobsresponse as shared_jobsresponse -from ...models.shared import jobstatusenum as shared_jobstatusenum -from ...models.shared import jobtypeenum as shared_jobtypeenum +from ..models import jobsresponse as models_jobsresponse +from ..models import jobstatusenum as models_jobstatusenum +from ..models import jobtypeenum as models_jobtypeenum from datetime import datetime from typing import List, Optional @@ -18,7 +18,7 @@ class ListJobsRequest: r"""The end date to filter by""" created_at_start: Optional[datetime] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'createdAtStart', 'style': 'form', 'explode': True }}) r"""The start date to filter by""" - job_type: Optional[shared_jobtypeenum.JobTypeEnum] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'jobType', 'style': 'form', 'explode': True }}) + job_type: Optional[models_jobtypeenum.JobTypeEnum] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'jobType', 'style': 'form', 'explode': True }}) r"""Filter the Jobs by jobType.""" limit: Optional[int] = dataclasses.field(default=20, metadata={'query_param': { 'field_name': 'limit', 'style': 'form', 'explode': True }}) r"""Set the limit on the number of Jobs returned. The default is 20 Jobs.""" @@ -26,7 +26,7 @@ class ListJobsRequest: r"""Set the offset to start at when returning Jobs. The default is 0.""" order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) r"""The field and method to use for ordering. Currently allowed are createdAt and updatedAt.""" - status: Optional[shared_jobstatusenum.JobStatusEnum] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'status', 'style': 'form', 'explode': True }}) + status: Optional[models_jobstatusenum.JobStatusEnum] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'status', 'style': 'form', 'explode': True }}) r"""The Job status you want to filter by""" updated_at_end: Optional[datetime] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'updatedAtEnd', 'style': 'form', 'explode': True }}) r"""The end date to filter by""" @@ -46,7 +46,7 @@ class ListJobsResponse: 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) + jobs_response: Optional[models_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_api/api/listsources.py similarity index 92% rename from src/airbyte/models/operations/listsources.py rename to src/airbyte_api/api/listsources.py index c76a9a10..528804d8 100644 --- a/src/airbyte/models/operations/listsources.py +++ b/src/airbyte_api/api/listsources.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ...models.shared import sourcesresponse as shared_sourcesresponse +from ..models import sourcesresponse as models_sourcesresponse from typing import List, Optional @@ -29,7 +29,7 @@ class ListSourcesResponse: 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) + sources_response: Optional[models_sourcesresponse.SourcesResponse] = dataclasses.field(default=None) r"""Successful operation""" diff --git a/src/airbyte/models/operations/listworkspaces.py b/src/airbyte_api/api/listworkspaces.py similarity index 92% rename from src/airbyte/models/operations/listworkspaces.py rename to src/airbyte_api/api/listworkspaces.py index c36c206a..7e03a466 100644 --- a/src/airbyte/models/operations/listworkspaces.py +++ b/src/airbyte_api/api/listworkspaces.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ...models.shared import workspacesresponse as shared_workspacesresponse +from ..models import workspacesresponse as models_workspacesresponse from typing import List, Optional @@ -29,7 +29,7 @@ class ListWorkspacesResponse: 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) + workspaces_response: Optional[models_workspacesresponse.WorkspacesResponse] = dataclasses.field(default=None) r"""Successful operation""" diff --git a/src/airbyte/models/operations/patchconnection.py b/src/airbyte_api/api/patchconnection.py similarity index 77% rename from src/airbyte/models/operations/patchconnection.py rename to src/airbyte_api/api/patchconnection.py index e546c01f..ecf74101 100644 --- a/src/airbyte/models/operations/patchconnection.py +++ b/src/airbyte_api/api/patchconnection.py @@ -3,14 +3,14 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ...models.shared import connectionpatchrequest as shared_connectionpatchrequest -from ...models.shared import connectionresponse as shared_connectionresponse +from ..models import connectionpatchrequest as models_connectionpatchrequest +from ..models import connectionresponse as models_connectionresponse from typing import Optional @dataclasses.dataclass class PatchConnectionRequest: - connection_patch_request: shared_connectionpatchrequest.ConnectionPatchRequest = dataclasses.field(metadata={'request': { 'media_type': 'application/json' }}) + connection_patch_request: models_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 }}) @@ -24,7 +24,7 @@ class PatchConnectionResponse: 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) + connection_response: Optional[models_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_api/api/patchdestination.py similarity index 77% rename from src/airbyte/models/operations/patchdestination.py rename to src/airbyte_api/api/patchdestination.py index b533fe04..0f5f4186 100644 --- a/src/airbyte/models/operations/patchdestination.py +++ b/src/airbyte_api/api/patchdestination.py @@ -3,15 +3,15 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ...models.shared import destinationpatchrequest as shared_destinationpatchrequest -from ...models.shared import destinationresponse as shared_destinationresponse +from ..models import destinationpatchrequest as models_destinationpatchrequest +from ..models import destinationresponse as models_destinationresponse from typing import Optional @dataclasses.dataclass class PatchDestinationRequest: destination_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'destinationId', 'style': 'simple', 'explode': False }}) - destination_patch_request: Optional[shared_destinationpatchrequest.DestinationPatchRequest] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + destination_patch_request: Optional[models_destinationpatchrequest.DestinationPatchRequest] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) @@ -24,7 +24,7 @@ class PatchDestinationResponse: 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) + destination_response: Optional[models_destinationresponse.DestinationResponse] = dataclasses.field(default=None) r"""Update a Destination""" diff --git a/src/airbyte/models/operations/patchsource.py b/src/airbyte_api/api/patchsource.py similarity index 77% rename from src/airbyte/models/operations/patchsource.py rename to src/airbyte_api/api/patchsource.py index 80f7eb85..fcd60547 100644 --- a/src/airbyte/models/operations/patchsource.py +++ b/src/airbyte_api/api/patchsource.py @@ -3,15 +3,15 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ...models.shared import sourcepatchrequest as shared_sourcepatchrequest -from ...models.shared import sourceresponse as shared_sourceresponse +from ..models import sourcepatchrequest as models_sourcepatchrequest +from ..models import sourceresponse as models_sourceresponse from typing import Optional @dataclasses.dataclass class PatchSourceRequest: source_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'sourceId', 'style': 'simple', 'explode': False }}) - source_patch_request: Optional[shared_sourcepatchrequest.SourcePatchRequest] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + source_patch_request: Optional[models_sourcepatchrequest.SourcePatchRequest] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) @@ -24,7 +24,7 @@ class PatchSourceResponse: 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) + source_response: Optional[models_sourceresponse.SourceResponse] = dataclasses.field(default=None) r"""Update a Source""" diff --git a/src/airbyte/models/operations/putdestination.py b/src/airbyte_api/api/putdestination.py similarity index 77% rename from src/airbyte/models/operations/putdestination.py rename to src/airbyte_api/api/putdestination.py index 301404a6..1e624df5 100644 --- a/src/airbyte/models/operations/putdestination.py +++ b/src/airbyte_api/api/putdestination.py @@ -3,15 +3,15 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ...models.shared import destinationputrequest as shared_destinationputrequest -from ...models.shared import destinationresponse as shared_destinationresponse +from ..models import destinationputrequest as models_destinationputrequest +from ..models import destinationresponse as models_destinationresponse from typing import Optional @dataclasses.dataclass class PutDestinationRequest: destination_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'destinationId', 'style': 'simple', 'explode': False }}) - destination_put_request: Optional[shared_destinationputrequest.DestinationPutRequest] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + destination_put_request: Optional[models_destinationputrequest.DestinationPutRequest] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) @@ -24,7 +24,7 @@ class PutDestinationResponse: 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) + destination_response: Optional[models_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_api/api/putsource.py similarity index 77% rename from src/airbyte/models/operations/putsource.py rename to src/airbyte_api/api/putsource.py index 23d5ab3c..5e8256ed 100644 --- a/src/airbyte/models/operations/putsource.py +++ b/src/airbyte_api/api/putsource.py @@ -3,15 +3,15 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ...models.shared import sourceputrequest as shared_sourceputrequest -from ...models.shared import sourceresponse as shared_sourceresponse +from ..models import sourceputrequest as models_sourceputrequest +from ..models import sourceresponse as models_sourceresponse from typing import Optional @dataclasses.dataclass class PutSourceRequest: source_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'sourceId', 'style': 'simple', 'explode': False }}) - source_put_request: Optional[shared_sourceputrequest.SourcePutRequest] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) + source_put_request: Optional[models_sourceputrequest.SourcePutRequest] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) @@ -24,7 +24,7 @@ class PutSourceResponse: 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) + source_response: Optional[models_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_api/api/updateworkspace.py similarity index 76% rename from src/airbyte/models/operations/updateworkspace.py rename to src/airbyte_api/api/updateworkspace.py index d3152c79..1942257c 100644 --- a/src/airbyte/models/operations/updateworkspace.py +++ b/src/airbyte_api/api/updateworkspace.py @@ -3,14 +3,14 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ...models.shared import workspaceresponse as shared_workspaceresponse -from ...models.shared import workspaceupdaterequest as shared_workspaceupdaterequest +from ..models import workspaceresponse as models_workspaceresponse +from ..models import workspaceupdaterequest as models_workspaceupdaterequest from typing import Optional @dataclasses.dataclass class UpdateWorkspaceRequest: - workspace_update_request: shared_workspaceupdaterequest.WorkspaceUpdateRequest = dataclasses.field(metadata={'request': { 'media_type': 'application/json' }}) + workspace_update_request: models_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 }}) @@ -24,7 +24,7 @@ class UpdateWorkspaceResponse: 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) + workspace_response: Optional[models_workspaceresponse.WorkspaceResponse] = dataclasses.field(default=None) r"""Successful operation""" diff --git a/src/airbyte_api/connections.py b/src/airbyte_api/connections.py new file mode 100644 index 00000000..6bda693e --- /dev/null +++ b/src/airbyte_api/connections.py @@ -0,0 +1,292 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +import requests as requests_http +from .sdkconfiguration import SDKConfiguration +from airbyte_api import api, errors, models, utils +from airbyte_api._hooks import AfterErrorContext, AfterSuccessContext, BeforeRequestContext, HookContext +from typing import Optional + +class Connections: + sdk_configuration: SDKConfiguration + + def __init__(self, sdk_config: SDKConfiguration) -> None: + self.sdk_configuration = sdk_config + + + + def create_connection(self, request: models.ConnectionCreateRequest) -> api.CreateConnectionResponse: + r"""Create a connection""" + hook_ctx = HookContext(operation_id='createConnection', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = base_url + '/connections' + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + req_content_type, data, form = utils.serialize_request_body(request, models.ConnectionCreateRequest, "request", False, False, 'json') + if req_content_type is not None and req_content_type not in ('multipart/form-data', 'multipart/mixed'): + headers['content-type'] = req_content_type + if data is None and form is None: + raise Exception('request body is required') + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('POST', url, params=query_params, data=data, files=form, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['400','403','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.CreateConnectionResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(http_res.headers.get('Content-Type') or '', 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[models.ConnectionResponse]) + res.connection_response = out + else: + content_type = http_res.headers.get('Content-Type') + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + elif http_res.status_code == 400 or http_res.status_code == 403 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + + def delete_connection(self, request: api.DeleteConnectionRequest) -> api.DeleteConnectionResponse: + r"""Delete a Connection""" + hook_ctx = HookContext(operation_id='deleteConnection', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = utils.generate_url(base_url, '/connections/{connectionId}', request) + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + headers['Accept'] = '*/*' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('DELETE', url, params=query_params, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['403','404','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.DeleteConnectionResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 204: + pass + elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + + def get_connection(self, request: api.GetConnectionRequest) -> api.GetConnectionResponse: + r"""Get Connection details""" + hook_ctx = HookContext(operation_id='getConnection', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = utils.generate_url(base_url, '/connections/{connectionId}', request) + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('GET', url, params=query_params, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['403','404','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.GetConnectionResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(http_res.headers.get('Content-Type') or '', 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[models.ConnectionResponse]) + res.connection_response = out + else: + content_type = http_res.headers.get('Content-Type') + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + + def list_connections(self, request: api.ListConnectionsRequest) -> api.ListConnectionsResponse: + r"""List connections""" + hook_ctx = HookContext(operation_id='listConnections', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = base_url + '/connections' + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + query_params = { **utils.get_query_params(request), **query_params } + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('GET', url, params=query_params, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['403','404','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.ListConnectionsResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(http_res.headers.get('Content-Type') or '', 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[models.ConnectionsResponse]) + res.connections_response = out + else: + content_type = http_res.headers.get('Content-Type') + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + + def patch_connection(self, request: api.PatchConnectionRequest) -> api.PatchConnectionResponse: + r"""Update Connection details""" + hook_ctx = HookContext(operation_id='patchConnection', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = utils.generate_url(base_url, '/connections/{connectionId}', request) + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + req_content_type, data, form = utils.serialize_request_body(request, api.PatchConnectionRequest, "connection_patch_request", False, False, 'json') + if req_content_type is not None and req_content_type not in ('multipart/form-data', 'multipart/mixed'): + headers['content-type'] = req_content_type + if data is None and form is None: + raise Exception('request body is required') + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('PATCH', url, params=query_params, data=data, files=form, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['403','404','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.PatchConnectionResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(http_res.headers.get('Content-Type') or '', 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[models.ConnectionResponse]) + res.connection_response = out + else: + content_type = http_res.headers.get('Content-Type') + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + diff --git a/src/airbyte_api/destinations.py b/src/airbyte_api/destinations.py new file mode 100644 index 00000000..36925357 --- /dev/null +++ b/src/airbyte_api/destinations.py @@ -0,0 +1,347 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +import requests as requests_http +from .sdkconfiguration import SDKConfiguration +from airbyte_api import api, errors, models, utils +from airbyte_api._hooks import AfterErrorContext, AfterSuccessContext, BeforeRequestContext, HookContext +from typing import Optional + +class Destinations: + sdk_configuration: SDKConfiguration + + def __init__(self, sdk_config: SDKConfiguration) -> None: + self.sdk_configuration = sdk_config + + + + def create_destination(self, request: Optional[models.DestinationCreateRequest]) -> api.CreateDestinationResponse: + r"""Create a destination + Creates a destination given a name, workspace id, and a json blob containing the configuration for the source. + """ + hook_ctx = HookContext(operation_id='createDestination', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = base_url + '/destinations' + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + req_content_type, data, form = utils.serialize_request_body(request, Optional[models.DestinationCreateRequest], "request", False, True, 'json') + if req_content_type is not None and req_content_type not in ('multipart/form-data', 'multipart/mixed'): + headers['content-type'] = req_content_type + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('POST', url, params=query_params, data=data, files=form, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['400','403','404','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.CreateDestinationResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(http_res.headers.get('Content-Type') or '', 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[models.DestinationResponse]) + res.destination_response = out + else: + content_type = http_res.headers.get('Content-Type') + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + elif http_res.status_code == 400 or http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + + def delete_destination(self, request: api.DeleteDestinationRequest) -> api.DeleteDestinationResponse: + r"""Delete a Destination""" + hook_ctx = HookContext(operation_id='deleteDestination', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = utils.generate_url(base_url, '/destinations/{destinationId}', request) + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + headers['Accept'] = '*/*' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('DELETE', url, params=query_params, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['403','404','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.DeleteDestinationResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 204: + pass + elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + + def get_destination(self, request: api.GetDestinationRequest) -> api.GetDestinationResponse: + r"""Get Destination details""" + hook_ctx = HookContext(operation_id='getDestination', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = utils.generate_url(base_url, '/destinations/{destinationId}', request) + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('GET', url, params=query_params, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['403','404','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.GetDestinationResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(http_res.headers.get('Content-Type') or '', 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[models.DestinationResponse]) + res.destination_response = out + else: + content_type = http_res.headers.get('Content-Type') + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + + def list_destinations(self, request: api.ListDestinationsRequest) -> api.ListDestinationsResponse: + r"""List destinations""" + hook_ctx = HookContext(operation_id='listDestinations', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = base_url + '/destinations' + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + query_params = { **utils.get_query_params(request), **query_params } + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('GET', url, params=query_params, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['403','404','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.ListDestinationsResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(http_res.headers.get('Content-Type') or '', 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[models.DestinationsResponse]) + res.destinations_response = out + else: + content_type = http_res.headers.get('Content-Type') + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + + def patch_destination(self, request: api.PatchDestinationRequest) -> api.PatchDestinationResponse: + r"""Update a Destination""" + hook_ctx = HookContext(operation_id='patchDestination', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = utils.generate_url(base_url, '/destinations/{destinationId}', request) + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + req_content_type, data, form = utils.serialize_request_body(request, api.PatchDestinationRequest, "destination_patch_request", False, True, 'json') + if req_content_type is not None and req_content_type not in ('multipart/form-data', 'multipart/mixed'): + headers['content-type'] = req_content_type + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('PATCH', url, params=query_params, data=data, files=form, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['403','404','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.PatchDestinationResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(http_res.headers.get('Content-Type') or '', 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[models.DestinationResponse]) + res.destination_response = out + else: + content_type = http_res.headers.get('Content-Type') + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + + def put_destination(self, request: api.PutDestinationRequest) -> api.PutDestinationResponse: + r"""Update a Destination and fully overwrite it""" + hook_ctx = HookContext(operation_id='putDestination', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = utils.generate_url(base_url, '/destinations/{destinationId}', request) + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + req_content_type, data, form = utils.serialize_request_body(request, api.PutDestinationRequest, "destination_put_request", False, True, 'json') + if req_content_type is not None and req_content_type not in ('multipart/form-data', 'multipart/mixed'): + headers['content-type'] = req_content_type + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('PUT', url, params=query_params, data=data, files=form, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['403','404','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.PutDestinationResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(http_res.headers.get('Content-Type') or '', 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[models.DestinationResponse]) + res.destination_response = out + else: + content_type = http_res.headers.get('Content-Type') + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + diff --git a/src/airbyte/models/errors/__init__.py b/src/airbyte_api/errors/__init__.py similarity index 100% rename from src/airbyte/models/errors/__init__.py rename to src/airbyte_api/errors/__init__.py diff --git a/src/airbyte/models/errors/sdkerror.py b/src/airbyte_api/errors/sdkerror.py similarity index 100% rename from src/airbyte/models/errors/sdkerror.py rename to src/airbyte_api/errors/sdkerror.py diff --git a/src/airbyte_api/jobs.py b/src/airbyte_api/jobs.py new file mode 100644 index 00000000..0262a7cd --- /dev/null +++ b/src/airbyte_api/jobs.py @@ -0,0 +1,238 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +import requests as requests_http +from .sdkconfiguration import SDKConfiguration +from airbyte_api import api, errors, models, utils +from airbyte_api._hooks import AfterErrorContext, AfterSuccessContext, BeforeRequestContext, HookContext +from typing import Optional + +class Jobs: + sdk_configuration: SDKConfiguration + + def __init__(self, sdk_config: SDKConfiguration) -> None: + self.sdk_configuration = sdk_config + + + + def cancel_job(self, request: api.CancelJobRequest) -> api.CancelJobResponse: + r"""Cancel a running Job""" + hook_ctx = HookContext(operation_id='cancelJob', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = utils.generate_url(base_url, '/jobs/{jobId}', request) + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('DELETE', url, params=query_params, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['403','404','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.CancelJobResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(http_res.headers.get('Content-Type') or '', 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[models.JobResponse]) + res.job_response = out + else: + content_type = http_res.headers.get('Content-Type') + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + + def create_job(self, request: models.JobCreateRequest) -> api.CreateJobResponse: + r"""Trigger a sync or reset job of a connection""" + hook_ctx = HookContext(operation_id='createJob', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = base_url + '/jobs' + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + req_content_type, data, form = utils.serialize_request_body(request, models.JobCreateRequest, "request", False, False, 'json') + if req_content_type is not None and req_content_type not in ('multipart/form-data', 'multipart/mixed'): + headers['content-type'] = req_content_type + if data is None and form is None: + raise Exception('request body is required') + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('POST', url, params=query_params, data=data, files=form, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['400','403','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.CreateJobResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(http_res.headers.get('Content-Type') or '', 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[models.JobResponse]) + res.job_response = out + else: + content_type = http_res.headers.get('Content-Type') + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + elif http_res.status_code == 400 or http_res.status_code == 403 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + + def get_job(self, request: api.GetJobRequest) -> api.GetJobResponse: + r"""Get Job status and details""" + hook_ctx = HookContext(operation_id='getJob', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = utils.generate_url(base_url, '/jobs/{jobId}', request) + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('GET', url, params=query_params, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['403','404','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.GetJobResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(http_res.headers.get('Content-Type') or '', 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[models.JobResponse]) + res.job_response = out + else: + content_type = http_res.headers.get('Content-Type') + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + + def list_jobs(self, request: api.ListJobsRequest) -> api.ListJobsResponse: + r"""List Jobs by sync type""" + hook_ctx = HookContext(operation_id='listJobs', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = base_url + '/jobs' + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + query_params = { **utils.get_query_params(request), **query_params } + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('GET', url, params=query_params, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['403','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.ListJobsResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(http_res.headers.get('Content-Type') or '', 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[models.JobsResponse]) + res.jobs_response = out + else: + content_type = http_res.headers.get('Content-Type') + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + elif http_res.status_code == 403 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + diff --git a/src/airbyte_api/models/__init__.py b/src/airbyte_api/models/__init__.py new file mode 100644 index 00000000..6526e984 --- /dev/null +++ b/src/airbyte_api/models/__init__.py @@ -0,0 +1,322 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from .actortypeenum import * +from .airtable import * +from .amazon_ads import * +from .amazon_seller_partner import * +from .asana import * +from .bing_ads import * +from .connectioncreaterequest import * +from .connectionpatchrequest import * +from .connectionresponse import * +from .connectionschedule import * +from .connectionscheduleresponse import * +from .connectionsresponse import * +from .connectionstatusenum import * +from .connectionsyncmodeenum import * +from .destination_astra import * +from .destination_aws_datalake import * +from .destination_azure_blob_storage import * +from .destination_bigquery import * +from .destination_clickhouse import * +from .destination_convex import * +from .destination_databricks import * +from .destination_dev_null import * +from .destination_duckdb import * +from .destination_dynamodb import * +from .destination_elasticsearch import * +from .destination_firestore import * +from .destination_gcs import * +from .destination_google_sheets import * +from .destination_langchain import * +from .destination_milvus import * +from .destination_mongodb import * +from .destination_mssql import * +from .destination_mysql import * +from .destination_oracle import * +from .destination_pinecone import * +from .destination_postgres import * +from .destination_pubsub import * +from .destination_qdrant import * +from .destination_redis import * +from .destination_redshift import * +from .destination_s3 import * +from .destination_s3_glue import * +from .destination_sftp_json import * +from .destination_snowflake import * +from .destination_teradata import * +from .destination_typesense import * +from .destination_vectara import * +from .destination_weaviate import * +from .destinationcreaterequest import * +from .destinationpatchrequest import * +from .destinationputrequest import * +from .destinationresponse import * +from .destinationsresponse import * +from .facebook_marketing import * +from .geographyenum import * +from .geographyenumnodefault import * +from .github import * +from .gitlab import * +from .google_ads import * +from .google_analytics_data_api import * +from .google_drive import * +from .google_search_console import * +from .google_sheets import * +from .harvest import * +from .hubspot import * +from .initiateoauthrequest import * +from .instagram import * +from .intercom import * +from .jobcreaterequest import * +from .jobresponse import * +from .jobsresponse import * +from .jobstatusenum import * +from .jobtypeenum import * +from .lever_hiring import * +from .linkedin_ads import * +from .mailchimp import * +from .microsoft_onedrive import * +from .microsoft_sharepoint import * +from .microsoft_teams import * +from .monday import * +from .namespacedefinitionenum import * +from .namespacedefinitionenumnodefault import * +from .nonbreakingschemaupdatesbehaviorenum import * +from .nonbreakingschemaupdatesbehaviorenumnodefault import * +from .notion import * +from .oauthactornames import * +from .oauthinputconfiguration import * +from .pinterest import * +from .retently import * +from .salesforce import * +from .scheduletypeenum import * +from .scheduletypewithbasicenum import * +from .schemebasicauth import * +from .security import * +from .shopify import * +from .slack import * +from .smartsheets import * +from .snapchat_marketing import * +from .snowflake import * +from .source_aha import * +from .source_aircall import * +from .source_airtable import * +from .source_amazon_ads import * +from .source_amazon_seller_partner import * +from .source_amazon_sqs import * +from .source_amplitude import * +from .source_apify_dataset import * +from .source_appfollow import * +from .source_asana import * +from .source_auth0 import * +from .source_aws_cloudtrail import * +from .source_azure_blob_storage import * +from .source_azure_table import * +from .source_bamboo_hr import * +from .source_bigquery import * +from .source_bing_ads import * +from .source_braintree import * +from .source_braze import * +from .source_cart import * +from .source_chargebee import * +from .source_chartmogul import * +from .source_clickhouse import * +from .source_clickup_api import * +from .source_clockify import * +from .source_close_com import * +from .source_coda import * +from .source_coin_api import * +from .source_coinmarketcap import * +from .source_configcat import * +from .source_confluence import * +from .source_convex import * +from .source_datascope import * +from .source_delighted import * +from .source_dixa import * +from .source_dockerhub import * +from .source_dremio import * +from .source_dynamodb import * +from .source_e2e_test_cloud import * +from .source_emailoctopus import * +from .source_exchange_rates import * +from .source_facebook_marketing import * +from .source_faker import * +from .source_fauna import * +from .source_file import * +from .source_firebolt import * +from .source_freshcaller import * +from .source_freshdesk import * +from .source_freshsales import * +from .source_gainsight_px import * +from .source_gcs import * +from .source_getlago import * +from .source_github import * +from .source_gitlab import * +from .source_glassfrog import * +from .source_gnews import * +from .source_google_ads import * +from .source_google_analytics_data_api import * +from .source_google_analytics_v4_service_account_only import * +from .source_google_directory import * +from .source_google_drive import * +from .source_google_pagespeed_insights import * +from .source_google_search_console import * +from .source_google_sheets import * +from .source_google_webfonts import * +from .source_greenhouse import * +from .source_gridly import * +from .source_harvest import * +from .source_hubplanner import * +from .source_hubspot import * +from .source_insightly import * +from .source_instagram import * +from .source_instatus import * +from .source_intercom import * +from .source_ip2whois import * +from .source_iterable import * +from .source_jira import * +from .source_k6_cloud import * +from .source_klarna import * +from .source_klaviyo import * +from .source_kyve import * +from .source_launchdarkly import * +from .source_lemlist import * +from .source_lever_hiring import * +from .source_linkedin_ads import * +from .source_linkedin_pages import * +from .source_linnworks import * +from .source_lokalise import * +from .source_mailchimp import * +from .source_mailgun import * +from .source_mailjet_sms import * +from .source_marketo import * +from .source_metabase import * +from .source_microsoft_onedrive import * +from .source_microsoft_sharepoint import * +from .source_microsoft_teams import * +from .source_mixpanel import * +from .source_monday import * +from .source_mongodb_internal_poc import * +from .source_mongodb_v2 import * +from .source_mssql import * +from .source_my_hours import * +from .source_mysql import * +from .source_netsuite import * +from .source_notion import * +from .source_nytimes import * +from .source_okta import * +from .source_omnisend import * +from .source_onesignal import * +from .source_oracle import * +from .source_orb import * +from .source_orbit import * +from .source_outbrain_amplify import * +from .source_outreach import * +from .source_paypal_transaction import * +from .source_paystack import * +from .source_pendo import * +from .source_persistiq import * +from .source_pexels_api import * +from .source_pinterest import * +from .source_pipedrive import * +from .source_pocket import * +from .source_pokeapi import * +from .source_polygon_stock_api import * +from .source_postgres import * +from .source_posthog import * +from .source_postmarkapp import * +from .source_prestashop import * +from .source_punk_api import * +from .source_pypi import * +from .source_qualaroo import * +from .source_quickbooks import * +from .source_railz import * +from .source_recharge import * +from .source_recreation import * +from .source_recruitee import * +from .source_recurly import * +from .source_redshift import * +from .source_retently import * +from .source_rki_covid import * +from .source_rss import * +from .source_s3 import * +from .source_salesforce import * +from .source_salesloft import * +from .source_sap_fieldglass import * +from .source_secoda import * +from .source_sendgrid import * +from .source_sendinblue import * +from .source_senseforce import * +from .source_sentry import * +from .source_sftp import * +from .source_sftp_bulk import * +from .source_shopify import * +from .source_shortio import * +from .source_slack import * +from .source_smaily import * +from .source_smartengage import * +from .source_smartsheets import * +from .source_snapchat_marketing import * +from .source_snowflake import * +from .source_sonar_cloud import * +from .source_spacex_api import * +from .source_square import * +from .source_strava import * +from .source_stripe import * +from .source_survey_sparrow import * +from .source_surveymonkey import * +from .source_tempo import * +from .source_the_guardian_api import * +from .source_tiktok_marketing import * +from .source_trello import * +from .source_trustpilot import * +from .source_tvmaze_schedule import * +from .source_twilio import * +from .source_twilio_taskrouter import * +from .source_twitter import * +from .source_typeform import * +from .source_us_census import * +from .source_vantage import * +from .source_webflow import * +from .source_whisky_hunter import * +from .source_wikipedia_pageviews import * +from .source_woocommerce import * +from .source_xkcd import * +from .source_yandex_metrica import * +from .source_yotpo import * +from .source_youtube_analytics import * +from .source_zendesk_chat import * +from .source_zendesk_sell import * +from .source_zendesk_sunshine import * +from .source_zendesk_support import * +from .source_zendesk_talk import * +from .source_zenloop import * +from .source_zoho_crm import * +from .source_zoom import * +from .sourcecreaterequest import * +from .sourcepatchrequest import * +from .sourceputrequest import * +from .sourceresponse import * +from .sourcesresponse import * +from .square import * +from .strava import * +from .streamconfiguration import * +from .streamconfigurations import * +from .streamproperties import * +from .streampropertiesresponse import * +from .surveymonkey import * +from .tiktok_marketing import * +from .typeform import * +from .workspacecreaterequest import * +from .workspaceoauthcredentialsrequest import * +from .workspaceresponse import * +from .workspacesresponse import * +from .workspaceupdaterequest import * +from .youtube_analytics import * +from .zendesk_chat import * +from .zendesk_sunshine import * +from .zendesk_support import * +from .zendesk_talk import * + +__all__ = ["AESCBCEnvelopeEncryption","APIAccessToken","APIKey","APIKeyAuth","APIKeySecret","APIPassword","APIToken","AWSEnvironment","AWSRegion","AWSS3Staging","AWSSellerPartnerAccountType","AccessToken","AccessTokenIsRequiredForAuthenticationRequests","AccountNames","ActionReportTime","ActorTypeEnum","AdAnalyticsReportConfiguration","Aha","Aircall","Airtable","Allow","AmazonAds","AmazonS3","AmazonSellerPartner","AmazonSqs","Amplitude","AndGroup","ApifyDataset","Appfollow","Applications","Asana","AsanaCredentials","Astra","Auth0","AuthMethod","AuthType","AuthenticateViaAPIKey","AuthenticateViaAsanaOauth","AuthenticateViaGoogleOauth","AuthenticateViaHarvestOAuth","AuthenticateViaLeverAPIKey","AuthenticateViaLeverOAuth","AuthenticateViaMicrosoft","AuthenticateViaMicrosoftOAuth","AuthenticateViaMicrosoftOAuth20","AuthenticateViaOAuth","AuthenticateViaOAuth20","AuthenticateViaRetentlyOAuth","AuthenticateWithAPIToken","AuthenticateWithPersonalAccessToken","AuthenticationViaGoogleOAuth","Authorization","Autogenerated","Avro","AvroApacheAvro","AvroFormat","AwsCloudtrail","AwsDatalake","AzBlobAzureBlobStorage","AzureBlobStorage","AzureOpenAI","AzureTable","BambooHr","BetweenFilter","Bigquery","BingAds","BothUsernameAndPasswordIsRequiredForAuthenticationRequest","Braintree","Braze","ByMarkdownHeader","ByProgrammingLanguage","BySeparator","Bzip2","CSVCommaSeparatedValues","CSVFormat","CacheType","Cart","Categories","CentralAPIRouter","Chargebee","Chartmogul","ChooseHowToPartitionData","ChromaLocalPersistance","ClickWindowDays","Clickhouse","ClickupAPI","Clockify","CloseCom","Coda","Codec","Cohere","CohortReportSettings","Cohorts","CohortsRange","CoinAPI","Coinmarketcap","Collection","CompressionCodecOptional","CompressionType","Configcat","Confluence","ConnectionCreateRequest","ConnectionPatchRequest","ConnectionResponse","ConnectionSchedule","ConnectionScheduleResponse","ConnectionStatusEnum","ConnectionSyncModeEnum","ConnectionType","ConnectionsResponse","ContentType","ContinuousFeed","ConversionReportTime","Convex","Country","CredentialType","Credentials","CredentialsTitle","Csv","CustomQueriesArray","CustomReportConfig","CustomerStatus","DataCenterLocation","DataFreshness","DataRegion","DataSourceType","DataType","Databricks","Datascope","DatasetLocation","DateRange","DefaultVectorizer","Deflate","Delighted","DestinationAstra","DestinationAstraLanguage","DestinationAstraMode","DestinationAstraSchemasEmbeddingEmbedding1Mode","DestinationAstraSchemasEmbeddingEmbeddingMode","DestinationAstraSchemasEmbeddingMode","DestinationAstraSchemasMode","DestinationAstraSchemasProcessingMode","DestinationAstraSchemasProcessingTextSplitterMode","DestinationAstraSchemasProcessingTextSplitterTextSplitterMode","DestinationAwsDatalake","DestinationAwsDatalakeCompressionCodecOptional","DestinationAwsDatalakeCredentialsTitle","DestinationAwsDatalakeFormatTypeWildcard","DestinationAzureBlobStorage","DestinationAzureBlobStorageFormatType","DestinationAzureBlobStorageJSONLinesNewlineDelimitedJSON","DestinationBigquery","DestinationBigqueryCredentialType","DestinationBigqueryHMACKey","DestinationBigqueryMethod","DestinationClickhouse","DestinationClickhouseSchemasTunnelMethod","DestinationClickhouseTunnelMethod","DestinationConvex","DestinationCreateRequest","DestinationDatabricks","DestinationDatabricksAzureBlobStorage","DestinationDatabricksDataSourceType","DestinationDatabricksS3BucketRegion","DestinationDatabricksSchemasDataSourceType","DestinationDevNull","DestinationDuckdb","DestinationDynamodb","DestinationElasticsearch","DestinationElasticsearchMethod","DestinationElasticsearchSchemasMethod","DestinationFirestore","DestinationGcs","DestinationGcsCSVCommaSeparatedValues","DestinationGcsCodec","DestinationGcsCompressionCodec","DestinationGcsCompressionType","DestinationGcsFormatType","DestinationGcsGZIP","DestinationGcsJSONLinesNewlineDelimitedJSON","DestinationGcsNoCompression","DestinationGcsParquetColumnarStorage","DestinationGcsSchemasCodec","DestinationGcsSchemasCompressionType","DestinationGcsSchemasFormatCodec","DestinationGcsSchemasFormatCompressionType","DestinationGcsSchemasFormatFormatType","DestinationGcsSchemasFormatOutputFormat1Codec","DestinationGcsSchemasFormatOutputFormatCodec","DestinationGcsSchemasFormatOutputFormatFormatType","DestinationGcsSchemasFormatType","DestinationGcsSchemasNoCompression","DestinationGoogleSheets","DestinationGoogleSheetsGoogleSheets","DestinationLangchain","DestinationLangchainFake","DestinationLangchainMode","DestinationLangchainOpenAI","DestinationLangchainPinecone","DestinationLangchainProcessingConfigModel","DestinationLangchainSchemasIndexingIndexing3Mode","DestinationLangchainSchemasIndexingIndexingMode","DestinationLangchainSchemasIndexingMode","DestinationLangchainSchemasMode","DestinationMilvus","DestinationMilvusAPIToken","DestinationMilvusAzureOpenAI","DestinationMilvusByMarkdownHeader","DestinationMilvusByProgrammingLanguage","DestinationMilvusBySeparator","DestinationMilvusCohere","DestinationMilvusFake","DestinationMilvusFieldNameMappingConfigModel","DestinationMilvusIndexing","DestinationMilvusLanguage","DestinationMilvusMode","DestinationMilvusOpenAI","DestinationMilvusOpenAICompatible","DestinationMilvusProcessingConfigModel","DestinationMilvusSchemasEmbeddingEmbedding5Mode","DestinationMilvusSchemasEmbeddingEmbeddingMode","DestinationMilvusSchemasEmbeddingMode","DestinationMilvusSchemasIndexingAuthAuthenticationMode","DestinationMilvusSchemasIndexingAuthMode","DestinationMilvusSchemasIndexingMode","DestinationMilvusSchemasMode","DestinationMilvusSchemasProcessingMode","DestinationMilvusSchemasProcessingTextSplitterMode","DestinationMilvusSchemasProcessingTextSplitterTextSplitterMode","DestinationMilvusUsernamePassword","DestinationMongodb","DestinationMongodbAuthorization","DestinationMongodbInstance","DestinationMongodbNoTunnel","DestinationMongodbPasswordAuthentication","DestinationMongodbSSHKeyAuthentication","DestinationMongodbSchemasAuthorization","DestinationMongodbSchemasInstance","DestinationMongodbSchemasTunnelMethod","DestinationMongodbSchemasTunnelMethodTunnelMethod","DestinationMongodbTunnelMethod","DestinationMssql","DestinationMssqlNoTunnel","DestinationMssqlPasswordAuthentication","DestinationMssqlSSHKeyAuthentication","DestinationMssqlSchemasSslMethod","DestinationMssqlSchemasTunnelMethod","DestinationMssqlSchemasTunnelMethodTunnelMethod","DestinationMssqlSslMethod","DestinationMssqlTunnelMethod","DestinationMysql","DestinationMysqlNoTunnel","DestinationMysqlPasswordAuthentication","DestinationMysqlSSHKeyAuthentication","DestinationMysqlSchemasTunnelMethod","DestinationMysqlSchemasTunnelMethodTunnelMethod","DestinationMysqlTunnelMethod","DestinationOracle","DestinationOracleNoTunnel","DestinationOraclePasswordAuthentication","DestinationOracleSSHKeyAuthentication","DestinationOracleSchemasTunnelMethod","DestinationOracleSchemasTunnelMethodTunnelMethod","DestinationOracleTunnelMethod","DestinationPatchRequest","DestinationPinecone","DestinationPineconeAzureOpenAI","DestinationPineconeByMarkdownHeader","DestinationPineconeByProgrammingLanguage","DestinationPineconeBySeparator","DestinationPineconeCohere","DestinationPineconeFake","DestinationPineconeFieldNameMappingConfigModel","DestinationPineconeIndexing","DestinationPineconeLanguage","DestinationPineconeMode","DestinationPineconeOpenAI","DestinationPineconeOpenAICompatible","DestinationPineconeProcessingConfigModel","DestinationPineconeSchemasEmbeddingEmbedding5Mode","DestinationPineconeSchemasEmbeddingEmbeddingMode","DestinationPineconeSchemasEmbeddingMode","DestinationPineconeSchemasMode","DestinationPineconeSchemasProcessingMode","DestinationPineconeSchemasProcessingTextSplitterMode","DestinationPineconeSchemasProcessingTextSplitterTextSplitterMode","DestinationPostgres","DestinationPostgresMode","DestinationPostgresNoTunnel","DestinationPostgresPasswordAuthentication","DestinationPostgresSSHKeyAuthentication","DestinationPostgresSchemasMode","DestinationPostgresSchemasSSLModeSSLModes6Mode","DestinationPostgresSchemasSSLModeSSLModesMode","DestinationPostgresSchemasSslModeMode","DestinationPostgresSchemasTunnelMethod","DestinationPostgresSchemasTunnelMethodTunnelMethod","DestinationPostgresTunnelMethod","DestinationPubsub","DestinationPutRequest","DestinationQdrant","DestinationQdrantAzureOpenAI","DestinationQdrantByMarkdownHeader","DestinationQdrantByProgrammingLanguage","DestinationQdrantBySeparator","DestinationQdrantCohere","DestinationQdrantFake","DestinationQdrantFieldNameMappingConfigModel","DestinationQdrantIndexing","DestinationQdrantLanguage","DestinationQdrantMode","DestinationQdrantNoAuth","DestinationQdrantOpenAI","DestinationQdrantOpenAICompatible","DestinationQdrantProcessingConfigModel","DestinationQdrantSchemasEmbeddingEmbedding5Mode","DestinationQdrantSchemasEmbeddingEmbeddingMode","DestinationQdrantSchemasEmbeddingMode","DestinationQdrantSchemasIndexingAuthMethodMode","DestinationQdrantSchemasIndexingMode","DestinationQdrantSchemasMode","DestinationQdrantSchemasProcessingMode","DestinationQdrantSchemasProcessingTextSplitterMode","DestinationQdrantSchemasProcessingTextSplitterTextSplitterMode","DestinationRedis","DestinationRedisDisable","DestinationRedisMode","DestinationRedisNoTunnel","DestinationRedisPasswordAuthentication","DestinationRedisSSHKeyAuthentication","DestinationRedisSchemasMode","DestinationRedisSchemasTunnelMethod","DestinationRedisSchemasTunnelMethodTunnelMethod","DestinationRedisTunnelMethod","DestinationRedisVerifyFull","DestinationRedshift","DestinationRedshiftEncryptionType","DestinationRedshiftMethod","DestinationRedshiftNoTunnel","DestinationRedshiftPasswordAuthentication","DestinationRedshiftS3BucketRegion","DestinationRedshiftSSHKeyAuthentication","DestinationRedshiftSchemasMethod","DestinationRedshiftSchemasTunnelMethod","DestinationRedshiftSchemasTunnelMethodTunnelMethod","DestinationRedshiftTunnelMethod","DestinationResponse","DestinationS3","DestinationS3AvroApacheAvro","DestinationS3Bzip2","DestinationS3CSVCommaSeparatedValues","DestinationS3Codec","DestinationS3CompressionType","DestinationS3Deflate","DestinationS3Flattening","DestinationS3FormatType","DestinationS3GZIP","DestinationS3Glue","DestinationS3GlueCompressionType","DestinationS3GlueFormatType","DestinationS3GlueGZIP","DestinationS3GlueJSONLinesNewlineDelimitedJSON","DestinationS3GlueNoCompression","DestinationS3GlueS3BucketRegion","DestinationS3GlueSchemasCompressionType","DestinationS3JSONLinesNewlineDelimitedJSON","DestinationS3NoCompression","DestinationS3ParquetColumnarStorage","DestinationS3S3BucketRegion","DestinationS3SchemasCodec","DestinationS3SchemasCompressionCodec","DestinationS3SchemasCompressionType","DestinationS3SchemasFlattening","DestinationS3SchemasFormatCodec","DestinationS3SchemasFormatCompressionType","DestinationS3SchemasFormatFormatType","DestinationS3SchemasFormatNoCompression","DestinationS3SchemasFormatOutputFormat3Codec","DestinationS3SchemasFormatOutputFormat3CompressionCodecCodec","DestinationS3SchemasFormatOutputFormatCodec","DestinationS3SchemasFormatOutputFormatCompressionType","DestinationS3SchemasFormatOutputFormatFormatType","DestinationS3SchemasFormatType","DestinationS3SchemasGZIP","DestinationS3SchemasNoCompression","DestinationS3Snappy","DestinationS3Xz","DestinationS3Zstandard","DestinationSftpJSON","DestinationSnowflake","DestinationSnowflakeAuthType","DestinationSnowflakeOAuth20","DestinationSnowflakeSchemasAuthType","DestinationSnowflakeSchemasCredentialsAuthType","DestinationSnowflakeSnowflake","DestinationTeradata","DestinationTeradataAllow","DestinationTeradataDisable","DestinationTeradataMode","DestinationTeradataPrefer","DestinationTeradataRequire","DestinationTeradataSchemasMode","DestinationTeradataSchemasSSLModeSSLModes5Mode","DestinationTeradataSchemasSSLModeSSLModes6Mode","DestinationTeradataSchemasSSLModeSSLModesMode","DestinationTeradataSchemasSslModeMode","DestinationTeradataVerifyCa","DestinationTeradataVerifyFull","DestinationTypesense","DestinationVectara","DestinationWeaviate","DestinationWeaviateAPIToken","DestinationWeaviateAzureOpenAI","DestinationWeaviateByMarkdownHeader","DestinationWeaviateByProgrammingLanguage","DestinationWeaviateBySeparator","DestinationWeaviateCohere","DestinationWeaviateFake","DestinationWeaviateFieldNameMappingConfigModel","DestinationWeaviateIndexing","DestinationWeaviateLanguage","DestinationWeaviateMode","DestinationWeaviateOpenAI","DestinationWeaviateOpenAICompatible","DestinationWeaviateProcessingConfigModel","DestinationWeaviateSchemasEmbeddingEmbedding5Mode","DestinationWeaviateSchemasEmbeddingEmbedding6Mode","DestinationWeaviateSchemasEmbeddingEmbedding7Mode","DestinationWeaviateSchemasEmbeddingEmbeddingMode","DestinationWeaviateSchemasEmbeddingMode","DestinationWeaviateSchemasIndexingAuthAuthenticationMode","DestinationWeaviateSchemasIndexingAuthMode","DestinationWeaviateSchemasIndexingMode","DestinationWeaviateSchemasMode","DestinationWeaviateSchemasProcessingMode","DestinationWeaviateSchemasProcessingTextSplitterMode","DestinationWeaviateSchemasProcessingTextSplitterTextSplitterMode","DestinationWeaviateUsernamePassword","DestinationsResponse","DetailType","DetectChangesWithXminSystemColumn","DevNull","Dimension","Disable","Disabled","DistanceMetric","Dixa","DocArrayHnswSearch","Dockerhub","DocumentFileTypeFormatExperimental","DoubleValue","Dremio","Duckdb","DynamoDBRegion","Dynamodb","E2eTestCloud","EUBasedAccount","Elasticsearch","Emailoctopus","Enabled","EncryptedTrustServerCertificate","EncryptedVerifyCertificate","EncryptionAlgorithm","EncryptionMethod","EncryptionType","EngagementWindowDays","Environment","ExchangeRates","Expression","FacebookMarketing","Fake","Faker","Fauna","FieldNameMappingConfigModel","File","FileBasedStreamConfig","FileFormat","FileType","Filter","FilterName","FilterType","Firebolt","Firestore","Flattening","FormatType","FormatTypeWildcard","Freshcaller","Freshdesk","Freshsales","FromCSV","FromField","GCSBucketRegion","GCSGoogleCloudStorage","GCSStaging","GCSTmpFilesAfterwardProcessing","GainsightPx","Gcs","GeographyEnum","GeographyEnumNoDefault","Getlago","Github","GithubCredentials","Gitlab","GitlabCredentials","Glassfrog","GlobalAccount","Gnews","GoogleAds","GoogleAdsCredentials","GoogleAnalyticsDataAPI","GoogleAnalyticsDataAPICredentials","GoogleAnalyticsV4ServiceAccountOnly","GoogleCredentials","GoogleDirectory","GoogleDrive","GoogleDriveCredentials","GooglePagespeedInsights","GoogleSearchConsole","GoogleSheets","GoogleSheetsCredentials","GoogleWebfonts","Granularity","GranularityForGeoLocationRegion","GranularityForPeriodicReports","Greenhouse","Gridly","Gzip","HMACKey","HTTPSPublicWeb","Harvest","HarvestCredentials","Header","HeaderDefinitionType","Hubplanner","Hubspot","HubspotCredentials","IAMRole","IAMUser","In","InListFilter","Indexing","InferenceType","InitiateOauthRequest","InsightConfig","Insightly","Instagram","Instance","Instatus","Int64Value","Intercom","InvalidCDCPositionBehaviorAdvanced","Ip2whois","IssuesStreamExpandWith","Iterable","JSONLinesNewlineDelimitedJSON","Jira","JobCreateRequest","JobResponse","JobStatusEnum","JobTypeEnum","JobsResponse","Jsonl","JsonlFormat","K6Cloud","KeyPairAuthentication","Klarna","Klaviyo","Kyve","LSNCommitBehaviour","Langchain","Language","Launchdarkly","Lemlist","Level","LeverHiring","LeverHiringCredentials","LinkedinAds","LinkedinAdsCredentials","LinkedinPages","Linnworks","Local","LoginPassword","Lokalise","Mailchimp","MailchimpCredentials","Mailgun","MailjetSms","Marketo","Metabase","Method","MicrosoftOnedrive","MicrosoftOnedriveCredentials","MicrosoftSharepoint","MicrosoftSharepointCredentials","MicrosoftTeams","MicrosoftTeamsCredentials","Milvus","Mixpanel","Mode","Monday","MondayCredentials","MongoDBAtlas","MongoDBAtlasReplicaSet","Mongodb","MongodbInternalPoc","MongodbV2","Mssql","MultiSchema","MyHours","Mysql","NamespaceDefinitionEnum","NamespaceDefinitionEnumNoDefault","NativeNetworkEncryptionNNE","Netsuite","NoAuth","NoAuthentication","NoCompression","NoEncryption","NoExternalEmbedding","NoTunnel","NonBreakingSchemaUpdatesBehaviorEnum","NonBreakingSchemaUpdatesBehaviorEnumNoDefault","NoneT","Normalization","NormalizationFlattening","NotExpression","Notion","NotionCredentials","Nullable","NumericFilter","Nytimes","OAuth","OAuth20","OAuth20Credentials","OAuth2AccessToken","OAuth2ConfidentialApplication","OAuthActorNames","OAuthInputConfiguration","OauthAuthentication","Okta","Omnisend","Onesignal","OpenAI","OpenAICompatible","Operator","OptionTitle","OptionsList","OrGroup","Oracle","Orb","Orbit","OriginDatacenterOfTheSurveyMonkeyAccount","OutbrainAmplify","Outreach","Parquet","ParquetColumnarStorage","ParquetFormat","ParsingStrategy","PasswordAuthentication","PaypalTransaction","Paystack","Pendo","PeriodUsedForMostPopularStreams","Persistiq","PersonalAccessToken","PexelsAPI","Pinecone","Pinterest","PinterestCredentials","Pipedrive","PivotCategory","Plugin","Pocket","Pokeapi","PokemonName","PolygonStockAPI","Postgres","Posthog","Postmarkapp","Prefer","Preferred","Prestashop","PrivateApp","PrivateToken","ProcessingConfigModel","ProductCatalog","ProjectSecret","Pubsub","PunkAPI","Pypi","Qdrant","Qualaroo","Quickbooks","Railz","ReadChangesUsingBinaryLogCDC","ReadChangesUsingChangeDataCaptureCDC","ReadChangesUsingWriteAheadLogCDC","Recharge","RecommendedManagedTables","Recreation","Recruitee","Recurly","Redis","Redshift","Region","ReplicaSet","ReportConfig","ReportOptions","ReportRecordTypes","ReportingDataObject","Require","Required","Retently","RetentlyCredentials","RkiCovid","Rss","S3","S3AmazonWebServices","S3BucketRegion","S3Glue","SCPSecureCopyProtocol","SFTPSecureFileTransferProtocol","SSHKeyAuthentication","SSHSecureShell","Salesforce","Salesloft","SandboxAccessToken","SapFieldglass","ScanChangesWithUserDefinedCursor","ScheduleTypeEnum","ScheduleTypeWithBasicEnum","SchemeBasicAuth","SearchCriteria","SearchScope","Secoda","Security","SelfManagedReplicaSet","Sendgrid","Sendinblue","Senseforce","Sentry","SerializationLibrary","ServiceAccount","ServiceAccountKey","ServiceAccountKeyAuthentication","ServiceKeyAuthentication","ServiceName","Sftp","SftpBulk","SftpJSON","ShareTypeUsedForMostPopularSharedStream","Shopify","ShopifyCredentials","Shortio","SignInViaGoogleOAuth","SignInViaSlackOAuth","Silent","SingleSchema","SingleStoreAccessToken","Slack","SlackCredentials","Smaily","Smartengage","Smartsheets","SmartsheetsCredentials","SnapchatMarketing","Snappy","Snowflake","SnowflakeCredentials","SonarCloud","SortBy","SourceAha","SourceAircall","SourceAirtable","SourceAirtableAirtable","SourceAirtableAuthMethod","SourceAirtableOAuth20","SourceAirtableSchemasAuthMethod","SourceAmazonAds","SourceAmazonAdsAmazonAds","SourceAmazonAdsAuthType","SourceAmazonSellerPartner","SourceAmazonSellerPartnerAmazonSellerPartner","SourceAmazonSellerPartnerAuthType","SourceAmazonSqs","SourceAmazonSqsAWSRegion","SourceAmplitude","SourceApifyDataset","SourceAppfollow","SourceAsana","SourceAsanaAsana","SourceAsanaCredentialsTitle","SourceAsanaSchemasCredentialsTitle","SourceAuth0","SourceAuth0SchemasAuthenticationMethod","SourceAuth0SchemasCredentialsAuthenticationMethod","SourceAwsCloudtrail","SourceAzureBlobStorage","SourceAzureBlobStorageAzureBlobStorage","SourceAzureBlobStorageFiletype","SourceAzureBlobStorageHeaderDefinitionType","SourceAzureBlobStorageMode","SourceAzureBlobStorageSchemasFiletype","SourceAzureBlobStorageSchemasHeaderDefinitionType","SourceAzureBlobStorageSchemasStreamsFiletype","SourceAzureBlobStorageSchemasStreamsFormatFiletype","SourceAzureBlobStorageSchemasStreamsFormatFormatFiletype","SourceAzureTable","SourceBambooHr","SourceBigquery","SourceBigqueryBigquery","SourceBingAds","SourceBingAdsBingAds","SourceBraintree","SourceBraintreeEnvironment","SourceBraze","SourceCart","SourceCartAuthType","SourceCartSchemasAuthType","SourceChargebee","SourceChartmogul","SourceClickhouse","SourceClickhouseClickhouse","SourceClickhouseNoTunnel","SourceClickhousePasswordAuthentication","SourceClickhouseSSHKeyAuthentication","SourceClickhouseSchemasTunnelMethod","SourceClickhouseSchemasTunnelMethodTunnelMethod","SourceClickhouseTunnelMethod","SourceClickupAPI","SourceClockify","SourceCloseCom","SourceCoda","SourceCoinAPI","SourceCoinmarketcap","SourceConfigcat","SourceConfluence","SourceConvex","SourceConvexConvex","SourceCreateRequest","SourceDatascope","SourceDelighted","SourceDixa","SourceDockerhub","SourceDremio","SourceDynamodb","SourceDynamodbDynamodb","SourceDynamodbDynamodbRegion","SourceE2eTestCloudSchemasType","SourceE2eTestCloudType","SourceEmailoctopus","SourceExchangeRates","SourceFacebookMarketing","SourceFacebookMarketingActionReportTime","SourceFacebookMarketingFacebookMarketing","SourceFacebookMarketingValidEnums","SourceFaker","SourceFauna","SourceFaunaDeletionMode","SourceFaunaSchemasDeletionMode","SourceFile","SourceFileS3AmazonWebServices","SourceFileSchemasProviderStorage","SourceFileSchemasProviderStorageProvider6Storage","SourceFileSchemasProviderStorageProvider7Storage","SourceFileSchemasProviderStorageProviderStorage","SourceFileSchemasStorage","SourceFileStorage","SourceFirebolt","SourceFreshcaller","SourceFreshdesk","SourceFreshsales","SourceGCSStreamConfig","SourceGainsightPx","SourceGcs","SourceGcsAutogenerated","SourceGcsCSVFormat","SourceGcsFiletype","SourceGcsFromCSV","SourceGcsGcs","SourceGcsHeaderDefinitionType","SourceGcsInferenceType","SourceGcsSchemasHeaderDefinitionType","SourceGcsSchemasStreamsHeaderDefinitionType","SourceGcsUserProvided","SourceGcsValidationPolicy","SourceGetlago","SourceGithub","SourceGithubGithub","SourceGithubOptionTitle","SourceGithubPersonalAccessToken","SourceGitlab","SourceGitlabAuthType","SourceGitlabGitlab","SourceGitlabOAuth20","SourceGitlabSchemasAuthType","SourceGlassfrog","SourceGnews","SourceGoogleAds","SourceGoogleAdsGoogleAds","SourceGoogleAnalyticsDataAPI","SourceGoogleAnalyticsDataAPIAndGroup","SourceGoogleAnalyticsDataAPIAuthType","SourceGoogleAnalyticsDataAPIBetweenFilter","SourceGoogleAnalyticsDataAPICustomReportConfig","SourceGoogleAnalyticsDataAPIDisabled","SourceGoogleAnalyticsDataAPIDoubleValue","SourceGoogleAnalyticsDataAPIEnabled","SourceGoogleAnalyticsDataAPIExpression","SourceGoogleAnalyticsDataAPIFilter","SourceGoogleAnalyticsDataAPIFilterName","SourceGoogleAnalyticsDataAPIFilterType","SourceGoogleAnalyticsDataAPIGoogleAnalyticsDataAPI","SourceGoogleAnalyticsDataAPIGranularity","SourceGoogleAnalyticsDataAPIInListFilter","SourceGoogleAnalyticsDataAPIInt64Value","SourceGoogleAnalyticsDataAPINotExpression","SourceGoogleAnalyticsDataAPINumericFilter","SourceGoogleAnalyticsDataAPIOrGroup","SourceGoogleAnalyticsDataAPISchemasAuthType","SourceGoogleAnalyticsDataAPISchemasBetweenFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayBetweenFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterBetweenFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1DoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterFilter4ToValueValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterFilter4ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1FilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1Int64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2DoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsFilterFilter4ToValueValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsFilterFilter4ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsFilterFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2FilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2Int64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3DoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterFilter4ToValueValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterFilter4ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3FilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3Int64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterInListFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterNumericFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterStringFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayEnabled","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayExpression","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayFilterType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayInListFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterBetweenFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterExpression","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterFilterType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterInListFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1DoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilter3ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilter3ValueValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1FilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1Int64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2DoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterFilter4ToValueValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterFilter4ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2FilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2Int64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3BetweenFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3DoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterFilter4ToValueValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterFilter4ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3FilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3FilterType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3InListFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3Int64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3NumericFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3StringFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterFilter4ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4ValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterBetweenFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterDoubleValue","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterExpression","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFilterName","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFilterType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterInListFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterInt64Value","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterNumericFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterStringFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterNumericFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterStringFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterValueType","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayNumericFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayStringFilter","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayValidEnums","SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayValueType","SourceGoogleAnalyticsDataAPISchemasDoubleValue","SourceGoogleAnalyticsDataAPISchemasEnabled","SourceGoogleAnalyticsDataAPISchemasExpression","SourceGoogleAnalyticsDataAPISchemasFilterName","SourceGoogleAnalyticsDataAPISchemasFilterType","SourceGoogleAnalyticsDataAPISchemasInListFilter","SourceGoogleAnalyticsDataAPISchemasInt64Value","SourceGoogleAnalyticsDataAPISchemasNumericFilter","SourceGoogleAnalyticsDataAPISchemasStringFilter","SourceGoogleAnalyticsDataAPISchemasValidEnums","SourceGoogleAnalyticsDataAPISchemasValueType","SourceGoogleAnalyticsDataAPIStringFilter","SourceGoogleAnalyticsDataAPIValidEnums","SourceGoogleAnalyticsDataAPIValueType","SourceGoogleAnalyticsV4ServiceAccountOnly","SourceGoogleAnalyticsV4ServiceAccountOnlyAuthType","SourceGoogleAnalyticsV4ServiceAccountOnlyServiceAccountKeyAuthentication","SourceGoogleDirectory","SourceGoogleDirectoryCredentialsTitle","SourceGoogleDirectorySchemasCredentialsTitle","SourceGoogleDrive","SourceGoogleDriveAuthType","SourceGoogleDriveAuthenticateViaGoogleOAuth","SourceGoogleDriveAutogenerated","SourceGoogleDriveAvroFormat","SourceGoogleDriveCSVFormat","SourceGoogleDriveDocumentFileTypeFormatExperimental","SourceGoogleDriveFileBasedStreamConfig","SourceGoogleDriveFiletype","SourceGoogleDriveFromCSV","SourceGoogleDriveGoogleDrive","SourceGoogleDriveHeaderDefinitionType","SourceGoogleDriveJsonlFormat","SourceGoogleDriveLocal","SourceGoogleDriveMode","SourceGoogleDriveParquetFormat","SourceGoogleDriveParsingStrategy","SourceGoogleDriveSchemasAuthType","SourceGoogleDriveSchemasFiletype","SourceGoogleDriveSchemasHeaderDefinitionType","SourceGoogleDriveSchemasStreamsFiletype","SourceGoogleDriveSchemasStreamsFormatFiletype","SourceGoogleDriveSchemasStreamsFormatFormatFiletype","SourceGoogleDriveSchemasStreamsHeaderDefinitionType","SourceGoogleDriveServiceAccountKeyAuthentication","SourceGoogleDriveUserProvided","SourceGoogleDriveValidationPolicy","SourceGooglePagespeedInsights","SourceGoogleSearchConsole","SourceGoogleSearchConsoleAuthType","SourceGoogleSearchConsoleCustomReportConfig","SourceGoogleSearchConsoleGoogleSearchConsole","SourceGoogleSearchConsoleOAuth","SourceGoogleSearchConsoleSchemasAuthType","SourceGoogleSearchConsoleServiceAccountKeyAuthentication","SourceGoogleSearchConsoleValidEnums","SourceGoogleSheets","SourceGoogleSheetsAuthType","SourceGoogleSheetsAuthenticateViaGoogleOAuth","SourceGoogleSheetsGoogleSheets","SourceGoogleSheetsSchemasAuthType","SourceGoogleSheetsServiceAccountKeyAuthentication","SourceGoogleWebfonts","SourceGreenhouse","SourceGridly","SourceHarvest","SourceHarvestAuthType","SourceHarvestAuthenticateWithPersonalAccessToken","SourceHarvestHarvest","SourceHarvestSchemasAuthType","SourceHubplanner","SourceHubspot","SourceHubspotAuthType","SourceHubspotHubspot","SourceHubspotOAuth","SourceHubspotSchemasAuthType","SourceInsightly","SourceInstagram","SourceInstagramInstagram","SourceInstatus","SourceIntercom","SourceIntercomIntercom","SourceIp2whois","SourceIterable","SourceJira","SourceK6Cloud","SourceKlarna","SourceKlarnaRegion","SourceKlaviyo","SourceKyve","SourceLaunchdarkly","SourceLemlist","SourceLeverHiring","SourceLeverHiringAuthType","SourceLeverHiringEnvironment","SourceLeverHiringLeverHiring","SourceLeverHiringSchemasAuthType","SourceLinkedinAds","SourceLinkedinAdsAuthMethod","SourceLinkedinAdsLinkedinAds","SourceLinkedinAdsOAuth20","SourceLinkedinAdsSchemasAuthMethod","SourceLinkedinPages","SourceLinkedinPagesAccessToken","SourceLinkedinPagesAuthMethod","SourceLinkedinPagesOAuth20","SourceLinkedinPagesSchemasAuthMethod","SourceLinnworks","SourceLokalise","SourceMailchimp","SourceMailchimpAuthType","SourceMailchimpMailchimp","SourceMailchimpOAuth20","SourceMailchimpSchemasAuthType","SourceMailgun","SourceMailjetSms","SourceMarketo","SourceMetabase","SourceMicrosoftOnedrive","SourceMicrosoftOnedriveAuthType","SourceMicrosoftOnedriveAutogenerated","SourceMicrosoftOnedriveAvroFormat","SourceMicrosoftOnedriveCSVFormat","SourceMicrosoftOnedriveDocumentFileTypeFormatExperimental","SourceMicrosoftOnedriveFileBasedStreamConfig","SourceMicrosoftOnedriveFiletype","SourceMicrosoftOnedriveFromCSV","SourceMicrosoftOnedriveHeaderDefinitionType","SourceMicrosoftOnedriveJsonlFormat","SourceMicrosoftOnedriveLocal","SourceMicrosoftOnedriveMicrosoftOnedrive","SourceMicrosoftOnedriveMode","SourceMicrosoftOnedriveParquetFormat","SourceMicrosoftOnedriveParsingStrategy","SourceMicrosoftOnedriveSchemasAuthType","SourceMicrosoftOnedriveSchemasFiletype","SourceMicrosoftOnedriveSchemasHeaderDefinitionType","SourceMicrosoftOnedriveSchemasStreamsFiletype","SourceMicrosoftOnedriveSchemasStreamsFormatFiletype","SourceMicrosoftOnedriveSchemasStreamsFormatFormatFiletype","SourceMicrosoftOnedriveSchemasStreamsHeaderDefinitionType","SourceMicrosoftOnedriveUserProvided","SourceMicrosoftOnedriveValidationPolicy","SourceMicrosoftSharepoint","SourceMicrosoftSharepointAuthType","SourceMicrosoftSharepointAuthenticateViaMicrosoftOAuth","SourceMicrosoftSharepointAutogenerated","SourceMicrosoftSharepointAvroFormat","SourceMicrosoftSharepointCSVFormat","SourceMicrosoftSharepointDocumentFileTypeFormatExperimental","SourceMicrosoftSharepointFileBasedStreamConfig","SourceMicrosoftSharepointFiletype","SourceMicrosoftSharepointFromCSV","SourceMicrosoftSharepointHeaderDefinitionType","SourceMicrosoftSharepointJsonlFormat","SourceMicrosoftSharepointLocal","SourceMicrosoftSharepointMicrosoftSharepoint","SourceMicrosoftSharepointMode","SourceMicrosoftSharepointParquetFormat","SourceMicrosoftSharepointParsingStrategy","SourceMicrosoftSharepointSchemasAuthType","SourceMicrosoftSharepointSchemasFiletype","SourceMicrosoftSharepointSchemasHeaderDefinitionType","SourceMicrosoftSharepointSchemasStreamsFiletype","SourceMicrosoftSharepointSchemasStreamsFormatFiletype","SourceMicrosoftSharepointSchemasStreamsFormatFormatFiletype","SourceMicrosoftSharepointSchemasStreamsHeaderDefinitionType","SourceMicrosoftSharepointSearchScope","SourceMicrosoftSharepointServiceKeyAuthentication","SourceMicrosoftSharepointUserProvided","SourceMicrosoftSharepointValidationPolicy","SourceMicrosoftTeams","SourceMicrosoftTeamsAuthType","SourceMicrosoftTeamsMicrosoftTeams","SourceMicrosoftTeamsSchemasAuthType","SourceMixpanel","SourceMixpanelOptionTitle","SourceMixpanelRegion","SourceMixpanelSchemasOptionTitle","SourceMonday","SourceMondayAuthType","SourceMondayMonday","SourceMondayOAuth20","SourceMondaySchemasAuthType","SourceMongodbInternalPoc","SourceMongodbV2","SourceMongodbV2ClusterType","SourceMongodbV2SchemasClusterType","SourceMssql","SourceMssqlEncryptedTrustServerCertificate","SourceMssqlEncryptedVerifyCertificate","SourceMssqlInvalidCDCPositionBehaviorAdvanced","SourceMssqlMethod","SourceMssqlMssql","SourceMssqlNoTunnel","SourceMssqlPasswordAuthentication","SourceMssqlSSHKeyAuthentication","SourceMssqlSchemasMethod","SourceMssqlSchemasSSLMethodSSLMethodSSLMethod","SourceMssqlSchemasSslMethod","SourceMssqlSchemasSslMethodSslMethod","SourceMssqlSchemasTunnelMethod","SourceMssqlSchemasTunnelMethodTunnelMethod","SourceMssqlTunnelMethod","SourceMyHours","SourceMysql","SourceMysqlInvalidCDCPositionBehaviorAdvanced","SourceMysqlMethod","SourceMysqlMode","SourceMysqlMysql","SourceMysqlNoTunnel","SourceMysqlPasswordAuthentication","SourceMysqlSSHKeyAuthentication","SourceMysqlScanChangesWithUserDefinedCursor","SourceMysqlSchemasMethod","SourceMysqlSchemasMode","SourceMysqlSchemasSSLModeSSLModesMode","SourceMysqlSchemasSslModeMode","SourceMysqlSchemasTunnelMethod","SourceMysqlSchemasTunnelMethodTunnelMethod","SourceMysqlTunnelMethod","SourceMysqlVerifyCA","SourceNetsuite","SourceNotion","SourceNotionAccessToken","SourceNotionAuthType","SourceNotionNotion","SourceNotionOAuth20","SourceNotionSchemasAuthType","SourceNytimes","SourceOkta","SourceOktaAPIToken","SourceOktaAuthType","SourceOktaOAuth20","SourceOktaSchemasAuthType","SourceOmnisend","SourceOnesignal","SourceOracle","SourceOracleConnectionType","SourceOracleEncryptionMethod","SourceOracleNoTunnel","SourceOracleOracle","SourceOraclePasswordAuthentication","SourceOracleSSHKeyAuthentication","SourceOracleSchemasTunnelMethod","SourceOracleSchemasTunnelMethodTunnelMethod","SourceOracleTunnelMethod","SourceOrb","SourceOrbit","SourceOutbrainAmplify","SourceOutbrainAmplifyAccessToken","SourceOutbrainAmplifyUsernamePassword","SourceOutreach","SourcePatchRequest","SourcePaypalTransaction","SourcePaystack","SourcePendo","SourcePersistiq","SourcePexelsAPI","SourcePinterest","SourcePinterestAuthMethod","SourcePinterestLevel","SourcePinterestPinterest","SourcePinterestSchemasValidEnums","SourcePinterestValidEnums","SourcePipedrive","SourcePocket","SourcePocketSortBy","SourcePokeapi","SourcePolygonStockAPI","SourcePostgres","SourcePostgresAllow","SourcePostgresDisable","SourcePostgresInvalidCDCPositionBehaviorAdvanced","SourcePostgresMethod","SourcePostgresMode","SourcePostgresNoTunnel","SourcePostgresPasswordAuthentication","SourcePostgresPostgres","SourcePostgresPrefer","SourcePostgresRequire","SourcePostgresSSHKeyAuthentication","SourcePostgresScanChangesWithUserDefinedCursor","SourcePostgresSchemasMethod","SourcePostgresSchemasMode","SourcePostgresSchemasReplicationMethodMethod","SourcePostgresSchemasSSLModeSSLModes5Mode","SourcePostgresSchemasSSLModeSSLModes6Mode","SourcePostgresSchemasSSLModeSSLModesMode","SourcePostgresSchemasSslModeMode","SourcePostgresSchemasTunnelMethod","SourcePostgresSchemasTunnelMethodTunnelMethod","SourcePostgresTunnelMethod","SourcePostgresVerifyCa","SourcePostgresVerifyFull","SourcePosthog","SourcePostmarkapp","SourcePrestashop","SourcePunkAPI","SourcePutRequest","SourcePypi","SourceQualaroo","SourceQuickbooks","SourceQuickbooksAuthType","SourceQuickbooksOAuth20","SourceRailz","SourceRecharge","SourceRecreation","SourceRecruitee","SourceRecurly","SourceRedshift","SourceRedshiftRedshift","SourceResponse","SourceRetently","SourceRetentlyAuthType","SourceRetentlyRetently","SourceRetentlySchemasAuthType","SourceRkiCovid","SourceRss","SourceS3","SourceS3Autogenerated","SourceS3AvroFormat","SourceS3CSVFormat","SourceS3DocumentFileTypeFormatExperimental","SourceS3FileBasedStreamConfig","SourceS3Filetype","SourceS3FromCSV","SourceS3HeaderDefinitionType","SourceS3InferenceType","SourceS3JsonlFormat","SourceS3Local","SourceS3Mode","SourceS3ParquetFormat","SourceS3ParsingStrategy","SourceS3S3","SourceS3SchemasFiletype","SourceS3SchemasFormatFileFormatFiletype","SourceS3SchemasFormatFiletype","SourceS3SchemasHeaderDefinitionType","SourceS3SchemasStreamsFiletype","SourceS3SchemasStreamsFormatFiletype","SourceS3SchemasStreamsFormatFormat4Filetype","SourceS3SchemasStreamsFormatFormat5Filetype","SourceS3SchemasStreamsFormatFormatFiletype","SourceS3SchemasStreamsHeaderDefinitionType","SourceS3UserProvided","SourceS3ValidationPolicy","SourceSalesforce","SourceSalesforceSalesforce","SourceSalesloft","SourceSalesloftAuthType","SourceSalesloftSchemasAuthType","SourceSapFieldglass","SourceSecoda","SourceSendgrid","SourceSendinblue","SourceSenseforce","SourceSentry","SourceSftp","SourceSftpAuthMethod","SourceSftpBulk","SourceSftpPasswordAuthentication","SourceSftpSSHKeyAuthentication","SourceSftpSchemasAuthMethod","SourceShopify","SourceShopifyAuthMethod","SourceShopifyOAuth20","SourceShopifySchemasAuthMethod","SourceShopifyShopify","SourceShortio","SourceSlack","SourceSlackAPIToken","SourceSlackOptionTitle","SourceSlackSchemasOptionTitle","SourceSlackSlack","SourceSmaily","SourceSmartengage","SourceSmartsheets","SourceSmartsheetsAuthType","SourceSmartsheetsOAuth20","SourceSmartsheetsSchemasAuthType","SourceSmartsheetsSmartsheets","SourceSnapchatMarketing","SourceSnapchatMarketingSnapchatMarketing","SourceSnowflake","SourceSnowflakeAuthType","SourceSnowflakeOAuth20","SourceSnowflakeSchemasAuthType","SourceSnowflakeSnowflake","SourceSnowflakeUsernameAndPassword","SourceSonarCloud","SourceSpacexAPI","SourceSquare","SourceSquareAPIKey","SourceSquareAuthType","SourceSquareSchemasAuthType","SourceSquareSquare","SourceStrava","SourceStravaAuthType","SourceStravaStrava","SourceStripe","SourceSurveySparrow","SourceSurveySparrowURLBase","SourceSurveymonkey","SourceSurveymonkeyAuthMethod","SourceSurveymonkeySurveymonkey","SourceTempo","SourceTheGuardianAPI","SourceTiktokMarketing","SourceTiktokMarketingAuthType","SourceTiktokMarketingOAuth20","SourceTiktokMarketingSchemasAuthType","SourceTiktokMarketingTiktokMarketing","SourceTrello","SourceTrustpilot","SourceTrustpilotAPIKey","SourceTrustpilotAuthType","SourceTrustpilotOAuth20","SourceTrustpilotSchemasAuthType","SourceTvmazeSchedule","SourceTwilio","SourceTwilioTaskrouter","SourceTwitter","SourceTypeform","SourceTypeformAuthType","SourceTypeformOAuth20","SourceTypeformPrivateToken","SourceTypeformSchemasAuthType","SourceTypeformTypeform","SourceUsCensus","SourceVantage","SourceWebflow","SourceWhiskyHunter","SourceWikipediaPageviews","SourceWoocommerce","SourceXkcd","SourceYandexMetrica","SourceYotpo","SourceYoutubeAnalytics","SourceYoutubeAnalyticsYoutubeAnalytics","SourceZendeskChat","SourceZendeskChatAccessToken","SourceZendeskChatCredentials","SourceZendeskChatOAuth20","SourceZendeskChatSchemasCredentials","SourceZendeskChatZendeskChat","SourceZendeskSell","SourceZendeskSunshine","SourceZendeskSunshineAPIToken","SourceZendeskSunshineAuthMethod","SourceZendeskSunshineOAuth20","SourceZendeskSunshineSchemasAuthMethod","SourceZendeskSunshineZendeskSunshine","SourceZendeskSupport","SourceZendeskSupportAPIToken","SourceZendeskSupportCredentials","SourceZendeskSupportOAuth20","SourceZendeskSupportSchemasCredentials","SourceZendeskSupportZendeskSupport","SourceZendeskTalk","SourceZendeskTalkAPIToken","SourceZendeskTalkAuthType","SourceZendeskTalkOAuth20","SourceZendeskTalkSchemasAuthType","SourceZendeskTalkZendeskTalk","SourceZenloop","SourceZohoCrm","SourceZohoCrmEnvironment","SourceZoom","SourcesResponse","SpacexAPI","Square","SquareCredentials","StandaloneMongoDbInstance","Standard","StandardInserts","State","StateFilter","Status","Storage","Strategies","Strava","StreamConfiguration","StreamConfigurations","StreamName","StreamProperties","StreamPropertiesResponse","StreamsCriteria","StringFilter","Stripe","SurveyMonkeyAuthorizationMethod","SurveySparrow","Surveymonkey","SurveymonkeyCredentials","SwipeUpAttributionWindow","SystemIDSID","TLSEncryptedVerifyCertificate","Tempo","Teradata","TestDestinationType","TheGuardianAPI","TiktokMarketing","TiktokMarketingCredentials","TimeGranularity","TopHeadlinesTopic","TransformationQueryRunType","Trello","Trustpilot","TunnelMethod","TvmazeSchedule","Twilio","TwilioTaskrouter","Twitter","Type","Typeform","TypeformCredentials","Typesense","URLBase","Unencrypted","UnexpectedFieldBehavior","UsCensus","UserProvided","UsernameAndPassword","UsernamePassword","ValidActionBreakdowns","ValidAdSetStatuses","ValidAdStatuses","ValidBreakdowns","ValidCampaignStatuses","ValidationPolicy","Validenums","ValueType","Vantage","Vectara","VerifyCa","VerifyFull","VerifyIdentity","ViewAttributionWindow","ViewWindowDays","Weaviate","Webflow","WhiskyHunter","WikipediaPageviews","Woocommerce","WorkspaceCreateRequest","WorkspaceOAuthCredentialsRequest","WorkspaceResponse","WorkspaceUpdateRequest","WorkspacesResponse","Xkcd","Xz","YandexMetrica","Yotpo","YoutubeAnalytics","YoutubeAnalyticsCredentials","ZendeskChat","ZendeskChatCredentials","ZendeskSell","ZendeskSunshine","ZendeskSunshineCredentials","ZendeskSupport","ZendeskSupportCredentials","ZendeskTalk","ZendeskTalkCredentials","Zenloop","ZohoCRMEdition","ZohoCrm","Zoom","Zstandard"] diff --git a/src/airbyte/models/shared/actortypeenum.py b/src/airbyte_api/models/actortypeenum.py similarity index 100% rename from src/airbyte/models/shared/actortypeenum.py rename to src/airbyte_api/models/actortypeenum.py diff --git a/src/airbyte/models/shared/airtable.py b/src/airbyte_api/models/airtable.py similarity index 97% rename from src/airbyte/models/shared/airtable.py rename to src/airbyte_api/models/airtable.py index 5617e818..6abef9d6 100644 --- a/src/airbyte/models/shared/airtable.py +++ b/src/airbyte_api/models/airtable.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/amazon_ads.py b/src/airbyte_api/models/amazon_ads.py similarity index 97% rename from src/airbyte/models/shared/amazon_ads.py rename to src/airbyte_api/models/amazon_ads.py index b8ff24b8..9326e63b 100644 --- a/src/airbyte/models/shared/amazon_ads.py +++ b/src/airbyte_api/models/amazon_ads.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/amazon_seller_partner.py b/src/airbyte_api/models/amazon_seller_partner.py similarity index 96% rename from src/airbyte/models/shared/amazon_seller_partner.py rename to src/airbyte_api/models/amazon_seller_partner.py index 6397acf4..3f5e7be2 100644 --- a/src/airbyte/models/shared/amazon_seller_partner.py +++ b/src/airbyte_api/models/amazon_seller_partner.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/asana.py b/src/airbyte_api/models/asana.py similarity index 96% rename from src/airbyte/models/shared/asana.py rename to src/airbyte_api/models/asana.py index a1a26c67..f7bef222 100644 --- a/src/airbyte/models/shared/asana.py +++ b/src/airbyte_api/models/asana.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/bing_ads.py b/src/airbyte_api/models/bing_ads.py similarity index 96% rename from src/airbyte/models/shared/bing_ads.py rename to src/airbyte_api/models/bing_ads.py index fbfefc9f..d49b07d1 100644 --- a/src/airbyte/models/shared/bing_ads.py +++ b/src/airbyte_api/models/bing_ads.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/connectioncreaterequest.py b/src/airbyte_api/models/connectioncreaterequest.py similarity index 99% rename from src/airbyte/models/shared/connectioncreaterequest.py rename to src/airbyte_api/models/connectioncreaterequest.py index 62adbdb9..498e5cad 100644 --- a/src/airbyte/models/shared/connectioncreaterequest.py +++ b/src/airbyte_api/models/connectioncreaterequest.py @@ -8,7 +8,7 @@ from .namespacedefinitionenum import NamespaceDefinitionEnum from .nonbreakingschemaupdatesbehaviorenum import NonBreakingSchemaUpdatesBehaviorEnum from .streamconfigurations import StreamConfigurations -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/connectionpatchrequest.py b/src/airbyte_api/models/connectionpatchrequest.py similarity index 99% rename from src/airbyte/models/shared/connectionpatchrequest.py rename to src/airbyte_api/models/connectionpatchrequest.py index 0cd4b8d1..64c24eae 100644 --- a/src/airbyte/models/shared/connectionpatchrequest.py +++ b/src/airbyte_api/models/connectionpatchrequest.py @@ -8,7 +8,7 @@ from .namespacedefinitionenumnodefault import NamespaceDefinitionEnumNoDefault from .nonbreakingschemaupdatesbehaviorenumnodefault import NonBreakingSchemaUpdatesBehaviorEnumNoDefault from .streamconfigurations import StreamConfigurations -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/connectionresponse.py b/src/airbyte_api/models/connectionresponse.py similarity index 99% rename from src/airbyte/models/shared/connectionresponse.py rename to src/airbyte_api/models/connectionresponse.py index a4f27b2b..3122e4ba 100644 --- a/src/airbyte/models/shared/connectionresponse.py +++ b/src/airbyte_api/models/connectionresponse.py @@ -8,7 +8,7 @@ from .namespacedefinitionenum import NamespaceDefinitionEnum from .nonbreakingschemaupdatesbehaviorenum import NonBreakingSchemaUpdatesBehaviorEnum from .streamconfigurations import StreamConfigurations -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/connectionschedule.py b/src/airbyte_api/models/connectionschedule.py similarity index 96% rename from src/airbyte/models/shared/connectionschedule.py rename to src/airbyte_api/models/connectionschedule.py index bbc1a11b..78751b0b 100644 --- a/src/airbyte/models/shared/connectionschedule.py +++ b/src/airbyte_api/models/connectionschedule.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses from .scheduletypeenum import ScheduleTypeEnum -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/connectionscheduleresponse.py b/src/airbyte_api/models/connectionscheduleresponse.py similarity index 97% rename from src/airbyte/models/shared/connectionscheduleresponse.py rename to src/airbyte_api/models/connectionscheduleresponse.py index 8948bb44..7b8b2b54 100644 --- a/src/airbyte/models/shared/connectionscheduleresponse.py +++ b/src/airbyte_api/models/connectionscheduleresponse.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses from .scheduletypewithbasicenum import ScheduleTypeWithBasicEnum -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/connectionsresponse.py b/src/airbyte_api/models/connectionsresponse.py similarity index 96% rename from src/airbyte/models/shared/connectionsresponse.py rename to src/airbyte_api/models/connectionsresponse.py index 5103b11c..39b61e98 100644 --- a/src/airbyte/models/shared/connectionsresponse.py +++ b/src/airbyte_api/models/connectionsresponse.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses from .connectionresponse import ConnectionResponse -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional diff --git a/src/airbyte/models/shared/connectionstatusenum.py b/src/airbyte_api/models/connectionstatusenum.py similarity index 100% rename from src/airbyte/models/shared/connectionstatusenum.py rename to src/airbyte_api/models/connectionstatusenum.py diff --git a/src/airbyte/models/shared/connectionsyncmodeenum.py b/src/airbyte_api/models/connectionsyncmodeenum.py similarity index 100% rename from src/airbyte/models/shared/connectionsyncmodeenum.py rename to src/airbyte_api/models/connectionsyncmodeenum.py diff --git a/src/airbyte/models/shared/destination_astra.py b/src/airbyte_api/models/destination_astra.py similarity index 99% rename from src/airbyte/models/shared/destination_astra.py rename to src/airbyte_api/models/destination_astra.py index 43814913..3ccaf106 100644 --- a/src/airbyte/models/shared/destination_astra.py +++ b/src/airbyte_api/models/destination_astra.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, List, Optional, Union diff --git a/src/airbyte/models/shared/destination_aws_datalake.py b/src/airbyte_api/models/destination_aws_datalake.py similarity index 99% rename from src/airbyte/models/shared/destination_aws_datalake.py rename to src/airbyte_api/models/destination_aws_datalake.py index 095771af..e6dcb5d3 100644 --- a/src/airbyte/models/shared/destination_aws_datalake.py +++ b/src/airbyte_api/models/destination_aws_datalake.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/destination_azure_blob_storage.py b/src/airbyte_api/models/destination_azure_blob_storage.py similarity index 99% rename from src/airbyte/models/shared/destination_azure_blob_storage.py rename to src/airbyte_api/models/destination_azure_blob_storage.py index 7a5b8e5a..0e64f88d 100644 --- a/src/airbyte/models/shared/destination_azure_blob_storage.py +++ b/src/airbyte_api/models/destination_azure_blob_storage.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/destination_bigquery.py b/src/airbyte_api/models/destination_bigquery.py similarity index 99% rename from src/airbyte/models/shared/destination_bigquery.py rename to src/airbyte_api/models/destination_bigquery.py index 107a951d..230855b0 100644 --- a/src/airbyte/models/shared/destination_bigquery.py +++ b/src/airbyte_api/models/destination_bigquery.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/destination_clickhouse.py b/src/airbyte_api/models/destination_clickhouse.py similarity index 95% rename from src/airbyte/models/shared/destination_clickhouse.py rename to src/airbyte_api/models/destination_clickhouse.py index 355c0514..d55882e7 100644 --- a/src/airbyte/models/shared/destination_clickhouse.py +++ b/src/airbyte_api/models/destination_clickhouse.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union @@ -82,6 +82,8 @@ class DestinationClickhouse: r"""Password associated with the 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"""HTTP port of the database.""" + raw_data_schema: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('raw_data_schema'), 'exclude': lambda f: f is None }}) + r"""The schema to write raw tables into (default: airbyte_internal)""" tunnel_method: Optional[Union[NoTunnel, SSHKeyAuthentication, PasswordAuthentication]] = 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/destination_convex.py b/src/airbyte_api/models/destination_convex.py similarity index 96% rename from src/airbyte/models/shared/destination_convex.py rename to src/airbyte_api/models/destination_convex.py index d49a5029..324b9090 100644 --- a/src/airbyte/models/shared/destination_convex.py +++ b/src/airbyte_api/models/destination_convex.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/destination_databricks.py b/src/airbyte_api/models/destination_databricks.py similarity index 99% rename from src/airbyte/models/shared/destination_databricks.py rename to src/airbyte_api/models/destination_databricks.py index 587d44e2..9afb83ee 100644 --- a/src/airbyte/models/shared/destination_databricks.py +++ b/src/airbyte_api/models/destination_databricks.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/destination_dev_null.py b/src/airbyte_api/models/destination_dev_null.py similarity index 97% rename from src/airbyte/models/shared/destination_dev_null.py rename to src/airbyte_api/models/destination_dev_null.py index 0bc1af45..968a150e 100644 --- a/src/airbyte/models/shared/destination_dev_null.py +++ b/src/airbyte_api/models/destination_dev_null.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/destination_duckdb.py b/src/airbyte_api/models/destination_duckdb.py similarity index 97% rename from src/airbyte/models/shared/destination_duckdb.py rename to src/airbyte_api/models/destination_duckdb.py index dfe48afb..1c0ef533 100644 --- a/src/airbyte/models/shared/destination_duckdb.py +++ b/src/airbyte_api/models/destination_duckdb.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/destination_dynamodb.py b/src/airbyte_api/models/destination_dynamodb.py similarity index 98% rename from src/airbyte/models/shared/destination_dynamodb.py rename to src/airbyte_api/models/destination_dynamodb.py index a5985926..9f519104 100644 --- a/src/airbyte/models/shared/destination_dynamodb.py +++ b/src/airbyte_api/models/destination_dynamodb.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/destination_elasticsearch.py b/src/airbyte_api/models/destination_elasticsearch.py similarity index 99% rename from src/airbyte/models/shared/destination_elasticsearch.py rename to src/airbyte_api/models/destination_elasticsearch.py index 8603e70d..3ffaa4a6 100644 --- a/src/airbyte/models/shared/destination_elasticsearch.py +++ b/src/airbyte_api/models/destination_elasticsearch.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/destination_firestore.py b/src/airbyte_api/models/destination_firestore.py similarity index 97% rename from src/airbyte/models/shared/destination_firestore.py rename to src/airbyte_api/models/destination_firestore.py index b45f7dcf..1e8b5601 100644 --- a/src/airbyte/models/shared/destination_firestore.py +++ b/src/airbyte_api/models/destination_firestore.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/destination_gcs.py b/src/airbyte_api/models/destination_gcs.py similarity index 99% rename from src/airbyte/models/shared/destination_gcs.py rename to src/airbyte_api/models/destination_gcs.py index d7cd25e4..369743a9 100644 --- a/src/airbyte/models/shared/destination_gcs.py +++ b/src/airbyte_api/models/destination_gcs.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/destination_google_sheets.py b/src/airbyte_api/models/destination_google_sheets.py similarity index 98% rename from src/airbyte/models/shared/destination_google_sheets.py rename to src/airbyte_api/models/destination_google_sheets.py index 3c237b5c..7818d9be 100644 --- a/src/airbyte/models/shared/destination_google_sheets.py +++ b/src/airbyte_api/models/destination_google_sheets.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/destination_langchain.py b/src/airbyte_api/models/destination_langchain.py similarity index 99% rename from src/airbyte/models/shared/destination_langchain.py rename to src/airbyte_api/models/destination_langchain.py index ce9a4580..7e07fe2b 100644 --- a/src/airbyte/models/shared/destination_langchain.py +++ b/src/airbyte_api/models/destination_langchain.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, List, Optional, Union diff --git a/src/airbyte/models/shared/destination_milvus.py b/src/airbyte_api/models/destination_milvus.py similarity index 99% rename from src/airbyte/models/shared/destination_milvus.py rename to src/airbyte_api/models/destination_milvus.py index 973bd0d7..814216ba 100644 --- a/src/airbyte/models/shared/destination_milvus.py +++ b/src/airbyte_api/models/destination_milvus.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, List, Optional, Union diff --git a/src/airbyte/models/shared/destination_mongodb.py b/src/airbyte_api/models/destination_mongodb.py similarity index 99% rename from src/airbyte/models/shared/destination_mongodb.py rename to src/airbyte_api/models/destination_mongodb.py index 0bd8695b..578e9248 100644 --- a/src/airbyte/models/shared/destination_mongodb.py +++ b/src/airbyte_api/models/destination_mongodb.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/destination_mssql.py b/src/airbyte_api/models/destination_mssql.py similarity index 99% rename from src/airbyte/models/shared/destination_mssql.py rename to src/airbyte_api/models/destination_mssql.py index 63805ae7..8c603372 100644 --- a/src/airbyte/models/shared/destination_mssql.py +++ b/src/airbyte_api/models/destination_mssql.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/destination_mysql.py b/src/airbyte_api/models/destination_mysql.py similarity index 99% rename from src/airbyte/models/shared/destination_mysql.py rename to src/airbyte_api/models/destination_mysql.py index 7dc2c393..ed266bb1 100644 --- a/src/airbyte/models/shared/destination_mysql.py +++ b/src/airbyte_api/models/destination_mysql.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/destination_oracle.py b/src/airbyte_api/models/destination_oracle.py similarity index 99% rename from src/airbyte/models/shared/destination_oracle.py rename to src/airbyte_api/models/destination_oracle.py index 5e7e0d8e..b86622f1 100644 --- a/src/airbyte/models/shared/destination_oracle.py +++ b/src/airbyte_api/models/destination_oracle.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/destination_pinecone.py b/src/airbyte_api/models/destination_pinecone.py similarity index 99% rename from src/airbyte/models/shared/destination_pinecone.py rename to src/airbyte_api/models/destination_pinecone.py index 95d283ee..050578fb 100644 --- a/src/airbyte/models/shared/destination_pinecone.py +++ b/src/airbyte_api/models/destination_pinecone.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, List, Optional, Union diff --git a/src/airbyte/models/shared/destination_postgres.py b/src/airbyte_api/models/destination_postgres.py similarity index 99% rename from src/airbyte/models/shared/destination_postgres.py rename to src/airbyte_api/models/destination_postgres.py index 6d18101a..d9541881 100644 --- a/src/airbyte/models/shared/destination_postgres.py +++ b/src/airbyte_api/models/destination_postgres.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/destination_pubsub.py b/src/airbyte_api/models/destination_pubsub.py similarity index 98% rename from src/airbyte/models/shared/destination_pubsub.py rename to src/airbyte_api/models/destination_pubsub.py index 465cbab6..2d98540b 100644 --- a/src/airbyte/models/shared/destination_pubsub.py +++ b/src/airbyte_api/models/destination_pubsub.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/destination_qdrant.py b/src/airbyte_api/models/destination_qdrant.py similarity index 99% rename from src/airbyte/models/shared/destination_qdrant.py rename to src/airbyte_api/models/destination_qdrant.py index 4a1338f0..28e6d4db 100644 --- a/src/airbyte/models/shared/destination_qdrant.py +++ b/src/airbyte_api/models/destination_qdrant.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, List, Optional, Union diff --git a/src/airbyte/models/shared/destination_redis.py b/src/airbyte_api/models/destination_redis.py similarity index 99% rename from src/airbyte/models/shared/destination_redis.py rename to src/airbyte_api/models/destination_redis.py index 51ddca94..8751225c 100644 --- a/src/airbyte/models/shared/destination_redis.py +++ b/src/airbyte_api/models/destination_redis.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/destination_redshift.py b/src/airbyte_api/models/destination_redshift.py similarity index 96% rename from src/airbyte/models/shared/destination_redshift.py rename to src/airbyte_api/models/destination_redshift.py index ec2ab028..d0c74359 100644 --- a/src/airbyte/models/shared/destination_redshift.py +++ b/src/airbyte_api/models/destination_redshift.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union @@ -156,8 +156,6 @@ class AWSS3Staging: 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.""" 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') }}) diff --git a/src/airbyte/models/shared/destination_s3.py b/src/airbyte_api/models/destination_s3.py similarity index 99% rename from src/airbyte/models/shared/destination_s3.py rename to src/airbyte_api/models/destination_s3.py index c05ef878..a426fd89 100644 --- a/src/airbyte/models/shared/destination_s3.py +++ b/src/airbyte_api/models/destination_s3.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/destination_s3_glue.py b/src/airbyte_api/models/destination_s3_glue.py similarity index 99% rename from src/airbyte/models/shared/destination_s3_glue.py rename to src/airbyte_api/models/destination_s3_glue.py index 9a8f8083..6b54ed39 100644 --- a/src/airbyte/models/shared/destination_s3_glue.py +++ b/src/airbyte_api/models/destination_s3_glue.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/destination_sftp_json.py b/src/airbyte_api/models/destination_sftp_json.py similarity index 98% rename from src/airbyte/models/shared/destination_sftp_json.py rename to src/airbyte_api/models/destination_sftp_json.py index ca44639a..53ab9b54 100644 --- a/src/airbyte/models/shared/destination_sftp_json.py +++ b/src/airbyte_api/models/destination_sftp_json.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/destination_snowflake.py b/src/airbyte_api/models/destination_snowflake.py similarity index 92% rename from src/airbyte/models/shared/destination_snowflake.py rename to src/airbyte_api/models/destination_snowflake.py index c3fedaf7..33f808a0 100644 --- a/src/airbyte/models/shared/destination_snowflake.py +++ b/src/airbyte_api/models/destination_snowflake.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union @@ -83,5 +83,7 @@ class DestinationSnowflake: r"""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] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('raw_data_schema'), 'exclude': lambda f: f is None }}) r"""The schema to write raw tables into (default: airbyte_internal)""" + retention_period_days: Optional[int] = dataclasses.field(default=1, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('retention_period_days'), 'exclude': lambda f: f is None }}) + r"""The number of days of Snowflake Time Travel to enable on the tables. See Snowflake's documentation for more information. Setting a nonzero value will incur increased storage costs in your Snowflake instance.""" diff --git a/src/airbyte/models/shared/destination_teradata.py b/src/airbyte_api/models/destination_teradata.py similarity index 99% rename from src/airbyte/models/shared/destination_teradata.py rename to src/airbyte_api/models/destination_teradata.py index 7a98150a..b1da1797 100644 --- a/src/airbyte/models/shared/destination_teradata.py +++ b/src/airbyte_api/models/destination_teradata.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/destination_typesense.py b/src/airbyte_api/models/destination_typesense.py similarity index 86% rename from src/airbyte/models/shared/destination_typesense.py rename to src/airbyte_api/models/destination_typesense.py index 9db797a8..9363ea6e 100644 --- a/src/airbyte/models/shared/destination_typesense.py +++ b/src/airbyte_api/models/destination_typesense.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional @@ -21,6 +21,8 @@ class DestinationTypesense: 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') }}) + path: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('path'), 'exclude': lambda f: f is None }}) + r"""Path of the Typesense instance. Default is none""" 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/destination_vectara.py b/src/airbyte_api/models/destination_vectara.py similarity index 99% rename from src/airbyte/models/shared/destination_vectara.py rename to src/airbyte_api/models/destination_vectara.py index 68e71592..f18289b9 100644 --- a/src/airbyte/models/shared/destination_vectara.py +++ b/src/airbyte_api/models/destination_vectara.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, List, Optional diff --git a/src/airbyte/models/shared/destination_weaviate.py b/src/airbyte_api/models/destination_weaviate.py similarity index 99% rename from src/airbyte/models/shared/destination_weaviate.py rename to src/airbyte_api/models/destination_weaviate.py index 8cc4d45b..ddfb6f87 100644 --- a/src/airbyte/models/shared/destination_weaviate.py +++ b/src/airbyte_api/models/destination_weaviate.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, List, Optional, Union diff --git a/src/airbyte_api/models/destinationcreaterequest.py b/src/airbyte_api/models/destinationcreaterequest.py new file mode 100644 index 00000000..25d8b149 --- /dev/null +++ b/src/airbyte_api/models/destinationcreaterequest.py @@ -0,0 +1,55 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from .destination_astra import DestinationAstra +from .destination_aws_datalake import DestinationAwsDatalake +from .destination_azure_blob_storage import DestinationAzureBlobStorage +from .destination_bigquery import DestinationBigquery +from .destination_clickhouse import DestinationClickhouse +from .destination_convex import DestinationConvex +from .destination_databricks import DestinationDatabricks +from .destination_dev_null import DestinationDevNull +from .destination_duckdb import DestinationDuckdb +from .destination_dynamodb import DestinationDynamodb +from .destination_elasticsearch import DestinationElasticsearch +from .destination_firestore import DestinationFirestore +from .destination_gcs import DestinationGcs +from .destination_google_sheets import DestinationGoogleSheets +from .destination_langchain import DestinationLangchain +from .destination_milvus import DestinationMilvus +from .destination_mongodb import DestinationMongodb +from .destination_mssql import DestinationMssql +from .destination_mysql import DestinationMysql +from .destination_oracle import DestinationOracle +from .destination_pinecone import DestinationPinecone +from .destination_postgres import DestinationPostgres +from .destination_pubsub import DestinationPubsub +from .destination_qdrant import DestinationQdrant +from .destination_redis import DestinationRedis +from .destination_redshift import DestinationRedshift +from .destination_s3 import DestinationS3 +from .destination_s3_glue import DestinationS3Glue +from .destination_sftp_json import DestinationSftpJSON +from .destination_snowflake import DestinationSnowflake +from .destination_teradata import DestinationTeradata +from .destination_typesense import DestinationTypesense +from .destination_vectara import DestinationVectara +from .destination_weaviate import DestinationWeaviate +from airbyte_api import utils +from dataclasses_json import Undefined, dataclass_json +from typing import Optional, Union + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class DestinationCreateRequest: + configuration: Union[DestinationGoogleSheets, DestinationAstra, DestinationAwsDatalake, DestinationAzureBlobStorage, DestinationBigquery, DestinationClickhouse, DestinationConvex, DestinationDatabricks, DestinationDevNull, DestinationDuckdb, DestinationDynamodb, DestinationElasticsearch, DestinationFirestore, DestinationGcs, DestinationLangchain, DestinationMilvus, DestinationMongodb, DestinationMssql, DestinationMysql, DestinationOracle, DestinationPinecone, DestinationPostgres, DestinationPubsub, DestinationQdrant, DestinationRedis, DestinationRedshift, DestinationS3, DestinationS3Glue, DestinationSftpJSON, DestinationSnowflake, DestinationTeradata, DestinationTypesense, DestinationVectara, DestinationWeaviate] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('configuration') }}) + r"""The values required to configure the destination.""" + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + r"""Name of the destination e.g. dev-mysql-instance.""" + workspace_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('workspaceId') }}) + definition_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('definitionId'), 'exclude': lambda f: f is None }}) + r"""The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided.""" + + diff --git a/src/airbyte_api/models/destinationpatchrequest.py b/src/airbyte_api/models/destinationpatchrequest.py new file mode 100644 index 00000000..28000668 --- /dev/null +++ b/src/airbyte_api/models/destinationpatchrequest.py @@ -0,0 +1,51 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from .destination_astra import DestinationAstra +from .destination_aws_datalake import DestinationAwsDatalake +from .destination_azure_blob_storage import DestinationAzureBlobStorage +from .destination_bigquery import DestinationBigquery +from .destination_clickhouse import DestinationClickhouse +from .destination_convex import DestinationConvex +from .destination_databricks import DestinationDatabricks +from .destination_dev_null import DestinationDevNull +from .destination_duckdb import DestinationDuckdb +from .destination_dynamodb import DestinationDynamodb +from .destination_elasticsearch import DestinationElasticsearch +from .destination_firestore import DestinationFirestore +from .destination_gcs import DestinationGcs +from .destination_google_sheets import DestinationGoogleSheets +from .destination_langchain import DestinationLangchain +from .destination_milvus import DestinationMilvus +from .destination_mongodb import DestinationMongodb +from .destination_mssql import DestinationMssql +from .destination_mysql import DestinationMysql +from .destination_oracle import DestinationOracle +from .destination_pinecone import DestinationPinecone +from .destination_postgres import DestinationPostgres +from .destination_pubsub import DestinationPubsub +from .destination_qdrant import DestinationQdrant +from .destination_redis import DestinationRedis +from .destination_redshift import DestinationRedshift +from .destination_s3 import DestinationS3 +from .destination_s3_glue import DestinationS3Glue +from .destination_sftp_json import DestinationSftpJSON +from .destination_snowflake import DestinationSnowflake +from .destination_teradata import DestinationTeradata +from .destination_typesense import DestinationTypesense +from .destination_vectara import DestinationVectara +from .destination_weaviate import DestinationWeaviate +from airbyte_api import utils +from dataclasses_json import Undefined, dataclass_json +from typing import Optional, Union + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class DestinationPatchRequest: + configuration: Optional[Union[DestinationGoogleSheets, DestinationAstra, DestinationAwsDatalake, DestinationAzureBlobStorage, DestinationBigquery, DestinationClickhouse, DestinationConvex, DestinationDatabricks, DestinationDevNull, DestinationDuckdb, DestinationDynamodb, DestinationElasticsearch, DestinationFirestore, DestinationGcs, DestinationLangchain, DestinationMilvus, DestinationMongodb, DestinationMssql, DestinationMysql, DestinationOracle, DestinationPinecone, DestinationPostgres, DestinationPubsub, DestinationQdrant, DestinationRedis, DestinationRedshift, DestinationS3, DestinationS3Glue, DestinationSftpJSON, DestinationSnowflake, DestinationTeradata, DestinationTypesense, DestinationVectara, DestinationWeaviate]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('configuration'), 'exclude': lambda f: f is None }}) + r"""The values required to configure the destination.""" + name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) + + diff --git a/src/airbyte_api/models/destinationputrequest.py b/src/airbyte_api/models/destinationputrequest.py new file mode 100644 index 00000000..fde23059 --- /dev/null +++ b/src/airbyte_api/models/destinationputrequest.py @@ -0,0 +1,51 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from .destination_astra import DestinationAstra +from .destination_aws_datalake import DestinationAwsDatalake +from .destination_azure_blob_storage import DestinationAzureBlobStorage +from .destination_bigquery import DestinationBigquery +from .destination_clickhouse import DestinationClickhouse +from .destination_convex import DestinationConvex +from .destination_databricks import DestinationDatabricks +from .destination_dev_null import DestinationDevNull +from .destination_duckdb import DestinationDuckdb +from .destination_dynamodb import DestinationDynamodb +from .destination_elasticsearch import DestinationElasticsearch +from .destination_firestore import DestinationFirestore +from .destination_gcs import DestinationGcs +from .destination_google_sheets import DestinationGoogleSheets +from .destination_langchain import DestinationLangchain +from .destination_milvus import DestinationMilvus +from .destination_mongodb import DestinationMongodb +from .destination_mssql import DestinationMssql +from .destination_mysql import DestinationMysql +from .destination_oracle import DestinationOracle +from .destination_pinecone import DestinationPinecone +from .destination_postgres import DestinationPostgres +from .destination_pubsub import DestinationPubsub +from .destination_qdrant import DestinationQdrant +from .destination_redis import DestinationRedis +from .destination_redshift import DestinationRedshift +from .destination_s3 import DestinationS3 +from .destination_s3_glue import DestinationS3Glue +from .destination_sftp_json import DestinationSftpJSON +from .destination_snowflake import DestinationSnowflake +from .destination_teradata import DestinationTeradata +from .destination_typesense import DestinationTypesense +from .destination_vectara import DestinationVectara +from .destination_weaviate import DestinationWeaviate +from airbyte_api import utils +from dataclasses_json import Undefined, dataclass_json +from typing import Union + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class DestinationPutRequest: + configuration: Union[DestinationGoogleSheets, DestinationAstra, DestinationAwsDatalake, DestinationAzureBlobStorage, DestinationBigquery, DestinationClickhouse, DestinationConvex, DestinationDatabricks, DestinationDevNull, DestinationDuckdb, DestinationDynamodb, DestinationElasticsearch, DestinationFirestore, DestinationGcs, DestinationLangchain, DestinationMilvus, DestinationMongodb, DestinationMssql, DestinationMysql, DestinationOracle, DestinationPinecone, DestinationPostgres, DestinationPubsub, DestinationQdrant, DestinationRedis, DestinationRedshift, DestinationS3, DestinationS3Glue, DestinationSftpJSON, DestinationSnowflake, DestinationTeradata, DestinationTypesense, DestinationVectara, DestinationWeaviate] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('configuration') }}) + r"""The values required to configure the destination.""" + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + + diff --git a/src/airbyte_api/models/destinationresponse.py b/src/airbyte_api/models/destinationresponse.py new file mode 100644 index 00000000..dc841539 --- /dev/null +++ b/src/airbyte_api/models/destinationresponse.py @@ -0,0 +1,55 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from .destination_astra import DestinationAstra +from .destination_aws_datalake import DestinationAwsDatalake +from .destination_azure_blob_storage import DestinationAzureBlobStorage +from .destination_bigquery import DestinationBigquery +from .destination_clickhouse import DestinationClickhouse +from .destination_convex import DestinationConvex +from .destination_databricks import DestinationDatabricks +from .destination_dev_null import DestinationDevNull +from .destination_duckdb import DestinationDuckdb +from .destination_dynamodb import DestinationDynamodb +from .destination_elasticsearch import DestinationElasticsearch +from .destination_firestore import DestinationFirestore +from .destination_gcs import DestinationGcs +from .destination_google_sheets import DestinationGoogleSheets +from .destination_langchain import DestinationLangchain +from .destination_milvus import DestinationMilvus +from .destination_mongodb import DestinationMongodb +from .destination_mssql import DestinationMssql +from .destination_mysql import DestinationMysql +from .destination_oracle import DestinationOracle +from .destination_pinecone import DestinationPinecone +from .destination_postgres import DestinationPostgres +from .destination_pubsub import DestinationPubsub +from .destination_qdrant import DestinationQdrant +from .destination_redis import DestinationRedis +from .destination_redshift import DestinationRedshift +from .destination_s3 import DestinationS3 +from .destination_s3_glue import DestinationS3Glue +from .destination_sftp_json import DestinationSftpJSON +from .destination_snowflake import DestinationSnowflake +from .destination_teradata import DestinationTeradata +from .destination_typesense import DestinationTypesense +from .destination_vectara import DestinationVectara +from .destination_weaviate import DestinationWeaviate +from airbyte_api import utils +from dataclasses_json import Undefined, dataclass_json +from typing import Union + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class DestinationResponse: + r"""Provides details of a single destination.""" + configuration: Union[DestinationGoogleSheets, DestinationAstra, DestinationAwsDatalake, DestinationAzureBlobStorage, DestinationBigquery, DestinationClickhouse, DestinationConvex, DestinationDatabricks, DestinationDevNull, DestinationDuckdb, DestinationDynamodb, DestinationElasticsearch, DestinationFirestore, DestinationGcs, DestinationLangchain, DestinationMilvus, DestinationMongodb, DestinationMssql, DestinationMysql, DestinationOracle, DestinationPinecone, DestinationPostgres, DestinationPubsub, DestinationQdrant, DestinationRedis, DestinationRedshift, DestinationS3, DestinationS3Glue, DestinationSftpJSON, DestinationSnowflake, DestinationTeradata, DestinationTypesense, DestinationVectara, DestinationWeaviate] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('configuration') }}) + r"""The values required to configure the destination.""" + destination_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationId') }}) + destination_type: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + workspace_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('workspaceId') }}) + + diff --git a/src/airbyte/models/shared/destinationsresponse.py b/src/airbyte_api/models/destinationsresponse.py similarity index 96% rename from src/airbyte/models/shared/destinationsresponse.py rename to src/airbyte_api/models/destinationsresponse.py index 10a1e74d..91895204 100644 --- a/src/airbyte/models/shared/destinationsresponse.py +++ b/src/airbyte_api/models/destinationsresponse.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses from .destinationresponse import DestinationResponse -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional diff --git a/src/airbyte/models/shared/facebook_marketing.py b/src/airbyte_api/models/facebook_marketing.py similarity index 96% rename from src/airbyte/models/shared/facebook_marketing.py rename to src/airbyte_api/models/facebook_marketing.py index da6676bd..bc54fef5 100644 --- a/src/airbyte/models/shared/facebook_marketing.py +++ b/src/airbyte_api/models/facebook_marketing.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/geographyenum.py b/src/airbyte_api/models/geographyenum.py similarity index 100% rename from src/airbyte/models/shared/geographyenum.py rename to src/airbyte_api/models/geographyenum.py diff --git a/src/airbyte/models/shared/geographyenumnodefault.py b/src/airbyte_api/models/geographyenumnodefault.py similarity index 100% rename from src/airbyte/models/shared/geographyenumnodefault.py rename to src/airbyte_api/models/geographyenumnodefault.py diff --git a/src/airbyte/models/shared/github.py b/src/airbyte_api/models/github.py similarity index 97% rename from src/airbyte/models/shared/github.py rename to src/airbyte_api/models/github.py index e3a50693..5a2be24c 100644 --- a/src/airbyte/models/shared/github.py +++ b/src/airbyte_api/models/github.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/gitlab.py b/src/airbyte_api/models/gitlab.py similarity index 97% rename from src/airbyte/models/shared/gitlab.py rename to src/airbyte_api/models/gitlab.py index 0e39edc8..780397cb 100644 --- a/src/airbyte/models/shared/gitlab.py +++ b/src/airbyte_api/models/gitlab.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/google_ads.py b/src/airbyte_api/models/google_ads.py similarity index 98% rename from src/airbyte/models/shared/google_ads.py rename to src/airbyte_api/models/google_ads.py index 1b8960c2..8f7989cb 100644 --- a/src/airbyte/models/shared/google_ads.py +++ b/src/airbyte_api/models/google_ads.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/google_analytics_data_api.py b/src/airbyte_api/models/google_analytics_data_api.py similarity index 97% rename from src/airbyte/models/shared/google_analytics_data_api.py rename to src/airbyte_api/models/google_analytics_data_api.py index eb64a27b..8fb18322 100644 --- a/src/airbyte/models/shared/google_analytics_data_api.py +++ b/src/airbyte_api/models/google_analytics_data_api.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/google_drive.py b/src/airbyte_api/models/google_drive.py similarity index 97% rename from src/airbyte/models/shared/google_drive.py rename to src/airbyte_api/models/google_drive.py index 10418621..d711d6bc 100644 --- a/src/airbyte/models/shared/google_drive.py +++ b/src/airbyte_api/models/google_drive.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/google_search_console.py b/src/airbyte_api/models/google_search_console.py similarity index 97% rename from src/airbyte/models/shared/google_search_console.py rename to src/airbyte_api/models/google_search_console.py index 2cbc4943..690906ea 100644 --- a/src/airbyte/models/shared/google_search_console.py +++ b/src/airbyte_api/models/google_search_console.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/google_sheets.py b/src/airbyte_api/models/google_sheets.py similarity index 97% rename from src/airbyte/models/shared/google_sheets.py rename to src/airbyte_api/models/google_sheets.py index c4ac1fd2..be1ac597 100644 --- a/src/airbyte/models/shared/google_sheets.py +++ b/src/airbyte_api/models/google_sheets.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/harvest.py b/src/airbyte_api/models/harvest.py similarity index 97% rename from src/airbyte/models/shared/harvest.py rename to src/airbyte_api/models/harvest.py index 6d1d8755..1cfa5767 100644 --- a/src/airbyte/models/shared/harvest.py +++ b/src/airbyte_api/models/harvest.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/hubspot.py b/src/airbyte_api/models/hubspot.py similarity index 97% rename from src/airbyte/models/shared/hubspot.py rename to src/airbyte_api/models/hubspot.py index fe8cc96a..a40a2632 100644 --- a/src/airbyte/models/shared/hubspot.py +++ b/src/airbyte_api/models/hubspot.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/initiateoauthrequest.py b/src/airbyte_api/models/initiateoauthrequest.py similarity index 97% rename from src/airbyte/models/shared/initiateoauthrequest.py rename to src/airbyte_api/models/initiateoauthrequest.py index 717bf074..b071e76f 100644 --- a/src/airbyte/models/shared/initiateoauthrequest.py +++ b/src/airbyte_api/models/initiateoauthrequest.py @@ -4,7 +4,7 @@ import dataclasses from .oauthactornames import OAuthActorNames from .oauthinputconfiguration import OAuthInputConfiguration -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/instagram.py b/src/airbyte_api/models/instagram.py similarity index 96% rename from src/airbyte/models/shared/instagram.py rename to src/airbyte_api/models/instagram.py index 1da88057..1b27ee69 100644 --- a/src/airbyte/models/shared/instagram.py +++ b/src/airbyte_api/models/instagram.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/intercom.py b/src/airbyte_api/models/intercom.py similarity index 96% rename from src/airbyte/models/shared/intercom.py rename to src/airbyte_api/models/intercom.py index c6502e11..8f52aac5 100644 --- a/src/airbyte/models/shared/intercom.py +++ b/src/airbyte_api/models/intercom.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/jobcreaterequest.py b/src/airbyte_api/models/jobcreaterequest.py similarity index 96% rename from src/airbyte/models/shared/jobcreaterequest.py rename to src/airbyte_api/models/jobcreaterequest.py index 53410c05..6f2e8802 100644 --- a/src/airbyte/models/shared/jobcreaterequest.py +++ b/src/airbyte_api/models/jobcreaterequest.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses from .jobtypeenum import JobTypeEnum -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json diff --git a/src/airbyte/models/shared/jobresponse.py b/src/airbyte_api/models/jobresponse.py similarity index 98% rename from src/airbyte/models/shared/jobresponse.py rename to src/airbyte_api/models/jobresponse.py index cd971ff1..51dadac5 100644 --- a/src/airbyte/models/shared/jobresponse.py +++ b/src/airbyte_api/models/jobresponse.py @@ -4,7 +4,7 @@ import dataclasses from .jobstatusenum import JobStatusEnum from .jobtypeenum import JobTypeEnum -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/jobsresponse.py b/src/airbyte_api/models/jobsresponse.py similarity index 96% rename from src/airbyte/models/shared/jobsresponse.py rename to src/airbyte_api/models/jobsresponse.py index d7ce4a44..4ce4d253 100644 --- a/src/airbyte/models/shared/jobsresponse.py +++ b/src/airbyte_api/models/jobsresponse.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses from .jobresponse import JobResponse -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional diff --git a/src/airbyte/models/shared/jobstatusenum.py b/src/airbyte_api/models/jobstatusenum.py similarity index 100% rename from src/airbyte/models/shared/jobstatusenum.py rename to src/airbyte_api/models/jobstatusenum.py diff --git a/src/airbyte/models/shared/jobtypeenum.py b/src/airbyte_api/models/jobtypeenum.py similarity index 100% rename from src/airbyte/models/shared/jobtypeenum.py rename to src/airbyte_api/models/jobtypeenum.py diff --git a/src/airbyte/models/shared/lever_hiring.py b/src/airbyte_api/models/lever_hiring.py similarity index 97% rename from src/airbyte/models/shared/lever_hiring.py rename to src/airbyte_api/models/lever_hiring.py index 85a239e9..728314f9 100644 --- a/src/airbyte/models/shared/lever_hiring.py +++ b/src/airbyte_api/models/lever_hiring.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/linkedin_ads.py b/src/airbyte_api/models/linkedin_ads.py similarity index 97% rename from src/airbyte/models/shared/linkedin_ads.py rename to src/airbyte_api/models/linkedin_ads.py index 71934959..9cbde474 100644 --- a/src/airbyte/models/shared/linkedin_ads.py +++ b/src/airbyte_api/models/linkedin_ads.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/mailchimp.py b/src/airbyte_api/models/mailchimp.py similarity index 97% rename from src/airbyte/models/shared/mailchimp.py rename to src/airbyte_api/models/mailchimp.py index a6a07dff..4dfc3e2b 100644 --- a/src/airbyte/models/shared/mailchimp.py +++ b/src/airbyte_api/models/mailchimp.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte_api/models/microsoft_onedrive.py b/src/airbyte_api/models/microsoft_onedrive.py new file mode 100644 index 00000000..c3caa3bf --- /dev/null +++ b/src/airbyte_api/models/microsoft_onedrive.py @@ -0,0 +1,26 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from airbyte_api import utils +from dataclasses_json import Undefined, dataclass_json +from typing import Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class MicrosoftOnedriveCredentials: + 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 of your Microsoft 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 }}) + r"""Client Secret of your Microsoft developer application""" + + + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class MicrosoftOnedrive: + credentials: Optional[MicrosoftOnedriveCredentials] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials'), 'exclude': lambda f: f is None }}) + + diff --git a/src/airbyte/models/shared/microsoft_sharepoint.py b/src/airbyte_api/models/microsoft_sharepoint.py similarity index 97% rename from src/airbyte/models/shared/microsoft_sharepoint.py rename to src/airbyte_api/models/microsoft_sharepoint.py index 530930b9..a21b0732 100644 --- a/src/airbyte/models/shared/microsoft_sharepoint.py +++ b/src/airbyte_api/models/microsoft_sharepoint.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/microsoft_teams.py b/src/airbyte_api/models/microsoft_teams.py similarity index 97% rename from src/airbyte/models/shared/microsoft_teams.py rename to src/airbyte_api/models/microsoft_teams.py index d263ecea..8e94903b 100644 --- a/src/airbyte/models/shared/microsoft_teams.py +++ b/src/airbyte_api/models/microsoft_teams.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/monday.py b/src/airbyte_api/models/monday.py similarity index 97% rename from src/airbyte/models/shared/monday.py rename to src/airbyte_api/models/monday.py index 60611ef4..3bed1db8 100644 --- a/src/airbyte/models/shared/monday.py +++ b/src/airbyte_api/models/monday.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/namespacedefinitionenum.py b/src/airbyte_api/models/namespacedefinitionenum.py similarity index 100% rename from src/airbyte/models/shared/namespacedefinitionenum.py rename to src/airbyte_api/models/namespacedefinitionenum.py diff --git a/src/airbyte/models/shared/namespacedefinitionenumnodefault.py b/src/airbyte_api/models/namespacedefinitionenumnodefault.py similarity index 100% rename from src/airbyte/models/shared/namespacedefinitionenumnodefault.py rename to src/airbyte_api/models/namespacedefinitionenumnodefault.py diff --git a/src/airbyte/models/shared/nonbreakingschemaupdatesbehaviorenum.py b/src/airbyte_api/models/nonbreakingschemaupdatesbehaviorenum.py similarity index 100% rename from src/airbyte/models/shared/nonbreakingschemaupdatesbehaviorenum.py rename to src/airbyte_api/models/nonbreakingschemaupdatesbehaviorenum.py diff --git a/src/airbyte/models/shared/nonbreakingschemaupdatesbehaviorenumnodefault.py b/src/airbyte_api/models/nonbreakingschemaupdatesbehaviorenumnodefault.py similarity index 100% rename from src/airbyte/models/shared/nonbreakingschemaupdatesbehaviorenumnodefault.py rename to src/airbyte_api/models/nonbreakingschemaupdatesbehaviorenumnodefault.py diff --git a/src/airbyte/models/shared/notion.py b/src/airbyte_api/models/notion.py similarity index 97% rename from src/airbyte/models/shared/notion.py rename to src/airbyte_api/models/notion.py index 40c5e8d2..de01e7e0 100644 --- a/src/airbyte/models/shared/notion.py +++ b/src/airbyte_api/models/notion.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/oauthactornames.py b/src/airbyte_api/models/oauthactornames.py similarity index 97% rename from src/airbyte/models/shared/oauthactornames.py rename to src/airbyte_api/models/oauthactornames.py index 0a7c4940..614c1147 100644 --- a/src/airbyte/models/shared/oauthactornames.py +++ b/src/airbyte_api/models/oauthactornames.py @@ -24,6 +24,7 @@ class OAuthActorNames(str, Enum): LEVER_HIRING = 'lever-hiring' LINKEDIN_ADS = 'linkedin-ads' MAILCHIMP = 'mailchimp' + MICROSOFT_ONEDRIVE = 'microsoft-onedrive' MICROSOFT_SHAREPOINT = 'microsoft-sharepoint' MICROSOFT_TEAMS = 'microsoft-teams' MONDAY = 'monday' diff --git a/src/airbyte/models/shared/oauthinputconfiguration.py b/src/airbyte_api/models/oauthinputconfiguration.py similarity index 100% rename from src/airbyte/models/shared/oauthinputconfiguration.py rename to src/airbyte_api/models/oauthinputconfiguration.py diff --git a/src/airbyte/models/shared/pinterest.py b/src/airbyte_api/models/pinterest.py similarity index 97% rename from src/airbyte/models/shared/pinterest.py rename to src/airbyte_api/models/pinterest.py index 6a1051f4..a2fc21b6 100644 --- a/src/airbyte/models/shared/pinterest.py +++ b/src/airbyte_api/models/pinterest.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/retently.py b/src/airbyte_api/models/retently.py similarity index 97% rename from src/airbyte/models/shared/retently.py rename to src/airbyte_api/models/retently.py index cff74e02..fc41ec57 100644 --- a/src/airbyte/models/shared/retently.py +++ b/src/airbyte_api/models/retently.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/salesforce.py b/src/airbyte_api/models/salesforce.py similarity index 97% rename from src/airbyte/models/shared/salesforce.py rename to src/airbyte_api/models/salesforce.py index c02e448a..9b313190 100644 --- a/src/airbyte/models/shared/salesforce.py +++ b/src/airbyte_api/models/salesforce.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/scheduletypeenum.py b/src/airbyte_api/models/scheduletypeenum.py similarity index 100% rename from src/airbyte/models/shared/scheduletypeenum.py rename to src/airbyte_api/models/scheduletypeenum.py diff --git a/src/airbyte/models/shared/scheduletypewithbasicenum.py b/src/airbyte_api/models/scheduletypewithbasicenum.py similarity index 100% rename from src/airbyte/models/shared/scheduletypewithbasicenum.py rename to src/airbyte_api/models/scheduletypewithbasicenum.py diff --git a/src/airbyte/models/shared/schemebasicauth.py b/src/airbyte_api/models/schemebasicauth.py similarity index 100% rename from src/airbyte/models/shared/schemebasicauth.py rename to src/airbyte_api/models/schemebasicauth.py diff --git a/src/airbyte/models/shared/security.py b/src/airbyte_api/models/security.py similarity index 100% rename from src/airbyte/models/shared/security.py rename to src/airbyte_api/models/security.py diff --git a/src/airbyte/models/shared/shopify.py b/src/airbyte_api/models/shopify.py similarity index 97% rename from src/airbyte/models/shared/shopify.py rename to src/airbyte_api/models/shopify.py index d069ed61..98bb27f1 100644 --- a/src/airbyte/models/shared/shopify.py +++ b/src/airbyte_api/models/shopify.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/slack.py b/src/airbyte_api/models/slack.py similarity index 97% rename from src/airbyte/models/shared/slack.py rename to src/airbyte_api/models/slack.py index 0a93620f..307b7850 100644 --- a/src/airbyte/models/shared/slack.py +++ b/src/airbyte_api/models/slack.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/smartsheets.py b/src/airbyte_api/models/smartsheets.py similarity index 97% rename from src/airbyte/models/shared/smartsheets.py rename to src/airbyte_api/models/smartsheets.py index 42c78d90..28f97f45 100644 --- a/src/airbyte/models/shared/smartsheets.py +++ b/src/airbyte_api/models/smartsheets.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/snapchat_marketing.py b/src/airbyte_api/models/snapchat_marketing.py similarity index 96% rename from src/airbyte/models/shared/snapchat_marketing.py rename to src/airbyte_api/models/snapchat_marketing.py index ae5359e4..9926f2f9 100644 --- a/src/airbyte/models/shared/snapchat_marketing.py +++ b/src/airbyte_api/models/snapchat_marketing.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/snowflake.py b/src/airbyte_api/models/snowflake.py similarity index 97% rename from src/airbyte/models/shared/snowflake.py rename to src/airbyte_api/models/snowflake.py index ba8ac89c..e917020a 100644 --- a/src/airbyte/models/shared/snowflake.py +++ b/src/airbyte_api/models/snowflake.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/source_aha.py b/src/airbyte_api/models/source_aha.py similarity index 96% rename from src/airbyte/models/shared/source_aha.py rename to src/airbyte_api/models/source_aha.py index 7844b66a..43d3ee65 100644 --- a/src/airbyte/models/shared/source_aha.py +++ b/src/airbyte_api/models/source_aha.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_aircall.py b/src/airbyte_api/models/source_aircall.py similarity index 97% rename from src/airbyte/models/shared/source_aircall.py rename to src/airbyte_api/models/source_aircall.py index 7022cbc7..66a27523 100644 --- a/src/airbyte/models/shared/source_aircall.py +++ b/src/airbyte_api/models/source_aircall.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_airtable.py b/src/airbyte_api/models/source_airtable.py similarity index 99% rename from src/airbyte/models/shared/source_airtable.py rename to src/airbyte_api/models/source_airtable.py index c4de0090..60b06bb6 100644 --- a/src/airbyte/models/shared/source_airtable.py +++ b/src/airbyte_api/models/source_airtable.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_amazon_ads.py b/src/airbyte_api/models/source_amazon_ads.py similarity index 99% rename from src/airbyte/models/shared/source_amazon_ads.py rename to src/airbyte_api/models/source_amazon_ads.py index 0f77ca2b..5935684c 100644 --- a/src/airbyte/models/shared/source_amazon_ads.py +++ b/src/airbyte_api/models/source_amazon_ads.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import date from enum import Enum diff --git a/src/airbyte/models/shared/source_amazon_seller_partner.py b/src/airbyte_api/models/source_amazon_seller_partner.py similarity index 99% rename from src/airbyte/models/shared/source_amazon_seller_partner.py rename to src/airbyte_api/models/source_amazon_seller_partner.py index 103e4cd2..0bec1624 100644 --- a/src/airbyte/models/shared/source_amazon_seller_partner.py +++ b/src/airbyte_api/models/source_amazon_seller_partner.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_amazon_sqs.py b/src/airbyte_api/models/source_amazon_sqs.py similarity index 99% rename from src/airbyte/models/shared/source_amazon_sqs.py rename to src/airbyte_api/models/source_amazon_sqs.py index cebbac94..1c449a6c 100644 --- a/src/airbyte/models/shared/source_amazon_sqs.py +++ b/src/airbyte_api/models/source_amazon_sqs.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_amplitude.py b/src/airbyte_api/models/source_amplitude.py similarity index 98% rename from src/airbyte/models/shared/source_amplitude.py rename to src/airbyte_api/models/source_amplitude.py index dbcd376e..dd1bfe84 100644 --- a/src/airbyte/models/shared/source_amplitude.py +++ b/src/airbyte_api/models/source_amplitude.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_apify_dataset.py b/src/airbyte_api/models/source_apify_dataset.py similarity index 98% rename from src/airbyte/models/shared/source_apify_dataset.py rename to src/airbyte_api/models/source_apify_dataset.py index 1d806371..9cfa11ae 100644 --- a/src/airbyte/models/shared/source_apify_dataset.py +++ b/src/airbyte_api/models/source_apify_dataset.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_appfollow.py b/src/airbyte_api/models/source_appfollow.py similarity index 96% rename from src/airbyte/models/shared/source_appfollow.py rename to src/airbyte_api/models/source_appfollow.py index 47662061..2aff3d96 100644 --- a/src/airbyte/models/shared/source_appfollow.py +++ b/src/airbyte_api/models/source_appfollow.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_asana.py b/src/airbyte_api/models/source_asana.py similarity index 99% rename from src/airbyte/models/shared/source_asana.py rename to src/airbyte_api/models/source_asana.py index e6bcf18b..7a0df471 100644 --- a/src/airbyte/models/shared/source_asana.py +++ b/src/airbyte_api/models/source_asana.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Any, Final, List, Optional, Union diff --git a/src/airbyte/models/shared/source_auth0.py b/src/airbyte_api/models/source_auth0.py similarity index 99% rename from src/airbyte/models/shared/source_auth0.py rename to src/airbyte_api/models/source_auth0.py index 54f0b7d5..29b1404d 100644 --- a/src/airbyte/models/shared/source_auth0.py +++ b/src/airbyte_api/models/source_auth0.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/source_aws_cloudtrail.py b/src/airbyte_api/models/source_aws_cloudtrail.py similarity index 98% rename from src/airbyte/models/shared/source_aws_cloudtrail.py rename to src/airbyte_api/models/source_aws_cloudtrail.py index cb153094..edd7caae 100644 --- a/src/airbyte/models/shared/source_aws_cloudtrail.py +++ b/src/airbyte_api/models/source_aws_cloudtrail.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import date from enum import Enum diff --git a/src/airbyte/models/shared/source_azure_blob_storage.py b/src/airbyte_api/models/source_azure_blob_storage.py similarity index 97% rename from src/airbyte/models/shared/source_azure_blob_storage.py rename to src/airbyte_api/models/source_azure_blob_storage.py index 5bb2d78a..42203ae4 100644 --- a/src/airbyte/models/shared/source_azure_blob_storage.py +++ b/src/airbyte_api/models/source_azure_blob_storage.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum @@ -133,6 +133,8 @@ class CSVFormat: FILETYPE: Final[Optional[SourceAzureBlobStorageFiletype]] = dataclasses.field(default=SourceAzureBlobStorageFiletype.CSV, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filetype'), 'exclude': lambda f: f is None }}) header_definition: Optional[Union[FromCSV, Autogenerated, UserProvided]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('header_definition'), 'exclude': lambda f: f is None }}) r"""How headers will be defined. `User Provided` assumes the CSV does not have a header row and uses the headers provided and `Autogenerated` assumes the CSV does not have a header row and the CDK will generate headers using for `f{i}` where `i` is the index starting from 0. Else, the default behavior is to use the header from the CSV file. If a user wants to autogenerate or provide column names for a CSV having headers, they can skip rows.""" + ignore_errors_on_fields_mismatch: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ignore_errors_on_fields_mismatch'), 'exclude': lambda f: f is None }}) + r"""Whether to ignore errors that occur when the number of fields in the CSV does not match the number of columns in the schema.""" inference_type: Optional[InferenceType] = dataclasses.field(default=InferenceType.NONE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('inference_type'), 'exclude': lambda f: f is None }}) r"""How to infer the types of the columns. If none, inference default to strings.""" null_values: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('null_values'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/source_azure_table.py b/src/airbyte_api/models/source_azure_table.py similarity index 98% rename from src/airbyte/models/shared/source_azure_table.py rename to src/airbyte_api/models/source_azure_table.py index 692a4dc2..58f9dff8 100644 --- a/src/airbyte/models/shared/source_azure_table.py +++ b/src/airbyte_api/models/source_azure_table.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_bamboo_hr.py b/src/airbyte_api/models/source_bamboo_hr.py similarity index 98% rename from src/airbyte/models/shared/source_bamboo_hr.py rename to src/airbyte_api/models/source_bamboo_hr.py index ff99aba0..7e1470ac 100644 --- a/src/airbyte/models/shared/source_bamboo_hr.py +++ b/src/airbyte_api/models/source_bamboo_hr.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_bigquery.py b/src/airbyte_api/models/source_bigquery.py similarity index 98% rename from src/airbyte/models/shared/source_bigquery.py rename to src/airbyte_api/models/source_bigquery.py index 3b9c9a15..86d0e2ef 100644 --- a/src/airbyte/models/shared/source_bigquery.py +++ b/src/airbyte_api/models/source_bigquery.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_bing_ads.py b/src/airbyte_api/models/source_bing_ads.py similarity index 99% rename from src/airbyte/models/shared/source_bing_ads.py rename to src/airbyte_api/models/source_bing_ads.py index dcc5294a..613683da 100644 --- a/src/airbyte/models/shared/source_bing_ads.py +++ b/src/airbyte_api/models/source_bing_ads.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import date from enum import Enum diff --git a/src/airbyte/models/shared/source_braintree.py b/src/airbyte_api/models/source_braintree.py similarity index 98% rename from src/airbyte/models/shared/source_braintree.py rename to src/airbyte_api/models/source_braintree.py index 3c9d4b0c..dfe32175 100644 --- a/src/airbyte/models/shared/source_braintree.py +++ b/src/airbyte_api/models/source_braintree.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_braze.py b/src/airbyte_api/models/source_braze.py similarity index 97% rename from src/airbyte/models/shared/source_braze.py rename to src/airbyte_api/models/source_braze.py index 57095d67..af9ca704 100644 --- a/src/airbyte/models/shared/source_braze.py +++ b/src/airbyte_api/models/source_braze.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import date from enum import Enum diff --git a/src/airbyte/models/shared/source_cart.py b/src/airbyte_api/models/source_cart.py similarity index 98% rename from src/airbyte/models/shared/source_cart.py rename to src/airbyte_api/models/source_cart.py index 84e0c84b..0b265572 100644 --- a/src/airbyte/models/shared/source_cart.py +++ b/src/airbyte_api/models/source_cart.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/source_chargebee.py b/src/airbyte_api/models/source_chargebee.py similarity index 98% rename from src/airbyte/models/shared/source_chargebee.py rename to src/airbyte_api/models/source_chargebee.py index d5e20a03..0fae9153 100644 --- a/src/airbyte/models/shared/source_chargebee.py +++ b/src/airbyte_api/models/source_chargebee.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_chartmogul.py b/src/airbyte_api/models/source_chartmogul.py similarity index 97% rename from src/airbyte/models/shared/source_chartmogul.py rename to src/airbyte_api/models/source_chartmogul.py index 03978c83..a887ae31 100644 --- a/src/airbyte/models/shared/source_chartmogul.py +++ b/src/airbyte_api/models/source_chartmogul.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_clickhouse.py b/src/airbyte_api/models/source_clickhouse.py similarity index 99% rename from src/airbyte/models/shared/source_clickhouse.py rename to src/airbyte_api/models/source_clickhouse.py index 5c170552..8f9e1315 100644 --- a/src/airbyte/models/shared/source_clickhouse.py +++ b/src/airbyte_api/models/source_clickhouse.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/source_clickup_api.py b/src/airbyte_api/models/source_clickup_api.py similarity index 98% rename from src/airbyte/models/shared/source_clickup_api.py rename to src/airbyte_api/models/source_clickup_api.py index 43da32ab..e3e79963 100644 --- a/src/airbyte/models/shared/source_clickup_api.py +++ b/src/airbyte_api/models/source_clickup_api.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_clockify.py b/src/airbyte_api/models/source_clockify.py similarity index 97% rename from src/airbyte/models/shared/source_clockify.py rename to src/airbyte_api/models/source_clockify.py index 907c72e1..aad3e5ff 100644 --- a/src/airbyte/models/shared/source_clockify.py +++ b/src/airbyte_api/models/source_clockify.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_close_com.py b/src/airbyte_api/models/source_close_com.py similarity index 97% rename from src/airbyte/models/shared/source_close_com.py rename to src/airbyte_api/models/source_close_com.py index 2eabbb23..5761df01 100644 --- a/src/airbyte/models/shared/source_close_com.py +++ b/src/airbyte_api/models/source_close_com.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import date from enum import Enum diff --git a/src/airbyte/models/shared/source_coda.py b/src/airbyte_api/models/source_coda.py similarity index 95% rename from src/airbyte/models/shared/source_coda.py rename to src/airbyte_api/models/source_coda.py index c9d794d9..e9399927 100644 --- a/src/airbyte/models/shared/source_coda.py +++ b/src/airbyte_api/models/source_coda.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_coin_api.py b/src/airbyte_api/models/source_coin_api.py similarity index 98% rename from src/airbyte/models/shared/source_coin_api.py rename to src/airbyte_api/models/source_coin_api.py index eb642f2d..8f74c57c 100644 --- a/src/airbyte/models/shared/source_coin_api.py +++ b/src/airbyte_api/models/source_coin_api.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_coinmarketcap.py b/src/airbyte_api/models/source_coinmarketcap.py similarity index 98% rename from src/airbyte/models/shared/source_coinmarketcap.py rename to src/airbyte_api/models/source_coinmarketcap.py index 8285c346..aa04805a 100644 --- a/src/airbyte/models/shared/source_coinmarketcap.py +++ b/src/airbyte_api/models/source_coinmarketcap.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, List, Optional diff --git a/src/airbyte/models/shared/source_configcat.py b/src/airbyte_api/models/source_configcat.py similarity index 97% rename from src/airbyte/models/shared/source_configcat.py rename to src/airbyte_api/models/source_configcat.py index 00222c28..7d8b890d 100644 --- a/src/airbyte/models/shared/source_configcat.py +++ b/src/airbyte_api/models/source_configcat.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_confluence.py b/src/airbyte_api/models/source_confluence.py similarity index 97% rename from src/airbyte/models/shared/source_confluence.py rename to src/airbyte_api/models/source_confluence.py index 7f995e69..e43d0041 100644 --- a/src/airbyte/models/shared/source_confluence.py +++ b/src/airbyte_api/models/source_confluence.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_convex.py b/src/airbyte_api/models/source_convex.py similarity index 96% rename from src/airbyte/models/shared/source_convex.py rename to src/airbyte_api/models/source_convex.py index adcb24c3..71fef2d5 100644 --- a/src/airbyte/models/shared/source_convex.py +++ b/src/airbyte_api/models/source_convex.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_datascope.py b/src/airbyte_api/models/source_datascope.py similarity index 96% rename from src/airbyte/models/shared/source_datascope.py rename to src/airbyte_api/models/source_datascope.py index 976b3448..73ecac03 100644 --- a/src/airbyte/models/shared/source_datascope.py +++ b/src/airbyte_api/models/source_datascope.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_delighted.py b/src/airbyte_api/models/source_delighted.py similarity index 97% rename from src/airbyte/models/shared/source_delighted.py rename to src/airbyte_api/models/source_delighted.py index e152cc7b..42bc6c1c 100644 --- a/src/airbyte/models/shared/source_delighted.py +++ b/src/airbyte_api/models/source_delighted.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_dixa.py b/src/airbyte_api/models/source_dixa.py similarity index 97% rename from src/airbyte/models/shared/source_dixa.py rename to src/airbyte_api/models/source_dixa.py index 5e648411..64788ea8 100644 --- a/src/airbyte/models/shared/source_dixa.py +++ b/src/airbyte_api/models/source_dixa.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_dockerhub.py b/src/airbyte_api/models/source_dockerhub.py similarity index 96% rename from src/airbyte/models/shared/source_dockerhub.py rename to src/airbyte_api/models/source_dockerhub.py index e050b514..16f64a24 100644 --- a/src/airbyte/models/shared/source_dockerhub.py +++ b/src/airbyte_api/models/source_dockerhub.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_dremio.py b/src/airbyte_api/models/source_dremio.py similarity index 97% rename from src/airbyte/models/shared/source_dremio.py rename to src/airbyte_api/models/source_dremio.py index 74bb110b..5919e3b1 100644 --- a/src/airbyte/models/shared/source_dremio.py +++ b/src/airbyte_api/models/source_dremio.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_dynamodb.py b/src/airbyte_api/models/source_dynamodb.py similarity index 99% rename from src/airbyte/models/shared/source_dynamodb.py rename to src/airbyte_api/models/source_dynamodb.py index c7da4b76..c833a118 100644 --- a/src/airbyte/models/shared/source_dynamodb.py +++ b/src/airbyte_api/models/source_dynamodb.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_e2e_test_cloud.py b/src/airbyte_api/models/source_e2e_test_cloud.py similarity index 99% rename from src/airbyte/models/shared/source_e2e_test_cloud.py rename to src/airbyte_api/models/source_e2e_test_cloud.py index 25aa79ba..2f15ddd6 100644 --- a/src/airbyte/models/shared/source_e2e_test_cloud.py +++ b/src/airbyte_api/models/source_e2e_test_cloud.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Any, Dict, Final, Optional, Union diff --git a/src/airbyte/models/shared/source_emailoctopus.py b/src/airbyte_api/models/source_emailoctopus.py similarity index 96% rename from src/airbyte/models/shared/source_emailoctopus.py rename to src/airbyte_api/models/source_emailoctopus.py index 017ffeaa..7a931b1f 100644 --- a/src/airbyte/models/shared/source_emailoctopus.py +++ b/src/airbyte_api/models/source_emailoctopus.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_exchange_rates.py b/src/airbyte_api/models/source_exchange_rates.py similarity index 98% rename from src/airbyte/models/shared/source_exchange_rates.py rename to src/airbyte_api/models/source_exchange_rates.py index 821beb0e..00bfeaaa 100644 --- a/src/airbyte/models/shared/source_exchange_rates.py +++ b/src/airbyte_api/models/source_exchange_rates.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import date from enum import Enum diff --git a/src/airbyte/models/shared/source_facebook_marketing.py b/src/airbyte_api/models/source_facebook_marketing.py similarity index 84% rename from src/airbyte/models/shared/source_facebook_marketing.py rename to src/airbyte_api/models/source_facebook_marketing.py index 3f1eace9..b388e572 100644 --- a/src/airbyte/models/shared/source_facebook_marketing.py +++ b/src/airbyte_api/models/source_facebook_marketing.py @@ -3,12 +3,46 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum from typing import Final, List, Optional +class ValidAdStatuses(str, Enum): + r"""An enumeration.""" + ACTIVE = 'ACTIVE' + ADSET_PAUSED = 'ADSET_PAUSED' + ARCHIVED = 'ARCHIVED' + CAMPAIGN_PAUSED = 'CAMPAIGN_PAUSED' + DELETED = 'DELETED' + DISAPPROVED = 'DISAPPROVED' + IN_PROCESS = 'IN_PROCESS' + PAUSED = 'PAUSED' + PENDING_BILLING_INFO = 'PENDING_BILLING_INFO' + PENDING_REVIEW = 'PENDING_REVIEW' + PREAPPROVED = 'PREAPPROVED' + WITH_ISSUES = 'WITH_ISSUES' + +class ValidAdSetStatuses(str, Enum): + r"""An enumeration.""" + ACTIVE = 'ACTIVE' + ARCHIVED = 'ARCHIVED' + CAMPAIGN_PAUSED = 'CAMPAIGN_PAUSED' + DELETED = 'DELETED' + IN_PROCESS = 'IN_PROCESS' + PAUSED = 'PAUSED' + WITH_ISSUES = 'WITH_ISSUES' + +class ValidCampaignStatuses(str, Enum): + r"""An enumeration.""" + ACTIVE = 'ACTIVE' + ARCHIVED = 'ARCHIVED' + DELETED = 'DELETED' + IN_PROCESS = 'IN_PROCESS' + PAUSED = 'PAUSED' + WITH_ISSUES = 'WITH_ISSUES' + class ValidActionBreakdowns(str, Enum): r"""An enumeration.""" ACTION_CANVAS_COMPONENT_NAME = 'action_canvas_component_name' @@ -21,8 +55,9 @@ class ValidActionBreakdowns(str, Enum): ACTION_TYPE = 'action_type' ACTION_VIDEO_SOUND = 'action_video_sound' ACTION_VIDEO_TYPE = 'action_video_type' + STANDARD_EVENT_CONTENT_TYPE = 'standard_event_content_type' -class ActionReportTime(str, Enum): +class SourceFacebookMarketingActionReportTime(str, Enum): r"""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.""" CONVERSION = 'conversion' IMPRESSION = 'impression' @@ -49,7 +84,16 @@ class ValidBreakdowns(str, Enum): IMAGE_ASSET = 'image_asset' IMPRESSION_DEVICE = 'impression_device' IS_CONVERSION_ID_MODELED = 'is_conversion_id_modeled' + LANDING_DESTINATION = 'landing_destination' LINK_URL_ASSET = 'link_url_asset' + MARKETING_MESSAGES_BTN_NAME = 'marketing_messages_btn_name' + MDSA_LANDING_DESTINATION = 'mdsa_landing_destination' + MEDIA_ASSET_URL = 'media_asset_url' + MEDIA_CREATOR = 'media_creator' + MEDIA_DESTINATION_URL = 'media_destination_url' + MEDIA_FORMAT = 'media_format' + MEDIA_ORIGIN_URL = 'media_origin_url' + MEDIA_TEXT_CONTENT = 'media_text_content' MMM = 'mmm' PLACE_PAGE_ID = 'place_page_id' PLATFORM_POSITION = 'platform_position' @@ -60,6 +104,8 @@ class ValidBreakdowns(str, Enum): REGION = 'region' SKAN_CAMPAIGN_ID = 'skan_campaign_id' SKAN_CONVERSION_ID = 'skan_conversion_id' + SKAN_VERSION = 'skan_version' + STANDARD_EVENT_CONTENT_TYPE = 'standard_event_content_type' TITLE_ASSET = 'title_asset' VIDEO_ASSET = 'video_asset' @@ -94,6 +140,7 @@ class SourceFacebookMarketingValidEnums(str, Enum): CATALOG_SEGMENT_VALUE_OMNI_PURCHASE_ROAS = 'catalog_segment_value_omni_purchase_roas' CATALOG_SEGMENT_VALUE_WEBSITE_PURCHASE_ROAS = 'catalog_segment_value_website_purchase_roas' CLICKS = 'clicks' + CONVERSION_LEAD_RATE = 'conversion_lead_rate' CONVERSION_RATE_RANKING = 'conversion_rate_ranking' CONVERSION_VALUES = 'conversion_values' CONVERSIONS = 'conversions' @@ -104,6 +151,7 @@ class SourceFacebookMarketingValidEnums(str, Enum): COST_PER_ACTION_TYPE = 'cost_per_action_type' COST_PER_AD_CLICK = 'cost_per_ad_click' COST_PER_CONVERSION = 'cost_per_conversion' + COST_PER_CONVERSION_LEAD = 'cost_per_conversion_lead' COST_PER_DDA_COUNTBY_CONVS = 'cost_per_dda_countby_convs' COST_PER_ESTIMATED_AD_RECALLERS = 'cost_per_estimated_ad_recallers' COST_PER_INLINE_LINK_CLICK = 'cost_per_inline_link_click' @@ -148,6 +196,9 @@ class SourceFacebookMarketingValidEnums(str, Enum): INTERACTIVE_COMPONENT_TAP = 'interactive_component_tap' LABELS = 'labels' LOCATION = 'location' + MARKETING_MESSAGES_COST_PER_DELIVERED = 'marketing_messages_cost_per_delivered' + MARKETING_MESSAGES_COST_PER_LINK_BTN_CLICK = 'marketing_messages_cost_per_link_btn_click' + MARKETING_MESSAGES_SPEND = 'marketing_messages_spend' MOBILE_APP_PURCHASE_ROAS = 'mobile_app_purchase_roas' OBJECTIVE = 'objective' OPTIMIZATION_GOAL = 'optimization_goal' @@ -157,9 +208,6 @@ class SourceFacebookMarketingValidEnums(str, Enum): PURCHASE_ROAS = 'purchase_roas' QUALIFYING_QUESTION_QUALIFY_ANSWER_RATE = 'qualifying_question_qualify_answer_rate' QUALITY_RANKING = 'quality_ranking' - QUALITY_SCORE_ECTR = 'quality_score_ectr' - QUALITY_SCORE_ECVR = 'quality_score_ecvr' - QUALITY_SCORE_ORGANIC = 'quality_score_organic' REACH = 'reach' SOCIAL_SPEND = 'social_spend' SPEND = 'spend' @@ -214,7 +262,7 @@ class InsightConfig: r"""The name value of insight""" action_breakdowns: Optional[List[ValidActionBreakdowns]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('action_breakdowns'), 'exclude': lambda f: f is None }}) r"""A list of chosen action_breakdowns for action_breakdowns""" - action_report_time: Optional[ActionReportTime] = dataclasses.field(default=ActionReportTime.MIXED, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('action_report_time'), 'exclude': lambda f: f is None }}) + action_report_time: Optional[SourceFacebookMarketingActionReportTime] = dataclasses.field(default=SourceFacebookMarketingActionReportTime.MIXED, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('action_report_time'), 'exclude': lambda f: f is None }}) r"""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: Optional[List[ValidBreakdowns]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('breakdowns'), 'exclude': lambda f: f is None }}) r"""A list of chosen breakdowns for breakdowns""" @@ -248,6 +296,12 @@ class SourceFacebookMarketing: 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.""" 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""" + ad_statuses: Optional[List[ValidAdStatuses]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ad_statuses'), 'exclude': lambda f: f is None }}) + r"""Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out.""" + adset_statuses: Optional[List[ValidAdSetStatuses]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('adset_statuses'), 'exclude': lambda f: f is None }}) + r"""Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out.""" + campaign_statuses: Optional[List[ValidCampaignStatuses]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('campaign_statuses'), 'exclude': lambda f: f is None }}) + r"""Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out.""" 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 app""" 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 }}) @@ -258,8 +312,6 @@ class SourceFacebookMarketing: r"""The date until which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. All data generated between the start date and this end date will be replicated. Not setting this option will result in always syncing the latest data.""" fetch_thumbnail_images: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fetch_thumbnail_images'), 'exclude': lambda f: f is None }}) r"""Set to active if you want to fetch the thumbnail_url and store the result in thumbnail_data_url for each Ad Creative.""" - include_deleted: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('include_deleted'), 'exclude': lambda f: f is None }}) - r"""Set to active if you want to include data from deleted Campaigns, Ads, and AdSets.""" insights_job_timeout: Optional[int] = dataclasses.field(default=60, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('insights_job_timeout'), 'exclude': lambda f: f is None }}) r"""Insights Job Timeout establishes the maximum amount of time (in minutes) of waiting for the report job to complete. When timeout is reached the job is considered failed and we are trying to request smaller amount of data by breaking the job to few smaller ones. If you definitely know that 60 minutes is not enough for your report to be processed then you can decrease the timeout value, so we start breaking job to smaller parts faster.""" insights_lookback_window: Optional[int] = dataclasses.field(default=28, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('insights_lookback_window'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/source_faker.py b/src/airbyte_api/models/source_faker.py similarity index 89% rename from src/airbyte/models/shared/source_faker.py rename to src/airbyte_api/models/source_faker.py index 2d3c6824..05ed8607 100644 --- a/src/airbyte/models/shared/source_faker.py +++ b/src/airbyte_api/models/source_faker.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional @@ -17,7 +17,7 @@ class SourceFaker: 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 }}) - r"""How many users should be generated in total. This setting does not apply to the purchases or products stream.""" + r"""How many users should be generated in total. The purchases table will be scaled to match, with 10 purchases created per 10 users. This setting does not apply to the products stream.""" parallelism: Optional[int] = dataclasses.field(default=4, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('parallelism'), 'exclude': lambda f: f is None }}) r"""How many parallel workers should we use to generate fake data? Choose a value equal to the number of CPUs you will allocate to this source.""" records_per_slice: Optional[int] = dataclasses.field(default=1000, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('records_per_slice'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/source_fauna.py b/src/airbyte_api/models/source_fauna.py similarity index 99% rename from src/airbyte/models/shared/source_fauna.py rename to src/airbyte_api/models/source_fauna.py index bc745522..a694e5dd 100644 --- a/src/airbyte/models/shared/source_fauna.py +++ b/src/airbyte_api/models/source_fauna.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/source_file.py b/src/airbyte_api/models/source_file.py similarity index 99% rename from src/airbyte/models/shared/source_file.py rename to src/airbyte_api/models/source_file.py index 2adeddc7..daf3532d 100644 --- a/src/airbyte/models/shared/source_file.py +++ b/src/airbyte_api/models/source_file.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/source_firebolt.py b/src/airbyte_api/models/source_firebolt.py similarity index 85% rename from src/airbyte/models/shared/source_firebolt.py rename to src/airbyte_api/models/source_firebolt.py index e849f3ea..a30a9d71 100644 --- a/src/airbyte/models/shared/source_firebolt.py +++ b/src/airbyte_api/models/source_firebolt.py @@ -2,12 +2,12 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional -class SourceFireboltFirebolt(str, Enum): +class Firebolt(str, Enum): FIREBOLT = 'firebolt' @@ -26,6 +26,6 @@ class SourceFirebolt: 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') }}) + SOURCE_TYPE: Final[Firebolt] = dataclasses.field(default=Firebolt.FIREBOLT, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_freshcaller.py b/src/airbyte_api/models/source_freshcaller.py similarity index 98% rename from src/airbyte/models/shared/source_freshcaller.py rename to src/airbyte_api/models/source_freshcaller.py index a2b47f72..788cc47d 100644 --- a/src/airbyte/models/shared/source_freshcaller.py +++ b/src/airbyte_api/models/source_freshcaller.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_freshdesk.py b/src/airbyte_api/models/source_freshdesk.py similarity index 85% rename from src/airbyte/models/shared/source_freshdesk.py rename to src/airbyte_api/models/source_freshdesk.py index d516adfb..91474baa 100644 --- a/src/airbyte/models/shared/source_freshdesk.py +++ b/src/airbyte_api/models/source_freshdesk.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum @@ -20,6 +20,8 @@ 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""" + lookback_window_in_days: Optional[int] = dataclasses.field(default=14, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lookback_window_in_days'), 'exclude': lambda f: f is None }}) + r"""Number of days for lookback window for the stream Satisfaction Ratings""" 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') }}) diff --git a/src/airbyte/models/shared/source_freshsales.py b/src/airbyte_api/models/source_freshsales.py similarity index 97% rename from src/airbyte/models/shared/source_freshsales.py rename to src/airbyte_api/models/source_freshsales.py index a29f87ad..9f72ecfe 100644 --- a/src/airbyte/models/shared/source_freshsales.py +++ b/src/airbyte_api/models/source_freshsales.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_gainsight_px.py b/src/airbyte_api/models/source_gainsight_px.py similarity index 96% rename from src/airbyte/models/shared/source_gainsight_px.py rename to src/airbyte_api/models/source_gainsight_px.py index 35c0ae43..7cacd3f9 100644 --- a/src/airbyte/models/shared/source_gainsight_px.py +++ b/src/airbyte_api/models/source_gainsight_px.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_gcs.py b/src/airbyte_api/models/source_gcs.py similarity index 96% rename from src/airbyte/models/shared/source_gcs.py rename to src/airbyte_api/models/source_gcs.py index ea4100b5..8c591970 100644 --- a/src/airbyte/models/shared/source_gcs.py +++ b/src/airbyte_api/models/source_gcs.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum @@ -72,6 +72,8 @@ class SourceGcsCSVFormat: FILETYPE: Final[Optional[SourceGcsFiletype]] = dataclasses.field(default=SourceGcsFiletype.CSV, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filetype'), 'exclude': lambda f: f is None }}) header_definition: Optional[Union[SourceGcsFromCSV, SourceGcsAutogenerated, SourceGcsUserProvided]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('header_definition'), 'exclude': lambda f: f is None }}) r"""How headers will be defined. `User Provided` assumes the CSV does not have a header row and uses the headers provided and `Autogenerated` assumes the CSV does not have a header row and the CDK will generate headers using for `f{i}` where `i` is the index starting from 0. Else, the default behavior is to use the header from the CSV file. If a user wants to autogenerate or provide column names for a CSV having headers, they can skip rows.""" + ignore_errors_on_fields_mismatch: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ignore_errors_on_fields_mismatch'), 'exclude': lambda f: f is None }}) + r"""Whether to ignore errors that occur when the number of fields in the CSV does not match the number of columns in the schema.""" inference_type: Optional[SourceGcsInferenceType] = dataclasses.field(default=SourceGcsInferenceType.NONE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('inference_type'), 'exclude': lambda f: f is None }}) r"""How to infer the types of the columns. If none, inference default to strings.""" null_values: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('null_values'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/source_getlago.py b/src/airbyte_api/models/source_getlago.py similarity index 97% rename from src/airbyte/models/shared/source_getlago.py rename to src/airbyte_api/models/source_getlago.py index 74339911..5b56a04c 100644 --- a/src/airbyte/models/shared/source_getlago.py +++ b/src/airbyte_api/models/source_getlago.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_github.py b/src/airbyte_api/models/source_github.py similarity index 97% rename from src/airbyte/models/shared/source_github.py rename to src/airbyte_api/models/source_github.py index 2b8c66ed..22cf9081 100644 --- a/src/airbyte/models/shared/source_github.py +++ b/src/airbyte_api/models/source_github.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum @@ -49,7 +49,7 @@ class SourceGithub: credentials: Union[OAuth, SourceGithubPersonalAccessToken] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials') }}) 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.""" + r"""List of GitHub organizations/repositories, e.g. `airbytehq/airbyte` for single repository, `airbytehq/*` for get all repositories from organization and `airbytehq/a* for matching multiple repositories by pattern.""" 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 }}) diff --git a/src/airbyte/models/shared/source_gitlab.py b/src/airbyte_api/models/source_gitlab.py similarity index 99% rename from src/airbyte/models/shared/source_gitlab.py rename to src/airbyte_api/models/source_gitlab.py index 4d4f5d74..be133775 100644 --- a/src/airbyte/models/shared/source_gitlab.py +++ b/src/airbyte_api/models/source_gitlab.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_glassfrog.py b/src/airbyte_api/models/source_glassfrog.py similarity index 95% rename from src/airbyte/models/shared/source_glassfrog.py rename to src/airbyte_api/models/source_glassfrog.py index 6c1a4782..8fa36937 100644 --- a/src/airbyte/models/shared/source_glassfrog.py +++ b/src/airbyte_api/models/source_glassfrog.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_gnews.py b/src/airbyte_api/models/source_gnews.py similarity index 99% rename from src/airbyte/models/shared/source_gnews.py rename to src/airbyte_api/models/source_gnews.py index 907d254f..95881cbd 100644 --- a/src/airbyte/models/shared/source_gnews.py +++ b/src/airbyte_api/models/source_gnews.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, List, Optional diff --git a/src/airbyte/models/shared/source_google_ads.py b/src/airbyte_api/models/source_google_ads.py similarity index 99% rename from src/airbyte/models/shared/source_google_ads.py rename to src/airbyte_api/models/source_google_ads.py index 172cccab..d3fa4b9c 100644 --- a/src/airbyte/models/shared/source_google_ads.py +++ b/src/airbyte_api/models/source_google_ads.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import date from enum import Enum diff --git a/src/airbyte/models/shared/source_google_analytics_data_api.py b/src/airbyte_api/models/source_google_analytics_data_api.py similarity index 99% rename from src/airbyte/models/shared/source_google_analytics_data_api.py rename to src/airbyte_api/models/source_google_analytics_data_api.py index 31028839..85655fea 100644 --- a/src/airbyte/models/shared/source_google_analytics_data_api.py +++ b/src/airbyte_api/models/source_google_analytics_data_api.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import date from enum import Enum diff --git a/src/airbyte/models/shared/source_google_analytics_v4_service_account_only.py b/src/airbyte_api/models/source_google_analytics_v4_service_account_only.py similarity index 99% rename from src/airbyte/models/shared/source_google_analytics_v4_service_account_only.py rename to src/airbyte_api/models/source_google_analytics_v4_service_account_only.py index 5199d328..2bc292bd 100644 --- a/src/airbyte/models/shared/source_google_analytics_v4_service_account_only.py +++ b/src/airbyte_api/models/source_google_analytics_v4_service_account_only.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import date from enum import Enum diff --git a/src/airbyte/models/shared/source_google_directory.py b/src/airbyte_api/models/source_google_directory.py similarity index 99% rename from src/airbyte/models/shared/source_google_directory.py rename to src/airbyte_api/models/source_google_directory.py index 1808de11..df8fe6ba 100644 --- a/src/airbyte/models/shared/source_google_directory.py +++ b/src/airbyte_api/models/source_google_directory.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/source_google_drive.py b/src/airbyte_api/models/source_google_drive.py similarity index 99% rename from src/airbyte/models/shared/source_google_drive.py rename to src/airbyte_api/models/source_google_drive.py index 88a03f9c..da795371 100644 --- a/src/airbyte/models/shared/source_google_drive.py +++ b/src/airbyte_api/models/source_google_drive.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_google_pagespeed_insights.py b/src/airbyte_api/models/source_google_pagespeed_insights.py similarity index 98% rename from src/airbyte/models/shared/source_google_pagespeed_insights.py rename to src/airbyte_api/models/source_google_pagespeed_insights.py index 10f4989c..485a07d9 100644 --- a/src/airbyte/models/shared/source_google_pagespeed_insights.py +++ b/src/airbyte_api/models/source_google_pagespeed_insights.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, List, Optional diff --git a/src/airbyte/models/shared/source_google_search_console.py b/src/airbyte_api/models/source_google_search_console.py similarity index 99% rename from src/airbyte/models/shared/source_google_search_console.py rename to src/airbyte_api/models/source_google_search_console.py index d195921e..1f5f4251 100644 --- a/src/airbyte/models/shared/source_google_search_console.py +++ b/src/airbyte_api/models/source_google_search_console.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import date from enum import Enum diff --git a/src/airbyte/models/shared/source_google_sheets.py b/src/airbyte_api/models/source_google_sheets.py similarity index 99% rename from src/airbyte/models/shared/source_google_sheets.py rename to src/airbyte_api/models/source_google_sheets.py index df954c0b..9be21d2f 100644 --- a/src/airbyte/models/shared/source_google_sheets.py +++ b/src/airbyte_api/models/source_google_sheets.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/source_google_webfonts.py b/src/airbyte_api/models/source_google_webfonts.py similarity index 98% rename from src/airbyte/models/shared/source_google_webfonts.py rename to src/airbyte_api/models/source_google_webfonts.py index 2feb1ff7..826584a4 100644 --- a/src/airbyte/models/shared/source_google_webfonts.py +++ b/src/airbyte_api/models/source_google_webfonts.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_greenhouse.py b/src/airbyte_api/models/source_greenhouse.py similarity index 96% rename from src/airbyte/models/shared/source_greenhouse.py rename to src/airbyte_api/models/source_greenhouse.py index f1c8a41f..4bc6fde5 100644 --- a/src/airbyte/models/shared/source_greenhouse.py +++ b/src/airbyte_api/models/source_greenhouse.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_gridly.py b/src/airbyte_api/models/source_gridly.py similarity index 96% rename from src/airbyte/models/shared/source_gridly.py rename to src/airbyte_api/models/source_gridly.py index 0cbc7333..4880bd74 100644 --- a/src/airbyte/models/shared/source_gridly.py +++ b/src/airbyte_api/models/source_gridly.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_harvest.py b/src/airbyte_api/models/source_harvest.py similarity index 99% rename from src/airbyte/models/shared/source_harvest.py rename to src/airbyte_api/models/source_harvest.py index 5bf0e0fb..fb106955 100644 --- a/src/airbyte/models/shared/source_harvest.py +++ b/src/airbyte_api/models/source_harvest.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_hubplanner.py b/src/airbyte_api/models/source_hubplanner.py similarity index 96% rename from src/airbyte/models/shared/source_hubplanner.py rename to src/airbyte_api/models/source_hubplanner.py index eb5b5fab..f72eb9c5 100644 --- a/src/airbyte/models/shared/source_hubplanner.py +++ b/src/airbyte_api/models/source_hubplanner.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_hubspot.py b/src/airbyte_api/models/source_hubspot.py similarity index 86% rename from src/airbyte/models/shared/source_hubspot.py rename to src/airbyte_api/models/source_hubspot.py index fd17d02b..ca10e8ea 100644 --- a/src/airbyte/models/shared/source_hubspot.py +++ b/src/airbyte_api/models/source_hubspot.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum @@ -52,10 +52,10 @@ class SourceHubspotHubspot(str, Enum): class SourceHubspot: credentials: Union[SourceHubspotOAuth, PrivateApp] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials') }}) 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.""" 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') }}) + 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:00Z. Any data before this date will not be replicated. If not set, \\"2006-06-01T00:00:00Z\\" (Hubspot creation date) will be used as start date. It's recommended to provide relevant to your data start date value to optimize synchronization.""" diff --git a/src/airbyte/models/shared/source_insightly.py b/src/airbyte_api/models/source_insightly.py similarity index 97% rename from src/airbyte/models/shared/source_insightly.py rename to src/airbyte_api/models/source_insightly.py index f5e0eab9..10c8f1f8 100644 --- a/src/airbyte/models/shared/source_insightly.py +++ b/src/airbyte_api/models/source_insightly.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_instagram.py b/src/airbyte_api/models/source_instagram.py similarity index 98% rename from src/airbyte/models/shared/source_instagram.py rename to src/airbyte_api/models/source_instagram.py index e7db1b0c..773d7e61 100644 --- a/src/airbyte/models/shared/source_instagram.py +++ b/src/airbyte_api/models/source_instagram.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_instatus.py b/src/airbyte_api/models/source_instatus.py similarity index 95% rename from src/airbyte/models/shared/source_instatus.py rename to src/airbyte_api/models/source_instatus.py index e4f52e1c..f9404333 100644 --- a/src/airbyte/models/shared/source_instatus.py +++ b/src/airbyte_api/models/source_instatus.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_intercom.py b/src/airbyte_api/models/source_intercom.py similarity index 98% rename from src/airbyte/models/shared/source_intercom.py rename to src/airbyte_api/models/source_intercom.py index 286b4c1e..b6f46900 100644 --- a/src/airbyte/models/shared/source_intercom.py +++ b/src/airbyte_api/models/source_intercom.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_ip2whois.py b/src/airbyte_api/models/source_ip2whois.py similarity index 97% rename from src/airbyte/models/shared/source_ip2whois.py rename to src/airbyte_api/models/source_ip2whois.py index 55aa92fd..1fff254f 100644 --- a/src/airbyte/models/shared/source_ip2whois.py +++ b/src/airbyte_api/models/source_ip2whois.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_iterable.py b/src/airbyte_api/models/source_iterable.py similarity index 97% rename from src/airbyte/models/shared/source_iterable.py rename to src/airbyte_api/models/source_iterable.py index b69c3dd8..1f15eb27 100644 --- a/src/airbyte/models/shared/source_iterable.py +++ b/src/airbyte_api/models/source_iterable.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_jira.py b/src/airbyte_api/models/source_jira.py similarity index 99% rename from src/airbyte/models/shared/source_jira.py rename to src/airbyte_api/models/source_jira.py index 9fd3e552..b5e4b73c 100644 --- a/src/airbyte/models/shared/source_jira.py +++ b/src/airbyte_api/models/source_jira.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_k6_cloud.py b/src/airbyte_api/models/source_k6_cloud.py similarity index 96% rename from src/airbyte/models/shared/source_k6_cloud.py rename to src/airbyte_api/models/source_k6_cloud.py index a1a8d444..f98288c2 100644 --- a/src/airbyte/models/shared/source_k6_cloud.py +++ b/src/airbyte_api/models/source_k6_cloud.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_klarna.py b/src/airbyte_api/models/source_klarna.py similarity index 98% rename from src/airbyte/models/shared/source_klarna.py rename to src/airbyte_api/models/source_klarna.py index 72cfd356..c4c03e6c 100644 --- a/src/airbyte/models/shared/source_klarna.py +++ b/src/airbyte_api/models/source_klarna.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_klaviyo.py b/src/airbyte_api/models/source_klaviyo.py similarity index 97% rename from src/airbyte/models/shared/source_klaviyo.py rename to src/airbyte_api/models/source_klaviyo.py index 89e94728..26387f7e 100644 --- a/src/airbyte/models/shared/source_klaviyo.py +++ b/src/airbyte_api/models/source_klaviyo.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_kyve.py b/src/airbyte_api/models/source_kyve.py similarity index 98% rename from src/airbyte/models/shared/source_kyve.py rename to src/airbyte_api/models/source_kyve.py index 63e43bbb..ec61aea2 100644 --- a/src/airbyte/models/shared/source_kyve.py +++ b/src/airbyte_api/models/source_kyve.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_launchdarkly.py b/src/airbyte_api/models/source_launchdarkly.py similarity index 96% rename from src/airbyte/models/shared/source_launchdarkly.py rename to src/airbyte_api/models/source_launchdarkly.py index 29a85f6d..024385b3 100644 --- a/src/airbyte/models/shared/source_launchdarkly.py +++ b/src/airbyte_api/models/source_launchdarkly.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_lemlist.py b/src/airbyte_api/models/source_lemlist.py similarity index 95% rename from src/airbyte/models/shared/source_lemlist.py rename to src/airbyte_api/models/source_lemlist.py index 2f18a84e..d61a76fd 100644 --- a/src/airbyte/models/shared/source_lemlist.py +++ b/src/airbyte_api/models/source_lemlist.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_lever_hiring.py b/src/airbyte_api/models/source_lever_hiring.py similarity index 99% rename from src/airbyte/models/shared/source_lever_hiring.py rename to src/airbyte_api/models/source_lever_hiring.py index 6193e793..a1e96707 100644 --- a/src/airbyte/models/shared/source_lever_hiring.py +++ b/src/airbyte_api/models/source_lever_hiring.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/source_linkedin_ads.py b/src/airbyte_api/models/source_linkedin_ads.py similarity index 99% rename from src/airbyte/models/shared/source_linkedin_ads.py rename to src/airbyte_api/models/source_linkedin_ads.py index 82903fbc..be953a48 100644 --- a/src/airbyte/models/shared/source_linkedin_ads.py +++ b/src/airbyte_api/models/source_linkedin_ads.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import date from enum import Enum diff --git a/src/airbyte/models/shared/source_linkedin_pages.py b/src/airbyte_api/models/source_linkedin_pages.py similarity index 98% rename from src/airbyte/models/shared/source_linkedin_pages.py rename to src/airbyte_api/models/source_linkedin_pages.py index f9640a4d..61729a57 100644 --- a/src/airbyte/models/shared/source_linkedin_pages.py +++ b/src/airbyte_api/models/source_linkedin_pages.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte_api/models/source_linnworks.py b/src/airbyte_api/models/source_linnworks.py new file mode 100644 index 00000000..3145fd3a --- /dev/null +++ b/src/airbyte_api/models/source_linnworks.py @@ -0,0 +1,28 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +import dateutil.parser +from airbyte_api import utils +from dataclasses_json import Undefined, dataclass_json +from datetime import datetime +from enum import Enum +from typing import Final + +class Linnworks(str, Enum): + LINNWORKS = 'linnworks' + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class SourceLinnworks: + application_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('application_id') }}) + r"""Linnworks Application ID""" + application_secret: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('application_secret') }}) + r"""Linnworks Application Secret""" + 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.""" + token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('token') }}) + SOURCE_TYPE: Final[Linnworks] = dataclasses.field(default=Linnworks.LINNWORKS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) + + diff --git a/src/airbyte/models/shared/source_lokalise.py b/src/airbyte_api/models/source_lokalise.py similarity index 97% rename from src/airbyte/models/shared/source_lokalise.py rename to src/airbyte_api/models/source_lokalise.py index bc3619fd..48cc6fc6 100644 --- a/src/airbyte/models/shared/source_lokalise.py +++ b/src/airbyte_api/models/source_lokalise.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_mailchimp.py b/src/airbyte_api/models/source_mailchimp.py similarity index 93% rename from src/airbyte/models/shared/source_mailchimp.py rename to src/airbyte_api/models/source_mailchimp.py index 86d13cb2..f1d68992 100644 --- a/src/airbyte/models/shared/source_mailchimp.py +++ b/src/airbyte_api/models/source_mailchimp.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum @@ -46,8 +46,9 @@ class SourceMailchimpMailchimp(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SourceMailchimp: - 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 }}) + data_center: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data_center'), 'exclude': lambda f: f is None }}) + r"""Technical fields used to identify datacenter to send request to""" 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_api/models/source_mailgun.py similarity index 98% rename from src/airbyte/models/shared/source_mailgun.py rename to src/airbyte_api/models/source_mailgun.py index 500e7382..af99dfae 100644 --- a/src/airbyte/models/shared/source_mailgun.py +++ b/src/airbyte_api/models/source_mailgun.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_mailjet_sms.py b/src/airbyte_api/models/source_mailjet_sms.py similarity index 97% rename from src/airbyte/models/shared/source_mailjet_sms.py rename to src/airbyte_api/models/source_mailjet_sms.py index 95efa0ac..b833ca59 100644 --- a/src/airbyte/models/shared/source_mailjet_sms.py +++ b/src/airbyte_api/models/source_mailjet_sms.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_marketo.py b/src/airbyte_api/models/source_marketo.py similarity index 98% rename from src/airbyte/models/shared/source_marketo.py rename to src/airbyte_api/models/source_marketo.py index 4416a023..733721e8 100644 --- a/src/airbyte/models/shared/source_marketo.py +++ b/src/airbyte_api/models/source_marketo.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_metabase.py b/src/airbyte_api/models/source_metabase.py similarity index 98% rename from src/airbyte/models/shared/source_metabase.py rename to src/airbyte_api/models/source_metabase.py index 6cecc487..ffd927bf 100644 --- a/src/airbyte/models/shared/source_metabase.py +++ b/src/airbyte_api/models/source_metabase.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte_api/models/source_microsoft_onedrive.py b/src/airbyte_api/models/source_microsoft_onedrive.py new file mode 100644 index 00000000..c203075a --- /dev/null +++ b/src/airbyte_api/models/source_microsoft_onedrive.py @@ -0,0 +1,259 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +import dateutil.parser +from airbyte_api import utils +from dataclasses_json import Undefined, dataclass_json +from datetime import datetime +from enum import Enum +from typing import Final, List, Optional, Union + +class SourceMicrosoftOnedriveSchemasAuthType(str, Enum): + SERVICE = 'Service' + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class ServiceKeyAuthentication: + r"""ServiceCredentials class for service key authentication. + This class is structured similarly to OAuthCredentials but for a different authentication method. + """ + client_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_id') }}) + r"""Client ID of your Microsoft developer application""" + client_secret: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_secret') }}) + r"""Client Secret of your Microsoft developer application""" + tenant_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tenant_id') }}) + r"""Tenant ID of the Microsoft OneDrive user""" + user_principal_name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('user_principal_name') }}) + r"""Special characters such as a period, comma, space, and the at sign (@) are converted to underscores (_). More details: https://learn.microsoft.com/en-us/sharepoint/list-onedrive-urls""" + AUTH_TYPE: Final[Optional[SourceMicrosoftOnedriveSchemasAuthType]] = dataclasses.field(default=SourceMicrosoftOnedriveSchemasAuthType.SERVICE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('auth_type'), 'exclude': lambda f: f is None }}) + + + +class SourceMicrosoftOnedriveAuthType(str, Enum): + CLIENT = 'Client' + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class AuthenticateViaMicrosoftOAuth: + r"""OAuthCredentials class to hold authentication details for Microsoft OAuth authentication. + This class uses pydantic for data validation and settings management. + """ + client_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_id') }}) + r"""Client ID of your Microsoft developer application""" + client_secret: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_secret') }}) + r"""Client Secret of your Microsoft developer application""" + refresh_token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('refresh_token') }}) + r"""Refresh Token of your Microsoft developer application""" + tenant_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tenant_id') }}) + r"""Tenant ID of the Microsoft OneDrive user""" + AUTH_TYPE: Final[Optional[SourceMicrosoftOnedriveAuthType]] = dataclasses.field(default=SourceMicrosoftOnedriveAuthType.CLIENT, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('auth_type'), 'exclude': lambda f: f is None }}) + + + +class SearchScope(str, Enum): + r"""Specifies the location(s) to search for files. Valid options are 'ACCESSIBLE_DRIVES' to search in the selected OneDrive drive, 'SHARED_ITEMS' for shared items the user has access to, and 'ALL' to search both.""" + ACCESSIBLE_DRIVES = 'ACCESSIBLE_DRIVES' + SHARED_ITEMS = 'SHARED_ITEMS' + ALL = 'ALL' + +class SourceMicrosoftOnedriveMicrosoftOnedrive(str, Enum): + MICROSOFT_ONEDRIVE = 'microsoft-onedrive' + +class SourceMicrosoftOnedriveSchemasStreamsFormatFormatFiletype(str, Enum): + UNSTRUCTURED = 'unstructured' + +class SourceMicrosoftOnedriveMode(str, Enum): + LOCAL = 'local' + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class SourceMicrosoftOnedriveLocal: + r"""Process files locally, supporting `fast` and `ocr` modes. This is the default option.""" + MODE: Final[Optional[SourceMicrosoftOnedriveMode]] = dataclasses.field(default=SourceMicrosoftOnedriveMode.LOCAL, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode'), 'exclude': lambda f: f is None }}) + + + +class SourceMicrosoftOnedriveParsingStrategy(str, Enum): + r"""The strategy used to parse documents. `fast` extracts text directly from the document which doesn't work for all files. `ocr_only` is more reliable, but slower. `hi_res` is the most reliable, but requires an API key and a hosted instance of unstructured and can't be used with local mode. See the unstructured.io documentation for more details: https://unstructured-io.github.io/unstructured/core/partition.html#partition-pdf""" + AUTO = 'auto' + FAST = 'fast' + OCR_ONLY = 'ocr_only' + HI_RES = 'hi_res' + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class SourceMicrosoftOnedriveDocumentFileTypeFormatExperimental: + r"""Extract text from document formats (.pdf, .docx, .md, .pptx) and emit as one record per file.""" + FILETYPE: Final[Optional[SourceMicrosoftOnedriveSchemasStreamsFormatFormatFiletype]] = dataclasses.field(default=SourceMicrosoftOnedriveSchemasStreamsFormatFormatFiletype.UNSTRUCTURED, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filetype'), 'exclude': lambda f: f is None }}) + processing: Optional[Union[SourceMicrosoftOnedriveLocal]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('processing'), 'exclude': lambda f: f is None }}) + r"""Processing configuration""" + skip_unprocessable_files: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('skip_unprocessable_files'), 'exclude': lambda f: f is None }}) + r"""If true, skip files that cannot be parsed and pass the error message along as the _ab_source_file_parse_error field. If false, fail the sync.""" + strategy: Optional[SourceMicrosoftOnedriveParsingStrategy] = dataclasses.field(default=SourceMicrosoftOnedriveParsingStrategy.AUTO, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('strategy'), 'exclude': lambda f: f is None }}) + r"""The strategy used to parse documents. `fast` extracts text directly from the document which doesn't work for all files. `ocr_only` is more reliable, but slower. `hi_res` is the most reliable, but requires an API key and a hosted instance of unstructured and can't be used with local mode. See the unstructured.io documentation for more details: https://unstructured-io.github.io/unstructured/core/partition.html#partition-pdf""" + + + +class SourceMicrosoftOnedriveSchemasStreamsFormatFiletype(str, Enum): + PARQUET = 'parquet' + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class SourceMicrosoftOnedriveParquetFormat: + decimal_as_float: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('decimal_as_float'), 'exclude': lambda f: f is None }}) + r"""Whether to convert decimal fields to floats. There is a loss of precision when converting decimals to floats, so this is not recommended.""" + FILETYPE: Final[Optional[SourceMicrosoftOnedriveSchemasStreamsFormatFiletype]] = dataclasses.field(default=SourceMicrosoftOnedriveSchemasStreamsFormatFiletype.PARQUET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filetype'), 'exclude': lambda f: f is None }}) + + + +class SourceMicrosoftOnedriveSchemasStreamsFiletype(str, Enum): + JSONL = 'jsonl' + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class SourceMicrosoftOnedriveJsonlFormat: + FILETYPE: Final[Optional[SourceMicrosoftOnedriveSchemasStreamsFiletype]] = dataclasses.field(default=SourceMicrosoftOnedriveSchemasStreamsFiletype.JSONL, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filetype'), 'exclude': lambda f: f is None }}) + + + +class SourceMicrosoftOnedriveSchemasFiletype(str, Enum): + CSV = 'csv' + +class SourceMicrosoftOnedriveSchemasStreamsHeaderDefinitionType(str, Enum): + USER_PROVIDED = 'User Provided' + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class SourceMicrosoftOnedriveUserProvided: + column_names: List[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('column_names') }}) + r"""The column names that will be used while emitting the CSV records""" + HEADER_DEFINITION_TYPE: Final[Optional[SourceMicrosoftOnedriveSchemasStreamsHeaderDefinitionType]] = dataclasses.field(default=SourceMicrosoftOnedriveSchemasStreamsHeaderDefinitionType.USER_PROVIDED, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('header_definition_type'), 'exclude': lambda f: f is None }}) + + + +class SourceMicrosoftOnedriveSchemasHeaderDefinitionType(str, Enum): + AUTOGENERATED = 'Autogenerated' + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class SourceMicrosoftOnedriveAutogenerated: + HEADER_DEFINITION_TYPE: Final[Optional[SourceMicrosoftOnedriveSchemasHeaderDefinitionType]] = dataclasses.field(default=SourceMicrosoftOnedriveSchemasHeaderDefinitionType.AUTOGENERATED, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('header_definition_type'), 'exclude': lambda f: f is None }}) + + + +class SourceMicrosoftOnedriveHeaderDefinitionType(str, Enum): + FROM_CSV = 'From CSV' + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class SourceMicrosoftOnedriveFromCSV: + HEADER_DEFINITION_TYPE: Final[Optional[SourceMicrosoftOnedriveHeaderDefinitionType]] = dataclasses.field(default=SourceMicrosoftOnedriveHeaderDefinitionType.FROM_CSV, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('header_definition_type'), 'exclude': lambda f: f is None }}) + + + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class SourceMicrosoftOnedriveCSVFormat: + delimiter: Optional[str] = dataclasses.field(default=',', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('delimiter'), 'exclude': lambda f: f is None }}) + r"""The character delimiting individual cells in the CSV data. This may only be a 1-character string. For tab-delimited data enter '\t'.""" + double_quote: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('double_quote'), 'exclude': lambda f: f is None }}) + r"""Whether two quotes in a quoted CSV value denote a single quote in the data.""" + encoding: Optional[str] = dataclasses.field(default='utf8', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('encoding'), 'exclude': lambda f: f is None }}) + r"""The character encoding of the CSV data. Leave blank to default to UTF8. See list of python encodings for allowable options.""" + escape_char: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('escape_char'), 'exclude': lambda f: f is None }}) + r"""The character used for escaping special characters. To disallow escaping, leave this field blank.""" + false_values: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('false_values'), 'exclude': lambda f: f is None }}) + r"""A set of case-sensitive strings that should be interpreted as false values.""" + FILETYPE: Final[Optional[SourceMicrosoftOnedriveSchemasFiletype]] = dataclasses.field(default=SourceMicrosoftOnedriveSchemasFiletype.CSV, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filetype'), 'exclude': lambda f: f is None }}) + header_definition: Optional[Union[SourceMicrosoftOnedriveFromCSV, SourceMicrosoftOnedriveAutogenerated, SourceMicrosoftOnedriveUserProvided]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('header_definition'), 'exclude': lambda f: f is None }}) + r"""How headers will be defined. `User Provided` assumes the CSV does not have a header row and uses the headers provided and `Autogenerated` assumes the CSV does not have a header row and the CDK will generate headers using for `f{i}` where `i` is the index starting from 0. Else, the default behavior is to use the header from the CSV file. If a user wants to autogenerate or provide column names for a CSV having headers, they can skip rows.""" + null_values: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('null_values'), 'exclude': lambda f: f is None }}) + r"""A set of case-sensitive strings that should be interpreted as null values. For example, if the value 'NA' should be interpreted as null, enter 'NA' in this field.""" + quote_char: Optional[str] = dataclasses.field(default='"', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('quote_char'), 'exclude': lambda f: f is None }}) + r"""The character used for quoting CSV values. To disallow quoting, make this field blank.""" + skip_rows_after_header: Optional[int] = dataclasses.field(default=0, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('skip_rows_after_header'), 'exclude': lambda f: f is None }}) + r"""The number of rows to skip after the header row.""" + skip_rows_before_header: Optional[int] = dataclasses.field(default=0, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('skip_rows_before_header'), 'exclude': lambda f: f is None }}) + r"""The number of rows to skip before the header row. For example, if the header row is on the 3rd row, enter 2 in this field.""" + strings_can_be_null: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('strings_can_be_null'), 'exclude': lambda f: f is None }}) + r"""Whether strings can be interpreted as null values. If true, strings that match the null_values set will be interpreted as null. If false, strings that match the null_values set will be interpreted as the string itself.""" + true_values: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('true_values'), 'exclude': lambda f: f is None }}) + r"""A set of case-sensitive strings that should be interpreted as true values.""" + + + +class SourceMicrosoftOnedriveFiletype(str, Enum): + AVRO = 'avro' + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class SourceMicrosoftOnedriveAvroFormat: + double_as_string: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('double_as_string'), 'exclude': lambda f: f is None }}) + r"""Whether to convert double fields to strings. This is recommended if you have decimal numbers with a high degree of precision because there can be a loss precision when handling floating point numbers.""" + FILETYPE: Final[Optional[SourceMicrosoftOnedriveFiletype]] = dataclasses.field(default=SourceMicrosoftOnedriveFiletype.AVRO, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filetype'), 'exclude': lambda f: f is None }}) + + + +class SourceMicrosoftOnedriveValidationPolicy(str, Enum): + r"""The name of the validation policy that dictates sync behavior when a record does not adhere to the stream schema.""" + EMIT_RECORD = 'Emit Record' + SKIP_RECORD = 'Skip Record' + WAIT_FOR_DISCOVER = 'Wait for Discover' + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class SourceMicrosoftOnedriveFileBasedStreamConfig: + format: Union[SourceMicrosoftOnedriveAvroFormat, SourceMicrosoftOnedriveCSVFormat, SourceMicrosoftOnedriveJsonlFormat, SourceMicrosoftOnedriveParquetFormat, SourceMicrosoftOnedriveDocumentFileTypeFormatExperimental] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('format') }}) + r"""The configuration options that are used to alter how to read incoming files that deviate from the standard formatting.""" + name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + r"""The name of the stream.""" + days_to_sync_if_history_is_full: Optional[int] = dataclasses.field(default=3, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('days_to_sync_if_history_is_full'), 'exclude': lambda f: f is None }}) + r"""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: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('globs'), 'exclude': lambda f: f is None }}) + r"""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] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('input_schema'), 'exclude': lambda f: f is None }}) + r"""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.""" + primary_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('primary_key'), 'exclude': lambda f: f is None }}) + r"""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] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('schemaless'), 'exclude': lambda f: f is None }}) + r"""When enabled, syncs will not validate or structure records against the stream's schema.""" + validation_policy: Optional[SourceMicrosoftOnedriveValidationPolicy] = dataclasses.field(default=SourceMicrosoftOnedriveValidationPolicy.EMIT_RECORD, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validation_policy'), 'exclude': lambda f: f is None }}) + r"""The name of the validation policy that dictates sync behavior when a record does not adhere to the stream schema.""" + + + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class SourceMicrosoftOnedrive: + r"""SourceMicrosoftOneDriveSpec class for Microsoft OneDrive Source Specification. + This class combines the authentication details with additional configuration for the OneDrive API. + """ + credentials: Union[AuthenticateViaMicrosoftOAuth, ServiceKeyAuthentication] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials') }}) + r"""Credentials for connecting to the One Drive API""" + streams: List[SourceMicrosoftOnedriveFileBasedStreamConfig] = 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.""" + drive_name: Optional[str] = dataclasses.field(default='OneDrive', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('drive_name'), 'exclude': lambda f: f is None }}) + r"""Name of the Microsoft OneDrive drive where the file(s) exist.""" + folder_path: Optional[str] = dataclasses.field(default='.', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('folder_path'), 'exclude': lambda f: f is None }}) + r"""Path to a specific folder within the drives to search for files. Leave empty to search all folders of the drives. This does not apply to shared items.""" + search_scope: Optional[SearchScope] = dataclasses.field(default=SearchScope.ALL, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('search_scope'), 'exclude': lambda f: f is None }}) + r"""Specifies the location(s) to search for files. Valid options are 'ACCESSIBLE_DRIVES' to search in the selected OneDrive drive, 'SHARED_ITEMS' for shared items the user has access to, and 'ALL' to search both.""" + SOURCE_TYPE: Final[SourceMicrosoftOnedriveMicrosoftOnedrive] = dataclasses.field(default=SourceMicrosoftOnedriveMicrosoftOnedrive.MICROSOFT_ONEDRIVE, 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_microsoft_sharepoint.py b/src/airbyte_api/models/source_microsoft_sharepoint.py similarity index 91% rename from src/airbyte/models/shared/source_microsoft_sharepoint.py rename to src/airbyte_api/models/source_microsoft_sharepoint.py index 346c0a19..9f6cddc4 100644 --- a/src/airbyte/models/shared/source_microsoft_sharepoint.py +++ b/src/airbyte_api/models/source_microsoft_sharepoint.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum @@ -15,7 +15,7 @@ class SourceMicrosoftSharepointSchemasAuthType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class ServiceKeyAuthentication: +class SourceMicrosoftSharepointServiceKeyAuthentication: r"""ServiceCredentials class for service key authentication. This class is structured similarly to OAuthCredentials but for a different authentication method. """ @@ -37,7 +37,7 @@ class SourceMicrosoftSharepointAuthType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class AuthenticateViaMicrosoftOAuth: +class SourceMicrosoftSharepointAuthenticateViaMicrosoftOAuth: r"""OAuthCredentials class to hold authentication details for Microsoft OAuth authentication. This class uses pydantic for data validation and settings management. """ @@ -53,6 +53,12 @@ class AuthenticateViaMicrosoftOAuth: +class SourceMicrosoftSharepointSearchScope(str, Enum): + r"""Specifies the location(s) to search for files. Valid options are 'ACCESSIBLE_DRIVES' for all SharePoint drives the user can access, 'SHARED_ITEMS' for shared items the user has access to, and 'ALL' to search both.""" + ACCESSIBLE_DRIVES = 'ACCESSIBLE_DRIVES' + SHARED_ITEMS = 'SHARED_ITEMS' + ALL = 'ALL' + class SourceMicrosoftSharepointMicrosoftSharepoint(str, Enum): MICROSOFT_SHAREPOINT = 'microsoft-sharepoint' @@ -172,6 +178,8 @@ class SourceMicrosoftSharepointCSVFormat: FILETYPE: Final[Optional[SourceMicrosoftSharepointSchemasFiletype]] = dataclasses.field(default=SourceMicrosoftSharepointSchemasFiletype.CSV, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filetype'), 'exclude': lambda f: f is None }}) header_definition: Optional[Union[SourceMicrosoftSharepointFromCSV, SourceMicrosoftSharepointAutogenerated, SourceMicrosoftSharepointUserProvided]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('header_definition'), 'exclude': lambda f: f is None }}) r"""How headers will be defined. `User Provided` assumes the CSV does not have a header row and uses the headers provided and `Autogenerated` assumes the CSV does not have a header row and the CDK will generate headers using for `f{i}` where `i` is the index starting from 0. Else, the default behavior is to use the header from the CSV file. If a user wants to autogenerate or provide column names for a CSV having headers, they can skip rows.""" + ignore_errors_on_fields_mismatch: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ignore_errors_on_fields_mismatch'), 'exclude': lambda f: f is None }}) + r"""Whether to ignore errors that occur when the number of fields in the CSV does not match the number of columns in the schema.""" null_values: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('null_values'), 'exclude': lambda f: f is None }}) r"""A set of case-sensitive strings that should be interpreted as null values. For example, if the value 'NA' should be interpreted as null, enter 'NA' in this field.""" quote_char: Optional[str] = dataclasses.field(default='"', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('quote_char'), 'exclude': lambda f: f is None }}) @@ -236,12 +244,14 @@ class SourceMicrosoftSharepoint: r"""SourceMicrosoftSharePointSpec class for Microsoft SharePoint Source Specification. This class combines the authentication details with additional configuration for the SharePoint API. """ - credentials: Union[AuthenticateViaMicrosoftOAuth, ServiceKeyAuthentication] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials') }}) + credentials: Union[SourceMicrosoftSharepointAuthenticateViaMicrosoftOAuth, SourceMicrosoftSharepointServiceKeyAuthentication] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials') }}) r"""Credentials for connecting to the One Drive API""" - folder_path: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('folder_path') }}) - r"""Path to folder of the Microsoft SharePoint drive where the file(s) exist.""" streams: List[SourceMicrosoftSharepointFileBasedStreamConfig] = 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.""" + folder_path: Optional[str] = dataclasses.field(default='.', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('folder_path'), 'exclude': lambda f: f is None }}) + r"""Path to a specific folder within the drives to search for files. Leave empty to search all folders of the drives. This does not apply to shared items.""" + search_scope: Optional[SourceMicrosoftSharepointSearchScope] = dataclasses.field(default=SourceMicrosoftSharepointSearchScope.ALL, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('search_scope'), 'exclude': lambda f: f is None }}) + r"""Specifies the location(s) to search for files. Valid options are 'ACCESSIBLE_DRIVES' for all SharePoint drives the user can access, 'SHARED_ITEMS' for shared items the user has access to, and 'ALL' to search both.""" SOURCE_TYPE: Final[SourceMicrosoftSharepointMicrosoftSharepoint] = dataclasses.field(default=SourceMicrosoftSharepointMicrosoftSharepoint.MICROSOFT_SHAREPOINT, 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_microsoft_teams.py b/src/airbyte_api/models/source_microsoft_teams.py similarity index 99% rename from src/airbyte/models/shared/source_microsoft_teams.py rename to src/airbyte_api/models/source_microsoft_teams.py index ddcfe8d8..1fe24653 100644 --- a/src/airbyte/models/shared/source_microsoft_teams.py +++ b/src/airbyte_api/models/source_microsoft_teams.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/source_mixpanel.py b/src/airbyte_api/models/source_mixpanel.py similarity index 99% rename from src/airbyte/models/shared/source_mixpanel.py rename to src/airbyte_api/models/source_mixpanel.py index 7bca42f4..5eca3f8f 100644 --- a/src/airbyte/models/shared/source_mixpanel.py +++ b/src/airbyte_api/models/source_mixpanel.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import date from enum import Enum diff --git a/src/airbyte/models/shared/source_monday.py b/src/airbyte_api/models/source_monday.py similarity index 98% rename from src/airbyte/models/shared/source_monday.py rename to src/airbyte_api/models/source_monday.py index 0697048c..0970402c 100644 --- a/src/airbyte/models/shared/source_monday.py +++ b/src/airbyte_api/models/source_monday.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/source_mongodb_internal_poc.py b/src/airbyte_api/models/source_mongodb_internal_poc.py similarity index 98% rename from src/airbyte/models/shared/source_mongodb_internal_poc.py rename to src/airbyte_api/models/source_mongodb_internal_poc.py index 85ad3676..2605bbc7 100644 --- a/src/airbyte/models/shared/source_mongodb_internal_poc.py +++ b/src/airbyte_api/models/source_mongodb_internal_poc.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_mongodb_v2.py b/src/airbyte_api/models/source_mongodb_v2.py similarity index 84% rename from src/airbyte/models/shared/source_mongodb_v2.py rename to src/airbyte_api/models/source_mongodb_v2.py index a1717a56..7ccb4c50 100644 --- a/src/airbyte/models/shared/source_mongodb_v2.py +++ b/src/airbyte_api/models/source_mongodb_v2.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Any, Dict, Final, Optional, Union @@ -59,6 +59,11 @@ class MongoDBAtlasReplicaSet: +class InvalidCDCPositionBehaviorAdvanced(str, Enum): + r"""Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value into the WAL. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss.""" + FAIL_SYNC = 'Fail sync' + RE_SYNC_DATA = 'Re-sync data' + class MongodbV2(str, Enum): MONGODB_V2 = 'mongodb-v2' @@ -72,6 +77,8 @@ class SourceMongodbV2: 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.""" + invalid_cdc_cursor_position_behavior: Optional[InvalidCDCPositionBehaviorAdvanced] = dataclasses.field(default=InvalidCDCPositionBehaviorAdvanced.FAIL_SYNC, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('invalid_cdc_cursor_position_behavior'), 'exclude': lambda f: f is None }}) + r"""Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value into the WAL. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss.""" 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_api/models/source_mssql.py similarity index 86% rename from src/airbyte/models/shared/source_mssql.py rename to src/airbyte_api/models/source_mssql.py index 7d98dc18..2935b708 100644 --- a/src/airbyte/models/shared/source_mssql.py +++ b/src/airbyte_api/models/source_mssql.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, List, Optional, Union @@ -19,6 +19,11 @@ class ScanChangesWithUserDefinedCursor: +class SourceMssqlInvalidCDCPositionBehaviorAdvanced(str, Enum): + r"""Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value into the WAL. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss.""" + FAIL_SYNC = 'Fail sync' + RE_SYNC_DATA = 'Re-sync data' + class SourceMssqlMethod(str, Enum): CDC = 'CDC' @@ -28,8 +33,12 @@ class SourceMssqlMethod(str, Enum): 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.""" 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.""" + 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 2400 seconds. Read about initial waiting time.""" + invalid_cdc_cursor_position_behavior: Optional[SourceMssqlInvalidCDCPositionBehaviorAdvanced] = dataclasses.field(default=SourceMssqlInvalidCDCPositionBehaviorAdvanced.FAIL_SYNC, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('invalid_cdc_cursor_position_behavior'), 'exclude': lambda f: f is None }}) + r"""Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value into the WAL. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss.""" METHOD: Final[SourceMssqlMethod] = dataclasses.field(default=SourceMssqlMethod.CDC, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('method') }}) + 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.""" diff --git a/src/airbyte/models/shared/source_my_hours.py b/src/airbyte_api/models/source_my_hours.py similarity index 97% rename from src/airbyte/models/shared/source_my_hours.py rename to src/airbyte_api/models/source_my_hours.py index 49080c98..552b2642 100644 --- a/src/airbyte/models/shared/source_my_hours.py +++ b/src/airbyte_api/models/source_my_hours.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_mysql.py b/src/airbyte_api/models/source_mysql.py similarity index 91% rename from src/airbyte/models/shared/source_mysql.py rename to src/airbyte_api/models/source_mysql.py index 53de87e9..241719a8 100644 --- a/src/airbyte/models/shared/source_mysql.py +++ b/src/airbyte_api/models/source_mysql.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union @@ -19,6 +19,11 @@ class SourceMysqlScanChangesWithUserDefinedCursor: +class SourceMysqlInvalidCDCPositionBehaviorAdvanced(str, Enum): + r"""Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value into the WAL. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss.""" + FAIL_SYNC = 'Fail sync' + RE_SYNC_DATA = 'Re-sync data' + class SourceMysqlMethod(str, Enum): CDC = 'CDC' @@ -29,6 +34,8 @@ class ReadChangesUsingBinaryLogCDC: r"""Recommended - Incrementally reads new inserts, updates, and deletes using the MySQL binary log. This must be enabled on your database.""" 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.""" + invalid_cdc_cursor_position_behavior: Optional[SourceMysqlInvalidCDCPositionBehaviorAdvanced] = dataclasses.field(default=SourceMysqlInvalidCDCPositionBehaviorAdvanced.FAIL_SYNC, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('invalid_cdc_cursor_position_behavior'), 'exclude': lambda f: f is None }}) + r"""Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value into the WAL. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss.""" 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.""" diff --git a/src/airbyte/models/shared/source_netsuite.py b/src/airbyte_api/models/source_netsuite.py similarity index 98% rename from src/airbyte/models/shared/source_netsuite.py rename to src/airbyte_api/models/source_netsuite.py index cf5d494e..42f8a5eb 100644 --- a/src/airbyte/models/shared/source_netsuite.py +++ b/src/airbyte_api/models/source_netsuite.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, List, Optional diff --git a/src/airbyte/models/shared/source_notion.py b/src/airbyte_api/models/source_notion.py similarity index 99% rename from src/airbyte/models/shared/source_notion.py rename to src/airbyte_api/models/source_notion.py index 4c36020c..21e0f24d 100644 --- a/src/airbyte/models/shared/source_notion.py +++ b/src/airbyte_api/models/source_notion.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_nytimes.py b/src/airbyte_api/models/source_nytimes.py similarity index 98% rename from src/airbyte/models/shared/source_nytimes.py rename to src/airbyte_api/models/source_nytimes.py index e9c1e2af..ab944711 100644 --- a/src/airbyte/models/shared/source_nytimes.py +++ b/src/airbyte_api/models/source_nytimes.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import date from enum import Enum diff --git a/src/airbyte/models/shared/source_okta.py b/src/airbyte_api/models/source_okta.py similarity index 98% rename from src/airbyte/models/shared/source_okta.py rename to src/airbyte_api/models/source_okta.py index f14153cc..115643af 100644 --- a/src/airbyte/models/shared/source_okta.py +++ b/src/airbyte_api/models/source_okta.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/source_omnisend.py b/src/airbyte_api/models/source_omnisend.py similarity index 95% rename from src/airbyte/models/shared/source_omnisend.py rename to src/airbyte_api/models/source_omnisend.py index cc659620..cf950002 100644 --- a/src/airbyte/models/shared/source_omnisend.py +++ b/src/airbyte_api/models/source_omnisend.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_onesignal.py b/src/airbyte_api/models/source_onesignal.py similarity index 98% rename from src/airbyte/models/shared/source_onesignal.py rename to src/airbyte_api/models/source_onesignal.py index 4d33a0fe..311476c2 100644 --- a/src/airbyte/models/shared/source_onesignal.py +++ b/src/airbyte_api/models/source_onesignal.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_oracle.py b/src/airbyte_api/models/source_oracle.py similarity index 99% rename from src/airbyte/models/shared/source_oracle.py rename to src/airbyte_api/models/source_oracle.py index d211d198..4d309e9e 100644 --- a/src/airbyte/models/shared/source_oracle.py +++ b/src/airbyte_api/models/source_oracle.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, List, Optional, Union diff --git a/src/airbyte/models/shared/source_orb.py b/src/airbyte_api/models/source_orb.py similarity index 86% rename from src/airbyte/models/shared/source_orb.py rename to src/airbyte_api/models/source_orb.py index 7c6a9bfd..a4a5c29d 100644 --- a/src/airbyte/models/shared/source_orb.py +++ b/src/airbyte_api/models/source_orb.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, List, Optional @@ -18,6 +18,8 @@ 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.""" + 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"""UTC date and time in the format 2022-03-01T00:00:00Z. Any data with created_at after this data will not be synced. For Subscription Usage, this becomes the `timeframe_start` API parameter.""" 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 }}) diff --git a/src/airbyte/models/shared/source_orbit.py b/src/airbyte_api/models/source_orbit.py similarity index 97% rename from src/airbyte/models/shared/source_orbit.py rename to src/airbyte_api/models/source_orbit.py index 2e87002d..0f9dd855 100644 --- a/src/airbyte/models/shared/source_orbit.py +++ b/src/airbyte_api/models/source_orbit.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_outbrain_amplify.py b/src/airbyte_api/models/source_outbrain_amplify.py similarity index 99% rename from src/airbyte/models/shared/source_outbrain_amplify.py rename to src/airbyte_api/models/source_outbrain_amplify.py index 3e973a49..4ff42fbf 100644 --- a/src/airbyte/models/shared/source_outbrain_amplify.py +++ b/src/airbyte_api/models/source_outbrain_amplify.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/source_outreach.py b/src/airbyte_api/models/source_outreach.py similarity index 98% rename from src/airbyte/models/shared/source_outreach.py rename to src/airbyte_api/models/source_outreach.py index 82ecf217..2adeeb63 100644 --- a/src/airbyte/models/shared/source_outreach.py +++ b/src/airbyte_api/models/source_outreach.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte_api/models/source_paypal_transaction.py b/src/airbyte_api/models/source_paypal_transaction.py new file mode 100644 index 00000000..cf2a1ce0 --- /dev/null +++ b/src/airbyte_api/models/source_paypal_transaction.py @@ -0,0 +1,37 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +import dateutil.parser +from airbyte_api import utils +from dataclasses_json import Undefined, dataclass_json +from datetime import datetime +from enum import Enum +from typing import Final, Optional + +class PaypalTransaction(str, Enum): + PAYPAL_TRANSACTION = 'paypal-transaction' + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class SourcePaypalTransaction: + client_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_id') }}) + r"""The Client ID of your Paypal developer application.""" + client_secret: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_secret') }}) + 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.""" + dispute_start_date: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dispute_start_date'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) + r"""Start Date parameter for the list dispute endpoint in ISO format. This Start Date must be in range within 180 days before present time, and requires ONLY 3 miliseconds(mandatory). If you don't use this option, it defaults to a start date set 180 days in the past.""" + 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"""End Date for data extraction in ISO format. This can be help you select specific range of time, mainly for test purposes or data integrity tests. When this is not used, now_utc() is used by the streams. This does not apply to Disputes and Product 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"""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_api/models/source_paystack.py similarity index 98% rename from src/airbyte/models/shared/source_paystack.py rename to src/airbyte_api/models/source_paystack.py index 13dab288..731c49d8 100644 --- a/src/airbyte/models/shared/source_paystack.py +++ b/src/airbyte_api/models/source_paystack.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_pendo.py b/src/airbyte_api/models/source_pendo.py similarity index 95% rename from src/airbyte/models/shared/source_pendo.py rename to src/airbyte_api/models/source_pendo.py index 0e8f44cc..ef01e95a 100644 --- a/src/airbyte/models/shared/source_pendo.py +++ b/src/airbyte_api/models/source_pendo.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_persistiq.py b/src/airbyte_api/models/source_persistiq.py similarity index 96% rename from src/airbyte/models/shared/source_persistiq.py rename to src/airbyte_api/models/source_persistiq.py index 823a2b0c..f51165c3 100644 --- a/src/airbyte/models/shared/source_persistiq.py +++ b/src/airbyte_api/models/source_persistiq.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_pexels_api.py b/src/airbyte_api/models/source_pexels_api.py similarity index 98% rename from src/airbyte/models/shared/source_pexels_api.py rename to src/airbyte_api/models/source_pexels_api.py index 9a1a9438..e28f178e 100644 --- a/src/airbyte/models/shared/source_pexels_api.py +++ b/src/airbyte_api/models/source_pexels_api.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_pinterest.py b/src/airbyte_api/models/source_pinterest.py similarity index 99% rename from src/airbyte/models/shared/source_pinterest.py rename to src/airbyte_api/models/source_pinterest.py index aa974d7e..f121c386 100644 --- a/src/airbyte/models/shared/source_pinterest.py +++ b/src/airbyte_api/models/source_pinterest.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import date from enum import Enum diff --git a/src/airbyte/models/shared/source_pipedrive.py b/src/airbyte_api/models/source_pipedrive.py similarity index 97% rename from src/airbyte/models/shared/source_pipedrive.py rename to src/airbyte_api/models/source_pipedrive.py index b1c588cd..7736de94 100644 --- a/src/airbyte/models/shared/source_pipedrive.py +++ b/src/airbyte_api/models/source_pipedrive.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_pocket.py b/src/airbyte_api/models/source_pocket.py similarity index 99% rename from src/airbyte/models/shared/source_pocket.py rename to src/airbyte_api/models/source_pocket.py index df678049..d4b2d4cc 100644 --- a/src/airbyte/models/shared/source_pocket.py +++ b/src/airbyte_api/models/source_pocket.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_pokeapi.py b/src/airbyte_api/models/source_pokeapi.py similarity index 99% rename from src/airbyte/models/shared/source_pokeapi.py rename to src/airbyte_api/models/source_pokeapi.py index a7594730..6e56e683 100644 --- a/src/airbyte/models/shared/source_pokeapi.py +++ b/src/airbyte_api/models/source_pokeapi.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_polygon_stock_api.py b/src/airbyte_api/models/source_polygon_stock_api.py similarity index 98% rename from src/airbyte/models/shared/source_polygon_stock_api.py rename to src/airbyte_api/models/source_polygon_stock_api.py index e4069169..b63de529 100644 --- a/src/airbyte/models/shared/source_polygon_stock_api.py +++ b/src/airbyte_api/models/source_polygon_stock_api.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import date from enum import Enum diff --git a/src/airbyte/models/shared/source_postgres.py b/src/airbyte_api/models/source_postgres.py similarity index 93% rename from src/airbyte/models/shared/source_postgres.py rename to src/airbyte_api/models/source_postgres.py index ecc2281b..42eedddb 100644 --- a/src/airbyte/models/shared/source_postgres.py +++ b/src/airbyte_api/models/source_postgres.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Any, Dict, Final, List, Optional, Union @@ -31,6 +31,11 @@ class DetectChangesWithXminSystemColumn: +class SourcePostgresInvalidCDCPositionBehaviorAdvanced(str, Enum): + r"""Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value into the WAL. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss.""" + FAIL_SYNC = 'Fail sync' + RE_SYNC_DATA = 'Re-sync data' + class LSNCommitBehaviour(str, Enum): 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.""" WHILE_READING_DATA = 'While reading Data' @@ -58,6 +63,8 @@ class ReadChangesUsingWriteAheadLogCDC: r"""Specifies a query that the connector executes on the source database when the connector sends a heartbeat message. Please see the setup guide for how and when to configure this setting.""" 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.""" + invalid_cdc_cursor_position_behavior: Optional[SourcePostgresInvalidCDCPositionBehaviorAdvanced] = dataclasses.field(default=SourcePostgresInvalidCDCPositionBehaviorAdvanced.FAIL_SYNC, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('invalid_cdc_cursor_position_behavior'), 'exclude': lambda f: f is None }}) + r"""Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value into the WAL. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss.""" 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 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') }}) diff --git a/src/airbyte/models/shared/source_posthog.py b/src/airbyte_api/models/source_posthog.py similarity index 98% rename from src/airbyte/models/shared/source_posthog.py rename to src/airbyte_api/models/source_posthog.py index daf6a2f6..f7d17380 100644 --- a/src/airbyte/models/shared/source_posthog.py +++ b/src/airbyte_api/models/source_posthog.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_postmarkapp.py b/src/airbyte_api/models/source_postmarkapp.py similarity index 96% rename from src/airbyte/models/shared/source_postmarkapp.py rename to src/airbyte_api/models/source_postmarkapp.py index 4ee3e20a..68226ea5 100644 --- a/src/airbyte/models/shared/source_postmarkapp.py +++ b/src/airbyte_api/models/source_postmarkapp.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_prestashop.py b/src/airbyte_api/models/source_prestashop.py similarity index 97% rename from src/airbyte/models/shared/source_prestashop.py rename to src/airbyte_api/models/source_prestashop.py index 99ddca17..20f6436a 100644 --- a/src/airbyte/models/shared/source_prestashop.py +++ b/src/airbyte_api/models/source_prestashop.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import date from enum import Enum diff --git a/src/airbyte/models/shared/source_punk_api.py b/src/airbyte_api/models/source_punk_api.py similarity index 97% rename from src/airbyte/models/shared/source_punk_api.py rename to src/airbyte_api/models/source_punk_api.py index 3a2f594c..cacb1b38 100644 --- a/src/airbyte/models/shared/source_punk_api.py +++ b/src/airbyte_api/models/source_punk_api.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_pypi.py b/src/airbyte_api/models/source_pypi.py similarity index 97% rename from src/airbyte/models/shared/source_pypi.py rename to src/airbyte_api/models/source_pypi.py index d52de1d6..5cb6a6fc 100644 --- a/src/airbyte/models/shared/source_pypi.py +++ b/src/airbyte_api/models/source_pypi.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_qualaroo.py b/src/airbyte_api/models/source_qualaroo.py similarity index 98% rename from src/airbyte/models/shared/source_qualaroo.py rename to src/airbyte_api/models/source_qualaroo.py index beca0e55..d73ca192 100644 --- a/src/airbyte/models/shared/source_qualaroo.py +++ b/src/airbyte_api/models/source_qualaroo.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, List, Optional diff --git a/src/airbyte/models/shared/source_quickbooks.py b/src/airbyte_api/models/source_quickbooks.py similarity index 97% rename from src/airbyte/models/shared/source_quickbooks.py rename to src/airbyte_api/models/source_quickbooks.py index 2ffdbf72..3471eabf 100644 --- a/src/airbyte/models/shared/source_quickbooks.py +++ b/src/airbyte_api/models/source_quickbooks.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum @@ -17,7 +17,7 @@ class SourceQuickbooksAuthType(str, Enum): @dataclasses.dataclass class SourceQuickbooksOAuth20: access_token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('access_token') }}) - r"""Access token fot making authenticated requests.""" + r"""Access token for making authenticated requests.""" client_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_id') }}) r"""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 = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_secret') }}) diff --git a/src/airbyte/models/shared/source_railz.py b/src/airbyte_api/models/source_railz.py similarity index 97% rename from src/airbyte/models/shared/source_railz.py rename to src/airbyte_api/models/source_railz.py index 9ef37661..cc55e516 100644 --- a/src/airbyte/models/shared/source_railz.py +++ b/src/airbyte_api/models/source_railz.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_recharge.py b/src/airbyte_api/models/source_recharge.py similarity index 98% rename from src/airbyte/models/shared/source_recharge.py rename to src/airbyte_api/models/source_recharge.py index 0ccf0db7..dae7d2e9 100644 --- a/src/airbyte/models/shared/source_recharge.py +++ b/src/airbyte_api/models/source_recharge.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_recreation.py b/src/airbyte_api/models/source_recreation.py similarity index 96% rename from src/airbyte/models/shared/source_recreation.py rename to src/airbyte_api/models/source_recreation.py index 83b3a240..ebc14c7e 100644 --- a/src/airbyte/models/shared/source_recreation.py +++ b/src/airbyte_api/models/source_recreation.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_recruitee.py b/src/airbyte_api/models/source_recruitee.py similarity index 97% rename from src/airbyte/models/shared/source_recruitee.py rename to src/airbyte_api/models/source_recruitee.py index 0507f332..3d7f44fd 100644 --- a/src/airbyte/models/shared/source_recruitee.py +++ b/src/airbyte_api/models/source_recruitee.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte_api/models/source_recurly.py b/src/airbyte_api/models/source_recurly.py new file mode 100644 index 00000000..2e404b98 --- /dev/null +++ b/src/airbyte_api/models/source_recurly.py @@ -0,0 +1,25 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from airbyte_api import utils +from dataclasses_json import Undefined, dataclass_json +from enum import Enum +from typing import Final, Optional + +class Recurly(str, Enum): + RECURLY = 'recurly' + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +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.""" + 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_api/models/source_redshift.py similarity index 98% rename from src/airbyte/models/shared/source_redshift.py rename to src/airbyte_api/models/source_redshift.py index 76e6df68..94fb6a93 100644 --- a/src/airbyte/models/shared/source_redshift.py +++ b/src/airbyte_api/models/source_redshift.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, List, Optional diff --git a/src/airbyte/models/shared/source_retently.py b/src/airbyte_api/models/source_retently.py similarity index 99% rename from src/airbyte/models/shared/source_retently.py rename to src/airbyte_api/models/source_retently.py index b3dbea5f..879ffd61 100644 --- a/src/airbyte/models/shared/source_retently.py +++ b/src/airbyte_api/models/source_retently.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Any, Dict, Final, Optional, Union diff --git a/src/airbyte/models/shared/source_rki_covid.py b/src/airbyte_api/models/source_rki_covid.py similarity index 96% rename from src/airbyte/models/shared/source_rki_covid.py rename to src/airbyte_api/models/source_rki_covid.py index f164619f..b90fc95e 100644 --- a/src/airbyte/models/shared/source_rki_covid.py +++ b/src/airbyte_api/models/source_rki_covid.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_rss.py b/src/airbyte_api/models/source_rss.py similarity index 95% rename from src/airbyte/models/shared/source_rss.py rename to src/airbyte_api/models/source_rss.py index 0318dc53..f7825790 100644 --- a/src/airbyte/models/shared/source_rss.py +++ b/src/airbyte_api/models/source_rss.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_s3.py b/src/airbyte_api/models/source_s3.py similarity index 98% rename from src/airbyte/models/shared/source_s3.py rename to src/airbyte_api/models/source_s3.py index 08ec9539..38a360bc 100644 --- a/src/airbyte/models/shared/source_s3.py +++ b/src/airbyte_api/models/source_s3.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum @@ -110,6 +110,8 @@ class S3AmazonWebServices: r"""Endpoint to an S3 compatible service. Leave empty to use AWS.""" path_prefix: Optional[str] = dataclasses.field(default='', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('path_prefix'), 'exclude': lambda f: f is None }}) r"""By providing a path-like prefix (e.g. myFolder/thisTable/) under which all the relevant files sit, we can optimize finding these in S3. This is optional but recommended if your bucket contains many folders/files which you don't need to replicate.""" + region_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('region_name'), 'exclude': lambda f: f is None }}) + r"""AWS region where the S3 bucket is located. If not provided, the region will be determined automatically.""" role_arn: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('role_arn'), 'exclude': lambda f: f is None }}) r"""Specifies the Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations requested using this profile. Set the External ID to the Airbyte workspace ID, which can be found in the URL of this page.""" 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 }}) @@ -327,6 +329,8 @@ class SourceS3: r"""Deprecated and will be removed soon. Please do not use this field anymore and use streams.globs instead. A regular expression which tells the connector which files to replicate. All files which match this pattern will be replicated. Use | to separate multiple patterns. See this page to understand pattern syntax (GLOBSTAR and SPLIT flags are enabled). Use pattern ** to pick up all files.""" provider: Optional[S3AmazonWebServices] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('provider'), 'exclude': lambda f: f is None }}) 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""" + region_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('region_name'), 'exclude': lambda f: f is None }}) + r"""AWS region where the S3 bucket is located. If not provided, the region will be determined automatically.""" role_arn: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('role_arn'), 'exclude': lambda f: f is None }}) r"""Specifies the Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations requested using this profile. Set the External ID to the Airbyte workspace ID, which can be found in the URL of this page.""" schema: Optional[str] = dataclasses.field(default='{}', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('schema'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/source_salesforce.py b/src/airbyte_api/models/source_salesforce.py similarity index 93% rename from src/airbyte/models/shared/source_salesforce.py rename to src/airbyte_api/models/source_salesforce.py index 9a033223..bbac5da9 100644 --- a/src/airbyte/models/shared/source_salesforce.py +++ b/src/airbyte_api/models/source_salesforce.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum @@ -52,6 +52,8 @@ class SourceSalesforce: 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.""" + stream_slice_step: Optional[str] = dataclasses.field(default='P30D', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('stream_slice_step'), 'exclude': lambda f: f is None }}) + r"""The size of the time window (ISO8601 duration) to slice requests.""" 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 }}) r"""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.""" diff --git a/src/airbyte/models/shared/source_salesloft.py b/src/airbyte_api/models/source_salesloft.py similarity index 99% rename from src/airbyte/models/shared/source_salesloft.py rename to src/airbyte_api/models/source_salesloft.py index f004dcfc..dffb9a8c 100644 --- a/src/airbyte/models/shared/source_salesloft.py +++ b/src/airbyte_api/models/source_salesloft.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_sap_fieldglass.py b/src/airbyte_api/models/source_sap_fieldglass.py similarity index 96% rename from src/airbyte/models/shared/source_sap_fieldglass.py rename to src/airbyte_api/models/source_sap_fieldglass.py index 9cadd72b..5951e383 100644 --- a/src/airbyte/models/shared/source_sap_fieldglass.py +++ b/src/airbyte_api/models/source_sap_fieldglass.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_secoda.py b/src/airbyte_api/models/source_secoda.py similarity index 96% rename from src/airbyte/models/shared/source_secoda.py rename to src/airbyte_api/models/source_secoda.py index 1efe6500..90522d23 100644 --- a/src/airbyte/models/shared/source_secoda.py +++ b/src/airbyte_api/models/source_secoda.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_sendgrid.py b/src/airbyte_api/models/source_sendgrid.py similarity index 97% rename from src/airbyte/models/shared/source_sendgrid.py rename to src/airbyte_api/models/source_sendgrid.py index 71e9ebdc..b486fa26 100644 --- a/src/airbyte/models/shared/source_sendgrid.py +++ b/src/airbyte_api/models/source_sendgrid.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_sendinblue.py b/src/airbyte_api/models/source_sendinblue.py similarity index 96% rename from src/airbyte/models/shared/source_sendinblue.py rename to src/airbyte_api/models/source_sendinblue.py index bfc79885..5db0af5f 100644 --- a/src/airbyte/models/shared/source_sendinblue.py +++ b/src/airbyte_api/models/source_sendinblue.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_senseforce.py b/src/airbyte_api/models/source_senseforce.py similarity index 99% rename from src/airbyte/models/shared/source_senseforce.py rename to src/airbyte_api/models/source_senseforce.py index 167ac137..b640c48c 100644 --- a/src/airbyte/models/shared/source_senseforce.py +++ b/src/airbyte_api/models/source_senseforce.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import date from enum import Enum diff --git a/src/airbyte/models/shared/source_sentry.py b/src/airbyte_api/models/source_sentry.py similarity index 98% rename from src/airbyte/models/shared/source_sentry.py rename to src/airbyte_api/models/source_sentry.py index d7947bfe..e04a189d 100644 --- a/src/airbyte/models/shared/source_sentry.py +++ b/src/airbyte_api/models/source_sentry.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Any, Final, List, Optional diff --git a/src/airbyte/models/shared/source_sftp.py b/src/airbyte_api/models/source_sftp.py similarity index 99% rename from src/airbyte/models/shared/source_sftp.py rename to src/airbyte_api/models/source_sftp.py index 8b6393a3..aafe2f14 100644 --- a/src/airbyte/models/shared/source_sftp.py +++ b/src/airbyte_api/models/source_sftp.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/source_sftp_bulk.py b/src/airbyte_api/models/source_sftp_bulk.py similarity index 99% rename from src/airbyte/models/shared/source_sftp_bulk.py rename to src/airbyte_api/models/source_sftp_bulk.py index c93589e9..0d139e3a 100644 --- a/src/airbyte/models/shared/source_sftp_bulk.py +++ b/src/airbyte_api/models/source_sftp_bulk.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_shopify.py b/src/airbyte_api/models/source_shopify.py similarity index 83% rename from src/airbyte/models/shared/source_shopify.py rename to src/airbyte_api/models/source_shopify.py index 922b7eac..f4308907 100644 --- a/src/airbyte/models/shared/source_shopify.py +++ b/src/airbyte_api/models/source_shopify.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import date from enum import Enum @@ -50,8 +50,12 @@ 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'.""" + bulk_window_in_days: Optional[int] = dataclasses.field(default=30, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('bulk_window_in_days'), 'exclude': lambda f: f is None }}) + r"""Defines what would be a date range per single BULK Job""" 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""" + fetch_transactions_user_id: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fetch_transactions_user_id'), 'exclude': lambda f: f is None }}) + r"""Defines which API type (REST/BULK) to use to fetch `Transactions` data. If you are a `Shopify Plus` user, leave the default value to speed up the fetch.""" 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_shortio.py b/src/airbyte_api/models/source_shortio.py similarity index 97% rename from src/airbyte/models/shared/source_shortio.py rename to src/airbyte_api/models/source_shortio.py index 72787f92..c29b51c6 100644 --- a/src/airbyte/models/shared/source_shortio.py +++ b/src/airbyte_api/models/source_shortio.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_slack.py b/src/airbyte_api/models/source_slack.py similarity index 99% rename from src/airbyte/models/shared/source_slack.py rename to src/airbyte_api/models/source_slack.py index e816645f..fb64c404 100644 --- a/src/airbyte/models/shared/source_slack.py +++ b/src/airbyte_api/models/source_slack.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_smaily.py b/src/airbyte_api/models/source_smaily.py similarity index 97% rename from src/airbyte/models/shared/source_smaily.py rename to src/airbyte_api/models/source_smaily.py index 53992cf5..85b1cebb 100644 --- a/src/airbyte/models/shared/source_smaily.py +++ b/src/airbyte_api/models/source_smaily.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_smartengage.py b/src/airbyte_api/models/source_smartengage.py similarity index 95% rename from src/airbyte/models/shared/source_smartengage.py rename to src/airbyte_api/models/source_smartengage.py index 619a7cfa..aea19b64 100644 --- a/src/airbyte/models/shared/source_smartengage.py +++ b/src/airbyte_api/models/source_smartengage.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_smartsheets.py b/src/airbyte_api/models/source_smartsheets.py similarity index 99% rename from src/airbyte/models/shared/source_smartsheets.py rename to src/airbyte_api/models/source_smartsheets.py index 5ff2546e..fa9e434f 100644 --- a/src/airbyte/models/shared/source_smartsheets.py +++ b/src/airbyte_api/models/source_smartsheets.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte_api/models/source_snapchat_marketing.py b/src/airbyte_api/models/source_snapchat_marketing.py new file mode 100644 index 00000000..f128f73d --- /dev/null +++ b/src/airbyte_api/models/source_snapchat_marketing.py @@ -0,0 +1,56 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +import dateutil.parser +from airbyte_api import utils +from dataclasses_json import Undefined, dataclass_json +from datetime import date +from enum import Enum +from typing import Final, Optional + +class ActionReportTime(str, Enum): + r"""Specifies the principle for conversion reporting.""" + CONVERSION = 'conversion' + IMPRESSION = 'impression' + +class SourceSnapchatMarketingSnapchatMarketing(str, Enum): + SNAPCHAT_MARKETING = 'snapchat-marketing' + +class SwipeUpAttributionWindow(str, Enum): + r"""Attribution window for swipe ups.""" + ONE_DAY = '1_DAY' + SEVEN_DAY = '7_DAY' + TWENTY_EIGHT_DAY = '28_DAY' + +class ViewAttributionWindow(str, Enum): + r"""Attribution window for views.""" + ONE_HOUR = '1_HOUR' + THREE_HOUR = '3_HOUR' + SIX_HOUR = '6_HOUR' + ONE_DAY = '1_DAY' + SEVEN_DAY = '7_DAY' + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class SourceSnapchatMarketing: + client_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_id') }}) + r"""The Client ID of your Snapchat developer application.""" + client_secret: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_secret') }}) + 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.""" + action_report_time: Optional[ActionReportTime] = dataclasses.field(default=ActionReportTime.CONVERSION, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('action_report_time'), 'exclude': lambda f: f is None }}) + r"""Specifies the principle for conversion reporting.""" + 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.""" + swipe_up_attribution_window: Optional[SwipeUpAttributionWindow] = dataclasses.field(default=SwipeUpAttributionWindow.TWENTY_EIGHT_DAY, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('swipe_up_attribution_window'), 'exclude': lambda f: f is None }}) + r"""Attribution window for swipe ups.""" + view_attribution_window: Optional[ViewAttributionWindow] = dataclasses.field(default=ViewAttributionWindow.ONE_DAY, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('view_attribution_window'), 'exclude': lambda f: f is None }}) + r"""Attribution window for views.""" + + diff --git a/src/airbyte/models/shared/source_snowflake.py b/src/airbyte_api/models/source_snowflake.py similarity index 99% rename from src/airbyte/models/shared/source_snowflake.py rename to src/airbyte_api/models/source_snowflake.py index 5c0f5e18..83beba65 100644 --- a/src/airbyte/models/shared/source_snowflake.py +++ b/src/airbyte_api/models/source_snowflake.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional, Union diff --git a/src/airbyte/models/shared/source_sonar_cloud.py b/src/airbyte_api/models/source_sonar_cloud.py similarity index 98% rename from src/airbyte/models/shared/source_sonar_cloud.py rename to src/airbyte_api/models/source_sonar_cloud.py index 4cd0ab80..96b781e0 100644 --- a/src/airbyte/models/shared/source_sonar_cloud.py +++ b/src/airbyte_api/models/source_sonar_cloud.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import date from enum import Enum diff --git a/src/airbyte/models/shared/source_spacex_api.py b/src/airbyte_api/models/source_spacex_api.py similarity index 96% rename from src/airbyte/models/shared/source_spacex_api.py rename to src/airbyte_api/models/source_spacex_api.py index c9903df9..ebcad73f 100644 --- a/src/airbyte/models/shared/source_spacex_api.py +++ b/src/airbyte_api/models/source_spacex_api.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_square.py b/src/airbyte_api/models/source_square.py similarity index 99% rename from src/airbyte/models/shared/source_square.py rename to src/airbyte_api/models/source_square.py index bfb068d5..860879b2 100644 --- a/src/airbyte/models/shared/source_square.py +++ b/src/airbyte_api/models/source_square.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import date from enum import Enum diff --git a/src/airbyte/models/shared/source_strava.py b/src/airbyte_api/models/source_strava.py similarity index 98% rename from src/airbyte/models/shared/source_strava.py rename to src/airbyte_api/models/source_strava.py index 4f0f2205..7884fae6 100644 --- a/src/airbyte/models/shared/source_strava.py +++ b/src/airbyte_api/models/source_strava.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_stripe.py b/src/airbyte_api/models/source_stripe.py similarity index 99% rename from src/airbyte/models/shared/source_stripe.py rename to src/airbyte_api/models/source_stripe.py index de85b241..a5ca0aa5 100644 --- a/src/airbyte/models/shared/source_stripe.py +++ b/src/airbyte_api/models/source_stripe.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_survey_sparrow.py b/src/airbyte_api/models/source_survey_sparrow.py similarity index 98% rename from src/airbyte/models/shared/source_survey_sparrow.py rename to src/airbyte_api/models/source_survey_sparrow.py index 2c8b7fda..4576c41b 100644 --- a/src/airbyte/models/shared/source_survey_sparrow.py +++ b/src/airbyte_api/models/source_survey_sparrow.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Any, Final, List, Optional, Union diff --git a/src/airbyte/models/shared/source_surveymonkey.py b/src/airbyte_api/models/source_surveymonkey.py similarity index 93% rename from src/airbyte/models/shared/source_surveymonkey.py rename to src/airbyte_api/models/source_surveymonkey.py index 7f9a1221..f0fd55c8 100644 --- a/src/airbyte/models/shared/source_surveymonkey.py +++ b/src/airbyte_api/models/source_surveymonkey.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum @@ -40,10 +40,10 @@ class SourceSurveymonkeySurveymonkey(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SourceSurveymonkey: + credentials: SurveyMonkeyAuthorizationMethod = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials') }}) + r"""The authorization method to use to retrieve data from SurveyMonkey""" 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.""" - 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') }}) diff --git a/src/airbyte/models/shared/source_tempo.py b/src/airbyte_api/models/source_tempo.py similarity index 96% rename from src/airbyte/models/shared/source_tempo.py rename to src/airbyte_api/models/source_tempo.py index 4d4b5b54..7d1a39ed 100644 --- a/src/airbyte/models/shared/source_tempo.py +++ b/src/airbyte_api/models/source_tempo.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_the_guardian_api.py b/src/airbyte_api/models/source_the_guardian_api.py similarity index 98% rename from src/airbyte/models/shared/source_the_guardian_api.py rename to src/airbyte_api/models/source_the_guardian_api.py index b8305d8c..23e67d28 100644 --- a/src/airbyte/models/shared/source_the_guardian_api.py +++ b/src/airbyte_api/models/source_the_guardian_api.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_tiktok_marketing.py b/src/airbyte_api/models/source_tiktok_marketing.py similarity index 99% rename from src/airbyte/models/shared/source_tiktok_marketing.py rename to src/airbyte_api/models/source_tiktok_marketing.py index 8cf63450..e78de14a 100644 --- a/src/airbyte/models/shared/source_tiktok_marketing.py +++ b/src/airbyte_api/models/source_tiktok_marketing.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import date from enum import Enum diff --git a/src/airbyte/models/shared/source_trello.py b/src/airbyte_api/models/source_trello.py similarity index 98% rename from src/airbyte/models/shared/source_trello.py rename to src/airbyte_api/models/source_trello.py index f3af6ad1..c3485309 100644 --- a/src/airbyte/models/shared/source_trello.py +++ b/src/airbyte_api/models/source_trello.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_trustpilot.py b/src/airbyte_api/models/source_trustpilot.py similarity index 99% rename from src/airbyte/models/shared/source_trustpilot.py rename to src/airbyte_api/models/source_trustpilot.py index 0b629e3b..ca24a7b1 100644 --- a/src/airbyte/models/shared/source_trustpilot.py +++ b/src/airbyte_api/models/source_trustpilot.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_tvmaze_schedule.py b/src/airbyte_api/models/source_tvmaze_schedule.py similarity index 98% rename from src/airbyte/models/shared/source_tvmaze_schedule.py rename to src/airbyte_api/models/source_tvmaze_schedule.py index ed18e757..a9e8d418 100644 --- a/src/airbyte/models/shared/source_tvmaze_schedule.py +++ b/src/airbyte_api/models/source_tvmaze_schedule.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_twilio.py b/src/airbyte_api/models/source_twilio.py similarity index 98% rename from src/airbyte/models/shared/source_twilio.py rename to src/airbyte_api/models/source_twilio.py index ff931a09..c2ebf485 100644 --- a/src/airbyte/models/shared/source_twilio.py +++ b/src/airbyte_api/models/source_twilio.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_twilio_taskrouter.py b/src/airbyte_api/models/source_twilio_taskrouter.py similarity index 96% rename from src/airbyte/models/shared/source_twilio_taskrouter.py rename to src/airbyte_api/models/source_twilio_taskrouter.py index 5b050ab8..169148bf 100644 --- a/src/airbyte/models/shared/source_twilio_taskrouter.py +++ b/src/airbyte_api/models/source_twilio_taskrouter.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_twitter.py b/src/airbyte_api/models/source_twitter.py similarity index 98% rename from src/airbyte/models/shared/source_twitter.py rename to src/airbyte_api/models/source_twitter.py index 6b513674..49d60543 100644 --- a/src/airbyte/models/shared/source_twitter.py +++ b/src/airbyte_api/models/source_twitter.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_typeform.py b/src/airbyte_api/models/source_typeform.py similarity index 99% rename from src/airbyte/models/shared/source_typeform.py rename to src/airbyte_api/models/source_typeform.py index 72670efe..7746d267 100644 --- a/src/airbyte/models/shared/source_typeform.py +++ b/src/airbyte_api/models/source_typeform.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_us_census.py b/src/airbyte_api/models/source_us_census.py similarity index 97% rename from src/airbyte/models/shared/source_us_census.py rename to src/airbyte_api/models/source_us_census.py index cfe7b152..80f96538 100644 --- a/src/airbyte/models/shared/source_us_census.py +++ b/src/airbyte_api/models/source_us_census.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_vantage.py b/src/airbyte_api/models/source_vantage.py similarity index 96% rename from src/airbyte/models/shared/source_vantage.py rename to src/airbyte_api/models/source_vantage.py index 196b1d1d..d3799888 100644 --- a/src/airbyte/models/shared/source_vantage.py +++ b/src/airbyte_api/models/source_vantage.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_webflow.py b/src/airbyte_api/models/source_webflow.py similarity index 97% rename from src/airbyte/models/shared/source_webflow.py rename to src/airbyte_api/models/source_webflow.py index 17d79913..591a29c6 100644 --- a/src/airbyte/models/shared/source_webflow.py +++ b/src/airbyte_api/models/source_webflow.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_whisky_hunter.py b/src/airbyte_api/models/source_whisky_hunter.py similarity index 95% rename from src/airbyte/models/shared/source_whisky_hunter.py rename to src/airbyte_api/models/source_whisky_hunter.py index 751152bb..d08d7390 100644 --- a/src/airbyte/models/shared/source_whisky_hunter.py +++ b/src/airbyte_api/models/source_whisky_hunter.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_wikipedia_pageviews.py b/src/airbyte_api/models/source_wikipedia_pageviews.py similarity index 98% rename from src/airbyte/models/shared/source_wikipedia_pageviews.py rename to src/airbyte_api/models/source_wikipedia_pageviews.py index df8879a0..4d87bd82 100644 --- a/src/airbyte/models/shared/source_wikipedia_pageviews.py +++ b/src/airbyte_api/models/source_wikipedia_pageviews.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_woocommerce.py b/src/airbyte_api/models/source_woocommerce.py similarity index 97% rename from src/airbyte/models/shared/source_woocommerce.py rename to src/airbyte_api/models/source_woocommerce.py index cc3f93c1..01fb6a14 100644 --- a/src/airbyte/models/shared/source_woocommerce.py +++ b/src/airbyte_api/models/source_woocommerce.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import date from enum import Enum diff --git a/src/airbyte/models/shared/source_xkcd.py b/src/airbyte_api/models/source_xkcd.py similarity index 95% rename from src/airbyte/models/shared/source_xkcd.py rename to src/airbyte_api/models/source_xkcd.py index bd0b2295..faeaa866 100644 --- a/src/airbyte/models/shared/source_xkcd.py +++ b/src/airbyte_api/models/source_xkcd.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_yandex_metrica.py b/src/airbyte_api/models/source_yandex_metrica.py similarity index 98% rename from src/airbyte/models/shared/source_yandex_metrica.py rename to src/airbyte_api/models/source_yandex_metrica.py index 58271507..539527c9 100644 --- a/src/airbyte/models/shared/source_yandex_metrica.py +++ b/src/airbyte_api/models/source_yandex_metrica.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import date from enum import Enum diff --git a/src/airbyte/models/shared/source_yotpo.py b/src/airbyte_api/models/source_yotpo.py similarity index 98% rename from src/airbyte/models/shared/source_yotpo.py rename to src/airbyte_api/models/source_yotpo.py index 5fb944d8..c19ba09b 100644 --- a/src/airbyte/models/shared/source_yotpo.py +++ b/src/airbyte_api/models/source_yotpo.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_youtube_analytics.py b/src/airbyte_api/models/source_youtube_analytics.py similarity index 98% rename from src/airbyte/models/shared/source_youtube_analytics.py rename to src/airbyte_api/models/source_youtube_analytics.py index c974bf67..d23029b8 100644 --- a/src/airbyte/models/shared/source_youtube_analytics.py +++ b/src/airbyte_api/models/source_youtube_analytics.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Any, Dict, Final, Optional diff --git a/src/airbyte/models/shared/source_zendesk_chat.py b/src/airbyte_api/models/source_zendesk_chat.py similarity index 99% rename from src/airbyte/models/shared/source_zendesk_chat.py rename to src/airbyte_api/models/source_zendesk_chat.py index 23dc8fbe..cab9c2ad 100644 --- a/src/airbyte/models/shared/source_zendesk_chat.py +++ b/src/airbyte_api/models/source_zendesk_chat.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_zendesk_sell.py b/src/airbyte_api/models/source_zendesk_sell.py similarity index 96% rename from src/airbyte/models/shared/source_zendesk_sell.py rename to src/airbyte_api/models/source_zendesk_sell.py index 12d7a805..9dae1877 100644 --- a/src/airbyte/models/shared/source_zendesk_sell.py +++ b/src/airbyte_api/models/source_zendesk_sell.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final diff --git a/src/airbyte/models/shared/source_zendesk_sunshine.py b/src/airbyte_api/models/source_zendesk_sunshine.py similarity index 99% rename from src/airbyte/models/shared/source_zendesk_sunshine.py rename to src/airbyte_api/models/source_zendesk_sunshine.py index 609e1de5..42e7c672 100644 --- a/src/airbyte/models/shared/source_zendesk_sunshine.py +++ b/src/airbyte_api/models/source_zendesk_sunshine.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_zendesk_support.py b/src/airbyte_api/models/source_zendesk_support.py similarity index 99% rename from src/airbyte/models/shared/source_zendesk_support.py rename to src/airbyte_api/models/source_zendesk_support.py index 5a5267ab..be5f5bd7 100644 --- a/src/airbyte/models/shared/source_zendesk_support.py +++ b/src/airbyte_api/models/source_zendesk_support.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte/models/shared/source_zendesk_talk.py b/src/airbyte_api/models/source_zendesk_talk.py similarity index 87% rename from src/airbyte/models/shared/source_zendesk_talk.py rename to src/airbyte_api/models/source_zendesk_talk.py index 5bf34695..e6419d81 100644 --- a/src/airbyte/models/shared/source_zendesk_talk.py +++ b/src/airbyte_api/models/source_zendesk_talk.py @@ -3,45 +3,45 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum from typing import Any, Dict, Final, Optional, Union class SourceZendeskTalkSchemasAuthType(str, Enum): - OAUTH2_0 = 'oauth2.0' + API_TOKEN = 'api_token' @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class SourceZendeskTalkOAuth20: +class SourceZendeskTalkAPIToken: UNSET='__SPEAKEASY_UNSET__' - access_token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('access_token') }}) + 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') }}) + r"""The user email for your Zendesk account.""" additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) - AUTH_TYPE: Final[Optional[SourceZendeskTalkSchemasAuthType]] = dataclasses.field(default=SourceZendeskTalkSchemasAuthType.OAUTH2_0, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('auth_type'), 'exclude': lambda f: f is None }}) - 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""" - 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""" + AUTH_TYPE: Final[Optional[SourceZendeskTalkSchemasAuthType]] = dataclasses.field(default=SourceZendeskTalkSchemasAuthType.API_TOKEN, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('auth_type'), 'exclude': lambda f: f is None }}) class SourceZendeskTalkAuthType(str, Enum): - API_TOKEN = 'api_token' + OAUTH2_0 = 'oauth2.0' @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class SourceZendeskTalkAPIToken: +class SourceZendeskTalkOAuth20: UNSET='__SPEAKEASY_UNSET__' - api_token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('api_token') }}) + 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.""" - email: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('email') }}) - r"""The user email for your Zendesk account.""" additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) - AUTH_TYPE: Final[Optional[SourceZendeskTalkAuthType]] = dataclasses.field(default=SourceZendeskTalkAuthType.API_TOKEN, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('auth_type'), 'exclude': lambda f: f is None }}) + AUTH_TYPE: Final[Optional[SourceZendeskTalkAuthType]] = dataclasses.field(default=SourceZendeskTalkAuthType.OAUTH2_0, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('auth_type'), 'exclude': lambda f: f is None }}) + 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""" + 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""" @@ -56,7 +56,7 @@ 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.""" - 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 }}) + credentials: Optional[Union[SourceZendeskTalkOAuth20, SourceZendeskTalkAPIToken]] = 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_api/models/source_zenloop.py similarity index 98% rename from src/airbyte/models/shared/source_zenloop.py rename to src/airbyte_api/models/source_zenloop.py index cf929340..eb69fbcb 100644 --- a/src/airbyte/models/shared/source_zenloop.py +++ b/src/airbyte_api/models/source_zenloop.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from enum import Enum from typing import Final, Optional diff --git a/src/airbyte/models/shared/source_zoho_crm.py b/src/airbyte_api/models/source_zoho_crm.py similarity index 99% rename from src/airbyte/models/shared/source_zoho_crm.py rename to src/airbyte_api/models/source_zoho_crm.py index 4e60cb63..e0047cf7 100644 --- a/src/airbyte/models/shared/source_zoho_crm.py +++ b/src/airbyte_api/models/source_zoho_crm.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses import dateutil.parser -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from datetime import datetime from enum import Enum diff --git a/src/airbyte_api/models/source_zoom.py b/src/airbyte_api/models/source_zoom.py new file mode 100644 index 00000000..e8720ba6 --- /dev/null +++ b/src/airbyte_api/models/source_zoom.py @@ -0,0 +1,26 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from airbyte_api import utils +from dataclasses_json import Undefined, dataclass_json +from enum import Enum +from typing import Final, Optional + +class Zoom(str, Enum): + ZOOM = 'zoom' + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class SourceZoom: + account_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('account_id') }}) + r"""The account ID for your Zoom account. You can find this in the Zoom Marketplace under the \\"Manage\\" tab for your app.""" + client_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_id') }}) + r"""The client ID for your Zoom app. You can find this in the Zoom Marketplace under the \\"Manage\\" tab for your app.""" + client_secret: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_secret') }}) + r"""The client secret for your Zoom app. You can find this in the Zoom Marketplace under the \\"Manage\\" tab for your app.""" + authorization_endpoint: Optional[str] = dataclasses.field(default='https://zoom.us/oauth/token', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('authorization_endpoint'), 'exclude': lambda f: f is None }}) + SOURCE_TYPE: Final[Zoom] = dataclasses.field(default=Zoom.ZOOM, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) + + diff --git a/src/airbyte/models/shared/sourcecreaterequest.py b/src/airbyte_api/models/sourcecreaterequest.py similarity index 81% rename from src/airbyte/models/shared/sourcecreaterequest.py rename to src/airbyte_api/models/sourcecreaterequest.py index f6feff68..66729a6e 100644 --- a/src/airbyte/models/shared/sourcecreaterequest.py +++ b/src/airbyte_api/models/sourcecreaterequest.py @@ -67,7 +67,6 @@ from .source_google_search_console import SourceGoogleSearchConsole from .source_google_sheets import SourceGoogleSheets from .source_google_webfonts import SourceGoogleWebfonts -from .source_google_workspace_admin_reports import SourceGoogleWorkspaceAdminReports from .source_greenhouse import SourceGreenhouse from .source_gridly import SourceGridly from .source_harvest import SourceHarvest @@ -89,12 +88,14 @@ from .source_lever_hiring import SourceLeverHiring from .source_linkedin_ads import SourceLinkedinAds from .source_linkedin_pages import SourceLinkedinPages +from .source_linnworks import SourceLinnworks from .source_lokalise import SourceLokalise from .source_mailchimp import SourceMailchimp from .source_mailgun import SourceMailgun from .source_mailjet_sms import SourceMailjetSms from .source_marketo import SourceMarketo from .source_metabase import SourceMetabase +from .source_microsoft_onedrive import SourceMicrosoftOnedrive from .source_microsoft_sharepoint import SourceMicrosoftSharepoint from .source_microsoft_teams import SourceMicrosoftTeams from .source_mixpanel import SourceMixpanel @@ -137,6 +138,7 @@ from .source_recharge import SourceRecharge from .source_recreation import SourceRecreation from .source_recruitee import SourceRecruitee +from .source_recurly import SourceRecurly from .source_redshift import SourceRedshift from .source_retently import SourceRetently from .source_rki_covid import SourceRkiCovid @@ -195,7 +197,7 @@ from .source_zenloop import SourceZenloop from .source_zoho_crm import SourceZohoCrm from .source_zoom import SourceZoom -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional, Union @@ -203,7 +205,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SourceCreateRequest: - configuration: Union[SourceAha, SourceAircall, SourceAirtable, SourceAmazonAds, SourceAmazonSellerPartner, SourceAmazonSqs, SourceAmplitude, SourceApifyDataset, SourceAppfollow, SourceAsana, SourceAuth0, SourceAwsCloudtrail, SourceAzureBlobStorage, SourceAzureTable, SourceBambooHr, SourceBigquery, SourceBingAds, SourceBraintree, SourceBraze, SourceCart, SourceChargebee, SourceChartmogul, SourceClickhouse, SourceClickupAPI, SourceClockify, SourceCloseCom, SourceCoda, SourceCoinAPI, SourceCoinmarketcap, SourceConfigcat, SourceConfluence, SourceConvex, SourceDatascope, SourceDelighted, SourceDixa, SourceDockerhub, SourceDremio, SourceDynamodb, Union[ContinuousFeed], SourceEmailoctopus, SourceExchangeRates, SourceFacebookMarketing, SourceFaker, SourceFauna, SourceFile, SourceFirebolt, SourceFreshcaller, SourceFreshdesk, SourceFreshsales, SourceGainsightPx, SourceGcs, SourceGetlago, SourceGithub, SourceGitlab, SourceGlassfrog, SourceGnews, SourceGoogleAds, SourceGoogleAnalyticsDataAPI, SourceGoogleAnalyticsV4ServiceAccountOnly, SourceGoogleDirectory, SourceGoogleDrive, SourceGooglePagespeedInsights, SourceGoogleSearchConsole, SourceGoogleSheets, SourceGoogleWebfonts, SourceGoogleWorkspaceAdminReports, SourceGreenhouse, SourceGridly, SourceHarvest, SourceHubplanner, SourceHubspot, SourceInsightly, SourceInstagram, SourceInstatus, SourceIntercom, SourceIp2whois, SourceIterable, SourceJira, SourceK6Cloud, SourceKlarna, SourceKlaviyo, SourceKyve, SourceLaunchdarkly, SourceLemlist, SourceLeverHiring, SourceLinkedinAds, SourceLinkedinPages, SourceLokalise, SourceMailchimp, SourceMailgun, SourceMailjetSms, SourceMarketo, SourceMetabase, SourceMicrosoftSharepoint, SourceMicrosoftTeams, SourceMixpanel, SourceMonday, SourceMongodbInternalPoc, SourceMongodbV2, SourceMssql, SourceMyHours, SourceMysql, SourceNetsuite, SourceNotion, SourceNytimes, SourceOkta, SourceOmnisend, SourceOnesignal, SourceOracle, SourceOrb, SourceOrbit, SourceOutbrainAmplify, SourceOutreach, SourcePaypalTransaction, SourcePaystack, SourcePendo, SourcePersistiq, SourcePexelsAPI, SourcePinterest, SourcePipedrive, SourcePocket, SourcePokeapi, SourcePolygonStockAPI, SourcePostgres, SourcePosthog, SourcePostmarkapp, SourcePrestashop, SourcePunkAPI, SourcePypi, SourceQualaroo, SourceQuickbooks, SourceRailz, SourceRecharge, SourceRecreation, SourceRecruitee, SourceRedshift, SourceRetently, SourceRkiCovid, SourceRss, SourceS3, SourceSalesforce, SourceSalesloft, SourceSapFieldglass, SourceSecoda, SourceSendgrid, SourceSendinblue, SourceSenseforce, SourceSentry, SourceSftp, SourceSftpBulk, SourceShopify, SourceShortio, SourceSlack, SourceSmaily, SourceSmartengage, SourceSmartsheets, SourceSnapchatMarketing, SourceSnowflake, SourceSonarCloud, SourceSpacexAPI, SourceSquare, SourceStrava, SourceStripe, SourceSurveySparrow, SourceSurveymonkey, SourceTempo, SourceTheGuardianAPI, SourceTiktokMarketing, SourceTrello, SourceTrustpilot, SourceTvmazeSchedule, SourceTwilio, SourceTwilioTaskrouter, SourceTwitter, SourceTypeform, SourceUsCensus, SourceVantage, SourceWebflow, SourceWhiskyHunter, SourceWikipediaPageviews, SourceWoocommerce, SourceXkcd, SourceYandexMetrica, SourceYotpo, SourceYoutubeAnalytics, SourceZendeskChat, SourceZendeskSell, SourceZendeskSunshine, SourceZendeskSupport, SourceZendeskTalk, SourceZenloop, SourceZohoCrm, SourceZoom] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('configuration') }}) + configuration: Union[SourceAha, SourceAircall, SourceAirtable, SourceAmazonAds, SourceAmazonSellerPartner, SourceAmazonSqs, SourceAmplitude, SourceApifyDataset, SourceAppfollow, SourceAsana, SourceAuth0, SourceAwsCloudtrail, SourceAzureBlobStorage, SourceAzureTable, SourceBambooHr, SourceBigquery, SourceBingAds, SourceBraintree, SourceBraze, SourceCart, SourceChargebee, SourceChartmogul, SourceClickhouse, SourceClickupAPI, SourceClockify, SourceCloseCom, SourceCoda, SourceCoinAPI, SourceCoinmarketcap, SourceConfigcat, SourceConfluence, SourceConvex, SourceDatascope, SourceDelighted, SourceDixa, SourceDockerhub, SourceDremio, SourceDynamodb, Union[ContinuousFeed], SourceEmailoctopus, SourceExchangeRates, SourceFacebookMarketing, SourceFaker, SourceFauna, SourceFile, SourceFirebolt, SourceFreshcaller, SourceFreshdesk, SourceFreshsales, SourceGainsightPx, SourceGcs, SourceGetlago, SourceGithub, SourceGitlab, SourceGlassfrog, SourceGnews, SourceGoogleAds, SourceGoogleAnalyticsDataAPI, SourceGoogleAnalyticsV4ServiceAccountOnly, SourceGoogleDirectory, SourceGoogleDrive, SourceGooglePagespeedInsights, SourceGoogleSearchConsole, SourceGoogleSheets, SourceGoogleWebfonts, SourceGreenhouse, SourceGridly, SourceHarvest, SourceHubplanner, SourceHubspot, SourceInsightly, SourceInstagram, SourceInstatus, SourceIntercom, SourceIp2whois, SourceIterable, SourceJira, SourceK6Cloud, SourceKlarna, SourceKlaviyo, SourceKyve, SourceLaunchdarkly, SourceLemlist, SourceLeverHiring, SourceLinkedinAds, SourceLinkedinPages, SourceLinnworks, SourceLokalise, SourceMailchimp, SourceMailgun, SourceMailjetSms, SourceMarketo, SourceMetabase, SourceMicrosoftOnedrive, SourceMicrosoftSharepoint, SourceMicrosoftTeams, SourceMixpanel, SourceMonday, SourceMongodbInternalPoc, SourceMongodbV2, SourceMssql, SourceMyHours, SourceMysql, SourceNetsuite, SourceNotion, SourceNytimes, SourceOkta, SourceOmnisend, SourceOnesignal, SourceOracle, SourceOrb, SourceOrbit, SourceOutbrainAmplify, SourceOutreach, SourcePaypalTransaction, SourcePaystack, SourcePendo, SourcePersistiq, SourcePexelsAPI, SourcePinterest, SourcePipedrive, SourcePocket, SourcePokeapi, SourcePolygonStockAPI, SourcePostgres, SourcePosthog, SourcePostmarkapp, SourcePrestashop, SourcePunkAPI, SourcePypi, SourceQualaroo, SourceQuickbooks, SourceRailz, SourceRecharge, SourceRecreation, SourceRecruitee, SourceRecurly, SourceRedshift, SourceRetently, SourceRkiCovid, SourceRss, SourceS3, SourceSalesforce, SourceSalesloft, SourceSapFieldglass, SourceSecoda, SourceSendgrid, SourceSendinblue, SourceSenseforce, SourceSentry, SourceSftp, SourceSftpBulk, SourceShopify, SourceShortio, SourceSlack, SourceSmaily, SourceSmartengage, SourceSmartsheets, SourceSnapchatMarketing, SourceSnowflake, SourceSonarCloud, SourceSpacexAPI, SourceSquare, SourceStrava, SourceStripe, SourceSurveySparrow, SourceSurveymonkey, SourceTempo, SourceTheGuardianAPI, SourceTiktokMarketing, SourceTrello, SourceTrustpilot, SourceTvmazeSchedule, SourceTwilio, SourceTwilioTaskrouter, SourceTwitter, SourceTypeform, SourceUsCensus, SourceVantage, SourceWebflow, SourceWhiskyHunter, SourceWikipediaPageviews, SourceWoocommerce, SourceXkcd, SourceYandexMetrica, SourceYotpo, SourceYoutubeAnalytics, SourceZendeskChat, SourceZendeskSell, SourceZendeskSunshine, SourceZendeskSupport, SourceZendeskTalk, SourceZenloop, SourceZohoCrm, SourceZoom] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('configuration') }}) r"""The values required to configure the source.""" name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) r"""Name of the source e.g. dev-mysql-instance.""" diff --git a/src/airbyte/models/shared/sourcepatchrequest.py b/src/airbyte_api/models/sourcepatchrequest.py similarity index 81% rename from src/airbyte/models/shared/sourcepatchrequest.py rename to src/airbyte_api/models/sourcepatchrequest.py index e6f34c24..c4794d4d 100644 --- a/src/airbyte/models/shared/sourcepatchrequest.py +++ b/src/airbyte_api/models/sourcepatchrequest.py @@ -67,7 +67,6 @@ from .source_google_search_console import SourceGoogleSearchConsole from .source_google_sheets import SourceGoogleSheets from .source_google_webfonts import SourceGoogleWebfonts -from .source_google_workspace_admin_reports import SourceGoogleWorkspaceAdminReports from .source_greenhouse import SourceGreenhouse from .source_gridly import SourceGridly from .source_harvest import SourceHarvest @@ -89,12 +88,14 @@ from .source_lever_hiring import SourceLeverHiring from .source_linkedin_ads import SourceLinkedinAds from .source_linkedin_pages import SourceLinkedinPages +from .source_linnworks import SourceLinnworks from .source_lokalise import SourceLokalise from .source_mailchimp import SourceMailchimp from .source_mailgun import SourceMailgun from .source_mailjet_sms import SourceMailjetSms from .source_marketo import SourceMarketo from .source_metabase import SourceMetabase +from .source_microsoft_onedrive import SourceMicrosoftOnedrive from .source_microsoft_sharepoint import SourceMicrosoftSharepoint from .source_microsoft_teams import SourceMicrosoftTeams from .source_mixpanel import SourceMixpanel @@ -137,6 +138,7 @@ from .source_recharge import SourceRecharge from .source_recreation import SourceRecreation from .source_recruitee import SourceRecruitee +from .source_recurly import SourceRecurly from .source_redshift import SourceRedshift from .source_retently import SourceRetently from .source_rki_covid import SourceRkiCovid @@ -195,7 +197,7 @@ from .source_zenloop import SourceZenloop from .source_zoho_crm import SourceZohoCrm from .source_zoom import SourceZoom -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional, Union @@ -203,7 +205,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SourcePatchRequest: - configuration: Optional[Union[SourceAha, SourceAircall, SourceAirtable, SourceAmazonAds, SourceAmazonSellerPartner, SourceAmazonSqs, SourceAmplitude, SourceApifyDataset, SourceAppfollow, SourceAsana, SourceAuth0, SourceAwsCloudtrail, SourceAzureBlobStorage, SourceAzureTable, SourceBambooHr, SourceBigquery, SourceBingAds, SourceBraintree, SourceBraze, SourceCart, SourceChargebee, SourceChartmogul, SourceClickhouse, SourceClickupAPI, SourceClockify, SourceCloseCom, SourceCoda, SourceCoinAPI, SourceCoinmarketcap, SourceConfigcat, SourceConfluence, SourceConvex, SourceDatascope, SourceDelighted, SourceDixa, SourceDockerhub, SourceDremio, SourceDynamodb, Union[ContinuousFeed], SourceEmailoctopus, SourceExchangeRates, SourceFacebookMarketing, SourceFaker, SourceFauna, SourceFile, SourceFirebolt, SourceFreshcaller, SourceFreshdesk, SourceFreshsales, SourceGainsightPx, SourceGcs, SourceGetlago, SourceGithub, SourceGitlab, SourceGlassfrog, SourceGnews, SourceGoogleAds, SourceGoogleAnalyticsDataAPI, SourceGoogleAnalyticsV4ServiceAccountOnly, SourceGoogleDirectory, SourceGoogleDrive, SourceGooglePagespeedInsights, SourceGoogleSearchConsole, SourceGoogleSheets, SourceGoogleWebfonts, SourceGoogleWorkspaceAdminReports, SourceGreenhouse, SourceGridly, SourceHarvest, SourceHubplanner, SourceHubspot, SourceInsightly, SourceInstagram, SourceInstatus, SourceIntercom, SourceIp2whois, SourceIterable, SourceJira, SourceK6Cloud, SourceKlarna, SourceKlaviyo, SourceKyve, SourceLaunchdarkly, SourceLemlist, SourceLeverHiring, SourceLinkedinAds, SourceLinkedinPages, SourceLokalise, SourceMailchimp, SourceMailgun, SourceMailjetSms, SourceMarketo, SourceMetabase, SourceMicrosoftSharepoint, SourceMicrosoftTeams, SourceMixpanel, SourceMonday, SourceMongodbInternalPoc, SourceMongodbV2, SourceMssql, SourceMyHours, SourceMysql, SourceNetsuite, SourceNotion, SourceNytimes, SourceOkta, SourceOmnisend, SourceOnesignal, SourceOracle, SourceOrb, SourceOrbit, SourceOutbrainAmplify, SourceOutreach, SourcePaypalTransaction, SourcePaystack, SourcePendo, SourcePersistiq, SourcePexelsAPI, SourcePinterest, SourcePipedrive, SourcePocket, SourcePokeapi, SourcePolygonStockAPI, SourcePostgres, SourcePosthog, SourcePostmarkapp, SourcePrestashop, SourcePunkAPI, SourcePypi, SourceQualaroo, SourceQuickbooks, SourceRailz, SourceRecharge, SourceRecreation, SourceRecruitee, SourceRedshift, SourceRetently, SourceRkiCovid, SourceRss, SourceS3, SourceSalesforce, SourceSalesloft, SourceSapFieldglass, SourceSecoda, SourceSendgrid, SourceSendinblue, SourceSenseforce, SourceSentry, SourceSftp, SourceSftpBulk, SourceShopify, SourceShortio, SourceSlack, SourceSmaily, SourceSmartengage, SourceSmartsheets, SourceSnapchatMarketing, SourceSnowflake, SourceSonarCloud, SourceSpacexAPI, SourceSquare, SourceStrava, SourceStripe, SourceSurveySparrow, SourceSurveymonkey, SourceTempo, SourceTheGuardianAPI, SourceTiktokMarketing, SourceTrello, SourceTrustpilot, SourceTvmazeSchedule, SourceTwilio, SourceTwilioTaskrouter, SourceTwitter, SourceTypeform, SourceUsCensus, SourceVantage, SourceWebflow, SourceWhiskyHunter, SourceWikipediaPageviews, SourceWoocommerce, SourceXkcd, SourceYandexMetrica, SourceYotpo, SourceYoutubeAnalytics, SourceZendeskChat, SourceZendeskSell, SourceZendeskSunshine, SourceZendeskSupport, SourceZendeskTalk, SourceZenloop, SourceZohoCrm, SourceZoom]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('configuration'), 'exclude': lambda f: f is None }}) + configuration: Optional[Union[SourceAha, SourceAircall, SourceAirtable, SourceAmazonAds, SourceAmazonSellerPartner, SourceAmazonSqs, SourceAmplitude, SourceApifyDataset, SourceAppfollow, SourceAsana, SourceAuth0, SourceAwsCloudtrail, SourceAzureBlobStorage, SourceAzureTable, SourceBambooHr, SourceBigquery, SourceBingAds, SourceBraintree, SourceBraze, SourceCart, SourceChargebee, SourceChartmogul, SourceClickhouse, SourceClickupAPI, SourceClockify, SourceCloseCom, SourceCoda, SourceCoinAPI, SourceCoinmarketcap, SourceConfigcat, SourceConfluence, SourceConvex, SourceDatascope, SourceDelighted, SourceDixa, SourceDockerhub, SourceDremio, SourceDynamodb, Union[ContinuousFeed], SourceEmailoctopus, SourceExchangeRates, SourceFacebookMarketing, SourceFaker, SourceFauna, SourceFile, SourceFirebolt, SourceFreshcaller, SourceFreshdesk, SourceFreshsales, SourceGainsightPx, SourceGcs, SourceGetlago, SourceGithub, SourceGitlab, SourceGlassfrog, SourceGnews, SourceGoogleAds, SourceGoogleAnalyticsDataAPI, SourceGoogleAnalyticsV4ServiceAccountOnly, SourceGoogleDirectory, SourceGoogleDrive, SourceGooglePagespeedInsights, SourceGoogleSearchConsole, SourceGoogleSheets, SourceGoogleWebfonts, SourceGreenhouse, SourceGridly, SourceHarvest, SourceHubplanner, SourceHubspot, SourceInsightly, SourceInstagram, SourceInstatus, SourceIntercom, SourceIp2whois, SourceIterable, SourceJira, SourceK6Cloud, SourceKlarna, SourceKlaviyo, SourceKyve, SourceLaunchdarkly, SourceLemlist, SourceLeverHiring, SourceLinkedinAds, SourceLinkedinPages, SourceLinnworks, SourceLokalise, SourceMailchimp, SourceMailgun, SourceMailjetSms, SourceMarketo, SourceMetabase, SourceMicrosoftOnedrive, SourceMicrosoftSharepoint, SourceMicrosoftTeams, SourceMixpanel, SourceMonday, SourceMongodbInternalPoc, SourceMongodbV2, SourceMssql, SourceMyHours, SourceMysql, SourceNetsuite, SourceNotion, SourceNytimes, SourceOkta, SourceOmnisend, SourceOnesignal, SourceOracle, SourceOrb, SourceOrbit, SourceOutbrainAmplify, SourceOutreach, SourcePaypalTransaction, SourcePaystack, SourcePendo, SourcePersistiq, SourcePexelsAPI, SourcePinterest, SourcePipedrive, SourcePocket, SourcePokeapi, SourcePolygonStockAPI, SourcePostgres, SourcePosthog, SourcePostmarkapp, SourcePrestashop, SourcePunkAPI, SourcePypi, SourceQualaroo, SourceQuickbooks, SourceRailz, SourceRecharge, SourceRecreation, SourceRecruitee, SourceRecurly, SourceRedshift, SourceRetently, SourceRkiCovid, SourceRss, SourceS3, SourceSalesforce, SourceSalesloft, SourceSapFieldglass, SourceSecoda, SourceSendgrid, SourceSendinblue, SourceSenseforce, SourceSentry, SourceSftp, SourceSftpBulk, SourceShopify, SourceShortio, SourceSlack, SourceSmaily, SourceSmartengage, SourceSmartsheets, SourceSnapchatMarketing, SourceSnowflake, SourceSonarCloud, SourceSpacexAPI, SourceSquare, SourceStrava, SourceStripe, SourceSurveySparrow, SourceSurveymonkey, SourceTempo, SourceTheGuardianAPI, SourceTiktokMarketing, SourceTrello, SourceTrustpilot, SourceTvmazeSchedule, SourceTwilio, SourceTwilioTaskrouter, SourceTwitter, SourceTypeform, SourceUsCensus, SourceVantage, SourceWebflow, SourceWhiskyHunter, SourceWikipediaPageviews, SourceWoocommerce, SourceXkcd, SourceYandexMetrica, SourceYotpo, SourceYoutubeAnalytics, SourceZendeskChat, SourceZendeskSell, SourceZendeskSunshine, SourceZendeskSupport, SourceZendeskTalk, SourceZenloop, SourceZohoCrm, SourceZoom]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('configuration'), 'exclude': lambda f: f is None }}) r"""The values required to configure the source.""" name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) secret_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('secretId'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/sourceputrequest.py b/src/airbyte_api/models/sourceputrequest.py similarity index 80% rename from src/airbyte/models/shared/sourceputrequest.py rename to src/airbyte_api/models/sourceputrequest.py index 79079af5..50debee6 100644 --- a/src/airbyte/models/shared/sourceputrequest.py +++ b/src/airbyte_api/models/sourceputrequest.py @@ -67,7 +67,6 @@ from .source_google_search_console import SourceGoogleSearchConsole from .source_google_sheets import SourceGoogleSheets from .source_google_webfonts import SourceGoogleWebfonts -from .source_google_workspace_admin_reports import SourceGoogleWorkspaceAdminReports from .source_greenhouse import SourceGreenhouse from .source_gridly import SourceGridly from .source_harvest import SourceHarvest @@ -89,12 +88,14 @@ from .source_lever_hiring import SourceLeverHiring from .source_linkedin_ads import SourceLinkedinAds from .source_linkedin_pages import SourceLinkedinPages +from .source_linnworks import SourceLinnworks from .source_lokalise import SourceLokalise from .source_mailchimp import SourceMailchimp from .source_mailgun import SourceMailgun from .source_mailjet_sms import SourceMailjetSms from .source_marketo import SourceMarketo from .source_metabase import SourceMetabase +from .source_microsoft_onedrive import SourceMicrosoftOnedrive from .source_microsoft_sharepoint import SourceMicrosoftSharepoint from .source_microsoft_teams import SourceMicrosoftTeams from .source_mixpanel import SourceMixpanel @@ -137,6 +138,7 @@ from .source_recharge import SourceRecharge from .source_recreation import SourceRecreation from .source_recruitee import SourceRecruitee +from .source_recurly import SourceRecurly from .source_redshift import SourceRedshift from .source_retently import SourceRetently from .source_rki_covid import SourceRkiCovid @@ -195,7 +197,7 @@ from .source_zenloop import SourceZenloop from .source_zoho_crm import SourceZohoCrm from .source_zoom import SourceZoom -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Union @@ -203,7 +205,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SourcePutRequest: - configuration: Union[SourceAha, SourceAircall, SourceAirtable, SourceAmazonAds, SourceAmazonSellerPartner, SourceAmazonSqs, SourceAmplitude, SourceApifyDataset, SourceAppfollow, SourceAsana, SourceAuth0, SourceAwsCloudtrail, SourceAzureBlobStorage, SourceAzureTable, SourceBambooHr, SourceBigquery, SourceBingAds, SourceBraintree, SourceBraze, SourceCart, SourceChargebee, SourceChartmogul, SourceClickhouse, SourceClickupAPI, SourceClockify, SourceCloseCom, SourceCoda, SourceCoinAPI, SourceCoinmarketcap, SourceConfigcat, SourceConfluence, SourceConvex, SourceDatascope, SourceDelighted, SourceDixa, SourceDockerhub, SourceDremio, SourceDynamodb, Union[ContinuousFeed], SourceEmailoctopus, SourceExchangeRates, SourceFacebookMarketing, SourceFaker, SourceFauna, SourceFile, SourceFirebolt, SourceFreshcaller, SourceFreshdesk, SourceFreshsales, SourceGainsightPx, SourceGcs, SourceGetlago, SourceGithub, SourceGitlab, SourceGlassfrog, SourceGnews, SourceGoogleAds, SourceGoogleAnalyticsDataAPI, SourceGoogleAnalyticsV4ServiceAccountOnly, SourceGoogleDirectory, SourceGoogleDrive, SourceGooglePagespeedInsights, SourceGoogleSearchConsole, SourceGoogleSheets, SourceGoogleWebfonts, SourceGoogleWorkspaceAdminReports, SourceGreenhouse, SourceGridly, SourceHarvest, SourceHubplanner, SourceHubspot, SourceInsightly, SourceInstagram, SourceInstatus, SourceIntercom, SourceIp2whois, SourceIterable, SourceJira, SourceK6Cloud, SourceKlarna, SourceKlaviyo, SourceKyve, SourceLaunchdarkly, SourceLemlist, SourceLeverHiring, SourceLinkedinAds, SourceLinkedinPages, SourceLokalise, SourceMailchimp, SourceMailgun, SourceMailjetSms, SourceMarketo, SourceMetabase, SourceMicrosoftSharepoint, SourceMicrosoftTeams, SourceMixpanel, SourceMonday, SourceMongodbInternalPoc, SourceMongodbV2, SourceMssql, SourceMyHours, SourceMysql, SourceNetsuite, SourceNotion, SourceNytimes, SourceOkta, SourceOmnisend, SourceOnesignal, SourceOracle, SourceOrb, SourceOrbit, SourceOutbrainAmplify, SourceOutreach, SourcePaypalTransaction, SourcePaystack, SourcePendo, SourcePersistiq, SourcePexelsAPI, SourcePinterest, SourcePipedrive, SourcePocket, SourcePokeapi, SourcePolygonStockAPI, SourcePostgres, SourcePosthog, SourcePostmarkapp, SourcePrestashop, SourcePunkAPI, SourcePypi, SourceQualaroo, SourceQuickbooks, SourceRailz, SourceRecharge, SourceRecreation, SourceRecruitee, SourceRedshift, SourceRetently, SourceRkiCovid, SourceRss, SourceS3, SourceSalesforce, SourceSalesloft, SourceSapFieldglass, SourceSecoda, SourceSendgrid, SourceSendinblue, SourceSenseforce, SourceSentry, SourceSftp, SourceSftpBulk, SourceShopify, SourceShortio, SourceSlack, SourceSmaily, SourceSmartengage, SourceSmartsheets, SourceSnapchatMarketing, SourceSnowflake, SourceSonarCloud, SourceSpacexAPI, SourceSquare, SourceStrava, SourceStripe, SourceSurveySparrow, SourceSurveymonkey, SourceTempo, SourceTheGuardianAPI, SourceTiktokMarketing, SourceTrello, SourceTrustpilot, SourceTvmazeSchedule, SourceTwilio, SourceTwilioTaskrouter, SourceTwitter, SourceTypeform, SourceUsCensus, SourceVantage, SourceWebflow, SourceWhiskyHunter, SourceWikipediaPageviews, SourceWoocommerce, SourceXkcd, SourceYandexMetrica, SourceYotpo, SourceYoutubeAnalytics, SourceZendeskChat, SourceZendeskSell, SourceZendeskSunshine, SourceZendeskSupport, SourceZendeskTalk, SourceZenloop, SourceZohoCrm, SourceZoom] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('configuration') }}) + configuration: Union[SourceAha, SourceAircall, SourceAirtable, SourceAmazonAds, SourceAmazonSellerPartner, SourceAmazonSqs, SourceAmplitude, SourceApifyDataset, SourceAppfollow, SourceAsana, SourceAuth0, SourceAwsCloudtrail, SourceAzureBlobStorage, SourceAzureTable, SourceBambooHr, SourceBigquery, SourceBingAds, SourceBraintree, SourceBraze, SourceCart, SourceChargebee, SourceChartmogul, SourceClickhouse, SourceClickupAPI, SourceClockify, SourceCloseCom, SourceCoda, SourceCoinAPI, SourceCoinmarketcap, SourceConfigcat, SourceConfluence, SourceConvex, SourceDatascope, SourceDelighted, SourceDixa, SourceDockerhub, SourceDremio, SourceDynamodb, Union[ContinuousFeed], SourceEmailoctopus, SourceExchangeRates, SourceFacebookMarketing, SourceFaker, SourceFauna, SourceFile, SourceFirebolt, SourceFreshcaller, SourceFreshdesk, SourceFreshsales, SourceGainsightPx, SourceGcs, SourceGetlago, SourceGithub, SourceGitlab, SourceGlassfrog, SourceGnews, SourceGoogleAds, SourceGoogleAnalyticsDataAPI, SourceGoogleAnalyticsV4ServiceAccountOnly, SourceGoogleDirectory, SourceGoogleDrive, SourceGooglePagespeedInsights, SourceGoogleSearchConsole, SourceGoogleSheets, SourceGoogleWebfonts, SourceGreenhouse, SourceGridly, SourceHarvest, SourceHubplanner, SourceHubspot, SourceInsightly, SourceInstagram, SourceInstatus, SourceIntercom, SourceIp2whois, SourceIterable, SourceJira, SourceK6Cloud, SourceKlarna, SourceKlaviyo, SourceKyve, SourceLaunchdarkly, SourceLemlist, SourceLeverHiring, SourceLinkedinAds, SourceLinkedinPages, SourceLinnworks, SourceLokalise, SourceMailchimp, SourceMailgun, SourceMailjetSms, SourceMarketo, SourceMetabase, SourceMicrosoftOnedrive, SourceMicrosoftSharepoint, SourceMicrosoftTeams, SourceMixpanel, SourceMonday, SourceMongodbInternalPoc, SourceMongodbV2, SourceMssql, SourceMyHours, SourceMysql, SourceNetsuite, SourceNotion, SourceNytimes, SourceOkta, SourceOmnisend, SourceOnesignal, SourceOracle, SourceOrb, SourceOrbit, SourceOutbrainAmplify, SourceOutreach, SourcePaypalTransaction, SourcePaystack, SourcePendo, SourcePersistiq, SourcePexelsAPI, SourcePinterest, SourcePipedrive, SourcePocket, SourcePokeapi, SourcePolygonStockAPI, SourcePostgres, SourcePosthog, SourcePostmarkapp, SourcePrestashop, SourcePunkAPI, SourcePypi, SourceQualaroo, SourceQuickbooks, SourceRailz, SourceRecharge, SourceRecreation, SourceRecruitee, SourceRecurly, SourceRedshift, SourceRetently, SourceRkiCovid, SourceRss, SourceS3, SourceSalesforce, SourceSalesloft, SourceSapFieldglass, SourceSecoda, SourceSendgrid, SourceSendinblue, SourceSenseforce, SourceSentry, SourceSftp, SourceSftpBulk, SourceShopify, SourceShortio, SourceSlack, SourceSmaily, SourceSmartengage, SourceSmartsheets, SourceSnapchatMarketing, SourceSnowflake, SourceSonarCloud, SourceSpacexAPI, SourceSquare, SourceStrava, SourceStripe, SourceSurveySparrow, SourceSurveymonkey, SourceTempo, SourceTheGuardianAPI, SourceTiktokMarketing, SourceTrello, SourceTrustpilot, SourceTvmazeSchedule, SourceTwilio, SourceTwilioTaskrouter, SourceTwitter, SourceTypeform, SourceUsCensus, SourceVantage, SourceWebflow, SourceWhiskyHunter, SourceWikipediaPageviews, SourceWoocommerce, SourceXkcd, SourceYandexMetrica, SourceYotpo, SourceYoutubeAnalytics, SourceZendeskChat, SourceZendeskSell, SourceZendeskSunshine, SourceZendeskSupport, SourceZendeskTalk, SourceZenloop, SourceZohoCrm, SourceZoom] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('configuration') }}) r"""The values required to configure the source.""" name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) diff --git a/src/airbyte/models/shared/sourceresponse.py b/src/airbyte_api/models/sourceresponse.py similarity index 81% rename from src/airbyte/models/shared/sourceresponse.py rename to src/airbyte_api/models/sourceresponse.py index 6abbc2bb..e990891d 100644 --- a/src/airbyte/models/shared/sourceresponse.py +++ b/src/airbyte_api/models/sourceresponse.py @@ -67,7 +67,6 @@ from .source_google_search_console import SourceGoogleSearchConsole from .source_google_sheets import SourceGoogleSheets from .source_google_webfonts import SourceGoogleWebfonts -from .source_google_workspace_admin_reports import SourceGoogleWorkspaceAdminReports from .source_greenhouse import SourceGreenhouse from .source_gridly import SourceGridly from .source_harvest import SourceHarvest @@ -89,12 +88,14 @@ from .source_lever_hiring import SourceLeverHiring from .source_linkedin_ads import SourceLinkedinAds from .source_linkedin_pages import SourceLinkedinPages +from .source_linnworks import SourceLinnworks from .source_lokalise import SourceLokalise from .source_mailchimp import SourceMailchimp from .source_mailgun import SourceMailgun from .source_mailjet_sms import SourceMailjetSms from .source_marketo import SourceMarketo from .source_metabase import SourceMetabase +from .source_microsoft_onedrive import SourceMicrosoftOnedrive from .source_microsoft_sharepoint import SourceMicrosoftSharepoint from .source_microsoft_teams import SourceMicrosoftTeams from .source_mixpanel import SourceMixpanel @@ -137,6 +138,7 @@ from .source_recharge import SourceRecharge from .source_recreation import SourceRecreation from .source_recruitee import SourceRecruitee +from .source_recurly import SourceRecurly from .source_redshift import SourceRedshift from .source_retently import SourceRetently from .source_rki_covid import SourceRkiCovid @@ -195,7 +197,7 @@ from .source_zenloop import SourceZenloop from .source_zoho_crm import SourceZohoCrm from .source_zoom import SourceZoom -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Union @@ -204,7 +206,7 @@ @dataclasses.dataclass class SourceResponse: r"""Provides details of a single source.""" - configuration: Union[SourceAha, SourceAircall, SourceAirtable, SourceAmazonAds, SourceAmazonSellerPartner, SourceAmazonSqs, SourceAmplitude, SourceApifyDataset, SourceAppfollow, SourceAsana, SourceAuth0, SourceAwsCloudtrail, SourceAzureBlobStorage, SourceAzureTable, SourceBambooHr, SourceBigquery, SourceBingAds, SourceBraintree, SourceBraze, SourceCart, SourceChargebee, SourceChartmogul, SourceClickhouse, SourceClickupAPI, SourceClockify, SourceCloseCom, SourceCoda, SourceCoinAPI, SourceCoinmarketcap, SourceConfigcat, SourceConfluence, SourceConvex, SourceDatascope, SourceDelighted, SourceDixa, SourceDockerhub, SourceDremio, SourceDynamodb, Union[ContinuousFeed], SourceEmailoctopus, SourceExchangeRates, SourceFacebookMarketing, SourceFaker, SourceFauna, SourceFile, SourceFirebolt, SourceFreshcaller, SourceFreshdesk, SourceFreshsales, SourceGainsightPx, SourceGcs, SourceGetlago, SourceGithub, SourceGitlab, SourceGlassfrog, SourceGnews, SourceGoogleAds, SourceGoogleAnalyticsDataAPI, SourceGoogleAnalyticsV4ServiceAccountOnly, SourceGoogleDirectory, SourceGoogleDrive, SourceGooglePagespeedInsights, SourceGoogleSearchConsole, SourceGoogleSheets, SourceGoogleWebfonts, SourceGoogleWorkspaceAdminReports, SourceGreenhouse, SourceGridly, SourceHarvest, SourceHubplanner, SourceHubspot, SourceInsightly, SourceInstagram, SourceInstatus, SourceIntercom, SourceIp2whois, SourceIterable, SourceJira, SourceK6Cloud, SourceKlarna, SourceKlaviyo, SourceKyve, SourceLaunchdarkly, SourceLemlist, SourceLeverHiring, SourceLinkedinAds, SourceLinkedinPages, SourceLokalise, SourceMailchimp, SourceMailgun, SourceMailjetSms, SourceMarketo, SourceMetabase, SourceMicrosoftSharepoint, SourceMicrosoftTeams, SourceMixpanel, SourceMonday, SourceMongodbInternalPoc, SourceMongodbV2, SourceMssql, SourceMyHours, SourceMysql, SourceNetsuite, SourceNotion, SourceNytimes, SourceOkta, SourceOmnisend, SourceOnesignal, SourceOracle, SourceOrb, SourceOrbit, SourceOutbrainAmplify, SourceOutreach, SourcePaypalTransaction, SourcePaystack, SourcePendo, SourcePersistiq, SourcePexelsAPI, SourcePinterest, SourcePipedrive, SourcePocket, SourcePokeapi, SourcePolygonStockAPI, SourcePostgres, SourcePosthog, SourcePostmarkapp, SourcePrestashop, SourcePunkAPI, SourcePypi, SourceQualaroo, SourceQuickbooks, SourceRailz, SourceRecharge, SourceRecreation, SourceRecruitee, SourceRedshift, SourceRetently, SourceRkiCovid, SourceRss, SourceS3, SourceSalesforce, SourceSalesloft, SourceSapFieldglass, SourceSecoda, SourceSendgrid, SourceSendinblue, SourceSenseforce, SourceSentry, SourceSftp, SourceSftpBulk, SourceShopify, SourceShortio, SourceSlack, SourceSmaily, SourceSmartengage, SourceSmartsheets, SourceSnapchatMarketing, SourceSnowflake, SourceSonarCloud, SourceSpacexAPI, SourceSquare, SourceStrava, SourceStripe, SourceSurveySparrow, SourceSurveymonkey, SourceTempo, SourceTheGuardianAPI, SourceTiktokMarketing, SourceTrello, SourceTrustpilot, SourceTvmazeSchedule, SourceTwilio, SourceTwilioTaskrouter, SourceTwitter, SourceTypeform, SourceUsCensus, SourceVantage, SourceWebflow, SourceWhiskyHunter, SourceWikipediaPageviews, SourceWoocommerce, SourceXkcd, SourceYandexMetrica, SourceYotpo, SourceYoutubeAnalytics, SourceZendeskChat, SourceZendeskSell, SourceZendeskSunshine, SourceZendeskSupport, SourceZendeskTalk, SourceZenloop, SourceZohoCrm, SourceZoom] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('configuration') }}) + configuration: Union[SourceAha, SourceAircall, SourceAirtable, SourceAmazonAds, SourceAmazonSellerPartner, SourceAmazonSqs, SourceAmplitude, SourceApifyDataset, SourceAppfollow, SourceAsana, SourceAuth0, SourceAwsCloudtrail, SourceAzureBlobStorage, SourceAzureTable, SourceBambooHr, SourceBigquery, SourceBingAds, SourceBraintree, SourceBraze, SourceCart, SourceChargebee, SourceChartmogul, SourceClickhouse, SourceClickupAPI, SourceClockify, SourceCloseCom, SourceCoda, SourceCoinAPI, SourceCoinmarketcap, SourceConfigcat, SourceConfluence, SourceConvex, SourceDatascope, SourceDelighted, SourceDixa, SourceDockerhub, SourceDremio, SourceDynamodb, Union[ContinuousFeed], SourceEmailoctopus, SourceExchangeRates, SourceFacebookMarketing, SourceFaker, SourceFauna, SourceFile, SourceFirebolt, SourceFreshcaller, SourceFreshdesk, SourceFreshsales, SourceGainsightPx, SourceGcs, SourceGetlago, SourceGithub, SourceGitlab, SourceGlassfrog, SourceGnews, SourceGoogleAds, SourceGoogleAnalyticsDataAPI, SourceGoogleAnalyticsV4ServiceAccountOnly, SourceGoogleDirectory, SourceGoogleDrive, SourceGooglePagespeedInsights, SourceGoogleSearchConsole, SourceGoogleSheets, SourceGoogleWebfonts, SourceGreenhouse, SourceGridly, SourceHarvest, SourceHubplanner, SourceHubspot, SourceInsightly, SourceInstagram, SourceInstatus, SourceIntercom, SourceIp2whois, SourceIterable, SourceJira, SourceK6Cloud, SourceKlarna, SourceKlaviyo, SourceKyve, SourceLaunchdarkly, SourceLemlist, SourceLeverHiring, SourceLinkedinAds, SourceLinkedinPages, SourceLinnworks, SourceLokalise, SourceMailchimp, SourceMailgun, SourceMailjetSms, SourceMarketo, SourceMetabase, SourceMicrosoftOnedrive, SourceMicrosoftSharepoint, SourceMicrosoftTeams, SourceMixpanel, SourceMonday, SourceMongodbInternalPoc, SourceMongodbV2, SourceMssql, SourceMyHours, SourceMysql, SourceNetsuite, SourceNotion, SourceNytimes, SourceOkta, SourceOmnisend, SourceOnesignal, SourceOracle, SourceOrb, SourceOrbit, SourceOutbrainAmplify, SourceOutreach, SourcePaypalTransaction, SourcePaystack, SourcePendo, SourcePersistiq, SourcePexelsAPI, SourcePinterest, SourcePipedrive, SourcePocket, SourcePokeapi, SourcePolygonStockAPI, SourcePostgres, SourcePosthog, SourcePostmarkapp, SourcePrestashop, SourcePunkAPI, SourcePypi, SourceQualaroo, SourceQuickbooks, SourceRailz, SourceRecharge, SourceRecreation, SourceRecruitee, SourceRecurly, SourceRedshift, SourceRetently, SourceRkiCovid, SourceRss, SourceS3, SourceSalesforce, SourceSalesloft, SourceSapFieldglass, SourceSecoda, SourceSendgrid, SourceSendinblue, SourceSenseforce, SourceSentry, SourceSftp, SourceSftpBulk, SourceShopify, SourceShortio, SourceSlack, SourceSmaily, SourceSmartengage, SourceSmartsheets, SourceSnapchatMarketing, SourceSnowflake, SourceSonarCloud, SourceSpacexAPI, SourceSquare, SourceStrava, SourceStripe, SourceSurveySparrow, SourceSurveymonkey, SourceTempo, SourceTheGuardianAPI, SourceTiktokMarketing, SourceTrello, SourceTrustpilot, SourceTvmazeSchedule, SourceTwilio, SourceTwilioTaskrouter, SourceTwitter, SourceTypeform, SourceUsCensus, SourceVantage, SourceWebflow, SourceWhiskyHunter, SourceWikipediaPageviews, SourceWoocommerce, SourceXkcd, SourceYandexMetrica, SourceYotpo, SourceYoutubeAnalytics, SourceZendeskChat, SourceZendeskSell, SourceZendeskSunshine, SourceZendeskSupport, SourceZendeskTalk, SourceZenloop, SourceZohoCrm, SourceZoom] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('configuration') }}) r"""The values required to configure the source.""" name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) source_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceId') }}) diff --git a/src/airbyte/models/shared/sourcesresponse.py b/src/airbyte_api/models/sourcesresponse.py similarity index 96% rename from src/airbyte/models/shared/sourcesresponse.py rename to src/airbyte_api/models/sourcesresponse.py index 610c4089..4a0591ec 100644 --- a/src/airbyte/models/shared/sourcesresponse.py +++ b/src/airbyte_api/models/sourcesresponse.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses from .sourceresponse import SourceResponse -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional diff --git a/src/airbyte/models/shared/square.py b/src/airbyte_api/models/square.py similarity index 97% rename from src/airbyte/models/shared/square.py rename to src/airbyte_api/models/square.py index d03e2afb..bbb32293 100644 --- a/src/airbyte/models/shared/square.py +++ b/src/airbyte_api/models/square.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/strava.py b/src/airbyte_api/models/strava.py similarity index 96% rename from src/airbyte/models/shared/strava.py rename to src/airbyte_api/models/strava.py index b72052c6..e0ceb376 100644 --- a/src/airbyte/models/shared/strava.py +++ b/src/airbyte_api/models/strava.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/streamconfiguration.py b/src/airbyte_api/models/streamconfiguration.py similarity index 98% rename from src/airbyte/models/shared/streamconfiguration.py rename to src/airbyte_api/models/streamconfiguration.py index 0fd9c9d4..e98171ef 100644 --- a/src/airbyte/models/shared/streamconfiguration.py +++ b/src/airbyte_api/models/streamconfiguration.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses from .connectionsyncmodeenum import ConnectionSyncModeEnum -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional diff --git a/src/airbyte/models/shared/streamconfigurations.py b/src/airbyte_api/models/streamconfigurations.py similarity index 95% rename from src/airbyte/models/shared/streamconfigurations.py rename to src/airbyte_api/models/streamconfigurations.py index c2a389c2..6e250850 100644 --- a/src/airbyte/models/shared/streamconfigurations.py +++ b/src/airbyte_api/models/streamconfigurations.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses from .streamconfiguration import StreamConfiguration -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional diff --git a/src/airbyte/models/shared/streamproperties.py b/src/airbyte_api/models/streamproperties.py similarity index 98% rename from src/airbyte/models/shared/streamproperties.py rename to src/airbyte_api/models/streamproperties.py index 04ea479e..94e52d8c 100644 --- a/src/airbyte/models/shared/streamproperties.py +++ b/src/airbyte_api/models/streamproperties.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses from .connectionsyncmodeenum import ConnectionSyncModeEnum -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional diff --git a/src/airbyte/models/shared/streampropertiesresponse.py b/src/airbyte_api/models/streampropertiesresponse.py similarity index 95% rename from src/airbyte/models/shared/streampropertiesresponse.py rename to src/airbyte_api/models/streampropertiesresponse.py index a658c976..6adb3117 100644 --- a/src/airbyte/models/shared/streampropertiesresponse.py +++ b/src/airbyte_api/models/streampropertiesresponse.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses from .streamproperties import StreamProperties -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional diff --git a/src/airbyte/models/shared/surveymonkey.py b/src/airbyte_api/models/surveymonkey.py similarity index 97% rename from src/airbyte/models/shared/surveymonkey.py rename to src/airbyte_api/models/surveymonkey.py index 56125631..fe2a3e15 100644 --- a/src/airbyte/models/shared/surveymonkey.py +++ b/src/airbyte_api/models/surveymonkey.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/tiktok_marketing.py b/src/airbyte_api/models/tiktok_marketing.py similarity index 97% rename from src/airbyte/models/shared/tiktok_marketing.py rename to src/airbyte_api/models/tiktok_marketing.py index 5077f53a..8ff57b14 100644 --- a/src/airbyte/models/shared/tiktok_marketing.py +++ b/src/airbyte_api/models/tiktok_marketing.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/typeform.py b/src/airbyte_api/models/typeform.py similarity index 97% rename from src/airbyte/models/shared/typeform.py rename to src/airbyte_api/models/typeform.py index 27072aae..94050561 100644 --- a/src/airbyte/models/shared/typeform.py +++ b/src/airbyte_api/models/typeform.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/workspacecreaterequest.py b/src/airbyte_api/models/workspacecreaterequest.py similarity index 93% rename from src/airbyte/models/shared/workspacecreaterequest.py rename to src/airbyte_api/models/workspacecreaterequest.py index f72cc098..ea35eebe 100644 --- a/src/airbyte/models/shared/workspacecreaterequest.py +++ b/src/airbyte_api/models/workspacecreaterequest.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json diff --git a/src/airbyte/models/shared/workspaceoauthcredentialsrequest.py b/src/airbyte_api/models/workspaceoauthcredentialsrequest.py similarity index 83% rename from src/airbyte/models/shared/workspaceoauthcredentialsrequest.py rename to src/airbyte_api/models/workspaceoauthcredentialsrequest.py index e11a54b8..790f19ba 100644 --- a/src/airbyte/models/shared/workspaceoauthcredentialsrequest.py +++ b/src/airbyte_api/models/workspaceoauthcredentialsrequest.py @@ -23,6 +23,7 @@ from .lever_hiring import LeverHiring from .linkedin_ads import LinkedinAds from .mailchimp import Mailchimp +from .microsoft_onedrive import MicrosoftOnedrive from .microsoft_sharepoint import MicrosoftSharepoint from .microsoft_teams import MicrosoftTeams from .monday import Monday @@ -46,7 +47,7 @@ from .zendesk_sunshine import ZendeskSunshine from .zendesk_support import ZendeskSupport from .zendesk_talk import ZendeskTalk -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Any, Union @@ -57,7 +58,7 @@ class WorkspaceOAuthCredentialsRequest: r"""POST body for creating/updating workspace level OAuth credentials""" actor_type: ActorTypeEnum = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('actorType') }}) r"""Whether you're setting this override for a source or destination""" - configuration: Union[Airtable, AmazonAds, AmazonSellerPartner, Asana, BingAds, FacebookMarketing, Github, Gitlab, GoogleAds, GoogleAnalyticsDataAPI, GoogleDrive, GoogleSearchConsole, GoogleSheets, Harvest, Hubspot, Instagram, Intercom, LeverHiring, LinkedinAds, Mailchimp, MicrosoftSharepoint, MicrosoftTeams, Monday, Notion, Pinterest, Retently, Salesforce, Shopify, Slack, Smartsheets, SnapchatMarketing, Snowflake, Square, Strava, Surveymonkey, TiktokMarketing, Any, Typeform, YoutubeAnalytics, ZendeskChat, ZendeskSunshine, ZendeskSupport, ZendeskTalk] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('configuration') }}) + configuration: Union[Airtable, AmazonAds, AmazonSellerPartner, Asana, BingAds, FacebookMarketing, Github, Gitlab, GoogleAds, GoogleAnalyticsDataAPI, GoogleDrive, GoogleSearchConsole, GoogleSheets, Harvest, Hubspot, Instagram, Intercom, LeverHiring, LinkedinAds, Mailchimp, MicrosoftOnedrive, MicrosoftSharepoint, MicrosoftTeams, Monday, Notion, Pinterest, Retently, Salesforce, Shopify, Slack, Smartsheets, SnapchatMarketing, Snowflake, Square, Strava, Surveymonkey, TiktokMarketing, Any, Typeform, YoutubeAnalytics, ZendeskChat, ZendeskSunshine, ZendeskSupport, ZendeskTalk] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('configuration') }}) r"""The values required to configure the source.""" name: OAuthActorNames = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) diff --git a/src/airbyte/models/shared/workspaceresponse.py b/src/airbyte_api/models/workspaceresponse.py similarity index 96% rename from src/airbyte/models/shared/workspaceresponse.py rename to src/airbyte_api/models/workspaceresponse.py index 26d84770..ea3a0171 100644 --- a/src/airbyte/models/shared/workspaceresponse.py +++ b/src/airbyte_api/models/workspaceresponse.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses from .geographyenum import GeographyEnum -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/workspacesresponse.py b/src/airbyte_api/models/workspacesresponse.py similarity index 96% rename from src/airbyte/models/shared/workspacesresponse.py rename to src/airbyte_api/models/workspacesresponse.py index 920e1457..50defee5 100644 --- a/src/airbyte/models/shared/workspacesresponse.py +++ b/src/airbyte_api/models/workspacesresponse.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses from .workspaceresponse import WorkspaceResponse -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional diff --git a/src/airbyte/models/shared/workspaceupdaterequest.py b/src/airbyte_api/models/workspaceupdaterequest.py similarity index 93% rename from src/airbyte/models/shared/workspaceupdaterequest.py rename to src/airbyte_api/models/workspaceupdaterequest.py index 4a16bf0a..a9ee53ab 100644 --- a/src/airbyte/models/shared/workspaceupdaterequest.py +++ b/src/airbyte_api/models/workspaceupdaterequest.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json diff --git a/src/airbyte/models/shared/youtube_analytics.py b/src/airbyte_api/models/youtube_analytics.py similarity index 97% rename from src/airbyte/models/shared/youtube_analytics.py rename to src/airbyte_api/models/youtube_analytics.py index bb5c5777..d3143187 100644 --- a/src/airbyte/models/shared/youtube_analytics.py +++ b/src/airbyte_api/models/youtube_analytics.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/zendesk_chat.py b/src/airbyte_api/models/zendesk_chat.py similarity index 97% rename from src/airbyte/models/shared/zendesk_chat.py rename to src/airbyte_api/models/zendesk_chat.py index cc2748c2..2d851d74 100644 --- a/src/airbyte/models/shared/zendesk_chat.py +++ b/src/airbyte_api/models/zendesk_chat.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/zendesk_sunshine.py b/src/airbyte_api/models/zendesk_sunshine.py similarity index 97% rename from src/airbyte/models/shared/zendesk_sunshine.py rename to src/airbyte_api/models/zendesk_sunshine.py index c761dd58..67a498b7 100644 --- a/src/airbyte/models/shared/zendesk_sunshine.py +++ b/src/airbyte_api/models/zendesk_sunshine.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/zendesk_support.py b/src/airbyte_api/models/zendesk_support.py similarity index 98% rename from src/airbyte/models/shared/zendesk_support.py rename to src/airbyte_api/models/zendesk_support.py index 364fe2b3..0a5ed9ff 100644 --- a/src/airbyte/models/shared/zendesk_support.py +++ b/src/airbyte_api/models/zendesk_support.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte/models/shared/zendesk_talk.py b/src/airbyte_api/models/zendesk_talk.py similarity index 97% rename from src/airbyte/models/shared/zendesk_talk.py rename to src/airbyte_api/models/zendesk_talk.py index 5fc3ba63..135da0d8 100644 --- a/src/airbyte/models/shared/zendesk_talk.py +++ b/src/airbyte_api/models/zendesk_talk.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from airbyte import utils +from airbyte_api import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional diff --git a/src/airbyte_api/sdk.py b/src/airbyte_api/sdk.py new file mode 100644 index 00000000..3604e804 --- /dev/null +++ b/src/airbyte_api/sdk.py @@ -0,0 +1,85 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +import requests as requests_http +from .connections import Connections +from .destinations import Destinations +from .jobs import Jobs +from .sdkconfiguration import SDKConfiguration +from .sources import Sources +from .streams import Streams +from .utils.retries import RetryConfig +from .workspaces import Workspaces +from airbyte_api import models, utils +from airbyte_api._hooks import SDKHooks +from typing import Callable, Dict, Optional, Union + +class AirbyteAPI: + r"""airbyte-api: Programmatically control Airbyte Cloud, OSS & Enterprise.""" + connections: Connections + destinations: Destinations + jobs: Jobs + sources: Sources + streams: Streams + workspaces: Workspaces + + sdk_configuration: SDKConfiguration + + def __init__(self, + security: Union[models.Security,Callable[[], models.Security]] = None, + server_idx: Optional[int] = None, + server_url: Optional[str] = None, + url_params: Optional[Dict[str, str]] = None, + client: Optional[requests_http.Session] = None, + retry_config: Optional[RetryConfig] = None + ) -> None: + """Instantiates the SDK configuring it with the provided parameters. + + :param security: The security details required for authentication + :type security: Union[models.Security,Callable[[], models.Security]] + :param server_idx: The index of the server to use for all operations + :type server_idx: int + :param server_url: The server URL to use for all operations + :type server_url: str + :param url_params: Parameters to optionally template the server URL with + :type url_params: Dict[str, str] + :param client: The requests.Session HTTP client to use for all operations + :type client: requests_http.Session + :param retry_config: The utils.RetryConfig to use globally + :type retry_config: RetryConfig + """ + if client is None: + client = requests_http.Session() + + if server_url is not None: + if url_params is not None: + server_url = utils.template_url(server_url, url_params) + + + self.sdk_configuration = SDKConfiguration( + client, + security, + server_url, + server_idx, + retry_config=retry_config + ) + + hooks = SDKHooks() + + current_server_url, *_ = self.sdk_configuration.get_server_details() + server_url, self.sdk_configuration.client = hooks.sdk_init(current_server_url, self.sdk_configuration.client) + if current_server_url != server_url: + self.sdk_configuration.server_url = server_url + + # pylint: disable=protected-access + self.sdk_configuration.__dict__['_hooks'] = hooks + + self._init_sdks() + + + def _init_sdks(self): + self.connections = Connections(self.sdk_configuration) + self.destinations = Destinations(self.sdk_configuration) + self.jobs = Jobs(self.sdk_configuration) + self.sources = Sources(self.sdk_configuration) + self.streams = Streams(self.sdk_configuration) + self.workspaces = Workspaces(self.sdk_configuration) diff --git a/src/airbyte_api/sdkconfiguration.py b/src/airbyte_api/sdkconfiguration.py new file mode 100644 index 00000000..3dff8ab4 --- /dev/null +++ b/src/airbyte_api/sdkconfiguration.py @@ -0,0 +1,45 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + + +import requests as requests_http +from ._hooks import SDKHooks +from .utils import utils +from .utils.retries import RetryConfig +from airbyte_api import models +from dataclasses import dataclass +from typing import Callable, Dict, Optional, Tuple, Union + + +SERVERS = [ + 'https://api.airbyte.com/v1', + # Airbyte API v1 +] +"""Contains the list of servers available to the SDK""" + +@dataclass +class SDKConfiguration: + client: requests_http.Session + security: Union[models.Security,Callable[[], models.Security]] = None + server_url: Optional[str] = '' + server_idx: Optional[int] = 0 + language: str = 'python' + openapi_doc_version: str = '1.0.0' + sdk_version: str = '0.49.1' + gen_version: str = '2.304.1' + user_agent: str = 'speakeasy-sdk/python 0.49.1 2.304.1 1.0.0 airbyte-api' + retry_config: Optional[RetryConfig] = None + + def __post_init__(self): + self._hooks = SDKHooks() + + def get_server_details(self) -> Tuple[str, Dict[str, str]]: + if self.server_url is not None and self.server_url != '': + return utils.remove_suffix(self.server_url, '/'), {} + if self.server_idx is None: + self.server_idx = 0 + + return SERVERS[self.server_idx], {} + + + def get_hooks(self) -> SDKHooks: + return self._hooks diff --git a/src/airbyte_api/sources.py b/src/airbyte_api/sources.py new file mode 100644 index 00000000..ede38be9 --- /dev/null +++ b/src/airbyte_api/sources.py @@ -0,0 +1,407 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +import requests as requests_http +from .sdkconfiguration import SDKConfiguration +from airbyte_api import api, errors, models, utils +from airbyte_api._hooks import AfterErrorContext, AfterSuccessContext, BeforeRequestContext, HookContext +from typing import Optional + +class Sources: + sdk_configuration: SDKConfiguration + + def __init__(self, sdk_config: SDKConfiguration) -> None: + self.sdk_configuration = sdk_config + + + + def create_source(self, request: Optional[models.SourceCreateRequest]) -> api.CreateSourceResponse: + r"""Create a source + Creates a source given a name, workspace id, and a json blob containing the configuration for the source. + """ + hook_ctx = HookContext(operation_id='createSource', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = base_url + '/sources' + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + req_content_type, data, form = utils.serialize_request_body(request, Optional[models.SourceCreateRequest], "request", False, True, 'json') + if req_content_type is not None and req_content_type not in ('multipart/form-data', 'multipart/mixed'): + headers['content-type'] = req_content_type + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('POST', url, params=query_params, data=data, files=form, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['400','403','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.CreateSourceResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(http_res.headers.get('Content-Type') or '', 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[models.SourceResponse]) + res.source_response = out + else: + content_type = http_res.headers.get('Content-Type') + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + elif http_res.status_code == 400 or http_res.status_code == 403 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + + def delete_source(self, request: api.DeleteSourceRequest) -> api.DeleteSourceResponse: + r"""Delete a Source""" + hook_ctx = HookContext(operation_id='deleteSource', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = utils.generate_url(base_url, '/sources/{sourceId}', request) + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + headers['Accept'] = '*/*' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('DELETE', url, params=query_params, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['403','404','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.DeleteSourceResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 204: + pass + elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + + def get_source(self, request: api.GetSourceRequest) -> api.GetSourceResponse: + r"""Get Source details""" + hook_ctx = HookContext(operation_id='getSource', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = utils.generate_url(base_url, '/sources/{sourceId}', request) + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('GET', url, params=query_params, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['403','404','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.GetSourceResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(http_res.headers.get('Content-Type') or '', 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[models.SourceResponse]) + res.source_response = out + else: + content_type = http_res.headers.get('Content-Type') + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + + def initiate_o_auth(self, request: models.InitiateOauthRequest) -> api.InitiateOAuthResponse: + r"""Initiate OAuth for a source + Given a source ID, workspace ID, and redirect URL, initiates OAuth for the source. + + This returns a fully formed URL for performing user authentication against the relevant source identity provider (IdP). Once authentication has been completed, the IdP will redirect to an Airbyte endpoint which will save the access and refresh tokens off as a secret and return the secret ID to the redirect URL specified in the `secret_id` query string parameter. + + That secret ID can be used to create a source with credentials in place of actual tokens. + """ + hook_ctx = HookContext(operation_id='initiateOAuth', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = base_url + '/sources/initiateOAuth' + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + req_content_type, data, form = utils.serialize_request_body(request, models.InitiateOauthRequest, "request", False, False, 'json') + if req_content_type is not None and req_content_type not in ('multipart/form-data', 'multipart/mixed'): + headers['content-type'] = req_content_type + if data is None and form is None: + raise Exception('request body is required') + headers['Accept'] = '*/*' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('POST', url, params=query_params, data=data, files=form, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['400','403','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.InitiateOAuthResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + pass + elif http_res.status_code == 400 or http_res.status_code == 403 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + + def list_sources(self, request: api.ListSourcesRequest) -> api.ListSourcesResponse: + r"""List sources""" + hook_ctx = HookContext(operation_id='listSources', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = base_url + '/sources' + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + query_params = { **utils.get_query_params(request), **query_params } + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('GET', url, params=query_params, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['403','404','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.ListSourcesResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(http_res.headers.get('Content-Type') or '', 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[models.SourcesResponse]) + res.sources_response = out + else: + content_type = http_res.headers.get('Content-Type') + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + + def patch_source(self, request: api.PatchSourceRequest) -> api.PatchSourceResponse: + r"""Update a Source""" + hook_ctx = HookContext(operation_id='patchSource', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = utils.generate_url(base_url, '/sources/{sourceId}', request) + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + req_content_type, data, form = utils.serialize_request_body(request, api.PatchSourceRequest, "source_patch_request", False, True, 'json') + if req_content_type is not None and req_content_type not in ('multipart/form-data', 'multipart/mixed'): + headers['content-type'] = req_content_type + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('PATCH', url, params=query_params, data=data, files=form, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['403','404','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.PatchSourceResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(http_res.headers.get('Content-Type') or '', 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[models.SourceResponse]) + res.source_response = out + else: + content_type = http_res.headers.get('Content-Type') + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + + def put_source(self, request: api.PutSourceRequest) -> api.PutSourceResponse: + r"""Update a Source and fully overwrite it""" + hook_ctx = HookContext(operation_id='putSource', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = utils.generate_url(base_url, '/sources/{sourceId}', request) + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + req_content_type, data, form = utils.serialize_request_body(request, api.PutSourceRequest, "source_put_request", False, True, 'json') + if req_content_type is not None and req_content_type not in ('multipart/form-data', 'multipart/mixed'): + headers['content-type'] = req_content_type + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('PUT', url, params=query_params, data=data, files=form, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['403','404','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.PutSourceResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(http_res.headers.get('Content-Type') or '', 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[models.SourceResponse]) + res.source_response = out + else: + content_type = http_res.headers.get('Content-Type') + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + diff --git a/src/airbyte_api/streams.py b/src/airbyte_api/streams.py new file mode 100644 index 00000000..bf065a6d --- /dev/null +++ b/src/airbyte_api/streams.py @@ -0,0 +1,71 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +import requests as requests_http +from .sdkconfiguration import SDKConfiguration +from airbyte_api import api, errors, models, utils +from airbyte_api._hooks import AfterErrorContext, AfterSuccessContext, BeforeRequestContext, HookContext +from typing import Optional + +class Streams: + sdk_configuration: SDKConfiguration + + def __init__(self, sdk_config: SDKConfiguration) -> None: + self.sdk_configuration = sdk_config + + + + def get_stream_properties(self, request: api.GetStreamPropertiesRequest) -> api.GetStreamPropertiesResponse: + r"""Get stream properties""" + hook_ctx = HookContext(operation_id='getStreamProperties', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = base_url + '/streams' + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + query_params = { **utils.get_query_params(request), **query_params } + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('GET', url, params=query_params, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['400','403','404','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.GetStreamPropertiesResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(http_res.headers.get('Content-Type') or '', 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[models.StreamPropertiesResponse]) + res.stream_properties_response = out + else: + content_type = http_res.headers.get('Content-Type') + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + elif http_res.status_code == 400 or http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + diff --git a/src/airbyte/utils/__init__.py b/src/airbyte_api/utils/__init__.py similarity index 100% rename from src/airbyte/utils/__init__.py rename to src/airbyte_api/utils/__init__.py diff --git a/src/airbyte/utils/retries.py b/src/airbyte_api/utils/retries.py similarity index 94% rename from src/airbyte/utils/retries.py rename to src/airbyte_api/utils/retries.py index 8eba0940..c40fc413 100644 --- a/src/airbyte/utils/retries.py +++ b/src/airbyte_api/utils/retries.py @@ -75,12 +75,12 @@ def do_request(): if res.status_code == parsed_code: raise TemporaryError(res) except requests.exceptions.ConnectionError as exception: - if retries.config.config.retry_connection_errors: + if retries.config.retry_connection_errors: raise raise PermanentError(exception) from exception except requests.exceptions.Timeout as exception: - if retries.config.config.retry_connection_errors: + if retries.config.retry_connection_errors: raise raise PermanentError(exception) from exception @@ -114,7 +114,6 @@ def retry_with_backoff(func, initial_interval=500, max_interval=60000, exponent= raise sleep = ((initial_interval/1000) * exponent**retries + random.uniform(0, 1)) - if sleep > max_interval/1000: - sleep = max_interval/1000 + sleep = min(sleep, max_interval / 1000) time.sleep(sleep) retries += 1 diff --git a/src/airbyte_api/utils/utils.py b/src/airbyte_api/utils/utils.py new file mode 100644 index 00000000..79c6adc0 --- /dev/null +++ b/src/airbyte_api/utils/utils.py @@ -0,0 +1,1060 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +import base64 +import json +import re +import sys +from dataclasses import Field, fields, is_dataclass, make_dataclass +from datetime import date, datetime +from decimal import Decimal +from email.message import Message +from enum import Enum +from typing import ( + Any, + Callable, + Dict, + List, + Optional, + Tuple, + Union, + get_args, + get_origin, +) +from xmlrpc.client import boolean +from typing_inspect import is_optional_type +import dateutil.parser +from dataclasses_json import DataClassJsonMixin + + +def get_security(security: Any) -> Tuple[Dict[str, str], Dict[str, str]]: + headers: Dict[str, str] = {} + query_params: Dict[str, str] = {} + + if security is None: + return headers, query_params + + sec_fields: Tuple[Field, ...] = fields(security) + for sec_field in sec_fields: + value = getattr(security, sec_field.name) + if value is None: + continue + + metadata = sec_field.metadata.get("security") + if metadata is None: + continue + if metadata.get("option"): + _parse_security_option(headers, query_params, value) + return headers, query_params + if metadata.get("scheme"): + # Special case for basic auth which could be a flattened struct + if metadata.get("sub_type") == "basic" and not is_dataclass(value): + _parse_security_scheme(headers, query_params, metadata, security) + else: + _parse_security_scheme(headers, query_params, metadata, value) + + return headers, query_params + + +def _parse_security_option( + headers: Dict[str, str], query_params: Dict[str, str], option: Any +): + opt_fields: Tuple[Field, ...] = fields(option) + for opt_field in opt_fields: + metadata = opt_field.metadata.get("security") + if metadata is None or metadata.get("scheme") is None: + continue + _parse_security_scheme( + headers, query_params, metadata, getattr(option, opt_field.name) + ) + + +def _parse_security_scheme( + headers: Dict[str, str], + query_params: Dict[str, str], + scheme_metadata: Dict, + scheme: Any, +): + scheme_type = scheme_metadata.get("type") + sub_type = scheme_metadata.get("sub_type") + + if is_dataclass(scheme): + if scheme_type == "http" and sub_type == "basic": + _parse_basic_auth_scheme(headers, scheme) + return + + scheme_fields: Tuple[Field, ...] = fields(scheme) + for scheme_field in scheme_fields: + metadata = scheme_field.metadata.get("security") + if metadata is None or metadata.get("field_name") is None: + continue + + value = getattr(scheme, scheme_field.name) + + _parse_security_scheme_value( + headers, query_params, scheme_metadata, metadata, value + ) + else: + _parse_security_scheme_value( + headers, query_params, scheme_metadata, scheme_metadata, scheme + ) + + +def _parse_security_scheme_value( + headers: Dict[str, str], + query_params: Dict[str, str], + scheme_metadata: Dict, + security_metadata: Dict, + value: Any, +): + scheme_type = scheme_metadata.get("type") + sub_type = scheme_metadata.get("sub_type") + + header_name = str(security_metadata.get("field_name")) + + if scheme_type == "apiKey": + if sub_type == "header": + headers[header_name] = value + elif sub_type == "query": + query_params[header_name] = value + else: + raise Exception("not supported") + elif scheme_type == "openIdConnect": + headers[header_name] = _apply_bearer(value) + elif scheme_type == "oauth2": + if sub_type != "client_credentials": + headers[header_name] = _apply_bearer(value) + elif scheme_type == "http": + if sub_type == "bearer": + headers[header_name] = _apply_bearer(value) + else: + raise Exception("not supported") + else: + raise Exception("not supported") + + +def _apply_bearer(token: str) -> str: + return token.lower().startswith("bearer ") and token or f"Bearer {token}" + + +def _parse_basic_auth_scheme(headers: Dict[str, str], scheme: Any): + username = "" + password = "" + + scheme_fields: Tuple[Field, ...] = fields(scheme) + for scheme_field in scheme_fields: + metadata = scheme_field.metadata.get("security") + if metadata is None or metadata.get("field_name") is None: + continue + + field_name = metadata.get("field_name") + value = getattr(scheme, scheme_field.name) + + if field_name == "username": + username = value + if field_name == "password": + password = value + + data = f"{username}:{password}".encode() + headers["Authorization"] = f"Basic {base64.b64encode(data).decode()}" + + +def generate_url( + server_url: str, + path: str, + path_params: Any, + gbls: Optional[Any] = None, +) -> str: + path_param_values: Dict[str, str] = {} + + globals_already_populated = _populate_path_params( + path_params, gbls, path_param_values, [] + ) + if gbls is not None: + _populate_path_params(gbls, None, path_param_values, globals_already_populated) + + for key, value in path_param_values.items(): + path = path.replace("{" + key + "}", value, 1) + + return remove_suffix(server_url, "/") + path + + +def _populate_path_params( + path_params: Any, + gbls: Any, + path_param_values: Dict[str, str], + skip_fields: List[str], +) -> List[str]: + globals_already_populated: List[str] = [] + + path_param_fields: Tuple[Field, ...] = fields(path_params) + for field in path_param_fields: + if field.name in skip_fields: + continue + + param_metadata = field.metadata.get("path_param") + if param_metadata is None: + continue + + param = getattr(path_params, field.name) if path_params is not None else None + param, global_found = _populate_from_globals( + field.name, param, "path_param", gbls + ) + if global_found: + globals_already_populated.append(field.name) + + if param is None: + continue + + f_name = param_metadata.get("field_name", field.name) + serialization = param_metadata.get("serialization", "") + if serialization != "": + serialized_params = _get_serialized_params( + param_metadata, field.type, f_name, param + ) + for key, value in serialized_params.items(): + path_param_values[key] = value + else: + if param_metadata.get("style", "simple") == "simple": + if isinstance(param, List): + pp_vals: List[str] = [] + for pp_val in param: + if pp_val is None: + continue + pp_vals.append(_val_to_string(pp_val)) + path_param_values[param_metadata.get("field_name", field.name)] = ( + ",".join(pp_vals) + ) + elif isinstance(param, Dict): + pp_vals: List[str] = [] + for pp_key in param: + if param[pp_key] is None: + continue + if param_metadata.get("explode"): + pp_vals.append(f"{pp_key}={_val_to_string(param[pp_key])}") + else: + pp_vals.append(f"{pp_key},{_val_to_string(param[pp_key])}") + path_param_values[param_metadata.get("field_name", field.name)] = ( + ",".join(pp_vals) + ) + elif not isinstance(param, (str, int, float, complex, bool, Decimal)): + pp_vals: List[str] = [] + param_fields: Tuple[Field, ...] = fields(param) + for param_field in param_fields: + param_value_metadata = param_field.metadata.get("path_param") + if not param_value_metadata: + continue + + param_name = param_value_metadata.get("field_name", field.name) + + param_field_val = getattr(param, param_field.name) + if param_field_val is None: + continue + if param_metadata.get("explode"): + pp_vals.append( + f"{param_name}={_val_to_string(param_field_val)}" + ) + else: + pp_vals.append( + f"{param_name},{_val_to_string(param_field_val)}" + ) + path_param_values[param_metadata.get("field_name", field.name)] = ( + ",".join(pp_vals) + ) + else: + path_param_values[param_metadata.get("field_name", field.name)] = ( + _val_to_string(param) + ) + + return globals_already_populated + + +def is_optional(field): + return get_origin(field) is Union and type(None) in get_args(field) + + +def template_url(url_with_params: str, params: Dict[str, str]) -> str: + for key, value in params.items(): + url_with_params = url_with_params.replace("{" + key + "}", value) + + return url_with_params + + +def get_query_params( + query_params: Any, + gbls: Optional[Any] = None, +) -> Dict[str, List[str]]: + params: Dict[str, List[str]] = {} + + globals_already_populated = _populate_query_params(query_params, gbls, params, []) + if gbls is not None: + _populate_query_params(gbls, None, params, globals_already_populated) + + return params + + +def _populate_query_params( + query_params: Any, + gbls: Any, + query_param_values: Dict[str, List[str]], + skip_fields: List[str], +) -> List[str]: + globals_already_populated: List[str] = [] + + param_fields: Tuple[Field, ...] = fields(query_params) + for field in param_fields: + if field.name in skip_fields: + continue + + metadata = field.metadata.get("query_param") + if not metadata: + continue + + param_name = field.name + value = getattr(query_params, param_name) if query_params is not None else None + + value, global_found = _populate_from_globals( + param_name, value, "query_param", gbls + ) + if global_found: + globals_already_populated.append(param_name) + + f_name = metadata.get("field_name") + serialization = metadata.get("serialization", "") + if serialization != "": + serialized_parms = _get_serialized_params( + metadata, field.type, f_name, value + ) + for key, value in serialized_parms.items(): + if key in query_param_values: + query_param_values[key].extend(value) + else: + query_param_values[key] = [value] + else: + style = metadata.get("style", "form") + if style == "deepObject": + _populate_deep_object_query_params( + metadata, f_name, value, query_param_values + ) + elif style == "form": + _populate_delimited_query_params( + metadata, f_name, value, ",", query_param_values + ) + elif style == "pipeDelimited": + _populate_delimited_query_params( + metadata, f_name, value, "|", query_param_values + ) + else: + raise Exception("not yet implemented") + + return globals_already_populated + + +def get_headers(headers_params: Any, gbls: Optional[Any] = None) -> Dict[str, str]: + headers: Dict[str, str] = {} + + globals_already_populated = [] + if headers_params is not None: + globals_already_populated = _populate_headers(headers_params, gbls, headers, []) + if gbls is not None: + _populate_headers(gbls, None, headers, globals_already_populated) + + return headers + + +def _populate_headers( + headers_params: Any, + gbls: Any, + header_values: Dict[str, str], + skip_fields: List[str], +) -> List[str]: + globals_already_populated: List[str] = [] + + param_fields: Tuple[Field, ...] = fields(headers_params) + for field in param_fields: + if field.name in skip_fields: + continue + + metadata = field.metadata.get("header") + if not metadata: + continue + + value, global_found = _populate_from_globals( + field.name, getattr(headers_params, field.name), "header", gbls + ) + if global_found: + globals_already_populated.append(field.name) + value = _serialize_header(metadata.get("explode", False), value) + + if value != "": + header_values[metadata.get("field_name", field.name)] = value + + return globals_already_populated + + +def _get_serialized_params( + metadata: Dict, field_type: type, field_name: str, obj: Any +) -> Dict[str, str]: + params: Dict[str, str] = {} + + serialization = metadata.get("serialization", "") + if serialization == "json": + params[metadata.get("field_name", field_name)] = marshal_json(obj, field_type) + + return params + + +def _populate_deep_object_query_params( + metadata: Dict, field_name: str, obj: Any, params: Dict[str, List[str]] +): + if obj is None: + return + + if is_dataclass(obj): + obj_fields: Tuple[Field, ...] = fields(obj) + for obj_field in obj_fields: + obj_param_metadata = obj_field.metadata.get("query_param") + if not obj_param_metadata: + continue + + obj_val = getattr(obj, obj_field.name) + if obj_val is None: + continue + + if isinstance(obj_val, List): + for val in obj_val: + if val is None: + continue + + if ( + params.get( + f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]' + ) + is None + ): + params[ + f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]' + ] = [] + + params[ + f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]' + ].append(_val_to_string(val)) + else: + params[ + f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]' + ] = [_val_to_string(obj_val)] + elif isinstance(obj, Dict): + for key, value in obj.items(): + if value is None: + continue + + if isinstance(value, List): + for val in value: + if val is None: + continue + + if ( + params.get(f'{metadata.get("field_name", field_name)}[{key}]') + is None + ): + params[f'{metadata.get("field_name", field_name)}[{key}]'] = [] + + params[f'{metadata.get("field_name", field_name)}[{key}]'].append( + _val_to_string(val) + ) + else: + params[f'{metadata.get("field_name", field_name)}[{key}]'] = [ + _val_to_string(value) + ] + + +def _get_query_param_field_name(obj_field: Field) -> str: + obj_param_metadata = obj_field.metadata.get("query_param") + + if not obj_param_metadata: + return "" + + return obj_param_metadata.get("field_name", obj_field.name) + + +def _populate_delimited_query_params( + metadata: Dict, + field_name: str, + obj: Any, + delimiter: str, + query_param_values: Dict[str, List[str]], +): + _populate_form( + field_name, + metadata.get("explode", True), + obj, + _get_query_param_field_name, + delimiter, + query_param_values, + ) + + +SERIALIZATION_METHOD_TO_CONTENT_TYPE = { + "json": "application/json", + "form": "application/x-www-form-urlencoded", + "multipart": "multipart/form-data", + "raw": "application/octet-stream", + "string": "text/plain", +} + + +def serialize_request_body( + request: Any, + request_type: type, + request_field_name: str, + nullable: bool, + optional: bool, + serialization_method: str, + encoder=None, +) -> Tuple[Optional[str], Optional[Any], Optional[Any]]: + if request is None: + if not nullable and optional: + return None, None, None + + if not is_dataclass(request) or not hasattr(request, request_field_name): + return serialize_content_type( + request_field_name, + request_type, + SERIALIZATION_METHOD_TO_CONTENT_TYPE[serialization_method], + request, + encoder, + ) + + request_val = getattr(request, request_field_name) + + if request_val is None: + if not nullable and optional: + return None, None, None + + request_fields: Tuple[Field, ...] = fields(request) + request_metadata = None + + for field in request_fields: + if field.name == request_field_name: + request_metadata = field.metadata.get("request") + break + + if request_metadata is None: + raise Exception("invalid request type") + + return serialize_content_type( + request_field_name, + request_type, + request_metadata.get("media_type", "application/octet-stream"), + request_val, + ) + + +def serialize_content_type( + field_name: str, request_type: Any, media_type: str, request: Any, encoder=None +) -> Tuple[Optional[str], Optional[Any], Optional[List[List[Any]]]]: + if re.match(r"(application|text)\/.*?\+*json.*", media_type) is not None: + return media_type, marshal_json(request, request_type, encoder), None + if re.match(r"multipart\/.*", media_type) is not None: + return serialize_multipart_form(media_type, request) + if re.match(r"application\/x-www-form-urlencoded.*", media_type) is not None: + return media_type, serialize_form_data(field_name, request), None + if isinstance(request, (bytes, bytearray)): + return media_type, request, None + if isinstance(request, str): + return media_type, request, None + + raise Exception( + f"invalid request body type {type(request)} for mediaType {media_type}" + ) + + +def serialize_multipart_form( + media_type: str, request: Any +) -> Tuple[str, Any, List[List[Any]]]: + form: List[List[Any]] = [] + request_fields = fields(request) + + for field in request_fields: + val = getattr(request, field.name) + if val is None: + continue + + field_metadata = field.metadata.get("multipart_form") + if not field_metadata: + continue + + if field_metadata.get("file") is True: + file_fields = fields(val) + + file_name = "" + field_name = "" + content = bytes() + + for file_field in file_fields: + file_metadata = file_field.metadata.get("multipart_form") + if file_metadata is None: + continue + + if file_metadata.get("content") is True: + content = getattr(val, file_field.name) + else: + field_name = file_metadata.get("field_name", file_field.name) + file_name = getattr(val, file_field.name) + if field_name == "" or file_name == "" or content == bytes(): + raise Exception("invalid multipart/form-data file") + + form.append([field_name, [file_name, content]]) + elif field_metadata.get("json") is True: + to_append = [ + field_metadata.get("field_name", field.name), + [None, marshal_json(val, field.type), "application/json"], + ] + form.append(to_append) + else: + field_name = field_metadata.get("field_name", field.name) + if isinstance(val, List): + for value in val: + if value is None: + continue + form.append([field_name + "[]", [None, _val_to_string(value)]]) + else: + form.append([field_name, [None, _val_to_string(val)]]) + return media_type, None, form + + +def serialize_dict( + original: Dict, explode: bool, field_name, existing: Optional[Dict[str, List[str]]] +) -> Dict[str, List[str]]: + if existing is None: + existing = {} + + if explode is True: + for key, val in original.items(): + if key not in existing: + existing[key] = [] + existing[key].append(val) + else: + temp = [] + for key, val in original.items(): + temp.append(str(key)) + temp.append(str(val)) + if field_name not in existing: + existing[field_name] = [] + existing[field_name].append(",".join(temp)) + return existing + + +def serialize_form_data(field_name: str, data: Any) -> Dict[str, Any]: + form: Dict[str, List[str]] = {} + + if is_dataclass(data): + for field in fields(data): + val = getattr(data, field.name) + if val is None: + continue + + metadata = field.metadata.get("form") + if metadata is None: + continue + + field_name = metadata.get("field_name", field.name) + + if metadata.get("json"): + form[field_name] = [marshal_json(val, field.type)] + else: + if metadata.get("style", "form") == "form": + _populate_form( + field_name, + metadata.get("explode", True), + val, + _get_form_field_name, + ",", + form, + ) + else: + raise Exception(f"Invalid form style for field {field.name}") + elif isinstance(data, Dict): + for key, value in data.items(): + form[key] = [_val_to_string(value)] + else: + raise Exception(f"Invalid request body type for field {field_name}") + + return form + + +def _get_form_field_name(obj_field: Field) -> str: + obj_param_metadata = obj_field.metadata.get("form") + + if not obj_param_metadata: + return "" + + return obj_param_metadata.get("field_name", obj_field.name) + + +def _populate_form( + field_name: str, + explode: boolean, + obj: Any, + get_field_name_func: Callable, + delimiter: str, + form: Dict[str, List[str]], +): + if obj is None: + return form + + if is_dataclass(obj): + items = [] + + obj_fields: Tuple[Field, ...] = fields(obj) + for obj_field in obj_fields: + obj_field_name = get_field_name_func(obj_field) + if obj_field_name == "": + continue + + val = getattr(obj, obj_field.name) + if val is None: + continue + + if explode: + form[obj_field_name] = [_val_to_string(val)] + else: + items.append(f"{obj_field_name}{delimiter}{_val_to_string(val)}") + + if len(items) > 0: + form[field_name] = [delimiter.join(items)] + elif isinstance(obj, Dict): + items = [] + for key, value in obj.items(): + if value is None: + continue + + if explode: + form[key] = [_val_to_string(value)] + else: + items.append(f"{key}{delimiter}{_val_to_string(value)}") + + if len(items) > 0: + form[field_name] = [delimiter.join(items)] + elif isinstance(obj, List): + items = [] + + for value in obj: + if value is None: + continue + + if explode: + if not field_name in form: + form[field_name] = [] + form[field_name].append(_val_to_string(value)) + else: + items.append(_val_to_string(value)) + + if len(items) > 0: + form[field_name] = [delimiter.join([str(item) for item in items])] + else: + form[field_name] = [_val_to_string(obj)] + + return form + + +def _serialize_header(explode: bool, obj: Any) -> str: + if obj is None: + return "" + + if is_dataclass(obj): + items = [] + obj_fields: Tuple[Field, ...] = fields(obj) + for obj_field in obj_fields: + obj_param_metadata = obj_field.metadata.get("header") + + if not obj_param_metadata: + continue + + obj_field_name = obj_param_metadata.get("field_name", obj_field.name) + if obj_field_name == "": + continue + + val = getattr(obj, obj_field.name) + if val is None: + continue + + if explode: + items.append(f"{obj_field_name}={_val_to_string(val)}") + else: + items.append(obj_field_name) + items.append(_val_to_string(val)) + + if len(items) > 0: + return ",".join(items) + elif isinstance(obj, Dict): + items = [] + + for key, value in obj.items(): + if value is None: + continue + + if explode: + items.append(f"{key}={_val_to_string(value)}") + else: + items.append(key) + items.append(_val_to_string(value)) + + if len(items) > 0: + return ",".join([str(item) for item in items]) + elif isinstance(obj, List): + items = [] + + for value in obj: + if value is None: + continue + + items.append(_val_to_string(value)) + + if len(items) > 0: + return ",".join(items) + else: + return f"{_val_to_string(obj)}" + + return "" + + +def unmarshal_json(data, typ, decoder=None): + unmarshal = make_dataclass("Unmarshal", [("res", typ)], bases=(DataClassJsonMixin,)) + json_dict = json.loads(data) + try: + out = unmarshal.from_dict({"res": json_dict}) + except AttributeError as attr_err: + raise AttributeError( + f"unable to unmarshal {data} as {typ} - {attr_err}" + ) from attr_err + + return out.res if decoder is None else decoder(out.res) + + +def marshal_json(val, typ, encoder=None): + if not is_optional_type(typ) and val is None: + raise ValueError(f"Could not marshal None into non-optional type: {typ}") + + marshal = make_dataclass("Marshal", [("res", typ)], bases=(DataClassJsonMixin,)) + marshaller = marshal(res=val) + json_dict = marshaller.to_dict() + val = json_dict["res"] if encoder is None else encoder(json_dict["res"]) + + return json.dumps(val, separators=(",", ":"), sort_keys=True) + + +def match_content_type(content_type: str, pattern: str) -> boolean: + if pattern in (content_type, "*", "*/*"): + return True + + msg = Message() + msg["content-type"] = content_type + media_type = msg.get_content_type() + + if media_type == pattern: + return True + + parts = media_type.split("/") + if len(parts) == 2: + if pattern in (f"{parts[0]}/*", f"*/{parts[1]}"): + return True + + return False + + +def match_status_codes(status_codes: List[str], status_code: int) -> bool: + for code in status_codes: + if code == str(status_code): + return True + + if code.endswith("XX") and code.startswith(str(status_code)[:1]): + return True + return False + + +def datetimeisoformat(optional: bool): + def isoformatoptional(val): + if optional and val is None: + return None + return _val_to_string(val) + + return isoformatoptional + + +def dateisoformat(optional: bool): + def isoformatoptional(val): + if optional and val is None: + return None + return date.isoformat(val) + + return isoformatoptional + + +def datefromisoformat(date_str: str): + return dateutil.parser.parse(date_str).date() + + +def bigintencoder(optional: bool): + def bigintencode(val: int): + if optional and val is None: + return None + return str(val) + + return bigintencode + + +def bigintdecoder(val): + if isinstance(val, float): + raise ValueError(f"{val} is a float") + return int(val) + + +def decimalencoder(optional: bool, as_str: bool): + def decimalencode(val: Decimal): + if optional and val is None: + return None + + if as_str: + return str(val) + + return float(val) + + return decimalencode + + +def decimaldecoder(val): + return Decimal(str(val)) + + +def map_encoder(optional: bool, value_encoder: Callable): + def map_encode(val: Dict): + if optional and val is None: + return None + + encoded = {} + for key, value in val.items(): + encoded[key] = value_encoder(value) + + return encoded + + return map_encode + + +def map_decoder(value_decoder: Callable): + def map_decode(val: Dict): + decoded = {} + for key, value in val.items(): + decoded[key] = value_decoder(value) + + return decoded + + return map_decode + + +def list_encoder(optional: bool, value_encoder: Callable): + def list_encode(val: List): + if optional and val is None: + return None + + encoded = [] + for value in val: + encoded.append(value_encoder(value)) + + return encoded + + return list_encode + + +def list_decoder(value_decoder: Callable): + def list_decode(val: List): + decoded = [] + for value in val: + decoded.append(value_decoder(value)) + + return decoded + + return list_decode + + +def union_encoder(all_encoders: Dict[str, Callable]): + def selective_encoder(val: Any): + if type(val) in all_encoders: + return all_encoders[type(val)](val) + return val + + return selective_encoder + + +def union_decoder(all_decoders: List[Callable]): + def selective_decoder(val: Any): + decoded = val + for decoder in all_decoders: + try: + decoded = decoder(val) + break + except (TypeError, ValueError): + continue + return decoded + + return selective_decoder + + +def get_field_name(name): + def override(_, _field_name=name): + return _field_name + + return override + + +def _val_to_string(val) -> str: + if isinstance(val, bool): + return str(val).lower() + if isinstance(val, datetime): + return str(val.isoformat().replace("+00:00", "Z")) + if isinstance(val, Enum): + return str(val.value) + + return str(val) + + +def _populate_from_globals( + param_name: str, value: Any, param_type: str, gbls: Any +) -> Tuple[Any, bool]: + if gbls is None: + return value, False + + global_fields = fields(gbls) + + found = False + for field in global_fields: + if field.name is not param_name: + continue + + found = True + + if value is not None: + return value, True + + global_value = getattr(gbls, field.name) + + param_metadata = field.metadata.get(param_type) + if param_metadata is None: + return value, True + + return global_value, True + + return value, found + + +def decoder_with_discriminator(field_name): + def decode_fx(obj): + kls = getattr(sys.modules["sdk.models"], obj[field_name]) + return unmarshal_json(json.dumps(obj), kls) + + return decode_fx + + +def remove_suffix(input_string, suffix): + if suffix and input_string.endswith(suffix): + return input_string[: -len(suffix)] + return input_string diff --git a/src/airbyte_api/workspaces.py b/src/airbyte_api/workspaces.py new file mode 100644 index 00000000..46fef002 --- /dev/null +++ b/src/airbyte_api/workspaces.py @@ -0,0 +1,349 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +import requests as requests_http +from .sdkconfiguration import SDKConfiguration +from airbyte_api import api, errors, models, utils +from airbyte_api._hooks import AfterErrorContext, AfterSuccessContext, BeforeRequestContext, HookContext +from typing import Optional + +class Workspaces: + sdk_configuration: SDKConfiguration + + def __init__(self, sdk_config: SDKConfiguration) -> None: + self.sdk_configuration = sdk_config + + + + def create_or_update_workspace_o_auth_credentials(self, request: api.CreateOrUpdateWorkspaceOAuthCredentialsRequest) -> api.CreateOrUpdateWorkspaceOAuthCredentialsResponse: + r"""Create OAuth override credentials for a workspace and source type. + Create/update a set of OAuth credentials to override the Airbyte-provided OAuth credentials used for source/destination OAuth. + In order to determine what the credential configuration needs to be, please see the connector specification of the relevant source/destination. + """ + hook_ctx = HookContext(operation_id='createOrUpdateWorkspaceOAuthCredentials', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = utils.generate_url(base_url, '/workspaces/{workspaceId}/oauthCredentials', request) + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + req_content_type, data, form = utils.serialize_request_body(request, api.CreateOrUpdateWorkspaceOAuthCredentialsRequest, "workspace_o_auth_credentials_request", False, False, 'json') + if req_content_type is not None and req_content_type not in ('multipart/form-data', 'multipart/mixed'): + headers['content-type'] = req_content_type + if data is None and form is None: + raise Exception('request body is required') + headers['Accept'] = '*/*' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('PUT', url, params=query_params, data=data, files=form, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['400','403','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.CreateOrUpdateWorkspaceOAuthCredentialsResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + pass + elif http_res.status_code == 400 or http_res.status_code == 403 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + + def create_workspace(self, request: models.WorkspaceCreateRequest) -> api.CreateWorkspaceResponse: + r"""Create a workspace""" + hook_ctx = HookContext(operation_id='createWorkspace', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = base_url + '/workspaces' + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + req_content_type, data, form = utils.serialize_request_body(request, models.WorkspaceCreateRequest, "request", False, False, 'json') + if req_content_type is not None and req_content_type not in ('multipart/form-data', 'multipart/mixed'): + headers['content-type'] = req_content_type + if data is None and form is None: + raise Exception('request body is required') + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('POST', url, params=query_params, data=data, files=form, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['400','403','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.CreateWorkspaceResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(http_res.headers.get('Content-Type') or '', 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[models.WorkspaceResponse]) + res.workspace_response = out + else: + content_type = http_res.headers.get('Content-Type') + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + elif http_res.status_code == 400 or http_res.status_code == 403 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + + def delete_workspace(self, request: api.DeleteWorkspaceRequest) -> api.DeleteWorkspaceResponse: + r"""Delete a Workspace""" + hook_ctx = HookContext(operation_id='deleteWorkspace', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = utils.generate_url(base_url, '/workspaces/{workspaceId}', request) + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + headers['Accept'] = '*/*' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('DELETE', url, params=query_params, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['403','404','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.DeleteWorkspaceResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 204: + pass + elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + + def get_workspace(self, request: api.GetWorkspaceRequest) -> api.GetWorkspaceResponse: + r"""Get Workspace details""" + hook_ctx = HookContext(operation_id='getWorkspace', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = utils.generate_url(base_url, '/workspaces/{workspaceId}', request) + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('GET', url, params=query_params, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['403','404','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.GetWorkspaceResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(http_res.headers.get('Content-Type') or '', 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[models.WorkspaceResponse]) + res.workspace_response = out + else: + content_type = http_res.headers.get('Content-Type') + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + + def list_workspaces(self, request: api.ListWorkspacesRequest) -> api.ListWorkspacesResponse: + r"""List workspaces""" + hook_ctx = HookContext(operation_id='listWorkspaces', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = base_url + '/workspaces' + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + query_params = { **utils.get_query_params(request), **query_params } + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('GET', url, params=query_params, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['403','404','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.ListWorkspacesResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(http_res.headers.get('Content-Type') or '', 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[models.WorkspacesResponse]) + res.workspaces_response = out + else: + content_type = http_res.headers.get('Content-Type') + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + elif http_res.status_code == 403 or http_res.status_code == 404 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + + + def update_workspace(self, request: api.UpdateWorkspaceRequest) -> api.UpdateWorkspaceResponse: + r"""Update a workspace""" + hook_ctx = HookContext(operation_id='updateWorkspace', oauth2_scopes=[], security_source=self.sdk_configuration.security) + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + + url = utils.generate_url(base_url, '/workspaces/{workspaceId}', request) + + if callable(self.sdk_configuration.security): + headers, query_params = utils.get_security(self.sdk_configuration.security()) + else: + headers, query_params = utils.get_security(self.sdk_configuration.security) + + req_content_type, data, form = utils.serialize_request_body(request, api.UpdateWorkspaceRequest, "workspace_update_request", False, False, 'json') + if req_content_type is not None and req_content_type not in ('multipart/form-data', 'multipart/mixed'): + headers['content-type'] = req_content_type + if data is None and form is None: + raise Exception('request body is required') + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.client + + try: + req = client.prepare_request(requests_http.Request('PATCH', url, params=query_params, data=data, files=form, headers=headers)) + req = self.sdk_configuration.get_hooks().before_request(BeforeRequestContext(hook_ctx), req) + http_res = client.send(req) + except Exception as e: + _, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), None, e) + if e is not None: + raise e + + if utils.match_status_codes(['400','403','4XX','5XX'], http_res.status_code): + result, e = self.sdk_configuration.get_hooks().after_error(AfterErrorContext(hook_ctx), http_res, None) + if e is not None: + raise e + if result is not None: + http_res = result + else: + http_res = self.sdk_configuration.get_hooks().after_success(AfterSuccessContext(hook_ctx), http_res) + + + + res = api.UpdateWorkspaceResponse(status_code=http_res.status_code, content_type=http_res.headers.get('Content-Type') or '', raw_response=http_res) + + if http_res.status_code == 200: + if utils.match_content_type(http_res.headers.get('Content-Type') or '', 'application/json'): + out = utils.unmarshal_json(http_res.text, Optional[models.WorkspaceResponse]) + res.workspace_response = out + else: + content_type = http_res.headers.get('Content-Type') + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) + elif http_res.status_code == 400 or http_res.status_code == 403 or http_res.status_code >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) + else: + raise errors.SDKError('unknown status code received', http_res.status_code, http_res.text, http_res) + + return res + + +