---
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:
/health:
get:
tags:
- "public_health"
- "public"
responses:
"200":
description: "Successful operation"
operationId: "getHealthCheck"
summary: "Health Check"
security: []
x-speakeasy-alias: "getHealthCheck"
x-speakeasy-group: "Health"
/jobs:
get:
tags:
- "public_jobs"
- "public"
- "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: 1687450500000
- name: "createdAtEnd"
description: "The end date to filter by"
schema:
type: "string"
format: "date-time"
in: "query"
required: false
example: 1687450500000
- name: "updatedAtStart"
description: "The start date to filter by"
schema:
type: "string"
format: "date-time"
example: 1687450500000
in: "query"
required: false
- name: "updatedAtEnd"
description: "The end date to filter by"
schema:
type: "string"
format: "date-time"
in: "query"
required: false
example: 1687450500000
- name: "orderBy"
description: "The field and method to use for ordering"
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-speakeasy-alias: "listJobs"
x-speakeasy-group: "Jobs"
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:
- "public_jobs"
- "public"
- "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-speakeasy-alias: "createJob"
x-speakeasy-group: "Jobs"
/jobs/{jobId}:
get:
tags:
- "public_jobs"
- "public"
- "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"
x-speakeasy-alias: "getJob"
x-speakeasy-group: "Jobs"
summary: "Get Job status and details"
delete:
tags:
- "public_jobs"
- "public"
- "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"
x-speakeasy-alias: "cancelJob"
x-speakeasy-group: "Jobs"
summary: "Cancel a running Job"
parameters:
- name: "jobId"
schema:
format: "int64"
type: "integer"
in: "path"
required: true
/workspaces/{workspaceId}/definitions/declarative_sources:
parameters:
- name: "workspaceId"
schema:
format: "uuid"
type: "string"
in: "path"
required: true
get:
tags:
- "public_declarative_source_definitions"
- "public"
- "DeclarativeSourceDefinitions"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/DeclarativeSourceDefinitionsResponse"
description: "Successful operation"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "listDeclarativeSourceDefinitions"
x-speakeasy-alias: "listDeclarativeSourceDefinitions"
x-speakeasy-group: "DeclarativeSourceDefinitions"
summary: "List declarative source definitions."
post:
summary: "Create a declarative source definition."
x-speakeasy-entity-operation: "DeclarativeSourceDefinition#create"
operationId: "createDeclarativeSourceDefinition"
x-speakeasy-alias: "createDeclarativeSourceDefinition"
x-speakeasy-group: "DeclarativeSourceDefinitions"
tags:
- "public_declarative_source_definitions"
- "public"
- "DeclarativeSourceDefinitions"
responses:
"200":
description: "Success"
content:
application/json:
schema:
$ref: "#/components/schemas/DeclarativeSourceDefinitionResponse"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateDeclarativeSourceDefinitionRequest"
/workspaces/{workspaceId}/definitions/declarative_sources/{definitionId}:
parameters:
- name: "workspaceId"
schema:
format: "uuid"
type: "string"
in: "path"
required: true
- name: "definitionId"
x-speakeasy-match: "id"
schema:
format: "uuid"
type: "string"
in: "path"
required: true
get:
tags:
- "public_declarative_source_definitions"
- "public"
- "DeclarativeSourceDefinitions"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/DeclarativeSourceDefinitionResponse"
description: "Success"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "getDeclarativeSourceDefinition"
x-speakeasy-alias: "getDeclarativeSourceDefinition"
x-speakeasy-group: "DeclarativeSourceDefinitions"
summary: "Get declarative source definition details."
x-speakeasy-entity-operation: "DeclarativeSourceDefinition#read"
put:
tags:
- "public_declarative_source_definitions"
- "public"
- "DeclarativeSourceDefinitions"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateDeclarativeSourceDefinitionRequest"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/DeclarativeSourceDefinitionResponse"
description: "Success"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "updateDeclarativeSourceDefinition"
x-speakeasy-alias: "updateDeclarativeSourceDefinition"
x-speakeasy-group: "DeclarativeSourceDefinitions"
summary: "Update declarative source definition details."
x-speakeasy-entity-operation: "DeclarativeSourceDefinition#update"
delete:
tags:
- "public_declarative_source_definitions"
- "public"
- "DeclarativeSourceDefinitions"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/DeclarativeSourceDefinitionResponse"
description: "Success"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "deleteDeclarativeSourceDefinition"
x-speakeasy-alias: "deleteDeclarativeSourceDefinition"
x-speakeasy-group: "DeclarativeSourceDefinitions"
summary: "Delete a declarative source definition."
x-speakeasy-entity-operation: "DeclarativeSourceDefinition#delete"
/workspaces/{workspaceId}/definitions/sources:
parameters:
- name: "workspaceId"
schema:
format: "uuid"
type: "string"
in: "path"
required: true
get:
tags:
- "public_source_definitions"
- "public"
- "SourceDefinitions"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/DefinitionsResponse"
description: "Successful operation"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "listSourceDefinitions"
x-speakeasy-alias: "listSourceDefinitions"
x-speakeasy-group: "SourceDefinitions"
summary: "List source definitions."
post:
operationId: "createSourceDefinition"
x-speakeasy-alias: "createSourceDefinition"
x-speakeasy-group: "SourceDefinitions"
summary: "Create a source definition."
x-speakeasy-entity-operation: "SourceDefinition#create"
tags:
- "public_source_definitions"
- "public"
- "SourceDefinitions"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateDefinitionRequest"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/DefinitionResponse"
description: "Success"
/workspaces/{workspaceId}/definitions/sources/{definitionId}:
parameters:
- name: "workspaceId"
schema:
format: "uuid"
type: "string"
in: "path"
required: true
- name: "definitionId"
x-speakeasy-match: "id"
schema:
format: "uuid"
type: "string"
in: "path"
required: true
get:
tags:
- "public_source_definitions"
- "public"
- "SourceDefinitions"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/DefinitionResponse"
description: "Success"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "getSourceDefinition"
x-speakeasy-alias: "getSourceDefinition"
x-speakeasy-group: "SourceDefinitions"
summary: "Get source definition details."
x-speakeasy-entity-operation: "SourceDefinition#read"
put:
tags:
- "public_source_definitions"
- "public"
- "SourceDefinitions"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateDefinitionRequest"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/DefinitionResponse"
description: "Success"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "updateSourceDefinition"
x-speakeasy-alias: "updateSourceDefinition"
x-speakeasy-group: "SourceDefinitions"
summary: "Update source definition details."
x-speakeasy-entity-operation: "SourceDefinition#update"
delete:
tags:
- "public_source_definitions"
- "public"
- "SourceDefinitions"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/DefinitionResponse"
description: "Success"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "deleteSourceDefinition"
x-speakeasy-alias: "deleteSourceDefinition"
x-speakeasy-group: "SourceDefinitions"
summary: "Delete a source definition."
x-speakeasy-entity-operation: "SourceDefinition#delete"
/workspaces/{workspaceId}/definitions/destinations:
parameters:
- name: "workspaceId"
schema:
format: "uuid"
type: "string"
in: "path"
required: true
get:
tags:
- "public_destination_definitions"
- "public"
- "DestinationDefinitions"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/DefinitionsResponse"
description: "Successful operation"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "listDestinationDefinitions"
x-speakeasy-alias: "listDestinationDefinitions"
x-speakeasy-group: "DestinationDefinitions"
summary: "List destination definitions."
post:
operationId: "createDestinationDefinition"
x-speakeasy-alias: "createDestinationDefinition"
x-speakeasy-group: "DestinationDefinitions"
summary: "Create a destination definition."
x-speakeasy-entity-operation: "DestinationDefinition#create"
tags:
- "public_destination_definitions"
- "public"
- "DestinationDefinitions"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateDefinitionRequest"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/DefinitionResponse"
description: "Success"
/workspaces/{workspaceId}/definitions/destinations/{definitionId}:
parameters:
- name: "workspaceId"
schema:
format: "uuid"
type: "string"
in: "path"
required: true
- name: "definitionId"
x-speakeasy-match: "id"
schema:
format: "uuid"
type: "string"
in: "path"
required: true
get:
tags:
- "public_destination_definitions"
- "public"
- "DestinationDefinitions"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/DefinitionResponse"
description: "Success"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "getDestinationDefinition"
x-speakeasy-alias: "getDestinationDefinition"
x-speakeasy-group: "DestinationDefinitions"
summary: "Get destination definition details."
x-speakeasy-entity-operation: "DestinationDefinition#read"
put:
tags:
- "public_destination_definitions"
- "public"
- "DestinationDefinitions"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateDefinitionRequest"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/DefinitionResponse"
description: "Success"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "updateDestinationDefinition"
x-speakeasy-alias: "updateDestinationDefinition"
x-speakeasy-group: "DestinationDefinitions"
summary: "Update destination definition details."
x-speakeasy-entity-operation: "DestinationDefinition#update"
delete:
tags:
- "public_destination_definitions"
- "public"
- "DestinationDefinitions"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/DefinitionResponse"
description: "Success"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "deleteDestinationDefinition"
x-speakeasy-alias: "deleteDestinationDefinition"
x-speakeasy-group: "DestinationDefinitions"
summary: "Delete a destination definition."
x-speakeasy-entity-operation: "DestinationDefinition#delete"
/sources:
get:
tags:
- "public_sources"
- "public"
- "Sources"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/SourcesResponse"
description: "Successful operation"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "listSources"
x-speakeasy-alias: "listSources"
x-speakeasy-group: "Sources"
summary: "List sources"
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: 1672531200000
end_date: 1704067200000
name: "My Source"
workspaceId: "744cc0ed-7f05-4949-9e60-2a814f90c035"
tags:
- "public_sources"
- "public"
- "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"
x-speakeasy-alias: "createSource"
x-speakeasy-group: "Sources"
x-speakeasy-entity-operation: "Source#create"
summary: "Create a source"
description: "Creates a source given a name, workspace id, and a json blob containing\
\ the configuration for the source."
/sources/{sourceId}:
get:
tags:
- "public_sources"
- "public"
- "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"
x-speakeasy-alias: "getSource"
x-speakeasy-group: "Sources"
x-speakeasy-entity-operation: "Source#read"
summary: "Get Source details"
parameters:
- in: "query"
name: "includeSecretCoordinates"
schema:
type: "boolean"
required: false
description: "Rather than return *** for secret properties include the secret\
\ coordinate information"
patch:
tags:
- "public_sources"
- "public"
- "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: 1672531200000
end_date: 1704067200000
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"
x-speakeasy-alias: "patchSource"
x-speakeasy-group: "Sources"
summary: "Update a Source"
put:
tags:
- "public_sources"
- "public"
- "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: 1672531200000
end_date: 1704067200000
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"
x-speakeasy-alias: "putSource"
x-speakeasy-group: "Sources"
summary: "Update a Source and fully overwrite it"
x-speakeasy-entity-operation: "Source#update"
delete:
tags:
- "public_sources"
- "public"
- "Sources"
responses:
"204":
description: "The resource was deleted successfully"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "deleteSource"
x-speakeasy-alias: "deleteSource"
x-speakeasy-group: "Sources"
summary: "Delete a Source"
parameters:
- name: "sourceId"
schema:
format: "UUID"
type: "string"
in: "path"
required: true
/destinations:
get:
tags:
- "public_destinations"
- "public"
- "Destinations"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/DestinationsResponse"
description: "Successful operation"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "listDestinations"
x-speakeasy-alias: "listDestinations"
x-speakeasy-group: "Destinations"
summary: "List destinations"
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:
- "public_destinations"
- "public"
- "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"
x-speakeasy-alias: "createDestination"
x-speakeasy-entity-operation: "Destination#create"
x-speakeasy-group: "Destinations"
summary: "Create a destination"
description: "Creates a destination given a name, workspace id, and a json blob\
\ containing the configuration for the source."
/destinations/{destinationId}:
get:
tags:
- "public_destinations"
- "public"
- "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: 1672531200000
end_date: 1704067200000
description: "Get a Destination by the id in the path."
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "getDestination"
x-speakeasy-alias: "getDestination"
x-speakeasy-entity-operation: "Destination#read"
x-speakeasy-group: "Destinations"
summary: "Get Destination details"
parameters:
- in: "query"
name: "includeSecretCoordinates"
schema:
type: "boolean"
required: false
description: "Rather than return *** for secret properties include the secret\
\ coordinate information"
delete:
tags:
- "public_destinations"
- "public"
- "Destinations"
responses:
"204":
description: "The resource was deleted successfully"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "deleteDestination"
x-speakeasy-alias: "deleteDestination"
x-speakeasy-entity-operation: "Destination#delete"
x-speakeasy-group: "Destinations"
summary: "Delete a Destination"
patch:
tags:
- "public_destinations"
- "public"
- "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: 1672531200000
end_date: 1704067200000
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: 1672531200000
end_date: 1704067200000
description: "Update a Destination"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "patchDestination"
x-speakeasy-alias: "patchDestination"
x-speakeasy-group: "Destinations"
summary: "Update a Destination"
put:
tags:
- "public_destinations"
- "public"
- "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: 1672531200000
end_date: 1704067200000
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: 1672531200000
end_date: 1704067200000
description: "Update a Destination and fully overwrite it"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "putDestination"
x-speakeasy-alias: "putDestination"
x-speakeasy-group: "Destinations"
x-speakeasy-entity-operation: "Destination#update"
summary: "Update a Destination and fully overwrite it"
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:
- "public_sources"
- "public"
- "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"
x-speakeasy-alias: "initiateOAuth"
x-speakeasy-group: "Sources"
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."
/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:
- "public_connections"
- "public"
- "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"
x-speakeasy-alias: "createConnection"
x-speakeasy-group: "Connections"
summary: "Create a connection"
x-speakeasy-entity-operation: "Connection#create"
get:
tags:
- "public_connections"
- "public"
- "Connections"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/ConnectionsResponse"
description: "Successful operation"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "listConnections"
x-speakeasy-alias: "listConnections"
x-speakeasy-group: "Connections"
summary: "List connections"
x-speakeasy-entity-operation: "Connections#read"
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: "tagIds"
description: "The UUIDs of the tags you wish to list connections for. Empty\
\ list will retrieve all connections."
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:
- "public_connections"
- "public"
- "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"
x-speakeasy-alias: "getConnection"
x-speakeasy-group: "Connections"
summary: "Get Connection details"
x-speakeasy-entity-operation: "Connection#read"
patch:
tags:
- "public_connections"
- "public"
- "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"
x-speakeasy-alias: "patchConnection"
x-speakeasy-group: "Connections"
summary: "Update Connection details"
x-speakeasy-entity-operation: "Connection#update"
delete:
tags:
- "public_connections"
- "public"
- "Connections"
responses:
"204":
description: "The resource was deleted successfully"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "deleteConnection"
x-speakeasy-alias: "deleteConnection"
x-speakeasy-group: "Connections"
summary: "Delete a Connection"
x-speakeasy-entity-operation: "Connection#delete"
parameters:
- name: "connectionId"
schema:
format: "UUID"
type: "string"
in: "path"
required: true
/streams:
get:
tags:
- "public_streams"
- "public"
- "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"
x-speakeasy-alias: "getStreamProperties"
x-speakeasy-group: "Streams"
summary: "Get stream properties"
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: false
- 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:
- "public_workspaces"
- "public"
- "Workspaces"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/WorkspacesResponse"
description: "Successful operation"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "listWorkspaces"
x-speakeasy-alias: "listWorkspaces"
x-speakeasy-group: "Workspaces"
summary: "List workspaces"
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"
post:
tags:
- "public_workspaces"
- "public"
- "Workspaces"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/WorkspaceCreateRequest"
examples:
Workspace Creation Request Example:
value:
name: "Company Workspace Name"
required: true
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"
x-speakeasy-alias: "createWorkspace"
x-speakeasy-group: "Workspaces"
summary: "Create a workspace"
x-speakeasy-entity-operation: "Workspace#create"
/workspaces/{workspaceId}:
parameters:
- name: "workspaceId"
schema:
format: "UUID"
type: "string"
in: "path"
required: true
get:
tags:
- "public_workspaces"
- "public"
- "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"
x-speakeasy-alias: "getWorkspace"
x-speakeasy-group: "Workspaces"
summary: "Get Workspace details"
x-speakeasy-entity-operation: "Workspace#read"
patch:
tags:
- "public_workspaces"
- "public"
- "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"
x-speakeasy-alias: "updateWorkspace"
x-speakeasy-group: "Workspaces"
summary: "Update a workspace"
x-speakeasy-entity-operation: "Workspace#update"
delete:
tags:
- "public_workspaces"
- "public"
- "Workspaces"
responses:
"204":
description: "The resource was deleted successfully"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "deleteWorkspace"
x-speakeasy-alias: "deleteWorkspace"
x-speakeasy-group: "Workspaces"
summary: "Delete a Workspace"
x-speakeasy-entity-operation: "Workspace#delete"
/workspaces/{workspaceId}/oauthCredentials:
put:
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/WorkspaceOAuthCredentialsRequest"
required: true
tags:
- "public_workspaces"
- "public"
- "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"
x-speakeasy-alias: "createOrUpdateWorkspaceOAuthCredentials"
x-speakeasy-group: "Workspaces"
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."
parameters:
- name: "workspaceId"
schema:
format: "UUID"
type: "string"
in: "path"
required: true
/workspaces/{workspaceId}/oauthCredentials/{actorType}/{name}:
delete:
parameters:
- name: "workspaceId"
schema:
format: "UUID"
type: "string"
in: "path"
required: true
- name: "actorType"
schema:
$ref: "#/components/schemas/ActorTypeEnum"
in: "path"
required: true
- name: "name"
schema:
type: "string"
in: "path"
required: true
description: "The name of the source or destination i.e. google-ads"
tags:
- "public_workspaces"
- "public"
- "Workspaces"
responses:
"204":
description: "OAuth credential override was deleted successfully."
"400":
description: "A field in the path has not been set appropriately."
"403":
description: "API key is invalid."
operationId: "deleteWorkspaceOAuthCredentials"
x-speakeasy-alias: "deleteWorkspaceOAuthCredentials"
x-speakeasy-group: "Workspaces"
summary: "Delete OAuth override credentials for a workspace and source/destination type."
description: "Delete a set of OAuth credentials that overrides the Airbyte-provided\
\ OAuth credentials used for source/destination OAuth.\n\n> \U0001F6A7 Warning\n\
>\n> Deleting an override that is actively used by existing sources or destinations\
\ will cause those connectors to fail on their next sync and require re-authentication."
/permissions/{permissionId}:
parameters:
- name: "permissionId"
schema:
format: "UUID"
type: "string"
in: "path"
required: true
get:
tags:
- "public_permissions"
- "public"
- "Permissions"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/PermissionResponse"
description: "Get a Permission by the id in the path."
"403":
description: "Not allowed"
"404":
description: "Not found"
"422":
description: "Data issue"
operationId: "getPermission"
summary: "Get Permission details"
x-speakeasy-alias: "getPermission"
x-speakeasy-group: "Permissions"
x-speakeasy-entity-operation: "Permission#read"
patch:
tags:
- "public_permissions"
- "public"
- "Permissions"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/PermissionUpdateRequest"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/PermissionResponse"
description: "Successful updated"
"400":
description: "Invalid data"
"403":
description: "Not allowed"
"404":
description: "Not found"
"422":
description: "Data issue"
operationId: "updatePermission"
summary: "Update a permission"
x-speakeasy-alias: "updatePermission"
x-speakeasy-group: "Permissions"
x-speakeasy-entity-operation: "Permission#update"
delete:
tags:
- "public_permissions"
- "public"
- "Permissions"
responses:
"204":
description: "The resource was deleted successfully"
"403":
description: "Not allowed"
"404":
description: "Not found"
"422":
description: "Data issue"
operationId: "deletePermission"
x-speakeasy-alias: "deletePermission"
x-speakeasy-group: "Permissions"
summary: "Delete a Permission"
x-speakeasy-entity-operation: "Permission#delete"
/permissions:
get:
tags:
- "public_permissions"
- "public"
- "Permissions"
parameters:
- name: "userId"
description: "User Id in permission."
schema:
format: "UUID"
type: "string"
in: "query"
required: false
- name: "organizationId"
description: "This is required if you want to read someone else's permissions,\
\ and you should have organization admin or a higher role."
schema:
format: "UUID"
type: "string"
in: "query"
required: false
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/PermissionsResponse"
description: "List Permissions."
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "listPermissions"
x-speakeasy-alias: "listPermissions"
x-speakeasy-group: "Permissions"
summary: "List Permissions by user id"
post:
tags:
- "public_permissions"
- "public"
- "Permissions"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/PermissionCreateRequest"
examples:
Permission Creation Request Example:
value:
permissionType: "workspace_admin"
userId: "7d08fd6c-531e-4a00-937e-3d355f253e63"
workspaceId: "9924bcd0-99be-453d-ba47-c2c9766f7da5"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/PermissionResponse"
examples:
Permission Creation Response Example:
value:
permissionId: "9924bcd0-99be-453d-ba47-c2c9766f7da5"
permissionType: "workspace_admin"
userId: "7d08fd6c-531e-4a00-937e-3d355f253e63"
description: "Successful operation"
"400":
description: "Invalid data"
"403":
description: "Not allowed"
operationId: "createPermission"
x-speakeasy-alias: "createPermission"
x-speakeasy-group: "Permissions"
summary: "Create a permission"
x-speakeasy-entity-operation: "Permission#create"
/organizations:
get:
tags:
- "public_organizations"
- "public"
- "Organizations"
summary: "List all organizations for a user"
description: "Lists users organizations."
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/OrganizationsResponse"
description: "List user's organizations."
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "listOrganizationsForUser"
x-speakeasy-alias: "listOrganizationsForUser"
x-speakeasy-group: "Organizations"
/organizations/{organizationId}/oauthCredentials:
put:
parameters:
- name: "organizationId"
schema:
format: "UUID"
type: "string"
in: "path"
required: true
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/OrganizationOAuthCredentialsRequest"
required: true
tags:
- "public_organizations"
- "public"
- "Organizations"
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: "createOrUpdateOrganizationOAuthCredentials"
x-speakeasy-alias: "createOrUpdateOrganizationOAuthCredentials"
x-speakeasy-group: "Organizations"
summary: "Create OAuth override credentials for an organization 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."
/organizations/{organizationId}/oauthCredentials/{actorType}/{name}:
delete:
parameters:
- name: "organizationId"
schema:
format: "UUID"
type: "string"
in: "path"
required: true
- name: "actorType"
schema:
$ref: "#/components/schemas/ActorTypeEnum"
in: "path"
required: true
- name: "name"
schema:
type: "string"
in: "path"
required: true
description: "The name of the source or destination i.e. google-ads"
tags:
- "public_organizations"
- "public"
- "Organizations"
responses:
"204":
description: "OAuth credential override was deleted successfully."
"400":
description: "A field in the path has not been set appropriately."
"403":
description: "API key is invalid."
operationId: "deleteOrganizationOAuthCredentials"
x-speakeasy-alias: "deleteOrganizationOAuthCredentials"
x-speakeasy-group: "Organizations"
summary: "Delete OAuth override credentials for an organization and source/destination type."
description: "Delete a set of OAuth credentials that overrides the Airbyte-provided\
\ OAuth credentials used for source/destination OAuth.\n\n> \U0001F6A7 Warning\n\
>\n> Deleting an override that is actively used by existing sources or destinations\
\ will cause those connectors to fail on their next sync and require re-authentication."
/users:
get:
tags:
- "public_users"
- "public"
- "Users"
summary: "List all users within an organization"
description: "Organization Admin user can list all users within the same organization.\
\ Also provide filtering on a list of user IDs or/and a list of user emails."
parameters:
- in: "query"
name: "organizationId"
schema:
type: "string"
format: "UUID"
required: true
- in: "query"
name: "ids"
schema:
type: "array"
items:
type: "string"
format: "UUID"
description: "List of user IDs to filter by"
- in: "query"
name: "emails"
schema:
type: "array"
items:
type: "string"
format: "email"
description: "List of user emails to filter by"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/UsersResponse"
description: "List Users."
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "listUsersWithinAnOrganization"
x-speakeasy-alias: "listUsersWithinAnOrganization"
x-speakeasy-group: "Users"
/tags:
get:
tags:
- "public_tags"
- "public"
- "Tags"
summary: "List all tags"
description: "Lists all tags"
parameters:
- name: "workspaceIds"
in: "query"
schema:
type: "array"
items:
format: "uuid"
type: "string"
required: false
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/TagsResponse"
description: "List Tags."
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "listTags"
x-speakeasy-alias: "listTags"
x-speakeasy-group: "Tags"
post:
tags:
- "public_tags"
- "public"
- "Tags"
summary: "Create a tag"
description: "Create a tag"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/TagCreateRequest"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/TagResponse"
description: "Successful operation"
"400":
description: "Invalid data"
"403":
description: "Not allowed"
"409":
description: "Tag with same name already exists"
operationId: "createTag"
x-speakeasy-alias: "createTag"
x-speakeasy-group: "Tags"
/tags/{tagId}:
parameters:
- name: "tagId"
schema:
$ref: "#/components/schemas/TagId"
in: "path"
required: true
get:
tags:
- "public_tags"
- "public"
- "Tags"
summary: "Get a tag"
description: "Get a tag"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/TagResponse"
description: "Successful operation"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "getTag"
x-speakeasy-alias: "getTag"
x-speakeasy-group: "Tags"
delete:
tags:
- "public_tags"
- "public"
- "Tags"
summary: "Delete a tag"
description: "Delete a tag"
responses:
"204":
description: "The resource was deleted successfully"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "deleteTag"
x-speakeasy-alias: "deleteTag"
x-speakeasy-group: "Tags"
patch:
tags:
- "public_tags"
- "public"
- "Tags"
summary: "Update a tag"
description: "Update a tag"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/TagPatchRequest"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/TagResponse"
description: "Successful operation"
"400":
description: "Invalid data"
"403":
description: "Not allowed"
"404":
description: "Not found"
operationId: "updateTag"
x-speakeasy-alias: "updateTag"
x-speakeasy-group: "Tags"
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."
x-speakeasy-component: true
schemas:
WorkspaceId:
type: "string"
format: "uuid"
x-speakeasy-component: true
DeclarativeManifest:
x-speakeasy-component: true
x-speakeasy-type-override: "any"
x-speakeasy-terraform-custom-type:
imports:
- "github.com/hashicorp/terraform-plugin-framework-jsontypes/jsontypes"
schemaType: "jsontypes.NormalizedType{}"
valueType: "jsontypes.Normalized"
description: "Low code CDK manifest JSON object"
type: "object"
ManifestVersion:
x-speakeasy-component: true
type: "integer"
format: "int64"
SourceDefinitionSpecification:
description: "The specification for what values are required to configure the\
\ sourceDefinition."
type: "object"
example:
user:
type: "string"
x-speakeasy-component: true
NamespaceDefinitionType:
type: "string"
description: "Method used for computing final namespace in destination"
enum:
- "source"
- "destination"
- "customformat"
x-speakeasy-component: true
TagId:
type: "string"
format: "uuid"
x-speakeasy-component: true
Tag:
description: "A tag that can be associated with a connection. Useful for grouping\
\ and organizing connections in a workspace."
type: "object"
x-speakeasy-component: true
required:
- "tagId"
- "workspaceId"
- "name"
- "color"
properties:
tagId:
$ref: "#/components/schemas/TagId"
workspaceId:
$ref: "#/components/schemas/WorkspaceId"
name:
type: "string"
color:
type: "string"
OrganizationId:
type: "string"
format: "uuid"
x-speakeasy-component: true
PermissionType:
type: "string"
description: "Describes what actions/endpoints the permission entitles to"
enum:
- "instance_admin"
- "organization_admin"
- "organization_editor"
- "organization_runner"
- "organization_reader"
- "organization_member"
- "workspace_owner"
- "workspace_admin"
- "workspace_runner"
- "workspace_editor"
- "workspace_reader"
x-speakeasy-component: true
PublicPermissionType:
type: "string"
description: "Subset of `PermissionType` (removing `instance_admin`), could\
\ be used in public-api."
enum:
- "organization_admin"
- "organization_editor"
- "organization_runner"
- "organization_reader"
- "organization_member"
- "workspace_admin"
- "workspace_editor"
- "workspace_runner"
- "workspace_reader"
x-speakeasy-component: true
UserId:
type: "string"
description: "Internal Airbyte user ID"
format: "uuid"
x-speakeasy-component: true
AuthProvider:
type: "string"
description: "Auth Provider"
default: "airbyte"
enum:
- "airbyte"
- "google_identity_platform"
- "keycloak"
x-speakeasy-component: true
UserStatus:
type: "string"
description: "user status"
enum:
- "invited"
- "registered"
- "disabled"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
SelectedFieldInfo:
type: "object"
description: "Path to a field/column/property in a stream to be selected. For\
\ example, if the field to be selected is a database column called \"foo\"\
, this will be [\"foo\"]. Use multiple path elements for nested schemas."
properties:
fieldPath:
type: "array"
items:
type: "string"
x-speakeasy-component: true
StreamMapperType:
type: "string"
enum:
- "hashing"
- "field-renaming"
- "row-filtering"
- "encryption"
- "field-filtering"
x-speakeasy-component: true
ConfiguredStreamMapper:
type: "object"
required:
- "type"
- "mapperConfiguration"
properties:
id:
type: "string"
format: "uuid"
type:
$ref: "#/components/schemas/StreamMapperType"
mapperConfiguration:
$ref: "#/components/schemas/MapperConfiguration"
x-speakeasy-component: true
MapperConfiguration:
type: "object"
description: "The values required to configure the mapper."
oneOf:
- $ref: "#/components/schemas/HashingMapperConfiguration"
- $ref: "#/components/schemas/FieldFilteringMapperConfiguration"
- $ref: "#/components/schemas/FieldRenamingMapperConfiguration"
- $ref: "#/components/schemas/RowFilteringMapperConfiguration"
- $ref: "#/components/schemas/EncryptionMapperConfiguration"
x-speakeasy-component: true
HashingMapperConfiguration:
title: "Hashing"
type: "object"
properties:
fieldNameSuffix:
type: "string"
title: "Field name suffix"
description: "The suffix to append to the field name after hashing."
method:
type: "string"
enum:
- "MD2"
- "MD5"
- "SHA-1"
- "SHA-224"
- "SHA-256"
- "SHA-384"
- "SHA-512"
title: "Hashing method"
description: "The hashing algorithm to use."
targetField:
type: "string"
title: "Original Field Name"
description: "The name of the field to be hashed."
required:
- "fieldNameSuffix"
- "method"
- "targetField"
x-speakeasy-component: true
FieldFilteringMapperConfiguration:
title: "Field Filtering"
type: "object"
properties:
targetField:
type: "string"
title: "The Field to Filter"
description: "The name of the field to filter."
required:
- "targetField"
x-speakeasy-component: true
FieldRenamingMapperConfiguration:
title: "Field Renaming"
type: "object"
properties:
newFieldName:
type: "string"
title: "New Field Name"
description: "The new name for the field after renaming."
originalFieldName:
type: "string"
title: "Original Field Name"
description: "The current name of the field to rename."
required:
- "newFieldName"
- "originalFieldName"
x-speakeasy-component: true
RowFilteringOperationType:
type: "string"
enum:
- "EQUAL"
- "NOT"
x-speakeasy-component: true
RowFilteringOperationEqual:
type: "object"
title: "EQUAL"
required:
- "comparisonValue"
- "fieldName"
- "type"
properties:
comparisonValue:
type: "string"
title: "Comparison Value"
description: "The value to compare the field against."
fieldName:
type: "string"
title: "Field Name"
description: "The name of the field to apply the operation on."
type:
$ref: "#/components/schemas/RowFilteringOperationType"
x-speakeasy-component: true
RowFilteringOperationNot:
type: "object"
title: "NOT"
required:
- "conditions"
- "type"
properties:
conditions:
title: "Sub-Conditions (NOT)"
description: "Conditions to evaluate with the NOT operator."
minItems: 1
type: "array"
items:
$ref: "#/components/schemas/RowFilteringOperation"
type:
$ref: "#/components/schemas/RowFilteringOperationType"
x-speakeasy-component: true
RowFilteringOperation:
type: "object"
oneOf:
- $ref: "#/components/schemas/RowFilteringOperationEqual"
- $ref: "#/components/schemas/RowFilteringOperationNot"
discriminator:
propertyName: "type"
mapping:
EQUAL: "#/components/schemas/RowFilteringOperationEqual"
NOT: "#/components/schemas/RowFilteringOperationNot"
x-speakeasy-component: true
x-airbyte-circular-ref: true
RowFilteringMapperConfiguration:
title: "Row Filtering"
type: "object"
properties:
conditions:
$ref: "#/components/schemas/RowFilteringOperation"
required:
- "conditions"
x-speakeasy-component: true
EncryptionMapperAlgorithm:
type: "string"
enum:
- "RSA"
- "AES"
x-speakeasy-component: true
EncryptionMapperConfiguration:
title: "Encryption"
type: "object"
oneOf:
- $ref: "#/components/schemas/EncryptionMapperRSAConfiguration"
- $ref: "#/components/schemas/EncryptionMapperAESConfiguration"
discriminator:
propertyName: "algorithm"
mapping:
RSA: "#/components/schemas/EncryptionMapperRSAConfiguration"
AES: "#/components/schemas/EncryptionMapperAESConfiguration"
x-speakeasy-component: true
EncryptionMapperRSAConfiguration:
title: "Encryption - RSA"
type: "object"
properties:
algorithm:
$ref: "#/components/schemas/EncryptionMapperAlgorithm"
fieldNameSuffix:
type: "string"
publicKey:
type: "string"
targetField:
type: "string"
required:
- "algorithm"
- "publicKey"
- "targetField"
- "fieldNameSuffix"
x-speakeasy-component: true
EncryptionMapperAESConfiguration:
title: "Encryption - AES"
type: "object"
properties:
algorithm:
$ref: "#/components/schemas/EncryptionMapperAlgorithm"
fieldNameSuffix:
type: "string"
key:
type: "string"
x-speakeasy-param-sensitive: true
mode:
type: "string"
enum:
- "CBC"
- "CFB"
- "OFB"
- "CTR"
- "GCM"
- "ECB"
padding:
type: "string"
enum:
- "NoPadding"
- "PKCS5Padding"
targetField:
type: "string"
required:
- "algorithm"
- "key"
- "mode"
- "padding"
- "targetField"
- "fieldNameSuffix"
x-speakeasy-component: true
SelectedFields:
description: "Paths to the fields that will be included in the configured catalog."
type: "array"
format: "set"
items:
$ref: "#/components/schemas/SelectedFieldInfo"
x-speakeasy-component: true
ScopedResourceRequirements:
x-speakeasy-component: true
description: "actor or actor definition specific resource requirements. if default\
\ is set, these are the requirements that should be set for ALL jobs run for\
\ this actor definition. it is overriden by the job type specific configurations.\
\ if not set, the platform will use defaults. these values will be overriden\
\ by configuration at the connection level."
type: "object"
additionalProperties: false
properties:
default:
$ref: "#/components/schemas/ResourceRequirements"
jobSpecific:
type: "array"
items:
$ref: "#/components/schemas/JobTypeResourceLimit"
ActorDefinitionId:
description: "A unique identifier for an actor definition."
type: "string"
format: "uuid"
x-speakeasy-component: true
JobTypeResourceLimit:
x-speakeasy-component: true
description: "sets resource requirements for a specific job type for an actor\
\ or actor definition. these values override the default, if both are set."
type: "object"
additionalProperties: false
required:
- "jobType"
- "resourceRequirements"
properties:
jobType:
$ref: "#/components/schemas/JobType"
resourceRequirements:
$ref: "#/components/schemas/ResourceRequirements"
JobType:
x-speakeasy-component: true
description: "enum that describes the different types of jobs that the platform\
\ runs."
type: "string"
enum:
- "get_spec"
- "check_connection"
- "discover_schema"
- "sync"
- "reset_connection"
- "connection_updater"
- "replicate"
ResourceRequirements:
x-speakeasy-component: true
description: "optional resource requirements to run workers (blank for unbounded\
\ allocations)"
type: "object"
properties:
cpu_request:
type: "string"
cpu_limit:
type: "string"
memory_request:
type: "string"
memory_limit:
type: "string"
ephemeral_storage_request:
type: "string"
ephemeral_storage_limit:
type: "string"
OAuthConfiguration:
description: "The values required to configure OAuth flows. The schema for this\
\ must match the `OAuthConfigSpecification.oauthUserInputFromConnectorConfigSpecification`\
\ schema."
x-speakeasy-component: true
OAuthInputConfiguration:
$ref: "#/components/schemas/OAuthConfiguration"
x-speakeasy-component: true
NonBreakingChangesPreference:
enum:
- "ignore"
- "disable"
- "propagate_columns"
- "propagate_fully"
type: "string"
x-speakeasy-component: true
ApplicationCreate:
required:
- "name"
type: "object"
properties:
name:
type: "string"
x-speakeasy-component: true
ApplicationReadList:
required:
- "applications"
type: "object"
properties:
applications:
type: "array"
items:
$ref: "#/components/schemas/ApplicationRead"
x-speakeasy-component: true
ApplicationRead:
required:
- "id"
- "name"
- "clientId"
- "clientSecret"
- "createdAt"
type: "object"
properties:
id:
type: "string"
name:
type: "string"
clientId:
type: "string"
clientSecret:
type: "string"
createdAt:
type: "integer"
format: "int64"
x-speakeasy-component: true
ApplicationTokenRequestWithGrant:
required:
- "client_id"
- "client_secret"
- "grant_type"
type: "object"
properties:
client_id:
type: "string"
client_secret:
type: "string"
grant-type:
enum:
- "client_credentials"
x-speakeasy-component: true
PublicAccessTokenResponse:
required:
- "access_token"
- "token_type"
- "expires_in"
type: "object"
properties:
access_token:
type: "string"
token_type:
enum:
- "Bearer"
expires_in:
type: "integer"
format: "int64"
x-speakeasy-component: true
RedirectUrlResponse:
title: "Root Type for RedirectUrlResponse"
description: ""
type: "object"
properties:
redirectUrl:
format: "url"
type: "string"
example:
redirectUrl: "https://example.com"
x-speakeasy-component: true
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"
x-speakeasy-component: true
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"
x-speakeasy-component: true
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/AirbyteApiConnectionSchedule"
dataResidency:
deprecated: true
x-speakeasy-deprecation-message: "We no longer support modifying dataResidency\
\ on Community and Enterprise connections. All connections will use the\
\ dataResidency of their associated workspace."
type: "string"
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”)."
default: ""
nonBreakingSchemaUpdatesBehavior:
$ref: "#/components/schemas/NonBreakingSchemaUpdatesBehaviorEnum"
status:
$ref: "#/components/schemas/ConnectionStatusEnum"
tags:
type: "array"
items:
$ref: "#/components/schemas/Tag"
x-speakeasy-entity: "Connection"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
ConnectionPatchRequest:
type: "object"
properties:
name:
description: "Optional name of the connection"
type: "string"
configurations:
$ref: "#/components/schemas/StreamConfigurations"
schedule:
$ref: "#/components/schemas/AirbyteApiConnectionSchedule"
dataResidency:
deprecated: true
x-speakeasy-deprecation-message: "We no longer support modifying dataResidency\
\ on Community and Enterprise connections. All connections will use the\
\ dataResidency of their associated workspace."
type: "string"
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"
tags:
type: "array"
items:
$ref: "#/components/schemas/Tag"
x-speakeasy-entity: "Connection"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: 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"
x-speakeasy-component: true
JobStatusEnum:
enum:
- "pending"
- "queued"
- "running"
- "incomplete"
- "failed"
- "succeeded"
- "cancelled"
type: "string"
x-speakeasy-component: true
JobTypeEnum:
description: "Enum that describes the different types of jobs that the platform\
\ runs."
enum:
- "sync"
- "reset"
- "refresh"
- "clear"
type: "string"
x-speakeasy-component: true
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 OAuth redirect flow."
type: "string"
resourceAllocation:
$ref: "#/components/schemas/ScopedResourceRequirements"
x-implements: "io.airbyte.api.common.ConfigurableActor"
x-speakeasy-entity: "Source"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
SourcePutRequest:
required:
- "name"
- "configuration"
type: "object"
properties:
name:
type: "string"
configuration:
$ref: "#/components/schemas/SourceConfiguration"
resourceAllocation:
$ref: "#/components/schemas/ScopedResourceRequirements"
x-implements: "io.airbyte.api.common.ConfigurableActor"
x-speakeasy-entity: "Source"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: 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 OAuth redirect flow."
type: "string"
resourceAllocation:
$ref: "#/components/schemas/ScopedResourceRequirements"
x-implements: "io.airbyte.api.common.ConfigurableActor"
x-speakeasy-entity: "Source"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
TagCreateRequest:
required:
- "name"
- "color"
- "workspaceId"
type: "object"
properties:
name:
type: "string"
color:
type: "string"
workspaceId:
$ref: "#/components/schemas/WorkspaceId"
x-speakeasy-entity: "Tag"
x-speakeasy-component: true
TagPatchRequest:
required:
- "name"
- "color"
type: "object"
properties:
name:
type: "string"
color:
type: "string"
x-speakeasy-entity: "Tag"
x-speakeasy-component: true
OrganizationOAuthCredentialsRequest:
title: "Root Type for OrganizationOAuthCredentials"
description: "POST body for creating/updating organization level OAuth credentials"
required:
- "actorType"
- "name"
- "configuration"
type: "object"
properties:
actorType:
$ref: "#/components/schemas/ActorTypeEnum"
name:
type: "string"
description: "The name of the source i.e. google-ads"
configuration:
$ref: "#/components/schemas/OAuthCredentialsConfiguration"
x-speakeasy-component: true
ConnectionResponse:
title: "Root Type for ConnectionResponse"
description: "Provides details of a single connection."
type: "object"
required:
- "connectionId"
- "name"
- "sourceId"
- "destinationId"
- "workspaceId"
- "status"
- "schedule"
- "configurations"
- "createdAt"
- "tags"
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"
nonBreakingSchemaUpdatesBehavior:
$ref: "#/components/schemas/NonBreakingSchemaUpdatesBehaviorEnum"
namespaceDefinition:
$ref: "#/components/schemas/NamespaceDefinitionEnum"
namespaceFormat:
type: "string"
prefix:
type: "string"
configurations:
$ref: "#/components/schemas/StreamConfigurations"
createdAt:
format: "int64"
type: "integer"
tags:
type: "array"
items:
$ref: "#/components/schemas/Tag"
statusReason:
type: "string"
x-speakeasy-entity: "Connection"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
AirbyteApiConnectionSchedule:
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"
x-speakeasy-component: true
ScheduleTypeEnum:
type: "string"
enum:
- "manual"
- "cron"
x-speakeasy-component: true
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"
x-speakeasy-component: true
ScheduleTypeWithBasicEnum:
type: "string"
enum:
- "manual"
- "cron"
- "basic"
x-speakeasy-component: true
ConnectionStatusEnum:
type: "string"
enum:
- "active"
- "inactive"
- "deprecated"
- "locked"
x-speakeasy-component: true
NamespaceDefinitionEnum:
type: "string"
description: "Define the location where the data will be stored in the destination"
enum:
- "source"
- "destination"
- "custom_format"
default: "destination"
x-speakeasy-component: true
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"
x-speakeasy-component: true
NamespaceDefinitionEnumNoDefault:
type: "string"
description: "Define the location where the data will be stored in the destination"
enum:
- "source"
- "destination"
- "custom_format"
x-speakeasy-component: true
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"
x-speakeasy-component: true
DestinationResponse:
title: "Root Type for DestinationResponse"
description: "Provides details of a single destination."
type: "object"
required:
- "destinationId"
- "name"
- "destinationType"
- "definitionId"
- "workspaceId"
- "configuration"
- "createdAt"
properties:
destinationId:
format: "UUID"
type: "string"
name:
type: "string"
destinationType:
type: "string"
definitionId:
format: "UUID"
type: "string"
workspaceId:
format: "UUID"
type: "string"
configuration:
$ref: "#/components/schemas/DestinationConfiguration"
createdAt:
format: "int64"
type: "integer"
resourceAllocation:
$ref: "#/components/schemas/ScopedResourceRequirements"
example:
destinationId: "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826"
name: "Analytics Team Postgres"
destinationType: "postgres"
workspaceId: "871d9b60-11d1-44cb-8c92-c246d53bf87e"
definitionId: "321d9b60-11d1-44cb-8c92-c246d53bf98e"
x-speakeasy-component: true
SourceResponse:
title: "Root Type for SourceResponse"
description: "Provides details of a single source."
type: "object"
required:
- "sourceId"
- "name"
- "sourceType"
- "workspaceId"
- "configuration"
- "definitionId"
- "createdAt"
properties:
sourceId:
format: "UUID"
type: "string"
name:
type: "string"
sourceType:
type: "string"
definitionId:
format: "UUID"
type: "string"
workspaceId:
format: "UUID"
type: "string"
configuration:
$ref: "#/components/schemas/SourceConfiguration"
createdAt:
format: "int64"
type: "integer"
resourceAllocation:
$ref: "#/components/schemas/ScopedResourceRequirements"
example:
sourceId: "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826"
name: "Analytics Team Postgres"
sourceType: "postgres"
workspaceId: "871d9b60-11d1-44cb-8c92-c246d53bf87e"
definitionId: "321d9b60-11d1-44cb-8c92-c246d53bf98e"
x-speakeasy-component: true
ConnectorDefinitionResponse:
title: "Root Type for ConnectorDefinitionResponse"
description: "Provides details of a single connector definition."
type: "object"
required:
- "id"
- "connectorDefinitionType"
- "name"
- "version"
properties:
id:
format: "UUID"
type: "string"
name:
type: "string"
connectorDefinitionType:
$ref: "#/components/schemas/ConnectorType"
version:
type: "string"
example:
id: "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826"
name: "Postgres"
connectorDefinnitionType: "source"
version: "0.2.0"
x-speakeasy-component: true
ConnectorType:
type: "string"
enum:
- "source"
- "destination"
x-speakeasy-component: true
TagResponse:
title: "Root Type for TagResponse"
description: "Provides details of a single tag."
type: "object"
required:
- "tagId"
- "name"
- "color"
- "workspaceId"
properties:
tagId:
$ref: "#/components/schemas/TagId"
name:
type: "string"
color:
description: "A hexadecimal color value"
type: "string"
workspaceId:
$ref: "#/components/schemas/WorkspaceId"
example:
tagId: "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826"
name: "Analytics Team"
color: "FF5733"
workspaceId: "871d9b60-11d1-44cb-8c92-c246d53bf87e"
x-speakeasy-component: true
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"
resourceAllocation:
$ref: "#/components/schemas/ScopedResourceRequirements"
x-implements: "io.airbyte.api.common.ConfigurableActor"
x-speakeasy-entity: "Destination"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
DestinationPatchRequest:
type: "object"
properties:
name:
type: "string"
configuration:
$ref: "#/components/schemas/DestinationConfiguration"
resourceAllocation:
$ref: "#/components/schemas/ScopedResourceRequirements"
x-implements: "io.airbyte.api.common.ConfigurableActor"
x-speakeasy-entity: "Destination"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
DestinationPutRequest:
required:
- "name"
- "configuration"
type: "object"
properties:
name:
type: "string"
configuration:
$ref: "#/components/schemas/DestinationConfiguration"
resourceAllocation:
$ref: "#/components/schemas/ScopedResourceRequirements"
x-implements: "io.airbyte.api.common.ConfigurableActor"
x-speakeasy-entity: "Destination"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
WorkspaceCreateRequest:
required:
- "name"
type: "object"
properties:
name:
description: "Name of the workspace"
type: "string"
organizationId:
description: "ID of organization to add workspace to."
format: "uuid"
type: "string"
notifications:
$ref: "#/components/schemas/NotificationsConfig"
regionId:
type: "string"
format: "uuid"
x-speakeasy-entity: "Workspace"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
WorkspaceUpdateRequest:
type: "object"
properties:
name:
description: "Name of the workspace"
type: "string"
notifications:
$ref: "#/components/schemas/NotificationsConfig"
regionId:
type: "string"
format: "uuid"
x-speakeasy-entity: "Workspace"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
WorkspaceResponse:
title: "Root Type for WorkspaceResponse"
description: "Provides details of a single workspace."
type: "object"
required:
- "workspaceId"
- "name"
- "dataResidency"
- "notifications"
properties:
workspaceId:
format: "UUID"
type: "string"
name:
type: "string"
dataResidency:
type: "string"
notifications:
$ref: "#/components/schemas/NotificationsConfig"
x-speakeasy-entity: "Workspace"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
NotificationsConfig:
description: "Configures workspace notifications."
type: "object"
properties:
failure:
$ref: "#/components/schemas/NotificationConfig"
success:
$ref: "#/components/schemas/NotificationConfig"
connectionUpdate:
$ref: "#/components/schemas/NotificationConfig"
connectionUpdateActionRequired:
$ref: "#/components/schemas/NotificationConfig"
syncDisabled:
$ref: "#/components/schemas/NotificationConfig"
syncDisabledWarning:
$ref: "#/components/schemas/NotificationConfig"
x-speakeasy-entity: "Workspace"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
NotificationConfig:
description: "Configures a notification."
type: "object"
properties:
email:
$ref: "#/components/schemas/EmailNotificationConfig"
webhook:
$ref: "#/components/schemas/WebhookNotificationConfig"
x-speakeasy-entity: "Workspace"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
WebhookNotificationConfig:
description: "Configures a webhook notification."
type: "object"
properties:
enabled:
type: "boolean"
url:
type: "string"
x-speakeasy-entity: "Workspace"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
EmailNotificationConfig:
description: "Configures an email notification."
type: "object"
properties:
enabled:
type: "boolean"
x-speakeasy-entity: "Workspace"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
UserResponse:
title: "Root Type for UserResponse"
description: "Provides details of a single user in an organization."
type: "object"
required:
- "id"
- "name"
- "email"
properties:
name:
description: "Name of the user"
type: "string"
id:
$ref: "#/components/schemas/UserId"
email:
type: "string"
format: "email"
x-speakeasy-entity: "User"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
UsersResponse:
title: "Root Type for UsersResponse"
description: "List/Array of multiple users in an organization"
required:
- "data"
type: "object"
properties:
data:
type: "array"
items:
$ref: "#/components/schemas/UserResponse"
x-speakeasy-component: true
x-speakeasy-entity: "User"
x-speakeasy-param-suppress-computed-diff: true
PermissionCreateRequest:
required:
- "permissionType"
- "userId"
type: "object"
properties:
permissionType:
$ref: "#/components/schemas/PublicPermissionType"
userId:
$ref: "#/components/schemas/UserId"
workspaceId:
$ref: "#/components/schemas/WorkspaceId"
organizationId:
$ref: "#/components/schemas/OrganizationId"
x-speakeasy-entity: "Permission"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
PermissionUpdateRequest:
required:
- "permissionType"
type: "object"
properties:
permissionType:
$ref: "#/components/schemas/PermissionType"
x-speakeasy-entity: "Permission"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
PermissionResponse:
title: "Root Type for PermissionResponse"
description: "Provides details of a single permission."
type: "object"
required:
- "permissionId"
- "permissionType"
- "userId"
properties:
permissionId:
type: "string"
format: "uuid"
permissionType:
$ref: "#/components/schemas/PermissionType"
userId:
$ref: "#/components/schemas/UserId"
workspaceId:
$ref: "#/components/schemas/WorkspaceId"
organizationId:
$ref: "#/components/schemas/OrganizationId"
x-speakeasy-entity: "Permission"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
PermissionScope:
description: "Scope of a single permission, e.g. workspace, organization"
type: "string"
enum:
- "workspace"
- "organization"
- "none"
x-speakeasy-component: true
PermissionResponseRead:
title: "Root type for PermissionResponseRead"
description: "Reformat PermissionResponse with permission scope"
type: "object"
required:
- "permissionId"
- "permissionType"
- "userId"
- "scope"
- "scopeId"
properties:
permissionId:
type: "string"
format: "uuid"
permissionType:
$ref: "#/components/schemas/PermissionType"
userId:
$ref: "#/components/schemas/UserId"
scopeId:
type: "string"
format: "uuid"
scope:
$ref: "#/components/schemas/PermissionScope"
x-speakeasy-entity: "Permission"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
PermissionsResponse:
title: "Root Type for PermissionsResponse"
description: "List/Array of multiple permissions"
required:
- "data"
type: "object"
properties:
data:
type: "array"
items:
$ref: "#/components/schemas/PermissionResponseRead"
x-speakeasy-component: true
OrganizationResponse:
title: "Root Type for OrganizationResponse"
description: "Provides details of a single organization for a user."
type: "object"
required:
- "organizationId"
- "organizationName"
- "email"
properties:
organizationId:
$ref: "#/components/schemas/OrganizationId"
organizationName:
type: "string"
email:
type: "string"
format: "email"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
OrganizationsResponse:
title: "Root Type for OrganizationsResponse"
description: "List/Array of multiple organizations."
required:
- "data"
type: "object"
properties:
data:
type: "array"
items:
$ref: "#/components/schemas/OrganizationResponse"
x-speakeasy-component: 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"
x-speakeasy-component: true
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"
x-speakeasy-component: true
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"
x-speakeasy-component: true
ConnectorDefinitionsResponse:
title: "Root Type for DefinitionsResponse"
description: ""
required:
- "data"
type: "object"
properties:
data:
type: "array"
items:
$ref: "#/components/schemas/ConnectorDefinitionResponse"
x-speakeasy-component: true
CreateDeclarativeSourceDefinitionRequest:
type: "object"
x-speakeasy-component: true
required:
- "workspaceId"
- "name"
- "manifest"
properties:
name:
type: "string"
manifest:
$ref: "#/components/schemas/DeclarativeManifest"
UpdateDeclarativeSourceDefinitionRequest:
type: "object"
x-speakeasy-component: true
required:
- "manifest"
properties:
manifest:
$ref: "#/components/schemas/DeclarativeManifest"
DeclarativeSourceDefinitionsResponse:
title: "Root Type for DeclarativeSourceDefinitionsResponse"
description: ""
x-speakeasy-component: true
required:
- "data"
type: "object"
properties:
previous:
type: "string"
next:
type: "string"
data:
type: "array"
items:
$ref: "#/components/schemas/DeclarativeSourceDefinitionResponse"
DeclarativeSourceDefinitionResponse:
type: "object"
x-speakeasy-component: true
required:
- "id"
- "name"
- "manifest"
- "version"
properties:
id:
format: "UUID"
type: "string"
name:
type: "string"
manifest:
$ref: "#/components/schemas/DeclarativeManifest"
version:
x-speakeasy-terraform-ignore: true
$ref: "#/components/schemas/ManifestVersion"
CreateDefinitionRequest:
type: "object"
x-speakeasy-component: true
required:
- "name"
- "dockerRepository"
- "dockerImageTag"
properties:
name:
type: "string"
dockerRepository:
type: "string"
dockerImageTag:
type: "string"
documentationUrl:
type: "string"
format: "uri"
UpdateDefinitionRequest:
type: "object"
x-speakeasy-component: true
required:
- "name"
- "dockerImageTag"
properties:
name:
type: "string"
dockerImageTag:
type: "string"
DefinitionsResponse:
title: "Root Type for DefinitionsResponse"
description: ""
x-speakeasy-component: true
required:
- "data"
type: "object"
properties:
previous:
type: "string"
next:
type: "string"
data:
type: "array"
items:
$ref: "#/components/schemas/DefinitionResponse"
DefinitionResponse:
title: "Root Type for DefinitionResponse"
description: "Provides details of a single connector definition."
type: "object"
x-speakeasy-component: true
required:
- "id"
- "name"
- "dockerRepository"
- "dockerImageTag"
properties:
id:
format: "UUID"
type: "string"
name:
type: "string"
dockerRepository:
type: "string"
dockerImageTag:
type: "string"
documentationUrl:
type: "string"
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"
x-speakeasy-component: true
TagsResponse:
title: "Root Type for TagsResponse"
description: ""
required:
- "data"
type: "object"
properties:
data:
type: "array"
items:
$ref: "#/components/schemas/TagResponse"
x-speakeasy-component: true
StreamConfiguration:
description: "Configurations for a single stream."
type: "object"
required:
- "name"
properties:
name:
type: "string"
namespace:
type: "string"
description: "Namespace of the stream."
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"
includeFiles:
description: "Whether to move raw files from the source to the destination\
\ during the sync."
type: "boolean"
destinationObjectName:
description: "The name of the destination object that this stream will be\
\ written to, used for data activation destinations."
type: "string"
selectedFields:
description: "By default (if not provided in the request) all fields will\
\ be synced. Otherwise, only the fields in this list will be synced."
$ref: "#/components/schemas/SelectedFields"
mappers:
description: "Mappers that should be applied to the stream before writing\
\ to the destination."
type: "array"
items:
$ref: "#/components/schemas/ConfiguredStreamMapper"
x-speakeasy-component: true
StreamConfigurations:
description: "A list of configured stream options for a connection."
type: "object"
properties:
streams:
type: "array"
format: "set"
items:
$ref: "#/components/schemas/StreamConfiguration"
x-speakeasy-component: true
StreamPropertiesResponse:
description: "A list of stream properties."
type: "array"
items:
$ref: "#/components/schemas/StreamProperties"
x-speakeasy-component: true
StreamProperties:
description: "The stream properties associated with a connection."
type: "object"
properties:
streamName:
type: "string"
syncModes:
type: "array"
items:
$ref: "#/components/schemas/ConnectionSyncModeEnum"
streamnamespace:
type: "string"
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"
x-speakeasy-component: true
ConnectionSyncModeEnum:
enum:
- "full_refresh_overwrite"
- "full_refresh_overwrite_deduped"
- "full_refresh_append"
- "full_refresh_update"
- "full_refresh_soft_delete"
- "incremental_append"
- "incremental_deduped_history"
- "incremental_update"
- "incremental_soft_delete"
x-speakeasy-component: true
ActorTypeEnum:
description: "Whether you're setting this override for a source or destination"
enum:
- "source"
- "destination"
x-speakeasy-component: true
RegionCreateRequest:
type: "object"
required:
- "name"
- "organizationId"
properties:
name:
type: "string"
organizationId:
type: "string"
format: "uuid"
enabled:
type: "boolean"
x-speakeasy-entity: "Region"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
RegionPatchRequest:
type: "object"
properties:
name:
type: "string"
enabled:
type: "boolean"
x-speakeasy-entity: "Region"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
RegionResponse:
type: "object"
required:
- "regionId"
- "name"
- "organizationId"
- "enabled"
- "createdAt"
- "updatedAt"
properties:
regionId:
type: "string"
format: "uuid"
name:
type: "string"
organizationId:
type: "string"
format: "uuid"
enabled:
type: "boolean"
createdAt:
type: "string"
updatedAt:
type: "string"
x-speakeasy-entity: "Region"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
RegionsResponse:
type: "object"
required:
- "data"
properties:
data:
type: "array"
items:
$ref: "#/components/schemas/RegionResponse"
x-speakeasy-component: true
DataplaneCreateRequest:
type: "object"
required:
- "regionId"
- "name"
properties:
regionId:
type: "string"
format: "uuid"
name:
type: "string"
enabled:
type: "boolean"
x-speakeasy-entity: "Dataplane"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
DataplanePatchRequest:
type: "object"
properties:
name:
type: "string"
enabled:
type: "boolean"
x-speakeasy-entity: "Dataplane"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
DataplaneResponse:
type: "object"
required:
- "dataplaneId"
- "name"
- "regionId"
- "enabled"
- "createdAt"
- "updatedAt"
properties:
dataplaneId:
type: "string"
format: "uuid"
name:
type: "string"
regionId:
type: "string"
format: "uuid"
enabled:
type: "boolean"
createdAt:
type: "string"
updatedAt:
type: "string"
x-speakeasy-entity: "Dataplane"
x-speakeasy-param-suppress-computed-diff: true
x-speakeasy-component: true
DataplanesResponse:
type: "object"
required:
- "data"
properties:
data:
type: "array"
items:
$ref: "#/components/schemas/DataplaneResponse"
x-speakeasy-component: true
EmbeddedWidgetRequest:
type: "object"
required:
- "allowedOrigin"
- "externalUserId"
- "organizationId"
properties:
allowedOrigin:
type: "string"
externalUserId:
type: "string"
organizationId:
type: "string"
format: "uuid"
x-speakeasy-component: true
EmbeddedWidgetResponse:
type: "object"
required:
- "token"
properties:
token:
type: "string"
x-speakeasy-component: true
EmbeddedScopedTokenRequest:
type: "object"
required:
- "workspaceId"
properties:
workspaceId:
type: "string"
format: "uuid"
x-speakeasy-component: true
EmbeddedScopedTokenResponse:
type: "object"
required:
- "token"
properties:
token:
type: "string"
x-speakeasy-component: true
EmbeddedOrganizationsList:
required:
- "organizations"
properties:
organizations:
type: "array"
items:
$ref: "#/components/schemas/EmbeddedOrganizationListItem"
x-speakeasy-component: true
EmbeddedOrganizationListItem:
type: "object"
required:
- "organizationId"
- "organizationName"
- "permission"
properties:
organizationId:
type: "string"
format: "uuid"
organizationName:
type: "string"
permission:
$ref: "#/components/schemas/PermissionType"
x-speakeasy-component: true
SSOConfigStatus:
type: "string"
enum:
- "draft"
- "active"
x-speakeasy-component: true
source-invoiced:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it at https://invoiced.com/account"
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "invoiced"
const: "invoiced"
enum:
- "invoiced"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-invoiced-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it at https://invoiced.com/account"
name: "api_key"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-nebius-ai:
properties:
api_key:
airbyte_secret: true
description: "API key or access token"
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
limit:
default: "20"
description: "Limit for each response objects"
order: 2
title: "Limit"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "nebius-ai"
const: "nebius-ai"
enum:
- "nebius-ai"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-nebius-ai-update:
properties:
api_key:
airbyte_secret: true
description: "API key or access token"
name: "api_key"
order: 0
title: "API Key"
type: "string"
limit:
default: "20"
description: "Limit for each response objects"
order: 2
title: "Limit"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-google-forms:
properties:
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_refresh_token:
airbyte_secret: true
order: 2
title: "Refresh token"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
x-speakeasy-param-sensitive: true
form_id:
order: 3
title: "Form IDs"
type: "array"
sourceType:
title: "google-forms"
const: "google-forms"
enum:
- "google-forms"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "client_refresh_token"
- "form_id"
- "sourceType"
type: "object"
source-google-forms-update:
properties:
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
client_refresh_token:
airbyte_secret: true
order: 2
title: "Refresh token"
type: "string"
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
form_id:
order: 3
title: "Form IDs"
type: "array"
required:
- "client_id"
- "client_secret"
- "client_refresh_token"
- "form_id"
type: "object"
source-the-guardian-api:
properties:
api_key:
airbyte_secret: true
description: "Your API Key. See here. The key is case sensitive."
order: 2
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
end_date:
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."
examples:
- "YYYY-MM-DD"
order: 4
pattern: "^([1-9][0-9]{3})\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01])$"
title: "End Date"
type: "string"
query:
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"
order: 1
title: "Query"
type: "string"
section:
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"
order: 3
title: "Section"
type: "string"
start_date:
description: "Use this to set the minimum date (YYYY-MM-DD) of the results.\
\ Results older than the start_date will not be shown."
examples:
- "YYYY-MM-DD"
order: 5
pattern: "^([1-9][0-9]{3})\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01])$"
title: "Start Date"
type: "string"
tag:
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"
order: 0
title: "Tag"
type: "string"
sourceType:
title: "the-guardian-api"
const: "the-guardian-api"
enum:
- "the-guardian-api"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-the-guardian-api-update:
properties:
api_key:
airbyte_secret: true
description: "Your API Key. See here. The key is case sensitive."
order: 2
title: "API Key"
type: "string"
end_date:
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."
examples:
- "YYYY-MM-DD"
order: 4
pattern: "^([1-9][0-9]{3})\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01])$"
title: "End Date"
type: "string"
query:
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"
order: 1
title: "Query"
type: "string"
section:
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"
order: 3
title: "Section"
type: "string"
start_date:
description: "Use this to set the minimum date (YYYY-MM-DD) of the results.\
\ Results older than the start_date will not be shown."
examples:
- "YYYY-MM-DD"
order: 5
pattern: "^([1-9][0-9]{3})\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01])$"
title: "Start Date"
type: "string"
tag:
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"
order: 0
title: "Tag"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-prestashop:
properties:
access_key:
airbyte_secret: true
description: "Your PrestaShop access key. See the docs for info on how to obtain this."
order: 0
title: "Access Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "The Start date in the format YYYY-MM-DD."
examples:
- "2022-01-01"
format: "date"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start date"
type: "string"
url:
description: "Shop URL without trailing slash."
order: 1
title: "Shop URL"
type: "string"
sourceType:
title: "prestashop"
const: "prestashop"
enum:
- "prestashop"
order: 0
type: "string"
required:
- "access_key"
- "url"
- "start_date"
- "sourceType"
type: "object"
source-prestashop-update:
properties:
access_key:
airbyte_secret: true
description: "Your PrestaShop access key. See the docs for info on how to obtain this."
order: 0
title: "Access Key"
type: "string"
start_date:
description: "The Start date in the format YYYY-MM-DD."
examples:
- "2022-01-01"
format: "date"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start date"
type: "string"
url:
description: "Shop URL without trailing slash."
order: 1
title: "Shop URL"
type: "string"
required:
- "access_key"
- "url"
- "start_date"
type: "object"
source-keka:
properties:
api_key:
order: 2
title: "API Key"
type: "string"
client_id:
description: "Your client identifier for authentication."
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Your client secret for secure authentication."
order: 1
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
grant_type:
order: 3
title: "Grant Type"
type: "string"
scope:
order: 4
title: "Scope"
type: "string"
sourceType:
title: "keka"
const: "keka"
enum:
- "keka"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "api_key"
- "grant_type"
- "scope"
- "sourceType"
type: "object"
source-keka-update:
properties:
api_key:
order: 2
title: "API Key"
type: "string"
client_id:
description: "Your client identifier for authentication."
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Your client secret for secure authentication."
order: 1
title: "Client Secret"
type: "string"
grant_type:
order: 3
title: "Grant Type"
type: "string"
scope:
order: 4
title: "Scope"
type: "string"
required:
- "client_id"
- "client_secret"
- "api_key"
- "grant_type"
- "scope"
type: "object"
source-payfit:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
company_id:
order: 1
title: "Company ID"
type: "string"
sourceType:
title: "payfit"
const: "payfit"
enum:
- "payfit"
order: 0
type: "string"
required:
- "api_key"
- "company_id"
- "sourceType"
type: "object"
source-payfit-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
company_id:
order: 1
title: "Company ID"
type: "string"
required:
- "api_key"
- "company_id"
type: "object"
source-simplesat:
properties:
api_key:
airbyte_secret: true
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
end_date:
description: "Date till when the sync should end"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "end_date"
type: "string"
start_date:
description: "Date from when the sync should start"
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "start_date"
type: "string"
sourceType:
title: "simplesat"
const: "simplesat"
enum:
- "simplesat"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-simplesat-update:
properties:
api_key:
airbyte_secret: true
name: "api_key"
order: 0
title: "API Key"
type: "string"
end_date:
description: "Date till when the sync should end"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "end_date"
type: "string"
start_date:
description: "Date from when the sync should start"
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "start_date"
type: "string"
required:
- "api_key"
type: "object"
source-when-i-work:
properties:
email:
airbyte_secret: true
description: "Email of your when-i-work account"
order: 0
title: "Email"
type: "string"
x-speakeasy-param-sensitive: true
password:
airbyte_secret: true
description: "Password for your when-i-work account"
order: 1
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "when-i-work"
const: "when-i-work"
enum:
- "when-i-work"
order: 0
type: "string"
required:
- "email"
- "password"
- "sourceType"
type: "object"
source-when-i-work-update:
properties:
email:
airbyte_secret: true
description: "Email of your when-i-work account"
order: 0
title: "Email"
type: "string"
password:
airbyte_secret: true
description: "Password for your when-i-work account"
order: 1
title: "Password"
type: "string"
required:
- "email"
- "password"
type: "object"
source-kisi:
properties:
api_key:
description: "Your KISI API Key"
order: 0
title: "API Key"
type: "string"
sourceType:
title: "kisi"
const: "kisi"
enum:
- "kisi"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-kisi-update:
properties:
api_key:
description: "Your KISI API Key"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-eventbrite:
properties:
private_token:
airbyte_secret: true
description: "The private token to use for authenticating API requests."
name: "private_token"
order: 0
title: "Private Token"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "eventbrite"
const: "eventbrite"
enum:
- "eventbrite"
order: 0
type: "string"
required:
- "private_token"
- "start_date"
- "sourceType"
type: "object"
source-eventbrite-update:
properties:
private_token:
airbyte_secret: true
description: "The private token to use for authenticating API requests."
name: "private_token"
order: 0
title: "Private Token"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "private_token"
- "start_date"
type: "object"
source-datagen:
properties:
concurrency:
description: "Maximum number of concurrent data generators. Leave empty\
\ to let Airbyte optimize performance."
title: "Max Concurrency"
type: "integer"
flavor:
default: "increment"
description: "Different patterns for generating data"
display_type: "radio"
oneOf:
- additionalProperties: true
description: "Generates incrementally increasing numerical data for the\
\ source."
properties:
data_type:
default: "increment"
enum:
- "increment"
type: "string"
required:
- "data_type"
title: "Incremental"
type: "object"
- additionalProperties: true
description: "Generates one column of each Airbyte data type."
properties:
data_type:
default: "types"
enum:
- "types"
type: "string"
required:
- "data_type"
title: "All Types"
type: "object"
title: "Data Generation Type"
type: "object"
max_records:
default: "100"
description: "The number of record messages to emit from this connector.\
\ Min 1. Max 100 billion."
title: "Max Record"
type: "integer"
sourceType:
title: "datagen"
const: "datagen"
enum:
- "datagen"
order: 0
type: "string"
required:
- "max_records"
- "flavor"
- "sourceType"
title: "Data Gen Source Configuration Specification"
type: "object"
source-datagen-update:
properties:
concurrency:
description: "Maximum number of concurrent data generators. Leave empty\
\ to let Airbyte optimize performance."
title: "Max Concurrency"
type: "integer"
flavor:
default: "increment"
description: "Different patterns for generating data"
display_type: "radio"
oneOf:
- additionalProperties: true
description: "Generates incrementally increasing numerical data for the\
\ source."
properties:
data_type:
default: "increment"
enum:
- "increment"
type: "string"
required:
- "data_type"
title: "Incremental"
type: "object"
- additionalProperties: true
description: "Generates one column of each Airbyte data type."
properties:
data_type:
default: "types"
enum:
- "types"
type: "string"
required:
- "data_type"
title: "All Types"
type: "object"
title: "Data Generation Type"
type: "object"
max_records:
default: "100"
description: "The number of record messages to emit from this connector.\
\ Min 1. Max 100 billion."
title: "Max Record"
type: "integer"
required:
- "max_records"
- "flavor"
title: "Data Gen Source Configuration Specification"
type: "object"
source-google-classroom:
properties:
client_id:
airbyte_secret: true
name: "client_id"
order: 0
title: "OAuth Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_refresh_token:
airbyte_secret: true
order: 2
title: "Refresh token"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
name: "client_secret"
order: 1
title: "OAuth Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "google-classroom"
const: "google-classroom"
enum:
- "google-classroom"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "client_refresh_token"
- "sourceType"
type: "object"
source-google-classroom-update:
properties:
client_id:
airbyte_secret: true
name: "client_id"
order: 0
title: "OAuth Client ID"
type: "string"
client_refresh_token:
airbyte_secret: true
order: 2
title: "Refresh token"
type: "string"
client_secret:
airbyte_secret: true
name: "client_secret"
order: 1
title: "OAuth Client Secret"
type: "string"
required:
- "client_id"
- "client_secret"
- "client_refresh_token"
type: "object"
source-klaviyo:
properties:
api_key:
airbyte_secret: true
description: "Klaviyo API Key. See our docs if you need help finding this key."
order: 0
title: "Api Key"
type: "string"
x-speakeasy-param-sensitive: true
disable_fetching_predictive_analytics:
description: "Certain streams like the profiles stream can retrieve predictive\
\ analytics data from Klaviyo's API. However, at high volume, this can\
\ lead to service availability issues on the API which can be improved\
\ by not fetching this field. WARNING: Enabling this setting will stop\
\ the \"predictive_analytics\" column from being populated in your downstream\
\ destination."
order: 2
title: "Disable Fetching Predictive Analytics"
type: "boolean"
num_workers:
default: 10
description: "The number of worker threads to use for the sync. The performance\
\ upper boundary is based on the limit of your Klaviyo plan. More info\
\ about the rate limit plan tiers can be found on Klaviyo's API docs."
examples:
- 1
- 2
- 3
maximum: 50
minimum: 1
order: 3
title: "Number of concurrent threads"
type: "integer"
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."
examples:
- "2017-01-25T00:00:00Z"
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
sourceType:
title: "klaviyo"
const: "klaviyo"
enum:
- "klaviyo"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-klaviyo-update:
properties:
api_key:
airbyte_secret: true
description: "Klaviyo API Key. See our docs if you need help finding this key."
order: 0
title: "Api Key"
type: "string"
disable_fetching_predictive_analytics:
description: "Certain streams like the profiles stream can retrieve predictive\
\ analytics data from Klaviyo's API. However, at high volume, this can\
\ lead to service availability issues on the API which can be improved\
\ by not fetching this field. WARNING: Enabling this setting will stop\
\ the \"predictive_analytics\" column from being populated in your downstream\
\ destination."
order: 2
title: "Disable Fetching Predictive Analytics"
type: "boolean"
num_workers:
default: 10
description: "The number of worker threads to use for the sync. The performance\
\ upper boundary is based on the limit of your Klaviyo plan. More info\
\ about the rate limit plan tiers can be found on Klaviyo's API docs."
examples:
- 1
- 2
- 3
maximum: 50
minimum: 1
order: 3
title: "Number of concurrent threads"
type: "integer"
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."
examples:
- "2017-01-25T00:00:00Z"
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
required:
- "api_key"
type: "object"
source-datadog:
properties:
api_key:
airbyte_secret: true
description: "Datadog API key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
application_key:
airbyte_secret: true
description: "Datadog application key"
order: 1
title: "Application Key"
type: "string"
x-speakeasy-param-sensitive: true
end_date:
description: "UTC date and time in the format 2017-01-25T00:00:00Z. Data\
\ after this date will not be replicated. An empty value will represent\
\ the current datetime for each execution. This just applies to Incremental\
\ syncs."
examples:
- "2022-10-01T00:00:00Z"
order: 5
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "End date"
type: "string"
max_records_per_request:
default: 5000
description: "Maximum number of records to collect per request."
maximum: 5000
minimum: 1
order: 6
title: "Max records per requests"
type: "integer"
queries:
default: []
description: "List of queries to be run and used as inputs."
items:
properties:
data_source:
description: "A data source that is powered by the platform."
enum:
- "metrics"
- "cloud_cost"
- "logs"
- "rum"
order: 2
title: "Data Source"
type: "string"
name:
description: "The variable name for use in queries."
order: 1
title: "Query Name"
type: "string"
query:
description: "A classic query string."
order: 3
title: "Query"
type: "string"
required:
- "name"
- "data_source"
- "query"
type: "object"
order: 7
title: "Queries"
type: "array"
query:
description: "The search query. This just applies to Incremental syncs.\
\ If empty, it'll collect all logs."
order: 2
title: "Query"
type: "string"
site:
default: "datadoghq.com"
description: "The site where Datadog data resides in."
enum:
- "datadoghq.com"
- "us3.datadoghq.com"
- "us5.datadoghq.com"
- "datadoghq.eu"
- "ddog-gov.com"
order: 4
title: "Site"
type: "string"
start_date:
default: "2023-12-01T00:00:00Z"
description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\
\ data before this date will not be replicated. This just applies to Incremental\
\ syncs."
examples:
- "2022-10-01T00:00:00Z"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "datadog"
const: "datadog"
enum:
- "datadog"
order: 0
type: "string"
required:
- "api_key"
- "application_key"
- "sourceType"
type: "object"
source-datadog-update:
properties:
api_key:
airbyte_secret: true
description: "Datadog API key"
order: 0
title: "API Key"
type: "string"
application_key:
airbyte_secret: true
description: "Datadog application key"
order: 1
title: "Application Key"
type: "string"
end_date:
description: "UTC date and time in the format 2017-01-25T00:00:00Z. Data\
\ after this date will not be replicated. An empty value will represent\
\ the current datetime for each execution. This just applies to Incremental\
\ syncs."
examples:
- "2022-10-01T00:00:00Z"
order: 5
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "End date"
type: "string"
max_records_per_request:
default: 5000
description: "Maximum number of records to collect per request."
maximum: 5000
minimum: 1
order: 6
title: "Max records per requests"
type: "integer"
queries:
default: []
description: "List of queries to be run and used as inputs."
items:
properties:
data_source:
description: "A data source that is powered by the platform."
enum:
- "metrics"
- "cloud_cost"
- "logs"
- "rum"
order: 2
title: "Data Source"
type: "string"
name:
description: "The variable name for use in queries."
order: 1
title: "Query Name"
type: "string"
query:
description: "A classic query string."
order: 3
title: "Query"
type: "string"
required:
- "name"
- "data_source"
- "query"
type: "object"
order: 7
title: "Queries"
type: "array"
query:
description: "The search query. This just applies to Incremental syncs.\
\ If empty, it'll collect all logs."
order: 2
title: "Query"
type: "string"
site:
default: "datadoghq.com"
description: "The site where Datadog data resides in."
enum:
- "datadoghq.com"
- "us3.datadoghq.com"
- "us5.datadoghq.com"
- "datadoghq.eu"
- "ddog-gov.com"
order: 4
title: "Site"
type: "string"
start_date:
default: "2023-12-01T00:00:00Z"
description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\
\ data before this date will not be replicated. This just applies to Incremental\
\ syncs."
examples:
- "2022-10-01T00:00:00Z"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "application_key"
type: "object"
source-activecampaign:
properties:
account_username:
description: "Account Username"
order: 1
type: "string"
api_key:
airbyte_secret: true
description: "API Key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "activecampaign"
const: "activecampaign"
enum:
- "activecampaign"
order: 0
type: "string"
required:
- "api_key"
- "account_username"
- "sourceType"
type: "object"
source-activecampaign-update:
properties:
account_username:
description: "Account Username"
order: 1
type: "string"
api_key:
airbyte_secret: true
description: "API Key"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
- "account_username"
type: "object"
source-luma:
properties:
api_key:
airbyte_secret: true
description: "Get your API key on lu.ma Calendars dashboard → Settings."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "luma"
const: "luma"
enum:
- "luma"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-luma-update:
properties:
api_key:
airbyte_secret: true
description: "Get your API key on lu.ma Calendars dashboard → Settings."
name: "api_key"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-quickbooks:
properties:
access_token:
airbyte_secret: true
description: "Access token for making authenticated requests."
order: 3
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "oauth2.0"
order: 1
type: "string"
enum:
- "oauth2.0"
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."
order: 2
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
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."
order: 4
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
realm_id:
airbyte_secret: true
description: "Labeled Company ID. The Make API Calls panel is populated\
\ with the realm id and the current access token."
order: 0
title: "Realm ID"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "A token used when refreshing the access token."
order: 5
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
sandbox:
default: false
description: "Determines whether to use the sandbox or production environment."
order: 8
title: "Sandbox"
type: "boolean"
start_date:
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."
examples:
- "2021-03-20T00:00:00Z"
format: "date-time"
order: 7
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
token_expiry_date:
description: "The date-time when the access token should be refreshed."
format: "date-time"
order: 6
title: "Token Expiry Date"
type: "string"
sourceType:
title: "quickbooks"
const: "quickbooks"
enum:
- "quickbooks"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "access_token"
- "token_expiry_date"
- "realm_id"
- "start_date"
- "sandbox"
- "sourceType"
type: "object"
source-quickbooks-update:
properties:
access_token:
airbyte_secret: true
description: "Access token for making authenticated requests."
order: 3
title: "Access Token"
type: "string"
auth_type:
const: "oauth2.0"
order: 1
type: "string"
enum:
- "oauth2.0"
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."
order: 2
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
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."
order: 4
title: "Client Secret"
type: "string"
realm_id:
airbyte_secret: true
description: "Labeled Company ID. The Make API Calls panel is populated\
\ with the realm id and the current access token."
order: 0
title: "Realm ID"
type: "string"
refresh_token:
airbyte_secret: true
description: "A token used when refreshing the access token."
order: 5
title: "Refresh Token"
type: "string"
sandbox:
default: false
description: "Determines whether to use the sandbox or production environment."
order: 8
title: "Sandbox"
type: "boolean"
start_date:
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."
examples:
- "2021-03-20T00:00:00Z"
format: "date-time"
order: 7
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
token_expiry_date:
description: "The date-time when the access token should be refreshed."
format: "date-time"
order: 6
title: "Token Expiry Date"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "access_token"
- "token_expiry_date"
- "realm_id"
- "start_date"
- "sandbox"
type: "object"
source-flowlu:
properties:
api_key:
airbyte_secret: true
description: "The API key to use for authentication"
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
company:
name: "company"
order: 1
title: "Company"
type: "string"
sourceType:
title: "flowlu"
const: "flowlu"
enum:
- "flowlu"
order: 0
type: "string"
required:
- "api_key"
- "company"
- "sourceType"
type: "object"
source-flowlu-update:
properties:
api_key:
airbyte_secret: true
description: "The API key to use for authentication"
name: "api_key"
order: 0
title: "API Key"
type: "string"
company:
name: "company"
order: 1
title: "Company"
type: "string"
required:
- "api_key"
- "company"
type: "object"
source-beamer:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "beamer"
const: "beamer"
enum:
- "beamer"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-beamer-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-wikipedia-pageviews:
properties:
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"
order: 0
title: "Access"
type: "string"
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"
order: 1
title: "Agent"
type: "string"
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"
order: 2
title: "Article"
type: "string"
country:
description: "The ISO 3166-1 alpha-2 code of a country for which to retrieve\
\ top articles."
examples:
- "FR"
- "IN"
order: 3
title: "Country"
type: "string"
end:
description: "The date of the last day to include, in YYYYMMDD or YYYYMMDDHH\
\ format."
order: 4
title: "End"
type: "string"
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"
order: 5
title: "Project"
type: "string"
start:
description: "The date of the first day to include, in YYYYMMDD or YYYYMMDDHH\
\ format. Also serves as the date to retrieve data for the top articles."
order: 6
title: "Start"
type: "string"
sourceType:
title: "wikipedia-pageviews"
const: "wikipedia-pageviews"
enum:
- "wikipedia-pageviews"
order: 0
type: "string"
required:
- "access"
- "agent"
- "article"
- "country"
- "end"
- "project"
- "start"
- "sourceType"
type: "object"
source-wikipedia-pageviews-update:
properties:
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"
order: 0
title: "Access"
type: "string"
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"
order: 1
title: "Agent"
type: "string"
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"
order: 2
title: "Article"
type: "string"
country:
description: "The ISO 3166-1 alpha-2 code of a country for which to retrieve\
\ top articles."
examples:
- "FR"
- "IN"
order: 3
title: "Country"
type: "string"
end:
description: "The date of the last day to include, in YYYYMMDD or YYYYMMDDHH\
\ format."
order: 4
title: "End"
type: "string"
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"
order: 5
title: "Project"
type: "string"
start:
description: "The date of the first day to include, in YYYYMMDD or YYYYMMDDHH\
\ format. Also serves as the date to retrieve data for the top articles."
order: 6
title: "Start"
type: "string"
required:
- "access"
- "agent"
- "article"
- "country"
- "end"
- "project"
- "start"
type: "object"
source-incident-io:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it at https://app.incident.io/settings/api-keys"
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "incident-io"
const: "incident-io"
enum:
- "incident-io"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-incident-io-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it at https://app.incident.io/settings/api-keys"
name: "api_key"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-freshservice:
properties:
api_key:
airbyte_secret: true
description: "Freshservice API Key. See here. The key is case sensitive."
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
domain_name:
description: "The name of your Freshservice domain"
examples:
- "mydomain.freshservice.com"
order: 1
title: "Domain Name"
type: "string"
start_date:
description: "UTC date and time in the format 2020-10-01T00:00:00Z. Any\
\ data before this date will not be replicated."
examples:
- "2020-10-01T00:00:00Z"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
sourceType:
title: "freshservice"
const: "freshservice"
enum:
- "freshservice"
order: 0
type: "string"
required:
- "api_key"
- "domain_name"
- "start_date"
- "sourceType"
type: "object"
source-freshservice-update:
properties:
api_key:
airbyte_secret: true
description: "Freshservice API Key. See here. The key is case sensitive."
order: 0
title: "API Key"
type: "string"
domain_name:
description: "The name of your Freshservice domain"
examples:
- "mydomain.freshservice.com"
order: 1
title: "Domain Name"
type: "string"
start_date:
description: "UTC date and time in the format 2020-10-01T00:00:00Z. Any\
\ data before this date will not be replicated."
examples:
- "2020-10-01T00:00:00Z"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
required:
- "api_key"
- "domain_name"
- "start_date"
type: "object"
source-care-quality-commission:
properties:
api_key:
airbyte_secret: true
description: "Your CQC Primary Key. See https://www.cqc.org.uk/about-us/transparency/using-cqc-data#api\
\ for steps to generate one."
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "care-quality-commission"
const: "care-quality-commission"
enum:
- "care-quality-commission"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-care-quality-commission-update:
properties:
api_key:
airbyte_secret: true
description: "Your CQC Primary Key. See https://www.cqc.org.uk/about-us/transparency/using-cqc-data#api\
\ for steps to generate one."
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-outbrain-amplify:
properties:
conversion_count:
description: "The definition of conversion count in reports. See the docs."
enum:
- "click/view_time"
- "conversion_time"
order: 5
title: "Definition of conversion count in reports."
type: "string"
credentials:
default: {}
description: "Credentials for making authenticated requests requires either\
\ username/password or access_token."
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests."
type: "string"
x-speakeasy-param-sensitive: true
type:
const: "access_token"
title: "Access token is required for authentication requests."
type: "string"
enum:
- "access_token"
required:
- "type"
- "access_token"
title: "Access token"
type: "object"
- properties:
password:
airbyte_secret: true
description: "Add Password for authentication."
type: "string"
x-speakeasy-param-sensitive: true
type:
const: "username_password"
title: "Both username and password is required for authentication\
\ request."
type: "string"
enum:
- "username_password"
username:
description: "Add Username for authentication."
type: "string"
required:
- "type"
- "username"
- "password"
title: "Username Password"
type: "object"
order: 0
title: "Authentication Method"
type: "object"
end_date:
description: "Date in the format YYYY-MM-DD."
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
type: "string"
geo_location_breakdown:
description: "The granularity used for geo location data in reports."
enum:
- "country"
- "region"
- "subregion"
order: 2
title: "Granularity for geo-location region."
type: "string"
report_granularity:
description: "The granularity used for periodic data in reports. See the docs."
enum:
- "daily"
- "weekly"
- "monthly"
order: 1
title: "Granularity for periodic reports."
type: "string"
start_date:
description: "Date in the format YYYY-MM-DD eg. 2017-01-25. Any data before\
\ this date will not be replicated."
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
type: "string"
sourceType:
title: "outbrain-amplify"
const: "outbrain-amplify"
enum:
- "outbrain-amplify"
order: 0
type: "string"
required:
- "credentials"
- "start_date"
- "sourceType"
title: "Outbrain Amplify Spec"
type: "object"
source-outbrain-amplify-update:
properties:
conversion_count:
description: "The definition of conversion count in reports. See the docs."
enum:
- "click/view_time"
- "conversion_time"
order: 5
title: "Definition of conversion count in reports."
type: "string"
credentials:
default: {}
description: "Credentials for making authenticated requests requires either\
\ username/password or access_token."
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests."
type: "string"
type:
const: "access_token"
title: "Access token is required for authentication requests."
type: "string"
enum:
- "access_token"
required:
- "type"
- "access_token"
title: "Access token"
type: "object"
- properties:
password:
airbyte_secret: true
description: "Add Password for authentication."
type: "string"
type:
const: "username_password"
title: "Both username and password is required for authentication\
\ request."
type: "string"
enum:
- "username_password"
username:
description: "Add Username for authentication."
type: "string"
required:
- "type"
- "username"
- "password"
title: "Username Password"
type: "object"
order: 0
title: "Authentication Method"
type: "object"
end_date:
description: "Date in the format YYYY-MM-DD."
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
type: "string"
geo_location_breakdown:
description: "The granularity used for geo location data in reports."
enum:
- "country"
- "region"
- "subregion"
order: 2
title: "Granularity for geo-location region."
type: "string"
report_granularity:
description: "The granularity used for periodic data in reports. See the docs."
enum:
- "daily"
- "weekly"
- "monthly"
order: 1
title: "Granularity for periodic reports."
type: "string"
start_date:
description: "Date in the format YYYY-MM-DD eg. 2017-01-25. Any data before\
\ this date will not be replicated."
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
type: "string"
required:
- "credentials"
- "start_date"
title: "Outbrain Amplify Spec"
type: "object"
source-uppromote:
properties:
api_key:
airbyte_secret: true
description: "For developing your own custom integration with UpPromote,\
\ you can create an API key. This is available from Professional plan.\
\ Simply go to Settings > Integration > API > Create API Key. "
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "Data before this date will not be fetched."
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "uppromote"
const: "uppromote"
enum:
- "uppromote"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-uppromote-update:
properties:
api_key:
airbyte_secret: true
description: "For developing your own custom integration with UpPromote,\
\ you can create an API key. This is available from Professional plan.\
\ Simply go to Settings > Integration > API > Create API Key. "
order: 0
title: "API Key"
type: "string"
start_date:
description: "Data before this date will not be fetched."
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-mailosaur:
properties:
password:
airbyte_secret: true
always_show: true
description: "Enter your api key here"
order: 1
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
username:
description: "Enter \"api\" here"
order: 0
title: "Username"
type: "string"
sourceType:
title: "mailosaur"
const: "mailosaur"
enum:
- "mailosaur"
order: 0
type: "string"
required:
- "username"
- "sourceType"
type: "object"
source-mailosaur-update:
properties:
password:
airbyte_secret: true
always_show: true
description: "Enter your api key here"
order: 1
title: "Password"
type: "string"
username:
description: "Enter \"api\" here"
order: 0
title: "Username"
type: "string"
required:
- "username"
type: "object"
source-buildkite:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "buildkite"
const: "buildkite"
enum:
- "buildkite"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-buildkite-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-justcall:
properties:
api_key_2:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "justcall"
const: "justcall"
enum:
- "justcall"
order: 0
type: "string"
required:
- "api_key_2"
- "start_date"
- "sourceType"
type: "object"
source-justcall-update:
properties:
api_key_2:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key_2"
- "start_date"
type: "object"
source-gnews:
properties:
api_key:
airbyte_secret: true
description: "API Key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
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."
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"
order: 3
title: "Country"
type: "string"
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)"
examples:
- "2022-08-21 16:27:09"
order: 7
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$"
title: "End Date"
type: "string"
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."
items:
enum:
- "title"
- "description"
- "content"
type: "string"
order: 4
title: "In"
type: "array"
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."
enum:
- "ar"
- "zh"
- "nl"
- "en"
- "fr"
- "de"
- "el"
- "he"
- "hi"
- "it"
- "ja"
- "ml"
- "mr"
- "no"
- "pt"
- "ro"
- "ru"
- "es"
- "sv"
- "ta"
- "te"
- "uk"
order: 2
title: "Language"
type: "string"
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"
items:
enum:
- "title"
- "description"
- "content"
type: "string"
order: 5
title: "Nullable"
type: "array"
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\nsequence.\
\ \n For example the query: \"Apple iPhone\" will return articles matching\
\ at\nleast once this sequence of keywords. - 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\npossible to replace the space character \n by\
\ AND to obtain the same result. For example the query: Apple Microsoft\n\
is equivalent to Apple AND Microsoft - 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\nthe AND operator. For example the \n query: Apple OR Microsoft\
\ will return all articles matching the keyword\nApple 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\nor phrase surrounded by quotes.\n For example the query:\
\ Apple NOT iPhone will return all articles matching\nthe 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)"
order: 1
title: "Query"
type: "string"
sortby:
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\npublication\
\ date are returned first\n - relevance = sort by best match to keywords,\
\ the articles with the best\nmatch are returned first"
enum:
- "publishedAt"
- "relevance"
order: 8
title: "Sort By"
type: "string"
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)"
examples:
- "2022-08-21 16:27:09"
order: 6
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$"
title: "Start Date"
type: "string"
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\nsequence.\
\ \n For example the query: \"Apple iPhone\" will return articles matching\
\ at\nleast once this sequence of keywords. - 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\npossible to replace the space character \n by\
\ AND to obtain the same result. For example the query: Apple Microsoft\n\
is equivalent to Apple AND Microsoft - 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\nthe AND operator. For example the \n query: Apple OR Microsoft\
\ will return all articles matching the keyword\nApple 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\nor phrase surrounded by quotes.\n For example the query:\
\ Apple NOT iPhone will return all articles matching\nthe 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)"
order: 9
title: "Top Headlines Query"
type: "string"
top_headlines_topic:
description: "This parameter allows you to change the category for the request."
enum:
- "breaking-news"
- "world"
- "nation"
- "business"
- "technology"
- "entertainment"
- "sports"
- "science"
- "health"
order: 10
title: "Top Headlines Topic"
type: "string"
sourceType:
title: "gnews"
const: "gnews"
enum:
- "gnews"
order: 0
type: "string"
required:
- "api_key"
- "query"
- "sourceType"
title: "Gnews Spec"
type: "object"
source-gnews-update:
properties:
api_key:
airbyte_secret: true
description: "API Key"
order: 0
title: "API Key"
type: "string"
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."
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"
order: 3
title: "Country"
type: "string"
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)"
examples:
- "2022-08-21 16:27:09"
order: 7
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$"
title: "End Date"
type: "string"
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."
items:
enum:
- "title"
- "description"
- "content"
type: "string"
order: 4
title: "In"
type: "array"
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."
enum:
- "ar"
- "zh"
- "nl"
- "en"
- "fr"
- "de"
- "el"
- "he"
- "hi"
- "it"
- "ja"
- "ml"
- "mr"
- "no"
- "pt"
- "ro"
- "ru"
- "es"
- "sv"
- "ta"
- "te"
- "uk"
order: 2
title: "Language"
type: "string"
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"
items:
enum:
- "title"
- "description"
- "content"
type: "string"
order: 5
title: "Nullable"
type: "array"
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\nsequence.\
\ \n For example the query: \"Apple iPhone\" will return articles matching\
\ at\nleast once this sequence of keywords. - 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\npossible to replace the space character \n by\
\ AND to obtain the same result. For example the query: Apple Microsoft\n\
is equivalent to Apple AND Microsoft - 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\nthe AND operator. For example the \n query: Apple OR Microsoft\
\ will return all articles matching the keyword\nApple 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\nor phrase surrounded by quotes.\n For example the query:\
\ Apple NOT iPhone will return all articles matching\nthe 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)"
order: 1
title: "Query"
type: "string"
sortby:
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\npublication\
\ date are returned first\n - relevance = sort by best match to keywords,\
\ the articles with the best\nmatch are returned first"
enum:
- "publishedAt"
- "relevance"
order: 8
title: "Sort By"
type: "string"
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)"
examples:
- "2022-08-21 16:27:09"
order: 6
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$"
title: "Start Date"
type: "string"
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\nsequence.\
\ \n For example the query: \"Apple iPhone\" will return articles matching\
\ at\nleast once this sequence of keywords. - 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\npossible to replace the space character \n by\
\ AND to obtain the same result. For example the query: Apple Microsoft\n\
is equivalent to Apple AND Microsoft - 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\nthe AND operator. For example the \n query: Apple OR Microsoft\
\ will return all articles matching the keyword\nApple 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\nor phrase surrounded by quotes.\n For example the query:\
\ Apple NOT iPhone will return all articles matching\nthe 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)"
order: 9
title: "Top Headlines Query"
type: "string"
top_headlines_topic:
description: "This parameter allows you to change the category for the request."
enum:
- "breaking-news"
- "world"
- "nation"
- "business"
- "technology"
- "entertainment"
- "sports"
- "science"
- "health"
order: 10
title: "Top Headlines Topic"
type: "string"
required:
- "api_key"
- "query"
title: "Gnews Spec"
type: "object"
source-workable:
properties:
account_subdomain:
description: "Your Workable account subdomain, e.g. https://your_account_subdomain.workable.com."
order: 1
title: "Account Subdomain"
type: "string"
api_key:
airbyte_secret: true
description: "Your Workable API Key. See here."
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "Get data that was created since this date (format: YYYYMMDDTHHMMSSZ)."
examples:
- "20150708T115616Z"
- "20221115T225616Z"
order: 2
pattern: "^[0-9]{8}T[0-9]{6}Z$"
title: "Start Date"
type: "string"
sourceType:
title: "workable"
const: "workable"
enum:
- "workable"
order: 0
type: "string"
required:
- "api_key"
- "account_subdomain"
- "start_date"
- "sourceType"
type: "object"
source-workable-update:
properties:
account_subdomain:
description: "Your Workable account subdomain, e.g. https://your_account_subdomain.workable.com."
order: 1
title: "Account Subdomain"
type: "string"
api_key:
airbyte_secret: true
description: "Your Workable API Key. See here."
order: 0
title: "API Key"
type: "string"
start_date:
description: "Get data that was created since this date (format: YYYYMMDDTHHMMSSZ)."
examples:
- "20150708T115616Z"
- "20221115T225616Z"
order: 2
pattern: "^[0-9]{8}T[0-9]{6}Z$"
title: "Start Date"
type: "string"
required:
- "api_key"
- "account_subdomain"
- "start_date"
type: "object"
source-kyve:
properties:
pool_ids:
description: "The IDs of the KYVE storage pool you want to archive. (Comma\
\ separated)"
examples:
- "0"
- "0,1"
order: 0
title: "Pool-IDs"
type: "string"
start_ids:
description: "The start-id defines, from which bundle id the pipeline should\
\ start to extract the data. (Comma separated)"
examples:
- "0"
- "0,0"
order: 1
title: "Bundle-Start-IDs"
type: "string"
url_base:
default: "https://api.kyve.network"
description: "URL to the KYVE Chain API."
examples:
- "https://api.kaon.kyve.network/"
- "https://api.korellia.kyve.network/"
order: 2
title: "KYVE-API URL Base"
type: "string"
sourceType:
title: "kyve"
const: "kyve"
enum:
- "kyve"
order: 0
type: "string"
required:
- "pool_ids"
- "start_ids"
- "url_base"
- "sourceType"
title: "KYVE Spec"
type: "object"
source-kyve-update:
properties:
pool_ids:
description: "The IDs of the KYVE storage pool you want to archive. (Comma\
\ separated)"
examples:
- "0"
- "0,1"
order: 0
title: "Pool-IDs"
type: "string"
start_ids:
description: "The start-id defines, from which bundle id the pipeline should\
\ start to extract the data. (Comma separated)"
examples:
- "0"
- "0,0"
order: 1
title: "Bundle-Start-IDs"
type: "string"
url_base:
default: "https://api.kyve.network"
description: "URL to the KYVE Chain API."
examples:
- "https://api.kaon.kyve.network/"
- "https://api.korellia.kyve.network/"
order: 2
title: "KYVE-API URL Base"
type: "string"
required:
- "pool_ids"
- "start_ids"
- "url_base"
title: "KYVE Spec"
type: "object"
source-capsule-crm:
properties:
bearer_token:
airbyte_secret: true
description: "Bearer token to authenticate API requests. Generate it from\
\ the 'My Preferences' > 'API Authentication Tokens' page in your Capsule\
\ account."
name: "bearer_token"
order: 0
title: "Bearer Token"
type: "string"
x-speakeasy-param-sensitive: true
entity:
enum:
- "parties"
- "opportunities"
- "kases"
order: 2
title: "Entity"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "capsule-crm"
const: "capsule-crm"
enum:
- "capsule-crm"
order: 0
type: "string"
required:
- "bearer_token"
- "start_date"
- "entity"
- "sourceType"
type: "object"
source-capsule-crm-update:
properties:
bearer_token:
airbyte_secret: true
description: "Bearer token to authenticate API requests. Generate it from\
\ the 'My Preferences' > 'API Authentication Tokens' page in your Capsule\
\ account."
name: "bearer_token"
order: 0
title: "Bearer Token"
type: "string"
entity:
enum:
- "parties"
- "opportunities"
- "kases"
order: 2
title: "Entity"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "bearer_token"
- "start_date"
- "entity"
type: "object"
source-couchbase:
properties:
bucket:
description: "The name of the bucket to sync data from"
order: 3
title: "Bucket"
type: "string"
connection_string:
description: "The connection string for the Couchbase server (e.g., couchbase://localhost\
\ or couchbases://example.com)"
order: 0
title: "Connection String"
type: "string"
password:
airbyte_secret: true
description: "The password to use for authentication"
order: 2
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "The date from which you'd like to replicate data for incremental\
\ streams, in the format YYYY-MM-DDT00:00:00Z. All data generated after\
\ this date will be replicated. If not set, all data will be replicated."
format: "date-time"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
username:
description: "The username to use for authentication"
order: 1
title: "Username"
type: "string"
sourceType:
title: "couchbase"
const: "couchbase"
enum:
- "couchbase"
order: 0
type: "string"
required:
- "connection_string"
- "username"
- "password"
- "bucket"
- "sourceType"
title: "Couchbase Source Spec"
type: "object"
source-couchbase-update:
properties:
bucket:
description: "The name of the bucket to sync data from"
order: 3
title: "Bucket"
type: "string"
connection_string:
description: "The connection string for the Couchbase server (e.g., couchbase://localhost\
\ or couchbases://example.com)"
order: 0
title: "Connection String"
type: "string"
password:
airbyte_secret: true
description: "The password to use for authentication"
order: 2
title: "Password"
type: "string"
start_date:
description: "The date from which you'd like to replicate data for incremental\
\ streams, in the format YYYY-MM-DDT00:00:00Z. All data generated after\
\ this date will be replicated. If not set, all data will be replicated."
format: "date-time"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
username:
description: "The username to use for authentication"
order: 1
title: "Username"
type: "string"
required:
- "connection_string"
- "username"
- "password"
- "bucket"
title: "Couchbase Source Spec"
type: "object"
source-dwolla:
properties:
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
x-speakeasy-param-sensitive: true
environment:
default: "api"
description: "The environment for the Dwolla API, either 'api-sandbox' or\
\ 'api'."
enum:
- "api"
- "api-sandbox"
order: 2
title: "Environment"
type: "string"
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "dwolla"
const: "dwolla"
enum:
- "dwolla"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "environment"
- "start_date"
- "sourceType"
type: "object"
source-dwolla-update:
properties:
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
environment:
default: "api"
description: "The environment for the Dwolla API, either 'api-sandbox' or\
\ 'api'."
enum:
- "api"
- "api-sandbox"
order: 2
title: "Environment"
type: "string"
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "client_id"
- "client_secret"
- "environment"
- "start_date"
type: "object"
source-sigma-computing:
properties:
base_url:
description: "The base url of your sigma organization"
order: 5
title: "Base URL"
type: "string"
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_refresh_token:
airbyte_secret: true
order: 2
title: "Refresh token"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
x-speakeasy-param-sensitive: true
oauth_access_token:
airbyte_secret: true
description: "The current access token. This field might be overridden by\
\ the connector based on the token refresh endpoint response."
order: 3
title: "Access token"
type: "string"
x-speakeasy-param-sensitive: true
oauth_token_expiry_date:
description: "The date the current access token expires in. This field might\
\ be overridden by the connector based on the token refresh endpoint response."
format: "date-time"
order: 4
title: "Token expiry date"
type: "string"
sourceType:
title: "sigma-computing"
const: "sigma-computing"
enum:
- "sigma-computing"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "client_refresh_token"
- "base_url"
- "sourceType"
type: "object"
source-sigma-computing-update:
properties:
base_url:
description: "The base url of your sigma organization"
order: 5
title: "Base URL"
type: "string"
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
client_refresh_token:
airbyte_secret: true
order: 2
title: "Refresh token"
type: "string"
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
oauth_access_token:
airbyte_secret: true
description: "The current access token. This field might be overridden by\
\ the connector based on the token refresh endpoint response."
order: 3
title: "Access token"
type: "string"
oauth_token_expiry_date:
description: "The date the current access token expires in. This field might\
\ be overridden by the connector based on the token refresh endpoint response."
format: "date-time"
order: 4
title: "Token expiry date"
type: "string"
required:
- "client_id"
- "client_secret"
- "client_refresh_token"
- "base_url"
type: "object"
source-imagga:
properties:
api_key:
airbyte_secret: true
description: "Your Imagga API key, available in your Imagga dashboard. Could\
\ be found at `https://imagga.com/profile/dashboard`"
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
api_secret:
airbyte_secret: true
description: "Your Imagga API secret, available in your Imagga dashboard.\
\ Could be found at `https://imagga.com/profile/dashboard`"
name: "api_secret"
order: 1
title: "API Secret"
type: "string"
x-speakeasy-param-sensitive: true
img_for_detection:
default: "https://imagga.com/static/images/categorization/child-476506_640.jpg"
description: "An image for detection endpoints"
order: 2
title: "Image URL for detection endpoints"
type: "string"
sourceType:
title: "imagga"
const: "imagga"
enum:
- "imagga"
order: 0
type: "string"
required:
- "api_key"
- "api_secret"
- "sourceType"
type: "object"
source-imagga-update:
properties:
api_key:
airbyte_secret: true
description: "Your Imagga API key, available in your Imagga dashboard. Could\
\ be found at `https://imagga.com/profile/dashboard`"
name: "api_key"
order: 0
title: "API Key"
type: "string"
api_secret:
airbyte_secret: true
description: "Your Imagga API secret, available in your Imagga dashboard.\
\ Could be found at `https://imagga.com/profile/dashboard`"
name: "api_secret"
order: 1
title: "API Secret"
type: "string"
img_for_detection:
default: "https://imagga.com/static/images/categorization/child-476506_640.jpg"
description: "An image for detection endpoints"
order: 2
title: "Image URL for detection endpoints"
type: "string"
required:
- "api_key"
- "api_secret"
type: "object"
source-yousign:
properties:
api_key:
airbyte_secret: true
description: "API key or access token"
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
limit:
default: "10"
description: "Limit for each response objects"
order: 2
title: "Limit"
type: "string"
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
subdomain:
default: "api"
description: "The subdomain for the Yousign API environment, such as 'sandbox'\
\ or 'api'."
enum:
- "api-sandbox"
- "api"
order: 1
title: "Subdomain"
type: "string"
sourceType:
title: "yousign"
const: "yousign"
enum:
- "yousign"
order: 0
type: "string"
required:
- "api_key"
- "subdomain"
- "limit"
- "start_date"
- "sourceType"
type: "object"
source-yousign-update:
properties:
api_key:
airbyte_secret: true
description: "API key or access token"
name: "api_key"
order: 0
title: "API Key"
type: "string"
limit:
default: "10"
description: "Limit for each response objects"
order: 2
title: "Limit"
type: "string"
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
subdomain:
default: "api"
description: "The subdomain for the Yousign API environment, such as 'sandbox'\
\ or 'api'."
enum:
- "api-sandbox"
- "api"
order: 1
title: "Subdomain"
type: "string"
required:
- "api_key"
- "subdomain"
- "limit"
- "start_date"
type: "object"
source-piwik:
properties:
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
x-speakeasy-param-sensitive: true
organization_id:
description: "The organization id appearing at URL of your piwik website"
order: 2
title: "Organization ID"
type: "string"
sourceType:
title: "piwik"
const: "piwik"
enum:
- "piwik"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "organization_id"
- "sourceType"
type: "object"
source-piwik-update:
properties:
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
organization_id:
description: "The organization id appearing at URL of your piwik website"
order: 2
title: "Organization ID"
type: "string"
required:
- "client_id"
- "client_secret"
- "organization_id"
type: "object"
source-shopify:
properties:
bulk_window_in_days:
default: 30
description: "Defines what would be a date range per single BULK Job"
title: "GraphQL BULK Date Range in Days"
type: "integer"
credentials:
description: "The authorization method to use to retrieve data from Shopify"
oneOf:
- description: "OAuth2.0"
properties:
access_token:
airbyte_secret: true
description: "The Access Token for making authenticated requests."
order: 3
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_method:
const: "oauth2.0"
order: 0
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The Client ID of the Shopify developer application."
order: 1
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The Client Secret of the Shopify developer application."
order: 2
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_method"
title: "OAuth2.0"
type: "object"
- description: "API Password Auth"
properties:
api_password:
airbyte_secret: true
description: "The API Password for your private application in the\
\ `Shopify` store."
order: 1
title: "API Password"
type: "string"
x-speakeasy-param-sensitive: true
auth_method:
const: "api_password"
order: 0
type: "string"
enum:
- "api_password"
required:
- "auth_method"
- "api_password"
title: "API Password"
type: "object"
order: 2
title: "Shopify Authorization Method"
type: "object"
fetch_transactions_user_id:
default: false
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."
title: "Add `user_id` to Transactions (slower)"
type: "boolean"
job_checkpoint_interval:
default: 100000
description: "The threshold, after which the single BULK Job should be checkpointed\
\ (min: 15k, max: 1M)"
maximum: 1000000
minimum: 15000
title: "BULK Job checkpoint (rows collected)"
type: "integer"
job_product_variants_include_pres_prices:
default: true
description: "If enabled, the `Product Variants` stream attempts to include\
\ `Presentment prices` field (may affect the performance)."
title: "Add `Presentment prices` to Product Variants"
type: "boolean"
job_termination_threshold:
default: 7200
description: "The max time in seconds, after which the single BULK Job should\
\ be `CANCELED` and retried. The bigger the value the longer the BULK\
\ Job is allowed to run."
maximum: 21600
minimum: 3600
title: "BULK Job termination threshold"
type: "integer"
shop:
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'."
examples:
- "my-store"
- "my-store.myshopify.com"
order: 1
pattern: "^(?!https://)(?!https://).*"
title: "Shopify Store"
type: "string"
start_date:
default: "2020-01-01"
description: "The date you would like to replicate data from. Format: YYYY-MM-DD.\
\ Any data before this date will not be replicated."
format: "date"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Replication Start Date"
type: "string"
sourceType:
title: "shopify"
const: "shopify"
enum:
- "shopify"
order: 0
type: "string"
required:
- "shop"
- "sourceType"
title: "Shopify Source CDK Specifications"
type: "object"
source-shopify-update:
properties:
bulk_window_in_days:
default: 30
description: "Defines what would be a date range per single BULK Job"
title: "GraphQL BULK Date Range in Days"
type: "integer"
credentials:
description: "The authorization method to use to retrieve data from Shopify"
oneOf:
- description: "OAuth2.0"
properties:
access_token:
airbyte_secret: true
description: "The Access Token for making authenticated requests."
order: 3
title: "Access Token"
type: "string"
auth_method:
const: "oauth2.0"
order: 0
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The Client ID of the Shopify developer application."
order: 1
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of the Shopify developer application."
order: 2
title: "Client Secret"
type: "string"
required:
- "auth_method"
title: "OAuth2.0"
type: "object"
- description: "API Password Auth"
properties:
api_password:
airbyte_secret: true
description: "The API Password for your private application in the\
\ `Shopify` store."
order: 1
title: "API Password"
type: "string"
auth_method:
const: "api_password"
order: 0
type: "string"
enum:
- "api_password"
required:
- "auth_method"
- "api_password"
title: "API Password"
type: "object"
order: 2
title: "Shopify Authorization Method"
type: "object"
fetch_transactions_user_id:
default: false
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."
title: "Add `user_id` to Transactions (slower)"
type: "boolean"
job_checkpoint_interval:
default: 100000
description: "The threshold, after which the single BULK Job should be checkpointed\
\ (min: 15k, max: 1M)"
maximum: 1000000
minimum: 15000
title: "BULK Job checkpoint (rows collected)"
type: "integer"
job_product_variants_include_pres_prices:
default: true
description: "If enabled, the `Product Variants` stream attempts to include\
\ `Presentment prices` field (may affect the performance)."
title: "Add `Presentment prices` to Product Variants"
type: "boolean"
job_termination_threshold:
default: 7200
description: "The max time in seconds, after which the single BULK Job should\
\ be `CANCELED` and retried. The bigger the value the longer the BULK\
\ Job is allowed to run."
maximum: 21600
minimum: 3600
title: "BULK Job termination threshold"
type: "integer"
shop:
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'."
examples:
- "my-store"
- "my-store.myshopify.com"
order: 1
pattern: "^(?!https://)(?!https://).*"
title: "Shopify Store"
type: "string"
start_date:
default: "2020-01-01"
description: "The date you would like to replicate data from. Format: YYYY-MM-DD.\
\ Any data before this date will not be replicated."
format: "date"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Replication Start Date"
type: "string"
required:
- "shop"
title: "Shopify Source CDK Specifications"
type: "object"
source-shippo:
properties:
shippo_token:
description: "The bearer token used for making requests"
order: 0
title: "Shippo Token"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "shippo"
const: "shippo"
enum:
- "shippo"
order: 0
type: "string"
required:
- "shippo_token"
- "start_date"
- "sourceType"
type: "object"
source-shippo-update:
properties:
shippo_token:
description: "The bearer token used for making requests"
order: 0
title: "Shippo Token"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "shippo_token"
- "start_date"
type: "object"
source-coda:
properties:
auth_token:
airbyte_secret: true
description: "Bearer token"
order: 0
title: "Authentication token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "coda"
const: "coda"
enum:
- "coda"
order: 0
type: "string"
required:
- "auth_token"
- "sourceType"
type: "object"
source-coda-update:
properties:
auth_token:
airbyte_secret: true
description: "Bearer token"
order: 0
title: "Authentication token"
type: "string"
required:
- "auth_token"
type: "object"
source-fleetio:
properties:
account_token:
airbyte_secret: true
order: 1
title: "account_token"
type: "string"
x-speakeasy-param-sensitive: true
api_key:
airbyte_secret: true
order: 0
title: "api_key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "fleetio"
const: "fleetio"
enum:
- "fleetio"
order: 0
type: "string"
required:
- "api_key"
- "account_token"
- "sourceType"
type: "object"
source-fleetio-update:
properties:
account_token:
airbyte_secret: true
order: 1
title: "account_token"
type: "string"
api_key:
airbyte_secret: true
order: 0
title: "api_key"
type: "string"
required:
- "api_key"
- "account_token"
type: "object"
source-pendo:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "pendo"
const: "pendo"
enum:
- "pendo"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-pendo-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-missive:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
kind:
default: "group"
description: "Kind parameter for `contact_groups` stream"
enum:
- "group"
- "organization"
order: 3
title: "Kind"
type: "string"
limit:
default: "50"
description: "Max records per page limit"
order: 1
title: "Limit"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "missive"
const: "missive"
enum:
- "missive"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-missive-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
kind:
default: "group"
description: "Kind parameter for `contact_groups` stream"
enum:
- "group"
- "organization"
order: 3
title: "Kind"
type: "string"
limit:
default: "50"
description: "Max records per page limit"
order: 1
title: "Limit"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-netsuite-enterprise:
properties:
account_id:
description: "The username which is used to access the database."
order: 6
title: "Account ID"
type: "string"
authentication_method:
description: "Configure how to authenticate to Netsuite. Options include\
\ username/password or token-based authentication."
oneOf:
- additionalProperties: true
description: "Authenticate using a password."
properties:
authentication_method:
default: "password_authentication"
enum:
- "password_authentication"
type: "string"
password:
airbyte_secret: true
description: "The password associated with the username."
order: 1
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "authentication_method"
- "password"
title: "Password Authentication"
type: "object"
- additionalProperties: true
description: "Authenticate using a token-based authentication method.\
\ This requires a consumer key and secret, as well as a token ID and\
\ secret."
properties:
authentication_method:
default: "token_based_authentication"
enum:
- "token_based_authentication"
type: "string"
client_id:
description: "The consumer key used for token-based authentication.\
\ This is generated in NetSuite when creating an integration record."
order: 1
title: "Consumer Key"
type: "string"
client_secret:
airbyte_secret: true
description: "The consumer secret used for token-based authentication.\
\ This is generated in NetSuite when creating an integration record."
order: 2
title: "Consumer Secret"
type: "string"
x-speakeasy-param-sensitive: true
token_id:
description: "The token ID used for token-based authentication. This\
\ is generated in NetSuite when creating a token-based role."
order: 3
title: "Token ID"
type: "string"
token_secret:
airbyte_secret: true
description: "The token secret used for token-based authentication.\
\ This is generated in NetSuite when creating a token-based role.Ensure\
\ to keep this value secure."
order: 4
title: "Token Secret"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "authentication_method"
- "client_id"
- "client_secret"
- "token_id"
- "token_secret"
title: "Token Based Authentication"
type: "object"
- additionalProperties: true
description: "Authenticate using OAuth2. This requires a consumer key,\
\ the private part of the certificate with which netsuite OAuth2 Client\
\ Credentials was setup and the certificate ID for the OAuth2 setup\
\ entry. "
properties:
authentication_method:
default: "oauth2_authentication"
enum:
- "oauth2_authentication"
type: "string"
client_id:
description: "The consumer key used for OAuth2 authentication. This\
\ is generated in NetSuite when creating an integration record."
order: 1
title: "Consumer Key"
type: "string"
key_id:
description: "The certificate ID for the OAuth 2.0 Client Credentials\
\ Setup entry."
order: 2
title: "Certificate ID"
type: "string"
oauth2_private_key:
airbyte_secret: true
description: "The private portion of the certificate with which OAuth2\
\ was setup. ( created with openssl req -new -x509 -newkey rsa:4096\
\ -keyout private.pem -sigopt rsa_padding_mode:pss -sha256 -sigopt\
\ rsa_pss_saltlen:64 -out public.pem -nodes -days 365 )"
multiline: true
order: 3
title: "OAuth2 Private Key"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "authentication_method"
- "client_id"
- "key_id"
- "oauth2_private_key"
title: "OAuth2 Authentication"
type: "object"
order: 5
title: "Authentication Method"
type: "object"
check_privileges:
default: true
description: "When this feature is enabled, during schema discovery the\
\ connector will query each table or view individually to check access\
\ privileges and inaccessible tables, views, or columns therein will be\
\ removed. In large schemas, this might cause schema discovery to take\
\ too long, in which case it might be advisable to disable this feature."
order: 13
title: "Check Table and Column Access Privileges"
type: "boolean"
checkpoint_target_interval_seconds:
default: 300
description: "How often (in seconds) a stream should checkpoint, when possible."
order: 11
title: "Checkpoint Target Time Interval"
type: "integer"
concurrency:
default: 1
description: "Maximum number of concurrent queries to the database."
order: 12
title: "Concurrency"
type: "integer"
cursor:
description: "Configures how data is extracted from the database."
display_type: "radio"
oneOf:
- additionalProperties: true
description: "Incrementally detects new inserts and updates using the\
\ cursor column chosen when configuring a connection (e.g. created_at,\
\ updated_at)."
properties:
cursor_method:
default: "user_defined"
enum:
- "user_defined"
type: "string"
required:
- "cursor_method"
title: "Scan Changes with User Defined Cursor"
type: "object"
order: 10
title: "Update Method"
type: "object"
host:
description: "Hostname of the database."
order: 1
title: "Host"
type: "string"
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)."
order: 8
title: "JDBC URL Params"
type: "string"
port:
default: 1708
description: "Port of the database."
maximum: 65536
minimum: 0
order: 2
title: "Port"
type: "integer"
role_id:
description: "The username which is used to access the database."
order: 7
title: "Role Id"
type: "string"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- additionalProperties: true
description: "No ssh tunnel needed to connect to database"
properties:
tunnel_method:
default: "NO_TUNNEL"
enum:
- "NO_TUNNEL"
type: "string"
required:
- "tunnel_method"
title: "No Tunnel"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
x-speakeasy-param-sensitive: true
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_KEY_AUTH"
enum:
- "SSH_KEY_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_PASSWORD_AUTH"
enum:
- "SSH_PASSWORD_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
type: "object"
order: 9
title: "SSH Tunnel Method"
type: "object"
username:
description: "The username which is used to access the database."
order: 4
title: "User"
type: "string"
sourceType:
title: "netsuite-enterprise"
const: "netsuite-enterprise"
enum:
- "netsuite-enterprise"
order: 0
type: "string"
required:
- "host"
- "port"
- "username"
- "authentication_method"
- "tunnel_method"
- "cursor"
- "account_id"
- "role_id"
- "sourceType"
title: "Netsuite Source Spec"
type: "object"
source-netsuite-enterprise-update:
properties:
account_id:
description: "The username which is used to access the database."
order: 6
title: "Account ID"
type: "string"
authentication_method:
description: "Configure how to authenticate to Netsuite. Options include\
\ username/password or token-based authentication."
oneOf:
- additionalProperties: true
description: "Authenticate using a password."
properties:
authentication_method:
default: "password_authentication"
enum:
- "password_authentication"
type: "string"
password:
airbyte_secret: true
description: "The password associated with the username."
order: 1
title: "Password"
type: "string"
required:
- "authentication_method"
- "password"
title: "Password Authentication"
type: "object"
- additionalProperties: true
description: "Authenticate using a token-based authentication method.\
\ This requires a consumer key and secret, as well as a token ID and\
\ secret."
properties:
authentication_method:
default: "token_based_authentication"
enum:
- "token_based_authentication"
type: "string"
client_id:
description: "The consumer key used for token-based authentication.\
\ This is generated in NetSuite when creating an integration record."
order: 1
title: "Consumer Key"
type: "string"
client_secret:
airbyte_secret: true
description: "The consumer secret used for token-based authentication.\
\ This is generated in NetSuite when creating an integration record."
order: 2
title: "Consumer Secret"
type: "string"
token_id:
description: "The token ID used for token-based authentication. This\
\ is generated in NetSuite when creating a token-based role."
order: 3
title: "Token ID"
type: "string"
token_secret:
airbyte_secret: true
description: "The token secret used for token-based authentication.\
\ This is generated in NetSuite when creating a token-based role.Ensure\
\ to keep this value secure."
order: 4
title: "Token Secret"
type: "string"
required:
- "authentication_method"
- "client_id"
- "client_secret"
- "token_id"
- "token_secret"
title: "Token Based Authentication"
type: "object"
- additionalProperties: true
description: "Authenticate using OAuth2. This requires a consumer key,\
\ the private part of the certificate with which netsuite OAuth2 Client\
\ Credentials was setup and the certificate ID for the OAuth2 setup\
\ entry. "
properties:
authentication_method:
default: "oauth2_authentication"
enum:
- "oauth2_authentication"
type: "string"
client_id:
description: "The consumer key used for OAuth2 authentication. This\
\ is generated in NetSuite when creating an integration record."
order: 1
title: "Consumer Key"
type: "string"
key_id:
description: "The certificate ID for the OAuth 2.0 Client Credentials\
\ Setup entry."
order: 2
title: "Certificate ID"
type: "string"
oauth2_private_key:
airbyte_secret: true
description: "The private portion of the certificate with which OAuth2\
\ was setup. ( created with openssl req -new -x509 -newkey rsa:4096\
\ -keyout private.pem -sigopt rsa_padding_mode:pss -sha256 -sigopt\
\ rsa_pss_saltlen:64 -out public.pem -nodes -days 365 )"
multiline: true
order: 3
title: "OAuth2 Private Key"
type: "string"
required:
- "authentication_method"
- "client_id"
- "key_id"
- "oauth2_private_key"
title: "OAuth2 Authentication"
type: "object"
order: 5
title: "Authentication Method"
type: "object"
check_privileges:
default: true
description: "When this feature is enabled, during schema discovery the\
\ connector will query each table or view individually to check access\
\ privileges and inaccessible tables, views, or columns therein will be\
\ removed. In large schemas, this might cause schema discovery to take\
\ too long, in which case it might be advisable to disable this feature."
order: 13
title: "Check Table and Column Access Privileges"
type: "boolean"
checkpoint_target_interval_seconds:
default: 300
description: "How often (in seconds) a stream should checkpoint, when possible."
order: 11
title: "Checkpoint Target Time Interval"
type: "integer"
concurrency:
default: 1
description: "Maximum number of concurrent queries to the database."
order: 12
title: "Concurrency"
type: "integer"
cursor:
description: "Configures how data is extracted from the database."
display_type: "radio"
oneOf:
- additionalProperties: true
description: "Incrementally detects new inserts and updates using the\
\ cursor column chosen when configuring a connection (e.g. created_at,\
\ updated_at)."
properties:
cursor_method:
default: "user_defined"
enum:
- "user_defined"
type: "string"
required:
- "cursor_method"
title: "Scan Changes with User Defined Cursor"
type: "object"
order: 10
title: "Update Method"
type: "object"
host:
description: "Hostname of the database."
order: 1
title: "Host"
type: "string"
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)."
order: 8
title: "JDBC URL Params"
type: "string"
port:
default: 1708
description: "Port of the database."
maximum: 65536
minimum: 0
order: 2
title: "Port"
type: "integer"
role_id:
description: "The username which is used to access the database."
order: 7
title: "Role Id"
type: "string"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- additionalProperties: true
description: "No ssh tunnel needed to connect to database"
properties:
tunnel_method:
default: "NO_TUNNEL"
enum:
- "NO_TUNNEL"
type: "string"
required:
- "tunnel_method"
title: "No Tunnel"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_KEY_AUTH"
enum:
- "SSH_KEY_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_PASSWORD_AUTH"
enum:
- "SSH_PASSWORD_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
type: "object"
order: 9
title: "SSH Tunnel Method"
type: "object"
username:
description: "The username which is used to access the database."
order: 4
title: "User"
type: "string"
required:
- "host"
- "port"
- "username"
- "authentication_method"
- "tunnel_method"
- "cursor"
- "account_id"
- "role_id"
title: "Netsuite Source Spec"
type: "object"
source-pingdom:
properties:
api_key:
airbyte_secret: true
order: 1
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
probes:
examples:
- "probe1"
- "probe2"
order: 0
title: "probes"
type: "string"
resolution:
default: "hour"
enum:
- "hour"
- "day"
- "week"
order: 2
title: "resolution"
type: "string"
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "pingdom"
const: "pingdom"
enum:
- "pingdom"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-pingdom-update:
properties:
api_key:
airbyte_secret: true
order: 1
title: "API Key"
type: "string"
probes:
examples:
- "probe1"
- "probe2"
order: 0
title: "probes"
type: "string"
resolution:
default: "hour"
enum:
- "hour"
- "day"
- "week"
order: 2
title: "resolution"
type: "string"
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-azure-blob-storage:
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."
properties:
azure_blob_storage_account_name:
description: "The account's name of the Azure Blob Storage."
examples:
- "airbyte5storage"
order: 3
title: "Azure Blob Storage account name"
type: "string"
azure_blob_storage_container_name:
description: "The name of the Azure blob storage container."
examples:
- "airbytetescontainername"
order: 4
title: "Azure blob storage container (Bucket) Name"
type: "string"
azure_blob_storage_endpoint:
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
title: "Endpoint Domain Name"
type: "string"
credentials:
description: "Credentials for connecting to the Azure Blob Storage"
oneOf:
- properties:
auth_type:
const: "oauth2"
default: "oauth2"
enum:
- "oauth2"
title: "Auth Type"
type: "string"
client_id:
airbyte_secret: true
description: "Client ID of your Microsoft developer application"
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "Client Secret of your Microsoft developer application"
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "Refresh Token of your Microsoft developer application"
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
tenant_id:
airbyte_secret: true
description: "Tenant ID of the Microsoft Azure Application user"
title: "Tenant ID"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tenant_id"
- "client_id"
- "client_secret"
- "refresh_token"
- "auth_type"
title: "Authenticate via Oauth2"
type: "object"
- properties:
app_client_id:
airbyte_secret: true
description: "Client ID of your Microsoft developer application"
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
app_client_secret:
airbyte_secret: true
description: "Client Secret of your Microsoft developer application"
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
app_tenant_id:
airbyte_secret: true
description: "Tenant ID of the Microsoft Azure Application"
title: "Tenant ID"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "client_credentials"
default: "client_credentials"
enum:
- "client_credentials"
title: "Auth Type"
type: "string"
required:
- "app_tenant_id"
- "app_client_id"
- "app_client_secret"
- "auth_type"
title: "Authenticate via Client Credentials"
type: "object"
- properties:
auth_type:
const: "storage_account_key"
default: "storage_account_key"
enum:
- "storage_account_key"
title: "Auth Type"
type: "string"
azure_blob_storage_account_key:
airbyte_secret: true
description: "The Azure blob storage account key."
examples:
- "Z8ZkZpteggFx394vm+PJHnGTvdRncaYS+JhLKdj789YNmD+iyGTnG+PV+POiuYNhBg/ACS+LKjd%4FG3FHGN12Nd=="
order: 3
title: "Azure Blob Storage account key"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "azure_blob_storage_account_key"
- "auth_type"
title: "Authenticate via Storage Account Key"
type: "object"
order: 2
title: "Authentication"
type: "object"
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"
order: 1
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"
title: "Start Date"
type: "string"
streams:
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."
items:
properties:
days_to_sync_if_history_is_full:
default: 3
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."
title: "Days To Sync If History Is Full"
type: "integer"
format:
description: "The configuration options that are used to alter how\
\ to read incoming files that deviate from the standard formatting."
oneOf:
- properties:
double_as_string:
default: false
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."
title: "Convert Double Fields to Strings"
type: "boolean"
filetype:
const: "avro"
default: "avro"
title: "Filetype"
type: "string"
enum:
- "avro"
required:
- "filetype"
title: "Avro Format"
type: "object"
- properties:
delimiter:
default: ","
description: "The character delimiting individual cells in the\
\ CSV data. This may only be a 1-character string. For tab-delimited\
\ data enter '\\t'."
title: "Delimiter"
type: "string"
double_quote:
default: true
description: "Whether two quotes in a quoted CSV value denote\
\ a single quote in the data."
title: "Double Quote"
type: "boolean"
encoding:
default: "utf8"
description: "The character encoding of the CSV data. Leave\
\ blank to default to UTF8. See list of python encodings for allowable\
\ options."
title: "Encoding"
type: "string"
escape_char:
description: "The character used for escaping special characters.\
\ To disallow escaping, leave this field blank."
title: "Escape Character"
type: "string"
false_values:
default:
- "n"
- "no"
- "f"
- "false"
- "off"
- "0"
description: "A set of case-sensitive strings that should be\
\ interpreted as false values."
items:
type: "string"
title: "False Values"
type: "array"
uniqueItems: true
filetype:
const: "csv"
default: "csv"
title: "Filetype"
type: "string"
enum:
- "csv"
header_definition:
default:
header_definition_type: "From CSV"
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."
oneOf:
- properties:
header_definition_type:
const: "From CSV"
default: "From CSV"
title: "Header Definition Type"
type: "string"
enum:
- "From CSV"
required:
- "header_definition_type"
title: "From CSV"
type: "object"
- properties:
header_definition_type:
const: "Autogenerated"
default: "Autogenerated"
title: "Header Definition Type"
type: "string"
enum:
- "Autogenerated"
required:
- "header_definition_type"
title: "Autogenerated"
type: "object"
- properties:
column_names:
description: "The column names that will be used while\
\ emitting the CSV records"
items:
type: "string"
title: "Column Names"
type: "array"
header_definition_type:
const: "User Provided"
default: "User Provided"
title: "Header Definition Type"
type: "string"
enum:
- "User Provided"
required:
- "column_names"
- "header_definition_type"
title: "User Provided"
type: "object"
title: "CSV Header Definition"
type: "object"
ignore_errors_on_fields_mismatch:
default: false
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."
title: "Ignore errors on field mismatch"
type: "boolean"
null_values:
default: []
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."
items:
type: "string"
title: "Null Values"
type: "array"
uniqueItems: true
quote_char:
default: "\""
description: "The character used for quoting CSV values. To\
\ disallow quoting, make this field blank."
title: "Quote Character"
type: "string"
skip_rows_after_header:
default: 0
description: "The number of rows to skip after the header row."
title: "Skip Rows After Header"
type: "integer"
skip_rows_before_header:
default: 0
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."
title: "Skip Rows Before Header"
type: "integer"
strings_can_be_null:
default: true
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."
title: "Strings Can Be Null"
type: "boolean"
true_values:
default:
- "y"
- "yes"
- "t"
- "true"
- "on"
- "1"
description: "A set of case-sensitive strings that should be\
\ interpreted as true values."
items:
type: "string"
title: "True Values"
type: "array"
uniqueItems: true
required:
- "filetype"
title: "CSV Format"
type: "object"
- properties:
filetype:
const: "jsonl"
default: "jsonl"
title: "Filetype"
type: "string"
enum:
- "jsonl"
required:
- "filetype"
title: "Jsonl Format"
type: "object"
- properties:
decimal_as_float:
default: false
description: "Whether to convert decimal fields to floats. There\
\ is a loss of precision when converting decimals to floats,\
\ so this is not recommended."
title: "Convert Decimal Fields to Floats"
type: "boolean"
filetype:
const: "parquet"
default: "parquet"
title: "Filetype"
type: "string"
enum:
- "parquet"
required:
- "filetype"
title: "Parquet Format"
type: "object"
- description: "Extract text from document formats (.pdf, .docx, .md,\
\ .pptx) and emit as one record per file."
properties:
filetype:
const: "unstructured"
default: "unstructured"
title: "Filetype"
type: "string"
enum:
- "unstructured"
processing:
default:
mode: "local"
description: "Processing configuration"
oneOf:
- description: "Process files locally, supporting `fast` and\
\ `ocr` modes. This is the default option."
properties:
mode:
const: "local"
default: "local"
enum:
- "local"
title: "Mode"
type: "string"
required:
- "mode"
title: "Local"
type: "object"
title: "Processing"
type: "object"
skip_unprocessable_files:
always_show: true
default: true
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."
title: "Skip Unprocessable Files"
type: "boolean"
strategy:
always_show: true
default: "auto"
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"
enum:
- "auto"
- "fast"
- "ocr_only"
- "hi_res"
order: 0
title: "Parsing Strategy"
type: "string"
required:
- "filetype"
title: "Unstructured Document Format"
type: "object"
- properties:
filetype:
const: "excel"
default: "excel"
title: "Filetype"
type: "string"
enum:
- "excel"
required:
- "filetype"
title: "Excel Format"
type: "object"
title: "Format"
type: "object"
globs:
default:
- "**"
description: "The pattern used to specify which files should be selected\
\ from the file system. For more information on glob pattern matching\
\ look here."
items:
type: "string"
order: 1
title: "Globs"
type: "array"
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."
title: "Input Schema"
type: "string"
name:
description: "The name of the stream."
title: "Name"
type: "string"
recent_n_files_to_read_for_schema_discovery:
description: "The number of resent files which will be used to discover\
\ the schema for this stream."
exclusiveMinimum: 0
title: "Files To Read For Schema Discover"
type: "integer"
schemaless:
default: false
description: "When enabled, syncs will not validate or structure records\
\ against the stream's schema."
title: "Schemaless"
type: "boolean"
validation_policy:
default: "Emit Record"
description: "The name of the validation policy that dictates sync\
\ behavior when a record does not adhere to the stream schema."
enum:
- "Emit Record"
- "Skip Record"
- "Wait for Discover"
title: "Validation Policy"
required:
- "name"
- "format"
title: "FileBasedStreamConfig"
type: "object"
order: 10
title: "The list of streams to sync"
type: "array"
sourceType:
title: "azure-blob-storage"
const: "azure-blob-storage"
enum:
- "azure-blob-storage"
order: 0
type: "string"
required:
- "streams"
- "credentials"
- "azure_blob_storage_account_name"
- "azure_blob_storage_container_name"
- "sourceType"
title: "SourceAzureBlobStorageSpec"
type: "object"
source-azure-blob-storage-update:
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."
properties:
azure_blob_storage_account_name:
description: "The account's name of the Azure Blob Storage."
examples:
- "airbyte5storage"
order: 3
title: "Azure Blob Storage account name"
type: "string"
azure_blob_storage_container_name:
description: "The name of the Azure blob storage container."
examples:
- "airbytetescontainername"
order: 4
title: "Azure blob storage container (Bucket) Name"
type: "string"
azure_blob_storage_endpoint:
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
title: "Endpoint Domain Name"
type: "string"
credentials:
description: "Credentials for connecting to the Azure Blob Storage"
oneOf:
- properties:
auth_type:
const: "oauth2"
default: "oauth2"
enum:
- "oauth2"
title: "Auth Type"
type: "string"
client_id:
airbyte_secret: true
description: "Client ID of your Microsoft developer application"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Client Secret of your Microsoft developer application"
title: "Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "Refresh Token of your Microsoft developer application"
title: "Refresh Token"
type: "string"
tenant_id:
airbyte_secret: true
description: "Tenant ID of the Microsoft Azure Application user"
title: "Tenant ID"
type: "string"
required:
- "tenant_id"
- "client_id"
- "client_secret"
- "refresh_token"
- "auth_type"
title: "Authenticate via Oauth2"
type: "object"
- properties:
app_client_id:
airbyte_secret: true
description: "Client ID of your Microsoft developer application"
title: "Client ID"
type: "string"
app_client_secret:
airbyte_secret: true
description: "Client Secret of your Microsoft developer application"
title: "Client Secret"
type: "string"
app_tenant_id:
airbyte_secret: true
description: "Tenant ID of the Microsoft Azure Application"
title: "Tenant ID"
type: "string"
auth_type:
const: "client_credentials"
default: "client_credentials"
enum:
- "client_credentials"
title: "Auth Type"
type: "string"
required:
- "app_tenant_id"
- "app_client_id"
- "app_client_secret"
- "auth_type"
title: "Authenticate via Client Credentials"
type: "object"
- properties:
auth_type:
const: "storage_account_key"
default: "storage_account_key"
enum:
- "storage_account_key"
title: "Auth Type"
type: "string"
azure_blob_storage_account_key:
airbyte_secret: true
description: "The Azure blob storage account key."
examples:
- "Z8ZkZpteggFx394vm+PJHnGTvdRncaYS+JhLKdj789YNmD+iyGTnG+PV+POiuYNhBg/ACS+LKjd%4FG3FHGN12Nd=="
order: 3
title: "Azure Blob Storage account key"
type: "string"
required:
- "azure_blob_storage_account_key"
- "auth_type"
title: "Authenticate via Storage Account Key"
type: "object"
order: 2
title: "Authentication"
type: "object"
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"
order: 1
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"
title: "Start Date"
type: "string"
streams:
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."
items:
properties:
days_to_sync_if_history_is_full:
default: 3
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."
title: "Days To Sync If History Is Full"
type: "integer"
format:
description: "The configuration options that are used to alter how\
\ to read incoming files that deviate from the standard formatting."
oneOf:
- properties:
double_as_string:
default: false
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."
title: "Convert Double Fields to Strings"
type: "boolean"
filetype:
const: "avro"
default: "avro"
title: "Filetype"
type: "string"
enum:
- "avro"
required:
- "filetype"
title: "Avro Format"
type: "object"
- properties:
delimiter:
default: ","
description: "The character delimiting individual cells in the\
\ CSV data. This may only be a 1-character string. For tab-delimited\
\ data enter '\\t'."
title: "Delimiter"
type: "string"
double_quote:
default: true
description: "Whether two quotes in a quoted CSV value denote\
\ a single quote in the data."
title: "Double Quote"
type: "boolean"
encoding:
default: "utf8"
description: "The character encoding of the CSV data. Leave\
\ blank to default to UTF8. See list of python encodings for allowable\
\ options."
title: "Encoding"
type: "string"
escape_char:
description: "The character used for escaping special characters.\
\ To disallow escaping, leave this field blank."
title: "Escape Character"
type: "string"
false_values:
default:
- "n"
- "no"
- "f"
- "false"
- "off"
- "0"
description: "A set of case-sensitive strings that should be\
\ interpreted as false values."
items:
type: "string"
title: "False Values"
type: "array"
uniqueItems: true
filetype:
const: "csv"
default: "csv"
title: "Filetype"
type: "string"
enum:
- "csv"
header_definition:
default:
header_definition_type: "From CSV"
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."
oneOf:
- properties:
header_definition_type:
const: "From CSV"
default: "From CSV"
title: "Header Definition Type"
type: "string"
enum:
- "From CSV"
required:
- "header_definition_type"
title: "From CSV"
type: "object"
- properties:
header_definition_type:
const: "Autogenerated"
default: "Autogenerated"
title: "Header Definition Type"
type: "string"
enum:
- "Autogenerated"
required:
- "header_definition_type"
title: "Autogenerated"
type: "object"
- properties:
column_names:
description: "The column names that will be used while\
\ emitting the CSV records"
items:
type: "string"
title: "Column Names"
type: "array"
header_definition_type:
const: "User Provided"
default: "User Provided"
title: "Header Definition Type"
type: "string"
enum:
- "User Provided"
required:
- "column_names"
- "header_definition_type"
title: "User Provided"
type: "object"
title: "CSV Header Definition"
type: "object"
ignore_errors_on_fields_mismatch:
default: false
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."
title: "Ignore errors on field mismatch"
type: "boolean"
null_values:
default: []
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."
items:
type: "string"
title: "Null Values"
type: "array"
uniqueItems: true
quote_char:
default: "\""
description: "The character used for quoting CSV values. To\
\ disallow quoting, make this field blank."
title: "Quote Character"
type: "string"
skip_rows_after_header:
default: 0
description: "The number of rows to skip after the header row."
title: "Skip Rows After Header"
type: "integer"
skip_rows_before_header:
default: 0
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."
title: "Skip Rows Before Header"
type: "integer"
strings_can_be_null:
default: true
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."
title: "Strings Can Be Null"
type: "boolean"
true_values:
default:
- "y"
- "yes"
- "t"
- "true"
- "on"
- "1"
description: "A set of case-sensitive strings that should be\
\ interpreted as true values."
items:
type: "string"
title: "True Values"
type: "array"
uniqueItems: true
required:
- "filetype"
title: "CSV Format"
type: "object"
- properties:
filetype:
const: "jsonl"
default: "jsonl"
title: "Filetype"
type: "string"
enum:
- "jsonl"
required:
- "filetype"
title: "Jsonl Format"
type: "object"
- properties:
decimal_as_float:
default: false
description: "Whether to convert decimal fields to floats. There\
\ is a loss of precision when converting decimals to floats,\
\ so this is not recommended."
title: "Convert Decimal Fields to Floats"
type: "boolean"
filetype:
const: "parquet"
default: "parquet"
title: "Filetype"
type: "string"
enum:
- "parquet"
required:
- "filetype"
title: "Parquet Format"
type: "object"
- description: "Extract text from document formats (.pdf, .docx, .md,\
\ .pptx) and emit as one record per file."
properties:
filetype:
const: "unstructured"
default: "unstructured"
title: "Filetype"
type: "string"
enum:
- "unstructured"
processing:
default:
mode: "local"
description: "Processing configuration"
oneOf:
- description: "Process files locally, supporting `fast` and\
\ `ocr` modes. This is the default option."
properties:
mode:
const: "local"
default: "local"
enum:
- "local"
title: "Mode"
type: "string"
required:
- "mode"
title: "Local"
type: "object"
title: "Processing"
type: "object"
skip_unprocessable_files:
always_show: true
default: true
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."
title: "Skip Unprocessable Files"
type: "boolean"
strategy:
always_show: true
default: "auto"
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"
enum:
- "auto"
- "fast"
- "ocr_only"
- "hi_res"
order: 0
title: "Parsing Strategy"
type: "string"
required:
- "filetype"
title: "Unstructured Document Format"
type: "object"
- properties:
filetype:
const: "excel"
default: "excel"
title: "Filetype"
type: "string"
enum:
- "excel"
required:
- "filetype"
title: "Excel Format"
type: "object"
title: "Format"
type: "object"
globs:
default:
- "**"
description: "The pattern used to specify which files should be selected\
\ from the file system. For more information on glob pattern matching\
\ look here."
items:
type: "string"
order: 1
title: "Globs"
type: "array"
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."
title: "Input Schema"
type: "string"
name:
description: "The name of the stream."
title: "Name"
type: "string"
recent_n_files_to_read_for_schema_discovery:
description: "The number of resent files which will be used to discover\
\ the schema for this stream."
exclusiveMinimum: 0
title: "Files To Read For Schema Discover"
type: "integer"
schemaless:
default: false
description: "When enabled, syncs will not validate or structure records\
\ against the stream's schema."
title: "Schemaless"
type: "boolean"
validation_policy:
default: "Emit Record"
description: "The name of the validation policy that dictates sync\
\ behavior when a record does not adhere to the stream schema."
enum:
- "Emit Record"
- "Skip Record"
- "Wait for Discover"
title: "Validation Policy"
required:
- "name"
- "format"
title: "FileBasedStreamConfig"
type: "object"
order: 10
title: "The list of streams to sync"
type: "array"
required:
- "streams"
- "credentials"
- "azure_blob_storage_account_name"
- "azure_blob_storage_container_name"
title: "SourceAzureBlobStorageSpec"
type: "object"
source-close-com:
properties:
api_key:
airbyte_secret: true
description: "Close.com API key (usually starts with 'api_'; find yours\
\ here)."
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
default: "2021-01-01"
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"
format: "date"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Replication Start Date"
type: "string"
sourceType:
title: "close-com"
const: "close-com"
enum:
- "close-com"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-close-com-update:
properties:
api_key:
airbyte_secret: true
description: "Close.com API key (usually starts with 'api_'; find yours\
\ here)."
order: 0
title: "API Key"
type: "string"
start_date:
default: "2021-01-01"
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"
format: "date"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Replication Start Date"
type: "string"
required:
- "api_key"
type: "object"
source-countercyclical:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "countercyclical"
const: "countercyclical"
enum:
- "countercyclical"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-countercyclical-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-gong:
properties:
access_key:
airbyte_secret: true
description: "Gong Access Key"
order: 0
title: "Gong Access Key"
type: "string"
x-speakeasy-param-sensitive: true
access_key_secret:
airbyte_secret: true
description: "Gong Access Key Secret"
order: 1
title: "Gong Access Key Secret"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "The date from which to list calls, in the ISO-8601 format;\
\ if not specified, the calls start with the earliest recorded call. For\
\ web-conference calls recorded by Gong, the date denotes its scheduled\
\ time, otherwise, it denotes its actual start time."
examples:
- "2018-02-18T08:00:00Z"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "gong"
const: "gong"
enum:
- "gong"
order: 0
type: "string"
required:
- "access_key"
- "access_key_secret"
- "sourceType"
type: "object"
source-gong-update:
properties:
access_key:
airbyte_secret: true
description: "Gong Access Key"
order: 0
title: "Gong Access Key"
type: "string"
access_key_secret:
airbyte_secret: true
description: "Gong Access Key Secret"
order: 1
title: "Gong Access Key Secret"
type: "string"
start_date:
description: "The date from which to list calls, in the ISO-8601 format;\
\ if not specified, the calls start with the earliest recorded call. For\
\ web-conference calls recorded by Gong, the date denotes its scheduled\
\ time, otherwise, it denotes its actual start time."
examples:
- "2018-02-18T08:00:00Z"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "access_key"
- "access_key_secret"
type: "object"
source-hugging-face-datasets:
properties:
dataset_name:
order: 0
title: "Dataset Name"
type: "string"
dataset_splits:
description: "Splits to import. Will import all of them if nothing is provided\
\ (see https://huggingface.co/docs/dataset-viewer/en/configs_and_splits\
\ for more details)"
order: 2
title: "Dataset Splits"
type: "array"
dataset_subsets:
description: "Dataset Subsets to import. Will import all of them if nothing\
\ is provided (see https://huggingface.co/docs/dataset-viewer/en/configs_and_splits\
\ for more details)"
order: 1
title: "Dataset Subsets"
type: "array"
sourceType:
title: "hugging-face-datasets"
const: "hugging-face-datasets"
enum:
- "hugging-face-datasets"
order: 0
type: "string"
required:
- "dataset_name"
- "sourceType"
type: "object"
source-hugging-face-datasets-update:
properties:
dataset_name:
order: 0
title: "Dataset Name"
type: "string"
dataset_splits:
description: "Splits to import. Will import all of them if nothing is provided\
\ (see https://huggingface.co/docs/dataset-viewer/en/configs_and_splits\
\ for more details)"
order: 2
title: "Dataset Splits"
type: "array"
dataset_subsets:
description: "Dataset Subsets to import. Will import all of them if nothing\
\ is provided (see https://huggingface.co/docs/dataset-viewer/en/configs_and_splits\
\ for more details)"
order: 1
title: "Dataset Subsets"
type: "array"
required:
- "dataset_name"
type: "object"
source-canny:
properties:
api_key:
airbyte_secret: true
description: "You can find your secret API key in Your Canny Subdomain >\
\ Settings > API"
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "canny"
const: "canny"
enum:
- "canny"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-canny-update:
properties:
api_key:
airbyte_secret: true
description: "You can find your secret API key in Your Canny Subdomain >\
\ Settings > API"
name: "api_key"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-woocommerce:
properties:
api_key:
airbyte_secret: true
description: "Customer Key for API in WooCommerce shop"
order: 0
title: "Customer Key"
type: "string"
x-speakeasy-param-sensitive: true
api_secret:
airbyte_secret: true
description: "Customer Secret for API in WooCommerce shop"
order: 1
title: "Customer Secret"
type: "string"
x-speakeasy-param-sensitive: true
shop:
description: "The name of the store. For https://EXAMPLE.com, the shop name\
\ is 'EXAMPLE.com'."
order: 2
title: "Shop Name"
type: "string"
start_date:
description: "The date you would like to replicate data from. Format: YYYY-MM-DD"
examples:
- "2021-01-01"
format: "date"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
sourceType:
title: "woocommerce"
const: "woocommerce"
enum:
- "woocommerce"
order: 0
type: "string"
required:
- "api_key"
- "api_secret"
- "shop"
- "start_date"
- "sourceType"
type: "object"
source-woocommerce-update:
properties:
api_key:
airbyte_secret: true
description: "Customer Key for API in WooCommerce shop"
order: 0
title: "Customer Key"
type: "string"
api_secret:
airbyte_secret: true
description: "Customer Secret for API in WooCommerce shop"
order: 1
title: "Customer Secret"
type: "string"
shop:
description: "The name of the store. For https://EXAMPLE.com, the shop name\
\ is 'EXAMPLE.com'."
order: 2
title: "Shop Name"
type: "string"
start_date:
description: "The date you would like to replicate data from. Format: YYYY-MM-DD"
examples:
- "2021-01-01"
format: "date"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
required:
- "api_key"
- "api_secret"
- "shop"
- "start_date"
type: "object"
source-retailexpress-by-maropost:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "retailexpress-by-maropost"
const: "retailexpress-by-maropost"
enum:
- "retailexpress-by-maropost"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-retailexpress-by-maropost-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-microsoft-entra-id:
properties:
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
x-speakeasy-param-sensitive: true
tenant_id:
airbyte_secret: true
order: 2
title: "Tenant Id"
type: "string"
x-speakeasy-param-sensitive: true
user_id:
airbyte_secret: true
order: 3
title: "User Id"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "microsoft-entra-id"
const: "microsoft-entra-id"
enum:
- "microsoft-entra-id"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "tenant_id"
- "user_id"
- "sourceType"
type: "object"
source-microsoft-entra-id-update:
properties:
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
tenant_id:
airbyte_secret: true
order: 2
title: "Tenant Id"
type: "string"
user_id:
airbyte_secret: true
order: 3
title: "User Id"
type: "string"
required:
- "client_id"
- "client_secret"
- "tenant_id"
- "user_id"
type: "object"
source-younium:
properties:
legal_entity:
description: "Legal Entity that data should be pulled from"
title: "Legal Entity"
type: "string"
password:
airbyte_secret: true
description: "Account password for younium account API key"
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
playground:
default: false
description: "Property defining if connector is used against playground\
\ or production environment"
title: "Playground environment"
type: "boolean"
username:
description: "Username for Younium account"
title: "Username"
type: "string"
sourceType:
title: "younium"
const: "younium"
enum:
- "younium"
order: 0
type: "string"
required:
- "username"
- "password"
- "legal_entity"
- "sourceType"
title: "Younium Spec"
type: "object"
source-younium-update:
properties:
legal_entity:
description: "Legal Entity that data should be pulled from"
title: "Legal Entity"
type: "string"
password:
airbyte_secret: true
description: "Account password for younium account API key"
title: "Password"
type: "string"
playground:
default: false
description: "Property defining if connector is used against playground\
\ or production environment"
title: "Playground environment"
type: "boolean"
username:
description: "Username for Younium account"
title: "Username"
type: "string"
required:
- "username"
- "password"
- "legal_entity"
title: "Younium Spec"
type: "object"
source-less-annoying-crm:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Manage and create your API keys on the Programmer\
\ API settings page at https://account.lessannoyingcrm.com/app/Settings/Api."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "less-annoying-crm"
const: "less-annoying-crm"
enum:
- "less-annoying-crm"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-less-annoying-crm-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Manage and create your API keys on the Programmer\
\ API settings page at https://account.lessannoyingcrm.com/app/Settings/Api."
name: "api_key"
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-planhat:
properties:
api_token:
airbyte_secret: true
description: "Your Planhat API Access Token"
order: 0
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "planhat"
const: "planhat"
enum:
- "planhat"
order: 0
type: "string"
required:
- "api_token"
- "sourceType"
type: "object"
source-planhat-update:
properties:
api_token:
airbyte_secret: true
description: "Your Planhat API Access Token"
order: 0
title: "API Token"
type: "string"
required:
- "api_token"
type: "object"
source-encharge:
properties:
api_key:
airbyte_secret: true
description: "The API key to use for authentication"
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "encharge"
const: "encharge"
enum:
- "encharge"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-encharge-update:
properties:
api_key:
airbyte_secret: true
description: "The API key to use for authentication"
name: "api_key"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-shortio:
properties:
domain_id:
airbyte_secret: false
desciprtion: "Short.io Domain ID"
title: "Domain ID"
type: "string"
x-speakeasy-param-sensitive: true
secret_key:
airbyte_secret: true
description: "Short.io Secret Key"
title: "Secret Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
airbyte_secret: false
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"
title: "Start Date"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "shortio"
const: "shortio"
enum:
- "shortio"
order: 0
type: "string"
required:
- "domain_id"
- "secret_key"
- "start_date"
- "sourceType"
title: "Shortio Spec"
type: "object"
source-shortio-update:
properties:
domain_id:
airbyte_secret: false
desciprtion: "Short.io Domain ID"
title: "Domain ID"
type: "string"
secret_key:
airbyte_secret: true
description: "Short.io Secret Key"
title: "Secret Key"
type: "string"
start_date:
airbyte_secret: false
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"
title: "Start Date"
type: "string"
required:
- "domain_id"
- "secret_key"
- "start_date"
title: "Shortio Spec"
type: "object"
source-instatus:
properties:
api_key:
airbyte_secret: true
description: "Instatus REST API key"
order: 0
title: "Rest API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "instatus"
const: "instatus"
enum:
- "instatus"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-instatus-update:
properties:
api_key:
airbyte_secret: true
description: "Instatus REST API key"
order: 0
title: "Rest API Key"
type: "string"
required:
- "api_key"
type: "object"
source-flexmail:
properties:
account_id:
description: "Your Flexmail account ID. You can find it in your Flexmail\
\ account settings."
name: "account_id"
order: 0
title: "Account ID"
type: "string"
personal_access_token:
airbyte_secret: true
description: "A personal access token for API authentication. Manage your\
\ tokens in Flexmail under Settings > API > Personal access tokens."
name: "personal_access_token"
order: 1
title: "Personal Access Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "flexmail"
const: "flexmail"
enum:
- "flexmail"
order: 0
type: "string"
required:
- "account_id"
- "personal_access_token"
- "sourceType"
type: "object"
source-flexmail-update:
properties:
account_id:
description: "Your Flexmail account ID. You can find it in your Flexmail\
\ account settings."
name: "account_id"
order: 0
title: "Account ID"
type: "string"
personal_access_token:
airbyte_secret: true
description: "A personal access token for API authentication. Manage your\
\ tokens in Flexmail under Settings > API > Personal access tokens."
name: "personal_access_token"
order: 1
title: "Personal Access Token"
type: "string"
required:
- "account_id"
- "personal_access_token"
type: "object"
source-openfda:
properties:
sourceType:
title: "openfda"
const: "openfda"
enum:
- "openfda"
order: 0
type: "string"
required:
- "sourceType"
type: "object"
source-openfda-update:
properties: {}
required: []
type: "object"
source-tyntec-sms:
properties:
api_key:
airbyte_secret: true
description: "Your Tyntec API Key. See here"
order: 0
title: "Tyntec API Key"
type: "string"
x-speakeasy-param-sensitive: true
from:
description: "The phone number of the SMS message sender (international)."
order: 2
title: "SMS Message Sender Phone"
type: "string"
message:
description: "The content of the SMS message to be sent."
order: 3
title: "SMS Message Body"
type: "string"
to:
description: "The phone number of the SMS message recipient (international)."
order: 1
title: "SMS Message Recipient Phone"
type: "string"
sourceType:
title: "tyntec-sms"
const: "tyntec-sms"
enum:
- "tyntec-sms"
order: 0
type: "string"
required:
- "api_key"
- "to"
- "from"
- "sourceType"
type: "object"
source-tyntec-sms-update:
properties:
api_key:
airbyte_secret: true
description: "Your Tyntec API Key. See here"
order: 0
title: "Tyntec API Key"
type: "string"
from:
description: "The phone number of the SMS message sender (international)."
order: 2
title: "SMS Message Sender Phone"
type: "string"
message:
description: "The content of the SMS message to be sent."
order: 3
title: "SMS Message Body"
type: "string"
to:
description: "The phone number of the SMS message recipient (international)."
order: 1
title: "SMS Message Recipient Phone"
type: "string"
required:
- "api_key"
- "to"
- "from"
type: "object"
source-elasticemail:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
from:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "From"
type: "string"
scope_type:
enum:
- "Personal"
- "Global"
order: 1
title: "scope type"
type: "string"
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "elasticemail"
const: "elasticemail"
enum:
- "elasticemail"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-elasticemail-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
from:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "From"
type: "string"
scope_type:
enum:
- "Personal"
- "Global"
order: 1
title: "scope type"
type: "string"
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-rocket-chat:
properties:
endpoint:
description: "Your rocket.chat instance URL."
examples:
- "https://airbyte-connector-poc.rocket.chat"
- "https://hey.yoursite.com"
order: 0
title: "Endpoint"
type: "string"
token:
airbyte_secret: true
description: "Your API Token. See here. The token is case sensitive."
order: 1
title: "Token"
type: "string"
x-speakeasy-param-sensitive: true
user_id:
description: "Your User Id."
order: 2
title: "User ID."
type: "string"
sourceType:
title: "rocket-chat"
const: "rocket-chat"
enum:
- "rocket-chat"
order: 0
type: "string"
required:
- "endpoint"
- "token"
- "user_id"
- "sourceType"
type: "object"
source-rocket-chat-update:
properties:
endpoint:
description: "Your rocket.chat instance URL."
examples:
- "https://airbyte-connector-poc.rocket.chat"
- "https://hey.yoursite.com"
order: 0
title: "Endpoint"
type: "string"
token:
airbyte_secret: true
description: "Your API Token. See here. The token is case sensitive."
order: 1
title: "Token"
type: "string"
user_id:
description: "Your User Id."
order: 2
title: "User ID."
type: "string"
required:
- "endpoint"
- "token"
- "user_id"
type: "object"
source-vwo:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "vwo"
const: "vwo"
enum:
- "vwo"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-vwo-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-aircall:
properties:
api_id:
airbyte_secret: true
description: "App ID found at settings https://dashboard.aircall.io/integrations/api-keys"
order: 0
title: "API ID"
type: "string"
x-speakeasy-param-sensitive: true
api_token:
airbyte_secret: true
description: "App token found at settings (Ref- https://dashboard.aircall.io/integrations/api-keys)"
order: 1
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "Date time filter for incremental filter, Specify which date\
\ to extract from."
examples:
- "2022-03-01T00:00:00.000Z"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$"
title: "Date-From Filter"
type: "string"
sourceType:
title: "aircall"
const: "aircall"
enum:
- "aircall"
order: 0
type: "string"
required:
- "api_id"
- "api_token"
- "start_date"
- "sourceType"
type: "object"
source-aircall-update:
properties:
api_id:
airbyte_secret: true
description: "App ID found at settings https://dashboard.aircall.io/integrations/api-keys"
order: 0
title: "API ID"
type: "string"
api_token:
airbyte_secret: true
description: "App token found at settings (Ref- https://dashboard.aircall.io/integrations/api-keys)"
order: 1
title: "API Token"
type: "string"
start_date:
description: "Date time filter for incremental filter, Specify which date\
\ to extract from."
examples:
- "2022-03-01T00:00:00.000Z"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$"
title: "Date-From Filter"
type: "string"
required:
- "api_id"
- "api_token"
- "start_date"
type: "object"
source-sharetribe:
properties:
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
x-speakeasy-param-sensitive: true
oauth_access_token:
airbyte_secret: true
description: "The current access token. This field might be overridden by\
\ the connector based on the token refresh endpoint response."
order: 3
title: "Access token"
type: "string"
x-speakeasy-param-sensitive: true
oauth_token_expiry_date:
description: "The date the current access token expires in. This field might\
\ be overridden by the connector based on the token refresh endpoint response."
format: "date-time"
order: 4
title: "Token expiry date"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "sharetribe"
const: "sharetribe"
enum:
- "sharetribe"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "start_date"
- "sourceType"
type: "object"
source-sharetribe-update:
properties:
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
oauth_access_token:
airbyte_secret: true
description: "The current access token. This field might be overridden by\
\ the connector based on the token refresh endpoint response."
order: 3
title: "Access token"
type: "string"
oauth_token_expiry_date:
description: "The date the current access token expires in. This field might\
\ be overridden by the connector based on the token refresh endpoint response."
format: "date-time"
order: 4
title: "Token expiry date"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "client_id"
- "client_secret"
- "start_date"
type: "object"
source-tmdb:
properties:
api_key:
airbyte_secret: true
description: "API Key from tmdb account"
order: 0
title: "Unique key for establishing connection"
type: "string"
x-speakeasy-param-sensitive: true
language:
description: "Language expressed in ISO 639-1 scheme, Mandate for required\
\ streams (Example en-US)"
examples:
- "en-US"
- "en-UK"
order: 1
title: "Language for filtering"
type: "string"
movie_id:
description: "Target movie ID, Mandate for movie streams (Example is 550)"
examples:
- 550
- 560
order: 2
title: "Movie ID for targeting movies"
type: "string"
query:
description: "Target movie ID, Mandate for search streams"
examples:
- "Marvel"
- "DC"
order: 3
title: "Query for search streams"
type: "string"
sourceType:
title: "tmdb"
const: "tmdb"
enum:
- "tmdb"
order: 0
type: "string"
required:
- "api_key"
- "language"
- "movie_id"
- "query"
- "sourceType"
type: "object"
source-tmdb-update:
properties:
api_key:
airbyte_secret: true
description: "API Key from tmdb account"
order: 0
title: "Unique key for establishing connection"
type: "string"
language:
description: "Language expressed in ISO 639-1 scheme, Mandate for required\
\ streams (Example en-US)"
examples:
- "en-US"
- "en-UK"
order: 1
title: "Language for filtering"
type: "string"
movie_id:
description: "Target movie ID, Mandate for movie streams (Example is 550)"
examples:
- 550
- 560
order: 2
title: "Movie ID for targeting movies"
type: "string"
query:
description: "Target movie ID, Mandate for search streams"
examples:
- "Marvel"
- "DC"
order: 3
title: "Query for search streams"
type: "string"
required:
- "api_key"
- "language"
- "movie_id"
- "query"
type: "object"
source-drift:
properties:
credentials:
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests."
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
client_id:
airbyte_secret: true
description: "The Client ID of your Drift developer application."
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The Client Secret of your Drift developer application."
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
credentials:
const: "oauth2.0"
order: 0
type: "string"
enum:
- "oauth2.0"
refresh_token:
airbyte_secret: true
description: "Refresh Token to renew the expired Access Token."
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "client_id"
- "client_secret"
- "access_token"
- "refresh_token"
title: "OAuth2.0"
type: "object"
- properties:
access_token:
airbyte_secret: true
description: "Drift Access Token. See the docs for more information on how to generate this key."
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
credentials:
const: "access_token"
order: 0
type: "string"
enum:
- "access_token"
required:
- "access_token"
title: "Access Token"
type: "object"
order: 0
title: "Authorization Method"
type: "object"
email:
default: "test@test.com"
description: "Email used as parameter for contacts stream"
order: 1
title: "Email parameter for contacts stream"
type: "string"
sourceType:
title: "drift"
const: "drift"
enum:
- "drift"
order: 0
type: "string"
required:
- "sourceType"
type: "object"
source-drift-update:
properties:
credentials:
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests."
title: "Access Token"
type: "string"
client_id:
airbyte_secret: true
description: "The Client ID of your Drift developer application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Drift developer application."
title: "Client Secret"
type: "string"
credentials:
const: "oauth2.0"
order: 0
type: "string"
enum:
- "oauth2.0"
refresh_token:
airbyte_secret: true
description: "Refresh Token to renew the expired Access Token."
title: "Refresh Token"
type: "string"
required:
- "client_id"
- "client_secret"
- "access_token"
- "refresh_token"
title: "OAuth2.0"
type: "object"
- properties:
access_token:
airbyte_secret: true
description: "Drift Access Token. See the docs for more information on how to generate this key."
title: "Access Token"
type: "string"
credentials:
const: "access_token"
order: 0
type: "string"
enum:
- "access_token"
required:
- "access_token"
title: "Access Token"
type: "object"
order: 0
title: "Authorization Method"
type: "object"
email:
default: "test@test.com"
description: "Email used as parameter for contacts stream"
order: 1
title: "Email parameter for contacts stream"
type: "string"
required: []
type: "object"
source-paddle:
properties:
api_key:
airbyte_secret: true
description: "Your Paddle API key. You can generate it by navigating to\
\ Paddle > Developer tools > Authentication > Generate API key. Treat\
\ this key like a password and keep it secure."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
environment:
default: "api"
description: "The environment for the Paddle API, either 'sandbox' or 'live'."
enum:
- "api"
- "sandbox-api"
name: "environment"
order: 1
title: "Environment"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "paddle"
const: "paddle"
enum:
- "paddle"
order: 0
type: "string"
required:
- "api_key"
- "environment"
- "start_date"
- "sourceType"
type: "object"
source-paddle-update:
properties:
api_key:
airbyte_secret: true
description: "Your Paddle API key. You can generate it by navigating to\
\ Paddle > Developer tools > Authentication > Generate API key. Treat\
\ this key like a password and keep it secure."
name: "api_key"
order: 0
title: "API Key"
type: "string"
environment:
default: "api"
description: "The environment for the Paddle API, either 'sandbox' or 'live'."
enum:
- "api"
- "sandbox-api"
name: "environment"
order: 1
title: "Environment"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "environment"
- "start_date"
type: "object"
source-snapchat-marketing:
properties:
action_report_time:
default: "conversion"
description: "Specifies the principle for conversion reporting."
enum:
- "conversion"
- "impression"
order: 5
title: "Action Report Time"
type: "string"
ad_account_ids:
description: "Ad Account IDs of the ad accounts to retrieve"
order: 9
title: "Ad Account IDs"
type: "array"
client_id:
airbyte_secret: true
description: "The Client ID of your Snapchat developer application."
order: 0
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The Client Secret of your Snapchat developer application."
order: 1
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
end_date:
description: "Date in the format 2017-01-25. Any data after this date will\
\ not be replicated."
examples:
- "2022-01-30"
format: "date"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "End Date"
type: "string"
organization_ids:
description: "The IDs of the organizations to retrieve"
order: 8
title: "Organization IDs"
type: "array"
refresh_token:
airbyte_secret: true
description: "Refresh Token to renew the expired Access Token."
order: 2
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
default: "2022-01-01"
description: "Date in the format 2022-01-01. Any data before this date will\
\ not be replicated."
examples:
- "2022-01-01"
format: "date"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
swipe_up_attribution_window:
default: "28_DAY"
description: "Attribution window for swipe ups."
enum:
- "1_DAY"
- "7_DAY"
- "28_DAY"
order: 6
title: "Swipe Up Attribution Window"
type: "string"
view_attribution_window:
default: "1_DAY"
description: "Attribution window for views."
enum:
- "1_HOUR"
- "3_HOUR"
- "6_HOUR"
- "1_DAY"
- "7_DAY"
order: 7
title: "View Attribution Window"
type: "string"
sourceType:
title: "snapchat-marketing"
const: "snapchat-marketing"
enum:
- "snapchat-marketing"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "sourceType"
type: "object"
source-snapchat-marketing-update:
properties:
action_report_time:
default: "conversion"
description: "Specifies the principle for conversion reporting."
enum:
- "conversion"
- "impression"
order: 5
title: "Action Report Time"
type: "string"
ad_account_ids:
description: "Ad Account IDs of the ad accounts to retrieve"
order: 9
title: "Ad Account IDs"
type: "array"
client_id:
airbyte_secret: true
description: "The Client ID of your Snapchat developer application."
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Snapchat developer application."
order: 1
title: "Client Secret"
type: "string"
end_date:
description: "Date in the format 2017-01-25. Any data after this date will\
\ not be replicated."
examples:
- "2022-01-30"
format: "date"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "End Date"
type: "string"
organization_ids:
description: "The IDs of the organizations to retrieve"
order: 8
title: "Organization IDs"
type: "array"
refresh_token:
airbyte_secret: true
description: "Refresh Token to renew the expired Access Token."
order: 2
title: "Refresh Token"
type: "string"
start_date:
default: "2022-01-01"
description: "Date in the format 2022-01-01. Any data before this date will\
\ not be replicated."
examples:
- "2022-01-01"
format: "date"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
swipe_up_attribution_window:
default: "28_DAY"
description: "Attribution window for swipe ups."
enum:
- "1_DAY"
- "7_DAY"
- "28_DAY"
order: 6
title: "Swipe Up Attribution Window"
type: "string"
view_attribution_window:
default: "1_DAY"
description: "Attribution window for views."
enum:
- "1_HOUR"
- "3_HOUR"
- "6_HOUR"
- "1_DAY"
- "7_DAY"
order: 7
title: "View Attribution Window"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
type: "object"
source-gitlab:
properties:
api_url:
default: "gitlab.com"
description: "Please enter your basic URL from GitLab instance."
examples:
- "gitlab.com"
- "https://gitlab.com"
- "https://gitlab.company.org"
order: 2
title: "API URL"
type: "string"
credentials:
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests."
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "oauth2.0"
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The API ID of the Gitlab developer application."
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The API Secret the Gitlab developer application."
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "The key to refresh the expired access_token."
type: "string"
x-speakeasy-param-sensitive: true
token_expiry_date:
description: "The date-time when the access token should be refreshed."
format: "date-time"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "access_token"
- "token_expiry_date"
title: "OAuth2.0"
type: "object"
- properties:
access_token:
airbyte_secret: true
description: "Log into your Gitlab account and then generate a personal\
\ Access Token."
title: "Private Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "access_token"
type: "string"
enum:
- "access_token"
required:
- "access_token"
title: "Private Token"
type: "object"
order: 0
title: "Authorization Method"
type: "object"
groups_list:
description: "List of groups. e.g. airbyte.io."
examples:
- "airbyte.io"
items:
type: "string"
order: 3
title: "Groups"
type: "array"
projects_list:
description: "Space-delimited list of projects. e.g. airbyte.io/documentation\
\ meltano/tap-gitlab."
examples:
- "airbyte.io/documentation"
items:
type: "string"
order: 4
title: "Projects"
type: "array"
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"
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
sourceType:
title: "gitlab"
const: "gitlab"
enum:
- "gitlab"
order: 0
type: "string"
required:
- "credentials"
- "sourceType"
title: "Source Gitlab Spec"
type: "object"
source-gitlab-update:
properties:
api_url:
default: "gitlab.com"
description: "Please enter your basic URL from GitLab instance."
examples:
- "gitlab.com"
- "https://gitlab.com"
- "https://gitlab.company.org"
order: 2
title: "API URL"
type: "string"
credentials:
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests."
type: "string"
auth_type:
const: "oauth2.0"
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The API ID of the Gitlab developer application."
type: "string"
client_secret:
airbyte_secret: true
description: "The API Secret the Gitlab developer application."
type: "string"
refresh_token:
airbyte_secret: true
description: "The key to refresh the expired access_token."
type: "string"
token_expiry_date:
description: "The date-time when the access token should be refreshed."
format: "date-time"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "access_token"
- "token_expiry_date"
title: "OAuth2.0"
type: "object"
- properties:
access_token:
airbyte_secret: true
description: "Log into your Gitlab account and then generate a personal\
\ Access Token."
title: "Private Token"
type: "string"
auth_type:
const: "access_token"
type: "string"
enum:
- "access_token"
required:
- "access_token"
title: "Private Token"
type: "object"
order: 0
title: "Authorization Method"
type: "object"
groups_list:
description: "List of groups. e.g. airbyte.io."
examples:
- "airbyte.io"
items:
type: "string"
order: 3
title: "Groups"
type: "array"
projects_list:
description: "Space-delimited list of projects. e.g. airbyte.io/documentation\
\ meltano/tap-gitlab."
examples:
- "airbyte.io/documentation"
items:
type: "string"
order: 4
title: "Projects"
type: "array"
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"
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
required:
- "credentials"
title: "Source Gitlab Spec"
type: "object"
source-launchdarkly:
properties:
access_token:
airbyte_secret: true
description: "Your Access token. See here."
order: 0
title: "Access token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "launchdarkly"
const: "launchdarkly"
enum:
- "launchdarkly"
order: 0
type: "string"
required:
- "access_token"
- "sourceType"
type: "object"
source-launchdarkly-update:
properties:
access_token:
airbyte_secret: true
description: "Your Access token. See here."
order: 0
title: "Access token"
type: "string"
required:
- "access_token"
type: "object"
source-pandadoc:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it at https://app.pandadoc.com/a/#/settings/api-dashboard/configuration"
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "pandadoc"
const: "pandadoc"
enum:
- "pandadoc"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-pandadoc-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it at https://app.pandadoc.com/a/#/settings/api-dashboard/configuration"
name: "api_key"
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-sage-hr:
properties:
api_key:
airbyte_secret: true
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
subdomain:
order: 1
title: "subdomain"
type: "string"
sourceType:
title: "sage-hr"
const: "sage-hr"
enum:
- "sage-hr"
order: 0
type: "string"
required:
- "api_key"
- "subdomain"
- "sourceType"
type: "object"
source-sage-hr-update:
properties:
api_key:
airbyte_secret: true
name: "api_key"
order: 0
title: "API Key"
type: "string"
subdomain:
order: 1
title: "subdomain"
type: "string"
required:
- "api_key"
- "subdomain"
type: "object"
source-thinkific-courses:
properties:
X-Auth-Subdomain:
order: 1
title: "subdomain"
type: "string"
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "thinkific-courses"
const: "thinkific-courses"
enum:
- "thinkific-courses"
order: 0
type: "string"
required:
- "api_key"
- "X-Auth-Subdomain"
- "sourceType"
type: "object"
source-thinkific-courses-update:
properties:
X-Auth-Subdomain:
order: 1
title: "subdomain"
type: "string"
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
- "X-Auth-Subdomain"
type: "object"
source-linnworks:
properties:
application_id:
description: "Linnworks Application ID"
title: "Application ID."
type: "string"
application_secret:
airbyte_secret: true
description: "Linnworks Application Secret"
title: "Application Secret"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\
\ data before this date will not be replicated."
format: "date-time"
title: "Start Date"
type: "string"
token:
airbyte_secret: true
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "linnworks"
const: "linnworks"
enum:
- "linnworks"
order: 0
type: "string"
required:
- "application_id"
- "application_secret"
- "token"
- "start_date"
- "sourceType"
title: "Linnworks Spec"
type: "object"
source-linnworks-update:
properties:
application_id:
description: "Linnworks Application ID"
title: "Application ID."
type: "string"
application_secret:
airbyte_secret: true
description: "Linnworks Application Secret"
title: "Application Secret"
type: "string"
start_date:
description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\
\ data before this date will not be replicated."
format: "date-time"
title: "Start Date"
type: "string"
token:
airbyte_secret: true
title: "API Token"
type: "string"
required:
- "application_id"
- "application_secret"
- "token"
- "start_date"
title: "Linnworks Spec"
type: "object"
source-paperform:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Generate it on your account page at https://paperform.co/account/developer."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "paperform"
const: "paperform"
enum:
- "paperform"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-paperform-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Generate it on your account page at https://paperform.co/account/developer."
name: "api_key"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-microsoft-sharepoint:
description: "SourceMicrosoftSharePointSpec class for Microsoft SharePoint Source\
\ Specification.\nThis class combines the authentication details with additional\
\ configuration for the SharePoint API."
properties:
credentials:
description: "Credentials for connecting to the One Drive API"
oneOf:
- description: "OAuthCredentials class to hold authentication details for\
\ Microsoft OAuth authentication.\nThis class uses pydantic for data\
\ validation and settings management."
properties:
auth_type:
const: "Client"
default: "Client"
enum:
- "Client"
title: "Auth Type"
type: "string"
client_id:
airbyte_secret: true
description: "Client ID of your Microsoft developer application"
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "Client Secret of your Microsoft developer application"
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "Refresh Token of your Microsoft developer application"
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
tenant_id:
airbyte_secret: true
description: "Tenant ID of the Microsoft SharePoint user"
title: "Tenant ID"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tenant_id"
- "client_id"
- "client_secret"
title: "Authenticate via Microsoft (OAuth)"
type: "object"
- description: "ServiceCredentials class for service key authentication.\n\
This class is structured similarly to OAuthCredentials but for a different\
\ authentication method."
properties:
auth_type:
const: "Service"
default: "Service"
enum:
- "Service"
title: "Auth Type"
type: "string"
client_id:
airbyte_secret: true
description: "Client ID of your Microsoft developer application"
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "Client Secret of your Microsoft developer application"
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
tenant_id:
airbyte_secret: true
description: "Tenant ID of the Microsoft SharePoint user"
title: "Tenant ID"
type: "string"
x-speakeasy-param-sensitive: true
user_principal_name:
airbyte_secret: true
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"
title: "User Principal Name"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tenant_id"
- "user_principal_name"
- "client_id"
- "client_secret"
title: "Service Key Authentication"
type: "object"
order: 0
title: "Authentication"
type: "object"
delivery_method:
default: "use_records_transfer"
display_type: "radio"
group: "advanced"
oneOf:
- description: "Recommended - Extract and load structured records into your\
\ destination of choice. This is the classic method of moving data in\
\ Airbyte. It allows for blocking and hashing individual fields or files\
\ from a structured schema. Data can be flattened, typed and deduped\
\ depending on the destination."
properties:
delivery_type:
const: "use_records_transfer"
default: "use_records_transfer"
enum:
- "use_records_transfer"
title: "Delivery Type"
type: "string"
required:
- "delivery_type"
title: "Replicate Records"
type: "object"
- description: "Copy raw files without parsing their contents. Bits are\
\ copied into the destination exactly as they appeared in the source.\
\ Recommended for use with unstructured text data, non-text and compressed\
\ files."
properties:
delivery_type:
const: "use_file_transfer"
default: "use_file_transfer"
enum:
- "use_file_transfer"
title: "Delivery Type"
type: "string"
preserve_directory_structure:
default: true
description: "If enabled, sends subdirectory folder structure along\
\ with source file names to the destination. Otherwise, files will\
\ be synced by their names only. This option is ignored when file-based\
\ replication is not enabled."
title: "Preserve Sub-Directories in File Paths"
type: "boolean"
required:
- "delivery_type"
title: "Copy Raw Files"
type: "object"
order: 1
title: "Delivery Method"
type: "object"
folder_path:
default: "."
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."
order: 4
title: "Folder Path"
type: "string"
search_scope:
default: "ALL"
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."
enum:
- "ACCESSIBLE_DRIVES"
- "SHARED_ITEMS"
- "ALL"
order: 3
title: "Search Scope"
type: "string"
site_url:
default: ""
description: "Url of SharePoint site to search for files. Leave empty to\
\ search in the main site. Use 'https://.sharepoint.com/sites/'\
\ to iterate over all sites."
order: 5
title: "Site URL"
type: "string"
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"
order: 1
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"
title: "Start Date"
type: "string"
streams:
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."
items:
properties:
days_to_sync_if_history_is_full:
default: 3
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."
title: "Days To Sync If History Is Full"
type: "integer"
format:
description: "The configuration options that are used to alter how\
\ to read incoming files that deviate from the standard formatting."
oneOf:
- properties:
double_as_string:
default: false
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."
title: "Convert Double Fields to Strings"
type: "boolean"
filetype:
const: "avro"
default: "avro"
title: "Filetype"
type: "string"
enum:
- "avro"
required:
- "filetype"
title: "Avro Format"
type: "object"
- properties:
delimiter:
default: ","
description: "The character delimiting individual cells in the\
\ CSV data. This may only be a 1-character string. For tab-delimited\
\ data enter '\\t'."
title: "Delimiter"
type: "string"
double_quote:
default: true
description: "Whether two quotes in a quoted CSV value denote\
\ a single quote in the data."
title: "Double Quote"
type: "boolean"
encoding:
default: "utf8"
description: "The character encoding of the CSV data. Leave\
\ blank to default to UTF8. See list of python encodings for allowable\
\ options."
title: "Encoding"
type: "string"
escape_char:
description: "The character used for escaping special characters.\
\ To disallow escaping, leave this field blank."
title: "Escape Character"
type: "string"
false_values:
default:
- "n"
- "no"
- "f"
- "false"
- "off"
- "0"
description: "A set of case-sensitive strings that should be\
\ interpreted as false values."
items:
type: "string"
title: "False Values"
type: "array"
uniqueItems: true
filetype:
const: "csv"
default: "csv"
title: "Filetype"
type: "string"
enum:
- "csv"
header_definition:
default:
header_definition_type: "From CSV"
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."
oneOf:
- properties:
header_definition_type:
const: "From CSV"
default: "From CSV"
title: "Header Definition Type"
type: "string"
enum:
- "From CSV"
required:
- "header_definition_type"
title: "From CSV"
type: "object"
- properties:
header_definition_type:
const: "Autogenerated"
default: "Autogenerated"
title: "Header Definition Type"
type: "string"
enum:
- "Autogenerated"
required:
- "header_definition_type"
title: "Autogenerated"
type: "object"
- properties:
column_names:
description: "The column names that will be used while\
\ emitting the CSV records"
items:
type: "string"
title: "Column Names"
type: "array"
header_definition_type:
const: "User Provided"
default: "User Provided"
title: "Header Definition Type"
type: "string"
enum:
- "User Provided"
required:
- "column_names"
- "header_definition_type"
title: "User Provided"
type: "object"
title: "CSV Header Definition"
type: "object"
ignore_errors_on_fields_mismatch:
default: false
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."
title: "Ignore errors on field mismatch"
type: "boolean"
null_values:
default: []
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."
items:
type: "string"
title: "Null Values"
type: "array"
uniqueItems: true
quote_char:
default: "\""
description: "The character used for quoting CSV values. To\
\ disallow quoting, make this field blank."
title: "Quote Character"
type: "string"
skip_rows_after_header:
default: 0
description: "The number of rows to skip after the header row."
title: "Skip Rows After Header"
type: "integer"
skip_rows_before_header:
default: 0
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."
title: "Skip Rows Before Header"
type: "integer"
strings_can_be_null:
default: true
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."
title: "Strings Can Be Null"
type: "boolean"
true_values:
default:
- "y"
- "yes"
- "t"
- "true"
- "on"
- "1"
description: "A set of case-sensitive strings that should be\
\ interpreted as true values."
items:
type: "string"
title: "True Values"
type: "array"
uniqueItems: true
required:
- "filetype"
title: "CSV Format"
type: "object"
- properties:
filetype:
const: "jsonl"
default: "jsonl"
title: "Filetype"
type: "string"
enum:
- "jsonl"
required:
- "filetype"
title: "Jsonl Format"
type: "object"
- properties:
decimal_as_float:
default: false
description: "Whether to convert decimal fields to floats. There\
\ is a loss of precision when converting decimals to floats,\
\ so this is not recommended."
title: "Convert Decimal Fields to Floats"
type: "boolean"
filetype:
const: "parquet"
default: "parquet"
title: "Filetype"
type: "string"
enum:
- "parquet"
required:
- "filetype"
title: "Parquet Format"
type: "object"
- description: "Extract text from document formats (.pdf, .docx, .md,\
\ .pptx) and emit as one record per file."
properties:
filetype:
const: "unstructured"
default: "unstructured"
title: "Filetype"
type: "string"
enum:
- "unstructured"
processing:
default:
mode: "local"
description: "Processing configuration"
oneOf:
- description: "Process files locally, supporting `fast` and\
\ `ocr` modes. This is the default option."
properties:
mode:
const: "local"
default: "local"
enum:
- "local"
title: "Mode"
type: "string"
required:
- "mode"
title: "Local"
type: "object"
title: "Processing"
type: "object"
skip_unprocessable_files:
always_show: true
default: true
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."
title: "Skip Unprocessable Files"
type: "boolean"
strategy:
always_show: true
default: "auto"
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"
enum:
- "auto"
- "fast"
- "ocr_only"
- "hi_res"
order: 0
title: "Parsing Strategy"
type: "string"
required:
- "filetype"
title: "Unstructured Document Format"
type: "object"
- properties:
filetype:
const: "excel"
default: "excel"
title: "Filetype"
type: "string"
enum:
- "excel"
required:
- "filetype"
title: "Excel Format"
type: "object"
title: "Format"
type: "object"
globs:
default:
- "**"
description: "The pattern used to specify which files should be selected\
\ from the file system. For more information on glob pattern matching\
\ look here."
items:
type: "string"
order: 1
title: "Globs"
type: "array"
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."
title: "Input Schema"
type: "string"
name:
description: "The name of the stream."
title: "Name"
type: "string"
recent_n_files_to_read_for_schema_discovery:
description: "The number of resent files which will be used to discover\
\ the schema for this stream."
exclusiveMinimum: 0
title: "Files To Read For Schema Discover"
type: "integer"
schemaless:
default: false
description: "When enabled, syncs will not validate or structure records\
\ against the stream's schema."
title: "Schemaless"
type: "boolean"
validation_policy:
default: "Emit Record"
description: "The name of the validation policy that dictates sync\
\ behavior when a record does not adhere to the stream schema."
enum:
- "Emit Record"
- "Skip Record"
- "Wait for Discover"
title: "Validation Policy"
required:
- "name"
- "format"
title: "FileBasedStreamConfig"
type: "object"
order: 10
title: "The list of streams to sync"
type: "array"
sourceType:
title: "microsoft-sharepoint"
const: "microsoft-sharepoint"
enum:
- "microsoft-sharepoint"
order: 0
type: "string"
required:
- "streams"
- "credentials"
- "sourceType"
title: "Microsoft SharePoint Source Spec"
type: "object"
source-microsoft-sharepoint-update:
description: "SourceMicrosoftSharePointSpec class for Microsoft SharePoint Source\
\ Specification.\nThis class combines the authentication details with additional\
\ configuration for the SharePoint API."
properties:
credentials:
description: "Credentials for connecting to the One Drive API"
oneOf:
- description: "OAuthCredentials class to hold authentication details for\
\ Microsoft OAuth authentication.\nThis class uses pydantic for data\
\ validation and settings management."
properties:
auth_type:
const: "Client"
default: "Client"
enum:
- "Client"
title: "Auth Type"
type: "string"
client_id:
airbyte_secret: true
description: "Client ID of your Microsoft developer application"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Client Secret of your Microsoft developer application"
title: "Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "Refresh Token of your Microsoft developer application"
title: "Refresh Token"
type: "string"
tenant_id:
airbyte_secret: true
description: "Tenant ID of the Microsoft SharePoint user"
title: "Tenant ID"
type: "string"
required:
- "tenant_id"
- "client_id"
- "client_secret"
title: "Authenticate via Microsoft (OAuth)"
type: "object"
- description: "ServiceCredentials class for service key authentication.\n\
This class is structured similarly to OAuthCredentials but for a different\
\ authentication method."
properties:
auth_type:
const: "Service"
default: "Service"
enum:
- "Service"
title: "Auth Type"
type: "string"
client_id:
airbyte_secret: true
description: "Client ID of your Microsoft developer application"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Client Secret of your Microsoft developer application"
title: "Client Secret"
type: "string"
tenant_id:
airbyte_secret: true
description: "Tenant ID of the Microsoft SharePoint user"
title: "Tenant ID"
type: "string"
user_principal_name:
airbyte_secret: true
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"
title: "User Principal Name"
type: "string"
required:
- "tenant_id"
- "user_principal_name"
- "client_id"
- "client_secret"
title: "Service Key Authentication"
type: "object"
order: 0
title: "Authentication"
type: "object"
delivery_method:
default: "use_records_transfer"
display_type: "radio"
group: "advanced"
oneOf:
- description: "Recommended - Extract and load structured records into your\
\ destination of choice. This is the classic method of moving data in\
\ Airbyte. It allows for blocking and hashing individual fields or files\
\ from a structured schema. Data can be flattened, typed and deduped\
\ depending on the destination."
properties:
delivery_type:
const: "use_records_transfer"
default: "use_records_transfer"
enum:
- "use_records_transfer"
title: "Delivery Type"
type: "string"
required:
- "delivery_type"
title: "Replicate Records"
type: "object"
- description: "Copy raw files without parsing their contents. Bits are\
\ copied into the destination exactly as they appeared in the source.\
\ Recommended for use with unstructured text data, non-text and compressed\
\ files."
properties:
delivery_type:
const: "use_file_transfer"
default: "use_file_transfer"
enum:
- "use_file_transfer"
title: "Delivery Type"
type: "string"
preserve_directory_structure:
default: true
description: "If enabled, sends subdirectory folder structure along\
\ with source file names to the destination. Otherwise, files will\
\ be synced by their names only. This option is ignored when file-based\
\ replication is not enabled."
title: "Preserve Sub-Directories in File Paths"
type: "boolean"
required:
- "delivery_type"
title: "Copy Raw Files"
type: "object"
order: 1
title: "Delivery Method"
type: "object"
folder_path:
default: "."
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."
order: 4
title: "Folder Path"
type: "string"
search_scope:
default: "ALL"
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."
enum:
- "ACCESSIBLE_DRIVES"
- "SHARED_ITEMS"
- "ALL"
order: 3
title: "Search Scope"
type: "string"
site_url:
default: ""
description: "Url of SharePoint site to search for files. Leave empty to\
\ search in the main site. Use 'https://.sharepoint.com/sites/'\
\ to iterate over all sites."
order: 5
title: "Site URL"
type: "string"
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"
order: 1
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"
title: "Start Date"
type: "string"
streams:
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."
items:
properties:
days_to_sync_if_history_is_full:
default: 3
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."
title: "Days To Sync If History Is Full"
type: "integer"
format:
description: "The configuration options that are used to alter how\
\ to read incoming files that deviate from the standard formatting."
oneOf:
- properties:
double_as_string:
default: false
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."
title: "Convert Double Fields to Strings"
type: "boolean"
filetype:
const: "avro"
default: "avro"
title: "Filetype"
type: "string"
enum:
- "avro"
required:
- "filetype"
title: "Avro Format"
type: "object"
- properties:
delimiter:
default: ","
description: "The character delimiting individual cells in the\
\ CSV data. This may only be a 1-character string. For tab-delimited\
\ data enter '\\t'."
title: "Delimiter"
type: "string"
double_quote:
default: true
description: "Whether two quotes in a quoted CSV value denote\
\ a single quote in the data."
title: "Double Quote"
type: "boolean"
encoding:
default: "utf8"
description: "The character encoding of the CSV data. Leave\
\ blank to default to UTF8. See list of python encodings for allowable\
\ options."
title: "Encoding"
type: "string"
escape_char:
description: "The character used for escaping special characters.\
\ To disallow escaping, leave this field blank."
title: "Escape Character"
type: "string"
false_values:
default:
- "n"
- "no"
- "f"
- "false"
- "off"
- "0"
description: "A set of case-sensitive strings that should be\
\ interpreted as false values."
items:
type: "string"
title: "False Values"
type: "array"
uniqueItems: true
filetype:
const: "csv"
default: "csv"
title: "Filetype"
type: "string"
enum:
- "csv"
header_definition:
default:
header_definition_type: "From CSV"
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."
oneOf:
- properties:
header_definition_type:
const: "From CSV"
default: "From CSV"
title: "Header Definition Type"
type: "string"
enum:
- "From CSV"
required:
- "header_definition_type"
title: "From CSV"
type: "object"
- properties:
header_definition_type:
const: "Autogenerated"
default: "Autogenerated"
title: "Header Definition Type"
type: "string"
enum:
- "Autogenerated"
required:
- "header_definition_type"
title: "Autogenerated"
type: "object"
- properties:
column_names:
description: "The column names that will be used while\
\ emitting the CSV records"
items:
type: "string"
title: "Column Names"
type: "array"
header_definition_type:
const: "User Provided"
default: "User Provided"
title: "Header Definition Type"
type: "string"
enum:
- "User Provided"
required:
- "column_names"
- "header_definition_type"
title: "User Provided"
type: "object"
title: "CSV Header Definition"
type: "object"
ignore_errors_on_fields_mismatch:
default: false
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."
title: "Ignore errors on field mismatch"
type: "boolean"
null_values:
default: []
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."
items:
type: "string"
title: "Null Values"
type: "array"
uniqueItems: true
quote_char:
default: "\""
description: "The character used for quoting CSV values. To\
\ disallow quoting, make this field blank."
title: "Quote Character"
type: "string"
skip_rows_after_header:
default: 0
description: "The number of rows to skip after the header row."
title: "Skip Rows After Header"
type: "integer"
skip_rows_before_header:
default: 0
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."
title: "Skip Rows Before Header"
type: "integer"
strings_can_be_null:
default: true
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."
title: "Strings Can Be Null"
type: "boolean"
true_values:
default:
- "y"
- "yes"
- "t"
- "true"
- "on"
- "1"
description: "A set of case-sensitive strings that should be\
\ interpreted as true values."
items:
type: "string"
title: "True Values"
type: "array"
uniqueItems: true
required:
- "filetype"
title: "CSV Format"
type: "object"
- properties:
filetype:
const: "jsonl"
default: "jsonl"
title: "Filetype"
type: "string"
enum:
- "jsonl"
required:
- "filetype"
title: "Jsonl Format"
type: "object"
- properties:
decimal_as_float:
default: false
description: "Whether to convert decimal fields to floats. There\
\ is a loss of precision when converting decimals to floats,\
\ so this is not recommended."
title: "Convert Decimal Fields to Floats"
type: "boolean"
filetype:
const: "parquet"
default: "parquet"
title: "Filetype"
type: "string"
enum:
- "parquet"
required:
- "filetype"
title: "Parquet Format"
type: "object"
- description: "Extract text from document formats (.pdf, .docx, .md,\
\ .pptx) and emit as one record per file."
properties:
filetype:
const: "unstructured"
default: "unstructured"
title: "Filetype"
type: "string"
enum:
- "unstructured"
processing:
default:
mode: "local"
description: "Processing configuration"
oneOf:
- description: "Process files locally, supporting `fast` and\
\ `ocr` modes. This is the default option."
properties:
mode:
const: "local"
default: "local"
enum:
- "local"
title: "Mode"
type: "string"
required:
- "mode"
title: "Local"
type: "object"
title: "Processing"
type: "object"
skip_unprocessable_files:
always_show: true
default: true
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."
title: "Skip Unprocessable Files"
type: "boolean"
strategy:
always_show: true
default: "auto"
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"
enum:
- "auto"
- "fast"
- "ocr_only"
- "hi_res"
order: 0
title: "Parsing Strategy"
type: "string"
required:
- "filetype"
title: "Unstructured Document Format"
type: "object"
- properties:
filetype:
const: "excel"
default: "excel"
title: "Filetype"
type: "string"
enum:
- "excel"
required:
- "filetype"
title: "Excel Format"
type: "object"
title: "Format"
type: "object"
globs:
default:
- "**"
description: "The pattern used to specify which files should be selected\
\ from the file system. For more information on glob pattern matching\
\ look here."
items:
type: "string"
order: 1
title: "Globs"
type: "array"
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."
title: "Input Schema"
type: "string"
name:
description: "The name of the stream."
title: "Name"
type: "string"
recent_n_files_to_read_for_schema_discovery:
description: "The number of resent files which will be used to discover\
\ the schema for this stream."
exclusiveMinimum: 0
title: "Files To Read For Schema Discover"
type: "integer"
schemaless:
default: false
description: "When enabled, syncs will not validate or structure records\
\ against the stream's schema."
title: "Schemaless"
type: "boolean"
validation_policy:
default: "Emit Record"
description: "The name of the validation policy that dictates sync\
\ behavior when a record does not adhere to the stream schema."
enum:
- "Emit Record"
- "Skip Record"
- "Wait for Discover"
title: "Validation Policy"
required:
- "name"
- "format"
title: "FileBasedStreamConfig"
type: "object"
order: 10
title: "The list of streams to sync"
type: "array"
required:
- "streams"
- "credentials"
title: "Microsoft SharePoint Source Spec"
type: "object"
source-svix:
properties:
api_key:
airbyte_secret: true
description: "API key or access token"
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "svix"
const: "svix"
enum:
- "svix"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-svix-update:
properties:
api_key:
airbyte_secret: true
description: "API key or access token"
name: "api_key"
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-amazon-sqs:
properties:
access_key:
airbyte_secret: true
description: "The Access Key ID of the AWS IAM Role to use for pulling messages"
examples:
- "xxxxxHRNxxx3TBxxxxxx"
order: 6
title: "AWS IAM Access Key ID"
type: "string"
x-speakeasy-param-sensitive: true
attributes_to_return:
default: "All"
description: "Comma separated list of Mesage Attribute names to return"
examples:
- "attr1,attr2"
order: 4
title: "Message Attributes To Return"
type: "string"
max_batch_size:
default: 10
description: "Max amount of messages to get in one batch (10 max)"
examples:
- 5
order: 2
title: "Max Batch Size"
type: "integer"
max_wait_time:
default: 20
description: "Max amount of time in seconds to wait for messages in a single\
\ poll (20 max)"
examples:
- 5
order: 3
title: "Max Wait Time"
type: "integer"
queue_url:
description: "URL of the SQS Queue"
examples:
- "https://sqs.eu-west-1.amazonaws.com/1234567890/my-example-queue"
order: 0
title: "Queue URL"
type: "string"
region:
default: "us-east-1"
description: "AWS Region of the SQS Queue"
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
title: "AWS Region"
type: "string"
secret_key:
airbyte_secret: true
description: "The Secret Key of the AWS IAM Role to use for pulling messages"
examples:
- "hu+qE5exxxxT6o/ZrKsxxxxxxBhxxXLexxxxxVKz"
order: 7
title: "AWS IAM Secret Key"
type: "string"
x-speakeasy-param-sensitive: true
target:
default: "ReceiveMessage"
description: "Note - Different targets have different attribute enum requirements,\
\ please refer actions sections in https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/Welcome.html"
enum:
- "GetQueueAttributes"
- "ReceiveMessage"
order: 8
title: "The targeted action resource for the fetch"
type: "string"
visibility_timeout:
default: 20
description: "Modify the Visibility Timeout of the individual message from\
\ the Queue's default (seconds)."
examples:
- 20
order: 5
title: "Message Visibility Timeout"
type: "integer"
sourceType:
title: "amazon-sqs"
const: "amazon-sqs"
enum:
- "amazon-sqs"
order: 0
type: "string"
required:
- "queue_url"
- "region"
- "access_key"
- "secret_key"
- "sourceType"
type: "object"
source-amazon-sqs-update:
properties:
access_key:
airbyte_secret: true
description: "The Access Key ID of the AWS IAM Role to use for pulling messages"
examples:
- "xxxxxHRNxxx3TBxxxxxx"
order: 6
title: "AWS IAM Access Key ID"
type: "string"
attributes_to_return:
default: "All"
description: "Comma separated list of Mesage Attribute names to return"
examples:
- "attr1,attr2"
order: 4
title: "Message Attributes To Return"
type: "string"
max_batch_size:
default: 10
description: "Max amount of messages to get in one batch (10 max)"
examples:
- 5
order: 2
title: "Max Batch Size"
type: "integer"
max_wait_time:
default: 20
description: "Max amount of time in seconds to wait for messages in a single\
\ poll (20 max)"
examples:
- 5
order: 3
title: "Max Wait Time"
type: "integer"
queue_url:
description: "URL of the SQS Queue"
examples:
- "https://sqs.eu-west-1.amazonaws.com/1234567890/my-example-queue"
order: 0
title: "Queue URL"
type: "string"
region:
default: "us-east-1"
description: "AWS Region of the SQS Queue"
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
title: "AWS Region"
type: "string"
secret_key:
airbyte_secret: true
description: "The Secret Key of the AWS IAM Role to use for pulling messages"
examples:
- "hu+qE5exxxxT6o/ZrKsxxxxxxBhxxXLexxxxxVKz"
order: 7
title: "AWS IAM Secret Key"
type: "string"
target:
default: "ReceiveMessage"
description: "Note - Different targets have different attribute enum requirements,\
\ please refer actions sections in https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/Welcome.html"
enum:
- "GetQueueAttributes"
- "ReceiveMessage"
order: 8
title: "The targeted action resource for the fetch"
type: "string"
visibility_timeout:
default: 20
description: "Modify the Visibility Timeout of the individual message from\
\ the Queue's default (seconds)."
examples:
- 20
order: 5
title: "Message Visibility Timeout"
type: "integer"
required:
- "queue_url"
- "region"
- "access_key"
- "secret_key"
type: "object"
source-sonar-cloud:
properties:
component_keys:
description: "Comma-separated list of component keys."
examples:
- "airbyte-ws-order"
- "airbyte-ws-checkout"
order: 0
title: "Component Keys"
type: "array"
end_date:
description: "To retrieve issues created before the given date (inclusive)."
examples:
- "YYYY-MM-DD"
format: "date"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "End date"
type: "string"
organization:
description: "Organization key. See here."
examples:
- "airbyte"
order: 2
title: "Organization"
type: "string"
start_date:
description: "To retrieve issues created after the given date (inclusive)."
examples:
- "YYYY-MM-DD"
format: "date"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start date"
type: "string"
user_token:
airbyte_secret: true
description: "Your User Token. See here. The token is case sensitive."
order: 4
title: "User Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "sonar-cloud"
const: "sonar-cloud"
enum:
- "sonar-cloud"
order: 0
type: "string"
required:
- "component_keys"
- "organization"
- "user_token"
- "sourceType"
type: "object"
source-sonar-cloud-update:
properties:
component_keys:
description: "Comma-separated list of component keys."
examples:
- "airbyte-ws-order"
- "airbyte-ws-checkout"
order: 0
title: "Component Keys"
type: "array"
end_date:
description: "To retrieve issues created before the given date (inclusive)."
examples:
- "YYYY-MM-DD"
format: "date"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "End date"
type: "string"
organization:
description: "Organization key. See here."
examples:
- "airbyte"
order: 2
title: "Organization"
type: "string"
start_date:
description: "To retrieve issues created after the given date (inclusive)."
examples:
- "YYYY-MM-DD"
format: "date"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start date"
type: "string"
user_token:
airbyte_secret: true
description: "Your User Token. See here. The token is case sensitive."
order: 4
title: "User Token"
type: "string"
required:
- "component_keys"
- "organization"
- "user_token"
type: "object"
source-everhour:
properties:
api_key:
airbyte_secret: true
description: "Everhour API Key. See the docs for information on how to generate this key."
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "everhour"
const: "everhour"
enum:
- "everhour"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-everhour-update:
properties:
api_key:
airbyte_secret: true
description: "Everhour API Key. See the docs for information on how to generate this key."
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-tinyemail:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "tinyemail"
const: "tinyemail"
enum:
- "tinyemail"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-tinyemail-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-lob:
properties:
api_key:
airbyte_secret: true
description: "API key to use for authentication. You can find your account's\
\ API keys in your Dashboard Settings at https://dashboard.lob.com/settings/api-keys."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
limit:
default: "50"
description: "Max records per page limit"
order: 2
title: "Limit"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "lob"
const: "lob"
enum:
- "lob"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-lob-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use for authentication. You can find your account's\
\ API keys in your Dashboard Settings at https://dashboard.lob.com/settings/api-keys."
name: "api_key"
order: 0
title: "API Key"
type: "string"
limit:
default: "50"
description: "Max records per page limit"
order: 2
title: "Limit"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-emailoctopus:
properties:
api_key:
airbyte_secret: true
description: "EmailOctopus API Key. See the docs for information on how to generate this key."
order: 0
title: "EmailOctopus API key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "emailoctopus"
const: "emailoctopus"
enum:
- "emailoctopus"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-emailoctopus-update:
properties:
api_key:
airbyte_secret: true
description: "EmailOctopus API Key. See the docs for information on how to generate this key."
order: 0
title: "EmailOctopus API key"
type: "string"
required:
- "api_key"
type: "object"
source-railz:
properties:
client_id:
description: "Client ID (client_id)"
order: 0
title: "Client ID"
type: "string"
secret_key:
airbyte_secret: true
description: "Secret key (secret_key)"
order: 1
title: "Secret key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "Start date"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start date"
type: "string"
sourceType:
title: "railz"
const: "railz"
enum:
- "railz"
order: 0
type: "string"
required:
- "client_id"
- "secret_key"
- "start_date"
- "sourceType"
schema: "http://json-schema.org/draft-07/schema#"
type: "object"
source-railz-update:
properties:
client_id:
description: "Client ID (client_id)"
order: 0
title: "Client ID"
type: "string"
secret_key:
airbyte_secret: true
description: "Secret key (secret_key)"
order: 1
title: "Secret key"
type: "string"
start_date:
description: "Start date"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start date"
type: "string"
required:
- "client_id"
- "secret_key"
- "start_date"
schema: "http://json-schema.org/draft-07/schema#"
type: "object"
source-apptivo:
properties:
access_key:
airbyte_secret: true
order: 1
title: "Access Key"
type: "string"
x-speakeasy-param-sensitive: true
api_key:
airbyte_secret: true
description: "API key to use. Find it in your Apptivo account under Business\
\ Settings -> API Access."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "apptivo"
const: "apptivo"
enum:
- "apptivo"
order: 0
type: "string"
required:
- "api_key"
- "access_key"
- "sourceType"
type: "object"
source-apptivo-update:
properties:
access_key:
airbyte_secret: true
order: 1
title: "Access Key"
type: "string"
api_key:
airbyte_secret: true
description: "API key to use. Find it in your Apptivo account under Business\
\ Settings -> API Access."
name: "api_key"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
- "access_key"
type: "object"
source-zonka-feedback:
properties:
auth_token:
airbyte_secret: true
description: "Auth token to use. Generate it by navigating to Company Settings\
\ > Developers > API in your Zonka Feedback account."
name: "auth_token"
order: 1
title: "Auth Token"
type: "string"
x-speakeasy-param-sensitive: true
datacenter:
description: "The identifier for the data center, such as 'us1' or 'e' for\
\ EU."
enum:
- "us1"
- "e"
name: "dc_id"
order: 0
title: "Data Center ID"
type: "string"
sourceType:
title: "zonka-feedback"
const: "zonka-feedback"
enum:
- "zonka-feedback"
order: 0
type: "string"
required:
- "datacenter"
- "auth_token"
- "sourceType"
type: "object"
source-zonka-feedback-update:
properties:
auth_token:
airbyte_secret: true
description: "Auth token to use. Generate it by navigating to Company Settings\
\ > Developers > API in your Zonka Feedback account."
name: "auth_token"
order: 1
title: "Auth Token"
type: "string"
datacenter:
description: "The identifier for the data center, such as 'us1' or 'e' for\
\ EU."
enum:
- "us1"
- "e"
name: "dc_id"
order: 0
title: "Data Center ID"
type: "string"
required:
- "datacenter"
- "auth_token"
type: "object"
source-orb:
properties:
api_key:
airbyte_secret: true
description: "Orb API Key, issued from the Orb admin console."
order: 0
title: "Orb API Key"
type: "string"
x-speakeasy-param-sensitive: true
end_date:
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: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "End Date"
type: "string"
lookback_window_days:
default: 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."
minimum: 0
order: 3
title: "Lookback Window (in days)"
type: "integer"
numeric_event_properties_keys:
description: "Property key names to extract from all events, in order to\
\ enrich ledger entries corresponding to an event deduction."
items:
type: "string"
order: 5
title: "Event properties keys (numeric values)"
type: "array"
plan_id:
description: "Orb Plan ID to filter subscriptions that should have usage\
\ fetched."
order: 7
title: "Orb Plan ID for Subscription Usage (string value)"
type: "string"
start_date:
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"
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
string_event_properties_keys:
description: "Property key names to extract from all events, in order to\
\ enrich ledger entries corresponding to an event deduction."
items:
type: "string"
order: 4
title: "Event properties keys (string values)"
type: "array"
subscription_usage_grouping_key:
description: "Property key name to group subscription usage by."
order: 6
title: "Subscription usage grouping key (string value)"
type: "string"
sourceType:
title: "orb"
const: "orb"
enum:
- "orb"
order: 0
type: "string"
required:
- "start_date"
- "api_key"
- "sourceType"
type: "object"
source-orb-update:
properties:
api_key:
airbyte_secret: true
description: "Orb API Key, issued from the Orb admin console."
order: 0
title: "Orb API Key"
type: "string"
end_date:
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: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "End Date"
type: "string"
lookback_window_days:
default: 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."
minimum: 0
order: 3
title: "Lookback Window (in days)"
type: "integer"
numeric_event_properties_keys:
description: "Property key names to extract from all events, in order to\
\ enrich ledger entries corresponding to an event deduction."
items:
type: "string"
order: 5
title: "Event properties keys (numeric values)"
type: "array"
plan_id:
description: "Orb Plan ID to filter subscriptions that should have usage\
\ fetched."
order: 7
title: "Orb Plan ID for Subscription Usage (string value)"
type: "string"
start_date:
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"
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
string_event_properties_keys:
description: "Property key names to extract from all events, in order to\
\ enrich ledger entries corresponding to an event deduction."
items:
type: "string"
order: 4
title: "Event properties keys (string values)"
type: "array"
subscription_usage_grouping_key:
description: "Property key name to group subscription usage by."
order: 6
title: "Subscription usage grouping key (string value)"
type: "string"
required:
- "start_date"
- "api_key"
type: "object"
source-employment-hero:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
employees_configids:
description: "Employees IDs in the given organisation found in `employees`\
\ stream for passing to sub-streams"
order: 2
title: "Employees ID"
type: "array"
organization_configids:
description: "Organization ID which could be found as result of `organizations`\
\ stream to be used in other substreams"
order: 1
title: "Organization ID"
type: "array"
sourceType:
title: "employment-hero"
const: "employment-hero"
enum:
- "employment-hero"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-employment-hero-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
employees_configids:
description: "Employees IDs in the given organisation found in `employees`\
\ stream for passing to sub-streams"
order: 2
title: "Employees ID"
type: "array"
organization_configids:
description: "Organization ID which could be found as result of `organizations`\
\ stream to be used in other substreams"
order: 1
title: "Organization ID"
type: "array"
required:
- "api_key"
type: "object"
source-sentry:
properties:
auth_token:
airbyte_secret: true
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/\""
order: 0
title: "Authentication Tokens"
type: "string"
x-speakeasy-param-sensitive: true
discover_fields:
description: "Fields to retrieve when fetching discover events"
item: "string"
order: 4
title: "Discover Event Fields"
type: "array"
hostname:
default: "sentry.io"
description: "Host name of Sentry API server.For self-hosted, specify your\
\ host name here. Otherwise, leave it empty."
order: 1
title: "Host Name"
type: "string"
organization:
description: "The slug of the organization the groups belong to."
order: 2
title: "Organization"
type: "string"
project:
description: "The name (slug) of the Project you want to sync."
order: 3
title: "Project"
type: "string"
sourceType:
title: "sentry"
const: "sentry"
enum:
- "sentry"
order: 0
type: "string"
required:
- "auth_token"
- "organization"
- "project"
- "sourceType"
type: "object"
source-sentry-update:
properties:
auth_token:
airbyte_secret: true
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/\""
order: 0
title: "Authentication Tokens"
type: "string"
discover_fields:
description: "Fields to retrieve when fetching discover events"
item: "string"
order: 4
title: "Discover Event Fields"
type: "array"
hostname:
default: "sentry.io"
description: "Host name of Sentry API server.For self-hosted, specify your\
\ host name here. Otherwise, leave it empty."
order: 1
title: "Host Name"
type: "string"
organization:
description: "The slug of the organization the groups belong to."
order: 2
title: "Organization"
type: "string"
project:
description: "The name (slug) of the Project you want to sync."
order: 3
title: "Project"
type: "string"
required:
- "auth_token"
- "organization"
- "project"
type: "object"
source-yahoo-finance-price:
properties:
interval:
description: "The interval of between prices queried."
enum:
- "1m"
- "5m"
- "15m"
- "30m"
- "90m"
- "1h"
- "1d"
- "5d"
- "1wk"
- "1mo"
- "3mo"
order: 1
title: "Interval"
type: "string"
range:
description: "The range of prices to be queried."
enum:
- "1d"
- "5d"
- "7d"
- "1mo"
- "3mo"
- "6mo"
- "1y"
- "2y"
- "5y"
- "ytd"
- "max"
order: 2
title: "Range"
type: "string"
tickers:
description: "Comma-separated identifiers for the stocks to be queried.\
\ Whitespaces are allowed."
order: 0
title: "Tickers"
type: "string"
sourceType:
title: "yahoo-finance-price"
const: "yahoo-finance-price"
enum:
- "yahoo-finance-price"
order: 0
type: "string"
required:
- "tickers"
- "sourceType"
type: "object"
source-yahoo-finance-price-update:
properties:
interval:
description: "The interval of between prices queried."
enum:
- "1m"
- "5m"
- "15m"
- "30m"
- "90m"
- "1h"
- "1d"
- "5d"
- "1wk"
- "1mo"
- "3mo"
order: 1
title: "Interval"
type: "string"
range:
description: "The range of prices to be queried."
enum:
- "1d"
- "5d"
- "7d"
- "1mo"
- "3mo"
- "6mo"
- "1y"
- "2y"
- "5y"
- "ytd"
- "max"
order: 2
title: "Range"
type: "string"
tickers:
description: "Comma-separated identifiers for the stocks to be queried.\
\ Whitespaces are allowed."
order: 0
title: "Tickers"
type: "string"
required:
- "tickers"
type: "object"
source-mailjet-mail:
properties:
api_key:
description: "Your API Key. See here."
order: 0
title: "API Key"
type: "string"
api_key_secret:
airbyte_secret: true
description: "Your API Secret Key. See here."
order: 1
title: "API Secret Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "mailjet-mail"
const: "mailjet-mail"
enum:
- "mailjet-mail"
order: 0
type: "string"
required:
- "api_key"
- "api_key_secret"
- "sourceType"
type: "object"
source-mailjet-mail-update:
properties:
api_key:
description: "Your API Key. See here."
order: 0
title: "API Key"
type: "string"
api_key_secret:
airbyte_secret: true
description: "Your API Secret Key. See here."
order: 1
title: "API Secret Key"
type: "string"
required:
- "api_key"
- "api_key_secret"
type: "object"
source-notion:
properties:
credentials:
description: "Choose either OAuth (recommended for Airbyte Cloud) or Access\
\ Token. See our docs\
\ for more information."
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "The Access Token received by completing the OAuth flow\
\ for your Notion integration. See our docs\
\ for more information."
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "OAuth2.0"
type: "string"
enum:
- "OAuth2.0"
client_id:
airbyte_secret: true
description: "The Client ID of your Notion integration. See our docs\
\ for more information."
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The Client Secret of your Notion integration. See our\
\ docs\
\ for more information."
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_type"
- "client_id"
- "client_secret"
- "access_token"
title: "OAuth2.0"
type: "object"
- properties:
auth_type:
const: "token"
type: "string"
enum:
- "token"
token:
airbyte_secret: true
description: "The Access Token for your private Notion integration.\
\ See the docs\
\ for more information on how to obtain this token."
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_type"
- "token"
title: "Access Token"
type: "object"
order: 1
title: "Authentication Method"
type: "object"
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."
examples:
- "2020-11-16T00:00:00.000Z"
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"
title: "Start Date"
type: "string"
sourceType:
title: "notion"
const: "notion"
enum:
- "notion"
order: 0
type: "string"
title: "Notion Source Spec"
type: "object"
source-notion-update:
properties:
credentials:
description: "Choose either OAuth (recommended for Airbyte Cloud) or Access\
\ Token. See our docs\
\ for more information."
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "The Access Token received by completing the OAuth flow\
\ for your Notion integration. See our docs\
\ for more information."
title: "Access Token"
type: "string"
auth_type:
const: "OAuth2.0"
type: "string"
enum:
- "OAuth2.0"
client_id:
airbyte_secret: true
description: "The Client ID of your Notion integration. See our docs\
\ for more information."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Notion integration. See our\
\ docs\
\ for more information."
title: "Client Secret"
type: "string"
required:
- "auth_type"
- "client_id"
- "client_secret"
- "access_token"
title: "OAuth2.0"
type: "object"
- properties:
auth_type:
const: "token"
type: "string"
enum:
- "token"
token:
airbyte_secret: true
description: "The Access Token for your private Notion integration.\
\ See the docs\
\ for more information on how to obtain this token."
title: "Access Token"
type: "string"
required:
- "auth_type"
- "token"
title: "Access Token"
type: "object"
order: 1
title: "Authentication Method"
type: "object"
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."
examples:
- "2020-11-16T00:00:00.000Z"
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"
title: "Start Date"
type: "string"
title: "Notion Source Spec"
type: "object"
source-trustpilot:
properties:
business_units:
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"
items:
type: "string"
order: 2
title: "Business Unit names"
type: "array"
credentials:
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests."
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "oauth2.0"
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The API key of the Trustpilot API application. (represents\
\ the OAuth Client ID)"
title: "API key"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The Secret of the Trustpilot API application. (represents\
\ the OAuth Client Secret)"
title: "Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "The key to refresh the expired access_token."
title: "Refresh token"
type: "string"
x-speakeasy-param-sensitive: true
token_expiry_date:
description: "The date-time when the access token should be refreshed."
format: "date-time"
title: "Token expiry date time"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "access_token"
- "token_expiry_date"
title: "OAuth 2.0"
type: "object"
- 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."
properties:
auth_type:
const: "apikey"
type: "string"
enum:
- "apikey"
client_id:
airbyte_secret: true
description: "The API key of the Trustpilot API application."
title: "API key"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "client_id"
title: "API Key"
type: "object"
order: 0
title: "Authorization Method"
type: "object"
start_date:
description: "For streams with sync. method incremental the start date time\
\ to be used"
examples:
- "%Y-%m-%dT%H:%M:%SZ"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
sourceType:
title: "trustpilot"
const: "trustpilot"
enum:
- "trustpilot"
order: 0
type: "string"
required:
- "credentials"
- "start_date"
- "business_units"
- "sourceType"
type: "object"
source-trustpilot-update:
properties:
business_units:
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"
items:
type: "string"
order: 2
title: "Business Unit names"
type: "array"
credentials:
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests."
title: "Access Token"
type: "string"
auth_type:
const: "oauth2.0"
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The API key of the Trustpilot API application. (represents\
\ the OAuth Client ID)"
title: "API key"
type: "string"
client_secret:
airbyte_secret: true
description: "The Secret of the Trustpilot API application. (represents\
\ the OAuth Client Secret)"
title: "Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "The key to refresh the expired access_token."
title: "Refresh token"
type: "string"
token_expiry_date:
description: "The date-time when the access token should be refreshed."
format: "date-time"
title: "Token expiry date time"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "access_token"
- "token_expiry_date"
title: "OAuth 2.0"
type: "object"
- 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."
properties:
auth_type:
const: "apikey"
type: "string"
enum:
- "apikey"
client_id:
airbyte_secret: true
description: "The API key of the Trustpilot API application."
title: "API key"
type: "string"
required:
- "client_id"
title: "API Key"
type: "object"
order: 0
title: "Authorization Method"
type: "object"
start_date:
description: "For streams with sync. method incremental the start date time\
\ to be used"
examples:
- "%Y-%m-%dT%H:%M:%SZ"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
required:
- "credentials"
- "start_date"
- "business_units"
type: "object"
source-mode:
properties:
api_secret:
airbyte_secret: true
description: "API secret to use as the password for Basic Authentication."
name: "api_secret"
order: 1
title: "API Secret"
type: "string"
x-speakeasy-param-sensitive: true
api_token:
airbyte_secret: true
description: "API token to use as the username for Basic Authentication."
name: "api_token"
order: 0
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
workspace:
order: 2
title: "workspace"
type: "string"
sourceType:
title: "mode"
const: "mode"
enum:
- "mode"
order: 0
type: "string"
required:
- "api_token"
- "api_secret"
- "workspace"
- "sourceType"
type: "object"
source-mode-update:
properties:
api_secret:
airbyte_secret: true
description: "API secret to use as the password for Basic Authentication."
name: "api_secret"
order: 1
title: "API Secret"
type: "string"
api_token:
airbyte_secret: true
description: "API token to use as the username for Basic Authentication."
name: "api_token"
order: 0
title: "API Token"
type: "string"
workspace:
order: 2
title: "workspace"
type: "string"
required:
- "api_token"
- "api_secret"
- "workspace"
type: "object"
source-fillout:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it in the Developer settings tab of your\
\ Fillout account."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "fillout"
const: "fillout"
enum:
- "fillout"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-fillout-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it in the Developer settings tab of your\
\ Fillout account."
name: "api_key"
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-hellobaton:
properties:
api_key:
airbyte_secret: true
description: "authentication key required to access the api endpoints"
order: 1
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
company:
description: "Company name that generates your base api url"
examples:
- "google"
- "facebook"
- "microsoft"
order: 2
title: "company"
type: "string"
sourceType:
title: "hellobaton"
const: "hellobaton"
enum:
- "hellobaton"
order: 0
type: "string"
required:
- "api_key"
- "api_key"
- "company"
- "sourceType"
type: "object"
source-hellobaton-update:
properties:
api_key:
airbyte_secret: true
description: "authentication key required to access the api endpoints"
order: 1
title: "API Key"
type: "string"
company:
description: "Company name that generates your base api url"
examples:
- "google"
- "facebook"
- "microsoft"
order: 2
title: "company"
type: "string"
required:
- "api_key"
- "api_key"
- "company"
type: "object"
source-inflowinventory:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
companyid:
order: 1
title: "CompanyID"
type: "string"
sourceType:
title: "inflowinventory"
const: "inflowinventory"
enum:
- "inflowinventory"
order: 0
type: "string"
required:
- "api_key"
- "companyid"
- "sourceType"
type: "object"
source-inflowinventory-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
companyid:
order: 1
title: "CompanyID"
type: "string"
required:
- "api_key"
- "companyid"
type: "object"
source-clockodo:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it in the 'Personal data' section of\
\ your Clockodo account."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
email_address:
description: "Your Clockodo account email address. Find it in your Clockodo\
\ account settings."
name: "email_address"
order: 1
title: "Email Address"
type: "string"
external_application:
default: "Airbyte"
description: "Identification of the calling application, including the email\
\ address of a technical contact person. Format: [name of application\
\ or company];[email address]."
name: "external_application"
order: 2
title: "External Application Header"
type: "string"
start_date:
format: "date-time"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
years:
description: "2024, 2025"
order: 3
title: "Years"
type: "array"
sourceType:
title: "clockodo"
const: "clockodo"
enum:
- "clockodo"
order: 0
type: "string"
required:
- "api_key"
- "email_address"
- "external_application"
- "years"
- "start_date"
- "sourceType"
type: "object"
source-clockodo-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it in the 'Personal data' section of\
\ your Clockodo account."
name: "api_key"
order: 0
title: "API Key"
type: "string"
email_address:
description: "Your Clockodo account email address. Find it in your Clockodo\
\ account settings."
name: "email_address"
order: 1
title: "Email Address"
type: "string"
external_application:
default: "Airbyte"
description: "Identification of the calling application, including the email\
\ address of a technical contact person. Format: [name of application\
\ or company];[email address]."
name: "external_application"
order: 2
title: "External Application Header"
type: "string"
start_date:
format: "date-time"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
years:
description: "2024, 2025"
order: 3
title: "Years"
type: "array"
required:
- "api_key"
- "email_address"
- "external_application"
- "years"
- "start_date"
type: "object"
source-google-webfonts:
properties:
alt:
description: "Optional, Available params- json, media, proto"
order: 1
type: "string"
api_key:
airbyte_secret: true
description: "API key is required to access google apis, For getting your's\
\ goto google console and generate api key for Webfonts"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
prettyPrint:
description: "Optional, boolean type"
order: 2
type: "string"
sort:
description: "Optional, to find how to sort"
order: 3
type: "string"
sourceType:
title: "google-webfonts"
const: "google-webfonts"
enum:
- "google-webfonts"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-google-webfonts-update:
properties:
alt:
description: "Optional, Available params- json, media, proto"
order: 1
type: "string"
api_key:
airbyte_secret: true
description: "API key is required to access google apis, For getting your's\
\ goto google console and generate api key for Webfonts"
order: 0
title: "API Key"
type: "string"
prettyPrint:
description: "Optional, boolean type"
order: 2
type: "string"
sort:
description: "Optional, to find how to sort"
order: 3
type: "string"
required:
- "api_key"
type: "object"
source-pypi:
properties:
project_name:
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"
order: 0
title: "PyPI Package"
type: "string"
version:
description: "Version of the project/package. Use it to find a particular\
\ release instead of all releases."
examples:
- "1.2.0"
order: 1
title: "Package Version"
type: "string"
sourceType:
title: "pypi"
const: "pypi"
enum:
- "pypi"
order: 0
type: "string"
required:
- "project_name"
- "sourceType"
type: "object"
source-pypi-update:
properties:
project_name:
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"
order: 0
title: "PyPI Package"
type: "string"
version:
description: "Version of the project/package. Use it to find a particular\
\ release instead of all releases."
examples:
- "1.2.0"
order: 1
title: "Package Version"
type: "string"
required:
- "project_name"
type: "object"
source-file:
properties:
dataset_name:
description: "The Name of the final table to replicate this file into (should\
\ include letters, numbers dash and underscores only)."
title: "Dataset Name"
type: "string"
format:
default: "csv"
description: "The Format of the file which should be replicated (Warning:\
\ some formats may be experimental, please refer to the docs)."
enum:
- "csv"
- "json"
- "jsonl"
- "excel"
- "excel_binary"
- "fwf"
- "feather"
- "parquet"
- "yaml"
title: "File Format"
type: "string"
provider:
default: "Public Web"
description: "The storage Provider or Location of the file(s) which should\
\ be replicated."
oneOf:
- properties:
storage:
const: "HTTPS"
type: "string"
enum:
- "HTTPS"
user_agent:
default: false
description: "Add User-Agent to request"
title: "User-Agent"
type: "boolean"
required:
- "storage"
title: "HTTPS: Public Web"
- properties:
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: "Service Account JSON"
type: "string"
x-speakeasy-param-sensitive: true
storage:
const: "GCS"
title: "Storage"
type: "string"
enum:
- "GCS"
required:
- "storage"
title: "GCS: Google Cloud Storage"
- properties:
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."
title: "AWS Access Key ID"
type: "string"
aws_secret_access_key:
airbyte_secret: true
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."
title: "AWS Secret Access Key"
type: "string"
x-speakeasy-param-sensitive: true
storage:
const: "S3"
title: "Storage"
type: "string"
enum:
- "S3"
required:
- "storage"
title: "S3: Amazon Web Services"
- properties:
sas_token:
airbyte_secret: true
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."
title: "SAS Token"
type: "string"
x-speakeasy-param-sensitive: true
shared_key:
airbyte_secret: true
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."
title: "Shared Key"
type: "string"
x-speakeasy-param-sensitive: true
storage:
const: "AzBlob"
title: "Storage"
type: "string"
enum:
- "AzBlob"
storage_account:
description: "The globally unique name of the storage account that\
\ the desired blob sits within. See here for more details."
title: "Storage Account"
type: "string"
required:
- "storage"
- "storage_account"
title: "AzBlob: Azure Blob Storage"
- properties:
host:
description: ""
title: "Host"
type: "string"
password:
airbyte_secret: true
description: ""
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
port:
default: "22"
description: ""
title: "Port"
type: "string"
storage:
const: "SSH"
title: "Storage"
type: "string"
enum:
- "SSH"
user:
description: ""
title: "User"
type: "string"
required:
- "storage"
- "user"
- "host"
title: "SSH: Secure Shell"
- properties:
host:
description: ""
title: "Host"
type: "string"
password:
airbyte_secret: true
description: ""
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
port:
default: "22"
description: ""
title: "Port"
type: "string"
storage:
const: "SCP"
title: "Storage"
type: "string"
enum:
- "SCP"
user:
description: ""
title: "User"
type: "string"
required:
- "storage"
- "user"
- "host"
title: "SCP: Secure copy protocol"
- properties:
host:
description: ""
title: "Host"
type: "string"
password:
airbyte_secret: true
description: ""
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
port:
default: "22"
description: ""
title: "Port"
type: "string"
storage:
const: "SFTP"
title: "Storage"
type: "string"
enum:
- "SFTP"
user:
description: ""
title: "User"
type: "string"
required:
- "storage"
- "user"
- "host"
title: "SFTP: Secure File Transfer Protocol"
- properties:
storage:
const: "local"
description: "WARNING: Note that the local storage URL available for\
\ reading must start with the local mount \"/local/\" at the moment\
\ until we implement more advanced docker mounting options."
title: "Storage"
type: "string"
enum:
- "local"
required:
- "storage"
title: "Local Filesystem (limited)"
title: "Storage Provider"
type: "object"
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\"\
] }"
title: "Reader Options"
type: "string"
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"
title: "URL"
type: "string"
sourceType:
title: "file"
const: "file"
enum:
- "file"
order: 0
type: "string"
required:
- "dataset_name"
- "format"
- "url"
- "provider"
- "sourceType"
title: "File Source Spec"
type: "object"
source-file-update:
properties:
dataset_name:
description: "The Name of the final table to replicate this file into (should\
\ include letters, numbers dash and underscores only)."
title: "Dataset Name"
type: "string"
format:
default: "csv"
description: "The Format of the file which should be replicated (Warning:\
\ some formats may be experimental, please refer to the docs)."
enum:
- "csv"
- "json"
- "jsonl"
- "excel"
- "excel_binary"
- "fwf"
- "feather"
- "parquet"
- "yaml"
title: "File Format"
type: "string"
provider:
default: "Public Web"
description: "The storage Provider or Location of the file(s) which should\
\ be replicated."
oneOf:
- properties:
storage:
const: "HTTPS"
type: "string"
enum:
- "HTTPS"
user_agent:
default: false
description: "Add User-Agent to request"
title: "User-Agent"
type: "boolean"
required:
- "storage"
title: "HTTPS: Public Web"
- properties:
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: "Service Account JSON"
type: "string"
storage:
const: "GCS"
title: "Storage"
type: "string"
enum:
- "GCS"
required:
- "storage"
title: "GCS: Google Cloud Storage"
- properties:
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."
title: "AWS Access Key ID"
type: "string"
aws_secret_access_key:
airbyte_secret: true
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."
title: "AWS Secret Access Key"
type: "string"
storage:
const: "S3"
title: "Storage"
type: "string"
enum:
- "S3"
required:
- "storage"
title: "S3: Amazon Web Services"
- properties:
sas_token:
airbyte_secret: true
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."
title: "SAS Token"
type: "string"
shared_key:
airbyte_secret: true
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."
title: "Shared Key"
type: "string"
storage:
const: "AzBlob"
title: "Storage"
type: "string"
enum:
- "AzBlob"
storage_account:
description: "The globally unique name of the storage account that\
\ the desired blob sits within. See here for more details."
title: "Storage Account"
type: "string"
required:
- "storage"
- "storage_account"
title: "AzBlob: Azure Blob Storage"
- properties:
host:
description: ""
title: "Host"
type: "string"
password:
airbyte_secret: true
description: ""
title: "Password"
type: "string"
port:
default: "22"
description: ""
title: "Port"
type: "string"
storage:
const: "SSH"
title: "Storage"
type: "string"
enum:
- "SSH"
user:
description: ""
title: "User"
type: "string"
required:
- "storage"
- "user"
- "host"
title: "SSH: Secure Shell"
- properties:
host:
description: ""
title: "Host"
type: "string"
password:
airbyte_secret: true
description: ""
title: "Password"
type: "string"
port:
default: "22"
description: ""
title: "Port"
type: "string"
storage:
const: "SCP"
title: "Storage"
type: "string"
enum:
- "SCP"
user:
description: ""
title: "User"
type: "string"
required:
- "storage"
- "user"
- "host"
title: "SCP: Secure copy protocol"
- properties:
host:
description: ""
title: "Host"
type: "string"
password:
airbyte_secret: true
description: ""
title: "Password"
type: "string"
port:
default: "22"
description: ""
title: "Port"
type: "string"
storage:
const: "SFTP"
title: "Storage"
type: "string"
enum:
- "SFTP"
user:
description: ""
title: "User"
type: "string"
required:
- "storage"
- "user"
- "host"
title: "SFTP: Secure File Transfer Protocol"
- properties:
storage:
const: "local"
description: "WARNING: Note that the local storage URL available for\
\ reading must start with the local mount \"/local/\" at the moment\
\ until we implement more advanced docker mounting options."
title: "Storage"
type: "string"
enum:
- "local"
required:
- "storage"
title: "Local Filesystem (limited)"
title: "Storage Provider"
type: "object"
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\"\
] }"
title: "Reader Options"
type: "string"
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"
title: "URL"
type: "string"
required:
- "dataset_name"
- "format"
- "url"
- "provider"
title: "File Source Spec"
type: "object"
source-lokalise:
properties:
api_key:
airbyte_secret: true
description: "Lokalise API Key with read-access. Available at Profile settings\
\ > API tokens. See here."
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
project_id:
description: "Lokalise project ID. Available at Project Settings > General."
order: 1
title: "Project Id"
type: "string"
sourceType:
title: "lokalise"
const: "lokalise"
enum:
- "lokalise"
order: 0
type: "string"
required:
- "api_key"
- "project_id"
- "sourceType"
type: "object"
source-lokalise-update:
properties:
api_key:
airbyte_secret: true
description: "Lokalise API Key with read-access. Available at Profile settings\
\ > API tokens. See here."
order: 0
title: "API Key"
type: "string"
project_id:
description: "Lokalise project ID. Available at Project Settings > General."
order: 1
title: "Project Id"
type: "string"
required:
- "api_key"
- "project_id"
type: "object"
source-opsgenie:
properties:
api_token:
airbyte_secret: true
description: "API token used to access the Opsgenie platform"
type: "string"
x-speakeasy-param-sensitive: true
endpoint:
default: "api.opsgenie.com"
description: "Service endpoint to use for API calls."
examples:
- "api.opsgenie.com"
- "api.eu.opsgenie.com"
type: "string"
start_date:
description: "The date from which you'd like to replicate data from Opsgenie\
\ in the format of YYYY-MM-DDT00:00:00Z. All data generated after this\
\ date will be replicated. Note that it will be used only in the following\
\ incremental streams: issues."
examples:
- "2022-07-01T00:00:00Z"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
type: "string"
sourceType:
title: "opsgenie"
const: "opsgenie"
enum:
- "opsgenie"
order: 0
type: "string"
required:
- "api_token"
- "endpoint"
- "sourceType"
title: "Opsgenie Spec"
type: "object"
source-opsgenie-update:
properties:
api_token:
airbyte_secret: true
description: "API token used to access the Opsgenie platform"
type: "string"
endpoint:
default: "api.opsgenie.com"
description: "Service endpoint to use for API calls."
examples:
- "api.opsgenie.com"
- "api.eu.opsgenie.com"
type: "string"
start_date:
description: "The date from which you'd like to replicate data from Opsgenie\
\ in the format of YYYY-MM-DDT00:00:00Z. All data generated after this\
\ date will be replicated. Note that it will be used only in the following\
\ incremental streams: issues."
examples:
- "2022-07-01T00:00:00Z"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
type: "string"
required:
- "api_token"
- "endpoint"
title: "Opsgenie Spec"
type: "object"
source-zoho-crm:
properties:
client_id:
airbyte_secret: true
description: "OAuth2.0 Client ID"
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "OAuth2.0 Client Secret"
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
dc_region:
description: "Please choose the region of your Data Center location. More\
\ info by this Link"
enum:
- "US"
- "AU"
- "EU"
- "IN"
- "CN"
- "JP"
title: "Data Center Location"
type: "string"
edition:
default: "Free"
description: "Choose your Edition of Zoho CRM to determine API Concurrency\
\ Limits"
enum:
- "Free"
- "Standard"
- "Professional"
- "Enterprise"
- "Ultimate"
title: "Zoho CRM Edition"
type: "string"
environment:
description: "Please choose the environment"
enum:
- "Production"
- "Developer"
- "Sandbox"
title: "Environment"
type: "string"
refresh_token:
airbyte_secret: true
description: "OAuth2.0 Refresh Token"
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
start_datetime:
description: "ISO 8601, for instance: `YYYY-MM-DD`, `YYYY-MM-DD HH:MM:SS+HH:MM`"
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"
format: "date-time"
title: "Start Date"
type:
- "string"
- "null"
sourceType:
title: "zoho-crm"
const: "zoho-crm"
enum:
- "zoho-crm"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "environment"
- "dc_region"
- "edition"
- "sourceType"
title: "Zoho Crm Configuration"
type: "object"
source-zoho-crm-update:
properties:
client_id:
airbyte_secret: true
description: "OAuth2.0 Client ID"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "OAuth2.0 Client Secret"
title: "Client Secret"
type: "string"
dc_region:
description: "Please choose the region of your Data Center location. More\
\ info by this Link"
enum:
- "US"
- "AU"
- "EU"
- "IN"
- "CN"
- "JP"
title: "Data Center Location"
type: "string"
edition:
default: "Free"
description: "Choose your Edition of Zoho CRM to determine API Concurrency\
\ Limits"
enum:
- "Free"
- "Standard"
- "Professional"
- "Enterprise"
- "Ultimate"
title: "Zoho CRM Edition"
type: "string"
environment:
description: "Please choose the environment"
enum:
- "Production"
- "Developer"
- "Sandbox"
title: "Environment"
type: "string"
refresh_token:
airbyte_secret: true
description: "OAuth2.0 Refresh Token"
title: "Refresh Token"
type: "string"
start_datetime:
description: "ISO 8601, for instance: `YYYY-MM-DD`, `YYYY-MM-DD HH:MM:SS+HH:MM`"
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"
format: "date-time"
title: "Start Date"
type:
- "string"
- "null"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "environment"
- "dc_region"
- "edition"
title: "Zoho Crm Configuration"
type: "object"
source-stripe:
properties:
account_id:
description: "Your Stripe account ID (starts with 'acct_', find yours here)."
order: 0
title: "Account ID"
type: "string"
call_rate_limit:
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."
examples:
- 25
- 100
title: "Max number of API calls per second"
type: "integer"
client_secret:
airbyte_secret: true
description: "Stripe API key (usually starts with 'sk_live_'; find yours\
\ here)."
order: 1
title: "Secret Key"
type: "string"
x-speakeasy-param-sensitive: true
lookback_window_days:
default: 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"
minimum: 0
order: 3
title: "Lookback Window in days"
type: "integer"
num_workers:
default: 10
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."
examples:
- 1
- 2
- 3
maximum: 20
minimum: 1
order: 5
title: "Number of concurrent threads"
type: "integer"
slice_range:
default: 365
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."
examples:
- 1
- 3
- 10
- 30
- 180
- 360
minimum: 1
order: 4
title: "Data request time increment in days"
type: "integer"
start_date:
default: "2017-01-25T00:00:00Z"
description: "UTC date and time in the format 2017-01-25T00:00:00Z. Only\
\ data generated after this date will be replicated."
examples:
- "2017-01-25T00:00:00Z"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Replication start date"
type: "string"
sourceType:
title: "stripe"
const: "stripe"
enum:
- "stripe"
order: 0
type: "string"
required:
- "client_secret"
- "account_id"
- "sourceType"
title: "Stripe Source Spec"
type: "object"
source-stripe-update:
properties:
account_id:
description: "Your Stripe account ID (starts with 'acct_', find yours here)."
order: 0
title: "Account ID"
type: "string"
call_rate_limit:
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."
examples:
- 25
- 100
title: "Max number of API calls per second"
type: "integer"
client_secret:
airbyte_secret: true
description: "Stripe API key (usually starts with 'sk_live_'; find yours\
\ here)."
order: 1
title: "Secret Key"
type: "string"
lookback_window_days:
default: 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"
minimum: 0
order: 3
title: "Lookback Window in days"
type: "integer"
num_workers:
default: 10
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."
examples:
- 1
- 2
- 3
maximum: 20
minimum: 1
order: 5
title: "Number of concurrent threads"
type: "integer"
slice_range:
default: 365
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."
examples:
- 1
- 3
- 10
- 30
- 180
- 360
minimum: 1
order: 4
title: "Data request time increment in days"
type: "integer"
start_date:
default: "2017-01-25T00:00:00Z"
description: "UTC date and time in the format 2017-01-25T00:00:00Z. Only\
\ data generated after this date will be replicated."
examples:
- "2017-01-25T00:00:00Z"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Replication start date"
type: "string"
required:
- "client_secret"
- "account_id"
title: "Stripe Source Spec"
type: "object"
source-linear:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "linear"
const: "linear"
enum:
- "linear"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-linear-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-ticketmaster:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "ticketmaster"
const: "ticketmaster"
enum:
- "ticketmaster"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-ticketmaster-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-zoho-analytics-metadata-api:
properties:
client_id:
airbyte_secret: true
name: "client_id"
order: 0
title: "OAuth Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
name: "client_secret"
order: 1
title: "OAuth Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
data_center:
default: "com"
enum:
- "com"
- "eu"
- "in"
- "com.au"
- "com.cn"
- "jp"
order: 3
title: "Data Center"
type: "string"
org_id:
order: 4
title: "Org Id"
type: "number"
refresh_token:
airbyte_secret: true
name: "refresh_token"
order: 2
title: "OAuth Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "zoho-analytics-metadata-api"
const: "zoho-analytics-metadata-api"
enum:
- "zoho-analytics-metadata-api"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "data_center"
- "org_id"
- "sourceType"
type: "object"
source-zoho-analytics-metadata-api-update:
properties:
client_id:
airbyte_secret: true
name: "client_id"
order: 0
title: "OAuth Client ID"
type: "string"
client_secret:
airbyte_secret: true
name: "client_secret"
order: 1
title: "OAuth Client Secret"
type: "string"
data_center:
default: "com"
enum:
- "com"
- "eu"
- "in"
- "com.au"
- "com.cn"
- "jp"
order: 3
title: "Data Center"
type: "string"
org_id:
order: 4
title: "Org Id"
type: "number"
refresh_token:
airbyte_secret: true
name: "refresh_token"
order: 2
title: "OAuth Refresh Token"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "data_center"
- "org_id"
type: "object"
source-buzzsprout:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
podcast_id:
description: "Podcast ID found in `https://www.buzzsprout.com/my/profile/api`"
order: 1
title: "Podcast ID"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "buzzsprout"
const: "buzzsprout"
enum:
- "buzzsprout"
order: 0
type: "string"
required:
- "api_key"
- "podcast_id"
- "start_date"
- "sourceType"
type: "object"
source-buzzsprout-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
podcast_id:
description: "Podcast ID found in `https://www.buzzsprout.com/my/profile/api`"
order: 1
title: "Podcast ID"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "podcast_id"
- "start_date"
type: "object"
source-adobe-commerce-magento:
properties:
api_key:
airbyte_secret: true
order: 0
title: "Integration Access Token"
type: "string"
x-speakeasy-param-sensitive: true
api_version:
default: "V1"
description: "V1"
order: 3
title: "API Version"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
store_host:
description: "magento.mystore.com"
order: 1
title: "Store Host"
type: "string"
sourceType:
title: "adobe-commerce-magento"
const: "adobe-commerce-magento"
enum:
- "adobe-commerce-magento"
order: 0
type: "string"
required:
- "api_key"
- "store_host"
- "start_date"
- "sourceType"
type: "object"
source-adobe-commerce-magento-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "Integration Access Token"
type: "string"
api_version:
default: "V1"
description: "V1"
order: 3
title: "API Version"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
store_host:
description: "magento.mystore.com"
order: 1
title: "Store Host"
type: "string"
required:
- "api_key"
- "store_host"
- "start_date"
type: "object"
source-rocketlane:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Generate it from the API section in Settings\
\ of your Rocketlane account."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "rocketlane"
const: "rocketlane"
enum:
- "rocketlane"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-rocketlane-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Generate it from the API section in Settings\
\ of your Rocketlane account."
name: "api_key"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-youtube-analytics:
properties:
credentials:
additionalProperties: true
properties:
client_id:
airbyte_secret: true
description: "The Client ID of your developer application"
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The client secret of your developer application"
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "A refresh token generated using the above client ID and\
\ secret"
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "client_id"
- "client_secret"
- "refresh_token"
title: "Authenticate via OAuth 2.0"
type: "object"
sourceType:
title: "youtube-analytics"
const: "youtube-analytics"
enum:
- "youtube-analytics"
order: 0
type: "string"
required:
- "credentials"
- "sourceType"
title: "YouTube Analytics Spec"
type: "object"
source-youtube-analytics-update:
properties:
credentials:
additionalProperties: true
properties:
client_id:
airbyte_secret: true
description: "The Client ID of your developer application"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The client secret of your developer application"
title: "Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "A refresh token generated using the above client ID and\
\ secret"
title: "Refresh Token"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
title: "Authenticate via OAuth 2.0"
type: "object"
required:
- "credentials"
title: "YouTube Analytics Spec"
type: "object"
source-systeme:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "systeme"
const: "systeme"
enum:
- "systeme"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-systeme-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-zendesk-talk:
properties:
credentials:
description: "Zendesk service provides two authentication methods. Choose\
\ between: `OAuth2.0` or `API token`."
oneOf:
- additionalProperties: true
properties:
access_token:
airbyte_secret: true
description: "The value of the API token generated. See the docs\
\ for more information."
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "oauth2.0"
order: 0
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "Client ID"
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "Client Secret"
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "access_token"
title: "OAuth2.0"
type: "object"
- additionalProperties: true
properties:
api_token:
airbyte_secret: true
description: "The value of the API token generated. See the docs\
\ for more information."
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "api_token"
type: "string"
enum:
- "api_token"
email:
description: "The user email for your Zendesk account."
title: "Email"
type: "string"
required:
- "email"
- "api_token"
title: "API Token"
type: "object"
order: 1
title: "Authentication"
type: "object"
start_date:
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"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
subdomain:
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."
order: 0
title: "Subdomain"
type: "string"
sourceType:
title: "zendesk-talk"
const: "zendesk-talk"
enum:
- "zendesk-talk"
order: 0
type: "string"
required:
- "subdomain"
- "start_date"
- "sourceType"
type: "object"
source-zendesk-talk-update:
properties:
credentials:
description: "Zendesk service provides two authentication methods. Choose\
\ between: `OAuth2.0` or `API token`."
oneOf:
- additionalProperties: true
properties:
access_token:
airbyte_secret: true
description: "The value of the API token generated. See the docs\
\ for more information."
title: "Access Token"
type: "string"
auth_type:
const: "oauth2.0"
order: 0
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "Client ID"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Client Secret"
title: "Client Secret"
type: "string"
required:
- "access_token"
title: "OAuth2.0"
type: "object"
- additionalProperties: true
properties:
api_token:
airbyte_secret: true
description: "The value of the API token generated. See the docs\
\ for more information."
title: "API Token"
type: "string"
auth_type:
const: "api_token"
type: "string"
enum:
- "api_token"
email:
description: "The user email for your Zendesk account."
title: "Email"
type: "string"
required:
- "email"
- "api_token"
title: "API Token"
type: "object"
order: 1
title: "Authentication"
type: "object"
start_date:
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"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
subdomain:
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."
order: 0
title: "Subdomain"
type: "string"
required:
- "subdomain"
- "start_date"
type: "object"
source-thinkific:
properties:
api_key:
airbyte_secret: true
description: "Your Thinkific API key for authentication."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
subdomain:
description: "The subdomain of your Thinkific URL (e.g., if your URL is\
\ example.thinkific.com, your subdomain is \"example\"."
order: 1
title: "subdomain"
type: "string"
sourceType:
title: "thinkific"
const: "thinkific"
enum:
- "thinkific"
order: 0
type: "string"
required:
- "api_key"
- "subdomain"
- "sourceType"
type: "object"
source-thinkific-update:
properties:
api_key:
airbyte_secret: true
description: "Your Thinkific API key for authentication."
name: "api_key"
order: 0
title: "API Key"
type: "string"
subdomain:
description: "The subdomain of your Thinkific URL (e.g., if your URL is\
\ example.thinkific.com, your subdomain is \"example\"."
order: 1
title: "subdomain"
type: "string"
required:
- "api_key"
- "subdomain"
type: "object"
source-papersign:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Generate it on your account page at https://paperform.co/account/developer."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "papersign"
const: "papersign"
enum:
- "papersign"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-papersign-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Generate it on your account page at https://paperform.co/account/developer."
name: "api_key"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-eventzilla:
properties:
x-api-key:
airbyte_secret: true
description: "API key to use. Generate it by creating a new application\
\ within your Eventzilla account settings under Settings > App Management."
name: "x-api-key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "eventzilla"
const: "eventzilla"
enum:
- "eventzilla"
order: 0
type: "string"
required:
- "x-api-key"
- "sourceType"
type: "object"
source-eventzilla-update:
properties:
x-api-key:
airbyte_secret: true
description: "API key to use. Generate it by creating a new application\
\ within your Eventzilla account settings under Settings > App Management."
name: "x-api-key"
order: 0
title: "API Key"
type: "string"
required:
- "x-api-key"
type: "object"
source-plausible:
properties:
api_key:
airbyte_secret: true
description: "Plausible API Key. See the docs for information on how to generate this key."
order: 0
title: "Plausible API key"
type: "string"
x-speakeasy-param-sensitive: true
api_url:
description: "The API URL of your plausible instance. Change this if you\
\ self-host plausible. The default is https://plausible.io/api/v1/stats"
examples:
- "https://plausible.example.com/api/v1/stats"
order: 2
pattern: "^[A-Za-z0-9-.]+\\.[A-Z-a-z0-9-.]+"
title: "API URL"
type: "string"
site_id:
description: "The domain of the site you want to retrieve data for. Enter\
\ the name of your site as configured on Plausible, i.e., excluding \"\
https://\" and \"www\". Can be retrieved from the 'domain' field in your\
\ Plausible site settings."
examples:
- "airbyte.com"
- "docs.airbyte.com"
order: 1
pattern: "^[A-Za-z0-9-.]+\\.[A-Z-a-z0-9-.]+"
title: "Target website domain"
type: "string"
start_date:
description: "Start date for data to retrieve, in ISO-8601 format."
examples:
- "YYYY-MM-DD"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Data start date"
type: "string"
sourceType:
title: "plausible"
const: "plausible"
enum:
- "plausible"
order: 0
type: "string"
required:
- "api_key"
- "site_id"
- "sourceType"
type: "object"
source-plausible-update:
properties:
api_key:
airbyte_secret: true
description: "Plausible API Key. See the docs for information on how to generate this key."
order: 0
title: "Plausible API key"
type: "string"
api_url:
description: "The API URL of your plausible instance. Change this if you\
\ self-host plausible. The default is https://plausible.io/api/v1/stats"
examples:
- "https://plausible.example.com/api/v1/stats"
order: 2
pattern: "^[A-Za-z0-9-.]+\\.[A-Z-a-z0-9-.]+"
title: "API URL"
type: "string"
site_id:
description: "The domain of the site you want to retrieve data for. Enter\
\ the name of your site as configured on Plausible, i.e., excluding \"\
https://\" and \"www\". Can be retrieved from the 'domain' field in your\
\ Plausible site settings."
examples:
- "airbyte.com"
- "docs.airbyte.com"
order: 1
pattern: "^[A-Za-z0-9-.]+\\.[A-Z-a-z0-9-.]+"
title: "Target website domain"
type: "string"
start_date:
description: "Start date for data to retrieve, in ISO-8601 format."
examples:
- "YYYY-MM-DD"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Data start date"
type: "string"
required:
- "api_key"
- "site_id"
type: "object"
source-getlago:
properties:
api_key:
airbyte_secret: true
description: "Your API Key. See here."
order: 1
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
api_url:
default: "https://api.getlago.com/api/v1"
description: "Your Lago API URL"
order: 0
title: "API Url"
type: "string"
sourceType:
title: "getlago"
const: "getlago"
enum:
- "getlago"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-getlago-update:
properties:
api_key:
airbyte_secret: true
description: "Your API Key. See here."
order: 1
title: "API Key"
type: "string"
api_url:
default: "https://api.getlago.com/api/v1"
description: "Your Lago API URL"
order: 0
title: "API Url"
type: "string"
required:
- "api_key"
type: "object"
source-zapier-supported-storage:
properties:
secret:
airbyte_secret: true
description: "Secret key supplied by zapier"
order: 0
title: "Secret Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "zapier-supported-storage"
const: "zapier-supported-storage"
enum:
- "zapier-supported-storage"
order: 0
type: "string"
required:
- "secret"
- "sourceType"
type: "object"
source-zapier-supported-storage-update:
properties:
secret:
airbyte_secret: true
description: "Secret key supplied by zapier"
order: 0
title: "Secret Key"
type: "string"
required:
- "secret"
type: "object"
source-gridly:
properties:
api_key:
airbyte_secret: true
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
grid_id:
description: "ID of a grid, or can be ID of a branch"
title: "Grid ID"
type: "string"
sourceType:
title: "gridly"
const: "gridly"
enum:
- "gridly"
order: 0
type: "string"
required:
- "api_key"
- "grid_id"
- "sourceType"
title: "Gridly Spec"
type: "object"
source-gridly-update:
properties:
api_key:
airbyte_secret: true
title: "API Key"
type: "string"
grid_id:
description: "ID of a grid, or can be ID of a branch"
title: "Grid ID"
type: "string"
required:
- "api_key"
- "grid_id"
title: "Gridly Spec"
type: "object"
source-revenuecat:
properties:
api_key:
airbyte_secret: true
description: "API key or access token"
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "revenuecat"
const: "revenuecat"
enum:
- "revenuecat"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-revenuecat-update:
properties:
api_key:
airbyte_secret: true
description: "API key or access token"
name: "api_key"
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-zoho-campaign:
properties:
client_id_2:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_refresh_token:
airbyte_secret: true
order: 2
title: "Refresh token"
type: "string"
x-speakeasy-param-sensitive: true
client_secret_2:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
x-speakeasy-param-sensitive: true
data_center:
enum:
- "com"
- "eu"
- "in"
- "com.au"
- ".jp"
- ".com.cn"
order: 3
title: "Data Center"
type: "string"
sourceType:
title: "zoho-campaign"
const: "zoho-campaign"
enum:
- "zoho-campaign"
order: 0
type: "string"
required:
- "client_id_2"
- "client_secret_2"
- "client_refresh_token"
- "data_center"
- "sourceType"
type: "object"
source-zoho-campaign-update:
properties:
client_id_2:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
client_refresh_token:
airbyte_secret: true
order: 2
title: "Refresh token"
type: "string"
client_secret_2:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
data_center:
enum:
- "com"
- "eu"
- "in"
- "com.au"
- ".jp"
- ".com.cn"
order: 3
title: "Data Center"
type: "string"
required:
- "client_id_2"
- "client_secret_2"
- "client_refresh_token"
- "data_center"
type: "object"
source-oura:
properties:
api_key:
airbyte_secret: true
description: "API Key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
end_datetime:
description: "End datetime to sync until. Default is current UTC datetime."
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
type: "string"
start_datetime:
description: "Start datetime to sync from. Default is current UTC datetime\
\ minus 1\nday.\n"
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
type: "string"
sourceType:
title: "oura"
const: "oura"
enum:
- "oura"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-oura-update:
properties:
api_key:
airbyte_secret: true
description: "API Key"
order: 0
title: "API Key"
type: "string"
end_datetime:
description: "End datetime to sync until. Default is current UTC datetime."
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
type: "string"
start_datetime:
description: "Start datetime to sync from. Default is current UTC datetime\
\ minus 1\nday.\n"
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
type: "string"
required:
- "api_key"
type: "object"
source-cin7:
properties:
accountid:
description: "The ID associated with your account."
order: 0
title: "Account ID"
type: "string"
api_key:
airbyte_secret: true
description: "The API key associated with your account."
order: 1
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "cin7"
const: "cin7"
enum:
- "cin7"
order: 0
type: "string"
required:
- "accountid"
- "api_key"
- "sourceType"
type: "object"
source-cin7-update:
properties:
accountid:
description: "The ID associated with your account."
order: 0
title: "Account ID"
type: "string"
api_key:
airbyte_secret: true
description: "The API key associated with your account."
order: 1
title: "API Key"
type: "string"
required:
- "accountid"
- "api_key"
type: "object"
source-jamf-pro:
properties:
password:
airbyte_secret: true
always_show: true
order: 2
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
subdomain:
description: "The unique subdomain for your Jamf Pro instance."
name: "subdomain"
order: 0
title: "Subdomain"
type: "string"
username:
order: 1
title: "Username"
type: "string"
sourceType:
title: "jamf-pro"
const: "jamf-pro"
enum:
- "jamf-pro"
order: 0
type: "string"
required:
- "subdomain"
- "username"
- "sourceType"
type: "object"
source-jamf-pro-update:
properties:
password:
airbyte_secret: true
always_show: true
order: 2
title: "Password"
type: "string"
subdomain:
description: "The unique subdomain for your Jamf Pro instance."
name: "subdomain"
order: 0
title: "Subdomain"
type: "string"
username:
order: 1
title: "Username"
type: "string"
required:
- "subdomain"
- "username"
type: "object"
source-looker:
properties:
client_id:
description: "The Client ID is first part of an API3 key that is specific\
\ to each Looker user. See the docs for more information on how to generate this key."
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret is second part of an API3 key."
order: 1
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
domain:
description: "Domain for your Looker account, e.g. airbyte.cloud.looker.com,looker.[clientname].com,IP\
\ address"
examples:
- "domainname.looker.com"
- "looker.clientname.com"
- "123.123.124.123:8000"
order: 2
title: "Domain"
type: "string"
run_look_ids:
description: "The IDs of any Looks to run"
items:
pattern: "^[0-9]*$"
type: "string"
order: 3
title: "Look IDs to Run"
type: "array"
sourceType:
title: "looker"
const: "looker"
enum:
- "looker"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "domain"
- "sourceType"
type: "object"
source-looker-update:
properties:
client_id:
description: "The Client ID is first part of an API3 key that is specific\
\ to each Looker user. See the docs for more information on how to generate this key."
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret is second part of an API3 key."
order: 1
title: "Client Secret"
type: "string"
domain:
description: "Domain for your Looker account, e.g. airbyte.cloud.looker.com,looker.[clientname].com,IP\
\ address"
examples:
- "domainname.looker.com"
- "looker.clientname.com"
- "123.123.124.123:8000"
order: 2
title: "Domain"
type: "string"
run_look_ids:
description: "The IDs of any Looks to run"
items:
pattern: "^[0-9]*$"
type: "string"
order: 3
title: "Look IDs to Run"
type: "array"
required:
- "client_id"
- "client_secret"
- "domain"
type: "object"
source-dropbox-sign:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it at https://app.hellosign.com/home/myAccount#api"
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "dropbox-sign"
const: "dropbox-sign"
enum:
- "dropbox-sign"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-dropbox-sign-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it at https://app.hellosign.com/home/myAccount#api"
name: "api_key"
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-campayn:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it in your Campayn account settings.\
\ Keep it secure as it grants access to your Campayn data."
name: "api_key"
order: 1
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sub_domain:
name: "domain"
order: 0
title: "Sub Domain"
type: "string"
sourceType:
title: "campayn"
const: "campayn"
enum:
- "campayn"
order: 0
type: "string"
required:
- "sub_domain"
- "api_key"
- "sourceType"
type: "object"
source-campayn-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it in your Campayn account settings.\
\ Keep it secure as it grants access to your Campayn data."
name: "api_key"
order: 1
title: "API Key"
type: "string"
sub_domain:
name: "domain"
order: 0
title: "Sub Domain"
type: "string"
required:
- "sub_domain"
- "api_key"
type: "object"
source-google-tasks:
properties:
api_key:
airbyte_secret: true
order: 1
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
records_limit:
default: "50"
description: "The maximum number of records to be returned per request"
order: 0
title: "Records Limit"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "google-tasks"
const: "google-tasks"
enum:
- "google-tasks"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-google-tasks-update:
properties:
api_key:
airbyte_secret: true
order: 1
title: "API Key"
type: "string"
records_limit:
default: "50"
description: "The maximum number of records to be returned per request"
order: 0
title: "Records Limit"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-zenefits:
properties:
token:
airbyte_secret: true
description: "Use Sync with Zenefits button on the link given on the readme\
\ file, and get the token to access the api"
title: "token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "zenefits"
const: "zenefits"
enum:
- "zenefits"
order: 0
type: "string"
required:
- "token"
- "sourceType"
title: "Zenefits Spec"
type: "object"
source-zenefits-update:
properties:
token:
airbyte_secret: true
description: "Use Sync with Zenefits button on the link given on the readme\
\ file, and get the token to access the api"
title: "token"
type: "string"
required:
- "token"
title: "Zenefits Spec"
type: "object"
source-copper:
properties:
api_key:
airbyte_secret: true
description: "Copper API key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
user_email:
description: "user email used to login in to Copper"
order: 1
title: "User email"
type: "string"
sourceType:
title: "copper"
const: "copper"
enum:
- "copper"
order: 0
type: "string"
required:
- "api_key"
- "user_email"
- "sourceType"
type: "object"
source-copper-update:
properties:
api_key:
airbyte_secret: true
description: "Copper API key"
order: 0
title: "API Key"
type: "string"
user_email:
description: "user email used to login in to Copper"
order: 1
title: "User email"
type: "string"
required:
- "api_key"
- "user_email"
type: "object"
source-recreation:
properties:
apikey:
airbyte_secret: true
description: "API Key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
query_campsites:
order: 1
title: "Query Campsite"
type: "string"
sourceType:
title: "recreation"
const: "recreation"
enum:
- "recreation"
order: 0
type: "string"
required:
- "apikey"
- "sourceType"
type: "object"
source-recreation-update:
properties:
apikey:
airbyte_secret: true
description: "API Key"
order: 0
title: "API Key"
type: "string"
query_campsites:
order: 1
title: "Query Campsite"
type: "string"
required:
- "apikey"
type: "object"
source-linkedin-ads:
properties:
account_ids:
default: []
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."
examples:
- 123456789
items:
type: "integer"
title: "Account IDs"
type: "array"
ad_analytics_reports:
default: []
items:
description: "Config for custom ad Analytics Report"
properties:
name:
description: "The name for the custom report."
title: "Report Name"
type: "string"
pivot_by:
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."
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"
title: "Pivot Category"
type: "string"
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."
enum:
- "ALL"
- "DAILY"
- "MONTHLY"
- "YEARLY"
title: "Time Granularity"
type: "string"
required:
- "name"
- "pivot_by"
- "time_granularity"
title: "Ad Analytics Report Configuration"
type: "object"
title: "Custom Ad Analytics Reports"
type: "array"
credentials:
oneOf:
- properties:
auth_method:
const: "oAuth2.0"
type: "string"
enum:
- "oAuth2.0"
client_id:
airbyte_secret: true
description: "The client ID of your developer application. Refer to\
\ our documentation\
\ for more information."
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The client secret of your developer application. Refer\
\ to our documentation\
\ for more information."
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "The key to refresh the expired access token. Refer to\
\ our documentation\
\ for more information."
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "client_id"
- "client_secret"
- "refresh_token"
title: "OAuth2.0"
type: "object"
- properties:
access_token:
airbyte_secret: true
description: "The access token generated for your developer application.\
\ Refer to our documentation\
\ for more information."
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_method:
const: "access_token"
type: "string"
enum:
- "access_token"
required:
- "access_token"
title: "Access Token"
type: "object"
title: "Authentication"
type: "object"
lookback_window:
default: 0
description: "How far into the past to look for records. (in days)"
minimum: 0
title: "Lookback Window"
type: "integer"
num_workers:
default: 3
description: "The number of workers to use for the connector. This is used\
\ to limit the number of concurrent requests to the LinkedIn Ads API.\
\ If not set, the default is 3 workers."
maximum: 50
minimum: 2
title: "Number of Workers"
type: "integer"
start_date:
description: "UTC date in the format YYYY-MM-DD. Any data before this date\
\ will not be replicated."
examples:
- "2021-05-17"
format: "date"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
pattern_descriptor: "YYYY-MM-DD"
title: "Start Date"
type: "string"
sourceType:
title: "linkedin-ads"
const: "linkedin-ads"
enum:
- "linkedin-ads"
order: 0
type: "string"
required:
- "start_date"
- "sourceType"
title: "Linkedin Ads Spec"
type: "object"
source-linkedin-ads-update:
properties:
account_ids:
default: []
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."
examples:
- 123456789
items:
type: "integer"
title: "Account IDs"
type: "array"
ad_analytics_reports:
default: []
items:
description: "Config for custom ad Analytics Report"
properties:
name:
description: "The name for the custom report."
title: "Report Name"
type: "string"
pivot_by:
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."
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"
title: "Pivot Category"
type: "string"
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."
enum:
- "ALL"
- "DAILY"
- "MONTHLY"
- "YEARLY"
title: "Time Granularity"
type: "string"
required:
- "name"
- "pivot_by"
- "time_granularity"
title: "Ad Analytics Report Configuration"
type: "object"
title: "Custom Ad Analytics Reports"
type: "array"
credentials:
oneOf:
- properties:
auth_method:
const: "oAuth2.0"
type: "string"
enum:
- "oAuth2.0"
client_id:
airbyte_secret: true
description: "The client ID of your developer application. Refer to\
\ our documentation\
\ for more information."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The client secret of your developer application. Refer\
\ to our documentation\
\ for more information."
title: "Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "The key to refresh the expired access token. Refer to\
\ our documentation\
\ for more information."
title: "Refresh Token"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
title: "OAuth2.0"
type: "object"
- properties:
access_token:
airbyte_secret: true
description: "The access token generated for your developer application.\
\ Refer to our documentation\
\ for more information."
title: "Access Token"
type: "string"
auth_method:
const: "access_token"
type: "string"
enum:
- "access_token"
required:
- "access_token"
title: "Access Token"
type: "object"
title: "Authentication"
type: "object"
lookback_window:
default: 0
description: "How far into the past to look for records. (in days)"
minimum: 0
title: "Lookback Window"
type: "integer"
num_workers:
default: 3
description: "The number of workers to use for the connector. This is used\
\ to limit the number of concurrent requests to the LinkedIn Ads API.\
\ If not set, the default is 3 workers."
maximum: 50
minimum: 2
title: "Number of Workers"
type: "integer"
start_date:
description: "UTC date in the format YYYY-MM-DD. Any data before this date\
\ will not be replicated."
examples:
- "2021-05-17"
format: "date"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
pattern_descriptor: "YYYY-MM-DD"
title: "Start Date"
type: "string"
required:
- "start_date"
title: "Linkedin Ads Spec"
type: "object"
source-metricool:
properties:
blog_ids:
description: "Brand IDs"
order: 2
title: "Blog IDs"
type: "array"
end_date:
description: "If not set, defaults to current datetime."
format: "date-time"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "End Date"
type: "string"
start_date:
description: "If not set, defaults to 60 days back. If below \"End Date\"\
, defaults to 1 day before \"End Date\""
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
user_id:
description: "Account ID"
order: 1
title: "User ID"
type: "string"
user_token:
airbyte_secret: true
description: "User token to authenticate API requests. Find it in the Account\
\ Settings menu, API section of your Metricool account."
name: "user_token"
order: 0
title: "User Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "metricool"
const: "metricool"
enum:
- "metricool"
order: 0
type: "string"
required:
- "user_token"
- "user_id"
- "blog_ids"
- "sourceType"
type: "object"
source-metricool-update:
properties:
blog_ids:
description: "Brand IDs"
order: 2
title: "Blog IDs"
type: "array"
end_date:
description: "If not set, defaults to current datetime."
format: "date-time"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "End Date"
type: "string"
start_date:
description: "If not set, defaults to 60 days back. If below \"End Date\"\
, defaults to 1 day before \"End Date\""
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
user_id:
description: "Account ID"
order: 1
title: "User ID"
type: "string"
user_token:
airbyte_secret: true
description: "User token to authenticate API requests. Find it in the Account\
\ Settings menu, API section of your Metricool account."
name: "user_token"
order: 0
title: "User Token"
type: "string"
required:
- "user_token"
- "user_id"
- "blog_ids"
type: "object"
source-churnkey:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
x-ck-app:
order: 1
title: "App ID"
type: "string"
sourceType:
title: "churnkey"
const: "churnkey"
enum:
- "churnkey"
order: 0
type: "string"
required:
- "api_key"
- "x-ck-app"
- "sourceType"
type: "object"
source-churnkey-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-ck-app:
order: 1
title: "App ID"
type: "string"
required:
- "api_key"
- "x-ck-app"
type: "object"
source-mendeley:
properties:
client_id:
airbyte_secret: true
description: "Could be found at `https://dev.mendeley.com/myapps.html`"
order: 0
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_refresh_token:
airbyte_secret: true
description: "Use cURL or Postman with the OAuth 2.0 Authorization tab.\
\ Set the Auth URL to https://api.mendeley.com/oauth/authorize, the Token\
\ URL to https://api.mendeley.com/oauth/token, and use all as the scope."
order: 2
title: "Refresh token"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "Could be found at `https://dev.mendeley.com/myapps.html`"
order: 1
title: "Client secret"
type: "string"
x-speakeasy-param-sensitive: true
name_for_institution:
default: "City University"
description: "The name parameter for institutions search"
order: 5
title: "Name for institution"
type: "string"
query_for_catalog:
default: "Polar Bear"
description: "Query for catalog search"
order: 4
title: "Query for catalog search"
type: "string"
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "mendeley"
const: "mendeley"
enum:
- "mendeley"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "client_refresh_token"
- "start_date"
- "query_for_catalog"
- "name_for_institution"
- "sourceType"
type: "object"
source-mendeley-update:
properties:
client_id:
airbyte_secret: true
description: "Could be found at `https://dev.mendeley.com/myapps.html`"
order: 0
title: "Client ID"
type: "string"
client_refresh_token:
airbyte_secret: true
description: "Use cURL or Postman with the OAuth 2.0 Authorization tab.\
\ Set the Auth URL to https://api.mendeley.com/oauth/authorize, the Token\
\ URL to https://api.mendeley.com/oauth/token, and use all as the scope."
order: 2
title: "Refresh token"
type: "string"
client_secret:
airbyte_secret: true
description: "Could be found at `https://dev.mendeley.com/myapps.html`"
order: 1
title: "Client secret"
type: "string"
name_for_institution:
default: "City University"
description: "The name parameter for institutions search"
order: 5
title: "Name for institution"
type: "string"
query_for_catalog:
default: "Polar Bear"
description: "Query for catalog search"
order: 4
title: "Query for catalog search"
type: "string"
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "client_id"
- "client_secret"
- "client_refresh_token"
- "start_date"
- "query_for_catalog"
- "name_for_institution"
type: "object"
source-freshchat:
properties:
account_name:
airbyte_secret: false
description: "The unique account name for your Freshchat instance"
name: "account_name"
order: 0
title: "Account Name"
type: "string"
x-speakeasy-param-sensitive: true
api_key:
airbyte_secret: true
order: 1
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "freshchat"
const: "freshchat"
enum:
- "freshchat"
order: 0
type: "string"
required:
- "account_name"
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-freshchat-update:
properties:
account_name:
airbyte_secret: false
description: "The unique account name for your Freshchat instance"
name: "account_name"
order: 0
title: "Account Name"
type: "string"
api_key:
airbyte_secret: true
order: 1
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "account_name"
- "api_key"
- "start_date"
type: "object"
source-mailersend:
properties:
api_token:
airbyte_secret: true
description: "Your API Token. See here."
order: 0
type: "string"
x-speakeasy-param-sensitive: true
domain_id:
description: "The domain entity in mailersend"
examples:
- "airbyte.com"
- "linkana.com"
order: 1
type: "string"
start_date:
description: "Timestamp is assumed to be UTC."
examples:
- 123131321
order: 2
title: "1668311800"
type: "number"
sourceType:
title: "mailersend"
const: "mailersend"
enum:
- "mailersend"
order: 0
type: "string"
required:
- "api_token"
- "domain_id"
- "sourceType"
type: "object"
source-mailersend-update:
properties:
api_token:
airbyte_secret: true
description: "Your API Token. See here."
order: 0
type: "string"
domain_id:
description: "The domain entity in mailersend"
examples:
- "airbyte.com"
- "linkana.com"
order: 1
type: "string"
start_date:
description: "Timestamp is assumed to be UTC."
examples:
- 123131321
order: 2
title: "1668311800"
type: "number"
required:
- "api_token"
- "domain_id"
type: "object"
source-okta:
properties:
credentials:
oneOf:
- properties:
auth_type:
const: "oauth2.0"
order: 0
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The Client ID of your OAuth application."
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The Client Secret of your OAuth application."
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "Refresh Token to obtain new Access Token, when it's\
\ expired."
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_type"
- "client_id"
- "client_secret"
- "refresh_token"
title: "OAuth2.0"
type: "object"
- properties:
auth_type:
const: "oauth2.0_private_key"
order: 0
type: "string"
enum:
- "oauth2.0_private_key"
client_id:
airbyte_secret: true
description: "The Client ID of your OAuth application."
order: 1
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
key_id:
airbyte_secret: true
description: "The key ID (kid)."
order: 2
title: "Key ID"
type: "string"
x-speakeasy-param-sensitive: true
private_key:
airbyte_secret: true
description: "The private key in PEM format"
order: 3
title: "Private key"
type: "string"
x-speakeasy-param-sensitive: true
scope:
description: "The OAuth scope."
order: 4
title: "Scope"
type: "string"
required:
- "auth_type"
- "client_id"
- "key_id"
- "private_key"
- "scope"
title: "OAuth 2.0 with private key"
type: "object"
- properties:
api_token:
airbyte_secret: true
description: "An Okta token. See the docs for instructions on how to generate it."
title: "Personal API Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "api_token"
order: 0
type: "string"
enum:
- "api_token"
required:
- "auth_type"
- "api_token"
title: "API Token"
type: "object"
order: 0
title: "Authorization Method"
type: "object"
domain:
airbyte_secret: false
description: "The Okta domain. See the docs for instructions on how to find it."
order: 1
title: "Okta domain"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
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"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
sourceType:
title: "okta"
const: "okta"
enum:
- "okta"
order: 0
type: "string"
required:
- "sourceType"
type: "object"
source-okta-update:
properties:
credentials:
oneOf:
- properties:
auth_type:
const: "oauth2.0"
order: 0
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The Client ID of your OAuth application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your OAuth application."
title: "Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "Refresh Token to obtain new Access Token, when it's\
\ expired."
title: "Refresh Token"
type: "string"
required:
- "auth_type"
- "client_id"
- "client_secret"
- "refresh_token"
title: "OAuth2.0"
type: "object"
- properties:
auth_type:
const: "oauth2.0_private_key"
order: 0
type: "string"
enum:
- "oauth2.0_private_key"
client_id:
airbyte_secret: true
description: "The Client ID of your OAuth application."
order: 1
title: "Client ID"
type: "string"
key_id:
airbyte_secret: true
description: "The key ID (kid)."
order: 2
title: "Key ID"
type: "string"
private_key:
airbyte_secret: true
description: "The private key in PEM format"
order: 3
title: "Private key"
type: "string"
scope:
description: "The OAuth scope."
order: 4
title: "Scope"
type: "string"
required:
- "auth_type"
- "client_id"
- "key_id"
- "private_key"
- "scope"
title: "OAuth 2.0 with private key"
type: "object"
- properties:
api_token:
airbyte_secret: true
description: "An Okta token. See the docs for instructions on how to generate it."
title: "Personal API Token"
type: "string"
auth_type:
const: "api_token"
order: 0
type: "string"
enum:
- "api_token"
required:
- "auth_type"
- "api_token"
title: "API Token"
type: "object"
order: 0
title: "Authorization Method"
type: "object"
domain:
airbyte_secret: false
description: "The Okta domain. See the docs for instructions on how to find it."
order: 1
title: "Okta domain"
type: "string"
start_date:
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"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
required: []
type: "object"
source-ip2whois:
properties:
api_key:
airbyte_secret: true
description: "Your API Key. See here."
order: 0
title: "API key"
type: "string"
x-speakeasy-param-sensitive: true
domain:
description: "Domain name. See here."
examples:
- "www.google.com"
- "www.facebook.com"
order: 1
title: "Domain"
type: "string"
sourceType:
title: "ip2whois"
const: "ip2whois"
enum:
- "ip2whois"
order: 0
type: "string"
required:
- "sourceType"
type: "object"
source-ip2whois-update:
properties:
api_key:
airbyte_secret: true
description: "Your API Key. See here."
order: 0
title: "API key"
type: "string"
domain:
description: "Domain name. See here."
examples:
- "www.google.com"
- "www.facebook.com"
order: 1
title: "Domain"
type: "string"
required: []
type: "object"
source-twitter:
properties:
api_key:
airbyte_secret: true
description: "App only Bearer Token. See the docs for more information on how to obtain this token."
order: 0
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
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
title: "End Date"
type: "string"
query:
description: "Query for matching Tweets. You can learn how to build this\
\ query by reading build a query guide ."
order: 1
title: "Search Query"
type: "string"
start_date:
description: "The start date for retrieving tweets cannot be more than 7\
\ days in the past."
format: "date-time"
order: 2
title: "Start Date"
type: "string"
sourceType:
title: "twitter"
const: "twitter"
enum:
- "twitter"
order: 0
type: "string"
required:
- "api_key"
- "query"
- "sourceType"
type: "object"
source-twitter-update:
properties:
api_key:
airbyte_secret: true
description: "App only Bearer Token. See the docs for more information on how to obtain this token."
order: 0
title: "Access Token"
type: "string"
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
title: "End Date"
type: "string"
query:
description: "Query for matching Tweets. You can learn how to build this\
\ query by reading build a query guide ."
order: 1
title: "Search Query"
type: "string"
start_date:
description: "The start date for retrieving tweets cannot be more than 7\
\ days in the past."
format: "date-time"
order: 2
title: "Start Date"
type: "string"
required:
- "api_key"
- "query"
type: "object"
source-sftp-bulk:
description: "Used during spec; allows the developer to configure the cloud\
\ provider specific options\nthat are needed when users configure a file-based\
\ source."
properties:
credentials:
description: "Credentials for connecting to the SFTP Server"
oneOf:
- properties:
auth_type:
const: "password"
default: "password"
enum:
- "password"
title: "Auth Type"
type: "string"
password:
airbyte_secret: true
description: "Password"
order: 3
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "password"
- "auth_type"
title: "Authenticate via Password"
type: "object"
- properties:
auth_type:
const: "private_key"
default: "private_key"
enum:
- "private_key"
title: "Auth Type"
type: "string"
private_key:
airbyte_secret: true
description: "The Private key"
multiline: true
order: 4
title: "Private key"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "private_key"
- "auth_type"
title: "Authenticate via Private Key"
type: "object"
order: 4
title: "Authentication"
type: "object"
delivery_method:
default: "use_records_transfer"
display_type: "radio"
group: "advanced"
oneOf:
- description: "Recommended - Extract and load structured records into your\
\ destination of choice. This is the classic method of moving data in\
\ Airbyte. It allows for blocking and hashing individual fields or files\
\ from a structured schema. Data can be flattened, typed and deduped\
\ depending on the destination."
properties:
delivery_type:
const: "use_records_transfer"
default: "use_records_transfer"
enum:
- "use_records_transfer"
title: "Delivery Type"
type: "string"
required:
- "delivery_type"
title: "Replicate Records"
type: "object"
- description: "Copy raw files without parsing their contents. Bits are\
\ copied into the destination exactly as they appeared in the source.\
\ Recommended for use with unstructured text data, non-text and compressed\
\ files."
properties:
delivery_type:
const: "use_file_transfer"
default: "use_file_transfer"
enum:
- "use_file_transfer"
title: "Delivery Type"
type: "string"
preserve_directory_structure:
default: true
description: "If enabled, sends subdirectory folder structure along\
\ with source file names to the destination. Otherwise, files will\
\ be synced by their names only. This option is ignored when file-based\
\ replication is not enabled."
title: "Preserve Sub-Directories in File Paths"
type: "boolean"
required:
- "delivery_type"
title: "Copy Raw Files"
type: "object"
order: 7
title: "Delivery Method"
type: "object"
folder_path:
default: "/"
description: "The directory to search files for sync"
examples:
- "/logs/2022"
order: 6
pattern_descriptor: "/folder_to_sync"
title: "Folder Path"
type: "string"
host:
description: "The server host address"
examples:
- "www.host.com"
- "192.0.2.1"
order: 2
title: "Host Address"
type: "string"
port:
default: 22
description: "The server port"
examples:
- "22"
order: 5
title: "Host Address"
type: "integer"
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"
order: 1
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"
title: "Start Date"
type: "string"
streams:
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."
items:
properties:
days_to_sync_if_history_is_full:
default: 3
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."
title: "Days To Sync If History Is Full"
type: "integer"
format:
description: "The configuration options that are used to alter how\
\ to read incoming files that deviate from the standard formatting."
oneOf:
- properties:
double_as_string:
default: false
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."
title: "Convert Double Fields to Strings"
type: "boolean"
filetype:
const: "avro"
default: "avro"
title: "Filetype"
type: "string"
enum:
- "avro"
required:
- "filetype"
title: "Avro Format"
type: "object"
- properties:
delimiter:
default: ","
description: "The character delimiting individual cells in the\
\ CSV data. This may only be a 1-character string. For tab-delimited\
\ data enter '\\t'."
title: "Delimiter"
type: "string"
double_quote:
default: true
description: "Whether two quotes in a quoted CSV value denote\
\ a single quote in the data."
title: "Double Quote"
type: "boolean"
encoding:
default: "utf8"
description: "The character encoding of the CSV data. Leave\
\ blank to default to UTF8. See list of python encodings for allowable\
\ options."
title: "Encoding"
type: "string"
escape_char:
description: "The character used for escaping special characters.\
\ To disallow escaping, leave this field blank."
title: "Escape Character"
type: "string"
false_values:
default:
- "n"
- "no"
- "f"
- "false"
- "off"
- "0"
description: "A set of case-sensitive strings that should be\
\ interpreted as false values."
items:
type: "string"
title: "False Values"
type: "array"
uniqueItems: true
filetype:
const: "csv"
default: "csv"
title: "Filetype"
type: "string"
enum:
- "csv"
header_definition:
default:
header_definition_type: "From CSV"
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."
oneOf:
- properties:
header_definition_type:
const: "From CSV"
default: "From CSV"
title: "Header Definition Type"
type: "string"
enum:
- "From CSV"
required:
- "header_definition_type"
title: "From CSV"
type: "object"
- properties:
header_definition_type:
const: "Autogenerated"
default: "Autogenerated"
title: "Header Definition Type"
type: "string"
enum:
- "Autogenerated"
required:
- "header_definition_type"
title: "Autogenerated"
type: "object"
- properties:
column_names:
description: "The column names that will be used while\
\ emitting the CSV records"
items:
type: "string"
title: "Column Names"
type: "array"
header_definition_type:
const: "User Provided"
default: "User Provided"
title: "Header Definition Type"
type: "string"
enum:
- "User Provided"
required:
- "column_names"
- "header_definition_type"
title: "User Provided"
type: "object"
title: "CSV Header Definition"
type: "object"
ignore_errors_on_fields_mismatch:
default: false
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."
title: "Ignore errors on field mismatch"
type: "boolean"
null_values:
default: []
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."
items:
type: "string"
title: "Null Values"
type: "array"
uniqueItems: true
quote_char:
default: "\""
description: "The character used for quoting CSV values. To\
\ disallow quoting, make this field blank."
title: "Quote Character"
type: "string"
skip_rows_after_header:
default: 0
description: "The number of rows to skip after the header row."
title: "Skip Rows After Header"
type: "integer"
skip_rows_before_header:
default: 0
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."
title: "Skip Rows Before Header"
type: "integer"
strings_can_be_null:
default: true
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."
title: "Strings Can Be Null"
type: "boolean"
true_values:
default:
- "y"
- "yes"
- "t"
- "true"
- "on"
- "1"
description: "A set of case-sensitive strings that should be\
\ interpreted as true values."
items:
type: "string"
title: "True Values"
type: "array"
uniqueItems: true
required:
- "filetype"
title: "CSV Format"
type: "object"
- properties:
filetype:
const: "jsonl"
default: "jsonl"
title: "Filetype"
type: "string"
enum:
- "jsonl"
required:
- "filetype"
title: "Jsonl Format"
type: "object"
- properties:
decimal_as_float:
default: false
description: "Whether to convert decimal fields to floats. There\
\ is a loss of precision when converting decimals to floats,\
\ so this is not recommended."
title: "Convert Decimal Fields to Floats"
type: "boolean"
filetype:
const: "parquet"
default: "parquet"
title: "Filetype"
type: "string"
enum:
- "parquet"
required:
- "filetype"
title: "Parquet Format"
type: "object"
- description: "Extract text from document formats (.pdf, .docx, .md,\
\ .pptx) and emit as one record per file."
properties:
filetype:
const: "unstructured"
default: "unstructured"
title: "Filetype"
type: "string"
enum:
- "unstructured"
processing:
default:
mode: "local"
description: "Processing configuration"
oneOf:
- description: "Process files locally, supporting `fast` and\
\ `ocr` modes. This is the default option."
properties:
mode:
const: "local"
default: "local"
enum:
- "local"
title: "Mode"
type: "string"
required:
- "mode"
title: "Local"
type: "object"
- description: "Process files via an API, using the `hi_res`\
\ mode. This option is useful for increased performance\
\ and accuracy, but requires an API key and a hosted instance\
\ of unstructured."
properties:
api_key:
airbyte_secret: true
always_show: true
default: ""
description: "The API key to use matching the environment"
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
api_url:
always_show: true
default: "https://api.unstructured.io"
description: "The URL of the unstructured API to use"
examples:
- "https://api.unstructured.com"
title: "API URL"
type: "string"
mode:
const: "api"
default: "api"
enum:
- "api"
title: "Mode"
type: "string"
parameters:
always_show: true
default: []
description: "List of parameters send to the API"
items:
properties:
name:
description: "The name of the unstructured API parameter\
\ to use"
examples:
- "combine_under_n_chars"
- "languages"
title: "Parameter name"
type: "string"
value:
description: "The value of the parameter"
examples:
- "true"
- "hi_res"
title: "Value"
type: "string"
required:
- "name"
- "value"
title: "APIParameterConfigModel"
type: "object"
title: "Additional URL Parameters"
type: "array"
required:
- "mode"
title: "via API"
type: "object"
title: "Processing"
type: "object"
skip_unprocessable_files:
always_show: true
default: true
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."
title: "Skip Unprocessable Files"
type: "boolean"
strategy:
always_show: true
default: "auto"
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"
enum:
- "auto"
- "fast"
- "ocr_only"
- "hi_res"
order: 0
title: "Parsing Strategy"
type: "string"
required:
- "filetype"
title: "Unstructured Document Format"
type: "object"
- properties:
filetype:
const: "excel"
default: "excel"
title: "Filetype"
type: "string"
enum:
- "excel"
required:
- "filetype"
title: "Excel Format"
type: "object"
title: "Format"
type: "object"
globs:
default:
- "**"
description: "The pattern used to specify which files should be selected\
\ from the file system. For more information on glob pattern matching\
\ look here."
items:
type: "string"
order: 1
title: "Globs"
type: "array"
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."
title: "Input Schema"
type: "string"
name:
description: "The name of the stream."
title: "Name"
type: "string"
recent_n_files_to_read_for_schema_discovery:
description: "The number of resent files which will be used to discover\
\ the schema for this stream."
exclusiveMinimum: 0
title: "Files To Read For Schema Discover"
type: "integer"
schemaless:
default: false
description: "When enabled, syncs will not validate or structure records\
\ against the stream's schema."
title: "Schemaless"
type: "boolean"
validation_policy:
default: "Emit Record"
description: "The name of the validation policy that dictates sync\
\ behavior when a record does not adhere to the stream schema."
enum:
- "Emit Record"
- "Skip Record"
- "Wait for Discover"
title: "Validation Policy"
required:
- "name"
- "format"
title: "FileBasedStreamConfig"
type: "object"
order: 10
title: "The list of streams to sync"
type: "array"
username:
description: "The server user"
order: 3
title: "User Name"
type: "string"
sourceType:
title: "sftp-bulk"
const: "sftp-bulk"
enum:
- "sftp-bulk"
order: 0
type: "string"
required:
- "streams"
- "host"
- "username"
- "credentials"
- "sourceType"
title: "SFTP Bulk Source Spec"
type: "object"
source-sftp-bulk-update:
description: "Used during spec; allows the developer to configure the cloud\
\ provider specific options\nthat are needed when users configure a file-based\
\ source."
properties:
credentials:
description: "Credentials for connecting to the SFTP Server"
oneOf:
- properties:
auth_type:
const: "password"
default: "password"
enum:
- "password"
title: "Auth Type"
type: "string"
password:
airbyte_secret: true
description: "Password"
order: 3
title: "Password"
type: "string"
required:
- "password"
- "auth_type"
title: "Authenticate via Password"
type: "object"
- properties:
auth_type:
const: "private_key"
default: "private_key"
enum:
- "private_key"
title: "Auth Type"
type: "string"
private_key:
airbyte_secret: true
description: "The Private key"
multiline: true
order: 4
title: "Private key"
type: "string"
required:
- "private_key"
- "auth_type"
title: "Authenticate via Private Key"
type: "object"
order: 4
title: "Authentication"
type: "object"
delivery_method:
default: "use_records_transfer"
display_type: "radio"
group: "advanced"
oneOf:
- description: "Recommended - Extract and load structured records into your\
\ destination of choice. This is the classic method of moving data in\
\ Airbyte. It allows for blocking and hashing individual fields or files\
\ from a structured schema. Data can be flattened, typed and deduped\
\ depending on the destination."
properties:
delivery_type:
const: "use_records_transfer"
default: "use_records_transfer"
enum:
- "use_records_transfer"
title: "Delivery Type"
type: "string"
required:
- "delivery_type"
title: "Replicate Records"
type: "object"
- description: "Copy raw files without parsing their contents. Bits are\
\ copied into the destination exactly as they appeared in the source.\
\ Recommended for use with unstructured text data, non-text and compressed\
\ files."
properties:
delivery_type:
const: "use_file_transfer"
default: "use_file_transfer"
enum:
- "use_file_transfer"
title: "Delivery Type"
type: "string"
preserve_directory_structure:
default: true
description: "If enabled, sends subdirectory folder structure along\
\ with source file names to the destination. Otherwise, files will\
\ be synced by their names only. This option is ignored when file-based\
\ replication is not enabled."
title: "Preserve Sub-Directories in File Paths"
type: "boolean"
required:
- "delivery_type"
title: "Copy Raw Files"
type: "object"
order: 7
title: "Delivery Method"
type: "object"
folder_path:
default: "/"
description: "The directory to search files for sync"
examples:
- "/logs/2022"
order: 6
pattern_descriptor: "/folder_to_sync"
title: "Folder Path"
type: "string"
host:
description: "The server host address"
examples:
- "www.host.com"
- "192.0.2.1"
order: 2
title: "Host Address"
type: "string"
port:
default: 22
description: "The server port"
examples:
- "22"
order: 5
title: "Host Address"
type: "integer"
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"
order: 1
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"
title: "Start Date"
type: "string"
streams:
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."
items:
properties:
days_to_sync_if_history_is_full:
default: 3
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."
title: "Days To Sync If History Is Full"
type: "integer"
format:
description: "The configuration options that are used to alter how\
\ to read incoming files that deviate from the standard formatting."
oneOf:
- properties:
double_as_string:
default: false
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."
title: "Convert Double Fields to Strings"
type: "boolean"
filetype:
const: "avro"
default: "avro"
title: "Filetype"
type: "string"
enum:
- "avro"
required:
- "filetype"
title: "Avro Format"
type: "object"
- properties:
delimiter:
default: ","
description: "The character delimiting individual cells in the\
\ CSV data. This may only be a 1-character string. For tab-delimited\
\ data enter '\\t'."
title: "Delimiter"
type: "string"
double_quote:
default: true
description: "Whether two quotes in a quoted CSV value denote\
\ a single quote in the data."
title: "Double Quote"
type: "boolean"
encoding:
default: "utf8"
description: "The character encoding of the CSV data. Leave\
\ blank to default to UTF8. See list of python encodings for allowable\
\ options."
title: "Encoding"
type: "string"
escape_char:
description: "The character used for escaping special characters.\
\ To disallow escaping, leave this field blank."
title: "Escape Character"
type: "string"
false_values:
default:
- "n"
- "no"
- "f"
- "false"
- "off"
- "0"
description: "A set of case-sensitive strings that should be\
\ interpreted as false values."
items:
type: "string"
title: "False Values"
type: "array"
uniqueItems: true
filetype:
const: "csv"
default: "csv"
title: "Filetype"
type: "string"
enum:
- "csv"
header_definition:
default:
header_definition_type: "From CSV"
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."
oneOf:
- properties:
header_definition_type:
const: "From CSV"
default: "From CSV"
title: "Header Definition Type"
type: "string"
enum:
- "From CSV"
required:
- "header_definition_type"
title: "From CSV"
type: "object"
- properties:
header_definition_type:
const: "Autogenerated"
default: "Autogenerated"
title: "Header Definition Type"
type: "string"
enum:
- "Autogenerated"
required:
- "header_definition_type"
title: "Autogenerated"
type: "object"
- properties:
column_names:
description: "The column names that will be used while\
\ emitting the CSV records"
items:
type: "string"
title: "Column Names"
type: "array"
header_definition_type:
const: "User Provided"
default: "User Provided"
title: "Header Definition Type"
type: "string"
enum:
- "User Provided"
required:
- "column_names"
- "header_definition_type"
title: "User Provided"
type: "object"
title: "CSV Header Definition"
type: "object"
ignore_errors_on_fields_mismatch:
default: false
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."
title: "Ignore errors on field mismatch"
type: "boolean"
null_values:
default: []
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."
items:
type: "string"
title: "Null Values"
type: "array"
uniqueItems: true
quote_char:
default: "\""
description: "The character used for quoting CSV values. To\
\ disallow quoting, make this field blank."
title: "Quote Character"
type: "string"
skip_rows_after_header:
default: 0
description: "The number of rows to skip after the header row."
title: "Skip Rows After Header"
type: "integer"
skip_rows_before_header:
default: 0
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."
title: "Skip Rows Before Header"
type: "integer"
strings_can_be_null:
default: true
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."
title: "Strings Can Be Null"
type: "boolean"
true_values:
default:
- "y"
- "yes"
- "t"
- "true"
- "on"
- "1"
description: "A set of case-sensitive strings that should be\
\ interpreted as true values."
items:
type: "string"
title: "True Values"
type: "array"
uniqueItems: true
required:
- "filetype"
title: "CSV Format"
type: "object"
- properties:
filetype:
const: "jsonl"
default: "jsonl"
title: "Filetype"
type: "string"
enum:
- "jsonl"
required:
- "filetype"
title: "Jsonl Format"
type: "object"
- properties:
decimal_as_float:
default: false
description: "Whether to convert decimal fields to floats. There\
\ is a loss of precision when converting decimals to floats,\
\ so this is not recommended."
title: "Convert Decimal Fields to Floats"
type: "boolean"
filetype:
const: "parquet"
default: "parquet"
title: "Filetype"
type: "string"
enum:
- "parquet"
required:
- "filetype"
title: "Parquet Format"
type: "object"
- description: "Extract text from document formats (.pdf, .docx, .md,\
\ .pptx) and emit as one record per file."
properties:
filetype:
const: "unstructured"
default: "unstructured"
title: "Filetype"
type: "string"
enum:
- "unstructured"
processing:
default:
mode: "local"
description: "Processing configuration"
oneOf:
- description: "Process files locally, supporting `fast` and\
\ `ocr` modes. This is the default option."
properties:
mode:
const: "local"
default: "local"
enum:
- "local"
title: "Mode"
type: "string"
required:
- "mode"
title: "Local"
type: "object"
- description: "Process files via an API, using the `hi_res`\
\ mode. This option is useful for increased performance\
\ and accuracy, but requires an API key and a hosted instance\
\ of unstructured."
properties:
api_key:
airbyte_secret: true
always_show: true
default: ""
description: "The API key to use matching the environment"
title: "API Key"
type: "string"
api_url:
always_show: true
default: "https://api.unstructured.io"
description: "The URL of the unstructured API to use"
examples:
- "https://api.unstructured.com"
title: "API URL"
type: "string"
mode:
const: "api"
default: "api"
enum:
- "api"
title: "Mode"
type: "string"
parameters:
always_show: true
default: []
description: "List of parameters send to the API"
items:
properties:
name:
description: "The name of the unstructured API parameter\
\ to use"
examples:
- "combine_under_n_chars"
- "languages"
title: "Parameter name"
type: "string"
value:
description: "The value of the parameter"
examples:
- "true"
- "hi_res"
title: "Value"
type: "string"
required:
- "name"
- "value"
title: "APIParameterConfigModel"
type: "object"
title: "Additional URL Parameters"
type: "array"
required:
- "mode"
title: "via API"
type: "object"
title: "Processing"
type: "object"
skip_unprocessable_files:
always_show: true
default: true
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."
title: "Skip Unprocessable Files"
type: "boolean"
strategy:
always_show: true
default: "auto"
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"
enum:
- "auto"
- "fast"
- "ocr_only"
- "hi_res"
order: 0
title: "Parsing Strategy"
type: "string"
required:
- "filetype"
title: "Unstructured Document Format"
type: "object"
- properties:
filetype:
const: "excel"
default: "excel"
title: "Filetype"
type: "string"
enum:
- "excel"
required:
- "filetype"
title: "Excel Format"
type: "object"
title: "Format"
type: "object"
globs:
default:
- "**"
description: "The pattern used to specify which files should be selected\
\ from the file system. For more information on glob pattern matching\
\ look here."
items:
type: "string"
order: 1
title: "Globs"
type: "array"
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."
title: "Input Schema"
type: "string"
name:
description: "The name of the stream."
title: "Name"
type: "string"
recent_n_files_to_read_for_schema_discovery:
description: "The number of resent files which will be used to discover\
\ the schema for this stream."
exclusiveMinimum: 0
title: "Files To Read For Schema Discover"
type: "integer"
schemaless:
default: false
description: "When enabled, syncs will not validate or structure records\
\ against the stream's schema."
title: "Schemaless"
type: "boolean"
validation_policy:
default: "Emit Record"
description: "The name of the validation policy that dictates sync\
\ behavior when a record does not adhere to the stream schema."
enum:
- "Emit Record"
- "Skip Record"
- "Wait for Discover"
title: "Validation Policy"
required:
- "name"
- "format"
title: "FileBasedStreamConfig"
type: "object"
order: 10
title: "The list of streams to sync"
type: "array"
username:
description: "The server user"
order: 3
title: "User Name"
type: "string"
required:
- "streams"
- "host"
- "username"
- "credentials"
title: "SFTP Bulk Source Spec"
type: "object"
source-microsoft-onedrive:
description: "SourceMicrosoftOneDriveSpec class for Microsoft OneDrive Source\
\ Specification.\nThis class combines the authentication details with additional\
\ configuration for the OneDrive API."
properties:
credentials:
description: "Credentials for connecting to the One Drive API"
oneOf:
- description: "OAuthCredentials class to hold authentication details for\
\ Microsoft OAuth authentication.\nThis class uses pydantic for data\
\ validation and settings management."
properties:
auth_type:
const: "Client"
default: "Client"
enum:
- "Client"
title: "Auth Type"
type: "string"
client_id:
airbyte_secret: true
description: "Client ID of your Microsoft developer application"
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "Client Secret of your Microsoft developer application"
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "Refresh Token of your Microsoft developer application"
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
tenant_id:
airbyte_secret: true
description: "Tenant ID of the Microsoft OneDrive user"
title: "Tenant ID"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tenant_id"
- "client_id"
- "client_secret"
- "refresh_token"
title: "Authenticate via Microsoft (OAuth)"
type: "object"
- description: "ServiceCredentials class for service key authentication.\n\
This class is structured similarly to OAuthCredentials but for a different\
\ authentication method."
properties:
auth_type:
const: "Service"
default: "Service"
enum:
- "Service"
title: "Auth Type"
type: "string"
client_id:
airbyte_secret: true
description: "Client ID of your Microsoft developer application"
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "Client Secret of your Microsoft developer application"
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
tenant_id:
airbyte_secret: true
description: "Tenant ID of the Microsoft OneDrive user"
title: "Tenant ID"
type: "string"
x-speakeasy-param-sensitive: true
user_principal_name:
airbyte_secret: true
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"
title: "User Principal Name"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tenant_id"
- "user_principal_name"
- "client_id"
- "client_secret"
title: "Service Key Authentication"
type: "object"
order: 0
title: "Authentication"
type: "object"
drive_name:
default: "OneDrive"
description: "Name of the Microsoft OneDrive drive where the file(s) exist."
order: 2
title: "Drive Name"
type: "string"
folder_path:
default: "."
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."
order: 4
title: "Folder Path"
type: "string"
search_scope:
default: "ALL"
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."
enum:
- "ACCESSIBLE_DRIVES"
- "SHARED_ITEMS"
- "ALL"
order: 3
title: "Search Scope"
type: "string"
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"
order: 1
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"
title: "Start Date"
type: "string"
streams:
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."
items:
properties:
days_to_sync_if_history_is_full:
default: 3
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."
title: "Days To Sync If History Is Full"
type: "integer"
format:
description: "The configuration options that are used to alter how\
\ to read incoming files that deviate from the standard formatting."
oneOf:
- properties:
double_as_string:
default: false
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."
title: "Convert Double Fields to Strings"
type: "boolean"
filetype:
const: "avro"
default: "avro"
title: "Filetype"
type: "string"
enum:
- "avro"
required:
- "filetype"
title: "Avro Format"
type: "object"
- properties:
delimiter:
default: ","
description: "The character delimiting individual cells in the\
\ CSV data. This may only be a 1-character string. For tab-delimited\
\ data enter '\\t'."
title: "Delimiter"
type: "string"
double_quote:
default: true
description: "Whether two quotes in a quoted CSV value denote\
\ a single quote in the data."
title: "Double Quote"
type: "boolean"
encoding:
default: "utf8"
description: "The character encoding of the CSV data. Leave\
\ blank to default to UTF8. See list of python encodings for allowable\
\ options."
title: "Encoding"
type: "string"
escape_char:
description: "The character used for escaping special characters.\
\ To disallow escaping, leave this field blank."
title: "Escape Character"
type: "string"
false_values:
default:
- "n"
- "no"
- "f"
- "false"
- "off"
- "0"
description: "A set of case-sensitive strings that should be\
\ interpreted as false values."
items:
type: "string"
title: "False Values"
type: "array"
uniqueItems: true
filetype:
const: "csv"
default: "csv"
title: "Filetype"
type: "string"
enum:
- "csv"
header_definition:
default:
header_definition_type: "From CSV"
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."
oneOf:
- properties:
header_definition_type:
const: "From CSV"
default: "From CSV"
title: "Header Definition Type"
type: "string"
enum:
- "From CSV"
required:
- "header_definition_type"
title: "From CSV"
type: "object"
- properties:
header_definition_type:
const: "Autogenerated"
default: "Autogenerated"
title: "Header Definition Type"
type: "string"
enum:
- "Autogenerated"
required:
- "header_definition_type"
title: "Autogenerated"
type: "object"
- properties:
column_names:
description: "The column names that will be used while\
\ emitting the CSV records"
items:
type: "string"
title: "Column Names"
type: "array"
header_definition_type:
const: "User Provided"
default: "User Provided"
title: "Header Definition Type"
type: "string"
enum:
- "User Provided"
required:
- "column_names"
- "header_definition_type"
title: "User Provided"
type: "object"
title: "CSV Header Definition"
type: "object"
ignore_errors_on_fields_mismatch:
default: false
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."
title: "Ignore errors on field mismatch"
type: "boolean"
null_values:
default: []
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."
items:
type: "string"
title: "Null Values"
type: "array"
uniqueItems: true
quote_char:
default: "\""
description: "The character used for quoting CSV values. To\
\ disallow quoting, make this field blank."
title: "Quote Character"
type: "string"
skip_rows_after_header:
default: 0
description: "The number of rows to skip after the header row."
title: "Skip Rows After Header"
type: "integer"
skip_rows_before_header:
default: 0
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."
title: "Skip Rows Before Header"
type: "integer"
strings_can_be_null:
default: true
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."
title: "Strings Can Be Null"
type: "boolean"
true_values:
default:
- "y"
- "yes"
- "t"
- "true"
- "on"
- "1"
description: "A set of case-sensitive strings that should be\
\ interpreted as true values."
items:
type: "string"
title: "True Values"
type: "array"
uniqueItems: true
required:
- "filetype"
title: "CSV Format"
type: "object"
- properties:
filetype:
const: "jsonl"
default: "jsonl"
title: "Filetype"
type: "string"
enum:
- "jsonl"
required:
- "filetype"
title: "Jsonl Format"
type: "object"
- properties:
decimal_as_float:
default: false
description: "Whether to convert decimal fields to floats. There\
\ is a loss of precision when converting decimals to floats,\
\ so this is not recommended."
title: "Convert Decimal Fields to Floats"
type: "boolean"
filetype:
const: "parquet"
default: "parquet"
title: "Filetype"
type: "string"
enum:
- "parquet"
required:
- "filetype"
title: "Parquet Format"
type: "object"
- description: "Extract text from document formats (.pdf, .docx, .md,\
\ .pptx) and emit as one record per file."
properties:
filetype:
const: "unstructured"
default: "unstructured"
title: "Filetype"
type: "string"
enum:
- "unstructured"
processing:
default:
mode: "local"
description: "Processing configuration"
oneOf:
- description: "Process files locally, supporting `fast` and\
\ `ocr` modes. This is the default option."
properties:
mode:
const: "local"
default: "local"
enum:
- "local"
title: "Mode"
type: "string"
required:
- "mode"
title: "Local"
type: "object"
title: "Processing"
type: "object"
skip_unprocessable_files:
always_show: true
default: true
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."
title: "Skip Unprocessable Files"
type: "boolean"
strategy:
always_show: true
default: "auto"
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"
enum:
- "auto"
- "fast"
- "ocr_only"
- "hi_res"
order: 0
title: "Parsing Strategy"
type: "string"
required:
- "filetype"
title: "Unstructured Document Format"
type: "object"
title: "Format"
type: "object"
globs:
default:
- "**"
description: "The pattern used to specify which files should be selected\
\ from the file system. For more information on glob pattern matching\
\ look here."
items:
type: "string"
order: 1
title: "Globs"
type: "array"
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."
title: "Input Schema"
type: "string"
name:
description: "The name of the stream."
title: "Name"
type: "string"
schemaless:
default: false
description: "When enabled, syncs will not validate or structure records\
\ against the stream's schema."
title: "Schemaless"
type: "boolean"
validation_policy:
default: "Emit Record"
description: "The name of the validation policy that dictates sync\
\ behavior when a record does not adhere to the stream schema."
enum:
- "Emit Record"
- "Skip Record"
- "Wait for Discover"
title: "Validation Policy"
required:
- "name"
- "format"
title: "FileBasedStreamConfig"
type: "object"
order: 10
title: "The list of streams to sync"
type: "array"
sourceType:
title: "microsoft-onedrive"
const: "microsoft-onedrive"
enum:
- "microsoft-onedrive"
order: 0
type: "string"
required:
- "streams"
- "credentials"
- "sourceType"
title: "Microsoft OneDrive Source Spec"
type: "object"
source-microsoft-onedrive-update:
description: "SourceMicrosoftOneDriveSpec class for Microsoft OneDrive Source\
\ Specification.\nThis class combines the authentication details with additional\
\ configuration for the OneDrive API."
properties:
credentials:
description: "Credentials for connecting to the One Drive API"
oneOf:
- description: "OAuthCredentials class to hold authentication details for\
\ Microsoft OAuth authentication.\nThis class uses pydantic for data\
\ validation and settings management."
properties:
auth_type:
const: "Client"
default: "Client"
enum:
- "Client"
title: "Auth Type"
type: "string"
client_id:
airbyte_secret: true
description: "Client ID of your Microsoft developer application"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Client Secret of your Microsoft developer application"
title: "Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "Refresh Token of your Microsoft developer application"
title: "Refresh Token"
type: "string"
tenant_id:
airbyte_secret: true
description: "Tenant ID of the Microsoft OneDrive user"
title: "Tenant ID"
type: "string"
required:
- "tenant_id"
- "client_id"
- "client_secret"
- "refresh_token"
title: "Authenticate via Microsoft (OAuth)"
type: "object"
- description: "ServiceCredentials class for service key authentication.\n\
This class is structured similarly to OAuthCredentials but for a different\
\ authentication method."
properties:
auth_type:
const: "Service"
default: "Service"
enum:
- "Service"
title: "Auth Type"
type: "string"
client_id:
airbyte_secret: true
description: "Client ID of your Microsoft developer application"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Client Secret of your Microsoft developer application"
title: "Client Secret"
type: "string"
tenant_id:
airbyte_secret: true
description: "Tenant ID of the Microsoft OneDrive user"
title: "Tenant ID"
type: "string"
user_principal_name:
airbyte_secret: true
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"
title: "User Principal Name"
type: "string"
required:
- "tenant_id"
- "user_principal_name"
- "client_id"
- "client_secret"
title: "Service Key Authentication"
type: "object"
order: 0
title: "Authentication"
type: "object"
drive_name:
default: "OneDrive"
description: "Name of the Microsoft OneDrive drive where the file(s) exist."
order: 2
title: "Drive Name"
type: "string"
folder_path:
default: "."
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."
order: 4
title: "Folder Path"
type: "string"
search_scope:
default: "ALL"
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."
enum:
- "ACCESSIBLE_DRIVES"
- "SHARED_ITEMS"
- "ALL"
order: 3
title: "Search Scope"
type: "string"
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"
order: 1
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"
title: "Start Date"
type: "string"
streams:
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."
items:
properties:
days_to_sync_if_history_is_full:
default: 3
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."
title: "Days To Sync If History Is Full"
type: "integer"
format:
description: "The configuration options that are used to alter how\
\ to read incoming files that deviate from the standard formatting."
oneOf:
- properties:
double_as_string:
default: false
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."
title: "Convert Double Fields to Strings"
type: "boolean"
filetype:
const: "avro"
default: "avro"
title: "Filetype"
type: "string"
enum:
- "avro"
required:
- "filetype"
title: "Avro Format"
type: "object"
- properties:
delimiter:
default: ","
description: "The character delimiting individual cells in the\
\ CSV data. This may only be a 1-character string. For tab-delimited\
\ data enter '\\t'."
title: "Delimiter"
type: "string"
double_quote:
default: true
description: "Whether two quotes in a quoted CSV value denote\
\ a single quote in the data."
title: "Double Quote"
type: "boolean"
encoding:
default: "utf8"
description: "The character encoding of the CSV data. Leave\
\ blank to default to UTF8. See list of python encodings for allowable\
\ options."
title: "Encoding"
type: "string"
escape_char:
description: "The character used for escaping special characters.\
\ To disallow escaping, leave this field blank."
title: "Escape Character"
type: "string"
false_values:
default:
- "n"
- "no"
- "f"
- "false"
- "off"
- "0"
description: "A set of case-sensitive strings that should be\
\ interpreted as false values."
items:
type: "string"
title: "False Values"
type: "array"
uniqueItems: true
filetype:
const: "csv"
default: "csv"
title: "Filetype"
type: "string"
enum:
- "csv"
header_definition:
default:
header_definition_type: "From CSV"
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."
oneOf:
- properties:
header_definition_type:
const: "From CSV"
default: "From CSV"
title: "Header Definition Type"
type: "string"
enum:
- "From CSV"
required:
- "header_definition_type"
title: "From CSV"
type: "object"
- properties:
header_definition_type:
const: "Autogenerated"
default: "Autogenerated"
title: "Header Definition Type"
type: "string"
enum:
- "Autogenerated"
required:
- "header_definition_type"
title: "Autogenerated"
type: "object"
- properties:
column_names:
description: "The column names that will be used while\
\ emitting the CSV records"
items:
type: "string"
title: "Column Names"
type: "array"
header_definition_type:
const: "User Provided"
default: "User Provided"
title: "Header Definition Type"
type: "string"
enum:
- "User Provided"
required:
- "column_names"
- "header_definition_type"
title: "User Provided"
type: "object"
title: "CSV Header Definition"
type: "object"
ignore_errors_on_fields_mismatch:
default: false
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."
title: "Ignore errors on field mismatch"
type: "boolean"
null_values:
default: []
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."
items:
type: "string"
title: "Null Values"
type: "array"
uniqueItems: true
quote_char:
default: "\""
description: "The character used for quoting CSV values. To\
\ disallow quoting, make this field blank."
title: "Quote Character"
type: "string"
skip_rows_after_header:
default: 0
description: "The number of rows to skip after the header row."
title: "Skip Rows After Header"
type: "integer"
skip_rows_before_header:
default: 0
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."
title: "Skip Rows Before Header"
type: "integer"
strings_can_be_null:
default: true
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."
title: "Strings Can Be Null"
type: "boolean"
true_values:
default:
- "y"
- "yes"
- "t"
- "true"
- "on"
- "1"
description: "A set of case-sensitive strings that should be\
\ interpreted as true values."
items:
type: "string"
title: "True Values"
type: "array"
uniqueItems: true
required:
- "filetype"
title: "CSV Format"
type: "object"
- properties:
filetype:
const: "jsonl"
default: "jsonl"
title: "Filetype"
type: "string"
enum:
- "jsonl"
required:
- "filetype"
title: "Jsonl Format"
type: "object"
- properties:
decimal_as_float:
default: false
description: "Whether to convert decimal fields to floats. There\
\ is a loss of precision when converting decimals to floats,\
\ so this is not recommended."
title: "Convert Decimal Fields to Floats"
type: "boolean"
filetype:
const: "parquet"
default: "parquet"
title: "Filetype"
type: "string"
enum:
- "parquet"
required:
- "filetype"
title: "Parquet Format"
type: "object"
- description: "Extract text from document formats (.pdf, .docx, .md,\
\ .pptx) and emit as one record per file."
properties:
filetype:
const: "unstructured"
default: "unstructured"
title: "Filetype"
type: "string"
enum:
- "unstructured"
processing:
default:
mode: "local"
description: "Processing configuration"
oneOf:
- description: "Process files locally, supporting `fast` and\
\ `ocr` modes. This is the default option."
properties:
mode:
const: "local"
default: "local"
enum:
- "local"
title: "Mode"
type: "string"
required:
- "mode"
title: "Local"
type: "object"
title: "Processing"
type: "object"
skip_unprocessable_files:
always_show: true
default: true
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."
title: "Skip Unprocessable Files"
type: "boolean"
strategy:
always_show: true
default: "auto"
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"
enum:
- "auto"
- "fast"
- "ocr_only"
- "hi_res"
order: 0
title: "Parsing Strategy"
type: "string"
required:
- "filetype"
title: "Unstructured Document Format"
type: "object"
title: "Format"
type: "object"
globs:
default:
- "**"
description: "The pattern used to specify which files should be selected\
\ from the file system. For more information on glob pattern matching\
\ look here."
items:
type: "string"
order: 1
title: "Globs"
type: "array"
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."
title: "Input Schema"
type: "string"
name:
description: "The name of the stream."
title: "Name"
type: "string"
schemaless:
default: false
description: "When enabled, syncs will not validate or structure records\
\ against the stream's schema."
title: "Schemaless"
type: "boolean"
validation_policy:
default: "Emit Record"
description: "The name of the validation policy that dictates sync\
\ behavior when a record does not adhere to the stream schema."
enum:
- "Emit Record"
- "Skip Record"
- "Wait for Discover"
title: "Validation Policy"
required:
- "name"
- "format"
title: "FileBasedStreamConfig"
type: "object"
order: 10
title: "The list of streams to sync"
type: "array"
required:
- "streams"
- "credentials"
title: "Microsoft OneDrive Source Spec"
type: "object"
source-appfigures:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
group_by:
default: "product"
description: "Category term for grouping the search results"
enum:
- "network"
- "product"
- "country"
- "date"
order: 3
title: "Group by"
type: "string"
search_store:
default: "apple"
description: "The store which needs to be searched in streams"
order: 1
title: "Search Store"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "appfigures"
const: "appfigures"
enum:
- "appfigures"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-appfigures-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
group_by:
default: "product"
description: "Category term for grouping the search results"
enum:
- "network"
- "product"
- "country"
- "date"
order: 3
title: "Group by"
type: "string"
search_store:
default: "apple"
description: "The store which needs to be searched in streams"
order: 1
title: "Search Store"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-ding-connect:
properties:
X-Correlation-Id:
description: "Optional header to correlate HTTP requests between a client\
\ and server."
name: "X-Correlation-Id"
order: 1
title: "X-Correlation-Id"
type: "string"
api_key:
airbyte_secret: true
description: "Your API key for authenticating with the DingConnect API.\
\ You can generate this key by navigating to the Developer tab in the\
\ Account Settings section of your DingConnect account."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "ding-connect"
const: "ding-connect"
enum:
- "ding-connect"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-ding-connect-update:
properties:
X-Correlation-Id:
description: "Optional header to correlate HTTP requests between a client\
\ and server."
name: "X-Correlation-Id"
order: 1
title: "X-Correlation-Id"
type: "string"
api_key:
airbyte_secret: true
description: "Your API key for authenticating with the DingConnect API.\
\ You can generate this key by navigating to the Developer tab in the\
\ Account Settings section of your DingConnect account."
name: "api_key"
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-thrive-learning:
properties:
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
username:
description: "Your website Tenant ID (eu-west-000000 please contact support\
\ for your tenant)"
order: 0
title: "Tenant ID"
type: "string"
sourceType:
title: "thrive-learning"
const: "thrive-learning"
enum:
- "thrive-learning"
order: 0
type: "string"
required:
- "username"
- "start_date"
- "sourceType"
type: "object"
source-thrive-learning-update:
properties:
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
username:
description: "Your website Tenant ID (eu-west-000000 please contact support\
\ for your tenant)"
order: 0
title: "Tenant ID"
type: "string"
required:
- "username"
- "start_date"
type: "object"
source-printify:
properties:
api_token:
airbyte_secret: true
description: "Your Printify API token. Obtain it from your Printify account\
\ settings."
name: "api_token"
order: 0
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "printify"
const: "printify"
enum:
- "printify"
order: 0
type: "string"
required:
- "api_token"
- "sourceType"
type: "object"
source-printify-update:
properties:
api_token:
airbyte_secret: true
description: "Your Printify API token. Obtain it from your Printify account\
\ settings."
name: "api_token"
order: 0
title: "API Token"
type: "string"
required:
- "api_token"
type: "object"
source-tiktok-marketing:
properties:
attribution_window:
default: 3
description: "The attribution window in days."
maximum: 364
minimum: 0
order: 3
title: "Attribution Window"
type: "integer"
credentials:
default: {}
description: "Authentication method"
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Long-term Authorized Access Token."
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
advertiser_id:
description: "The Advertiser ID to filter reports and streams. Let\
\ this empty to retrieve all."
title: "Advertiser ID"
type: "string"
app_id:
airbyte_secret: true
description: "The Developer Application App ID."
title: "App ID"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "oauth2.0"
order: 0
title: "Auth Type"
type: "string"
enum:
- "oauth2.0"
secret:
airbyte_secret: true
description: "The Developer Application Secret."
title: "Secret"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "app_id"
- "secret"
- "access_token"
title: "OAuth2.0"
type: "object"
- properties:
access_token:
airbyte_secret: true
description: "The long-term authorized access token."
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
advertiser_id:
description: "The Advertiser ID which generated for the developer's\
\ Sandbox application."
title: "Advertiser ID"
type: "string"
auth_type:
const: "sandbox_access_token"
order: 0
title: "Auth Type"
type: "string"
enum:
- "sandbox_access_token"
required:
- "advertiser_id"
- "access_token"
title: "Sandbox Access Token"
type: "object"
order: 0
title: "Authentication Method"
type: "object"
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."
format: "date"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "End Date"
type: "string"
include_deleted:
default: false
description: "Set to active if you want to include deleted data in report\
\ based streams and Ads, Ad Groups and Campaign streams."
order: 4
title: "Include Deleted Data in Reports and Ads, Ad Groups and Campaign\
\ streams."
type: "boolean"
start_date:
default: "2016-09-01"
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."
format: "date"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Replication Start Date"
type: "string"
sourceType:
title: "tiktok-marketing"
const: "tiktok-marketing"
enum:
- "tiktok-marketing"
order: 0
type: "string"
title: "TikTok Marketing Source Spec"
type: "object"
source-tiktok-marketing-update:
properties:
attribution_window:
default: 3
description: "The attribution window in days."
maximum: 364
minimum: 0
order: 3
title: "Attribution Window"
type: "integer"
credentials:
default: {}
description: "Authentication method"
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Long-term Authorized Access Token."
title: "Access Token"
type: "string"
advertiser_id:
description: "The Advertiser ID to filter reports and streams. Let\
\ this empty to retrieve all."
title: "Advertiser ID"
type: "string"
app_id:
airbyte_secret: true
description: "The Developer Application App ID."
title: "App ID"
type: "string"
auth_type:
const: "oauth2.0"
order: 0
title: "Auth Type"
type: "string"
enum:
- "oauth2.0"
secret:
airbyte_secret: true
description: "The Developer Application Secret."
title: "Secret"
type: "string"
required:
- "app_id"
- "secret"
- "access_token"
title: "OAuth2.0"
type: "object"
- properties:
access_token:
airbyte_secret: true
description: "The long-term authorized access token."
title: "Access Token"
type: "string"
advertiser_id:
description: "The Advertiser ID which generated for the developer's\
\ Sandbox application."
title: "Advertiser ID"
type: "string"
auth_type:
const: "sandbox_access_token"
order: 0
title: "Auth Type"
type: "string"
enum:
- "sandbox_access_token"
required:
- "advertiser_id"
- "access_token"
title: "Sandbox Access Token"
type: "object"
order: 0
title: "Authentication Method"
type: "object"
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."
format: "date"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "End Date"
type: "string"
include_deleted:
default: false
description: "Set to active if you want to include deleted data in report\
\ based streams and Ads, Ad Groups and Campaign streams."
order: 4
title: "Include Deleted Data in Reports and Ads, Ad Groups and Campaign\
\ streams."
type: "boolean"
start_date:
default: "2016-09-01"
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."
format: "date"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Replication Start Date"
type: "string"
title: "TikTok Marketing Source Spec"
type: "object"
source-oncehub:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it in your OnceHub account under the\
\ API & Webhooks Integration page."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "oncehub"
const: "oncehub"
enum:
- "oncehub"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-oncehub-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it in your OnceHub account under the\
\ API & Webhooks Integration page."
name: "api_key"
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-aws-cloudtrail:
properties:
aws_key_id:
airbyte_secret: true
description: "AWS CloudTrail Access Key ID. See the docs for more information on how to obtain this key."
title: "Key ID"
type: "string"
x-speakeasy-param-sensitive: true
aws_region_name:
default: "us-east-1"
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."
title: "Region Name"
type: "string"
aws_secret_key:
airbyte_secret: true
description: "AWS CloudTrail Access Key ID. See the docs for more information on how to obtain this key."
title: "Secret Key"
type: "string"
x-speakeasy-param-sensitive: true
lookup_attributes_filter:
properties:
attribute_key:
default: "EventName"
examples:
- "EventName"
title: "Attribute Key from the response to filter"
type: "string"
attribute_value:
default: "ListInstanceAssociations"
examples:
- "ListInstanceAssociations"
- "ConsoleLogin"
title: "Corresponding value to the given attribute key"
type: "string"
required:
- "attribute_key"
- "attribute_value"
title: "Filter applied while fetching records based on AttributeKey and\
\ AttributeValue which will be appended on the request body"
type: "object"
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"
format: "date"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
sourceType:
title: "aws-cloudtrail"
const: "aws-cloudtrail"
enum:
- "aws-cloudtrail"
order: 0
type: "string"
required:
- "aws_key_id"
- "aws_secret_key"
- "aws_region_name"
- "sourceType"
title: "Aws CloudTrail Spec"
type: "object"
source-aws-cloudtrail-update:
properties:
aws_key_id:
airbyte_secret: true
description: "AWS CloudTrail Access Key ID. See the docs for more information on how to obtain this key."
title: "Key ID"
type: "string"
aws_region_name:
default: "us-east-1"
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."
title: "Region Name"
type: "string"
aws_secret_key:
airbyte_secret: true
description: "AWS CloudTrail Access Key ID. See the docs for more information on how to obtain this key."
title: "Secret Key"
type: "string"
lookup_attributes_filter:
properties:
attribute_key:
default: "EventName"
examples:
- "EventName"
title: "Attribute Key from the response to filter"
type: "string"
attribute_value:
default: "ListInstanceAssociations"
examples:
- "ListInstanceAssociations"
- "ConsoleLogin"
title: "Corresponding value to the given attribute key"
type: "string"
required:
- "attribute_key"
- "attribute_value"
title: "Filter applied while fetching records based on AttributeKey and\
\ AttributeValue which will be appended on the request body"
type: "object"
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"
format: "date"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
required:
- "aws_key_id"
- "aws_secret_key"
- "aws_region_name"
title: "Aws CloudTrail Spec"
type: "object"
source-jira:
properties:
api_token:
airbyte_secret: true
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."
order: 0
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
domain:
description: "The Domain for your Jira account, e.g. airbyteio.atlassian.net,\
\ airbyteio.jira.com, jira.your-domain.com"
examples:
- ".atlassian.net"
- ".jira.com"
- "jira..com"
order: 1
title: "Domain"
type: "string"
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
title: "Email"
type: "string"
lookback_window_minutes:
default: 0
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
maximum: 576000
minimum: 0
order: 5
title: "Lookback window"
type: "integer"
num_workers:
default: 3
description: "The number of worker threads to use for the sync."
examples:
- 1
- 2
- 3
maximum: 40
minimum: 1
order: 6
title: "Number of concurrent threads"
type: "integer"
projects:
description: "List of Jira project keys to replicate data for, or leave\
\ it empty if you want to replicate data for all projects."
examples:
- "PROJ1"
- "PROJ2"
items:
type: "string"
order: 3
title: "Projects"
type: "array"
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"
format: "date-time"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
sourceType:
title: "jira"
const: "jira"
enum:
- "jira"
order: 0
type: "string"
required:
- "api_token"
- "domain"
- "email"
- "sourceType"
title: "Jira Spec"
type: "object"
source-jira-update:
properties:
api_token:
airbyte_secret: true
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."
order: 0
title: "API Token"
type: "string"
domain:
description: "The Domain for your Jira account, e.g. airbyteio.atlassian.net,\
\ airbyteio.jira.com, jira.your-domain.com"
examples:
- ".atlassian.net"
- ".jira.com"
- "jira..com"
order: 1
title: "Domain"
type: "string"
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
title: "Email"
type: "string"
lookback_window_minutes:
default: 0
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
maximum: 576000
minimum: 0
order: 5
title: "Lookback window"
type: "integer"
num_workers:
default: 3
description: "The number of worker threads to use for the sync."
examples:
- 1
- 2
- 3
maximum: 40
minimum: 1
order: 6
title: "Number of concurrent threads"
type: "integer"
projects:
description: "List of Jira project keys to replicate data for, or leave\
\ it empty if you want to replicate data for all projects."
examples:
- "PROJ1"
- "PROJ2"
items:
type: "string"
order: 3
title: "Projects"
type: "array"
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"
format: "date-time"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
required:
- "api_token"
- "domain"
- "email"
title: "Jira Spec"
type: "object"
source-smartwaiver:
properties:
api_key:
airbyte_secret: true
description: "You can retrieve your token by visiting your dashboard then\
\ click on My Account then click on API keys."
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
default: "2017-01-24 13:12:29"
order: 1
title: "Start Date"
type: "string"
start_date_2:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "smartwaiver"
const: "smartwaiver"
enum:
- "smartwaiver"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "start_date_2"
- "sourceType"
type: "object"
source-smartwaiver-update:
properties:
api_key:
airbyte_secret: true
description: "You can retrieve your token by visiting your dashboard then\
\ click on My Account then click on API keys."
order: 0
title: "API Key"
type: "string"
start_date:
default: "2017-01-24 13:12:29"
order: 1
title: "Start Date"
type: "string"
start_date_2:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
- "start_date_2"
type: "object"
source-bunny-inc:
properties:
apikey:
airbyte_secret: true
order: 1
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
subdomain:
description: "The subdomain specific to your Bunny account or service."
name: "subdomain"
order: 0
title: "Subdomain"
type: "string"
sourceType:
title: "bunny-inc"
const: "bunny-inc"
enum:
- "bunny-inc"
order: 0
type: "string"
required:
- "subdomain"
- "apikey"
- "sourceType"
type: "object"
source-bunny-inc-update:
properties:
apikey:
airbyte_secret: true
order: 1
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
subdomain:
description: "The subdomain specific to your Bunny account or service."
name: "subdomain"
order: 0
title: "Subdomain"
type: "string"
required:
- "subdomain"
- "apikey"
type: "object"
source-hubspot:
properties:
credentials:
description: "Choose how to authenticate to HubSpot."
oneOf:
- properties:
client_id:
description: "The Client ID of your HubSpot developer application.\
\ See the Hubspot docs if you need help finding this ID."
examples:
- "123456789000"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The client secret for your HubSpot developer application.\
\ See the Hubspot docs if you need help finding this secret."
examples:
- "secret"
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
credentials_title:
const: "OAuth Credentials"
description: "Name of the credentials"
order: 0
title: "Auth Type"
type: "string"
enum:
- "OAuth Credentials"
refresh_token:
airbyte_secret: true
description: "Refresh token to renew an expired access token. See\
\ the Hubspot docs if you need help finding this token."
examples:
- "refresh_token"
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "credentials_title"
title: "OAuth"
type: "object"
- properties:
access_token:
airbyte_secret: true
description: "HubSpot Access token. See the Hubspot docs if you need help finding this token."
title: "Access token"
type: "string"
x-speakeasy-param-sensitive: true
credentials_title:
const: "Private App Credentials"
description: "Name of the credentials set"
order: 0
title: "Auth Type"
type: "string"
enum:
- "Private App Credentials"
required:
- "access_token"
- "credentials_title"
title: "Private App"
type: "object"
title: "Authentication"
type: "object"
enable_experimental_streams:
default: false
description: "If enabled then experimental streams become available for\
\ sync."
title: "Enable experimental streams"
type: "boolean"
num_worker:
default: 3
description: "The number of worker threads to use for the sync."
examples:
- 1
- 2
- 3
maximum: 40
minimum: 1
title: "Number of concurrent threads"
type: "integer"
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 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"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "hubspot"
const: "hubspot"
enum:
- "hubspot"
order: 0
type: "string"
required:
- "credentials"
- "sourceType"
title: "HubSpot Source Spec"
type: "object"
source-hubspot-update:
properties:
credentials:
description: "Choose how to authenticate to HubSpot."
oneOf:
- properties:
client_id:
description: "The Client ID of your HubSpot developer application.\
\ See the Hubspot docs if you need help finding this ID."
examples:
- "123456789000"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The client secret for your HubSpot developer application.\
\ See the Hubspot docs if you need help finding this secret."
examples:
- "secret"
title: "Client Secret"
type: "string"
credentials_title:
const: "OAuth Credentials"
description: "Name of the credentials"
order: 0
title: "Auth Type"
type: "string"
enum:
- "OAuth Credentials"
refresh_token:
airbyte_secret: true
description: "Refresh token to renew an expired access token. See\
\ the Hubspot docs if you need help finding this token."
examples:
- "refresh_token"
title: "Refresh Token"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "credentials_title"
title: "OAuth"
type: "object"
- properties:
access_token:
airbyte_secret: true
description: "HubSpot Access token. See the Hubspot docs if you need help finding this token."
title: "Access token"
type: "string"
credentials_title:
const: "Private App Credentials"
description: "Name of the credentials set"
order: 0
title: "Auth Type"
type: "string"
enum:
- "Private App Credentials"
required:
- "access_token"
- "credentials_title"
title: "Private App"
type: "object"
title: "Authentication"
type: "object"
enable_experimental_streams:
default: false
description: "If enabled then experimental streams become available for\
\ sync."
title: "Enable experimental streams"
type: "boolean"
num_worker:
default: 3
description: "The number of worker threads to use for the sync."
examples:
- 1
- 2
- 3
maximum: 40
minimum: 1
title: "Number of concurrent threads"
type: "integer"
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 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"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "credentials"
title: "HubSpot Source Spec"
type: "object"
source-fastly:
properties:
fastly_api_token:
airbyte_secret: true
description: "Your Fastly API token. You can generate this token in the\
\ Fastly web interface under Account Settings or via the Fastly API. Ensure\
\ the token has the appropriate scope for your use case."
name: "fastly_api_token"
order: 0
title: "Fastly API Token"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "fastly"
const: "fastly"
enum:
- "fastly"
order: 0
type: "string"
required:
- "fastly_api_token"
- "start_date"
- "sourceType"
type: "object"
source-fastly-update:
properties:
fastly_api_token:
airbyte_secret: true
description: "Your Fastly API token. You can generate this token in the\
\ Fastly web interface under Account Settings or via the Fastly API. Ensure\
\ the token has the appropriate scope for your use case."
name: "fastly_api_token"
order: 0
title: "Fastly API Token"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "fastly_api_token"
- "start_date"
type: "object"
source-sap-fieldglass:
properties:
api_key:
airbyte_secret: true
description: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "sap-fieldglass"
const: "sap-fieldglass"
enum:
- "sap-fieldglass"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
title: "Sap Fieldglass Spec"
type: "object"
source-sap-fieldglass-update:
properties:
api_key:
airbyte_secret: true
description: "API Key"
type: "string"
required:
- "api_key"
title: "Sap Fieldglass Spec"
type: "object"
source-twilio-taskrouter:
properties:
account_sid:
airbyte_secret: true
description: "Twilio Account ID"
order: 0
title: "Account SID"
type: "string"
x-speakeasy-param-sensitive: true
auth_token:
airbyte_secret: true
description: "Twilio Auth Token"
order: 1
title: "Auth Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "twilio-taskrouter"
const: "twilio-taskrouter"
enum:
- "twilio-taskrouter"
order: 0
type: "string"
required:
- "account_sid"
- "auth_token"
- "sourceType"
type: "object"
source-twilio-taskrouter-update:
properties:
account_sid:
airbyte_secret: true
description: "Twilio Account ID"
order: 0
title: "Account SID"
type: "string"
auth_token:
airbyte_secret: true
description: "Twilio Auth Token"
order: 1
title: "Auth Token"
type: "string"
required:
- "account_sid"
- "auth_token"
type: "object"
source-xkcd:
properties:
comic_number:
default: "2960"
description: "Specifies the comic number in which details are to be extracted,\
\ pagination will begin with that number to end of available comics"
order: 0
title: "comic_number"
type: "string"
sourceType:
title: "xkcd"
const: "xkcd"
enum:
- "xkcd"
order: 0
type: "string"
type: "object"
source-xkcd-update:
properties:
comic_number:
default: "2960"
description: "Specifies the comic number in which details are to be extracted,\
\ pagination will begin with that number to end of available comics"
order: 0
title: "comic_number"
type: "string"
type: "object"
source-jobnimbus:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it by logging into your JobNimbus account,\
\ navigating to settings, and creating a new API key under the API section."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "jobnimbus"
const: "jobnimbus"
enum:
- "jobnimbus"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-jobnimbus-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it by logging into your JobNimbus account,\
\ navigating to settings, and creating a new API key under the API section."
name: "api_key"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-marketstack:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "marketstack"
const: "marketstack"
enum:
- "marketstack"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-marketstack-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-zenloop:
properties:
api_token:
airbyte_secret: true
description: "Zenloop API Token. You can get the API token in settings page\
\ here "
type: "string"
x-speakeasy-param-sensitive: true
date_from:
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"
type: "string"
survey_group_id:
airbyte_secret: true
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"
type: "string"
x-speakeasy-param-sensitive: true
survey_id:
airbyte_secret: true
description: "Zenloop Survey ID. Can be found here. Leave empty to pull answers from all surveys"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "zenloop"
const: "zenloop"
enum:
- "zenloop"
order: 0
type: "string"
required:
- "api_token"
- "sourceType"
title: "Zenloop Spec"
type: "object"
source-zenloop-update:
properties:
api_token:
airbyte_secret: true
description: "Zenloop API Token. You can get the API token in settings page\
\ here "
type: "string"
date_from:
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"
type: "string"
survey_group_id:
airbyte_secret: true
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"
type: "string"
survey_id:
airbyte_secret: true
description: "Zenloop Survey ID. Can be found here. Leave empty to pull answers from all surveys"
type: "string"
required:
- "api_token"
title: "Zenloop Spec"
type: "object"
source-circa:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it at https://app.circa.co/settings/integrations/api"
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "circa"
const: "circa"
enum:
- "circa"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-circa-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it at https://app.circa.co/settings/integrations/api"
name: "api_key"
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-chargebee:
properties:
num_workers:
default: 3
description: "The number of worker threads to use for the sync. The performance\
\ upper boundary is based on the limit of your Chargebee plan. More info\
\ about the rate limit plan tiers can be found on Chargebee's API docs."
examples:
- 1
- 2
- 3
maximum: 50
minimum: 1
order: 4
title: "Number of concurrent threads"
type: "integer"
product_catalog:
default: "2.0"
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"
order: 3
title: "Product Catalog"
type: "string"
site:
description: "The site prefix for your Chargebee instance."
examples:
- "airbyte-test"
order: 1
title: "Site"
type: "string"
site_api_key:
airbyte_secret: true
description: "Chargebee API Key. See the docs for more information on how to obtain this key."
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
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."
examples:
- "2021-01-25T00:00:00Z"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
sourceType:
title: "chargebee"
const: "chargebee"
enum:
- "chargebee"
order: 0
type: "string"
required:
- "site_api_key"
- "site"
- "start_date"
- "sourceType"
type: "object"
source-chargebee-update:
properties:
num_workers:
default: 3
description: "The number of worker threads to use for the sync. The performance\
\ upper boundary is based on the limit of your Chargebee plan. More info\
\ about the rate limit plan tiers can be found on Chargebee's API docs."
examples:
- 1
- 2
- 3
maximum: 50
minimum: 1
order: 4
title: "Number of concurrent threads"
type: "integer"
product_catalog:
default: "2.0"
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"
order: 3
title: "Product Catalog"
type: "string"
site:
description: "The site prefix for your Chargebee instance."
examples:
- "airbyte-test"
order: 1
title: "Site"
type: "string"
site_api_key:
airbyte_secret: true
description: "Chargebee API Key. See the docs for more information on how to obtain this key."
order: 0
title: "API Key"
type: "string"
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."
examples:
- "2021-01-25T00:00:00Z"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
required:
- "site_api_key"
- "site"
- "start_date"
type: "object"
source-wrike:
properties:
access_token:
airbyte_secret: true
description: "Permanent access token. You can find documentation on how\
\ to acquire a permanent access token here"
order: 0
title: "Permanent Access Token"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "UTC date and time in the format 2017-01-25T00:00:00Z. Only\
\ comments after this date will be replicated."
examples:
- "2017-01-25T00:00:00Z"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date for comments"
type: "string"
wrike_instance:
default: "app-us2.wrike.com"
description: "Wrike's instance such as `app-us2.wrike.com`"
order: 1
title: "Wrike Instance (hostname)"
type: "string"
sourceType:
title: "wrike"
const: "wrike"
enum:
- "wrike"
order: 0
type: "string"
required:
- "access_token"
- "wrike_instance"
- "sourceType"
type: "object"
source-wrike-update:
properties:
access_token:
airbyte_secret: true
description: "Permanent access token. You can find documentation on how\
\ to acquire a permanent access token here"
order: 0
title: "Permanent Access Token"
type: "string"
start_date:
description: "UTC date and time in the format 2017-01-25T00:00:00Z. Only\
\ comments after this date will be replicated."
examples:
- "2017-01-25T00:00:00Z"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date for comments"
type: "string"
wrike_instance:
default: "app-us2.wrike.com"
description: "Wrike's instance such as `app-us2.wrike.com`"
order: 1
title: "Wrike Instance (hostname)"
type: "string"
required:
- "access_token"
- "wrike_instance"
type: "object"
source-zoom:
properties:
account_id:
description: "The account ID for your Zoom account. You can find this in\
\ the Zoom Marketplace under the \"Manage\" tab for your app."
order: 0
type: "string"
authorization_endpoint:
default: "https://zoom.us/oauth/token"
order: 3
type: "string"
client_id:
description: "The client ID for your Zoom app. You can find this in the\
\ Zoom Marketplace under the \"Manage\" tab for your app."
order: 1
type: "string"
client_secret:
airbyte_secret: true
description: "The client secret for your Zoom app. You can find this in\
\ the Zoom Marketplace under the \"Manage\" tab for your app."
order: 2
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "zoom"
const: "zoom"
enum:
- "zoom"
order: 0
type: "string"
required:
- "account_id"
- "client_id"
- "client_secret"
- "authorization_endpoint"
- "sourceType"
title: "Zoom Spec"
type: "object"
source-zoom-update:
properties:
account_id:
description: "The account ID for your Zoom account. You can find this in\
\ the Zoom Marketplace under the \"Manage\" tab for your app."
order: 0
type: "string"
authorization_endpoint:
default: "https://zoom.us/oauth/token"
order: 3
type: "string"
client_id:
description: "The client ID for your Zoom app. You can find this in the\
\ Zoom Marketplace under the \"Manage\" tab for your app."
order: 1
type: "string"
client_secret:
airbyte_secret: true
description: "The client secret for your Zoom app. You can find this in\
\ the Zoom Marketplace under the \"Manage\" tab for your app."
order: 2
type: "string"
required:
- "account_id"
- "client_id"
- "client_secret"
- "authorization_endpoint"
title: "Zoom Spec"
type: "object"
source-klarna:
properties:
password:
airbyte_secret: true
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)"
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
playground:
default: false
description: "Propertie defining if connector is used against playground\
\ or production environment"
title: "Playground"
type: "boolean"
region:
description: "Base url region (For playground eu https://docs.klarna.com/klarna-payments/api/payments-api/#tag/API-URLs).\
\ Supported 'eu', 'na', 'oc'"
enum:
- "eu"
- "na"
- "oc"
title: "Region"
type: "string"
username:
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)"
title: "Username"
type: "string"
sourceType:
title: "klarna"
const: "klarna"
enum:
- "klarna"
order: 0
type: "string"
required:
- "region"
- "playground"
- "username"
- "password"
- "sourceType"
title: "Klarna Spec"
type: "object"
source-klarna-update:
properties:
password:
airbyte_secret: true
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)"
title: "Password"
type: "string"
playground:
default: false
description: "Propertie defining if connector is used against playground\
\ or production environment"
title: "Playground"
type: "boolean"
region:
description: "Base url region (For playground eu https://docs.klarna.com/klarna-payments/api/payments-api/#tag/API-URLs).\
\ Supported 'eu', 'na', 'oc'"
enum:
- "eu"
- "na"
- "oc"
title: "Region"
type: "string"
username:
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)"
title: "Username"
type: "string"
required:
- "region"
- "playground"
- "username"
- "password"
title: "Klarna Spec"
type: "object"
source-typeform:
properties:
credentials:
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests."
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "oauth2.0"
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The Client ID of the Typeform developer application."
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The Client Secret the Typeform developer application."
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "The key to refresh the expired access_token."
type: "string"
x-speakeasy-param-sensitive: true
token_expiry_date:
description: "The date-time when the access token should be refreshed."
format: "date-time"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "access_token"
- "token_expiry_date"
title: "OAuth2.0"
type: "object"
- properties:
access_token:
airbyte_secret: true
description: "Log into your Typeform account and then generate a personal\
\ Access Token."
title: "Private Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "access_token"
type: "string"
enum:
- "access_token"
required:
- "access_token"
title: "Private Token"
type: "object"
order: 0
title: "Authorization Method"
type: "object"
form_ids:
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"
items:
type: "string"
order: 3
title: "Form IDs to replicate"
type: "array"
uniqueItems: true
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"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
sourceType:
title: "typeform"
const: "typeform"
enum:
- "typeform"
order: 0
type: "string"
required:
- "credentials"
- "sourceType"
type: "object"
source-typeform-update:
properties:
credentials:
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests."
type: "string"
auth_type:
const: "oauth2.0"
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The Client ID of the Typeform developer application."
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret the Typeform developer application."
type: "string"
refresh_token:
airbyte_secret: true
description: "The key to refresh the expired access_token."
type: "string"
token_expiry_date:
description: "The date-time when the access token should be refreshed."
format: "date-time"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "access_token"
- "token_expiry_date"
title: "OAuth2.0"
type: "object"
- properties:
access_token:
airbyte_secret: true
description: "Log into your Typeform account and then generate a personal\
\ Access Token."
title: "Private Token"
type: "string"
auth_type:
const: "access_token"
type: "string"
enum:
- "access_token"
required:
- "access_token"
title: "Private Token"
type: "object"
order: 0
title: "Authorization Method"
type: "object"
form_ids:
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"
items:
type: "string"
order: 3
title: "Form IDs to replicate"
type: "array"
uniqueItems: true
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"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
required:
- "credentials"
type: "object"
source-dremio:
properties:
api_key:
airbyte_secret: true
description: "API Key that is generated when you authenticate to Dremio\
\ API"
type: "string"
x-speakeasy-param-sensitive: true
base_url:
default: "https://app.dremio.cloud"
description: "URL of your Dremio instance"
type: "string"
sourceType:
title: "dremio"
const: "dremio"
enum:
- "dremio"
order: 0
type: "string"
required:
- "api_key"
- "base_url"
- "sourceType"
title: "Dremio Spec"
type: "object"
source-dremio-update:
properties:
api_key:
airbyte_secret: true
description: "API Key that is generated when you authenticate to Dremio\
\ API"
type: "string"
base_url:
default: "https://app.dremio.cloud"
description: "URL of your Dremio instance"
type: "string"
required:
- "api_key"
- "base_url"
title: "Dremio Spec"
type: "object"
source-ebay-fulfillment:
properties:
api_host:
default: "https://api.ebay.com"
enum:
- "https://api.ebay.com"
- "https://api.sandbox.ebay.com"
order: 1
title: "API Host"
type: "string"
password:
airbyte_secret: true
order: 3
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
redirect_uri:
order: 4
title: "Redirect URI"
type: "string"
refresh_token:
airbyte_secret: true
order: 5
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token_endpoint:
default: "https://api.ebay.com/identity/v1/oauth2/token"
enum:
- "https://api.ebay.com/identity/v1/oauth2/token"
- "https://api.sandbox.ebay.com/identity/v1/oauth2/token"
order: 0
title: "Refresh Token Endpoint"
type: "string"
start_date:
format: "date-time"
order: 6
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
username:
order: 2
title: "Username"
type: "string"
sourceType:
title: "ebay-fulfillment"
const: "ebay-fulfillment"
enum:
- "ebay-fulfillment"
order: 0
type: "string"
required:
- "refresh_token_endpoint"
- "api_host"
- "username"
- "password"
- "redirect_uri"
- "refresh_token"
- "start_date"
- "sourceType"
type: "object"
source-ebay-fulfillment-update:
properties:
api_host:
default: "https://api.ebay.com"
enum:
- "https://api.ebay.com"
- "https://api.sandbox.ebay.com"
order: 1
title: "API Host"
type: "string"
password:
airbyte_secret: true
order: 3
title: "Password"
type: "string"
redirect_uri:
order: 4
title: "Redirect URI"
type: "string"
refresh_token:
airbyte_secret: true
order: 5
title: "Refresh Token"
type: "string"
refresh_token_endpoint:
default: "https://api.ebay.com/identity/v1/oauth2/token"
enum:
- "https://api.ebay.com/identity/v1/oauth2/token"
- "https://api.sandbox.ebay.com/identity/v1/oauth2/token"
order: 0
title: "Refresh Token Endpoint"
type: "string"
start_date:
format: "date-time"
order: 6
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
username:
order: 2
title: "Username"
type: "string"
required:
- "refresh_token_endpoint"
- "api_host"
- "username"
- "password"
- "redirect_uri"
- "refresh_token"
- "start_date"
type: "object"
source-safetyculture:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "safetyculture"
const: "safetyculture"
enum:
- "safetyculture"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-safetyculture-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-lemlist:
properties:
api_key:
airbyte_secret: true
description: "Lemlist API key,"
order: 0
title: "API Key"
title": "API key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "lemlist"
const: "lemlist"
enum:
- "lemlist"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-lemlist-update:
properties:
api_key:
airbyte_secret: true
description: "Lemlist API key,"
order: 0
title: "API Key"
title": "API key"
type: "string"
required:
- "api_key"
type: "object"
source-glassfrog:
properties:
api_key:
airbyte_secret: true
description: "API key provided by Glassfrog"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "glassfrog"
const: "glassfrog"
enum:
- "glassfrog"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-glassfrog-update:
properties:
api_key:
airbyte_secret: true
description: "API key provided by Glassfrog"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-facebook-pages:
properties:
access_token:
airbyte_secret: true
description: "Facebook Page Access Token"
order: 0
title: "Page Access Token"
type: "string"
x-speakeasy-param-sensitive: true
page_id:
description: "Page ID"
order: 1
title: "Page ID"
type: "string"
sourceType:
title: "facebook-pages"
const: "facebook-pages"
enum:
- "facebook-pages"
order: 0
type: "string"
required:
- "access_token"
- "page_id"
- "sourceType"
title: "Facebook Pages Spec"
type: "object"
source-facebook-pages-update:
properties:
access_token:
airbyte_secret: true
description: "Facebook Page Access Token"
order: 0
title: "Page Access Token"
type: "string"
page_id:
description: "Page ID"
order: 1
title: "Page ID"
type: "string"
required:
- "access_token"
- "page_id"
title: "Facebook Pages Spec"
type: "object"
source-recruitee:
properties:
api_key:
airbyte_secret: true
description: "Recruitee API Key. See here."
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
company_id:
description: "Recruitee Company ID. You can also find this ID on the Recruitee API\
\ tokens page."
order: 1
title: "Company ID"
type: "integer"
sourceType:
title: "recruitee"
const: "recruitee"
enum:
- "recruitee"
order: 0
type: "string"
required:
- "api_key"
- "company_id"
- "sourceType"
type: "object"
source-recruitee-update:
properties:
api_key:
airbyte_secret: true
description: "Recruitee API Key. See here."
order: 0
title: "API Key"
type: "string"
company_id:
description: "Recruitee Company ID. You can also find this ID on the Recruitee API\
\ tokens page."
order: 1
title: "Company ID"
type: "integer"
required:
- "api_key"
- "company_id"
type: "object"
source-airbyte:
properties:
client_id:
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
order: 1
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
host:
description: "The Host URL of your Self-Managed Deployment (e.x. airbtye.mydomain.com)"
order: 3
title: "Self-Managed Host"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "airbyte"
const: "airbyte"
enum:
- "airbyte"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "start_date"
- "sourceType"
type: "object"
source-airbyte-update:
properties:
client_id:
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
order: 1
title: "Client Secret"
type: "string"
host:
description: "The Host URL of your Self-Managed Deployment (e.x. airbtye.mydomain.com)"
order: 3
title: "Self-Managed Host"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "client_id"
- "client_secret"
- "start_date"
type: "object"
source-azure-table:
properties:
storage_access_key:
airbyte_secret: true
description: "Azure Table Storage Access Key. See the docs for more information on how to obtain this key."
order: 1
title: "Access Key"
type: "string"
x-speakeasy-param-sensitive: true
storage_account_name:
airbyte_secret: false
description: "The name of your storage account."
order: 0
title: "Account Name"
type: "string"
x-speakeasy-param-sensitive: true
storage_endpoint_suffix:
airbyte_secret: false
default: "core.windows.net"
description: "Azure Table Storage service account URL suffix. See the docs\
\ for more information on how to obtain endpoint suffix"
examples:
- "core.windows.net"
- "core.chinacloudapi.cn"
order: 2
title: "Endpoint Suffix"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "azure-table"
const: "azure-table"
enum:
- "azure-table"
order: 0
type: "string"
required:
- "storage_account_name"
- "storage_access_key"
- "sourceType"
title: "Azure Data Table Spec"
type: "object"
source-azure-table-update:
properties:
storage_access_key:
airbyte_secret: true
description: "Azure Table Storage Access Key. See the docs for more information on how to obtain this key."
order: 1
title: "Access Key"
type: "string"
storage_account_name:
airbyte_secret: false
description: "The name of your storage account."
order: 0
title: "Account Name"
type: "string"
storage_endpoint_suffix:
airbyte_secret: false
default: "core.windows.net"
description: "Azure Table Storage service account URL suffix. See the docs\
\ for more information on how to obtain endpoint suffix"
examples:
- "core.windows.net"
- "core.chinacloudapi.cn"
order: 2
title: "Endpoint Suffix"
type: "string"
required:
- "storage_account_name"
- "storage_access_key"
title: "Azure Data Table Spec"
type: "object"
source-customer-io:
properties:
app_api_key:
airbyte_secret: true
order: 0
title: "Customer.io App API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "customer-io"
const: "customer-io"
enum:
- "customer-io"
order: 0
type: "string"
required:
- "app_api_key"
- "sourceType"
type: "object"
source-customer-io-update:
properties:
app_api_key:
airbyte_secret: true
order: 0
title: "Customer.io App API Key"
type: "string"
required:
- "app_api_key"
type: "object"
source-surveymonkey:
properties:
credentials:
description: "The authorization method to use to retrieve data from SurveyMonkey"
order: 2
properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests. See the\
\ docs for information on how to generate this key."
order: 3
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_method:
const: "oauth2.0"
order: 0
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The Client ID of the SurveyMonkey developer application."
order: 1
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The Client Secret of the SurveyMonkey developer application."
order: 2
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_method"
- "access_token"
title: "SurveyMonkey Authorization Method"
type: "object"
origin:
default: "USA"
description: "Depending on the originating datacenter of the SurveyMonkey\
\ account, the API access URL may be different."
enum:
- "USA"
- "Europe"
- "Canada"
order: 1
title: "Origin datacenter of the SurveyMonkey account"
type: "string"
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:
- "2021-01-01T00:00:00Z"
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z?$"
title: "Start Date"
type: "string"
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."
items:
pattern: "^[0-9]{8,9}$"
type: "string"
order: 1000
title: "Survey Monkey survey IDs"
type: "array"
sourceType:
title: "surveymonkey"
const: "surveymonkey"
enum:
- "surveymonkey"
order: 0
type: "string"
required:
- "start_date"
- "credentials"
- "sourceType"
type: "object"
source-surveymonkey-update:
properties:
credentials:
description: "The authorization method to use to retrieve data from SurveyMonkey"
order: 2
properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests. See the\
\ docs for information on how to generate this key."
order: 3
title: "Access Token"
type: "string"
auth_method:
const: "oauth2.0"
order: 0
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The Client ID of the SurveyMonkey developer application."
order: 1
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of the SurveyMonkey developer application."
order: 2
title: "Client Secret"
type: "string"
required:
- "auth_method"
- "access_token"
title: "SurveyMonkey Authorization Method"
type: "object"
origin:
default: "USA"
description: "Depending on the originating datacenter of the SurveyMonkey\
\ account, the API access URL may be different."
enum:
- "USA"
- "Europe"
- "Canada"
order: 1
title: "Origin datacenter of the SurveyMonkey account"
type: "string"
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:
- "2021-01-01T00:00:00Z"
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z?$"
title: "Start Date"
type: "string"
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."
items:
pattern: "^[0-9]{8,9}$"
type: "string"
order: 1000
title: "Survey Monkey survey IDs"
type: "array"
required:
- "start_date"
- "credentials"
type: "object"
source-signnow:
properties:
api_key_id:
airbyte_secret: true
description: "Api key which could be found in API section after enlarging\
\ keys section"
order: 1
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
auth_token:
airbyte_secret: true
description: "The authorization token is needed for `signing_links` stream\
\ which could be seen from enlarged view of `https://app.signnow.com/webapp/api-dashboard/keys`"
order: 0
title: "Auth Token"
type: "string"
x-speakeasy-param-sensitive: true
name_filter_for_documents:
description: "Name filter for documents stream"
order: 3
title: "Name filter for documents"
type: "array"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "signnow"
const: "signnow"
enum:
- "signnow"
order: 0
type: "string"
required:
- "auth_token"
- "api_key_id"
- "start_date"
- "sourceType"
type: "object"
source-signnow-update:
properties:
api_key_id:
airbyte_secret: true
description: "Api key which could be found in API section after enlarging\
\ keys section"
order: 1
title: "API Key"
type: "string"
auth_token:
airbyte_secret: true
description: "The authorization token is needed for `signing_links` stream\
\ which could be seen from enlarged view of `https://app.signnow.com/webapp/api-dashboard/keys`"
order: 0
title: "Auth Token"
type: "string"
name_filter_for_documents:
description: "Name filter for documents stream"
order: 3
title: "Name filter for documents"
type: "array"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "auth_token"
- "api_key_id"
- "start_date"
type: "object"
source-reddit:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
exact:
description: "Specifies exact keyword and reduces distractions"
order: 3
title: "Exact"
type: "boolean"
include_over_18:
default: false
description: "Includes mature content"
order: 2
title: "Include over 18 flag"
type: "boolean"
limit:
default: "1000"
description: "Max records per page limit"
order: 4
title: "Limit"
type: "number"
query:
default: "airbyte"
description: "Specifies the query for searching in reddits and subreddits"
order: 1
title: "Query"
type: "string"
start_date:
format: "date-time"
order: 6
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
subreddits:
default:
- "r/funny"
- "r/AskReddit"
description: "Subreddits for exploration"
order: 5
title: "Subreddits"
type: "array"
sourceType:
title: "reddit"
const: "reddit"
enum:
- "reddit"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-reddit-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
exact:
description: "Specifies exact keyword and reduces distractions"
order: 3
title: "Exact"
type: "boolean"
include_over_18:
default: false
description: "Includes mature content"
order: 2
title: "Include over 18 flag"
type: "boolean"
limit:
default: "1000"
description: "Max records per page limit"
order: 4
title: "Limit"
type: "number"
query:
default: "airbyte"
description: "Specifies the query for searching in reddits and subreddits"
order: 1
title: "Query"
type: "string"
start_date:
format: "date-time"
order: 6
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
subreddits:
default:
- "r/funny"
- "r/AskReddit"
description: "Subreddits for exploration"
order: 5
title: "Subreddits"
type: "array"
required:
- "api_key"
- "start_date"
type: "object"
source-firehydrant:
properties:
api_token:
airbyte_secret: true
description: "Bot token to use for authenticating with the FireHydrant API.\
\ You can find or create a bot token by logging into your organization\
\ and visiting the Bot users page at https://app.firehydrant.io/organizations/bots."
name: "api_token"
order: 0
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "firehydrant"
const: "firehydrant"
enum:
- "firehydrant"
order: 0
type: "string"
required:
- "api_token"
- "sourceType"
type: "object"
source-firehydrant-update:
properties:
api_token:
airbyte_secret: true
description: "Bot token to use for authenticating with the FireHydrant API.\
\ You can find or create a bot token by logging into your organization\
\ and visiting the Bot users page at https://app.firehydrant.io/organizations/bots."
name: "api_token"
order: 0
title: "API Token"
type: "string"
required:
- "api_token"
type: "object"
source-concord:
properties:
api_key:
airbyte_secret: true
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
env:
description: "The environment from where you want to access the API."
enum:
- "uat"
- "api"
name: "organizationId"
order: 1
title: "Environment"
type: "string"
sourceType:
title: "concord"
const: "concord"
enum:
- "concord"
order: 0
type: "string"
required:
- "api_key"
- "env"
- "sourceType"
type: "object"
source-concord-update:
properties:
api_key:
airbyte_secret: true
name: "api_key"
order: 0
title: "API Key"
type: "string"
env:
description: "The environment from where you want to access the API."
enum:
- "uat"
- "api"
name: "organizationId"
order: 1
title: "Environment"
type: "string"
required:
- "api_key"
- "env"
type: "object"
source-e-conomic:
properties:
agreement_grant_token:
airbyte_secret: true
description: "Token that identifies the grant issued by an agreement, allowing\
\ your app to access data. Obtain it from your e-conomic account settings."
name: "agreement_grant_token"
order: 1
title: "Agreement Grant Token"
type: "string"
x-speakeasy-param-sensitive: true
app_secret_token:
airbyte_secret: true
description: "Your private token that identifies your app. Find it in your\
\ e-conomic account settings."
name: "app_secret_token"
order: 0
title: "App Secret Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "e-conomic"
const: "e-conomic"
enum:
- "e-conomic"
order: 0
type: "string"
required:
- "app_secret_token"
- "agreement_grant_token"
- "sourceType"
type: "object"
source-e-conomic-update:
properties:
agreement_grant_token:
airbyte_secret: true
description: "Token that identifies the grant issued by an agreement, allowing\
\ your app to access data. Obtain it from your e-conomic account settings."
name: "agreement_grant_token"
order: 1
title: "Agreement Grant Token"
type: "string"
app_secret_token:
airbyte_secret: true
description: "Your private token that identifies your app. Find it in your\
\ e-conomic account settings."
name: "app_secret_token"
order: 0
title: "App Secret Token"
type: "string"
required:
- "app_secret_token"
- "agreement_grant_token"
type: "object"
source-appfollow:
properties:
api_secret:
airbyte_secret: true
description: "API Key provided by Appfollow"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "appfollow"
const: "appfollow"
enum:
- "appfollow"
order: 0
type: "string"
required:
- "sourceType"
type: "object"
source-appfollow-update:
properties:
api_secret:
airbyte_secret: true
description: "API Key provided by Appfollow"
order: 0
title: "API Key"
type: "string"
required: []
type: "object"
source-dixa:
properties:
api_token:
airbyte_secret: true
description: "Dixa API token"
order: 1
type: "string"
x-speakeasy-param-sensitive: true
batch_size:
default: 31
description: "Number of days to batch into one request. Max 31."
examples:
- 1
- 31
order: 2
pattern: "^[0-9]{1,2}$"
type: "integer"
start_date:
description: "The connector pulls records updated from this date onwards."
examples:
- "YYYY-MM-DD"
format: "date-time"
order: 3
title: "Start date"
type: "string"
sourceType:
title: "dixa"
const: "dixa"
enum:
- "dixa"
order: 0
type: "string"
required:
- "api_token"
- "start_date"
- "sourceType"
type: "object"
source-dixa-update:
properties:
api_token:
airbyte_secret: true
description: "Dixa API token"
order: 1
type: "string"
batch_size:
default: 31
description: "Number of days to batch into one request. Max 31."
examples:
- 1
- 31
order: 2
pattern: "^[0-9]{1,2}$"
type: "integer"
start_date:
description: "The connector pulls records updated from this date onwards."
examples:
- "YYYY-MM-DD"
format: "date-time"
order: 3
title: "Start date"
type: "string"
required:
- "api_token"
- "start_date"
type: "object"
source-solarwinds-service-desk:
properties:
api_key_2:
airbyte_secret: true
description: "Refer to `https://documentation.solarwinds.com/en/success_center/swsd/content/completeguidetoswsd/token-authentication-for-api-integration.htm#link4`"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "solarwinds-service-desk"
const: "solarwinds-service-desk"
enum:
- "solarwinds-service-desk"
order: 0
type: "string"
required:
- "api_key_2"
- "start_date"
- "sourceType"
type: "object"
source-solarwinds-service-desk-update:
properties:
api_key_2:
airbyte_secret: true
description: "Refer to `https://documentation.solarwinds.com/en/success_center/swsd/content/completeguidetoswsd/token-authentication-for-api-integration.htm#link4`"
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key_2"
- "start_date"
type: "object"
source-freshcaller:
properties:
api_key:
airbyte_secret: true
description: "Freshcaller API Key. See the docs for more information on\
\ how to obtain this key."
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
domain:
description: "Used to construct Base URL for the Freshcaller APIs"
examples:
- "snaptravel"
title: "Domain for Freshcaller account"
type: "string"
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."
title: "Requests per minute"
type: "integer"
start_date:
description: "UTC date and time. Any data created after this date will be\
\ replicated."
examples:
- "2022-01-01T12: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$"
title: "Start Date"
type: "string"
sync_lag_minutes:
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"
title: "Lag in minutes for each sync"
type: "integer"
sourceType:
title: "freshcaller"
const: "freshcaller"
enum:
- "freshcaller"
order: 0
type: "string"
required:
- "domain"
- "api_key"
- "sourceType"
title: "Freshcaller Spec"
type: "object"
source-freshcaller-update:
properties:
api_key:
airbyte_secret: true
description: "Freshcaller API Key. See the docs for more information on\
\ how to obtain this key."
title: "API Key"
type: "string"
domain:
description: "Used to construct Base URL for the Freshcaller APIs"
examples:
- "snaptravel"
title: "Domain for Freshcaller account"
type: "string"
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."
title: "Requests per minute"
type: "integer"
start_date:
description: "UTC date and time. Any data created after this date will be\
\ replicated."
examples:
- "2022-01-01T12: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$"
title: "Start Date"
type: "string"
sync_lag_minutes:
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"
title: "Lag in minutes for each sync"
type: "integer"
required:
- "domain"
- "api_key"
title: "Freshcaller Spec"
type: "object"
source-workday:
properties:
credentials:
description: "Credentials for connecting to the Workday (RAAS) API."
properties:
password:
airbyte_secret: true
order: 1
title: "Password of your Workday account"
type: "string"
x-speakeasy-param-sensitive: true
username:
order: 0
title: "Username of your Workday account"
type: "string"
required:
- "username"
- "password"
title: "Authentication"
type: "object"
host:
order: 1
title: "Workday hostname"
type: "string"
num_workers:
default: 10
description: "The number of worker threads to use for the sync."
examples:
- 1
- 2
- 3
maximum: 20
minimum: 1
title: "Number of concurrent threads"
type: "integer"
report_ids:
description: "Report IDs can be found by clicking the three dots on the\
\ right side of the report > Web Service > View URLs > in JSON url copy\
\ everything between Workday tenant/ and ?format=json."
examples:
- "for JSON url https://hostname/ccx/service/customreport2/tenant/report/id?format=json\
\ Report ID is report/id."
items:
properties:
report_id:
type: "string"
type: "object"
order: 2
title: "Report IDs you want to sync."
type: "array"
tenant_id:
airbyte_secret: true
order: 0
title: "Workday tenant"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "workday"
const: "workday"
enum:
- "workday"
order: 0
type: "string"
required:
- "tenant_id"
- "host"
- "credentials"
- "report_ids"
- "sourceType"
type: "object"
source-workday-update:
properties:
credentials:
description: "Credentials for connecting to the Workday (RAAS) API."
properties:
password:
airbyte_secret: true
order: 1
title: "Password of your Workday account"
type: "string"
username:
order: 0
title: "Username of your Workday account"
type: "string"
required:
- "username"
- "password"
title: "Authentication"
type: "object"
host:
order: 1
title: "Workday hostname"
type: "string"
num_workers:
default: 10
description: "The number of worker threads to use for the sync."
examples:
- 1
- 2
- 3
maximum: 20
minimum: 1
title: "Number of concurrent threads"
type: "integer"
report_ids:
description: "Report IDs can be found by clicking the three dots on the\
\ right side of the report > Web Service > View URLs > in JSON url copy\
\ everything between Workday tenant/ and ?format=json."
examples:
- "for JSON url https://hostname/ccx/service/customreport2/tenant/report/id?format=json\
\ Report ID is report/id."
items:
properties:
report_id:
type: "string"
type: "object"
order: 2
title: "Report IDs you want to sync."
type: "array"
tenant_id:
airbyte_secret: true
order: 0
title: "Workday tenant"
type: "string"
required:
- "tenant_id"
- "host"
- "credentials"
- "report_ids"
type: "object"
source-aha:
properties:
api_key:
airbyte_secret: true
description: "API Key"
order: 0
title: "API Bearer Token"
type: "string"
x-speakeasy-param-sensitive: true
url:
description: "URL"
order: 1
title: "Aha Url Instance"
type: "string"
sourceType:
title: "aha"
const: "aha"
enum:
- "aha"
order: 0
type: "string"
required:
- "api_key"
- "url"
- "sourceType"
type: "object"
source-aha-update:
properties:
api_key:
airbyte_secret: true
description: "API Key"
order: 0
title: "API Bearer Token"
type: "string"
url:
description: "URL"
order: 1
title: "Aha Url Instance"
type: "string"
required:
- "api_key"
- "url"
type: "object"
source-convertkit:
properties:
credentials:
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "An access token generated using the provided client\
\ information and refresh token."
order: 4
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "oauth2.0"
order: 0
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The client ID of your OAuth application."
order: 1
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The client secret of your OAuth application."
order: 2
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
expires_at:
description: "The time at which the current access token is set to\
\ expire"
format: "date-time"
order: 5
title: "Access Token Expires At"
type: "string"
refresh_token:
airbyte_secret: true
description: "A current, non-expired refresh token genereted using\
\ the provided client ID and secret."
order: 3
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_type"
- "client_id"
- "client_secret"
- "refresh_token"
title: "OAuth 2.0"
type: "object"
- properties:
api_key:
airbyte_secret: true
default: "{{ config.get('credentials',{}).get('api_key') or config.get('api_secret')\
\ }}"
description: "Kit/ConvertKit API Key"
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "api_key"
order: 1
type: "string"
enum:
- "api_key"
required:
- "auth_type"
- "api_key"
title: "API Key"
type: "object"
order: 1
title: "Authentication Type"
type: "object"
start_date:
default: "2013-01-01T00:00:00Z"
format: "date-time"
order: 0
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "convertkit"
const: "convertkit"
enum:
- "convertkit"
order: 0
type: "string"
required:
- "start_date"
- "credentials"
- "sourceType"
type: "object"
source-convertkit-update:
properties:
credentials:
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "An access token generated using the provided client\
\ information and refresh token."
order: 4
title: "Access Token"
type: "string"
auth_type:
const: "oauth2.0"
order: 0
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The client ID of your OAuth application."
order: 1
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The client secret of your OAuth application."
order: 2
title: "Client Secret"
type: "string"
expires_at:
description: "The time at which the current access token is set to\
\ expire"
format: "date-time"
order: 5
title: "Access Token Expires At"
type: "string"
refresh_token:
airbyte_secret: true
description: "A current, non-expired refresh token genereted using\
\ the provided client ID and secret."
order: 3
title: "Refresh Token"
type: "string"
required:
- "auth_type"
- "client_id"
- "client_secret"
- "refresh_token"
title: "OAuth 2.0"
type: "object"
- properties:
api_key:
airbyte_secret: true
default: "{{ config.get('credentials',{}).get('api_key') or config.get('api_secret')\
\ }}"
description: "Kit/ConvertKit API Key"
title: "API Key"
type: "string"
auth_type:
const: "api_key"
order: 1
type: "string"
enum:
- "api_key"
required:
- "auth_type"
- "api_key"
title: "API Key"
type: "object"
order: 1
title: "Authentication Type"
type: "object"
start_date:
default: "2013-01-01T00:00:00Z"
format: "date-time"
order: 0
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "start_date"
- "credentials"
type: "object"
source-gitbook:
properties:
access_token:
airbyte_secret: true
description: "Personal access token for authenticating with the GitBook\
\ API. You can view and manage your access tokens in the Developer settings\
\ of your GitBook user account."
name: "access_token"
order: 0
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
space_id:
order: 1
title: "Space Id"
type: "string"
sourceType:
title: "gitbook"
const: "gitbook"
enum:
- "gitbook"
order: 0
type: "string"
required:
- "access_token"
- "space_id"
- "sourceType"
type: "object"
source-gitbook-update:
properties:
access_token:
airbyte_secret: true
description: "Personal access token for authenticating with the GitBook\
\ API. You can view and manage your access tokens in the Developer settings\
\ of your GitBook user account."
name: "access_token"
order: 0
title: "Access Token"
type: "string"
space_id:
order: 1
title: "Space Id"
type: "string"
required:
- "access_token"
- "space_id"
type: "object"
source-miro:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "miro"
const: "miro"
enum:
- "miro"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-miro-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-metabase:
properties:
instance_api_url:
description: "URL to your metabase instance API"
examples:
- "https://localhost:3000/api/"
order: 0
pattern: "^https://"
title: "Metabase Instance API URL"
type: "string"
password:
airbyte_secret: true
always_show: true
order: 2
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
session_token:
airbyte_secret: true
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."
order: 3
type: "string"
x-speakeasy-param-sensitive: true
username:
order: 1
title: "Username"
type: "string"
sourceType:
title: "metabase"
const: "metabase"
enum:
- "metabase"
order: 0
type: "string"
required:
- "instance_api_url"
- "username"
- "sourceType"
type: "object"
source-metabase-update:
properties:
instance_api_url:
description: "URL to your metabase instance API"
examples:
- "https://localhost:3000/api/"
order: 0
pattern: "^https://"
title: "Metabase Instance API URL"
type: "string"
password:
airbyte_secret: true
always_show: true
order: 2
title: "Password"
type: "string"
session_token:
airbyte_secret: true
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."
order: 3
type: "string"
username:
order: 1
title: "Username"
type: "string"
required:
- "instance_api_url"
- "username"
type: "object"
source-bluetally:
properties:
api_key:
airbyte_secret: true
description: "Your API key to authenticate with the BlueTally API. You can\
\ generate it by navigating to your account settings, selecting 'API Keys',\
\ and clicking 'Create API Key'."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "bluetally"
const: "bluetally"
enum:
- "bluetally"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-bluetally-update:
properties:
api_key:
airbyte_secret: true
description: "Your API key to authenticate with the BlueTally API. You can\
\ generate it by navigating to your account settings, selecting 'API Keys',\
\ and clicking 'Create API Key'."
name: "api_key"
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-algolia:
properties:
api_key:
airbyte_secret: true
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
application_id:
description: "The application ID for your application found in settings"
order: 1
title: "Application ID"
type: "string"
object_id:
default: "ecommerce-sample-data-9999996"
description: "Object ID within index for search queries"
order: 4
title: "Object ID"
type: "string"
search_query:
default: "hitsPerPage=2&getRankingInfo=1"
description: "Search query to be used with indexes_query stream with format\
\ defined in `https://www.algolia.com/doc/rest-api/search/#tag/Search/operation/searchSingleIndex`"
order: 2
title: "Indexes Search query"
type: "string"
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "algolia"
const: "algolia"
enum:
- "algolia"
order: 0
type: "string"
required:
- "api_key"
- "application_id"
- "start_date"
- "sourceType"
type: "object"
source-algolia-update:
properties:
api_key:
airbyte_secret: true
name: "api_key"
order: 0
title: "API Key"
type: "string"
application_id:
description: "The application ID for your application found in settings"
order: 1
title: "Application ID"
type: "string"
object_id:
default: "ecommerce-sample-data-9999996"
description: "Object ID within index for search queries"
order: 4
title: "Object ID"
type: "string"
search_query:
default: "hitsPerPage=2&getRankingInfo=1"
description: "Search query to be used with indexes_query stream with format\
\ defined in `https://www.algolia.com/doc/rest-api/search/#tag/Search/operation/searchSingleIndex`"
order: 2
title: "Indexes Search query"
type: "string"
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "application_id"
- "start_date"
type: "object"
source-amplitude:
properties:
active_users_group_by_country:
default: true
description: "According to Amplitude documentation, grouping by `Country` is optional. If you\
\ face issues fetching the stream or checking the connection please set\
\ this field to `False`.\n"
title: "Active Users Group by Country"
type: "boolean"
api_key:
airbyte_secret: true
description: "Amplitude API Key. See the setup guide for more information on how to obtain this key."
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
data_region:
default: "Standard Server"
description: "Amplitude data region server"
enum:
- "Standard Server"
- "EU Residency Server"
title: "Data region"
type: "string"
request_time_range:
default: 24
description: "According to Considerations too large of a time range in te request can cause\
\ a timeout error. In this case, please provide a shorter time interval\
\ in hours.\n"
maximum: 8760
minimum: 1
title: "Request time range"
type: "integer"
secret_key:
airbyte_secret: true
description: "Amplitude Secret Key. See the setup guide for more information on how to obtain this key."
title: "Secret Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
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"
format: "date-time"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Replication Start Date"
type: "string"
sourceType:
title: "amplitude"
const: "amplitude"
enum:
- "amplitude"
order: 0
type: "string"
required:
- "api_key"
- "secret_key"
- "start_date"
- "sourceType"
title: "Amplitude Spec"
type: "object"
source-amplitude-update:
properties:
active_users_group_by_country:
default: true
description: "According to Amplitude documentation, grouping by `Country` is optional. If you\
\ face issues fetching the stream or checking the connection please set\
\ this field to `False`.\n"
title: "Active Users Group by Country"
type: "boolean"
api_key:
airbyte_secret: true
description: "Amplitude API Key. See the setup guide for more information on how to obtain this key."
title: "API Key"
type: "string"
data_region:
default: "Standard Server"
description: "Amplitude data region server"
enum:
- "Standard Server"
- "EU Residency Server"
title: "Data region"
type: "string"
request_time_range:
default: 24
description: "According to Considerations too large of a time range in te request can cause\
\ a timeout error. In this case, please provide a shorter time interval\
\ in hours.\n"
maximum: 8760
minimum: 1
title: "Request time range"
type: "integer"
secret_key:
airbyte_secret: true
description: "Amplitude Secret Key. See the setup guide for more information on how to obtain this key."
title: "Secret Key"
type: "string"
start_date:
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"
format: "date-time"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Replication Start Date"
type: "string"
required:
- "api_key"
- "secret_key"
- "start_date"
title: "Amplitude Spec"
type: "object"
source-finnworlds:
properties:
bond_type:
description: "For example 10y, 5y, 2y..."
order: 3
title: "Bond Type"
type: "array"
commodities:
description: "Options Available: beef, cheese, oil, ..."
order: 7
title: "Commodities"
type: "array"
countries:
description: "brazil, united states, italia, japan"
order: 4
title: "Countries"
type: "array"
key:
airbyte_secret: true
order: 2
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
list:
default: "ticker"
description: "Choose isin, ticker, reg_lei or cik"
order: 0
title: "List"
type: "string"
list_countries_for_bonds:
default: "country"
order: 1
title: "List Countries for Bonds"
type: "string"
start_date:
format: "date-time"
order: 6
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
tickers:
description: "AAPL, T, MU, GOOG"
order: 5
title: "Tickers"
type: "array"
sourceType:
title: "finnworlds"
const: "finnworlds"
enum:
- "finnworlds"
order: 0
type: "string"
required:
- "key"
- "start_date"
- "sourceType"
type: "object"
source-finnworlds-update:
properties:
bond_type:
description: "For example 10y, 5y, 2y..."
order: 3
title: "Bond Type"
type: "array"
commodities:
description: "Options Available: beef, cheese, oil, ..."
order: 7
title: "Commodities"
type: "array"
countries:
description: "brazil, united states, italia, japan"
order: 4
title: "Countries"
type: "array"
key:
airbyte_secret: true
order: 2
title: "API Key"
type: "string"
list:
default: "ticker"
description: "Choose isin, ticker, reg_lei or cik"
order: 0
title: "List"
type: "string"
list_countries_for_bonds:
default: "country"
order: 1
title: "List Countries for Bonds"
type: "string"
start_date:
format: "date-time"
order: 6
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
tickers:
description: "AAPL, T, MU, GOOG"
order: 5
title: "Tickers"
type: "array"
required:
- "key"
- "start_date"
type: "object"
source-google-calendar:
properties:
calendarid:
order: 3
title: "Calendar Id"
type: "string"
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_refresh_token_2:
airbyte_secret: true
order: 2
title: "Refresh token"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "google-calendar"
const: "google-calendar"
enum:
- "google-calendar"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "client_refresh_token_2"
- "calendarid"
- "sourceType"
type: "object"
source-google-calendar-update:
properties:
calendarid:
order: 3
title: "Calendar Id"
type: "string"
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
client_refresh_token_2:
airbyte_secret: true
order: 2
title: "Refresh token"
type: "string"
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
required:
- "client_id"
- "client_secret"
- "client_refresh_token_2"
- "calendarid"
type: "object"
source-google-pagespeed-insights:
properties:
api_key:
airbyte_secret: true
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."
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
categories:
description: "Defines which Lighthouse category to run. One or many of:\
\ \"accessibility\", \"best-practices\", \"performance\", \"pwa\", \"\
seo\"."
items:
enum:
- "accessibility"
- "best-practices"
- "performance"
- "pwa"
- "seo"
type: "string"
order: 1
title: "Lighthouse Categories"
type: "array"
strategies:
description: "The analyses strategy to use. Either \"desktop\" or \"mobile\"\
."
items:
enum:
- "desktop"
- "mobile"
type: "string"
order: 2
title: "Analyses Strategies"
type: "array"
urls:
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"
items:
pattern: "^(?:origin:)?(http(s)?:\\/\\/)[\\w.-]+(?:\\.[\\w\\.-]+)+[\\\
w\\-\\._~:\\/?#\\[\\]@!\\$&'\\(\\)\\*\\+,;=.]+$"
type: "string"
order: 3
title: "URLs to analyse"
type: "array"
sourceType:
title: "google-pagespeed-insights"
const: "google-pagespeed-insights"
enum:
- "google-pagespeed-insights"
order: 0
type: "string"
required:
- "categories"
- "strategies"
- "urls"
- "sourceType"
type: "object"
source-google-pagespeed-insights-update:
properties:
api_key:
airbyte_secret: true
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."
order: 0
title: "API Key"
type: "string"
categories:
description: "Defines which Lighthouse category to run. One or many of:\
\ \"accessibility\", \"best-practices\", \"performance\", \"pwa\", \"\
seo\"."
items:
enum:
- "accessibility"
- "best-practices"
- "performance"
- "pwa"
- "seo"
type: "string"
order: 1
title: "Lighthouse Categories"
type: "array"
strategies:
description: "The analyses strategy to use. Either \"desktop\" or \"mobile\"\
."
items:
enum:
- "desktop"
- "mobile"
type: "string"
order: 2
title: "Analyses Strategies"
type: "array"
urls:
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"
items:
pattern: "^(?:origin:)?(http(s)?:\\/\\/)[\\w.-]+(?:\\.[\\w\\.-]+)+[\\\
w\\-\\._~:\\/?#\\[\\]@!\\$&'\\(\\)\\*\\+,;=.]+$"
type: "string"
order: 3
title: "URLs to analyse"
type: "array"
required:
- "categories"
- "strategies"
- "urls"
type: "object"
source-illumina-basespace:
properties:
access_token:
airbyte_secret: true
description: "BaseSpace access token. Instructions for obtaining your access\
\ token can be found in the BaseSpace Developer Documentation."
order: 0
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
domain:
description: "Domain name of the BaseSpace instance (e.g., euw2.sh.basespace.illumina.com)"
order: 1
title: "Domain"
type: "string"
user:
default: "current"
description: "Providing a user ID restricts the returned data to what that\
\ user can access. If you use the default ('current'), all data accessible\
\ to the user associated with the API key will be shown."
order: 2
title: "User"
type: "string"
sourceType:
title: "illumina-basespace"
const: "illumina-basespace"
enum:
- "illumina-basespace"
order: 0
type: "string"
required:
- "access_token"
- "domain"
- "user"
- "sourceType"
type: "object"
source-illumina-basespace-update:
properties:
access_token:
airbyte_secret: true
description: "BaseSpace access token. Instructions for obtaining your access\
\ token can be found in the BaseSpace Developer Documentation."
order: 0
title: "Access Token"
type: "string"
domain:
description: "Domain name of the BaseSpace instance (e.g., euw2.sh.basespace.illumina.com)"
order: 1
title: "Domain"
type: "string"
user:
default: "current"
description: "Providing a user ID restricts the returned data to what that\
\ user can access. If you use the default ('current'), all data accessible\
\ to the user associated with the API key will be shown."
order: 2
title: "User"
type: "string"
required:
- "access_token"
- "domain"
- "user"
type: "object"
source-defillama:
properties:
sourceType:
title: "defillama"
const: "defillama"
enum:
- "defillama"
order: 0
type: "string"
type: "object"
source-defillama-update:
properties: {}
type: "object"
source-savvycal:
properties:
api_key:
airbyte_secret: true
description: "Go to SavvyCal → Settings → Developer → Personal Tokens and\
\ make a new token. Then, copy the private key. https://savvycal.com/developers"
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "savvycal"
const: "savvycal"
enum:
- "savvycal"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-savvycal-update:
properties:
api_key:
airbyte_secret: true
description: "Go to SavvyCal → Settings → Developer → Personal Tokens and\
\ make a new token. Then, copy the private key. https://savvycal.com/developers"
name: "api_key"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-zoho-billing:
properties:
client_id:
airbyte_secret: true
name: "client_id"
order: 1
title: "OAuth Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
name: "client_secret"
order: 2
title: "OAuth Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
name: "refresh_token"
order: 3
title: "OAuth Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
region:
enum:
- "com"
- "eu"
- "in"
- "com.cn"
- "com.au"
- "jp"
- "sa"
- "ca"
name: "region"
order: 0
title: "Region"
type: "string"
sourceType:
title: "zoho-billing"
const: "zoho-billing"
enum:
- "zoho-billing"
order: 0
type: "string"
required:
- "region"
- "client_id"
- "client_secret"
- "refresh_token"
- "sourceType"
type: "object"
source-zoho-billing-update:
properties:
client_id:
airbyte_secret: true
name: "client_id"
order: 1
title: "OAuth Client ID"
type: "string"
client_secret:
airbyte_secret: true
name: "client_secret"
order: 2
title: "OAuth Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
name: "refresh_token"
order: 3
title: "OAuth Refresh Token"
type: "string"
region:
enum:
- "com"
- "eu"
- "in"
- "com.cn"
- "com.au"
- "jp"
- "sa"
- "ca"
name: "region"
order: 0
title: "Region"
type: "string"
required:
- "region"
- "client_id"
- "client_secret"
- "refresh_token"
type: "object"
source-dolibarr:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
my_dolibarr_domain_url:
description: "enter your \"domain/dolibarr_url\" without https:// Example:\
\ mydomain.com/dolibarr"
order: 1
title: "my_dolibarr_domain/url"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "dolibarr"
const: "dolibarr"
enum:
- "dolibarr"
order: 0
type: "string"
required:
- "api_key"
- "my_dolibarr_domain_url"
- "start_date"
- "sourceType"
type: "object"
source-dolibarr-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
my_dolibarr_domain_url:
description: "enter your \"domain/dolibarr_url\" without https:// Example:\
\ mydomain.com/dolibarr"
order: 1
title: "my_dolibarr_domain/url"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "my_dolibarr_domain_url"
- "start_date"
type: "object"
source-akeneo:
properties:
api_username:
order: 1
title: "API Username"
type: "string"
client_id:
order: 3
title: "Client ID"
type: "string"
host:
description: "https://cb8715249e.trial.akeneo.cloud"
order: 0
title: "Host"
type: "string"
password:
airbyte_secret: true
order: 2
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
secret:
airbyte_secret: true
always_show: true
order: 4
title: "Secret"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "akeneo"
const: "akeneo"
enum:
- "akeneo"
order: 0
type: "string"
required:
- "host"
- "api_username"
- "password"
- "client_id"
- "sourceType"
type: "object"
source-akeneo-update:
properties:
api_username:
order: 1
title: "API Username"
type: "string"
client_id:
order: 3
title: "Client ID"
type: "string"
host:
description: "https://cb8715249e.trial.akeneo.cloud"
order: 0
title: "Host"
type: "string"
password:
airbyte_secret: true
order: 2
title: "Password"
type: "string"
secret:
airbyte_secret: true
always_show: true
order: 4
title: "Secret"
type: "string"
required:
- "host"
- "api_username"
- "password"
- "client_id"
type: "object"
source-amazon-ads:
properties:
auth_type:
const: "oauth2.0"
default: "oauth2.0"
order: 0
title: "Auth Type"
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The client ID of your Amazon Ads developer application. See\
\ the docs for more information."
order: 1
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The client secret of your Amazon Ads developer application.\
\ See the docs for more information."
order: 2
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
look_back_window:
default: 3
description: "The amount of days to go back in time to get the updated data\
\ from Amazon Ads"
examples:
- 3
- 10
order: 8
title: "Look Back Window"
type: "integer"
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."
items:
type: "string"
order: 7
title: "Marketplace IDs"
type: "array"
num_workers:
default: 10
description: "The number of worker threads to use for the sync."
examples:
- 2
- 3
maximum: 10
minimum: 2
order: 9
title: "Number of concurrent threads"
type: "integer"
profiles:
description: "Profile IDs you want to fetch data for. The Amazon Ads source\
\ connector supports only profiles with seller and vendor type, profiles\
\ with agency type will be ignored. 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."
items:
type: "integer"
order: 6
title: "Profile IDs"
type: "array"
refresh_token:
airbyte_secret: true
description: "Amazon Ads refresh token. See the docs for more information on how to obtain this token."
order: 3
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
region:
default: "NA"
description: "Region to pull data from (EU/NA/FE). See docs for more details."
enum:
- "NA"
- "EU"
- "FE"
order: 4
title: "Region"
type: "string"
start_date:
description: "The Start date for collecting reports, should not be more\
\ than 60 days in the past. In YYYY-MM-DD format"
examples:
- "2022-10-10"
- "2022-10-22"
format: "date"
order: 5
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
sourceType:
title: "amazon-ads"
const: "amazon-ads"
enum:
- "amazon-ads"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "sourceType"
title: "Source Amazon Ads"
type: "object"
source-amazon-ads-update:
properties:
auth_type:
const: "oauth2.0"
default: "oauth2.0"
order: 0
title: "Auth Type"
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The client ID of your Amazon Ads developer application. See\
\ the docs for more information."
order: 1
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The client secret of your Amazon Ads developer application.\
\ See the docs for more information."
order: 2
title: "Client Secret"
type: "string"
look_back_window:
default: 3
description: "The amount of days to go back in time to get the updated data\
\ from Amazon Ads"
examples:
- 3
- 10
order: 8
title: "Look Back Window"
type: "integer"
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."
items:
type: "string"
order: 7
title: "Marketplace IDs"
type: "array"
num_workers:
default: 10
description: "The number of worker threads to use for the sync."
examples:
- 2
- 3
maximum: 10
minimum: 2
order: 9
title: "Number of concurrent threads"
type: "integer"
profiles:
description: "Profile IDs you want to fetch data for. The Amazon Ads source\
\ connector supports only profiles with seller and vendor type, profiles\
\ with agency type will be ignored. 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."
items:
type: "integer"
order: 6
title: "Profile IDs"
type: "array"
refresh_token:
airbyte_secret: true
description: "Amazon Ads refresh token. See the docs for more information on how to obtain this token."
order: 3
title: "Refresh Token"
type: "string"
region:
default: "NA"
description: "Region to pull data from (EU/NA/FE). See docs for more details."
enum:
- "NA"
- "EU"
- "FE"
order: 4
title: "Region"
type: "string"
start_date:
description: "The Start date for collecting reports, should not be more\
\ than 60 days in the past. In YYYY-MM-DD format"
examples:
- "2022-10-10"
- "2022-10-22"
format: "date"
order: 5
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
title: "Source Amazon Ads"
type: "object"
source-mux:
properties:
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
playback_id:
description: "The playback id for your video asset shown in website details"
order: 3
title: "Playback ID"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
username:
order: 0
title: "Username"
type: "string"
sourceType:
title: "mux"
const: "mux"
enum:
- "mux"
order: 0
type: "string"
required:
- "username"
- "start_date"
- "sourceType"
type: "object"
source-mux-update:
properties:
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
playback_id:
description: "The playback id for your video asset shown in website details"
order: 3
title: "Playback ID"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
username:
order: 0
title: "Username"
type: "string"
required:
- "username"
- "start_date"
type: "object"
source-poplar:
properties:
access_token:
airbyte_secret: true
description: "Your Poplar API Access Token. Generate it from the [API Credentials\
\ page](https://app.heypoplar.com/credentials) in your account. Use a\
\ production token for live data or a test token for testing purposes."
name: "access_token"
order: 0
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "poplar"
const: "poplar"
enum:
- "poplar"
order: 0
type: "string"
required:
- "access_token"
- "start_date"
- "sourceType"
type: "object"
source-poplar-update:
properties:
access_token:
airbyte_secret: true
description: "Your Poplar API Access Token. Generate it from the [API Credentials\
\ page](https://app.heypoplar.com/credentials) in your account. Use a\
\ production token for live data or a test token for testing purposes."
name: "access_token"
order: 0
title: "Access Token"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "access_token"
- "start_date"
type: "object"
source-spotify-ads:
properties:
ad_account_id:
description: "The ID of the Spotify Ad Account you want to sync data from."
examples:
- "03561a07-cb0a-4354-b751-88512a6f4d79"
order: 3
pattern: "^[a-zA-Z0-9\\-]+$"
title: "Ad Account ID"
type: "string"
client_id:
airbyte_secret: true
description: "The Client ID of your Spotify Developer application."
order: 0
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The Client Secret of your Spotify Developer application."
order: 1
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
fields:
default:
- "IMPRESSIONS"
- "CLICKS"
- "SPEND"
- "CTR"
- "REACH"
- "FREQUENCY"
- "COMPLETION_RATE"
description: "List of fields to include in the campaign performance report.\
\ Choose from available metrics."
examples:
- - "IMPRESSIONS"
- "CLICKS"
- "SPEND"
- "CTR"
- - "STREAMS"
- "NEW_LISTENERS"
- "PAID_LISTENS"
items:
enum:
- "CLICKS"
- "COMPLETES"
- "COMPLETION_RATE"
- "CONVERSION_RATE"
- "CTR"
- "E_CPM"
- "E_CPCL"
- "FIRST_QUARTILES"
- "FREQUENCY"
- "IMPRESSIONS"
- "INTENT_RATE"
- "LISTENERS"
- "MIDPOINTS"
- "NEW_LISTENERS"
- "NEW_LISTENER_CONVERSION_RATE"
- "NEW_LISTENER_STREAMS"
- "OFF_SPOTIFY_IMPRESSIONS"
- "PAID_LISTENS"
- "PAID_LISTENS_FREQUENCY"
- "PAID_LISTENS_REACH"
- "REACH"
- "SKIPS"
- "SPEND"
- "STARTS"
- "STREAMS"
- "STREAMS_PER_NEW_LISTENER"
- "STREAMS_PER_USER"
- "THIRD_QUARTILES"
- "VIDEO_VIEWS"
- "VIDEO_EXPANDS"
- "VIDEO_EXPAND_RATE"
- "UNMUTES"
type: "string"
order: 5
title: "Report Fields"
type: "array"
refresh_token:
airbyte_secret: true
description: "The Refresh Token obtained from the initial OAuth 2.0 authorization\
\ flow."
order: 2
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "The date to start syncing data from, in YYYY-MM-DD format."
examples:
- "2024-01-01"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
sourceType:
title: "spotify-ads"
const: "spotify-ads"
enum:
- "spotify-ads"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "ad_account_id"
- "start_date"
- "fields"
- "sourceType"
type: "object"
source-spotify-ads-update:
properties:
ad_account_id:
description: "The ID of the Spotify Ad Account you want to sync data from."
examples:
- "03561a07-cb0a-4354-b751-88512a6f4d79"
order: 3
pattern: "^[a-zA-Z0-9\\-]+$"
title: "Ad Account ID"
type: "string"
client_id:
airbyte_secret: true
description: "The Client ID of your Spotify Developer application."
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Spotify Developer application."
order: 1
title: "Client Secret"
type: "string"
fields:
default:
- "IMPRESSIONS"
- "CLICKS"
- "SPEND"
- "CTR"
- "REACH"
- "FREQUENCY"
- "COMPLETION_RATE"
description: "List of fields to include in the campaign performance report.\
\ Choose from available metrics."
examples:
- - "IMPRESSIONS"
- "CLICKS"
- "SPEND"
- "CTR"
- - "STREAMS"
- "NEW_LISTENERS"
- "PAID_LISTENS"
items:
enum:
- "CLICKS"
- "COMPLETES"
- "COMPLETION_RATE"
- "CONVERSION_RATE"
- "CTR"
- "E_CPM"
- "E_CPCL"
- "FIRST_QUARTILES"
- "FREQUENCY"
- "IMPRESSIONS"
- "INTENT_RATE"
- "LISTENERS"
- "MIDPOINTS"
- "NEW_LISTENERS"
- "NEW_LISTENER_CONVERSION_RATE"
- "NEW_LISTENER_STREAMS"
- "OFF_SPOTIFY_IMPRESSIONS"
- "PAID_LISTENS"
- "PAID_LISTENS_FREQUENCY"
- "PAID_LISTENS_REACH"
- "REACH"
- "SKIPS"
- "SPEND"
- "STARTS"
- "STREAMS"
- "STREAMS_PER_NEW_LISTENER"
- "STREAMS_PER_USER"
- "THIRD_QUARTILES"
- "VIDEO_VIEWS"
- "VIDEO_EXPANDS"
- "VIDEO_EXPAND_RATE"
- "UNMUTES"
type: "string"
order: 5
title: "Report Fields"
type: "array"
refresh_token:
airbyte_secret: true
description: "The Refresh Token obtained from the initial OAuth 2.0 authorization\
\ flow."
order: 2
title: "Refresh Token"
type: "string"
start_date:
description: "The date to start syncing data from, in YYYY-MM-DD format."
examples:
- "2024-01-01"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "ad_account_id"
- "start_date"
- "fields"
type: "object"
source-sap-hana-enterprise:
properties:
check_privileges:
default: true
description: "When this feature is enabled, during schema discovery the\
\ connector will query each table or view individually to check access\
\ privileges and inaccessible tables, views, or columns therein will be\
\ removed. In large schemas, this might cause schema discovery to take\
\ too long, in which case it might be advisable to disable this feature."
order: 14
title: "Check Table and Column Access Privileges"
type: "boolean"
checkpoint_target_interval_seconds:
default: 300
description: "How often (in seconds) a stream should checkpoint, when possible."
order: 12
title: "Checkpoint Target Time Interval"
type: "integer"
concurrency:
default: 1
description: "Maximum number of concurrent queries to the database."
order: 13
title: "Concurrency"
type: "integer"
cursor:
description: "Configures how data is extracted from the database."
display_type: "radio"
oneOf:
- additionalProperties: true
description: "Incrementally detects new inserts and updates using the\
\ cursor column chosen when configuring a connection (e.g. created_at,\
\ updated_at)."
properties:
cursor_method:
default: "user_defined"
enum:
- "user_defined"
type: "string"
required:
- "cursor_method"
title: "Scan Changes with User Defined Cursor"
type: "object"
- additionalProperties: true
description: "Recommended - Incrementally reads new inserts, updates,\
\ and deletes using change data capture feature. This must be enabled\
\ on your database."
properties:
cursor_method:
default: "cdc"
enum:
- "cdc"
type: "string"
initial_load_timeout_hours:
always_show: true
default: 8
description: "The amount of time an initial load is allowed to continue\
\ for before catching up on CDC events."
max: 24
min: 4
order: 2
title: "Initial Load Timeout in Hours (Advanced)"
type: "integer"
invalid_cdc_cursor_position_behavior:
always_show: true
default: "Fail sync"
description: "Determines whether Airbyte should fail or re-sync data\
\ in case of an stale/invalid cursor value in the mined logs. 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"
order: 1
title: "Invalid CDC Position Behavior (Advanced)"
type: "string"
required:
- "cursor_method"
title: "Read Changes using Change Data Capture (CDC)"
type: "object"
order: 11
title: "Update Method"
type: "object"
database:
description: "The name of the tenant database to connect to. This is required\
\ for multi-tenant SAP HANA systems. For single-tenant systems, this can\
\ be left empty."
order: 5
title: "Database"
type: "string"
encryption:
description: "The encryption method with is used when communicating with\
\ the database."
oneOf:
- additionalProperties: true
description: "Data transfer will not be encrypted."
properties:
encryption_method:
default: "unencrypted"
enum:
- "unencrypted"
type: "string"
required:
- "encryption_method"
title: "Unencrypted"
type: "object"
- additionalProperties: true
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."
properties:
encryption_algorithm:
default: "AES256"
description: "This parameter defines what encryption algorithm is\
\ used."
enum:
- "AES256"
- "RC4_56"
- "3DES168"
title: "Encryption Algorithm"
type: "string"
encryption_method:
default: "client_nne"
enum:
- "client_nne"
type: "string"
required:
- "encryption_method"
- "encryption_algorithm"
title: "Native Network Encryption (NNE)"
type: "object"
- additionalProperties: true
description: "Verify and use the certificate provided by the server."
properties:
encryption_method:
default: "encrypted_verify_certificate"
enum:
- "encrypted_verify_certificate"
type: "string"
ssl_certificate:
airbyte_secret: true
description: "Privacy Enhanced Mail (PEM) files are concatenated certificate\
\ containers frequently used in certificate installations."
multiline: true
title: "SSL PEM File"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "encryption_method"
- "ssl_certificate"
title: "TLS Encrypted (verify certificate)"
type: "object"
order: 9
title: "Encryption"
type: "object"
filters:
description: "Inclusion filters for table selection per schema. If no filters\
\ are specified for a schema, all tables in that schema will be synced."
items:
additionalProperties: true
description: "Inclusion filter configuration for table selection per schema."
properties:
schema_name:
always_show: true
description: "The name of the schema to apply this filter to. Should\
\ match a schema defined in \"Schemas\" field above."
order: 1
title: "Schema Name"
type: "string"
table_name_patterns:
always_show: true
description: "List of table name patterns to include from this schema.\
\ Each filter should be a SQL LIKE pattern."
items:
type: "string"
order: 2
title: "Table Filter Patterns"
type: "array"
required:
- "schema_name"
- "table_name_patterns"
title: "Table Filter"
type: "object"
order: 7
title: "Table Name Filters"
type: "array"
host:
description: "Hostname of the database."
order: 1
title: "Host"
type: "string"
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)."
order: 8
title: "JDBC URL Params"
type: "string"
password:
airbyte_secret: true
always_show: true
description: "The password associated with the username."
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
port:
default: 443
description: "Port of the database.\nSAP recommends the following port numbers:\n\
443 - Default listening port for SAP HANA Cloud client connections to\
\ the listener."
maximum: 65536
minimum: 0
order: 2
title: "Port"
type: "integer"
schemas:
description: "The list of schemas to sync from. Defaults to user. Case sensitive."
items:
type: "string"
order: 6
title: "Schemas"
type: "array"
uniqueItems: true
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- additionalProperties: true
description: "No ssh tunnel needed to connect to database"
properties:
tunnel_method:
default: "NO_TUNNEL"
enum:
- "NO_TUNNEL"
type: "string"
required:
- "tunnel_method"
title: "No Tunnel"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
x-speakeasy-param-sensitive: true
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_KEY_AUTH"
enum:
- "SSH_KEY_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_PASSWORD_AUTH"
enum:
- "SSH_PASSWORD_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
type: "object"
order: 10
title: "SSH Tunnel Method"
type: "object"
username:
description: "The username which is used to access the database."
order: 3
title: "User"
type: "string"
sourceType:
title: "sap-hana-enterprise"
const: "sap-hana-enterprise"
enum:
- "sap-hana-enterprise"
order: 0
type: "string"
required:
- "host"
- "port"
- "username"
- "encryption"
- "tunnel_method"
- "cursor"
- "sourceType"
title: "SAP HANA Source Spec"
type: "object"
source-sap-hana-enterprise-update:
properties:
check_privileges:
default: true
description: "When this feature is enabled, during schema discovery the\
\ connector will query each table or view individually to check access\
\ privileges and inaccessible tables, views, or columns therein will be\
\ removed. In large schemas, this might cause schema discovery to take\
\ too long, in which case it might be advisable to disable this feature."
order: 14
title: "Check Table and Column Access Privileges"
type: "boolean"
checkpoint_target_interval_seconds:
default: 300
description: "How often (in seconds) a stream should checkpoint, when possible."
order: 12
title: "Checkpoint Target Time Interval"
type: "integer"
concurrency:
default: 1
description: "Maximum number of concurrent queries to the database."
order: 13
title: "Concurrency"
type: "integer"
cursor:
description: "Configures how data is extracted from the database."
display_type: "radio"
oneOf:
- additionalProperties: true
description: "Incrementally detects new inserts and updates using the\
\ cursor column chosen when configuring a connection (e.g. created_at,\
\ updated_at)."
properties:
cursor_method:
default: "user_defined"
enum:
- "user_defined"
type: "string"
required:
- "cursor_method"
title: "Scan Changes with User Defined Cursor"
type: "object"
- additionalProperties: true
description: "Recommended - Incrementally reads new inserts, updates,\
\ and deletes using change data capture feature. This must be enabled\
\ on your database."
properties:
cursor_method:
default: "cdc"
enum:
- "cdc"
type: "string"
initial_load_timeout_hours:
always_show: true
default: 8
description: "The amount of time an initial load is allowed to continue\
\ for before catching up on CDC events."
max: 24
min: 4
order: 2
title: "Initial Load Timeout in Hours (Advanced)"
type: "integer"
invalid_cdc_cursor_position_behavior:
always_show: true
default: "Fail sync"
description: "Determines whether Airbyte should fail or re-sync data\
\ in case of an stale/invalid cursor value in the mined logs. 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"
order: 1
title: "Invalid CDC Position Behavior (Advanced)"
type: "string"
required:
- "cursor_method"
title: "Read Changes using Change Data Capture (CDC)"
type: "object"
order: 11
title: "Update Method"
type: "object"
database:
description: "The name of the tenant database to connect to. This is required\
\ for multi-tenant SAP HANA systems. For single-tenant systems, this can\
\ be left empty."
order: 5
title: "Database"
type: "string"
encryption:
description: "The encryption method with is used when communicating with\
\ the database."
oneOf:
- additionalProperties: true
description: "Data transfer will not be encrypted."
properties:
encryption_method:
default: "unencrypted"
enum:
- "unencrypted"
type: "string"
required:
- "encryption_method"
title: "Unencrypted"
type: "object"
- additionalProperties: true
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."
properties:
encryption_algorithm:
default: "AES256"
description: "This parameter defines what encryption algorithm is\
\ used."
enum:
- "AES256"
- "RC4_56"
- "3DES168"
title: "Encryption Algorithm"
type: "string"
encryption_method:
default: "client_nne"
enum:
- "client_nne"
type: "string"
required:
- "encryption_method"
- "encryption_algorithm"
title: "Native Network Encryption (NNE)"
type: "object"
- additionalProperties: true
description: "Verify and use the certificate provided by the server."
properties:
encryption_method:
default: "encrypted_verify_certificate"
enum:
- "encrypted_verify_certificate"
type: "string"
ssl_certificate:
airbyte_secret: true
description: "Privacy Enhanced Mail (PEM) files are concatenated certificate\
\ containers frequently used in certificate installations."
multiline: true
title: "SSL PEM File"
type: "string"
required:
- "encryption_method"
- "ssl_certificate"
title: "TLS Encrypted (verify certificate)"
type: "object"
order: 9
title: "Encryption"
type: "object"
filters:
description: "Inclusion filters for table selection per schema. If no filters\
\ are specified for a schema, all tables in that schema will be synced."
items:
additionalProperties: true
description: "Inclusion filter configuration for table selection per schema."
properties:
schema_name:
always_show: true
description: "The name of the schema to apply this filter to. Should\
\ match a schema defined in \"Schemas\" field above."
order: 1
title: "Schema Name"
type: "string"
table_name_patterns:
always_show: true
description: "List of table name patterns to include from this schema.\
\ Each filter should be a SQL LIKE pattern."
items:
type: "string"
order: 2
title: "Table Filter Patterns"
type: "array"
required:
- "schema_name"
- "table_name_patterns"
title: "Table Filter"
type: "object"
order: 7
title: "Table Name Filters"
type: "array"
host:
description: "Hostname of the database."
order: 1
title: "Host"
type: "string"
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)."
order: 8
title: "JDBC URL Params"
type: "string"
password:
airbyte_secret: true
always_show: true
description: "The password associated with the username."
order: 4
title: "Password"
type: "string"
port:
default: 443
description: "Port of the database.\nSAP recommends the following port numbers:\n\
443 - Default listening port for SAP HANA Cloud client connections to\
\ the listener."
maximum: 65536
minimum: 0
order: 2
title: "Port"
type: "integer"
schemas:
description: "The list of schemas to sync from. Defaults to user. Case sensitive."
items:
type: "string"
order: 6
title: "Schemas"
type: "array"
uniqueItems: true
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- additionalProperties: true
description: "No ssh tunnel needed to connect to database"
properties:
tunnel_method:
default: "NO_TUNNEL"
enum:
- "NO_TUNNEL"
type: "string"
required:
- "tunnel_method"
title: "No Tunnel"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_KEY_AUTH"
enum:
- "SSH_KEY_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_PASSWORD_AUTH"
enum:
- "SSH_PASSWORD_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
type: "object"
order: 10
title: "SSH Tunnel Method"
type: "object"
username:
description: "The username which is used to access the database."
order: 3
title: "User"
type: "string"
required:
- "host"
- "port"
- "username"
- "encryption"
- "tunnel_method"
- "cursor"
title: "SAP HANA Source Spec"
type: "object"
source-sendinblue:
properties:
api_key:
airbyte_secret: true
description: "Your API Key. See here."
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "sendinblue"
const: "sendinblue"
enum:
- "sendinblue"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-sendinblue-update:
properties:
api_key:
airbyte_secret: true
description: "Your API Key. See here."
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-github:
properties:
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."
examples:
- "https://github.com"
- "https://github.company.org"
order: 3
title: "API URL"
type: "string"
branches:
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."
examples:
- "airbytehq/airbyte/master"
- "airbytehq/airbyte/my-branch"
items:
type: "string"
order: 4
pattern_descriptor: "org/repo/branch1 org/repo/branch2"
title: "Branches"
type: "array"
credentials:
description: "Choose how to authenticate to GitHub"
group: "auth"
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "OAuth access token"
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
client_id:
airbyte_secret: true
description: "OAuth Client Id"
title: "Client Id"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "OAuth Client secret"
title: "Client secret"
type: "string"
x-speakeasy-param-sensitive: true
option_title:
const: "OAuth Credentials"
order: 0
type: "string"
enum:
- "OAuth Credentials"
required:
- "access_token"
title: "OAuth"
type: "object"
- properties:
option_title:
const: "PAT Credentials"
order: 0
type: "string"
enum:
- "PAT Credentials"
personal_access_token:
airbyte_secret: true
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\
\ \",\""
title: "Personal Access Tokens"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "personal_access_token"
title: "Personal Access Token"
type: "object"
order: 0
title: "Authentication"
type: "object"
max_waiting_time:
default: 10
description: "Max Waiting Time for rate limit. Set higher value to wait\
\ till rate limits will be resetted to continue sync"
examples:
- 10
- 30
- 60
maximum: 60
minimum: 1
order: 5
title: "Max Waiting Time (in minutes)"
type: "integer"
repositories:
description: "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."
examples:
- "airbytehq/airbyte"
- "airbytehq/another-repo"
- "airbytehq/*"
- "airbytehq/a*"
items:
pattern: "^[\\w.-]+/(([\\w.-]*\\*)|[\\w.-]+(?docs for more info"
examples:
- "2021-03-01T00:00:00Z"
format: "date-time"
order: 2
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"
title: "Start date"
type: "string"
sourceType:
title: "github"
const: "github"
enum:
- "github"
order: 0
type: "string"
required:
- "credentials"
- "repositories"
- "sourceType"
title: "GitHub Source Spec"
type: "object"
source-github-update:
properties:
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."
examples:
- "https://github.com"
- "https://github.company.org"
order: 3
title: "API URL"
type: "string"
branches:
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."
examples:
- "airbytehq/airbyte/master"
- "airbytehq/airbyte/my-branch"
items:
type: "string"
order: 4
pattern_descriptor: "org/repo/branch1 org/repo/branch2"
title: "Branches"
type: "array"
credentials:
description: "Choose how to authenticate to GitHub"
group: "auth"
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "OAuth access token"
title: "Access Token"
type: "string"
client_id:
airbyte_secret: true
description: "OAuth Client Id"
title: "Client Id"
type: "string"
client_secret:
airbyte_secret: true
description: "OAuth Client secret"
title: "Client secret"
type: "string"
option_title:
const: "OAuth Credentials"
order: 0
type: "string"
enum:
- "OAuth Credentials"
required:
- "access_token"
title: "OAuth"
type: "object"
- properties:
option_title:
const: "PAT Credentials"
order: 0
type: "string"
enum:
- "PAT Credentials"
personal_access_token:
airbyte_secret: true
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\
\ \",\""
title: "Personal Access Tokens"
type: "string"
required:
- "personal_access_token"
title: "Personal Access Token"
type: "object"
order: 0
title: "Authentication"
type: "object"
max_waiting_time:
default: 10
description: "Max Waiting Time for rate limit. Set higher value to wait\
\ till rate limits will be resetted to continue sync"
examples:
- 10
- 30
- 60
maximum: 60
minimum: 1
order: 5
title: "Max Waiting Time (in minutes)"
type: "integer"
repositories:
description: "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."
examples:
- "airbytehq/airbyte"
- "airbytehq/another-repo"
- "airbytehq/*"
- "airbytehq/a*"
items:
pattern: "^[\\w.-]+/(([\\w.-]*\\*)|[\\w.-]+(?docs for more info"
examples:
- "2021-03-01T00:00:00Z"
format: "date-time"
order: 2
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"
title: "Start date"
type: "string"
required:
- "credentials"
- "repositories"
title: "GitHub Source Spec"
type: "object"
source-service-now:
properties:
base_url:
order: 0
title: "Base URL"
type: "string"
password:
airbyte_secret: true
always_show: true
order: 2
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
username:
order: 1
title: "Username"
type: "string"
sourceType:
title: "service-now"
const: "service-now"
enum:
- "service-now"
order: 0
type: "string"
required:
- "base_url"
- "username"
- "sourceType"
type: "object"
source-service-now-update:
properties:
base_url:
order: 0
title: "Base URL"
type: "string"
password:
airbyte_secret: true
always_show: true
order: 2
title: "Password"
type: "string"
username:
order: 1
title: "Username"
type: "string"
required:
- "base_url"
- "username"
type: "object"
source-guru:
properties:
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
search_cards_query:
description: "Query for searching cards"
order: 4
title: "search_cards_query"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
team_id:
description: "Team ID received through response of /teams streams, make\
\ sure about access to the team"
order: 3
title: "team_id"
type: "string"
username:
order: 0
title: "Username"
type: "string"
sourceType:
title: "guru"
const: "guru"
enum:
- "guru"
order: 0
type: "string"
required:
- "username"
- "start_date"
- "sourceType"
type: "object"
source-guru-update:
properties:
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
search_cards_query:
description: "Query for searching cards"
order: 4
title: "search_cards_query"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
team_id:
description: "Team ID received through response of /teams streams, make\
\ sure about access to the team"
order: 3
title: "team_id"
type: "string"
username:
order: 0
title: "Username"
type: "string"
required:
- "username"
- "start_date"
type: "object"
source-alpha-vantage:
properties:
adjusted:
default: false
description: "Whether to return adjusted data. Only applicable to intraday\
\ endpoints.\n"
order: 3
title: "Adjusted?"
type: "boolean"
api_key:
airbyte_secret: true
description: "API Key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
interval:
default: "1min"
description: "Time-series data point interval. Required for intraday endpoints.\n"
enum:
- "1min"
- "5min"
- "15min"
- "30min"
- "60min"
order: 2
title: "Interval"
type: "string"
outputsize:
default: "compact"
description: "Whether to return full or compact data (the last 100 data\
\ points).\n"
enum:
- "compact"
- "full"
order: 4
title: "Output Size"
type: "string"
symbol:
description: "Stock symbol (with exchange code)"
examples:
- "AAPL"
- "TSCO.LON"
order: 1
title: "Symbol"
type: "string"
sourceType:
title: "alpha-vantage"
const: "alpha-vantage"
enum:
- "alpha-vantage"
order: 0
type: "string"
required:
- "api_key"
- "symbol"
- "sourceType"
type: "object"
source-alpha-vantage-update:
properties:
adjusted:
default: false
description: "Whether to return adjusted data. Only applicable to intraday\
\ endpoints.\n"
order: 3
title: "Adjusted?"
type: "boolean"
api_key:
airbyte_secret: true
description: "API Key"
order: 0
title: "API Key"
type: "string"
interval:
default: "1min"
description: "Time-series data point interval. Required for intraday endpoints.\n"
enum:
- "1min"
- "5min"
- "15min"
- "30min"
- "60min"
order: 2
title: "Interval"
type: "string"
outputsize:
default: "compact"
description: "Whether to return full or compact data (the last 100 data\
\ points).\n"
enum:
- "compact"
- "full"
order: 4
title: "Output Size"
type: "string"
symbol:
description: "Stock symbol (with exchange code)"
examples:
- "AAPL"
- "TSCO.LON"
order: 1
title: "Symbol"
type: "string"
required:
- "api_key"
- "symbol"
type: "object"
source-picqer:
properties:
organization_name:
description: "The organization name which is used to login to picqer"
order: 2
title: "Organization Name"
type: "string"
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
username:
order: 0
title: "Username"
type: "string"
sourceType:
title: "picqer"
const: "picqer"
enum:
- "picqer"
order: 0
type: "string"
required:
- "username"
- "organization_name"
- "start_date"
- "sourceType"
type: "object"
source-picqer-update:
properties:
organization_name:
description: "The organization name which is used to login to picqer"
order: 2
title: "Organization Name"
type: "string"
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
username:
order: 0
title: "Username"
type: "string"
required:
- "username"
- "organization_name"
- "start_date"
type: "object"
source-newsdata-io:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
categories:
description: "Search the news articles for a specific category. You can\
\ add up to 5 categories in a single query."
order: 3
title: "Categories"
type: "array"
countries:
description: "Search the news articles from a specific country. You can\
\ add up to 5 countries in a single query. Example: au, jp, br"
order: 2
title: "Countries"
type: "array"
domains:
description: "Search the news articles for specific domains or news sources.\
\ You can add up to 5 domains in a single query. "
order: 5
title: "Domains"
type: "array"
end_date:
description: "Choose an end date. Now UTC is default value"
format: "date"
order: 7
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "End Date"
type: "string"
languages:
description: "Search the news articles for a specific language. You can\
\ add up to 5 languages in a single query. "
order: 4
title: "Languages"
type: "array"
search_query:
description: "Search news articles for specific keywords or phrases present\
\ in the news title, content, URL, meta keywords and meta description."
order: 1
title: "Search Query"
type: "string"
start_date:
format: "date-time"
order: 6
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "newsdata-io"
const: "newsdata-io"
enum:
- "newsdata-io"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-newsdata-io-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
categories:
description: "Search the news articles for a specific category. You can\
\ add up to 5 categories in a single query."
order: 3
title: "Categories"
type: "array"
countries:
description: "Search the news articles from a specific country. You can\
\ add up to 5 countries in a single query. Example: au, jp, br"
order: 2
title: "Countries"
type: "array"
domains:
description: "Search the news articles for specific domains or news sources.\
\ You can add up to 5 domains in a single query. "
order: 5
title: "Domains"
type: "array"
end_date:
description: "Choose an end date. Now UTC is default value"
format: "date"
order: 7
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "End Date"
type: "string"
languages:
description: "Search the news articles for a specific language. You can\
\ add up to 5 languages in a single query. "
order: 4
title: "Languages"
type: "array"
search_query:
description: "Search news articles for specific keywords or phrases present\
\ in the news title, content, URL, meta keywords and meta description."
order: 1
title: "Search Query"
type: "string"
start_date:
format: "date-time"
order: 6
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-clazar:
properties:
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "clazar"
const: "clazar"
enum:
- "clazar"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "sourceType"
type: "object"
source-clazar-update:
properties:
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
required:
- "client_id"
- "client_secret"
type: "object"
source-ebay-finance:
properties:
api_host:
default: "https://apiz.ebay.com"
description: "https://apiz.sandbox.ebay.com for sandbox & https://apiz.ebay.com\
\ for production"
enum:
- "https://apiz.sandbox.ebay.com"
- "https://apiz.ebay.com"
order: 6
title: "API Host"
type: "string"
password:
airbyte_secret: true
always_show: true
description: "Ebay Client Secret"
order: 3
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
redirect_uri:
order: 4
title: "Redirect URI"
type: "string"
refresh_token:
airbyte_secret: true
order: 5
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 7
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
token_refresh_endpoint:
default: "https://api.ebay.com/identity/v1/oauth2/token"
enum:
- "https://api.sandbox.ebay.com/identity/v1/oauth2/token"
- "https://api.ebay.com/identity/v1/oauth2/token"
order: 0
title: "Refresh Token Endpoint"
type: "string"
username:
description: "Ebay Developer Client ID"
order: 2
title: "Username"
type: "string"
sourceType:
title: "ebay-finance"
const: "ebay-finance"
enum:
- "ebay-finance"
order: 0
type: "string"
required:
- "token_refresh_endpoint"
- "username"
- "redirect_uri"
- "refresh_token"
- "api_host"
- "start_date"
- "sourceType"
type: "object"
source-ebay-finance-update:
properties:
api_host:
default: "https://apiz.ebay.com"
description: "https://apiz.sandbox.ebay.com for sandbox & https://apiz.ebay.com\
\ for production"
enum:
- "https://apiz.sandbox.ebay.com"
- "https://apiz.ebay.com"
order: 6
title: "API Host"
type: "string"
password:
airbyte_secret: true
always_show: true
description: "Ebay Client Secret"
order: 3
title: "Password"
type: "string"
redirect_uri:
order: 4
title: "Redirect URI"
type: "string"
refresh_token:
airbyte_secret: true
order: 5
title: "Refresh Token"
type: "string"
start_date:
format: "date-time"
order: 7
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
token_refresh_endpoint:
default: "https://api.ebay.com/identity/v1/oauth2/token"
enum:
- "https://api.sandbox.ebay.com/identity/v1/oauth2/token"
- "https://api.ebay.com/identity/v1/oauth2/token"
order: 0
title: "Refresh Token Endpoint"
type: "string"
username:
description: "Ebay Developer Client ID"
order: 2
title: "Username"
type: "string"
required:
- "token_refresh_endpoint"
- "username"
- "redirect_uri"
- "refresh_token"
- "api_host"
- "start_date"
type: "object"
source-katana:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it at https://katanamrp.com/login/"
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "katana"
const: "katana"
enum:
- "katana"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-katana-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it at https://katanamrp.com/login/"
name: "api_key"
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-bugsnag:
properties:
auth_token:
airbyte_secret: true
description: "Personal auth token for accessing the Bugsnag API. Generate\
\ it in the My Account section of Bugsnag settings."
name: "auth_token"
order: 0
title: "Auth Token"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "bugsnag"
const: "bugsnag"
enum:
- "bugsnag"
order: 0
type: "string"
required:
- "auth_token"
- "start_date"
- "sourceType"
type: "object"
source-bugsnag-update:
properties:
auth_token:
airbyte_secret: true
description: "Personal auth token for accessing the Bugsnag API. Generate\
\ it in the My Account section of Bugsnag settings."
name: "auth_token"
order: 0
title: "Auth Token"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "auth_token"
- "start_date"
type: "object"
source-outreach:
properties:
client_id:
description: "The Client ID of your Outreach developer application."
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Outreach developer application."
order: 1
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
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."
order: 3
title: "Redirect URI"
type: "string"
refresh_token:
airbyte_secret: true
description: "The token for obtaining the new access token."
order: 2
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "The date from which you'd like to replicate data for Outreach\
\ API, in the format YYYY-MM-DDT00:00:00.000Z. All data generated after\
\ this date will be replicated."
examples:
- "2020-11-16T00:00:00.000Z"
format: "date-time"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
sourceType:
title: "outreach"
const: "outreach"
enum:
- "outreach"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "redirect_uri"
- "start_date"
- "sourceType"
type: "object"
source-outreach-update:
properties:
client_id:
description: "The Client ID of your Outreach developer application."
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Outreach developer application."
order: 1
title: "Client Secret"
type: "string"
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."
order: 3
title: "Redirect URI"
type: "string"
refresh_token:
airbyte_secret: true
description: "The token for obtaining the new access token."
order: 2
title: "Refresh Token"
type: "string"
start_date:
description: "The date from which you'd like to replicate data for Outreach\
\ API, in the format YYYY-MM-DDT00:00:00.000Z. All data generated after\
\ this date will be replicated."
examples:
- "2020-11-16T00:00:00.000Z"
format: "date-time"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "redirect_uri"
- "start_date"
type: "object"
source-primetric:
properties:
client_id:
airbyte_secret: true
description: "The Client ID of your Primetric developer application. The\
\ Client ID is visible here."
examples:
- "1234aBcD5678EFGh9045Neq79sdDlA15082VMYcj"
order: 0
pattern: "^[a-zA-Z0-9]+$"
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The Client Secret of your Primetric developer application.\
\ You can manage your client's credentials here."
order: 1
pattern: "^[a-zA-Z0-9]+$"
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "primetric"
const: "primetric"
enum:
- "primetric"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "sourceType"
title: "Primetric Spec"
type: "object"
source-primetric-update:
properties:
client_id:
airbyte_secret: true
description: "The Client ID of your Primetric developer application. The\
\ Client ID is visible here."
examples:
- "1234aBcD5678EFGh9045Neq79sdDlA15082VMYcj"
order: 0
pattern: "^[a-zA-Z0-9]+$"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Primetric developer application.\
\ You can manage your client's credentials here."
order: 1
pattern: "^[a-zA-Z0-9]+$"
title: "Client Secret"
type: "string"
required:
- "client_id"
- "client_secret"
title: "Primetric Spec"
type: "object"
source-pokeapi:
properties:
pokemon_name:
description: "Pokemon requested from the API."
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"
- "nidoran-f"
- "nidorina"
- "nidoqueen"
- "nidoran-m"
- "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"
order: 0
pattern: "^[a-z0-9_\\-]+$"
title: "Pokemon Name"
type: "string"
sourceType:
title: "pokeapi"
const: "pokeapi"
enum:
- "pokeapi"
order: 0
type: "string"
required:
- "pokemon_name"
- "sourceType"
type: "object"
source-pokeapi-update:
properties:
pokemon_name:
description: "Pokemon requested from the API."
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"
- "nidoran-f"
- "nidorina"
- "nidoqueen"
- "nidoran-m"
- "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"
order: 0
pattern: "^[a-z0-9_\\-]+$"
title: "Pokemon Name"
type: "string"
required:
- "pokemon_name"
type: "object"
source-mailerlite:
properties:
api_token:
airbyte_secret: true
description: "Your API Token. See here."
order: 0
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "mailerlite"
const: "mailerlite"
enum:
- "mailerlite"
order: 0
type: "string"
required:
- "api_token"
- "sourceType"
type: "object"
source-mailerlite-update:
properties:
api_token:
airbyte_secret: true
description: "Your API Token. See here."
order: 0
type: "string"
required:
- "api_token"
type: "object"
source-help-scout:
properties:
client_id:
airbyte_secret: true
name: "client_id"
order: 0
title: "Application ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
name: "client_secret"
order: 1
title: "Application Secret"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "help-scout"
const: "help-scout"
enum:
- "help-scout"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "start_date"
- "sourceType"
type: "object"
source-help-scout-update:
properties:
client_id:
airbyte_secret: true
name: "client_id"
order: 0
title: "Application ID"
type: "string"
client_secret:
airbyte_secret: true
name: "client_secret"
order: 1
title: "Application Secret"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "client_id"
- "client_secret"
- "start_date"
type: "object"
source-repairshopr:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
subdomain:
order: 1
title: "subdomain"
type: "string"
sourceType:
title: "repairshopr"
const: "repairshopr"
enum:
- "repairshopr"
order: 0
type: "string"
required:
- "api_key"
- "subdomain"
- "sourceType"
type: "object"
source-repairshopr-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
subdomain:
order: 1
title: "subdomain"
type: "string"
required:
- "api_key"
- "subdomain"
type: "object"
source-hubplanner:
properties:
api_key:
airbyte_secret: true
description: "Hubplanner API key. See https://github.com/hubplanner/API#authentication\
\ for more details."
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "hubplanner"
const: "hubplanner"
enum:
- "hubplanner"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
title: "Hubplanner Spec"
type: "object"
source-hubplanner-update:
properties:
api_key:
airbyte_secret: true
description: "Hubplanner API key. See https://github.com/hubplanner/API#authentication\
\ for more details."
type: "string"
required:
- "api_key"
title: "Hubplanner Spec"
type: "object"
source-babelforce:
properties:
access_key_id:
airbyte_secret: true
description: "The Babelforce access key ID"
order: 0
title: "Access Key ID"
type: "string"
x-speakeasy-param-sensitive: true
access_token:
airbyte_secret: true
description: "The Babelforce access token"
order: 1
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
date_created_from:
description: "Timestamp in Unix the replication from Babelforce API will\
\ start from. For example 1651363200 which corresponds to 2022-05-01 00:00:00."
examples:
- 1651363200
order: 2
title: "Date Created from"
type: "integer"
date_created_to:
description: "Timestamp in Unix the replication from Babelforce will be\
\ up to. For example 1651363200 which corresponds to 2022-05-01 00:00:00."
examples:
- 1651363200
order: 3
title: "Date Created to"
type: "integer"
region:
default: "services"
description: "Babelforce region"
enum:
- "services"
- "us-east"
- "ap-southeast"
order: 4
title: "Region"
type: "string"
sourceType:
title: "babelforce"
const: "babelforce"
enum:
- "babelforce"
order: 0
type: "string"
required:
- "access_key_id"
- "access_token"
- "region"
- "sourceType"
type: "object"
source-babelforce-update:
properties:
access_key_id:
airbyte_secret: true
description: "The Babelforce access key ID"
order: 0
title: "Access Key ID"
type: "string"
access_token:
airbyte_secret: true
description: "The Babelforce access token"
order: 1
title: "Access Token"
type: "string"
date_created_from:
description: "Timestamp in Unix the replication from Babelforce API will\
\ start from. For example 1651363200 which corresponds to 2022-05-01 00:00:00."
examples:
- 1651363200
order: 2
title: "Date Created from"
type: "integer"
date_created_to:
description: "Timestamp in Unix the replication from Babelforce will be\
\ up to. For example 1651363200 which corresponds to 2022-05-01 00:00:00."
examples:
- 1651363200
order: 3
title: "Date Created to"
type: "integer"
region:
default: "services"
description: "Babelforce region"
enum:
- "services"
- "us-east"
- "ap-southeast"
order: 4
title: "Region"
type: "string"
required:
- "access_key_id"
- "access_token"
- "region"
type: "object"
source-redshift:
properties:
database:
description: "Name of the database."
examples:
- "master"
order: 3
title: "Database"
type: "string"
host:
description: "Host Endpoint of the Redshift Cluster (must include the cluster-id,\
\ region and end with .redshift.amazonaws.com)."
order: 1
title: "Host"
type: "string"
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)."
order: 7
title: "JDBC URL Params"
type: "string"
password:
airbyte_secret: true
description: "Password associated with the username."
order: 6
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
port:
default: 5439
description: "Port of the database."
examples:
- "5439"
maximum: 65536
minimum: 0
order: 2
title: "Port"
type: "integer"
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."
examples:
- "public"
items:
type: "string"
minItems: 0
order: 4
title: "Schemas"
type: "array"
uniqueItems: true
username:
description: "Username to use to access the database."
order: 5
title: "Username"
type: "string"
sourceType:
title: "redshift"
const: "redshift"
enum:
- "redshift"
order: 0
type: "string"
required:
- "host"
- "port"
- "database"
- "username"
- "password"
- "sourceType"
title: "Redshift Source Spec"
type: "object"
source-redshift-update:
properties:
database:
description: "Name of the database."
examples:
- "master"
order: 3
title: "Database"
type: "string"
host:
description: "Host Endpoint of the Redshift Cluster (must include the cluster-id,\
\ region and end with .redshift.amazonaws.com)."
order: 1
title: "Host"
type: "string"
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)."
order: 7
title: "JDBC URL Params"
type: "string"
password:
airbyte_secret: true
description: "Password associated with the username."
order: 6
title: "Password"
type: "string"
port:
default: 5439
description: "Port of the database."
examples:
- "5439"
maximum: 65536
minimum: 0
order: 2
title: "Port"
type: "integer"
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."
examples:
- "public"
items:
type: "string"
minItems: 0
order: 4
title: "Schemas"
type: "array"
uniqueItems: true
username:
description: "Username to use to access the database."
order: 5
title: "Username"
type: "string"
required:
- "host"
- "port"
- "database"
- "username"
- "password"
title: "Redshift Source Spec"
type: "object"
source-coingecko-coins:
properties:
api_key:
airbyte_secret: true
description: "API Key (for pro users)"
order: 0
type: "string"
x-speakeasy-param-sensitive: true
coin_id:
description: "CoinGecko coin ID (e.g. bitcoin). Can be retrieved from the\n\
`/coins/list` endpoint.\n"
order: 1
type: "string"
days:
default: "30"
description: "The number of days of data for market chart.\n"
enum:
- "1"
- "7"
- "14"
- "30"
- "90"
- "180"
- "365"
- "max"
order: 3
type: "string"
end_date:
description: "The end date for the historical data stream in dd-mm-yyyy\
\ format.\n"
format: "date"
order: 5
pattern: "^[0-9]{2}-[0-9]{2}-[0-9]{4}$"
type: "string"
start_date:
description: "The start date for the historical data stream in dd-mm-yyyy\
\ format.\n"
format: "date"
order: 4
pattern: "^[0-9]{2}-[0-9]{2}-[0-9]{4}$"
type: "string"
vs_currency:
description: "The target currency of market data (e.g. usd, eur, jpy, etc.)\n"
order: 2
type: "string"
sourceType:
title: "coingecko-coins"
const: "coingecko-coins"
enum:
- "coingecko-coins"
order: 0
type: "string"
required:
- "coin_id"
- "vs_currency"
- "days"
- "start_date"
- "sourceType"
title: "CoinGecko Coins Spec"
type: "object"
source-coingecko-coins-update:
properties:
api_key:
airbyte_secret: true
description: "API Key (for pro users)"
order: 0
type: "string"
coin_id:
description: "CoinGecko coin ID (e.g. bitcoin). Can be retrieved from the\n\
`/coins/list` endpoint.\n"
order: 1
type: "string"
days:
default: "30"
description: "The number of days of data for market chart.\n"
enum:
- "1"
- "7"
- "14"
- "30"
- "90"
- "180"
- "365"
- "max"
order: 3
type: "string"
end_date:
description: "The end date for the historical data stream in dd-mm-yyyy\
\ format.\n"
format: "date"
order: 5
pattern: "^[0-9]{2}-[0-9]{2}-[0-9]{4}$"
type: "string"
start_date:
description: "The start date for the historical data stream in dd-mm-yyyy\
\ format.\n"
format: "date"
order: 4
pattern: "^[0-9]{2}-[0-9]{2}-[0-9]{4}$"
type: "string"
vs_currency:
description: "The target currency of market data (e.g. usd, eur, jpy, etc.)\n"
order: 2
type: "string"
required:
- "coin_id"
- "vs_currency"
- "days"
- "start_date"
title: "CoinGecko Coins Spec"
type: "object"
source-open-data-dc:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
location:
description: "address or place or block"
order: 1
title: "location"
type: "string"
marid:
description: "A unique identifier (Master Address Repository)."
order: 2
title: "marid"
type: "string"
sourceType:
title: "open-data-dc"
const: "open-data-dc"
enum:
- "open-data-dc"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-open-data-dc-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
location:
description: "address or place or block"
order: 1
title: "location"
type: "string"
marid:
description: "A unique identifier (Master Address Repository)."
order: 2
title: "marid"
type: "string"
required:
- "api_key"
type: "object"
source-survicate:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "survicate"
const: "survicate"
enum:
- "survicate"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-survicate-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-mssql:
properties:
database:
description: "The name of the database."
examples:
- "master"
order: 2
title: "Database"
type: "string"
host:
description: "The hostname of the database."
order: 0
title: "Host"
type: "string"
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)."
order: 6
title: "JDBC URL Params"
type: "string"
password:
airbyte_secret: true
description: "The password associated with the username."
order: 5
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
port:
description: "The port of the database."
examples:
- "1433"
maximum: 65536
minimum: 0
order: 1
title: "Port"
type: "integer"
replication_method:
default: "CDC"
description: "Configures how data is extracted from the database."
display_type: "radio"
oneOf:
- 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."
properties:
initial_load_timeout_hours:
default: 8
description: "The amount of time an initial load is allowed to continue\
\ for before catching up on CDC logs."
max: 24
min: 4
order: 6
title: "Initial Load Timeout in Hours (Advanced)"
type: "integer"
initial_waiting_seconds:
default: 300
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 3600 seconds. Read about\
\ initial waiting time."
max: 3600
min: 120
order: 3
title: "Initial Waiting Time in Seconds (Advanced)"
type: "integer"
invalid_cdc_cursor_position_behavior:
default: "Fail sync"
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"
order: 4
title: "Invalid CDC position behavior (Advanced)"
type: "string"
method:
const: "CDC"
order: 0
type: "string"
enum:
- "CDC"
queue_size:
default: 10000
description: "The size of the internal queue. This may interfere with\
\ memory consumption and efficiency of the connector, please be\
\ careful."
max: 10000
min: 1000
order: 5
title: "Size of the queue (Advanced)"
type: "integer"
required:
- "method"
title: "Read Changes using Change Data Capture (CDC)"
- description: "Incrementally detects new inserts and updates using the\
\ cursor column chosen when configuring a connection (e.g. created_at,\
\ updated_at)."
properties:
exclude_todays_data:
always_show: true
default: false
description: "When enabled incremental syncs using a cursor of a temporal\
\ types (date or datetime) will include cursor values only up until\
\ last midnight (Advanced)"
order: 1
title: "Exclude Today's Data"
type: "boolean"
method:
const: "STANDARD"
order: 0
type: "string"
enum:
- "STANDARD"
required:
- "method"
title: "Scan Changes with User Defined Cursor"
order: 8
title: "Update Method"
type: "object"
schemas:
default:
- "dbo"
description: "The list of schemas to sync from. Defaults to user. Case sensitive."
items:
type: "string"
minItems: 0
order: 3
title: "Schemas"
type: "array"
uniqueItems: true
ssl_method:
description: "The encryption method which is used when communicating with\
\ the database."
oneOf:
- description: "Data transfer will not be encrypted."
properties:
ssl_method:
const: "unencrypted"
type: "string"
enum:
- "unencrypted"
required:
- "ssl_method"
title: "Unencrypted"
- description: "Use the certificate provided by the server without verification.\
\ (For testing purposes only!)"
properties:
ssl_method:
const: "encrypted_trust_server_certificate"
type: "string"
enum:
- "encrypted_trust_server_certificate"
required:
- "ssl_method"
title: "Encrypted (trust server certificate)"
- description: "Verify and use the certificate provided by the server."
properties:
certificate:
airbyte_secret: true
description: "certificate of the server, or of the CA that signed\
\ the server certificate"
multiline: true
order: 1
title: "Certificate"
type: "string"
x-speakeasy-param-sensitive: true
hostNameInCertificate:
description: "Specifies the host name of the server. The value of\
\ this property must match the subject property of the certificate."
order: 0
title: "Host Name In Certificate"
type: "string"
ssl_method:
const: "encrypted_verify_certificate"
type: "string"
enum:
- "encrypted_verify_certificate"
required:
- "ssl_method"
title: "Encrypted (verify certificate)"
order: 7
title: "SSL Method"
type: "object"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- properties:
tunnel_method:
const: "NO_TUNNEL"
description: "No ssh tunnel needed to connect to database"
order: 0
type: "string"
enum:
- "NO_TUNNEL"
required:
- "tunnel_method"
title: "No Tunnel"
- properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
x-speakeasy-param-sensitive: true
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_KEY_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host."
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
- properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
title: "SSH Tunnel Method"
type: "object"
username:
description: "The username which is used to access the database."
order: 4
title: "Username"
type: "string"
sourceType:
title: "mssql"
const: "mssql"
enum:
- "mssql"
order: 0
type: "string"
required:
- "host"
- "port"
- "database"
- "username"
- "password"
- "sourceType"
title: "MSSQL Source Spec"
type: "object"
source-mssql-update:
properties:
database:
description: "The name of the database."
examples:
- "master"
order: 2
title: "Database"
type: "string"
host:
description: "The hostname of the database."
order: 0
title: "Host"
type: "string"
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)."
order: 6
title: "JDBC URL Params"
type: "string"
password:
airbyte_secret: true
description: "The password associated with the username."
order: 5
title: "Password"
type: "string"
port:
description: "The port of the database."
examples:
- "1433"
maximum: 65536
minimum: 0
order: 1
title: "Port"
type: "integer"
replication_method:
default: "CDC"
description: "Configures how data is extracted from the database."
display_type: "radio"
oneOf:
- 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."
properties:
initial_load_timeout_hours:
default: 8
description: "The amount of time an initial load is allowed to continue\
\ for before catching up on CDC logs."
max: 24
min: 4
order: 6
title: "Initial Load Timeout in Hours (Advanced)"
type: "integer"
initial_waiting_seconds:
default: 300
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 3600 seconds. Read about\
\ initial waiting time."
max: 3600
min: 120
order: 3
title: "Initial Waiting Time in Seconds (Advanced)"
type: "integer"
invalid_cdc_cursor_position_behavior:
default: "Fail sync"
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"
order: 4
title: "Invalid CDC position behavior (Advanced)"
type: "string"
method:
const: "CDC"
order: 0
type: "string"
enum:
- "CDC"
queue_size:
default: 10000
description: "The size of the internal queue. This may interfere with\
\ memory consumption and efficiency of the connector, please be\
\ careful."
max: 10000
min: 1000
order: 5
title: "Size of the queue (Advanced)"
type: "integer"
required:
- "method"
title: "Read Changes using Change Data Capture (CDC)"
- description: "Incrementally detects new inserts and updates using the\
\ cursor column chosen when configuring a connection (e.g. created_at,\
\ updated_at)."
properties:
exclude_todays_data:
always_show: true
default: false
description: "When enabled incremental syncs using a cursor of a temporal\
\ types (date or datetime) will include cursor values only up until\
\ last midnight (Advanced)"
order: 1
title: "Exclude Today's Data"
type: "boolean"
method:
const: "STANDARD"
order: 0
type: "string"
enum:
- "STANDARD"
required:
- "method"
title: "Scan Changes with User Defined Cursor"
order: 8
title: "Update Method"
type: "object"
schemas:
default:
- "dbo"
description: "The list of schemas to sync from. Defaults to user. Case sensitive."
items:
type: "string"
minItems: 0
order: 3
title: "Schemas"
type: "array"
uniqueItems: true
ssl_method:
description: "The encryption method which is used when communicating with\
\ the database."
oneOf:
- description: "Data transfer will not be encrypted."
properties:
ssl_method:
const: "unencrypted"
type: "string"
enum:
- "unencrypted"
required:
- "ssl_method"
title: "Unencrypted"
- description: "Use the certificate provided by the server without verification.\
\ (For testing purposes only!)"
properties:
ssl_method:
const: "encrypted_trust_server_certificate"
type: "string"
enum:
- "encrypted_trust_server_certificate"
required:
- "ssl_method"
title: "Encrypted (trust server certificate)"
- description: "Verify and use the certificate provided by the server."
properties:
certificate:
airbyte_secret: true
description: "certificate of the server, or of the CA that signed\
\ the server certificate"
multiline: true
order: 1
title: "Certificate"
type: "string"
hostNameInCertificate:
description: "Specifies the host name of the server. The value of\
\ this property must match the subject property of the certificate."
order: 0
title: "Host Name In Certificate"
type: "string"
ssl_method:
const: "encrypted_verify_certificate"
type: "string"
enum:
- "encrypted_verify_certificate"
required:
- "ssl_method"
title: "Encrypted (verify certificate)"
order: 7
title: "SSL Method"
type: "object"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- properties:
tunnel_method:
const: "NO_TUNNEL"
description: "No ssh tunnel needed to connect to database"
order: 0
type: "string"
enum:
- "NO_TUNNEL"
required:
- "tunnel_method"
title: "No Tunnel"
- properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_KEY_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host."
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
- properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
title: "SSH Tunnel Method"
type: "object"
username:
description: "The username which is used to access the database."
order: 4
title: "Username"
type: "string"
required:
- "host"
- "port"
- "database"
- "username"
- "password"
title: "MSSQL Source Spec"
type: "object"
source-breezometer:
properties:
api_key:
airbyte_secret: true
description: "Your API Access Key. See here."
tittle: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
days_to_forecast:
description: "Number of days to forecast. Minimum 1, maximum 3. Valid for\
\ Polen and Weather Forecast streams."
examples:
- 3
tittle: "Days to Forecast"
type: "integer"
historic_hours:
description: "Number of hours retireve from Air Quality History stream.\
\ Minimum 1, maximum 720."
examples:
- 30
tittle: "Historic Hours"
type: "integer"
hours_to_forecast:
description: "Number of hours to forecast. Minimum 1, maximum 96. Valid\
\ for Air Quality Forecast stream."
examples:
- 30
tittle: "Hours to Forecast"
type: "integer"
latitude:
description: "Latitude of the monitored location."
examples:
- "54.675003"
tittle: "Latitude"
type: "string"
longitude:
description: "Longitude of the monitored location."
examples:
- "-113.550282"
tittle: "Longitude"
type: "string"
radius:
description: "Desired radius from the location provided. Minimum 5, maximum\
\ 100. Valid for Wildfires streams."
examples:
- 50
tittle: "Radius"
type: "integer"
sourceType:
title: "breezometer"
const: "breezometer"
enum:
- "breezometer"
order: 0
type: "string"
required:
- "api_key"
- "latitude"
- "longitude"
- "sourceType"
title: "Breezometer Spec"
type: "object"
source-breezometer-update:
properties:
api_key:
airbyte_secret: true
description: "Your API Access Key. See here."
tittle: "API Key"
type: "string"
days_to_forecast:
description: "Number of days to forecast. Minimum 1, maximum 3. Valid for\
\ Polen and Weather Forecast streams."
examples:
- 3
tittle: "Days to Forecast"
type: "integer"
historic_hours:
description: "Number of hours retireve from Air Quality History stream.\
\ Minimum 1, maximum 720."
examples:
- 30
tittle: "Historic Hours"
type: "integer"
hours_to_forecast:
description: "Number of hours to forecast. Minimum 1, maximum 96. Valid\
\ for Air Quality Forecast stream."
examples:
- 30
tittle: "Hours to Forecast"
type: "integer"
latitude:
description: "Latitude of the monitored location."
examples:
- "54.675003"
tittle: "Latitude"
type: "string"
longitude:
description: "Longitude of the monitored location."
examples:
- "-113.550282"
tittle: "Longitude"
type: "string"
radius:
description: "Desired radius from the location provided. Minimum 5, maximum\
\ 100. Valid for Wildfires streams."
examples:
- 50
tittle: "Radius"
type: "integer"
required:
- "api_key"
- "latitude"
- "longitude"
title: "Breezometer Spec"
type: "object"
source-salesforce:
properties:
auth_type:
const: "Client"
type: "string"
enum:
- "Client"
client_id:
description: "Enter your Salesforce developer application's Client ID"
order: 2
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Enter your Salesforce developer application's Client secret"
order: 3
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
force_use_bulk_api:
default: false
description: "Toggle to use Bulk API (this might cause empty fields for\
\ some streams)"
order: 6
title: "Force to use BULK API"
type: "boolean"
is_sandbox:
default: false
description: "Toggle if you're using a Salesforce Sandbox"
order: 1
title: "Sandbox"
type: "boolean"
refresh_token:
airbyte_secret: true
description: "Enter your application's Salesforce Refresh Token used for Airbyte to access your Salesforce\
\ account."
order: 4
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
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."
examples:
- "2021-07-25"
- "2021-07-25T00:00:00Z"
format: "date-time"
order: 5
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"
title: "Start Date"
type: "string"
stream_slice_step:
default: "P30D"
description: "The size of the time window (ISO8601 duration) to slice requests."
examples:
- "PT12H"
- "P7D"
- "P30D"
- "P1M"
- "P1Y"
order: 7
title: "Stream Slice Step for Incremental sync"
type: "string"
streams_criteria:
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."
items:
properties:
criteria:
default: "contains"
enum:
- "starts with"
- "ends with"
- "contains"
- "exacts"
- "starts not with"
- "ends not with"
- "not contains"
- "not exacts"
order: 1
title: "Search criteria"
type: "string"
value:
order: 2
title: "Search value"
type: "string"
required:
- "criteria"
- "value"
type: "object"
order: 8
title: "Filter Salesforce Objects"
type: "array"
sourceType:
title: "salesforce"
const: "salesforce"
enum:
- "salesforce"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "sourceType"
title: "Salesforce Source Spec"
type: "object"
source-salesforce-update:
properties:
auth_type:
const: "Client"
type: "string"
enum:
- "Client"
client_id:
description: "Enter your Salesforce developer application's Client ID"
order: 2
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Enter your Salesforce developer application's Client secret"
order: 3
title: "Client Secret"
type: "string"
force_use_bulk_api:
default: false
description: "Toggle to use Bulk API (this might cause empty fields for\
\ some streams)"
order: 6
title: "Force to use BULK API"
type: "boolean"
is_sandbox:
default: false
description: "Toggle if you're using a Salesforce Sandbox"
order: 1
title: "Sandbox"
type: "boolean"
refresh_token:
airbyte_secret: true
description: "Enter your application's Salesforce Refresh Token used for Airbyte to access your Salesforce\
\ account."
order: 4
title: "Refresh Token"
type: "string"
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."
examples:
- "2021-07-25"
- "2021-07-25T00:00:00Z"
format: "date-time"
order: 5
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"
title: "Start Date"
type: "string"
stream_slice_step:
default: "P30D"
description: "The size of the time window (ISO8601 duration) to slice requests."
examples:
- "PT12H"
- "P7D"
- "P30D"
- "P1M"
- "P1Y"
order: 7
title: "Stream Slice Step for Incremental sync"
type: "string"
streams_criteria:
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."
items:
properties:
criteria:
default: "contains"
enum:
- "starts with"
- "ends with"
- "contains"
- "exacts"
- "starts not with"
- "ends not with"
- "not contains"
- "not exacts"
order: 1
title: "Search criteria"
type: "string"
value:
order: 2
title: "Search value"
type: "string"
required:
- "criteria"
- "value"
type: "object"
order: 8
title: "Filter Salesforce Objects"
type: "array"
required:
- "client_id"
- "client_secret"
- "refresh_token"
title: "Salesforce Source Spec"
type: "object"
source-clickhouse:
properties:
database:
description: "The name of the database."
examples:
- "default"
order: 2
title: "Database"
type: "string"
host:
description: "The host endpoint of the Clickhouse cluster."
order: 0
title: "Host"
type: "string"
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."
order: 5
title: "JDBC URL Parameters (Advanced)"
type: "string"
password:
airbyte_secret: true
description: "The password associated with this username."
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
port:
default: 8123
description: "The port of the database."
examples:
- "8123"
maximum: 65536
minimum: 0
order: 1
title: "Port"
type: "integer"
ssl:
default: true
description: "Encrypt data using SSL."
order: 6
title: "SSL Connection"
type: "boolean"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- properties:
tunnel_method:
const: "NO_TUNNEL"
description: "No ssh tunnel needed to connect to database"
order: 0
type: "string"
enum:
- "NO_TUNNEL"
required:
- "tunnel_method"
title: "No Tunnel"
- properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
x-speakeasy-param-sensitive: true
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_KEY_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host."
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
- properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
title: "SSH Tunnel Method"
type: "object"
username:
description: "The username which is used to access the database."
order: 3
title: "Username"
type: "string"
sourceType:
title: "clickhouse"
const: "clickhouse"
enum:
- "clickhouse"
order: 0
type: "string"
required:
- "host"
- "port"
- "database"
- "username"
- "sourceType"
title: "ClickHouse Source Spec"
type: "object"
source-clickhouse-update:
properties:
database:
description: "The name of the database."
examples:
- "default"
order: 2
title: "Database"
type: "string"
host:
description: "The host endpoint of the Clickhouse cluster."
order: 0
title: "Host"
type: "string"
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."
order: 5
title: "JDBC URL Parameters (Advanced)"
type: "string"
password:
airbyte_secret: true
description: "The password associated with this username."
order: 4
title: "Password"
type: "string"
port:
default: 8123
description: "The port of the database."
examples:
- "8123"
maximum: 65536
minimum: 0
order: 1
title: "Port"
type: "integer"
ssl:
default: true
description: "Encrypt data using SSL."
order: 6
title: "SSL Connection"
type: "boolean"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- properties:
tunnel_method:
const: "NO_TUNNEL"
description: "No ssh tunnel needed to connect to database"
order: 0
type: "string"
enum:
- "NO_TUNNEL"
required:
- "tunnel_method"
title: "No Tunnel"
- properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_KEY_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host."
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
- properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
title: "SSH Tunnel Method"
type: "object"
username:
description: "The username which is used to access the database."
order: 3
title: "Username"
type: "string"
required:
- "host"
- "port"
- "database"
- "username"
title: "ClickHouse Source Spec"
type: "object"
source-lightspeed-retail:
properties:
api_key:
airbyte_secret: true
description: "API key or access token"
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
subdomain:
description: "The subdomain for the retailer, e.g., 'example' in 'example.retail.lightspeed.app'."
name: "subdomain"
order: 1
title: "Subdomain"
type: "string"
sourceType:
title: "lightspeed-retail"
const: "lightspeed-retail"
enum:
- "lightspeed-retail"
order: 0
type: "string"
required:
- "api_key"
- "subdomain"
- "sourceType"
type: "object"
source-lightspeed-retail-update:
properties:
api_key:
airbyte_secret: true
description: "API key or access token"
name: "api_key"
order: 0
title: "API Key"
type: "string"
subdomain:
description: "The subdomain for the retailer, e.g., 'example' in 'example.retail.lightspeed.app'."
name: "subdomain"
order: 1
title: "Subdomain"
type: "string"
required:
- "api_key"
- "subdomain"
type: "object"
source-postmarkapp:
properties:
X-Postmark-Account-Token:
airbyte_secret: true
description: "API Key for account"
order: 1
title: "X-Postmark-Account-Token"
type: "string"
x-speakeasy-param-sensitive: true
X-Postmark-Server-Token:
airbyte_secret: true
description: "API Key for server"
order: 0
title: "X-Postmark-Server-Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "postmarkapp"
const: "postmarkapp"
enum:
- "postmarkapp"
order: 0
type: "string"
required:
- "X-Postmark-Server-Token"
- "X-Postmark-Account-Token"
- "sourceType"
type: "object"
source-postmarkapp-update:
properties:
X-Postmark-Account-Token:
airbyte_secret: true
description: "API Key for account"
order: 1
title: "X-Postmark-Account-Token"
type: "string"
X-Postmark-Server-Token:
airbyte_secret: true
description: "API Key for server"
order: 0
title: "X-Postmark-Server-Token"
type: "string"
required:
- "X-Postmark-Server-Token"
- "X-Postmark-Account-Token"
type: "object"
source-finnhub:
properties:
api_key:
airbyte_secret: true
description: "The API key to use for authentication"
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
exchange:
default: "US"
description: "More info: https://finnhub.io/docs/api/stock-symbols"
order: 3
title: "Exchange"
type: "string"
market_news_category:
default: "general"
description: "This parameter can be 1 of the following values general, forex,\
\ crypto, merger."
enum:
- "general"
- "forex"
- "crypto"
- "merger"
order: 2
title: "Market News Category"
type: "string"
start_date_2:
format: "date-time"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
symbols:
name: "company_symbol"
order: 1
title: "Companies"
type: "array"
sourceType:
title: "finnhub"
const: "finnhub"
enum:
- "finnhub"
order: 0
type: "string"
required:
- "api_key"
- "symbols"
- "market_news_category"
- "exchange"
- "start_date_2"
- "sourceType"
type: "object"
source-finnhub-update:
properties:
api_key:
airbyte_secret: true
description: "The API key to use for authentication"
name: "api_key"
order: 0
title: "API Key"
type: "string"
exchange:
default: "US"
description: "More info: https://finnhub.io/docs/api/stock-symbols"
order: 3
title: "Exchange"
type: "string"
market_news_category:
default: "general"
description: "This parameter can be 1 of the following values general, forex,\
\ crypto, merger."
enum:
- "general"
- "forex"
- "crypto"
- "merger"
order: 2
title: "Market News Category"
type: "string"
start_date_2:
format: "date-time"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
symbols:
name: "company_symbol"
order: 1
title: "Companies"
type: "array"
required:
- "api_key"
- "symbols"
- "market_news_category"
- "exchange"
- "start_date_2"
type: "object"
source-float:
properties:
access_token:
airbyte_secret: true
description: "API token obtained from your Float Account Settings page"
name: "float_access_token"
order: 0
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "float"
const: "float"
enum:
- "float"
order: 0
type: "string"
required:
- "access_token"
- "start_date"
- "sourceType"
type: "object"
source-float-update:
properties:
access_token:
airbyte_secret: true
description: "API token obtained from your Float Account Settings page"
name: "float_access_token"
order: 0
title: "Access Token"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "access_token"
- "start_date"
type: "object"
source-merge:
properties:
account_token:
airbyte_secret: true
description: "Link your other integrations with account credentials on accounts\
\ section to get account token (ref - https://app.merge.dev/linked-accounts/accounts)"
order: 0
title: "Account Token"
type: "string"
x-speakeasy-param-sensitive: true
api_token:
airbyte_secret: true
description: "API token can be seen at https://app.merge.dev/keys"
order: 1
title: "Api token"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "Date time filter for incremental filter, Specify which date\
\ to extract from."
examples:
- "2022-03-01T00:00:00.000Z"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$"
title: "Date-From Filter"
type: "string"
sourceType:
title: "merge"
const: "merge"
enum:
- "merge"
order: 0
type: "string"
required:
- "account_token"
- "api_token"
- "start_date"
- "sourceType"
type: "object"
source-merge-update:
properties:
account_token:
airbyte_secret: true
description: "Link your other integrations with account credentials on accounts\
\ section to get account token (ref - https://app.merge.dev/linked-accounts/accounts)"
order: 0
title: "Account Token"
type: "string"
api_token:
airbyte_secret: true
description: "API token can be seen at https://app.merge.dev/keys"
order: 1
title: "Api token"
type: "string"
start_date:
description: "Date time filter for incremental filter, Specify which date\
\ to extract from."
examples:
- "2022-03-01T00:00:00.000Z"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$"
title: "Date-From Filter"
type: "string"
required:
- "account_token"
- "api_token"
- "start_date"
type: "object"
source-referralhero:
properties:
api_key:
airbyte_secret: true
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "referralhero"
const: "referralhero"
enum:
- "referralhero"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-referralhero-update:
properties:
api_key:
airbyte_secret: true
name: "api_key"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-hardcoded-records:
properties:
count:
default: 1000
description: "How many records per stream should be generated"
minimum: 1
order: 0
title: "Count"
type: "integer"
sourceType:
title: "hardcoded-records"
const: "hardcoded-records"
enum:
- "hardcoded-records"
order: 0
type: "string"
required:
- "sourceType"
title: "Hardcoded Records Source Spec"
type: "object"
source-hardcoded-records-update:
properties:
count:
default: 1000
description: "How many records per stream should be generated"
minimum: 1
order: 0
title: "Count"
type: "integer"
required: []
title: "Hardcoded Records Source Spec"
type: "object"
source-onfleet:
properties:
api_key:
airbyte_secret: true
description: "API key to use for authenticating requests. You can create\
\ and manage your API keys in the API section of the Onfleet dashboard."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
password:
airbyte_secret: true
default: "x"
description: "Placeholder for basic HTTP auth password - should be set to\
\ empty string"
name: "password"
order: 1
title: "Placeholder Password"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "onfleet"
const: "onfleet"
enum:
- "onfleet"
order: 0
type: "string"
required:
- "api_key"
- "password"
- "sourceType"
type: "object"
source-onfleet-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use for authenticating requests. You can create\
\ and manage your API keys in the API section of the Onfleet dashboard."
name: "api_key"
order: 0
title: "API Key"
type: "string"
password:
airbyte_secret: true
default: "x"
description: "Placeholder for basic HTTP auth password - should be set to\
\ empty string"
name: "password"
order: 1
title: "Placeholder Password"
type: "string"
required:
- "api_key"
- "password"
type: "object"
source-gorgias:
properties:
domain_name:
description: "Domain name given for gorgias, found as your url prefix for\
\ accessing your website"
order: 2
title: "Domain name"
type: "string"
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
username:
order: 0
title: "Username"
type: "string"
sourceType:
title: "gorgias"
const: "gorgias"
enum:
- "gorgias"
order: 0
type: "string"
required:
- "username"
- "domain_name"
- "start_date"
- "sourceType"
type: "object"
source-gorgias-update:
properties:
domain_name:
description: "Domain name given for gorgias, found as your url prefix for\
\ accessing your website"
order: 2
title: "Domain name"
type: "string"
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
username:
order: 0
title: "Username"
type: "string"
required:
- "username"
- "domain_name"
- "start_date"
type: "object"
source-faker:
properties:
always_updated:
default: true
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."
title: "Always Updated"
type: "boolean"
count:
default: 1000
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."
minimum: 1
order: 0
title: "Count"
type: "integer"
parallelism:
default: 4
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."
minimum: 1
order: 4
title: "Parallelism"
type: "integer"
records_per_slice:
default: 1000
description: "How many fake records will be in each page (stream slice),\
\ before a state message is emitted?"
minimum: 1
order: 2
title: "Records Per Stream Slice"
type: "integer"
seed:
default: -1
description: "Manually control the faker random seed to return the same\
\ values on subsequent runs (leave -1 for random)"
order: 1
title: "Seed"
type: "integer"
sourceType:
title: "faker"
const: "faker"
enum:
- "faker"
order: 0
type: "string"
required:
- "sourceType"
title: "Faker Source Spec"
type: "object"
source-faker-update:
properties:
always_updated:
default: true
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."
title: "Always Updated"
type: "boolean"
count:
default: 1000
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."
minimum: 1
order: 0
title: "Count"
type: "integer"
parallelism:
default: 4
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."
minimum: 1
order: 4
title: "Parallelism"
type: "integer"
records_per_slice:
default: 1000
description: "How many fake records will be in each page (stream slice),\
\ before a state message is emitted?"
minimum: 1
order: 2
title: "Records Per Stream Slice"
type: "integer"
seed:
default: -1
description: "Manually control the faker random seed to return the same\
\ values on subsequent runs (leave -1 for random)"
order: 1
title: "Seed"
type: "integer"
required: []
title: "Faker Source Spec"
type: "object"
source-lever-hiring:
properties:
credentials:
description: "Choose how to authenticate to Lever Hiring."
oneOf:
- properties:
auth_type:
const: "Client"
order: 0
type: "string"
enum:
- "Client"
client_id:
description: "The Client ID of your Lever Hiring developer application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Lever Hiring developer application."
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "The token for obtaining new access token."
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "refresh_token"
title: "Authenticate via Lever (OAuth)"
type: "object"
- properties:
api_key:
airbyte_secret: true
description: "The Api Key of your Lever Hiring account."
order: 1
title: "Api key"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "Api Key"
order: 0
type: "string"
enum:
- "Api Key"
required:
- "api_key"
title: "Authenticate via Lever (Api Key)"
type: "object"
order: 3
title: "Authentication Mechanism"
type: "object"
environment:
default: "Sandbox"
description: "The environment in which you'd like to replicate data for\
\ Lever. This is used to determine which Lever API endpoint to use."
enum:
- "Production"
- "Sandbox"
order: 1
title: "Environment"
type: "string"
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"
order: 0
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
sourceType:
title: "lever-hiring"
const: "lever-hiring"
enum:
- "lever-hiring"
order: 0
type: "string"
required:
- "start_date"
- "sourceType"
title: "Lever Hiring Source Spec"
type: "object"
source-lever-hiring-update:
properties:
credentials:
description: "Choose how to authenticate to Lever Hiring."
oneOf:
- properties:
auth_type:
const: "Client"
order: 0
type: "string"
enum:
- "Client"
client_id:
description: "The Client ID of your Lever Hiring developer application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Lever Hiring developer application."
title: "Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "The token for obtaining new access token."
title: "Refresh Token"
type: "string"
required:
- "refresh_token"
title: "Authenticate via Lever (OAuth)"
type: "object"
- properties:
api_key:
airbyte_secret: true
description: "The Api Key of your Lever Hiring account."
order: 1
title: "Api key"
type: "string"
auth_type:
const: "Api Key"
order: 0
type: "string"
enum:
- "Api Key"
required:
- "api_key"
title: "Authenticate via Lever (Api Key)"
type: "object"
order: 3
title: "Authentication Mechanism"
type: "object"
environment:
default: "Sandbox"
description: "The environment in which you'd like to replicate data for\
\ Lever. This is used to determine which Lever API endpoint to use."
enum:
- "Production"
- "Sandbox"
order: 1
title: "Environment"
type: "string"
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"
order: 0
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
required:
- "start_date"
title: "Lever Hiring Source Spec"
type: "object"
source-unleash:
properties:
api_token:
airbyte_secret: true
description: "Your API Token (Server-Side SDK [Client]). See here.\
\ The token is case sensitive."
examples:
- "project:environment.be44368985f7fb3237c584ef86f3d6bdada42ddbd63a019d26955178"
- "*:environment.be44368985f7fb3237c584ef86f3d6bdada42ddbd63a019d26955178"
- "be44368985f7fb3237c584ef86f3d6bdada42ddbd63a019d26955178"
order: 0
title: "API Token Client"
type: "string"
x-speakeasy-param-sensitive: true
api_url:
description: "Your API URL. No trailing slash. ex: https://unleash.host.com/api"
order: 1
title: "API URL"
type: "string"
nameprefix:
description: "Use this if you want to filter the API call for only one given\
\ project (can be used in addition to the \"Feature Name Prefix\" field).\
\ See here"
order: 3
title: "Feature Name Prefix"
type: "string"
project_name:
description: "Use this if you want to filter the API call for only one given\
\ project (can be used in addition to the \"Feature Name Prefix\" field).\
\ See here"
order: 2
title: "Project Name"
type: "string"
sourceType:
title: "unleash"
const: "unleash"
enum:
- "unleash"
order: 0
type: "string"
required:
- "api_token"
- "api_url"
- "sourceType"
type: "object"
source-unleash-update:
properties:
api_token:
airbyte_secret: true
description: "Your API Token (Server-Side SDK [Client]). See here.\
\ The token is case sensitive."
examples:
- "project:environment.be44368985f7fb3237c584ef86f3d6bdada42ddbd63a019d26955178"
- "*:environment.be44368985f7fb3237c584ef86f3d6bdada42ddbd63a019d26955178"
- "be44368985f7fb3237c584ef86f3d6bdada42ddbd63a019d26955178"
order: 0
title: "API Token Client"
type: "string"
api_url:
description: "Your API URL. No trailing slash. ex: https://unleash.host.com/api"
order: 1
title: "API URL"
type: "string"
nameprefix:
description: "Use this if you want to filter the API call for only one given\
\ project (can be used in addition to the \"Feature Name Prefix\" field).\
\ See here"
order: 3
title: "Feature Name Prefix"
type: "string"
project_name:
description: "Use this if you want to filter the API call for only one given\
\ project (can be used in addition to the \"Feature Name Prefix\" field).\
\ See here"
order: 2
title: "Project Name"
type: "string"
required:
- "api_token"
- "api_url"
type: "object"
source-braze:
properties:
api_key:
airbyte_secret: true
description: "Braze REST API key"
order: 1
title: "Rest API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "Rows after this date will be synced"
format: "date"
order: 2
title: "Start date"
type: "string"
url:
description: "Braze REST API endpoint"
order: 0
title: "URL"
type: "string"
sourceType:
title: "braze"
const: "braze"
enum:
- "braze"
order: 0
type: "string"
required:
- "url"
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-braze-update:
properties:
api_key:
airbyte_secret: true
description: "Braze REST API key"
order: 1
title: "Rest API Key"
type: "string"
start_date:
description: "Rows after this date will be synced"
format: "date"
order: 2
title: "Start date"
type: "string"
url:
description: "Braze REST API endpoint"
order: 0
title: "URL"
type: "string"
required:
- "url"
- "api_key"
- "start_date"
type: "object"
source-sftp:
properties:
credentials:
description: "The server authentication method"
oneOf:
- properties:
auth_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
auth_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 1
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_method"
- "auth_user_password"
title: "Password Authentication"
- properties:
auth_method:
const: "SSH_KEY_AUTH"
description: "Connect through ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
auth_ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 1
title: "SSH Private Key"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_method"
- "auth_ssh_key"
title: "SSH Key Authentication"
order: 3
title: "Authentication"
type: "object"
file_pattern:
default: ""
description: "The regular expression to specify files for sync in a chosen\
\ Folder Path"
examples:
- "log-([0-9]{4})([0-9]{2})([0-9]{2}) - This will filter files which `log-yearmmdd`"
order: 6
title: "File Pattern"
type: "string"
file_types:
default: "csv,json"
description: "Coma separated file types. Currently only 'csv' and 'json'\
\ types are supported."
examples:
- "csv,json"
- "csv"
order: 4
title: "File types"
type: "string"
folder_path:
default: ""
description: "The directory to search files for sync"
examples:
- "/logs/2022"
order: 5
title: "Folder Path"
type: "string"
host:
description: "The server host address"
examples:
- "www.host.com"
- "192.0.2.1"
order: 1
title: "Host Address"
type: "string"
port:
default: 22
description: "The server port"
examples:
- "22"
order: 2
title: "Port"
type: "integer"
user:
description: "The server user"
order: 0
title: "User Name"
type: "string"
sourceType:
title: "sftp"
const: "sftp"
enum:
- "sftp"
order: 0
type: "string"
required:
- "user"
- "host"
- "port"
- "sourceType"
title: "SFTP Source Spec"
type: "object"
source-sftp-update:
properties:
credentials:
description: "The server authentication method"
oneOf:
- properties:
auth_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
auth_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 1
title: "Password"
type: "string"
required:
- "auth_method"
- "auth_user_password"
title: "Password Authentication"
- properties:
auth_method:
const: "SSH_KEY_AUTH"
description: "Connect through ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
auth_ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 1
title: "SSH Private Key"
type: "string"
required:
- "auth_method"
- "auth_ssh_key"
title: "SSH Key Authentication"
order: 3
title: "Authentication"
type: "object"
file_pattern:
default: ""
description: "The regular expression to specify files for sync in a chosen\
\ Folder Path"
examples:
- "log-([0-9]{4})([0-9]{2})([0-9]{2}) - This will filter files which `log-yearmmdd`"
order: 6
title: "File Pattern"
type: "string"
file_types:
default: "csv,json"
description: "Coma separated file types. Currently only 'csv' and 'json'\
\ types are supported."
examples:
- "csv,json"
- "csv"
order: 4
title: "File types"
type: "string"
folder_path:
default: ""
description: "The directory to search files for sync"
examples:
- "/logs/2022"
order: 5
title: "Folder Path"
type: "string"
host:
description: "The server host address"
examples:
- "www.host.com"
- "192.0.2.1"
order: 1
title: "Host Address"
type: "string"
port:
default: 22
description: "The server port"
examples:
- "22"
order: 2
title: "Port"
type: "integer"
user:
description: "The server user"
order: 0
title: "User Name"
type: "string"
required:
- "user"
- "host"
- "port"
title: "SFTP Source Spec"
type: "object"
source-agilecrm:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it at Admin Settings -> API & Analytics\
\ -> API Key in your Agile CRM account."
name: "api_key"
order: 2
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
domain:
description: "The specific subdomain for your Agile CRM account"
name: "domain"
order: 1
title: "Domain"
type: "string"
email:
description: "Your Agile CRM account email address. This is used as the\
\ username for authentication."
name: "email"
order: 0
title: "Email Address"
type: "string"
sourceType:
title: "agilecrm"
const: "agilecrm"
enum:
- "agilecrm"
order: 0
type: "string"
required:
- "email"
- "domain"
- "api_key"
- "sourceType"
type: "object"
source-agilecrm-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it at Admin Settings -> API & Analytics\
\ -> API Key in your Agile CRM account."
name: "api_key"
order: 2
title: "API Key"
type: "string"
domain:
description: "The specific subdomain for your Agile CRM account"
name: "domain"
order: 1
title: "Domain"
type: "string"
email:
description: "Your Agile CRM account email address. This is used as the\
\ username for authentication."
name: "email"
order: 0
title: "Email Address"
type: "string"
required:
- "email"
- "domain"
- "api_key"
type: "object"
source-google-drive:
description: "Used during spec; allows the developer to configure the cloud\
\ provider specific options\nthat are needed when users configure a file-based\
\ source."
properties:
credentials:
description: "Credentials for connecting to the Google Drive API"
oneOf:
- properties:
auth_type:
const: "Client"
default: "Client"
enum:
- "Client"
title: "Auth Type"
type: "string"
client_id:
airbyte_secret: true
description: "Client ID for the Google Drive API"
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "Client Secret for the Google Drive API"
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "Refresh Token for the Google Drive API"
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "auth_type"
title: "Authenticate via Google (OAuth)"
type: "object"
- properties:
auth_type:
const: "Service"
default: "Service"
enum:
- "Service"
title: "Auth Type"
type: "string"
service_account_info:
airbyte_secret: true
description: "The JSON key of the service account to use for authorization.\
\ Read more here."
title: "Service Account Information"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "service_account_info"
- "auth_type"
title: "Service Account Key Authentication"
type: "object"
title: "Authentication"
type: "object"
delivery_method:
default: "use_records_transfer"
display_type: "radio"
group: "advanced"
oneOf:
- description: "Recommended - Extract and load structured records into your\
\ destination of choice. This is the classic method of moving data in\
\ Airbyte. It allows for blocking and hashing individual fields or files\
\ from a structured schema. Data can be flattened, typed and deduped\
\ depending on the destination."
properties:
delivery_type:
const: "use_records_transfer"
default: "use_records_transfer"
enum:
- "use_records_transfer"
title: "Delivery Type"
type: "string"
required:
- "delivery_type"
title: "Replicate Records"
type: "object"
- description: "Copy raw files without parsing their contents. Bits are\
\ copied into the destination exactly as they appeared in the source.\
\ Recommended for use with unstructured text data, non-text and compressed\
\ files."
properties:
delivery_type:
const: "use_file_transfer"
default: "use_file_transfer"
enum:
- "use_file_transfer"
title: "Delivery Type"
type: "string"
preserve_directory_structure:
default: true
description: "If enabled, sends subdirectory folder structure along\
\ with source file names to the destination. Otherwise, files will\
\ be synced by their names only. This option is ignored when file-based\
\ replication is not enabled."
title: "Preserve Sub-Directories in File Paths"
type: "boolean"
required:
- "delivery_type"
title: "Copy Raw Files"
type: "object"
- description: "Sends one identity stream and one for more permissions (ACL)\
\ streams to the destination. This data can be used in downstream systems\
\ to recreate permission restrictions mirroring the original source."
properties:
delivery_type:
const: "use_permissions_transfer"
default: "use_permissions_transfer"
enum:
- "use_permissions_transfer"
title: "Delivery Type"
type: "string"
domain:
airbyte_hidden: false
description: "The Google domain of the identities."
order: 1
title: "Domain"
type: "string"
include_identities_stream:
default: true
description: "This data can be used in downstream systems to recreate\
\ permission restrictions mirroring the original source"
title: "Include Identity Stream"
type: "boolean"
required:
- "delivery_type"
title: "Replicate Permissions ACL"
type: "object"
order: 1
title: "Delivery Method"
type: "object"
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"
title: "Folder Url"
type: "string"
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"
order: 1
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"
title: "Start Date"
type: "string"
streams:
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."
items:
properties:
days_to_sync_if_history_is_full:
default: 3
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."
title: "Days To Sync If History Is Full"
type: "integer"
format:
description: "The configuration options that are used to alter how\
\ to read incoming files that deviate from the standard formatting."
oneOf:
- properties:
double_as_string:
default: false
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."
title: "Convert Double Fields to Strings"
type: "boolean"
filetype:
const: "avro"
default: "avro"
title: "Filetype"
type: "string"
enum:
- "avro"
required:
- "filetype"
title: "Avro Format"
type: "object"
- properties:
delimiter:
default: ","
description: "The character delimiting individual cells in the\
\ CSV data. This may only be a 1-character string. For tab-delimited\
\ data enter '\\t'."
title: "Delimiter"
type: "string"
double_quote:
default: true
description: "Whether two quotes in a quoted CSV value denote\
\ a single quote in the data."
title: "Double Quote"
type: "boolean"
encoding:
default: "utf8"
description: "The character encoding of the CSV data. Leave\
\ blank to default to UTF8. See list of python encodings for allowable\
\ options."
title: "Encoding"
type: "string"
escape_char:
description: "The character used for escaping special characters.\
\ To disallow escaping, leave this field blank."
title: "Escape Character"
type: "string"
false_values:
default:
- "n"
- "no"
- "f"
- "false"
- "off"
- "0"
description: "A set of case-sensitive strings that should be\
\ interpreted as false values."
items:
type: "string"
title: "False Values"
type: "array"
uniqueItems: true
filetype:
const: "csv"
default: "csv"
title: "Filetype"
type: "string"
enum:
- "csv"
header_definition:
default:
header_definition_type: "From CSV"
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."
oneOf:
- properties:
header_definition_type:
const: "From CSV"
default: "From CSV"
title: "Header Definition Type"
type: "string"
enum:
- "From CSV"
required:
- "header_definition_type"
title: "From CSV"
type: "object"
- properties:
header_definition_type:
const: "Autogenerated"
default: "Autogenerated"
title: "Header Definition Type"
type: "string"
enum:
- "Autogenerated"
required:
- "header_definition_type"
title: "Autogenerated"
type: "object"
- properties:
column_names:
description: "The column names that will be used while\
\ emitting the CSV records"
items:
type: "string"
title: "Column Names"
type: "array"
header_definition_type:
const: "User Provided"
default: "User Provided"
title: "Header Definition Type"
type: "string"
enum:
- "User Provided"
required:
- "column_names"
- "header_definition_type"
title: "User Provided"
type: "object"
title: "CSV Header Definition"
type: "object"
ignore_errors_on_fields_mismatch:
default: false
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."
title: "Ignore errors on field mismatch"
type: "boolean"
null_values:
default: []
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."
items:
type: "string"
title: "Null Values"
type: "array"
uniqueItems: true
quote_char:
default: "\""
description: "The character used for quoting CSV values. To\
\ disallow quoting, make this field blank."
title: "Quote Character"
type: "string"
skip_rows_after_header:
default: 0
description: "The number of rows to skip after the header row."
title: "Skip Rows After Header"
type: "integer"
skip_rows_before_header:
default: 0
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."
title: "Skip Rows Before Header"
type: "integer"
strings_can_be_null:
default: true
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."
title: "Strings Can Be Null"
type: "boolean"
true_values:
default:
- "y"
- "yes"
- "t"
- "true"
- "on"
- "1"
description: "A set of case-sensitive strings that should be\
\ interpreted as true values."
items:
type: "string"
title: "True Values"
type: "array"
uniqueItems: true
required:
- "filetype"
title: "CSV Format"
type: "object"
- properties:
filetype:
const: "jsonl"
default: "jsonl"
title: "Filetype"
type: "string"
enum:
- "jsonl"
required:
- "filetype"
title: "Jsonl Format"
type: "object"
- properties:
decimal_as_float:
default: false
description: "Whether to convert decimal fields to floats. There\
\ is a loss of precision when converting decimals to floats,\
\ so this is not recommended."
title: "Convert Decimal Fields to Floats"
type: "boolean"
filetype:
const: "parquet"
default: "parquet"
title: "Filetype"
type: "string"
enum:
- "parquet"
required:
- "filetype"
title: "Parquet Format"
type: "object"
- description: "Extract text from document formats (.pdf, .docx, .md,\
\ .pptx) and emit as one record per file."
properties:
filetype:
const: "unstructured"
default: "unstructured"
title: "Filetype"
type: "string"
enum:
- "unstructured"
processing:
default:
mode: "local"
description: "Processing configuration"
oneOf:
- description: "Process files locally, supporting `fast` and\
\ `ocr` modes. This is the default option."
properties:
mode:
const: "local"
default: "local"
enum:
- "local"
title: "Mode"
type: "string"
required:
- "mode"
title: "Local"
type: "object"
title: "Processing"
type: "object"
skip_unprocessable_files:
always_show: true
default: true
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."
title: "Skip Unprocessable Files"
type: "boolean"
strategy:
always_show: true
default: "auto"
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"
enum:
- "auto"
- "fast"
- "ocr_only"
- "hi_res"
order: 0
title: "Parsing Strategy"
type: "string"
required:
- "filetype"
title: "Unstructured Document Format"
type: "object"
- properties:
filetype:
const: "excel"
default: "excel"
title: "Filetype"
type: "string"
enum:
- "excel"
required:
- "filetype"
title: "Excel Format"
type: "object"
title: "Format"
type: "object"
globs:
default:
- "**"
description: "The pattern used to specify which files should be selected\
\ from the file system. For more information on glob pattern matching\
\ look here."
items:
type: "string"
order: 1
title: "Globs"
type: "array"
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."
title: "Input Schema"
type: "string"
name:
description: "The name of the stream."
title: "Name"
type: "string"
recent_n_files_to_read_for_schema_discovery:
description: "The number of resent files which will be used to discover\
\ the schema for this stream."
exclusiveMinimum: 0
title: "Files To Read For Schema Discover"
type: "integer"
schemaless:
default: false
description: "When enabled, syncs will not validate or structure records\
\ against the stream's schema."
title: "Schemaless"
type: "boolean"
validation_policy:
default: "Emit Record"
description: "The name of the validation policy that dictates sync\
\ behavior when a record does not adhere to the stream schema."
enum:
- "Emit Record"
- "Skip Record"
- "Wait for Discover"
title: "Validation Policy"
required:
- "name"
- "format"
title: "FileBasedStreamConfig"
type: "object"
order: 10
title: "The list of streams to sync"
type: "array"
sourceType:
title: "google-drive"
const: "google-drive"
enum:
- "google-drive"
order: 0
type: "string"
required:
- "streams"
- "folder_url"
- "credentials"
- "sourceType"
title: "Google Drive Source Spec"
type: "object"
source-google-drive-update:
description: "Used during spec; allows the developer to configure the cloud\
\ provider specific options\nthat are needed when users configure a file-based\
\ source."
properties:
credentials:
description: "Credentials for connecting to the Google Drive API"
oneOf:
- properties:
auth_type:
const: "Client"
default: "Client"
enum:
- "Client"
title: "Auth Type"
type: "string"
client_id:
airbyte_secret: true
description: "Client ID for the Google Drive API"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Client Secret for the Google Drive API"
title: "Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "Refresh Token for the Google Drive API"
title: "Refresh Token"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "auth_type"
title: "Authenticate via Google (OAuth)"
type: "object"
- properties:
auth_type:
const: "Service"
default: "Service"
enum:
- "Service"
title: "Auth Type"
type: "string"
service_account_info:
airbyte_secret: true
description: "The JSON key of the service account to use for authorization.\
\ Read more here."
title: "Service Account Information"
type: "string"
required:
- "service_account_info"
- "auth_type"
title: "Service Account Key Authentication"
type: "object"
title: "Authentication"
type: "object"
delivery_method:
default: "use_records_transfer"
display_type: "radio"
group: "advanced"
oneOf:
- description: "Recommended - Extract and load structured records into your\
\ destination of choice. This is the classic method of moving data in\
\ Airbyte. It allows for blocking and hashing individual fields or files\
\ from a structured schema. Data can be flattened, typed and deduped\
\ depending on the destination."
properties:
delivery_type:
const: "use_records_transfer"
default: "use_records_transfer"
enum:
- "use_records_transfer"
title: "Delivery Type"
type: "string"
required:
- "delivery_type"
title: "Replicate Records"
type: "object"
- description: "Copy raw files without parsing their contents. Bits are\
\ copied into the destination exactly as they appeared in the source.\
\ Recommended for use with unstructured text data, non-text and compressed\
\ files."
properties:
delivery_type:
const: "use_file_transfer"
default: "use_file_transfer"
enum:
- "use_file_transfer"
title: "Delivery Type"
type: "string"
preserve_directory_structure:
default: true
description: "If enabled, sends subdirectory folder structure along\
\ with source file names to the destination. Otherwise, files will\
\ be synced by their names only. This option is ignored when file-based\
\ replication is not enabled."
title: "Preserve Sub-Directories in File Paths"
type: "boolean"
required:
- "delivery_type"
title: "Copy Raw Files"
type: "object"
- description: "Sends one identity stream and one for more permissions (ACL)\
\ streams to the destination. This data can be used in downstream systems\
\ to recreate permission restrictions mirroring the original source."
properties:
delivery_type:
const: "use_permissions_transfer"
default: "use_permissions_transfer"
enum:
- "use_permissions_transfer"
title: "Delivery Type"
type: "string"
domain:
airbyte_hidden: false
description: "The Google domain of the identities."
order: 1
title: "Domain"
type: "string"
include_identities_stream:
default: true
description: "This data can be used in downstream systems to recreate\
\ permission restrictions mirroring the original source"
title: "Include Identity Stream"
type: "boolean"
required:
- "delivery_type"
title: "Replicate Permissions ACL"
type: "object"
order: 1
title: "Delivery Method"
type: "object"
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"
title: "Folder Url"
type: "string"
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"
order: 1
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"
title: "Start Date"
type: "string"
streams:
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."
items:
properties:
days_to_sync_if_history_is_full:
default: 3
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."
title: "Days To Sync If History Is Full"
type: "integer"
format:
description: "The configuration options that are used to alter how\
\ to read incoming files that deviate from the standard formatting."
oneOf:
- properties:
double_as_string:
default: false
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."
title: "Convert Double Fields to Strings"
type: "boolean"
filetype:
const: "avro"
default: "avro"
title: "Filetype"
type: "string"
enum:
- "avro"
required:
- "filetype"
title: "Avro Format"
type: "object"
- properties:
delimiter:
default: ","
description: "The character delimiting individual cells in the\
\ CSV data. This may only be a 1-character string. For tab-delimited\
\ data enter '\\t'."
title: "Delimiter"
type: "string"
double_quote:
default: true
description: "Whether two quotes in a quoted CSV value denote\
\ a single quote in the data."
title: "Double Quote"
type: "boolean"
encoding:
default: "utf8"
description: "The character encoding of the CSV data. Leave\
\ blank to default to UTF8. See list of python encodings for allowable\
\ options."
title: "Encoding"
type: "string"
escape_char:
description: "The character used for escaping special characters.\
\ To disallow escaping, leave this field blank."
title: "Escape Character"
type: "string"
false_values:
default:
- "n"
- "no"
- "f"
- "false"
- "off"
- "0"
description: "A set of case-sensitive strings that should be\
\ interpreted as false values."
items:
type: "string"
title: "False Values"
type: "array"
uniqueItems: true
filetype:
const: "csv"
default: "csv"
title: "Filetype"
type: "string"
enum:
- "csv"
header_definition:
default:
header_definition_type: "From CSV"
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."
oneOf:
- properties:
header_definition_type:
const: "From CSV"
default: "From CSV"
title: "Header Definition Type"
type: "string"
enum:
- "From CSV"
required:
- "header_definition_type"
title: "From CSV"
type: "object"
- properties:
header_definition_type:
const: "Autogenerated"
default: "Autogenerated"
title: "Header Definition Type"
type: "string"
enum:
- "Autogenerated"
required:
- "header_definition_type"
title: "Autogenerated"
type: "object"
- properties:
column_names:
description: "The column names that will be used while\
\ emitting the CSV records"
items:
type: "string"
title: "Column Names"
type: "array"
header_definition_type:
const: "User Provided"
default: "User Provided"
title: "Header Definition Type"
type: "string"
enum:
- "User Provided"
required:
- "column_names"
- "header_definition_type"
title: "User Provided"
type: "object"
title: "CSV Header Definition"
type: "object"
ignore_errors_on_fields_mismatch:
default: false
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."
title: "Ignore errors on field mismatch"
type: "boolean"
null_values:
default: []
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."
items:
type: "string"
title: "Null Values"
type: "array"
uniqueItems: true
quote_char:
default: "\""
description: "The character used for quoting CSV values. To\
\ disallow quoting, make this field blank."
title: "Quote Character"
type: "string"
skip_rows_after_header:
default: 0
description: "The number of rows to skip after the header row."
title: "Skip Rows After Header"
type: "integer"
skip_rows_before_header:
default: 0
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."
title: "Skip Rows Before Header"
type: "integer"
strings_can_be_null:
default: true
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."
title: "Strings Can Be Null"
type: "boolean"
true_values:
default:
- "y"
- "yes"
- "t"
- "true"
- "on"
- "1"
description: "A set of case-sensitive strings that should be\
\ interpreted as true values."
items:
type: "string"
title: "True Values"
type: "array"
uniqueItems: true
required:
- "filetype"
title: "CSV Format"
type: "object"
- properties:
filetype:
const: "jsonl"
default: "jsonl"
title: "Filetype"
type: "string"
enum:
- "jsonl"
required:
- "filetype"
title: "Jsonl Format"
type: "object"
- properties:
decimal_as_float:
default: false
description: "Whether to convert decimal fields to floats. There\
\ is a loss of precision when converting decimals to floats,\
\ so this is not recommended."
title: "Convert Decimal Fields to Floats"
type: "boolean"
filetype:
const: "parquet"
default: "parquet"
title: "Filetype"
type: "string"
enum:
- "parquet"
required:
- "filetype"
title: "Parquet Format"
type: "object"
- description: "Extract text from document formats (.pdf, .docx, .md,\
\ .pptx) and emit as one record per file."
properties:
filetype:
const: "unstructured"
default: "unstructured"
title: "Filetype"
type: "string"
enum:
- "unstructured"
processing:
default:
mode: "local"
description: "Processing configuration"
oneOf:
- description: "Process files locally, supporting `fast` and\
\ `ocr` modes. This is the default option."
properties:
mode:
const: "local"
default: "local"
enum:
- "local"
title: "Mode"
type: "string"
required:
- "mode"
title: "Local"
type: "object"
title: "Processing"
type: "object"
skip_unprocessable_files:
always_show: true
default: true
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."
title: "Skip Unprocessable Files"
type: "boolean"
strategy:
always_show: true
default: "auto"
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"
enum:
- "auto"
- "fast"
- "ocr_only"
- "hi_res"
order: 0
title: "Parsing Strategy"
type: "string"
required:
- "filetype"
title: "Unstructured Document Format"
type: "object"
- properties:
filetype:
const: "excel"
default: "excel"
title: "Filetype"
type: "string"
enum:
- "excel"
required:
- "filetype"
title: "Excel Format"
type: "object"
title: "Format"
type: "object"
globs:
default:
- "**"
description: "The pattern used to specify which files should be selected\
\ from the file system. For more information on glob pattern matching\
\ look here."
items:
type: "string"
order: 1
title: "Globs"
type: "array"
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."
title: "Input Schema"
type: "string"
name:
description: "The name of the stream."
title: "Name"
type: "string"
recent_n_files_to_read_for_schema_discovery:
description: "The number of resent files which will be used to discover\
\ the schema for this stream."
exclusiveMinimum: 0
title: "Files To Read For Schema Discover"
type: "integer"
schemaless:
default: false
description: "When enabled, syncs will not validate or structure records\
\ against the stream's schema."
title: "Schemaless"
type: "boolean"
validation_policy:
default: "Emit Record"
description: "The name of the validation policy that dictates sync\
\ behavior when a record does not adhere to the stream schema."
enum:
- "Emit Record"
- "Skip Record"
- "Wait for Discover"
title: "Validation Policy"
required:
- "name"
- "format"
title: "FileBasedStreamConfig"
type: "object"
order: 10
title: "The list of streams to sync"
type: "array"
required:
- "streams"
- "folder_url"
- "credentials"
title: "Google Drive Source Spec"
type: "object"
source-mailjet-sms:
properties:
end_date:
description: "Retrieve SMS messages created before the specified timestamp.\
\ Required format - Unix timestamp."
examples:
- 1666281656
order: 0
pattern: "^[0-9]*$"
title: "End date"
type: "integer"
start_date:
description: "Retrieve SMS messages created after the specified timestamp.\
\ Required format - Unix timestamp."
examples:
- 1666261656
order: 1
pattern: "^[0-9]*$"
title: "Start date"
type: "integer"
token:
airbyte_secret: true
description: "Your access token. See here."
order: 2
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "mailjet-sms"
const: "mailjet-sms"
enum:
- "mailjet-sms"
order: 0
type: "string"
required:
- "token"
- "sourceType"
type: "object"
source-mailjet-sms-update:
properties:
end_date:
description: "Retrieve SMS messages created before the specified timestamp.\
\ Required format - Unix timestamp."
examples:
- 1666281656
order: 0
pattern: "^[0-9]*$"
title: "End date"
type: "integer"
start_date:
description: "Retrieve SMS messages created after the specified timestamp.\
\ Required format - Unix timestamp."
examples:
- 1666261656
order: 1
pattern: "^[0-9]*$"
title: "Start date"
type: "integer"
token:
airbyte_secret: true
description: "Your access token. See here."
order: 2
title: "Access Token"
type: "string"
required:
- "token"
type: "object"
source-pabbly-subscriptions-billing:
properties:
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
username:
order: 0
title: "Username"
type: "string"
sourceType:
title: "pabbly-subscriptions-billing"
const: "pabbly-subscriptions-billing"
enum:
- "pabbly-subscriptions-billing"
order: 0
type: "string"
required:
- "username"
- "sourceType"
type: "object"
source-pabbly-subscriptions-billing-update:
properties:
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
username:
order: 0
title: "Username"
type: "string"
required:
- "username"
type: "object"
source-chameleon:
properties:
api_key:
airbyte_secret: true
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
end_date:
description: "End date for incremental sync"
format: "date-time"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "End date"
type: "string"
filter:
default: "tour"
description: "Filter for using in the `segments_experiences` stream"
enum:
- "tour"
- "survey"
- "launcher"
order: 3
title: "Filter"
type: "string"
limit:
default: "50"
description: "Max records per page limit"
order: 2
title: "Limit"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "chameleon"
const: "chameleon"
enum:
- "chameleon"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-chameleon-update:
properties:
api_key:
airbyte_secret: true
name: "api_key"
order: 0
title: "API Key"
type: "string"
end_date:
description: "End date for incremental sync"
format: "date-time"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "End date"
type: "string"
filter:
default: "tour"
description: "Filter for using in the `segments_experiences` stream"
enum:
- "tour"
- "survey"
- "launcher"
order: 3
title: "Filter"
type: "string"
limit:
default: "50"
description: "Max records per page limit"
order: 2
title: "Limit"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-shopwired:
properties:
api_key:
airbyte_secret: true
description: "Your API Key, which acts as the username for Basic Authentication.\
\ You can find it in your ShopWired account under API settings."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
api_secret:
airbyte_secret: true
description: "Your API Secret, which acts as the password for Basic Authentication.\
\ You can find it in your ShopWired account under API settings."
name: "api_secret"
order: 1
title: "API Secret"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "shopwired"
const: "shopwired"
enum:
- "shopwired"
order: 0
type: "string"
required:
- "api_key"
- "api_secret"
- "start_date"
- "sourceType"
type: "object"
source-shopwired-update:
properties:
api_key:
airbyte_secret: true
description: "Your API Key, which acts as the username for Basic Authentication.\
\ You can find it in your ShopWired account under API settings."
name: "api_key"
order: 0
title: "API Key"
type: "string"
api_secret:
airbyte_secret: true
description: "Your API Secret, which acts as the password for Basic Authentication.\
\ You can find it in your ShopWired account under API settings."
name: "api_secret"
order: 1
title: "API Secret"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "api_secret"
- "start_date"
type: "object"
source-100ms:
properties:
management_token:
airbyte_secret: true
description: "The management token used for authenticating API requests.\
\ You can find or generate this token in your 100ms dashboard under the\
\ API section. Refer to the documentation at https://www.100ms.live/docs/concepts/v2/concepts/security-and-tokens#management-token-for-rest-api\
\ for more details."
name: "management_token"
order: 0
title: "Management Token"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "100ms"
const: "100ms"
enum:
- "100ms"
order: 0
type: "string"
required:
- "management_token"
- "start_date"
- "sourceType"
type: "object"
source-100ms-update:
properties:
management_token:
airbyte_secret: true
description: "The management token used for authenticating API requests.\
\ You can find or generate this token in your 100ms dashboard under the\
\ API section. Refer to the documentation at https://www.100ms.live/docs/concepts/v2/concepts/security-and-tokens#management-token-for-rest-api\
\ for more details."
name: "management_token"
order: 0
title: "Management Token"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "management_token"
- "start_date"
type: "object"
source-campaign-monitor:
properties:
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "Date from when the sync should start"
order: 2
title: "start_date"
type: "string"
username:
order: 0
title: "Username"
type: "string"
sourceType:
title: "campaign-monitor"
const: "campaign-monitor"
enum:
- "campaign-monitor"
order: 0
type: "string"
required:
- "username"
- "sourceType"
type: "object"
source-campaign-monitor-update:
properties:
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
start_date:
description: "Date from when the sync should start"
order: 2
title: "start_date"
type: "string"
username:
order: 0
title: "Username"
type: "string"
required:
- "username"
type: "object"
source-gcs:
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."
properties:
bucket:
description: "Name of the GCS bucket where the file(s) exist."
order: 2
title: "Bucket"
type: "string"
credentials:
description: "Credentials for connecting to the Google Cloud Storage API"
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access Token"
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "Client"
default: "Client"
enum:
- "Client"
title: "Auth Type"
type: "string"
client_id:
airbyte_secret: true
description: "Client ID"
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "Client Secret"
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "Access Token"
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "client_id"
- "client_secret"
- "access_token"
- "refresh_token"
title: "Authenticate via Google (OAuth)"
type: "object"
- properties:
auth_type:
const: "Service"
default: "Service"
enum:
- "Service"
title: "Auth Type"
type: "string"
service_account:
airbyte_secret: true
description: "Enter your Google Cloud service account key in JSON format"
title: "Service Account Information."
type: "string"
x-speakeasy-param-sensitive: true
required:
- "service_account"
title: "Service Account Authentication."
type: "object"
order: 0
title: "Authentication"
type: "object"
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"
order: 1
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"
title: "Start Date"
type: "string"
streams:
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."
items:
properties:
days_to_sync_if_history_is_full:
default: 3
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."
title: "Days To Sync If History Is Full"
type: "integer"
format:
description: "The configuration options that are used to alter how\
\ to read incoming files that deviate from the standard formatting."
oneOf:
- properties:
double_as_string:
default: false
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."
title: "Convert Double Fields to Strings"
type: "boolean"
filetype:
const: "avro"
default: "avro"
title: "Filetype"
type: "string"
enum:
- "avro"
required:
- "filetype"
title: "Avro Format"
type: "object"
- properties:
delimiter:
default: ","
description: "The character delimiting individual cells in the\
\ CSV data. This may only be a 1-character string. For tab-delimited\
\ data enter '\\t'."
title: "Delimiter"
type: "string"
double_quote:
default: true
description: "Whether two quotes in a quoted CSV value denote\
\ a single quote in the data."
title: "Double Quote"
type: "boolean"
encoding:
default: "utf8"
description: "The character encoding of the CSV data. Leave\
\ blank to default to UTF8. See list of python encodings for allowable\
\ options."
title: "Encoding"
type: "string"
escape_char:
description: "The character used for escaping special characters.\
\ To disallow escaping, leave this field blank."
title: "Escape Character"
type: "string"
false_values:
default:
- "n"
- "no"
- "f"
- "false"
- "off"
- "0"
description: "A set of case-sensitive strings that should be\
\ interpreted as false values."
items:
type: "string"
title: "False Values"
type: "array"
uniqueItems: true
filetype:
const: "csv"
default: "csv"
title: "Filetype"
type: "string"
enum:
- "csv"
header_definition:
default:
header_definition_type: "From CSV"
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."
oneOf:
- properties:
header_definition_type:
const: "From CSV"
default: "From CSV"
title: "Header Definition Type"
type: "string"
enum:
- "From CSV"
required:
- "header_definition_type"
title: "From CSV"
type: "object"
- properties:
header_definition_type:
const: "Autogenerated"
default: "Autogenerated"
title: "Header Definition Type"
type: "string"
enum:
- "Autogenerated"
required:
- "header_definition_type"
title: "Autogenerated"
type: "object"
- properties:
column_names:
description: "The column names that will be used while\
\ emitting the CSV records"
items:
type: "string"
title: "Column Names"
type: "array"
header_definition_type:
const: "User Provided"
default: "User Provided"
title: "Header Definition Type"
type: "string"
enum:
- "User Provided"
required:
- "column_names"
- "header_definition_type"
title: "User Provided"
type: "object"
title: "CSV Header Definition"
type: "object"
ignore_errors_on_fields_mismatch:
default: false
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."
title: "Ignore errors on field mismatch"
type: "boolean"
null_values:
default: []
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."
items:
type: "string"
title: "Null Values"
type: "array"
uniqueItems: true
quote_char:
default: "\""
description: "The character used for quoting CSV values. To\
\ disallow quoting, make this field blank."
title: "Quote Character"
type: "string"
skip_rows_after_header:
default: 0
description: "The number of rows to skip after the header row."
title: "Skip Rows After Header"
type: "integer"
skip_rows_before_header:
default: 0
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."
title: "Skip Rows Before Header"
type: "integer"
strings_can_be_null:
default: true
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."
title: "Strings Can Be Null"
type: "boolean"
true_values:
default:
- "y"
- "yes"
- "t"
- "true"
- "on"
- "1"
description: "A set of case-sensitive strings that should be\
\ interpreted as true values."
items:
type: "string"
title: "True Values"
type: "array"
uniqueItems: true
required:
- "filetype"
title: "CSV Format"
type: "object"
- properties:
filetype:
const: "jsonl"
default: "jsonl"
title: "Filetype"
type: "string"
enum:
- "jsonl"
required:
- "filetype"
title: "Jsonl Format"
type: "object"
- properties:
decimal_as_float:
default: false
description: "Whether to convert decimal fields to floats. There\
\ is a loss of precision when converting decimals to floats,\
\ so this is not recommended."
title: "Convert Decimal Fields to Floats"
type: "boolean"
filetype:
const: "parquet"
default: "parquet"
title: "Filetype"
type: "string"
enum:
- "parquet"
required:
- "filetype"
title: "Parquet Format"
type: "object"
- description: "Extract text from document formats (.pdf, .docx, .md,\
\ .pptx) and emit as one record per file."
properties:
filetype:
const: "unstructured"
default: "unstructured"
title: "Filetype"
type: "string"
enum:
- "unstructured"
processing:
default:
mode: "local"
description: "Processing configuration"
oneOf:
- description: "Process files locally, supporting `fast` and\
\ `ocr` modes. This is the default option."
properties:
mode:
const: "local"
default: "local"
enum:
- "local"
title: "Mode"
type: "string"
required:
- "mode"
title: "Local"
type: "object"
- description: "Process files via an API, using the `hi_res`\
\ mode. This option is useful for increased performance\
\ and accuracy, but requires an API key and a hosted instance\
\ of unstructured."
properties:
api_key:
airbyte_secret: true
always_show: true
default: ""
description: "The API key to use matching the environment"
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
api_url:
always_show: true
default: "https://api.unstructured.io"
description: "The URL of the unstructured API to use"
examples:
- "https://api.unstructured.com"
title: "API URL"
type: "string"
mode:
const: "api"
default: "api"
enum:
- "api"
title: "Mode"
type: "string"
parameters:
always_show: true
default: []
description: "List of parameters send to the API"
items:
properties:
name:
description: "The name of the unstructured API parameter\
\ to use"
examples:
- "combine_under_n_chars"
- "languages"
title: "Parameter name"
type: "string"
value:
description: "The value of the parameter"
examples:
- "true"
- "hi_res"
title: "Value"
type: "string"
required:
- "name"
- "value"
title: "APIParameterConfigModel"
type: "object"
title: "Additional URL Parameters"
type: "array"
required:
- "mode"
title: "via API"
type: "object"
title: "Processing"
type: "object"
skip_unprocessable_files:
always_show: true
default: true
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."
title: "Skip Unprocessable Files"
type: "boolean"
strategy:
always_show: true
default: "auto"
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"
enum:
- "auto"
- "fast"
- "ocr_only"
- "hi_res"
order: 0
title: "Parsing Strategy"
type: "string"
required:
- "filetype"
title: "Unstructured Document Format"
type: "object"
- properties:
filetype:
const: "excel"
default: "excel"
title: "Filetype"
type: "string"
enum:
- "excel"
required:
- "filetype"
title: "Excel Format"
type: "object"
title: "Format"
type: "object"
globs:
default:
- "**"
description: "The pattern used to specify which files should be selected\
\ from the file system. For more information on glob pattern matching\
\ look here."
items:
type: "string"
order: 1
title: "Globs"
type: "array"
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."
title: "Input Schema"
type: "string"
name:
description: "The name of the stream."
title: "Name"
type: "string"
recent_n_files_to_read_for_schema_discovery:
description: "The number of resent files which will be used to discover\
\ the schema for this stream."
exclusiveMinimum: 0
title: "Files To Read For Schema Discover"
type: "integer"
schemaless:
default: false
description: "When enabled, syncs will not validate or structure records\
\ against the stream's schema."
title: "Schemaless"
type: "boolean"
validation_policy:
default: "Emit Record"
description: "The name of the validation policy that dictates sync\
\ behavior when a record does not adhere to the stream schema."
enum:
- "Emit Record"
- "Skip Record"
- "Wait for Discover"
title: "Validation Policy"
required:
- "name"
- "format"
title: "FileBasedStreamConfig"
type: "object"
order: 10
title: "The list of streams to sync"
type: "array"
sourceType:
title: "gcs"
const: "gcs"
enum:
- "gcs"
order: 0
type: "string"
required:
- "streams"
- "credentials"
- "bucket"
- "sourceType"
title: "Config"
type: "object"
source-gcs-update:
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."
properties:
bucket:
description: "Name of the GCS bucket where the file(s) exist."
order: 2
title: "Bucket"
type: "string"
credentials:
description: "Credentials for connecting to the Google Cloud Storage API"
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access Token"
title: "Access Token"
type: "string"
auth_type:
const: "Client"
default: "Client"
enum:
- "Client"
title: "Auth Type"
type: "string"
client_id:
airbyte_secret: true
description: "Client ID"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Client Secret"
title: "Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "Access Token"
title: "Access Token"
type: "string"
required:
- "client_id"
- "client_secret"
- "access_token"
- "refresh_token"
title: "Authenticate via Google (OAuth)"
type: "object"
- properties:
auth_type:
const: "Service"
default: "Service"
enum:
- "Service"
title: "Auth Type"
type: "string"
service_account:
airbyte_secret: true
description: "Enter your Google Cloud service account key in JSON format"
title: "Service Account Information."
type: "string"
required:
- "service_account"
title: "Service Account Authentication."
type: "object"
order: 0
title: "Authentication"
type: "object"
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"
order: 1
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"
title: "Start Date"
type: "string"
streams:
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."
items:
properties:
days_to_sync_if_history_is_full:
default: 3
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."
title: "Days To Sync If History Is Full"
type: "integer"
format:
description: "The configuration options that are used to alter how\
\ to read incoming files that deviate from the standard formatting."
oneOf:
- properties:
double_as_string:
default: false
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."
title: "Convert Double Fields to Strings"
type: "boolean"
filetype:
const: "avro"
default: "avro"
title: "Filetype"
type: "string"
enum:
- "avro"
required:
- "filetype"
title: "Avro Format"
type: "object"
- properties:
delimiter:
default: ","
description: "The character delimiting individual cells in the\
\ CSV data. This may only be a 1-character string. For tab-delimited\
\ data enter '\\t'."
title: "Delimiter"
type: "string"
double_quote:
default: true
description: "Whether two quotes in a quoted CSV value denote\
\ a single quote in the data."
title: "Double Quote"
type: "boolean"
encoding:
default: "utf8"
description: "The character encoding of the CSV data. Leave\
\ blank to default to UTF8. See list of python encodings for allowable\
\ options."
title: "Encoding"
type: "string"
escape_char:
description: "The character used for escaping special characters.\
\ To disallow escaping, leave this field blank."
title: "Escape Character"
type: "string"
false_values:
default:
- "n"
- "no"
- "f"
- "false"
- "off"
- "0"
description: "A set of case-sensitive strings that should be\
\ interpreted as false values."
items:
type: "string"
title: "False Values"
type: "array"
uniqueItems: true
filetype:
const: "csv"
default: "csv"
title: "Filetype"
type: "string"
enum:
- "csv"
header_definition:
default:
header_definition_type: "From CSV"
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."
oneOf:
- properties:
header_definition_type:
const: "From CSV"
default: "From CSV"
title: "Header Definition Type"
type: "string"
enum:
- "From CSV"
required:
- "header_definition_type"
title: "From CSV"
type: "object"
- properties:
header_definition_type:
const: "Autogenerated"
default: "Autogenerated"
title: "Header Definition Type"
type: "string"
enum:
- "Autogenerated"
required:
- "header_definition_type"
title: "Autogenerated"
type: "object"
- properties:
column_names:
description: "The column names that will be used while\
\ emitting the CSV records"
items:
type: "string"
title: "Column Names"
type: "array"
header_definition_type:
const: "User Provided"
default: "User Provided"
title: "Header Definition Type"
type: "string"
enum:
- "User Provided"
required:
- "column_names"
- "header_definition_type"
title: "User Provided"
type: "object"
title: "CSV Header Definition"
type: "object"
ignore_errors_on_fields_mismatch:
default: false
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."
title: "Ignore errors on field mismatch"
type: "boolean"
null_values:
default: []
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."
items:
type: "string"
title: "Null Values"
type: "array"
uniqueItems: true
quote_char:
default: "\""
description: "The character used for quoting CSV values. To\
\ disallow quoting, make this field blank."
title: "Quote Character"
type: "string"
skip_rows_after_header:
default: 0
description: "The number of rows to skip after the header row."
title: "Skip Rows After Header"
type: "integer"
skip_rows_before_header:
default: 0
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."
title: "Skip Rows Before Header"
type: "integer"
strings_can_be_null:
default: true
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."
title: "Strings Can Be Null"
type: "boolean"
true_values:
default:
- "y"
- "yes"
- "t"
- "true"
- "on"
- "1"
description: "A set of case-sensitive strings that should be\
\ interpreted as true values."
items:
type: "string"
title: "True Values"
type: "array"
uniqueItems: true
required:
- "filetype"
title: "CSV Format"
type: "object"
- properties:
filetype:
const: "jsonl"
default: "jsonl"
title: "Filetype"
type: "string"
enum:
- "jsonl"
required:
- "filetype"
title: "Jsonl Format"
type: "object"
- properties:
decimal_as_float:
default: false
description: "Whether to convert decimal fields to floats. There\
\ is a loss of precision when converting decimals to floats,\
\ so this is not recommended."
title: "Convert Decimal Fields to Floats"
type: "boolean"
filetype:
const: "parquet"
default: "parquet"
title: "Filetype"
type: "string"
enum:
- "parquet"
required:
- "filetype"
title: "Parquet Format"
type: "object"
- description: "Extract text from document formats (.pdf, .docx, .md,\
\ .pptx) and emit as one record per file."
properties:
filetype:
const: "unstructured"
default: "unstructured"
title: "Filetype"
type: "string"
enum:
- "unstructured"
processing:
default:
mode: "local"
description: "Processing configuration"
oneOf:
- description: "Process files locally, supporting `fast` and\
\ `ocr` modes. This is the default option."
properties:
mode:
const: "local"
default: "local"
enum:
- "local"
title: "Mode"
type: "string"
required:
- "mode"
title: "Local"
type: "object"
- description: "Process files via an API, using the `hi_res`\
\ mode. This option is useful for increased performance\
\ and accuracy, but requires an API key and a hosted instance\
\ of unstructured."
properties:
api_key:
airbyte_secret: true
always_show: true
default: ""
description: "The API key to use matching the environment"
title: "API Key"
type: "string"
api_url:
always_show: true
default: "https://api.unstructured.io"
description: "The URL of the unstructured API to use"
examples:
- "https://api.unstructured.com"
title: "API URL"
type: "string"
mode:
const: "api"
default: "api"
enum:
- "api"
title: "Mode"
type: "string"
parameters:
always_show: true
default: []
description: "List of parameters send to the API"
items:
properties:
name:
description: "The name of the unstructured API parameter\
\ to use"
examples:
- "combine_under_n_chars"
- "languages"
title: "Parameter name"
type: "string"
value:
description: "The value of the parameter"
examples:
- "true"
- "hi_res"
title: "Value"
type: "string"
required:
- "name"
- "value"
title: "APIParameterConfigModel"
type: "object"
title: "Additional URL Parameters"
type: "array"
required:
- "mode"
title: "via API"
type: "object"
title: "Processing"
type: "object"
skip_unprocessable_files:
always_show: true
default: true
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."
title: "Skip Unprocessable Files"
type: "boolean"
strategy:
always_show: true
default: "auto"
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"
enum:
- "auto"
- "fast"
- "ocr_only"
- "hi_res"
order: 0
title: "Parsing Strategy"
type: "string"
required:
- "filetype"
title: "Unstructured Document Format"
type: "object"
- properties:
filetype:
const: "excel"
default: "excel"
title: "Filetype"
type: "string"
enum:
- "excel"
required:
- "filetype"
title: "Excel Format"
type: "object"
title: "Format"
type: "object"
globs:
default:
- "**"
description: "The pattern used to specify which files should be selected\
\ from the file system. For more information on glob pattern matching\
\ look here."
items:
type: "string"
order: 1
title: "Globs"
type: "array"
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."
title: "Input Schema"
type: "string"
name:
description: "The name of the stream."
title: "Name"
type: "string"
recent_n_files_to_read_for_schema_discovery:
description: "The number of resent files which will be used to discover\
\ the schema for this stream."
exclusiveMinimum: 0
title: "Files To Read For Schema Discover"
type: "integer"
schemaless:
default: false
description: "When enabled, syncs will not validate or structure records\
\ against the stream's schema."
title: "Schemaless"
type: "boolean"
validation_policy:
default: "Emit Record"
description: "The name of the validation policy that dictates sync\
\ behavior when a record does not adhere to the stream schema."
enum:
- "Emit Record"
- "Skip Record"
- "Wait for Discover"
title: "Validation Policy"
required:
- "name"
- "format"
title: "FileBasedStreamConfig"
type: "object"
order: 10
title: "The list of streams to sync"
type: "array"
required:
- "streams"
- "credentials"
- "bucket"
title: "Config"
type: "object"
source-statuspage:
properties:
api_key:
airbyte_secret: true
description: "Your API Key. See here."
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "statuspage"
const: "statuspage"
enum:
- "statuspage"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-statuspage-update:
properties:
api_key:
airbyte_secret: true
description: "Your API Key. See here."
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-basecamp:
properties:
account_id:
order: 0
title: "Account ID"
type: "number"
client_id:
airbyte_secret: true
order: 2
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_refresh_token_2:
airbyte_secret: true
order: 4
title: "Refresh token"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
order: 3
title: "Client secret"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "basecamp"
const: "basecamp"
enum:
- "basecamp"
order: 0
type: "string"
required:
- "account_id"
- "start_date"
- "client_id"
- "client_secret"
- "client_refresh_token_2"
- "sourceType"
type: "object"
source-basecamp-update:
properties:
account_id:
order: 0
title: "Account ID"
type: "number"
client_id:
airbyte_secret: true
order: 2
title: "Client ID"
type: "string"
client_refresh_token_2:
airbyte_secret: true
order: 4
title: "Refresh token"
type: "string"
client_secret:
airbyte_secret: true
order: 3
title: "Client secret"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "account_id"
- "start_date"
- "client_id"
- "client_secret"
- "client_refresh_token_2"
type: "object"
source-taboola:
properties:
account_id:
description: "The ID associated with your taboola account"
order: 2
title: "Account ID"
type: "string"
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "taboola"
const: "taboola"
enum:
- "taboola"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "account_id"
- "sourceType"
type: "object"
source-taboola-update:
properties:
account_id:
description: "The ID associated with your taboola account"
order: 2
title: "Account ID"
type: "string"
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
required:
- "client_id"
- "client_secret"
- "account_id"
type: "object"
source-qualaroo:
properties:
key:
airbyte_secret: true
description: "A Qualaroo token. See the docs for instructions on how to generate it."
order: 1
title: "API key"
type: "string"
x-speakeasy-param-sensitive: true
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:
- "2021-03-01T00:00:00.000Z"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$"
title: "Start Date"
type: "string"
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."
items:
pattern: "^[0-9]{1,8}$"
type: "string"
order: 3
title: "Qualaroo survey IDs"
type: "array"
token:
airbyte_secret: true
description: "A Qualaroo token. See the docs for instructions on how to generate it."
order: 0
title: "API token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "qualaroo"
const: "qualaroo"
enum:
- "qualaroo"
order: 0
type: "string"
required:
- "token"
- "key"
- "start_date"
- "sourceType"
type: "object"
source-qualaroo-update:
properties:
key:
airbyte_secret: true
description: "A Qualaroo token. See the docs for instructions on how to generate it."
order: 1
title: "API key"
type: "string"
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:
- "2021-03-01T00:00:00.000Z"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$"
title: "Start Date"
type: "string"
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."
items:
pattern: "^[0-9]{1,8}$"
type: "string"
order: 3
title: "Qualaroo survey IDs"
type: "array"
token:
airbyte_secret: true
description: "A Qualaroo token. See the docs for instructions on how to generate it."
order: 0
title: "API token"
type: "string"
required:
- "token"
- "key"
- "start_date"
type: "object"
source-phyllo:
properties:
client_id:
airbyte_secret: true
description: "Your Client ID for the Phyllo API. You can find this in the\
\ Phyllo Developer Dashboard under API credentials."
name: "client_id"
order: 0
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "Your Client Secret for the Phyllo API. You can find this in\
\ the Phyllo Developer Dashboard under API credentials."
name: "client_secret"
order: 2
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
environment:
default: "api"
description: "The environment for the API (e.g., 'api.sandbox', 'api.staging',\
\ 'api')"
enum:
- "api.sandbox"
- "api.staging"
- "api"
name: "environment"
order: 1
title: "Environment"
type: "string"
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "phyllo"
const: "phyllo"
enum:
- "phyllo"
order: 0
type: "string"
required:
- "client_id"
- "environment"
- "client_secret"
- "start_date"
- "sourceType"
type: "object"
source-phyllo-update:
properties:
client_id:
airbyte_secret: true
description: "Your Client ID for the Phyllo API. You can find this in the\
\ Phyllo Developer Dashboard under API credentials."
name: "client_id"
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Your Client Secret for the Phyllo API. You can find this in\
\ the Phyllo Developer Dashboard under API credentials."
name: "client_secret"
order: 2
title: "Client Secret"
type: "string"
environment:
default: "api"
description: "The environment for the API (e.g., 'api.sandbox', 'api.staging',\
\ 'api')"
enum:
- "api.sandbox"
- "api.staging"
- "api"
name: "environment"
order: 1
title: "Environment"
type: "string"
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "client_id"
- "environment"
- "client_secret"
- "start_date"
type: "object"
source-front:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
page_limit:
default: "50"
description: "Page limit for the responses"
order: 2
title: "Page limit"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "front"
const: "front"
enum:
- "front"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-front-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
page_limit:
default: "50"
description: "Page limit for the responses"
order: 2
title: "Page limit"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-gmail:
properties:
client_id:
airbyte_secret: true
name: "client_id"
order: 0
title: "OAuth Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_refresh_token:
airbyte_secret: true
order: 2
title: "Refresh token"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
name: "client_secret"
order: 1
title: "OAuth Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
include_spam_and_trash:
default: false
description: "Include drafts/messages from SPAM and TRASH in the results.\
\ Defaults to false."
order: 3
title: "Include Spam & Trash"
type: "boolean"
sourceType:
title: "gmail"
const: "gmail"
enum:
- "gmail"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "client_refresh_token"
- "sourceType"
type: "object"
source-gmail-update:
properties:
client_id:
airbyte_secret: true
name: "client_id"
order: 0
title: "OAuth Client ID"
type: "string"
client_refresh_token:
airbyte_secret: true
order: 2
title: "Refresh token"
type: "string"
client_secret:
airbyte_secret: true
name: "client_secret"
order: 1
title: "OAuth Client Secret"
type: "string"
include_spam_and_trash:
default: false
description: "Include drafts/messages from SPAM and TRASH in the results.\
\ Defaults to false."
order: 3
title: "Include Spam & Trash"
type: "boolean"
required:
- "client_id"
- "client_secret"
- "client_refresh_token"
type: "object"
source-ticktick:
properties:
authorization:
oneOf:
- properties:
auth_type:
const: "Oauth"
order: 0
type: "string"
enum:
- "Oauth"
client_access_token:
airbyte_secret: true
description: "Access token for making authenticated requests; filled\
\ after complete oauth2 flow."
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
client_id:
airbyte_secret: true
description: "The client ID of your Ticktick application. Read more\
\ here."
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The client secret of of your Ticktick application. application.\
\ Read more here."
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_type"
- "client_id"
- "client_secret"
title: "OAuth2"
type: "object"
- properties:
auth_type:
const: "Token"
order: 0
type: "string"
enum:
- "Token"
bearer_token:
airbyte_secret: true
description: "Access token for making authenticated requests; filled\
\ after complete oauth2 flow."
title: "Bearer Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_type"
- "bearer_token"
title: "Bearer Token (from Oauth2)"
type: "object"
title: "Authentication Type"
type: "object"
sourceType:
title: "ticktick"
const: "ticktick"
enum:
- "ticktick"
order: 0
type: "string"
type: "object"
source-ticktick-update:
properties:
authorization:
oneOf:
- properties:
auth_type:
const: "Oauth"
order: 0
type: "string"
enum:
- "Oauth"
client_access_token:
airbyte_secret: true
description: "Access token for making authenticated requests; filled\
\ after complete oauth2 flow."
title: "Access Token"
type: "string"
client_id:
airbyte_secret: true
description: "The client ID of your Ticktick application. Read more\
\ here."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The client secret of of your Ticktick application. application.\
\ Read more here."
title: "Client Secret"
type: "string"
required:
- "auth_type"
- "client_id"
- "client_secret"
title: "OAuth2"
type: "object"
- properties:
auth_type:
const: "Token"
order: 0
type: "string"
enum:
- "Token"
bearer_token:
airbyte_secret: true
description: "Access token for making authenticated requests; filled\
\ after complete oauth2 flow."
title: "Bearer Token"
type: "string"
required:
- "auth_type"
- "bearer_token"
title: "Bearer Token (from Oauth2)"
type: "object"
title: "Authentication Type"
type: "object"
type: "object"
source-trello:
properties:
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"
items:
pattern: "^[0-9a-fA-F]{24}$"
type: "string"
order: 3
title: "Trello Board IDs"
type: "array"
key:
airbyte_secret: true
description: "Trello API key. See the docs for instructions on how to generate it."
order: 0
title: "API key"
type: "string"
x-speakeasy-param-sensitive: true
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:
- "2021-03-01T00:00:00Z"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
token:
airbyte_secret: true
description: "Trello API token. See the docs for instructions on how to generate it."
order: 1
title: "API token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "trello"
const: "trello"
enum:
- "trello"
order: 0
type: "string"
required:
- "key"
- "token"
- "start_date"
- "sourceType"
type: "object"
source-trello-update:
properties:
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"
items:
pattern: "^[0-9a-fA-F]{24}$"
type: "string"
order: 3
title: "Trello Board IDs"
type: "array"
key:
airbyte_secret: true
description: "Trello API key. See the docs for instructions on how to generate it."
order: 0
title: "API key"
type: "string"
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:
- "2021-03-01T00:00:00Z"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
token:
airbyte_secret: true
description: "Trello API token. See the docs for instructions on how to generate it."
order: 1
title: "API token"
type: "string"
required:
- "key"
- "token"
- "start_date"
type: "object"
source-harvest:
properties:
account_id:
airbyte_secret: true
description: "Harvest account ID. Required for all Harvest requests in pair\
\ with Personal Access Token"
order: 0
title: "Account ID"
type: "string"
x-speakeasy-param-sensitive: true
credentials:
description: "Choose how to authenticate to Harvest."
oneOf:
- additionalProperties: true
properties:
auth_type:
const: "Client"
order: 0
type: "string"
enum:
- "Client"
client_id:
description: "The Client ID of your Harvest developer application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Harvest developer application."
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "Refresh Token to renew the expired Access Token."
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "client_id"
- "client_secret"
- "refresh_token"
title: "Authenticate via Harvest (OAuth)"
type: "object"
- additionalProperties: true
properties:
api_token:
airbyte_secret: true
description: "Log into Harvest and then create new personal access token."
title: "Personal Access Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "Token"
order: 0
type: "string"
enum:
- "Token"
required:
- "api_token"
title: "Authenticate with Personal Access Token"
type: "object"
order: 3
title: "Authentication mechanism"
type: "object"
replication_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:
- "2017-01-25T00:00:00Z"
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
sourceType:
title: "harvest"
const: "harvest"
enum:
- "harvest"
order: 0
type: "string"
required:
- "account_id"
- "replication_start_date"
- "sourceType"
type: "object"
source-harvest-update:
properties:
account_id:
airbyte_secret: true
description: "Harvest account ID. Required for all Harvest requests in pair\
\ with Personal Access Token"
order: 0
title: "Account ID"
type: "string"
credentials:
description: "Choose how to authenticate to Harvest."
oneOf:
- additionalProperties: true
properties:
auth_type:
const: "Client"
order: 0
type: "string"
enum:
- "Client"
client_id:
description: "The Client ID of your Harvest developer application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Harvest developer application."
title: "Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "Refresh Token to renew the expired Access Token."
title: "Refresh Token"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
title: "Authenticate via Harvest (OAuth)"
type: "object"
- additionalProperties: true
properties:
api_token:
airbyte_secret: true
description: "Log into Harvest and then create new personal access token."
title: "Personal Access Token"
type: "string"
auth_type:
const: "Token"
order: 0
type: "string"
enum:
- "Token"
required:
- "api_token"
title: "Authenticate with Personal Access Token"
type: "object"
order: 3
title: "Authentication mechanism"
type: "object"
replication_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:
- "2017-01-25T00:00:00Z"
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
required:
- "account_id"
- "replication_start_date"
type: "object"
source-sendowl:
properties:
password:
airbyte_secret: true
always_show: true
description: "Enter your API secret"
order: 1
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
username:
description: "Enter you API Key"
order: 0
title: "Username"
type: "string"
sourceType:
title: "sendowl"
const: "sendowl"
enum:
- "sendowl"
order: 0
type: "string"
required:
- "username"
- "start_date"
- "sourceType"
type: "object"
source-sendowl-update:
properties:
password:
airbyte_secret: true
always_show: true
description: "Enter your API secret"
order: 1
title: "Password"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
username:
description: "Enter you API Key"
order: 0
title: "Username"
type: "string"
required:
- "username"
- "start_date"
type: "object"
source-getgist:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it in the Integration Settings on your\
\ Gist dashboard at https://app.getgist.com/projects/_/settings/api-key."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "getgist"
const: "getgist"
enum:
- "getgist"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-getgist-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it in the Integration Settings on your\
\ Gist dashboard at https://app.getgist.com/projects/_/settings/api-key."
name: "api_key"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-mailtrap:
properties:
api_token:
airbyte_secret: true
description: "API token to use. Find it at https://mailtrap.io/account"
name: "api_token"
order: 0
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "mailtrap"
const: "mailtrap"
enum:
- "mailtrap"
order: 0
type: "string"
required:
- "api_token"
- "sourceType"
type: "object"
source-mailtrap-update:
properties:
api_token:
airbyte_secret: true
description: "API token to use. Find it at https://mailtrap.io/account"
name: "api_token"
order: 0
title: "API Token"
type: "string"
required:
- "api_token"
type: "object"
source-sharepoint-enterprise:
description: "SourceMicrosoftSharePointSpec class for Microsoft SharePoint Source\
\ Specification.\nThis class combines the authentication details with additional\
\ configuration for the SharePoint API."
properties:
credentials:
description: "Credentials for connecting to the One Drive API"
oneOf:
- description: "OAuthCredentials class to hold authentication details for\
\ Microsoft OAuth authentication.\nThis class uses pydantic for data\
\ validation and settings management."
properties:
auth_type:
const: "Client"
default: "Client"
enum:
- "Client"
title: "Auth Type"
type: "string"
client_id:
airbyte_secret: true
description: "Client ID of your Microsoft developer application"
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "Client Secret of your Microsoft developer application"
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "Refresh Token of your Microsoft developer application"
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
scopes:
default: "offline_access Files.Read.All Sites.Read.All Sites.Selected\
\ User.Read.All Group.Read.All Application.Read.All Device.Read.All"
description: "Scopes to request when authorizing. If you want to change\
\ scopes after source was created, you need to Re-authenticate to\
\ actually apply this change to your access token. "
title: "Scopes"
type: "string"
tenant_id:
airbyte_secret: true
description: "Tenant ID of the Microsoft SharePoint user"
title: "Tenant ID"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tenant_id"
- "client_id"
- "client_secret"
title: "Authenticate via Microsoft (OAuth)"
type: "object"
- description: "ServiceCredentials class for service key authentication.\n\
This class is structured similarly to OAuthCredentials but for a different\
\ authentication method."
properties:
auth_type:
const: "Service"
default: "Service"
enum:
- "Service"
title: "Auth Type"
type: "string"
client_id:
airbyte_secret: true
description: "Client ID of your Microsoft developer application"
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "Client Secret of your Microsoft developer application"
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
tenant_id:
airbyte_secret: true
description: "Tenant ID of the Microsoft SharePoint user"
title: "Tenant ID"
type: "string"
x-speakeasy-param-sensitive: true
user_principal_name:
airbyte_secret: true
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"
title: "User Principal Name"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tenant_id"
- "user_principal_name"
- "client_id"
- "client_secret"
title: "Service Key Authentication"
type: "object"
order: 0
title: "Authentication"
type: "object"
delivery_method:
default: "use_records_transfer"
display_type: "radio"
group: "advanced"
oneOf:
- description: "Recommended - Extract and load structured records into your\
\ destination of choice. This is the classic method of moving data in\
\ Airbyte. It allows for blocking and hashing individual fields or files\
\ from a structured schema. Data can be flattened, typed and deduped\
\ depending on the destination."
properties:
delivery_type:
const: "use_records_transfer"
default: "use_records_transfer"
enum:
- "use_records_transfer"
title: "Delivery Type"
type: "string"
required:
- "delivery_type"
title: "Replicate Records"
type: "object"
- description: "Copy raw files without parsing their contents. Bits are\
\ copied into the destination exactly as they appeared in the source.\
\ Recommended for use with unstructured text data, non-text and compressed\
\ files."
properties:
delivery_type:
const: "use_file_transfer"
default: "use_file_transfer"
enum:
- "use_file_transfer"
title: "Delivery Type"
type: "string"
preserve_directory_structure:
default: true
description: "If enabled, sends subdirectory folder structure along\
\ with source file names to the destination. Otherwise, files will\
\ be synced by their names only. This option is ignored when file-based\
\ replication is not enabled."
title: "Preserve Sub-Directories in File Paths"
type: "boolean"
required:
- "delivery_type"
title: "Copy Raw Files"
type: "object"
- description: "Sends one identity stream and one for more permissions (ACL)\
\ streams to the destination. This data can be used in downstream systems\
\ to recreate permission restrictions mirroring the original source."
properties:
delivery_type:
const: "use_permissions_transfer"
default: "use_permissions_transfer"
enum:
- "use_permissions_transfer"
title: "Delivery Type"
type: "string"
include_identities_stream:
default: true
description: "This data can be used in downstream systems to recreate\
\ permission restrictions mirroring the original source"
title: "Include Identity Stream"
type: "boolean"
required:
- "delivery_type"
title: "Replicate Permissions ACL"
type: "object"
order: 1
title: "Delivery Method"
type: "object"
file_contains_query:
description: "Input additional query to search files. It will make search\
\ files step faster if your Sharepoint account has a lot of files and\
\ folders. This query text will be used in the request that will look\
\ for files which properties contains inserted text. You can use multiple\
\ query texts, they will be applied in search request one by one."
items:
type: "string"
order: 6
title: "File properties contains query text"
type: "array"
folder_path:
default: "."
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."
order: 4
title: "Folder Path"
type: "string"
search_scope:
default: "ALL"
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."
enum:
- "ACCESSIBLE_DRIVES"
- "SHARED_ITEMS"
- "ALL"
order: 3
title: "Search Scope"
type: "string"
site_url:
default: ""
description: "Url of SharePoint site to search for files. Leave empty to\
\ search in the main site. Use 'https://.sharepoint.com/sites/'\
\ to iterate over all sites."
order: 5
title: "Site URL"
type: "string"
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"
order: 1
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"
title: "Start Date"
type: "string"
streams:
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."
items:
properties:
days_to_sync_if_history_is_full:
default: 3
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."
title: "Days To Sync If History Is Full"
type: "integer"
format:
description: "The configuration options that are used to alter how\
\ to read incoming files that deviate from the standard formatting."
oneOf:
- properties:
double_as_string:
default: false
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."
title: "Convert Double Fields to Strings"
type: "boolean"
filetype:
const: "avro"
default: "avro"
title: "Filetype"
type: "string"
enum:
- "avro"
required:
- "filetype"
title: "Avro Format"
type: "object"
- properties:
delimiter:
default: ","
description: "The character delimiting individual cells in the\
\ CSV data. This may only be a 1-character string. For tab-delimited\
\ data enter '\\t'."
title: "Delimiter"
type: "string"
double_quote:
default: true
description: "Whether two quotes in a quoted CSV value denote\
\ a single quote in the data."
title: "Double Quote"
type: "boolean"
encoding:
default: "utf8"
description: "The character encoding of the CSV data. Leave\
\ blank to default to UTF8. See list of python encodings for allowable\
\ options."
title: "Encoding"
type: "string"
escape_char:
description: "The character used for escaping special characters.\
\ To disallow escaping, leave this field blank."
title: "Escape Character"
type: "string"
false_values:
default:
- "n"
- "no"
- "f"
- "false"
- "off"
- "0"
description: "A set of case-sensitive strings that should be\
\ interpreted as false values."
items:
type: "string"
title: "False Values"
type: "array"
uniqueItems: true
filetype:
const: "csv"
default: "csv"
title: "Filetype"
type: "string"
enum:
- "csv"
header_definition:
default:
header_definition_type: "From CSV"
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."
oneOf:
- properties:
header_definition_type:
const: "From CSV"
default: "From CSV"
title: "Header Definition Type"
type: "string"
enum:
- "From CSV"
required:
- "header_definition_type"
title: "From CSV"
type: "object"
- properties:
header_definition_type:
const: "Autogenerated"
default: "Autogenerated"
title: "Header Definition Type"
type: "string"
enum:
- "Autogenerated"
required:
- "header_definition_type"
title: "Autogenerated"
type: "object"
- properties:
column_names:
description: "The column names that will be used while\
\ emitting the CSV records"
items:
type: "string"
title: "Column Names"
type: "array"
header_definition_type:
const: "User Provided"
default: "User Provided"
title: "Header Definition Type"
type: "string"
enum:
- "User Provided"
required:
- "column_names"
- "header_definition_type"
title: "User Provided"
type: "object"
title: "CSV Header Definition"
type: "object"
ignore_errors_on_fields_mismatch:
default: false
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."
title: "Ignore errors on field mismatch"
type: "boolean"
null_values:
default: []
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."
items:
type: "string"
title: "Null Values"
type: "array"
uniqueItems: true
quote_char:
default: "\""
description: "The character used for quoting CSV values. To\
\ disallow quoting, make this field blank."
title: "Quote Character"
type: "string"
skip_rows_after_header:
default: 0
description: "The number of rows to skip after the header row."
title: "Skip Rows After Header"
type: "integer"
skip_rows_before_header:
default: 0
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."
title: "Skip Rows Before Header"
type: "integer"
strings_can_be_null:
default: true
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."
title: "Strings Can Be Null"
type: "boolean"
true_values:
default:
- "y"
- "yes"
- "t"
- "true"
- "on"
- "1"
description: "A set of case-sensitive strings that should be\
\ interpreted as true values."
items:
type: "string"
title: "True Values"
type: "array"
uniqueItems: true
required:
- "filetype"
title: "CSV Format"
type: "object"
- properties:
filetype:
const: "jsonl"
default: "jsonl"
title: "Filetype"
type: "string"
enum:
- "jsonl"
required:
- "filetype"
title: "Jsonl Format"
type: "object"
- properties:
decimal_as_float:
default: false
description: "Whether to convert decimal fields to floats. There\
\ is a loss of precision when converting decimals to floats,\
\ so this is not recommended."
title: "Convert Decimal Fields to Floats"
type: "boolean"
filetype:
const: "parquet"
default: "parquet"
title: "Filetype"
type: "string"
enum:
- "parquet"
required:
- "filetype"
title: "Parquet Format"
type: "object"
- description: "Extract text from document formats (.pdf, .docx, .md,\
\ .pptx) and emit as one record per file."
properties:
filetype:
const: "unstructured"
default: "unstructured"
title: "Filetype"
type: "string"
enum:
- "unstructured"
processing:
default:
mode: "local"
description: "Processing configuration"
oneOf:
- description: "Process files locally, supporting `fast` and\
\ `ocr` modes. This is the default option."
properties:
mode:
const: "local"
default: "local"
enum:
- "local"
title: "Mode"
type: "string"
required:
- "mode"
title: "Local"
type: "object"
title: "Processing"
type: "object"
skip_unprocessable_files:
always_show: true
default: true
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."
title: "Skip Unprocessable Files"
type: "boolean"
strategy:
always_show: true
default: "auto"
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"
enum:
- "auto"
- "fast"
- "ocr_only"
- "hi_res"
order: 0
title: "Parsing Strategy"
type: "string"
required:
- "filetype"
title: "Unstructured Document Format"
type: "object"
- properties:
filetype:
const: "excel"
default: "excel"
title: "Filetype"
type: "string"
enum:
- "excel"
required:
- "filetype"
title: "Excel Format"
type: "object"
title: "Format"
type: "object"
globs:
default:
- "**"
description: "The pattern used to specify which files should be selected\
\ from the file system. For more information on glob pattern matching\
\ look here."
items:
type: "string"
order: 1
title: "Globs"
type: "array"
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."
title: "Input Schema"
type: "string"
name:
description: "The name of the stream."
title: "Name"
type: "string"
recent_n_files_to_read_for_schema_discovery:
description: "The number of resent files which will be used to discover\
\ the schema for this stream."
exclusiveMinimum: 0
title: "Files To Read For Schema Discover"
type: "integer"
schemaless:
default: false
description: "When enabled, syncs will not validate or structure records\
\ against the stream's schema."
title: "Schemaless"
type: "boolean"
validation_policy:
default: "Emit Record"
description: "The name of the validation policy that dictates sync\
\ behavior when a record does not adhere to the stream schema."
enum:
- "Emit Record"
- "Skip Record"
- "Wait for Discover"
title: "Validation Policy"
required:
- "name"
- "format"
title: "FileBasedStreamConfig"
type: "object"
order: 10
title: "The list of streams to sync"
type: "array"
sourceType:
title: "sharepoint-enterprise"
const: "sharepoint-enterprise"
enum:
- "sharepoint-enterprise"
order: 0
type: "string"
required:
- "streams"
- "credentials"
- "sourceType"
title: "Microsoft SharePoint Source Spec"
type: "object"
source-sharepoint-enterprise-update:
description: "SourceMicrosoftSharePointSpec class for Microsoft SharePoint Source\
\ Specification.\nThis class combines the authentication details with additional\
\ configuration for the SharePoint API."
properties:
credentials:
description: "Credentials for connecting to the One Drive API"
oneOf:
- description: "OAuthCredentials class to hold authentication details for\
\ Microsoft OAuth authentication.\nThis class uses pydantic for data\
\ validation and settings management."
properties:
auth_type:
const: "Client"
default: "Client"
enum:
- "Client"
title: "Auth Type"
type: "string"
client_id:
airbyte_secret: true
description: "Client ID of your Microsoft developer application"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Client Secret of your Microsoft developer application"
title: "Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "Refresh Token of your Microsoft developer application"
title: "Refresh Token"
type: "string"
scopes:
default: "offline_access Files.Read.All Sites.Read.All Sites.Selected\
\ User.Read.All Group.Read.All Application.Read.All Device.Read.All"
description: "Scopes to request when authorizing. If you want to change\
\ scopes after source was created, you need to Re-authenticate to\
\ actually apply this change to your access token. "
title: "Scopes"
type: "string"
tenant_id:
airbyte_secret: true
description: "Tenant ID of the Microsoft SharePoint user"
title: "Tenant ID"
type: "string"
required:
- "tenant_id"
- "client_id"
- "client_secret"
title: "Authenticate via Microsoft (OAuth)"
type: "object"
- description: "ServiceCredentials class for service key authentication.\n\
This class is structured similarly to OAuthCredentials but for a different\
\ authentication method."
properties:
auth_type:
const: "Service"
default: "Service"
enum:
- "Service"
title: "Auth Type"
type: "string"
client_id:
airbyte_secret: true
description: "Client ID of your Microsoft developer application"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Client Secret of your Microsoft developer application"
title: "Client Secret"
type: "string"
tenant_id:
airbyte_secret: true
description: "Tenant ID of the Microsoft SharePoint user"
title: "Tenant ID"
type: "string"
user_principal_name:
airbyte_secret: true
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"
title: "User Principal Name"
type: "string"
required:
- "tenant_id"
- "user_principal_name"
- "client_id"
- "client_secret"
title: "Service Key Authentication"
type: "object"
order: 0
title: "Authentication"
type: "object"
delivery_method:
default: "use_records_transfer"
display_type: "radio"
group: "advanced"
oneOf:
- description: "Recommended - Extract and load structured records into your\
\ destination of choice. This is the classic method of moving data in\
\ Airbyte. It allows for blocking and hashing individual fields or files\
\ from a structured schema. Data can be flattened, typed and deduped\
\ depending on the destination."
properties:
delivery_type:
const: "use_records_transfer"
default: "use_records_transfer"
enum:
- "use_records_transfer"
title: "Delivery Type"
type: "string"
required:
- "delivery_type"
title: "Replicate Records"
type: "object"
- description: "Copy raw files without parsing their contents. Bits are\
\ copied into the destination exactly as they appeared in the source.\
\ Recommended for use with unstructured text data, non-text and compressed\
\ files."
properties:
delivery_type:
const: "use_file_transfer"
default: "use_file_transfer"
enum:
- "use_file_transfer"
title: "Delivery Type"
type: "string"
preserve_directory_structure:
default: true
description: "If enabled, sends subdirectory folder structure along\
\ with source file names to the destination. Otherwise, files will\
\ be synced by their names only. This option is ignored when file-based\
\ replication is not enabled."
title: "Preserve Sub-Directories in File Paths"
type: "boolean"
required:
- "delivery_type"
title: "Copy Raw Files"
type: "object"
- description: "Sends one identity stream and one for more permissions (ACL)\
\ streams to the destination. This data can be used in downstream systems\
\ to recreate permission restrictions mirroring the original source."
properties:
delivery_type:
const: "use_permissions_transfer"
default: "use_permissions_transfer"
enum:
- "use_permissions_transfer"
title: "Delivery Type"
type: "string"
include_identities_stream:
default: true
description: "This data can be used in downstream systems to recreate\
\ permission restrictions mirroring the original source"
title: "Include Identity Stream"
type: "boolean"
required:
- "delivery_type"
title: "Replicate Permissions ACL"
type: "object"
order: 1
title: "Delivery Method"
type: "object"
file_contains_query:
description: "Input additional query to search files. It will make search\
\ files step faster if your Sharepoint account has a lot of files and\
\ folders. This query text will be used in the request that will look\
\ for files which properties contains inserted text. You can use multiple\
\ query texts, they will be applied in search request one by one."
items:
type: "string"
order: 6
title: "File properties contains query text"
type: "array"
folder_path:
default: "."
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."
order: 4
title: "Folder Path"
type: "string"
search_scope:
default: "ALL"
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."
enum:
- "ACCESSIBLE_DRIVES"
- "SHARED_ITEMS"
- "ALL"
order: 3
title: "Search Scope"
type: "string"
site_url:
default: ""
description: "Url of SharePoint site to search for files. Leave empty to\
\ search in the main site. Use 'https://.sharepoint.com/sites/'\
\ to iterate over all sites."
order: 5
title: "Site URL"
type: "string"
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"
order: 1
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"
title: "Start Date"
type: "string"
streams:
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."
items:
properties:
days_to_sync_if_history_is_full:
default: 3
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."
title: "Days To Sync If History Is Full"
type: "integer"
format:
description: "The configuration options that are used to alter how\
\ to read incoming files that deviate from the standard formatting."
oneOf:
- properties:
double_as_string:
default: false
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."
title: "Convert Double Fields to Strings"
type: "boolean"
filetype:
const: "avro"
default: "avro"
title: "Filetype"
type: "string"
enum:
- "avro"
required:
- "filetype"
title: "Avro Format"
type: "object"
- properties:
delimiter:
default: ","
description: "The character delimiting individual cells in the\
\ CSV data. This may only be a 1-character string. For tab-delimited\
\ data enter '\\t'."
title: "Delimiter"
type: "string"
double_quote:
default: true
description: "Whether two quotes in a quoted CSV value denote\
\ a single quote in the data."
title: "Double Quote"
type: "boolean"
encoding:
default: "utf8"
description: "The character encoding of the CSV data. Leave\
\ blank to default to UTF8. See list of python encodings for allowable\
\ options."
title: "Encoding"
type: "string"
escape_char:
description: "The character used for escaping special characters.\
\ To disallow escaping, leave this field blank."
title: "Escape Character"
type: "string"
false_values:
default:
- "n"
- "no"
- "f"
- "false"
- "off"
- "0"
description: "A set of case-sensitive strings that should be\
\ interpreted as false values."
items:
type: "string"
title: "False Values"
type: "array"
uniqueItems: true
filetype:
const: "csv"
default: "csv"
title: "Filetype"
type: "string"
enum:
- "csv"
header_definition:
default:
header_definition_type: "From CSV"
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."
oneOf:
- properties:
header_definition_type:
const: "From CSV"
default: "From CSV"
title: "Header Definition Type"
type: "string"
enum:
- "From CSV"
required:
- "header_definition_type"
title: "From CSV"
type: "object"
- properties:
header_definition_type:
const: "Autogenerated"
default: "Autogenerated"
title: "Header Definition Type"
type: "string"
enum:
- "Autogenerated"
required:
- "header_definition_type"
title: "Autogenerated"
type: "object"
- properties:
column_names:
description: "The column names that will be used while\
\ emitting the CSV records"
items:
type: "string"
title: "Column Names"
type: "array"
header_definition_type:
const: "User Provided"
default: "User Provided"
title: "Header Definition Type"
type: "string"
enum:
- "User Provided"
required:
- "column_names"
- "header_definition_type"
title: "User Provided"
type: "object"
title: "CSV Header Definition"
type: "object"
ignore_errors_on_fields_mismatch:
default: false
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."
title: "Ignore errors on field mismatch"
type: "boolean"
null_values:
default: []
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."
items:
type: "string"
title: "Null Values"
type: "array"
uniqueItems: true
quote_char:
default: "\""
description: "The character used for quoting CSV values. To\
\ disallow quoting, make this field blank."
title: "Quote Character"
type: "string"
skip_rows_after_header:
default: 0
description: "The number of rows to skip after the header row."
title: "Skip Rows After Header"
type: "integer"
skip_rows_before_header:
default: 0
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."
title: "Skip Rows Before Header"
type: "integer"
strings_can_be_null:
default: true
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."
title: "Strings Can Be Null"
type: "boolean"
true_values:
default:
- "y"
- "yes"
- "t"
- "true"
- "on"
- "1"
description: "A set of case-sensitive strings that should be\
\ interpreted as true values."
items:
type: "string"
title: "True Values"
type: "array"
uniqueItems: true
required:
- "filetype"
title: "CSV Format"
type: "object"
- properties:
filetype:
const: "jsonl"
default: "jsonl"
title: "Filetype"
type: "string"
enum:
- "jsonl"
required:
- "filetype"
title: "Jsonl Format"
type: "object"
- properties:
decimal_as_float:
default: false
description: "Whether to convert decimal fields to floats. There\
\ is a loss of precision when converting decimals to floats,\
\ so this is not recommended."
title: "Convert Decimal Fields to Floats"
type: "boolean"
filetype:
const: "parquet"
default: "parquet"
title: "Filetype"
type: "string"
enum:
- "parquet"
required:
- "filetype"
title: "Parquet Format"
type: "object"
- description: "Extract text from document formats (.pdf, .docx, .md,\
\ .pptx) and emit as one record per file."
properties:
filetype:
const: "unstructured"
default: "unstructured"
title: "Filetype"
type: "string"
enum:
- "unstructured"
processing:
default:
mode: "local"
description: "Processing configuration"
oneOf:
- description: "Process files locally, supporting `fast` and\
\ `ocr` modes. This is the default option."
properties:
mode:
const: "local"
default: "local"
enum:
- "local"
title: "Mode"
type: "string"
required:
- "mode"
title: "Local"
type: "object"
title: "Processing"
type: "object"
skip_unprocessable_files:
always_show: true
default: true
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."
title: "Skip Unprocessable Files"
type: "boolean"
strategy:
always_show: true
default: "auto"
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"
enum:
- "auto"
- "fast"
- "ocr_only"
- "hi_res"
order: 0
title: "Parsing Strategy"
type: "string"
required:
- "filetype"
title: "Unstructured Document Format"
type: "object"
- properties:
filetype:
const: "excel"
default: "excel"
title: "Filetype"
type: "string"
enum:
- "excel"
required:
- "filetype"
title: "Excel Format"
type: "object"
title: "Format"
type: "object"
globs:
default:
- "**"
description: "The pattern used to specify which files should be selected\
\ from the file system. For more information on glob pattern matching\
\ look here."
items:
type: "string"
order: 1
title: "Globs"
type: "array"
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."
title: "Input Schema"
type: "string"
name:
description: "The name of the stream."
title: "Name"
type: "string"
recent_n_files_to_read_for_schema_discovery:
description: "The number of resent files which will be used to discover\
\ the schema for this stream."
exclusiveMinimum: 0
title: "Files To Read For Schema Discover"
type: "integer"
schemaless:
default: false
description: "When enabled, syncs will not validate or structure records\
\ against the stream's schema."
title: "Schemaless"
type: "boolean"
validation_policy:
default: "Emit Record"
description: "The name of the validation policy that dictates sync\
\ behavior when a record does not adhere to the stream schema."
enum:
- "Emit Record"
- "Skip Record"
- "Wait for Discover"
title: "Validation Policy"
required:
- "name"
- "format"
title: "FileBasedStreamConfig"
type: "object"
order: 10
title: "The list of streams to sync"
type: "array"
required:
- "streams"
- "credentials"
title: "Microsoft SharePoint Source Spec"
type: "object"
source-cloudbeds:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "cloudbeds"
const: "cloudbeds"
enum:
- "cloudbeds"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-cloudbeds-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-freshbooks:
properties:
account_id:
order: 3
title: "Account Id"
type: "string"
business_uuid:
order: 7
title: "Business uuid"
type: "string"
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_refresh_token:
airbyte_secret: true
order: 4
title: "Refresh token"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
x-speakeasy-param-sensitive: true
oauth_access_token:
airbyte_secret: true
description: "The current access token. This field might be overridden by\
\ the connector based on the token refresh endpoint response."
order: 5
title: "Access token"
type: "string"
x-speakeasy-param-sensitive: true
oauth_token_expiry_date:
description: "The date the current access token expires in. This field might\
\ be overridden by the connector based on the token refresh endpoint response."
format: "date-time"
order: 6
title: "Token expiry date"
type: "string"
redirect_uri:
airbyte_secret: true
order: 2
title: "Redirect Uri"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "freshbooks"
const: "freshbooks"
enum:
- "freshbooks"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "redirect_uri"
- "account_id"
- "client_refresh_token"
- "business_uuid"
- "sourceType"
type: "object"
source-freshbooks-update:
properties:
account_id:
order: 3
title: "Account Id"
type: "string"
business_uuid:
order: 7
title: "Business uuid"
type: "string"
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
client_refresh_token:
airbyte_secret: true
order: 4
title: "Refresh token"
type: "string"
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
oauth_access_token:
airbyte_secret: true
description: "The current access token. This field might be overridden by\
\ the connector based on the token refresh endpoint response."
order: 5
title: "Access token"
type: "string"
oauth_token_expiry_date:
description: "The date the current access token expires in. This field might\
\ be overridden by the connector based on the token refresh endpoint response."
format: "date-time"
order: 6
title: "Token expiry date"
type: "string"
redirect_uri:
airbyte_secret: true
order: 2
title: "Redirect Uri"
type: "string"
required:
- "client_id"
- "client_secret"
- "redirect_uri"
- "account_id"
- "client_refresh_token"
- "business_uuid"
type: "object"
source-just-sift:
properties:
api_token:
airbyte_secret: true
description: "API token to use for accessing the Sift API. Obtain this token\
\ from your Sift account administrator."
name: "api_token"
order: 0
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "just-sift"
const: "just-sift"
enum:
- "just-sift"
order: 0
type: "string"
required:
- "api_token"
- "sourceType"
type: "object"
source-just-sift-update:
properties:
api_token:
airbyte_secret: true
description: "API token to use for accessing the Sift API. Obtain this token\
\ from your Sift account administrator."
name: "api_token"
order: 0
title: "API Token"
type: "string"
required:
- "api_token"
type: "object"
source-rentcast:
properties:
address:
description: "The full address of the property, in the format of Street,\
\ City, State, Zip. Used to retrieve data for a specific property, or\
\ together with the radius parameter to search for listings in a specific\
\ area"
order: 1
title: "Address"
type: "string"
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
bath_rooms:
description: "The number of bathrooms, used to search for listings matching\
\ this criteria. Supports fractions to indicate partial bathrooms"
order: 10
title: "Bath Rooms"
type: "integer"
bedrooms:
description: "The number of bedrooms, used to search for listings matching\
\ this criteria. Use 0 to indicate a studio layout"
order: 9
title: "Bedrooms"
type: "number"
city:
description: "The name of the city, used to search for listings in a specific\
\ city. This parameter is case-sensitive"
order: 2
title: "City"
type: "string"
data_type_:
description: "The type of aggregate market data to return. Defaults to \"\
All\" if not provided : All , Sale , Rental"
order: 13
title: "Data Type "
type: "string"
days_old:
description: "The maximum number of days since a property was listed on\
\ the market, with a minimum of 1 or The maximum number of days since\
\ a property was last sold, with a minimum of 1. Used to search for properties\
\ that were sold within the specified date range"
order: 12
title: "Days Old"
type: "string"
history_range:
description: "The time range for historical record entries, in months. Defaults\
\ to 12 if not provided"
order: 14
title: "History Range"
type: "string"
latitude:
description: "The latitude of the search area. Use the latitude/longitude\
\ and radius parameters to search for listings in a specific area"
order: 5
title: "Latitude"
type: "string"
longitude:
description: "The longitude of the search area. Use the latitude/longitude\
\ and radius parameters to search for listings in a specific area"
order: 6
title: "Longitude"
type: "string"
property_type:
description: "The type of the property, used to search for listings matching\
\ this criteria : Single Family , Condo , Townhouse , Manufactured , \
\ Multi-Family , Apartment , Land ,"
order: 8
title: "Property Type"
type: "string"
radius:
description: "The radius of the search area in miles, with a maximum of\
\ 100. Use in combination with the latitude/longitude or address parameters\
\ to search for listings in a specific area"
order: 7
title: "Radius"
type: "string"
state:
description: "The 2-character state abbreviation, used to search for listings\
\ in a specific state. This parameter is case-sensitive"
order: 3
title: "State"
type: "string"
status:
description: "The current listing status, used to search for listings matching\
\ this criteria : Active or Inactive"
order: 11
title: "Status"
type: "string"
zipcode:
description: "The 5-digit zip code, used to search for listings in a specific\
\ zip code"
order: 4
title: "Zip Code"
type: "string"
sourceType:
title: "rentcast"
const: "rentcast"
enum:
- "rentcast"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-rentcast-update:
properties:
address:
description: "The full address of the property, in the format of Street,\
\ City, State, Zip. Used to retrieve data for a specific property, or\
\ together with the radius parameter to search for listings in a specific\
\ area"
order: 1
title: "Address"
type: "string"
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
bath_rooms:
description: "The number of bathrooms, used to search for listings matching\
\ this criteria. Supports fractions to indicate partial bathrooms"
order: 10
title: "Bath Rooms"
type: "integer"
bedrooms:
description: "The number of bedrooms, used to search for listings matching\
\ this criteria. Use 0 to indicate a studio layout"
order: 9
title: "Bedrooms"
type: "number"
city:
description: "The name of the city, used to search for listings in a specific\
\ city. This parameter is case-sensitive"
order: 2
title: "City"
type: "string"
data_type_:
description: "The type of aggregate market data to return. Defaults to \"\
All\" if not provided : All , Sale , Rental"
order: 13
title: "Data Type "
type: "string"
days_old:
description: "The maximum number of days since a property was listed on\
\ the market, with a minimum of 1 or The maximum number of days since\
\ a property was last sold, with a minimum of 1. Used to search for properties\
\ that were sold within the specified date range"
order: 12
title: "Days Old"
type: "string"
history_range:
description: "The time range for historical record entries, in months. Defaults\
\ to 12 if not provided"
order: 14
title: "History Range"
type: "string"
latitude:
description: "The latitude of the search area. Use the latitude/longitude\
\ and radius parameters to search for listings in a specific area"
order: 5
title: "Latitude"
type: "string"
longitude:
description: "The longitude of the search area. Use the latitude/longitude\
\ and radius parameters to search for listings in a specific area"
order: 6
title: "Longitude"
type: "string"
property_type:
description: "The type of the property, used to search for listings matching\
\ this criteria : Single Family , Condo , Townhouse , Manufactured , \
\ Multi-Family , Apartment , Land ,"
order: 8
title: "Property Type"
type: "string"
radius:
description: "The radius of the search area in miles, with a maximum of\
\ 100. Use in combination with the latitude/longitude or address parameters\
\ to search for listings in a specific area"
order: 7
title: "Radius"
type: "string"
state:
description: "The 2-character state abbreviation, used to search for listings\
\ in a specific state. This parameter is case-sensitive"
order: 3
title: "State"
type: "string"
status:
description: "The current listing status, used to search for listings matching\
\ this criteria : Active or Inactive"
order: 11
title: "Status"
type: "string"
zipcode:
description: "The 5-digit zip code, used to search for listings in a specific\
\ zip code"
order: 4
title: "Zip Code"
type: "string"
required:
- "api_key"
type: "object"
source-yotpo:
properties:
access_token:
airbyte_secret: true
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)"
order: 0
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
app_key:
description: "App key found at settings (Ref- https://settings.yotpo.com/#/general_settings)"
order: 1
title: "App Key"
type: "string"
email:
default: "example@gmail.com"
description: "Email address registered with yotpo."
order: 3
title: "Registered email address"
type: "string"
start_date:
description: "Date time filter for incremental filter, Specify which date\
\ to extract from."
examples:
- "2022-03-01T00:00:00.000Z"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$"
title: "Date-From Filter"
type: "string"
sourceType:
title: "yotpo"
const: "yotpo"
enum:
- "yotpo"
order: 0
type: "string"
required:
- "access_token"
- "app_key"
- "start_date"
- "email"
- "sourceType"
type: "object"
source-yotpo-update:
properties:
access_token:
airbyte_secret: true
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)"
order: 0
title: "Access Token"
type: "string"
app_key:
description: "App key found at settings (Ref- https://settings.yotpo.com/#/general_settings)"
order: 1
title: "App Key"
type: "string"
email:
default: "example@gmail.com"
description: "Email address registered with yotpo."
order: 3
title: "Registered email address"
type: "string"
start_date:
description: "Date time filter for incremental filter, Specify which date\
\ to extract from."
examples:
- "2022-03-01T00:00:00.000Z"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$"
title: "Date-From Filter"
type: "string"
required:
- "access_token"
- "app_key"
- "start_date"
- "email"
type: "object"
source-netsuite:
properties:
consumer_key:
airbyte_secret: true
description: "Consumer key associated with your integration"
order: 1
title: "Consumer Key"
type: "string"
x-speakeasy-param-sensitive: true
consumer_secret:
airbyte_secret: true
description: "Consumer secret associated with your integration"
order: 2
title: "Consumer Secret"
type: "string"
x-speakeasy-param-sensitive: true
object_types:
default: []
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."
examples:
- "customer"
- "salesorder"
- "etc"
items:
type: "string"
order: 5
title: "Object Types"
type: "array"
realm:
airbyte_secret: true
description: "Netsuite realm e.g. 2344535, as for `production` or 2344535_SB1,\
\ as for the `sandbox`"
order: 0
title: "Realm (Account Id)"
type: "string"
x-speakeasy-param-sensitive: true
start_datetime:
description: "Starting point for your data replication, in format of \"\
YYYY-MM-DDTHH:mm:ssZ\""
examples:
- "2017-01-25T00:00:00Z"
order: 6
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
token_key:
airbyte_secret: true
description: "Access token key"
order: 3
title: "Token Key (Token Id)"
type: "string"
x-speakeasy-param-sensitive: true
token_secret:
airbyte_secret: true
description: "Access token secret"
order: 4
title: "Token Secret"
type: "string"
x-speakeasy-param-sensitive: true
window_in_days:
default: 30
description: "The amount of days used to query the data with date chunks.\
\ Set smaller value, if you have lots of data."
order: 7
title: "Window in Days"
type: "integer"
sourceType:
title: "netsuite"
const: "netsuite"
enum:
- "netsuite"
order: 0
type: "string"
required:
- "realm"
- "consumer_key"
- "consumer_secret"
- "token_key"
- "token_secret"
- "start_datetime"
- "sourceType"
title: "Netsuite Spec"
type: "object"
source-netsuite-update:
properties:
consumer_key:
airbyte_secret: true
description: "Consumer key associated with your integration"
order: 1
title: "Consumer Key"
type: "string"
consumer_secret:
airbyte_secret: true
description: "Consumer secret associated with your integration"
order: 2
title: "Consumer Secret"
type: "string"
object_types:
default: []
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."
examples:
- "customer"
- "salesorder"
- "etc"
items:
type: "string"
order: 5
title: "Object Types"
type: "array"
realm:
airbyte_secret: true
description: "Netsuite realm e.g. 2344535, as for `production` or 2344535_SB1,\
\ as for the `sandbox`"
order: 0
title: "Realm (Account Id)"
type: "string"
start_datetime:
description: "Starting point for your data replication, in format of \"\
YYYY-MM-DDTHH:mm:ssZ\""
examples:
- "2017-01-25T00:00:00Z"
order: 6
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
token_key:
airbyte_secret: true
description: "Access token key"
order: 3
title: "Token Key (Token Id)"
type: "string"
token_secret:
airbyte_secret: true
description: "Access token secret"
order: 4
title: "Token Secret"
type: "string"
window_in_days:
default: 30
description: "The amount of days used to query the data with date chunks.\
\ Set smaller value, if you have lots of data."
order: 7
title: "Window in Days"
type: "integer"
required:
- "realm"
- "consumer_key"
- "consumer_secret"
- "token_key"
- "token_secret"
- "start_datetime"
title: "Netsuite Spec"
type: "object"
source-convex:
properties:
access_key:
airbyte_secret: true
description: "API access key used to retrieve data from Convex."
title: "Access Key"
type: "string"
x-speakeasy-param-sensitive: true
deployment_url:
examples:
- "https://murky-swan-635.convex.cloud"
- "https://cluttered-owl-337.convex.cloud"
title: "Deployment Url"
type: "string"
sourceType:
title: "convex"
const: "convex"
enum:
- "convex"
order: 0
type: "string"
required:
- "deployment_url"
- "access_key"
- "sourceType"
title: "Convex Source Spec"
type: "object"
source-convex-update:
properties:
access_key:
airbyte_secret: true
description: "API access key used to retrieve data from Convex."
title: "Access Key"
type: "string"
deployment_url:
examples:
- "https://murky-swan-635.convex.cloud"
- "https://cluttered-owl-337.convex.cloud"
title: "Deployment Url"
type: "string"
required:
- "deployment_url"
- "access_key"
title: "Convex Source Spec"
type: "object"
source-recurly:
properties:
accounts_step_days:
default: 30
description: "Days in length for each API call to get data from the accounts\
\ stream. Smaller values will result in more API calls but better concurrency."
examples:
- 7
- 30
- 90
maximum: 365
minimum: 1
order: 4
title: "Days in length for each API call to get data"
type: "integer"
api_key:
airbyte_secret: true
description: "Recurly API Key. See the docs for more information on how to generate this key."
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
begin_time:
description: "ISO8601 timestamp from which the replication from Recurly\
\ API will start from."
examples:
- "2021-12-01T00:00:00Z"
order: 1
pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
type: "string"
end_time:
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:00Z"
order: 2
pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
type: "string"
is_sandbox:
default: false
description: "Set to true for sandbox accounts (400 requests/min, all types).\
\ Defaults to false for production accounts (1,000 GET requests/min)."
order: 5
title: "Use Sandbox Environment"
type: "boolean"
num_workers:
default: 10
description: "The number of worker threads to use for the sync."
examples:
- 1
- 2
- 3
maximum: 20
minimum: 1
order: 3
title: "Number of concurrent threads"
type: "integer"
sourceType:
title: "recurly"
const: "recurly"
enum:
- "recurly"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-recurly-update:
properties:
accounts_step_days:
default: 30
description: "Days in length for each API call to get data from the accounts\
\ stream. Smaller values will result in more API calls but better concurrency."
examples:
- 7
- 30
- 90
maximum: 365
minimum: 1
order: 4
title: "Days in length for each API call to get data"
type: "integer"
api_key:
airbyte_secret: true
description: "Recurly API Key. See the docs for more information on how to generate this key."
order: 0
title: "API Key"
type: "string"
begin_time:
description: "ISO8601 timestamp from which the replication from Recurly\
\ API will start from."
examples:
- "2021-12-01T00:00:00Z"
order: 1
pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
type: "string"
end_time:
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:00Z"
order: 2
pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
type: "string"
is_sandbox:
default: false
description: "Set to true for sandbox accounts (400 requests/min, all types).\
\ Defaults to false for production accounts (1,000 GET requests/min)."
order: 5
title: "Use Sandbox Environment"
type: "boolean"
num_workers:
default: 10
description: "The number of worker threads to use for the sync."
examples:
- 1
- 2
- 3
maximum: 20
minimum: 1
order: 3
title: "Number of concurrent threads"
type: "integer"
required:
- "api_key"
type: "object"
source-pennylane:
properties:
api_key:
airbyte_secret: true
order: 1
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_time:
format: "date-time"
order: 0
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start time"
type: "string"
sourceType:
title: "pennylane"
const: "pennylane"
enum:
- "pennylane"
order: 0
type: "string"
required:
- "start_time"
- "api_key"
- "sourceType"
type: "object"
source-pennylane-update:
properties:
api_key:
airbyte_secret: true
order: 1
title: "API Key"
type: "string"
start_time:
format: "date-time"
order: 0
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start time"
type: "string"
required:
- "start_time"
- "api_key"
type: "object"
source-factorial:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
limit:
default: "50"
description: "Max records per page limit"
order: 2
title: "Limit"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "factorial"
const: "factorial"
enum:
- "factorial"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-factorial-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
limit:
default: "50"
description: "Max records per page limit"
order: 2
title: "Limit"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-teamwork:
properties:
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
site_name:
description: "The teamwork site name appearing at the url"
order: 2
title: "Site Name"
type: "string"
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
username:
order: 0
title: "Username"
type: "string"
sourceType:
title: "teamwork"
const: "teamwork"
enum:
- "teamwork"
order: 0
type: "string"
required:
- "username"
- "site_name"
- "start_date"
- "sourceType"
type: "object"
source-teamwork-update:
properties:
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
site_name:
description: "The teamwork site name appearing at the url"
order: 2
title: "Site Name"
type: "string"
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
username:
order: 0
title: "Username"
type: "string"
required:
- "username"
- "site_name"
- "start_date"
type: "object"
source-zendesk-chat:
properties:
credentials:
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests."
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
client_id:
airbyte_secret: true
description: "The Client ID of your OAuth application"
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The Client Secret of your OAuth application."
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
credentials:
const: "oauth2.0"
order: 0
type: "string"
enum:
- "oauth2.0"
refresh_token:
airbyte_secret: true
description: "Refresh Token to obtain new Access Token, when it's\
\ expired."
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "credentials"
title: "OAuth2.0"
type: "object"
- properties:
access_token:
airbyte_secret: true
description: "The Access Token to make authenticated requests."
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
credentials:
const: "access_token"
order: 0
type: "string"
enum:
- "access_token"
required:
- "credentials"
- "access_token"
title: "Access Token"
type: "object"
order: 2
title: "Authorization Method"
type: "object"
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"
format: "date-time"
order: 0
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
subdomain:
description: "The unique subdomain of your Zendesk account (without https://).\
\ See the Zendesk docs to find your subdomain."
examples:
- "myzendeskchat"
order: 1
pattern: "^(?!https://)"
title: "Subdomain"
type: "string"
sourceType:
title: "zendesk-chat"
const: "zendesk-chat"
enum:
- "zendesk-chat"
order: 0
type: "string"
required:
- "start_date"
- "subdomain"
- "sourceType"
type: "object"
source-zendesk-chat-update:
properties:
credentials:
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests."
title: "Access Token"
type: "string"
client_id:
airbyte_secret: true
description: "The Client ID of your OAuth application"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your OAuth application."
title: "Client Secret"
type: "string"
credentials:
const: "oauth2.0"
order: 0
type: "string"
enum:
- "oauth2.0"
refresh_token:
airbyte_secret: true
description: "Refresh Token to obtain new Access Token, when it's\
\ expired."
title: "Refresh Token"
type: "string"
required:
- "credentials"
title: "OAuth2.0"
type: "object"
- properties:
access_token:
airbyte_secret: true
description: "The Access Token to make authenticated requests."
title: "Access Token"
type: "string"
credentials:
const: "access_token"
order: 0
type: "string"
enum:
- "access_token"
required:
- "credentials"
- "access_token"
title: "Access Token"
type: "object"
order: 2
title: "Authorization Method"
type: "object"
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"
format: "date-time"
order: 0
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
subdomain:
description: "The unique subdomain of your Zendesk account (without https://).\
\ See the Zendesk docs to find your subdomain."
examples:
- "myzendeskchat"
order: 1
pattern: "^(?!https://)"
title: "Subdomain"
type: "string"
required:
- "start_date"
- "subdomain"
type: "object"
source-my-hours:
properties:
email:
description: "Your My Hours username"
example: "john@doe.com"
title: "Email"
type: "string"
logs_batch_size:
default: 30
description: "Pagination size used for retrieving logs in days"
examples:
- 30
maximum: 365
minimum: 1
title: "Time logs batch size"
type: "integer"
password:
airbyte_secret: true
description: "The password associated to the username"
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "Start date for collecting time logs"
examples:
- "%Y-%m-%d"
- "2016-01-01"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
sourceType:
title: "my-hours"
const: "my-hours"
enum:
- "my-hours"
order: 0
type: "string"
required:
- "email"
- "password"
- "start_date"
- "sourceType"
title: "My Hours Spec"
type: "object"
source-my-hours-update:
properties:
email:
description: "Your My Hours username"
example: "john@doe.com"
title: "Email"
type: "string"
logs_batch_size:
default: 30
description: "Pagination size used for retrieving logs in days"
examples:
- 30
maximum: 365
minimum: 1
title: "Time logs batch size"
type: "integer"
password:
airbyte_secret: true
description: "The password associated to the username"
title: "Password"
type: "string"
start_date:
description: "Start date for collecting time logs"
examples:
- "%Y-%m-%d"
- "2016-01-01"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
required:
- "email"
- "password"
- "start_date"
title: "My Hours Spec"
type: "object"
source-7shifts:
properties:
access_token:
airbyte_secret: true
description: "Access token to use for authentication. Generate it in the\
\ 7shifts Developer Tools."
name: "access_token"
order: 0
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "7shifts"
const: "7shifts"
enum:
- "7shifts"
order: 0
type: "string"
required:
- "access_token"
- "start_date"
- "sourceType"
type: "object"
source-7shifts-update:
properties:
access_token:
airbyte_secret: true
description: "Access token to use for authentication. Generate it in the\
\ 7shifts Developer Tools."
name: "access_token"
order: 0
title: "Access Token"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "access_token"
- "start_date"
type: "object"
source-acuity-scheduling:
properties:
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
username:
order: 0
title: "Username"
type: "string"
sourceType:
title: "acuity-scheduling"
const: "acuity-scheduling"
enum:
- "acuity-scheduling"
order: 0
type: "string"
required:
- "username"
- "start_date"
- "sourceType"
type: "object"
source-acuity-scheduling-update:
properties:
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
username:
order: 0
title: "Username"
type: "string"
required:
- "username"
- "start_date"
type: "object"
source-openweather:
properties:
appid:
airbyte_secret: true
description: "API KEY"
order: 0
type: "string"
x-speakeasy-param-sensitive: true
lang:
description: "You can use lang parameter to get the output in your language.\
\ The contents of the description field will be translated. See here for the list\
\ of supported languages."
enum:
- "af"
- "al"
- "ar"
- "az"
- "bg"
- "ca"
- "cz"
- "da"
- "de"
- "el"
- "en"
- "eu"
- "fa"
- "fi"
- "fr"
- "gl"
- "he"
- "hi"
- "hr"
- "hu"
- "id"
- "it"
- "ja"
- "kr"
- "la"
- "lt"
- "mk"
- "no"
- "nl"
- "pl"
- "pt"
- "pt_br"
- "ro"
- "ru"
- "sv"
- "se"
- "sk"
- "sl"
- "sp"
- "es"
- "sr"
- "th"
- "tr"
- "ua"
- "uk"
- "vi"
- "zh_cn"
- "zh_tw"
- "zu"
examples:
- "en"
- "fr"
- "pt_br"
- "uk"
- "zh_cn"
- "zh_tw"
order: 1
type: "string"
lat:
description: "Latitude, decimal (-90; 90). If you need the geocoder to automatic\
\ convert city names and zip-codes to geo coordinates and the other way\
\ around, please use the OpenWeather Geocoding API"
examples:
- "45.7603"
- "-21.249107858038816"
order: 2
pattern: "^[-]?\\d{1,2}(\\.\\d+)?$"
type: "string"
lon:
description: "Longitude, decimal (-180; 180). If you need the geocoder to\
\ automatic convert city names and zip-codes to geo coordinates and the\
\ other way around, please use the OpenWeather Geocoding API"
examples:
- "4.835659"
- "-70.39482074115321"
order: 3
pattern: "^[-]?\\d{1,3}(\\.\\d+)?$"
type: "string"
only_current:
description: "True for particular day"
example:
- "true"
order: 4
type: "boolean"
units:
description: "Units of measurement. standard, metric and imperial units\
\ are available. If you do not use the units parameter, standard units\
\ will be applied by default."
enum:
- "standard"
- "metric"
- "imperial"
examples:
- "standard"
- "metric"
- "imperial"
order: 5
type: "string"
sourceType:
title: "openweather"
const: "openweather"
enum:
- "openweather"
order: 0
type: "string"
required:
- "appid"
- "lat"
- "lon"
- "sourceType"
type: "object"
source-openweather-update:
properties:
appid:
airbyte_secret: true
description: "API KEY"
order: 0
type: "string"
lang:
description: "You can use lang parameter to get the output in your language.\
\ The contents of the description field will be translated. See here for the list\
\ of supported languages."
enum:
- "af"
- "al"
- "ar"
- "az"
- "bg"
- "ca"
- "cz"
- "da"
- "de"
- "el"
- "en"
- "eu"
- "fa"
- "fi"
- "fr"
- "gl"
- "he"
- "hi"
- "hr"
- "hu"
- "id"
- "it"
- "ja"
- "kr"
- "la"
- "lt"
- "mk"
- "no"
- "nl"
- "pl"
- "pt"
- "pt_br"
- "ro"
- "ru"
- "sv"
- "se"
- "sk"
- "sl"
- "sp"
- "es"
- "sr"
- "th"
- "tr"
- "ua"
- "uk"
- "vi"
- "zh_cn"
- "zh_tw"
- "zu"
examples:
- "en"
- "fr"
- "pt_br"
- "uk"
- "zh_cn"
- "zh_tw"
order: 1
type: "string"
lat:
description: "Latitude, decimal (-90; 90). If you need the geocoder to automatic\
\ convert city names and zip-codes to geo coordinates and the other way\
\ around, please use the OpenWeather Geocoding API"
examples:
- "45.7603"
- "-21.249107858038816"
order: 2
pattern: "^[-]?\\d{1,2}(\\.\\d+)?$"
type: "string"
lon:
description: "Longitude, decimal (-180; 180). If you need the geocoder to\
\ automatic convert city names and zip-codes to geo coordinates and the\
\ other way around, please use the OpenWeather Geocoding API"
examples:
- "4.835659"
- "-70.39482074115321"
order: 3
pattern: "^[-]?\\d{1,3}(\\.\\d+)?$"
type: "string"
only_current:
description: "True for particular day"
example:
- "true"
order: 4
type: "boolean"
units:
description: "Units of measurement. standard, metric and imperial units\
\ are available. If you do not use the units parameter, standard units\
\ will be applied by default."
enum:
- "standard"
- "metric"
- "imperial"
examples:
- "standard"
- "metric"
- "imperial"
order: 5
type: "string"
required:
- "appid"
- "lat"
- "lon"
type: "object"
source-sparkpost:
properties:
api_key:
airbyte_secret: true
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
api_prefix:
default: "api"
enum:
- "api"
- "api.eu"
order: 2
title: "API Endpoint Prefix"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
sourceType:
title: "sparkpost"
const: "sparkpost"
enum:
- "sparkpost"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "api_prefix"
- "sourceType"
type: "object"
source-sparkpost-update:
properties:
api_key:
airbyte_secret: true
name: "api_key"
order: 0
title: "API Key"
type: "string"
api_prefix:
default: "api"
enum:
- "api"
- "api.eu"
order: 2
title: "API Endpoint Prefix"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
required:
- "api_key"
- "start_date"
- "api_prefix"
type: "object"
source-nocrm:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Generate it from the admin section of your\
\ noCRM.io account."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
subdomain:
description: "The subdomain specific to your noCRM.io account, e.g., 'yourcompany'\
\ in 'yourcompany.nocrm.io'."
name: "subdomain"
order: 1
title: "Subdomain"
type: "string"
sourceType:
title: "nocrm"
const: "nocrm"
enum:
- "nocrm"
order: 0
type: "string"
required:
- "api_key"
- "subdomain"
- "sourceType"
type: "object"
source-nocrm-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Generate it from the admin section of your\
\ noCRM.io account."
name: "api_key"
order: 0
title: "API Key"
type: "string"
subdomain:
description: "The subdomain specific to your noCRM.io account, e.g., 'yourcompany'\
\ in 'yourcompany.nocrm.io'."
name: "subdomain"
order: 1
title: "Subdomain"
type: "string"
required:
- "api_key"
- "subdomain"
type: "object"
source-perigon:
properties:
api_key:
airbyte_secret: true
description: "Your API key for authenticating with the Perigon API. Obtain\
\ it by creating an account at https://www.perigon.io/sign-up and verifying\
\ your email. The API key will be visible on your account dashboard."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "perigon"
const: "perigon"
enum:
- "perigon"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-perigon-update:
properties:
api_key:
airbyte_secret: true
description: "Your API key for authenticating with the Perigon API. Obtain\
\ it by creating an account at https://www.perigon.io/sign-up and verifying\
\ your email. The API key will be visible on your account dashboard."
name: "api_key"
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-opuswatch:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
default: "20250101"
order: 1
title: "Start Date"
type: "string"
sourceType:
title: "opuswatch"
const: "opuswatch"
enum:
- "opuswatch"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-opuswatch-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
start_date:
default: "20250101"
order: 1
title: "Start Date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-openaq:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
country_ids:
description: "The list of IDs of countries (comma separated) you need the\
\ data for, check more: https://docs.openaq.org/resources/countries"
order: 1
title: "Countries"
type: "array"
sourceType:
title: "openaq"
const: "openaq"
enum:
- "openaq"
order: 0
type: "string"
required:
- "api_key"
- "country_ids"
- "sourceType"
type: "object"
source-openaq-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
country_ids:
description: "The list of IDs of countries (comma separated) you need the\
\ data for, check more: https://docs.openaq.org/resources/countries"
order: 1
title: "Countries"
type: "array"
required:
- "api_key"
- "country_ids"
type: "object"
source-db2-enterprise:
properties:
check_privileges:
default: true
description: "When this feature is enabled, during schema discovery the\
\ connector will query each table or view individually to check access\
\ privileges and inaccessible tables, views, or columns therein will be\
\ removed. In large schemas, this might cause schema discovery to take\
\ too long, in which case it might be advisable to disable this feature."
order: 13
title: "Check Table and Column Access Privileges"
type: "boolean"
checkpoint_target_interval_seconds:
default: 300
description: "How often (in seconds) a stream should checkpoint, when possible."
order: 11
title: "Checkpoint Target Time Interval"
type: "integer"
concurrency:
default: 1
description: "Maximum number of concurrent queries to the database."
order: 12
title: "Concurrency"
type: "integer"
cursor:
description: "Configures how data is extracted from the database."
display_type: "radio"
oneOf:
- additionalProperties: true
description: "Incrementally detects new inserts and updates using the\
\ cursor column chosen when configuring a connection (e.g. created_at,\
\ updated_at)."
properties:
cursor_method:
default: "user_defined"
enum:
- "user_defined"
type: "string"
required:
- "cursor_method"
title: "Scan Changes with User Defined Cursor"
type: "object"
- additionalProperties: true
description: "Recommended - Incrementally reads new inserts, updates,\
\ and deletes using change data capture feature. This must be enabled\
\ on your database."
properties:
cursor_method:
default: "cdc"
enum:
- "cdc"
type: "string"
initial_load_timeout_hours:
always_show: true
default: 8
description: "The amount of time an initial load is allowed to continue\
\ for before catching up on CDC events."
max: 24
min: 4
order: 2
title: "Initial Load Timeout in Hours (Advanced)"
type: "integer"
required:
- "cursor_method"
title: "Read Changes using Change Data Capture (CDC)"
type: "object"
order: 10
title: "Update Method"
type: "object"
database:
always_show: true
description: "The database name."
order: 5
title: "Database"
type: "string"
encryption:
description: "The encryption method with is used when communicating with\
\ the database."
oneOf:
- additionalProperties: true
description: "Data transfer will not be encrypted."
properties:
encryption_method:
default: "unencrypted"
enum:
- "unencrypted"
type: "string"
required:
- "encryption_method"
title: "Unencrypted"
type: "object"
- additionalProperties: true
description: "Verify and use the certificate provided by the server."
properties:
encryption_method:
default: "encrypted_verify_certificate"
enum:
- "encrypted_verify_certificate"
type: "string"
ssl_certificate:
airbyte_secret: true
description: "Privacy Enhanced Mail (PEM) files are concatenated certificate\
\ containers frequently used in certificate installations."
multiline: true
title: "SSL PEM File"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "encryption_method"
- "ssl_certificate"
title: "TLS Encrypted (verify certificate)"
type: "object"
order: 8
title: "Encryption"
type: "object"
host:
description: "Hostname of the database."
order: 1
title: "Host"
type: "string"
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)."
order: 7
title: "JDBC URL Params"
type: "string"
password:
airbyte_secret: true
always_show: true
description: "The password associated with the username."
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
port:
default: 50000
description: "Port of the database."
maximum: 65536
minimum: 0
order: 2
title: "Port"
type: "integer"
schemas:
always_show: true
description: "The list of schemas to sync from."
items:
type: "string"
order: 6
title: "Schemas"
type: "array"
uniqueItems: true
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- additionalProperties: true
description: "No ssh tunnel needed to connect to database"
properties:
tunnel_method:
default: "NO_TUNNEL"
enum:
- "NO_TUNNEL"
type: "string"
required:
- "tunnel_method"
title: "No Tunnel"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
x-speakeasy-param-sensitive: true
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_KEY_AUTH"
enum:
- "SSH_KEY_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_PASSWORD_AUTH"
enum:
- "SSH_PASSWORD_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
type: "object"
order: 9
title: "SSH Tunnel Method"
type: "object"
username:
description: "The username which is used to access the database."
order: 3
title: "User"
type: "string"
sourceType:
title: "db2-enterprise"
const: "db2-enterprise"
enum:
- "db2-enterprise"
order: 0
type: "string"
required:
- "host"
- "port"
- "username"
- "database"
- "schemas"
- "encryption"
- "tunnel_method"
- "cursor"
- "sourceType"
title: "Db2 Source Spec"
type: "object"
source-db2-enterprise-update:
properties:
check_privileges:
default: true
description: "When this feature is enabled, during schema discovery the\
\ connector will query each table or view individually to check access\
\ privileges and inaccessible tables, views, or columns therein will be\
\ removed. In large schemas, this might cause schema discovery to take\
\ too long, in which case it might be advisable to disable this feature."
order: 13
title: "Check Table and Column Access Privileges"
type: "boolean"
checkpoint_target_interval_seconds:
default: 300
description: "How often (in seconds) a stream should checkpoint, when possible."
order: 11
title: "Checkpoint Target Time Interval"
type: "integer"
concurrency:
default: 1
description: "Maximum number of concurrent queries to the database."
order: 12
title: "Concurrency"
type: "integer"
cursor:
description: "Configures how data is extracted from the database."
display_type: "radio"
oneOf:
- additionalProperties: true
description: "Incrementally detects new inserts and updates using the\
\ cursor column chosen when configuring a connection (e.g. created_at,\
\ updated_at)."
properties:
cursor_method:
default: "user_defined"
enum:
- "user_defined"
type: "string"
required:
- "cursor_method"
title: "Scan Changes with User Defined Cursor"
type: "object"
- additionalProperties: true
description: "Recommended - Incrementally reads new inserts, updates,\
\ and deletes using change data capture feature. This must be enabled\
\ on your database."
properties:
cursor_method:
default: "cdc"
enum:
- "cdc"
type: "string"
initial_load_timeout_hours:
always_show: true
default: 8
description: "The amount of time an initial load is allowed to continue\
\ for before catching up on CDC events."
max: 24
min: 4
order: 2
title: "Initial Load Timeout in Hours (Advanced)"
type: "integer"
required:
- "cursor_method"
title: "Read Changes using Change Data Capture (CDC)"
type: "object"
order: 10
title: "Update Method"
type: "object"
database:
always_show: true
description: "The database name."
order: 5
title: "Database"
type: "string"
encryption:
description: "The encryption method with is used when communicating with\
\ the database."
oneOf:
- additionalProperties: true
description: "Data transfer will not be encrypted."
properties:
encryption_method:
default: "unencrypted"
enum:
- "unencrypted"
type: "string"
required:
- "encryption_method"
title: "Unencrypted"
type: "object"
- additionalProperties: true
description: "Verify and use the certificate provided by the server."
properties:
encryption_method:
default: "encrypted_verify_certificate"
enum:
- "encrypted_verify_certificate"
type: "string"
ssl_certificate:
airbyte_secret: true
description: "Privacy Enhanced Mail (PEM) files are concatenated certificate\
\ containers frequently used in certificate installations."
multiline: true
title: "SSL PEM File"
type: "string"
required:
- "encryption_method"
- "ssl_certificate"
title: "TLS Encrypted (verify certificate)"
type: "object"
order: 8
title: "Encryption"
type: "object"
host:
description: "Hostname of the database."
order: 1
title: "Host"
type: "string"
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)."
order: 7
title: "JDBC URL Params"
type: "string"
password:
airbyte_secret: true
always_show: true
description: "The password associated with the username."
order: 4
title: "Password"
type: "string"
port:
default: 50000
description: "Port of the database."
maximum: 65536
minimum: 0
order: 2
title: "Port"
type: "integer"
schemas:
always_show: true
description: "The list of schemas to sync from."
items:
type: "string"
order: 6
title: "Schemas"
type: "array"
uniqueItems: true
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- additionalProperties: true
description: "No ssh tunnel needed to connect to database"
properties:
tunnel_method:
default: "NO_TUNNEL"
enum:
- "NO_TUNNEL"
type: "string"
required:
- "tunnel_method"
title: "No Tunnel"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_KEY_AUTH"
enum:
- "SSH_KEY_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_PASSWORD_AUTH"
enum:
- "SSH_PASSWORD_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
type: "object"
order: 9
title: "SSH Tunnel Method"
type: "object"
username:
description: "The username which is used to access the database."
order: 3
title: "User"
type: "string"
required:
- "host"
- "port"
- "username"
- "database"
- "schemas"
- "encryption"
- "tunnel_method"
- "cursor"
title: "Db2 Source Spec"
type: "object"
source-deputy:
properties:
api_key:
airbyte_secret: true
order: 1
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
base_url:
description: "The base url for your deputy account to make API requests"
order: 0
title: "Base URL"
type: "string"
sourceType:
title: "deputy"
const: "deputy"
enum:
- "deputy"
order: 0
type: "string"
required:
- "base_url"
- "api_key"
- "sourceType"
type: "object"
source-deputy-update:
properties:
api_key:
airbyte_secret: true
order: 1
title: "API Key"
type: "string"
base_url:
description: "The base url for your deputy account to make API requests"
order: 0
title: "Base URL"
type: "string"
required:
- "base_url"
- "api_key"
type: "object"
source-workflowmax:
properties:
account_id:
description: "The account id for workflowmax"
order: 1
title: "Account ID"
type: "string"
api_key_2:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "workflowmax"
const: "workflowmax"
enum:
- "workflowmax"
order: 0
type: "string"
required:
- "api_key_2"
- "account_id"
- "start_date"
- "sourceType"
type: "object"
source-workflowmax-update:
properties:
account_id:
description: "The account id for workflowmax"
order: 1
title: "Account ID"
type: "string"
api_key_2:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key_2"
- "account_id"
- "start_date"
type: "object"
source-chargify:
properties:
api_key:
airbyte_secret: true
description: "Maxio Advanced Billing/Chargify API Key."
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
domain:
description: "Chargify domain. Normally this domain follows the following\
\ format"
order: 1
title: "Domain"
type: "string"
password:
airbyte_secret: true
always_show: true
order: 3
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
username:
order: 2
title: "Username"
type: "string"
sourceType:
title: "chargify"
const: "chargify"
enum:
- "chargify"
order: 0
type: "string"
required:
- "api_key"
- "domain"
- "username"
- "sourceType"
type: "object"
source-chargify-update:
properties:
api_key:
airbyte_secret: true
description: "Maxio Advanced Billing/Chargify API Key."
order: 0
title: "API Key"
type: "string"
domain:
description: "Chargify domain. Normally this domain follows the following\
\ format"
order: 1
title: "Domain"
type: "string"
password:
airbyte_secret: true
always_show: true
order: 3
title: "Password"
type: "string"
username:
order: 2
title: "Username"
type: "string"
required:
- "api_key"
- "domain"
- "username"
type: "object"
source-stockdata:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
filter_entities:
default: false
order: 3
title: "Entities"
type: "boolean"
industries:
description: "Specify the industries of entities which have been identified\
\ within the article."
order: 2
title: "Industries"
type: "array"
start_date:
format: "date-time"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
symbols:
order: 1
title: "Symbols"
type: "array"
sourceType:
title: "stockdata"
const: "stockdata"
enum:
- "stockdata"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-stockdata-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
filter_entities:
default: false
order: 3
title: "Entities"
type: "boolean"
industries:
description: "Specify the industries of entities which have been identified\
\ within the article."
order: 2
title: "Industries"
type: "array"
start_date:
format: "date-time"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
symbols:
order: 1
title: "Symbols"
type: "array"
required:
- "api_key"
- "start_date"
type: "object"
source-dockerhub:
properties:
docker_username:
description: "Username of DockerHub person or organization (for https://hub.docker.com/v2/repositories/USERNAME/\
\ API call)"
examples:
- "airbyte"
order: 0
pattern: "^[a-z0-9_\\-]+$"
title: "Docker Username"
type: "string"
sourceType:
title: "dockerhub"
const: "dockerhub"
enum:
- "dockerhub"
order: 0
type: "string"
required:
- "docker_username"
- "sourceType"
type: "object"
source-dockerhub-update:
properties:
docker_username:
description: "Username of DockerHub person or organization (for https://hub.docker.com/v2/repositories/USERNAME/\
\ API call)"
examples:
- "airbyte"
order: 0
pattern: "^[a-z0-9_\\-]+$"
title: "Docker Username"
type: "string"
required:
- "docker_username"
type: "object"
source-greythr:
properties:
base_url:
description: "https://api.greythr.com"
order: 0
title: "Base URL"
type: "string"
domain:
description: "Your GreytHR Host URL"
order: 1
title: "Host URL"
type: "string"
password:
airbyte_secret: true
always_show: true
order: 3
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
username:
order: 2
title: "Username"
type: "string"
sourceType:
title: "greythr"
const: "greythr"
enum:
- "greythr"
order: 0
type: "string"
required:
- "base_url"
- "domain"
- "username"
- "sourceType"
type: "object"
source-greythr-update:
properties:
base_url:
description: "https://api.greythr.com"
order: 0
title: "Base URL"
type: "string"
domain:
description: "Your GreytHR Host URL"
order: 1
title: "Host URL"
type: "string"
password:
airbyte_secret: true
always_show: true
order: 3
title: "Password"
type: "string"
username:
order: 2
title: "Username"
type: "string"
required:
- "base_url"
- "domain"
- "username"
type: "object"
source-webflow:
properties:
accept_version:
description: "The version of the Webflow API to use. See https://developers.webflow.com/#versioning"
example: "1.0.0"
order: 2
title: "Accept Version"
type: "string"
api_key:
airbyte_secret: true
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
title: "API token"
type: "string"
x-speakeasy-param-sensitive: true
site_id:
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
title: "Site id"
type: "string"
sourceType:
title: "webflow"
const: "webflow"
enum:
- "webflow"
order: 0
type: "string"
required:
- "api_key"
- "site_id"
- "sourceType"
title: "Webflow Spec"
type: "object"
source-webflow-update:
properties:
accept_version:
description: "The version of the Webflow API to use. See https://developers.webflow.com/#versioning"
example: "1.0.0"
order: 2
title: "Accept Version"
type: "string"
api_key:
airbyte_secret: true
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
title: "API token"
type: "string"
site_id:
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
title: "Site id"
type: "string"
required:
- "api_key"
- "site_id"
title: "Webflow Spec"
type: "object"
source-outlook:
properties:
client_id:
airbyte_secret: true
description: "The Client ID of your Microsoft Azure application"
name: "client_id"
order: 0
title: "OAuth Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The Client Secret of your Microsoft Azure application"
name: "client_secret"
order: 1
title: "OAuth Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "Refresh token obtained from Microsoft OAuth flow"
order: 2
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
tenant_id:
airbyte_secret: false
default: "common"
description: "Azure AD Tenant ID (optional for multi-tenant apps, defaults\
\ to 'common')"
order: 3
title: "Tenant ID (Optional)"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "outlook"
const: "outlook"
enum:
- "outlook"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "sourceType"
type: "object"
source-outlook-update:
properties:
client_id:
airbyte_secret: true
description: "The Client ID of your Microsoft Azure application"
name: "client_id"
order: 0
title: "OAuth Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Microsoft Azure application"
name: "client_secret"
order: 1
title: "OAuth Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "Refresh token obtained from Microsoft OAuth flow"
order: 2
title: "Refresh Token"
type: "string"
tenant_id:
airbyte_secret: false
default: "common"
description: "Azure AD Tenant ID (optional for multi-tenant apps, defaults\
\ to 'common')"
order: 3
title: "Tenant ID (Optional)"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
type: "object"
source-scryfall:
properties:
sourceType:
title: "scryfall"
const: "scryfall"
enum:
- "scryfall"
order: 0
type: "string"
required:
- "sourceType"
type: "object"
source-scryfall-update:
properties: {}
required: []
type: "object"
source-customerly:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "customerly"
const: "customerly"
enum:
- "customerly"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-customerly-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-newsdata:
properties:
OneOf:
order: 5
query:
description: "Keywords or phrases to search for in the news title and\
\ content. Advanced Search options:\n - Search `Social`: query = \"\
social\"\n - Search `Social Pizza`: query = \"social pizza\"\n - Search\
\ `Social` but not with `pizza`: query = \"social -pizza\"\n - Search\
\ `Social` but not with `pizza` and `wildfire`: query = \"social\n-pizza\
\ -wildfire\"\n - Search `Social` and `pizza`: query = \"social AND\
\ pizza\"\n - Search `Social` and `pizza` and `pasta`: query = \"social\
\ AND pizza\nAND pasta\"\n - Search `Social` or `pizza`: query = \"\
social OR pizza\"\n - Search `Social` or `pizza` but not `pasta`: query\
\ = \"social OR pizza\n-pasta\"\n - Search `Social` or `pizza` or `pasta`:\
\ query = \"social OR pizza OR\npasta\" Note: You can't use AND and\
\ OR in the same query."
order: 1
type: "string"
query_in_title:
description: "Same as `query`, but restricting the search to only the\
\ news title. It cannot be used along with `query`."
order: 1
type: "string"
api_key:
airbyte_secret: true
description: "API Key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
category:
description: "Categories (maximum 5) to restrict the search to."
items:
enum:
- "business"
- "entertainment"
- "environment"
- "food"
- "health"
- "politics"
- "science"
- "sports"
- "technology"
- "top"
- "world"
type: "string"
maxitems: 5
order: 3
type: "array"
country:
description: "2-letter ISO 3166-1 countries (maximum 5) to restrict the\
\ search to."
items:
enum:
- "ar"
- "au"
- "at"
- "bd"
- "by"
- "be"
- "br"
- "bg"
- "ca"
- "cl"
- "cn"
- "co"
- "cr"
- "cu"
- "cz"
- "dk"
- "do"
- "ec"
- "eg"
- "ee"
- "et"
- "fi"
- "fr"
- "de"
- "gr"
- "hk"
- "hu"
- "in"
- "id"
- "iq"
- "ie"
- "il"
- "it"
- "jp"
- "kz"
- "kw"
- "lv"
- "lb"
- "lt"
- "my"
- "mx"
- "ma"
- "mm"
- "nl"
- "nz"
- "ng"
- "kp"
- "no"
- "pk"
- "pe"
- "ph"
- "pl"
- "pt"
- "pr"
- "ro"
- "ru"
- "sa"
- "rs"
- "sg"
- "sk"
- "si"
- "za"
- "kr"
- "es"
- "se"
- "ch"
- "tw"
- "tz"
- "th"
- "tr"
- "ua"
- "ae"
- "gb"
- "us"
- "ve"
- "vi"
type: "string"
maxitems: 5
order: 2
type: "array"
domain:
description: "Domains (maximum 5) to restrict the search to. Use the sources\
\ stream to find top sources id."
items:
type: "string"
maxitems: 5
order: 1
type: "array"
language:
description: "Languages (maximum 5) to restrict the search to."
items:
enum:
- "be"
- "am"
- "ar"
- "bn"
- "bs"
- "bg"
- "my"
- "ckb"
- "zh"
- "hr"
- "cs"
- "da"
- "nl"
- "en"
- "et"
- "fi"
- "fr"
- "de"
- "el"
- "he"
- "hi"
- "hu"
- "in"
- "it"
- "jp"
- "ko"
- "lv"
- "lt"
- "ms"
- "no"
- "pl"
- "pt"
- "ro"
- "ru"
- "sr"
- "sk"
- "sl"
- "es"
- "sw"
- "sv"
- "th"
- "tr"
- "uk"
- "ur"
- "vi"
type: "string"
maxitems: 5
order: 4
type: "array"
sourceType:
title: "newsdata"
const: "newsdata"
enum:
- "newsdata"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-newsdata-update:
properties:
OneOf:
order: 5
query:
description: "Keywords or phrases to search for in the news title and\
\ content. Advanced Search options:\n - Search `Social`: query = \"\
social\"\n - Search `Social Pizza`: query = \"social pizza\"\n - Search\
\ `Social` but not with `pizza`: query = \"social -pizza\"\n - Search\
\ `Social` but not with `pizza` and `wildfire`: query = \"social\n-pizza\
\ -wildfire\"\n - Search `Social` and `pizza`: query = \"social AND\
\ pizza\"\n - Search `Social` and `pizza` and `pasta`: query = \"social\
\ AND pizza\nAND pasta\"\n - Search `Social` or `pizza`: query = \"\
social OR pizza\"\n - Search `Social` or `pizza` but not `pasta`: query\
\ = \"social OR pizza\n-pasta\"\n - Search `Social` or `pizza` or `pasta`:\
\ query = \"social OR pizza OR\npasta\" Note: You can't use AND and\
\ OR in the same query."
order: 1
type: "string"
query_in_title:
description: "Same as `query`, but restricting the search to only the\
\ news title. It cannot be used along with `query`."
order: 1
type: "string"
api_key:
airbyte_secret: true
description: "API Key"
order: 0
title: "API Key"
type: "string"
category:
description: "Categories (maximum 5) to restrict the search to."
items:
enum:
- "business"
- "entertainment"
- "environment"
- "food"
- "health"
- "politics"
- "science"
- "sports"
- "technology"
- "top"
- "world"
type: "string"
maxitems: 5
order: 3
type: "array"
country:
description: "2-letter ISO 3166-1 countries (maximum 5) to restrict the\
\ search to."
items:
enum:
- "ar"
- "au"
- "at"
- "bd"
- "by"
- "be"
- "br"
- "bg"
- "ca"
- "cl"
- "cn"
- "co"
- "cr"
- "cu"
- "cz"
- "dk"
- "do"
- "ec"
- "eg"
- "ee"
- "et"
- "fi"
- "fr"
- "de"
- "gr"
- "hk"
- "hu"
- "in"
- "id"
- "iq"
- "ie"
- "il"
- "it"
- "jp"
- "kz"
- "kw"
- "lv"
- "lb"
- "lt"
- "my"
- "mx"
- "ma"
- "mm"
- "nl"
- "nz"
- "ng"
- "kp"
- "no"
- "pk"
- "pe"
- "ph"
- "pl"
- "pt"
- "pr"
- "ro"
- "ru"
- "sa"
- "rs"
- "sg"
- "sk"
- "si"
- "za"
- "kr"
- "es"
- "se"
- "ch"
- "tw"
- "tz"
- "th"
- "tr"
- "ua"
- "ae"
- "gb"
- "us"
- "ve"
- "vi"
type: "string"
maxitems: 5
order: 2
type: "array"
domain:
description: "Domains (maximum 5) to restrict the search to. Use the sources\
\ stream to find top sources id."
items:
type: "string"
maxitems: 5
order: 1
type: "array"
language:
description: "Languages (maximum 5) to restrict the search to."
items:
enum:
- "be"
- "am"
- "ar"
- "bn"
- "bs"
- "bg"
- "my"
- "ckb"
- "zh"
- "hr"
- "cs"
- "da"
- "nl"
- "en"
- "et"
- "fi"
- "fr"
- "de"
- "el"
- "he"
- "hi"
- "hu"
- "in"
- "it"
- "jp"
- "ko"
- "lv"
- "lt"
- "ms"
- "no"
- "pl"
- "pt"
- "ro"
- "ru"
- "sr"
- "sk"
- "sl"
- "es"
- "sw"
- "sv"
- "th"
- "tr"
- "uk"
- "ur"
- "vi"
type: "string"
maxitems: 5
order: 4
type: "array"
required:
- "api_key"
type: "object"
source-flexport:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "flexport"
const: "flexport"
enum:
- "flexport"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-flexport-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-high-level:
properties:
api_key:
airbyte_secret: true
order: 1
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
location_id:
order: 0
title: "Location ID"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "high-level"
const: "high-level"
enum:
- "high-level"
order: 0
type: "string"
required:
- "location_id"
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-high-level-update:
properties:
api_key:
airbyte_secret: true
order: 1
title: "API Key"
type: "string"
location_id:
order: 0
title: "Location ID"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "location_id"
- "api_key"
- "start_date"
type: "object"
source-uptick:
properties:
base_url:
description: "eg. https://demo-fire.onuptick.com (no trailing slash)"
order: 0
title: "Base Url"
type: "string"
client_id:
airbyte_secret: true
order: 1
title: "OAuth Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
order: 2
title: "OAuth Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
password:
airbyte_secret: true
order: 4
title: "Uptick API Account Password"
type: "string"
x-speakeasy-param-sensitive: true
username:
order: 3
title: "Uptick API Account Email"
type: "string"
sourceType:
title: "uptick"
const: "uptick"
enum:
- "uptick"
order: 0
type: "string"
required:
- "base_url"
- "client_id"
- "client_secret"
- "username"
- "password"
- "sourceType"
type: "object"
source-uptick-update:
properties:
base_url:
description: "eg. https://demo-fire.onuptick.com (no trailing slash)"
order: 0
title: "Base Url"
type: "string"
client_id:
airbyte_secret: true
order: 1
title: "OAuth Client ID"
type: "string"
client_secret:
airbyte_secret: true
order: 2
title: "OAuth Client Secret"
type: "string"
password:
airbyte_secret: true
order: 4
title: "Uptick API Account Password"
type: "string"
username:
order: 3
title: "Uptick API Account Email"
type: "string"
required:
- "base_url"
- "client_id"
- "client_secret"
- "username"
- "password"
type: "object"
source-google-directory:
properties:
credentials:
description: "Google APIs use the OAuth 2.0 protocol for authentication\
\ and authorization. The Source supports Web server application and Service accounts scenarios."
oneOf:
- description: "For these scenario user only needs to give permission to\
\ read Google Directory data."
properties:
client_id:
airbyte_secret: true
description: "The Client ID of the developer application."
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The Client Secret of the developer application."
title: "Client secret"
type: "string"
x-speakeasy-param-sensitive: true
credentials_title:
const: "Web server app"
description: "Authentication Scenario"
order: 0
title: "Credentials Title"
type: "string"
enum:
- "Web server app"
refresh_token:
airbyte_secret: true
description: "The Token for obtaining a new access token."
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "client_id"
- "client_secret"
- "refresh_token"
title: "Sign in via Google (OAuth)"
type: "object"
- description: "For these scenario user should obtain service account's\
\ credentials from the Google API Console and provide delegated email."
properties:
credentials_json:
airbyte_secret: true
description: "The contents of the JSON service account key. See the\
\ docs for more information on how to generate this key."
title: "Credentials JSON"
type: "string"
x-speakeasy-param-sensitive: true
credentials_title:
const: "Service accounts"
description: "Authentication Scenario"
order: 0
title: "Credentials Title"
type: "string"
enum:
- "Service accounts"
email:
description: "The email of the user, which has permissions to access\
\ the Google Workspace Admin APIs."
title: "Email"
type: "string"
required:
- "credentials_json"
- "email"
title: "Service Account Key"
type: "object"
title: "Google Credentials"
type: "object"
sourceType:
title: "google-directory"
const: "google-directory"
enum:
- "google-directory"
order: 0
type: "string"
required:
- "sourceType"
title: "Google Directory Spec"
type: "object"
source-google-directory-update:
properties:
credentials:
description: "Google APIs use the OAuth 2.0 protocol for authentication\
\ and authorization. The Source supports Web server application and Service accounts scenarios."
oneOf:
- description: "For these scenario user only needs to give permission to\
\ read Google Directory data."
properties:
client_id:
airbyte_secret: true
description: "The Client ID of the developer application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of the developer application."
title: "Client secret"
type: "string"
credentials_title:
const: "Web server app"
description: "Authentication Scenario"
order: 0
title: "Credentials Title"
type: "string"
enum:
- "Web server app"
refresh_token:
airbyte_secret: true
description: "The Token for obtaining a new access token."
title: "Refresh Token"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
title: "Sign in via Google (OAuth)"
type: "object"
- description: "For these scenario user should obtain service account's\
\ credentials from the Google API Console and provide delegated email."
properties:
credentials_json:
airbyte_secret: true
description: "The contents of the JSON service account key. See the\
\ docs for more information on how to generate this key."
title: "Credentials JSON"
type: "string"
credentials_title:
const: "Service accounts"
description: "Authentication Scenario"
order: 0
title: "Credentials Title"
type: "string"
enum:
- "Service accounts"
email:
description: "The email of the user, which has permissions to access\
\ the Google Workspace Admin APIs."
title: "Email"
type: "string"
required:
- "credentials_json"
- "email"
title: "Service Account Key"
type: "object"
title: "Google Credentials"
type: "object"
required: []
title: "Google Directory Spec"
type: "object"
source-smartengage:
properties:
api_key:
airbyte_secret: true
description: "API Key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "smartengage"
const: "smartengage"
enum:
- "smartengage"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-smartengage-update:
properties:
api_key:
airbyte_secret: true
description: "API Key"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-k6-cloud:
properties:
api_token:
airbyte_secret: true
description: "Your API Token. See here. The key is case sensitive."
order: 0
title: "Api Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "k6-cloud"
const: "k6-cloud"
enum:
- "k6-cloud"
order: 0
type: "string"
required:
- "api_token"
- "sourceType"
type: "object"
source-k6-cloud-update:
properties:
api_token:
airbyte_secret: true
description: "Your API Token. See here. The key is case sensitive."
order: 0
title: "Api Token"
type: "string"
required:
- "api_token"
type: "object"
source-postgres:
groups:
- id: "db"
- id: "auth"
- id: "security"
title: "Security"
- id: "advanced"
title: "Advanced"
properties:
database:
description: "Name of the database."
group: "db"
order: 2
title: "Database Name"
type: "string"
entra_client_id:
description: "If using Entra service principal, the application ID of the\
\ service principal"
group: "auth"
title: "Entra client id"
type: "string"
entra_service_principal_auth:
default: false
description: "Interpret password as a client secret for a Microsft Entra\
\ service principal"
group: "auth"
title: "Entra service principal authentication"
type: "boolean"
entra_tenant_id:
description: "If using Entra service principal, the ID of the tenant"
group: "auth"
title: "Entra tenant id"
type: "string"
host:
description: "Hostname of the database."
group: "db"
order: 0
title: "Host"
type: "string"
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."
group: "advanced"
order: 6
pattern_descriptor: "key1=value1&key2=value2"
title: "JDBC URL Parameters (Advanced)"
type: "string"
password:
airbyte_secret: true
always_show: true
description: "Password associated with the username."
group: "auth"
order: 5
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
port:
default: 5432
description: "Port of the database."
examples:
- "5432"
group: "db"
maximum: 65536
minimum: 0
order: 1
title: "Port"
type: "integer"
replication_method:
default: "CDC"
description: "Configures how data is extracted from the database."
display_type: "radio"
group: "advanced"
oneOf:
- additionalProperties: true
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."
properties:
heartbeat_action_query:
default: ""
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."
order: 8
title: "Debezium heartbeat query (Advanced)"
type: "string"
initial_load_timeout_hours:
default: 8
description: "The amount of time an initial load is allowed to continue\
\ for before catching up on CDC logs."
max: 24
min: 4
order: 10
title: "Initial Load Timeout in Hours (Advanced)"
type: "integer"
initial_waiting_seconds:
default: 1200
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."
max: 2400
min: 120
order: 5
title: "Initial Waiting Time in Seconds (Advanced)"
type: "integer"
invalid_cdc_cursor_position_behavior:
default: "Fail sync"
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"
order: 9
title: "Invalid CDC position behavior (Advanced)"
type: "string"
lsn_commit_behaviour:
default: "After loading Data in the destination"
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"
order: 7
title: "LSN commit behaviour"
type: "string"
method:
const: "CDC"
order: 1
type: "string"
enum:
- "CDC"
plugin:
default: "pgoutput"
description: "A logical decoding plugin installed on the PostgreSQL\
\ server."
enum:
- "pgoutput"
order: 2
title: "Plugin"
type: "string"
publication:
description: "A Postgres publication used for consuming changes. Read\
\ about publications and replication identities."
order: 4
title: "Publication"
type: "string"
queue_size:
default: 10000
description: "The size of the internal queue. This may interfere with\
\ memory consumption and efficiency of the connector, please be\
\ careful."
max: 10000
min: 1000
order: 6
title: "Size of the queue (Advanced)"
type: "integer"
replication_slot:
description: "A plugin logical replication slot. Read about replication slots."
order: 3
title: "Replication Slot"
type: "string"
required:
- "method"
- "replication_slot"
- "publication"
title: "Read Changes using Write-Ahead Log (CDC)"
- description: "Recommended - Incrementally reads new inserts and\
\ updates via Postgres Xmin system column. Suitable for databases that have low transaction\
\ pressure."
properties:
method:
const: "Xmin"
order: 0
type: "string"
enum:
- "Xmin"
required:
- "method"
title: "Detect Changes with Xmin System Column"
- description: "Incrementally detects new inserts and updates using the\
\ cursor column chosen when configuring a connection (e.g. created_at,\
\ updated_at)."
properties:
method:
const: "Standard"
order: 8
type: "string"
enum:
- "Standard"
required:
- "method"
title: "Scan Changes with User Defined Cursor"
order: 9
title: "Update Method"
type: "object"
schemas:
default:
- "public"
description: "The list of schemas (case sensitive) to sync from. Defaults\
\ to public."
group: "db"
items:
type: "string"
minItems: 0
order: 3
title: "Schemas"
type: "array"
uniqueItems: true
ssl_mode:
description: "SSL connection modes. \n Read more in the docs."
group: "security"
oneOf:
- additionalProperties: true
description: "Disables encryption of communication between Airbyte and\
\ source database."
properties:
mode:
const: "disable"
order: 0
type: "string"
enum:
- "disable"
required:
- "mode"
title: "disable"
- additionalProperties: true
description: "Enables encryption only when required by the source database."
properties:
mode:
const: "allow"
order: 0
type: "string"
enum:
- "allow"
required:
- "mode"
title: "allow"
- additionalProperties: true
description: "Allows unencrypted connection only if the source database\
\ does not support encryption."
properties:
mode:
const: "prefer"
order: 0
type: "string"
enum:
- "prefer"
required:
- "mode"
title: "prefer"
- additionalProperties: true
description: "Always require encryption. If the source database server\
\ does not support encryption, connection will fail."
properties:
mode:
const: "require"
order: 0
type: "string"
enum:
- "require"
required:
- "mode"
title: "require"
- additionalProperties: true
description: "Always require encryption and verifies that the source database\
\ server has a valid SSL certificate."
properties:
ca_certificate:
airbyte_secret: true
description: "CA certificate"
multiline: true
order: 1
title: "CA Certificate"
type: "string"
x-speakeasy-param-sensitive: true
client_certificate:
airbyte_secret: true
always_show: true
description: "Client certificate"
multiline: true
order: 2
title: "Client Certificate"
type: "string"
x-speakeasy-param-sensitive: true
client_key:
airbyte_secret: true
always_show: true
description: "Client key"
multiline: true
order: 3
title: "Client Key"
type: "string"
x-speakeasy-param-sensitive: true
client_key_password:
airbyte_secret: true
description: "Password for keystorage. If you do not add it - the\
\ password will be generated automatically."
order: 4
title: "Client key password"
type: "string"
x-speakeasy-param-sensitive: true
mode:
const: "verify-ca"
order: 0
type: "string"
enum:
- "verify-ca"
required:
- "mode"
- "ca_certificate"
title: "verify-ca"
- additionalProperties: true
description: "This is the most secure mode. Always require encryption\
\ and verifies the identity of the source database server."
properties:
ca_certificate:
airbyte_secret: true
description: "CA certificate"
multiline: true
order: 1
title: "CA Certificate"
type: "string"
x-speakeasy-param-sensitive: true
client_certificate:
airbyte_secret: true
always_show: true
description: "Client certificate"
multiline: true
order: 2
title: "Client Certificate"
type: "string"
x-speakeasy-param-sensitive: true
client_key:
airbyte_secret: true
always_show: true
description: "Client key"
multiline: true
order: 3
title: "Client Key"
type: "string"
x-speakeasy-param-sensitive: true
client_key_password:
airbyte_secret: true
description: "Password for keystorage. If you do not add it - the\
\ password will be generated automatically."
order: 4
title: "Client key password"
type: "string"
x-speakeasy-param-sensitive: true
mode:
const: "verify-full"
order: 0
type: "string"
enum:
- "verify-full"
required:
- "mode"
- "ca_certificate"
title: "verify-full"
order: 8
title: "SSL Modes"
type: "object"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
group: "security"
oneOf:
- properties:
tunnel_method:
const: "NO_TUNNEL"
description: "No ssh tunnel needed to connect to database"
order: 0
type: "string"
enum:
- "NO_TUNNEL"
required:
- "tunnel_method"
title: "No Tunnel"
- properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
x-speakeasy-param-sensitive: true
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_KEY_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host."
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
- properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
title: "SSH Tunnel Method"
type: "object"
username:
description: "Username to access the database."
group: "auth"
order: 4
title: "Username"
type: "string"
sourceType:
title: "postgres"
const: "postgres"
enum:
- "postgres"
order: 0
type: "string"
required:
- "host"
- "port"
- "database"
- "username"
- "sourceType"
title: "Postgres Source Spec"
type: "object"
source-postgres-update:
groups:
- id: "db"
- id: "auth"
- id: "security"
title: "Security"
- id: "advanced"
title: "Advanced"
properties:
database:
description: "Name of the database."
group: "db"
order: 2
title: "Database Name"
type: "string"
entra_client_id:
description: "If using Entra service principal, the application ID of the\
\ service principal"
group: "auth"
title: "Entra client id"
type: "string"
entra_service_principal_auth:
default: false
description: "Interpret password as a client secret for a Microsft Entra\
\ service principal"
group: "auth"
title: "Entra service principal authentication"
type: "boolean"
entra_tenant_id:
description: "If using Entra service principal, the ID of the tenant"
group: "auth"
title: "Entra tenant id"
type: "string"
host:
description: "Hostname of the database."
group: "db"
order: 0
title: "Host"
type: "string"
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."
group: "advanced"
order: 6
pattern_descriptor: "key1=value1&key2=value2"
title: "JDBC URL Parameters (Advanced)"
type: "string"
password:
airbyte_secret: true
always_show: true
description: "Password associated with the username."
group: "auth"
order: 5
title: "Password"
type: "string"
port:
default: 5432
description: "Port of the database."
examples:
- "5432"
group: "db"
maximum: 65536
minimum: 0
order: 1
title: "Port"
type: "integer"
replication_method:
default: "CDC"
description: "Configures how data is extracted from the database."
display_type: "radio"
group: "advanced"
oneOf:
- additionalProperties: true
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."
properties:
heartbeat_action_query:
default: ""
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."
order: 8
title: "Debezium heartbeat query (Advanced)"
type: "string"
initial_load_timeout_hours:
default: 8
description: "The amount of time an initial load is allowed to continue\
\ for before catching up on CDC logs."
max: 24
min: 4
order: 10
title: "Initial Load Timeout in Hours (Advanced)"
type: "integer"
initial_waiting_seconds:
default: 1200
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."
max: 2400
min: 120
order: 5
title: "Initial Waiting Time in Seconds (Advanced)"
type: "integer"
invalid_cdc_cursor_position_behavior:
default: "Fail sync"
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"
order: 9
title: "Invalid CDC position behavior (Advanced)"
type: "string"
lsn_commit_behaviour:
default: "After loading Data in the destination"
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"
order: 7
title: "LSN commit behaviour"
type: "string"
method:
const: "CDC"
order: 1
type: "string"
enum:
- "CDC"
plugin:
default: "pgoutput"
description: "A logical decoding plugin installed on the PostgreSQL\
\ server."
enum:
- "pgoutput"
order: 2
title: "Plugin"
type: "string"
publication:
description: "A Postgres publication used for consuming changes. Read\
\ about publications and replication identities."
order: 4
title: "Publication"
type: "string"
queue_size:
default: 10000
description: "The size of the internal queue. This may interfere with\
\ memory consumption and efficiency of the connector, please be\
\ careful."
max: 10000
min: 1000
order: 6
title: "Size of the queue (Advanced)"
type: "integer"
replication_slot:
description: "A plugin logical replication slot. Read about replication slots."
order: 3
title: "Replication Slot"
type: "string"
required:
- "method"
- "replication_slot"
- "publication"
title: "Read Changes using Write-Ahead Log (CDC)"
- description: "Recommended - Incrementally reads new inserts and\
\ updates via Postgres Xmin system column. Suitable for databases that have low transaction\
\ pressure."
properties:
method:
const: "Xmin"
order: 0
type: "string"
enum:
- "Xmin"
required:
- "method"
title: "Detect Changes with Xmin System Column"
- description: "Incrementally detects new inserts and updates using the\
\ cursor column chosen when configuring a connection (e.g. created_at,\
\ updated_at)."
properties:
method:
const: "Standard"
order: 8
type: "string"
enum:
- "Standard"
required:
- "method"
title: "Scan Changes with User Defined Cursor"
order: 9
title: "Update Method"
type: "object"
schemas:
default:
- "public"
description: "The list of schemas (case sensitive) to sync from. Defaults\
\ to public."
group: "db"
items:
type: "string"
minItems: 0
order: 3
title: "Schemas"
type: "array"
uniqueItems: true
ssl_mode:
description: "SSL connection modes. \n Read more in the docs."
group: "security"
oneOf:
- additionalProperties: true
description: "Disables encryption of communication between Airbyte and\
\ source database."
properties:
mode:
const: "disable"
order: 0
type: "string"
enum:
- "disable"
required:
- "mode"
title: "disable"
- additionalProperties: true
description: "Enables encryption only when required by the source database."
properties:
mode:
const: "allow"
order: 0
type: "string"
enum:
- "allow"
required:
- "mode"
title: "allow"
- additionalProperties: true
description: "Allows unencrypted connection only if the source database\
\ does not support encryption."
properties:
mode:
const: "prefer"
order: 0
type: "string"
enum:
- "prefer"
required:
- "mode"
title: "prefer"
- additionalProperties: true
description: "Always require encryption. If the source database server\
\ does not support encryption, connection will fail."
properties:
mode:
const: "require"
order: 0
type: "string"
enum:
- "require"
required:
- "mode"
title: "require"
- additionalProperties: true
description: "Always require encryption and verifies that the source database\
\ server has a valid SSL certificate."
properties:
ca_certificate:
airbyte_secret: true
description: "CA certificate"
multiline: true
order: 1
title: "CA Certificate"
type: "string"
client_certificate:
airbyte_secret: true
always_show: true
description: "Client certificate"
multiline: true
order: 2
title: "Client Certificate"
type: "string"
client_key:
airbyte_secret: true
always_show: true
description: "Client key"
multiline: true
order: 3
title: "Client Key"
type: "string"
client_key_password:
airbyte_secret: true
description: "Password for keystorage. If you do not add it - the\
\ password will be generated automatically."
order: 4
title: "Client key password"
type: "string"
mode:
const: "verify-ca"
order: 0
type: "string"
enum:
- "verify-ca"
required:
- "mode"
- "ca_certificate"
title: "verify-ca"
- additionalProperties: true
description: "This is the most secure mode. Always require encryption\
\ and verifies the identity of the source database server."
properties:
ca_certificate:
airbyte_secret: true
description: "CA certificate"
multiline: true
order: 1
title: "CA Certificate"
type: "string"
client_certificate:
airbyte_secret: true
always_show: true
description: "Client certificate"
multiline: true
order: 2
title: "Client Certificate"
type: "string"
client_key:
airbyte_secret: true
always_show: true
description: "Client key"
multiline: true
order: 3
title: "Client Key"
type: "string"
client_key_password:
airbyte_secret: true
description: "Password for keystorage. If you do not add it - the\
\ password will be generated automatically."
order: 4
title: "Client key password"
type: "string"
mode:
const: "verify-full"
order: 0
type: "string"
enum:
- "verify-full"
required:
- "mode"
- "ca_certificate"
title: "verify-full"
order: 8
title: "SSL Modes"
type: "object"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
group: "security"
oneOf:
- properties:
tunnel_method:
const: "NO_TUNNEL"
description: "No ssh tunnel needed to connect to database"
order: 0
type: "string"
enum:
- "NO_TUNNEL"
required:
- "tunnel_method"
title: "No Tunnel"
- properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_KEY_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host."
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
- properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
title: "SSH Tunnel Method"
type: "object"
username:
description: "Username to access the database."
group: "auth"
order: 4
title: "Username"
type: "string"
required:
- "host"
- "port"
- "database"
- "username"
title: "Postgres Source Spec"
type: "object"
source-fauna:
properties:
collection:
description: "Settings for the Fauna Collection."
order: 5
properties:
deletions:
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:
- order: 0
properties:
deletion_mode:
const: "ignore"
type: "string"
enum:
- "ignore"
required:
- "deletion_mode"
title: "Disabled"
type: "object"
- order: 1
properties:
column:
default: "deleted_at"
description: "Name of the \"deleted at\" column."
title: "Deleted At Column"
type: "string"
deletion_mode:
const: "deleted_field"
type: "string"
enum:
- "deleted_field"
required:
- "deletion_mode"
- "column"
title: "Enabled"
type: "object"
order: 5
title: "Deletion Mode"
type: "object"
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."
order: 4
title: "Page Size"
type: "integer"
required:
- "page_size"
- "deletions"
title: "Collection"
type: "object"
domain:
default: "db.fauna.com"
description: "Domain of Fauna to query. Defaults db.fauna.com. See the\
\ docs."
order: 0
title: "Domain"
type: "string"
port:
default: 443
description: "Endpoint port."
order: 1
title: "Port"
type: "integer"
scheme:
default: "https"
description: "URL scheme."
order: 2
title: "Scheme"
type: "string"
secret:
airbyte_secret: true
description: "Fauna secret, used when authenticating with the database."
order: 3
title: "Fauna Secret"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "fauna"
const: "fauna"
enum:
- "fauna"
order: 0
type: "string"
required:
- "domain"
- "port"
- "scheme"
- "secret"
- "sourceType"
title: "Fauna Spec"
type: "object"
source-fauna-update:
properties:
collection:
description: "Settings for the Fauna Collection."
order: 5
properties:
deletions:
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:
- order: 0
properties:
deletion_mode:
const: "ignore"
type: "string"
enum:
- "ignore"
required:
- "deletion_mode"
title: "Disabled"
type: "object"
- order: 1
properties:
column:
default: "deleted_at"
description: "Name of the \"deleted at\" column."
title: "Deleted At Column"
type: "string"
deletion_mode:
const: "deleted_field"
type: "string"
enum:
- "deleted_field"
required:
- "deletion_mode"
- "column"
title: "Enabled"
type: "object"
order: 5
title: "Deletion Mode"
type: "object"
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."
order: 4
title: "Page Size"
type: "integer"
required:
- "page_size"
- "deletions"
title: "Collection"
type: "object"
domain:
default: "db.fauna.com"
description: "Domain of Fauna to query. Defaults db.fauna.com. See the\
\ docs."
order: 0
title: "Domain"
type: "string"
port:
default: 443
description: "Endpoint port."
order: 1
title: "Port"
type: "integer"
scheme:
default: "https"
description: "URL scheme."
order: 2
title: "Scheme"
type: "string"
secret:
airbyte_secret: true
description: "Fauna secret, used when authenticating with the database."
order: 3
title: "Fauna Secret"
type: "string"
required:
- "domain"
- "port"
- "scheme"
- "secret"
title: "Fauna Spec"
type: "object"
source-twilio:
properties:
account_sid:
airbyte_secret: true
description: "Twilio account SID"
order: 1
title: "Account ID"
type: "string"
x-speakeasy-param-sensitive: true
auth_token:
airbyte_secret: true
description: "Twilio Auth Token."
order: 2
title: "Auth Token"
type: "string"
x-speakeasy-param-sensitive: true
lookback_window:
default: 0
description: "How far into the past to look for records. (in minutes)"
examples:
- 60
maximum: 576000
minimum: 0
order: 4
title: "Lookback window"
type: "integer"
num_worker:
default: 3
description: "The number of worker threads to use for the sync."
examples:
- 1
- 2
- 3
maximum: 40
minimum: 1
order: 5
title: "Number of concurrent threads"
type: "integer"
start_date:
description: "UTC date and time in the format 2020-10-01T00:00:00Z. Any\
\ data before this date will not be replicated."
examples:
- "2020-10-01T00:00:00Z"
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Replication Start Date"
type: "string"
sourceType:
title: "twilio"
const: "twilio"
enum:
- "twilio"
order: 0
type: "string"
required:
- "account_sid"
- "auth_token"
- "start_date"
- "sourceType"
title: "Twilio Spec"
type: "object"
source-twilio-update:
properties:
account_sid:
airbyte_secret: true
description: "Twilio account SID"
order: 1
title: "Account ID"
type: "string"
auth_token:
airbyte_secret: true
description: "Twilio Auth Token."
order: 2
title: "Auth Token"
type: "string"
lookback_window:
default: 0
description: "How far into the past to look for records. (in minutes)"
examples:
- 60
maximum: 576000
minimum: 0
order: 4
title: "Lookback window"
type: "integer"
num_worker:
default: 3
description: "The number of worker threads to use for the sync."
examples:
- 1
- 2
- 3
maximum: 40
minimum: 1
order: 5
title: "Number of concurrent threads"
type: "integer"
start_date:
description: "UTC date and time in the format 2020-10-01T00:00:00Z. Any\
\ data before this date will not be replicated."
examples:
- "2020-10-01T00:00:00Z"
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Replication Start Date"
type: "string"
required:
- "account_sid"
- "auth_token"
- "start_date"
title: "Twilio Spec"
type: "object"
source-sendgrid:
properties:
api_key:
airbyte_secret: true
description: "Sendgrid API Key, use admin to generate this key."
order: 1
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\
\ data before this date will not be replicated."
format: "date-time"
order: 0
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "sendgrid"
const: "sendgrid"
enum:
- "sendgrid"
order: 0
type: "string"
required:
- "start_date"
- "api_key"
- "sourceType"
type: "object"
source-sendgrid-update:
properties:
api_key:
airbyte_secret: true
description: "Sendgrid API Key, use admin to generate this key."
order: 1
title: "API Key"
type: "string"
start_date:
description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\
\ data before this date will not be replicated."
format: "date-time"
order: 0
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "start_date"
- "api_key"
type: "object"
source-google-ads:
properties:
conversion_window_days:
default: 14
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."
examples:
- 14
maximum: 1095
minimum: 0
order: 6
title: "Conversion Window"
type: "integer"
credentials:
description: ""
order: 0
properties:
access_token:
airbyte_secret: true
description: "The Access Token for making authenticated requests. For\
\ detailed instructions on finding this value, refer to our documentation."
order: 4
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
client_id:
description: "The Client ID of your Google Ads developer application.\
\ For detailed instructions on finding this value, refer to our documentation."
order: 1
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Google Ads developer application.\
\ For detailed instructions on finding this value, refer to our documentation."
order: 2
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
developer_token:
airbyte_secret: true
description: "The Developer Token granted by Google to use their APIs.\
\ For detailed instructions on finding this value, refer to our documentation."
order: 0
title: "Developer Token"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "The token used to obtain a new Access Token. For detailed\
\ instructions on finding this value, refer to our documentation."
order: 3
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "developer_token"
- "client_id"
- "client_secret"
- "refresh_token"
title: "Google Credentials"
type: "object"
custom_queries_array:
description: ""
items:
properties:
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'"
multiline: true
title: "Custom Query"
type: "string"
table_name:
description: "The table name in your destination database for the\
\ chosen query."
title: "Destination Table Name"
type: "string"
required:
- "query"
- "table_name"
type: "object"
order: 5
title: "Custom GAQL Queries"
type: "array"
customer_id:
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."
examples:
- "6783948572,5839201945"
order: 1
pattern: "^[0-9]{10}(,[0-9]{10})*$"
pattern_descriptor: "The customer ID must be 10 digits. Separate multiple\
\ customer IDs using commas."
title: "Customer ID(s)"
type: "string"
customer_status_filter:
default: []
description: "A list of customer statuses to filter on. For detailed info\
\ about what each status mean refer to Google Ads documentation."
items:
description: "An enumeration."
enum:
- "UNKNOWN"
- "ENABLED"
- "CANCELED"
- "SUSPENDED"
- "CLOSED"
title: "CustomerStatus"
order: 2
title: "Customer Statuses Filter"
type: "array"
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)"
examples:
- "2017-01-30"
format: "date"
order: 4
pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
pattern_descriptor: "YYYY-MM-DD"
title: "End Date"
type: "string"
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)"
examples:
- "2017-01-25"
format: "date"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
pattern_descriptor: "YYYY-MM-DD"
title: "Start Date"
type: "string"
sourceType:
title: "google-ads"
const: "google-ads"
enum:
- "google-ads"
order: 0
type: "string"
required:
- "credentials"
- "sourceType"
title: "Google Ads Spec"
type: "object"
source-google-ads-update:
properties:
conversion_window_days:
default: 14
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."
examples:
- 14
maximum: 1095
minimum: 0
order: 6
title: "Conversion Window"
type: "integer"
credentials:
description: ""
order: 0
properties:
access_token:
airbyte_secret: true
description: "The Access Token for making authenticated requests. For\
\ detailed instructions on finding this value, refer to our documentation."
order: 4
title: "Access Token"
type: "string"
client_id:
description: "The Client ID of your Google Ads developer application.\
\ For detailed instructions on finding this value, refer to our documentation."
order: 1
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Google Ads developer application.\
\ For detailed instructions on finding this value, refer to our documentation."
order: 2
title: "Client Secret"
type: "string"
developer_token:
airbyte_secret: true
description: "The Developer Token granted by Google to use their APIs.\
\ For detailed instructions on finding this value, refer to our documentation."
order: 0
title: "Developer Token"
type: "string"
refresh_token:
airbyte_secret: true
description: "The token used to obtain a new Access Token. For detailed\
\ instructions on finding this value, refer to our documentation."
order: 3
title: "Refresh Token"
type: "string"
required:
- "developer_token"
- "client_id"
- "client_secret"
- "refresh_token"
title: "Google Credentials"
type: "object"
custom_queries_array:
description: ""
items:
properties:
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'"
multiline: true
title: "Custom Query"
type: "string"
table_name:
description: "The table name in your destination database for the\
\ chosen query."
title: "Destination Table Name"
type: "string"
required:
- "query"
- "table_name"
type: "object"
order: 5
title: "Custom GAQL Queries"
type: "array"
customer_id:
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."
examples:
- "6783948572,5839201945"
order: 1
pattern: "^[0-9]{10}(,[0-9]{10})*$"
pattern_descriptor: "The customer ID must be 10 digits. Separate multiple\
\ customer IDs using commas."
title: "Customer ID(s)"
type: "string"
customer_status_filter:
default: []
description: "A list of customer statuses to filter on. For detailed info\
\ about what each status mean refer to Google Ads documentation."
items:
description: "An enumeration."
enum:
- "UNKNOWN"
- "ENABLED"
- "CANCELED"
- "SUSPENDED"
- "CLOSED"
title: "CustomerStatus"
order: 2
title: "Customer Statuses Filter"
type: "array"
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)"
examples:
- "2017-01-30"
format: "date"
order: 4
pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
pattern_descriptor: "YYYY-MM-DD"
title: "End Date"
type: "string"
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)"
examples:
- "2017-01-25"
format: "date"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
pattern_descriptor: "YYYY-MM-DD"
title: "Start Date"
type: "string"
required:
- "credentials"
title: "Google Ads Spec"
type: "object"
source-google-search-console:
properties:
always_use_aggregation_type_auto:
default: false
description: "Some search analytics streams fail with a 400 error if the\
\ specified `aggregationType` is not supported. This is customer implementation\
\ dependent and if this error is encountered, enable this setting which\
\ will override the existing `aggregationType` to use `auto` which should\
\ resolve the stream errors."
order: 8
title: "Always Use Aggregation Type Auto"
type: "boolean"
authorization:
description: ""
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access token for making authenticated requests. Read\
\ more here."
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "Client"
order: 0
type: "string"
enum:
- "Client"
client_id:
airbyte_secret: true
description: "The client ID of your Google Search Console developer\
\ application. Read more here."
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The client secret of your Google Search Console developer\
\ application. Read more here."
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "The token for obtaining a new access token. Read more\
\ here."
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_type"
- "client_id"
- "client_secret"
- "refresh_token"
title: "OAuth"
type: "object"
- properties:
auth_type:
const: "Service"
order: 0
type: "string"
enum:
- "Service"
email:
description: "The email of the user which has permissions to access\
\ the Google Workspace Admin APIs."
title: "Admin Email"
type: "string"
service_account_info:
airbyte_secret: true
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, ... }"
title: "Service Account JSON Key"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_type"
- "service_account_info"
- "email"
title: "Service Account Key Authentication"
type: "object"
order: 3
title: "Authentication Type"
type: "object"
custom_reports_array:
description: "You can add your Custom Analytics report by creating one."
items:
properties:
dimensions:
default:
- "date"
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`."
items:
description: "An enumeration of dimensions."
enum:
- "country"
- "date"
- "device"
- "page"
- "query"
title: "ValidEnums"
minItems: 0
title: "Dimensions"
type: "array"
name:
description: "The name of the custom report, this name would be used\
\ as stream name"
title: "Name"
type: "string"
required:
- "name"
- "dimensions"
title: "Custom Report Config"
type: "object"
order: 5
title: "Custom Reports"
type: "array"
data_state:
default: "final"
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."
enum:
- "final"
- "all"
examples:
- "final"
- "all"
order: 6
title: "Data Freshness"
type: "string"
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"
format: "date"
order: 2
pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
pattern_descriptor: "YYYY-MM-DD"
title: "End Date"
type: "string"
num_workers:
default: 40
description: "The number of worker threads to use for the sync. For more\
\ details on Google Search Console rate limits, refer to the docs."
examples:
- 30
- 40
- 50
maximum: 100
minimum: 2
order: 7
title: "Number of concurrent threads"
type: "integer"
site_urls:
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"
items:
type: "string"
order: 0
title: "Website URL Property"
type: "array"
start_date:
always_show: true
default: "2021-01-01"
description: "UTC date in the format YYYY-MM-DD. Any data before this date\
\ will not be replicated."
format: "date"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
pattern_descriptor: "YYYY-MM-DD"
title: "Start Date"
type: "string"
sourceType:
title: "google-search-console"
const: "google-search-console"
enum:
- "google-search-console"
order: 0
type: "string"
required:
- "site_urls"
- "authorization"
- "sourceType"
title: "Google Search Console Spec"
type: "object"
source-google-search-console-update:
properties:
always_use_aggregation_type_auto:
default: false
description: "Some search analytics streams fail with a 400 error if the\
\ specified `aggregationType` is not supported. This is customer implementation\
\ dependent and if this error is encountered, enable this setting which\
\ will override the existing `aggregationType` to use `auto` which should\
\ resolve the stream errors."
order: 8
title: "Always Use Aggregation Type Auto"
type: "boolean"
authorization:
description: ""
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access token for making authenticated requests. Read\
\ more here."
title: "Access Token"
type: "string"
auth_type:
const: "Client"
order: 0
type: "string"
enum:
- "Client"
client_id:
airbyte_secret: true
description: "The client ID of your Google Search Console developer\
\ application. Read more here."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The client secret of your Google Search Console developer\
\ application. Read more here."
title: "Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "The token for obtaining a new access token. Read more\
\ here."
title: "Refresh Token"
type: "string"
required:
- "auth_type"
- "client_id"
- "client_secret"
- "refresh_token"
title: "OAuth"
type: "object"
- properties:
auth_type:
const: "Service"
order: 0
type: "string"
enum:
- "Service"
email:
description: "The email of the user which has permissions to access\
\ the Google Workspace Admin APIs."
title: "Admin Email"
type: "string"
service_account_info:
airbyte_secret: true
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, ... }"
title: "Service Account JSON Key"
type: "string"
required:
- "auth_type"
- "service_account_info"
- "email"
title: "Service Account Key Authentication"
type: "object"
order: 3
title: "Authentication Type"
type: "object"
custom_reports_array:
description: "You can add your Custom Analytics report by creating one."
items:
properties:
dimensions:
default:
- "date"
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`."
items:
description: "An enumeration of dimensions."
enum:
- "country"
- "date"
- "device"
- "page"
- "query"
title: "ValidEnums"
minItems: 0
title: "Dimensions"
type: "array"
name:
description: "The name of the custom report, this name would be used\
\ as stream name"
title: "Name"
type: "string"
required:
- "name"
- "dimensions"
title: "Custom Report Config"
type: "object"
order: 5
title: "Custom Reports"
type: "array"
data_state:
default: "final"
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."
enum:
- "final"
- "all"
examples:
- "final"
- "all"
order: 6
title: "Data Freshness"
type: "string"
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"
format: "date"
order: 2
pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
pattern_descriptor: "YYYY-MM-DD"
title: "End Date"
type: "string"
num_workers:
default: 40
description: "The number of worker threads to use for the sync. For more\
\ details on Google Search Console rate limits, refer to the docs."
examples:
- 30
- 40
- 50
maximum: 100
minimum: 2
order: 7
title: "Number of concurrent threads"
type: "integer"
site_urls:
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"
items:
type: "string"
order: 0
title: "Website URL Property"
type: "array"
start_date:
always_show: true
default: "2021-01-01"
description: "UTC date in the format YYYY-MM-DD. Any data before this date\
\ will not be replicated."
format: "date"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
pattern_descriptor: "YYYY-MM-DD"
title: "Start Date"
type: "string"
required:
- "site_urls"
- "authorization"
title: "Google Search Console Spec"
type: "object"
source-callrail:
properties:
account_id:
airbyte_secret: true
description: "Account ID"
order: 1
type: "string"
x-speakeasy-param-sensitive: true
api_key:
airbyte_secret: true
description: "API access key"
order: 0
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "Start getting data from that date."
examples:
- "%Y-%m-%d"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
type: "string"
sourceType:
title: "callrail"
const: "callrail"
enum:
- "callrail"
order: 0
type: "string"
required:
- "api_key"
- "account_id"
- "start_date"
- "sourceType"
type: "object"
source-callrail-update:
properties:
account_id:
airbyte_secret: true
description: "Account ID"
order: 1
type: "string"
api_key:
airbyte_secret: true
description: "API access key"
order: 0
type: "string"
start_date:
description: "Start getting data from that date."
examples:
- "%Y-%m-%d"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
type: "string"
required:
- "api_key"
- "account_id"
- "start_date"
type: "object"
source-strava:
properties:
athlete_id:
description: "The Athlete ID of your Strava developer application."
examples:
- "17831421"
order: 3
pattern: "^[0-9_\\-]+$"
title: "Athlete ID"
type: "integer"
auth_type:
const: "Client"
default: "Client"
enum:
- "Client"
order: 5
type: "string"
client_id:
description: "The Client ID of your Strava developer application."
examples:
- "12345"
order: 0
pattern: "^[0-9_\\-]+$"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Strava developer application."
examples:
- "fc6243f283e51f6ca989aab298b17da125496f50"
order: 1
pattern: "^[0-9a-fA-F]+$"
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "The Refresh Token with the activity: read_all permissions."
examples:
- "fc6243f283e51f6ca989aab298b17da125496f50"
order: 2
pattern: "^[0-9a-fA-F]+$"
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "UTC date and time. Any data before this date will not be replicated."
examples:
- "2021-03-01T00:00:00Z"
format: "date-time"
order: 4
title: "Start Date"
type: "string"
sourceType:
title: "strava"
const: "strava"
enum:
- "strava"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "athlete_id"
- "start_date"
- "sourceType"
type: "object"
source-strava-update:
properties:
athlete_id:
description: "The Athlete ID of your Strava developer application."
examples:
- "17831421"
order: 3
pattern: "^[0-9_\\-]+$"
title: "Athlete ID"
type: "integer"
auth_type:
const: "Client"
default: "Client"
enum:
- "Client"
order: 5
type: "string"
client_id:
description: "The Client ID of your Strava developer application."
examples:
- "12345"
order: 0
pattern: "^[0-9_\\-]+$"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Strava developer application."
examples:
- "fc6243f283e51f6ca989aab298b17da125496f50"
order: 1
pattern: "^[0-9a-fA-F]+$"
title: "Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "The Refresh Token with the activity: read_all permissions."
examples:
- "fc6243f283e51f6ca989aab298b17da125496f50"
order: 2
pattern: "^[0-9a-fA-F]+$"
title: "Refresh Token"
type: "string"
start_date:
description: "UTC date and time. Any data before this date will not be replicated."
examples:
- "2021-03-01T00:00:00Z"
format: "date-time"
order: 4
title: "Start Date"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "athlete_id"
- "start_date"
type: "object"
source-smaily:
properties:
api_password:
airbyte_secret: true
description: "API user password. See https://smaily.com/help/api/general/create-api-user/"
order: 0
title: "API User Password"
type: "string"
x-speakeasy-param-sensitive: true
api_subdomain:
description: "API Subdomain. See https://smaily.com/help/api/general/create-api-user/"
order: 1
title: "API Subdomain"
type: "string"
api_username:
description: "API user username. See https://smaily.com/help/api/general/create-api-user/"
order: 2
title: "API User Username"
type: "string"
sourceType:
title: "smaily"
const: "smaily"
enum:
- "smaily"
order: 0
type: "string"
required:
- "api_password"
- "api_subdomain"
- "api_username"
- "sourceType"
type: "object"
source-smaily-update:
properties:
api_password:
airbyte_secret: true
description: "API user password. See https://smaily.com/help/api/general/create-api-user/"
order: 0
title: "API User Password"
type: "string"
api_subdomain:
description: "API Subdomain. See https://smaily.com/help/api/general/create-api-user/"
order: 1
title: "API Subdomain"
type: "string"
api_username:
description: "API user username. See https://smaily.com/help/api/general/create-api-user/"
order: 2
title: "API User Username"
type: "string"
required:
- "api_password"
- "api_subdomain"
- "api_username"
type: "object"
source-easypromos:
properties:
bearer_token:
airbyte_secret: true
name: "jwt_token"
order: 0
title: "Bearer Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "easypromos"
const: "easypromos"
enum:
- "easypromos"
order: 0
type: "string"
required:
- "bearer_token"
- "sourceType"
type: "object"
source-easypromos-update:
properties:
bearer_token:
airbyte_secret: true
name: "jwt_token"
order: 0
title: "Bearer Token"
type: "string"
required:
- "bearer_token"
type: "object"
source-ubidots:
properties:
api_token:
airbyte_secret: true
description: "API token to use for authentication. Obtain it from your Ubidots\
\ account."
name: "api_token"
order: 0
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "ubidots"
const: "ubidots"
enum:
- "ubidots"
order: 0
type: "string"
required:
- "api_token"
- "sourceType"
type: "object"
source-ubidots-update:
properties:
api_token:
airbyte_secret: true
description: "API token to use for authentication. Obtain it from your Ubidots\
\ account."
name: "api_token"
order: 0
title: "API Token"
type: "string"
required:
- "api_token"
type: "object"
source-height:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
search_query:
default: "task"
description: "Search query to be used with search stream"
order: 2
title: "search_query"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "height"
const: "height"
enum:
- "height"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-height-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
search_query:
default: "task"
description: "Search query to be used with search stream"
order: 2
title: "search_query"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-castor-edc:
properties:
client_id:
airbyte_secret: true
description: "Visit `https://YOUR_REGION.castoredc.com/account/settings`"
order: 1
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "Visit `https://YOUR_REGION.castoredc.com/account/settings`"
order: 2
title: "Client secret"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
url_region:
default: "uk"
description: "The url region given at time of registration"
enum:
- "uk"
- "nl"
- "us"
order: 0
title: "URL Region"
type: "string"
sourceType:
title: "castor-edc"
const: "castor-edc"
enum:
- "castor-edc"
order: 0
type: "string"
required:
- "url_region"
- "client_id"
- "client_secret"
- "start_date"
- "sourceType"
type: "object"
source-castor-edc-update:
properties:
client_id:
airbyte_secret: true
description: "Visit `https://YOUR_REGION.castoredc.com/account/settings`"
order: 1
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Visit `https://YOUR_REGION.castoredc.com/account/settings`"
order: 2
title: "Client secret"
type: "string"
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
url_region:
default: "uk"
description: "The url region given at time of registration"
enum:
- "uk"
- "nl"
- "us"
order: 0
title: "URL Region"
type: "string"
required:
- "url_region"
- "client_id"
- "client_secret"
- "start_date"
type: "object"
source-ruddr:
properties:
api_token:
airbyte_secret: true
description: "API token to use. Generate it in the API Keys section of your\
\ Ruddr workspace settings."
name: "api_token"
order: 0
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "ruddr"
const: "ruddr"
enum:
- "ruddr"
order: 0
type: "string"
required:
- "api_token"
- "sourceType"
type: "object"
source-ruddr-update:
properties:
api_token:
airbyte_secret: true
description: "API token to use. Generate it in the API Keys section of your\
\ Ruddr workspace settings."
name: "api_token"
order: 0
title: "API Token"
type: "string"
required:
- "api_token"
type: "object"
source-polygon-stock-api:
properties:
adjusted:
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"
order: 0
title: "Adjusted"
type: "string"
apiKey:
airbyte_secret: true
description: "Your API ACCESS Key"
order: 1
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
end_date:
description: "The target date for the aggregate window."
examples:
- "2020-10-14"
format: "date"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "End Date"
type: "string"
limit:
description: "The target date for the aggregate window."
examples:
- 100
- 120
order: 3
title: "Limit"
type: "integer"
multiplier:
description: "The size of the timespan multiplier."
examples:
- 1
- 2
order: 4
title: "Multiplier"
type: "integer"
sort:
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"
order: 5
title: "Sort"
type: "string"
start_date:
description: "The beginning date for the aggregate window."
examples:
- "2020-10-14"
format: "date"
order: 6
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
stocksTicker:
description: "The exchange symbol that this item is traded under."
examples:
- "IBM"
- "MSFT"
order: 7
title: "Stock Ticker"
type: "string"
timespan:
description: "The size of the time window."
examples:
- "day"
order: 8
title: "Timespan"
type: "string"
sourceType:
title: "polygon-stock-api"
const: "polygon-stock-api"
enum:
- "polygon-stock-api"
order: 0
type: "string"
required:
- "apiKey"
- "end_date"
- "multiplier"
- "start_date"
- "stocksTicker"
- "timespan"
- "sourceType"
type: "object"
source-polygon-stock-api-update:
properties:
adjusted:
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"
order: 0
title: "Adjusted"
type: "string"
apiKey:
airbyte_secret: true
description: "Your API ACCESS Key"
order: 1
title: "API Key"
type: "string"
end_date:
description: "The target date for the aggregate window."
examples:
- "2020-10-14"
format: "date"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "End Date"
type: "string"
limit:
description: "The target date for the aggregate window."
examples:
- 100
- 120
order: 3
title: "Limit"
type: "integer"
multiplier:
description: "The size of the timespan multiplier."
examples:
- 1
- 2
order: 4
title: "Multiplier"
type: "integer"
sort:
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"
order: 5
title: "Sort"
type: "string"
start_date:
description: "The beginning date for the aggregate window."
examples:
- "2020-10-14"
format: "date"
order: 6
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
stocksTicker:
description: "The exchange symbol that this item is traded under."
examples:
- "IBM"
- "MSFT"
order: 7
title: "Stock Ticker"
type: "string"
timespan:
description: "The size of the time window."
examples:
- "day"
order: 8
title: "Timespan"
type: "string"
required:
- "apiKey"
- "end_date"
- "multiplier"
- "start_date"
- "stocksTicker"
- "timespan"
type: "object"
source-alpaca-broker-api:
properties:
environment:
default: "broker-api.sandbox"
description: "The trading environment, either 'live', 'paper' or 'broker-api.sandbox'."
enum:
- "api"
- "paper-api"
- "broker-api.sandbox"
name: "environment"
order: 0
title: "Environment"
type: "string"
limit:
default: "20"
description: "Limit for each response objects"
order: 4
title: "Limit"
type: "string"
password:
airbyte_secret: true
always_show: true
description: "Your Alpaca API Secret Key. You can find this in the Alpaca\
\ developer web console under your account settings."
order: 2
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
username:
description: "API Key ID for the alpaca market"
order: 1
title: "Username"
type: "string"
sourceType:
title: "alpaca-broker-api"
const: "alpaca-broker-api"
enum:
- "alpaca-broker-api"
order: 0
type: "string"
required:
- "environment"
- "username"
- "start_date"
- "sourceType"
type: "object"
source-alpaca-broker-api-update:
properties:
environment:
default: "broker-api.sandbox"
description: "The trading environment, either 'live', 'paper' or 'broker-api.sandbox'."
enum:
- "api"
- "paper-api"
- "broker-api.sandbox"
name: "environment"
order: 0
title: "Environment"
type: "string"
limit:
default: "20"
description: "Limit for each response objects"
order: 4
title: "Limit"
type: "string"
password:
airbyte_secret: true
always_show: true
description: "Your Alpaca API Secret Key. You can find this in the Alpaca\
\ developer web console under your account settings."
order: 2
title: "Password"
type: "string"
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
username:
description: "API Key ID for the alpaca market"
order: 1
title: "Username"
type: "string"
required:
- "environment"
- "username"
- "start_date"
type: "object"
source-omnisend:
properties:
api_key:
airbyte_secret: true
description: "API Key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "omnisend"
const: "omnisend"
enum:
- "omnisend"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-omnisend-update:
properties:
api_key:
airbyte_secret: true
description: "API Key"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-mongodb-v2:
groups:
- id: "connection"
- id: "advanced"
title: "Advanced"
properties:
database_config:
description: "Configures the MongoDB cluster type."
display_type: "radio"
group: "connection"
oneOf:
- additionalProperties: true
description: "MongoDB Atlas-hosted cluster configured as a replica set"
properties:
auth_source:
default: "admin"
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."
examples:
- "admin"
order: 6
title: "Authentication Source"
type: "string"
cluster_type:
const: "ATLAS_REPLICA_SET"
order: 1
type: "string"
enum:
- "ATLAS_REPLICA_SET"
connection_string:
description: "The connection string of the cluster that you want to\
\ replicate."
examples:
- "mongodb+srv://cluster0.abcd1.mongodb.net/"
order: 2
title: "Connection String"
type: "string"
databases:
description: "The names of the MongoDB databases that contain the\
\ collection(s) to replicate."
items:
type: "string"
order: 3
title: "Database Names"
type: "array"
password:
airbyte_secret: true
description: "The password associated with this username."
order: 5
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
schema_enforced:
always_show: true
default: true
description: "When enabled, syncs will validate and structure records\
\ against the stream's schema."
order: 7
title: "Schema Enforced"
type: "boolean"
username:
description: "The username which is used to access the database."
order: 4
title: "Username"
type: "string"
required:
- "cluster_type"
- "connection_string"
- "databases"
- "username"
- "password"
- "auth_source"
title: "MongoDB Atlas Replica Set"
- additionalProperties: true
description: "MongoDB self-hosted cluster configured as a replica set"
properties:
auth_source:
default: "admin"
description: "The authentication source where the user information\
\ is stored."
examples:
- "admin"
order: 6
title: "Authentication Source"
type: "string"
cluster_type:
const: "SELF_MANAGED_REPLICA_SET"
order: 1
type: "string"
enum:
- "SELF_MANAGED_REPLICA_SET"
connection_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
title: "Connection String"
type: "string"
databases:
description: "The names of the MongoDB databases that contain the\
\ collection(s) to replicate."
items:
type: "string"
order: 3
title: "Database Names"
type: "array"
password:
airbyte_secret: true
description: "The password associated with this username."
order: 5
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
schema_enforced:
always_show: true
default: true
description: "When enabled, syncs will validate and structure records\
\ against the stream's schema."
order: 7
title: "Schema Enforced"
type: "boolean"
username:
description: "The username which is used to access the database."
order: 4
title: "Username"
type: "string"
required:
- "cluster_type"
- "connection_string"
- "databases"
title: "Self-Managed Replica Set"
order: 1
title: "Cluster Type"
type: "object"
discover_sample_size:
default: 10000
description: "The maximum number of documents to sample when attempting\
\ to discover the unique fields for a collection."
group: "advanced"
maximum: 100000
minimum: 10
order: 10
title: "Document discovery sample size (Advanced)"
type: "integer"
discover_timeout_seconds:
default: 600
description: "The amount of time the connector will wait when it discovers\
\ a document. Defaults to 600 seconds. Valid range: 5 seconds to 1200\
\ seconds."
group: "advanced"
maximum: 1200
minimum: 5
order: 11
title: "Document discovery timeout in seconds (Advanced)"
type: "integer"
initial_load_timeout_hours:
default: 8
description: "The amount of time an initial load is allowed to continue\
\ for before catching up on CDC logs."
group: "advanced"
max: 24
min: 4
order: 14
title: "Initial Load Timeout in Hours (Advanced)"
type: "integer"
initial_waiting_seconds:
default: 300
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."
group: "advanced"
max: 1200
min: 120
order: 8
title: "Initial Waiting Time in Seconds (Advanced)"
type: "integer"
invalid_cdc_cursor_position_behavior:
default: "Fail sync"
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"
group: "advanced"
order: 12
title: "Invalid CDC position behavior (Advanced)"
type: "string"
queue_size:
default: 10000
description: "The size of the internal queue. This may interfere with memory\
\ consumption and efficiency of the connector, please be careful."
group: "advanced"
max: 10000
min: 1000
order: 9
title: "Size of the queue (Advanced)"
type: "integer"
update_capture_mode:
default: "Lookup"
description: "Determines how Airbyte looks up the value of an updated document.\
\ If 'Lookup' is chosen, the current value of the document will be read.\
\ If 'Post Image' is chosen, then the version of the document immediately\
\ after an update will be read. WARNING : Severe data loss will occur\
\ if this option is chosen and the appropriate settings are not set on\
\ your Mongo instance : https://www.mongodb.com/docs/manual/changeStreams/#change-streams-with-document-pre-and-post-images."
enum:
- "Lookup"
- "Post Image"
group: "advanced"
order: 13
title: "Capture mode (Advanced)"
type: "string"
sourceType:
title: "mongodb-v2"
const: "mongodb-v2"
enum:
- "mongodb-v2"
order: 0
type: "string"
required:
- "database_config"
- "sourceType"
title: "MongoDb Source Spec"
type: "object"
source-mongodb-v2-update:
groups:
- id: "connection"
- id: "advanced"
title: "Advanced"
properties:
database_config:
description: "Configures the MongoDB cluster type."
display_type: "radio"
group: "connection"
oneOf:
- additionalProperties: true
description: "MongoDB Atlas-hosted cluster configured as a replica set"
properties:
auth_source:
default: "admin"
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."
examples:
- "admin"
order: 6
title: "Authentication Source"
type: "string"
cluster_type:
const: "ATLAS_REPLICA_SET"
order: 1
type: "string"
enum:
- "ATLAS_REPLICA_SET"
connection_string:
description: "The connection string of the cluster that you want to\
\ replicate."
examples:
- "mongodb+srv://cluster0.abcd1.mongodb.net/"
order: 2
title: "Connection String"
type: "string"
databases:
description: "The names of the MongoDB databases that contain the\
\ collection(s) to replicate."
items:
type: "string"
order: 3
title: "Database Names"
type: "array"
password:
airbyte_secret: true
description: "The password associated with this username."
order: 5
title: "Password"
type: "string"
schema_enforced:
always_show: true
default: true
description: "When enabled, syncs will validate and structure records\
\ against the stream's schema."
order: 7
title: "Schema Enforced"
type: "boolean"
username:
description: "The username which is used to access the database."
order: 4
title: "Username"
type: "string"
required:
- "cluster_type"
- "connection_string"
- "databases"
- "username"
- "password"
- "auth_source"
title: "MongoDB Atlas Replica Set"
- additionalProperties: true
description: "MongoDB self-hosted cluster configured as a replica set"
properties:
auth_source:
default: "admin"
description: "The authentication source where the user information\
\ is stored."
examples:
- "admin"
order: 6
title: "Authentication Source"
type: "string"
cluster_type:
const: "SELF_MANAGED_REPLICA_SET"
order: 1
type: "string"
enum:
- "SELF_MANAGED_REPLICA_SET"
connection_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
title: "Connection String"
type: "string"
databases:
description: "The names of the MongoDB databases that contain the\
\ collection(s) to replicate."
items:
type: "string"
order: 3
title: "Database Names"
type: "array"
password:
airbyte_secret: true
description: "The password associated with this username."
order: 5
title: "Password"
type: "string"
schema_enforced:
always_show: true
default: true
description: "When enabled, syncs will validate and structure records\
\ against the stream's schema."
order: 7
title: "Schema Enforced"
type: "boolean"
username:
description: "The username which is used to access the database."
order: 4
title: "Username"
type: "string"
required:
- "cluster_type"
- "connection_string"
- "databases"
title: "Self-Managed Replica Set"
order: 1
title: "Cluster Type"
type: "object"
discover_sample_size:
default: 10000
description: "The maximum number of documents to sample when attempting\
\ to discover the unique fields for a collection."
group: "advanced"
maximum: 100000
minimum: 10
order: 10
title: "Document discovery sample size (Advanced)"
type: "integer"
discover_timeout_seconds:
default: 600
description: "The amount of time the connector will wait when it discovers\
\ a document. Defaults to 600 seconds. Valid range: 5 seconds to 1200\
\ seconds."
group: "advanced"
maximum: 1200
minimum: 5
order: 11
title: "Document discovery timeout in seconds (Advanced)"
type: "integer"
initial_load_timeout_hours:
default: 8
description: "The amount of time an initial load is allowed to continue\
\ for before catching up on CDC logs."
group: "advanced"
max: 24
min: 4
order: 14
title: "Initial Load Timeout in Hours (Advanced)"
type: "integer"
initial_waiting_seconds:
default: 300
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."
group: "advanced"
max: 1200
min: 120
order: 8
title: "Initial Waiting Time in Seconds (Advanced)"
type: "integer"
invalid_cdc_cursor_position_behavior:
default: "Fail sync"
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"
group: "advanced"
order: 12
title: "Invalid CDC position behavior (Advanced)"
type: "string"
queue_size:
default: 10000
description: "The size of the internal queue. This may interfere with memory\
\ consumption and efficiency of the connector, please be careful."
group: "advanced"
max: 10000
min: 1000
order: 9
title: "Size of the queue (Advanced)"
type: "integer"
update_capture_mode:
default: "Lookup"
description: "Determines how Airbyte looks up the value of an updated document.\
\ If 'Lookup' is chosen, the current value of the document will be read.\
\ If 'Post Image' is chosen, then the version of the document immediately\
\ after an update will be read. WARNING : Severe data loss will occur\
\ if this option is chosen and the appropriate settings are not set on\
\ your Mongo instance : https://www.mongodb.com/docs/manual/changeStreams/#change-streams-with-document-pre-and-post-images."
enum:
- "Lookup"
- "Post Image"
group: "advanced"
order: 13
title: "Capture mode (Advanced)"
type: "string"
required:
- "database_config"
title: "MongoDb Source Spec"
type: "object"
source-retently:
properties:
credentials:
description: "Choose how to authenticate to Retently"
oneOf:
- additionalProperties: true
properties:
auth_type:
const: "Client"
order: 0
type: "string"
enum:
- "Client"
client_id:
description: "The Client ID of your Retently developer application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Retently developer application."
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "Retently Refresh Token which can be used to fetch new\
\ Bearer Tokens when the current one expires."
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "client_id"
- "client_secret"
- "refresh_token"
title: "Authenticate via Retently (OAuth)"
type: "object"
- additionalProperties: true
properties:
api_key:
airbyte_secret: true
description: "Retently API Token. See the docs for more information on how to obtain this key."
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "Token"
order: 0
type: "string"
enum:
- "Token"
required:
- "api_key"
title: "Authenticate with API Token"
type: "object"
order: 0
title: "Authentication Mechanism"
type: "object"
sourceType:
title: "retently"
const: "retently"
enum:
- "retently"
order: 0
type: "string"
required:
- "sourceType"
type: "object"
source-retently-update:
properties:
credentials:
description: "Choose how to authenticate to Retently"
oneOf:
- additionalProperties: true
properties:
auth_type:
const: "Client"
order: 0
type: "string"
enum:
- "Client"
client_id:
description: "The Client ID of your Retently developer application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Retently developer application."
title: "Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "Retently Refresh Token which can be used to fetch new\
\ Bearer Tokens when the current one expires."
title: "Refresh Token"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
title: "Authenticate via Retently (OAuth)"
type: "object"
- additionalProperties: true
properties:
api_key:
airbyte_secret: true
description: "Retently API Token. See the docs for more information on how to obtain this key."
title: "API Token"
type: "string"
auth_type:
const: "Token"
order: 0
type: "string"
enum:
- "Token"
required:
- "api_key"
title: "Authenticate with API Token"
type: "object"
order: 0
title: "Authentication Mechanism"
type: "object"
required: []
type: "object"
source-jotform:
properties:
api_endpoint:
oneOf:
- properties:
api_endpoint:
const: "basic"
order: 0
type: "string"
enum:
- "basic"
url_prefix:
default: "Standard"
description: "You can access our API through the following URLs -\
\ Standard API Usage (Use the default API URL - https://api.jotform.com),\
\ For EU (Use the EU API URL - https://eu-api.jotform.com), For\
\ HIPAA (Use the HIPAA API URL - https://hipaa-api.jotform.com)"
enum:
- "Standard"
- "EU"
- "HIPAA"
title: "Base URL Prefix"
type: "string"
required:
- "url_prefix"
title: "Basic"
type: "object"
- properties:
api_endpoint:
const: "enterprise"
order: 0
type: "string"
enum:
- "enterprise"
enterprise_url:
description: "Upgrade to Enterprise to make your API url your-domain.com/API\
\ or subdomain.jotform.com/API instead of api.jotform.com"
title: "Enterprise URL"
type: "string"
required:
- "enterprise_url"
title: "Enterprise"
type: "object"
order: 1
title: "API Endpoint"
type: "object"
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
end_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "End date"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "jotform"
const: "jotform"
enum:
- "jotform"
order: 0
type: "string"
required:
- "api_key"
- "api_endpoint"
- "start_date"
- "end_date"
- "sourceType"
type: "object"
source-jotform-update:
properties:
api_endpoint:
oneOf:
- properties:
api_endpoint:
const: "basic"
order: 0
type: "string"
enum:
- "basic"
url_prefix:
default: "Standard"
description: "You can access our API through the following URLs -\
\ Standard API Usage (Use the default API URL - https://api.jotform.com),\
\ For EU (Use the EU API URL - https://eu-api.jotform.com), For\
\ HIPAA (Use the HIPAA API URL - https://hipaa-api.jotform.com)"
enum:
- "Standard"
- "EU"
- "HIPAA"
title: "Base URL Prefix"
type: "string"
required:
- "url_prefix"
title: "Basic"
type: "object"
- properties:
api_endpoint:
const: "enterprise"
order: 0
type: "string"
enum:
- "enterprise"
enterprise_url:
description: "Upgrade to Enterprise to make your API url your-domain.com/API\
\ or subdomain.jotform.com/API instead of api.jotform.com"
title: "Enterprise URL"
type: "string"
required:
- "enterprise_url"
title: "Enterprise"
type: "object"
order: 1
title: "API Endpoint"
type: "object"
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
end_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "End date"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "api_endpoint"
- "start_date"
- "end_date"
type: "object"
source-instagram:
properties:
access_token:
airbyte_secret: true
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"
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
client_id:
airbyte_secret: true
description: "The Client ID for your Oauth application"
title: "Client Id"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The Client Secret for your Oauth application"
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
num_workers:
default: 15
description: "The number of worker threads to use for the sync."
examples:
- 1
- 2
- 3
maximum: 40
minimum: 2
title: "Number of concurrent threads"
type: "integer"
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."
examples:
- "2017-01-25T00: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$"
title: "Start Date"
type: "string"
sourceType:
title: "instagram"
const: "instagram"
enum:
- "instagram"
order: 0
type: "string"
required:
- "access_token"
- "sourceType"
title: "Source Instagram"
type: "object"
source-instagram-update:
properties:
access_token:
airbyte_secret: true
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"
title: "Access Token"
type: "string"
client_id:
airbyte_secret: true
description: "The Client ID for your Oauth application"
title: "Client Id"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret for your Oauth application"
title: "Client Secret"
type: "string"
num_workers:
default: 15
description: "The number of worker threads to use for the sync."
examples:
- 1
- 2
- 3
maximum: 40
minimum: 2
title: "Number of concurrent threads"
type: "integer"
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."
examples:
- "2017-01-25T00: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$"
title: "Start Date"
type: "string"
required:
- "access_token"
title: "Source Instagram"
type: "object"
source-nutshell:
properties:
password:
airbyte_secret: true
always_show: true
order: 1
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
username:
order: 0
title: "Username"
type: "string"
sourceType:
title: "nutshell"
const: "nutshell"
enum:
- "nutshell"
order: 0
type: "string"
required:
- "username"
- "sourceType"
type: "object"
source-nutshell-update:
properties:
password:
airbyte_secret: true
always_show: true
order: 1
title: "API Token"
type: "string"
username:
order: 0
title: "Username"
type: "string"
required:
- "username"
type: "object"
source-dbt:
properties:
account_id:
order: 1
title: "account_id"
type: "string"
api_key_2:
airbyte_secret: true
order: 0
title: "Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "dbt"
const: "dbt"
enum:
- "dbt"
order: 0
type: "string"
required:
- "api_key_2"
- "account_id"
- "sourceType"
type: "object"
source-dbt-update:
properties:
account_id:
order: 1
title: "account_id"
type: "string"
api_key_2:
airbyte_secret: true
order: 0
title: "Token"
type: "string"
required:
- "api_key_2"
- "account_id"
type: "object"
source-nylas:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
api_server:
enum:
- "us"
- "eu"
order: 1
title: "API Server"
type: "string"
end_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "End date"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "nylas"
const: "nylas"
enum:
- "nylas"
order: 0
type: "string"
required:
- "api_key"
- "api_server"
- "start_date"
- "end_date"
- "sourceType"
type: "object"
source-nylas-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
api_server:
enum:
- "us"
- "eu"
order: 1
title: "API Server"
type: "string"
end_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "End date"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "api_server"
- "start_date"
- "end_date"
type: "object"
source-s3:
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."
properties:
aws_access_key_id:
airbyte_secret: true
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."
order: 2
title: "AWS Access Key ID"
type: "string"
x-speakeasy-param-sensitive: true
aws_secret_access_key:
airbyte_secret: true
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."
order: 3
title: "AWS Secret Access Key"
type: "string"
x-speakeasy-param-sensitive: true
bucket:
description: "Name of the S3 bucket where the file(s) exist."
order: 0
title: "Bucket"
type: "string"
delivery_method:
default: "use_records_transfer"
display_type: "radio"
group: "advanced"
oneOf:
- description: "Recommended - Extract and load structured records into your\
\ destination of choice. This is the classic method of moving data in\
\ Airbyte. It allows for blocking and hashing individual fields or files\
\ from a structured schema. Data can be flattened, typed and deduped\
\ depending on the destination."
properties:
delivery_type:
const: "use_records_transfer"
default: "use_records_transfer"
enum:
- "use_records_transfer"
title: "Delivery Type"
type: "string"
required:
- "delivery_type"
title: "Replicate Records"
type: "object"
- description: "Copy raw files without parsing their contents. Bits are\
\ copied into the destination exactly as they appeared in the source.\
\ Recommended for use with unstructured text data, non-text and compressed\
\ files."
properties:
delivery_type:
const: "use_file_transfer"
default: "use_file_transfer"
enum:
- "use_file_transfer"
title: "Delivery Type"
type: "string"
preserve_directory_structure:
default: true
description: "If enabled, sends subdirectory folder structure along\
\ with source file names to the destination. Otherwise, files will\
\ be synced by their names only. This option is ignored when file-based\
\ replication is not enabled."
title: "Preserve Sub-Directories in File Paths"
type: "boolean"
required:
- "delivery_type"
title: "Copy Raw Files"
type: "object"
order: 6
title: "Delivery Method"
type: "object"
endpoint:
default: ""
description: "Endpoint to an S3 compatible service. Leave empty to use AWS."
examples:
- "my-s3-endpoint.com"
- "https://my-s3-endpoint.com"
order: 4
title: "Endpoint"
type: "string"
region_name:
description: "AWS region where the S3 bucket is located. If not provided,\
\ the region will be determined automatically."
order: 5
title: "AWS Region"
type: "string"
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
title: "AWS Role ARN"
type: "string"
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"
order: 1
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"
title: "Start Date"
type: "string"
streams:
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."
items:
properties:
days_to_sync_if_history_is_full:
default: 3
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."
title: "Days To Sync If History Is Full"
type: "integer"
format:
description: "The configuration options that are used to alter how\
\ to read incoming files that deviate from the standard formatting."
oneOf:
- properties:
double_as_string:
default: false
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."
title: "Convert Double Fields to Strings"
type: "boolean"
filetype:
const: "avro"
default: "avro"
title: "Filetype"
type: "string"
enum:
- "avro"
required:
- "filetype"
title: "Avro Format"
type: "object"
- properties:
delimiter:
default: ","
description: "The character delimiting individual cells in the\
\ CSV data. This may only be a 1-character string. For tab-delimited\
\ data enter '\\t'."
title: "Delimiter"
type: "string"
double_quote:
default: true
description: "Whether two quotes in a quoted CSV value denote\
\ a single quote in the data."
title: "Double Quote"
type: "boolean"
encoding:
default: "utf8"
description: "The character encoding of the CSV data. Leave\
\ blank to default to UTF8. See list of python encodings for allowable\
\ options."
title: "Encoding"
type: "string"
escape_char:
description: "The character used for escaping special characters.\
\ To disallow escaping, leave this field blank."
title: "Escape Character"
type: "string"
false_values:
default:
- "n"
- "no"
- "f"
- "false"
- "off"
- "0"
description: "A set of case-sensitive strings that should be\
\ interpreted as false values."
items:
type: "string"
title: "False Values"
type: "array"
uniqueItems: true
filetype:
const: "csv"
default: "csv"
title: "Filetype"
type: "string"
enum:
- "csv"
header_definition:
default:
header_definition_type: "From CSV"
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."
oneOf:
- properties:
header_definition_type:
const: "From CSV"
default: "From CSV"
title: "Header Definition Type"
type: "string"
enum:
- "From CSV"
required:
- "header_definition_type"
title: "From CSV"
type: "object"
- properties:
header_definition_type:
const: "Autogenerated"
default: "Autogenerated"
title: "Header Definition Type"
type: "string"
enum:
- "Autogenerated"
required:
- "header_definition_type"
title: "Autogenerated"
type: "object"
- properties:
column_names:
description: "The column names that will be used while\
\ emitting the CSV records"
items:
type: "string"
title: "Column Names"
type: "array"
header_definition_type:
const: "User Provided"
default: "User Provided"
title: "Header Definition Type"
type: "string"
enum:
- "User Provided"
required:
- "column_names"
- "header_definition_type"
title: "User Provided"
type: "object"
title: "CSV Header Definition"
type: "object"
ignore_errors_on_fields_mismatch:
default: false
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."
title: "Ignore errors on field mismatch"
type: "boolean"
null_values:
default: []
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."
items:
type: "string"
title: "Null Values"
type: "array"
uniqueItems: true
quote_char:
default: "\""
description: "The character used for quoting CSV values. To\
\ disallow quoting, make this field blank."
title: "Quote Character"
type: "string"
skip_rows_after_header:
default: 0
description: "The number of rows to skip after the header row."
title: "Skip Rows After Header"
type: "integer"
skip_rows_before_header:
default: 0
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."
title: "Skip Rows Before Header"
type: "integer"
strings_can_be_null:
default: true
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."
title: "Strings Can Be Null"
type: "boolean"
true_values:
default:
- "y"
- "yes"
- "t"
- "true"
- "on"
- "1"
description: "A set of case-sensitive strings that should be\
\ interpreted as true values."
items:
type: "string"
title: "True Values"
type: "array"
uniqueItems: true
required:
- "filetype"
title: "CSV Format"
type: "object"
- properties:
filetype:
const: "jsonl"
default: "jsonl"
title: "Filetype"
type: "string"
enum:
- "jsonl"
required:
- "filetype"
title: "Jsonl Format"
type: "object"
- properties:
decimal_as_float:
default: false
description: "Whether to convert decimal fields to floats. There\
\ is a loss of precision when converting decimals to floats,\
\ so this is not recommended."
title: "Convert Decimal Fields to Floats"
type: "boolean"
filetype:
const: "parquet"
default: "parquet"
title: "Filetype"
type: "string"
enum:
- "parquet"
required:
- "filetype"
title: "Parquet Format"
type: "object"
- description: "Extract text from document formats (.pdf, .docx, .md,\
\ .pptx) and emit as one record per file."
properties:
filetype:
const: "unstructured"
default: "unstructured"
title: "Filetype"
type: "string"
enum:
- "unstructured"
processing:
default:
mode: "local"
description: "Processing configuration"
oneOf:
- description: "Process files locally, supporting `fast` and\
\ `ocr` modes. This is the default option."
properties:
mode:
const: "local"
default: "local"
enum:
- "local"
title: "Mode"
type: "string"
required:
- "mode"
title: "Local"
type: "object"
title: "Processing"
type: "object"
skip_unprocessable_files:
always_show: true
default: true
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."
title: "Skip Unprocessable Files"
type: "boolean"
strategy:
always_show: true
default: "auto"
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"
enum:
- "auto"
- "fast"
- "ocr_only"
- "hi_res"
order: 0
title: "Parsing Strategy"
type: "string"
required:
- "filetype"
title: "Unstructured Document Format"
type: "object"
- properties:
filetype:
const: "excel"
default: "excel"
title: "Filetype"
type: "string"
enum:
- "excel"
required:
- "filetype"
title: "Excel Format"
type: "object"
title: "Format"
type: "object"
globs:
default:
- "**"
description: "The pattern used to specify which files should be selected\
\ from the file system. For more information on glob pattern matching\
\ look here."
items:
type: "string"
order: 1
title: "Globs"
type: "array"
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."
title: "Input Schema"
type: "string"
name:
description: "The name of the stream."
title: "Name"
type: "string"
recent_n_files_to_read_for_schema_discovery:
description: "The number of resent files which will be used to discover\
\ the schema for this stream."
exclusiveMinimum: 0
title: "Files To Read For Schema Discover"
type: "integer"
schemaless:
default: false
description: "When enabled, syncs will not validate or structure records\
\ against the stream's schema."
title: "Schemaless"
type: "boolean"
validation_policy:
default: "Emit Record"
description: "The name of the validation policy that dictates sync\
\ behavior when a record does not adhere to the stream schema."
enum:
- "Emit Record"
- "Skip Record"
- "Wait for Discover"
title: "Validation Policy"
required:
- "name"
- "format"
title: "FileBasedStreamConfig"
type: "object"
order: 10
title: "The list of streams to sync"
type: "array"
sourceType:
title: "s3"
const: "s3"
enum:
- "s3"
order: 0
type: "string"
required:
- "streams"
- "bucket"
- "sourceType"
title: "Config"
type: "object"
source-s3-update:
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."
properties:
aws_access_key_id:
airbyte_secret: true
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."
order: 2
title: "AWS Access Key ID"
type: "string"
aws_secret_access_key:
airbyte_secret: true
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."
order: 3
title: "AWS Secret Access Key"
type: "string"
bucket:
description: "Name of the S3 bucket where the file(s) exist."
order: 0
title: "Bucket"
type: "string"
delivery_method:
default: "use_records_transfer"
display_type: "radio"
group: "advanced"
oneOf:
- description: "Recommended - Extract and load structured records into your\
\ destination of choice. This is the classic method of moving data in\
\ Airbyte. It allows for blocking and hashing individual fields or files\
\ from a structured schema. Data can be flattened, typed and deduped\
\ depending on the destination."
properties:
delivery_type:
const: "use_records_transfer"
default: "use_records_transfer"
enum:
- "use_records_transfer"
title: "Delivery Type"
type: "string"
required:
- "delivery_type"
title: "Replicate Records"
type: "object"
- description: "Copy raw files without parsing their contents. Bits are\
\ copied into the destination exactly as they appeared in the source.\
\ Recommended for use with unstructured text data, non-text and compressed\
\ files."
properties:
delivery_type:
const: "use_file_transfer"
default: "use_file_transfer"
enum:
- "use_file_transfer"
title: "Delivery Type"
type: "string"
preserve_directory_structure:
default: true
description: "If enabled, sends subdirectory folder structure along\
\ with source file names to the destination. Otherwise, files will\
\ be synced by their names only. This option is ignored when file-based\
\ replication is not enabled."
title: "Preserve Sub-Directories in File Paths"
type: "boolean"
required:
- "delivery_type"
title: "Copy Raw Files"
type: "object"
order: 6
title: "Delivery Method"
type: "object"
endpoint:
default: ""
description: "Endpoint to an S3 compatible service. Leave empty to use AWS."
examples:
- "my-s3-endpoint.com"
- "https://my-s3-endpoint.com"
order: 4
title: "Endpoint"
type: "string"
region_name:
description: "AWS region where the S3 bucket is located. If not provided,\
\ the region will be determined automatically."
order: 5
title: "AWS Region"
type: "string"
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
title: "AWS Role ARN"
type: "string"
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"
order: 1
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"
title: "Start Date"
type: "string"
streams:
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."
items:
properties:
days_to_sync_if_history_is_full:
default: 3
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."
title: "Days To Sync If History Is Full"
type: "integer"
format:
description: "The configuration options that are used to alter how\
\ to read incoming files that deviate from the standard formatting."
oneOf:
- properties:
double_as_string:
default: false
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."
title: "Convert Double Fields to Strings"
type: "boolean"
filetype:
const: "avro"
default: "avro"
title: "Filetype"
type: "string"
enum:
- "avro"
required:
- "filetype"
title: "Avro Format"
type: "object"
- properties:
delimiter:
default: ","
description: "The character delimiting individual cells in the\
\ CSV data. This may only be a 1-character string. For tab-delimited\
\ data enter '\\t'."
title: "Delimiter"
type: "string"
double_quote:
default: true
description: "Whether two quotes in a quoted CSV value denote\
\ a single quote in the data."
title: "Double Quote"
type: "boolean"
encoding:
default: "utf8"
description: "The character encoding of the CSV data. Leave\
\ blank to default to UTF8. See list of python encodings for allowable\
\ options."
title: "Encoding"
type: "string"
escape_char:
description: "The character used for escaping special characters.\
\ To disallow escaping, leave this field blank."
title: "Escape Character"
type: "string"
false_values:
default:
- "n"
- "no"
- "f"
- "false"
- "off"
- "0"
description: "A set of case-sensitive strings that should be\
\ interpreted as false values."
items:
type: "string"
title: "False Values"
type: "array"
uniqueItems: true
filetype:
const: "csv"
default: "csv"
title: "Filetype"
type: "string"
enum:
- "csv"
header_definition:
default:
header_definition_type: "From CSV"
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."
oneOf:
- properties:
header_definition_type:
const: "From CSV"
default: "From CSV"
title: "Header Definition Type"
type: "string"
enum:
- "From CSV"
required:
- "header_definition_type"
title: "From CSV"
type: "object"
- properties:
header_definition_type:
const: "Autogenerated"
default: "Autogenerated"
title: "Header Definition Type"
type: "string"
enum:
- "Autogenerated"
required:
- "header_definition_type"
title: "Autogenerated"
type: "object"
- properties:
column_names:
description: "The column names that will be used while\
\ emitting the CSV records"
items:
type: "string"
title: "Column Names"
type: "array"
header_definition_type:
const: "User Provided"
default: "User Provided"
title: "Header Definition Type"
type: "string"
enum:
- "User Provided"
required:
- "column_names"
- "header_definition_type"
title: "User Provided"
type: "object"
title: "CSV Header Definition"
type: "object"
ignore_errors_on_fields_mismatch:
default: false
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."
title: "Ignore errors on field mismatch"
type: "boolean"
null_values:
default: []
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."
items:
type: "string"
title: "Null Values"
type: "array"
uniqueItems: true
quote_char:
default: "\""
description: "The character used for quoting CSV values. To\
\ disallow quoting, make this field blank."
title: "Quote Character"
type: "string"
skip_rows_after_header:
default: 0
description: "The number of rows to skip after the header row."
title: "Skip Rows After Header"
type: "integer"
skip_rows_before_header:
default: 0
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."
title: "Skip Rows Before Header"
type: "integer"
strings_can_be_null:
default: true
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."
title: "Strings Can Be Null"
type: "boolean"
true_values:
default:
- "y"
- "yes"
- "t"
- "true"
- "on"
- "1"
description: "A set of case-sensitive strings that should be\
\ interpreted as true values."
items:
type: "string"
title: "True Values"
type: "array"
uniqueItems: true
required:
- "filetype"
title: "CSV Format"
type: "object"
- properties:
filetype:
const: "jsonl"
default: "jsonl"
title: "Filetype"
type: "string"
enum:
- "jsonl"
required:
- "filetype"
title: "Jsonl Format"
type: "object"
- properties:
decimal_as_float:
default: false
description: "Whether to convert decimal fields to floats. There\
\ is a loss of precision when converting decimals to floats,\
\ so this is not recommended."
title: "Convert Decimal Fields to Floats"
type: "boolean"
filetype:
const: "parquet"
default: "parquet"
title: "Filetype"
type: "string"
enum:
- "parquet"
required:
- "filetype"
title: "Parquet Format"
type: "object"
- description: "Extract text from document formats (.pdf, .docx, .md,\
\ .pptx) and emit as one record per file."
properties:
filetype:
const: "unstructured"
default: "unstructured"
title: "Filetype"
type: "string"
enum:
- "unstructured"
processing:
default:
mode: "local"
description: "Processing configuration"
oneOf:
- description: "Process files locally, supporting `fast` and\
\ `ocr` modes. This is the default option."
properties:
mode:
const: "local"
default: "local"
enum:
- "local"
title: "Mode"
type: "string"
required:
- "mode"
title: "Local"
type: "object"
title: "Processing"
type: "object"
skip_unprocessable_files:
always_show: true
default: true
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."
title: "Skip Unprocessable Files"
type: "boolean"
strategy:
always_show: true
default: "auto"
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"
enum:
- "auto"
- "fast"
- "ocr_only"
- "hi_res"
order: 0
title: "Parsing Strategy"
type: "string"
required:
- "filetype"
title: "Unstructured Document Format"
type: "object"
- properties:
filetype:
const: "excel"
default: "excel"
title: "Filetype"
type: "string"
enum:
- "excel"
required:
- "filetype"
title: "Excel Format"
type: "object"
title: "Format"
type: "object"
globs:
default:
- "**"
description: "The pattern used to specify which files should be selected\
\ from the file system. For more information on glob pattern matching\
\ look here."
items:
type: "string"
order: 1
title: "Globs"
type: "array"
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."
title: "Input Schema"
type: "string"
name:
description: "The name of the stream."
title: "Name"
type: "string"
recent_n_files_to_read_for_schema_discovery:
description: "The number of resent files which will be used to discover\
\ the schema for this stream."
exclusiveMinimum: 0
title: "Files To Read For Schema Discover"
type: "integer"
schemaless:
default: false
description: "When enabled, syncs will not validate or structure records\
\ against the stream's schema."
title: "Schemaless"
type: "boolean"
validation_policy:
default: "Emit Record"
description: "The name of the validation policy that dictates sync\
\ behavior when a record does not adhere to the stream schema."
enum:
- "Emit Record"
- "Skip Record"
- "Wait for Discover"
title: "Validation Policy"
required:
- "name"
- "format"
title: "FileBasedStreamConfig"
type: "object"
order: 10
title: "The list of streams to sync"
type: "array"
required:
- "streams"
- "bucket"
title: "Config"
type: "object"
source-uservoice:
properties:
api_key:
airbyte_secret: true
order: 1
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
subdomain:
name: "subdomain"
order: 0
title: "subdomain"
type: "string"
sourceType:
title: "uservoice"
const: "uservoice"
enum:
- "uservoice"
order: 0
type: "string"
required:
- "subdomain"
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-uservoice-update:
properties:
api_key:
airbyte_secret: true
order: 1
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
subdomain:
name: "subdomain"
order: 0
title: "subdomain"
type: "string"
required:
- "subdomain"
- "api_key"
- "start_date"
type: "object"
source-klaus-api:
properties:
account:
description: "getting data by account"
order: 1
title: "account"
type: "integer"
api_key:
airbyte_secret: true
description: "API access key used to retrieve data from the KLAUS API."
order: 0
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "Start getting data from that date."
examples:
- "2020-10-15T00:00:00Z"
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
type: "string"
workspace:
description: "getting data by workspace"
order: 2
title: "workspace"
type: "integer"
sourceType:
title: "klaus-api"
const: "klaus-api"
enum:
- "klaus-api"
order: 0
type: "string"
required:
- "api_key"
- "account"
- "workspace"
- "sourceType"
type: "object"
source-klaus-api-update:
properties:
account:
description: "getting data by account"
order: 1
title: "account"
type: "integer"
api_key:
airbyte_secret: true
description: "API access key used to retrieve data from the KLAUS API."
order: 0
type: "string"
start_date:
description: "Start getting data from that date."
examples:
- "2020-10-15T00:00:00Z"
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
type: "string"
workspace:
description: "getting data by workspace"
order: 2
title: "workspace"
type: "integer"
required:
- "api_key"
- "account"
- "workspace"
type: "object"
source-box:
properties:
client_id:
airbyte_secret: true
name: "client_id"
order: 0
title: "OAuth Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
name: "client_secret"
order: 1
title: "OAuth Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
user:
order: 2
title: "User"
type: "number"
sourceType:
title: "box"
const: "box"
enum:
- "box"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "user"
- "sourceType"
type: "object"
source-box-update:
properties:
client_id:
airbyte_secret: true
name: "client_id"
order: 0
title: "OAuth Client ID"
type: "string"
client_secret:
airbyte_secret: true
name: "client_secret"
order: 1
title: "OAuth Client Secret"
type: "string"
user:
order: 2
title: "User"
type: "number"
required:
- "client_id"
- "client_secret"
- "user"
type: "object"
source-zendesk-sunshine:
properties:
credentials:
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Long-term access Token for making authenticated requests."
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_method:
const: "oauth2.0"
default: "oauth2.0"
enum:
- "oauth2.0"
order: 0
type: "string"
client_id:
airbyte_secret: true
description: "The Client ID of your OAuth application."
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The Client Secret of your OAuth application."
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_method"
- "client_id"
- "client_secret"
- "access_token"
title: "OAuth2.0"
type: "object"
- properties:
api_token:
airbyte_secret: true
description: "API Token. See the docs for information on how to generate this key."
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_method:
const: "api_token"
default: "api_token"
enum:
- "api_token"
order: 1
type: "string"
email:
description: "The user email for your Zendesk account"
title: "Email"
type: "string"
required:
- "auth_method"
- "api_token"
- "email"
title: "API Token"
type: "object"
order: 2
title: "Authorization Method"
type: "object"
start_date:
description: "The date from which you'd like to replicate data for Zendesk\
\ Sunshine API, in the format YYYY-MM-DDT00:00:00Z."
examples:
- "2021-01-01T00:00:00Z"
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
subdomain:
description: "The subdomain for your Zendesk Account."
order: 0
title: "Subdomain"
type: "string"
sourceType:
title: "zendesk-sunshine"
const: "zendesk-sunshine"
enum:
- "zendesk-sunshine"
order: 0
type: "string"
required:
- "subdomain"
- "start_date"
- "sourceType"
type: "object"
source-zendesk-sunshine-update:
properties:
credentials:
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Long-term access Token for making authenticated requests."
title: "Access Token"
type: "string"
auth_method:
const: "oauth2.0"
default: "oauth2.0"
enum:
- "oauth2.0"
order: 0
type: "string"
client_id:
airbyte_secret: true
description: "The Client ID of your OAuth application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your OAuth application."
title: "Client Secret"
type: "string"
required:
- "auth_method"
- "client_id"
- "client_secret"
- "access_token"
title: "OAuth2.0"
type: "object"
- properties:
api_token:
airbyte_secret: true
description: "API Token. See the docs for information on how to generate this key."
title: "API Token"
type: "string"
auth_method:
const: "api_token"
default: "api_token"
enum:
- "api_token"
order: 1
type: "string"
email:
description: "The user email for your Zendesk account"
title: "Email"
type: "string"
required:
- "auth_method"
- "api_token"
- "email"
title: "API Token"
type: "object"
order: 2
title: "Authorization Method"
type: "object"
start_date:
description: "The date from which you'd like to replicate data for Zendesk\
\ Sunshine API, in the format YYYY-MM-DDT00:00:00Z."
examples:
- "2021-01-01T00:00:00Z"
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
subdomain:
description: "The subdomain for your Zendesk Account."
order: 0
title: "Subdomain"
type: "string"
required:
- "subdomain"
- "start_date"
type: "object"
source-mention:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
stats_end_date:
format: "date"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Statistics End Date"
type: "string"
stats_interval:
default: "P1D"
description: "Periodicity of statistics returned. it may be daily(P1D),\
\ weekly(P1W) or monthly(P1M)."
enum:
- "P1D"
- "P1W"
- "P1M"
order: 1
title: "Statistics Interval"
type: "string"
stats_start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Statistics Start Date"
type: "string"
sourceType:
title: "mention"
const: "mention"
enum:
- "mention"
order: 0
type: "string"
required:
- "api_key"
- "stats_start_date"
- "sourceType"
type: "object"
source-mention-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
stats_end_date:
format: "date"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Statistics End Date"
type: "string"
stats_interval:
default: "P1D"
description: "Periodicity of statistics returned. it may be daily(P1D),\
\ weekly(P1W) or monthly(P1M)."
enum:
- "P1D"
- "P1W"
- "P1M"
order: 1
title: "Statistics Interval"
type: "string"
stats_start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Statistics Start Date"
type: "string"
required:
- "api_key"
- "stats_start_date"
type: "object"
source-exchange-rates:
properties:
access_key:
airbyte_secret: true
description: "Your API Key. See here. The key is case sensitive."
type: "string"
x-speakeasy-param-sensitive: true
base:
description: "ISO reference currency. See here. Free plan doesn't support Source Currency Switching, default\
\ base currency is EUR"
examples:
- "EUR"
- "USD"
type: "string"
ignore_weekends:
default: true
description: "Ignore weekends? (Exchanges don't run on weekends)"
type: "boolean"
start_date:
description: "Start getting data from that date."
examples:
- "YYYY-MM-DD"
format: "date"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
type: "string"
sourceType:
title: "exchange-rates"
const: "exchange-rates"
enum:
- "exchange-rates"
order: 0
type: "string"
required:
- "start_date"
- "access_key"
- "sourceType"
title: "exchangeratesapi.io Source Spec"
type: "object"
source-exchange-rates-update:
properties:
access_key:
airbyte_secret: true
description: "Your API Key. See here. The key is case sensitive."
type: "string"
base:
description: "ISO reference currency. See here. Free plan doesn't support Source Currency Switching, default\
\ base currency is EUR"
examples:
- "EUR"
- "USD"
type: "string"
ignore_weekends:
default: true
description: "Ignore weekends? (Exchanges don't run on weekends)"
type: "boolean"
start_date:
description: "Start getting data from that date."
examples:
- "YYYY-MM-DD"
format: "date"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
type: "string"
required:
- "start_date"
- "access_key"
title: "exchangeratesapi.io Source Spec"
type: "object"
source-news-api:
properties:
api_key:
airbyte_secret: true
description: "API Key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
category:
default: "business"
description: "The category you want to get top headlines for."
enum:
- "business"
- "entertainment"
- "general"
- "health"
- "science"
- "sports"
- "technology"
order: 10
type: "string"
country:
default: "us"
description: "The 2-letter ISO 3166-1 code of the country you want to get\
\ headlines\nfor. You can't mix this with the sources parameter.\n"
enum:
- "ae"
- "ar"
- "at"
- "au"
- "be"
- "bg"
- "br"
- "ca"
- "ch"
- "cn"
- "co"
- "cu"
- "cz"
- "de"
- "eg"
- "fr"
- "gb"
- "gr"
- "hk"
- "hu"
- "id"
- "ie"
- "il"
- "in"
- "it"
- "jp"
- "kr"
- "lt"
- "lv"
- "ma"
- "mx"
- "my"
- "ng"
- "nl"
- "no"
- "nz"
- "ph"
- "pl"
- "pt"
- "ro"
- "rs"
- "ru"
- "sa"
- "se"
- "sg"
- "si"
- "sk"
- "th"
- "tr"
- "tw"
- "ua"
- "us"
- "ve"
- "za"
order: 9
type: "string"
domains:
description: "A comma-seperated string of domains (eg bbc.co.uk, techcrunch.com,\n\
engadget.com) to restrict the search to.\n"
items:
type: "string"
order: 4
type: "array"
end_date:
description: "A date and optional time for the newest article allowed. This\
\ should\nbe in ISO 8601 format.\n"
examples:
- "2021-01-01"
- "2021-01-01T12:00:00"
order: 7
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2})?$"
type: "string"
exclude_domains:
description: "A comma-seperated string of domains (eg bbc.co.uk, techcrunch.com,\n\
engadget.com) to remove from the results.\n"
items:
type: "string"
order: 5
type: "array"
language:
description: "The 2-letter ISO-639-1 code of the language you want to get\
\ headlines\nfor. Possible options: ar de en es fr he it nl no pt ru se\
\ ud zh.\n"
enum:
- "ar"
- "de"
- "en"
- "es"
- "fr"
- "he"
- "it"
- "nl"
- "no"
- "pt"
- "ru"
- "se"
- "ud"
- "zh"
order: 8
type: "string"
search_in:
description: "Where to apply search query. Possible values are: title, description,\n\
content.\n"
items:
enum:
- "title"
- "description"
- "content"
type: "string"
order: 2
type: "array"
search_query:
description: "Search query. See https://newsapi.org/docs/endpoints/everything\
\ for \ninformation.\n"
examples:
- "+bitcoin OR +crypto"
- "sunak AND (truss OR johnson)"
order: 1
type: "string"
sort_by:
default: "publishedAt"
description: "The order to sort the articles in. Possible options: relevancy,\n\
popularity, publishedAt.\n"
enum:
- "relevancy"
- "popularity"
- "publishedAt"
order: 11
type: "string"
sources:
description: "Identifiers (maximum 20) for the news sources or blogs you\
\ want\nheadlines from. Use the `/sources` endpoint to locate these\n\
programmatically or look at the sources index:\nhttps://newsapi.com/sources.\
\ Will override both country and category.\n"
items:
type: "string"
order: 3
type: "array"
start_date:
description: "A date and optional time for the oldest article allowed. This\
\ should\nbe in ISO 8601 format.\n"
examples:
- "2021-01-01"
- "2021-01-01T12:00:00"
order: 6
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2})?$"
type: "string"
sourceType:
title: "news-api"
const: "news-api"
enum:
- "news-api"
order: 0
type: "string"
required:
- "api_key"
- "country"
- "category"
- "sort_by"
- "sourceType"
type: "object"
source-news-api-update:
properties:
api_key:
airbyte_secret: true
description: "API Key"
order: 0
title: "API Key"
type: "string"
category:
default: "business"
description: "The category you want to get top headlines for."
enum:
- "business"
- "entertainment"
- "general"
- "health"
- "science"
- "sports"
- "technology"
order: 10
type: "string"
country:
default: "us"
description: "The 2-letter ISO 3166-1 code of the country you want to get\
\ headlines\nfor. You can't mix this with the sources parameter.\n"
enum:
- "ae"
- "ar"
- "at"
- "au"
- "be"
- "bg"
- "br"
- "ca"
- "ch"
- "cn"
- "co"
- "cu"
- "cz"
- "de"
- "eg"
- "fr"
- "gb"
- "gr"
- "hk"
- "hu"
- "id"
- "ie"
- "il"
- "in"
- "it"
- "jp"
- "kr"
- "lt"
- "lv"
- "ma"
- "mx"
- "my"
- "ng"
- "nl"
- "no"
- "nz"
- "ph"
- "pl"
- "pt"
- "ro"
- "rs"
- "ru"
- "sa"
- "se"
- "sg"
- "si"
- "sk"
- "th"
- "tr"
- "tw"
- "ua"
- "us"
- "ve"
- "za"
order: 9
type: "string"
domains:
description: "A comma-seperated string of domains (eg bbc.co.uk, techcrunch.com,\n\
engadget.com) to restrict the search to.\n"
items:
type: "string"
order: 4
type: "array"
end_date:
description: "A date and optional time for the newest article allowed. This\
\ should\nbe in ISO 8601 format.\n"
examples:
- "2021-01-01"
- "2021-01-01T12:00:00"
order: 7
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2})?$"
type: "string"
exclude_domains:
description: "A comma-seperated string of domains (eg bbc.co.uk, techcrunch.com,\n\
engadget.com) to remove from the results.\n"
items:
type: "string"
order: 5
type: "array"
language:
description: "The 2-letter ISO-639-1 code of the language you want to get\
\ headlines\nfor. Possible options: ar de en es fr he it nl no pt ru se\
\ ud zh.\n"
enum:
- "ar"
- "de"
- "en"
- "es"
- "fr"
- "he"
- "it"
- "nl"
- "no"
- "pt"
- "ru"
- "se"
- "ud"
- "zh"
order: 8
type: "string"
search_in:
description: "Where to apply search query. Possible values are: title, description,\n\
content.\n"
items:
enum:
- "title"
- "description"
- "content"
type: "string"
order: 2
type: "array"
search_query:
description: "Search query. See https://newsapi.org/docs/endpoints/everything\
\ for \ninformation.\n"
examples:
- "+bitcoin OR +crypto"
- "sunak AND (truss OR johnson)"
order: 1
type: "string"
sort_by:
default: "publishedAt"
description: "The order to sort the articles in. Possible options: relevancy,\n\
popularity, publishedAt.\n"
enum:
- "relevancy"
- "popularity"
- "publishedAt"
order: 11
type: "string"
sources:
description: "Identifiers (maximum 20) for the news sources or blogs you\
\ want\nheadlines from. Use the `/sources` endpoint to locate these\n\
programmatically or look at the sources index:\nhttps://newsapi.com/sources.\
\ Will override both country and category.\n"
items:
type: "string"
order: 3
type: "array"
start_date:
description: "A date and optional time for the oldest article allowed. This\
\ should\nbe in ISO 8601 format.\n"
examples:
- "2021-01-01"
- "2021-01-01T12:00:00"
order: 6
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2})?$"
type: "string"
required:
- "api_key"
- "country"
- "category"
- "sort_by"
type: "object"
source-linkedin-pages:
properties:
credentials:
oneOf:
- properties:
auth_method:
const: "oAuth2.0"
type: "string"
enum:
- "oAuth2.0"
client_id:
airbyte_secret: true
description: "The client ID of the LinkedIn developer application."
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The client secret of the LinkedIn developer application."
title: "Client secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "The token value generated using the LinkedIn Developers\
\ OAuth Token Tools. See the docs to obtain yours."
title: "Refresh token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "client_id"
- "client_secret"
- "refresh_token"
title: "OAuth2.0"
type: "object"
- properties:
access_token:
airbyte_secret: true
description: "The token value generated using the LinkedIn Developers\
\ OAuth Token Tools. See the docs to obtain yours."
title: "Access token"
type: "string"
x-speakeasy-param-sensitive: true
auth_method:
const: "access_token"
type: "string"
enum:
- "access_token"
required:
- "access_token"
title: "Access token"
type: "object"
order: 0
title: "Authentication"
type: "object"
org_id:
airbyte_secret: true
description: "Specify the Organization ID"
examples:
- "123456789"
order: 1
title: "Organization ID"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
default: "2023-01-01T00:00:00Z"
description: "Start date for getting metrics per time period. Must be atmost\
\ 12 months before the request date (UTC) and atleast 2 days prior to\
\ the request date (UTC). See https://bit.ly/linkedin-pages-date-rules\
\ {{ \"\\n\" }} {{ response.errorDetails }}"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
time_granularity_type:
default: "DAY"
description: "Granularity of the statistics for metrics per time period.\
\ Must be either \"DAY\" or \"MONTH\""
enum:
- "DAY"
- "MONTH"
order: 3
title: "Time Granularity Type"
type: "string"
sourceType:
title: "linkedin-pages"
const: "linkedin-pages"
enum:
- "linkedin-pages"
order: 0
type: "string"
required:
- "org_id"
- "sourceType"
type: "object"
source-linkedin-pages-update:
properties:
credentials:
oneOf:
- properties:
auth_method:
const: "oAuth2.0"
type: "string"
enum:
- "oAuth2.0"
client_id:
airbyte_secret: true
description: "The client ID of the LinkedIn developer application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The client secret of the LinkedIn developer application."
title: "Client secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "The token value generated using the LinkedIn Developers\
\ OAuth Token Tools. See the docs to obtain yours."
title: "Refresh token"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
title: "OAuth2.0"
type: "object"
- properties:
access_token:
airbyte_secret: true
description: "The token value generated using the LinkedIn Developers\
\ OAuth Token Tools. See the docs to obtain yours."
title: "Access token"
type: "string"
auth_method:
const: "access_token"
type: "string"
enum:
- "access_token"
required:
- "access_token"
title: "Access token"
type: "object"
order: 0
title: "Authentication"
type: "object"
org_id:
airbyte_secret: true
description: "Specify the Organization ID"
examples:
- "123456789"
order: 1
title: "Organization ID"
type: "string"
start_date:
default: "2023-01-01T00:00:00Z"
description: "Start date for getting metrics per time period. Must be atmost\
\ 12 months before the request date (UTC) and atleast 2 days prior to\
\ the request date (UTC). See https://bit.ly/linkedin-pages-date-rules\
\ {{ \"\\n\" }} {{ response.errorDetails }}"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
time_granularity_type:
default: "DAY"
description: "Granularity of the statistics for metrics per time period.\
\ Must be either \"DAY\" or \"MONTH\""
enum:
- "DAY"
- "MONTH"
order: 3
title: "Time Granularity Type"
type: "string"
required:
- "org_id"
type: "object"
source-zoho-books:
properties:
client_id:
airbyte_secret: true
name: "client_id"
order: 1
title: "OAuth Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
name: "client_secret"
order: 2
title: "OAuth Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
name: "refresh_token"
order: 3
title: "OAuth Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
region:
description: "The region code for the Zoho Books API, such as 'com', 'eu',\
\ 'in', etc."
enum:
- "com"
- "eu"
- "in"
- "com.cn"
- "com.au"
- "jp"
- "sa"
- "ca"
name: "region"
order: 0
title: "Region"
type: "string"
start_date:
format: "date-time"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "zoho-books"
const: "zoho-books"
enum:
- "zoho-books"
order: 0
type: "string"
required:
- "region"
- "client_id"
- "client_secret"
- "refresh_token"
- "start_date"
- "sourceType"
type: "object"
source-zoho-books-update:
properties:
client_id:
airbyte_secret: true
name: "client_id"
order: 1
title: "OAuth Client ID"
type: "string"
client_secret:
airbyte_secret: true
name: "client_secret"
order: 2
title: "OAuth Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
name: "refresh_token"
order: 3
title: "OAuth Refresh Token"
type: "string"
region:
description: "The region code for the Zoho Books API, such as 'com', 'eu',\
\ 'in', etc."
enum:
- "com"
- "eu"
- "in"
- "com.cn"
- "com.au"
- "jp"
- "sa"
- "ca"
name: "region"
order: 0
title: "Region"
type: "string"
start_date:
format: "date-time"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "region"
- "client_id"
- "client_secret"
- "refresh_token"
- "start_date"
type: "object"
source-track-pms:
properties:
api_key:
order: 1
title: "API Key"
type: "string"
api_secret:
airbyte_secret: true
always_show: true
order: 2
title: "API Secret"
type: "string"
x-speakeasy-param-sensitive: true
customer_domain:
order: 0
title: "Customer Domain"
type: "string"
sourceType:
title: "track-pms"
const: "track-pms"
enum:
- "track-pms"
order: 0
type: "string"
required:
- "customer_domain"
- "api_key"
- "sourceType"
type: "object"
source-track-pms-update:
properties:
api_key:
order: 1
title: "API Key"
type: "string"
api_secret:
airbyte_secret: true
always_show: true
order: 2
title: "API Secret"
type: "string"
customer_domain:
order: 0
title: "Customer Domain"
type: "string"
required:
- "customer_domain"
- "api_key"
type: "object"
source-whisky-hunter:
properties:
sourceType:
title: "whisky-hunter"
const: "whisky-hunter"
enum:
- "whisky-hunter"
order: 0
type: "string"
required:
- "sourceType"
type: "object"
source-whisky-hunter-update:
properties: {}
required: []
type: "object"
source-tvmaze-schedule:
properties:
domestic_schedule_country_code:
description: "Country code for domestic TV schedule retrieval."
examples:
- "US"
- "GB"
order: 2
type: "string"
end_date:
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}$"
type: "string"
start_date:
description: "Start date for TV schedule retrieval. May be in the future."
order: 0
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
type: "string"
web_schedule_country_code:
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"
order: 3
type: "string"
sourceType:
title: "tvmaze-schedule"
const: "tvmaze-schedule"
enum:
- "tvmaze-schedule"
order: 0
type: "string"
required:
- "start_date"
- "domestic_schedule_country_code"
- "sourceType"
type: "object"
source-tvmaze-schedule-update:
properties:
domestic_schedule_country_code:
description: "Country code for domestic TV schedule retrieval."
examples:
- "US"
- "GB"
order: 2
type: "string"
end_date:
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}$"
type: "string"
start_date:
description: "Start date for TV schedule retrieval. May be in the future."
order: 0
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
type: "string"
web_schedule_country_code:
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"
order: 3
type: "string"
required:
- "start_date"
- "domestic_schedule_country_code"
type: "object"
source-salesloft:
properties:
credentials:
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests."
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "oauth2.0"
type: "string"
enum:
- "oauth2.0"
client_id:
description: "The Client ID of your Salesloft developer application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Salesloft developer application."
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "The token for obtaining a new access token."
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
token_expiry_date:
description: "The date-time when the access token should be refreshed."
format: "date-time"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "access_token"
- "token_expiry_date"
- "auth_type"
title: "Authenticate via OAuth"
type: "object"
- properties:
api_key:
airbyte_secret: true
description: "API Key for making authenticated requests. More instruction\
\ on how to find this value in our docs"
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "api_key"
type: "string"
enum:
- "api_key"
required:
- "api_key"
- "auth_type"
title: "Authenticate via API Key"
type: "object"
order: 0
title: "Credentials"
type: "object"
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"
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
sourceType:
title: "salesloft"
const: "salesloft"
enum:
- "salesloft"
order: 0
type: "string"
required:
- "credentials"
- "start_date"
- "sourceType"
type: "object"
source-salesloft-update:
properties:
credentials:
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests."
type: "string"
auth_type:
const: "oauth2.0"
type: "string"
enum:
- "oauth2.0"
client_id:
description: "The Client ID of your Salesloft developer application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Salesloft developer application."
title: "Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "The token for obtaining a new access token."
title: "Refresh Token"
type: "string"
token_expiry_date:
description: "The date-time when the access token should be refreshed."
format: "date-time"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "access_token"
- "token_expiry_date"
- "auth_type"
title: "Authenticate via OAuth"
type: "object"
- properties:
api_key:
airbyte_secret: true
description: "API Key for making authenticated requests. More instruction\
\ on how to find this value in our docs"
title: "API Key"
type: "string"
auth_type:
const: "api_key"
type: "string"
enum:
- "api_key"
required:
- "api_key"
- "auth_type"
title: "Authenticate via API Key"
type: "object"
order: 0
title: "Credentials"
type: "object"
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"
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
required:
- "credentials"
- "start_date"
type: "object"
source-ninjaone-rmm:
properties:
api_key:
airbyte_secret: true
description: "Token could be generated natively by authorize section of\
\ NinjaOne swagger documentation `https://app.ninjarmm.com/apidocs/?links.active=authorization`"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "ninjaone-rmm"
const: "ninjaone-rmm"
enum:
- "ninjaone-rmm"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-ninjaone-rmm-update:
properties:
api_key:
airbyte_secret: true
description: "Token could be generated natively by authorize section of\
\ NinjaOne swagger documentation `https://app.ninjarmm.com/apidocs/?links.active=authorization`"
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-youtube-data:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
channel_ids:
order: 1
title: "Channel IDs"
type: "array"
sourceType:
title: "youtube-data"
const: "youtube-data"
enum:
- "youtube-data"
order: 0
type: "string"
required:
- "api_key"
- "channel_ids"
- "sourceType"
type: "object"
source-youtube-data-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
channel_ids:
order: 1
title: "Channel IDs"
type: "array"
required:
- "api_key"
- "channel_ids"
type: "object"
source-yandex-metrica:
properties:
auth_token:
airbyte_secret: true
description: "Your Yandex Metrica API access token"
order: 0
title: "Authentication Token"
type: "string"
x-speakeasy-param-sensitive: true
counter_id:
description: "Counter ID"
order: 1
pattern: "^[0-9]+$"
title: "Counter ID"
type: "string"
end_date:
description: "Starting point for your data replication, in format of \"\
YYYY-MM-DD\". If not provided will sync till most recent date."
examples:
- "2022-01-01"
format: "date"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "End Date"
type: "string"
start_date:
description: "Starting point for your data replication, in format of \"\
YYYY-MM-DD\"."
examples:
- "2022-01-01"
format: "date"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
sourceType:
title: "yandex-metrica"
const: "yandex-metrica"
enum:
- "yandex-metrica"
order: 0
type: "string"
required:
- "auth_token"
- "counter_id"
- "start_date"
- "sourceType"
title: "Yandex Metrica Spec"
type: "object"
source-yandex-metrica-update:
properties:
auth_token:
airbyte_secret: true
description: "Your Yandex Metrica API access token"
order: 0
title: "Authentication Token"
type: "string"
counter_id:
description: "Counter ID"
order: 1
pattern: "^[0-9]+$"
title: "Counter ID"
type: "string"
end_date:
description: "Starting point for your data replication, in format of \"\
YYYY-MM-DD\". If not provided will sync till most recent date."
examples:
- "2022-01-01"
format: "date"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "End Date"
type: "string"
start_date:
description: "Starting point for your data replication, in format of \"\
YYYY-MM-DD\"."
examples:
- "2022-01-01"
format: "date"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
required:
- "auth_token"
- "counter_id"
- "start_date"
title: "Yandex Metrica Spec"
type: "object"
source-clickup-api:
properties:
api_token:
airbyte_secret: true
description: "Every ClickUp API call required authentication. This field\
\ is your personal API token. See here."
order: 0
type: "string"
x-speakeasy-param-sensitive: true
include_closed_tasks:
default: false
description: "Include or exclude closed tasks. By default, they are excluded.\
\ See here."
order: 5
title: "Include Closed Tasks"
type: "boolean"
sourceType:
title: "clickup-api"
const: "clickup-api"
enum:
- "clickup-api"
order: 0
type: "string"
required:
- "api_token"
- "sourceType"
type: "object"
source-clickup-api-update:
properties:
api_token:
airbyte_secret: true
description: "Every ClickUp API call required authentication. This field\
\ is your personal API token. See here."
order: 0
type: "string"
include_closed_tasks:
default: false
description: "Include or exclude closed tasks. By default, they are excluded.\
\ See here."
order: 5
title: "Include Closed Tasks"
type: "boolean"
required:
- "api_token"
type: "object"
source-ezofficeinventory:
properties:
api_key:
airbyte_secret: true
description: "Your EZOfficeInventory Access Token. API Access is disabled\
\ by default. Enable API Access in Settings > Integrations > API Integration\
\ and click on Update to generate a new access token"
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "Earliest date you want to sync historical streams (inventory_histories,\
\ asset_histories, asset_stock_histories) from"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
subdomain:
airbyte_secret: false
description: "The company name used in signup, also visible in the URL when\
\ logged in."
name: "subdomain"
order: 1
title: "Subdomain"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "ezofficeinventory"
const: "ezofficeinventory"
enum:
- "ezofficeinventory"
order: 0
type: "string"
required:
- "api_key"
- "subdomain"
- "start_date"
- "sourceType"
type: "object"
source-ezofficeinventory-update:
properties:
api_key:
airbyte_secret: true
description: "Your EZOfficeInventory Access Token. API Access is disabled\
\ by default. Enable API Access in Settings > Integrations > API Integration\
\ and click on Update to generate a new access token"
name: "api_key"
order: 0
title: "API Key"
type: "string"
start_date:
description: "Earliest date you want to sync historical streams (inventory_histories,\
\ asset_histories, asset_stock_histories) from"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
subdomain:
airbyte_secret: false
description: "The company name used in signup, also visible in the URL when\
\ logged in."
name: "subdomain"
order: 1
title: "Subdomain"
type: "string"
required:
- "api_key"
- "subdomain"
- "start_date"
type: "object"
source-toggl:
properties:
api_token:
airbyte_secret: true
description: "Your API Token. See here. The token is case sensitive."
title: "API token"
type: "string"
x-speakeasy-param-sensitive: true
end_date:
description: "To retrieve time entries created before the given date (inclusive)."
examples:
- "YYYY-MM-DD"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "End date"
type: "string"
organization_id:
description: "Your organization id. See here."
title: "Organization ID"
type: "integer"
start_date:
description: "To retrieve time entries created after the given date (inclusive)."
examples:
- "YYYY-MM-DD"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start date"
type: "string"
workspace_id:
description: "Your workspace id. See here."
title: "Workspace ID"
type: "integer"
sourceType:
title: "toggl"
const: "toggl"
enum:
- "toggl"
order: 0
type: "string"
required:
- "api_token"
- "organization_id"
- "workspace_id"
- "start_date"
- "end_date"
- "sourceType"
title: "Toggl Spec"
type: "object"
source-toggl-update:
properties:
api_token:
airbyte_secret: true
description: "Your API Token. See here. The token is case sensitive."
title: "API token"
type: "string"
end_date:
description: "To retrieve time entries created before the given date (inclusive)."
examples:
- "YYYY-MM-DD"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "End date"
type: "string"
organization_id:
description: "Your organization id. See here."
title: "Organization ID"
type: "integer"
start_date:
description: "To retrieve time entries created after the given date (inclusive)."
examples:
- "YYYY-MM-DD"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start date"
type: "string"
workspace_id:
description: "Your workspace id. See here."
title: "Workspace ID"
type: "integer"
required:
- "api_token"
- "organization_id"
- "workspace_id"
- "start_date"
- "end_date"
title: "Toggl Spec"
type: "object"
source-assemblyai:
properties:
api_key:
airbyte_secret: true
description: "Your AssemblyAI API key. You can find it in the AssemblyAI\
\ dashboard at https://www.assemblyai.com/app/api-keys."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
request_id:
description: "The request ID for LeMur responses"
order: 3
title: "Request Id"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
subtitle_format:
default: "srt"
description: "The subtitle format for transcript_subtitle stream"
enum:
- "vtt"
- "srt"
order: 2
title: "Subtitle format"
type: "string"
sourceType:
title: "assemblyai"
const: "assemblyai"
enum:
- "assemblyai"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "subtitle_format"
- "sourceType"
type: "object"
source-assemblyai-update:
properties:
api_key:
airbyte_secret: true
description: "Your AssemblyAI API key. You can find it in the AssemblyAI\
\ dashboard at https://www.assemblyai.com/app/api-keys."
name: "api_key"
order: 0
title: "API Key"
type: "string"
request_id:
description: "The request ID for LeMur responses"
order: 3
title: "Request Id"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
subtitle_format:
default: "srt"
description: "The subtitle format for transcript_subtitle stream"
enum:
- "vtt"
- "srt"
order: 2
title: "Subtitle format"
type: "string"
required:
- "api_key"
- "start_date"
- "subtitle_format"
type: "object"
source-snowflake:
properties:
check_privileges:
default: true
description: "When this feature is enabled, during schema discovery the\
\ connector will query each table or view individually to check access\
\ privileges and inaccessible tables, views, or columns therein will be\
\ removed. In large schemas, this might cause schema discovery to take\
\ too long, in which case it might be advisable to disable this feature."
order: 10
title: "Check Table and Column Access Privileges"
type: "boolean"
checkpoint_target_interval_seconds:
default: 300
description: "How often (in seconds) a stream should checkpoint, when possible."
order: 8
title: "Checkpoint Target Time Interval"
type: "integer"
concurrency:
default: 1
description: "Maximum number of concurrent queries to the database."
order: 9
title: "Concurrency"
type: "integer"
credentials:
oneOf:
- additionalProperties: true
order: 1
properties:
auth_type:
default: "Key Pair Authentication"
enum:
- "Key Pair Authentication"
type: "string"
private_key:
airbyte_secret: true
description: "RSA Private key to use for Snowflake connection. See\
\ the docs for more information on how to obtain this key."
multiline: true
order: 2
title: "Private Key"
type: "string"
x-speakeasy-param-sensitive: true
private_key_password:
airbyte_secret: true
description: "Passphrase for private key"
order: 3
title: "Passphrase"
type: "string"
x-speakeasy-param-sensitive: true
username:
description: "The username you created to allow Airbyte to access\
\ the database."
order: 1
title: "Username"
type: "string"
required:
- "auth_type"
- "username"
- "private_key"
title: "Key Pair Authentication"
type: "object"
- additionalProperties: true
order: 2
properties:
auth_type:
default: "username/password"
enum:
- "username/password"
type: "string"
password:
airbyte_secret: true
description: "The password associated with the username."
order: 2
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
username:
description: "The username you created to allow Airbyte to access\
\ the database."
order: 1
title: "Username"
type: "string"
required:
- "auth_type"
- "username"
- "password"
title: "Username and Password"
type: "object"
order: 0
title: "Authorization Method"
type: "object"
cursor:
description: "Configures how data is extracted from the database."
display_type: "radio"
oneOf:
- additionalProperties: true
description: "Incrementally detects new inserts and updates using the\
\ cursor column chosen when configuring a connection (e.g. created_at,\
\ updated_at)."
properties:
cursor_method:
default: "user_defined"
enum:
- "user_defined"
type: "string"
required:
- "cursor_method"
title: "Scan Changes with User Defined Cursor"
type: "object"
order: 7
title: "Update Method"
type: "object"
database:
description: "The database you created for Airbyte to access data."
order: 4
title: "Database"
type: "string"
host:
description: "The host domain of the snowflake instance (must include the\
\ account, region, cloud environment, and end with snowflakecomputing.com)."
order: 1
title: "Server URL"
type: "string"
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)."
order: 6
title: "JDBC URL Params"
type: "string"
role:
description: "The role you created for Airbyte to access Snowflake."
order: 2
title: "Role"
type: "string"
schema:
description: "The source Snowflake schema tables. Leave empty to access\
\ tables from multiple schemas."
order: 5
title: "Schema"
type: "string"
warehouse:
description: "The warehouse you created for Airbyte to access data."
order: 3
title: "Warehouse"
type: "string"
sourceType:
title: "snowflake"
const: "snowflake"
enum:
- "snowflake"
order: 0
type: "string"
required:
- "host"
- "role"
- "warehouse"
- "database"
- "sourceType"
title: "Snowflake Source Spec"
type: "object"
source-snowflake-update:
properties:
check_privileges:
default: true
description: "When this feature is enabled, during schema discovery the\
\ connector will query each table or view individually to check access\
\ privileges and inaccessible tables, views, or columns therein will be\
\ removed. In large schemas, this might cause schema discovery to take\
\ too long, in which case it might be advisable to disable this feature."
order: 10
title: "Check Table and Column Access Privileges"
type: "boolean"
checkpoint_target_interval_seconds:
default: 300
description: "How often (in seconds) a stream should checkpoint, when possible."
order: 8
title: "Checkpoint Target Time Interval"
type: "integer"
concurrency:
default: 1
description: "Maximum number of concurrent queries to the database."
order: 9
title: "Concurrency"
type: "integer"
credentials:
oneOf:
- additionalProperties: true
order: 1
properties:
auth_type:
default: "Key Pair Authentication"
enum:
- "Key Pair Authentication"
type: "string"
private_key:
airbyte_secret: true
description: "RSA Private key to use for Snowflake connection. See\
\ the docs for more information on how to obtain this key."
multiline: true
order: 2
title: "Private Key"
type: "string"
private_key_password:
airbyte_secret: true
description: "Passphrase for private key"
order: 3
title: "Passphrase"
type: "string"
username:
description: "The username you created to allow Airbyte to access\
\ the database."
order: 1
title: "Username"
type: "string"
required:
- "auth_type"
- "username"
- "private_key"
title: "Key Pair Authentication"
type: "object"
- additionalProperties: true
order: 2
properties:
auth_type:
default: "username/password"
enum:
- "username/password"
type: "string"
password:
airbyte_secret: true
description: "The password associated with the username."
order: 2
title: "Password"
type: "string"
username:
description: "The username you created to allow Airbyte to access\
\ the database."
order: 1
title: "Username"
type: "string"
required:
- "auth_type"
- "username"
- "password"
title: "Username and Password"
type: "object"
order: 0
title: "Authorization Method"
type: "object"
cursor:
description: "Configures how data is extracted from the database."
display_type: "radio"
oneOf:
- additionalProperties: true
description: "Incrementally detects new inserts and updates using the\
\ cursor column chosen when configuring a connection (e.g. created_at,\
\ updated_at)."
properties:
cursor_method:
default: "user_defined"
enum:
- "user_defined"
type: "string"
required:
- "cursor_method"
title: "Scan Changes with User Defined Cursor"
type: "object"
order: 7
title: "Update Method"
type: "object"
database:
description: "The database you created for Airbyte to access data."
order: 4
title: "Database"
type: "string"
host:
description: "The host domain of the snowflake instance (must include the\
\ account, region, cloud environment, and end with snowflakecomputing.com)."
order: 1
title: "Server URL"
type: "string"
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)."
order: 6
title: "JDBC URL Params"
type: "string"
role:
description: "The role you created for Airbyte to access Snowflake."
order: 2
title: "Role"
type: "string"
schema:
description: "The source Snowflake schema tables. Leave empty to access\
\ tables from multiple schemas."
order: 5
title: "Schema"
type: "string"
warehouse:
description: "The warehouse you created for Airbyte to access data."
order: 3
title: "Warehouse"
type: "string"
required:
- "host"
- "role"
- "warehouse"
- "database"
title: "Snowflake Source Spec"
type: "object"
source-auth0:
properties:
base_url:
description: "The Authentication API is served over HTTPS. All URLs referenced\
\ in the documentation have the following base `https://YOUR_DOMAIN`"
examples:
- "https://dev-yourOrg.us.auth0.com/"
title: "Base URL"
type: "string"
credentials:
oneOf:
- properties:
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"
examples:
- "https://dev-yourOrg.us.auth0.com/api/v2/"
title: "Audience"
type: "string"
auth_type:
const: "oauth2_confidential_application"
order: 0
title: "Authentication Method"
type: "string"
enum:
- "oauth2_confidential_application"
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."
examples:
- "Client_ID"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Your application's Client Secret. You can find this\
\ value on the application's settings tab after you login the admin portal."
examples:
- "Client_Secret"
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_type"
- "client_id"
- "client_secret"
- "audience"
title: "OAuth2 Confidential Application"
type: "object"
- properties:
access_token:
airbyte_secret: true
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."
title: "OAuth2 Access Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "oauth2_access_token"
examples:
- "oauth2_access_token"
order: 0
title: "Authentication Method"
type: "string"
enum:
- "oauth2_access_token"
required:
- "access_token"
- "auth_type"
title: "OAuth2 Access Token"
type: "object"
title: "Authentication Method"
type: "object"
start_date:
airbyte_secret: false
default: "2023-08-05T00:43:59.244Z"
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"
title: "Start Date"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "auth0"
const: "auth0"
enum:
- "auth0"
order: 0
type: "string"
required:
- "base_url"
- "credentials"
- "sourceType"
title: "Auth0 Management API Spec"
type: "object"
source-auth0-update:
properties:
base_url:
description: "The Authentication API is served over HTTPS. All URLs referenced\
\ in the documentation have the following base `https://YOUR_DOMAIN`"
examples:
- "https://dev-yourOrg.us.auth0.com/"
title: "Base URL"
type: "string"
credentials:
oneOf:
- properties:
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"
examples:
- "https://dev-yourOrg.us.auth0.com/api/v2/"
title: "Audience"
type: "string"
auth_type:
const: "oauth2_confidential_application"
order: 0
title: "Authentication Method"
type: "string"
enum:
- "oauth2_confidential_application"
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."
examples:
- "Client_ID"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Your application's Client Secret. You can find this\
\ value on the application's settings tab after you login the admin portal."
examples:
- "Client_Secret"
title: "Client Secret"
type: "string"
required:
- "auth_type"
- "client_id"
- "client_secret"
- "audience"
title: "OAuth2 Confidential Application"
type: "object"
- properties:
access_token:
airbyte_secret: true
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."
title: "OAuth2 Access Token"
type: "string"
auth_type:
const: "oauth2_access_token"
examples:
- "oauth2_access_token"
order: 0
title: "Authentication Method"
type: "string"
enum:
- "oauth2_access_token"
required:
- "access_token"
- "auth_type"
title: "OAuth2 Access Token"
type: "object"
title: "Authentication Method"
type: "object"
start_date:
airbyte_secret: false
default: "2023-08-05T00:43:59.244Z"
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"
title: "Start Date"
type: "string"
required:
- "base_url"
- "credentials"
title: "Auth0 Management API Spec"
type: "object"
source-awin-advertiser:
properties:
advertiserId:
description: "Your Awin Advertiser ID. You can find this in your Awin dashboard\
\ or account settings."
name: "advertiserId"
order: 0
title: "advertiserId"
type: "string"
api_key:
airbyte_secret: true
description: "Your Awin API key. Generate this from your Awin account under\
\ API Credentials."
order: 1
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
lookback_days:
description: "Number of days to look back on each sync to catch any updates\
\ to existing records."
order: 3
title: "Lookback Days"
type: "integer"
start_date:
description: "Start date for data replication in YYYY-MM-DD format"
format: "date"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
step_increment:
default: "P400D"
description: "The time window size for each API request in ISO8601 duration\
\ format.\nFor the campaign performance stream, Awin API explicitly limits\
\ the period between startDate and endDate to 400 days maximum.\n"
order: 2
title: "Step Increment"
type: "string"
sourceType:
title: "awin-advertiser"
const: "awin-advertiser"
enum:
- "awin-advertiser"
order: 0
type: "string"
required:
- "advertiserId"
- "api_key"
- "step_increment"
- "lookback_days"
- "start_date"
- "sourceType"
type: "object"
source-awin-advertiser-update:
properties:
advertiserId:
description: "Your Awin Advertiser ID. You can find this in your Awin dashboard\
\ or account settings."
name: "advertiserId"
order: 0
title: "advertiserId"
type: "string"
api_key:
airbyte_secret: true
description: "Your Awin API key. Generate this from your Awin account under\
\ API Credentials."
order: 1
title: "API Key"
type: "string"
lookback_days:
description: "Number of days to look back on each sync to catch any updates\
\ to existing records."
order: 3
title: "Lookback Days"
type: "integer"
start_date:
description: "Start date for data replication in YYYY-MM-DD format"
format: "date"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
step_increment:
default: "P400D"
description: "The time window size for each API request in ISO8601 duration\
\ format.\nFor the campaign performance stream, Awin API explicitly limits\
\ the period between startDate and endDate to 400 days maximum.\n"
order: 2
title: "Step Increment"
type: "string"
required:
- "advertiserId"
- "api_key"
- "step_increment"
- "lookback_days"
- "start_date"
type: "object"
source-cal-com:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it at https://cal.com/account"
name: "api_key"
order: 1
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
orgId:
name: "Organization ID"
order: 0
title: "orgId"
type: "string"
sourceType:
title: "cal-com"
const: "cal-com"
enum:
- "cal-com"
order: 0
type: "string"
required:
- "orgId"
- "api_key"
- "sourceType"
type: "object"
source-cal-com-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it at https://cal.com/account"
name: "api_key"
order: 1
title: "API Key"
type: "string"
orgId:
name: "Organization ID"
order: 0
title: "orgId"
type: "string"
required:
- "orgId"
- "api_key"
type: "object"
source-fullstory:
properties:
api_key:
airbyte_secret: true
description: "API Key for the fullstory.com API."
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
uid:
airbyte_secret: true
description: "User ID for the fullstory.com API."
order: 1
title: "User ID"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "fullstory"
const: "fullstory"
enum:
- "fullstory"
order: 0
type: "string"
required:
- "api_key"
- "uid"
- "sourceType"
type: "object"
source-fullstory-update:
properties:
api_key:
airbyte_secret: true
description: "API Key for the fullstory.com API."
order: 0
title: "API Key"
type: "string"
uid:
airbyte_secret: true
description: "User ID for the fullstory.com API."
order: 1
title: "User ID"
type: "string"
required:
- "api_key"
- "uid"
type: "object"
source-oveit:
properties:
email:
description: "Oveit's login Email"
order: 0
title: "Email"
type: "string"
password:
airbyte_secret: true
description: "Oveit's login Password"
order: 1
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "oveit"
const: "oveit"
enum:
- "oveit"
order: 0
type: "string"
required:
- "email"
- "password"
- "sourceType"
type: "object"
source-oveit-update:
properties:
email:
description: "Oveit's login Email"
order: 0
title: "Email"
type: "string"
password:
airbyte_secret: true
description: "Oveit's login Password"
order: 1
title: "Password"
type: "string"
required:
- "email"
- "password"
type: "object"
source-clockify:
properties:
api_key:
airbyte_secret: true
description: "You can get your api access_key here This API is Case Sensitive."
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
api_url:
default: "https://api.clockify.me"
description: "The URL for the Clockify API. This should only need to be\
\ modified if connecting to an enterprise version of Clockify."
order: 1
title: "API Url"
type: "string"
workspace_id:
description: "WorkSpace Id"
order: 2
title: "Workspace Id"
type: "string"
sourceType:
title: "clockify"
const: "clockify"
enum:
- "clockify"
order: 0
type: "string"
required:
- "api_key"
- "workspace_id"
- "sourceType"
type: "object"
source-clockify-update:
properties:
api_key:
airbyte_secret: true
description: "You can get your api access_key here This API is Case Sensitive."
order: 0
title: "API Key"
type: "string"
api_url:
default: "https://api.clockify.me"
description: "The URL for the Clockify API. This should only need to be\
\ modified if connecting to an enterprise version of Clockify."
order: 1
title: "API Url"
type: "string"
workspace_id:
description: "WorkSpace Id"
order: 2
title: "Workspace Id"
type: "string"
required:
- "api_key"
- "workspace_id"
type: "object"
source-marketo:
properties:
client_id:
airbyte_secret: true
description: "The Client ID of your Marketo developer application. See the\
\ docs for info on how to obtain this."
order: 0
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The Client Secret of your Marketo developer application. See\
\ the\
\ docs for info on how to obtain this."
order: 1
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
domain_url:
airbyte_secret: true
description: "Your Marketo Base URL. See the docs for info on how to obtain this."
examples:
- "https://000-AAA-000.mktorest.com"
order: 3
title: "Domain URL"
type: "string"
x-speakeasy-param-sensitive: true
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-09-25T00:00:00Z"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
sourceType:
title: "marketo"
const: "marketo"
enum:
- "marketo"
order: 0
type: "string"
required:
- "domain_url"
- "client_id"
- "client_secret"
- "start_date"
- "sourceType"
title: "Source Marketo Spec"
type: "object"
source-marketo-update:
properties:
client_id:
airbyte_secret: true
description: "The Client ID of your Marketo developer application. See the\
\ docs for info on how to obtain this."
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Marketo developer application. See\
\ the\
\ docs for info on how to obtain this."
order: 1
title: "Client Secret"
type: "string"
domain_url:
airbyte_secret: true
description: "Your Marketo Base URL. See the docs for info on how to obtain this."
examples:
- "https://000-AAA-000.mktorest.com"
order: 3
title: "Domain URL"
type: "string"
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-09-25T00:00:00Z"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
required:
- "domain_url"
- "client_id"
- "client_secret"
- "start_date"
title: "Source Marketo Spec"
type: "object"
source-pocket:
properties:
access_token:
airbyte_secret: true
description: "The user's Pocket access token."
order: 1
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
consumer_key:
airbyte_secret: true
description: "Your application's Consumer Key."
order: 0
title: "Consumer Key"
type: "string"
x-speakeasy-param-sensitive: true
content_type:
description: "Select the content type of the items to retrieve."
enum:
- "article"
- "video"
- "image"
order: 5
title: "Content Type"
type: "string"
detail_type:
description: "Select the granularity of the information about each item."
enum:
- "simple"
- "complete"
order: 7
title: "Detail Type"
type: "string"
domain:
description: "Only return items from a particular `domain`."
order: 9
title: "Domain"
type: "string"
favorite:
default: false
description: "Retrieve only favorited items."
order: 3
title: "Is Favorite?"
type: "boolean"
search:
description: "Only return items whose title or url contain the `search`\
\ string."
order: 8
title: "Search Query"
type: "string"
since:
description: "Only return items modified since the given timestamp."
examples:
- "2022-10-20 14:14:14"
order: 10
pattern: "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}"
title: "Since"
type: "string"
sort:
description: "Sort retrieved items by the given criteria."
enum:
- "newest"
- "oldest"
- "title"
- "site"
order: 6
title: "Sort By"
type: "string"
state:
description: "Select the state of the items to retrieve."
enum:
- "unread"
- "archive"
- "all"
order: 2
title: "State"
type: "string"
tag:
description: "Return only items tagged with this tag name. Use _untagged_\
\ for retrieving only untagged items."
order: 4
title: "Tag Name"
type: "string"
sourceType:
title: "pocket"
const: "pocket"
enum:
- "pocket"
order: 0
type: "string"
required:
- "consumer_key"
- "access_token"
- "sourceType"
title: "Pocket Spec"
type: "object"
source-pocket-update:
properties:
access_token:
airbyte_secret: true
description: "The user's Pocket access token."
order: 1
title: "Access Token"
type: "string"
consumer_key:
airbyte_secret: true
description: "Your application's Consumer Key."
order: 0
title: "Consumer Key"
type: "string"
content_type:
description: "Select the content type of the items to retrieve."
enum:
- "article"
- "video"
- "image"
order: 5
title: "Content Type"
type: "string"
detail_type:
description: "Select the granularity of the information about each item."
enum:
- "simple"
- "complete"
order: 7
title: "Detail Type"
type: "string"
domain:
description: "Only return items from a particular `domain`."
order: 9
title: "Domain"
type: "string"
favorite:
default: false
description: "Retrieve only favorited items."
order: 3
title: "Is Favorite?"
type: "boolean"
search:
description: "Only return items whose title or url contain the `search`\
\ string."
order: 8
title: "Search Query"
type: "string"
since:
description: "Only return items modified since the given timestamp."
examples:
- "2022-10-20 14:14:14"
order: 10
pattern: "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}"
title: "Since"
type: "string"
sort:
description: "Sort retrieved items by the given criteria."
enum:
- "newest"
- "oldest"
- "title"
- "site"
order: 6
title: "Sort By"
type: "string"
state:
description: "Select the state of the items to retrieve."
enum:
- "unread"
- "archive"
- "all"
order: 2
title: "State"
type: "string"
tag:
description: "Return only items tagged with this tag name. Use _untagged_\
\ for retrieving only untagged items."
order: 4
title: "Tag Name"
type: "string"
required:
- "consumer_key"
- "access_token"
title: "Pocket Spec"
type: "object"
source-productboard:
properties:
access_token:
airbyte_secret: true
description: "Your Productboard access token. See https://developer.productboard.com/reference/authentication\
\ for steps to generate one."
name: "api_key"
order: 0
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "productboard"
const: "productboard"
enum:
- "productboard"
order: 0
type: "string"
required:
- "access_token"
- "start_date"
- "sourceType"
type: "object"
source-productboard-update:
properties:
access_token:
airbyte_secret: true
description: "Your Productboard access token. See https://developer.productboard.com/reference/authentication\
\ for steps to generate one."
name: "api_key"
order: 0
title: "Access Token"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "access_token"
- "start_date"
type: "object"
source-smartsheets:
properties:
credentials:
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests."
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "oauth2.0"
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The API ID of the SmartSheets developer application."
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The API Secret the SmartSheets developer application."
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "The key to refresh the expired access_token."
type: "string"
x-speakeasy-param-sensitive: true
token_expiry_date:
description: "The date-time when the access token should be refreshed."
format: "date-time"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "access_token"
- "token_expiry_date"
title: "OAuth2.0"
type: "object"
- properties:
access_token:
airbyte_secret: true
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."
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "access_token"
type: "string"
enum:
- "access_token"
required:
- "access_token"
title: "API Access Token"
type: "object"
order: 0
title: "Authorization Method"
type: "object"
is_report:
default: false
description: "If true, the source will treat the provided sheet_id as a\
\ report. If false, the source will treat the provided sheet_id as a sheet."
order: 4
title: "Is Report"
type: "boolean"
metadata_fields:
description: "A List of available columns which metadata can be pulled from."
items:
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"
title: "Validenums"
order: 3
title: "Metadata Fields"
type: "array"
spreadsheet_id:
description: "The spreadsheet ID. Find it by opening the spreadsheet then\
\ navigating to File > Properties"
order: 1
title: "Sheet ID"
type: "string"
sourceType:
title: "smartsheets"
const: "smartsheets"
enum:
- "smartsheets"
order: 0
type: "string"
required:
- "credentials"
- "spreadsheet_id"
- "sourceType"
title: "Smartsheets Source Spec"
type: "object"
source-smartsheets-update:
properties:
credentials:
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests."
type: "string"
auth_type:
const: "oauth2.0"
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The API ID of the SmartSheets developer application."
type: "string"
client_secret:
airbyte_secret: true
description: "The API Secret the SmartSheets developer application."
type: "string"
refresh_token:
airbyte_secret: true
description: "The key to refresh the expired access_token."
type: "string"
token_expiry_date:
description: "The date-time when the access token should be refreshed."
format: "date-time"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "access_token"
- "token_expiry_date"
title: "OAuth2.0"
type: "object"
- properties:
access_token:
airbyte_secret: true
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."
title: "Access Token"
type: "string"
auth_type:
const: "access_token"
type: "string"
enum:
- "access_token"
required:
- "access_token"
title: "API Access Token"
type: "object"
order: 0
title: "Authorization Method"
type: "object"
is_report:
default: false
description: "If true, the source will treat the provided sheet_id as a\
\ report. If false, the source will treat the provided sheet_id as a sheet."
order: 4
title: "Is Report"
type: "boolean"
metadata_fields:
description: "A List of available columns which metadata can be pulled from."
items:
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"
title: "Validenums"
order: 3
title: "Metadata Fields"
type: "array"
spreadsheet_id:
description: "The spreadsheet ID. Find it by opening the spreadsheet then\
\ navigating to File > Properties"
order: 1
title: "Sheet ID"
type: "string"
required:
- "credentials"
- "spreadsheet_id"
title: "Smartsheets Source Spec"
type: "object"
source-cisco-meraki:
properties:
api_key:
airbyte_secret: true
description: "Your Meraki API key. Obtain it by logging into your Meraki\
\ Dashboard at https://dashboard.meraki.com/, navigating to 'My Profile'\
\ via the avatar icon in the top right corner, and generating the API\
\ key. Save this key securely as it represents your admin credentials."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "cisco-meraki"
const: "cisco-meraki"
enum:
- "cisco-meraki"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-cisco-meraki-update:
properties:
api_key:
airbyte_secret: true
description: "Your Meraki API key. Obtain it by logging into your Meraki\
\ Dashboard at https://dashboard.meraki.com/, navigating to 'My Profile'\
\ via the avatar icon in the top right corner, and generating the API\
\ key. Save this key securely as it represents your admin credentials."
name: "api_key"
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-n8n:
properties:
api_key:
description: "Your API KEY. See here"
order: 1
type: "string"
host:
description: "Hostname of the n8n instance"
order: 0
type: "string"
sourceType:
title: "n8n"
const: "n8n"
enum:
- "n8n"
order: 0
type: "string"
required:
- "host"
- "api_key"
- "sourceType"
type: "object"
source-n8n-update:
properties:
api_key:
description: "Your API KEY. See here"
order: 1
type: "string"
host:
description: "Hostname of the n8n instance"
order: 0
type: "string"
required:
- "host"
- "api_key"
type: "object"
source-nasa:
properties:
api_key:
airbyte_secret: true
description: "API access key used to retrieve data from the NASA APOD API."
order: 0
type: "string"
x-speakeasy-param-sensitive: true
concept_tags:
default: false
description: "Indicates whether concept tags should be returned with the\
\ rest of the response. The concept tags are not necessarily included\
\ in the explanation, but rather derived from common search tags that\
\ are associated with the description text. (Better than just pure text\
\ search.) Defaults to False."
order: 1
type: "boolean"
count:
description: "A positive integer, no greater than 100. If this is specified\
\ then `count` randomly chosen images will be returned in a JSON array.\
\ Cannot be used in conjunction with `date` or `start_date` and `end_date`."
maximum: 100
minimum: 1
order: 2
type: "integer"
end_date:
description: "Indicates that end of a date range. If `start_date` is specified\
\ without an `end_date` then `end_date` defaults to the current date."
examples:
- "2022-10-20"
format: "date"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
type: "string"
start_date:
description: "Indicates the start of a date range. All images in the range\
\ from `start_date` to `end_date` will be returned in a JSON array. Must\
\ be after 1995-06-16, the first day an APOD picture was posted. There\
\ are no images for tomorrow available through this API."
examples:
- "2022-10-20"
format: "date"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
type: "string"
thumbs:
default: false
description: "Indicates whether the API should return a thumbnail image\
\ URL for video files. If set to True, the API returns URL of video thumbnail.\
\ If an APOD is not a video, this parameter is ignored."
order: 5
type: "boolean"
sourceType:
title: "nasa"
const: "nasa"
enum:
- "nasa"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-nasa-update:
properties:
api_key:
airbyte_secret: true
description: "API access key used to retrieve data from the NASA APOD API."
order: 0
type: "string"
concept_tags:
default: false
description: "Indicates whether concept tags should be returned with the\
\ rest of the response. The concept tags are not necessarily included\
\ in the explanation, but rather derived from common search tags that\
\ are associated with the description text. (Better than just pure text\
\ search.) Defaults to False."
order: 1
type: "boolean"
count:
description: "A positive integer, no greater than 100. If this is specified\
\ then `count` randomly chosen images will be returned in a JSON array.\
\ Cannot be used in conjunction with `date` or `start_date` and `end_date`."
maximum: 100
minimum: 1
order: 2
type: "integer"
end_date:
description: "Indicates that end of a date range. If `start_date` is specified\
\ without an `end_date` then `end_date` defaults to the current date."
examples:
- "2022-10-20"
format: "date"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
type: "string"
start_date:
description: "Indicates the start of a date range. All images in the range\
\ from `start_date` to `end_date` will be returned in a JSON array. Must\
\ be after 1995-06-16, the first day an APOD picture was posted. There\
\ are no images for tomorrow available through this API."
examples:
- "2022-10-20"
format: "date"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
type: "string"
thumbs:
default: false
description: "Indicates whether the API should return a thumbnail image\
\ URL for video files. If set to True, the API returns URL of video thumbnail.\
\ If an APOD is not a video, this parameter is ignored."
order: 5
type: "boolean"
required:
- "api_key"
type: "object"
source-squarespace:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it at https://developers.squarespace.com/commerce-apis/authentication-and-permissions"
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "Any data before this date will not be replicated."
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "squarespace"
const: "squarespace"
enum:
- "squarespace"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-squarespace-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it at https://developers.squarespace.com/commerce-apis/authentication-and-permissions"
name: "api_key"
order: 0
title: "API Key"
type: "string"
start_date:
description: "Any data before this date will not be replicated."
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-workramp:
properties:
academy_id:
description: "The id of the Academy"
order: 1
title: "Academy ID"
type: "string"
api_key:
airbyte_secret: true
description: "The API Token for Workramp"
order: 0
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "workramp"
const: "workramp"
enum:
- "workramp"
order: 0
type: "string"
required:
- "api_key"
- "academy_id"
- "sourceType"
type: "object"
source-workramp-update:
properties:
academy_id:
description: "The id of the Academy"
order: 1
title: "Academy ID"
type: "string"
api_key:
airbyte_secret: true
description: "The API Token for Workramp"
order: 0
title: "API Token"
type: "string"
required:
- "api_key"
- "academy_id"
type: "object"
source-iterable:
properties:
api_key:
airbyte_secret: true
description: "Iterable API Key. See the docs for more information on how to obtain this key."
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
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"
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
sourceType:
title: "iterable"
const: "iterable"
enum:
- "iterable"
order: 0
type: "string"
required:
- "start_date"
- "api_key"
- "sourceType"
title: "Iterable Spec"
type: "object"
source-iterable-update:
properties:
api_key:
airbyte_secret: true
description: "Iterable API Key. See the docs for more information on how to obtain this key."
order: 0
title: "API Key"
type: "string"
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"
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
required:
- "start_date"
- "api_key"
title: "Iterable Spec"
type: "object"
source-mysql:
properties:
check_privileges:
default: true
description: "When this feature is enabled, during schema discovery the\
\ connector will query each table or view individually to check access\
\ privileges and inaccessible tables, views, or columns therein will be\
\ removed. In large schemas, this might cause schema discovery to take\
\ too long, in which case it might be advisable to disable this feature."
order: 13
title: "Check Table and Column Access Privileges"
type: "boolean"
checkpoint_target_interval_seconds:
default: 300
description: "How often (in seconds) a stream should checkpoint, when possible."
order: 11
title: "Checkpoint Target Time Interval"
type: "integer"
database:
always_show: true
description: "The database name."
order: 6
title: "Database"
type: "string"
host:
description: "Hostname of the database."
order: 1
title: "Host"
type: "string"
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)."
order: 7
title: "JDBC URL Params"
type: "string"
max_db_connections:
description: "Maximum number of concurrent queries to the database. Leave\
\ empty to let Airbyte optimize performance."
order: 12
title: "Max Concurrent Queries to Database"
type: "integer"
password:
airbyte_secret: true
always_show: true
description: "The password associated with the username."
order: 5
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
port:
default: 3306
description: "Port of the database."
maximum: 65536
minimum: 0
order: 2
title: "Port"
type: "integer"
replication_method:
description: "Configures how data is extracted from the database."
display_type: "radio"
oneOf:
- additionalProperties: true
description: "Incrementally detects new inserts and updates using the\
\ cursor column chosen when configuring a connection (e.g. created_at,\
\ updated_at)."
properties:
method:
default: "STANDARD"
enum:
- "STANDARD"
type: "string"
required:
- "method"
title: "Scan Changes with User Defined Cursor"
type: "object"
- additionalProperties: true
description: "Recommended - Incrementally reads new inserts, updates,\
\ and deletes using MySQL's change data capture feature. This must be enabled on your database."
properties:
initial_load_timeout_hours:
always_show: true
default: 8
description: "The amount of time an initial load is allowed to continue\
\ for before catching up on CDC logs."
max: 24
min: 4
order: 3
title: "Initial Load Timeout in Hours (Advanced)"
type: "integer"
invalid_cdc_cursor_position_behavior:
always_show: true
default: "Fail sync"
description: "Determines whether Airbyte should fail or re-sync data\
\ in case of an stale/invalid cursor value in the mined logs. 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"
order: 2
title: "Invalid CDC Position Behavior (Advanced)"
type: "string"
method:
default: "CDC"
enum:
- "CDC"
type: "string"
server_timezone:
always_show: true
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: 1
title: "Configured server timezone for the MySQL source (Advanced)"
type: "string"
required:
- "method"
title: "Read Changes using Change Data Capture (CDC)"
type: "object"
order: 10
title: "Update Method"
type: "object"
ssl_mode:
default: "required"
description: "The encryption method which is used when communicating with\
\ the database."
oneOf:
- additionalProperties: true
description: "To allow unencrypted communication only when the source\
\ doesn't support encryption."
properties:
mode:
default: "preferred"
enum:
- "preferred"
type: "string"
required:
- "mode"
title: "preferred"
type: "object"
- additionalProperties: true
description: "To always require encryption. Note: The connection will\
\ fail if the source doesn't support encryption."
properties:
mode:
default: "required"
enum:
- "required"
type: "string"
required:
- "mode"
title: "required"
type: "object"
- additionalProperties: true
description: "To always require encryption and verify that the source\
\ has a valid SSL certificate."
properties:
ca_certificate:
airbyte_secret: true
description: "CA certificate"
multiline: true
title: "CA certificate"
type: "string"
x-speakeasy-param-sensitive: true
client_certificate:
airbyte_secret: true
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)"
multiline: true
title: "Client certificate File"
type: "string"
x-speakeasy-param-sensitive: true
client_key:
airbyte_secret: true
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)"
multiline: true
title: "Client Key"
type: "string"
x-speakeasy-param-sensitive: true
client_key_password:
airbyte_secret: true
description: "Password for keystorage. This field is optional. If\
\ you do not add it - the password will be generated automatically."
multiline: true
title: "Client key password"
type: "string"
x-speakeasy-param-sensitive: true
mode:
default: "verify_ca"
enum:
- "verify_ca"
type: "string"
required:
- "mode"
- "ca_certificate"
title: "verify_ca"
type: "object"
- additionalProperties: true
description: "To always require encryption and verify that the source\
\ has a valid SSL certificate."
properties:
ca_certificate:
airbyte_secret: true
description: "CA certificate"
multiline: true
title: "CA certificate"
type: "string"
x-speakeasy-param-sensitive: true
client_certificate:
airbyte_secret: true
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)"
multiline: true
title: "Client certificate File"
type: "string"
x-speakeasy-param-sensitive: true
client_key:
airbyte_secret: true
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)"
multiline: true
title: "Client Key"
type: "string"
x-speakeasy-param-sensitive: true
client_key_password:
airbyte_secret: true
description: "Password for keystorage. This field is optional. If\
\ you do not add it - the password will be generated automatically."
multiline: true
title: "Client key password"
type: "string"
x-speakeasy-param-sensitive: true
mode:
default: "verify_identity"
enum:
- "verify_identity"
type: "string"
required:
- "mode"
- "ca_certificate"
title: "verify_identity"
type: "object"
order: 8
title: "Encryption"
type: "object"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- additionalProperties: true
description: "No ssh tunnel needed to connect to database"
properties:
tunnel_method:
default: "NO_TUNNEL"
enum:
- "NO_TUNNEL"
type: "string"
required:
- "tunnel_method"
title: "No Tunnel"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
x-speakeasy-param-sensitive: true
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_KEY_AUTH"
enum:
- "SSH_KEY_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_PASSWORD_AUTH"
enum:
- "SSH_PASSWORD_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
type: "object"
order: 9
title: "SSH Tunnel Method"
type: "object"
username:
description: "The username which is used to access the database."
order: 4
title: "User"
type: "string"
sourceType:
title: "mysql"
const: "mysql"
enum:
- "mysql"
order: 0
type: "string"
required:
- "host"
- "port"
- "database"
- "username"
- "replication_method"
- "sourceType"
title: "MySQL Source Spec"
type: "object"
source-mysql-update:
properties:
check_privileges:
default: true
description: "When this feature is enabled, during schema discovery the\
\ connector will query each table or view individually to check access\
\ privileges and inaccessible tables, views, or columns therein will be\
\ removed. In large schemas, this might cause schema discovery to take\
\ too long, in which case it might be advisable to disable this feature."
order: 13
title: "Check Table and Column Access Privileges"
type: "boolean"
checkpoint_target_interval_seconds:
default: 300
description: "How often (in seconds) a stream should checkpoint, when possible."
order: 11
title: "Checkpoint Target Time Interval"
type: "integer"
database:
always_show: true
description: "The database name."
order: 6
title: "Database"
type: "string"
host:
description: "Hostname of the database."
order: 1
title: "Host"
type: "string"
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)."
order: 7
title: "JDBC URL Params"
type: "string"
max_db_connections:
description: "Maximum number of concurrent queries to the database. Leave\
\ empty to let Airbyte optimize performance."
order: 12
title: "Max Concurrent Queries to Database"
type: "integer"
password:
airbyte_secret: true
always_show: true
description: "The password associated with the username."
order: 5
title: "Password"
type: "string"
port:
default: 3306
description: "Port of the database."
maximum: 65536
minimum: 0
order: 2
title: "Port"
type: "integer"
replication_method:
description: "Configures how data is extracted from the database."
display_type: "radio"
oneOf:
- additionalProperties: true
description: "Incrementally detects new inserts and updates using the\
\ cursor column chosen when configuring a connection (e.g. created_at,\
\ updated_at)."
properties:
method:
default: "STANDARD"
enum:
- "STANDARD"
type: "string"
required:
- "method"
title: "Scan Changes with User Defined Cursor"
type: "object"
- additionalProperties: true
description: "Recommended - Incrementally reads new inserts, updates,\
\ and deletes using MySQL's change data capture feature. This must be enabled on your database."
properties:
initial_load_timeout_hours:
always_show: true
default: 8
description: "The amount of time an initial load is allowed to continue\
\ for before catching up on CDC logs."
max: 24
min: 4
order: 3
title: "Initial Load Timeout in Hours (Advanced)"
type: "integer"
invalid_cdc_cursor_position_behavior:
always_show: true
default: "Fail sync"
description: "Determines whether Airbyte should fail or re-sync data\
\ in case of an stale/invalid cursor value in the mined logs. 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"
order: 2
title: "Invalid CDC Position Behavior (Advanced)"
type: "string"
method:
default: "CDC"
enum:
- "CDC"
type: "string"
server_timezone:
always_show: true
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: 1
title: "Configured server timezone for the MySQL source (Advanced)"
type: "string"
required:
- "method"
title: "Read Changes using Change Data Capture (CDC)"
type: "object"
order: 10
title: "Update Method"
type: "object"
ssl_mode:
default: "required"
description: "The encryption method which is used when communicating with\
\ the database."
oneOf:
- additionalProperties: true
description: "To allow unencrypted communication only when the source\
\ doesn't support encryption."
properties:
mode:
default: "preferred"
enum:
- "preferred"
type: "string"
required:
- "mode"
title: "preferred"
type: "object"
- additionalProperties: true
description: "To always require encryption. Note: The connection will\
\ fail if the source doesn't support encryption."
properties:
mode:
default: "required"
enum:
- "required"
type: "string"
required:
- "mode"
title: "required"
type: "object"
- additionalProperties: true
description: "To always require encryption and verify that the source\
\ has a valid SSL certificate."
properties:
ca_certificate:
airbyte_secret: true
description: "CA certificate"
multiline: true
title: "CA certificate"
type: "string"
client_certificate:
airbyte_secret: true
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)"
multiline: true
title: "Client certificate File"
type: "string"
client_key:
airbyte_secret: true
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)"
multiline: true
title: "Client Key"
type: "string"
client_key_password:
airbyte_secret: true
description: "Password for keystorage. This field is optional. If\
\ you do not add it - the password will be generated automatically."
multiline: true
title: "Client key password"
type: "string"
mode:
default: "verify_ca"
enum:
- "verify_ca"
type: "string"
required:
- "mode"
- "ca_certificate"
title: "verify_ca"
type: "object"
- additionalProperties: true
description: "To always require encryption and verify that the source\
\ has a valid SSL certificate."
properties:
ca_certificate:
airbyte_secret: true
description: "CA certificate"
multiline: true
title: "CA certificate"
type: "string"
client_certificate:
airbyte_secret: true
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)"
multiline: true
title: "Client certificate File"
type: "string"
client_key:
airbyte_secret: true
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)"
multiline: true
title: "Client Key"
type: "string"
client_key_password:
airbyte_secret: true
description: "Password for keystorage. This field is optional. If\
\ you do not add it - the password will be generated automatically."
multiline: true
title: "Client key password"
type: "string"
mode:
default: "verify_identity"
enum:
- "verify_identity"
type: "string"
required:
- "mode"
- "ca_certificate"
title: "verify_identity"
type: "object"
order: 8
title: "Encryption"
type: "object"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- additionalProperties: true
description: "No ssh tunnel needed to connect to database"
properties:
tunnel_method:
default: "NO_TUNNEL"
enum:
- "NO_TUNNEL"
type: "string"
required:
- "tunnel_method"
title: "No Tunnel"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_KEY_AUTH"
enum:
- "SSH_KEY_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_PASSWORD_AUTH"
enum:
- "SSH_PASSWORD_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
type: "object"
order: 9
title: "SSH Tunnel Method"
type: "object"
username:
description: "The username which is used to access the database."
order: 4
title: "User"
type: "string"
required:
- "host"
- "port"
- "database"
- "username"
- "replication_method"
title: "MySQL Source Spec"
type: "object"
source-rollbar:
properties:
account_access_token:
airbyte_secret: true
order: 2
title: "Account Access Token"
type: "string"
x-speakeasy-param-sensitive: true
project_access_token:
airbyte_secret: true
name: "api_key"
order: 0
title: "Project Access Token"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "rollbar"
const: "rollbar"
enum:
- "rollbar"
order: 0
type: "string"
required:
- "project_access_token"
- "start_date"
- "account_access_token"
- "sourceType"
type: "object"
source-rollbar-update:
properties:
account_access_token:
airbyte_secret: true
order: 2
title: "Account Access Token"
type: "string"
project_access_token:
airbyte_secret: true
name: "api_key"
order: 0
title: "Project Access Token"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "project_access_token"
- "start_date"
- "account_access_token"
type: "object"
source-rootly:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "rootly"
const: "rootly"
enum:
- "rootly"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-rootly-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-vercel:
properties:
access_token:
airbyte_secret: true
description: "Access token to authenticate with the Vercel API. Create and\
\ manage tokens in your Vercel account settings."
name: "access_token"
order: 0
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "vercel"
const: "vercel"
enum:
- "vercel"
order: 0
type: "string"
required:
- "access_token"
- "start_date"
- "sourceType"
type: "object"
source-vercel-update:
properties:
access_token:
airbyte_secret: true
description: "Access token to authenticate with the Vercel API. Create and\
\ manage tokens in your Vercel account settings."
name: "access_token"
order: 0
title: "Access Token"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "access_token"
- "start_date"
type: "object"
source-apify-dataset:
properties:
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"
title: "Dataset ID"
type: "string"
token:
airbyte_secret: true
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"
title: "API token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "apify-dataset"
const: "apify-dataset"
enum:
- "apify-dataset"
order: 0
type: "string"
required:
- "token"
- "dataset_id"
- "sourceType"
title: "Apify Dataset Spec"
type: "object"
source-apify-dataset-update:
properties:
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"
title: "Dataset ID"
type: "string"
token:
airbyte_secret: true
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"
title: "API token"
type: "string"
required:
- "token"
- "dataset_id"
title: "Apify Dataset Spec"
type: "object"
source-confluence:
properties:
api_token:
airbyte_secret: true
description: "Please follow the Jira confluence for generating an API token:\
\ generating an API token."
order: 1
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
domain_name:
description: "Your Confluence domain name"
order: 2
title: "Domain name"
type: "string"
email:
description: "Your Confluence login email"
examples:
- "abc@example.com"
order: 0
title: "Email"
type: "string"
sourceType:
title: "confluence"
const: "confluence"
enum:
- "confluence"
order: 0
type: "string"
required:
- "email"
- "api_token"
- "domain_name"
- "sourceType"
type: "object"
source-confluence-update:
properties:
api_token:
airbyte_secret: true
description: "Please follow the Jira confluence for generating an API token:\
\ generating an API token."
order: 1
title: "API Token"
type: "string"
domain_name:
description: "Your Confluence domain name"
order: 2
title: "Domain name"
type: "string"
email:
description: "Your Confluence login email"
examples:
- "abc@example.com"
order: 0
title: "Email"
type: "string"
required:
- "email"
- "api_token"
- "domain_name"
type: "object"
source-zoho-expense:
properties:
client_id:
airbyte_secret: true
name: "client_id"
order: 1
title: "OAuth Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
name: "client_secret"
order: 2
title: "OAuth Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
data_center:
default: "com"
description: "The domain suffix for the Zoho Expense API based on your data\
\ center location (e.g., 'com', 'eu', 'in', etc.)"
enum:
- "com"
- "in"
- "jp"
- "ca"
- "com.cn"
- "sa"
- "com.au"
- "eu"
name: "domain"
order: 0
title: "Data Center"
type: "string"
refresh_token:
airbyte_secret: true
name: "refresh_token"
order: 3
title: "OAuth Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "zoho-expense"
const: "zoho-expense"
enum:
- "zoho-expense"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "sourceType"
type: "object"
source-zoho-expense-update:
properties:
client_id:
airbyte_secret: true
name: "client_id"
order: 1
title: "OAuth Client ID"
type: "string"
client_secret:
airbyte_secret: true
name: "client_secret"
order: 2
title: "OAuth Client Secret"
type: "string"
data_center:
default: "com"
description: "The domain suffix for the Zoho Expense API based on your data\
\ center location (e.g., 'com', 'eu', 'in', etc.)"
enum:
- "com"
- "in"
- "jp"
- "ca"
- "com.cn"
- "sa"
- "com.au"
- "eu"
name: "domain"
order: 0
title: "Data Center"
type: "string"
refresh_token:
airbyte_secret: true
name: "refresh_token"
order: 3
title: "OAuth Refresh Token"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
type: "object"
source-formbricks:
properties:
api_key:
airbyte_secret: true
description: "API key to use. You can generate and find it in your Postman\
\ account settings."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "formbricks"
const: "formbricks"
enum:
- "formbricks"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-formbricks-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. You can generate and find it in your Postman\
\ account settings."
name: "api_key"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-coin-api:
properties:
api_key:
airbyte_secret: true
description: "API Key"
order: 0
type: "string"
x-speakeasy-param-sensitive: true
end_date:
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"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$"
type: "string"
environment:
default: "sandbox"
description: "The environment to use. Either sandbox or production.\n"
enum:
- "sandbox"
- "production"
order: 1
type: "string"
limit:
default: 100
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"
maximum: 100000
minimum: 1
type: "integer"
period:
description: "The period to use. See the documentation for a list. https://docs.coinapi.io/#list-all-periods-get"
examples:
- "5SEC"
- "2MTH"
type: "string"
start_date:
description: "The start date in ISO 8601 format."
examples:
- "2019-01-01T00:00:00"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$"
type: "string"
symbol_id:
description: "The symbol ID to use. See the documentation for a list.\n\
https://docs.coinapi.io/#list-all-symbols-get\n"
order: 2
type: "string"
sourceType:
title: "coin-api"
const: "coin-api"
enum:
- "coin-api"
order: 0
type: "string"
required:
- "api_key"
- "environment"
- "symbol_id"
- "period"
- "start_date"
- "sourceType"
title: "Coin API Spec"
type: "object"
source-coin-api-update:
properties:
api_key:
airbyte_secret: true
description: "API Key"
order: 0
type: "string"
end_date:
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"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$"
type: "string"
environment:
default: "sandbox"
description: "The environment to use. Either sandbox or production.\n"
enum:
- "sandbox"
- "production"
order: 1
type: "string"
limit:
default: 100
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"
maximum: 100000
minimum: 1
type: "integer"
period:
description: "The period to use. See the documentation for a list. https://docs.coinapi.io/#list-all-periods-get"
examples:
- "5SEC"
- "2MTH"
type: "string"
start_date:
description: "The start date in ISO 8601 format."
examples:
- "2019-01-01T00:00:00"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$"
type: "string"
symbol_id:
description: "The symbol ID to use. See the documentation for a list.\n\
https://docs.coinapi.io/#list-all-symbols-get\n"
order: 2
type: "string"
required:
- "api_key"
- "environment"
- "symbol_id"
- "period"
- "start_date"
title: "Coin API Spec"
type: "object"
source-xsolla:
properties:
api_key:
airbyte_secret: true
description: "Go to Xsolla Dashboard and from company setting get the api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
project_id:
description: "You can find this parameter in your Publisher Account next\
\ to the name of the project . Example: 44056"
order: 1
title: "Project Id"
type: "number"
sourceType:
title: "xsolla"
const: "xsolla"
enum:
- "xsolla"
order: 0
type: "string"
required:
- "api_key"
- "project_id"
- "sourceType"
type: "object"
source-xsolla-update:
properties:
api_key:
airbyte_secret: true
description: "Go to Xsolla Dashboard and from company setting get the api_key"
order: 0
title: "API Key"
type: "string"
project_id:
description: "You can find this parameter in your Publisher Account next\
\ to the name of the project . Example: 44056"
order: 1
title: "Project Id"
type: "number"
required:
- "api_key"
- "project_id"
type: "object"
source-zoho-bigin:
properties:
client_id:
airbyte_secret: true
name: "client_id"
order: 0
title: "OAuth Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_refresh_token:
airbyte_secret: true
order: 3
title: "Refresh token"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
name: "client_secret"
order: 2
title: "OAuth Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
data_center:
default: "com"
description: "The data center where the Bigin account's resources are hosted"
enum:
- "com"
- "com.au"
- "eu"
- "in"
- "com.cn"
- "jp"
name: "data_center"
order: 1
title: "Data Center"
type: "string"
module_name:
order: 4
title: "Module Name"
type: "string"
sourceType:
title: "zoho-bigin"
const: "zoho-bigin"
enum:
- "zoho-bigin"
order: 0
type: "string"
required:
- "client_id"
- "data_center"
- "client_secret"
- "client_refresh_token"
- "module_name"
- "sourceType"
type: "object"
source-zoho-bigin-update:
properties:
client_id:
airbyte_secret: true
name: "client_id"
order: 0
title: "OAuth Client ID"
type: "string"
client_refresh_token:
airbyte_secret: true
order: 3
title: "Refresh token"
type: "string"
client_secret:
airbyte_secret: true
name: "client_secret"
order: 2
title: "OAuth Client Secret"
type: "string"
data_center:
default: "com"
description: "The data center where the Bigin account's resources are hosted"
enum:
- "com"
- "com.au"
- "eu"
- "in"
- "com.cn"
- "jp"
name: "data_center"
order: 1
title: "Data Center"
type: "string"
module_name:
order: 4
title: "Module Name"
type: "string"
required:
- "client_id"
- "data_center"
- "client_secret"
- "client_refresh_token"
- "module_name"
type: "object"
source-harness:
properties:
account_id:
description: "Harness Account ID"
order: 2
title: "Account ID"
type: "string"
api_key:
airbyte_secret: true
order: 0
title: "API key"
type: "string"
x-speakeasy-param-sensitive: true
api_url:
default: "https://app.harness.io"
description: "The API URL for fetching data from Harness"
examples:
- "https://my-harness-server.example.com"
order: 1
title: "API URL"
type: "string"
sourceType:
title: "harness"
const: "harness"
enum:
- "harness"
order: 0
type: "string"
required:
- "api_key"
- "account_id"
- "sourceType"
type: "object"
source-harness-update:
properties:
account_id:
description: "Harness Account ID"
order: 2
title: "Account ID"
type: "string"
api_key:
airbyte_secret: true
order: 0
title: "API key"
type: "string"
api_url:
default: "https://app.harness.io"
description: "The API URL for fetching data from Harness"
examples:
- "https://my-harness-server.example.com"
order: 1
title: "API URL"
type: "string"
required:
- "api_key"
- "account_id"
type: "object"
source-insightful:
properties:
api_token:
airbyte_secret: true
description: "Your API token for accessing the Insightful API. Generate\
\ it by logging in as an Admin to your organization's account, navigating\
\ to the API page, and creating a new token. Note that this token will\
\ only be shown once, so store it securely."
name: "api_token"
order: 0
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "insightful"
const: "insightful"
enum:
- "insightful"
order: 0
type: "string"
required:
- "api_token"
- "start_date"
- "sourceType"
type: "object"
source-insightful-update:
properties:
api_token:
airbyte_secret: true
description: "Your API token for accessing the Insightful API. Generate\
\ it by logging in as an Admin to your organization's account, navigating\
\ to the API page, and creating a new token. Note that this token will\
\ only be shown once, so store it securely."
name: "api_token"
order: 0
title: "API Token"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_token"
- "start_date"
type: "object"
source-slack:
properties:
channel_filter:
default: []
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"
items:
minLength: 0
type: "string"
title: "Channel name filter"
type: "array"
channel_messages_window_size:
default: 100
description: "The size (in days) of the date window that will be used while\
\ syncing data from the channel messages stream. A smaller window will\
\ allow for greater parallelization when syncing records, but can lead\
\ to rate limiting errors."
examples:
- 30
- 10
- 5
maximum: 100
minimum: 1
order: 8
title: "Channel messages date window size (in days)"
type: "integer"
credentials:
description: "Choose how to authenticate into Slack"
oneOf:
- order: 0
properties:
access_token:
airbyte_secret: true
description: "Slack access_token. See our docs if you need help generating the token."
title: "Access token"
type: "string"
x-speakeasy-param-sensitive: true
client_id:
description: "Slack client_id. See our docs if you need help finding this id."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Slack client_secret. See our docs if you need help finding this secret."
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
option_title:
const: "Default OAuth2.0 authorization"
type: "string"
enum:
- "Default OAuth2.0 authorization"
required:
- "option_title"
- "client_id"
- "client_secret"
- "access_token"
title: "Sign in via Slack (OAuth)"
type: "object"
- order: 1
properties:
api_token:
airbyte_secret: true
description: "A Slack bot token. See the docs for instructions on how to generate it."
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
option_title:
const: "API Token Credentials"
type: "string"
enum:
- "API Token Credentials"
required:
- "option_title"
- "api_token"
title: "API Token"
type: "object"
title: "Authentication mechanism"
type: "object"
include_private_channels:
default: false
description: "Whether to read information from private channels that the\
\ bot is already in. If false, only public channels will be read. If\
\ true, the bot must be manually added to private channels."
title: "Include private channels"
type: "boolean"
join_channels:
default: true
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."
title: "Join all channels"
type: "boolean"
lookback_window:
default: 0
description: "How far into the past to look for messages in threads, default\
\ is 0 days"
examples:
- 7
- 14
maximum: 365
minimum: 0
title: "Threads Lookback window (Days)"
type: "integer"
num_workers:
default: 2
description: "The number of worker threads to use for the sync."
examples:
- 2
- 3
maximum: 10
minimum: 2
order: 7
title: "Number of concurrent threads"
type: "integer"
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:
- "2017-01-25T00: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$"
title: "Start Date"
type: "string"
sourceType:
title: "slack"
const: "slack"
enum:
- "slack"
order: 0
type: "string"
required:
- "start_date"
- "lookback_window"
- "join_channels"
- "sourceType"
title: "Slack Spec"
type: "object"
source-slack-update:
properties:
channel_filter:
default: []
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"
items:
minLength: 0
type: "string"
title: "Channel name filter"
type: "array"
channel_messages_window_size:
default: 100
description: "The size (in days) of the date window that will be used while\
\ syncing data from the channel messages stream. A smaller window will\
\ allow for greater parallelization when syncing records, but can lead\
\ to rate limiting errors."
examples:
- 30
- 10
- 5
maximum: 100
minimum: 1
order: 8
title: "Channel messages date window size (in days)"
type: "integer"
credentials:
description: "Choose how to authenticate into Slack"
oneOf:
- order: 0
properties:
access_token:
airbyte_secret: true
description: "Slack access_token. See our docs if you need help generating the token."
title: "Access token"
type: "string"
client_id:
description: "Slack client_id. See our docs if you need help finding this id."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Slack client_secret. See our docs if you need help finding this secret."
title: "Client Secret"
type: "string"
option_title:
const: "Default OAuth2.0 authorization"
type: "string"
enum:
- "Default OAuth2.0 authorization"
required:
- "option_title"
- "client_id"
- "client_secret"
- "access_token"
title: "Sign in via Slack (OAuth)"
type: "object"
- order: 1
properties:
api_token:
airbyte_secret: true
description: "A Slack bot token. See the docs for instructions on how to generate it."
title: "API Token"
type: "string"
option_title:
const: "API Token Credentials"
type: "string"
enum:
- "API Token Credentials"
required:
- "option_title"
- "api_token"
title: "API Token"
type: "object"
title: "Authentication mechanism"
type: "object"
include_private_channels:
default: false
description: "Whether to read information from private channels that the\
\ bot is already in. If false, only public channels will be read. If\
\ true, the bot must be manually added to private channels."
title: "Include private channels"
type: "boolean"
join_channels:
default: true
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."
title: "Join all channels"
type: "boolean"
lookback_window:
default: 0
description: "How far into the past to look for messages in threads, default\
\ is 0 days"
examples:
- 7
- 14
maximum: 365
minimum: 0
title: "Threads Lookback window (Days)"
type: "integer"
num_workers:
default: 2
description: "The number of worker threads to use for the sync."
examples:
- 2
- 3
maximum: 10
minimum: 2
order: 7
title: "Number of concurrent threads"
type: "integer"
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:
- "2017-01-25T00: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$"
title: "Start Date"
type: "string"
required:
- "start_date"
- "lookback_window"
- "join_channels"
title: "Slack Spec"
type: "object"
source-tremendous:
properties:
api_key:
airbyte_secret: true
description: "API key to use. You can generate an API key through the Tremendous\
\ dashboard under Team Settings > Developers. Save the key once you’ve\
\ generated it."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
environment:
enum:
- "api"
- "testflight"
order: 1
title: "Environment"
type: "string"
sourceType:
title: "tremendous"
const: "tremendous"
enum:
- "tremendous"
order: 0
type: "string"
required:
- "api_key"
- "environment"
- "sourceType"
type: "object"
source-tremendous-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. You can generate an API key through the Tremendous\
\ dashboard under Team Settings > Developers. Save the key once you’ve\
\ generated it."
name: "api_key"
order: 0
title: "API Key"
type: "string"
environment:
enum:
- "api"
- "testflight"
order: 1
title: "Environment"
type: "string"
required:
- "api_key"
- "environment"
type: "object"
source-gainsight-px:
properties:
api_key:
airbyte_secret: true
description: "The Aptrinsic API Key which is recieved from the dashboard\
\ settings (ref - https://app.aptrinsic.com/settings/api-keys)"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "gainsight-px"
const: "gainsight-px"
enum:
- "gainsight-px"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-gainsight-px-update:
properties:
api_key:
airbyte_secret: true
description: "The Aptrinsic API Key which is recieved from the dashboard\
\ settings (ref - https://app.aptrinsic.com/settings/api-keys)"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-humanitix:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "humanitix"
const: "humanitix"
enum:
- "humanitix"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-humanitix-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-shutterstock:
properties:
api_token:
airbyte_secret: true
description: "Your OAuth 2.0 token for accessing the Shutterstock API. Obtain\
\ this token from your Shutterstock developer account."
name: "api_token"
order: 0
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
query_for_audio_search:
default: "mountain"
description: "The query for image search"
order: 4
title: "Query for audio search"
type: "string"
query_for_catalog_search:
default: "mountain"
description: "The query for catalog search"
order: 5
title: "Query for catalog search"
type: "string"
query_for_image_search:
default: "mountain"
description: "The query for image search"
order: 2
title: "Query for image search"
type: "string"
query_for_video_search:
default: "mountain"
description: "The Query for `videos_search` stream"
order: 3
title: "Query for video search"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "shutterstock"
const: "shutterstock"
enum:
- "shutterstock"
order: 0
type: "string"
required:
- "api_token"
- "start_date"
- "query_for_image_search"
- "query_for_video_search"
- "query_for_audio_search"
- "query_for_catalog_search"
- "sourceType"
type: "object"
source-shutterstock-update:
properties:
api_token:
airbyte_secret: true
description: "Your OAuth 2.0 token for accessing the Shutterstock API. Obtain\
\ this token from your Shutterstock developer account."
name: "api_token"
order: 0
title: "API Token"
type: "string"
query_for_audio_search:
default: "mountain"
description: "The query for image search"
order: 4
title: "Query for audio search"
type: "string"
query_for_catalog_search:
default: "mountain"
description: "The query for catalog search"
order: 5
title: "Query for catalog search"
type: "string"
query_for_image_search:
default: "mountain"
description: "The query for image search"
order: 2
title: "Query for image search"
type: "string"
query_for_video_search:
default: "mountain"
description: "The Query for `videos_search` stream"
order: 3
title: "Query for video search"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_token"
- "start_date"
- "query_for_image_search"
- "query_for_video_search"
- "query_for_audio_search"
- "query_for_catalog_search"
type: "object"
source-gologin:
properties:
api_key:
airbyte_secret: true
description: "API Key found at `https://app.gologin.com/personalArea/TokenApi`"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "gologin"
const: "gologin"
enum:
- "gologin"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-gologin-update:
properties:
api_key:
airbyte_secret: true
description: "API Key found at `https://app.gologin.com/personalArea/TokenApi`"
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-plaid:
properties:
access_token:
airbyte_secret: true
description: "The end-user's Link access token."
order: 0
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
api_key:
airbyte_secret: true
description: "The Plaid API key to use to hit the API."
order: 1
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
client_id:
description: "The Plaid client id."
order: 2
title: "Client ID"
type: "string"
plaid_env:
description: "The Plaid environment."
enum:
- "sandbox"
- "development"
- "production"
order: 3
title: "Plaid Environment"
type: "string"
start_date:
description: "The date from which you'd like to replicate data for Plaid\
\ in the format YYYY-MM-DD. All data generated after this date will be\
\ replicated."
format: "date"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
sourceType:
title: "plaid"
const: "plaid"
enum:
- "plaid"
order: 0
type: "string"
required:
- "access_token"
- "api_key"
- "client_id"
- "plaid_env"
- "sourceType"
type: "object"
source-plaid-update:
properties:
access_token:
airbyte_secret: true
description: "The end-user's Link access token."
order: 0
title: "Access Token"
type: "string"
api_key:
airbyte_secret: true
description: "The Plaid API key to use to hit the API."
order: 1
title: "API Key"
type: "string"
client_id:
description: "The Plaid client id."
order: 2
title: "Client ID"
type: "string"
plaid_env:
description: "The Plaid environment."
enum:
- "sandbox"
- "development"
- "production"
order: 3
title: "Plaid Environment"
type: "string"
start_date:
description: "The date from which you'd like to replicate data for Plaid\
\ in the format YYYY-MM-DD. All data generated after this date will be\
\ replicated."
format: "date"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
required:
- "access_token"
- "api_key"
- "client_id"
- "plaid_env"
type: "object"
source-google-sheets:
properties:
allow_leading_numbers:
default: false
description: "Allows column names to start with numbers. Example: \"50th\
\ Percentile\" → \"50_th_percentile\" This option will only work if \"\
Convert Column Names to SQL-Compliant Format (names_conversion)\" is enabled."
order: 7
title: "Allow Leading Numbers"
type: "boolean"
batch_size:
default: 1000000
description: "Default value is 1000000. An integer representing row batch\
\ size for each sent request to Google Sheets API. Row batch size means\
\ how many rows are processed from the google sheet, for example default\
\ value 1000000 would process rows 2-1000002, then 1000003-2000003 and\
\ so on. Based on Google\
\ Sheets API limits documentation, it is possible to send up to 300\
\ requests per minute, but each individual request has to be processed\
\ under 180 seconds, otherwise the request returns a timeout error. In\
\ regards to this information, consider network speed and number of columns\
\ of the google sheet when deciding a batch_size value."
order: 1
title: "Row Batch Size"
type: "integer"
combine_letter_number_pairs:
default: false
description: "Combines adjacent letters and numbers. Example: \"Q3 2023\"\
\ → \"q3_2023\" This option will only work if \"Convert Column Names to\
\ SQL-Compliant Format (names_conversion)\" is enabled."
order: 6
title: "Combine Letter-Number Pairs"
type: "boolean"
combine_number_word_pairs:
default: false
description: "Combines adjacent numbers and words. Example: \"50th Percentile?\"\
\ → \"_50th_percentile_\" This option will only work if \"Convert Column\
\ Names to SQL-Compliant Format (names_conversion)\" is enabled."
order: 4
title: "Combine Number-Word Pairs"
type: "boolean"
credentials:
description: "Credentials for connecting to the Google Sheets API"
oneOf:
- properties:
auth_type:
const: "Client"
type: "string"
enum:
- "Client"
client_id:
airbyte_secret: true
description: "Enter your Google application's Client ID. See Google's\
\ documentation for more information."
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "Enter your Google application's Client Secret. See Google's\
\ documentation for more information."
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "Enter your Google application's refresh token. See Google's\
\ documentation for more information."
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_type"
- "client_id"
- "client_secret"
- "refresh_token"
title: "Authenticate via Google (OAuth)"
type: "object"
- properties:
auth_type:
const: "Service"
type: "string"
enum:
- "Service"
service_account_info:
airbyte_secret: true
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, ... }"
title: "Service Account Information."
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_type"
- "service_account_info"
title: "Service Account Key Authentication"
type: "object"
title: "Authentication"
type: "object"
names_conversion:
default: false
description: "Converts column names to a SQL-compliant format (snake_case,\
\ lowercase, etc). If enabled, you can further customize the sanitization\
\ using the options below."
order: 2
title: "Convert Column Names to SQL-Compliant Format"
type: "boolean"
remove_leading_trailing_underscores:
default: false
description: "Removes leading and trailing underscores from column names.\
\ Does not remove leading underscores from column names that start with\
\ a number. Example: \"50th Percentile? \"→ \"_50_th_percentile\" This\
\ option will only work if \"Convert Column Names to SQL-Compliant Format\
\ (names_conversion)\" is enabled."
order: 3
title: "Remove Leading and Trailing Underscores"
type: "boolean"
remove_special_characters:
default: false
description: "Removes all special characters from column names. Example:\
\ \"Example ID*\" → \"example_id\" This option will only work if \"Convert\
\ Column Names to SQL-Compliant Format (names_conversion)\" is enabled."
order: 5
title: "Remove All Special Characters"
type: "boolean"
spreadsheet_id:
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"
order: 0
title: "Spreadsheet Link"
type: "string"
stream_name_overrides:
description: "**Overridden streams will default to Sync Mode: Full Refresh\
\ (Append), which does not support primary keys. If you want to use primary\
\ keys and deduplication, update the sync mode to \"Full Refresh | Overwrite\
\ + Deduped\" in your connection settings.**\nAllows you to rename streams\
\ (Google Sheet tab names) as they appear in Airbyte. \nEach item should\
\ be an object with a `source_stream_name` (the exact name of the sheet/tab\
\ in your spreadsheet) and a `custom_stream_name` (the name you want\
\ it to appear as in Airbyte and the destination).\nIf a `source_stream_name`\
\ is not found in your spreadsheet, it will be ignored and the default\
\ name will be used. This feature only affects stream (sheet/tab) names,\
\ not field/column names.\nIf you want to rename fields or column names,\
\ you can do so using the Airbyte Mappings feature after your connection\
\ is created. See the Airbyte documentation for more details on how to\
\ use Mappings.\nExamples:\n - To rename a sheet called \"Sheet1\" to\
\ \"sales_data\", and \"2024 Q1\" to \"q1_2024\":\n [\n { \"source_stream_name\"\
: \"Sheet1\", \"custom_stream_name\": \"sales_data\" },\n { \"source_stream_name\"\
: \"2024 Q1\", \"custom_stream_name\": \"q1_2024\" }\n ]\n - If you\
\ do not wish to rename any streams, leave this blank."
items:
order: 8
properties:
custom_stream_name:
description: "The name you want this stream to appear as in Airbyte\
\ and your destination."
order: 1
title: "Custom Stream Name"
type: "string"
source_stream_name:
description: "The exact name of the sheet/tab in your Google Spreadsheet."
order: 0
title: "Source Stream Name"
type: "string"
required:
- "source_stream_name"
- "custom_stream_name"
type: "object"
title: "Stream Name Overrides"
type: "array"
sourceType:
title: "google-sheets"
const: "google-sheets"
enum:
- "google-sheets"
order: 0
type: "string"
required:
- "spreadsheet_id"
- "credentials"
- "sourceType"
title: "Google Sheets Source Spec"
type: "object"
source-google-sheets-update:
properties:
allow_leading_numbers:
default: false
description: "Allows column names to start with numbers. Example: \"50th\
\ Percentile\" → \"50_th_percentile\" This option will only work if \"\
Convert Column Names to SQL-Compliant Format (names_conversion)\" is enabled."
order: 7
title: "Allow Leading Numbers"
type: "boolean"
batch_size:
default: 1000000
description: "Default value is 1000000. An integer representing row batch\
\ size for each sent request to Google Sheets API. Row batch size means\
\ how many rows are processed from the google sheet, for example default\
\ value 1000000 would process rows 2-1000002, then 1000003-2000003 and\
\ so on. Based on Google\
\ Sheets API limits documentation, it is possible to send up to 300\
\ requests per minute, but each individual request has to be processed\
\ under 180 seconds, otherwise the request returns a timeout error. In\
\ regards to this information, consider network speed and number of columns\
\ of the google sheet when deciding a batch_size value."
order: 1
title: "Row Batch Size"
type: "integer"
combine_letter_number_pairs:
default: false
description: "Combines adjacent letters and numbers. Example: \"Q3 2023\"\
\ → \"q3_2023\" This option will only work if \"Convert Column Names to\
\ SQL-Compliant Format (names_conversion)\" is enabled."
order: 6
title: "Combine Letter-Number Pairs"
type: "boolean"
combine_number_word_pairs:
default: false
description: "Combines adjacent numbers and words. Example: \"50th Percentile?\"\
\ → \"_50th_percentile_\" This option will only work if \"Convert Column\
\ Names to SQL-Compliant Format (names_conversion)\" is enabled."
order: 4
title: "Combine Number-Word Pairs"
type: "boolean"
credentials:
description: "Credentials for connecting to the Google Sheets API"
oneOf:
- properties:
auth_type:
const: "Client"
type: "string"
enum:
- "Client"
client_id:
airbyte_secret: true
description: "Enter your Google application's Client ID. See Google's\
\ documentation for more information."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Enter your Google application's Client Secret. See Google's\
\ documentation for more information."
title: "Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "Enter your Google application's refresh token. See Google's\
\ documentation for more information."
title: "Refresh Token"
type: "string"
required:
- "auth_type"
- "client_id"
- "client_secret"
- "refresh_token"
title: "Authenticate via Google (OAuth)"
type: "object"
- properties:
auth_type:
const: "Service"
type: "string"
enum:
- "Service"
service_account_info:
airbyte_secret: true
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, ... }"
title: "Service Account Information."
type: "string"
required:
- "auth_type"
- "service_account_info"
title: "Service Account Key Authentication"
type: "object"
title: "Authentication"
type: "object"
names_conversion:
default: false
description: "Converts column names to a SQL-compliant format (snake_case,\
\ lowercase, etc). If enabled, you can further customize the sanitization\
\ using the options below."
order: 2
title: "Convert Column Names to SQL-Compliant Format"
type: "boolean"
remove_leading_trailing_underscores:
default: false
description: "Removes leading and trailing underscores from column names.\
\ Does not remove leading underscores from column names that start with\
\ a number. Example: \"50th Percentile? \"→ \"_50_th_percentile\" This\
\ option will only work if \"Convert Column Names to SQL-Compliant Format\
\ (names_conversion)\" is enabled."
order: 3
title: "Remove Leading and Trailing Underscores"
type: "boolean"
remove_special_characters:
default: false
description: "Removes all special characters from column names. Example:\
\ \"Example ID*\" → \"example_id\" This option will only work if \"Convert\
\ Column Names to SQL-Compliant Format (names_conversion)\" is enabled."
order: 5
title: "Remove All Special Characters"
type: "boolean"
spreadsheet_id:
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"
order: 0
title: "Spreadsheet Link"
type: "string"
stream_name_overrides:
description: "**Overridden streams will default to Sync Mode: Full Refresh\
\ (Append), which does not support primary keys. If you want to use primary\
\ keys and deduplication, update the sync mode to \"Full Refresh | Overwrite\
\ + Deduped\" in your connection settings.**\nAllows you to rename streams\
\ (Google Sheet tab names) as they appear in Airbyte. \nEach item should\
\ be an object with a `source_stream_name` (the exact name of the sheet/tab\
\ in your spreadsheet) and a `custom_stream_name` (the name you want\
\ it to appear as in Airbyte and the destination).\nIf a `source_stream_name`\
\ is not found in your spreadsheet, it will be ignored and the default\
\ name will be used. This feature only affects stream (sheet/tab) names,\
\ not field/column names.\nIf you want to rename fields or column names,\
\ you can do so using the Airbyte Mappings feature after your connection\
\ is created. See the Airbyte documentation for more details on how to\
\ use Mappings.\nExamples:\n - To rename a sheet called \"Sheet1\" to\
\ \"sales_data\", and \"2024 Q1\" to \"q1_2024\":\n [\n { \"source_stream_name\"\
: \"Sheet1\", \"custom_stream_name\": \"sales_data\" },\n { \"source_stream_name\"\
: \"2024 Q1\", \"custom_stream_name\": \"q1_2024\" }\n ]\n - If you\
\ do not wish to rename any streams, leave this blank."
items:
order: 8
properties:
custom_stream_name:
description: "The name you want this stream to appear as in Airbyte\
\ and your destination."
order: 1
title: "Custom Stream Name"
type: "string"
source_stream_name:
description: "The exact name of the sheet/tab in your Google Spreadsheet."
order: 0
title: "Source Stream Name"
type: "string"
required:
- "source_stream_name"
- "custom_stream_name"
type: "object"
title: "Stream Name Overrides"
type: "array"
required:
- "spreadsheet_id"
- "credentials"
title: "Google Sheets Source Spec"
type: "object"
source-freshdesk:
properties:
api_key:
airbyte_secret: true
description: "Freshdesk API Key. See the docs for more information on how to obtain this key."
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
domain:
description: "Freshdesk domain"
examples:
- "myaccount.freshdesk.com"
order: 1
pattern: "^[a-zA-Z0-9._-]*\\.freshdesk\\.com$"
title: "Domain"
type: "string"
lookback_window_in_days:
default: 14
description: "Number of days for lookback window for the stream Satisfaction\
\ Ratings"
order: 4
title: "Lookback Window"
type: "integer"
rate_limit_plan:
description: "Rate Limit Plan for API Budget"
oneOf:
- properties:
contacts_rate_limit:
const: 50
description: "Maximum Rate in Limit/minute for contacts list endpoint\
\ in Free Plan"
title: "Contacts Rate"
type: "integer"
enum:
- null
general_rate_limit:
const: 50
description: "General Maximum Rate in Limit/minute for other endpoints\
\ in Free Plan"
title: "General Rate"
type: "integer"
enum:
- null
plan_type:
const: "free"
title: "Plan"
type: "string"
enum:
- "free"
tickets_rate_limit:
const: 50
description: "Maximum Rate in Limit/minute for tickets list endpoint\
\ in Free Plan"
title: "Tickets Rate"
type: "integer"
enum:
- null
title: "Free Plan"
type: "object"
- properties:
contacts_rate_limit:
const: 20
description: "Maximum Rate in Limit/minute for contacts list endpoint\
\ in Growth Plan"
title: "Contacts Rate"
type: "integer"
enum:
- null
general_rate_limit:
const: 200
description: "General Maximum Rate in Limit/minute for other endpoints\
\ in Growth Plan"
title: "General Rate"
type: "integer"
enum:
- null
plan_type:
const: "growth"
title: "Plan"
type: "string"
enum:
- "growth"
tickets_rate_limit:
const: 20
description: "Maximum Rate in Limit/minute for tickets list endpoint\
\ in Growth Plan"
title: "Tickets Rate"
type: "integer"
enum:
- null
title: "Growth Plan"
type: "object"
- properties:
contacts_rate_limit:
const: 100
description: "Maximum Rate in Limit/minute for contacts list endpoint\
\ in Pro Plan"
title: "Contacts Rate"
type: "integer"
enum:
- null
general_rate_limit:
const: 400
description: "General Maximum Rate in Limit/minute for other endpoints\
\ in Pro Plan"
title: "General Rate"
type: "integer"
enum:
- null
plan_type:
const: "pro"
title: "Plan"
type: "string"
enum:
- "pro"
tickets_rate_limit:
const: 100
description: "Maximum Rate in Limit/minute for tickets list endpoint\
\ in Pro Plan"
title: "Tickets Rate"
type: "integer"
enum:
- null
title: "Pro Plan"
type: "object"
- properties:
contacts_rate_limit:
const: 200
description: "Maximum Rate in Limit/minute for contacts list endpoint\
\ in Enterprise Plan"
title: "Contacts Rate"
type: "integer"
enum:
- null
general_rate_limit:
const: 700
description: "General Maximum Rate in Limit/minute for other endpoints\
\ in Enterprise Plan"
title: "General Rate"
type: "integer"
enum:
- null
plan_type:
const: "enterprise"
title: "Plan"
type: "string"
enum:
- "enterprise"
tickets_rate_limit:
const: 200
description: "Maximum Rate in Limit/minute for tickets list endpoint\
\ in Enterprise Plan"
title: "Tickets Rate"
type: "integer"
enum:
- null
title: "Enterprise Plan"
type: "object"
- properties:
contacts_rate_limit:
description: "Maximum Rate in Limit/minute for contacts list endpoint\
\ in Custom Plan"
title: "Contacts Rate"
type: "integer"
general_rate_limit:
description: "General Maximum Rate in Limit/minute for other endpoints\
\ in Custom Plan"
title: "General Rate"
type: "integer"
plan_type:
const: "custom"
title: "Plan"
type: "string"
enum:
- "custom"
tickets_rate_limit:
description: "Maximum Rate in Limit/minute for tickets list endpoint\
\ in Custom Plan"
title: "Tickets Rate"
type: "integer"
title: "Custom Plan"
type: "object"
title: "Rate Limit Plan"
type: "object"
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."
order: 2
title: "Requests per minute"
type: "integer"
start_date:
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."
examples:
- "2020-12-01T00:00:00Z"
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
sourceType:
title: "freshdesk"
const: "freshdesk"
enum:
- "freshdesk"
order: 0
type: "string"
required:
- "api_key"
- "domain"
- "sourceType"
type: "object"
source-freshdesk-update:
properties:
api_key:
airbyte_secret: true
description: "Freshdesk API Key. See the docs for more information on how to obtain this key."
order: 0
title: "API Key"
type: "string"
domain:
description: "Freshdesk domain"
examples:
- "myaccount.freshdesk.com"
order: 1
pattern: "^[a-zA-Z0-9._-]*\\.freshdesk\\.com$"
title: "Domain"
type: "string"
lookback_window_in_days:
default: 14
description: "Number of days for lookback window for the stream Satisfaction\
\ Ratings"
order: 4
title: "Lookback Window"
type: "integer"
rate_limit_plan:
description: "Rate Limit Plan for API Budget"
oneOf:
- properties:
contacts_rate_limit:
const: 50
description: "Maximum Rate in Limit/minute for contacts list endpoint\
\ in Free Plan"
title: "Contacts Rate"
type: "integer"
enum:
- null
general_rate_limit:
const: 50
description: "General Maximum Rate in Limit/minute for other endpoints\
\ in Free Plan"
title: "General Rate"
type: "integer"
enum:
- null
plan_type:
const: "free"
title: "Plan"
type: "string"
enum:
- "free"
tickets_rate_limit:
const: 50
description: "Maximum Rate in Limit/minute for tickets list endpoint\
\ in Free Plan"
title: "Tickets Rate"
type: "integer"
enum:
- null
title: "Free Plan"
type: "object"
- properties:
contacts_rate_limit:
const: 20
description: "Maximum Rate in Limit/minute for contacts list endpoint\
\ in Growth Plan"
title: "Contacts Rate"
type: "integer"
enum:
- null
general_rate_limit:
const: 200
description: "General Maximum Rate in Limit/minute for other endpoints\
\ in Growth Plan"
title: "General Rate"
type: "integer"
enum:
- null
plan_type:
const: "growth"
title: "Plan"
type: "string"
enum:
- "growth"
tickets_rate_limit:
const: 20
description: "Maximum Rate in Limit/minute for tickets list endpoint\
\ in Growth Plan"
title: "Tickets Rate"
type: "integer"
enum:
- null
title: "Growth Plan"
type: "object"
- properties:
contacts_rate_limit:
const: 100
description: "Maximum Rate in Limit/minute for contacts list endpoint\
\ in Pro Plan"
title: "Contacts Rate"
type: "integer"
enum:
- null
general_rate_limit:
const: 400
description: "General Maximum Rate in Limit/minute for other endpoints\
\ in Pro Plan"
title: "General Rate"
type: "integer"
enum:
- null
plan_type:
const: "pro"
title: "Plan"
type: "string"
enum:
- "pro"
tickets_rate_limit:
const: 100
description: "Maximum Rate in Limit/minute for tickets list endpoint\
\ in Pro Plan"
title: "Tickets Rate"
type: "integer"
enum:
- null
title: "Pro Plan"
type: "object"
- properties:
contacts_rate_limit:
const: 200
description: "Maximum Rate in Limit/minute for contacts list endpoint\
\ in Enterprise Plan"
title: "Contacts Rate"
type: "integer"
enum:
- null
general_rate_limit:
const: 700
description: "General Maximum Rate in Limit/minute for other endpoints\
\ in Enterprise Plan"
title: "General Rate"
type: "integer"
enum:
- null
plan_type:
const: "enterprise"
title: "Plan"
type: "string"
enum:
- "enterprise"
tickets_rate_limit:
const: 200
description: "Maximum Rate in Limit/minute for tickets list endpoint\
\ in Enterprise Plan"
title: "Tickets Rate"
type: "integer"
enum:
- null
title: "Enterprise Plan"
type: "object"
- properties:
contacts_rate_limit:
description: "Maximum Rate in Limit/minute for contacts list endpoint\
\ in Custom Plan"
title: "Contacts Rate"
type: "integer"
general_rate_limit:
description: "General Maximum Rate in Limit/minute for other endpoints\
\ in Custom Plan"
title: "General Rate"
type: "integer"
plan_type:
const: "custom"
title: "Plan"
type: "string"
enum:
- "custom"
tickets_rate_limit:
description: "Maximum Rate in Limit/minute for tickets list endpoint\
\ in Custom Plan"
title: "Tickets Rate"
type: "integer"
title: "Custom Plan"
type: "object"
title: "Rate Limit Plan"
type: "object"
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."
order: 2
title: "Requests per minute"
type: "integer"
start_date:
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."
examples:
- "2020-12-01T00:00:00Z"
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
required:
- "api_key"
- "domain"
type: "object"
source-vitally:
properties:
basic_auth_header:
airbyte_secret: true
always_show: true
description: "Basic Auth Header"
order: 3
title: "Basic Auth Header"
type: "string"
x-speakeasy-param-sensitive: true
domain:
description: "Provide only the subdomain part, like https://{your-custom-subdomain}.rest.vitally.io/.\
\ Keep empty if you don't have a subdomain."
order: 0
title: "Custom Subdomain"
type: "string"
secret_token:
description: "sk_live_secret_token"
order: 2
title: "Secret Token"
type: "string"
status:
description: "Status of the Vitally accounts. One of the following values;\
\ active, churned, activeOrChurned."
enum:
- "active"
- "churned"
- "activeOrChurned"
order: 1
title: "Status"
type: "string"
sourceType:
title: "vitally"
const: "vitally"
enum:
- "vitally"
order: 0
type: "string"
required:
- "domain"
- "status"
- "secret_token"
- "sourceType"
type: "object"
source-vitally-update:
properties:
basic_auth_header:
airbyte_secret: true
always_show: true
description: "Basic Auth Header"
order: 3
title: "Basic Auth Header"
type: "string"
domain:
description: "Provide only the subdomain part, like https://{your-custom-subdomain}.rest.vitally.io/.\
\ Keep empty if you don't have a subdomain."
order: 0
title: "Custom Subdomain"
type: "string"
secret_token:
description: "sk_live_secret_token"
order: 2
title: "Secret Token"
type: "string"
status:
description: "Status of the Vitally accounts. One of the following values;\
\ active, churned, activeOrChurned."
enum:
- "active"
- "churned"
- "activeOrChurned"
order: 1
title: "Status"
type: "string"
required:
- "domain"
- "status"
- "secret_token"
type: "object"
source-clarif-ai:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
user_id:
description: "User ID found in settings"
order: 1
title: "User ID"
type: "string"
sourceType:
title: "clarif-ai"
const: "clarif-ai"
enum:
- "clarif-ai"
order: 0
type: "string"
required:
- "api_key"
- "user_id"
- "start_date"
- "sourceType"
type: "object"
source-clarif-ai-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
user_id:
description: "User ID found in settings"
order: 1
title: "User ID"
type: "string"
required:
- "api_key"
- "user_id"
- "start_date"
type: "object"
source-huntr:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "huntr"
const: "huntr"
enum:
- "huntr"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-huntr-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-asana:
properties:
credentials:
description: "Choose how to authenticate to Github"
oneOf:
- properties:
client_id:
airbyte_secret: true
description: ""
title: ""
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: ""
title: ""
type: "string"
x-speakeasy-param-sensitive: true
option_title:
const: "OAuth Credentials"
description: "OAuth Credentials"
title: "Credentials title"
type: "string"
enum:
- "OAuth Credentials"
refresh_token:
airbyte_secret: true
description: ""
title: ""
type: "string"
x-speakeasy-param-sensitive: true
required:
- "client_id"
- "client_secret"
- "refresh_token"
title: "Authenticate via Asana (Oauth)"
type: "object"
- properties:
option_title:
const: "PAT Credentials"
description: "PAT Credentials"
title: "Credentials title"
type: "string"
enum:
- "PAT Credentials"
personal_access_token:
airbyte_secret: true
description: "Asana Personal Access Token (generate yours here)."
title: "Personal Access Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "personal_access_token"
title: "Authenticate with Personal Access Token"
type: "object"
title: "Authentication mechanism"
type: "object"
num_workers:
default: 10
description: "The number of worker threads to use for the sync. The performance\
\ upper boundary is based on the limit of your Asana pricing plan. More\
\ info about the rate limit tiers can be found on Asana's API docs."
examples:
- 1
- 2
- 3
maximum: 25
minimum: 1
title: "Number of concurrent threads"
type: "integer"
organization_export_ids:
description: "Globally unique identifiers for the organization exports"
title: "Organization Export IDs"
type: "array"
sourceType:
title: "asana"
const: "asana"
enum:
- "asana"
order: 0
type: "string"
title: "Asana Spec"
type: "object"
source-asana-update:
properties:
credentials:
description: "Choose how to authenticate to Github"
oneOf:
- properties:
client_id:
airbyte_secret: true
description: ""
title: ""
type: "string"
client_secret:
airbyte_secret: true
description: ""
title: ""
type: "string"
option_title:
const: "OAuth Credentials"
description: "OAuth Credentials"
title: "Credentials title"
type: "string"
enum:
- "OAuth Credentials"
refresh_token:
airbyte_secret: true
description: ""
title: ""
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
title: "Authenticate via Asana (Oauth)"
type: "object"
- properties:
option_title:
const: "PAT Credentials"
description: "PAT Credentials"
title: "Credentials title"
type: "string"
enum:
- "PAT Credentials"
personal_access_token:
airbyte_secret: true
description: "Asana Personal Access Token (generate yours here)."
title: "Personal Access Token"
type: "string"
required:
- "personal_access_token"
title: "Authenticate with Personal Access Token"
type: "object"
title: "Authentication mechanism"
type: "object"
num_workers:
default: 10
description: "The number of worker threads to use for the sync. The performance\
\ upper boundary is based on the limit of your Asana pricing plan. More\
\ info about the rate limit tiers can be found on Asana's API docs."
examples:
- 1
- 2
- 3
maximum: 25
minimum: 1
title: "Number of concurrent threads"
type: "integer"
organization_export_ids:
description: "Globally unique identifiers for the organization exports"
title: "Organization Export IDs"
type: "array"
title: "Asana Spec"
type: "object"
source-segment:
properties:
api_token:
airbyte_secret: true
description: "API token to use. Generate it in Segment's Workspace settings."
name: "api_token"
order: 1
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
region:
default: "api"
description: "The region for the API, e.g., 'api' for US or 'eu1' for EU"
name: "region"
order: 0
title: "Region"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "segment"
const: "segment"
enum:
- "segment"
order: 0
type: "string"
required:
- "region"
- "api_token"
- "start_date"
- "sourceType"
type: "object"
source-segment-update:
properties:
api_token:
airbyte_secret: true
description: "API token to use. Generate it in Segment's Workspace settings."
name: "api_token"
order: 1
title: "API Token"
type: "string"
region:
default: "api"
description: "The region for the API, e.g., 'api' for US or 'eu1' for EU"
name: "region"
order: 0
title: "Region"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "region"
- "api_token"
- "start_date"
type: "object"
source-posthog:
properties:
api_key:
airbyte_secret: true
description: "API Key. See the docs for information on how to generate this key."
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
base_url:
default: "https://app.posthog.com"
description: "Base PostHog url. Defaults to PostHog Cloud (https://app.posthog.com)."
examples:
- "https://posthog.example.com"
title: "Base URL"
type: "string"
events_time_step:
default: 30
description: "Set lower value in case of failing long running sync of events\
\ stream."
examples:
- 30
- 10
- 5
maximum: 91
minimum: 1
order: 3
title: "Events stream slice step size (in days)"
type: "integer"
start_date:
description: "The date from which you'd like to replicate the data. Any\
\ data 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$"
title: "Start Date"
type: "string"
sourceType:
title: "posthog"
const: "posthog"
enum:
- "posthog"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
title: "PostHog Spec"
type: "object"
source-posthog-update:
properties:
api_key:
airbyte_secret: true
description: "API Key. See the docs for information on how to generate this key."
title: "API Key"
type: "string"
base_url:
default: "https://app.posthog.com"
description: "Base PostHog url. Defaults to PostHog Cloud (https://app.posthog.com)."
examples:
- "https://posthog.example.com"
title: "Base URL"
type: "string"
events_time_step:
default: 30
description: "Set lower value in case of failing long running sync of events\
\ stream."
examples:
- 30
- 10
- 5
maximum: 91
minimum: 1
order: 3
title: "Events stream slice step size (in days)"
type: "integer"
start_date:
description: "The date from which you'd like to replicate the data. Any\
\ data 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$"
title: "Start Date"
type: "string"
required:
- "api_key"
- "start_date"
title: "PostHog Spec"
type: "object"
source-easypost:
properties:
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
username:
airbyte_secret: true
description: "The API Key from your easypost settings"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "easypost"
const: "easypost"
enum:
- "easypost"
order: 0
type: "string"
required:
- "username"
- "start_date"
- "sourceType"
type: "object"
source-easypost-update:
properties:
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
username:
airbyte_secret: true
description: "The API Key from your easypost settings"
order: 0
title: "API Key"
type: "string"
required:
- "username"
- "start_date"
type: "object"
source-judge-me-reviews:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
shop_domain:
description: "example.myshopify.com"
order: 1
title: "Shop Domain"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "judge-me-reviews"
const: "judge-me-reviews"
enum:
- "judge-me-reviews"
order: 0
type: "string"
required:
- "api_key"
- "shop_domain"
- "start_date"
- "sourceType"
type: "object"
source-judge-me-reviews-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
shop_domain:
description: "example.myshopify.com"
order: 1
title: "Shop Domain"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "shop_domain"
- "start_date"
type: "object"
source-split-io:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "split-io"
const: "split-io"
enum:
- "split-io"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-split-io-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-microsoft-teams:
properties:
credentials:
description: "Choose how to authenticate to Microsoft"
oneOf:
- properties:
auth_type:
const: "Client"
default: "Client"
enum:
- "Client"
order: 0
type: "string"
client_id:
description: "The Client ID of your Microsoft Teams developer application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Microsoft Teams developer\
\ application."
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "A Refresh Token to renew the expired Access Token."
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
tenant_id:
airbyte_secret: true
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"
title: "Directory (tenant) ID"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tenant_id"
- "client_id"
- "client_secret"
- "refresh_token"
title: "Authenticate via Microsoft (OAuth 2.0)"
type: "object"
- properties:
auth_type:
const: "Token"
default: "Token"
enum:
- "Token"
order: 0
type: "string"
client_id:
description: "The Client ID of your Microsoft Teams developer application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Microsoft Teams developer\
\ application."
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
tenant_id:
airbyte_secret: true
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"
title: "Directory (tenant) ID"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tenant_id"
- "client_id"
- "client_secret"
title: "Authenticate via Microsoft"
type: "object"
title: "Authentication mechanism"
type: "object"
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"
title: "Period"
type: "string"
sourceType:
title: "microsoft-teams"
const: "microsoft-teams"
enum:
- "microsoft-teams"
order: 0
type: "string"
required:
- "period"
- "sourceType"
title: "Microsoft Teams Spec"
type: "object"
source-microsoft-teams-update:
properties:
credentials:
description: "Choose how to authenticate to Microsoft"
oneOf:
- properties:
auth_type:
const: "Client"
default: "Client"
enum:
- "Client"
order: 0
type: "string"
client_id:
description: "The Client ID of your Microsoft Teams developer application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Microsoft Teams developer\
\ application."
title: "Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "A Refresh Token to renew the expired Access Token."
title: "Refresh Token"
type: "string"
tenant_id:
airbyte_secret: true
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"
title: "Directory (tenant) ID"
type: "string"
required:
- "tenant_id"
- "client_id"
- "client_secret"
- "refresh_token"
title: "Authenticate via Microsoft (OAuth 2.0)"
type: "object"
- properties:
auth_type:
const: "Token"
default: "Token"
enum:
- "Token"
order: 0
type: "string"
client_id:
description: "The Client ID of your Microsoft Teams developer application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Microsoft Teams developer\
\ application."
title: "Client Secret"
type: "string"
tenant_id:
airbyte_secret: true
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"
title: "Directory (tenant) ID"
type: "string"
required:
- "tenant_id"
- "client_id"
- "client_secret"
title: "Authenticate via Microsoft"
type: "object"
title: "Authentication mechanism"
type: "object"
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"
title: "Period"
type: "string"
required:
- "period"
title: "Microsoft Teams Spec"
type: "object"
source-aviationstack:
properties:
access_key:
airbyte_secret: true
description: "Your unique API key for authenticating with the Aviation API.\
\ You can find it in your Aviation account dashboard at https://aviationstack.com/dashboard"
name: "access_key"
order: 0
title: "Access Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "aviationstack"
const: "aviationstack"
enum:
- "aviationstack"
order: 0
type: "string"
required:
- "access_key"
- "start_date"
- "sourceType"
type: "object"
source-aviationstack-update:
properties:
access_key:
airbyte_secret: true
description: "Your unique API key for authenticating with the Aviation API.\
\ You can find it in your Aviation account dashboard at https://aviationstack.com/dashboard"
name: "access_key"
order: 0
title: "Access Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "access_key"
- "start_date"
type: "object"
source-todoist:
properties:
token:
airbyte_secret: true
description: "API authorization bearer token for authenticating the API"
order: 0
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "todoist"
const: "todoist"
enum:
- "todoist"
order: 0
type: "string"
required:
- "token"
- "sourceType"
type: "object"
source-todoist-update:
properties:
token:
airbyte_secret: true
description: "API authorization bearer token for authenticating the API"
order: 0
type: "string"
required:
- "token"
type: "object"
source-amazon-seller-partner:
properties:
account_type:
default: "Seller"
description: "Type of the Account you're going to authorize the Airbyte\
\ application by"
enum:
- "Seller"
- "Vendor"
order: 3
title: "AWS Seller Partner Account Type"
type: "string"
app_id:
airbyte_secret: true
description: "Your Amazon Application ID."
order: 4
title: "Application ID"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "oauth2.0"
order: 0
title: "Auth Type"
type: "string"
enum:
- "oauth2.0"
aws_environment:
default: "PRODUCTION"
description: "Select the AWS Environment."
enum:
- "PRODUCTION"
- "SANDBOX"
order: 1
title: "AWS Environment"
type: "string"
financial_events_step:
default: "180"
description: "The time window size (in days) for fetching financial events\
\ data in chunks. Options are 1 day, 7 days, 14 days, 30 days, 60 days,\
\ and 190 days, based on API limitations.\n\n- **Smaller step sizes (e.g.,\
\ 1 day)** are better for large data volumes. They fetch smaller chunks\
\ per request, reducing the risk of timeouts or overwhelming the API,\
\ though more requests may slow syncing and increase the chance of hitting\
\ rate limits.\n- **Larger step sizes (e.g., 14 days)** are better for\
\ smaller data volumes. They fetch more data per request, speeding up\
\ syncing and reducing the number of API calls, which minimizes strain\
\ on rate limits.\n\nSelect a step size that matches your data volume\
\ to optimize syncing speed and API performance."
enum:
- "1"
- "7"
- "14"
- "30"
- "60"
- "90"
- "180"
order: 13
title: "Financial Events Step Size (in days)"
type: "string"
lwa_app_id:
airbyte_secret: true
description: "Your Login with Amazon Client ID."
order: 5
title: "LWA Client Id"
type: "string"
x-speakeasy-param-sensitive: true
lwa_client_secret:
airbyte_secret: true
description: "Your Login with Amazon Client Secret."
order: 6
title: "LWA Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
max_async_job_count:
default: 2
description: "The maximum number of concurrent asynchronous job requests\
\ that can be active at a time."
minimum: 1
order: 15
title: "Maximum Concurrent Async Job Count"
type: "integer"
num_workers:
default: 2
description: "The number of workers to use for the connector when syncing\
\ concurrently."
maximum: 10
minimum: 2
order: 14
title: "Number of Workers"
type: "integer"
period_in_days:
default: 90
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."
minimum: 1
order: 10
title: "Period In Days"
type: "integer"
refresh_token:
airbyte_secret: true
description: "The Refresh Token obtained via OAuth flow authorization."
order: 7
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
region:
default: "US"
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"
order: 2
title: "AWS Region"
type: "string"
replication_end_date:
description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\
\ data after this date will not be replicated."
examples:
- "2017-01-25T00:00:00Z"
format: "date-time"
order: 9
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$|^$"
title: "End Date"
type: "string"
replication_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\
\ or older than 2 years ago from today, the date 2 years ago from today\
\ will be used."
examples:
- "2017-01-25T00:00:00Z"
format: "date-time"
order: 8
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
report_options_list:
description: "Additional information passed to reports. This varies by report\
\ type."
items:
properties:
options_list:
description: "List of options"
items:
properties:
option_name:
order: 0
title: "Name"
type: "string"
option_value:
order: 1
title: "Value"
type: "string"
required:
- "option_name"
- "option_value"
type: "object"
order: 2
title: "List of options"
type: "array"
report_name:
enum:
- "GET_AFN_INVENTORY_DATA"
- "GET_AFN_INVENTORY_DATA_BY_COUNTRY"
- "GET_AMAZON_FULFILLED_SHIPMENTS_DATA_GENERAL"
- "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_SELLER_FEEDBACK_DATA"
- "GET_STRANDED_INVENTORY_UI_DATA"
- "GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE"
- "GET_XML_ALL_ORDERS_DATA_BY_ORDER_DATE_GENERAL"
- "GET_XML_BROWSE_TREE_DATA"
- "GET_VENDOR_REAL_TIME_INVENTORY_REPORT"
order: 0
title: "Report Name"
type: "string"
stream_name:
order: 1
title: "Stream Name"
type: "string"
required:
- "report_name"
- "stream_name"
- "options_list"
title: "Report Options"
type: "object"
order: 11
title: "Report Options"
type: "array"
wait_to_avoid_fatal_errors:
default: false
description: "For report based streams with known amount of requests per\
\ time period, this option will use waiting time between requests to avoid\
\ fatal statuses in reports. See Troubleshooting section for more details"
order: 12
title: "Wait between requests to avoid fatal statuses in reports"
type: "boolean"
sourceType:
title: "amazon-seller-partner"
const: "amazon-seller-partner"
enum:
- "amazon-seller-partner"
order: 0
type: "string"
required:
- "aws_environment"
- "region"
- "account_type"
- "lwa_app_id"
- "lwa_client_secret"
- "refresh_token"
- "sourceType"
title: "Amazon Seller Partner Spec"
type: "object"
source-amazon-seller-partner-update:
properties:
account_type:
default: "Seller"
description: "Type of the Account you're going to authorize the Airbyte\
\ application by"
enum:
- "Seller"
- "Vendor"
order: 3
title: "AWS Seller Partner Account Type"
type: "string"
app_id:
airbyte_secret: true
description: "Your Amazon Application ID."
order: 4
title: "Application ID"
type: "string"
auth_type:
const: "oauth2.0"
order: 0
title: "Auth Type"
type: "string"
enum:
- "oauth2.0"
aws_environment:
default: "PRODUCTION"
description: "Select the AWS Environment."
enum:
- "PRODUCTION"
- "SANDBOX"
order: 1
title: "AWS Environment"
type: "string"
financial_events_step:
default: "180"
description: "The time window size (in days) for fetching financial events\
\ data in chunks. Options are 1 day, 7 days, 14 days, 30 days, 60 days,\
\ and 190 days, based on API limitations.\n\n- **Smaller step sizes (e.g.,\
\ 1 day)** are better for large data volumes. They fetch smaller chunks\
\ per request, reducing the risk of timeouts or overwhelming the API,\
\ though more requests may slow syncing and increase the chance of hitting\
\ rate limits.\n- **Larger step sizes (e.g., 14 days)** are better for\
\ smaller data volumes. They fetch more data per request, speeding up\
\ syncing and reducing the number of API calls, which minimizes strain\
\ on rate limits.\n\nSelect a step size that matches your data volume\
\ to optimize syncing speed and API performance."
enum:
- "1"
- "7"
- "14"
- "30"
- "60"
- "90"
- "180"
order: 13
title: "Financial Events Step Size (in days)"
type: "string"
lwa_app_id:
airbyte_secret: true
description: "Your Login with Amazon Client ID."
order: 5
title: "LWA Client Id"
type: "string"
lwa_client_secret:
airbyte_secret: true
description: "Your Login with Amazon Client Secret."
order: 6
title: "LWA Client Secret"
type: "string"
max_async_job_count:
default: 2
description: "The maximum number of concurrent asynchronous job requests\
\ that can be active at a time."
minimum: 1
order: 15
title: "Maximum Concurrent Async Job Count"
type: "integer"
num_workers:
default: 2
description: "The number of workers to use for the connector when syncing\
\ concurrently."
maximum: 10
minimum: 2
order: 14
title: "Number of Workers"
type: "integer"
period_in_days:
default: 90
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."
minimum: 1
order: 10
title: "Period In Days"
type: "integer"
refresh_token:
airbyte_secret: true
description: "The Refresh Token obtained via OAuth flow authorization."
order: 7
title: "Refresh Token"
type: "string"
region:
default: "US"
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"
order: 2
title: "AWS Region"
type: "string"
replication_end_date:
description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\
\ data after this date will not be replicated."
examples:
- "2017-01-25T00:00:00Z"
format: "date-time"
order: 9
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$|^$"
title: "End Date"
type: "string"
replication_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\
\ or older than 2 years ago from today, the date 2 years ago from today\
\ will be used."
examples:
- "2017-01-25T00:00:00Z"
format: "date-time"
order: 8
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
report_options_list:
description: "Additional information passed to reports. This varies by report\
\ type."
items:
properties:
options_list:
description: "List of options"
items:
properties:
option_name:
order: 0
title: "Name"
type: "string"
option_value:
order: 1
title: "Value"
type: "string"
required:
- "option_name"
- "option_value"
type: "object"
order: 2
title: "List of options"
type: "array"
report_name:
enum:
- "GET_AFN_INVENTORY_DATA"
- "GET_AFN_INVENTORY_DATA_BY_COUNTRY"
- "GET_AMAZON_FULFILLED_SHIPMENTS_DATA_GENERAL"
- "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_SELLER_FEEDBACK_DATA"
- "GET_STRANDED_INVENTORY_UI_DATA"
- "GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE"
- "GET_XML_ALL_ORDERS_DATA_BY_ORDER_DATE_GENERAL"
- "GET_XML_BROWSE_TREE_DATA"
- "GET_VENDOR_REAL_TIME_INVENTORY_REPORT"
order: 0
title: "Report Name"
type: "string"
stream_name:
order: 1
title: "Stream Name"
type: "string"
required:
- "report_name"
- "stream_name"
- "options_list"
title: "Report Options"
type: "object"
order: 11
title: "Report Options"
type: "array"
wait_to_avoid_fatal_errors:
default: false
description: "For report based streams with known amount of requests per\
\ time period, this option will use waiting time between requests to avoid\
\ fatal statuses in reports. See Troubleshooting section for more details"
order: 12
title: "Wait between requests to avoid fatal statuses in reports"
type: "boolean"
required:
- "aws_environment"
- "region"
- "account_type"
- "lwa_app_id"
- "lwa_client_secret"
- "refresh_token"
title: "Amazon Seller Partner Spec"
type: "object"
source-northpass-lms:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "northpass-lms"
const: "northpass-lms"
enum:
- "northpass-lms"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-northpass-lms-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-zoho-invoice:
properties:
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_refresh_token:
airbyte_secret: true
order: 2
title: "Refresh token"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
x-speakeasy-param-sensitive: true
organization_id:
description: "To be provided if a user belongs to multiple organizations"
order: 3
title: "Organization ID"
type: "string"
region:
enum:
- "com"
- "eu"
- "in"
- "com.cn"
- "com.au"
- "jp"
- "sa"
- "ca"
order: 4
title: "Region"
type: "string"
sourceType:
title: "zoho-invoice"
const: "zoho-invoice"
enum:
- "zoho-invoice"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "client_refresh_token"
- "region"
- "sourceType"
type: "object"
source-zoho-invoice-update:
properties:
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
client_refresh_token:
airbyte_secret: true
order: 2
title: "Refresh token"
type: "string"
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
organization_id:
description: "To be provided if a user belongs to multiple organizations"
order: 3
title: "Organization ID"
type: "string"
region:
enum:
- "com"
- "eu"
- "in"
- "com.cn"
- "com.au"
- "jp"
- "sa"
- "ca"
order: 4
title: "Region"
type: "string"
required:
- "client_id"
- "client_secret"
- "client_refresh_token"
- "region"
type: "object"
source-breezy-hr:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
company_id:
airbyte_secret: true
order: 1
title: "Company ID"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "breezy-hr"
const: "breezy-hr"
enum:
- "breezy-hr"
order: 0
type: "string"
required:
- "api_key"
- "company_id"
- "sourceType"
type: "object"
source-breezy-hr-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
company_id:
airbyte_secret: true
order: 1
title: "Company ID"
type: "string"
required:
- "api_key"
- "company_id"
type: "object"
source-captain-data:
properties:
api_key:
airbyte_secret: true
description: "Your Captain Data project API key."
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
project_uid:
description: "Your Captain Data project uuid."
order: 1
title: "Project UID"
type: "string"
sourceType:
title: "captain-data"
const: "captain-data"
enum:
- "captain-data"
order: 0
type: "string"
required:
- "api_key"
- "project_uid"
- "sourceType"
type: "object"
source-captain-data-update:
properties:
api_key:
airbyte_secret: true
description: "Your Captain Data project API key."
order: 0
title: "API Key"
type: "string"
project_uid:
description: "Your Captain Data project uuid."
order: 1
title: "Project UID"
type: "string"
required:
- "api_key"
- "project_uid"
type: "object"
source-hoorayhr:
properties:
hoorayhrpassword:
airbyte_secret: true
order: 1
title: "HoorayHR Password"
type: "string"
x-speakeasy-param-sensitive: true
hoorayhrusername:
order: 0
title: "HoorayHR Username"
type: "string"
sourceType:
title: "hoorayhr"
const: "hoorayhr"
enum:
- "hoorayhr"
order: 0
type: "string"
required:
- "hoorayhrusername"
- "hoorayhrpassword"
- "sourceType"
type: "object"
source-hoorayhr-update:
properties:
hoorayhrpassword:
airbyte_secret: true
order: 1
title: "HoorayHR Password"
type: "string"
hoorayhrusername:
order: 0
title: "HoorayHR Username"
type: "string"
required:
- "hoorayhrusername"
- "hoorayhrpassword"
type: "object"
source-us-census:
properties:
api_key:
airbyte_secret: true
description: "Your API Key. Get your key here."
order: 2
type: "string"
x-speakeasy-param-sensitive: true
query_params:
description: "The query parameters portion of the GET request, without the\
\ api key"
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:*"
order: 0
pattern: "^\\w+=(?:[\\w,:*]|%20)+(&(?!key)\\w+=(?:[\\w,:*]|%20)+)*$"
type: "string"
query_path:
description: "The path portion of the GET request"
examples:
- "data/2019/cbp"
- "data/2018/acs"
- "data/timeseries/healthins/sahie"
order: 1
pattern: "^data(\\/[\\w\\d]+)+$"
type: "string"
sourceType:
title: "us-census"
const: "us-census"
enum:
- "us-census"
order: 0
type: "string"
required:
- "query_path"
- "api_key"
- "sourceType"
type: "object"
source-us-census-update:
properties:
api_key:
airbyte_secret: true
description: "Your API Key. Get your key here."
order: 2
type: "string"
query_params:
description: "The query parameters portion of the GET request, without the\
\ api key"
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:*"
order: 0
pattern: "^\\w+=(?:[\\w,:*]|%20)+(&(?!key)\\w+=(?:[\\w,:*]|%20)+)*$"
type: "string"
query_path:
description: "The path portion of the GET request"
examples:
- "data/2019/cbp"
- "data/2018/acs"
- "data/timeseries/healthins/sahie"
order: 1
pattern: "^data(\\/[\\w\\d]+)+$"
type: "string"
required:
- "query_path"
- "api_key"
type: "object"
source-goldcast:
properties:
access_key:
airbyte_secret: true
description: "Your API Access Key. See here. The key is case sensitive."
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "goldcast"
const: "goldcast"
enum:
- "goldcast"
order: 0
type: "string"
required:
- "access_key"
- "sourceType"
title: "goldcast.io Source Spec"
type: "object"
source-goldcast-update:
properties:
access_key:
airbyte_secret: true
description: "Your API Access Key. See here. The key is case sensitive."
type: "string"
required:
- "access_key"
title: "goldcast.io Source Spec"
type: "object"
source-pinterest:
properties:
account_id:
description: "The Pinterest account ID you want to fetch data for. This\
\ ID must be provided to filter the data for a specific account."
examples:
- "1234567890"
title: "Account ID"
type: "string"
credentials:
properties:
auth_method:
const: "oauth2.0"
order: 0
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The Client ID of your OAuth application"
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The Client Secret of your OAuth application."
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "Refresh Token to obtain new Access Token, when it's expired."
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_method"
- "refresh_token"
- "client_id"
- "client_secret"
title: "OAuth2.0"
type: "object"
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."
items:
description: "Config for custom report"
properties:
attribution_types:
default:
- "INDIVIDUAL"
- "HOUSEHOLD"
description: "List of types of attribution for the conversion report"
items:
description: "An enumeration."
enum:
- "INDIVIDUAL"
- "HOUSEHOLD"
title: "ValidEnums"
order: 8
title: "Attribution types"
type: "array"
click_window_days:
default: 30
description: "Number of days to use as the conversion attribution\
\ window for a pin click action."
enum:
- 0
- 1
- 7
- 14
- 30
- 60
order: 4
title: "Click window days"
type: "integer"
columns:
default: []
description: "A list of chosen columns"
items:
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"
title: "ValidEnums"
order: 3
title: "Columns"
type: "array"
conversion_report_time:
default: "TIME_OF_AD_ACTION"
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.."
enum:
- "TIME_OF_AD_ACTION"
- "TIME_OF_CONVERSION"
order: 7
title: "Conversion report time"
type: "string"
engagement_window_days:
default:
- 30
description: "Number of days to use as the conversion attribution\
\ window for an engagement action."
enum:
- 0
- 1
- 7
- 14
- 30
- 60
order: 5
title: "Engagement window days"
type: "integer"
granularity:
default: "TOTAL"
description: "Chosen granularity for API"
enum:
- "TOTAL"
- "DAY"
- "HOUR"
- "WEEK"
- "MONTH"
order: 2
title: "Granularity"
type: "string"
level:
default: "ADVERTISER"
description: "Chosen level for API"
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"
order: 1
title: "Level"
type: "string"
name:
description: "The name value of report"
order: 0
title: "Name"
type: "string"
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)."
examples:
- "2022-07-28"
format: "date"
order: 9
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
pattern_descriptor: "YYYY-MM-DD"
title: "Start Date"
type: "string"
view_window_days:
default:
- 30
description: "Number of days to use as the conversion attribution\
\ window for a view action."
enum:
- 0
- 1
- 7
- 14
- 30
- 60
order: 6
title: "View window days"
type: "integer"
required:
- "name"
- "level"
- "granularity"
- "columns"
title: "ReportConfig"
type: "object"
title: "Custom Reports"
type: "array"
num_threads:
default: 2
description: "The number of parallel threads to use for the sync."
examples:
- 1
- 2
- 3
maximum: 40
minimum: 1
order: 10
title: "Number of concurrent threads"
type: "integer"
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)."
examples:
- "2022-07-28"
format: "date"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
pattern_descriptor: "YYYY-MM-DD"
title: "Start Date"
type: "string"
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."
items:
enum:
- "ACTIVE"
- "PAUSED"
- "ARCHIVED"
type: "string"
title: "Status"
type:
- "array"
- "null"
uniqueItems: true
sourceType:
title: "pinterest"
const: "pinterest"
enum:
- "pinterest"
order: 0
type: "string"
title: "Pinterest Spec"
type: "object"
source-pinterest-update:
properties:
account_id:
description: "The Pinterest account ID you want to fetch data for. This\
\ ID must be provided to filter the data for a specific account."
examples:
- "1234567890"
title: "Account ID"
type: "string"
credentials:
properties:
auth_method:
const: "oauth2.0"
order: 0
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The Client ID of your OAuth application"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your OAuth application."
title: "Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "Refresh Token to obtain new Access Token, when it's expired."
title: "Refresh Token"
type: "string"
required:
- "auth_method"
- "refresh_token"
- "client_id"
- "client_secret"
title: "OAuth2.0"
type: "object"
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."
items:
description: "Config for custom report"
properties:
attribution_types:
default:
- "INDIVIDUAL"
- "HOUSEHOLD"
description: "List of types of attribution for the conversion report"
items:
description: "An enumeration."
enum:
- "INDIVIDUAL"
- "HOUSEHOLD"
title: "ValidEnums"
order: 8
title: "Attribution types"
type: "array"
click_window_days:
default: 30
description: "Number of days to use as the conversion attribution\
\ window for a pin click action."
enum:
- 0
- 1
- 7
- 14
- 30
- 60
order: 4
title: "Click window days"
type: "integer"
columns:
default: []
description: "A list of chosen columns"
items:
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"
title: "ValidEnums"
order: 3
title: "Columns"
type: "array"
conversion_report_time:
default: "TIME_OF_AD_ACTION"
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.."
enum:
- "TIME_OF_AD_ACTION"
- "TIME_OF_CONVERSION"
order: 7
title: "Conversion report time"
type: "string"
engagement_window_days:
default:
- 30
description: "Number of days to use as the conversion attribution\
\ window for an engagement action."
enum:
- 0
- 1
- 7
- 14
- 30
- 60
order: 5
title: "Engagement window days"
type: "integer"
granularity:
default: "TOTAL"
description: "Chosen granularity for API"
enum:
- "TOTAL"
- "DAY"
- "HOUR"
- "WEEK"
- "MONTH"
order: 2
title: "Granularity"
type: "string"
level:
default: "ADVERTISER"
description: "Chosen level for API"
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"
order: 1
title: "Level"
type: "string"
name:
description: "The name value of report"
order: 0
title: "Name"
type: "string"
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)."
examples:
- "2022-07-28"
format: "date"
order: 9
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
pattern_descriptor: "YYYY-MM-DD"
title: "Start Date"
type: "string"
view_window_days:
default:
- 30
description: "Number of days to use as the conversion attribution\
\ window for a view action."
enum:
- 0
- 1
- 7
- 14
- 30
- 60
order: 6
title: "View window days"
type: "integer"
required:
- "name"
- "level"
- "granularity"
- "columns"
title: "ReportConfig"
type: "object"
title: "Custom Reports"
type: "array"
num_threads:
default: 2
description: "The number of parallel threads to use for the sync."
examples:
- 1
- 2
- 3
maximum: 40
minimum: 1
order: 10
title: "Number of concurrent threads"
type: "integer"
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)."
examples:
- "2022-07-28"
format: "date"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
pattern_descriptor: "YYYY-MM-DD"
title: "Start Date"
type: "string"
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."
items:
enum:
- "ACTIVE"
- "PAUSED"
- "ARCHIVED"
type: "string"
title: "Status"
type:
- "array"
- "null"
uniqueItems: true
title: "Pinterest Spec"
type: "object"
source-spacex-api:
properties:
id:
desciption: "Optional, For a specific ID"
order: 0
title: "Unique ID for specific source target"
type: "string"
options:
desciption: "Optional, Possible values for an endpoint. Example values for\
\ launches-latest, upcoming, past"
order: 1
title: "Configuration options for endpoints"
type: "string"
sourceType:
title: "spacex-api"
const: "spacex-api"
enum:
- "spacex-api"
order: 0
type: "string"
required:
- "sourceType"
type: "object"
source-spacex-api-update:
properties:
id:
desciption: "Optional, For a specific ID"
order: 0
title: "Unique ID for specific source target"
type: "string"
options:
desciption: "Optional, Possible values for an endpoint. Example values for\
\ launches-latest, upcoming, past"
order: 1
title: "Configuration options for endpoints"
type: "string"
required: []
type: "object"
source-bamboo-hr:
properties:
api_key:
airbyte_secret: true
description: "Api key of bamboo hr"
order: 0
title: "api_key"
type: "string"
x-speakeasy-param-sensitive: true
custom_reports_fields:
description: "Comma-separated list of fields to include in custom reports."
order: 2
title: "custom_reports_fields"
type: "string"
custom_reports_include_default_fields:
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."
order: 3
title: "custom_reports_include_default_fields"
type: "boolean"
employee_fields:
default: "firstName,lastName"
description: "Comma-separated list of fields to include for employees."
order: 4
title: "employee_fields"
type: "string"
start_date:
format: "date-time"
order: 5
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
subdomain:
description: "Sub Domain of bamboo hr"
order: 1
title: "subdomain"
type: "string"
sourceType:
title: "bamboo-hr"
const: "bamboo-hr"
enum:
- "bamboo-hr"
order: 0
type: "string"
required:
- "api_key"
- "subdomain"
- "sourceType"
type: "object"
source-bamboo-hr-update:
properties:
api_key:
airbyte_secret: true
description: "Api key of bamboo hr"
order: 0
title: "api_key"
type: "string"
custom_reports_fields:
description: "Comma-separated list of fields to include in custom reports."
order: 2
title: "custom_reports_fields"
type: "string"
custom_reports_include_default_fields:
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."
order: 3
title: "custom_reports_include_default_fields"
type: "boolean"
employee_fields:
default: "firstName,lastName"
description: "Comma-separated list of fields to include for employees."
order: 4
title: "employee_fields"
type: "string"
start_date:
format: "date-time"
order: 5
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
subdomain:
description: "Sub Domain of bamboo hr"
order: 1
title: "subdomain"
type: "string"
required:
- "api_key"
- "subdomain"
type: "object"
source-serpstat:
properties:
api_key:
airbyte_secret: true
description: "Serpstat API key can be found here: https://serpstat.com/users/profile/"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
domain:
default: "serpstat.com"
description: "The domain name to get data for (ex. serpstat.com)"
order: 1
title: "Domain"
type: "string"
domains:
description: "The list of domains that will be used in streams that support\
\ batch operations"
order: 3
title: "Domains"
type: "array"
filter_by:
description: "The field name by which the results should be filtered. Filtering\
\ the results will result in fewer API credits spent. Each stream has\
\ different filtering options. See https://serpstat.com/api/ for more\
\ details."
order: 4
title: "Filter by"
type: "string"
filter_value:
description: "The value of the field to filter by. Each stream has different\
\ filtering options. See https://serpstat.com/api/ for more details."
order: 5
title: "Filter value"
type: "string"
page_size:
default: 10
description: "The number of data rows per page to be returned. Each data\
\ row can contain multiple data points. The max value is 1000. Reducing\
\ the size of the page will result in fewer API credits spent."
order: 2
title: "Page size"
type: "integer"
pages_to_fetch:
default: 1
description: "The number of pages that should be fetched. All results will\
\ be obtained if left blank. Reducing the number of pages will result\
\ in fewer API credits spent."
order: 8
title: "Pages to fetch"
type: "integer"
region_id:
default: "g_us"
description: "The ID of a region to get data from in the form of a two-letter\
\ country code prepended with the g_ prefix. See the list of supported\
\ region IDs here: https://serpstat.com/api/664-request-parameters-v4/."
order: 9
title: "Region ID"
type: "string"
sort_by:
description: "The field name by which the results should be sorted. Each\
\ stream has different sorting options. See https://serpstat.com/api/\
\ for more details."
order: 6
title: "Sort by"
type: "string"
sort_value:
description: "The value of the field to sort by. Each stream has different\
\ sorting options. See https://serpstat.com/api/ for more details."
order: 7
title: "Sort value"
type: "string"
sourceType:
title: "serpstat"
const: "serpstat"
enum:
- "serpstat"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-serpstat-update:
properties:
api_key:
airbyte_secret: true
description: "Serpstat API key can be found here: https://serpstat.com/users/profile/"
order: 0
title: "API Key"
type: "string"
domain:
default: "serpstat.com"
description: "The domain name to get data for (ex. serpstat.com)"
order: 1
title: "Domain"
type: "string"
domains:
description: "The list of domains that will be used in streams that support\
\ batch operations"
order: 3
title: "Domains"
type: "array"
filter_by:
description: "The field name by which the results should be filtered. Filtering\
\ the results will result in fewer API credits spent. Each stream has\
\ different filtering options. See https://serpstat.com/api/ for more\
\ details."
order: 4
title: "Filter by"
type: "string"
filter_value:
description: "The value of the field to filter by. Each stream has different\
\ filtering options. See https://serpstat.com/api/ for more details."
order: 5
title: "Filter value"
type: "string"
page_size:
default: 10
description: "The number of data rows per page to be returned. Each data\
\ row can contain multiple data points. The max value is 1000. Reducing\
\ the size of the page will result in fewer API credits spent."
order: 2
title: "Page size"
type: "integer"
pages_to_fetch:
default: 1
description: "The number of pages that should be fetched. All results will\
\ be obtained if left blank. Reducing the number of pages will result\
\ in fewer API credits spent."
order: 8
title: "Pages to fetch"
type: "integer"
region_id:
default: "g_us"
description: "The ID of a region to get data from in the form of a two-letter\
\ country code prepended with the g_ prefix. See the list of supported\
\ region IDs here: https://serpstat.com/api/664-request-parameters-v4/."
order: 9
title: "Region ID"
type: "string"
sort_by:
description: "The field name by which the results should be sorted. Each\
\ stream has different sorting options. See https://serpstat.com/api/\
\ for more details."
order: 6
title: "Sort by"
type: "string"
sort_value:
description: "The value of the field to sort by. Each stream has different\
\ sorting options. See https://serpstat.com/api/ for more details."
order: 7
title: "Sort value"
type: "string"
required:
- "api_key"
type: "object"
source-wasabi-stats-api:
properties:
api_key:
airbyte_secret: true
description: "The API key format is `AccessKey:SecretKey`"
order: 1
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 0
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "wasabi-stats-api"
const: "wasabi-stats-api"
enum:
- "wasabi-stats-api"
order: 0
type: "string"
required:
- "start_date"
- "api_key"
- "sourceType"
type: "object"
source-wasabi-stats-api-update:
properties:
api_key:
airbyte_secret: true
description: "The API key format is `AccessKey:SecretKey`"
order: 1
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 0
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "start_date"
- "api_key"
type: "object"
source-revolut-merchant:
properties:
api_version:
description: "Specify the API version to use. This is required for certain\
\ API calls. Example: '2024-09-01'."
name: "api_version"
order: 0
title: "API Version"
type: "string"
environment:
description: "The base url of your environment. Either sandbox or production"
enum:
- "sandbox-merchant"
- "merchant"
order: 3
title: "environment"
type: "string"
secret_api_key:
airbyte_secret: true
description: "Secret API key to use for authenticating with the Revolut\
\ Merchant API. Find it in your Revolut Business account under APIs >\
\ Merchant API."
name: "secret_api_key"
order: 1
title: "Secret API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "revolut-merchant"
const: "revolut-merchant"
enum:
- "revolut-merchant"
order: 0
type: "string"
required:
- "api_version"
- "secret_api_key"
- "start_date"
- "environment"
- "sourceType"
type: "object"
source-revolut-merchant-update:
properties:
api_version:
description: "Specify the API version to use. This is required for certain\
\ API calls. Example: '2024-09-01'."
name: "api_version"
order: 0
title: "API Version"
type: "string"
environment:
description: "The base url of your environment. Either sandbox or production"
enum:
- "sandbox-merchant"
- "merchant"
order: 3
title: "environment"
type: "string"
secret_api_key:
airbyte_secret: true
description: "Secret API key to use for authenticating with the Revolut\
\ Merchant API. Find it in your Revolut Business account under APIs >\
\ Merchant API."
name: "secret_api_key"
order: 1
title: "Secret API Key"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_version"
- "secret_api_key"
- "start_date"
- "environment"
type: "object"
source-hibob:
properties:
is_sandbox:
description: "Toggle true if this instance is a HiBob sandbox "
order: 2
title: "Is Sandbox"
type: "boolean"
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
username:
order: 0
title: "Username"
type: "string"
sourceType:
title: "hibob"
const: "hibob"
enum:
- "hibob"
order: 0
type: "string"
required:
- "username"
- "is_sandbox"
- "sourceType"
type: "object"
source-hibob-update:
properties:
is_sandbox:
description: "Toggle true if this instance is a HiBob sandbox "
order: 2
title: "Is Sandbox"
type: "boolean"
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
username:
order: 0
title: "Username"
type: "string"
required:
- "username"
- "is_sandbox"
type: "object"
source-mixpanel:
properties:
attribution_window:
default: 5
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)"
order: 2
title: "Attribution Window"
type: "integer"
credentials:
description: "Choose how to authenticate to Mixpanel"
oneOf:
- properties:
option_title:
const: "Service Account"
order: 0
type: "string"
enum:
- "Service Account"
project_id:
description: "Your project ID number. See the docs for more information on how to obtain this."
order: 3
title: "Project ID"
type: "integer"
secret:
airbyte_secret: true
description: "Mixpanel Service Account Secret. See the docs\
\ for more information on how to obtain this."
order: 2
title: "Secret"
type: "string"
x-speakeasy-param-sensitive: true
username:
description: "Mixpanel Service Account Username. See the docs\
\ for more information on how to obtain this."
order: 1
title: "Username"
type: "string"
required:
- "username"
- "secret"
- "project_id"
title: "Service Account"
type: "object"
- properties:
api_secret:
airbyte_secret: true
description: "Mixpanel project secret. See the docs for more information on how to obtain this."
order: 1
title: "Project Secret"
type: "string"
x-speakeasy-param-sensitive: true
option_title:
const: "Project Secret"
order: 0
type: "string"
enum:
- "Project Secret"
required:
- "api_secret"
title: "Project Secret"
type: "object"
order: 0
title: "Authentication *"
type: "object"
date_window_size:
default: 30
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)"
minimum: 1
order: 8
title: "Date slicing window"
type: "integer"
end_date:
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"
format: "date-time"
order: 6
pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}Z)?$"
title: "End Date"
type: "string"
export_lookback_window:
default: 0
description: "The number of seconds to look back from the last synced timestamp\
\ during incremental syncs of the Export stream. This ensures no data\
\ is missed due to delays in event recording. Default is 0 seconds. Must\
\ be a non-negative integer."
minimum: 0
order: 10
title: "Export Lookback Window"
type: "integer"
num_workers:
default: 3
description: "The number of worker threads to use for the sync. The performance\
\ upper boundary is based on the limit of your Mixpanel pricing plan.\
\ More info about the rate limit tiers can be found on Mixpanel's API\
\ docs."
examples:
- 1
- 2
- 3
maximum: 25
minimum: 1
order: 11
title: "Number of concurrent threads"
type: "integer"
page_size:
default: 1000
description: "The number of records to fetch per request for the engage\
\ stream. Default is 1000. If you are experiencing long sync times with\
\ this stream, try increasing this value."
minimum: 1
order: 9
title: "Page Size"
type: "integer"
project_timezone:
default: "US/Pacific"
description: "Time zone in which integer date times are stored. The project\
\ timezone may be found in the project settings in the Mixpanel console."
examples:
- "US/Pacific"
- "UTC"
order: 3
title: "Project Timezone"
type: "string"
region:
default: "US"
description: "The region of mixpanel domain instance either US or EU."
enum:
- "US"
- "EU"
order: 7
title: "Region"
type: "string"
select_properties_by_default:
default: true
description: "Setting this config parameter to TRUE ensures that new properties\
\ on events and engage records are captured. Otherwise new properties\
\ will be ignored."
order: 4
title: "Select Properties By Default"
type: "boolean"
start_date:
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"
format: "date-time"
order: 5
pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}Z)?$"
title: "Start Date"
type: "string"
sourceType:
title: "mixpanel"
const: "mixpanel"
enum:
- "mixpanel"
order: 0
type: "string"
required:
- "credentials"
- "sourceType"
title: "Source Mixpanel Spec"
type: "object"
source-mixpanel-update:
properties:
attribution_window:
default: 5
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)"
order: 2
title: "Attribution Window"
type: "integer"
credentials:
description: "Choose how to authenticate to Mixpanel"
oneOf:
- properties:
option_title:
const: "Service Account"
order: 0
type: "string"
enum:
- "Service Account"
project_id:
description: "Your project ID number. See the docs for more information on how to obtain this."
order: 3
title: "Project ID"
type: "integer"
secret:
airbyte_secret: true
description: "Mixpanel Service Account Secret. See the docs\
\ for more information on how to obtain this."
order: 2
title: "Secret"
type: "string"
username:
description: "Mixpanel Service Account Username. See the docs\
\ for more information on how to obtain this."
order: 1
title: "Username"
type: "string"
required:
- "username"
- "secret"
- "project_id"
title: "Service Account"
type: "object"
- properties:
api_secret:
airbyte_secret: true
description: "Mixpanel project secret. See the docs for more information on how to obtain this."
order: 1
title: "Project Secret"
type: "string"
option_title:
const: "Project Secret"
order: 0
type: "string"
enum:
- "Project Secret"
required:
- "api_secret"
title: "Project Secret"
type: "object"
order: 0
title: "Authentication *"
type: "object"
date_window_size:
default: 30
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)"
minimum: 1
order: 8
title: "Date slicing window"
type: "integer"
end_date:
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"
format: "date-time"
order: 6
pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}Z)?$"
title: "End Date"
type: "string"
export_lookback_window:
default: 0
description: "The number of seconds to look back from the last synced timestamp\
\ during incremental syncs of the Export stream. This ensures no data\
\ is missed due to delays in event recording. Default is 0 seconds. Must\
\ be a non-negative integer."
minimum: 0
order: 10
title: "Export Lookback Window"
type: "integer"
num_workers:
default: 3
description: "The number of worker threads to use for the sync. The performance\
\ upper boundary is based on the limit of your Mixpanel pricing plan.\
\ More info about the rate limit tiers can be found on Mixpanel's API\
\ docs."
examples:
- 1
- 2
- 3
maximum: 25
minimum: 1
order: 11
title: "Number of concurrent threads"
type: "integer"
page_size:
default: 1000
description: "The number of records to fetch per request for the engage\
\ stream. Default is 1000. If you are experiencing long sync times with\
\ this stream, try increasing this value."
minimum: 1
order: 9
title: "Page Size"
type: "integer"
project_timezone:
default: "US/Pacific"
description: "Time zone in which integer date times are stored. The project\
\ timezone may be found in the project settings in the Mixpanel console."
examples:
- "US/Pacific"
- "UTC"
order: 3
title: "Project Timezone"
type: "string"
region:
default: "US"
description: "The region of mixpanel domain instance either US or EU."
enum:
- "US"
- "EU"
order: 7
title: "Region"
type: "string"
select_properties_by_default:
default: true
description: "Setting this config parameter to TRUE ensures that new properties\
\ on events and engage records are captured. Otherwise new properties\
\ will be ignored."
order: 4
title: "Select Properties By Default"
type: "boolean"
start_date:
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"
format: "date-time"
order: 5
pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}Z)?$"
title: "Start Date"
type: "string"
required:
- "credentials"
title: "Source Mixpanel Spec"
type: "object"
source-rd-station-marketing:
properties:
authorization:
description: "Choose one of the possible authorization method"
oneOf:
- properties:
auth_type:
const: "Client"
order: 0
type: "string"
enum:
- "Client"
client_id:
airbyte_secret: true
description: "The Client ID of your RD Station developer application."
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The Client Secret of your RD Station developer application"
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "The token for obtaining the new access token."
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_type"
title: "Sign in via RD Station (OAuth)"
type: "object"
order: 1
title: "Authentication Type"
type: "object"
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-25T00:00:00Z"
order: 0
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
sourceType:
title: "rd-station-marketing"
const: "rd-station-marketing"
enum:
- "rd-station-marketing"
order: 0
type: "string"
required:
- "start_date"
- "sourceType"
title: "RD Station Marketing Spec"
type: "object"
source-rd-station-marketing-update:
properties:
authorization:
description: "Choose one of the possible authorization method"
oneOf:
- properties:
auth_type:
const: "Client"
order: 0
type: "string"
enum:
- "Client"
client_id:
airbyte_secret: true
description: "The Client ID of your RD Station developer application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your RD Station developer application"
title: "Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "The token for obtaining the new access token."
title: "Refresh Token"
type: "string"
required:
- "auth_type"
title: "Sign in via RD Station (OAuth)"
type: "object"
order: 1
title: "Authentication Type"
type: "object"
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-25T00:00:00Z"
order: 0
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
required:
- "start_date"
title: "RD Station Marketing Spec"
type: "object"
source-weatherstack:
properties:
access_key:
airbyte_secret: true
description: "API access key used to retrieve data from the Weatherstack\
\ API.(https://weatherstack.com/product)"
order: 1
type: "string"
x-speakeasy-param-sensitive: true
historical_date:
default": "2000-01-01"
description: "This is required for enabling the Historical date API with\
\ format- (YYYY-MM-DD). * Note, only supported by paid accounts"
examples:
- "2015-01-21"
order: 3
pattern: "[0-9]{4}-[0-9]{2}-[0-9]{2}"
type: "string"
query:
description: "A location to query such as city, IP, latitudeLongitude, or\
\ zipcode. Multiple locations with semicolon seperated if using a professional\
\ plan or higher. For more info- (https://weatherstack.com/documentation#query_parameter)"
examples:
- "New York"
- "London"
- "98101"
order: 2
type: "string"
sourceType:
title: "weatherstack"
const: "weatherstack"
enum:
- "weatherstack"
order: 0
type: "string"
required:
- "access_key"
- "query"
- "historical_date"
- "sourceType"
type: "object"
source-weatherstack-update:
properties:
access_key:
airbyte_secret: true
description: "API access key used to retrieve data from the Weatherstack\
\ API.(https://weatherstack.com/product)"
order: 1
type: "string"
historical_date:
default": "2000-01-01"
description: "This is required for enabling the Historical date API with\
\ format- (YYYY-MM-DD). * Note, only supported by paid accounts"
examples:
- "2015-01-21"
order: 3
pattern: "[0-9]{4}-[0-9]{2}-[0-9]{2}"
type: "string"
query:
description: "A location to query such as city, IP, latitudeLongitude, or\
\ zipcode. Multiple locations with semicolon seperated if using a professional\
\ plan or higher. For more info- (https://weatherstack.com/documentation#query_parameter)"
examples:
- "New York"
- "London"
- "98101"
order: 2
type: "string"
required:
- "access_key"
- "query"
- "historical_date"
type: "object"
source-zendesk-support:
properties:
credentials:
description: "Zendesk allows two authentication methods. We recommend using\
\ `OAuth2.0` for Airbyte Cloud users and `API token` for Airbyte Open\
\ Source users."
oneOf:
- additionalProperties: true
properties:
access_token:
airbyte_secret: true
description: "The OAuth access token. See the Zendesk docs for more information on generating this token."
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
client_id:
airbyte_secret: true
description: "The OAuth client's ID. See this guide for more information."
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The OAuth client secret. See this guide for more information."
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
credentials:
const: "oauth2.0"
order: 0
type: "string"
enum:
- "oauth2.0"
required:
- "access_token"
title: "OAuth2.0"
type: "object"
- additionalProperties: true
properties:
api_token:
airbyte_secret: true
description: "The value of the API token generated. See our full documentation for more information on generating this\
\ token."
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
credentials:
const: "api_token"
order: 0
type: "string"
enum:
- "api_token"
email:
description: "The user email for your Zendesk account."
title: "Email"
type: "string"
required:
- "email"
- "api_token"
title: "API Token"
type: "object"
order: 1
title: "Authentication"
type: "object"
num_workers:
default: 3
description: "The number of worker threads to use for the sync. The performance\
\ upper boundary is based on the limit of your Zendesk Support plan. More\
\ info about the rate limit plan tiers can be found on Zendesk's API docs."
examples:
- 1
- 2
- 3
maximum: 40
minimum: 1
order: 3
title: "Number of concurrent threads"
type: "integer"
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"
format: "date-time"
order: 2
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"
title: "Start Date"
type: "string"
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
title: "Subdomain"
type: "string"
sourceType:
title: "zendesk-support"
const: "zendesk-support"
enum:
- "zendesk-support"
order: 0
type: "string"
required:
- "subdomain"
- "sourceType"
title: "Source Zendesk Support Spec"
type: "object"
source-zendesk-support-update:
properties:
credentials:
description: "Zendesk allows two authentication methods. We recommend using\
\ `OAuth2.0` for Airbyte Cloud users and `API token` for Airbyte Open\
\ Source users."
oneOf:
- additionalProperties: true
properties:
access_token:
airbyte_secret: true
description: "The OAuth access token. See the Zendesk docs for more information on generating this token."
title: "Access Token"
type: "string"
client_id:
airbyte_secret: true
description: "The OAuth client's ID. See this guide for more information."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The OAuth client secret. See this guide for more information."
title: "Client Secret"
type: "string"
credentials:
const: "oauth2.0"
order: 0
type: "string"
enum:
- "oauth2.0"
required:
- "access_token"
title: "OAuth2.0"
type: "object"
- additionalProperties: true
properties:
api_token:
airbyte_secret: true
description: "The value of the API token generated. See our full documentation for more information on generating this\
\ token."
title: "API Token"
type: "string"
credentials:
const: "api_token"
order: 0
type: "string"
enum:
- "api_token"
email:
description: "The user email for your Zendesk account."
title: "Email"
type: "string"
required:
- "email"
- "api_token"
title: "API Token"
type: "object"
order: 1
title: "Authentication"
type: "object"
num_workers:
default: 3
description: "The number of worker threads to use for the sync. The performance\
\ upper boundary is based on the limit of your Zendesk Support plan. More\
\ info about the rate limit plan tiers can be found on Zendesk's API docs."
examples:
- 1
- 2
- 3
maximum: 40
minimum: 1
order: 3
title: "Number of concurrent threads"
type: "integer"
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"
format: "date-time"
order: 2
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"
title: "Start Date"
type: "string"
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
title: "Subdomain"
type: "string"
required:
- "subdomain"
title: "Source Zendesk Support Spec"
type: "object"
source-veeqo:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "veeqo"
const: "veeqo"
enum:
- "veeqo"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-veeqo-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-statsig:
properties:
api_key:
airbyte_secret: true
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
end_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "End date"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "statsig"
const: "statsig"
enum:
- "statsig"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "end_date"
- "sourceType"
type: "object"
source-statsig-update:
properties:
api_key:
airbyte_secret: true
name: "api_key"
order: 0
title: "API Key"
type: "string"
end_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "End date"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
- "end_date"
type: "object"
source-free-agent-connector:
properties:
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_refresh_token_2:
airbyte_secret: true
order: 2
title: "Refresh token"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
x-speakeasy-param-sensitive: true
payroll_year:
order: 4
title: "Payroll Year"
type: "number"
updated_since:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Updated Since"
type: "string"
sourceType:
title: "free-agent-connector"
const: "free-agent-connector"
enum:
- "free-agent-connector"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "client_refresh_token_2"
- "sourceType"
type: "object"
source-free-agent-connector-update:
properties:
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
client_refresh_token_2:
airbyte_secret: true
order: 2
title: "Refresh token"
type: "string"
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
payroll_year:
order: 4
title: "Payroll Year"
type: "number"
updated_since:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Updated Since"
type: "string"
required:
- "client_id"
- "client_secret"
- "client_refresh_token_2"
type: "object"
source-microsoft-lists:
properties:
application_id_uri:
order: 3
title: "Application Id URI"
type: "string"
client_id:
airbyte_secret: true
order: 1
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
order: 2
title: "Client secret"
type: "string"
x-speakeasy-param-sensitive: true
domain:
airbyte_secret: true
order: 5
title: "Domain"
type: "string"
x-speakeasy-param-sensitive: true
site_id:
order: 0
title: "Site Id"
type: "string"
tenant_id:
airbyte_secret: true
order: 4
title: "Tenant Id"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "microsoft-lists"
const: "microsoft-lists"
enum:
- "microsoft-lists"
order: 0
type: "string"
required:
- "site_id"
- "client_id"
- "client_secret"
- "application_id_uri"
- "tenant_id"
- "domain"
- "sourceType"
type: "object"
source-microsoft-lists-update:
properties:
application_id_uri:
order: 3
title: "Application Id URI"
type: "string"
client_id:
airbyte_secret: true
order: 1
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
order: 2
title: "Client secret"
type: "string"
domain:
airbyte_secret: true
order: 5
title: "Domain"
type: "string"
site_id:
order: 0
title: "Site Id"
type: "string"
tenant_id:
airbyte_secret: true
order: 4
title: "Tenant Id"
type: "string"
required:
- "site_id"
- "client_id"
- "client_secret"
- "application_id_uri"
- "tenant_id"
- "domain"
type: "object"
source-testrail:
properties:
domain_name:
description: "The unique domain name for accessing testrail"
order: 3
title: "Domain name"
type: "string"
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
username:
order: 0
title: "Username"
type: "string"
sourceType:
title: "testrail"
const: "testrail"
enum:
- "testrail"
order: 0
type: "string"
required:
- "username"
- "start_date"
- "domain_name"
- "sourceType"
type: "object"
source-testrail-update:
properties:
domain_name:
description: "The unique domain name for accessing testrail"
order: 3
title: "Domain name"
type: "string"
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
username:
order: 0
title: "Username"
type: "string"
required:
- "username"
- "start_date"
- "domain_name"
type: "object"
source-rss:
properties:
url:
description: "RSS Feed URL"
type: "string"
sourceType:
title: "rss"
const: "rss"
enum:
- "rss"
order: 0
type: "string"
required:
- "url"
- "sourceType"
title: "RSS Spec"
type: "object"
source-rss-update:
properties:
url:
description: "RSS Feed URL"
type: "string"
required:
- "url"
title: "RSS Spec"
type: "object"
source-apple-search-ads:
properties:
backoff_factor:
default: 5
description: "This factor factor determines the delay increase factor between\
\ retryable failures. Valid values are integers between 1 and 20."
examples:
- 10
order: 6
pattern: "^(20|1[0-9]|[1-9])$"
title: "Exponential Backoff Factor"
type: "integer"
client_id:
airbyte_secret: true
description: "A user identifier for the token request. See here"
order: 2
title: "Client Id"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "A string that authenticates the user’s setup request. See\
\ here"
order: 4
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
end_date:
description: "Data is retrieved until that date (included)"
examples:
- "2021-01-01"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "End Date"
type: "string"
lookback_window:
default: 30
description: "Apple Search Ads uses a 30-day attribution window. However,\
\ you may consider smaller values in order to shorten sync durations,\
\ at the cost of missing late data attributions."
examples:
- 7
order: 5
pattern: "^(30|[1-2][0-9]|[1-9])$"
title: "Lookback Window"
type: "integer"
org_id:
description: "The identifier of the organization that owns the campaign.\
\ Your Org Id is the same as your account in the Apple Search Ads UI."
order: 0
title: "Org Id"
type: "integer"
start_date:
description: "Start getting data from that date."
examples:
- "2020-01-01"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
timezone:
default: "UTC"
description: "The timezone for the reporting data. Use 'ORTZ' for Organization\
\ Time Zone or 'UTC' for Coordinated Universal Time. Default is UTC."
enum:
- "ORTZ"
- "UTC"
order: 7
title: "Time Zone"
type: "string"
token_refresh_endpoint:
default: "https://appleid.apple.com/auth/oauth2/token?grant_type=client_credentials&scope=searchadsorg"
description: "Token Refresh Endpoint. You should override the default value\
\ in scenarios where it's required to proxy requests to Apple's token\
\ endpoint"
order: 8
title: "Token Refresh Endpoint"
type: "string"
sourceType:
title: "apple-search-ads"
const: "apple-search-ads"
enum:
- "apple-search-ads"
order: 0
type: "string"
required:
- "org_id"
- "client_id"
- "start_date"
- "client_secret"
- "timezone"
- "token_refresh_endpoint"
- "sourceType"
type: "object"
source-apple-search-ads-update:
properties:
backoff_factor:
default: 5
description: "This factor factor determines the delay increase factor between\
\ retryable failures. Valid values are integers between 1 and 20."
examples:
- 10
order: 6
pattern: "^(20|1[0-9]|[1-9])$"
title: "Exponential Backoff Factor"
type: "integer"
client_id:
airbyte_secret: true
description: "A user identifier for the token request. See here"
order: 2
title: "Client Id"
type: "string"
client_secret:
airbyte_secret: true
description: "A string that authenticates the user’s setup request. See\
\ here"
order: 4
title: "Client Secret"
type: "string"
end_date:
description: "Data is retrieved until that date (included)"
examples:
- "2021-01-01"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "End Date"
type: "string"
lookback_window:
default: 30
description: "Apple Search Ads uses a 30-day attribution window. However,\
\ you may consider smaller values in order to shorten sync durations,\
\ at the cost of missing late data attributions."
examples:
- 7
order: 5
pattern: "^(30|[1-2][0-9]|[1-9])$"
title: "Lookback Window"
type: "integer"
org_id:
description: "The identifier of the organization that owns the campaign.\
\ Your Org Id is the same as your account in the Apple Search Ads UI."
order: 0
title: "Org Id"
type: "integer"
start_date:
description: "Start getting data from that date."
examples:
- "2020-01-01"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
timezone:
default: "UTC"
description: "The timezone for the reporting data. Use 'ORTZ' for Organization\
\ Time Zone or 'UTC' for Coordinated Universal Time. Default is UTC."
enum:
- "ORTZ"
- "UTC"
order: 7
title: "Time Zone"
type: "string"
token_refresh_endpoint:
default: "https://appleid.apple.com/auth/oauth2/token?grant_type=client_credentials&scope=searchadsorg"
description: "Token Refresh Endpoint. You should override the default value\
\ in scenarios where it's required to proxy requests to Apple's token\
\ endpoint"
order: 8
title: "Token Refresh Endpoint"
type: "string"
required:
- "org_id"
- "client_id"
- "start_date"
- "client_secret"
- "timezone"
- "token_refresh_endpoint"
type: "object"
source-spotlercrm:
properties:
access_token:
airbyte_secret: true
description: "Access Token to authenticate API requests. Generate it by\
\ logging into your CRM system, navigating to Settings / Integrations\
\ / API V4, and clicking 'generate new key'."
name: "access_token"
order: 0
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "spotlercrm"
const: "spotlercrm"
enum:
- "spotlercrm"
order: 0
type: "string"
required:
- "access_token"
- "sourceType"
type: "object"
source-spotlercrm-update:
properties:
access_token:
airbyte_secret: true
description: "Access Token to authenticate API requests. Generate it by\
\ logging into your CRM system, navigating to Settings / Integrations\
\ / API V4, and clicking 'generate new key'."
name: "access_token"
order: 0
title: "Access Token"
type: "string"
required:
- "access_token"
type: "object"
source-ashby:
properties:
api_key:
airbyte_secret: true
description: "The Ashby API Key, see doc here."
order: 0
title: "Ashby API key"
type: "string"
x-speakeasy-param-sensitive: true
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:
- "2017-01-25T00:00:00Z"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "ashby"
const: "ashby"
enum:
- "ashby"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-ashby-update:
properties:
api_key:
airbyte_secret: true
description: "The Ashby API Key, see doc here."
order: 0
title: "Ashby API key"
type: "string"
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:
- "2017-01-25T00:00:00Z"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-tempo:
properties:
api_token:
airbyte_secret: true
description: "Tempo API Token. Go to Tempo>Settings, scroll down to Data\
\ Access and select API integration."
order: 0
title: "API token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "tempo"
const: "tempo"
enum:
- "tempo"
order: 0
type: "string"
required:
- "api_token"
- "sourceType"
type: "object"
source-tempo-update:
properties:
api_token:
airbyte_secret: true
description: "Tempo API Token. Go to Tempo>Settings, scroll down to Data\
\ Access and select API integration."
order: 0
title: "API token"
type: "string"
required:
- "api_token"
type: "object"
source-freightview:
properties:
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
order: 1
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "freightview"
const: "freightview"
enum:
- "freightview"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "sourceType"
type: "object"
source-freightview-update:
properties:
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
order: 1
title: "Client Secret"
type: "string"
required:
- "client_id"
- "client_secret"
type: "object"
source-onesignal:
properties:
applications:
description: "Applications keys, see the docs for more information on how to obtain this data"
items:
properties:
app_api_key:
airbyte_secret: true
order: 2
title: "REST API Key"
type: "string"
x-speakeasy-param-sensitive: true
app_id:
airbyte_secret: true
order: 1
title: "OneSignal App ID"
type: "string"
x-speakeasy-param-sensitive: true
app_name:
order: 0
title: "OneSignal App Name"
type: "string"
required:
- "app_id"
- "app_api_key"
type: "object"
order: 1
title: "Applications"
type: "array"
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
title: "Outcome Names"
type: "string"
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"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
user_auth_key:
airbyte_secret: true
description: "OneSignal User Auth Key, see the docs for more information on how to obtain this key."
order: 0
title: "User Auth Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "onesignal"
const: "onesignal"
enum:
- "onesignal"
order: 0
type: "string"
required:
- "user_auth_key"
- "applications"
- "start_date"
- "outcome_names"
- "sourceType"
type: "object"
source-onesignal-update:
properties:
applications:
description: "Applications keys, see the docs for more information on how to obtain this data"
items:
properties:
app_api_key:
airbyte_secret: true
order: 2
title: "REST API Key"
type: "string"
app_id:
airbyte_secret: true
order: 1
title: "OneSignal App ID"
type: "string"
app_name:
order: 0
title: "OneSignal App Name"
type: "string"
required:
- "app_id"
- "app_api_key"
type: "object"
order: 1
title: "Applications"
type: "array"
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
title: "Outcome Names"
type: "string"
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"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
user_auth_key:
airbyte_secret: true
description: "OneSignal User Auth Key, see the docs for more information on how to obtain this key."
order: 0
title: "User Auth Key"
type: "string"
required:
- "user_auth_key"
- "applications"
- "start_date"
- "outcome_names"
type: "object"
source-google-analytics-data-api:
properties:
convert_conversions_event:
default: false
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."
order: 8
title: "Convert `conversions:*` Metrics to Float"
type: "boolean"
credentials:
description: "Credentials for the service"
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests."
order: 4
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "Client"
order: 0
type: "string"
enum:
- "Client"
client_id:
description: "The Client ID of your Google Analytics developer application."
order: 1
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Google Analytics developer\
\ application."
order: 2
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "The token for obtaining a new access token."
order: 3
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "client_id"
- "client_secret"
- "refresh_token"
title: "Authenticate via Google (Oauth)"
type: "object"
- properties:
auth_type:
const: "Service"
order: 0
type: "string"
enum:
- "Service"
credentials_json:
airbyte_secret: true
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, ... }"
order: 1
title: "Service Account JSON Key"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "credentials_json"
title: "Service Account Key Authentication"
type: "object"
order: 0
title: "Credentials"
type: "object"
custom_reports_array:
description: "You can add your Custom Analytics report by creating one."
items:
properties:
cohortSpec:
description: "Cohort reports creates a time series of user retention\
\ for the cohort."
oneOf:
- properties:
enabled:
const: "false"
type: "string"
enum:
- "false"
title: "Disabled"
type: "object"
- properties:
cohortReportSettings:
description: "Optional settings for a cohort report."
properties:
accumulate:
always_show: true
description: "If true, accumulates the result from first\
\ touch day to the end day"
title: "Accumulate"
type: "boolean"
title: "Cohort Report Settings"
type: "object"
cohorts:
always_show: true
items:
properties:
dateRange:
properties:
endDate:
examples:
- "2021-01-01"
format: "date"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
pattern_descriptor: "YYYY-MM-DD"
title: "End Date"
type: "string"
startDate:
examples:
- "2021-01-01"
format: "date"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
pattern_descriptor: "YYYY-MM-DD"
title: "Start Date"
type: "string"
required:
- "startDate"
- "endDate"
type: "object"
dimension:
description: "Dimension used by the cohort. Required and\
\ only supports `firstSessionDate`"
enum:
- "firstSessionDate"
order: 1
title: "Dimension"
type: "string"
name:
always_show: true
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
pattern: "^(?!(cohort_|RESERVED_)).*$"
title: "Name"
type: "string"
required:
- "dimension"
- "dateRange"
title: "Cohorts"
type: "object"
name: "Cohorts"
order: 0
type: "array"
cohortsRange:
order: 1
properties:
endOffset:
description: "Specifies the end date of the extended reporting\
\ date range for a cohort report."
minimum: 0
order: 2
title: "End Offset"
type: "integer"
granularity:
description: "The granularity used to interpret the startOffset\
\ and endOffset for the extended reporting date range\
\ for a cohort report."
enum:
- "GRANULARITY_UNSPECIFIED"
- "DAILY"
- "WEEKLY"
- "MONTHLY"
order: 0
title: "Granularity"
type: "string"
startOffset:
description: "Specifies the start date of the extended reporting\
\ date range for a cohort report."
minimum: 0
order: 1
title: "Start Offset"
type: "integer"
required:
- "granularity"
- "endOffset"
type: "object"
enabled:
const: "true"
type: "string"
enum:
- "true"
title: "Enabled"
type: "object"
order: 5
title: "Cohort Reports"
type: "object"
dimensionFilter:
description: "Dimensions filter"
oneOf:
- description: "The FilterExpressions in andGroup have an AND relationship."
properties:
expressions:
items:
properties:
field_name:
order: 1
title: "fieldName"
type: "string"
filter:
oneOf:
- properties:
caseSensitive:
order: 2
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "stringFilter"
type: "string"
enum:
- "stringFilter"
matchType:
items:
enum:
- "MATCH_TYPE_UNSPECIFIED"
- "EXACT"
- "BEGINS_WITH"
- "ENDS_WITH"
- "CONTAINS"
- "FULL_REGEXP"
- "PARTIAL_REGEXP"
title: "ValidEnums"
order: 1
title: "matchType"
type: "array"
value:
order: 0
tittle: "value"
type: "string"
required:
- "filter_name"
- "value"
title: "stringFilter"
type: "object"
- properties:
caseSensitive:
order: 1
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "inListFilter"
type: "string"
enum:
- "inListFilter"
values:
items:
type: "string"
minItems: 1
order: 0
tittle: "values"
type: "array"
required:
- "filter_name"
- "values"
title: "inListFilter"
type: "object"
- properties:
filter_name:
const: "numericFilter"
type: "string"
enum:
- "numericFilter"
operation:
items:
enum:
- "OPERATION_UNSPECIFIED"
- "EQUAL"
- "LESS_THAN"
- "LESS_THAN_OR_EQUAL"
- "GREATER_THAN"
- "GREATER_THAN_OR_EQUAL"
title: "ValidEnums"
order: 1
title: "operation"
type: "array"
value:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "value"
type: "object"
required:
- "filter_name"
- "operation"
- "value"
title: "numericFilter"
type: "object"
- properties:
filter_name:
const: "betweenFilter"
type: "string"
enum:
- "betweenFilter"
fromValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "fromValue"
type: "object"
toValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 1
tittle: "toValue"
type: "object"
required:
- "filter_name"
- "fromValue"
- "toValue"
title: "betweenFilter"
type: "object"
order: 2
title: "filter"
type: "object"
required:
- "field_name"
- "filter"
title: "Expression"
type: "object"
order: 1
title: "Expressions"
type: "array"
filter_type:
const: "andGroup"
order: 0
type: "string"
enum:
- "andGroup"
required:
- "filter_type"
- "expressions"
title: "andGroup"
type: "object"
- description: "The FilterExpressions in orGroup have an OR relationship."
properties:
expressions:
items:
properties:
field_name:
order: 1
title: "fieldName"
type: "string"
filter:
oneOf:
- properties:
caseSensitive:
order: 2
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "stringFilter"
type: "string"
enum:
- "stringFilter"
matchType:
items:
enum:
- "MATCH_TYPE_UNSPECIFIED"
- "EXACT"
- "BEGINS_WITH"
- "ENDS_WITH"
- "CONTAINS"
- "FULL_REGEXP"
- "PARTIAL_REGEXP"
title: "ValidEnums"
order: 1
title: "matchType"
type: "array"
value:
order: 0
tittle: "value"
type: "string"
required:
- "filter_name"
- "value"
title: "stringFilter"
type: "object"
- properties:
caseSensitive:
order: 1
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "inListFilter"
type: "string"
enum:
- "inListFilter"
values:
items:
type: "string"
minItems: 1
order: 0
tittle: "values"
type: "array"
required:
- "filter_name"
- "values"
title: "inListFilter"
type: "object"
- properties:
filter_name:
const: "numericFilter"
type: "string"
enum:
- "numericFilter"
operation:
items:
enum:
- "OPERATION_UNSPECIFIED"
- "EQUAL"
- "LESS_THAN"
- "LESS_THAN_OR_EQUAL"
- "GREATER_THAN"
- "GREATER_THAN_OR_EQUAL"
title: "ValidEnums"
order: 1
title: "operation"
type: "array"
value:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "value"
type: "object"
required:
- "filter_name"
- "operation"
- "value"
title: "numericFilter"
type: "object"
- properties:
filter_name:
const: "betweenFilter"
type: "string"
enum:
- "betweenFilter"
fromValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "fromValue"
type: "object"
toValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 1
tittle: "toValue"
type: "object"
required:
- "filter_name"
- "fromValue"
- "toValue"
title: "betweenFilter"
type: "object"
order: 2
title: "filter"
type: "object"
required:
- "field_name"
- "filter"
title: "Expression"
type: "object"
order: 1
title: "Expressions"
type: "array"
filter_type:
const: "orGroup"
order: 0
type: "string"
enum:
- "orGroup"
required:
- "filter_type"
- "expressions"
title: "orGroup"
type: "object"
- description: "The FilterExpression is NOT of notExpression."
properties:
expression:
properties:
field_name:
order: 1
title: "fieldName"
type: "string"
filter:
oneOf:
- properties:
caseSensitive:
order: 2
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "stringFilter"
type: "string"
enum:
- "stringFilter"
matchType:
items:
enum:
- "MATCH_TYPE_UNSPECIFIED"
- "EXACT"
- "BEGINS_WITH"
- "ENDS_WITH"
- "CONTAINS"
- "FULL_REGEXP"
- "PARTIAL_REGEXP"
title: "ValidEnums"
order: 1
title: "matchType"
type: "array"
value:
order: 0
tittle: "value"
type: "string"
required:
- "filter_name"
- "value"
title: "stringFilter"
type: "object"
- properties:
caseSensitive:
order: 1
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "inListFilter"
type: "string"
enum:
- "inListFilter"
values:
items:
type: "string"
minItems: 1
order: 0
tittle: "values"
type: "array"
required:
- "filter_name"
- "values"
title: "inListFilter"
type: "object"
- properties:
filter_name:
const: "numericFilter"
type: "string"
enum:
- "numericFilter"
operation:
items:
enum:
- "OPERATION_UNSPECIFIED"
- "EQUAL"
- "LESS_THAN"
- "LESS_THAN_OR_EQUAL"
- "GREATER_THAN"
- "GREATER_THAN_OR_EQUAL"
title: "ValidEnums"
order: 1
title: "operation"
type: "array"
value:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "value"
type: "object"
required:
- "filter_name"
- "operation"
- "value"
title: "numericFilter"
type: "object"
- properties:
filter_name:
const: "betweenFilter"
type: "string"
enum:
- "betweenFilter"
fromValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "fromValue"
type: "object"
toValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 1
tittle: "toValue"
type: "object"
required:
- "filter_name"
- "fromValue"
- "toValue"
title: "betweenFilter"
type: "object"
order: 2
title: "filter"
type: "object"
required:
- "field_name"
- "filter"
title: "Expression"
type: "object"
filter_type:
const: "notExpression"
order: 0
type: "string"
enum:
- "notExpression"
title: "notExpression"
type: "object"
- description: "A primitive filter. In the same FilterExpression,\
\ all of the filter's field names need to be either all dimensions."
properties:
field_name:
order: 1
title: "fieldName"
type: "string"
filter:
oneOf:
- properties:
caseSensitive:
order: 2
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "stringFilter"
type: "string"
enum:
- "stringFilter"
matchType:
items:
enum:
- "MATCH_TYPE_UNSPECIFIED"
- "EXACT"
- "BEGINS_WITH"
- "ENDS_WITH"
- "CONTAINS"
- "FULL_REGEXP"
- "PARTIAL_REGEXP"
title: "ValidEnums"
order: 1
title: "matchType"
type: "array"
value:
order: 0
tittle: "value"
type: "string"
required:
- "filter_name"
- "value"
title: "stringFilter"
type: "object"
- properties:
caseSensitive:
order: 1
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "inListFilter"
type: "string"
enum:
- "inListFilter"
values:
items:
type: "string"
minItems: 1
order: 0
tittle: "values"
type: "array"
required:
- "filter_name"
- "values"
title: "inListFilter"
type: "object"
- properties:
filter_name:
const: "numericFilter"
type: "string"
enum:
- "numericFilter"
operation:
items:
enum:
- "OPERATION_UNSPECIFIED"
- "EQUAL"
- "LESS_THAN"
- "LESS_THAN_OR_EQUAL"
- "GREATER_THAN"
- "GREATER_THAN_OR_EQUAL"
title: "ValidEnums"
order: 1
title: "operation"
type: "array"
value:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "value"
type: "object"
required:
- "filter_name"
- "operation"
- "value"
title: "numericFilter"
type: "object"
- properties:
filter_name:
const: "betweenFilter"
type: "string"
enum:
- "betweenFilter"
fromValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "fromValue"
type: "object"
toValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 1
tittle: "toValue"
type: "object"
required:
- "filter_name"
- "fromValue"
- "toValue"
title: "betweenFilter"
type: "object"
order: 2
title: "filter"
type: "object"
filter_type:
const: "filter"
order: 0
type: "string"
enum:
- "filter"
required:
- "field_name"
- "filter"
title: "filter"
type: "object"
order: 3
title: "Dimensions filter"
type: "object"
dimensions:
description: "A list of dimensions."
items:
type: "string"
minItems: 1
order: 1
title: "Dimensions"
type: "array"
metricFilter:
description: "Metrics filter"
oneOf:
- description: "The FilterExpressions in andGroup have an AND relationship."
properties:
expressions:
items:
properties:
field_name:
order: 1
title: "fieldName"
type: "string"
filter:
oneOf:
- properties:
caseSensitive:
order: 2
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "stringFilter"
type: "string"
enum:
- "stringFilter"
matchType:
items:
enum:
- "MATCH_TYPE_UNSPECIFIED"
- "EXACT"
- "BEGINS_WITH"
- "ENDS_WITH"
- "CONTAINS"
- "FULL_REGEXP"
- "PARTIAL_REGEXP"
title: "ValidEnums"
order: 1
title: "matchType"
type: "array"
value:
order: 0
tittle: "value"
type: "string"
required:
- "filter_name"
- "value"
title: "stringFilter"
type: "object"
- properties:
caseSensitive:
order: 1
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "inListFilter"
type: "string"
enum:
- "inListFilter"
values:
items:
type: "string"
minItems: 1
order: 0
tittle: "values"
type: "array"
required:
- "filter_name"
- "values"
title: "inListFilter"
type: "object"
- properties:
filter_name:
const: "numericFilter"
type: "string"
enum:
- "numericFilter"
operation:
items:
enum:
- "OPERATION_UNSPECIFIED"
- "EQUAL"
- "LESS_THAN"
- "LESS_THAN_OR_EQUAL"
- "GREATER_THAN"
- "GREATER_THAN_OR_EQUAL"
title: "ValidEnums"
order: 1
title: "operation"
type: "array"
value:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "value"
type: "object"
required:
- "filter_name"
- "operation"
- "value"
title: "numericFilter"
type: "object"
- properties:
filter_name:
const: "betweenFilter"
type: "string"
enum:
- "betweenFilter"
fromValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "fromValue"
type: "object"
toValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 1
tittle: "toValue"
type: "object"
required:
- "filter_name"
- "fromValue"
- "toValue"
title: "betweenFilter"
type: "object"
order: 2
title: "filter"
type: "object"
required:
- "field_name"
- "filter"
title: "Expression"
type: "object"
order: 1
title: "Expressions"
type: "array"
filter_type:
const: "andGroup"
order: 0
type: "string"
enum:
- "andGroup"
required:
- "filter_type"
- "expressions"
title: "andGroup"
type: "object"
- description: "The FilterExpressions in orGroup have an OR relationship."
properties:
expressions:
items:
properties:
field_name:
order: 1
title: "fieldName"
type: "string"
filter:
oneOf:
- properties:
caseSensitive:
order: 2
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "stringFilter"
type: "string"
enum:
- "stringFilter"
matchType:
items:
enum:
- "MATCH_TYPE_UNSPECIFIED"
- "EXACT"
- "BEGINS_WITH"
- "ENDS_WITH"
- "CONTAINS"
- "FULL_REGEXP"
- "PARTIAL_REGEXP"
title: "ValidEnums"
order: 1
title: "matchType"
type: "array"
value:
order: 0
tittle: "value"
type: "string"
required:
- "filter_name"
- "value"
title: "stringFilter"
type: "object"
- properties:
caseSensitive:
order: 1
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "inListFilter"
type: "string"
enum:
- "inListFilter"
values:
items:
type: "string"
minItems: 1
order: 0
tittle: "values"
type: "array"
required:
- "filter_name"
- "values"
title: "inListFilter"
type: "object"
- properties:
filter_name:
const: "numericFilter"
type: "string"
enum:
- "numericFilter"
operation:
items:
enum:
- "OPERATION_UNSPECIFIED"
- "EQUAL"
- "LESS_THAN"
- "LESS_THAN_OR_EQUAL"
- "GREATER_THAN"
- "GREATER_THAN_OR_EQUAL"
title: "ValidEnums"
order: 1
title: "operation"
type: "array"
value:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "value"
type: "object"
required:
- "filter_name"
- "operation"
- "value"
title: "numericFilter"
type: "object"
- properties:
filter_name:
const: "betweenFilter"
type: "string"
enum:
- "betweenFilter"
fromValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "fromValue"
type: "object"
toValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 1
tittle: "toValue"
type: "object"
required:
- "filter_name"
- "fromValue"
- "toValue"
title: "betweenFilter"
type: "object"
order: 2
title: "filter"
type: "object"
required:
- "field_name"
- "filter"
title: "Expression"
type: "object"
order: 1
title: "Expressions"
type: "array"
filter_type:
const: "orGroup"
order: 0
type: "string"
enum:
- "orGroup"
required:
- "filter_type"
- "expressions"
title: "orGroup"
type: "object"
- description: "The FilterExpression is NOT of notExpression."
properties:
expression:
properties:
field_name:
order: 1
title: "fieldName"
type: "string"
filter:
oneOf:
- properties:
caseSensitive:
order: 2
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "stringFilter"
type: "string"
enum:
- "stringFilter"
matchType:
items:
enum:
- "MATCH_TYPE_UNSPECIFIED"
- "EXACT"
- "BEGINS_WITH"
- "ENDS_WITH"
- "CONTAINS"
- "FULL_REGEXP"
- "PARTIAL_REGEXP"
title: "ValidEnums"
order: 1
title: "matchType"
type: "array"
value:
order: 0
tittle: "value"
type: "string"
required:
- "filter_name"
- "value"
title: "stringFilter"
type: "object"
- properties:
caseSensitive:
order: 1
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "inListFilter"
type: "string"
enum:
- "inListFilter"
values:
items:
type: "string"
minItems: 1
order: 0
tittle: "values"
type: "array"
required:
- "filter_name"
- "values"
title: "inListFilter"
type: "object"
- properties:
filter_name:
const: "numericFilter"
type: "string"
enum:
- "numericFilter"
operation:
items:
enum:
- "OPERATION_UNSPECIFIED"
- "EQUAL"
- "LESS_THAN"
- "LESS_THAN_OR_EQUAL"
- "GREATER_THAN"
- "GREATER_THAN_OR_EQUAL"
title: "ValidEnums"
order: 1
title: "operation"
type: "array"
value:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "value"
type: "object"
required:
- "filter_name"
- "operation"
- "value"
title: "numericFilter"
type: "object"
- properties:
filter_name:
const: "betweenFilter"
type: "string"
enum:
- "betweenFilter"
fromValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "fromValue"
type: "object"
toValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 1
tittle: "toValue"
type: "object"
required:
- "filter_name"
- "fromValue"
- "toValue"
title: "betweenFilter"
type: "object"
order: 2
title: "filter"
type: "object"
required:
- "field_name"
- "filter"
title: "Expression"
type: "object"
filter_type:
const: "notExpression"
order: 0
type: "string"
enum:
- "notExpression"
title: "notExpression"
type: "object"
- description: "A primitive filter. In the same FilterExpression,\
\ all of the filter's field names need to be either all metrics."
properties:
field_name:
order: 1
title: "fieldName"
type: "string"
filter:
oneOf:
- properties:
caseSensitive:
order: 2
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "stringFilter"
type: "string"
enum:
- "stringFilter"
matchType:
items:
enum:
- "MATCH_TYPE_UNSPECIFIED"
- "EXACT"
- "BEGINS_WITH"
- "ENDS_WITH"
- "CONTAINS"
- "FULL_REGEXP"
- "PARTIAL_REGEXP"
title: "ValidEnums"
order: 1
title: "matchType"
type: "array"
value:
order: 0
tittle: "value"
type: "string"
required:
- "filter_name"
- "value"
title: "stringFilter"
type: "object"
- properties:
caseSensitive:
order: 1
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "inListFilter"
type: "string"
enum:
- "inListFilter"
values:
items:
type: "string"
minItems: 1
order: 0
tittle: "values"
type: "array"
required:
- "filter_name"
- "values"
title: "inListFilter"
type: "object"
- properties:
filter_name:
const: "numericFilter"
type: "string"
enum:
- "numericFilter"
operation:
items:
enum:
- "OPERATION_UNSPECIFIED"
- "EQUAL"
- "LESS_THAN"
- "LESS_THAN_OR_EQUAL"
- "GREATER_THAN"
- "GREATER_THAN_OR_EQUAL"
title: "ValidEnums"
order: 1
title: "operation"
type: "array"
value:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "value"
type: "object"
required:
- "filter_name"
- "operation"
- "value"
title: "numericFilter"
type: "object"
- properties:
filter_name:
const: "betweenFilter"
type: "string"
enum:
- "betweenFilter"
fromValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "fromValue"
type: "object"
toValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 1
tittle: "toValue"
type: "object"
required:
- "filter_name"
- "fromValue"
- "toValue"
title: "betweenFilter"
type: "object"
order: 2
title: "filter"
type: "object"
filter_type:
const: "filter"
order: 0
type: "string"
enum:
- "filter"
required:
- "field_name"
- "filter"
title: "filter"
type: "object"
order: 4
title: "Metrics filter"
type: "object"
metrics:
description: "A list of metrics."
items:
type: "string"
minItems: 1
order: 2
title: "Metrics"
type: "array"
name:
description: "The name of the custom report, this name would be used\
\ as stream name."
order: 0
title: "Name"
type: "string"
required:
- "name"
- "dimensions"
- "metrics"
title: "Custom Report Config"
type: "object"
order: 4
title: "Custom Reports"
type: "array"
date_ranges_end_date:
description: "The end date from which to replicate report data in the format\
\ YYYY-MM-DD. Data generated after this date will not be included in the\
\ report. Not applied to custom Cohort reports. When no date is provided\
\ or the date is in the future, the date from today is used."
examples:
- "2021-01-31"
format: "date"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
pattern_descriptor: "YYYY-MM-DD"
title: "End Date"
type: "string"
date_ranges_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."
examples:
- "2021-01-01"
format: "date"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
pattern_descriptor: "YYYY-MM-DD"
title: "Start Date"
type: "string"
keep_empty_rows:
default: false
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."
order: 7
title: "Keep Empty Rows"
type: "boolean"
lookback_window:
default: 2
description: "Since attribution changes after the event date, and Google\
\ Analytics has a data processing latency, we should specify how many\
\ days in the past we should refresh the data in every run. So if you\
\ set it at 5 days, in every sync it will fetch the last bookmark date\
\ minus 5 days."
examples:
- 2
- 3
- 4
- 7
- 14
- 28
maximum: 60
minimum: 2
order: 6
title: "Lookback window (Days)"
type: "integer"
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."
examples:
- - "1738294"
- "5729978930"
items:
pattern: "^[0-9]*$"
type: "string"
order: 1
title: "Property IDs"
type: "array"
uniqueItems: true
window_in_days:
default: 1
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
maximum: 364
minimum: 1
order: 5
title: "Data Request Interval (Days)"
type: "integer"
sourceType:
title: "google-analytics-data-api"
const: "google-analytics-data-api"
enum:
- "google-analytics-data-api"
order: 0
type: "string"
required:
- "property_ids"
- "sourceType"
title: "Google Analytics (Data API) Spec"
type: "object"
source-google-analytics-data-api-update:
properties:
convert_conversions_event:
default: false
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."
order: 8
title: "Convert `conversions:*` Metrics to Float"
type: "boolean"
credentials:
description: "Credentials for the service"
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests."
order: 4
title: "Access Token"
type: "string"
auth_type:
const: "Client"
order: 0
type: "string"
enum:
- "Client"
client_id:
description: "The Client ID of your Google Analytics developer application."
order: 1
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Google Analytics developer\
\ application."
order: 2
title: "Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "The token for obtaining a new access token."
order: 3
title: "Refresh Token"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
title: "Authenticate via Google (Oauth)"
type: "object"
- properties:
auth_type:
const: "Service"
order: 0
type: "string"
enum:
- "Service"
credentials_json:
airbyte_secret: true
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, ... }"
order: 1
title: "Service Account JSON Key"
type: "string"
required:
- "credentials_json"
title: "Service Account Key Authentication"
type: "object"
order: 0
title: "Credentials"
type: "object"
custom_reports_array:
description: "You can add your Custom Analytics report by creating one."
items:
properties:
cohortSpec:
description: "Cohort reports creates a time series of user retention\
\ for the cohort."
oneOf:
- properties:
enabled:
const: "false"
type: "string"
enum:
- "false"
title: "Disabled"
type: "object"
- properties:
cohortReportSettings:
description: "Optional settings for a cohort report."
properties:
accumulate:
always_show: true
description: "If true, accumulates the result from first\
\ touch day to the end day"
title: "Accumulate"
type: "boolean"
title: "Cohort Report Settings"
type: "object"
cohorts:
always_show: true
items:
properties:
dateRange:
properties:
endDate:
examples:
- "2021-01-01"
format: "date"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
pattern_descriptor: "YYYY-MM-DD"
title: "End Date"
type: "string"
startDate:
examples:
- "2021-01-01"
format: "date"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
pattern_descriptor: "YYYY-MM-DD"
title: "Start Date"
type: "string"
required:
- "startDate"
- "endDate"
type: "object"
dimension:
description: "Dimension used by the cohort. Required and\
\ only supports `firstSessionDate`"
enum:
- "firstSessionDate"
order: 1
title: "Dimension"
type: "string"
name:
always_show: true
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
pattern: "^(?!(cohort_|RESERVED_)).*$"
title: "Name"
type: "string"
required:
- "dimension"
- "dateRange"
title: "Cohorts"
type: "object"
name: "Cohorts"
order: 0
type: "array"
cohortsRange:
order: 1
properties:
endOffset:
description: "Specifies the end date of the extended reporting\
\ date range for a cohort report."
minimum: 0
order: 2
title: "End Offset"
type: "integer"
granularity:
description: "The granularity used to interpret the startOffset\
\ and endOffset for the extended reporting date range\
\ for a cohort report."
enum:
- "GRANULARITY_UNSPECIFIED"
- "DAILY"
- "WEEKLY"
- "MONTHLY"
order: 0
title: "Granularity"
type: "string"
startOffset:
description: "Specifies the start date of the extended reporting\
\ date range for a cohort report."
minimum: 0
order: 1
title: "Start Offset"
type: "integer"
required:
- "granularity"
- "endOffset"
type: "object"
enabled:
const: "true"
type: "string"
enum:
- "true"
title: "Enabled"
type: "object"
order: 5
title: "Cohort Reports"
type: "object"
dimensionFilter:
description: "Dimensions filter"
oneOf:
- description: "The FilterExpressions in andGroup have an AND relationship."
properties:
expressions:
items:
properties:
field_name:
order: 1
title: "fieldName"
type: "string"
filter:
oneOf:
- properties:
caseSensitive:
order: 2
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "stringFilter"
type: "string"
enum:
- "stringFilter"
matchType:
items:
enum:
- "MATCH_TYPE_UNSPECIFIED"
- "EXACT"
- "BEGINS_WITH"
- "ENDS_WITH"
- "CONTAINS"
- "FULL_REGEXP"
- "PARTIAL_REGEXP"
title: "ValidEnums"
order: 1
title: "matchType"
type: "array"
value:
order: 0
tittle: "value"
type: "string"
required:
- "filter_name"
- "value"
title: "stringFilter"
type: "object"
- properties:
caseSensitive:
order: 1
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "inListFilter"
type: "string"
enum:
- "inListFilter"
values:
items:
type: "string"
minItems: 1
order: 0
tittle: "values"
type: "array"
required:
- "filter_name"
- "values"
title: "inListFilter"
type: "object"
- properties:
filter_name:
const: "numericFilter"
type: "string"
enum:
- "numericFilter"
operation:
items:
enum:
- "OPERATION_UNSPECIFIED"
- "EQUAL"
- "LESS_THAN"
- "LESS_THAN_OR_EQUAL"
- "GREATER_THAN"
- "GREATER_THAN_OR_EQUAL"
title: "ValidEnums"
order: 1
title: "operation"
type: "array"
value:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "value"
type: "object"
required:
- "filter_name"
- "operation"
- "value"
title: "numericFilter"
type: "object"
- properties:
filter_name:
const: "betweenFilter"
type: "string"
enum:
- "betweenFilter"
fromValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "fromValue"
type: "object"
toValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 1
tittle: "toValue"
type: "object"
required:
- "filter_name"
- "fromValue"
- "toValue"
title: "betweenFilter"
type: "object"
order: 2
title: "filter"
type: "object"
required:
- "field_name"
- "filter"
title: "Expression"
type: "object"
order: 1
title: "Expressions"
type: "array"
filter_type:
const: "andGroup"
order: 0
type: "string"
enum:
- "andGroup"
required:
- "filter_type"
- "expressions"
title: "andGroup"
type: "object"
- description: "The FilterExpressions in orGroup have an OR relationship."
properties:
expressions:
items:
properties:
field_name:
order: 1
title: "fieldName"
type: "string"
filter:
oneOf:
- properties:
caseSensitive:
order: 2
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "stringFilter"
type: "string"
enum:
- "stringFilter"
matchType:
items:
enum:
- "MATCH_TYPE_UNSPECIFIED"
- "EXACT"
- "BEGINS_WITH"
- "ENDS_WITH"
- "CONTAINS"
- "FULL_REGEXP"
- "PARTIAL_REGEXP"
title: "ValidEnums"
order: 1
title: "matchType"
type: "array"
value:
order: 0
tittle: "value"
type: "string"
required:
- "filter_name"
- "value"
title: "stringFilter"
type: "object"
- properties:
caseSensitive:
order: 1
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "inListFilter"
type: "string"
enum:
- "inListFilter"
values:
items:
type: "string"
minItems: 1
order: 0
tittle: "values"
type: "array"
required:
- "filter_name"
- "values"
title: "inListFilter"
type: "object"
- properties:
filter_name:
const: "numericFilter"
type: "string"
enum:
- "numericFilter"
operation:
items:
enum:
- "OPERATION_UNSPECIFIED"
- "EQUAL"
- "LESS_THAN"
- "LESS_THAN_OR_EQUAL"
- "GREATER_THAN"
- "GREATER_THAN_OR_EQUAL"
title: "ValidEnums"
order: 1
title: "operation"
type: "array"
value:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "value"
type: "object"
required:
- "filter_name"
- "operation"
- "value"
title: "numericFilter"
type: "object"
- properties:
filter_name:
const: "betweenFilter"
type: "string"
enum:
- "betweenFilter"
fromValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "fromValue"
type: "object"
toValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 1
tittle: "toValue"
type: "object"
required:
- "filter_name"
- "fromValue"
- "toValue"
title: "betweenFilter"
type: "object"
order: 2
title: "filter"
type: "object"
required:
- "field_name"
- "filter"
title: "Expression"
type: "object"
order: 1
title: "Expressions"
type: "array"
filter_type:
const: "orGroup"
order: 0
type: "string"
enum:
- "orGroup"
required:
- "filter_type"
- "expressions"
title: "orGroup"
type: "object"
- description: "The FilterExpression is NOT of notExpression."
properties:
expression:
properties:
field_name:
order: 1
title: "fieldName"
type: "string"
filter:
oneOf:
- properties:
caseSensitive:
order: 2
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "stringFilter"
type: "string"
enum:
- "stringFilter"
matchType:
items:
enum:
- "MATCH_TYPE_UNSPECIFIED"
- "EXACT"
- "BEGINS_WITH"
- "ENDS_WITH"
- "CONTAINS"
- "FULL_REGEXP"
- "PARTIAL_REGEXP"
title: "ValidEnums"
order: 1
title: "matchType"
type: "array"
value:
order: 0
tittle: "value"
type: "string"
required:
- "filter_name"
- "value"
title: "stringFilter"
type: "object"
- properties:
caseSensitive:
order: 1
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "inListFilter"
type: "string"
enum:
- "inListFilter"
values:
items:
type: "string"
minItems: 1
order: 0
tittle: "values"
type: "array"
required:
- "filter_name"
- "values"
title: "inListFilter"
type: "object"
- properties:
filter_name:
const: "numericFilter"
type: "string"
enum:
- "numericFilter"
operation:
items:
enum:
- "OPERATION_UNSPECIFIED"
- "EQUAL"
- "LESS_THAN"
- "LESS_THAN_OR_EQUAL"
- "GREATER_THAN"
- "GREATER_THAN_OR_EQUAL"
title: "ValidEnums"
order: 1
title: "operation"
type: "array"
value:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "value"
type: "object"
required:
- "filter_name"
- "operation"
- "value"
title: "numericFilter"
type: "object"
- properties:
filter_name:
const: "betweenFilter"
type: "string"
enum:
- "betweenFilter"
fromValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "fromValue"
type: "object"
toValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 1
tittle: "toValue"
type: "object"
required:
- "filter_name"
- "fromValue"
- "toValue"
title: "betweenFilter"
type: "object"
order: 2
title: "filter"
type: "object"
required:
- "field_name"
- "filter"
title: "Expression"
type: "object"
filter_type:
const: "notExpression"
order: 0
type: "string"
enum:
- "notExpression"
title: "notExpression"
type: "object"
- description: "A primitive filter. In the same FilterExpression,\
\ all of the filter's field names need to be either all dimensions."
properties:
field_name:
order: 1
title: "fieldName"
type: "string"
filter:
oneOf:
- properties:
caseSensitive:
order: 2
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "stringFilter"
type: "string"
enum:
- "stringFilter"
matchType:
items:
enum:
- "MATCH_TYPE_UNSPECIFIED"
- "EXACT"
- "BEGINS_WITH"
- "ENDS_WITH"
- "CONTAINS"
- "FULL_REGEXP"
- "PARTIAL_REGEXP"
title: "ValidEnums"
order: 1
title: "matchType"
type: "array"
value:
order: 0
tittle: "value"
type: "string"
required:
- "filter_name"
- "value"
title: "stringFilter"
type: "object"
- properties:
caseSensitive:
order: 1
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "inListFilter"
type: "string"
enum:
- "inListFilter"
values:
items:
type: "string"
minItems: 1
order: 0
tittle: "values"
type: "array"
required:
- "filter_name"
- "values"
title: "inListFilter"
type: "object"
- properties:
filter_name:
const: "numericFilter"
type: "string"
enum:
- "numericFilter"
operation:
items:
enum:
- "OPERATION_UNSPECIFIED"
- "EQUAL"
- "LESS_THAN"
- "LESS_THAN_OR_EQUAL"
- "GREATER_THAN"
- "GREATER_THAN_OR_EQUAL"
title: "ValidEnums"
order: 1
title: "operation"
type: "array"
value:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "value"
type: "object"
required:
- "filter_name"
- "operation"
- "value"
title: "numericFilter"
type: "object"
- properties:
filter_name:
const: "betweenFilter"
type: "string"
enum:
- "betweenFilter"
fromValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "fromValue"
type: "object"
toValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 1
tittle: "toValue"
type: "object"
required:
- "filter_name"
- "fromValue"
- "toValue"
title: "betweenFilter"
type: "object"
order: 2
title: "filter"
type: "object"
filter_type:
const: "filter"
order: 0
type: "string"
enum:
- "filter"
required:
- "field_name"
- "filter"
title: "filter"
type: "object"
order: 3
title: "Dimensions filter"
type: "object"
dimensions:
description: "A list of dimensions."
items:
type: "string"
minItems: 1
order: 1
title: "Dimensions"
type: "array"
metricFilter:
description: "Metrics filter"
oneOf:
- description: "The FilterExpressions in andGroup have an AND relationship."
properties:
expressions:
items:
properties:
field_name:
order: 1
title: "fieldName"
type: "string"
filter:
oneOf:
- properties:
caseSensitive:
order: 2
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "stringFilter"
type: "string"
enum:
- "stringFilter"
matchType:
items:
enum:
- "MATCH_TYPE_UNSPECIFIED"
- "EXACT"
- "BEGINS_WITH"
- "ENDS_WITH"
- "CONTAINS"
- "FULL_REGEXP"
- "PARTIAL_REGEXP"
title: "ValidEnums"
order: 1
title: "matchType"
type: "array"
value:
order: 0
tittle: "value"
type: "string"
required:
- "filter_name"
- "value"
title: "stringFilter"
type: "object"
- properties:
caseSensitive:
order: 1
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "inListFilter"
type: "string"
enum:
- "inListFilter"
values:
items:
type: "string"
minItems: 1
order: 0
tittle: "values"
type: "array"
required:
- "filter_name"
- "values"
title: "inListFilter"
type: "object"
- properties:
filter_name:
const: "numericFilter"
type: "string"
enum:
- "numericFilter"
operation:
items:
enum:
- "OPERATION_UNSPECIFIED"
- "EQUAL"
- "LESS_THAN"
- "LESS_THAN_OR_EQUAL"
- "GREATER_THAN"
- "GREATER_THAN_OR_EQUAL"
title: "ValidEnums"
order: 1
title: "operation"
type: "array"
value:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "value"
type: "object"
required:
- "filter_name"
- "operation"
- "value"
title: "numericFilter"
type: "object"
- properties:
filter_name:
const: "betweenFilter"
type: "string"
enum:
- "betweenFilter"
fromValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "fromValue"
type: "object"
toValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 1
tittle: "toValue"
type: "object"
required:
- "filter_name"
- "fromValue"
- "toValue"
title: "betweenFilter"
type: "object"
order: 2
title: "filter"
type: "object"
required:
- "field_name"
- "filter"
title: "Expression"
type: "object"
order: 1
title: "Expressions"
type: "array"
filter_type:
const: "andGroup"
order: 0
type: "string"
enum:
- "andGroup"
required:
- "filter_type"
- "expressions"
title: "andGroup"
type: "object"
- description: "The FilterExpressions in orGroup have an OR relationship."
properties:
expressions:
items:
properties:
field_name:
order: 1
title: "fieldName"
type: "string"
filter:
oneOf:
- properties:
caseSensitive:
order: 2
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "stringFilter"
type: "string"
enum:
- "stringFilter"
matchType:
items:
enum:
- "MATCH_TYPE_UNSPECIFIED"
- "EXACT"
- "BEGINS_WITH"
- "ENDS_WITH"
- "CONTAINS"
- "FULL_REGEXP"
- "PARTIAL_REGEXP"
title: "ValidEnums"
order: 1
title: "matchType"
type: "array"
value:
order: 0
tittle: "value"
type: "string"
required:
- "filter_name"
- "value"
title: "stringFilter"
type: "object"
- properties:
caseSensitive:
order: 1
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "inListFilter"
type: "string"
enum:
- "inListFilter"
values:
items:
type: "string"
minItems: 1
order: 0
tittle: "values"
type: "array"
required:
- "filter_name"
- "values"
title: "inListFilter"
type: "object"
- properties:
filter_name:
const: "numericFilter"
type: "string"
enum:
- "numericFilter"
operation:
items:
enum:
- "OPERATION_UNSPECIFIED"
- "EQUAL"
- "LESS_THAN"
- "LESS_THAN_OR_EQUAL"
- "GREATER_THAN"
- "GREATER_THAN_OR_EQUAL"
title: "ValidEnums"
order: 1
title: "operation"
type: "array"
value:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "value"
type: "object"
required:
- "filter_name"
- "operation"
- "value"
title: "numericFilter"
type: "object"
- properties:
filter_name:
const: "betweenFilter"
type: "string"
enum:
- "betweenFilter"
fromValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "fromValue"
type: "object"
toValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 1
tittle: "toValue"
type: "object"
required:
- "filter_name"
- "fromValue"
- "toValue"
title: "betweenFilter"
type: "object"
order: 2
title: "filter"
type: "object"
required:
- "field_name"
- "filter"
title: "Expression"
type: "object"
order: 1
title: "Expressions"
type: "array"
filter_type:
const: "orGroup"
order: 0
type: "string"
enum:
- "orGroup"
required:
- "filter_type"
- "expressions"
title: "orGroup"
type: "object"
- description: "The FilterExpression is NOT of notExpression."
properties:
expression:
properties:
field_name:
order: 1
title: "fieldName"
type: "string"
filter:
oneOf:
- properties:
caseSensitive:
order: 2
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "stringFilter"
type: "string"
enum:
- "stringFilter"
matchType:
items:
enum:
- "MATCH_TYPE_UNSPECIFIED"
- "EXACT"
- "BEGINS_WITH"
- "ENDS_WITH"
- "CONTAINS"
- "FULL_REGEXP"
- "PARTIAL_REGEXP"
title: "ValidEnums"
order: 1
title: "matchType"
type: "array"
value:
order: 0
tittle: "value"
type: "string"
required:
- "filter_name"
- "value"
title: "stringFilter"
type: "object"
- properties:
caseSensitive:
order: 1
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "inListFilter"
type: "string"
enum:
- "inListFilter"
values:
items:
type: "string"
minItems: 1
order: 0
tittle: "values"
type: "array"
required:
- "filter_name"
- "values"
title: "inListFilter"
type: "object"
- properties:
filter_name:
const: "numericFilter"
type: "string"
enum:
- "numericFilter"
operation:
items:
enum:
- "OPERATION_UNSPECIFIED"
- "EQUAL"
- "LESS_THAN"
- "LESS_THAN_OR_EQUAL"
- "GREATER_THAN"
- "GREATER_THAN_OR_EQUAL"
title: "ValidEnums"
order: 1
title: "operation"
type: "array"
value:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "value"
type: "object"
required:
- "filter_name"
- "operation"
- "value"
title: "numericFilter"
type: "object"
- properties:
filter_name:
const: "betweenFilter"
type: "string"
enum:
- "betweenFilter"
fromValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "fromValue"
type: "object"
toValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 1
tittle: "toValue"
type: "object"
required:
- "filter_name"
- "fromValue"
- "toValue"
title: "betweenFilter"
type: "object"
order: 2
title: "filter"
type: "object"
required:
- "field_name"
- "filter"
title: "Expression"
type: "object"
filter_type:
const: "notExpression"
order: 0
type: "string"
enum:
- "notExpression"
title: "notExpression"
type: "object"
- description: "A primitive filter. In the same FilterExpression,\
\ all of the filter's field names need to be either all metrics."
properties:
field_name:
order: 1
title: "fieldName"
type: "string"
filter:
oneOf:
- properties:
caseSensitive:
order: 2
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "stringFilter"
type: "string"
enum:
- "stringFilter"
matchType:
items:
enum:
- "MATCH_TYPE_UNSPECIFIED"
- "EXACT"
- "BEGINS_WITH"
- "ENDS_WITH"
- "CONTAINS"
- "FULL_REGEXP"
- "PARTIAL_REGEXP"
title: "ValidEnums"
order: 1
title: "matchType"
type: "array"
value:
order: 0
tittle: "value"
type: "string"
required:
- "filter_name"
- "value"
title: "stringFilter"
type: "object"
- properties:
caseSensitive:
order: 1
tittle: "caseSensitive"
type: "boolean"
filter_name:
const: "inListFilter"
type: "string"
enum:
- "inListFilter"
values:
items:
type: "string"
minItems: 1
order: 0
tittle: "values"
type: "array"
required:
- "filter_name"
- "values"
title: "inListFilter"
type: "object"
- properties:
filter_name:
const: "numericFilter"
type: "string"
enum:
- "numericFilter"
operation:
items:
enum:
- "OPERATION_UNSPECIFIED"
- "EQUAL"
- "LESS_THAN"
- "LESS_THAN_OR_EQUAL"
- "GREATER_THAN"
- "GREATER_THAN_OR_EQUAL"
title: "ValidEnums"
order: 1
title: "operation"
type: "array"
value:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "value"
type: "object"
required:
- "filter_name"
- "operation"
- "value"
title: "numericFilter"
type: "object"
- properties:
filter_name:
const: "betweenFilter"
type: "string"
enum:
- "betweenFilter"
fromValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 0
tittle: "fromValue"
type: "object"
toValue:
oneOf:
- properties:
value:
type: "string"
value_type:
const: "int64Value"
type: "string"
enum:
- "int64Value"
required:
- "value_type"
- "value"
title: "int64Value"
type: "object"
- properties:
value:
type: "number"
value_type:
const: "doubleValue"
type: "string"
enum:
- "doubleValue"
required:
- "value_type"
- "value"
title: "doubleValue"
type: "object"
order: 1
tittle: "toValue"
type: "object"
required:
- "filter_name"
- "fromValue"
- "toValue"
title: "betweenFilter"
type: "object"
order: 2
title: "filter"
type: "object"
filter_type:
const: "filter"
order: 0
type: "string"
enum:
- "filter"
required:
- "field_name"
- "filter"
title: "filter"
type: "object"
order: 4
title: "Metrics filter"
type: "object"
metrics:
description: "A list of metrics."
items:
type: "string"
minItems: 1
order: 2
title: "Metrics"
type: "array"
name:
description: "The name of the custom report, this name would be used\
\ as stream name."
order: 0
title: "Name"
type: "string"
required:
- "name"
- "dimensions"
- "metrics"
title: "Custom Report Config"
type: "object"
order: 4
title: "Custom Reports"
type: "array"
date_ranges_end_date:
description: "The end date from which to replicate report data in the format\
\ YYYY-MM-DD. Data generated after this date will not be included in the\
\ report. Not applied to custom Cohort reports. When no date is provided\
\ or the date is in the future, the date from today is used."
examples:
- "2021-01-31"
format: "date"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
pattern_descriptor: "YYYY-MM-DD"
title: "End Date"
type: "string"
date_ranges_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."
examples:
- "2021-01-01"
format: "date"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
pattern_descriptor: "YYYY-MM-DD"
title: "Start Date"
type: "string"
keep_empty_rows:
default: false
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."
order: 7
title: "Keep Empty Rows"
type: "boolean"
lookback_window:
default: 2
description: "Since attribution changes after the event date, and Google\
\ Analytics has a data processing latency, we should specify how many\
\ days in the past we should refresh the data in every run. So if you\
\ set it at 5 days, in every sync it will fetch the last bookmark date\
\ minus 5 days."
examples:
- 2
- 3
- 4
- 7
- 14
- 28
maximum: 60
minimum: 2
order: 6
title: "Lookback window (Days)"
type: "integer"
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."
examples:
- - "1738294"
- "5729978930"
items:
pattern: "^[0-9]*$"
type: "string"
order: 1
title: "Property IDs"
type: "array"
uniqueItems: true
window_in_days:
default: 1
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
maximum: 364
minimum: 1
order: 5
title: "Data Request Interval (Days)"
type: "integer"
required:
- "property_ids"
title: "Google Analytics (Data API) Spec"
type: "object"
source-timely:
properties:
account_id:
description: "The Account ID for your Timely account"
name: "account_id"
order: 0
title: "Account ID"
type: "string"
bearer_token:
airbyte_secret: true
description: "The Bearer Token for your Timely account"
order: 2
title: "Bearer Token"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "Earliest date from which you want to pull data from."
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
sourceType:
title: "timely"
const: "timely"
enum:
- "timely"
order: 0
type: "string"
required:
- "account_id"
- "start_date"
- "bearer_token"
- "sourceType"
type: "object"
source-timely-update:
properties:
account_id:
description: "The Account ID for your Timely account"
name: "account_id"
order: 0
title: "Account ID"
type: "string"
bearer_token:
airbyte_secret: true
description: "The Bearer Token for your Timely account"
order: 2
title: "Bearer Token"
type: "string"
start_date:
description: "Earliest date from which you want to pull data from."
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
required:
- "account_id"
- "start_date"
- "bearer_token"
type: "object"
source-mailgun:
properties:
domain_region:
default: "US"
description: "Domain region code. 'EU' or 'US' are possible values. The\
\ default is 'US'."
enum:
- "US"
- "EU"
order: 1
title: "Domain Region Code"
type: "string"
private_key:
airbyte_secret: true
description: "Primary account API key to access your Mailgun data."
order: 0
title: "Private API Key"
type: "string"
x-speakeasy-param-sensitive: true
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."
examples:
- "2023-08-01T00:00:00Z"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Replication Start Date"
type: "string"
sourceType:
title: "mailgun"
const: "mailgun"
enum:
- "mailgun"
order: 0
type: "string"
required:
- "private_key"
- "sourceType"
type: "object"
source-mailgun-update:
properties:
domain_region:
default: "US"
description: "Domain region code. 'EU' or 'US' are possible values. The\
\ default is 'US'."
enum:
- "US"
- "EU"
order: 1
title: "Domain Region Code"
type: "string"
private_key:
airbyte_secret: true
description: "Primary account API key to access your Mailgun data."
order: 0
title: "Private API Key"
type: "string"
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."
examples:
- "2023-08-01T00:00:00Z"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Replication Start Date"
type: "string"
required:
- "private_key"
type: "object"
source-intercom:
properties:
access_token:
airbyte_secret: true
description: "Access token for making authenticated requests. See the Intercom docs for more information."
order: 0
title: "Access token"
type: "string"
x-speakeasy-param-sensitive: true
activity_logs_time_step:
default: 30
description: "Set lower value in case of failing long running sync of Activity\
\ Logs stream."
examples:
- 30
- 10
- 5
maximum: 91
minimum: 1
order: 3
title: "Activity logs stream slice step size (in days)"
type: "integer"
client_id:
airbyte_secret: true
description: "Client Id for your Intercom application."
order: 1
title: "Client Id"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "Client Secret for your Intercom application."
order: 2
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
lookback_window:
default: 0
description: "The number of days to shift the state value backward for record\
\ sync"
examples:
- 60
minimum: 0
order: 4
title: "Lookback window"
type: "integer"
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"
format: "date-time"
order: 5
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "intercom"
const: "intercom"
enum:
- "intercom"
order: 0
type: "string"
required:
- "access_token"
- "start_date"
- "sourceType"
type: "object"
source-intercom-update:
properties:
access_token:
airbyte_secret: true
description: "Access token for making authenticated requests. See the Intercom docs for more information."
order: 0
title: "Access token"
type: "string"
activity_logs_time_step:
default: 30
description: "Set lower value in case of failing long running sync of Activity\
\ Logs stream."
examples:
- 30
- 10
- 5
maximum: 91
minimum: 1
order: 3
title: "Activity logs stream slice step size (in days)"
type: "integer"
client_id:
airbyte_secret: true
description: "Client Id for your Intercom application."
order: 1
title: "Client Id"
type: "string"
client_secret:
airbyte_secret: true
description: "Client Secret for your Intercom application."
order: 2
title: "Client Secret"
type: "string"
lookback_window:
default: 0
description: "The number of days to shift the state value backward for record\
\ sync"
examples:
- 60
minimum: 0
order: 4
title: "Lookback window"
type: "integer"
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"
format: "date-time"
order: 5
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "access_token"
- "start_date"
type: "object"
source-coassemble:
properties:
user_id:
airbyte_secret: true
order: 1
title: "User ID"
type: "string"
x-speakeasy-param-sensitive: true
user_token:
airbyte_secret: true
name: "api_key"
order: 0
title: "User Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "coassemble"
const: "coassemble"
enum:
- "coassemble"
order: 0
type: "string"
required:
- "user_token"
- "user_id"
- "sourceType"
type: "object"
source-coassemble-update:
properties:
user_id:
airbyte_secret: true
order: 1
title: "User ID"
type: "string"
user_token:
airbyte_secret: true
name: "api_key"
order: 0
title: "User Token"
type: "string"
required:
- "user_token"
- "user_id"
type: "object"
source-rki-covid:
properties:
start_date:
description: "UTC date in the format 2017-01-25. Any data before this date\
\ will not be replicated."
order: 1
title: "Start Date"
type: "string"
sourceType:
title: "rki-covid"
const: "rki-covid"
enum:
- "rki-covid"
order: 0
type: "string"
required:
- "start_date"
- "sourceType"
title: "RKI Covid Spec"
type: "object"
source-rki-covid-update:
properties:
start_date:
description: "UTC date in the format 2017-01-25. Any data before this date\
\ will not be replicated."
order: 1
title: "Start Date"
type: "string"
required:
- "start_date"
title: "RKI Covid Spec"
type: "object"
source-secoda:
properties:
api_key:
airbyte_secret: true
description: "Your API Access Key. See here. The key is case sensitive."
order: 0
title: "Api Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "secoda"
const: "secoda"
enum:
- "secoda"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-secoda-update:
properties:
api_key:
airbyte_secret: true
description: "Your API Access Key. See here. The key is case sensitive."
order: 0
title: "Api Key"
type: "string"
required:
- "api_key"
type: "object"
source-delighted:
properties:
api_key:
airbyte_secret: true
description: "A Delighted API key."
order: 0
title: "Delighted API Key"
type: "string"
x-speakeasy-param-sensitive: true
since:
description: "The date from which you'd like to replicate the data"
examples:
- "2022-05-30T04:50:23Z"
- "2022-05-30 04:50:23"
format: "date-time"
order: 1
pattern: "^\\d{4}-\\d{2}-\\d{2}[T ]\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z?$"
title: "Replication Start Date"
type: "string"
sourceType:
title: "delighted"
const: "delighted"
enum:
- "delighted"
order: 0
type: "string"
required:
- "since"
- "api_key"
- "sourceType"
title: "Delighted Spec"
type: "object"
source-delighted-update:
properties:
api_key:
airbyte_secret: true
description: "A Delighted API key."
order: 0
title: "Delighted API Key"
type: "string"
since:
description: "The date from which you'd like to replicate the data"
examples:
- "2022-05-30T04:50:23Z"
- "2022-05-30 04:50:23"
format: "date-time"
order: 1
pattern: "^\\d{4}-\\d{2}-\\d{2}[T ]\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z?$"
title: "Replication Start Date"
type: "string"
required:
- "since"
- "api_key"
title: "Delighted Spec"
type: "object"
source-elasticsearch:
properties:
authenticationMethod:
description: "The type of authentication to be used"
oneOf:
- additionalProperties: true
description: "No authentication will be used"
properties:
method:
const: "none"
type: "string"
enum:
- "none"
required:
- "method"
title: "None"
- additionalProperties: true
description: "Use a api key and secret combination to authenticate"
properties:
apiKeyId:
description: "The Key ID to used when accessing an enterprise Elasticsearch\
\ instance."
title: "API Key ID"
type: "string"
apiKeySecret:
airbyte_secret: true
description: "The secret associated with the API Key ID."
title: "API Key Secret"
type: "string"
x-speakeasy-param-sensitive: true
method:
const: "secret"
type: "string"
enum:
- "secret"
required:
- "method"
- "apiKeyId"
- "apiKeySecret"
title: "Api Key/Secret"
- additionalProperties: true
description: "Basic auth header with a username and password"
properties:
method:
const: "basic"
type: "string"
enum:
- "basic"
password:
airbyte_secret: true
description: "Basic auth password to access a secure Elasticsearch\
\ server"
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
username:
description: "Basic auth username to access a secure Elasticsearch\
\ server"
title: "Username"
type: "string"
required:
- "method"
- "username"
- "password"
title: "Username/Password"
title: "Authentication Method"
type: "object"
endpoint:
description: "The full url of the Elasticsearch server"
title: "Server Endpoint"
type: "string"
sourceType:
title: "elasticsearch"
const: "elasticsearch"
enum:
- "elasticsearch"
order: 0
type: "string"
required:
- "endpoint"
- "sourceType"
title: "Elasticsearch Connection Configuration"
type: "object"
source-elasticsearch-update:
properties:
authenticationMethod:
description: "The type of authentication to be used"
oneOf:
- additionalProperties: true
description: "No authentication will be used"
properties:
method:
const: "none"
type: "string"
enum:
- "none"
required:
- "method"
title: "None"
- additionalProperties: true
description: "Use a api key and secret combination to authenticate"
properties:
apiKeyId:
description: "The Key ID to used when accessing an enterprise Elasticsearch\
\ instance."
title: "API Key ID"
type: "string"
apiKeySecret:
airbyte_secret: true
description: "The secret associated with the API Key ID."
title: "API Key Secret"
type: "string"
method:
const: "secret"
type: "string"
enum:
- "secret"
required:
- "method"
- "apiKeyId"
- "apiKeySecret"
title: "Api Key/Secret"
- additionalProperties: true
description: "Basic auth header with a username and password"
properties:
method:
const: "basic"
type: "string"
enum:
- "basic"
password:
airbyte_secret: true
description: "Basic auth password to access a secure Elasticsearch\
\ server"
title: "Password"
type: "string"
username:
description: "Basic auth username to access a secure Elasticsearch\
\ server"
title: "Username"
type: "string"
required:
- "method"
- "username"
- "password"
title: "Username/Password"
title: "Authentication Method"
type: "object"
endpoint:
description: "The full url of the Elasticsearch server"
title: "Server Endpoint"
type: "string"
required:
- "endpoint"
title: "Elasticsearch Connection Configuration"
type: "object"
source-mercado-ads:
properties:
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_refresh_token:
airbyte_secret: true
order: 2
title: "Refresh token"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
x-speakeasy-param-sensitive: true
end_date:
description: "Cannot exceed 90 days from current day for Product Ads"
format: "date"
order: 5
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "End Date"
type: "string"
lookback_days:
default: 7
order: 3
title: "Lookback Days"
type: "number"
start_date:
description: "Cannot exceed 90 days from current day for Product Ads, and\
\ 90 days from \"End Date\" on Brand and Display Ads"
format: "date"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
sourceType:
title: "mercado-ads"
const: "mercado-ads"
enum:
- "mercado-ads"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "client_refresh_token"
- "lookback_days"
- "sourceType"
type: "object"
source-mercado-ads-update:
properties:
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
client_refresh_token:
airbyte_secret: true
order: 2
title: "Refresh token"
type: "string"
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
end_date:
description: "Cannot exceed 90 days from current day for Product Ads"
format: "date"
order: 5
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "End Date"
type: "string"
lookback_days:
default: 7
order: 3
title: "Lookback Days"
type: "number"
start_date:
description: "Cannot exceed 90 days from current day for Product Ads, and\
\ 90 days from \"End Date\" on Brand and Display Ads"
format: "date"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
required:
- "client_id"
- "client_secret"
- "client_refresh_token"
- "lookback_days"
type: "object"
source-pretix:
properties:
api_token:
airbyte_secret: true
description: "API token to use. Obtain it from the pretix web interface\
\ by creating a new token under your team settings."
name: "api_token"
order: 0
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "pretix"
const: "pretix"
enum:
- "pretix"
order: 0
type: "string"
required:
- "api_token"
- "sourceType"
type: "object"
source-pretix-update:
properties:
api_token:
airbyte_secret: true
description: "API token to use. Obtain it from the pretix web interface\
\ by creating a new token under your team settings."
name: "api_token"
order: 0
title: "API Token"
type: "string"
required:
- "api_token"
type: "object"
source-cimis:
properties:
api_key:
airbyte_secret: true
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
daily_data_items:
enum:
- "day-air-tmp-avg"
- "day-air-tmp-min"
- "day-dew-pnt"
- "day-eto"
- "day-asce-eto"
- "day-asce-etr"
- "day-precip"
- "day-rel-hum-avg"
- "day-rel-hum-max"
- "day-rel-hum-min"
- "day-soil-tmp-avg"
- "day-soil-tmp-max"
- "day-soil-tmp-min"
- "day-sol-rad-avg"
- "day-sol-rad-net"
- "day-vap-pres-max"
- "day-vap-pres-avg"
- "day-wind-ene"
- "day-wind-ese"
- "day-wind-nne"
- "day-wind-nnw"
- "day-wind-run"
- "day-wind-spd-avg"
- "day-wind-ssw"
- "day-wind-wnw"
- "day-wind-wsw"
order: 3
title: "Daily Data Items"
type: "array"
end_date:
format: "date-time"
order: 6
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "End date"
type: "string"
hourly_data_items:
enum:
- "hly-air-tmp"
- "hly-dew-pnt"
- "hly-eto"
- "hly-net-rad"
- "hly-asce-eto"
- "hly-asce-etr"
- "hly-precip"
- "hly-rel-hum"
- "hly-res-wind"
- "hly-soil-tmp"
- "hly-sol-rad"
- "hly-vap-pres"
- "hly-wind-dir"
- "hly-wind-spd"
order: 4
title: "Hourly Data Items"
type: "array"
start_date:
format: "date-time"
order: 5
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
targets:
order: 2
title: "Targets"
type: "array"
targets_type:
enum:
- "WSN station numbers"
- "California zip codes"
- "decimal-degree coordinates"
- "street addresses"
order: 1
title: "Targets Type"
type: "string"
unit_of_measure:
enum:
- "E"
- "M"
order: 7
title: "Unit of Measure"
type: "string"
sourceType:
title: "cimis"
const: "cimis"
enum:
- "cimis"
order: 0
type: "string"
required:
- "api_key"
- "targets_type"
- "targets"
- "start_date"
- "end_date"
- "sourceType"
type: "object"
source-cimis-update:
properties:
api_key:
airbyte_secret: true
name: "api_key"
order: 0
title: "API Key"
type: "string"
daily_data_items:
enum:
- "day-air-tmp-avg"
- "day-air-tmp-min"
- "day-dew-pnt"
- "day-eto"
- "day-asce-eto"
- "day-asce-etr"
- "day-precip"
- "day-rel-hum-avg"
- "day-rel-hum-max"
- "day-rel-hum-min"
- "day-soil-tmp-avg"
- "day-soil-tmp-max"
- "day-soil-tmp-min"
- "day-sol-rad-avg"
- "day-sol-rad-net"
- "day-vap-pres-max"
- "day-vap-pres-avg"
- "day-wind-ene"
- "day-wind-ese"
- "day-wind-nne"
- "day-wind-nnw"
- "day-wind-run"
- "day-wind-spd-avg"
- "day-wind-ssw"
- "day-wind-wnw"
- "day-wind-wsw"
order: 3
title: "Daily Data Items"
type: "array"
end_date:
format: "date-time"
order: 6
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "End date"
type: "string"
hourly_data_items:
enum:
- "hly-air-tmp"
- "hly-dew-pnt"
- "hly-eto"
- "hly-net-rad"
- "hly-asce-eto"
- "hly-asce-etr"
- "hly-precip"
- "hly-rel-hum"
- "hly-res-wind"
- "hly-soil-tmp"
- "hly-sol-rad"
- "hly-vap-pres"
- "hly-wind-dir"
- "hly-wind-spd"
order: 4
title: "Hourly Data Items"
type: "array"
start_date:
format: "date-time"
order: 5
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
targets:
order: 2
title: "Targets"
type: "array"
targets_type:
enum:
- "WSN station numbers"
- "California zip codes"
- "decimal-degree coordinates"
- "street addresses"
order: 1
title: "Targets Type"
type: "string"
unit_of_measure:
enum:
- "E"
- "M"
order: 7
title: "Unit of Measure"
type: "string"
required:
- "api_key"
- "targets_type"
- "targets"
- "start_date"
- "end_date"
type: "object"
source-paypal-transaction:
properties:
client_id:
airbyte_secret: true
description: "The Client ID of your Paypal developer application."
order: 0
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The Client Secret of your Paypal developer application."
order: 1
title: "Client secret"
type: "string"
x-speakeasy-param-sensitive: true
dispute_start_date:
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."
examples:
- "2021-06-11T23:59:59.000Z"
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{3}Z$"
title: "Dispute Start Date Range"
type: "string"
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."
examples:
- "2021-06-11T23:59:59Z"
- "2021-06-11T23:59:59+00:00"
format: "date-time"
order: 4
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})$"
title: "End Date"
type: "string"
is_sandbox:
default: false
description: "Determines whether to use the sandbox or production environment."
order: 5
title: "Sandbox"
type: "boolean"
refresh_token:
airbyte_secret: true
description: "The key to refresh the expired access token."
order: 6
title: "Refresh token"
type: "string"
x-speakeasy-param-sensitive: true
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."
examples:
- "2021-06-11T23:59:59Z"
- "2021-06-11T23:59:59+00:00"
format: "date-time"
order: 2
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})$"
title: "Start Date"
type: "string"
time_window:
default: 7
description: "The number of days per request. Must be a number between 1\
\ and 31."
maximum: 31
minimum: 1
order: 7
title: "Number of days per request"
type: "integer"
sourceType:
title: "paypal-transaction"
const: "paypal-transaction"
enum:
- "paypal-transaction"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "start_date"
- "is_sandbox"
- "sourceType"
type: "object"
source-paypal-transaction-update:
properties:
client_id:
airbyte_secret: true
description: "The Client ID of your Paypal developer application."
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Paypal developer application."
order: 1
title: "Client secret"
type: "string"
dispute_start_date:
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."
examples:
- "2021-06-11T23:59:59.000Z"
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{3}Z$"
title: "Dispute Start Date Range"
type: "string"
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."
examples:
- "2021-06-11T23:59:59Z"
- "2021-06-11T23:59:59+00:00"
format: "date-time"
order: 4
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})$"
title: "End Date"
type: "string"
is_sandbox:
default: false
description: "Determines whether to use the sandbox or production environment."
order: 5
title: "Sandbox"
type: "boolean"
refresh_token:
airbyte_secret: true
description: "The key to refresh the expired access token."
order: 6
title: "Refresh token"
type: "string"
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."
examples:
- "2021-06-11T23:59:59Z"
- "2021-06-11T23:59:59+00:00"
format: "date-time"
order: 2
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})$"
title: "Start Date"
type: "string"
time_window:
default: 7
description: "The number of days per request. Must be a number between 1\
\ and 31."
maximum: 31
minimum: 1
order: 7
title: "Number of days per request"
type: "integer"
required:
- "client_id"
- "client_secret"
- "start_date"
- "is_sandbox"
type: "object"
source-pexels-api:
properties:
api_key:
airbyte_secret: true
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."
order: 0
title: "API Key from the pexels website"
type: "string"
x-speakeasy-param-sensitive: true
color:
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"
order: 1
title: "Specific color for the search"
type: "string"
locale:
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"
order: 2
title: "Specific locale for the search"
type: "string"
orientation:
description: "Optional, Desired photo orientation. The current supported\
\ orientations are landscape, portrait or square"
examples:
- "square"
- "landscape"
order: 3
title: "Specific orientation for the search"
type: "string"
query:
description: "Optional, the search query, Example Ocean, Tigers, Pears,\
\ etc."
examples:
- "people"
- "oceans"
order: 4
title: "Specific query for the search"
type: "string"
size:
description: "Optional, Minimum photo size. The current supported sizes\
\ are large(24MP), medium(12MP) or small(4MP)."
examples:
- "large"
- "small"
order: 5
title: "Specific size for the search"
type: "string"
sourceType:
title: "pexels-api"
const: "pexels-api"
enum:
- "pexels-api"
order: 0
type: "string"
required:
- "api_key"
- "query"
- "sourceType"
type: "object"
source-pexels-api-update:
properties:
api_key:
airbyte_secret: true
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."
order: 0
title: "API Key from the pexels website"
type: "string"
color:
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"
order: 1
title: "Specific color for the search"
type: "string"
locale:
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"
order: 2
title: "Specific locale for the search"
type: "string"
orientation:
description: "Optional, Desired photo orientation. The current supported\
\ orientations are landscape, portrait or square"
examples:
- "square"
- "landscape"
order: 3
title: "Specific orientation for the search"
type: "string"
query:
description: "Optional, the search query, Example Ocean, Tigers, Pears,\
\ etc."
examples:
- "people"
- "oceans"
order: 4
title: "Specific query for the search"
type: "string"
size:
description: "Optional, Minimum photo size. The current supported sizes\
\ are large(24MP), medium(12MP) or small(4MP)."
examples:
- "large"
- "small"
order: 5
title: "Specific size for the search"
type: "string"
required:
- "api_key"
- "query"
type: "object"
source-leadfeeder:
properties:
api_token:
airbyte_secret: true
order: 0
title: "Api Token"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "leadfeeder"
const: "leadfeeder"
enum:
- "leadfeeder"
order: 0
type: "string"
required:
- "api_token"
- "start_date"
- "sourceType"
type: "object"
source-leadfeeder-update:
properties:
api_token:
airbyte_secret: true
order: 0
title: "Api Token"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_token"
- "start_date"
type: "object"
source-blogger:
properties:
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_refresh_token:
airbyte_secret: true
order: 2
title: "Refresh token"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "blogger"
const: "blogger"
enum:
- "blogger"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "client_refresh_token"
- "sourceType"
type: "object"
source-blogger-update:
properties:
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
client_refresh_token:
airbyte_secret: true
order: 2
title: "Refresh token"
type: "string"
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
required:
- "client_id"
- "client_secret"
- "client_refresh_token"
type: "object"
source-codefresh:
properties:
account_id:
airbyte_secret: true
order: 1
title: "Account Id"
type: "string"
x-speakeasy-param-sensitive: true
api_key:
airbyte_secret: true
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
report_date_range:
order: 3
title: "Report Date Range"
type: "array"
report_granularity:
order: 2
title: "Report Granularity"
type: "string"
start_date:
format: "date-time"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "codefresh"
const: "codefresh"
enum:
- "codefresh"
order: 0
type: "string"
required:
- "api_key"
- "account_id"
- "start_date"
- "sourceType"
type: "object"
source-codefresh-update:
properties:
account_id:
airbyte_secret: true
order: 1
title: "Account Id"
type: "string"
api_key:
airbyte_secret: true
name: "api_key"
order: 0
title: "API Key"
type: "string"
report_date_range:
order: 3
title: "Report Date Range"
type: "array"
report_granularity:
order: 2
title: "Report Granularity"
type: "string"
start_date:
format: "date-time"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "account_id"
- "start_date"
type: "object"
source-appcues:
properties:
account_id:
description: "Account ID of Appcues found in account settings page (https://studio.appcues.com/settings/account)"
order: 2
title: "Account ID"
type: "string"
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
username:
order: 0
title: "Username"
type: "string"
sourceType:
title: "appcues"
const: "appcues"
enum:
- "appcues"
order: 0
type: "string"
required:
- "username"
- "account_id"
- "start_date"
- "sourceType"
type: "object"
source-appcues-update:
properties:
account_id:
description: "Account ID of Appcues found in account settings page (https://studio.appcues.com/settings/account)"
order: 2
title: "Account ID"
type: "string"
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
username:
order: 0
title: "Username"
type: "string"
required:
- "username"
- "account_id"
- "start_date"
type: "object"
source-facebook-marketing:
properties:
access_token:
airbyte_secret: true
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
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
account_ids:
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."
examples:
- "111111111111111"
items:
pattern: "^[0-9]+$"
type: "string"
minItems: 1
order: 0
pattern_descriptor: "The Ad Account ID must be a number."
title: "Ad Account ID(s)"
type: "array"
uniqueItems: true
ad_statuses:
default: []
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."
items:
description: "An enumeration."
enum:
- "ACTIVE"
- "ADSET_PAUSED"
- "ARCHIVED"
- "CAMPAIGN_PAUSED"
- "DELETED"
- "DISAPPROVED"
- "IN_PROCESS"
- "PAUSED"
- "PENDING_BILLING_INFO"
- "PENDING_REVIEW"
- "PREAPPROVED"
- "WITH_ISSUES"
title: "ValidAdStatuses"
order: 6
title: "Ad Statuses"
type: "array"
adset_statuses:
default: []
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."
items:
description: "An enumeration."
enum:
- "ACTIVE"
- "ARCHIVED"
- "CAMPAIGN_PAUSED"
- "DELETED"
- "IN_PROCESS"
- "PAUSED"
- "WITH_ISSUES"
title: "ValidAdSetStatuses"
order: 5
title: "AdSet Statuses"
type: "array"
campaign_statuses:
default: []
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."
items:
description: "An enumeration."
enum:
- "ACTIVE"
- "ARCHIVED"
- "DELETED"
- "IN_PROCESS"
- "PAUSED"
- "WITH_ISSUES"
title: "ValidCampaignStatuses"
order: 4
title: "Campaign Statuses"
type: "array"
credentials:
description: "Credentials for connecting to the Facebook Marketing API"
oneOf:
- properties:
access_token:
airbyte_secret: true
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."
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "Client"
default: "Client"
enum:
- "Client"
title: "Auth Type"
type: "string"
client_id:
airbyte_secret: true
description: "Client ID for the Facebook Marketing API"
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "Client Secret for the Facebook Marketing API"
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "client_id"
- "client_secret"
- "auth_type"
title: "Authenticate via Facebook Marketing (Oauth)"
type: "object"
- properties:
access_token:
airbyte_secret: true
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."
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "Service"
default: "Service"
enum:
- "Service"
title: "Auth Type"
type: "string"
required:
- "access_token"
- "auth_type"
title: "Service Account Key Authentication"
type: "object"
title: "Authentication"
type: "object"
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."
items:
description: "Config for custom insights"
properties:
action_breakdowns:
default: []
description: "A list of chosen action_breakdowns for action_breakdowns"
items:
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"
- "conversion_destination"
- "matched_persona_id"
- "matched_persona_name"
- "signal_source_bucket"
- "standard_event_content_type"
title: "ValidActionBreakdowns"
title: "Action Breakdowns"
type: "array"
breakdowns:
default: []
description: "A list of chosen breakdowns for breakdowns"
items:
description: "An enumeration."
enum:
- "ad_extension_domain"
- "ad_extension_url"
- "ad_format_asset"
- "age"
- "app_id"
- "body_asset"
- "breakdown_ad_objective"
- "breakdown_reporting_ad_id"
- "call_to_action_asset"
- "coarse_conversion_value"
- "comscore_market"
- "comscore_market_code"
- "conversion_destination"
- "country"
- "creative_relaxation_asset_type"
- "description_asset"
- "device_platform"
- "dma"
- "fidelity_type"
- "flexible_format_asset_type"
- "frequency_value"
- "gen_ai_asset_type"
- "gender"
- "hourly_stats_aggregated_by_advertiser_time_zone"
- "hourly_stats_aggregated_by_audience_time_zone"
- "hsid"
- "image_asset"
- "impression_device"
- "impression_view_time_advertiser_hour_v2"
- "is_auto_advance"
- "is_conversion_id_modeled"
- "is_rendered_as_delayed_skip_ad"
- "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"
- "media_type"
- "mmm"
- "place_page_id"
- "platform_position"
- "postback_sequence_index"
- "product_id"
- "publisher_platform"
- "redownload"
- "region"
- "signal_source_bucket"
- "skan_campaign_id"
- "skan_conversion_id"
- "skan_version"
- "sot_attribution_model_type"
- "sot_attribution_window"
- "sot_channel"
- "sot_event_type"
- "sot_source"
- "standard_event_content_type"
- "title_asset"
- "user_persona_id"
- "user_persona_name"
- "video_asset"
- "user_segment_key"
title: "ValidBreakdowns"
title: "Breakdowns"
type: "array"
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."
examples:
- "2017-01-26T00: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$"
title: "End Date"
type: "string"
fields:
default: []
description: "A list of chosen fields for fields parameter"
items:
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"
- "age_targeting"
- "attribution_setting"
- "auction_bid"
- "auction_competitiveness"
- "auction_max_competitor_bid"
- "average_purchases_conversion_value"
- "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_leads"
- "conversion_rate_ranking"
- "conversion_values"
- "conversions"
- "converted_product_app_custom_event_fb_mobile_purchase"
- "converted_product_app_custom_event_fb_mobile_purchase_value"
- "converted_product_offline_purchase"
- "converted_product_offline_purchase_value"
- "converted_product_omni_purchase"
- "converted_product_omni_purchase_values"
- "converted_product_quantity"
- "converted_product_value"
- "converted_product_website_pixel_purchase"
- "converted_product_website_pixel_purchase_value"
- "converted_promoted_product_app_custom_event_fb_mobile_purchase"
- "converted_promoted_product_app_custom_event_fb_mobile_purchase_value"
- "converted_promoted_product_offline_purchase"
- "converted_promoted_product_offline_purchase_value"
- "converted_promoted_product_omni_purchase"
- "converted_promoted_product_omni_purchase_values"
- "converted_promoted_product_quantity"
- "converted_promoted_product_value"
- "converted_promoted_product_website_pixel_purchase"
- "converted_promoted_product_website_pixel_purchase_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_dda_countby_convs"
- "cost_per_estimated_ad_recallers"
- "cost_per_inline_link_click"
- "cost_per_inline_post_engagement"
- "cost_per_objective_result"
- "cost_per_one_thousand_ad_impression"
- "cost_per_outbound_click"
- "cost_per_result"
- "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"
- "landing_page_view_actions_per_link_click"
- "landing_page_view_per_link_click"
- "landing_page_view_per_purchase_rate"
- "link_clicks_per_results"
- "location"
- "marketing_messages_click_rate_benchmark"
- "marketing_messages_cost_per_delivered"
- "marketing_messages_cost_per_link_btn_click"
- "marketing_messages_delivered"
- "marketing_messages_delivery_rate"
- "marketing_messages_link_btn_click"
- "marketing_messages_link_btn_click_rate"
- "marketing_messages_media_view_rate"
- "marketing_messages_phone_call_btn_click_rate"
- "marketing_messages_quick_reply_btn_click"
- "marketing_messages_quick_reply_btn_click_rate"
- "marketing_messages_read"
- "marketing_messages_read_rate"
- "marketing_messages_read_rate_benchmark"
- "marketing_messages_sent"
- "marketing_messages_spend"
- "marketing_messages_spend_currency"
- "marketing_messages_website_add_to_cart"
- "marketing_messages_website_initiate_checkout"
- "marketing_messages_website_purchase"
- "marketing_messages_website_purchase_values"
- "mobile_app_purchase_roas"
- "objective"
- "objective_result_rate"
- "objective_results"
- "onsite_conversion_messaging_detected_purchase_deduped"
- "optimization_goal"
- "outbound_clicks"
- "outbound_clicks_ctr"
- "place_page_name"
- "product_brand"
- "product_category"
- "product_content_id"
- "product_custom_label_0"
- "product_custom_label_1"
- "product_custom_label_2"
- "product_custom_label_3"
- "product_custom_label_4"
- "product_group_content_id"
- "product_group_retailer_id"
- "product_name"
- "product_retailer_id"
- "product_views"
- "purchase_per_landing_page_view"
- "purchase_roas"
- "purchases_per_link_click"
- "qualifying_question_qualify_answer_rate"
- "quality_ranking"
- "reach"
- "result_rate"
- "result_values_performance_indicator"
- "results"
- "shops_assisted_purchases"
- "social_spend"
- "spend"
- "total_card_view"
- "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"
- "video_view_per_impression"
- "website_ctr"
- "website_purchase_roas"
- "wish_bid"
title: "ValidEnums"
title: "Fields"
type: "array"
insights_job_timeout:
default: 60
description: "The insights job timeout"
exclusiveMinimum: 0
maximum: 60
mininum: 10
title: "Custom Insights Job Timeout"
type: "integer"
insights_lookback_window:
default: 28
description: "The attribution window"
exclusiveMinimum: 0
maximum: 28
mininum: 1
title: "Custom Insights Lookback Window"
type: "integer"
level:
default: "ad"
description: "Chosen level for API"
enum:
- "ad"
- "adset"
- "campaign"
- "account"
title: "Level"
type: "string"
name:
description: "The name value of insight"
title: "Name"
type: "string"
start_date:
description: "The date from which you'd like to replicate data for\
\ this stream, in the format YYYY-MM-DDT00:00:00Z."
examples:
- "2017-01-25T00: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$"
title: "Start Date"
type: "string"
time_increment:
default: 1
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). The minimum allowed value for this field is 1, and the\
\ maximum is 89."
exclusiveMinimum: 0
maximum: 89
minimum: 1
title: "Time Increment"
type: "integer"
required:
- "name"
title: "InsightConfig"
type: "object"
order: 9
title: "Custom Insights"
type: "array"
default_ads_insights_action_breakdowns:
default:
- "action_type"
- "action_target_id"
- "action_destination"
description: "Action breakdowns for the Built-in Ads Insights stream that\
\ will be used in the request. You can override default values or remove\
\ them to make it empty if needed."
items:
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"
- "conversion_destination"
- "matched_persona_id"
- "matched_persona_name"
- "signal_source_bucket"
- "standard_event_content_type"
title: "ValidActionBreakdowns"
order: 8
title: "Action breakdowns for the Built-in Ads Insight stream"
type: "array"
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."
examples:
- "2017-01-26T00:00:00Z"
format: "date-time"
order: 3
pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "End Date"
type: "string"
fetch_thumbnail_images:
default: false
description: "Set to active if you want to fetch the thumbnail_url and store\
\ the result in thumbnail_data_url for each Ad Creative."
order: 7
title: "Fetch Thumbnail Images from Ad Creative"
type: "boolean"
insights_job_timeout:
default: 60
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."
exclusiveMinimum: 0
maximum: 60
mininum: 10
order: 12
title: "Insights Job Timeout"
type: "integer"
insights_lookback_window:
default: 28
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."
exclusiveMinimum: 0
maximum: 28
mininum: 1
order: 11
title: "Insights Lookback Window"
type: "integer"
page_size:
default: 100
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."
exclusiveMinimum: 0
order: 10
title: "Page Size of Requests"
type: "integer"
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."
examples:
- "2017-01-25T00:00:00Z"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
sourceType:
title: "facebook-marketing"
const: "facebook-marketing"
enum:
- "facebook-marketing"
order: 0
type: "string"
required:
- "account_ids"
- "credentials"
- "sourceType"
title: "Source Facebook Marketing"
type: "object"
source-facebook-marketing-update:
properties:
access_token:
airbyte_secret: true
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
title: "Access Token"
type: "string"
account_ids:
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."
examples:
- "111111111111111"
items:
pattern: "^[0-9]+$"
type: "string"
minItems: 1
order: 0
pattern_descriptor: "The Ad Account ID must be a number."
title: "Ad Account ID(s)"
type: "array"
uniqueItems: true
ad_statuses:
default: []
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."
items:
description: "An enumeration."
enum:
- "ACTIVE"
- "ADSET_PAUSED"
- "ARCHIVED"
- "CAMPAIGN_PAUSED"
- "DELETED"
- "DISAPPROVED"
- "IN_PROCESS"
- "PAUSED"
- "PENDING_BILLING_INFO"
- "PENDING_REVIEW"
- "PREAPPROVED"
- "WITH_ISSUES"
title: "ValidAdStatuses"
order: 6
title: "Ad Statuses"
type: "array"
adset_statuses:
default: []
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."
items:
description: "An enumeration."
enum:
- "ACTIVE"
- "ARCHIVED"
- "CAMPAIGN_PAUSED"
- "DELETED"
- "IN_PROCESS"
- "PAUSED"
- "WITH_ISSUES"
title: "ValidAdSetStatuses"
order: 5
title: "AdSet Statuses"
type: "array"
campaign_statuses:
default: []
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."
items:
description: "An enumeration."
enum:
- "ACTIVE"
- "ARCHIVED"
- "DELETED"
- "IN_PROCESS"
- "PAUSED"
- "WITH_ISSUES"
title: "ValidCampaignStatuses"
order: 4
title: "Campaign Statuses"
type: "array"
credentials:
description: "Credentials for connecting to the Facebook Marketing API"
oneOf:
- properties:
access_token:
airbyte_secret: true
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."
title: "Access Token"
type: "string"
auth_type:
const: "Client"
default: "Client"
enum:
- "Client"
title: "Auth Type"
type: "string"
client_id:
airbyte_secret: true
description: "Client ID for the Facebook Marketing API"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Client Secret for the Facebook Marketing API"
title: "Client Secret"
type: "string"
required:
- "client_id"
- "client_secret"
- "auth_type"
title: "Authenticate via Facebook Marketing (Oauth)"
type: "object"
- properties:
access_token:
airbyte_secret: true
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."
title: "Access Token"
type: "string"
auth_type:
const: "Service"
default: "Service"
enum:
- "Service"
title: "Auth Type"
type: "string"
required:
- "access_token"
- "auth_type"
title: "Service Account Key Authentication"
type: "object"
title: "Authentication"
type: "object"
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."
items:
description: "Config for custom insights"
properties:
action_breakdowns:
default: []
description: "A list of chosen action_breakdowns for action_breakdowns"
items:
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"
- "conversion_destination"
- "matched_persona_id"
- "matched_persona_name"
- "signal_source_bucket"
- "standard_event_content_type"
title: "ValidActionBreakdowns"
title: "Action Breakdowns"
type: "array"
breakdowns:
default: []
description: "A list of chosen breakdowns for breakdowns"
items:
description: "An enumeration."
enum:
- "ad_extension_domain"
- "ad_extension_url"
- "ad_format_asset"
- "age"
- "app_id"
- "body_asset"
- "breakdown_ad_objective"
- "breakdown_reporting_ad_id"
- "call_to_action_asset"
- "coarse_conversion_value"
- "comscore_market"
- "comscore_market_code"
- "conversion_destination"
- "country"
- "creative_relaxation_asset_type"
- "description_asset"
- "device_platform"
- "dma"
- "fidelity_type"
- "flexible_format_asset_type"
- "frequency_value"
- "gen_ai_asset_type"
- "gender"
- "hourly_stats_aggregated_by_advertiser_time_zone"
- "hourly_stats_aggregated_by_audience_time_zone"
- "hsid"
- "image_asset"
- "impression_device"
- "impression_view_time_advertiser_hour_v2"
- "is_auto_advance"
- "is_conversion_id_modeled"
- "is_rendered_as_delayed_skip_ad"
- "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"
- "media_type"
- "mmm"
- "place_page_id"
- "platform_position"
- "postback_sequence_index"
- "product_id"
- "publisher_platform"
- "redownload"
- "region"
- "signal_source_bucket"
- "skan_campaign_id"
- "skan_conversion_id"
- "skan_version"
- "sot_attribution_model_type"
- "sot_attribution_window"
- "sot_channel"
- "sot_event_type"
- "sot_source"
- "standard_event_content_type"
- "title_asset"
- "user_persona_id"
- "user_persona_name"
- "video_asset"
- "user_segment_key"
title: "ValidBreakdowns"
title: "Breakdowns"
type: "array"
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."
examples:
- "2017-01-26T00: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$"
title: "End Date"
type: "string"
fields:
default: []
description: "A list of chosen fields for fields parameter"
items:
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"
- "age_targeting"
- "attribution_setting"
- "auction_bid"
- "auction_competitiveness"
- "auction_max_competitor_bid"
- "average_purchases_conversion_value"
- "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_leads"
- "conversion_rate_ranking"
- "conversion_values"
- "conversions"
- "converted_product_app_custom_event_fb_mobile_purchase"
- "converted_product_app_custom_event_fb_mobile_purchase_value"
- "converted_product_offline_purchase"
- "converted_product_offline_purchase_value"
- "converted_product_omni_purchase"
- "converted_product_omni_purchase_values"
- "converted_product_quantity"
- "converted_product_value"
- "converted_product_website_pixel_purchase"
- "converted_product_website_pixel_purchase_value"
- "converted_promoted_product_app_custom_event_fb_mobile_purchase"
- "converted_promoted_product_app_custom_event_fb_mobile_purchase_value"
- "converted_promoted_product_offline_purchase"
- "converted_promoted_product_offline_purchase_value"
- "converted_promoted_product_omni_purchase"
- "converted_promoted_product_omni_purchase_values"
- "converted_promoted_product_quantity"
- "converted_promoted_product_value"
- "converted_promoted_product_website_pixel_purchase"
- "converted_promoted_product_website_pixel_purchase_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_dda_countby_convs"
- "cost_per_estimated_ad_recallers"
- "cost_per_inline_link_click"
- "cost_per_inline_post_engagement"
- "cost_per_objective_result"
- "cost_per_one_thousand_ad_impression"
- "cost_per_outbound_click"
- "cost_per_result"
- "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"
- "landing_page_view_actions_per_link_click"
- "landing_page_view_per_link_click"
- "landing_page_view_per_purchase_rate"
- "link_clicks_per_results"
- "location"
- "marketing_messages_click_rate_benchmark"
- "marketing_messages_cost_per_delivered"
- "marketing_messages_cost_per_link_btn_click"
- "marketing_messages_delivered"
- "marketing_messages_delivery_rate"
- "marketing_messages_link_btn_click"
- "marketing_messages_link_btn_click_rate"
- "marketing_messages_media_view_rate"
- "marketing_messages_phone_call_btn_click_rate"
- "marketing_messages_quick_reply_btn_click"
- "marketing_messages_quick_reply_btn_click_rate"
- "marketing_messages_read"
- "marketing_messages_read_rate"
- "marketing_messages_read_rate_benchmark"
- "marketing_messages_sent"
- "marketing_messages_spend"
- "marketing_messages_spend_currency"
- "marketing_messages_website_add_to_cart"
- "marketing_messages_website_initiate_checkout"
- "marketing_messages_website_purchase"
- "marketing_messages_website_purchase_values"
- "mobile_app_purchase_roas"
- "objective"
- "objective_result_rate"
- "objective_results"
- "onsite_conversion_messaging_detected_purchase_deduped"
- "optimization_goal"
- "outbound_clicks"
- "outbound_clicks_ctr"
- "place_page_name"
- "product_brand"
- "product_category"
- "product_content_id"
- "product_custom_label_0"
- "product_custom_label_1"
- "product_custom_label_2"
- "product_custom_label_3"
- "product_custom_label_4"
- "product_group_content_id"
- "product_group_retailer_id"
- "product_name"
- "product_retailer_id"
- "product_views"
- "purchase_per_landing_page_view"
- "purchase_roas"
- "purchases_per_link_click"
- "qualifying_question_qualify_answer_rate"
- "quality_ranking"
- "reach"
- "result_rate"
- "result_values_performance_indicator"
- "results"
- "shops_assisted_purchases"
- "social_spend"
- "spend"
- "total_card_view"
- "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"
- "video_view_per_impression"
- "website_ctr"
- "website_purchase_roas"
- "wish_bid"
title: "ValidEnums"
title: "Fields"
type: "array"
insights_job_timeout:
default: 60
description: "The insights job timeout"
exclusiveMinimum: 0
maximum: 60
mininum: 10
title: "Custom Insights Job Timeout"
type: "integer"
insights_lookback_window:
default: 28
description: "The attribution window"
exclusiveMinimum: 0
maximum: 28
mininum: 1
title: "Custom Insights Lookback Window"
type: "integer"
level:
default: "ad"
description: "Chosen level for API"
enum:
- "ad"
- "adset"
- "campaign"
- "account"
title: "Level"
type: "string"
name:
description: "The name value of insight"
title: "Name"
type: "string"
start_date:
description: "The date from which you'd like to replicate data for\
\ this stream, in the format YYYY-MM-DDT00:00:00Z."
examples:
- "2017-01-25T00: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$"
title: "Start Date"
type: "string"
time_increment:
default: 1
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). The minimum allowed value for this field is 1, and the\
\ maximum is 89."
exclusiveMinimum: 0
maximum: 89
minimum: 1
title: "Time Increment"
type: "integer"
required:
- "name"
title: "InsightConfig"
type: "object"
order: 9
title: "Custom Insights"
type: "array"
default_ads_insights_action_breakdowns:
default:
- "action_type"
- "action_target_id"
- "action_destination"
description: "Action breakdowns for the Built-in Ads Insights stream that\
\ will be used in the request. You can override default values or remove\
\ them to make it empty if needed."
items:
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"
- "conversion_destination"
- "matched_persona_id"
- "matched_persona_name"
- "signal_source_bucket"
- "standard_event_content_type"
title: "ValidActionBreakdowns"
order: 8
title: "Action breakdowns for the Built-in Ads Insight stream"
type: "array"
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."
examples:
- "2017-01-26T00:00:00Z"
format: "date-time"
order: 3
pattern: "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "End Date"
type: "string"
fetch_thumbnail_images:
default: false
description: "Set to active if you want to fetch the thumbnail_url and store\
\ the result in thumbnail_data_url for each Ad Creative."
order: 7
title: "Fetch Thumbnail Images from Ad Creative"
type: "boolean"
insights_job_timeout:
default: 60
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."
exclusiveMinimum: 0
maximum: 60
mininum: 10
order: 12
title: "Insights Job Timeout"
type: "integer"
insights_lookback_window:
default: 28
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."
exclusiveMinimum: 0
maximum: 28
mininum: 1
order: 11
title: "Insights Lookback Window"
type: "integer"
page_size:
default: 100
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."
exclusiveMinimum: 0
order: 10
title: "Page Size of Requests"
type: "integer"
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."
examples:
- "2017-01-25T00:00:00Z"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
required:
- "account_ids"
- "credentials"
title: "Source Facebook Marketing"
type: "object"
source-survey-sparrow:
properties:
access_token:
airbyte_secret: true
description: "Your access token. See here. The key is case sensitive."
order: 0
type: "string"
x-speakeasy-param-sensitive: true
region:
default:
properties:
url_base:
const: "https://api.surveysparrow.com/v3"
type: "string"
enum:
- "https://api.surveysparrow.com/v3"
title: "Global account"
type: "object"
description: "Is your account location is EU based? If yes, the base url\
\ to retrieve data will be different."
oneOf:
- properties:
url_base:
const: "https://eu-api.surveysparrow.com/v3"
type: "string"
enum:
- "https://eu-api.surveysparrow.com/v3"
title: "EU-based account"
type: "object"
- properties:
url_base:
const: "https://api.surveysparrow.com/v3"
type: "string"
enum:
- "https://api.surveysparrow.com/v3"
title: "Global account"
type: "object"
order: 1
title: "Base URL"
type: "object"
survey_id:
description: "A List of your survey ids for survey-specific stream"
order: 2
type: "array"
sourceType:
title: "survey-sparrow"
const: "survey-sparrow"
enum:
- "survey-sparrow"
order: 0
type: "string"
required:
- "access_token"
- "sourceType"
type: "object"
source-survey-sparrow-update:
properties:
access_token:
airbyte_secret: true
description: "Your access token. See here. The key is case sensitive."
order: 0
type: "string"
region:
default:
properties:
url_base:
const: "https://api.surveysparrow.com/v3"
type: "string"
enum:
- "https://api.surveysparrow.com/v3"
title: "Global account"
type: "object"
description: "Is your account location is EU based? If yes, the base url\
\ to retrieve data will be different."
oneOf:
- properties:
url_base:
const: "https://eu-api.surveysparrow.com/v3"
type: "string"
enum:
- "https://eu-api.surveysparrow.com/v3"
title: "EU-based account"
type: "object"
- properties:
url_base:
const: "https://api.surveysparrow.com/v3"
type: "string"
enum:
- "https://api.surveysparrow.com/v3"
title: "Global account"
type: "object"
order: 1
title: "Base URL"
type: "object"
survey_id:
description: "A List of your survey ids for survey-specific stream"
order: 2
type: "array"
required:
- "access_token"
type: "object"
source-persistiq:
properties:
api_key:
airbyte_secret: true
description: "PersistIq API Key. See the docs for more information on where to find that key."
order: 0
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "persistiq"
const: "persistiq"
enum:
- "persistiq"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-persistiq-update:
properties:
api_key:
airbyte_secret: true
description: "PersistIq API Key. See the docs for more information on where to find that key."
order: 0
type: "string"
required:
- "api_key"
type: "object"
source-partnerstack:
properties:
private_key:
airbyte_secret: true
description: "The Live Private Key for a Partnerstack account."
order: 2
title: "Partnerstack Private key"
type: "string"
x-speakeasy-param-sensitive: true
public_key:
airbyte_secret: true
description: "The Live Public Key for a Partnerstack account."
order: 0
title: "Partnerstack Public key"
type: "string"
x-speakeasy-param-sensitive: true
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:
- "2017-01-25T00:00:00Z"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "partnerstack"
const: "partnerstack"
enum:
- "partnerstack"
order: 0
type: "string"
required:
- "public_key"
- "private_key"
- "sourceType"
type: "object"
source-partnerstack-update:
properties:
private_key:
airbyte_secret: true
description: "The Live Private Key for a Partnerstack account."
order: 2
title: "Partnerstack Private key"
type: "string"
public_key:
airbyte_secret: true
description: "The Live Public Key for a Partnerstack account."
order: 0
title: "Partnerstack Public key"
type: "string"
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:
- "2017-01-25T00:00:00Z"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "public_key"
- "private_key"
type: "object"
source-web-scrapper:
properties:
api_token:
airbyte_secret: true
description: "API token to use. Find it at https://cloud.webscraper.io/api"
name: "api_token"
order: 0
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "web-scrapper"
const: "web-scrapper"
enum:
- "web-scrapper"
order: 0
type: "string"
required:
- "api_token"
- "sourceType"
type: "object"
source-web-scrapper-update:
properties:
api_token:
airbyte_secret: true
description: "API token to use. Find it at https://cloud.webscraper.io/api"
name: "api_token"
order: 0
title: "API Token"
type: "string"
required:
- "api_token"
type: "object"
source-wufoo:
properties:
api_key:
airbyte_secret: true
description: "Your Wufoo API Key. You can find it by logging into your Wufoo\
\ account, selecting 'API Information' from the 'More' dropdown on any\
\ form, and locating the 16-digit code."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
subdomain:
description: "Your account subdomain/username for Wufoo."
name: "subdomain"
order: 1
title: "Subdomain"
type: "string"
sourceType:
title: "wufoo"
const: "wufoo"
enum:
- "wufoo"
order: 0
type: "string"
required:
- "api_key"
- "subdomain"
- "sourceType"
type: "object"
source-wufoo-update:
properties:
api_key:
airbyte_secret: true
description: "Your Wufoo API Key. You can find it by logging into your Wufoo\
\ account, selecting 'API Information' from the 'More' dropdown on any\
\ form, and locating the 16-digit code."
name: "api_key"
order: 0
title: "API Key"
type: "string"
subdomain:
description: "Your account subdomain/username for Wufoo."
name: "subdomain"
order: 1
title: "Subdomain"
type: "string"
required:
- "api_key"
- "subdomain"
type: "object"
source-configcat:
properties:
password:
airbyte_secret: true
description: "Basic auth password. See here."
order: 1
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
username:
description: "Basic auth user name. See here."
order: 0
title: "Username"
type: "string"
sourceType:
title: "configcat"
const: "configcat"
enum:
- "configcat"
order: 0
type: "string"
required:
- "username"
- "password"
- "sourceType"
type: "object"
source-configcat-update:
properties:
password:
airbyte_secret: true
description: "Basic auth password. See here."
order: 1
title: "Password"
type: "string"
username:
description: "Basic auth user name. See here."
order: 0
title: "Username"
type: "string"
required:
- "username"
- "password"
type: "object"
source-oracle-enterprise:
properties:
check_privileges:
default: true
description: "When this feature is enabled, during schema discovery the\
\ connector will query each table or view individually to check access\
\ privileges and inaccessible tables, views, or columns therein will be\
\ removed. In large schemas, this might cause schema discovery to take\
\ too long, in which case it might be advisable to disable this feature."
order: 14
title: "Check Table and Column Access Privileges"
type: "boolean"
checkpoint_target_interval_seconds:
default: 300
description: "How often (in seconds) a stream should checkpoint, when possible."
order: 12
title: "Checkpoint Target Time Interval"
type: "integer"
concurrency:
default: 1
description: "Maximum number of concurrent queries to the database."
order: 13
title: "Concurrency"
type: "integer"
connection_data:
description: "The scheme by which to establish a database connection."
oneOf:
- additionalProperties: true
description: "Use service name."
properties:
connection_type:
default: "service_name"
enum:
- "service_name"
type: "string"
service_name:
title: "Service name"
type: "string"
required:
- "connection_type"
- "service_name"
title: "Service name"
type: "object"
- additionalProperties: true
description: "Use Oracle System Identifier."
properties:
connection_type:
default: "sid"
enum:
- "sid"
type: "string"
sid:
title: "System ID (SID)"
type: "string"
required:
- "connection_type"
- "sid"
title: "System ID (SID)"
type: "object"
order: 3
title: "Connect by"
type: "object"
cursor:
description: "Configures how data is extracted from the database."
display_type: "radio"
oneOf:
- additionalProperties: true
description: "Incrementally detects new inserts and updates using the\
\ cursor column chosen when configuring a connection (e.g. created_at,\
\ updated_at)."
properties:
cursor_method:
default: "user_defined"
enum:
- "user_defined"
type: "string"
required:
- "cursor_method"
title: "Scan Changes with User Defined Cursor"
type: "object"
- additionalProperties: true
description: "Recommended - Incrementally reads new inserts, updates,\
\ and deletes using Oracle's change data capture feature. This must be enabled on your database."
properties:
cursor_method:
default: "cdc"
enum:
- "cdc"
type: "string"
debezium_shutdown_timeout_seconds:
always_show: true
default: 60
description: "The amount of time to allow the Debezium Engine to shut\
\ down, in seconds."
max: 3600
min: 1
order: 3
title: "Debezium Engine Shutdown Timeout in Seconds (Advanced)"
type: "integer"
initial_load_timeout_hours:
always_show: true
default: 8
description: "The amount of time an initial load is allowed to continue\
\ for before catching up on CDC events."
max: 24
min: 4
order: 2
title: "Initial Load Timeout in Hours (Advanced)"
type: "integer"
invalid_cdc_cursor_position_behavior:
always_show: true
default: "Fail sync"
description: "Determines whether Airbyte should fail or re-sync data\
\ in case of an stale/invalid cursor value in the mined logs. 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"
order: 1
title: "Invalid CDC Position Behavior (Advanced)"
type: "string"
required:
- "cursor_method"
title: "Read Changes using Change Data Capture (CDC)"
type: "object"
order: 11
title: "Update Method"
type: "object"
encryption:
description: "The encryption method with is used when communicating with\
\ the database."
oneOf:
- additionalProperties: true
description: "Data transfer will not be encrypted."
properties:
encryption_method:
default: "unencrypted"
enum:
- "unencrypted"
type: "string"
required:
- "encryption_method"
title: "Unencrypted"
type: "object"
- additionalProperties: true
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."
properties:
encryption_algorithm:
default: "AES256"
description: "This parameter defines what encryption algorithm is\
\ used."
enum:
- "AES256"
- "AES192"
- "AES128"
- "3DES168"
- "3DES112"
- "DES"
title: "Encryption Algorithm"
type: "string"
encryption_method:
default: "client_nne"
enum:
- "client_nne"
type: "string"
required:
- "encryption_method"
- "encryption_algorithm"
title: "Native Network Encryption (NNE)"
type: "object"
- additionalProperties: true
description: "Verify and use the certificate provided by the server."
properties:
encryption_method:
default: "encrypted_verify_certificate"
enum:
- "encrypted_verify_certificate"
type: "string"
ssl_certificate:
airbyte_secret: true
description: "Privacy Enhanced Mail (PEM) files are concatenated certificate\
\ containers frequently used in certificate installations."
multiline: true
title: "SSL PEM File"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "encryption_method"
- "ssl_certificate"
title: "TLS Encrypted (verify certificate)"
type: "object"
order: 9
title: "Encryption"
type: "object"
host:
description: "Hostname of the database."
order: 1
title: "Host"
type: "string"
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)."
order: 8
title: "JDBC URL Params"
type: "string"
password:
airbyte_secret: true
always_show: true
description: "The password associated with the username."
order: 5
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
port:
default: 1521
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."
maximum: 65536
minimum: 0
order: 2
title: "Port"
type: "integer"
schemas:
always_show: true
description: "The list of schemas to sync from. Defaults to user. Case sensitive."
items:
type: "string"
order: 6
title: "Schemas"
type: "array"
uniqueItems: true
table_filters:
always_show: true
description: "Inclusion filters for table selection per schema. If no filters\
\ are specified for a schema, all tables in that schema will be synced."
items:
additionalProperties: true
description: "Inclusion filter configuration for table selection per schema."
properties:
schema_name:
always_show: true
description: "The name of the schema to apply this filter to. Should\
\ match a schema defined in \"Schemas\" field above."
order: 1
title: "Schema Name"
type: "string"
table_name_patterns:
always_show: true
description: "List of table name patterns to include from this schema.\
\ Should be a SQL LIKE pattern."
items:
type: "string"
order: 2
title: "Table Filter Patterns"
type: "array"
required:
- "schema_name"
- "table_name_patterns"
title: "Table Filter"
type: "object"
order: 7
title: "Table Name Filters"
type: "array"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- additionalProperties: true
description: "No ssh tunnel needed to connect to database"
properties:
tunnel_method:
default: "NO_TUNNEL"
enum:
- "NO_TUNNEL"
type: "string"
required:
- "tunnel_method"
title: "No Tunnel"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
x-speakeasy-param-sensitive: true
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_KEY_AUTH"
enum:
- "SSH_KEY_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_PASSWORD_AUTH"
enum:
- "SSH_PASSWORD_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
type: "object"
order: 10
title: "SSH Tunnel Method"
type: "object"
username:
description: "The username which is used to access the database."
order: 4
title: "User"
type: "string"
sourceType:
title: "oracle-enterprise"
const: "oracle-enterprise"
enum:
- "oracle-enterprise"
order: 0
type: "string"
required:
- "host"
- "port"
- "connection_data"
- "username"
- "encryption"
- "tunnel_method"
- "cursor"
- "sourceType"
title: "Oracle Source Spec"
type: "object"
source-oracle-enterprise-update:
properties:
check_privileges:
default: true
description: "When this feature is enabled, during schema discovery the\
\ connector will query each table or view individually to check access\
\ privileges and inaccessible tables, views, or columns therein will be\
\ removed. In large schemas, this might cause schema discovery to take\
\ too long, in which case it might be advisable to disable this feature."
order: 14
title: "Check Table and Column Access Privileges"
type: "boolean"
checkpoint_target_interval_seconds:
default: 300
description: "How often (in seconds) a stream should checkpoint, when possible."
order: 12
title: "Checkpoint Target Time Interval"
type: "integer"
concurrency:
default: 1
description: "Maximum number of concurrent queries to the database."
order: 13
title: "Concurrency"
type: "integer"
connection_data:
description: "The scheme by which to establish a database connection."
oneOf:
- additionalProperties: true
description: "Use service name."
properties:
connection_type:
default: "service_name"
enum:
- "service_name"
type: "string"
service_name:
title: "Service name"
type: "string"
required:
- "connection_type"
- "service_name"
title: "Service name"
type: "object"
- additionalProperties: true
description: "Use Oracle System Identifier."
properties:
connection_type:
default: "sid"
enum:
- "sid"
type: "string"
sid:
title: "System ID (SID)"
type: "string"
required:
- "connection_type"
- "sid"
title: "System ID (SID)"
type: "object"
order: 3
title: "Connect by"
type: "object"
cursor:
description: "Configures how data is extracted from the database."
display_type: "radio"
oneOf:
- additionalProperties: true
description: "Incrementally detects new inserts and updates using the\
\ cursor column chosen when configuring a connection (e.g. created_at,\
\ updated_at)."
properties:
cursor_method:
default: "user_defined"
enum:
- "user_defined"
type: "string"
required:
- "cursor_method"
title: "Scan Changes with User Defined Cursor"
type: "object"
- additionalProperties: true
description: "Recommended - Incrementally reads new inserts, updates,\
\ and deletes using Oracle's change data capture feature. This must be enabled on your database."
properties:
cursor_method:
default: "cdc"
enum:
- "cdc"
type: "string"
debezium_shutdown_timeout_seconds:
always_show: true
default: 60
description: "The amount of time to allow the Debezium Engine to shut\
\ down, in seconds."
max: 3600
min: 1
order: 3
title: "Debezium Engine Shutdown Timeout in Seconds (Advanced)"
type: "integer"
initial_load_timeout_hours:
always_show: true
default: 8
description: "The amount of time an initial load is allowed to continue\
\ for before catching up on CDC events."
max: 24
min: 4
order: 2
title: "Initial Load Timeout in Hours (Advanced)"
type: "integer"
invalid_cdc_cursor_position_behavior:
always_show: true
default: "Fail sync"
description: "Determines whether Airbyte should fail or re-sync data\
\ in case of an stale/invalid cursor value in the mined logs. 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"
order: 1
title: "Invalid CDC Position Behavior (Advanced)"
type: "string"
required:
- "cursor_method"
title: "Read Changes using Change Data Capture (CDC)"
type: "object"
order: 11
title: "Update Method"
type: "object"
encryption:
description: "The encryption method with is used when communicating with\
\ the database."
oneOf:
- additionalProperties: true
description: "Data transfer will not be encrypted."
properties:
encryption_method:
default: "unencrypted"
enum:
- "unencrypted"
type: "string"
required:
- "encryption_method"
title: "Unencrypted"
type: "object"
- additionalProperties: true
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."
properties:
encryption_algorithm:
default: "AES256"
description: "This parameter defines what encryption algorithm is\
\ used."
enum:
- "AES256"
- "AES192"
- "AES128"
- "3DES168"
- "3DES112"
- "DES"
title: "Encryption Algorithm"
type: "string"
encryption_method:
default: "client_nne"
enum:
- "client_nne"
type: "string"
required:
- "encryption_method"
- "encryption_algorithm"
title: "Native Network Encryption (NNE)"
type: "object"
- additionalProperties: true
description: "Verify and use the certificate provided by the server."
properties:
encryption_method:
default: "encrypted_verify_certificate"
enum:
- "encrypted_verify_certificate"
type: "string"
ssl_certificate:
airbyte_secret: true
description: "Privacy Enhanced Mail (PEM) files are concatenated certificate\
\ containers frequently used in certificate installations."
multiline: true
title: "SSL PEM File"
type: "string"
required:
- "encryption_method"
- "ssl_certificate"
title: "TLS Encrypted (verify certificate)"
type: "object"
order: 9
title: "Encryption"
type: "object"
host:
description: "Hostname of the database."
order: 1
title: "Host"
type: "string"
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)."
order: 8
title: "JDBC URL Params"
type: "string"
password:
airbyte_secret: true
always_show: true
description: "The password associated with the username."
order: 5
title: "Password"
type: "string"
port:
default: 1521
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."
maximum: 65536
minimum: 0
order: 2
title: "Port"
type: "integer"
schemas:
always_show: true
description: "The list of schemas to sync from. Defaults to user. Case sensitive."
items:
type: "string"
order: 6
title: "Schemas"
type: "array"
uniqueItems: true
table_filters:
always_show: true
description: "Inclusion filters for table selection per schema. If no filters\
\ are specified for a schema, all tables in that schema will be synced."
items:
additionalProperties: true
description: "Inclusion filter configuration for table selection per schema."
properties:
schema_name:
always_show: true
description: "The name of the schema to apply this filter to. Should\
\ match a schema defined in \"Schemas\" field above."
order: 1
title: "Schema Name"
type: "string"
table_name_patterns:
always_show: true
description: "List of table name patterns to include from this schema.\
\ Should be a SQL LIKE pattern."
items:
type: "string"
order: 2
title: "Table Filter Patterns"
type: "array"
required:
- "schema_name"
- "table_name_patterns"
title: "Table Filter"
type: "object"
order: 7
title: "Table Name Filters"
type: "array"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- additionalProperties: true
description: "No ssh tunnel needed to connect to database"
properties:
tunnel_method:
default: "NO_TUNNEL"
enum:
- "NO_TUNNEL"
type: "string"
required:
- "tunnel_method"
title: "No Tunnel"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_KEY_AUTH"
enum:
- "SSH_KEY_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_PASSWORD_AUTH"
enum:
- "SSH_PASSWORD_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
type: "object"
order: 10
title: "SSH Tunnel Method"
type: "object"
username:
description: "The username which is used to access the database."
order: 4
title: "User"
type: "string"
required:
- "host"
- "port"
- "connection_data"
- "username"
- "encryption"
- "tunnel_method"
- "cursor"
title: "Oracle Source Spec"
type: "object"
source-insightly:
properties:
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"
format: "date-time"
order: 0
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type:
- "string"
- "null"
token:
airbyte_secret: true
description: "Your Insightly API token."
order: 1
title: "API Token"
type:
- "string"
- "null"
x-speakeasy-param-sensitive: true
sourceType:
title: "insightly"
const: "insightly"
enum:
- "insightly"
order: 0
type: "string"
required:
- "start_date"
- "token"
- "sourceType"
type: "object"
source-insightly-update:
properties:
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"
format: "date-time"
order: 0
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type:
- "string"
- "null"
token:
airbyte_secret: true
description: "Your Insightly API token."
order: 1
title: "API Token"
type:
- "string"
- "null"
required:
- "start_date"
- "token"
type: "object"
source-zoho-desk:
properties:
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
x-speakeasy-param-sensitive: true
include_custom_domain:
order: 4
title: "include Custom Domain"
type: "boolean"
refresh_token:
airbyte_secret: true
name: "refresh_token"
order: 3
title: "OAuth Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
token_refresh_endpoint:
name: "token_refresh_endpoint"
order: 2
title: "Token Refresh Endpoint"
type: "string"
sourceType:
title: "zoho-desk"
const: "zoho-desk"
enum:
- "zoho-desk"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "token_refresh_endpoint"
- "refresh_token"
- "sourceType"
type: "object"
source-zoho-desk-update:
properties:
client_id:
airbyte_secret: true
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
order: 1
title: "Client secret"
type: "string"
include_custom_domain:
order: 4
title: "include Custom Domain"
type: "boolean"
refresh_token:
airbyte_secret: true
name: "refresh_token"
order: 3
title: "OAuth Refresh Token"
type: "string"
token_refresh_endpoint:
name: "token_refresh_endpoint"
order: 2
title: "Token Refresh Endpoint"
type: "string"
required:
- "client_id"
- "client_secret"
- "token_refresh_endpoint"
- "refresh_token"
type: "object"
source-pipeliner:
properties:
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
service:
enum:
- "eu-central"
- "us-east"
- "ca-central"
- "ap-southeast"
order: 2
title: "Data Center"
type: "string"
spaceid:
order: 3
title: "Space ID"
type: "string"
username:
order: 0
title: "Username"
type: "string"
sourceType:
title: "pipeliner"
const: "pipeliner"
enum:
- "pipeliner"
order: 0
type: "string"
required:
- "username"
- "service"
- "spaceid"
- "sourceType"
type: "object"
source-pipeliner-update:
properties:
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
service:
enum:
- "eu-central"
- "us-east"
- "ca-central"
- "ap-southeast"
order: 2
title: "Data Center"
type: "string"
spaceid:
order: 3
title: "Space ID"
type: "string"
username:
order: 0
title: "Username"
type: "string"
required:
- "username"
- "service"
- "spaceid"
type: "object"
source-opinion-stage:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "opinion-stage"
const: "opinion-stage"
enum:
- "opinion-stage"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-opinion-stage-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-cart:
properties:
credentials:
description: ""
oneOf:
- order: 0
properties:
auth_type:
const: "CENTRAL_API_ROUTER"
order: 0
type: "string"
enum:
- "CENTRAL_API_ROUTER"
site_id:
airbyte_secret: true
description: "You can determine a site provisioning site Id by hitting\
\ https://site.com/store/sitemonitor.aspx and reading the response\
\ param PSID"
order: 3
title: "Site ID"
type: "string"
x-speakeasy-param-sensitive: true
user_name:
airbyte_secret: true
description: "Enter your application's User Name"
order: 1
title: "User Name"
type: "string"
x-speakeasy-param-sensitive: true
user_secret:
airbyte_secret: true
description: "Enter your application's User Secret"
order: 2
title: "User Secret"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_type"
- "user_name"
- "user_secret"
- "site_id"
title: "Central API Router"
type: "object"
- order: 1
properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests."
order: 1
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "SINGLE_STORE_ACCESS_TOKEN"
order: 0
type: "string"
enum:
- "SINGLE_STORE_ACCESS_TOKEN"
store_name:
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."
order: 2
title: "Store Name"
type: "string"
required:
- "auth_type"
- "access_token"
- "store_name"
title: "Single Store Access Token"
type: "object"
title: "Authorization Method"
type: "object"
start_date:
description: "The date from which you'd like to replicate the data"
examples:
- "2021-01-01T00:00:00Z"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
sourceType:
title: "cart"
const: "cart"
enum:
- "cart"
order: 0
type: "string"
required:
- "start_date"
- "sourceType"
title: "Cart.com Spec"
type: "object"
source-cart-update:
properties:
credentials:
description: ""
oneOf:
- order: 0
properties:
auth_type:
const: "CENTRAL_API_ROUTER"
order: 0
type: "string"
enum:
- "CENTRAL_API_ROUTER"
site_id:
airbyte_secret: true
description: "You can determine a site provisioning site Id by hitting\
\ https://site.com/store/sitemonitor.aspx and reading the response\
\ param PSID"
order: 3
title: "Site ID"
type: "string"
user_name:
airbyte_secret: true
description: "Enter your application's User Name"
order: 1
title: "User Name"
type: "string"
user_secret:
airbyte_secret: true
description: "Enter your application's User Secret"
order: 2
title: "User Secret"
type: "string"
required:
- "auth_type"
- "user_name"
- "user_secret"
- "site_id"
title: "Central API Router"
type: "object"
- order: 1
properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests."
order: 1
title: "Access Token"
type: "string"
auth_type:
const: "SINGLE_STORE_ACCESS_TOKEN"
order: 0
type: "string"
enum:
- "SINGLE_STORE_ACCESS_TOKEN"
store_name:
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."
order: 2
title: "Store Name"
type: "string"
required:
- "auth_type"
- "access_token"
- "store_name"
title: "Single Store Access Token"
type: "object"
title: "Authorization Method"
type: "object"
start_date:
description: "The date from which you'd like to replicate the data"
examples:
- "2021-01-01T00:00:00Z"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
required:
- "start_date"
title: "Cart.com Spec"
type: "object"
source-oracle:
properties:
connection_data:
description: "Connect data that will be used for DB connection"
oneOf:
- description: "Use service name"
properties:
connection_type:
const: "service_name"
order: 0
type: "string"
enum:
- "service_name"
service_name:
order: 1
title: "Service name"
type: "string"
required:
- "service_name"
title: "Service name"
- description: "Use SID (Oracle System Identifier)"
properties:
connection_type:
const: "sid"
order: 0
type: "string"
enum:
- "sid"
sid:
order: 1
title: "System ID (SID)"
type: "string"
required:
- "sid"
title: "System ID (SID)"
order: 3
title: "Connect by"
type: "object"
encryption:
description: "The encryption method with is used when communicating with\
\ the database."
oneOf:
- description: "Data transfer will not be encrypted."
properties:
encryption_method:
const: "unencrypted"
type: "string"
enum:
- "unencrypted"
required:
- "encryption_method"
title: "Unencrypted"
- 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."
properties:
encryption_algorithm:
default: "AES256"
description: "This parameter defines what encryption algorithm is\
\ used."
enum:
- "AES256"
- "RC4_56"
- "3DES168"
title: "Encryption Algorithm"
type: "string"
encryption_method:
const: "client_nne"
type: "string"
enum:
- "client_nne"
required:
- "encryption_method"
title: "Native Network Encryption (NNE)"
- description: "Verify and use the certificate provided by the server."
properties:
encryption_method:
const: "encrypted_verify_certificate"
type: "string"
enum:
- "encrypted_verify_certificate"
ssl_certificate:
airbyte_secret: true
description: "Privacy Enhanced Mail (PEM) files are concatenated certificate\
\ containers frequently used in certificate installations."
multiline: true
order: 4
title: "SSL PEM File"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "encryption_method"
- "ssl_certificate"
title: "TLS Encrypted (verify certificate)"
order: 8
title: "Encryption"
type: "object"
host:
description: "Hostname of the database."
order: 1
title: "Host"
type: "string"
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)."
order: 7
title: "JDBC URL Params"
type: "string"
password:
airbyte_secret: true
description: "The password associated with the username."
order: 5
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
port:
default: 1521
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"
maximum: 65536
minimum: 0
order: 2
title: "Port"
type: "integer"
schemas:
description: "The list of schemas to sync from. Defaults to user. Case sensitive."
items:
type: "string"
minItems: 1
order: 6
title: "Schemas"
type: "array"
uniqueItems: true
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- properties:
tunnel_method:
const: "NO_TUNNEL"
description: "No ssh tunnel needed to connect to database"
order: 0
type: "string"
enum:
- "NO_TUNNEL"
required:
- "tunnel_method"
title: "No Tunnel"
- properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
x-speakeasy-param-sensitive: true
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_KEY_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host."
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
- properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
title: "SSH Tunnel Method"
type: "object"
username:
description: "The username which is used to access the database."
order: 4
title: "User"
type: "string"
sourceType:
title: "oracle"
const: "oracle"
enum:
- "oracle"
order: 0
type: "string"
required:
- "host"
- "port"
- "username"
- "sourceType"
title: "Oracle Source Spec"
type: "object"
source-oracle-update:
properties:
connection_data:
description: "Connect data that will be used for DB connection"
oneOf:
- description: "Use service name"
properties:
connection_type:
const: "service_name"
order: 0
type: "string"
enum:
- "service_name"
service_name:
order: 1
title: "Service name"
type: "string"
required:
- "service_name"
title: "Service name"
- description: "Use SID (Oracle System Identifier)"
properties:
connection_type:
const: "sid"
order: 0
type: "string"
enum:
- "sid"
sid:
order: 1
title: "System ID (SID)"
type: "string"
required:
- "sid"
title: "System ID (SID)"
order: 3
title: "Connect by"
type: "object"
encryption:
description: "The encryption method with is used when communicating with\
\ the database."
oneOf:
- description: "Data transfer will not be encrypted."
properties:
encryption_method:
const: "unencrypted"
type: "string"
enum:
- "unencrypted"
required:
- "encryption_method"
title: "Unencrypted"
- 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."
properties:
encryption_algorithm:
default: "AES256"
description: "This parameter defines what encryption algorithm is\
\ used."
enum:
- "AES256"
- "RC4_56"
- "3DES168"
title: "Encryption Algorithm"
type: "string"
encryption_method:
const: "client_nne"
type: "string"
enum:
- "client_nne"
required:
- "encryption_method"
title: "Native Network Encryption (NNE)"
- description: "Verify and use the certificate provided by the server."
properties:
encryption_method:
const: "encrypted_verify_certificate"
type: "string"
enum:
- "encrypted_verify_certificate"
ssl_certificate:
airbyte_secret: true
description: "Privacy Enhanced Mail (PEM) files are concatenated certificate\
\ containers frequently used in certificate installations."
multiline: true
order: 4
title: "SSL PEM File"
type: "string"
required:
- "encryption_method"
- "ssl_certificate"
title: "TLS Encrypted (verify certificate)"
order: 8
title: "Encryption"
type: "object"
host:
description: "Hostname of the database."
order: 1
title: "Host"
type: "string"
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)."
order: 7
title: "JDBC URL Params"
type: "string"
password:
airbyte_secret: true
description: "The password associated with the username."
order: 5
title: "Password"
type: "string"
port:
default: 1521
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"
maximum: 65536
minimum: 0
order: 2
title: "Port"
type: "integer"
schemas:
description: "The list of schemas to sync from. Defaults to user. Case sensitive."
items:
type: "string"
minItems: 1
order: 6
title: "Schemas"
type: "array"
uniqueItems: true
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- properties:
tunnel_method:
const: "NO_TUNNEL"
description: "No ssh tunnel needed to connect to database"
order: 0
type: "string"
enum:
- "NO_TUNNEL"
required:
- "tunnel_method"
title: "No Tunnel"
- properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_KEY_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host."
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
- properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
title: "SSH Tunnel Method"
type: "object"
username:
description: "The username which is used to access the database."
order: 4
title: "User"
type: "string"
required:
- "host"
- "port"
- "username"
title: "Oracle Source Spec"
type: "object"
source-chartmogul:
properties:
api_key:
airbyte_secret: true
description: "Your Chartmogul API key. See the docs for info on how to obtain this."
order: 0
title: "API key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
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"
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "chartmogul"
const: "chartmogul"
enum:
- "chartmogul"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-chartmogul-update:
properties:
api_key:
airbyte_secret: true
description: "Your Chartmogul API key. See the docs for info on how to obtain this."
order: 0
title: "API key"
type: "string"
start_date:
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"
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-coinmarketcap:
properties:
api_key:
airbyte_secret: true
description: "Your API Key. See here. The token is case sensitive."
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
data_type:
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."
enum:
- "latest"
- "historical"
order: 1
title: "Data type"
type: "string"
symbols:
description: "Cryptocurrency symbols. (only used for quotes stream)"
examples:
- "AVAX"
- "BTC"
items:
type: "string"
minItems: 1
order: 2
title: "Symbol"
type: "array"
sourceType:
title: "coinmarketcap"
const: "coinmarketcap"
enum:
- "coinmarketcap"
order: 0
type: "string"
required:
- "api_key"
- "data_type"
- "sourceType"
type: "object"
source-coinmarketcap-update:
properties:
api_key:
airbyte_secret: true
description: "Your API Key. See here. The token is case sensitive."
order: 0
title: "API Key"
type: "string"
data_type:
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."
enum:
- "latest"
- "historical"
order: 1
title: "Data type"
type: "string"
symbols:
description: "Cryptocurrency symbols. (only used for quotes stream)"
examples:
- "AVAX"
- "BTC"
items:
type: "string"
minItems: 1
order: 2
title: "Symbol"
type: "array"
required:
- "api_key"
- "data_type"
type: "object"
source-simplecast:
properties:
api_token:
airbyte_secret: true
description: "API token to use. Find it at your Private Apps page on the\
\ Simplecast dashboard."
name: "api_token"
order: 0
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "simplecast"
const: "simplecast"
enum:
- "simplecast"
order: 0
type: "string"
required:
- "api_token"
- "sourceType"
type: "object"
source-simplecast-update:
properties:
api_token:
airbyte_secret: true
description: "API token to use. Find it at your Private Apps page on the\
\ Simplecast dashboard."
name: "api_token"
order: 0
title: "API Token"
type: "string"
required:
- "api_token"
type: "object"
source-recharge:
properties:
access_token:
airbyte_secret: true
description: "The value of the Access Token generated. See the docs for\
\ more information."
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
lookback_window_days:
default: 0
description: "Specifies how many days of historical data should be reloaded\
\ each time the recharge connector runs."
title: "Lookback Window (in days)"
type: "integer"
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"
format: "date-time"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
use_orders_deprecated_api:
default: true
description: "Define whether or not the `Orders` stream should use the deprecated\
\ `2021-01` API version, or use `2021-11`, otherwise."
title: "Use `Orders` Deprecated API"
type: "boolean"
sourceType:
title: "recharge"
const: "recharge"
enum:
- "recharge"
order: 0
type: "string"
required:
- "start_date"
- "access_token"
- "sourceType"
title: "Recharge Spec"
type: "object"
source-recharge-update:
properties:
access_token:
airbyte_secret: true
description: "The value of the Access Token generated. See the docs for\
\ more information."
title: "Access Token"
type: "string"
lookback_window_days:
default: 0
description: "Specifies how many days of historical data should be reloaded\
\ each time the recharge connector runs."
title: "Lookback Window (in days)"
type: "integer"
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"
format: "date-time"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
use_orders_deprecated_api:
default: true
description: "Define whether or not the `Orders` stream should use the deprecated\
\ `2021-01` API version, or use `2021-11`, otherwise."
title: "Use `Orders` Deprecated API"
type: "boolean"
required:
- "start_date"
- "access_token"
title: "Recharge Spec"
type: "object"
source-circleci:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
job_number:
default: "2"
description: "Job Number of the workflow for `jobs` stream, Auto fetches\
\ from `workflow_jobs` stream, if not configured"
order: 5
title: "Job Number"
type: "string"
org_id:
description: "The org ID found in `https://app.circleci.com/settings/organization/circleci/xxxxx/overview`"
order: 1
title: "Organization ID"
type: "string"
project_id:
description: "Project ID found in the project settings, Visit `https://app.circleci.com/settings/project/circleci/ORG_SLUG/YYYYY`"
order: 3
title: "Project ID"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
workflow_id:
description: "Workflow ID of a project pipeline, Could be seen in the URL\
\ of pipeline build, Example `https://app.circleci.com/pipelines/circleci/55555xxxxxx/7yyyyyyyyxxxxx/2/workflows/WORKFLOW_ID`"
order: 4
title: "Workflow ID"
type: "array"
sourceType:
title: "circleci"
const: "circleci"
enum:
- "circleci"
order: 0
type: "string"
required:
- "api_key"
- "org_id"
- "start_date"
- "project_id"
- "sourceType"
type: "object"
source-circleci-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
job_number:
default: "2"
description: "Job Number of the workflow for `jobs` stream, Auto fetches\
\ from `workflow_jobs` stream, if not configured"
order: 5
title: "Job Number"
type: "string"
org_id:
description: "The org ID found in `https://app.circleci.com/settings/organization/circleci/xxxxx/overview`"
order: 1
title: "Organization ID"
type: "string"
project_id:
description: "Project ID found in the project settings, Visit `https://app.circleci.com/settings/project/circleci/ORG_SLUG/YYYYY`"
order: 3
title: "Project ID"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
workflow_id:
description: "Workflow ID of a project pipeline, Could be seen in the URL\
\ of pipeline build, Example `https://app.circleci.com/pipelines/circleci/55555xxxxxx/7yyyyyyyyxxxxx/2/workflows/WORKFLOW_ID`"
order: 4
title: "Workflow ID"
type: "array"
required:
- "api_key"
- "org_id"
- "start_date"
- "project_id"
type: "object"
source-persona:
properties:
api_key:
airbyte_secret: true
description: "API key or access token"
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "persona"
const: "persona"
enum:
- "persona"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-persona-update:
properties:
api_key:
airbyte_secret: true
description: "API key or access token"
name: "api_key"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-zoho-inventory:
properties:
client_id:
airbyte_secret: true
name: "client_id"
order: 1
title: "OAuth Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
name: "client_secret"
order: 2
title: "OAuth Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
domain:
default: "com"
description: "The domain suffix for the Zoho Inventory API based on your\
\ data center location (e.g., 'com', 'eu', 'in', etc.)"
enum:
- "com"
- "in"
- "jp"
- "eu"
- "com.au"
- "ca"
- "com.cn"
- "sa"
name: "domain"
order: 0
title: "Domain"
type: "string"
refresh_token:
airbyte_secret: true
name: "refresh_token"
order: 3
title: "OAuth Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "zoho-inventory"
const: "zoho-inventory"
enum:
- "zoho-inventory"
order: 0
type: "string"
required:
- "domain"
- "client_id"
- "client_secret"
- "refresh_token"
- "start_date"
- "sourceType"
type: "object"
source-zoho-inventory-update:
properties:
client_id:
airbyte_secret: true
name: "client_id"
order: 1
title: "OAuth Client ID"
type: "string"
client_secret:
airbyte_secret: true
name: "client_secret"
order: 2
title: "OAuth Client Secret"
type: "string"
domain:
default: "com"
description: "The domain suffix for the Zoho Inventory API based on your\
\ data center location (e.g., 'com', 'eu', 'in', etc.)"
enum:
- "com"
- "in"
- "jp"
- "eu"
- "com.au"
- "ca"
- "com.cn"
- "sa"
name: "domain"
order: 0
title: "Domain"
type: "string"
refresh_token:
airbyte_secret: true
name: "refresh_token"
order: 3
title: "OAuth Refresh Token"
type: "string"
start_date:
format: "date-time"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "domain"
- "client_id"
- "client_secret"
- "refresh_token"
- "start_date"
type: "object"
source-salesflare:
properties:
api_key:
airbyte_secret: true
description: "Enter you api key like this : Bearer YOUR_API_KEY"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "salesflare"
const: "salesflare"
enum:
- "salesflare"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-salesflare-update:
properties:
api_key:
airbyte_secret: true
description: "Enter you api key like this : Bearer YOUR_API_KEY"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-boldsign:
properties:
api_key:
airbyte_secret: true
description: "Your BoldSign API key. You can generate it by navigating to\
\ the API menu in the BoldSign app, selecting 'API Key', and clicking\
\ 'Generate API Key'. Copy the generated key and paste it here."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "boldsign"
const: "boldsign"
enum:
- "boldsign"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-boldsign-update:
properties:
api_key:
airbyte_secret: true
description: "Your BoldSign API key. You can generate it by navigating to\
\ the API menu in the BoldSign app, selecting 'API Key', and clicking\
\ 'Generate API Key'. Copy the generated key and paste it here."
name: "api_key"
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-brevo:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "brevo"
const: "brevo"
enum:
- "brevo"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-brevo-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-partnerize:
properties:
application_key:
airbyte_secret: true
description: "The application key identifies the network you are making\
\ the request against. Find it in your account settings under 'User Application\
\ Key' at https://console.partnerize.com."
name: "application_key"
order: 1
title: "Application Key"
type: "string"
x-speakeasy-param-sensitive: true
user_api_key:
airbyte_secret: true
description: "The user API key identifies the user on whose behalf the request\
\ is made. Find it in your account settings under 'User API Key' at https://console.partnerize.com."
name: "user_api_key"
order: 0
title: "User API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "partnerize"
const: "partnerize"
enum:
- "partnerize"
order: 0
type: "string"
required:
- "user_api_key"
- "application_key"
- "sourceType"
type: "object"
source-partnerize-update:
properties:
application_key:
airbyte_secret: true
description: "The application key identifies the network you are making\
\ the request against. Find it in your account settings under 'User Application\
\ Key' at https://console.partnerize.com."
name: "application_key"
order: 1
title: "Application Key"
type: "string"
user_api_key:
airbyte_secret: true
description: "The user API key identifies the user on whose behalf the request\
\ is made. Find it in your account settings under 'User API Key' at https://console.partnerize.com."
name: "user_api_key"
order: 0
title: "User API Key"
type: "string"
required:
- "user_api_key"
- "application_key"
type: "object"
source-finage:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
period:
description: "Time period. Default is 10"
order: 4
title: "Period"
type: "string"
start_date:
format: "date-time"
order: 7
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
symbols:
description: "List of symbols "
order: 1
title: "Symbols"
type: "array"
tech_indicator_type:
default: "SMA"
description: "One of DEMA, EMA, SMA, WMA, RSI, TEMA, Williams, ADX "
enum:
- "DEMA"
- "EMA"
- "SMA"
- "WMA"
- "RSI"
- "TEMA"
- "Williams"
- "ADX"
order: 2
title: "Technical Indicator Type"
type: "string"
time:
default: "daily"
enum:
- "daily"
- "1min"
- "5min"
- "15min"
- "30min"
- "1hour"
- "4hour"
order: 3
title: "Time Interval"
type: "string"
time_aggregates:
default: "day"
description: "Size of the time"
enum:
- "minute"
- "hour"
- "day"
- "week"
- "month"
- "quarter"
- "year"
order: 5
title: "Time aggregates"
type: "string"
time_period:
description: "Time Period for cash flow stmts"
enum:
- "annual"
- "quarter"
order: 6
title: "Time Period"
type: "string"
sourceType:
title: "finage"
const: "finage"
enum:
- "finage"
order: 0
type: "string"
required:
- "api_key"
- "symbols"
- "start_date"
- "sourceType"
type: "object"
source-finage-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
period:
description: "Time period. Default is 10"
order: 4
title: "Period"
type: "string"
start_date:
format: "date-time"
order: 7
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
symbols:
description: "List of symbols "
order: 1
title: "Symbols"
type: "array"
tech_indicator_type:
default: "SMA"
description: "One of DEMA, EMA, SMA, WMA, RSI, TEMA, Williams, ADX "
enum:
- "DEMA"
- "EMA"
- "SMA"
- "WMA"
- "RSI"
- "TEMA"
- "Williams"
- "ADX"
order: 2
title: "Technical Indicator Type"
type: "string"
time:
default: "daily"
enum:
- "daily"
- "1min"
- "5min"
- "15min"
- "30min"
- "1hour"
- "4hour"
order: 3
title: "Time Interval"
type: "string"
time_aggregates:
default: "day"
description: "Size of the time"
enum:
- "minute"
- "hour"
- "day"
- "week"
- "month"
- "quarter"
- "year"
order: 5
title: "Time aggregates"
type: "string"
time_period:
description: "Time Period for cash flow stmts"
enum:
- "annual"
- "quarter"
order: 6
title: "Time Period"
type: "string"
required:
- "api_key"
- "symbols"
- "start_date"
type: "object"
source-datascope:
properties:
api_key:
airbyte_secret: true
description: "API Key"
order: 0
title: "Authorization"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "Start date for the data to be replicated"
examples:
- "dd/mm/YYYY HH:MM"
order: 1
pattern: "^[0-9]{2}/[0-9]{2}/[0-9]{4} [0-9]{2}:[0-9]{2}$"
title: "Start Date"
type: "string"
sourceType:
title: "datascope"
const: "datascope"
enum:
- "datascope"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-datascope-update:
properties:
api_key:
airbyte_secret: true
description: "API Key"
order: 0
title: "Authorization"
type: "string"
start_date:
description: "Start date for the data to be replicated"
examples:
- "dd/mm/YYYY HH:MM"
order: 1
pattern: "^[0-9]{2}/[0-9]{2}/[0-9]{4} [0-9]{2}:[0-9]{2}$"
title: "Start Date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-reply-io:
properties:
api_key:
airbyte_secret: true
description: "The API Token for Reply"
order: 0
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "reply-io"
const: "reply-io"
enum:
- "reply-io"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-reply-io-update:
properties:
api_key:
airbyte_secret: true
description: "The API Token for Reply"
order: 0
title: "API Token"
type: "string"
required:
- "api_key"
type: "object"
source-mixmax:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "mixmax"
const: "mixmax"
enum:
- "mixmax"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-mixmax-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-bing-ads:
properties:
account_names:
description: "Predicates that will be used to sync data by specific accounts."
items:
description: "Account Names Predicates Config."
properties:
name:
description: "Account Name is a string value for comparing with the\
\ specified predicate."
title: "Account Name"
type: "string"
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"
enum:
- "Contains"
- "Equals"
title: "Operator"
type: "string"
required:
- "operator"
- "name"
type: "object"
order: 5
title: "Account Names Predicates"
type: "array"
auth_method:
const: "oauth2.0"
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The Client ID of your Microsoft Advertising developer application."
order: 1
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
default: ""
description: "The Client Secret of your Microsoft Advertising developer\
\ application."
order: 2
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
custom_reports:
description: "You can add your Custom Bing Ads report by creating one."
items:
properties:
disable_custom_report_names_camel_to_snake_conversion:
default: false
description: "When enabled, disables the automatic conversion of custom\
\ report names from camelCase to snake_case. By default, custom\
\ report names are automatically converted (e.g., 'MyCustomReport'\
\ becomes 'my_custom_report'). Enable this option if you want to\
\ use the exact report names you specify."
title: "Disable Custom Report Names Camel to Snake Case Conversion"
type: "boolean"
name:
description: "The name of the custom report, this name would be used\
\ as stream name"
examples:
- "Account Performance"
- "AdDynamicTextPerformanceReport"
- "custom report"
title: "Report Name"
type: "string"
report_aggregation:
default:
- "Hourly"
description: "A list of available aggregations."
items:
description: "An enumeration of aggregations."
enum:
- "Hourly"
- "Daily"
- "Weekly"
- "Monthly"
- "DayOfWeek"
- "HourOfDay"
- "WeeklyStartingMonday"
- "Summary"
title: "ValidEnums"
title: "Aggregation"
type: "string"
report_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."
items:
description: "Name of report column."
type: "string"
minItems: 1
title: "Columns"
type: "array"
reporting_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."
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"
title: "Reporting Data Object"
type: "string"
required:
- "name"
- "reporting_object"
- "report_columns"
- "report_aggregation"
title: "Custom Report Config"
type: "object"
order: 8
title: "Custom Reports"
type: "array"
developer_token:
airbyte_secret: true
description: "Developer token associated with user. See more info in the docs."
order: 4
title: "Developer Token"
type: "string"
x-speakeasy-param-sensitive: true
lookback_window:
default: 0
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."
maximum: 90
minimum: 0
order: 7
title: "Lookback window"
type: "integer"
refresh_token:
airbyte_secret: true
description: "Refresh Token to renew the expired Access Token."
order: 3
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
reports_start_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."
format: "date"
order: 6
title: "Reports replication start date"
type: "string"
tenant_id:
airbyte_secret: true
default: "common"
description: "The Tenant ID of your Microsoft Advertising developer application.\
\ Set this to \"common\" unless you know you need a different value."
order: 0
title: "Tenant ID"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "bing-ads"
const: "bing-ads"
enum:
- "bing-ads"
order: 0
type: "string"
required:
- "developer_token"
- "client_id"
- "refresh_token"
- "sourceType"
title: "Bing Ads Spec"
type: "object"
source-bing-ads-update:
properties:
account_names:
description: "Predicates that will be used to sync data by specific accounts."
items:
description: "Account Names Predicates Config."
properties:
name:
description: "Account Name is a string value for comparing with the\
\ specified predicate."
title: "Account Name"
type: "string"
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"
enum:
- "Contains"
- "Equals"
title: "Operator"
type: "string"
required:
- "operator"
- "name"
type: "object"
order: 5
title: "Account Names Predicates"
type: "array"
auth_method:
const: "oauth2.0"
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The Client ID of your Microsoft Advertising developer application."
order: 1
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
default: ""
description: "The Client Secret of your Microsoft Advertising developer\
\ application."
order: 2
title: "Client Secret"
type: "string"
custom_reports:
description: "You can add your Custom Bing Ads report by creating one."
items:
properties:
disable_custom_report_names_camel_to_snake_conversion:
default: false
description: "When enabled, disables the automatic conversion of custom\
\ report names from camelCase to snake_case. By default, custom\
\ report names are automatically converted (e.g., 'MyCustomReport'\
\ becomes 'my_custom_report'). Enable this option if you want to\
\ use the exact report names you specify."
title: "Disable Custom Report Names Camel to Snake Case Conversion"
type: "boolean"
name:
description: "The name of the custom report, this name would be used\
\ as stream name"
examples:
- "Account Performance"
- "AdDynamicTextPerformanceReport"
- "custom report"
title: "Report Name"
type: "string"
report_aggregation:
default:
- "Hourly"
description: "A list of available aggregations."
items:
description: "An enumeration of aggregations."
enum:
- "Hourly"
- "Daily"
- "Weekly"
- "Monthly"
- "DayOfWeek"
- "HourOfDay"
- "WeeklyStartingMonday"
- "Summary"
title: "ValidEnums"
title: "Aggregation"
type: "string"
report_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."
items:
description: "Name of report column."
type: "string"
minItems: 1
title: "Columns"
type: "array"
reporting_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."
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"
title: "Reporting Data Object"
type: "string"
required:
- "name"
- "reporting_object"
- "report_columns"
- "report_aggregation"
title: "Custom Report Config"
type: "object"
order: 8
title: "Custom Reports"
type: "array"
developer_token:
airbyte_secret: true
description: "Developer token associated with user. See more info in the docs."
order: 4
title: "Developer Token"
type: "string"
lookback_window:
default: 0
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."
maximum: 90
minimum: 0
order: 7
title: "Lookback window"
type: "integer"
refresh_token:
airbyte_secret: true
description: "Refresh Token to renew the expired Access Token."
order: 3
title: "Refresh Token"
type: "string"
reports_start_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."
format: "date"
order: 6
title: "Reports replication start date"
type: "string"
tenant_id:
airbyte_secret: true
default: "common"
description: "The Tenant ID of your Microsoft Advertising developer application.\
\ Set this to \"common\" unless you know you need a different value."
order: 0
title: "Tenant ID"
type: "string"
required:
- "developer_token"
- "client_id"
- "refresh_token"
title: "Bing Ads Spec"
type: "object"
source-twelve-data:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
country:
description: "Where instrument is traded"
order: 1
title: "Country"
type: "string"
exchange:
description: "Where instrument is traded"
order: 2
title: "Exchange"
type: "string"
interval:
default: "1day"
description: "Between two consecutive points in time series Supports: 1min,\
\ 5min, 15min, 30min, 45min, 1h, 2h, 4h, 1day, 1week, 1month"
enum:
- "1min"
- "5min"
- "15min"
- "30min"
- "45min"
- "1h"
- "2h"
- "4h"
- "1day"
- "1week"
- "1month"
order: 4
title: "Interval"
type: "string"
symbol:
description: "Ticker of the instrument"
order: 3
title: "Symbol"
type: "string"
sourceType:
title: "twelve-data"
const: "twelve-data"
enum:
- "twelve-data"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-twelve-data-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
country:
description: "Where instrument is traded"
order: 1
title: "Country"
type: "string"
exchange:
description: "Where instrument is traded"
order: 2
title: "Exchange"
type: "string"
interval:
default: "1day"
description: "Between two consecutive points in time series Supports: 1min,\
\ 5min, 15min, 30min, 45min, 1h, 2h, 4h, 1day, 1week, 1month"
enum:
- "1min"
- "5min"
- "15min"
- "30min"
- "45min"
- "1h"
- "2h"
- "4h"
- "1day"
- "1week"
- "1month"
order: 4
title: "Interval"
type: "string"
symbol:
description: "Ticker of the instrument"
order: 3
title: "Symbol"
type: "string"
required:
- "api_key"
type: "object"
source-smartreach:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
teamid:
order: 1
title: "TeamID"
type: "number"
sourceType:
title: "smartreach"
const: "smartreach"
enum:
- "smartreach"
order: 0
type: "string"
required:
- "api_key"
- "teamid"
- "sourceType"
type: "object"
source-smartreach-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
teamid:
order: 1
title: "TeamID"
type: "number"
required:
- "api_key"
- "teamid"
type: "object"
source-tavus:
properties:
api_key:
airbyte_secret: true
description: "Your Tavus API key. You can find this in your Tavus account\
\ settings or API dashboard."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "tavus"
const: "tavus"
enum:
- "tavus"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-tavus-update:
properties:
api_key:
airbyte_secret: true
description: "Your Tavus API key. You can find this in your Tavus account\
\ settings or API dashboard."
name: "api_key"
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-monday:
properties:
board_ids:
description: "The IDs of the boards that the Items and Boards streams will\
\ extract records from. When left empty, streams will extract records\
\ from all boards that exist within the account."
items:
type: "integer"
title: "Boards to sync"
type: "array"
credentials:
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests."
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "oauth2.0"
order: 1
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The Client ID of your OAuth application."
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The Client Secret of your OAuth application."
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
subdomain:
default: ""
description: "Slug/subdomain of the account, or the first part of\
\ the URL that comes before .monday.com"
order: 0
title: "Subdomain/Slug"
type: "string"
required:
- "auth_type"
- "client_id"
- "client_secret"
- "access_token"
title: "OAuth2.0"
type: "object"
- properties:
api_token:
airbyte_secret: true
description: "API Token for making authenticated requests."
title: "Personal API Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "api_token"
order: 0
type: "string"
enum:
- "api_token"
required:
- "auth_type"
- "api_token"
title: "API Token"
type: "object"
title: "Authorization Method"
type: "object"
num_workers:
default: 4
description: "The number of worker threads to use for the sync."
examples:
- 1
- 2
- 3
maximum: 50
minimum: 2
title: "Number of concurrent threads"
type: "integer"
sourceType:
title: "monday"
const: "monday"
enum:
- "monday"
order: 0
type: "string"
required:
- "sourceType"
title: "Monday Spec"
type: "object"
source-monday-update:
properties:
board_ids:
description: "The IDs of the boards that the Items and Boards streams will\
\ extract records from. When left empty, streams will extract records\
\ from all boards that exist within the account."
items:
type: "integer"
title: "Boards to sync"
type: "array"
credentials:
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests."
title: "Access Token"
type: "string"
auth_type:
const: "oauth2.0"
order: 1
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The Client ID of your OAuth application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your OAuth application."
title: "Client Secret"
type: "string"
subdomain:
default: ""
description: "Slug/subdomain of the account, or the first part of\
\ the URL that comes before .monday.com"
order: 0
title: "Subdomain/Slug"
type: "string"
required:
- "auth_type"
- "client_id"
- "client_secret"
- "access_token"
title: "OAuth2.0"
type: "object"
- properties:
api_token:
airbyte_secret: true
description: "API Token for making authenticated requests."
title: "Personal API Token"
type: "string"
auth_type:
const: "api_token"
order: 0
type: "string"
enum:
- "api_token"
required:
- "auth_type"
- "api_token"
title: "API Token"
type: "object"
title: "Authorization Method"
type: "object"
num_workers:
default: 4
description: "The number of worker threads to use for the sync."
examples:
- 1
- 2
- 3
maximum: 50
minimum: 2
title: "Number of concurrent threads"
type: "integer"
required: []
title: "Monday Spec"
type: "object"
source-zapsign:
properties:
api_token:
airbyte_secret: true
description: "Your static API token for authentication. You can find it\
\ in your ZapSign account under the 'Settings' or 'API' section. For more\
\ details, refer to the [Getting Started](https://docs.zapsign.com.br/english/getting-started#how-do-i-get-my-api-token)\
\ guide."
name: "api_token"
order: 0
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
signer_ids:
description: "The signer ids for signer stream"
order: 2
title: "Signer IDs"
type: "array"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "zapsign"
const: "zapsign"
enum:
- "zapsign"
order: 0
type: "string"
required:
- "api_token"
- "start_date"
- "sourceType"
type: "object"
source-zapsign-update:
properties:
api_token:
airbyte_secret: true
description: "Your static API token for authentication. You can find it\
\ in your ZapSign account under the 'Settings' or 'API' section. For more\
\ details, refer to the [Getting Started](https://docs.zapsign.com.br/english/getting-started#how-do-i-get-my-api-token)\
\ guide."
name: "api_token"
order: 0
title: "API Token"
type: "string"
signer_ids:
description: "The signer ids for signer stream"
order: 2
title: "Signer IDs"
type: "array"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_token"
- "start_date"
type: "object"
source-docuseal:
properties:
api_key:
airbyte_secret: true
description: "Your API key for authenticating with the DocuSeal API. Obtain\
\ it from the DocuSeal API Console at https://console.docuseal.com/api."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
limit:
default: "5"
description: "The pagination limit"
order: 2
title: "Limit"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "docuseal"
const: "docuseal"
enum:
- "docuseal"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-docuseal-update:
properties:
api_key:
airbyte_secret: true
description: "Your API key for authenticating with the DocuSeal API. Obtain\
\ it from the DocuSeal API Console at https://console.docuseal.com/api."
name: "api_key"
order: 0
title: "API Key"
type: "string"
limit:
default: "5"
description: "The pagination limit"
order: 2
title: "Limit"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-onepagecrm:
properties:
password:
airbyte_secret: true
always_show: true
description: "Enter your API Key of your API app"
order: 1
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
username:
description: "Enter the user ID of your API app"
order: 0
title: "Username"
type: "string"
sourceType:
title: "onepagecrm"
const: "onepagecrm"
enum:
- "onepagecrm"
order: 0
type: "string"
required:
- "username"
- "sourceType"
type: "object"
source-onepagecrm-update:
properties:
password:
airbyte_secret: true
always_show: true
description: "Enter your API Key of your API app"
order: 1
title: "Password"
type: "string"
username:
description: "Enter the user ID of your API app"
order: 0
title: "Username"
type: "string"
required:
- "username"
type: "object"
source-financial-modelling:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
exchange:
default: "NASDAQ"
description: "The stock exchange : AMEX, AMS, AQS, ASX, ATH, BER, BME, BRU,\
\ BSE, BUD, BUE, BVC, CAI, CBOE, CNQ, CPH, DFM, DOH, DUS, DXE, EGX, EURONEXT,\
\ HAM, HEL, HKSE, ICE, IOB, IST, JKT, JNB, JPX, KLS, KOE, KSC, KUW, LSE,\
\ MCX, MEX, MIL, MUN, NASDAQ, NEO, NSE, NYSE, NZE, OEM, OQX, OSL, OTC,\
\ PNK, PRA, RIS, SAO, SAU, SES, SET, SGO, SHH, SHZ, SIX, STO, STU, TAI,\
\ TLV, TSX, TSXV, TWO, VIE, VSE, WSE, XETRA"
order: 1
title: "Exchange"
type: "string"
marketcaplowerthan:
description: "Used in screener to filter out stocks with a market cap lower\
\ than the give marketcap"
order: 3
title: "Market Cap Lower Than"
type: "string"
marketcapmorethan:
description: "Used in screener to filter out stocks with a market cap more\
\ than the give marketcap"
order: 2
title: "Market Cap More Than"
type: "string"
start_date:
format: "date-time"
order: 5
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
time_frame:
default: "4hour"
description: "For example 1min, 5min, 15min, 30min, 1hour, 4hour"
enum:
- "1min"
- "5min"
- "15min"
- "30min"
- "1hour"
- "4hour"
order: 4
title: "Time Frame"
type: "string"
sourceType:
title: "financial-modelling"
const: "financial-modelling"
enum:
- "financial-modelling"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-financial-modelling-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
exchange:
default: "NASDAQ"
description: "The stock exchange : AMEX, AMS, AQS, ASX, ATH, BER, BME, BRU,\
\ BSE, BUD, BUE, BVC, CAI, CBOE, CNQ, CPH, DFM, DOH, DUS, DXE, EGX, EURONEXT,\
\ HAM, HEL, HKSE, ICE, IOB, IST, JKT, JNB, JPX, KLS, KOE, KSC, KUW, LSE,\
\ MCX, MEX, MIL, MUN, NASDAQ, NEO, NSE, NYSE, NZE, OEM, OQX, OSL, OTC,\
\ PNK, PRA, RIS, SAO, SAU, SES, SET, SGO, SHH, SHZ, SIX, STO, STU, TAI,\
\ TLV, TSX, TSXV, TWO, VIE, VSE, WSE, XETRA"
order: 1
title: "Exchange"
type: "string"
marketcaplowerthan:
description: "Used in screener to filter out stocks with a market cap lower\
\ than the give marketcap"
order: 3
title: "Market Cap Lower Than"
type: "string"
marketcapmorethan:
description: "Used in screener to filter out stocks with a market cap more\
\ than the give marketcap"
order: 2
title: "Market Cap More Than"
type: "string"
start_date:
format: "date-time"
order: 5
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
time_frame:
default: "4hour"
description: "For example 1min, 5min, 15min, 30min, 1hour, 4hour"
enum:
- "1min"
- "5min"
- "15min"
- "30min"
- "1hour"
- "4hour"
order: 4
title: "Time Frame"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-waiteraid:
properties:
auth_hash:
airbyte_secret: true
description: "Your WaiterAid API key, obtained from API request with Username\
\ and Password"
order: 0
title: "Authentication Hash"
type: "string"
x-speakeasy-param-sensitive: true
restid:
airbyte_secret: true
description: "Your WaiterAid restaurant id from API request to getRestaurants"
order: 1
title: "Restaurant ID"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "Start getting data from that date."
examples:
- "YYYY-MM-DD"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
sourceType:
title: "waiteraid"
const: "waiteraid"
enum:
- "waiteraid"
order: 0
type: "string"
required:
- "auth_hash"
- "restid"
- "start_date"
- "sourceType"
type: "object"
source-waiteraid-update:
properties:
auth_hash:
airbyte_secret: true
description: "Your WaiterAid API key, obtained from API request with Username\
\ and Password"
order: 0
title: "Authentication Hash"
type: "string"
restid:
airbyte_secret: true
description: "Your WaiterAid restaurant id from API request to getRestaurants"
order: 1
title: "Restaurant ID"
type: "string"
start_date:
description: "Start getting data from that date."
examples:
- "YYYY-MM-DD"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
required:
- "auth_hash"
- "restid"
- "start_date"
type: "object"
source-shortcut:
properties:
api_key_2:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
query:
default: "title:Our first Epic"
description: "Query for searching as defined in `https://help.shortcut.com/hc/en-us/articles/360000046646-Searching-in-Shortcut-Using-Search-Operators`"
order: 2
title: "Query"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "shortcut"
const: "shortcut"
enum:
- "shortcut"
order: 0
type: "string"
required:
- "api_key_2"
- "start_date"
- "sourceType"
type: "object"
source-shortcut-update:
properties:
api_key_2:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
query:
default: "title:Our first Epic"
description: "Query for searching as defined in `https://help.shortcut.com/hc/en-us/articles/360000046646-Searching-in-Shortcut-Using-Search-Operators`"
order: 2
title: "Query"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key_2"
- "start_date"
type: "object"
source-pipedrive:
properties:
api_token:
airbyte_secret: true
description: "The Pipedrive API Token."
order: 0
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
replication_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"
order: 1
title: "Start Date"
type: "string"
sourceType:
title: "pipedrive"
const: "pipedrive"
enum:
- "pipedrive"
order: 0
type: "string"
required:
- "api_token"
- "replication_start_date"
- "sourceType"
type: "object"
source-pipedrive-update:
properties:
api_token:
airbyte_secret: true
description: "The Pipedrive API Token."
order: 0
title: "API Token"
type: "string"
replication_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"
order: 1
title: "Start Date"
type: "string"
required:
- "api_token"
- "replication_start_date"
type: "object"
source-gocardless:
properties:
access_token:
airbyte_secret: true
description: "Gocardless API TOKEN"
order: 0
pattern: "^(sandbox|live)_.+$"
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
gocardless_environment:
default: "sandbox"
description: "Environment you are trying to connect to."
enum:
- "sandbox"
- "live"
order: 1
title: "GoCardless API Environment"
type: "string"
gocardless_version:
description: "GoCardless version. This is a date. You can find the latest\
\ here: \nhttps://developer.gocardless.com/api-reference/#api-usage-making-requests\n"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "GoCardless API Version"
type: "string"
start_date:
description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\
\ data\nbefore this date will not be replicated.\n"
examples:
- "2017-01-25T00:00:00Z"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
sourceType:
title: "gocardless"
const: "gocardless"
enum:
- "gocardless"
order: 0
type: "string"
required:
- "access_token"
- "gocardless_environment"
- "gocardless_version"
- "start_date"
- "sourceType"
type: "object"
source-gocardless-update:
properties:
access_token:
airbyte_secret: true
description: "Gocardless API TOKEN"
order: 0
pattern: "^(sandbox|live)_.+$"
title: "Access Token"
type: "string"
gocardless_environment:
default: "sandbox"
description: "Environment you are trying to connect to."
enum:
- "sandbox"
- "live"
order: 1
title: "GoCardless API Environment"
type: "string"
gocardless_version:
description: "GoCardless version. This is a date. You can find the latest\
\ here: \nhttps://developer.gocardless.com/api-reference/#api-usage-making-requests\n"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "GoCardless API Version"
type: "string"
start_date:
description: "UTC date and time in the format 2017-01-25T00:00:00Z. Any\
\ data\nbefore this date will not be replicated.\n"
examples:
- "2017-01-25T00:00:00Z"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
required:
- "access_token"
- "gocardless_environment"
- "gocardless_version"
- "start_date"
type: "object"
source-intruder:
properties:
access_token:
airbyte_secret: true
description: "Your API Access token. See here."
order: 0
title: "API Access token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "intruder"
const: "intruder"
enum:
- "intruder"
order: 0
type: "string"
required:
- "access_token"
- "sourceType"
type: "object"
source-intruder-update:
properties:
access_token:
airbyte_secret: true
description: "Your API Access token. See here."
order: 0
title: "API Access token"
type: "string"
required:
- "access_token"
type: "object"
source-microsoft-dataverse:
properties:
client_id:
airbyte_secret: true
description: "App Registration Client Id"
order: 2
title: "Client Id"
type: "string"
x-speakeasy-param-sensitive: true
client_secret_value:
airbyte_secret: true
description: "App Registration Client Secret"
order: 3
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
odata_maxpagesize:
default: 5000
description: "Max number of results per page. Default=5000"
order: 4
title: "Max page size"
type: "integer"
tenant_id:
airbyte_secret: true
description: "Tenant Id of your Microsoft Dataverse Instance"
order: 1
title: "Tenant Id"
type: "string"
x-speakeasy-param-sensitive: true
url:
description: "URL to Microsoft Dataverse API"
examples:
- "https://.crm.dynamics.com"
order: 0
title: "URL"
type: "string"
sourceType:
title: "microsoft-dataverse"
const: "microsoft-dataverse"
enum:
- "microsoft-dataverse"
order: 0
type: "string"
required:
- "url"
- "tenant_id"
- "client_id"
- "client_secret_value"
- "sourceType"
title: "Microsoft Dataverse Spec"
type: "object"
source-microsoft-dataverse-update:
properties:
client_id:
airbyte_secret: true
description: "App Registration Client Id"
order: 2
title: "Client Id"
type: "string"
client_secret_value:
airbyte_secret: true
description: "App Registration Client Secret"
order: 3
title: "Client Secret"
type: "string"
odata_maxpagesize:
default: 5000
description: "Max number of results per page. Default=5000"
order: 4
title: "Max page size"
type: "integer"
tenant_id:
airbyte_secret: true
description: "Tenant Id of your Microsoft Dataverse Instance"
order: 1
title: "Tenant Id"
type: "string"
url:
description: "URL to Microsoft Dataverse API"
examples:
- "https://.crm.dynamics.com"
order: 0
title: "URL"
type: "string"
required:
- "url"
- "tenant_id"
- "client_id"
- "client_secret_value"
title: "Microsoft Dataverse Spec"
type: "object"
source-fastbill:
properties:
api_key:
airbyte_secret: true
description: "Fastbill API key"
order: 1
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
username:
description: "Username for Fastbill account"
order: 0
title: "Username"
type: "string"
sourceType:
title: "fastbill"
const: "fastbill"
enum:
- "fastbill"
order: 0
type: "string"
required:
- "username"
- "api_key"
- "sourceType"
type: "object"
source-fastbill-update:
properties:
api_key:
airbyte_secret: true
description: "Fastbill API key"
order: 1
title: "API Key"
type: "string"
username:
description: "Username for Fastbill account"
order: 0
title: "Username"
type: "string"
required:
- "username"
- "api_key"
type: "object"
source-visma-economic:
properties:
agreement_grant_token:
airbyte_secret: true
description: "Identifier for the grant issued by an agreement"
order: 0
title: "Agreement Grant Token"
type: "string"
x-speakeasy-param-sensitive: true
app_secret_token:
airbyte_secret: true
description: "Identification token for app accessing data"
order: 1
title: "App Secret Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "visma-economic"
const: "visma-economic"
enum:
- "visma-economic"
order: 0
type: "string"
required:
- "agreement_grant_token"
- "app_secret_token"
- "sourceType"
type: "object"
source-visma-economic-update:
properties:
agreement_grant_token:
airbyte_secret: true
description: "Identifier for the grant issued by an agreement"
order: 0
title: "Agreement Grant Token"
type: "string"
app_secret_token:
airbyte_secret: true
description: "Identification token for app accessing data"
order: 1
title: "App Secret Token"
type: "string"
required:
- "agreement_grant_token"
- "app_secret_token"
type: "object"
source-invoiceninja:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "invoiceninja"
const: "invoiceninja"
enum:
- "invoiceninja"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-invoiceninja-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-sendpulse:
properties:
client_id:
airbyte_secret: true
name: "client_id"
order: 0
title: "OAuth Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
name: "client_secret"
order: 1
title: "OAuth Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "sendpulse"
const: "sendpulse"
enum:
- "sendpulse"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "sourceType"
type: "object"
source-sendpulse-update:
properties:
client_id:
airbyte_secret: true
name: "client_id"
order: 0
title: "OAuth Client ID"
type: "string"
client_secret:
airbyte_secret: true
name: "client_secret"
order: 1
title: "OAuth Client Secret"
type: "string"
required:
- "client_id"
- "client_secret"
type: "object"
source-bigquery:
properties:
credentials_json:
airbyte_secret: true
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"
type: "string"
x-speakeasy-param-sensitive: true
dataset_id:
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"
type: "string"
project_id:
description: "The GCP project ID for the project containing the target BigQuery\
\ dataset."
title: "Project ID"
type: "string"
sourceType:
title: "bigquery"
const: "bigquery"
enum:
- "bigquery"
order: 0
type: "string"
required:
- "project_id"
- "credentials_json"
- "sourceType"
title: "BigQuery Source Spec"
type: "object"
source-bigquery-update:
properties:
credentials_json:
airbyte_secret: true
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"
type: "string"
dataset_id:
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"
type: "string"
project_id:
description: "The GCP project ID for the project containing the target BigQuery\
\ dataset."
title: "Project ID"
type: "string"
required:
- "project_id"
- "credentials_json"
title: "BigQuery Source Spec"
type: "object"
source-gutendex:
properties:
author_year_end:
description: "(Optional) Defines the maximum birth year of the authors.\
\ Books by authors born after the end year will not be returned. Supports\
\ both positive (CE) or negative (BCE) integer values"
examples:
- 2002
- 500
- -500
- 2020
order: 0
pattern: "^[-]?[0-9]{1,4}$"
type: "string"
author_year_start:
description: "(Optional) Defines the minimum birth year of the authors.\
\ Books by authors born prior to the start year will not be returned.\
\ Supports both positive (CE) or negative (BCE) integer values"
examples:
- 2002
- 500
- -500
- 2020
order: 1
pattern: "^[-]?[0-9]{1,4}$"
type: "string"
copyright:
description: "(Optional) Use this to find books with a certain copyright\
\ status - true for books with existing copyrights, false for books in\
\ the public domain in the USA, or null for books with no available copyright\
\ information."
examples:
- true
- false
- null
order: 2
pattern: "^(true|false|null)$"
type: "string"
languages:
description: "(Optional) Use this to find books in any of a list of languages.\
\ They must be comma-separated, two-character language codes."
examples:
- "en"
- "en,fr,fi"
order: 3
type: "string"
search:
description: "(Optional) Use this to search author names and book titles\
\ with given words. They must be separated by a space (i.e. %20 in URL-encoded\
\ format) and are case-insensitive."
examples:
- "dickens%20great%20expect"
- "dickens"
order: 4
type: "string"
sort:
description: "(Optional) Use this to sort books - ascending for Project\
\ Gutenberg ID numbers from lowest to highest, descending for IDs highest\
\ to lowest, or popular (the default) for most popular to least popular\
\ by number of downloads."
examples:
- "ascending"
- "descending"
- "popular"
order: 5
pattern: "^(ascending|descending|popular)$"
type: "string"
topic:
description: "(Optional) Use this to search for a case-insensitive key-phrase\
\ in books' bookshelves or subjects."
examples:
- "children"
- "fantasy"
order: 6
type: "string"
sourceType:
title: "gutendex"
const: "gutendex"
enum:
- "gutendex"
order: 0
type: "string"
required:
- "sourceType"
type: "object"
source-gutendex-update:
properties:
author_year_end:
description: "(Optional) Defines the maximum birth year of the authors.\
\ Books by authors born after the end year will not be returned. Supports\
\ both positive (CE) or negative (BCE) integer values"
examples:
- 2002
- 500
- -500
- 2020
order: 0
pattern: "^[-]?[0-9]{1,4}$"
type: "string"
author_year_start:
description: "(Optional) Defines the minimum birth year of the authors.\
\ Books by authors born prior to the start year will not be returned.\
\ Supports both positive (CE) or negative (BCE) integer values"
examples:
- 2002
- 500
- -500
- 2020
order: 1
pattern: "^[-]?[0-9]{1,4}$"
type: "string"
copyright:
description: "(Optional) Use this to find books with a certain copyright\
\ status - true for books with existing copyrights, false for books in\
\ the public domain in the USA, or null for books with no available copyright\
\ information."
examples:
- true
- false
- null
order: 2
pattern: "^(true|false|null)$"
type: "string"
languages:
description: "(Optional) Use this to find books in any of a list of languages.\
\ They must be comma-separated, two-character language codes."
examples:
- "en"
- "en,fr,fi"
order: 3
type: "string"
search:
description: "(Optional) Use this to search author names and book titles\
\ with given words. They must be separated by a space (i.e. %20 in URL-encoded\
\ format) and are case-insensitive."
examples:
- "dickens%20great%20expect"
- "dickens"
order: 4
type: "string"
sort:
description: "(Optional) Use this to sort books - ascending for Project\
\ Gutenberg ID numbers from lowest to highest, descending for IDs highest\
\ to lowest, or popular (the default) for most popular to least popular\
\ by number of downloads."
examples:
- "ascending"
- "descending"
- "popular"
order: 5
pattern: "^(ascending|descending|popular)$"
type: "string"
topic:
description: "(Optional) Use this to search for a case-insensitive key-phrase\
\ in books' bookshelves or subjects."
examples:
- "children"
- "fantasy"
order: 6
type: "string"
required: []
type: "object"
source-vantage:
properties:
access_token:
airbyte_secret: true
description: "Your API Access token. See here."
order: 0
title: "API Access Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "vantage"
const: "vantage"
enum:
- "vantage"
order: 0
type: "string"
required:
- "access_token"
- "sourceType"
type: "object"
source-vantage-update:
properties:
access_token:
airbyte_secret: true
description: "Your API Access token. See here."
order: 0
title: "API Access Token"
type: "string"
required:
- "access_token"
type: "object"
source-tickettailor:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it at https://www.getdrip.com/user/edit"
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "tickettailor"
const: "tickettailor"
enum:
- "tickettailor"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-tickettailor-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it at https://www.getdrip.com/user/edit"
name: "api_key"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-calendly:
properties:
api_key:
airbyte_secret: true
description: "Go to Integrations → API & Webhooks to obtain your bearer\
\ token. https://calendly.com/integrations/api_webhooks"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
lookback_days:
default: 0
description: "Number of days to be subtracted from the last cutoff date\
\ before starting to sync the `scheduled_events` stream."
order: 2
title: "Lookback Days"
type: "number"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "calendly"
const: "calendly"
enum:
- "calendly"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-calendly-update:
properties:
api_key:
airbyte_secret: true
description: "Go to Integrations → API & Webhooks to obtain your bearer\
\ token. https://calendly.com/integrations/api_webhooks"
order: 0
title: "API Key"
type: "string"
lookback_days:
default: 0
description: "Number of days to be subtracted from the last cutoff date\
\ before starting to sync the `scheduled_events` stream."
order: 2
title: "Lookback Days"
type: "number"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-firebolt:
properties:
account:
description: "Firebolt account to login."
title: "Account"
type: "string"
client_id:
description: "Firebolt service account ID."
examples:
- "bbl9qth066hmxkwyb0hy2iwk8ktez9dz"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Firebolt secret, corresponding to the service account ID."
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
database:
description: "The database to connect to."
title: "Database"
type: "string"
engine:
description: "Engine name to connect to."
title: "Engine"
type: "string"
host:
description: "The host name of your Firebolt database."
examples:
- "api.app.firebolt.io"
title: "Host"
type: "string"
sourceType:
title: "firebolt"
const: "firebolt"
enum:
- "firebolt"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "account"
- "database"
- "engine"
- "sourceType"
title: "Firebolt Spec"
type: "object"
source-firebolt-update:
properties:
account:
description: "Firebolt account to login."
title: "Account"
type: "string"
client_id:
description: "Firebolt service account ID."
examples:
- "bbl9qth066hmxkwyb0hy2iwk8ktez9dz"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Firebolt secret, corresponding to the service account ID."
title: "Client Secret"
type: "string"
database:
description: "The database to connect to."
title: "Database"
type: "string"
engine:
description: "Engine name to connect to."
title: "Engine"
type: "string"
host:
description: "The host name of your Firebolt database."
examples:
- "api.app.firebolt.io"
title: "Host"
type: "string"
required:
- "client_id"
- "client_secret"
- "account"
- "database"
- "engine"
title: "Firebolt Spec"
type: "object"
source-navan:
properties:
client_id:
airbyte_secret: true
name: "client_id"
order: 0
title: "OAuth Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
name: "client_secret"
order: 1
title: "OAuth Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "navan"
const: "navan"
enum:
- "navan"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "start_date"
- "sourceType"
type: "object"
source-navan-update:
properties:
client_id:
airbyte_secret: true
name: "client_id"
order: 0
title: "OAuth Client ID"
type: "string"
client_secret:
airbyte_secret: true
name: "client_secret"
order: 1
title: "OAuth Client Secret"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "client_id"
- "client_secret"
- "start_date"
type: "object"
source-mantle:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "mantle"
const: "mantle"
enum:
- "mantle"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "sourceType"
type: "object"
source-mantle-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
type: "object"
source-eventee:
properties:
api_token:
airbyte_secret: true
description: "API token to use. Generate it at https://admin.eventee.co/\
\ in 'Settings -> Features'."
name: "api_token"
order: 0
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "eventee"
const: "eventee"
enum:
- "eventee"
order: 0
type: "string"
required:
- "api_token"
- "sourceType"
type: "object"
source-eventee-update:
properties:
api_token:
airbyte_secret: true
description: "API token to use. Generate it at https://admin.eventee.co/\
\ in 'Settings -> Features'."
name: "api_token"
order: 0
title: "API Token"
type: "string"
required:
- "api_token"
type: "object"
source-simfin:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "simfin"
const: "simfin"
enum:
- "simfin"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-simfin-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-pivotal-tracker:
properties:
api_token:
airbyte_secret: true
description: "Pivotal Tracker API token"
examples:
- "5c054d0de3440452190fdc5d5a04d871"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "pivotal-tracker"
const: "pivotal-tracker"
enum:
- "pivotal-tracker"
order: 0
type: "string"
required:
- "api_token"
- "sourceType"
title: "Pivotal Tracker Spec"
type: "object"
source-pivotal-tracker-update:
properties:
api_token:
airbyte_secret: true
description: "Pivotal Tracker API token"
examples:
- "5c054d0de3440452190fdc5d5a04d871"
type: "string"
required:
- "api_token"
title: "Pivotal Tracker Spec"
type: "object"
source-chargedesk:
properties:
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "Date from when the sync should start in epoch Unix timestamp"
order: 2
title: "Start Date"
type: "integer"
username:
order: 0
title: "Username"
type: "string"
sourceType:
title: "chargedesk"
const: "chargedesk"
enum:
- "chargedesk"
order: 0
type: "string"
required:
- "username"
- "sourceType"
type: "object"
source-chargedesk-update:
properties:
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
start_date:
description: "Date from when the sync should start in epoch Unix timestamp"
order: 2
title: "Start Date"
type: "integer"
username:
order: 0
title: "Username"
type: "string"
required:
- "username"
type: "object"
source-brex:
properties:
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
user_token:
airbyte_secret: true
description: "User token to authenticate API requests. Generate it from\
\ your Brex dashboard under Developer > Settings."
name: "user_token"
order: 0
title: "User Token"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "brex"
const: "brex"
enum:
- "brex"
order: 0
type: "string"
required:
- "user_token"
- "start_date"
- "sourceType"
type: "object"
source-brex-update:
properties:
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
user_token:
airbyte_secret: true
description: "User token to authenticate API requests. Generate it from\
\ your Brex dashboard under Developer > Settings."
name: "user_token"
order: 0
title: "User Token"
type: "string"
required:
- "user_token"
- "start_date"
type: "object"
source-workday-rest:
properties:
credentials:
description: "Credentials for connecting to the Workday (REST) API."
properties:
access_token:
airbyte_secret: true
description: "Follow the instructions in the \"OAuth 2.0 in Postman\
\ - API Client for Integrations\" article in the Workday community\
\ docs to obtain access token."
order: 0
title: "Access token."
type: "string"
x-speakeasy-param-sensitive: true
required:
- "access_token"
title: "Authentication"
type: "object"
host:
order: 1
title: "Workday hostname"
type: "string"
num_workers:
default: 20
description: "The number of worker threads to use for the sync."
examples:
- 1
- 2
- 3
maximum: 50
minimum: 1
title: "Number of concurrent threads"
type: "integer"
start_date:
description: "Rows after this date will be synced, default 2 years ago."
examples:
- "2024-10-26T07:00:00.000Z"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$"
title: "Start date"
type: "string"
tenant_id:
airbyte_secret: true
order: 0
title: "Workday tenant"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "workday-rest"
const: "workday-rest"
enum:
- "workday-rest"
order: 0
type: "string"
required:
- "tenant_id"
- "host"
- "credentials"
- "sourceType"
type: "object"
source-workday-rest-update:
properties:
credentials:
description: "Credentials for connecting to the Workday (REST) API."
properties:
access_token:
airbyte_secret: true
description: "Follow the instructions in the \"OAuth 2.0 in Postman\
\ - API Client for Integrations\" article in the Workday community\
\ docs to obtain access token."
order: 0
title: "Access token."
type: "string"
required:
- "access_token"
title: "Authentication"
type: "object"
host:
order: 1
title: "Workday hostname"
type: "string"
num_workers:
default: 20
description: "The number of worker threads to use for the sync."
examples:
- 1
- 2
- 3
maximum: 50
minimum: 1
title: "Number of concurrent threads"
type: "integer"
start_date:
description: "Rows after this date will be synced, default 2 years ago."
examples:
- "2024-10-26T07:00:00.000Z"
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$"
title: "Start date"
type: "string"
tenant_id:
airbyte_secret: true
order: 0
title: "Workday tenant"
type: "string"
required:
- "tenant_id"
- "host"
- "credentials"
type: "object"
source-fulcrum:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it at https://web.fulcrumapp.com/settings/api"
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "fulcrum"
const: "fulcrum"
enum:
- "fulcrum"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-fulcrum-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it at https://web.fulcrumapp.com/settings/api"
name: "api_key"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-nexiopay:
properties:
api_key:
airbyte_secret: true
description: "Your Nexio API key (password). You can find it in the Nexio\
\ Dashboard under Settings > User Management. Select the API user and\
\ copy the API key."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
subdomain:
default: "nexiopay"
description: "The subdomain for the Nexio API environment, such as 'nexiopaysandbox'\
\ or 'nexiopay'."
enum:
- "nexiopaysandbox"
- "nexiopay"
name: "subdomain"
order: 2
title: "Subdomain"
type: "string"
username:
description: "Your Nexio API username. You can find it in the Nexio Dashboard\
\ under Settings > User Management. Select the API user and copy the username."
name: "username"
order: 1
title: "API Username"
type: "string"
sourceType:
title: "nexiopay"
const: "nexiopay"
enum:
- "nexiopay"
order: 0
type: "string"
required:
- "api_key"
- "username"
- "subdomain"
- "start_date"
- "sourceType"
type: "object"
source-nexiopay-update:
properties:
api_key:
airbyte_secret: true
description: "Your Nexio API key (password). You can find it in the Nexio\
\ Dashboard under Settings > User Management. Select the API user and\
\ copy the API key."
name: "api_key"
order: 0
title: "API Key"
type: "string"
start_date:
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
subdomain:
default: "nexiopay"
description: "The subdomain for the Nexio API environment, such as 'nexiopaysandbox'\
\ or 'nexiopay'."
enum:
- "nexiopaysandbox"
- "nexiopay"
name: "subdomain"
order: 2
title: "Subdomain"
type: "string"
username:
description: "Your Nexio API username. You can find it in the Nexio Dashboard\
\ under Settings > User Management. Select the API user and copy the username."
name: "username"
order: 1
title: "API Username"
type: "string"
required:
- "api_key"
- "username"
- "subdomain"
- "start_date"
type: "object"
source-pagerduty:
properties:
cutoff_days:
default: 90
description: "Fetch pipelines updated in the last number of days"
order: 0
title: "Cutoff Days"
type: "integer"
default_severity:
description: "A default severity category if not present"
examples:
- "Sev1"
- "Sev2"
- "Sev3"
- "Sev4"
- "Sev5"
- "Custom"
order: 1
pattern: "^(Sev[0-5])?(Custom)?$"
title: "Severity category"
type: "string"
exclude_services:
description: "List of PagerDuty service names to ignore incidents from.\
\ If not set, all incidents will be pulled."
examples:
- "service-1"
- "service-2"
items:
type: "string"
order: 2
title: "Exclude Services"
type: "array"
incident_log_entries_overview:
default: true
description: "If true, will return a subset of log entries that show only\
\ the most important changes to the incident."
order: 3
title: "Incident Log Entries Overview"
type: "boolean"
max_retries:
default: 5
description: "Maximum number of PagerDuty API request retries to perform\
\ upon connection errors. The source will pause for an exponentially increasing\
\ number of seconds before retrying."
maximum: 8
minimum: 0
order: 4
title: "Max Retries"
type: "integer"
page_size:
default: 25
description: "page size to use when querying PagerDuty API"
maximum: 25
minimum: 1
order: 5
title: "Page Size"
type: "integer"
service_details:
description: "List of PagerDuty service additional details to include."
items:
enum:
- "escalation_policies"
- "teams"
- "integrations"
- "auto_pause_notifications_parameters"
type: "string"
order: 6
title: "Service Details"
type: "array"
token:
airbyte_secret: true
description: "API key for PagerDuty API authentication"
order: 7
title: "API key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "pagerduty"
const: "pagerduty"
enum:
- "pagerduty"
order: 0
type: "string"
required:
- "token"
- "sourceType"
type: "object"
source-pagerduty-update:
properties:
cutoff_days:
default: 90
description: "Fetch pipelines updated in the last number of days"
order: 0
title: "Cutoff Days"
type: "integer"
default_severity:
description: "A default severity category if not present"
examples:
- "Sev1"
- "Sev2"
- "Sev3"
- "Sev4"
- "Sev5"
- "Custom"
order: 1
pattern: "^(Sev[0-5])?(Custom)?$"
title: "Severity category"
type: "string"
exclude_services:
description: "List of PagerDuty service names to ignore incidents from.\
\ If not set, all incidents will be pulled."
examples:
- "service-1"
- "service-2"
items:
type: "string"
order: 2
title: "Exclude Services"
type: "array"
incident_log_entries_overview:
default: true
description: "If true, will return a subset of log entries that show only\
\ the most important changes to the incident."
order: 3
title: "Incident Log Entries Overview"
type: "boolean"
max_retries:
default: 5
description: "Maximum number of PagerDuty API request retries to perform\
\ upon connection errors. The source will pause for an exponentially increasing\
\ number of seconds before retrying."
maximum: 8
minimum: 0
order: 4
title: "Max Retries"
type: "integer"
page_size:
default: 25
description: "page size to use when querying PagerDuty API"
maximum: 25
minimum: 1
order: 5
title: "Page Size"
type: "integer"
service_details:
description: "List of PagerDuty service additional details to include."
items:
enum:
- "escalation_policies"
- "teams"
- "integrations"
- "auto_pause_notifications_parameters"
type: "string"
order: 6
title: "Service Details"
type: "array"
token:
airbyte_secret: true
description: "API key for PagerDuty API authentication"
order: 7
title: "API key"
type: "string"
required:
- "token"
type: "object"
source-bigmailer:
properties:
api_key:
airbyte_secret: true
description: "API key to use. You can create and find it on the API key\
\ management page in your BigMailer account."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "bigmailer"
const: "bigmailer"
enum:
- "bigmailer"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-bigmailer-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. You can create and find it on the API key\
\ management page in your BigMailer account."
name: "api_key"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-senseforce:
properties:
access_token:
airbyte_secret: true
description: "Your API access token. See here. The toke is case sensitive."
order: 0
title: "API Access Token"
type: "string"
x-speakeasy-param-sensitive: true
backend_url:
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)"
examples:
- "https://galaxyapi.senseforce.io"
order: 1
title: "Senseforce backend URL"
type: "string"
dataset_id:
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)."
examples:
- "8f418098-ca28-4df5-9498-0df9fe78eda7"
order: 2
title: "Dataset ID"
type: "string"
start_date:
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"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "The first day (in UTC) when to read data from."
type: "string"
sourceType:
title: "senseforce"
const: "senseforce"
enum:
- "senseforce"
order: 0
type: "string"
required:
- "access_token"
- "backend_url"
- "dataset_id"
- "start_date"
- "sourceType"
type: "object"
source-senseforce-update:
properties:
access_token:
airbyte_secret: true
description: "Your API access token. See here. The toke is case sensitive."
order: 0
title: "API Access Token"
type: "string"
backend_url:
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)"
examples:
- "https://galaxyapi.senseforce.io"
order: 1
title: "Senseforce backend URL"
type: "string"
dataset_id:
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)."
examples:
- "8f418098-ca28-4df5-9498-0df9fe78eda7"
order: 2
title: "Dataset ID"
type: "string"
start_date:
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"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "The first day (in UTC) when to read data from."
type: "string"
required:
- "access_token"
- "backend_url"
- "dataset_id"
- "start_date"
type: "object"
source-freshsales:
properties:
api_key:
airbyte_secret: true
description: "Freshsales API Key. See here. The key is case sensitive."
order: 1
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
domain_name:
description: "The Name of your Freshsales domain"
examples:
- "mydomain.myfreshworks.com"
order: 0
title: "Domain Name"
type: "string"
sourceType:
title: "freshsales"
const: "freshsales"
enum:
- "freshsales"
order: 0
type: "string"
required:
- "domain_name"
- "api_key"
- "sourceType"
type: "object"
source-freshsales-update:
properties:
api_key:
airbyte_secret: true
description: "Freshsales API Key. See here. The key is case sensitive."
order: 1
title: "API Key"
type: "string"
domain_name:
description: "The Name of your Freshsales domain"
examples:
- "mydomain.myfreshworks.com"
order: 0
title: "Domain Name"
type: "string"
required:
- "domain_name"
- "api_key"
type: "object"
source-giphy:
properties:
api_key:
airbyte_secret: true
description: "Your GIPHY API Key. You can create and find your API key in\
\ the GIPHY Developer Dashboard at https://developers.giphy.com/dashboard/."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
query:
default: "foo"
description: "A query for search endpoint"
order: 2
title: "Query for search endpoints"
type: "string"
query_for_clips:
default: "foo"
description: "Query for clips search endpoint"
order: 5
title: "Query for clips search endpoint"
type: "string"
query_for_gif:
default: "foo"
description: "Query for gif search endpoint"
order: 3
title: "Query for gif search endpoint"
type: "string"
query_for_stickers:
default: "foo"
description: "Query for stickers search endpoint"
order: 4
title: "Query for stickers search endpoint"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "giphy"
const: "giphy"
enum:
- "giphy"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "query"
- "query_for_gif"
- "query_for_stickers"
- "query_for_clips"
- "sourceType"
type: "object"
source-giphy-update:
properties:
api_key:
airbyte_secret: true
description: "Your GIPHY API Key. You can create and find your API key in\
\ the GIPHY Developer Dashboard at https://developers.giphy.com/dashboard/."
name: "api_key"
order: 0
title: "API Key"
type: "string"
query:
default: "foo"
description: "A query for search endpoint"
order: 2
title: "Query for search endpoints"
type: "string"
query_for_clips:
default: "foo"
description: "Query for clips search endpoint"
order: 5
title: "Query for clips search endpoint"
type: "string"
query_for_gif:
default: "foo"
description: "Query for gif search endpoint"
order: 3
title: "Query for gif search endpoint"
type: "string"
query_for_stickers:
default: "foo"
description: "Query for stickers search endpoint"
order: 4
title: "Query for stickers search endpoint"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
- "query"
- "query_for_gif"
- "query_for_stickers"
- "query_for_clips"
type: "object"
source-drip:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it at https://www.getdrip.com/user/edit"
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "drip"
const: "drip"
enum:
- "drip"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-drip-update:
properties:
api_key:
airbyte_secret: true
description: "API key to use. Find it at https://www.getdrip.com/user/edit"
name: "api_key"
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-square:
properties:
credentials:
description: "Choose how to authenticate to Square."
oneOf:
- properties:
auth_type:
const: "OAuth"
order: 0
type: "string"
enum:
- "OAuth"
client_id:
airbyte_secret: true
description: "The Square-issued ID of your application"
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The Square-issued application secret for your application"
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "A refresh token generated using the above client ID\
\ and secret"
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_type"
- "client_id"
- "client_secret"
- "refresh_token"
title: "Oauth authentication"
type: "object"
- properties:
api_key:
airbyte_secret: true
description: "The API key for a Square application"
title: "API key token"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "API Key"
order: 1
type: "string"
enum:
- "API Key"
required:
- "auth_type"
- "api_key"
title: "API key"
type: "object"
order: 0
title: "Authentication"
type: "object"
include_deleted_objects:
default: false
description: "In some streams there is an option to include deleted objects\
\ (Items, Categories, Discounts, Taxes)"
order: 3
title: "Include Deleted Objects"
type: "boolean"
is_sandbox:
default: false
description: "Determines whether to use the sandbox or production environment."
order: 1
title: "Sandbox"
type: "boolean"
start_date:
default: "2021-01-01"
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."
format: "date"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
sourceType:
title: "square"
const: "square"
enum:
- "square"
order: 0
type: "string"
required:
- "is_sandbox"
- "sourceType"
type: "object"
source-square-update:
properties:
credentials:
description: "Choose how to authenticate to Square."
oneOf:
- properties:
auth_type:
const: "OAuth"
order: 0
type: "string"
enum:
- "OAuth"
client_id:
airbyte_secret: true
description: "The Square-issued ID of your application"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Square-issued application secret for your application"
title: "Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "A refresh token generated using the above client ID\
\ and secret"
title: "Refresh Token"
type: "string"
required:
- "auth_type"
- "client_id"
- "client_secret"
- "refresh_token"
title: "Oauth authentication"
type: "object"
- properties:
api_key:
airbyte_secret: true
description: "The API key for a Square application"
title: "API key token"
type: "string"
auth_type:
const: "API Key"
order: 1
type: "string"
enum:
- "API Key"
required:
- "auth_type"
- "api_key"
title: "API key"
type: "object"
order: 0
title: "Authentication"
type: "object"
include_deleted_objects:
default: false
description: "In some streams there is an option to include deleted objects\
\ (Items, Categories, Discounts, Taxes)"
order: 3
title: "Include Deleted Objects"
type: "boolean"
is_sandbox:
default: false
description: "Determines whether to use the sandbox or production environment."
order: 1
title: "Sandbox"
type: "boolean"
start_date:
default: "2021-01-01"
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."
format: "date"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
title: "Start Date"
type: "string"
required:
- "is_sandbox"
type: "object"
source-paystack:
properties:
lookback_window_days:
default: 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."
minimum: 0
order: 1
title: "Lookback Window (in days)"
type: "integer"
secret_key:
airbyte_secret: true
description: "The Paystack API key (usually starts with 'sk_live_'; find\
\ yours here)."
order: 2
pattern: "^(s|r)k_(live|test)_[a-zA-Z0-9]+$"
title: "Secret Key"
type: "string"
x-speakeasy-param-sensitive: true
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:
- "2017-01-25T00:00:00Z"
format: "date-time"
order: 0
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
sourceType:
title: "paystack"
const: "paystack"
enum:
- "paystack"
order: 0
type: "string"
required:
- "start_date"
- "secret_key"
- "sourceType"
type: "object"
source-paystack-update:
properties:
lookback_window_days:
default: 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."
minimum: 0
order: 1
title: "Lookback Window (in days)"
type: "integer"
secret_key:
airbyte_secret: true
description: "The Paystack API key (usually starts with 'sk_live_'; find\
\ yours here)."
order: 2
pattern: "^(s|r)k_(live|test)_[a-zA-Z0-9]+$"
title: "Secret Key"
type: "string"
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:
- "2017-01-25T00:00:00Z"
format: "date-time"
order: 0
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
required:
- "start_date"
- "secret_key"
type: "object"
source-productive:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
organization_id:
description: "The organization ID which could be seen from `https://app.productive.io/xxxx-xxxx/settings/api-integrations`\
\ page"
order: 1
title: "Organization ID"
type: "string"
sourceType:
title: "productive"
const: "productive"
enum:
- "productive"
order: 0
type: "string"
required:
- "api_key"
- "organization_id"
- "sourceType"
type: "object"
source-productive-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
organization_id:
description: "The organization ID which could be seen from `https://app.productive.io/xxxx-xxxx/settings/api-integrations`\
\ page"
order: 1
title: "Organization ID"
type: "string"
required:
- "api_key"
- "organization_id"
type: "object"
source-shipstation:
properties:
password:
airbyte_secret: true
always_show: true
order: 1
title: "API Secret"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
username:
order: 0
title: "API Key"
type: "string"
sourceType:
title: "shipstation"
const: "shipstation"
enum:
- "shipstation"
order: 0
type: "string"
required:
- "username"
- "start_date"
- "sourceType"
type: "object"
source-shipstation-update:
properties:
password:
airbyte_secret: true
always_show: true
order: 1
title: "API Secret"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
username:
order: 0
title: "API Key"
type: "string"
required:
- "username"
- "start_date"
type: "object"
source-appsflyer:
properties:
api_token:
airbyte_secret: true
description: "Pull API token for authentication. If you change the account\
\ admin, the token changes, and you must update scripts with the new token.\
\ Get the API token in the Dashboard."
type: "string"
x-speakeasy-param-sensitive: true
app_id:
description: "App identifier as found in AppsFlyer."
type: "string"
start_date:
description: "The default value to use if no bookmark exists for an endpoint.\
\ Raw Reports historical lookback is limited to 90 days."
examples:
- "2021-11-16"
- "2021-11-16 15:00:00"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$"
type: "string"
timezone:
default: "UTC"
description: "Time zone in which date times are stored. The project timezone\
\ may be found in the App settings in the AppsFlyer console."
examples:
- "US/Pacific"
- "UTC"
type: "string"
sourceType:
title: "appsflyer"
const: "appsflyer"
enum:
- "appsflyer"
order: 0
type: "string"
required:
- "app_id"
- "api_token"
- "start_date"
- "sourceType"
title: "Appsflyer Spec"
type: "object"
source-appsflyer-update:
properties:
api_token:
airbyte_secret: true
description: "Pull API token for authentication. If you change the account\
\ admin, the token changes, and you must update scripts with the new token.\
\ Get the API token in the Dashboard."
type: "string"
app_id:
description: "App identifier as found in AppsFlyer."
type: "string"
start_date:
description: "The default value to use if no bookmark exists for an endpoint.\
\ Raw Reports historical lookback is limited to 90 days."
examples:
- "2021-11-16"
- "2021-11-16 15:00:00"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?$"
type: "string"
timezone:
default: "UTC"
description: "Time zone in which date times are stored. The project timezone\
\ may be found in the App settings in the AppsFlyer console."
examples:
- "US/Pacific"
- "UTC"
type: "string"
required:
- "app_id"
- "api_token"
- "start_date"
title: "Appsflyer Spec"
type: "object"
source-braintree:
properties:
environment:
description: "Environment specifies where the data will come from."
enum:
- "Development"
- "Sandbox"
- "Qa"
- "Production"
examples:
- "sandbox"
- "production"
- "qa"
- "development"
name: "Environment"
title: "Environment"
type: "string"
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"
title: "Merchant ID"
type: "string"
private_key:
airbyte_secret: true
description: "Braintree Private Key. See the docs for more information on how to obtain this key."
name: "Private Key"
title: "Private Key"
type: "string"
x-speakeasy-param-sensitive: true
public_key:
description: "Braintree Public Key. See the docs for more information on how to obtain this key."
name: "Public Key"
title: "Public Key"
type: "string"
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"
- "2020-12-30"
- "2020-11-22 20:20:05"
format: "date-time"
name: "Start Date"
title: "Start Date"
type: "string"
sourceType:
title: "braintree"
const: "braintree"
enum:
- "braintree"
order: 0
type: "string"
required:
- "merchant_id"
- "public_key"
- "private_key"
- "environment"
- "sourceType"
title: "Braintree Spec"
type: "object"
source-braintree-update:
properties:
environment:
description: "Environment specifies where the data will come from."
enum:
- "Development"
- "Sandbox"
- "Qa"
- "Production"
examples:
- "sandbox"
- "production"
- "qa"
- "development"
name: "Environment"
title: "Environment"
type: "string"
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"
title: "Merchant ID"
type: "string"
private_key:
airbyte_secret: true
description: "Braintree Private Key. See the docs for more information on how to obtain this key."
name: "Private Key"
title: "Private Key"
type: "string"
public_key:
description: "Braintree Public Key. See the docs for more information on how to obtain this key."
name: "Public Key"
title: "Public Key"
type: "string"
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"
- "2020-12-30"
- "2020-11-22 20:20:05"
format: "date-time"
name: "Start Date"
title: "Start Date"
type: "string"
required:
- "merchant_id"
- "public_key"
- "private_key"
- "environment"
title: "Braintree Spec"
type: "object"
source-mailchimp:
properties:
credentials:
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "An access token generated using the above client ID\
\ and secret."
title: "Access Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "oauth2.0"
order: 0
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The Client ID of your OAuth application."
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The Client Secret of your OAuth application."
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_type"
- "access_token"
title: "OAuth2.0"
type: "object"
- properties:
apikey:
airbyte_secret: true
description: "Mailchimp API Key. See the docs for information on how to generate this key."
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "apikey"
order: 1
type: "string"
enum:
- "apikey"
required:
- "auth_type"
- "apikey"
title: "API Key"
type: "object"
title: "Authentication"
type: "object"
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."
examples:
- "2020-01-01T00:00:00.000Z"
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"
title: "Incremental Sync Start Date"
type: "string"
sourceType:
title: "mailchimp"
const: "mailchimp"
enum:
- "mailchimp"
order: 0
type: "string"
required:
- "sourceType"
title: "Mailchimp Spec"
type: "object"
source-mailchimp-update:
properties:
credentials:
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "An access token generated using the above client ID\
\ and secret."
title: "Access Token"
type: "string"
auth_type:
const: "oauth2.0"
order: 0
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The Client ID of your OAuth application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your OAuth application."
title: "Client Secret"
type: "string"
required:
- "auth_type"
- "access_token"
title: "OAuth2.0"
type: "object"
- properties:
apikey:
airbyte_secret: true
description: "Mailchimp API Key. See the docs for information on how to generate this key."
title: "API Key"
type: "string"
auth_type:
const: "apikey"
order: 1
type: "string"
enum:
- "apikey"
required:
- "auth_type"
- "apikey"
title: "API Key"
type: "object"
title: "Authentication"
type: "object"
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."
examples:
- "2020-01-01T00:00:00.000Z"
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"
title: "Incremental Sync Start Date"
type: "string"
required: []
title: "Mailchimp Spec"
type: "object"
source-airtable:
properties:
credentials:
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests."
type: "string"
x-speakeasy-param-sensitive: true
auth_method:
const: "oauth2.0"
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The client ID of the Airtable developer application."
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The client secret of the Airtable developer application."
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "The key to refresh the expired access token."
title: "Refresh token"
type: "string"
x-speakeasy-param-sensitive: true
token_expiry_date:
description: "The date-time when the access token should be refreshed."
format: "date-time"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
title: "OAuth2.0"
type: "object"
- properties:
api_key:
airbyte_secret: true
description: "The Personal Access Token for the Airtable account.\
\ See the Support Guide for more information on how to obtain this token."
examples:
- "key1234567890"
title: "Personal Access Token"
type: "string"
x-speakeasy-param-sensitive: true
auth_method:
const: "api_key"
type: "string"
enum:
- "api_key"
required:
- "api_key"
title: "Personal Access Token"
type: "object"
title: "Authentication"
type: "object"
sourceType:
title: "airtable"
const: "airtable"
enum:
- "airtable"
order: 0
type: "string"
type: "object"
source-airtable-update:
properties:
credentials:
oneOf:
- properties:
access_token:
airbyte_secret: true
description: "Access Token for making authenticated requests."
type: "string"
auth_method:
const: "oauth2.0"
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The client ID of the Airtable developer application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The client secret of the Airtable developer application."
title: "Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "The key to refresh the expired access token."
title: "Refresh token"
type: "string"
token_expiry_date:
description: "The date-time when the access token should be refreshed."
format: "date-time"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
title: "OAuth2.0"
type: "object"
- properties:
api_key:
airbyte_secret: true
description: "The Personal Access Token for the Airtable account.\
\ See the Support Guide for more information on how to obtain this token."
examples:
- "key1234567890"
title: "Personal Access Token"
type: "string"
auth_method:
const: "api_key"
type: "string"
enum:
- "api_key"
required:
- "api_key"
title: "Personal Access Token"
type: "object"
title: "Authentication"
type: "object"
type: "object"
source-teamtailor:
properties:
api:
order: 1
title: "api"
type: "string"
x_api_version:
description: "The version of the API"
order: 0
title: "X-Api-Version"
type: "string"
sourceType:
title: "teamtailor"
const: "teamtailor"
enum:
- "teamtailor"
order: 0
type: "string"
required:
- "x_api_version"
- "api"
- "sourceType"
type: "object"
source-teamtailor-update:
properties:
api:
order: 1
title: "api"
type: "string"
x_api_version:
description: "The version of the API"
order: 0
title: "X-Api-Version"
type: "string"
required:
- "x_api_version"
- "api"
type: "object"
source-dynamodb:
properties:
credentials:
description: "Credentials for the service"
oneOf:
- additionalProperties: true
properties:
access_key_id:
airbyte_secret: true
description: "The access key id to access Dynamodb. Airbyte requires\
\ read permissions to the database"
examples:
- "A012345678910EXAMPLE"
order: 1
title: "Dynamodb Key Id"
type: "string"
x-speakeasy-param-sensitive: true
auth_type:
const: "User"
order: 0
type: "string"
enum:
- "User"
secret_access_key:
airbyte_secret: true
description: "The corresponding secret to the access key id."
examples:
- "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY"
order: 2
title: "Dynamodb Access Key"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "access_key_id"
- "secret_access_key"
title: "Authenticate via Access Keys"
type:
- "null"
- "object"
- additionalProperties: true
properties:
auth_type:
const: "Role"
order: 0
type: "string"
enum:
- "Role"
title: "Role Based Authentication"
type: "object"
order: 0
title: "Credentials"
type: "object"
endpoint:
default: ""
description: "the URL of the Dynamodb database"
examples:
- "https://{aws_dynamo_db_url}.com"
title: "Dynamodb Endpoint"
type: "string"
ignore_missing_read_permissions_tables:
default: false
description: "Ignore tables with missing scan/read permissions"
title: "Ignore missing read permissions tables"
type: "boolean"
region:
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"
title: "Dynamodb Region"
type: "string"
reserved_attribute_names:
airbyte_secret: true
description: "Comma separated reserved attribute names present in your tables"
examples:
- "name, field_name, field-name"
title: "Reserved attribute names"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "dynamodb"
const: "dynamodb"
enum:
- "dynamodb"
order: 0
type: "string"
title: "Dynamodb Source Spec"
type: "object"
source-dynamodb-update:
properties:
credentials:
description: "Credentials for the service"
oneOf:
- additionalProperties: true
properties:
access_key_id:
airbyte_secret: true
description: "The access key id to access Dynamodb. Airbyte requires\
\ read permissions to the database"
examples:
- "A012345678910EXAMPLE"
order: 1
title: "Dynamodb Key Id"
type: "string"
auth_type:
const: "User"
order: 0
type: "string"
enum:
- "User"
secret_access_key:
airbyte_secret: true
description: "The corresponding secret to the access key id."
examples:
- "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY"
order: 2
title: "Dynamodb Access Key"
type: "string"
required:
- "access_key_id"
- "secret_access_key"
title: "Authenticate via Access Keys"
type:
- "null"
- "object"
- additionalProperties: true
properties:
auth_type:
const: "Role"
order: 0
type: "string"
enum:
- "Role"
title: "Role Based Authentication"
type: "object"
order: 0
title: "Credentials"
type: "object"
endpoint:
default: ""
description: "the URL of the Dynamodb database"
examples:
- "https://{aws_dynamo_db_url}.com"
title: "Dynamodb Endpoint"
type: "string"
ignore_missing_read_permissions_tables:
default: false
description: "Ignore tables with missing scan/read permissions"
title: "Ignore missing read permissions tables"
type: "boolean"
region:
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"
title: "Dynamodb Region"
type: "string"
reserved_attribute_names:
airbyte_secret: true
description: "Comma separated reserved attribute names present in your tables"
examples:
- "name, field_name, field-name"
title: "Reserved attribute names"
type: "string"
title: "Dynamodb Source Spec"
type: "object"
source-kissmetrics:
properties:
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
username:
order: 0
title: "Username"
type: "string"
sourceType:
title: "kissmetrics"
const: "kissmetrics"
enum:
- "kissmetrics"
order: 0
type: "string"
required:
- "username"
- "sourceType"
type: "object"
source-kissmetrics-update:
properties:
password:
airbyte_secret: true
always_show: true
order: 1
title: "Password"
type: "string"
username:
order: 0
title: "Username"
type: "string"
required:
- "username"
type: "object"
source-wordpress:
properties:
domain:
description: "The domain of the WordPress site. Example: my-wordpress-website.host.com"
name: "domain"
order: 0
title: "Domain"
type: "string"
password:
airbyte_secret: true
default: "x"
description: "Placeholder for basic HTTP auth password - should be set to\
\ empty string"
name: "password"
order: 1
title: "Placeholder Password"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
description: "Minimal Date to Retrieve Records when stream allow incremental. "
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
username:
airbyte_secret: true
default: "x"
description: "Placeholder for basic HTTP auth username - should be set to\
\ empty string"
name: "username"
order: 2
title: "Placeholder Username"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "wordpress"
const: "wordpress"
enum:
- "wordpress"
order: 0
type: "string"
required:
- "domain"
- "password"
- "username"
- "start_date"
- "sourceType"
type: "object"
source-wordpress-update:
properties:
domain:
description: "The domain of the WordPress site. Example: my-wordpress-website.host.com"
name: "domain"
order: 0
title: "Domain"
type: "string"
password:
airbyte_secret: true
default: "x"
description: "Placeholder for basic HTTP auth password - should be set to\
\ empty string"
name: "password"
order: 1
title: "Placeholder Password"
type: "string"
start_date:
description: "Minimal Date to Retrieve Records when stream allow incremental. "
format: "date-time"
order: 3
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
username:
airbyte_secret: true
default: "x"
description: "Placeholder for basic HTTP auth username - should be set to\
\ empty string"
name: "username"
order: 2
title: "Placeholder Username"
type: "string"
required:
- "domain"
- "password"
- "username"
- "start_date"
type: "object"
source-bitly:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
end_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "End date"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "bitly"
const: "bitly"
enum:
- "bitly"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "end_date"
- "sourceType"
type: "object"
source-bitly-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
end_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "End date"
type: "string"
start_date:
format: "date-time"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "start_date"
- "end_date"
type: "object"
source-pardot:
properties:
client_id:
airbyte_secret: true
description: "The Consumer Key that can be found when viewing your app in\
\ Salesforce"
order: 1
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The Consumer Secret that can be found when viewing your app\
\ in Salesforce"
order: 2
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
is_sandbox:
default: false
description: "Whether or not the the app is in a Salesforce sandbox. If\
\ you do not know what this, assume it is false."
order: 6
title: "Is Sandbox App?"
type: "boolean"
pardot_business_unit_id:
description: "Pardot Business ID, can be found at Setup > Pardot > Pardot\
\ Account Setup"
order: 0
title: "Pardot Business Unit ID"
type: "string"
refresh_token:
airbyte_secret: true
description: "Salesforce Refresh Token used for Airbyte to access your Salesforce\
\ account. If you don't know what this is, follow this guide to retrieve it."
order: 3
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
start_date:
default: "2007-01-01T00:00:00Z"
description: "UTC date and time in the format 2000-01-01T00:00:00Z. Any\
\ data before this date will not be replicated. Defaults to the year Pardot\
\ was released."
examples:
- "2021-07-25T00:00:00Z"
format: "date-time"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
sourceType:
title: "pardot"
const: "pardot"
enum:
- "pardot"
order: 0
type: "string"
required:
- "pardot_business_unit_id"
- "client_id"
- "client_secret"
- "refresh_token"
- "sourceType"
type: "object"
source-pardot-update:
properties:
client_id:
airbyte_secret: true
description: "The Consumer Key that can be found when viewing your app in\
\ Salesforce"
order: 1
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Consumer Secret that can be found when viewing your app\
\ in Salesforce"
order: 2
title: "Client Secret"
type: "string"
is_sandbox:
default: false
description: "Whether or not the the app is in a Salesforce sandbox. If\
\ you do not know what this, assume it is false."
order: 6
title: "Is Sandbox App?"
type: "boolean"
pardot_business_unit_id:
description: "Pardot Business ID, can be found at Setup > Pardot > Pardot\
\ Account Setup"
order: 0
title: "Pardot Business Unit ID"
type: "string"
refresh_token:
airbyte_secret: true
description: "Salesforce Refresh Token used for Airbyte to access your Salesforce\
\ account. If you don't know what this is, follow this guide to retrieve it."
order: 3
title: "Refresh Token"
type: "string"
start_date:
default: "2007-01-01T00:00:00Z"
description: "UTC date and time in the format 2000-01-01T00:00:00Z. Any\
\ data before this date will not be replicated. Defaults to the year Pardot\
\ was released."
examples:
- "2021-07-25T00:00:00Z"
format: "date-time"
order: 4
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start Date"
type: "string"
required:
- "pardot_business_unit_id"
- "client_id"
- "client_secret"
- "refresh_token"
type: "object"
source-ringcentral:
properties:
account_id:
airbyte_secret: true
description: "Could be seen at response to basic api call to an endpoint\
\ with ~ operator. Example- (https://platform.devtest.ringcentral.com/restapi/v1.0/account/~/extension/~/business-hours)\n"
order: 0
title: "Account Id"
type: "string"
x-speakeasy-param-sensitive: true
auth_token:
airbyte_secret: true
description: "Token could be recieved by following instructions at https://developers.ringcentral.com/api-reference/authentication"
order: 1
title: "Auth Token"
type: "string"
x-speakeasy-param-sensitive: true
extension_id:
airbyte_secret: true
description: "Could be seen at response to basic api call to an endpoint\
\ with ~ operator. Example- (https://platform.devtest.ringcentral.com/restapi/v1.0/account/~/extension/~/business-hours)\n"
order: 2
title: "Extension Id"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "ringcentral"
const: "ringcentral"
enum:
- "ringcentral"
order: 0
type: "string"
required:
- "account_id"
- "auth_token"
- "extension_id"
- "sourceType"
type: "object"
source-ringcentral-update:
properties:
account_id:
airbyte_secret: true
description: "Could be seen at response to basic api call to an endpoint\
\ with ~ operator. Example- (https://platform.devtest.ringcentral.com/restapi/v1.0/account/~/extension/~/business-hours)\n"
order: 0
title: "Account Id"
type: "string"
auth_token:
airbyte_secret: true
description: "Token could be recieved by following instructions at https://developers.ringcentral.com/api-reference/authentication"
order: 1
title: "Auth Token"
type: "string"
extension_id:
airbyte_secret: true
description: "Could be seen at response to basic api call to an endpoint\
\ with ~ operator. Example- (https://platform.devtest.ringcentral.com/restapi/v1.0/account/~/extension/~/business-hours)\n"
order: 2
title: "Extension Id"
type: "string"
required:
- "account_id"
- "auth_token"
- "extension_id"
type: "object"
source-watchmode:
properties:
api_key:
airbyte_secret: true
description: "Your API key for authenticating with the Watchmode API. You\
\ can request a free API key at https://api.watchmode.com/requestApiKey/."
name: "api_key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
search_val:
default: "Terminator"
description: "The name value for search stream"
order: 1
title: "Search Value"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
sourceType:
title: "watchmode"
const: "watchmode"
enum:
- "watchmode"
order: 0
type: "string"
required:
- "api_key"
- "search_val"
- "start_date"
- "sourceType"
type: "object"
source-watchmode-update:
properties:
api_key:
airbyte_secret: true
description: "Your API key for authenticating with the Watchmode API. You\
\ can request a free API key at https://api.watchmode.com/requestApiKey/."
name: "api_key"
order: 0
title: "API Key"
type: "string"
search_val:
default: "Terminator"
description: "The name value for search stream"
order: 1
title: "Search Value"
type: "string"
start_date:
format: "date-time"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
title: "Start date"
type: "string"
required:
- "api_key"
- "search_val"
- "start_date"
type: "object"
source-open-exchange-rates:
properties:
app_id:
airbyte_secret: true
description: "App ID provided by Open Exchange Rates"
order: 0
type: "string"
x-speakeasy-param-sensitive: true
base:
default: "USD"
description: "Change base currency (3-letter code, default is USD - only\
\ modifiable in paid plans)"
examples:
- "EUR"
- "USD"
order: 1
type: "string"
start_date:
description: "Start getting data from that date."
examples:
- "YYYY-MM-DD"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
type: "string"
sourceType:
title: "open-exchange-rates"
const: "open-exchange-rates"
enum:
- "open-exchange-rates"
order: 0
type: "string"
required:
- "app_id"
- "start_date"
- "sourceType"
type: "object"
source-open-exchange-rates-update:
properties:
app_id:
airbyte_secret: true
description: "App ID provided by Open Exchange Rates"
order: 0
type: "string"
base:
default: "USD"
description: "Change base currency (3-letter code, default is USD - only\
\ modifiable in paid plans)"
examples:
- "EUR"
- "USD"
order: 1
type: "string"
start_date:
description: "Start getting data from that date."
examples:
- "YYYY-MM-DD"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
type: "string"
required:
- "app_id"
- "start_date"
type: "object"
source-nytimes:
properties:
api_key:
airbyte_secret: true
description: "API Key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
end_date:
description: "End date to stop the article retrieval (format YYYY-MM)"
examples:
- "2022-08"
- "1851-01"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}$"
title: "End Date"
type: "string"
period:
description: "Period of time (in days)"
enum:
- 1
- 7
- 30
order: 3
title: "Period (used for Most Popular streams)"
type: "integer"
share_type:
description: "Share Type"
enum:
- "facebook"
order: 4
title: "Share Type (used for Most Popular Shared stream)"
type: "string"
start_date:
description: "Start date to begin the article retrieval (format YYYY-MM)"
examples:
- "2022-08"
- "1851-01"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}$"
title: "Start Date"
type: "string"
sourceType:
title: "nytimes"
const: "nytimes"
enum:
- "nytimes"
order: 0
type: "string"
required:
- "api_key"
- "start_date"
- "period"
- "sourceType"
title: "Nytimes Spec"
type: "object"
source-nytimes-update:
properties:
api_key:
airbyte_secret: true
description: "API Key"
order: 0
title: "API Key"
type: "string"
end_date:
description: "End date to stop the article retrieval (format YYYY-MM)"
examples:
- "2022-08"
- "1851-01"
order: 2
pattern: "^[0-9]{4}-[0-9]{2}$"
title: "End Date"
type: "string"
period:
description: "Period of time (in days)"
enum:
- 1
- 7
- 30
order: 3
title: "Period (used for Most Popular streams)"
type: "integer"
share_type:
description: "Share Type"
enum:
- "facebook"
order: 4
title: "Share Type (used for Most Popular Shared stream)"
type: "string"
start_date:
description: "Start date to begin the article retrieval (format YYYY-MM)"
examples:
- "2022-08"
- "1851-01"
order: 1
pattern: "^[0-9]{4}-[0-9]{2}$"
title: "Start Date"
type: "string"
required:
- "api_key"
- "start_date"
- "period"
title: "Nytimes Spec"
type: "object"
source-greenhouse:
properties:
api_key:
airbyte_secret: true
description: "Greenhouse API Key. See the docs for more information on how to generate this key."
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "greenhouse"
const: "greenhouse"
enum:
- "greenhouse"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-greenhouse-update:
properties:
api_key:
airbyte_secret: true
description: "Greenhouse API Key. See the docs for more information on how to generate this key."
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
source-you-need-a-budget-ynab:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
sourceType:
title: "you-need-a-budget-ynab"
const: "you-need-a-budget-ynab"
enum:
- "you-need-a-budget-ynab"
order: 0
type: "string"
required:
- "api_key"
- "sourceType"
type: "object"
source-you-need-a-budget-ynab-update:
properties:
api_key:
airbyte_secret: true
order: 0
title: "API Key"
type: "string"
required:
- "api_key"
type: "object"
shopify:
properties:
credentials:
properties:
client_id:
airbyte_secret: true
description: "The Client ID of the Shopify developer application."
order: 1
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of the Shopify developer application."
order: 2
title: "Client Secret"
type: "string"
title: "Shopify Source CDK Specifications"
azure-blob-storage:
properties:
credentials:
properties:
client_id:
airbyte_secret: true
description: "Client ID of your Microsoft developer application"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Client Secret of your Microsoft developer application"
title: "Client Secret"
type: "string"
title: "SourceAzureBlobStorageSpec"
drift:
properties:
credentials:
properties:
client_id:
airbyte_secret: true
description: "The Client ID of your Drift developer application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Drift developer application."
title: "Client Secret"
type: "string"
title: "Drift Spec"
snapchat-marketing:
properties:
client_id:
airbyte_secret: true
description: "The Client ID of your Snapchat developer application."
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Snapchat developer application."
order: 1
title: "Client Secret"
type: "string"
title: "Snapchat Marketing Spec"
gitlab:
properties:
credentials:
properties:
client_id:
airbyte_secret: true
description: "The API ID of the Gitlab developer application."
type: "string"
client_secret:
airbyte_secret: true
description: "The API Secret the Gitlab developer application."
type: "string"
title: "Source Gitlab Spec"
microsoft-sharepoint:
properties:
credentials:
properties:
client_id:
airbyte_secret: true
description: "Client ID of your Microsoft developer application"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Client Secret of your Microsoft developer application"
title: "Client Secret"
type: "string"
title: "Microsoft SharePoint Source Spec"
notion:
properties:
credentials:
properties:
client_id:
airbyte_secret: true
description: "The Client ID of your Notion integration. See our docs\
\ for more information."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Notion integration. See our\
\ docs\
\ for more information."
title: "Client Secret"
type: "string"
title: "Notion Source Spec"
youtube-analytics:
properties:
credentials:
properties:
client_id:
airbyte_secret: true
description: "The Client ID of your developer application"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The client secret of your developer application"
title: "Client Secret"
type: "string"
title: "YouTube Analytics Spec"
zendesk-talk:
properties:
credentials:
properties:
client_id:
airbyte_secret: true
description: "Client ID"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Client Secret"
title: "Client Secret"
type: "string"
title: "Zendesk Talk Spec"
linkedin-ads:
properties:
credentials:
properties:
client_id:
airbyte_secret: true
description: "The client ID of your developer application. Refer to\
\ our documentation\
\ for more information."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The client secret of your developer application. Refer\
\ to our documentation\
\ for more information."
title: "Client Secret"
type: "string"
title: "Linkedin Ads Spec"
microsoft-onedrive:
properties:
credentials:
properties:
client_id:
airbyte_secret: true
description: "Client ID of your Microsoft developer application"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Client Secret of your Microsoft developer application"
title: "Client Secret"
type: "string"
title: "Microsoft OneDrive Source Spec"
tiktok-marketing:
properties:
credentials:
properties:
app_id:
airbyte_secret: true
description: "The Developer Application App ID."
title: "App ID"
type: "string"
secret:
airbyte_secret: true
description: "The Developer Application Secret."
title: "Secret"
type: "string"
title: "TikTok Marketing Source Spec"
hubspot:
properties:
credentials:
properties:
client_id:
description: "The Client ID of your HubSpot developer application. See\
\ the Hubspot docs if you need help finding this ID."
examples:
- "123456789000"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The client secret for your HubSpot developer application.\
\ See the Hubspot docs if you need help finding this secret."
examples:
- "secret"
title: "Client Secret"
type: "string"
title: "HubSpot Source Spec"
typeform:
properties:
credentials:
properties:
client_id:
airbyte_secret: true
description: "The Client ID of the Typeform developer application."
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret the Typeform developer application."
type: "string"
title: "Typeform Spec"
facebook-pages:
title: "Facebook Pages Spec"
surveymonkey:
properties:
credentials:
properties:
client_id:
airbyte_secret: true
description: "The Client ID of the SurveyMonkey developer application."
order: 1
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of the SurveyMonkey developer application."
order: 2
title: "Client Secret"
type: "string"
title: "SurveyMonkey Spec"
amazon-ads:
properties:
client_id:
airbyte_secret: true
description: "The client ID of your Amazon Ads developer application. See\
\ the docs for more information."
order: 1
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The client secret of your Amazon Ads developer application.\
\ See the docs for more information."
order: 2
title: "Client Secret"
type: "string"
title: "Source Amazon Ads"
github:
properties:
credentials:
properties:
client_id:
airbyte_secret: true
description: "OAuth Client Id"
title: "Client Id"
type: "string"
client_secret:
airbyte_secret: true
description: "OAuth Client secret"
title: "Client secret"
type: "string"
title: "GitHub Source Spec"
salesforce:
properties:
client_id:
description: "Enter your Salesforce developer application's Client ID"
order: 2
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Enter your Salesforce developer application's Client secret"
order: 3
title: "Client Secret"
type: "string"
title: "Salesforce Source Spec"
lever-hiring:
properties:
credentials:
properties:
client_id:
description: "The Client ID of your Lever Hiring developer application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Lever Hiring developer application."
title: "Client Secret"
type: "string"
title: "Lever Hiring Source Spec"
google-drive:
properties:
credentials:
properties:
client_id:
airbyte_secret: true
description: "Client ID for the Google Drive API"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Client Secret for the Google Drive API"
title: "Client Secret"
type: "string"
title: "Google Drive Source Spec"
gcs:
properties:
credentials:
properties:
client_id:
airbyte_secret: true
description: "Client ID"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Client Secret"
title: "Client Secret"
type: "string"
title: "Config"
ticktick:
properties:
authorization:
properties:
client_id:
airbyte_secret: true
description: "The client ID of your Ticktick application. Read more\
\ here."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The client secret of of your Ticktick application. application.\
\ Read more here."
title: "Client Secret"
type: "string"
title: "TickTick Spec"
trello:
title: "Trello Spec"
sharepoint-enterprise:
properties:
credentials:
properties:
client_id:
airbyte_secret: true
description: "Client ID of your Microsoft developer application"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Client Secret of your Microsoft developer application"
title: "Client Secret"
type: "string"
title: "Microsoft SharePoint Source Spec"
google-ads:
properties:
credentials:
properties:
client_id:
description: "The Client ID of your Google Ads developer application.\
\ For detailed instructions on finding this value, refer to our documentation."
order: 1
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Google Ads developer application.\
\ For detailed instructions on finding this value, refer to our documentation."
order: 2
title: "Client Secret"
type: "string"
developer_token:
airbyte_secret: true
description: "The Developer Token granted by Google to use their APIs.\
\ For detailed instructions on finding this value, refer to our documentation."
order: 0
title: "Developer Token"
type: "string"
title: "Google Ads Spec"
google-search-console:
properties:
authorization:
properties:
client_id:
airbyte_secret: true
description: "The client ID of your Google Search Console developer\
\ application. Read more here."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The client secret of your Google Search Console developer\
\ application. Read more here."
title: "Client Secret"
type: "string"
title: "Google Search Console Spec"
instagram:
properties:
client_id:
airbyte_secret: true
description: "The Client ID for your Oauth application"
title: "Client Id"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret for your Oauth application"
title: "Client Secret"
type: "string"
title: "Source Instagram"
smartsheets:
properties:
credentials:
properties:
client_id:
airbyte_secret: true
description: "The API ID of the SmartSheets developer application."
type: "string"
client_secret:
airbyte_secret: true
description: "The API Secret the SmartSheets developer application."
type: "string"
title: "Smartsheets Source Spec"
slack:
properties:
credentials:
properties:
client_id:
description: "Slack client_id. See our docs if you need help finding this id."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Slack client_secret. See our docs if you need help finding this secret."
title: "Client Secret"
type: "string"
title: "Slack Spec"
google-sheets:
properties:
credentials:
properties:
client_id:
airbyte_secret: true
description: "Enter your Google application's Client ID. See Google's\
\ documentation for more information."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Enter your Google application's Client Secret. See Google's\
\ documentation for more information."
title: "Client Secret"
type: "string"
title: "Google Sheets Source Spec"
asana:
properties:
credentials:
properties:
client_id:
airbyte_secret: true
description: ""
title: ""
type: "string"
client_secret:
airbyte_secret: true
description: ""
title: ""
type: "string"
title: "Asana Spec"
microsoft-teams:
properties:
credentials:
properties:
client_id:
description: "The Client ID of your Microsoft Teams developer application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Microsoft Teams developer application."
title: "Client Secret"
type: "string"
title: "Microsoft Teams Spec"
amazon-seller-partner:
properties:
app_id:
airbyte_secret: true
description: "Your Amazon Application ID."
order: 4
title: "Application ID"
type: "string"
lwa_app_id:
airbyte_secret: true
description: "Your Login with Amazon Client ID."
order: 5
title: "LWA Client Id"
type: "string"
lwa_client_secret:
airbyte_secret: true
description: "Your Login with Amazon Client Secret."
order: 6
title: "LWA Client Secret"
type: "string"
title: "Amazon Seller Partner Spec"
pinterest:
properties:
credentials:
properties:
client_id:
airbyte_secret: true
description: "The Client ID of your OAuth application"
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your OAuth application."
title: "Client Secret"
type: "string"
title: "Pinterest Spec"
rd-station-marketing:
properties:
authorization:
properties:
client_id:
airbyte_secret: true
description: "The Client ID of your RD Station developer application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your RD Station developer application"
title: "Client Secret"
type: "string"
title: "RD Station Marketing Spec"
zendesk-support:
properties:
credentials:
properties:
client_id:
airbyte_secret: true
description: "The OAuth client's ID. See this guide for more information."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The OAuth client secret. See this guide for more information."
title: "Client Secret"
type: "string"
title: "Source Zendesk Support Spec"
google-analytics-data-api:
properties:
credentials:
properties:
client_id:
description: "The Client ID of your Google Analytics developer application."
order: 1
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Google Analytics developer application."
order: 2
title: "Client Secret"
type: "string"
title: "Google Analytics (Data API) Spec"
intercom:
title: "Intercom Spec"
facebook-marketing:
properties:
credentials:
properties:
client_id:
airbyte_hidden: true
airbyte_secret: true
description: "The Client Id for your OAuth app"
title: "Client Id"
type: "string"
client_secret:
airbyte_hidden: true
airbyte_secret: true
description: "The Client Secret for your OAuth app"
title: "Client Secret"
type: "string"
title: "Source Facebook Marketing"
bing-ads:
properties:
client_id:
airbyte_secret: true
description: "The Client ID of your Microsoft Advertising developer application."
order: 1
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
default: ""
description: "The Client Secret of your Microsoft Advertising developer\
\ application."
order: 2
title: "Client Secret"
type: "string"
title: "Bing Ads Spec"
monday:
properties:
credentials:
properties:
client_id:
airbyte_secret: true
description: "The Client ID of your OAuth application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your OAuth application."
title: "Client Secret"
type: "string"
title: "Monday Spec"
mailchimp:
properties:
credentials:
properties:
client_id:
airbyte_secret: true
description: "The Client ID of your OAuth application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your OAuth application."
title: "Client Secret"
type: "string"
title: "Mailchimp Spec"
airtable:
properties:
credentials:
properties:
client_id:
airbyte_secret: true
description: "The client ID of the Airtable developer application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The client secret of the Airtable developer application."
title: "Client Secret"
type: "string"
title: "Airtable Spec"
destination-hubspot:
properties:
credentials:
description: "Choose how to authenticate to HubSpot."
oneOf:
- additionalProperties: true
properties:
client_id:
airbyte_secret: true
description: "The Client ID of your HubSpot developer application.\
\ See the Hubspot docs if you need help finding this ID."
order: 0
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The client secret for your HubSpot developer application.\
\ See the Hubspot docs if you need help finding this secret."
order: 1
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "Refresh token to renew an expired access token. See\
\ the Hubspot docs if you need help finding this token."
order: 2
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
type:
default: "OAuth"
enum:
- "OAuth"
type: "string"
required:
- "type"
- "client_id"
- "client_secret"
- "refresh_token"
title: "OAuth"
type: "object"
order: 0
title: "Credentials"
type: "object"
object_storage_config:
oneOf:
- additionalProperties: true
properties:
storage_type:
default: "None"
enum:
- "None"
type: "string"
required:
- "storage_type"
title: "None"
type: "object"
- additionalProperties: true
properties:
access_key_id:
airbyte_secret: true
always_show: true
description: "The access key ID to access the S3 bucket. Airbyte requires\
\ Read and Write permissions to the given bucket. Read more here."
examples:
- "A012345678910EXAMPLE"
order: 1
title: "Access Key ID"
type: "string"
x-speakeasy-param-sensitive: true
bucket_path:
description: "All files in the bucket will be prefixed by this."
examples:
- "prefix/"
order: 7
title: "Prefix Path in the Bucket"
type: "string"
role_arn:
description: "The ARN of the AWS role to assume. Only usable in Airbyte\
\ Cloud."
examples:
- "arn:aws:iam::123456789:role/ExternalIdIsYourWorkspaceId"
order: 3
title: "Role ARN"
type: "string"
s3_bucket_name:
description: "The name of the S3 bucket. Read more here."
examples:
- "airbyte_sync"
order: 4
title: "S3 Bucket Name"
type: "string"
s3_bucket_region:
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"
examples:
- "us-east-1"
order: 5
title: "S3 Bucket Region"
type: "string"
s3_endpoint:
description: "Your S3 endpoint url. Read more here"
examples:
- "http://localhost:9000"
order: 6
title: "S3 Endpoint"
type: "string"
secret_access_key:
airbyte_secret: true
always_show: true
description: "The corresponding secret to the access key ID. Read\
\ more here"
examples:
- "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY"
order: 2
title: "Secret Access Key"
type: "string"
x-speakeasy-param-sensitive: true
storage_type:
default: "S3"
enum:
- "S3"
type: "string"
required:
- "storage_type"
- "s3_bucket_name"
- "s3_bucket_region"
- "bucket_path"
- "format"
title: "S3"
type: "object"
title: "Object Storage Configuration"
type: "object"
destinationType:
title: "hubspot"
const: "hubspot"
enum:
- "hubspot"
order: 0
type: "string"
required:
- "credentials"
- "destinationType"
title: "Hub Spot Specification"
type: "object"
destination-hubspot-update:
properties:
credentials:
description: "Choose how to authenticate to HubSpot."
oneOf:
- additionalProperties: true
properties:
client_id:
airbyte_secret: true
description: "The Client ID of your HubSpot developer application.\
\ See the Hubspot docs if you need help finding this ID."
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The client secret for your HubSpot developer application.\
\ See the Hubspot docs if you need help finding this secret."
order: 1
title: "Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "Refresh token to renew an expired access token. See\
\ the Hubspot docs if you need help finding this token."
order: 2
title: "Refresh Token"
type: "string"
type:
default: "OAuth"
enum:
- "OAuth"
type: "string"
required:
- "type"
- "client_id"
- "client_secret"
- "refresh_token"
title: "OAuth"
type: "object"
order: 0
title: "Credentials"
type: "object"
object_storage_config:
oneOf:
- additionalProperties: true
properties:
storage_type:
default: "None"
enum:
- "None"
type: "string"
required:
- "storage_type"
title: "None"
type: "object"
- additionalProperties: true
properties:
access_key_id:
airbyte_secret: true
always_show: true
description: "The access key ID to access the S3 bucket. Airbyte requires\
\ Read and Write permissions to the given bucket. Read more here."
examples:
- "A012345678910EXAMPLE"
order: 1
title: "Access Key ID"
type: "string"
bucket_path:
description: "All files in the bucket will be prefixed by this."
examples:
- "prefix/"
order: 7
title: "Prefix Path in the Bucket"
type: "string"
role_arn:
description: "The ARN of the AWS role to assume. Only usable in Airbyte\
\ Cloud."
examples:
- "arn:aws:iam::123456789:role/ExternalIdIsYourWorkspaceId"
order: 3
title: "Role ARN"
type: "string"
s3_bucket_name:
description: "The name of the S3 bucket. Read more here."
examples:
- "airbyte_sync"
order: 4
title: "S3 Bucket Name"
type: "string"
s3_bucket_region:
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"
examples:
- "us-east-1"
order: 5
title: "S3 Bucket Region"
type: "string"
s3_endpoint:
description: "Your S3 endpoint url. Read more here"
examples:
- "http://localhost:9000"
order: 6
title: "S3 Endpoint"
type: "string"
secret_access_key:
airbyte_secret: true
always_show: true
description: "The corresponding secret to the access key ID. Read\
\ more here"
examples:
- "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY"
order: 2
title: "Secret Access Key"
type: "string"
storage_type:
default: "S3"
enum:
- "S3"
type: "string"
required:
- "storage_type"
- "s3_bucket_name"
- "s3_bucket_region"
- "bucket_path"
- "format"
title: "S3"
type: "object"
title: "Object Storage Configuration"
type: "object"
required:
- "credentials"
title: "Hub Spot Specification"
type: "object"
destination-clickhouse:
groups:
- id: "connection"
title: "Connection"
- id: "advanced"
title: "Advanced"
properties:
database:
default: "default"
description: "Name of the database."
order: 3
title: "Database"
type: "string"
enable_json:
default: false
description: "Use the JSON type for Object fields. If disabled, the JSON\
\ will be converted to a string."
order: 6
title: "Enable JSON"
type: "boolean"
host:
description: "Hostname of the database."
order: 0
title: "Hostname"
type: "string"
password:
airbyte_secret: true
description: "Password associated with the username."
order: 5
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
port:
default: "8443"
description: "HTTP port of the database. Default(s) HTTP: 8123 — HTTPS:\
\ 8443"
order: 1
title: "Port"
type: "string"
protocol:
default: "https"
description: "Protocol for the database connection string."
enum:
- "http"
- "https"
order: 2
title: "Protocol"
type: "string"
record_window_size:
description: "Warning: Tuning this parameter can impact the performances.\
\ The maximum number of records that should be written to a batch. The\
\ batch size limit is still limited to 70 Mb"
order: 8
title: "Record Window Size"
type: "integer"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- additionalProperties: true
description: "No ssh tunnel needed to connect to database"
properties:
tunnel_method:
default: "NO_TUNNEL"
enum:
- "NO_TUNNEL"
type: "string"
required:
- "tunnel_method"
title: "No Tunnel"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
x-speakeasy-param-sensitive: true
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_KEY_AUTH"
enum:
- "SSH_KEY_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_PASSWORD_AUTH"
enum:
- "SSH_PASSWORD_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
type: "object"
order: 5
title: "SSH Tunnel Method"
type: "object"
username:
default: "default"
description: "Username to use to access the database."
order: 4
title: "Username"
type: "string"
destinationType:
title: "clickhouse"
const: "clickhouse"
enum:
- "clickhouse"
order: 0
type: "string"
required:
- "host"
- "port"
- "protocol"
- "database"
- "username"
- "password"
- "destinationType"
title: "Clickhouse Specification Oss"
type: "object"
destination-clickhouse-update:
groups:
- id: "connection"
title: "Connection"
- id: "advanced"
title: "Advanced"
properties:
database:
default: "default"
description: "Name of the database."
order: 3
title: "Database"
type: "string"
enable_json:
default: false
description: "Use the JSON type for Object fields. If disabled, the JSON\
\ will be converted to a string."
order: 6
title: "Enable JSON"
type: "boolean"
host:
description: "Hostname of the database."
order: 0
title: "Hostname"
type: "string"
password:
airbyte_secret: true
description: "Password associated with the username."
order: 5
title: "Password"
type: "string"
port:
default: "8443"
description: "HTTP port of the database. Default(s) HTTP: 8123 — HTTPS:\
\ 8443"
order: 1
title: "Port"
type: "string"
protocol:
default: "https"
description: "Protocol for the database connection string."
enum:
- "http"
- "https"
order: 2
title: "Protocol"
type: "string"
record_window_size:
description: "Warning: Tuning this parameter can impact the performances.\
\ The maximum number of records that should be written to a batch. The\
\ batch size limit is still limited to 70 Mb"
order: 8
title: "Record Window Size"
type: "integer"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- additionalProperties: true
description: "No ssh tunnel needed to connect to database"
properties:
tunnel_method:
default: "NO_TUNNEL"
enum:
- "NO_TUNNEL"
type: "string"
required:
- "tunnel_method"
title: "No Tunnel"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_KEY_AUTH"
enum:
- "SSH_KEY_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_PASSWORD_AUTH"
enum:
- "SSH_PASSWORD_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
type: "object"
order: 5
title: "SSH Tunnel Method"
type: "object"
username:
default: "default"
description: "Username to use to access the database."
order: 4
title: "Username"
type: "string"
required:
- "host"
- "port"
- "protocol"
- "database"
- "username"
- "password"
title: "Clickhouse Specification Oss"
type: "object"
destination-mssql:
properties:
database:
description: "The name of the MSSQL database."
order: 2
title: "DB Name"
type: "string"
host:
description: "The host name of the MSSQL database."
order: 0
title: "Host"
type: "string"
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)."
order: 6
title: "JDBC URL Params"
type: "string"
load_type:
always_show: true
description: "Specifies the type of load mechanism (e.g., BULK, INSERT)\
\ and its associated configuration."
oneOf:
- additionalProperties: true
description: "Configuration details for using the INSERT loading mechanism."
properties:
load_type:
default: "INSERT"
enum:
- "INSERT"
type: "string"
required:
- "load_type"
title: "Insert Load"
type: "object"
- additionalProperties: true
description: "Configuration details for using the BULK loading mechanism."
properties:
azure_blob_storage_account_key:
airbyte_secret: true
always_show: true
description: "The Azure blob storage account key. Mutually exclusive\
\ with a Shared Access Signature"
examples:
- "Z8ZkZpteggFx394vm+PJHnGTvdRncaYS+JhLKdj789YNmD+iyGTnG+PV+POiuYNhBg/ACS+LKjd%4FG3FHGN12Nd=="
title: "Azure Blob Storage account key"
type: "string"
x-speakeasy-param-sensitive: true
azure_blob_storage_account_name:
description: "The name of the Azure Blob Storage account. See: https://learn.microsoft.com/azure/storage/blobs/storage-blobs-introduction#storage-accounts"
examples:
- "mystorageaccount"
title: "Azure Blob Storage Account Name"
type: "string"
azure_blob_storage_container_name:
description: "The name of the Azure Blob Storage container. See: https://learn.microsoft.com/azure/storage/blobs/storage-blobs-introduction#containers"
examples:
- "mycontainer"
title: "Azure Blob Storage Container Name"
type: "string"
bulk_load_data_source:
always_show: true
description: "Specifies the external data source name configured in\
\ MSSQL, which references the Azure Blob container. See: https://learn.microsoft.com/sql/t-sql/statements/bulk-insert-transact-sql"
examples:
- "MyAzureBlobStorage"
order: 5
title: "BULK Load Data Source"
type: "string"
bulk_load_validate_values_pre_load:
always_show: false
default: false
description: "When enabled, Airbyte will validate all values before\
\ loading them into the destination table. This provides stronger\
\ data integrity guarantees but may significantly impact performance."
examples:
- "false"
order: 6
title: "Pre-Load Value Validation"
type: "boolean"
load_type:
default: "BULK"
enum:
- "BULK"
type: "string"
shared_access_signature:
airbyte_secret: true
always_show: true
description: "A shared access signature (SAS) provides secure delegated\
\ access to resources in your storage account. See: https://learn.microsoft.com/azure/storage/common/storage-sas-overview.Mutually\
\ exclusive with an account key"
examples:
- "sv=2021-08-06&st=2025-04-11T00%3A00%3A00Z&se=2025-04-12T00%3A00%3A00Z&sr=b&sp=rw&sig=abcdefghijklmnopqrstuvwxyz1234567890%2Fabcdefg%3D"
title: "Shared Access Signature"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "load_type"
- "azure_blob_storage_account_name"
- "azure_blob_storage_container_name"
- "bulk_load_data_source"
title: "Bulk Load"
type: "object"
order: 8
title: "Load Type"
type: "object"
password:
airbyte_secret: true
description: "The password associated with this username."
order: 5
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
port:
description: "The port of the MSSQL database."
examples:
- "1433"
maximum: 65536
minimum: 0
order: 1
title: "Port"
type: "integer"
schema:
default: "public"
description: "The default schema tables are written to if the source does\
\ not specify a namespace. The usual value for this field is \"public\"\
."
examples:
- "public"
order: 3
title: "Default Schema"
type: "string"
ssl_method:
description: "The encryption method which is used to communicate with the\
\ database."
oneOf:
- additionalProperties: true
description: "The data transfer will not be encrypted."
properties:
name:
default: "unencrypted"
enum:
- "unencrypted"
type: "string"
required:
- "name"
title: "Unencrypted"
type: "object"
- additionalProperties: true
description: "Use the certificate provided by the server without verification.\
\ (For testing purposes only!)"
properties:
name:
default: "encrypted_trust_server_certificate"
enum:
- "encrypted_trust_server_certificate"
type: "string"
required:
- "name"
title: "Encrypted (trust server certificate)"
type: "object"
- additionalProperties: true
description: "Verify and use the certificate provided by the server."
properties:
hostNameInCertificate:
description: "Specifies the host name of the server. The value of\
\ this property must match the subject property of the certificate."
order: 3
title: "Host Name In Certificate"
type: "string"
name:
default: "encrypted_verify_certificate"
enum:
- "encrypted_verify_certificate"
type: "string"
trustStoreName:
description: "Specifies the name of the trust store."
order: 1
title: "Trust Store Name"
type: "string"
trustStorePassword:
airbyte_secret: true
description: "Specifies the password of the trust store."
order: 2
title: "Trust Store Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "name"
title: "Encrypted (verify certificate)"
type: "object"
order: 7
title: "SSL Method"
type: "object"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- additionalProperties: true
description: "No ssh tunnel needed to connect to database"
properties:
tunnel_method:
default: "NO_TUNNEL"
enum:
- "NO_TUNNEL"
type: "string"
required:
- "tunnel_method"
title: "No Tunnel"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
x-speakeasy-param-sensitive: true
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_KEY_AUTH"
enum:
- "SSH_KEY_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_PASSWORD_AUTH"
enum:
- "SSH_PASSWORD_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
type: "object"
order: 5
title: "SSH Tunnel Method"
type: "object"
user:
description: "The username which is used to access the database."
order: 4
title: "User"
type: "string"
destinationType:
title: "mssql"
const: "mssql"
enum:
- "mssql"
order: 0
type: "string"
required:
- "host"
- "port"
- "database"
- "schema"
- "user"
- "ssl_method"
- "load_type"
- "destinationType"
title: "MSSQL Destination Specification"
type: "object"
destination-mssql-update:
properties:
database:
description: "The name of the MSSQL database."
order: 2
title: "DB Name"
type: "string"
host:
description: "The host name of the MSSQL database."
order: 0
title: "Host"
type: "string"
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)."
order: 6
title: "JDBC URL Params"
type: "string"
load_type:
always_show: true
description: "Specifies the type of load mechanism (e.g., BULK, INSERT)\
\ and its associated configuration."
oneOf:
- additionalProperties: true
description: "Configuration details for using the INSERT loading mechanism."
properties:
load_type:
default: "INSERT"
enum:
- "INSERT"
type: "string"
required:
- "load_type"
title: "Insert Load"
type: "object"
- additionalProperties: true
description: "Configuration details for using the BULK loading mechanism."
properties:
azure_blob_storage_account_key:
airbyte_secret: true
always_show: true
description: "The Azure blob storage account key. Mutually exclusive\
\ with a Shared Access Signature"
examples:
- "Z8ZkZpteggFx394vm+PJHnGTvdRncaYS+JhLKdj789YNmD+iyGTnG+PV+POiuYNhBg/ACS+LKjd%4FG3FHGN12Nd=="
title: "Azure Blob Storage account key"
type: "string"
azure_blob_storage_account_name:
description: "The name of the Azure Blob Storage account. See: https://learn.microsoft.com/azure/storage/blobs/storage-blobs-introduction#storage-accounts"
examples:
- "mystorageaccount"
title: "Azure Blob Storage Account Name"
type: "string"
azure_blob_storage_container_name:
description: "The name of the Azure Blob Storage container. See: https://learn.microsoft.com/azure/storage/blobs/storage-blobs-introduction#containers"
examples:
- "mycontainer"
title: "Azure Blob Storage Container Name"
type: "string"
bulk_load_data_source:
always_show: true
description: "Specifies the external data source name configured in\
\ MSSQL, which references the Azure Blob container. See: https://learn.microsoft.com/sql/t-sql/statements/bulk-insert-transact-sql"
examples:
- "MyAzureBlobStorage"
order: 5
title: "BULK Load Data Source"
type: "string"
bulk_load_validate_values_pre_load:
always_show: false
default: false
description: "When enabled, Airbyte will validate all values before\
\ loading them into the destination table. This provides stronger\
\ data integrity guarantees but may significantly impact performance."
examples:
- "false"
order: 6
title: "Pre-Load Value Validation"
type: "boolean"
load_type:
default: "BULK"
enum:
- "BULK"
type: "string"
shared_access_signature:
airbyte_secret: true
always_show: true
description: "A shared access signature (SAS) provides secure delegated\
\ access to resources in your storage account. See: https://learn.microsoft.com/azure/storage/common/storage-sas-overview.Mutually\
\ exclusive with an account key"
examples:
- "sv=2021-08-06&st=2025-04-11T00%3A00%3A00Z&se=2025-04-12T00%3A00%3A00Z&sr=b&sp=rw&sig=abcdefghijklmnopqrstuvwxyz1234567890%2Fabcdefg%3D"
title: "Shared Access Signature"
type: "string"
required:
- "load_type"
- "azure_blob_storage_account_name"
- "azure_blob_storage_container_name"
- "bulk_load_data_source"
title: "Bulk Load"
type: "object"
order: 8
title: "Load Type"
type: "object"
password:
airbyte_secret: true
description: "The password associated with this username."
order: 5
title: "Password"
type: "string"
port:
description: "The port of the MSSQL database."
examples:
- "1433"
maximum: 65536
minimum: 0
order: 1
title: "Port"
type: "integer"
schema:
default: "public"
description: "The default schema tables are written to if the source does\
\ not specify a namespace. The usual value for this field is \"public\"\
."
examples:
- "public"
order: 3
title: "Default Schema"
type: "string"
ssl_method:
description: "The encryption method which is used to communicate with the\
\ database."
oneOf:
- additionalProperties: true
description: "The data transfer will not be encrypted."
properties:
name:
default: "unencrypted"
enum:
- "unencrypted"
type: "string"
required:
- "name"
title: "Unencrypted"
type: "object"
- additionalProperties: true
description: "Use the certificate provided by the server without verification.\
\ (For testing purposes only!)"
properties:
name:
default: "encrypted_trust_server_certificate"
enum:
- "encrypted_trust_server_certificate"
type: "string"
required:
- "name"
title: "Encrypted (trust server certificate)"
type: "object"
- additionalProperties: true
description: "Verify and use the certificate provided by the server."
properties:
hostNameInCertificate:
description: "Specifies the host name of the server. The value of\
\ this property must match the subject property of the certificate."
order: 3
title: "Host Name In Certificate"
type: "string"
name:
default: "encrypted_verify_certificate"
enum:
- "encrypted_verify_certificate"
type: "string"
trustStoreName:
description: "Specifies the name of the trust store."
order: 1
title: "Trust Store Name"
type: "string"
trustStorePassword:
airbyte_secret: true
description: "Specifies the password of the trust store."
order: 2
title: "Trust Store Password"
type: "string"
required:
- "name"
title: "Encrypted (verify certificate)"
type: "object"
order: 7
title: "SSL Method"
type: "object"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- additionalProperties: true
description: "No ssh tunnel needed to connect to database"
properties:
tunnel_method:
default: "NO_TUNNEL"
enum:
- "NO_TUNNEL"
type: "string"
required:
- "tunnel_method"
title: "No Tunnel"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_KEY_AUTH"
enum:
- "SSH_KEY_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
type: "object"
- additionalProperties: true
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
default: "SSH_PASSWORD_AUTH"
enum:
- "SSH_PASSWORD_AUTH"
type: "string"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
type: "object"
order: 5
title: "SSH Tunnel Method"
type: "object"
user:
description: "The username which is used to access the database."
order: 4
title: "User"
type: "string"
required:
- "host"
- "port"
- "database"
- "schema"
- "user"
- "ssl_method"
- "load_type"
title: "MSSQL Destination Specification"
type: "object"
destination-mysql:
properties:
database:
description: "Name of the database."
order: 2
title: "DB Name"
type: "string"
disable_type_dedupe:
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"
order: 8
title: "Disable Final Tables. (WARNING! Unstable option; Columns in raw\
\ table schema might change between versions)"
type: "boolean"
host:
description: "Hostname of the database."
order: 0
title: "Host"
type: "string"
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)."
order: 6
title: "JDBC URL Params"
type: "string"
password:
airbyte_secret: true
description: "Password associated with the username."
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
port:
default: 3306
description: "Port of the database."
examples:
- "3306"
maximum: 65536
minimum: 0
order: 1
title: "Port"
type: "integer"
raw_data_schema:
description: "The database to write raw tables into"
order: 7
title: "Raw table database (defaults to airbyte_internal)"
type: "string"
ssl:
default: true
description: "Encrypt data using SSL."
order: 5
title: "SSL Connection"
type: "boolean"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- properties:
tunnel_method:
const: "NO_TUNNEL"
description: "No ssh tunnel needed to connect to database"
order: 0
type: "string"
enum:
- "NO_TUNNEL"
required:
- "tunnel_method"
title: "No Tunnel"
- properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
x-speakeasy-param-sensitive: true
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_KEY_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host."
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
- properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
title: "SSH Tunnel Method"
type: "object"
username:
description: "Username to use to access the database."
order: 3
title: "User"
type: "string"
destinationType:
title: "mysql"
const: "mysql"
enum:
- "mysql"
order: 0
type: "string"
required:
- "host"
- "port"
- "username"
- "database"
- "destinationType"
title: "MySQL Destination Spec"
type: "object"
destination-mysql-update:
properties:
database:
description: "Name of the database."
order: 2
title: "DB Name"
type: "string"
disable_type_dedupe:
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"
order: 8
title: "Disable Final Tables. (WARNING! Unstable option; Columns in raw\
\ table schema might change between versions)"
type: "boolean"
host:
description: "Hostname of the database."
order: 0
title: "Host"
type: "string"
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)."
order: 6
title: "JDBC URL Params"
type: "string"
password:
airbyte_secret: true
description: "Password associated with the username."
order: 4
title: "Password"
type: "string"
port:
default: 3306
description: "Port of the database."
examples:
- "3306"
maximum: 65536
minimum: 0
order: 1
title: "Port"
type: "integer"
raw_data_schema:
description: "The database to write raw tables into"
order: 7
title: "Raw table database (defaults to airbyte_internal)"
type: "string"
ssl:
default: true
description: "Encrypt data using SSL."
order: 5
title: "SSL Connection"
type: "boolean"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- properties:
tunnel_method:
const: "NO_TUNNEL"
description: "No ssh tunnel needed to connect to database"
order: 0
type: "string"
enum:
- "NO_TUNNEL"
required:
- "tunnel_method"
title: "No Tunnel"
- properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_KEY_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host."
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
- properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
title: "SSH Tunnel Method"
type: "object"
username:
description: "Username to use to access the database."
order: 3
title: "User"
type: "string"
required:
- "host"
- "port"
- "username"
- "database"
title: "MySQL Destination Spec"
type: "object"
destination-mongodb:
properties:
auth_type:
description: "Authorization type."
oneOf:
- description: "None."
properties:
authorization:
const: "none"
type: "string"
enum:
- "none"
required:
- "authorization"
title: "None"
type: "object"
- description: "Login/Password."
properties:
authorization:
const: "login/password"
type: "string"
enum:
- "login/password"
password:
airbyte_secret: true
description: "Password associated with the username."
order: 2
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
username:
description: "Username to use to access the database."
order: 1
title: "User"
type: "string"
required:
- "authorization"
- "username"
- "password"
title: "Login/Password"
type: "object"
title: "Authorization type"
type: "object"
database:
description: "Name of the database."
order: 2
title: "DB Name"
type: "string"
instance_type:
description: "MongoDb instance to connect to. For MongoDB Atlas and Replica\
\ Set TLS connection is used by default."
oneOf:
- properties:
host:
description: "The Host of a Mongo database to be replicated."
order: 0
title: "Host"
type: "string"
instance:
default: "standalone"
enum:
- "standalone"
type: "string"
port:
default: 27017
description: "The Port of a Mongo database to be replicated."
examples:
- "27017"
maximum: 65536
minimum: 0
order: 1
title: "Port"
type: "integer"
tls:
default: false
description: "Indicates whether TLS encryption protocol will be used\
\ to connect to MongoDB. It is recommended to use TLS connection\
\ if possible. For more information see documentation."
order: 2
title: "TLS Connection"
type: "boolean"
required:
- "instance"
- "host"
- "port"
title: "Standalone MongoDb Instance"
- properties:
instance:
default: "replica"
enum:
- "replica"
type: "string"
replica_set:
description: "A replica set name."
order: 1
title: "Replica Set"
type: "string"
server_addresses:
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
title: "Server addresses"
type: "string"
required:
- "instance"
- "server_addresses"
title: "Replica Set"
- properties:
cluster_url:
description: "URL of a cluster to connect to."
order: 0
title: "Cluster URL"
type: "string"
instance:
default: "atlas"
enum:
- "atlas"
type: "string"
required:
- "instance"
- "cluster_url"
title: "MongoDB Atlas"
order: 0
title: "MongoDb Instance Type"
type: "object"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- properties:
tunnel_method:
const: "NO_TUNNEL"
description: "No ssh tunnel needed to connect to database"
order: 0
type: "string"
enum:
- "NO_TUNNEL"
required:
- "tunnel_method"
title: "No Tunnel"
- properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
x-speakeasy-param-sensitive: true
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_KEY_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host."
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
- properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
title: "SSH Tunnel Method"
type: "object"
destinationType:
title: "mongodb"
const: "mongodb"
enum:
- "mongodb"
order: 0
type: "string"
required:
- "database"
- "auth_type"
- "destinationType"
title: "MongoDB Destination Spec"
type: "object"
destination-mongodb-update:
properties:
auth_type:
description: "Authorization type."
oneOf:
- description: "None."
properties:
authorization:
const: "none"
type: "string"
enum:
- "none"
required:
- "authorization"
title: "None"
type: "object"
- description: "Login/Password."
properties:
authorization:
const: "login/password"
type: "string"
enum:
- "login/password"
password:
airbyte_secret: true
description: "Password associated with the username."
order: 2
title: "Password"
type: "string"
username:
description: "Username to use to access the database."
order: 1
title: "User"
type: "string"
required:
- "authorization"
- "username"
- "password"
title: "Login/Password"
type: "object"
title: "Authorization type"
type: "object"
database:
description: "Name of the database."
order: 2
title: "DB Name"
type: "string"
instance_type:
description: "MongoDb instance to connect to. For MongoDB Atlas and Replica\
\ Set TLS connection is used by default."
oneOf:
- properties:
host:
description: "The Host of a Mongo database to be replicated."
order: 0
title: "Host"
type: "string"
instance:
default: "standalone"
enum:
- "standalone"
type: "string"
port:
default: 27017
description: "The Port of a Mongo database to be replicated."
examples:
- "27017"
maximum: 65536
minimum: 0
order: 1
title: "Port"
type: "integer"
tls:
default: false
description: "Indicates whether TLS encryption protocol will be used\
\ to connect to MongoDB. It is recommended to use TLS connection\
\ if possible. For more information see documentation."
order: 2
title: "TLS Connection"
type: "boolean"
required:
- "instance"
- "host"
- "port"
title: "Standalone MongoDb Instance"
- properties:
instance:
default: "replica"
enum:
- "replica"
type: "string"
replica_set:
description: "A replica set name."
order: 1
title: "Replica Set"
type: "string"
server_addresses:
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
title: "Server addresses"
type: "string"
required:
- "instance"
- "server_addresses"
title: "Replica Set"
- properties:
cluster_url:
description: "URL of a cluster to connect to."
order: 0
title: "Cluster URL"
type: "string"
instance:
default: "atlas"
enum:
- "atlas"
type: "string"
required:
- "instance"
- "cluster_url"
title: "MongoDB Atlas"
order: 0
title: "MongoDb Instance Type"
type: "object"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- properties:
tunnel_method:
const: "NO_TUNNEL"
description: "No ssh tunnel needed to connect to database"
order: 0
type: "string"
enum:
- "NO_TUNNEL"
required:
- "tunnel_method"
title: "No Tunnel"
- properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_KEY_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host."
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
- properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
title: "SSH Tunnel Method"
type: "object"
required:
- "database"
- "auth_type"
title: "MongoDB Destination Spec"
type: "object"
destination-redshift:
groups:
- id: "connection"
title: "Connection"
- id: "tables"
title: "Tables"
properties:
database:
description: "Name of the database."
group: "connection"
order: 5
title: "Database"
type: "string"
disable_type_dedupe:
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"
group: "tables"
order: 11
title: "Disable Final Tables. (WARNING! Unstable option; Columns in raw\
\ table schema might change between versions)"
type: "boolean"
drop_cascade:
default: false
description: "Drop tables with CASCADE. WARNING! This will delete all data\
\ in all dependent objects (views, etc.). Use with caution. This option\
\ is intended for usecases which can easily rebuild the dependent objects."
group: "tables"
order: 12
title: "Drop tables with CASCADE. (WARNING! Risk of unrecoverable data loss)"
type: "boolean"
host:
description: "Host Endpoint of the Redshift Cluster (must include the cluster-id,\
\ region and end with .redshift.amazonaws.com)"
group: "connection"
order: 1
title: "Host"
type: "string"
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)."
group: "connection"
order: 7
title: "JDBC URL Params"
type: "string"
password:
airbyte_secret: true
description: "Password associated with the username."
group: "connection"
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
port:
default: 5439
description: "Port of the database."
examples:
- "5439"
group: "connection"
maximum: 65536
minimum: 0
order: 2
title: "Port"
type: "integer"
raw_data_schema:
description: "The schema to write raw tables into (default: airbyte_internal)."
group: "tables"
order: 9
title: "Destinations V2 Raw Table Schema"
type: "string"
schema:
default: "public"
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\"."
examples:
- "public"
group: "connection"
order: 6
title: "Default Schema"
type: "string"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- properties:
tunnel_method:
const: "NO_TUNNEL"
description: "No ssh tunnel needed to connect to database"
order: 0
type: "string"
enum:
- "NO_TUNNEL"
required:
- "tunnel_method"
title: "No Tunnel"
- properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
x-speakeasy-param-sensitive: true
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_KEY_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host."
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
- properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
title: "SSH Tunnel Method"
type: "object"
uploading_method:
description: "The way data will be uploaded to Redshift."
display_type: "radio"
group: "connection"
oneOf:
- 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."
properties:
access_key_id:
airbyte_secret: true
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."
order: 3
title: "S3 Access Key Id"
type: "string"
x-speakeasy-param-sensitive: true
file_name_pattern:
description: "The pattern allows you to set the file-name format for\
\ the S3 staging file(s)"
examples:
- "{date}"
- "{date:yyyy_MM}"
- "{timestamp}"
- "{part_number}"
- "{sync_id}"
order: 5
title: "S3 Filename pattern"
type: "string"
method:
const: "S3 Staging"
type: "string"
enum:
- "S3 Staging"
purge_staging_data:
default: true
description: "Whether to delete the staging files from S3 after completing\
\ the sync. See docs for details."
order: 6
title: "Purge Staging Files and Tables"
type: "boolean"
s3_bucket_name:
description: "The name of the staging S3 bucket."
examples:
- "airbyte.staging"
order: 0
title: "S3 Bucket Name"
type: "string"
s3_bucket_path:
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
title: "S3 Bucket Path"
type: "string"
s3_bucket_region:
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
title: "S3 Bucket Region"
type: "string"
secret_access_key:
airbyte_secret: true
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."
order: 4
title: "S3 Secret Access Key"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "method"
- "s3_bucket_name"
- "s3_bucket_region"
- "access_key_id"
- "secret_access_key"
title: "AWS S3 Staging"
order: 8
title: "Uploading Method"
type: "object"
username:
description: "Username to use to access the database."
group: "connection"
order: 3
title: "Username"
type: "string"
destinationType:
title: "redshift"
const: "redshift"
enum:
- "redshift"
order: 0
type: "string"
required:
- "host"
- "port"
- "database"
- "username"
- "password"
- "schema"
- "destinationType"
title: "Redshift Destination Spec"
type: "object"
destination-redshift-update:
groups:
- id: "connection"
title: "Connection"
- id: "tables"
title: "Tables"
properties:
database:
description: "Name of the database."
group: "connection"
order: 5
title: "Database"
type: "string"
disable_type_dedupe:
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"
group: "tables"
order: 11
title: "Disable Final Tables. (WARNING! Unstable option; Columns in raw\
\ table schema might change between versions)"
type: "boolean"
drop_cascade:
default: false
description: "Drop tables with CASCADE. WARNING! This will delete all data\
\ in all dependent objects (views, etc.). Use with caution. This option\
\ is intended for usecases which can easily rebuild the dependent objects."
group: "tables"
order: 12
title: "Drop tables with CASCADE. (WARNING! Risk of unrecoverable data loss)"
type: "boolean"
host:
description: "Host Endpoint of the Redshift Cluster (must include the cluster-id,\
\ region and end with .redshift.amazonaws.com)"
group: "connection"
order: 1
title: "Host"
type: "string"
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)."
group: "connection"
order: 7
title: "JDBC URL Params"
type: "string"
password:
airbyte_secret: true
description: "Password associated with the username."
group: "connection"
order: 4
title: "Password"
type: "string"
port:
default: 5439
description: "Port of the database."
examples:
- "5439"
group: "connection"
maximum: 65536
minimum: 0
order: 2
title: "Port"
type: "integer"
raw_data_schema:
description: "The schema to write raw tables into (default: airbyte_internal)."
group: "tables"
order: 9
title: "Destinations V2 Raw Table Schema"
type: "string"
schema:
default: "public"
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\"."
examples:
- "public"
group: "connection"
order: 6
title: "Default Schema"
type: "string"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- properties:
tunnel_method:
const: "NO_TUNNEL"
description: "No ssh tunnel needed to connect to database"
order: 0
type: "string"
enum:
- "NO_TUNNEL"
required:
- "tunnel_method"
title: "No Tunnel"
- properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_KEY_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host."
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
- properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
title: "SSH Tunnel Method"
type: "object"
uploading_method:
description: "The way data will be uploaded to Redshift."
display_type: "radio"
group: "connection"
oneOf:
- 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."
properties:
access_key_id:
airbyte_secret: true
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."
order: 3
title: "S3 Access Key Id"
type: "string"
file_name_pattern:
description: "The pattern allows you to set the file-name format for\
\ the S3 staging file(s)"
examples:
- "{date}"
- "{date:yyyy_MM}"
- "{timestamp}"
- "{part_number}"
- "{sync_id}"
order: 5
title: "S3 Filename pattern"
type: "string"
method:
const: "S3 Staging"
type: "string"
enum:
- "S3 Staging"
purge_staging_data:
default: true
description: "Whether to delete the staging files from S3 after completing\
\ the sync. See docs for details."
order: 6
title: "Purge Staging Files and Tables"
type: "boolean"
s3_bucket_name:
description: "The name of the staging S3 bucket."
examples:
- "airbyte.staging"
order: 0
title: "S3 Bucket Name"
type: "string"
s3_bucket_path:
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
title: "S3 Bucket Path"
type: "string"
s3_bucket_region:
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
title: "S3 Bucket Region"
type: "string"
secret_access_key:
airbyte_secret: true
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."
order: 4
title: "S3 Secret Access Key"
type: "string"
required:
- "method"
- "s3_bucket_name"
- "s3_bucket_region"
- "access_key_id"
- "secret_access_key"
title: "AWS S3 Staging"
order: 8
title: "Uploading Method"
type: "object"
username:
description: "Username to use to access the database."
group: "connection"
order: 3
title: "Username"
type: "string"
required:
- "host"
- "port"
- "database"
- "username"
- "password"
- "schema"
title: "Redshift Destination Spec"
type: "object"
destination-dynamodb:
properties:
access_key_id:
airbyte_secret: true
description: "The access key id to access the DynamoDB. Airbyte requires\
\ Read and Write permissions to the DynamoDB."
examples:
- "A012345678910EXAMPLE"
title: "DynamoDB Key Id"
type: "string"
x-speakeasy-param-sensitive: true
dynamodb_endpoint:
default: ""
description: "This is your DynamoDB endpoint url.(if you are working with\
\ AWS DynamoDB, just leave empty)."
examples:
- "http://localhost:9000"
title: "Endpoint"
type: "string"
dynamodb_region:
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"
title: "DynamoDB Region"
type: "string"
dynamodb_table_name_prefix:
description: "The prefix to use when naming DynamoDB tables."
examples:
- "airbyte_sync"
title: "Table name prefix"
type: "string"
secret_access_key:
airbyte_secret: true
description: "The corresponding secret to the access key id."
examples:
- "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY"
title: "DynamoDB Access Key"
type: "string"
x-speakeasy-param-sensitive: true
destinationType:
title: "dynamodb"
const: "dynamodb"
enum:
- "dynamodb"
order: 0
type: "string"
required:
- "dynamodb_table_name_prefix"
- "dynamodb_region"
- "access_key_id"
- "secret_access_key"
- "destinationType"
title: "DynamoDB Destination Spec"
type: "object"
destination-dynamodb-update:
properties:
access_key_id:
airbyte_secret: true
description: "The access key id to access the DynamoDB. Airbyte requires\
\ Read and Write permissions to the DynamoDB."
examples:
- "A012345678910EXAMPLE"
title: "DynamoDB Key Id"
type: "string"
dynamodb_endpoint:
default: ""
description: "This is your DynamoDB endpoint url.(if you are working with\
\ AWS DynamoDB, just leave empty)."
examples:
- "http://localhost:9000"
title: "Endpoint"
type: "string"
dynamodb_region:
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"
title: "DynamoDB Region"
type: "string"
dynamodb_table_name_prefix:
description: "The prefix to use when naming DynamoDB tables."
examples:
- "airbyte_sync"
title: "Table name prefix"
type: "string"
secret_access_key:
airbyte_secret: true
description: "The corresponding secret to the access key id."
examples:
- "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY"
title: "DynamoDB Access Key"
type: "string"
required:
- "dynamodb_table_name_prefix"
- "dynamodb_region"
- "access_key_id"
- "secret_access_key"
title: "DynamoDB Destination Spec"
type: "object"
destination-snowflake:
groups:
- id: "connection"
title: "Connection"
- id: "sync_behavior"
title: "Sync Behavior"
- id: "advanced"
title: "Advanced"
properties:
cdc_deletion_mode:
always_show: true
default: "Hard delete"
description: "Whether to execute CDC deletions as hard deletes (i.e. propagate\
\ source deletions to the destination), or soft deletes (i.e. leave a\
\ tombstone record in the destination). Defaults to hard deletes."
enum:
- "Hard delete"
- "Soft delete"
group: "sync_behavior"
order: 5
title: "CDC deletion mode"
type: "string"
credentials:
description: "Determines the type of authentication that should be used."
group: "connection"
oneOf:
- additionalProperties: true
description: "Configuration details for the Key Pair Authentication."
properties:
auth_type:
default: "Key Pair Authentication"
enum:
- "Key Pair Authentication"
type: "string"
private_key:
airbyte_secret: true
description: "RSA Private key to use for Snowflake connection. See\
\ the docs for more\n information on how to obtain this key."
multiline: true
order: 0
title: "Private Key"
type: "string"
x-speakeasy-param-sensitive: true
private_key_password:
description: "Passphrase for private key"
order: 0
title: "Passphrase"
type: "string"
required:
- "auth_type"
- "private_key"
title: "Key Pair Authentication"
type: "object"
- additionalProperties: true
description: "Configuration details for the Username and Password Authentication."
properties:
auth_type:
default: "Username and Password"
enum:
- "Username and Password"
type: "string"
password:
airbyte_secret: true
description: "Enter the password associated with the username."
order: 0
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_type"
- "password"
title: "Username and Password"
type: "object"
order: 6
title: "Authorization Method"
type: "object"
database:
description: "Enter the name of the database you want to sync data into"
examples:
- "AIRBYTE_DATABASE"
group: "connection"
order: 3
title: "Database"
type: "string"
disable_type_dedupe:
description: "Write the legacy \"raw tables\" format, to enable backwards\
\ compatibility with older versions of this connector."
group: "advanced"
order: 7
title: "Legacy raw tables"
type: "boolean"
host:
description: "Enter your Snowflake account's locator (in the format ...snowflakecomputing.com)"
examples:
- "accountname.us-east-2.aws.snowflakecomputing.com"
- "accountname.snowflakecomputing.com"
group: "connection"
order: 0
pattern: "^(http(s)?:\\/\\/)?([^./?#]+\\.)?([^./?#]+\\.)?([^./?#]+\\.)?([^./?#]+\\\
.(snowflakecomputing\\.com|localstack\\.cloud))$"
pattern_descriptor: "{account_name}.snowflakecomputing.com or {accountname}.{aws_location}.aws.snowflakecomputing.com"
title: "Host"
type: "string"
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"
group: "advanced"
order: 9
title: "JDBC URL Params"
type: "string"
raw_data_schema:
description: "Airbyte will use this dataset for various internal tables.\
\ In legacy raw tables mode, the raw tables will be stored in this dataset.\
\ Defaults to \"airbyte_internal\"."
group: "advanced"
order: 8
title: "Airbyte Internal Table Dataset Name"
type: "string"
retention_period_days:
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."
group: "advanced"
order: 10
title: "Data Retention Period (days)"
type: "integer"
role:
description: "Enter the role that you want to use to access Snowflake"
examples:
- "AIRBYTE_ROLE"
group: "connection"
order: 1
title: "Role"
type: "string"
schema:
description: "Enter the name of the default schema"
examples:
- "AIRBYTE_SCHEMA"
group: "connection"
order: 4
title: "Default Schema"
type: "string"
username:
description: "Enter the name of the user you want to use to access the database"
examples:
- "AIRBYTE_USER"
group: "connection"
order: 5
title: "Username"
type: "string"
warehouse:
description: "Enter the name of the warehouse that you want to use as a compute cluster"
examples:
- "AIRBYTE_WAREHOUSE"
group: "connection"
order: 2
title: "Warehouse"
type: "string"
destinationType:
title: "snowflake"
const: "snowflake"
enum:
- "snowflake"
order: 0
type: "string"
required:
- "host"
- "role"
- "warehouse"
- "database"
- "schema"
- "username"
- "destinationType"
title: "Snowflake Specification"
type: "object"
destination-snowflake-update:
groups:
- id: "connection"
title: "Connection"
- id: "sync_behavior"
title: "Sync Behavior"
- id: "advanced"
title: "Advanced"
properties:
cdc_deletion_mode:
always_show: true
default: "Hard delete"
description: "Whether to execute CDC deletions as hard deletes (i.e. propagate\
\ source deletions to the destination), or soft deletes (i.e. leave a\
\ tombstone record in the destination). Defaults to hard deletes."
enum:
- "Hard delete"
- "Soft delete"
group: "sync_behavior"
order: 5
title: "CDC deletion mode"
type: "string"
credentials:
description: "Determines the type of authentication that should be used."
group: "connection"
oneOf:
- additionalProperties: true
description: "Configuration details for the Key Pair Authentication."
properties:
auth_type:
default: "Key Pair Authentication"
enum:
- "Key Pair Authentication"
type: "string"
private_key:
airbyte_secret: true
description: "RSA Private key to use for Snowflake connection. See\
\ the docs for more\n information on how to obtain this key."
multiline: true
order: 0
title: "Private Key"
type: "string"
private_key_password:
description: "Passphrase for private key"
order: 0
title: "Passphrase"
type: "string"
required:
- "auth_type"
- "private_key"
title: "Key Pair Authentication"
type: "object"
- additionalProperties: true
description: "Configuration details for the Username and Password Authentication."
properties:
auth_type:
default: "Username and Password"
enum:
- "Username and Password"
type: "string"
password:
airbyte_secret: true
description: "Enter the password associated with the username."
order: 0
title: "Password"
type: "string"
required:
- "auth_type"
- "password"
title: "Username and Password"
type: "object"
order: 6
title: "Authorization Method"
type: "object"
database:
description: "Enter the name of the database you want to sync data into"
examples:
- "AIRBYTE_DATABASE"
group: "connection"
order: 3
title: "Database"
type: "string"
disable_type_dedupe:
description: "Write the legacy \"raw tables\" format, to enable backwards\
\ compatibility with older versions of this connector."
group: "advanced"
order: 7
title: "Legacy raw tables"
type: "boolean"
host:
description: "Enter your Snowflake account's locator (in the format ...snowflakecomputing.com)"
examples:
- "accountname.us-east-2.aws.snowflakecomputing.com"
- "accountname.snowflakecomputing.com"
group: "connection"
order: 0
pattern: "^(http(s)?:\\/\\/)?([^./?#]+\\.)?([^./?#]+\\.)?([^./?#]+\\.)?([^./?#]+\\\
.(snowflakecomputing\\.com|localstack\\.cloud))$"
pattern_descriptor: "{account_name}.snowflakecomputing.com or {accountname}.{aws_location}.aws.snowflakecomputing.com"
title: "Host"
type: "string"
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"
group: "advanced"
order: 9
title: "JDBC URL Params"
type: "string"
raw_data_schema:
description: "Airbyte will use this dataset for various internal tables.\
\ In legacy raw tables mode, the raw tables will be stored in this dataset.\
\ Defaults to \"airbyte_internal\"."
group: "advanced"
order: 8
title: "Airbyte Internal Table Dataset Name"
type: "string"
retention_period_days:
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."
group: "advanced"
order: 10
title: "Data Retention Period (days)"
type: "integer"
role:
description: "Enter the role that you want to use to access Snowflake"
examples:
- "AIRBYTE_ROLE"
group: "connection"
order: 1
title: "Role"
type: "string"
schema:
description: "Enter the name of the default schema"
examples:
- "AIRBYTE_SCHEMA"
group: "connection"
order: 4
title: "Default Schema"
type: "string"
username:
description: "Enter the name of the user you want to use to access the database"
examples:
- "AIRBYTE_USER"
group: "connection"
order: 5
title: "Username"
type: "string"
warehouse:
description: "Enter the name of the warehouse that you want to use as a compute cluster"
examples:
- "AIRBYTE_WAREHOUSE"
group: "connection"
order: 2
title: "Warehouse"
type: "string"
required:
- "host"
- "role"
- "warehouse"
- "database"
- "schema"
- "username"
title: "Snowflake Specification"
type: "object"
destination-oracle:
properties:
encryption:
description: "The encryption method which is used when communicating with\
\ the database."
oneOf:
- description: "Data transfer will not be encrypted."
properties:
encryption_method:
const: "unencrypted"
default: "unencrypted"
enum:
- "unencrypted"
type: "string"
required:
- "encryption_method"
title: "Unencrypted"
- 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."
properties:
encryption_algorithm:
default: "AES256"
description: "This parameter defines the database encryption algorithm."
enum:
- "AES256"
- "RC4_56"
- "3DES168"
title: "Encryption Algorithm"
type: "string"
encryption_method:
const: "client_nne"
default: "client_nne"
enum:
- "client_nne"
type: "string"
required:
- "encryption_method"
title: "Native Network Encryption (NNE)"
- description: "Verify and use the certificate provided by the server."
properties:
encryption_method:
const: "encrypted_verify_certificate"
default: "encrypted_verify_certificate"
enum:
- "encrypted_verify_certificate"
type: "string"
ssl_certificate:
airbyte_secret: true
description: "Privacy Enhanced Mail (PEM) files are concatenated certificate\
\ containers frequently used in certificate installations."
multiline: true
title: "SSL PEM file"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "encryption_method"
- "ssl_certificate"
title: "TLS Encrypted (verify certificate)"
order: 7
title: "Encryption"
type: "object"
host:
description: "The hostname of the database."
order: 0
title: "Host"
type: "string"
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)."
order: 5
title: "JDBC URL Params"
type: "string"
password:
airbyte_secret: true
description: "The password associated with the username."
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
port:
default: 1521
description: "The port of the database."
examples:
- "1521"
maximum: 65536
minimum: 0
order: 1
title: "Port"
type: "integer"
raw_data_schema:
description: "The schema to write raw tables into (default: airbyte_internal)"
order: 7
title: "Raw Table Schema Name"
type: "string"
schema:
default: "airbyte"
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."
examples:
- "airbyte"
order: 6
title: "Default Schema"
type: "string"
sid:
description: "The System Identifier uniquely distinguishes the instance\
\ from any other instance on the same computer."
order: 2
title: "SID"
type: "string"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- properties:
tunnel_method:
const: "NO_TUNNEL"
description: "No ssh tunnel needed to connect to database"
order: 0
type: "string"
enum:
- "NO_TUNNEL"
required:
- "tunnel_method"
title: "No Tunnel"
- properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
x-speakeasy-param-sensitive: true
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_KEY_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host."
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
- properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
title: "SSH Tunnel Method"
type: "object"
username:
description: "The username to access the database. This user must have CREATE\
\ USER privileges in the database."
order: 3
title: "User"
type: "string"
destinationType:
title: "oracle"
const: "oracle"
enum:
- "oracle"
order: 0
type: "string"
required:
- "host"
- "port"
- "username"
- "sid"
- "destinationType"
title: "Oracle Destination Spec"
type: "object"
destination-oracle-update:
properties:
encryption:
description: "The encryption method which is used when communicating with\
\ the database."
oneOf:
- description: "Data transfer will not be encrypted."
properties:
encryption_method:
const: "unencrypted"
default: "unencrypted"
enum:
- "unencrypted"
type: "string"
required:
- "encryption_method"
title: "Unencrypted"
- 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."
properties:
encryption_algorithm:
default: "AES256"
description: "This parameter defines the database encryption algorithm."
enum:
- "AES256"
- "RC4_56"
- "3DES168"
title: "Encryption Algorithm"
type: "string"
encryption_method:
const: "client_nne"
default: "client_nne"
enum:
- "client_nne"
type: "string"
required:
- "encryption_method"
title: "Native Network Encryption (NNE)"
- description: "Verify and use the certificate provided by the server."
properties:
encryption_method:
const: "encrypted_verify_certificate"
default: "encrypted_verify_certificate"
enum:
- "encrypted_verify_certificate"
type: "string"
ssl_certificate:
airbyte_secret: true
description: "Privacy Enhanced Mail (PEM) files are concatenated certificate\
\ containers frequently used in certificate installations."
multiline: true
title: "SSL PEM file"
type: "string"
required:
- "encryption_method"
- "ssl_certificate"
title: "TLS Encrypted (verify certificate)"
order: 7
title: "Encryption"
type: "object"
host:
description: "The hostname of the database."
order: 0
title: "Host"
type: "string"
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)."
order: 5
title: "JDBC URL Params"
type: "string"
password:
airbyte_secret: true
description: "The password associated with the username."
order: 4
title: "Password"
type: "string"
port:
default: 1521
description: "The port of the database."
examples:
- "1521"
maximum: 65536
minimum: 0
order: 1
title: "Port"
type: "integer"
raw_data_schema:
description: "The schema to write raw tables into (default: airbyte_internal)"
order: 7
title: "Raw Table Schema Name"
type: "string"
schema:
default: "airbyte"
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."
examples:
- "airbyte"
order: 6
title: "Default Schema"
type: "string"
sid:
description: "The System Identifier uniquely distinguishes the instance\
\ from any other instance on the same computer."
order: 2
title: "SID"
type: "string"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- properties:
tunnel_method:
const: "NO_TUNNEL"
description: "No ssh tunnel needed to connect to database"
order: 0
type: "string"
enum:
- "NO_TUNNEL"
required:
- "tunnel_method"
title: "No Tunnel"
- properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_KEY_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host."
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
- properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
title: "SSH Tunnel Method"
type: "object"
username:
description: "The username to access the database. This user must have CREATE\
\ USER privileges in the database."
order: 3
title: "User"
type: "string"
required:
- "host"
- "port"
- "username"
- "sid"
title: "Oracle Destination Spec"
type: "object"
destination-milvus:
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."
groups:
- id: "processing"
title: "Processing"
- id: "embedding"
title: "Embedding"
- id: "indexing"
title: "Indexing"
- id: "advanced"
title: "Advanced"
properties:
embedding:
description: "Embedding configuration"
group: "embedding"
oneOf:
- description: "Use the OpenAI API to embed text. This option is using the\
\ text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
mode:
const: "openai"
default: "openai"
enum:
- "openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
title: "OpenAI API key"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "openai_key"
- "mode"
title: "OpenAI"
type: "object"
- description: "Use the Cohere API to embed text."
properties:
cohere_key:
airbyte_secret: true
title: "Cohere API key"
type: "string"
x-speakeasy-param-sensitive: true
mode:
const: "cohere"
default: "cohere"
enum:
- "cohere"
title: "Mode"
type: "string"
required:
- "cohere_key"
- "mode"
title: "Cohere"
type: "object"
- 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."
properties:
mode:
const: "fake"
default: "fake"
enum:
- "fake"
title: "Mode"
type: "string"
required:
- "mode"
title: "Fake"
type: "object"
- description: "Use the Azure-hosted OpenAI API to embed text. This option\
\ is using the text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
api_base:
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"
title: "Resource base URL"
type: "string"
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"
title: "Deployment"
type: "string"
mode:
const: "azure_openai"
default: "azure_openai"
enum:
- "azure_openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
description: "The API key for your Azure OpenAI resource. You can\
\ find this in the Azure portal under your Azure OpenAI resource"
title: "Azure OpenAI API key"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "openai_key"
- "api_base"
- "deployment"
- "mode"
title: "Azure OpenAI"
type: "object"
- description: "Use a service that's compatible with the OpenAI API to embed\
\ text."
properties:
api_key:
airbyte_secret: true
default: ""
title: "API key"
type: "string"
x-speakeasy-param-sensitive: true
base_url:
description: "The base URL for your OpenAI-compatible service"
examples:
- "https://your-service-name.com"
title: "Base URL"
type: "string"
dimensions:
description: "The number of dimensions the embedding model is generating"
examples:
- 1536
- 384
title: "Embedding dimensions"
type: "integer"
mode:
const: "openai_compatible"
default: "openai_compatible"
enum:
- "openai_compatible"
title: "Mode"
type: "string"
model_name:
default: "text-embedding-ada-002"
description: "The name of the model to use for embedding"
examples:
- "text-embedding-ada-002"
title: "Model name"
type: "string"
required:
- "base_url"
- "dimensions"
- "mode"
title: "OpenAI-compatible"
type: "object"
title: "Embedding"
type: "object"
indexing:
description: "Indexing configuration"
group: "indexing"
properties:
auth:
description: "Authentication method"
oneOf:
- description: "Authenticate using an API token (suitable for Zilliz\
\ Cloud)"
properties:
mode:
const: "token"
default: "token"
enum:
- "token"
title: "Mode"
type: "string"
token:
airbyte_secret: true
description: "API Token for the Milvus instance"
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "token"
- "mode"
title: "API Token"
type: "object"
- description: "Authenticate using username and password (suitable for\
\ self-managed Milvus clusters)"
properties:
mode:
const: "username_password"
default: "username_password"
enum:
- "username_password"
title: "Mode"
type: "string"
password:
airbyte_secret: true
description: "Password for the Milvus instance"
order: 2
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
username:
description: "Username for the Milvus instance"
order: 1
title: "Username"
type: "string"
required:
- "username"
- "password"
- "mode"
title: "Username/Password"
type: "object"
- description: "Do not authenticate (suitable for locally running test\
\ clusters, do not use for clusters with public IP addresses)"
properties:
mode:
const: "no_auth"
default: "no_auth"
enum:
- "no_auth"
title: "Mode"
type: "string"
required:
- "mode"
title: "No auth"
type: "object"
order: 2
title: "Authentication"
type: "object"
collection:
description: "The collection to load data into"
order: 3
title: "Collection Name"
type: "string"
db:
default: ""
description: "The database to connect to"
title: "Database Name"
type: "string"
host:
description: "The public endpoint of the Milvus instance. "
examples:
- "https://my-instance.zone.zillizcloud.com"
- "tcp://host.docker.internal:19530"
- "tcp://my-local-milvus:19530"
order: 1
title: "Public Endpoint"
type: "string"
text_field:
default: "text"
description: "The field in the entity that contains the embedded text"
title: "Text Field"
type: "string"
vector_field:
default: "vector"
description: "The field in the entity that contains the vector"
title: "Vector Field"
type: "string"
required:
- "host"
- "collection"
- "auth"
title: "Indexing"
type: "object"
omit_raw_text:
default: false
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."
group: "advanced"
title: "Do not store raw text"
type: "boolean"
processing:
group: "processing"
properties:
chunk_overlap:
default: 0
description: "Size of overlap between chunks in tokens to store in vector\
\ store to better capture relevant context"
title: "Chunk overlap"
type: "integer"
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
title: "Chunk size"
type: "integer"
field_name_mappings:
default: []
description: "List of fields to rename. Not applicable for nested fields,\
\ but can be used to rename fields already flattened via dot notation."
items:
properties:
from_field:
description: "The field name in the source"
title: "From field name"
type: "string"
to_field:
description: "The field name to use in the destination"
title: "To field name"
type: "string"
required:
- "from_field"
- "to_field"
title: "FieldNameMappingConfigModel"
type: "object"
title: "Field name mappings"
type: "array"
metadata_fields:
always_show: true
default: []
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."
examples:
- "age"
- "user"
- "user.name"
items:
type: "string"
title: "Fields to store as metadata"
type: "array"
text_fields:
always_show: true
default: []
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."
examples:
- "text"
- "user.name"
- "users.*.name"
items:
type: "string"
title: "Text fields to embed"
type: "array"
text_splitter:
description: "Split text fields into chunks based on the specified method."
oneOf:
- 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."
properties:
keep_separator:
default: false
description: "Whether to keep the separator in the resulting chunks"
title: "Keep separator"
type: "boolean"
mode:
const: "separator"
default: "separator"
enum:
- "separator"
title: "Mode"
type: "string"
separators:
default:
- "\"\\n\\n\""
- "\"\\n\""
- "\" \""
- "\"\""
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\"."
items:
type: "string"
title: "Separators"
type: "array"
required:
- "mode"
title: "By Separator"
type: "object"
- 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."
properties:
mode:
const: "markdown"
default: "markdown"
enum:
- "markdown"
title: "Mode"
type: "string"
split_level:
default: 1
description: "Level of markdown headers to split text fields by.\
\ Headings down to the specified level will be used as split\
\ points"
maximum: 6
minimum: 1
title: "Split level"
type: "integer"
required:
- "mode"
title: "By Markdown header"
type: "object"
- description: "Split the text by suitable delimiters based on the programming\
\ language. This is useful for splitting code into chunks."
properties:
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"
title: "Language"
type: "string"
mode:
const: "code"
default: "code"
enum:
- "code"
title: "Mode"
type: "string"
required:
- "language"
- "mode"
title: "By Programming Language"
type: "object"
title: "Text splitter"
type: "object"
required:
- "chunk_size"
title: "ProcessingConfigModel"
type: "object"
destinationType:
title: "milvus"
const: "milvus"
enum:
- "milvus"
order: 0
type: "string"
required:
- "embedding"
- "processing"
- "indexing"
- "destinationType"
title: "Destination Config"
type: "object"
destination-milvus-update:
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."
groups:
- id: "processing"
title: "Processing"
- id: "embedding"
title: "Embedding"
- id: "indexing"
title: "Indexing"
- id: "advanced"
title: "Advanced"
properties:
embedding:
description: "Embedding configuration"
group: "embedding"
oneOf:
- description: "Use the OpenAI API to embed text. This option is using the\
\ text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
mode:
const: "openai"
default: "openai"
enum:
- "openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
title: "OpenAI API key"
type: "string"
required:
- "openai_key"
- "mode"
title: "OpenAI"
type: "object"
- description: "Use the Cohere API to embed text."
properties:
cohere_key:
airbyte_secret: true
title: "Cohere API key"
type: "string"
mode:
const: "cohere"
default: "cohere"
enum:
- "cohere"
title: "Mode"
type: "string"
required:
- "cohere_key"
- "mode"
title: "Cohere"
type: "object"
- 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."
properties:
mode:
const: "fake"
default: "fake"
enum:
- "fake"
title: "Mode"
type: "string"
required:
- "mode"
title: "Fake"
type: "object"
- description: "Use the Azure-hosted OpenAI API to embed text. This option\
\ is using the text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
api_base:
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"
title: "Resource base URL"
type: "string"
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"
title: "Deployment"
type: "string"
mode:
const: "azure_openai"
default: "azure_openai"
enum:
- "azure_openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
description: "The API key for your Azure OpenAI resource. You can\
\ find this in the Azure portal under your Azure OpenAI resource"
title: "Azure OpenAI API key"
type: "string"
required:
- "openai_key"
- "api_base"
- "deployment"
- "mode"
title: "Azure OpenAI"
type: "object"
- description: "Use a service that's compatible with the OpenAI API to embed\
\ text."
properties:
api_key:
airbyte_secret: true
default: ""
title: "API key"
type: "string"
base_url:
description: "The base URL for your OpenAI-compatible service"
examples:
- "https://your-service-name.com"
title: "Base URL"
type: "string"
dimensions:
description: "The number of dimensions the embedding model is generating"
examples:
- 1536
- 384
title: "Embedding dimensions"
type: "integer"
mode:
const: "openai_compatible"
default: "openai_compatible"
enum:
- "openai_compatible"
title: "Mode"
type: "string"
model_name:
default: "text-embedding-ada-002"
description: "The name of the model to use for embedding"
examples:
- "text-embedding-ada-002"
title: "Model name"
type: "string"
required:
- "base_url"
- "dimensions"
- "mode"
title: "OpenAI-compatible"
type: "object"
title: "Embedding"
type: "object"
indexing:
description: "Indexing configuration"
group: "indexing"
properties:
auth:
description: "Authentication method"
oneOf:
- description: "Authenticate using an API token (suitable for Zilliz\
\ Cloud)"
properties:
mode:
const: "token"
default: "token"
enum:
- "token"
title: "Mode"
type: "string"
token:
airbyte_secret: true
description: "API Token for the Milvus instance"
title: "API Token"
type: "string"
required:
- "token"
- "mode"
title: "API Token"
type: "object"
- description: "Authenticate using username and password (suitable for\
\ self-managed Milvus clusters)"
properties:
mode:
const: "username_password"
default: "username_password"
enum:
- "username_password"
title: "Mode"
type: "string"
password:
airbyte_secret: true
description: "Password for the Milvus instance"
order: 2
title: "Password"
type: "string"
username:
description: "Username for the Milvus instance"
order: 1
title: "Username"
type: "string"
required:
- "username"
- "password"
- "mode"
title: "Username/Password"
type: "object"
- description: "Do not authenticate (suitable for locally running test\
\ clusters, do not use for clusters with public IP addresses)"
properties:
mode:
const: "no_auth"
default: "no_auth"
enum:
- "no_auth"
title: "Mode"
type: "string"
required:
- "mode"
title: "No auth"
type: "object"
order: 2
title: "Authentication"
type: "object"
collection:
description: "The collection to load data into"
order: 3
title: "Collection Name"
type: "string"
db:
default: ""
description: "The database to connect to"
title: "Database Name"
type: "string"
host:
description: "The public endpoint of the Milvus instance. "
examples:
- "https://my-instance.zone.zillizcloud.com"
- "tcp://host.docker.internal:19530"
- "tcp://my-local-milvus:19530"
order: 1
title: "Public Endpoint"
type: "string"
text_field:
default: "text"
description: "The field in the entity that contains the embedded text"
title: "Text Field"
type: "string"
vector_field:
default: "vector"
description: "The field in the entity that contains the vector"
title: "Vector Field"
type: "string"
required:
- "host"
- "collection"
- "auth"
title: "Indexing"
type: "object"
omit_raw_text:
default: false
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."
group: "advanced"
title: "Do not store raw text"
type: "boolean"
processing:
group: "processing"
properties:
chunk_overlap:
default: 0
description: "Size of overlap between chunks in tokens to store in vector\
\ store to better capture relevant context"
title: "Chunk overlap"
type: "integer"
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
title: "Chunk size"
type: "integer"
field_name_mappings:
default: []
description: "List of fields to rename. Not applicable for nested fields,\
\ but can be used to rename fields already flattened via dot notation."
items:
properties:
from_field:
description: "The field name in the source"
title: "From field name"
type: "string"
to_field:
description: "The field name to use in the destination"
title: "To field name"
type: "string"
required:
- "from_field"
- "to_field"
title: "FieldNameMappingConfigModel"
type: "object"
title: "Field name mappings"
type: "array"
metadata_fields:
always_show: true
default: []
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."
examples:
- "age"
- "user"
- "user.name"
items:
type: "string"
title: "Fields to store as metadata"
type: "array"
text_fields:
always_show: true
default: []
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."
examples:
- "text"
- "user.name"
- "users.*.name"
items:
type: "string"
title: "Text fields to embed"
type: "array"
text_splitter:
description: "Split text fields into chunks based on the specified method."
oneOf:
- 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."
properties:
keep_separator:
default: false
description: "Whether to keep the separator in the resulting chunks"
title: "Keep separator"
type: "boolean"
mode:
const: "separator"
default: "separator"
enum:
- "separator"
title: "Mode"
type: "string"
separators:
default:
- "\"\\n\\n\""
- "\"\\n\""
- "\" \""
- "\"\""
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\"."
items:
type: "string"
title: "Separators"
type: "array"
required:
- "mode"
title: "By Separator"
type: "object"
- 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."
properties:
mode:
const: "markdown"
default: "markdown"
enum:
- "markdown"
title: "Mode"
type: "string"
split_level:
default: 1
description: "Level of markdown headers to split text fields by.\
\ Headings down to the specified level will be used as split\
\ points"
maximum: 6
minimum: 1
title: "Split level"
type: "integer"
required:
- "mode"
title: "By Markdown header"
type: "object"
- description: "Split the text by suitable delimiters based on the programming\
\ language. This is useful for splitting code into chunks."
properties:
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"
title: "Language"
type: "string"
mode:
const: "code"
default: "code"
enum:
- "code"
title: "Mode"
type: "string"
required:
- "language"
- "mode"
title: "By Programming Language"
type: "object"
title: "Text splitter"
type: "object"
required:
- "chunk_size"
title: "ProcessingConfigModel"
type: "object"
required:
- "embedding"
- "processing"
- "indexing"
title: "Destination Config"
type: "object"
destination-firebolt:
properties:
account:
description: "Firebolt account to login."
title: "Account"
type: "string"
client_id:
description: "Firebolt service account ID."
examples:
- "bbl9qth066hmxkwyb0hy2iwk8ktez9dz"
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Firebolt secret, corresponding to the service account ID."
order: 1
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
database:
description: "The database to connect to."
title: "Database"
type: "string"
engine:
description: "Engine name to connect to."
title: "Engine"
type: "string"
host:
description: "The host name of your Firebolt database."
examples:
- "api.app.firebolt.io"
title: "Host"
type: "string"
loading_method:
description: "Loading method used to select the way data will be uploaded\
\ to Firebolt"
oneOf:
- additionalProperties: false
properties:
method:
const: "SQL"
type: "string"
enum:
- "SQL"
required:
- "method"
title: "SQL Inserts"
- additionalProperties: false
properties:
aws_key_id:
airbyte_secret: true
description: "AWS access key granting read and write access to S3."
title: "AWS Key ID"
type: "string"
x-speakeasy-param-sensitive: true
aws_key_secret:
airbyte_secret: true
description: "Corresponding secret part of the AWS Key"
title: "AWS Key Secret"
type: "string"
x-speakeasy-param-sensitive: true
method:
const: "S3"
type: "string"
enum:
- "S3"
s3_bucket:
description: "The name of the S3 bucket."
title: "S3 bucket name"
type: "string"
s3_region:
description: "Region name of the S3 bucket."
examples:
- "us-east-1"
title: "S3 region name"
type: "string"
required:
- "method"
- "s3_bucket"
- "s3_region"
- "aws_key_id"
- "aws_key_secret"
title: "External Table via S3"
title: "Loading Method"
type: "object"
destinationType:
title: "firebolt"
const: "firebolt"
enum:
- "firebolt"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "account"
- "database"
- "engine"
- "destinationType"
title: "Firebolt Spec"
type: "object"
destination-firebolt-update:
properties:
account:
description: "Firebolt account to login."
title: "Account"
type: "string"
client_id:
description: "Firebolt service account ID."
examples:
- "bbl9qth066hmxkwyb0hy2iwk8ktez9dz"
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Firebolt secret, corresponding to the service account ID."
order: 1
title: "Client Secret"
type: "string"
database:
description: "The database to connect to."
title: "Database"
type: "string"
engine:
description: "Engine name to connect to."
title: "Engine"
type: "string"
host:
description: "The host name of your Firebolt database."
examples:
- "api.app.firebolt.io"
title: "Host"
type: "string"
loading_method:
description: "Loading method used to select the way data will be uploaded\
\ to Firebolt"
oneOf:
- additionalProperties: false
properties:
method:
const: "SQL"
type: "string"
enum:
- "SQL"
required:
- "method"
title: "SQL Inserts"
- additionalProperties: false
properties:
aws_key_id:
airbyte_secret: true
description: "AWS access key granting read and write access to S3."
title: "AWS Key ID"
type: "string"
aws_key_secret:
airbyte_secret: true
description: "Corresponding secret part of the AWS Key"
title: "AWS Key Secret"
type: "string"
method:
const: "S3"
type: "string"
enum:
- "S3"
s3_bucket:
description: "The name of the S3 bucket."
title: "S3 bucket name"
type: "string"
s3_region:
description: "Region name of the S3 bucket."
examples:
- "us-east-1"
title: "S3 region name"
type: "string"
required:
- "method"
- "s3_bucket"
- "s3_region"
- "aws_key_id"
- "aws_key_secret"
title: "External Table via S3"
title: "Loading Method"
type: "object"
required:
- "client_id"
- "client_secret"
- "account"
- "database"
- "engine"
title: "Firebolt Spec"
type: "object"
destination-google-sheets:
properties:
credentials:
description: "Authentication method to access Google Sheets"
oneOf:
- properties:
auth_type:
const: "oauth2.0"
default: "oauth2.0"
order: 0
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The Client ID of your Google Sheets developer application."
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The Client Secret of your Google Sheets developer application."
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
refresh_token:
airbyte_secret: true
description: "The token for obtaining new access token."
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_type"
- "client_id"
- "client_secret"
- "refresh_token"
title: "Authenticate via Google (OAuth)"
type: "object"
- properties:
auth_type:
const: "service"
default: "service"
order: 0
type: "string"
enum:
- "service"
service_account_info:
airbyte_secret: true
description: "Enter your service account key in JSON format. See the\
\ docs\
\ for more information on how to generate this key."
title: "Service Account Information"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_type"
- "service_account_info"
title: "Service Account Key Authentication"
type: "object"
title: "Authentication"
type: "object"
spreadsheet_id:
description: "The link to your spreadsheet. See this\
\ guide for more details."
examples:
- "https://docs.google.com/spreadsheets/d/1hLd9Qqti3UyLXZB2aFfUWDT7BG/edit"
title: "Spreadsheet Link"
type: "string"
destinationType:
title: "google-sheets"
const: "google-sheets"
enum:
- "google-sheets"
order: 0
type: "string"
required:
- "spreadsheet_id"
- "credentials"
- "destinationType"
title: "Destination Google Sheets"
type: "object"
destination-google-sheets-update:
properties:
credentials:
description: "Authentication method to access Google Sheets"
oneOf:
- properties:
auth_type:
const: "oauth2.0"
default: "oauth2.0"
order: 0
type: "string"
enum:
- "oauth2.0"
client_id:
airbyte_secret: true
description: "The Client ID of your Google Sheets developer application."
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The Client Secret of your Google Sheets developer application."
title: "Client Secret"
type: "string"
refresh_token:
airbyte_secret: true
description: "The token for obtaining new access token."
title: "Refresh Token"
type: "string"
required:
- "auth_type"
- "client_id"
- "client_secret"
- "refresh_token"
title: "Authenticate via Google (OAuth)"
type: "object"
- properties:
auth_type:
const: "service"
default: "service"
order: 0
type: "string"
enum:
- "service"
service_account_info:
airbyte_secret: true
description: "Enter your service account key in JSON format. See the\
\ docs\
\ for more information on how to generate this key."
title: "Service Account Information"
type: "string"
required:
- "auth_type"
- "service_account_info"
title: "Service Account Key Authentication"
type: "object"
title: "Authentication"
type: "object"
spreadsheet_id:
description: "The link to your spreadsheet. See this\
\ guide for more details."
examples:
- "https://docs.google.com/spreadsheets/d/1hLd9Qqti3UyLXZB2aFfUWDT7BG/edit"
title: "Spreadsheet Link"
type: "string"
required:
- "spreadsheet_id"
- "credentials"
title: "Destination Google Sheets"
type: "object"
destination-teradata:
properties:
disable_type_dedupe:
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"
order: 8
title: "Disable Final Tables. (WARNING! Unstable option; Columns in raw\
\ table schema might change between versions)"
type: "boolean"
drop_cascade:
default: false
description: "Drop tables with CASCADE. WARNING! This will delete all data\
\ in all dependent objects (views, etc.). Use with caution. This option\
\ is intended for usecases which can easily rebuild the dependent objects."
order: 9
title: "Drop tables with CASCADE. (WARNING! Risk of unrecoverable data loss)"
type: "boolean"
host:
description: "Hostname of the database."
order: 0
title: "Host"
type: "string"
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)."
order: 6
title: "JDBC URL Params"
type: "string"
logmech:
description: ""
oneOf:
- order: 0
properties:
auth_type:
const: "TD2"
default: "TD2"
enum:
- "TD2"
order: 0
type: "string"
password:
airbyte_secret: true
description: "Enter the password associated with the username."
order: 2
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
username:
description: "Username to use to access the database."
order: 1
title: "User"
type: "string"
required:
- "username"
- "password"
title: "TD2"
type: "object"
- order: 1
properties:
auth_type:
const: "LDAP"
default: "LDAP"
enum:
- "LDAP"
order: 0
type: "string"
password:
airbyte_secret: true
description: "Enter the password associated with the username."
order: 2
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
username:
description: "Username to use to access the database."
order: 1
title: "User"
type: "string"
required:
- "username"
- "password"
title: "LDAP"
type: "object"
order: 1
title: "Authorization Mechanism"
type: "object"
query_band:
description: "Defines the custom session query band using name-value pairs.\
\ For example, 'org=Finance;report=Fin123;'"
order: 5
title: "Query Band"
type: "string"
raw_data_schema:
description: "The database to write raw tables into"
order: 7
title: "Raw table database (defaults to airbyte_internal)"
type: "string"
schema:
default: "airbyte_td"
description: "The default schema tables are written to if the source does\
\ not specify a namespace. The usual value for this field is \"public\"\
."
examples:
- "airbyte_td"
order: 2
title: "Default Schema"
type: "string"
ssl:
default: false
description: "Encrypt data using SSL. When activating SSL, please select\
\ one of the SSL modes."
order: 3
title: "SSL Connection"
type: "boolean"
ssl_mode:
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."
oneOf:
- additionalProperties: false
description: "Disable SSL."
properties:
mode:
const: "disable"
default: "disable"
enum:
- "disable"
order: 0
type: "string"
required:
- "mode"
title: "disable"
- additionalProperties: false
description: "Allow SSL mode."
properties:
mode:
const: "allow"
default: "allow"
enum:
- "allow"
order: 0
type: "string"
required:
- "mode"
title: "allow"
- additionalProperties: false
description: "Prefer SSL mode."
properties:
mode:
const: "prefer"
default: "prefer"
enum:
- "prefer"
order: 0
type: "string"
required:
- "mode"
title: "prefer"
- additionalProperties: false
description: "Require SSL mode."
properties:
mode:
const: "require"
default: "require"
enum:
- "require"
order: 0
type: "string"
required:
- "mode"
title: "require"
- additionalProperties: false
description: "Verify-ca SSL mode."
properties:
mode:
const: "verify-ca"
default: "verify-ca"
enum:
- "verify-ca"
order: 0
type: "string"
ssl_ca_certificate:
airbyte_secret: true
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."
multiline: true
order: 1
title: "CA certificate"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "mode"
- "ssl_ca_certificate"
title: "verify-ca"
- additionalProperties: false
description: "Verify-full SSL mode."
properties:
mode:
const: "verify-full"
default: "verify-full"
enum:
- "verify-full"
order: 0
type: "string"
ssl_ca_certificate:
airbyte_secret: true
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."
multiline: true
order: 1
title: "CA certificate"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "mode"
- "ssl_ca_certificate"
title: "verify-full"
order: 4
title: "SSL modes"
type: "object"
destinationType:
title: "teradata"
const: "teradata"
enum:
- "teradata"
order: 0
type: "string"
required:
- "host"
- "destinationType"
title: "Teradata Destination Spec"
type: "object"
destination-teradata-update:
properties:
disable_type_dedupe:
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"
order: 8
title: "Disable Final Tables. (WARNING! Unstable option; Columns in raw\
\ table schema might change between versions)"
type: "boolean"
drop_cascade:
default: false
description: "Drop tables with CASCADE. WARNING! This will delete all data\
\ in all dependent objects (views, etc.). Use with caution. This option\
\ is intended for usecases which can easily rebuild the dependent objects."
order: 9
title: "Drop tables with CASCADE. (WARNING! Risk of unrecoverable data loss)"
type: "boolean"
host:
description: "Hostname of the database."
order: 0
title: "Host"
type: "string"
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)."
order: 6
title: "JDBC URL Params"
type: "string"
logmech:
description: ""
oneOf:
- order: 0
properties:
auth_type:
const: "TD2"
default: "TD2"
enum:
- "TD2"
order: 0
type: "string"
password:
airbyte_secret: true
description: "Enter the password associated with the username."
order: 2
title: "Password"
type: "string"
username:
description: "Username to use to access the database."
order: 1
title: "User"
type: "string"
required:
- "username"
- "password"
title: "TD2"
type: "object"
- order: 1
properties:
auth_type:
const: "LDAP"
default: "LDAP"
enum:
- "LDAP"
order: 0
type: "string"
password:
airbyte_secret: true
description: "Enter the password associated with the username."
order: 2
title: "Password"
type: "string"
username:
description: "Username to use to access the database."
order: 1
title: "User"
type: "string"
required:
- "username"
- "password"
title: "LDAP"
type: "object"
order: 1
title: "Authorization Mechanism"
type: "object"
query_band:
description: "Defines the custom session query band using name-value pairs.\
\ For example, 'org=Finance;report=Fin123;'"
order: 5
title: "Query Band"
type: "string"
raw_data_schema:
description: "The database to write raw tables into"
order: 7
title: "Raw table database (defaults to airbyte_internal)"
type: "string"
schema:
default: "airbyte_td"
description: "The default schema tables are written to if the source does\
\ not specify a namespace. The usual value for this field is \"public\"\
."
examples:
- "airbyte_td"
order: 2
title: "Default Schema"
type: "string"
ssl:
default: false
description: "Encrypt data using SSL. When activating SSL, please select\
\ one of the SSL modes."
order: 3
title: "SSL Connection"
type: "boolean"
ssl_mode:
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."
oneOf:
- additionalProperties: false
description: "Disable SSL."
properties:
mode:
const: "disable"
default: "disable"
enum:
- "disable"
order: 0
type: "string"
required:
- "mode"
title: "disable"
- additionalProperties: false
description: "Allow SSL mode."
properties:
mode:
const: "allow"
default: "allow"
enum:
- "allow"
order: 0
type: "string"
required:
- "mode"
title: "allow"
- additionalProperties: false
description: "Prefer SSL mode."
properties:
mode:
const: "prefer"
default: "prefer"
enum:
- "prefer"
order: 0
type: "string"
required:
- "mode"
title: "prefer"
- additionalProperties: false
description: "Require SSL mode."
properties:
mode:
const: "require"
default: "require"
enum:
- "require"
order: 0
type: "string"
required:
- "mode"
title: "require"
- additionalProperties: false
description: "Verify-ca SSL mode."
properties:
mode:
const: "verify-ca"
default: "verify-ca"
enum:
- "verify-ca"
order: 0
type: "string"
ssl_ca_certificate:
airbyte_secret: true
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."
multiline: true
order: 1
title: "CA certificate"
type: "string"
required:
- "mode"
- "ssl_ca_certificate"
title: "verify-ca"
- additionalProperties: false
description: "Verify-full SSL mode."
properties:
mode:
const: "verify-full"
default: "verify-full"
enum:
- "verify-full"
order: 0
type: "string"
ssl_ca_certificate:
airbyte_secret: true
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."
multiline: true
order: 1
title: "CA certificate"
type: "string"
required:
- "mode"
- "ssl_ca_certificate"
title: "verify-full"
order: 4
title: "SSL modes"
type: "object"
required:
- "host"
title: "Teradata Destination Spec"
type: "object"
destination-duckdb:
properties:
destination_path:
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:"
title: "Destination DB"
type: "string"
motherduck_api_key:
airbyte_secret: true
description: "API key to use for authentication to a MotherDuck database."
title: "MotherDuck API Key"
type: "string"
x-speakeasy-param-sensitive: true
schema:
description: "Database schema name, default for duckdb is 'main'."
example: "main"
title: "Destination Schema"
type: "string"
destinationType:
title: "duckdb"
const: "duckdb"
enum:
- "duckdb"
order: 0
type: "string"
required:
- "destination_path"
- "destinationType"
title: "Destination Duckdb"
type: "object"
destination-duckdb-update:
properties:
destination_path:
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:"
title: "Destination DB"
type: "string"
motherduck_api_key:
airbyte_secret: true
description: "API key to use for authentication to a MotherDuck database."
title: "MotherDuck API Key"
type: "string"
schema:
description: "Database schema name, default for duckdb is 'main'."
example: "main"
title: "Destination Schema"
type: "string"
required:
- "destination_path"
title: "Destination Duckdb"
type: "object"
destination-mssql-v2:
properties:
database:
description: "The name of the MSSQL database."
order: 2
title: "DB Name"
type: "string"
host:
description: "The host name of the MSSQL database."
order: 0
title: "Host"
type: "string"
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)."
order: 6
title: "JDBC URL Params"
type: "string"
load_type:
always_show: true
description: "Specifies the type of load mechanism (e.g., BULK, INSERT)\
\ and its associated configuration."
oneOf:
- additionalProperties: true
description: "Configuration details for using the INSERT loading mechanism."
properties:
load_type:
default: "INSERT"
enum:
- "INSERT"
type: "string"
required:
- "load_type"
title: "Insert Load"
type: "object"
- additionalProperties: true
description: "Configuration details for using the BULK loading mechanism."
properties:
azure_blob_storage_account_name:
description: "The name of the Azure Blob Storage account. See: https://learn.microsoft.com/azure/storage/blobs/storage-blobs-introduction#storage-accounts"
examples:
- "mystorageaccount"
title: "Azure Blob Storage Account Name"
type: "string"
azure_blob_storage_container_name:
description: "The name of the Azure Blob Storage container. See: https://learn.microsoft.com/azure/storage/blobs/storage-blobs-introduction#containers"
examples:
- "mycontainer"
title: "Azure Blob Storage Container Name"
type: "string"
bulk_load_data_source:
always_show: true
description: "Specifies the external data source name configured in\
\ MSSQL, which references the Azure Blob container. See: https://learn.microsoft.com/sql/t-sql/statements/bulk-insert-transact-sql"
examples:
- "MyAzureBlobStorage"
order: 4
title: "BULK Load Data Source"
type: "string"
bulk_load_validate_values_pre_load:
always_show: false
default: false
description: "When enabled, Airbyte will validate all values before\
\ loading them into the destination table. This provides stronger\
\ data integrity guarantees but may significantly impact performance."
examples:
- "false"
order: 5
title: "Pre-Load Value Validation"
type: "boolean"
load_type:
default: "BULK"
enum:
- "BULK"
type: "string"
shared_access_signature:
airbyte_secret: true
always_show: true
description: "A shared access signature (SAS) provides secure delegated\
\ access to resources in your storage account. See: https://learn.microsoft.com/azure/storage/common/storage-sas-overview"
examples:
- "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY"
title: "Shared Access Signature"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "load_type"
- "azure_blob_storage_account_name"
- "azure_blob_storage_container_name"
- "shared_access_signature"
- "bulk_load_data_source"
title: "Bulk Load"
type: "object"
order: 8
title: "Load Type"
type: "object"
password:
airbyte_secret: true
description: "The password associated with this username."
order: 5
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
port:
description: "The port of the MSSQL database."
examples:
- "1433"
maximum: 65536
minimum: 0
order: 1
title: "Port"
type: "integer"
schema:
default: "public"
description: "The default schema tables are written to if the source does\
\ not specify a namespace. The usual value for this field is \"public\"\
."
examples:
- "public"
order: 3
title: "Default Schema"
type: "string"
ssl_method:
description: "The encryption method which is used to communicate with the\
\ database."
oneOf:
- additionalProperties: true
description: "The data transfer will not be encrypted."
properties:
name:
default: "unencrypted"
enum:
- "unencrypted"
type: "string"
required:
- "name"
title: "Unencrypted"
type: "object"
- additionalProperties: true
description: "Use the certificate provided by the server without verification.\
\ (For testing purposes only!)"
properties:
name:
default: "encrypted_trust_server_certificate"
enum:
- "encrypted_trust_server_certificate"
type: "string"
required:
- "name"
title: "Encrypted (trust server certificate)"
type: "object"
- additionalProperties: true
description: "Verify and use the certificate provided by the server."
properties:
hostNameInCertificate:
description: "Specifies the host name of the server. The value of\
\ this property must match the subject property of the certificate."
order: 3
title: "Host Name In Certificate"
type: "string"
name:
default: "encrypted_verify_certificate"
enum:
- "encrypted_verify_certificate"
type: "string"
trustStoreName:
description: "Specifies the name of the trust store."
order: 1
title: "Trust Store Name"
type: "string"
trustStorePassword:
airbyte_secret: true
description: "Specifies the password of the trust store."
order: 2
title: "Trust Store Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "name"
title: "Encrypted (verify certificate)"
type: "object"
order: 7
title: "SSL Method"
type: "object"
user:
description: "The username which is used to access the database."
order: 4
title: "User"
type: "string"
destinationType:
title: "mssql-v2"
const: "mssql-v2"
enum:
- "mssql-v2"
order: 0
type: "string"
required:
- "host"
- "port"
- "database"
- "schema"
- "user"
- "ssl_method"
- "load_type"
- "destinationType"
title: "MSSQL V2 Destination Specification"
type: "object"
destination-mssql-v2-update:
properties:
database:
description: "The name of the MSSQL database."
order: 2
title: "DB Name"
type: "string"
host:
description: "The host name of the MSSQL database."
order: 0
title: "Host"
type: "string"
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)."
order: 6
title: "JDBC URL Params"
type: "string"
load_type:
always_show: true
description: "Specifies the type of load mechanism (e.g., BULK, INSERT)\
\ and its associated configuration."
oneOf:
- additionalProperties: true
description: "Configuration details for using the INSERT loading mechanism."
properties:
load_type:
default: "INSERT"
enum:
- "INSERT"
type: "string"
required:
- "load_type"
title: "Insert Load"
type: "object"
- additionalProperties: true
description: "Configuration details for using the BULK loading mechanism."
properties:
azure_blob_storage_account_name:
description: "The name of the Azure Blob Storage account. See: https://learn.microsoft.com/azure/storage/blobs/storage-blobs-introduction#storage-accounts"
examples:
- "mystorageaccount"
title: "Azure Blob Storage Account Name"
type: "string"
azure_blob_storage_container_name:
description: "The name of the Azure Blob Storage container. See: https://learn.microsoft.com/azure/storage/blobs/storage-blobs-introduction#containers"
examples:
- "mycontainer"
title: "Azure Blob Storage Container Name"
type: "string"
bulk_load_data_source:
always_show: true
description: "Specifies the external data source name configured in\
\ MSSQL, which references the Azure Blob container. See: https://learn.microsoft.com/sql/t-sql/statements/bulk-insert-transact-sql"
examples:
- "MyAzureBlobStorage"
order: 4
title: "BULK Load Data Source"
type: "string"
bulk_load_validate_values_pre_load:
always_show: false
default: false
description: "When enabled, Airbyte will validate all values before\
\ loading them into the destination table. This provides stronger\
\ data integrity guarantees but may significantly impact performance."
examples:
- "false"
order: 5
title: "Pre-Load Value Validation"
type: "boolean"
load_type:
default: "BULK"
enum:
- "BULK"
type: "string"
shared_access_signature:
airbyte_secret: true
always_show: true
description: "A shared access signature (SAS) provides secure delegated\
\ access to resources in your storage account. See: https://learn.microsoft.com/azure/storage/common/storage-sas-overview"
examples:
- "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY"
title: "Shared Access Signature"
type: "string"
required:
- "load_type"
- "azure_blob_storage_account_name"
- "azure_blob_storage_container_name"
- "shared_access_signature"
- "bulk_load_data_source"
title: "Bulk Load"
type: "object"
order: 8
title: "Load Type"
type: "object"
password:
airbyte_secret: true
description: "The password associated with this username."
order: 5
title: "Password"
type: "string"
port:
description: "The port of the MSSQL database."
examples:
- "1433"
maximum: 65536
minimum: 0
order: 1
title: "Port"
type: "integer"
schema:
default: "public"
description: "The default schema tables are written to if the source does\
\ not specify a namespace. The usual value for this field is \"public\"\
."
examples:
- "public"
order: 3
title: "Default Schema"
type: "string"
ssl_method:
description: "The encryption method which is used to communicate with the\
\ database."
oneOf:
- additionalProperties: true
description: "The data transfer will not be encrypted."
properties:
name:
default: "unencrypted"
enum:
- "unencrypted"
type: "string"
required:
- "name"
title: "Unencrypted"
type: "object"
- additionalProperties: true
description: "Use the certificate provided by the server without verification.\
\ (For testing purposes only!)"
properties:
name:
default: "encrypted_trust_server_certificate"
enum:
- "encrypted_trust_server_certificate"
type: "string"
required:
- "name"
title: "Encrypted (trust server certificate)"
type: "object"
- additionalProperties: true
description: "Verify and use the certificate provided by the server."
properties:
hostNameInCertificate:
description: "Specifies the host name of the server. The value of\
\ this property must match the subject property of the certificate."
order: 3
title: "Host Name In Certificate"
type: "string"
name:
default: "encrypted_verify_certificate"
enum:
- "encrypted_verify_certificate"
type: "string"
trustStoreName:
description: "Specifies the name of the trust store."
order: 1
title: "Trust Store Name"
type: "string"
trustStorePassword:
airbyte_secret: true
description: "Specifies the password of the trust store."
order: 2
title: "Trust Store Password"
type: "string"
required:
- "name"
title: "Encrypted (verify certificate)"
type: "object"
order: 7
title: "SSL Method"
type: "object"
user:
description: "The username which is used to access the database."
order: 4
title: "User"
type: "string"
required:
- "host"
- "port"
- "database"
- "schema"
- "user"
- "ssl_method"
- "load_type"
title: "MSSQL V2 Destination Specification"
type: "object"
destination-sftp-json:
properties:
destination_path:
description: "Path to the directory where json files will be written."
examples:
- "/json_data"
order: 4
title: "Destination path"
type: "string"
host:
description: "Hostname of the SFTP server."
order: 0
title: "Host"
type: "string"
password:
airbyte_secret: true
description: "Password associated with the username."
order: 3
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
port:
default: 22
description: "Port of the SFTP server."
examples:
- 22
maximum: 65536
minimum: 0
order: 1
title: "Port"
type: "integer"
username:
description: "Username to use to access the SFTP server."
order: 2
title: "User"
type: "string"
destinationType:
title: "sftp-json"
const: "sftp-json"
enum:
- "sftp-json"
order: 0
type: "string"
required:
- "host"
- "username"
- "password"
- "destination_path"
- "destinationType"
title: "Destination SFTP JSON"
type: "object"
destination-sftp-json-update:
properties:
destination_path:
description: "Path to the directory where json files will be written."
examples:
- "/json_data"
order: 4
title: "Destination path"
type: "string"
host:
description: "Hostname of the SFTP server."
order: 0
title: "Host"
type: "string"
password:
airbyte_secret: true
description: "Password associated with the username."
order: 3
title: "Password"
type: "string"
port:
default: 22
description: "Port of the SFTP server."
examples:
- 22
maximum: 65536
minimum: 0
order: 1
title: "Port"
type: "integer"
username:
description: "Username to use to access the SFTP server."
order: 2
title: "User"
type: "string"
required:
- "host"
- "username"
- "password"
- "destination_path"
title: "Destination SFTP JSON"
type: "object"
destination-motherduck:
properties:
destination_path:
default: "md:"
description: "Path to a .duckdb file or 'md:' to connect\
\ to a MotherDuck database. If 'md:' is specified without a database name,\
\ the default MotherDuck database name ('my_db') will be used."
examples:
- "/local/destination.duckdb"
- "md:"
- "md:data_db"
- "md:my_db"
title: "Destination DB"
type: "string"
motherduck_api_key:
airbyte_secret: true
description: "API access token to use for authentication to a MotherDuck\
\ database."
title: "MotherDuck Access Token"
type: "string"
x-speakeasy-param-sensitive: true
schema:
description: "Database schema name, defaults to 'main' if not specified."
examples:
- "main"
- "airbyte_raw"
- "my_schema"
title: "Schema Name"
type: "string"
destinationType:
title: "motherduck"
const: "motherduck"
enum:
- "motherduck"
order: 0
type: "string"
required:
- "motherduck_api_key"
- "destinationType"
title: "Destination MotherDuck"
type: "object"
destination-motherduck-update:
properties:
destination_path:
default: "md:"
description: "Path to a .duckdb file or 'md:' to connect\
\ to a MotherDuck database. If 'md:' is specified without a database name,\
\ the default MotherDuck database name ('my_db') will be used."
examples:
- "/local/destination.duckdb"
- "md:"
- "md:data_db"
- "md:my_db"
title: "Destination DB"
type: "string"
motherduck_api_key:
airbyte_secret: true
description: "API access token to use for authentication to a MotherDuck\
\ database."
title: "MotherDuck Access Token"
type: "string"
schema:
description: "Database schema name, defaults to 'main' if not specified."
examples:
- "main"
- "airbyte_raw"
- "my_schema"
title: "Schema Name"
type: "string"
required:
- "motherduck_api_key"
title: "Destination MotherDuck"
type: "object"
destination-s3:
properties:
access_key_id:
airbyte_secret: true
always_show: true
description: "The access key ID to access the S3 bucket. Airbyte requires\
\ Read and Write permissions to the given bucket. Read more here."
examples:
- "A012345678910EXAMPLE"
order: 0
title: "Access Key ID"
type: "string"
x-speakeasy-param-sensitive: true
file_name_pattern:
description: "Pattern to match file names in the bucket directory. Read\
\ more here"
examples:
- "{date}"
- "{date:yyyy_MM}"
- "{timestamp}"
- "{part_number}"
- "{sync_id}"
order: 9
title: "File Name Pattern"
type: "string"
format:
description: "Format of the data output. See here for more details"
oneOf:
- additionalProperties: true
properties:
compression:
description: "Whether the output files should be compressed. If compression\
\ is selected, the output filename will have an extra extension\
\ (GZIP: \".jsonl.gz\")."
oneOf:
- additionalProperties: true
properties:
compression_type:
default: "No Compression"
enum:
- "No Compression"
type: "string"
required:
- "compression_type"
title: "No Compression"
type: "object"
- additionalProperties: true
properties:
compression_type:
default: "GZIP"
enum:
- "GZIP"
type: "string"
required:
- "compression_type"
title: "GZIP"
type: "object"
title: "Compression"
type: "object"
flattening:
default: "No flattening"
enum:
- "No flattening"
- "Root level flattening"
title: "Flattening"
type: "string"
format_type:
default: "CSV"
enum:
- "CSV"
type: "string"
required:
- "format_type"
- "flattening"
title: "CSV: Comma-Separated Values"
type: "object"
- additionalProperties: true
properties:
compression:
description: "Whether the output files should be compressed. If compression\
\ is selected, the output filename will have an extra extension\
\ (GZIP: \".jsonl.gz\")."
oneOf:
- additionalProperties: true
properties:
compression_type:
default: "No Compression"
enum:
- "No Compression"
type: "string"
required:
- "compression_type"
title: "No Compression"
type: "object"
- additionalProperties: true
properties:
compression_type:
default: "GZIP"
enum:
- "GZIP"
type: "string"
required:
- "compression_type"
title: "GZIP"
type: "object"
title: "Compression"
type: "object"
flattening:
default: "No flattening"
enum:
- "No flattening"
- "Root level flattening"
title: "Flattening"
type: "string"
format_type:
default: "JSONL"
enum:
- "JSONL"
type: "string"
required:
- "format_type"
title: "JSON Lines: Newline-delimited JSON"
type: "object"
- additionalProperties: true
properties:
compression_codec:
description: "The compression algorithm used to compress data. Default\
\ to no compression."
oneOf:
- additionalProperties: true
properties:
codec:
default: "no compression"
enum:
- "no compression"
type: "string"
required:
- "codec"
title: "no compression"
type: "object"
- additionalProperties: true
properties:
codec:
default: "Deflate"
enum:
- "Deflate"
type: "string"
compression_level:
title: "Deflate Level"
type: "integer"
required:
- "codec"
- "compression_level"
title: "Deflate"
type: "object"
- additionalProperties: true
properties:
codec:
default: "bzip2"
enum:
- "bzip2"
type: "string"
required:
- "codec"
title: "bzip2"
type: "object"
- additionalProperties: true
properties:
codec:
default: "xz"
enum:
- "xz"
type: "string"
compression_level:
title: "Compression Level"
type: "integer"
required:
- "codec"
- "compression_level"
title: "xz"
type: "object"
- additionalProperties: true
properties:
codec:
default: "zstandard"
enum:
- "zstandard"
type: "string"
compression_level:
title: "Compression Level"
type: "integer"
include_checksum:
title: "Include Checksum"
type: "boolean"
required:
- "codec"
- "compression_level"
- "include_checksum"
title: "zstandard"
type: "object"
- additionalProperties: true
properties:
codec:
default: "snappy"
enum:
- "snappy"
type: "string"
required:
- "codec"
title: "snappy"
type: "object"
order: 1
title: "Compression Codec"
type: "object"
format_type:
default: "Avro"
enum:
- "Avro"
type: "string"
required:
- "format_type"
- "compression_codec"
title: "Avro: Apache Avro"
type: "object"
- additionalProperties: true
properties:
block_size_mb:
default: 128
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."
title: "Block Size (Row Group Size) (MB)"
type: "integer"
compression_codec:
default: "UNCOMPRESSED"
description: "The compression algorithm used to compress data pages."
enum:
- "UNCOMPRESSED"
- "SNAPPY"
- "GZIP"
- "LZO"
- "BROTLI"
- "LZ4"
- "ZSTD"
title: "Compression Codec"
type: "string"
dictionary_encoding:
description: "Default: true."
title: "Dictionary Encoding"
type: "boolean"
dictionary_page_size_kb:
default: 1024
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."
title: "Dictionary Page Size (KB)"
type: "integer"
format_type:
default: "Parquet"
enum:
- "Parquet"
type: "string"
max_padding_size_mb:
default: 8
description: "Maximum size allowed as padding to align row groups.\
\ This is also the minimum size of a row group. Default: 8 MB."
title: "Max Padding Size (MB)"
type: "integer"
page_size_kb:
default: 1024
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."
title: "Page Size (KB)"
type: "integer"
required:
- "format_type"
title: "Parquet: Columnar Storage"
type: "object"
order: 6
title: "Output Format"
type: "object"
role_arn:
description: "The ARN of the AWS role to assume. Only usable in Airbyte\
\ Cloud."
examples:
- "arn:aws:iam::123456789:role/ExternalIdIsYourWorkspaceId"
order: 2
title: "Role ARN"
type: "string"
s3_bucket_name:
description: "The name of the S3 bucket. Read more here."
examples:
- "airbyte_sync"
order: 3
title: "S3 Bucket Name"
type: "string"
s3_bucket_path:
description: "Directory under the S3 bucket where data will be written.\
\ Read more here"
examples:
- "data_sync/test"
order: 4
title: "S3 Bucket Path"
type: "string"
s3_bucket_region:
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"
examples:
- "us-east-1"
order: 5
title: "S3 Bucket Region"
type: "string"
s3_endpoint:
description: "Your S3 endpoint url. Read more here"
examples:
- "http://localhost:9000"
order: 7
title: "S3 Endpoint"
type: "string"
s3_path_format:
description: "Format string on how data will be organized inside the bucket\
\ directory. Read more here"
examples:
- "${NAMESPACE}/${STREAM_NAME}/${YEAR}_${MONTH}_${DAY}_${EPOCH}_"
order: 8
title: "S3 Path Format"
type: "string"
secret_access_key:
airbyte_secret: true
always_show: true
description: "The corresponding secret to the access key ID. Read more here"
examples:
- "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY"
order: 1
title: "Secret Access Key"
type: "string"
x-speakeasy-param-sensitive: true
destinationType:
title: "s3"
const: "s3"
enum:
- "s3"
order: 0
type: "string"
required:
- "s3_bucket_name"
- "s3_bucket_path"
- "s3_bucket_region"
- "format"
- "destinationType"
title: "S3 V2 Destination Spec"
type: "object"
destination-s3-update:
properties:
access_key_id:
airbyte_secret: true
always_show: true
description: "The access key ID to access the S3 bucket. Airbyte requires\
\ Read and Write permissions to the given bucket. Read more here."
examples:
- "A012345678910EXAMPLE"
order: 0
title: "Access Key ID"
type: "string"
file_name_pattern:
description: "Pattern to match file names in the bucket directory. Read\
\ more here"
examples:
- "{date}"
- "{date:yyyy_MM}"
- "{timestamp}"
- "{part_number}"
- "{sync_id}"
order: 9
title: "File Name Pattern"
type: "string"
format:
description: "Format of the data output. See here for more details"
oneOf:
- additionalProperties: true
properties:
compression:
description: "Whether the output files should be compressed. If compression\
\ is selected, the output filename will have an extra extension\
\ (GZIP: \".jsonl.gz\")."
oneOf:
- additionalProperties: true
properties:
compression_type:
default: "No Compression"
enum:
- "No Compression"
type: "string"
required:
- "compression_type"
title: "No Compression"
type: "object"
- additionalProperties: true
properties:
compression_type:
default: "GZIP"
enum:
- "GZIP"
type: "string"
required:
- "compression_type"
title: "GZIP"
type: "object"
title: "Compression"
type: "object"
flattening:
default: "No flattening"
enum:
- "No flattening"
- "Root level flattening"
title: "Flattening"
type: "string"
format_type:
default: "CSV"
enum:
- "CSV"
type: "string"
required:
- "format_type"
- "flattening"
title: "CSV: Comma-Separated Values"
type: "object"
- additionalProperties: true
properties:
compression:
description: "Whether the output files should be compressed. If compression\
\ is selected, the output filename will have an extra extension\
\ (GZIP: \".jsonl.gz\")."
oneOf:
- additionalProperties: true
properties:
compression_type:
default: "No Compression"
enum:
- "No Compression"
type: "string"
required:
- "compression_type"
title: "No Compression"
type: "object"
- additionalProperties: true
properties:
compression_type:
default: "GZIP"
enum:
- "GZIP"
type: "string"
required:
- "compression_type"
title: "GZIP"
type: "object"
title: "Compression"
type: "object"
flattening:
default: "No flattening"
enum:
- "No flattening"
- "Root level flattening"
title: "Flattening"
type: "string"
format_type:
default: "JSONL"
enum:
- "JSONL"
type: "string"
required:
- "format_type"
title: "JSON Lines: Newline-delimited JSON"
type: "object"
- additionalProperties: true
properties:
compression_codec:
description: "The compression algorithm used to compress data. Default\
\ to no compression."
oneOf:
- additionalProperties: true
properties:
codec:
default: "no compression"
enum:
- "no compression"
type: "string"
required:
- "codec"
title: "no compression"
type: "object"
- additionalProperties: true
properties:
codec:
default: "Deflate"
enum:
- "Deflate"
type: "string"
compression_level:
title: "Deflate Level"
type: "integer"
required:
- "codec"
- "compression_level"
title: "Deflate"
type: "object"
- additionalProperties: true
properties:
codec:
default: "bzip2"
enum:
- "bzip2"
type: "string"
required:
- "codec"
title: "bzip2"
type: "object"
- additionalProperties: true
properties:
codec:
default: "xz"
enum:
- "xz"
type: "string"
compression_level:
title: "Compression Level"
type: "integer"
required:
- "codec"
- "compression_level"
title: "xz"
type: "object"
- additionalProperties: true
properties:
codec:
default: "zstandard"
enum:
- "zstandard"
type: "string"
compression_level:
title: "Compression Level"
type: "integer"
include_checksum:
title: "Include Checksum"
type: "boolean"
required:
- "codec"
- "compression_level"
- "include_checksum"
title: "zstandard"
type: "object"
- additionalProperties: true
properties:
codec:
default: "snappy"
enum:
- "snappy"
type: "string"
required:
- "codec"
title: "snappy"
type: "object"
order: 1
title: "Compression Codec"
type: "object"
format_type:
default: "Avro"
enum:
- "Avro"
type: "string"
required:
- "format_type"
- "compression_codec"
title: "Avro: Apache Avro"
type: "object"
- additionalProperties: true
properties:
block_size_mb:
default: 128
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."
title: "Block Size (Row Group Size) (MB)"
type: "integer"
compression_codec:
default: "UNCOMPRESSED"
description: "The compression algorithm used to compress data pages."
enum:
- "UNCOMPRESSED"
- "SNAPPY"
- "GZIP"
- "LZO"
- "BROTLI"
- "LZ4"
- "ZSTD"
title: "Compression Codec"
type: "string"
dictionary_encoding:
description: "Default: true."
title: "Dictionary Encoding"
type: "boolean"
dictionary_page_size_kb:
default: 1024
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."
title: "Dictionary Page Size (KB)"
type: "integer"
format_type:
default: "Parquet"
enum:
- "Parquet"
type: "string"
max_padding_size_mb:
default: 8
description: "Maximum size allowed as padding to align row groups.\
\ This is also the minimum size of a row group. Default: 8 MB."
title: "Max Padding Size (MB)"
type: "integer"
page_size_kb:
default: 1024
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."
title: "Page Size (KB)"
type: "integer"
required:
- "format_type"
title: "Parquet: Columnar Storage"
type: "object"
order: 6
title: "Output Format"
type: "object"
role_arn:
description: "The ARN of the AWS role to assume. Only usable in Airbyte\
\ Cloud."
examples:
- "arn:aws:iam::123456789:role/ExternalIdIsYourWorkspaceId"
order: 2
title: "Role ARN"
type: "string"
s3_bucket_name:
description: "The name of the S3 bucket. Read more here."
examples:
- "airbyte_sync"
order: 3
title: "S3 Bucket Name"
type: "string"
s3_bucket_path:
description: "Directory under the S3 bucket where data will be written.\
\ Read more here"
examples:
- "data_sync/test"
order: 4
title: "S3 Bucket Path"
type: "string"
s3_bucket_region:
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"
examples:
- "us-east-1"
order: 5
title: "S3 Bucket Region"
type: "string"
s3_endpoint:
description: "Your S3 endpoint url. Read more here"
examples:
- "http://localhost:9000"
order: 7
title: "S3 Endpoint"
type: "string"
s3_path_format:
description: "Format string on how data will be organized inside the bucket\
\ directory. Read more here"
examples:
- "${NAMESPACE}/${STREAM_NAME}/${YEAR}_${MONTH}_${DAY}_${EPOCH}_"
order: 8
title: "S3 Path Format"
type: "string"
secret_access_key:
airbyte_secret: true
always_show: true
description: "The corresponding secret to the access key ID. Read more here"
examples:
- "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY"
order: 1
title: "Secret Access Key"
type: "string"
required:
- "s3_bucket_name"
- "s3_bucket_path"
- "s3_bucket_region"
- "format"
title: "S3 V2 Destination Spec"
type: "object"
destination-redis:
properties:
cache_type:
default: "hash"
description: "Redis cache type to store data in."
enum:
- "hash"
order: 7
title: "Cache type"
type: "string"
host:
description: "Redis host to connect to."
examples:
- "localhost,127.0.0.1"
order: 1
title: "Host"
type: "string"
password:
airbyte_secret: true
description: "Password associated with Redis."
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
port:
default: 6379
description: "Port of Redis."
maximum: 65536
minimum: 0
order: 2
title: "Port"
type: "integer"
ssl:
default: false
description: "Indicates whether SSL encryption protocol will be used to\
\ connect to Redis. It is recommended to use SSL connection if possible."
order: 5
title: "SSL Connection"
type: "boolean"
ssl_mode:
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"
oneOf:
- additionalProperties: false
description: "Disable SSL."
properties:
mode:
const: "disable"
default: "disable"
enum:
- "disable"
order: 0
type: "string"
required:
- "mode"
title: "disable"
- additionalProperties: false
description: "Verify-full SSL mode."
properties:
ca_certificate:
airbyte_secret: true
description: "CA certificate"
multiline: true
order: 1
title: "CA Certificate"
type: "string"
x-speakeasy-param-sensitive: true
client_certificate:
airbyte_secret: true
description: "Client certificate"
multiline: true
order: 2
title: "Client Certificate"
type: "string"
x-speakeasy-param-sensitive: true
client_key:
airbyte_secret: true
description: "Client key"
multiline: true
order: 3
title: "Client Key"
type: "string"
x-speakeasy-param-sensitive: true
client_key_password:
airbyte_secret: true
description: "Password for keystorage. If you do not add it - the\
\ password will be generated automatically."
order: 4
title: "Client key password"
type: "string"
x-speakeasy-param-sensitive: true
mode:
const: "verify-full"
default: "verify-full"
enum:
- "verify-full"
order: 0
type: "string"
required:
- "mode"
- "ca_certificate"
- "client_certificate"
- "client_key"
title: "verify-full"
order: 6
title: "SSL Modes"
type: "object"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- properties:
tunnel_method:
const: "NO_TUNNEL"
description: "No ssh tunnel needed to connect to database"
order: 0
type: "string"
enum:
- "NO_TUNNEL"
required:
- "tunnel_method"
title: "No Tunnel"
- properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
x-speakeasy-param-sensitive: true
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_KEY_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host."
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
- properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
title: "SSH Tunnel Method"
type: "object"
username:
description: "Username associated with Redis."
order: 3
title: "Username"
type: "string"
destinationType:
title: "redis"
const: "redis"
enum:
- "redis"
order: 0
type: "string"
required:
- "host"
- "username"
- "port"
- "cache_type"
- "destinationType"
title: "Redis Destination Spec"
type: "object"
destination-redis-update:
properties:
cache_type:
default: "hash"
description: "Redis cache type to store data in."
enum:
- "hash"
order: 7
title: "Cache type"
type: "string"
host:
description: "Redis host to connect to."
examples:
- "localhost,127.0.0.1"
order: 1
title: "Host"
type: "string"
password:
airbyte_secret: true
description: "Password associated with Redis."
order: 4
title: "Password"
type: "string"
port:
default: 6379
description: "Port of Redis."
maximum: 65536
minimum: 0
order: 2
title: "Port"
type: "integer"
ssl:
default: false
description: "Indicates whether SSL encryption protocol will be used to\
\ connect to Redis. It is recommended to use SSL connection if possible."
order: 5
title: "SSL Connection"
type: "boolean"
ssl_mode:
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"
oneOf:
- additionalProperties: false
description: "Disable SSL."
properties:
mode:
const: "disable"
default: "disable"
enum:
- "disable"
order: 0
type: "string"
required:
- "mode"
title: "disable"
- additionalProperties: false
description: "Verify-full SSL mode."
properties:
ca_certificate:
airbyte_secret: true
description: "CA certificate"
multiline: true
order: 1
title: "CA Certificate"
type: "string"
client_certificate:
airbyte_secret: true
description: "Client certificate"
multiline: true
order: 2
title: "Client Certificate"
type: "string"
client_key:
airbyte_secret: true
description: "Client key"
multiline: true
order: 3
title: "Client Key"
type: "string"
client_key_password:
airbyte_secret: true
description: "Password for keystorage. If you do not add it - the\
\ password will be generated automatically."
order: 4
title: "Client key password"
type: "string"
mode:
const: "verify-full"
default: "verify-full"
enum:
- "verify-full"
order: 0
type: "string"
required:
- "mode"
- "ca_certificate"
- "client_certificate"
- "client_key"
title: "verify-full"
order: 6
title: "SSL Modes"
type: "object"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- properties:
tunnel_method:
const: "NO_TUNNEL"
description: "No ssh tunnel needed to connect to database"
order: 0
type: "string"
enum:
- "NO_TUNNEL"
required:
- "tunnel_method"
title: "No Tunnel"
- properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_KEY_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host."
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
- properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
title: "SSH Tunnel Method"
type: "object"
username:
description: "Username associated with Redis."
order: 3
title: "Username"
type: "string"
required:
- "host"
- "username"
- "port"
- "cache_type"
title: "Redis Destination Spec"
type: "object"
destination-typesense:
properties:
api_key:
description: "Typesense API Key"
order: 0
title: "API Key"
type: "string"
batch_size:
description: "How many documents should be imported together. Default 1000"
order: 4
title: "Batch size"
type: "integer"
host:
description: "Hostname of the Typesense instance without protocol. Accept\
\ multiple hosts separated by comma."
order: 1
title: "Host"
type: "string"
path:
description: "Path of the Typesense instance. Default is none"
order: 5
title: "Path"
type: "string"
port:
description: "Port of the Typesense instance. Ex: 8108, 80, 443. Default\
\ is 8108"
order: 2
title: "Port"
type: "string"
protocol:
description: "Protocol of the Typesense instance. Ex: http or https. Default\
\ is https"
order: 3
title: "Protocol"
type: "string"
destinationType:
title: "typesense"
const: "typesense"
enum:
- "typesense"
order: 0
type: "string"
required:
- "api_key"
- "host"
- "destinationType"
title: "Destination Typesense"
type: "object"
destination-typesense-update:
properties:
api_key:
description: "Typesense API Key"
order: 0
title: "API Key"
type: "string"
batch_size:
description: "How many documents should be imported together. Default 1000"
order: 4
title: "Batch size"
type: "integer"
host:
description: "Hostname of the Typesense instance without protocol. Accept\
\ multiple hosts separated by comma."
order: 1
title: "Host"
type: "string"
path:
description: "Path of the Typesense instance. Default is none"
order: 5
title: "Path"
type: "string"
port:
description: "Port of the Typesense instance. Ex: 8108, 80, 443. Default\
\ is 8108"
order: 2
title: "Port"
type: "string"
protocol:
description: "Protocol of the Typesense instance. Ex: http or https. Default\
\ is https"
order: 3
title: "Protocol"
type: "string"
required:
- "api_key"
- "host"
title: "Destination Typesense"
type: "object"
destination-elasticsearch:
properties:
authenticationMethod:
description: "The type of authentication to be used"
oneOf:
- additionalProperties: false
description: "No authentication will be used"
properties:
method:
const: "none"
type: "string"
enum:
- "none"
required:
- "method"
title: "None"
- additionalProperties: false
description: "Use a api key and secret combination to authenticate"
properties:
apiKeyId:
description: "The Key ID to used when accessing an enterprise Elasticsearch\
\ instance."
title: "API Key ID"
type: "string"
apiKeySecret:
airbyte_secret: true
description: "The secret associated with the API Key ID."
title: "API Key Secret"
type: "string"
x-speakeasy-param-sensitive: true
method:
const: "secret"
type: "string"
enum:
- "secret"
required:
- "method"
- "apiKeyId"
- "apiKeySecret"
title: "Api Key/Secret"
- additionalProperties: false
description: "Basic auth header with a username and password"
properties:
method:
const: "basic"
type: "string"
enum:
- "basic"
password:
airbyte_secret: true
description: "Basic auth password to access a secure Elasticsearch\
\ server"
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
username:
description: "Basic auth username to access a secure Elasticsearch\
\ server"
title: "Username"
type: "string"
required:
- "method"
- "username"
- "password"
title: "Username/Password"
title: "Authentication Method"
type: "object"
ca_certificate:
airbyte_secret: true
description: "CA certificate"
multiline: true
title: "CA certificate"
type: "string"
x-speakeasy-param-sensitive: true
endpoint:
description: "The full url of the Elasticsearch server"
title: "Server Endpoint"
type: "string"
pathPrefix:
description: "The Path Prefix of the Elasticsearch server"
title: "Server path prefix"
type: "string"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- properties:
tunnel_method:
const: "NO_TUNNEL"
description: "No ssh tunnel needed to connect to database"
order: 0
type: "string"
enum:
- "NO_TUNNEL"
required:
- "tunnel_method"
title: "No Tunnel"
- properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
x-speakeasy-param-sensitive: true
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_KEY_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host."
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
- properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
title: "SSH Tunnel Method"
type: "object"
upsert:
default: true
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."
title: "Upsert Records"
type: "boolean"
destinationType:
title: "elasticsearch"
const: "elasticsearch"
enum:
- "elasticsearch"
order: 0
type: "string"
required:
- "endpoint"
- "destinationType"
title: "Elasticsearch Connection Configuration"
type: "object"
destination-elasticsearch-update:
properties:
authenticationMethod:
description: "The type of authentication to be used"
oneOf:
- additionalProperties: false
description: "No authentication will be used"
properties:
method:
const: "none"
type: "string"
enum:
- "none"
required:
- "method"
title: "None"
- additionalProperties: false
description: "Use a api key and secret combination to authenticate"
properties:
apiKeyId:
description: "The Key ID to used when accessing an enterprise Elasticsearch\
\ instance."
title: "API Key ID"
type: "string"
apiKeySecret:
airbyte_secret: true
description: "The secret associated with the API Key ID."
title: "API Key Secret"
type: "string"
method:
const: "secret"
type: "string"
enum:
- "secret"
required:
- "method"
- "apiKeyId"
- "apiKeySecret"
title: "Api Key/Secret"
- additionalProperties: false
description: "Basic auth header with a username and password"
properties:
method:
const: "basic"
type: "string"
enum:
- "basic"
password:
airbyte_secret: true
description: "Basic auth password to access a secure Elasticsearch\
\ server"
title: "Password"
type: "string"
username:
description: "Basic auth username to access a secure Elasticsearch\
\ server"
title: "Username"
type: "string"
required:
- "method"
- "username"
- "password"
title: "Username/Password"
title: "Authentication Method"
type: "object"
ca_certificate:
airbyte_secret: true
description: "CA certificate"
multiline: true
title: "CA certificate"
type: "string"
endpoint:
description: "The full url of the Elasticsearch server"
title: "Server Endpoint"
type: "string"
pathPrefix:
description: "The Path Prefix of the Elasticsearch server"
title: "Server path prefix"
type: "string"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- properties:
tunnel_method:
const: "NO_TUNNEL"
description: "No ssh tunnel needed to connect to database"
order: 0
type: "string"
enum:
- "NO_TUNNEL"
required:
- "tunnel_method"
title: "No Tunnel"
- properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_KEY_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host."
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
- properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
title: "SSH Tunnel Method"
type: "object"
upsert:
default: true
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."
title: "Upsert Records"
type: "boolean"
required:
- "endpoint"
title: "Elasticsearch Connection Configuration"
type: "object"
destination-azure-blob-storage:
properties:
azure_blob_storage_account_key:
airbyte_secret: true
always_show: true
description: "The Azure Blob Storage account key. If you set this value,\
\ you must not set the \"Shared Access Signature\", \"Azure Tenant ID\"\
, \"Azure Client ID\", or \"Azure Client Secret\" fields."
examples:
- "Z8ZkZpteggFx394vm+PJHnGTvdRncaYS+JhLKdj789YNmD+iyGTnG+PV+POiuYNhBg/ACS+LKjd%4FG3FHGN12Nd=="
title: "Azure Blob Storage Account Key"
type: "string"
x-speakeasy-param-sensitive: true
azure_blob_storage_account_name:
description: "The name of the Azure Blob Storage Account. Read more here."
examples:
- "mystorageaccount"
title: "Azure Blob Storage Account Name"
type: "string"
azure_blob_storage_container_name:
description: "The name of the Azure Blob Storage Container. Read more here."
examples:
- "mycontainer"
title: "Azure Blob Storage Container Name"
type: "string"
azure_blob_storage_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."
title: "Azure Blob Storage Endpoint Domain Name"
type: "string"
azure_blob_storage_spill_size:
default: 500
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."
title: "Azure Blob Storage Target Blob Size (MB)"
type: "integer"
azure_client_id:
airbyte_secret: false
description: "The Azure Active Directory (Entra ID) client ID. Required\
\ for Entra ID authentication."
examples:
- "87654321-4321-4321-4321-210987654321"
title: "Azure Client ID"
type: "string"
x-speakeasy-param-sensitive: true
azure_client_secret:
airbyte_secret: true
always_show: true
description: "The Azure Active Directory (Entra ID) client secret. Required\
\ for Entra ID authentication."
examples:
- "your-client-secret"
title: "Azure Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
azure_tenant_id:
airbyte_secret: false
description: "The Azure Active Directory (Entra ID) tenant ID. Required\
\ for Entra ID authentication."
examples:
- "12345678-1234-1234-1234-123456789012"
title: "Azure Tenant ID"
type: "string"
x-speakeasy-param-sensitive: true
format:
description: "Format of the data output."
oneOf:
- additionalProperties: true
properties:
flattening:
default: "No flattening"
enum:
- "No flattening"
- "Root level flattening"
title: "Flattening"
type: "string"
format_type:
default: "CSV"
enum:
- "CSV"
type: "string"
required:
- "format_type"
- "flattening"
title: "CSV: Comma-Separated Values"
type: "object"
- additionalProperties: true
properties:
flattening:
default: "No flattening"
enum:
- "No flattening"
- "Root level flattening"
title: "Flattening"
type: "string"
format_type:
default: "JSONL"
enum:
- "JSONL"
type: "string"
required:
- "format_type"
title: "JSON Lines: Newline-delimited JSON"
type: "object"
title: "Output Format"
type: "object"
shared_access_signature:
airbyte_secret: true
always_show: true
description: "A shared access signature (SAS) provides secure delegated\
\ access to resources in your storage account. Read more here. If you set this value, you must not set the \"Azure Blob Storage\
\ Account Key\", \"Azure Tenant ID\", \"Azure Client ID\", or \"Azure\
\ Client Secret\" fields."
examples:
- "sv=2021-08-06&st=2025-04-11T00%3A00%3A00Z&se=2025-04-12T00%3A00%3A00Z&sr=b&sp=rw&sig=abcdefghijklmnopqrstuvwxyz1234567890%2Fabcdefg%3D"
title: "Shared Access Signature"
type: "string"
x-speakeasy-param-sensitive: true
destinationType:
title: "azure-blob-storage"
const: "azure-blob-storage"
enum:
- "azure-blob-storage"
order: 0
type: "string"
required:
- "azure_blob_storage_account_name"
- "azure_blob_storage_container_name"
- "format"
- "destinationType"
title: "Azure Blob Storage Destination Spec"
type: "object"
destination-azure-blob-storage-update:
properties:
azure_blob_storage_account_key:
airbyte_secret: true
always_show: true
description: "The Azure Blob Storage account key. If you set this value,\
\ you must not set the \"Shared Access Signature\", \"Azure Tenant ID\"\
, \"Azure Client ID\", or \"Azure Client Secret\" fields."
examples:
- "Z8ZkZpteggFx394vm+PJHnGTvdRncaYS+JhLKdj789YNmD+iyGTnG+PV+POiuYNhBg/ACS+LKjd%4FG3FHGN12Nd=="
title: "Azure Blob Storage Account Key"
type: "string"
azure_blob_storage_account_name:
description: "The name of the Azure Blob Storage Account. Read more here."
examples:
- "mystorageaccount"
title: "Azure Blob Storage Account Name"
type: "string"
azure_blob_storage_container_name:
description: "The name of the Azure Blob Storage Container. Read more here."
examples:
- "mycontainer"
title: "Azure Blob Storage Container Name"
type: "string"
azure_blob_storage_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."
title: "Azure Blob Storage Endpoint Domain Name"
type: "string"
azure_blob_storage_spill_size:
default: 500
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."
title: "Azure Blob Storage Target Blob Size (MB)"
type: "integer"
azure_client_id:
airbyte_secret: false
description: "The Azure Active Directory (Entra ID) client ID. Required\
\ for Entra ID authentication."
examples:
- "87654321-4321-4321-4321-210987654321"
title: "Azure Client ID"
type: "string"
azure_client_secret:
airbyte_secret: true
always_show: true
description: "The Azure Active Directory (Entra ID) client secret. Required\
\ for Entra ID authentication."
examples:
- "your-client-secret"
title: "Azure Client Secret"
type: "string"
azure_tenant_id:
airbyte_secret: false
description: "The Azure Active Directory (Entra ID) tenant ID. Required\
\ for Entra ID authentication."
examples:
- "12345678-1234-1234-1234-123456789012"
title: "Azure Tenant ID"
type: "string"
format:
description: "Format of the data output."
oneOf:
- additionalProperties: true
properties:
flattening:
default: "No flattening"
enum:
- "No flattening"
- "Root level flattening"
title: "Flattening"
type: "string"
format_type:
default: "CSV"
enum:
- "CSV"
type: "string"
required:
- "format_type"
- "flattening"
title: "CSV: Comma-Separated Values"
type: "object"
- additionalProperties: true
properties:
flattening:
default: "No flattening"
enum:
- "No flattening"
- "Root level flattening"
title: "Flattening"
type: "string"
format_type:
default: "JSONL"
enum:
- "JSONL"
type: "string"
required:
- "format_type"
title: "JSON Lines: Newline-delimited JSON"
type: "object"
title: "Output Format"
type: "object"
shared_access_signature:
airbyte_secret: true
always_show: true
description: "A shared access signature (SAS) provides secure delegated\
\ access to resources in your storage account. Read more here. If you set this value, you must not set the \"Azure Blob Storage\
\ Account Key\", \"Azure Tenant ID\", \"Azure Client ID\", or \"Azure\
\ Client Secret\" fields."
examples:
- "sv=2021-08-06&st=2025-04-11T00%3A00%3A00Z&se=2025-04-12T00%3A00%3A00Z&sr=b&sp=rw&sig=abcdefghijklmnopqrstuvwxyz1234567890%2Fabcdefg%3D"
title: "Shared Access Signature"
type: "string"
required:
- "azure_blob_storage_account_name"
- "azure_blob_storage_container_name"
- "format"
title: "Azure Blob Storage Destination Spec"
type: "object"
destination-yellowbrick:
properties:
database:
description: "Name of the database."
order: 2
title: "DB Name"
type: "string"
host:
description: "Hostname of the database."
order: 0
title: "Host"
type: "string"
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)."
order: 8
title: "JDBC URL Params"
type: "string"
password:
airbyte_secret: true
description: "Password associated with the username."
order: 5
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
port:
default: 5432
description: "Port of the database."
examples:
- "5432"
maximum: 65536
minimum: 0
order: 1
title: "Port"
type: "integer"
schema:
default: "public"
description: "The default schema tables are written to if the source does\
\ not specify a namespace. The usual value for this field is \"public\"\
."
examples:
- "public"
order: 3
title: "Default Schema"
type: "string"
ssl:
default: false
description: "Encrypt data using SSL. When activating SSL, please select\
\ one of the connection modes."
order: 6
title: "SSL Connection"
type: "boolean"
ssl_mode:
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."
oneOf:
- additionalProperties: false
description: "Disable SSL."
properties:
mode:
const: "disable"
default: "disable"
enum:
- "disable"
order: 0
type: "string"
required:
- "mode"
title: "disable"
- additionalProperties: false
description: "Allow SSL mode."
properties:
mode:
const: "allow"
default: "allow"
enum:
- "allow"
order: 0
type: "string"
required:
- "mode"
title: "allow"
- additionalProperties: false
description: "Prefer SSL mode."
properties:
mode:
const: "prefer"
default: "prefer"
enum:
- "prefer"
order: 0
type: "string"
required:
- "mode"
title: "prefer"
- additionalProperties: false
description: "Require SSL mode."
properties:
mode:
const: "require"
default: "require"
enum:
- "require"
order: 0
type: "string"
required:
- "mode"
title: "require"
- additionalProperties: false
description: "Verify-ca SSL mode."
properties:
ca_certificate:
airbyte_secret: true
description: "CA certificate"
multiline: true
order: 1
title: "CA certificate"
type: "string"
x-speakeasy-param-sensitive: true
client_key_password:
airbyte_secret: true
description: "Password for keystorage. This field is optional. If\
\ you do not add it - the password will be generated automatically."
order: 4
title: "Client key password"
type: "string"
x-speakeasy-param-sensitive: true
mode:
const: "verify-ca"
default: "verify-ca"
enum:
- "verify-ca"
order: 0
type: "string"
required:
- "mode"
- "ca_certificate"
title: "verify-ca"
- additionalProperties: false
description: "Verify-full SSL mode."
properties:
ca_certificate:
airbyte_secret: true
description: "CA certificate"
multiline: true
order: 1
title: "CA certificate"
type: "string"
x-speakeasy-param-sensitive: true
client_certificate:
airbyte_secret: true
description: "Client certificate"
multiline: true
order: 2
title: "Client certificate"
type: "string"
x-speakeasy-param-sensitive: true
client_key:
airbyte_secret: true
description: "Client key"
multiline: true
order: 3
title: "Client key"
type: "string"
x-speakeasy-param-sensitive: true
client_key_password:
airbyte_secret: true
description: "Password for keystorage. This field is optional. If\
\ you do not add it - the password will be generated automatically."
order: 4
title: "Client key password"
type: "string"
x-speakeasy-param-sensitive: true
mode:
const: "verify-full"
default: "verify-full"
enum:
- "verify-full"
order: 0
type: "string"
required:
- "mode"
- "ca_certificate"
- "client_certificate"
- "client_key"
title: "verify-full"
order: 7
title: "SSL modes"
type: "object"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- properties:
tunnel_method:
const: "NO_TUNNEL"
description: "No ssh tunnel needed to connect to database"
order: 0
type: "string"
enum:
- "NO_TUNNEL"
required:
- "tunnel_method"
title: "No Tunnel"
- properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
x-speakeasy-param-sensitive: true
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_KEY_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host."
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
- properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
title: "SSH Tunnel Method"
type: "object"
username:
description: "Username to use to access the database."
order: 4
title: "User"
type: "string"
destinationType:
title: "yellowbrick"
const: "yellowbrick"
enum:
- "yellowbrick"
order: 0
type: "string"
required:
- "host"
- "port"
- "username"
- "database"
- "schema"
- "destinationType"
title: "Yellowbrick Destination Spec"
type: "object"
destination-yellowbrick-update:
properties:
database:
description: "Name of the database."
order: 2
title: "DB Name"
type: "string"
host:
description: "Hostname of the database."
order: 0
title: "Host"
type: "string"
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)."
order: 8
title: "JDBC URL Params"
type: "string"
password:
airbyte_secret: true
description: "Password associated with the username."
order: 5
title: "Password"
type: "string"
port:
default: 5432
description: "Port of the database."
examples:
- "5432"
maximum: 65536
minimum: 0
order: 1
title: "Port"
type: "integer"
schema:
default: "public"
description: "The default schema tables are written to if the source does\
\ not specify a namespace. The usual value for this field is \"public\"\
."
examples:
- "public"
order: 3
title: "Default Schema"
type: "string"
ssl:
default: false
description: "Encrypt data using SSL. When activating SSL, please select\
\ one of the connection modes."
order: 6
title: "SSL Connection"
type: "boolean"
ssl_mode:
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."
oneOf:
- additionalProperties: false
description: "Disable SSL."
properties:
mode:
const: "disable"
default: "disable"
enum:
- "disable"
order: 0
type: "string"
required:
- "mode"
title: "disable"
- additionalProperties: false
description: "Allow SSL mode."
properties:
mode:
const: "allow"
default: "allow"
enum:
- "allow"
order: 0
type: "string"
required:
- "mode"
title: "allow"
- additionalProperties: false
description: "Prefer SSL mode."
properties:
mode:
const: "prefer"
default: "prefer"
enum:
- "prefer"
order: 0
type: "string"
required:
- "mode"
title: "prefer"
- additionalProperties: false
description: "Require SSL mode."
properties:
mode:
const: "require"
default: "require"
enum:
- "require"
order: 0
type: "string"
required:
- "mode"
title: "require"
- additionalProperties: false
description: "Verify-ca SSL mode."
properties:
ca_certificate:
airbyte_secret: true
description: "CA certificate"
multiline: true
order: 1
title: "CA certificate"
type: "string"
client_key_password:
airbyte_secret: true
description: "Password for keystorage. This field is optional. If\
\ you do not add it - the password will be generated automatically."
order: 4
title: "Client key password"
type: "string"
mode:
const: "verify-ca"
default: "verify-ca"
enum:
- "verify-ca"
order: 0
type: "string"
required:
- "mode"
- "ca_certificate"
title: "verify-ca"
- additionalProperties: false
description: "Verify-full SSL mode."
properties:
ca_certificate:
airbyte_secret: true
description: "CA certificate"
multiline: true
order: 1
title: "CA certificate"
type: "string"
client_certificate:
airbyte_secret: true
description: "Client certificate"
multiline: true
order: 2
title: "Client certificate"
type: "string"
client_key:
airbyte_secret: true
description: "Client key"
multiline: true
order: 3
title: "Client key"
type: "string"
client_key_password:
airbyte_secret: true
description: "Password for keystorage. This field is optional. If\
\ you do not add it - the password will be generated automatically."
order: 4
title: "Client key password"
type: "string"
mode:
const: "verify-full"
default: "verify-full"
enum:
- "verify-full"
order: 0
type: "string"
required:
- "mode"
- "ca_certificate"
- "client_certificate"
- "client_key"
title: "verify-full"
order: 7
title: "SSL modes"
type: "object"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- properties:
tunnel_method:
const: "NO_TUNNEL"
description: "No ssh tunnel needed to connect to database"
order: 0
type: "string"
enum:
- "NO_TUNNEL"
required:
- "tunnel_method"
title: "No Tunnel"
- properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_KEY_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host."
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
- properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
title: "SSH Tunnel Method"
type: "object"
username:
description: "Username to use to access the database."
order: 4
title: "User"
type: "string"
required:
- "host"
- "port"
- "username"
- "database"
- "schema"
title: "Yellowbrick Destination Spec"
type: "object"
destination-postgres:
properties:
database:
description: "Name of the database."
order: 2
title: "DB Name"
type: "string"
disable_type_dedupe:
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"
order: 10
title: "Disable Final Tables. (WARNING! Unstable option; Columns in raw\
\ table schema might change between versions)"
type: "boolean"
drop_cascade:
default: false
description: "Drop tables with CASCADE. WARNING! This will delete all data\
\ in all dependent objects (views, etc.). Use with caution. This option\
\ is intended for usecases which can easily rebuild the dependent objects."
order: 11
title: "Drop tables with CASCADE. (WARNING! Risk of unrecoverable data loss)"
type: "boolean"
host:
description: "Hostname of the database."
order: 0
title: "Host"
type: "string"
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)."
order: 8
title: "JDBC URL Params"
type: "string"
password:
airbyte_secret: true
description: "Password associated with the username."
order: 5
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
port:
default: 5432
description: "Port of the database."
examples:
- "5432"
maximum: 65536
minimum: 0
order: 1
title: "Port"
type: "integer"
raw_data_schema:
description: "The schema to write raw tables into"
order: 9
title: "Raw table schema (defaults to airbyte_internal)"
type: "string"
schema:
default: "public"
description: "The default schema tables are written to if the source does\
\ not specify a namespace. The usual value for this field is \"public\"\
."
examples:
- "public"
order: 3
title: "Default Schema"
type: "string"
ssl:
default: false
description: "Encrypt data using SSL. When activating SSL, please select\
\ one of the connection modes."
order: 6
title: "SSL Connection"
type: "boolean"
ssl_mode:
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."
oneOf:
- additionalProperties: false
description: "Disable SSL."
properties:
mode:
const: "disable"
default: "disable"
enum:
- "disable"
order: 0
type: "string"
required:
- "mode"
title: "disable"
- additionalProperties: false
description: "Allow SSL mode."
properties:
mode:
const: "allow"
default: "allow"
enum:
- "allow"
order: 0
type: "string"
required:
- "mode"
title: "allow"
- additionalProperties: false
description: "Prefer SSL mode."
properties:
mode:
const: "prefer"
default: "prefer"
enum:
- "prefer"
order: 0
type: "string"
required:
- "mode"
title: "prefer"
- additionalProperties: false
description: "Require SSL mode."
properties:
mode:
const: "require"
default: "require"
enum:
- "require"
order: 0
type: "string"
required:
- "mode"
title: "require"
- additionalProperties: false
description: "Verify-ca SSL mode."
properties:
ca_certificate:
airbyte_secret: true
description: "CA certificate"
multiline: true
order: 1
title: "CA certificate"
type: "string"
x-speakeasy-param-sensitive: true
client_key_password:
airbyte_secret: true
description: "Password for keystorage. This field is optional. If\
\ you do not add it - the password will be generated automatically."
order: 4
title: "Client key password"
type: "string"
x-speakeasy-param-sensitive: true
mode:
const: "verify-ca"
default: "verify-ca"
enum:
- "verify-ca"
order: 0
type: "string"
required:
- "mode"
- "ca_certificate"
title: "verify-ca"
- additionalProperties: false
description: "Verify-full SSL mode."
properties:
ca_certificate:
airbyte_secret: true
description: "CA certificate"
multiline: true
order: 1
title: "CA certificate"
type: "string"
x-speakeasy-param-sensitive: true
client_certificate:
airbyte_secret: true
description: "Client certificate"
multiline: true
order: 2
title: "Client certificate"
type: "string"
x-speakeasy-param-sensitive: true
client_key:
airbyte_secret: true
description: "Client key"
multiline: true
order: 3
title: "Client key"
type: "string"
x-speakeasy-param-sensitive: true
client_key_password:
airbyte_secret: true
description: "Password for keystorage. This field is optional. If\
\ you do not add it - the password will be generated automatically."
order: 4
title: "Client key password"
type: "string"
x-speakeasy-param-sensitive: true
mode:
const: "verify-full"
default: "verify-full"
enum:
- "verify-full"
order: 0
type: "string"
required:
- "mode"
- "ca_certificate"
- "client_certificate"
- "client_key"
title: "verify-full"
order: 7
title: "SSL modes"
type: "object"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- properties:
tunnel_method:
const: "NO_TUNNEL"
description: "No ssh tunnel needed to connect to database"
order: 0
type: "string"
enum:
- "NO_TUNNEL"
required:
- "tunnel_method"
title: "No Tunnel"
- properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
x-speakeasy-param-sensitive: true
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_KEY_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host."
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
- properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
title: "SSH Tunnel Method"
type: "object"
unconstrained_number:
default: false
description: "Create numeric columns as unconstrained DECIMAL instead of\
\ NUMBER(38, 9). This will allow increased precision in numeric values.\
\ (this is disabled by default for backwards compatibility, but is recommended\
\ to enable)"
order: 12
title: "Unconstrained numeric columns"
type: "boolean"
username:
description: "Username to use to access the database."
order: 4
title: "User"
type: "string"
destinationType:
title: "postgres"
const: "postgres"
enum:
- "postgres"
order: 0
type: "string"
required:
- "host"
- "port"
- "username"
- "database"
- "schema"
- "destinationType"
title: "Postgres Destination Spec"
type: "object"
destination-postgres-update:
properties:
database:
description: "Name of the database."
order: 2
title: "DB Name"
type: "string"
disable_type_dedupe:
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"
order: 10
title: "Disable Final Tables. (WARNING! Unstable option; Columns in raw\
\ table schema might change between versions)"
type: "boolean"
drop_cascade:
default: false
description: "Drop tables with CASCADE. WARNING! This will delete all data\
\ in all dependent objects (views, etc.). Use with caution. This option\
\ is intended for usecases which can easily rebuild the dependent objects."
order: 11
title: "Drop tables with CASCADE. (WARNING! Risk of unrecoverable data loss)"
type: "boolean"
host:
description: "Hostname of the database."
order: 0
title: "Host"
type: "string"
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)."
order: 8
title: "JDBC URL Params"
type: "string"
password:
airbyte_secret: true
description: "Password associated with the username."
order: 5
title: "Password"
type: "string"
port:
default: 5432
description: "Port of the database."
examples:
- "5432"
maximum: 65536
minimum: 0
order: 1
title: "Port"
type: "integer"
raw_data_schema:
description: "The schema to write raw tables into"
order: 9
title: "Raw table schema (defaults to airbyte_internal)"
type: "string"
schema:
default: "public"
description: "The default schema tables are written to if the source does\
\ not specify a namespace. The usual value for this field is \"public\"\
."
examples:
- "public"
order: 3
title: "Default Schema"
type: "string"
ssl:
default: false
description: "Encrypt data using SSL. When activating SSL, please select\
\ one of the connection modes."
order: 6
title: "SSL Connection"
type: "boolean"
ssl_mode:
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."
oneOf:
- additionalProperties: false
description: "Disable SSL."
properties:
mode:
const: "disable"
default: "disable"
enum:
- "disable"
order: 0
type: "string"
required:
- "mode"
title: "disable"
- additionalProperties: false
description: "Allow SSL mode."
properties:
mode:
const: "allow"
default: "allow"
enum:
- "allow"
order: 0
type: "string"
required:
- "mode"
title: "allow"
- additionalProperties: false
description: "Prefer SSL mode."
properties:
mode:
const: "prefer"
default: "prefer"
enum:
- "prefer"
order: 0
type: "string"
required:
- "mode"
title: "prefer"
- additionalProperties: false
description: "Require SSL mode."
properties:
mode:
const: "require"
default: "require"
enum:
- "require"
order: 0
type: "string"
required:
- "mode"
title: "require"
- additionalProperties: false
description: "Verify-ca SSL mode."
properties:
ca_certificate:
airbyte_secret: true
description: "CA certificate"
multiline: true
order: 1
title: "CA certificate"
type: "string"
client_key_password:
airbyte_secret: true
description: "Password for keystorage. This field is optional. If\
\ you do not add it - the password will be generated automatically."
order: 4
title: "Client key password"
type: "string"
mode:
const: "verify-ca"
default: "verify-ca"
enum:
- "verify-ca"
order: 0
type: "string"
required:
- "mode"
- "ca_certificate"
title: "verify-ca"
- additionalProperties: false
description: "Verify-full SSL mode."
properties:
ca_certificate:
airbyte_secret: true
description: "CA certificate"
multiline: true
order: 1
title: "CA certificate"
type: "string"
client_certificate:
airbyte_secret: true
description: "Client certificate"
multiline: true
order: 2
title: "Client certificate"
type: "string"
client_key:
airbyte_secret: true
description: "Client key"
multiline: true
order: 3
title: "Client key"
type: "string"
client_key_password:
airbyte_secret: true
description: "Password for keystorage. This field is optional. If\
\ you do not add it - the password will be generated automatically."
order: 4
title: "Client key password"
type: "string"
mode:
const: "verify-full"
default: "verify-full"
enum:
- "verify-full"
order: 0
type: "string"
required:
- "mode"
- "ca_certificate"
- "client_certificate"
- "client_key"
title: "verify-full"
order: 7
title: "SSL modes"
type: "object"
tunnel_method:
description: "Whether to initiate an SSH tunnel before connecting to the\
\ database, and if so, which kind of authentication to use."
oneOf:
- properties:
tunnel_method:
const: "NO_TUNNEL"
description: "No ssh tunnel needed to connect to database"
order: 0
type: "string"
enum:
- "NO_TUNNEL"
required:
- "tunnel_method"
title: "No Tunnel"
- properties:
ssh_key:
airbyte_secret: true
description: "OS-level user account ssh key credentials in RSA PEM\
\ format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )"
multiline: true
order: 4
title: "SSH Private Key"
type: "string"
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_KEY_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and ssh key"
order: 0
type: "string"
enum:
- "SSH_KEY_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host."
order: 3
title: "SSH Login Username"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "ssh_key"
title: "SSH Key Authentication"
- properties:
tunnel_host:
description: "Hostname of the jump server host that allows inbound\
\ ssh tunnel."
order: 1
title: "SSH Tunnel Jump Server Host"
type: "string"
tunnel_method:
const: "SSH_PASSWORD_AUTH"
description: "Connect through a jump server tunnel host using username\
\ and password authentication"
order: 0
type: "string"
enum:
- "SSH_PASSWORD_AUTH"
tunnel_port:
default: 22
description: "Port on the proxy/jump server that accepts inbound ssh\
\ connections."
examples:
- "22"
maximum: 65536
minimum: 0
order: 2
title: "SSH Connection Port"
type: "integer"
tunnel_user:
description: "OS-level username for logging into the jump server host"
order: 3
title: "SSH Login Username"
type: "string"
tunnel_user_password:
airbyte_secret: true
description: "OS-level password for logging into the jump server host"
order: 4
title: "Password"
type: "string"
required:
- "tunnel_method"
- "tunnel_host"
- "tunnel_port"
- "tunnel_user"
- "tunnel_user_password"
title: "Password Authentication"
title: "SSH Tunnel Method"
type: "object"
unconstrained_number:
default: false
description: "Create numeric columns as unconstrained DECIMAL instead of\
\ NUMBER(38, 9). This will allow increased precision in numeric values.\
\ (this is disabled by default for backwards compatibility, but is recommended\
\ to enable)"
order: 12
title: "Unconstrained numeric columns"
type: "boolean"
username:
description: "Username to use to access the database."
order: 4
title: "User"
type: "string"
required:
- "host"
- "port"
- "username"
- "database"
- "schema"
title: "Postgres Destination Spec"
type: "object"
destination-s3-data-lake:
description: "Defines the configurations required to connect to an Iceberg catalog,\
\ including warehouse location, main branch name, and catalog type specifics."
properties:
access_key_id:
airbyte_secret: true
always_show: true
description: "The AWS Access Key ID with permissions for S3 and Glue operations."
order: 0
title: "AWS Access Key ID"
type: "string"
x-speakeasy-param-sensitive: true
catalog_type:
always_show: true
description: "Specifies the type of Iceberg catalog (e.g., NESSIE, GLUE,\
\ REST, POLARIS) and its associated configuration."
oneOf:
- additionalProperties: true
description: "Configuration details for connecting to a Nessie-based Iceberg\
\ catalog."
properties:
access_token:
airbyte_secret: true
description: "Optional token for authentication with the Nessie server."
examples:
- "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY"
order: 2
title: "Nessie Access Token"
type: "string"
x-speakeasy-param-sensitive: true
catalog_type:
default: "NESSIE"
enum:
- "NESSIE"
type: "string"
namespace:
description: "The Nessie namespace to be used in the Table identifier.\
\ \n This will ONLY be used if the `Destination Namespace`\
\ setting for the connection is set to\n `Destination-defined`\
\ or `Source-defined`"
title: "Default namespace"
type: "string"
server_uri:
description: "The base URL of the Nessie server used to connect to\
\ the Nessie catalog."
order: 1
title: "Nessie Server URI"
type: "string"
required:
- "catalog_type"
- "server_uri"
- "namespace"
title: "Nessie Catalog"
type: "object"
- additionalProperties: true
description: "Configuration details for connecting to an AWS Glue-based\
\ Iceberg catalog."
properties:
catalog_type:
default: "GLUE"
enum:
- "GLUE"
type: "string"
database_name:
description: "The Glue database name. This will ONLY be used if the\
\ `Destination Namespace` setting for the connection is set to `Destination-defined`\
\ or `Source-defined`"
title: "Default database"
type: "string"
glue_id:
description: "The AWS Account ID associated with the Glue service\
\ used by the Iceberg catalog."
order: 1
title: "AWS Account ID"
type: "string"
role_arn:
description: "The ARN of the AWS role to assume. Only usable in Airbyte\
\ Cloud."
title: "Role ARN"
type: "string"
required:
- "catalog_type"
- "glue_id"
- "database_name"
title: "Glue Catalog"
type: "object"
- additionalProperties: true
description: "Configuration details for connecting to a REST catalog."
properties:
catalog_type:
default: "REST"
enum:
- "REST"
type: "string"
namespace:
description: "The namespace to be used in the Table identifier. \n\
\ This will ONLY be used if the `Destination Namespace`\
\ setting for the connection is set to\n `Destination-defined`\
\ or `Source-defined`"
title: "Default namespace"
type: "string"
server_uri:
description: "The base URL of the Rest server used to connect to the\
\ Rest catalog."
order: 1
title: "Rest Server URI"
type: "string"
required:
- "catalog_type"
- "server_uri"
- "namespace"
title: "Rest Catalog"
type: "object"
- additionalProperties: true
description: "Configuration details for connecting to an Apache Polaris-based\
\ Iceberg catalog."
properties:
catalog_name:
description: "The name of the catalog in Polaris. This corresponds\
\ to the catalog name created via the Polaris Management API."
order: 2
title: "Polaris Catalog Name"
type: "string"
catalog_type:
default: "POLARIS"
enum:
- "POLARIS"
type: "string"
client_id:
airbyte_secret: true
description: "The OAuth Client ID for authenticating with the Polaris\
\ server."
examples:
- "abc123clientid"
order: 3
title: "Client ID"
type: "string"
x-speakeasy-param-sensitive: true
client_secret:
airbyte_secret: true
description: "The OAuth Client Secret for authenticating with the\
\ Polaris server."
examples:
- "secretkey123"
order: 4
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
namespace:
description: "The Polaris namespace to be used in the Table identifier.\n\
\ This will ONLY be used if the `Destination Namespace`\
\ setting for the connection is set to\n `Destination-defined`\
\ or `Source-defined`"
order: 5
title: "Default namespace"
type: "string"
server_uri:
description: "The base URL of the Polaris server used to connect to\
\ the Polaris catalog."
order: 1
title: "Polaris Server URI"
type: "string"
required:
- "catalog_type"
- "server_uri"
- "catalog_name"
- "client_id"
- "client_secret"
- "namespace"
title: "Polaris Catalog"
type: "object"
order: 7
title: "Catalog Type"
type: "object"
main_branch_name:
always_show: true
default: "main"
description: "The primary or default branch name in the catalog. Most query\
\ engines will use \"main\" by default. See Iceberg documentation for more information."
order: 6
title: "Main Branch Name"
type: "string"
s3_bucket_name:
always_show: true
description: "The name of the S3 bucket that will host the Iceberg data."
order: 2
title: "S3 Bucket Name"
type: "string"
s3_bucket_region:
always_show: true
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"
examples:
- "us-east-1"
order: 3
title: "S3 Bucket Region"
type: "string"
s3_endpoint:
description: "Your S3 endpoint url. Read more here"
order: 4
title: "S3 Endpoint"
type: "string"
secret_access_key:
airbyte_secret: true
always_show: true
description: "The AWS Secret Access Key paired with the Access Key ID for\
\ AWS authentication."
order: 1
title: "AWS Secret Access Key"
type: "string"
x-speakeasy-param-sensitive: true
warehouse_location:
always_show: true
description: "The root location of the data warehouse used by the Iceberg\
\ catalog. Typically includes a bucket name and path within that bucket.\
\ For AWS Glue and Nessie, must include the storage protocol (such as\
\ \"s3://\" for Amazon S3)."
examples:
- "s3://your-bucket/path/to/store/files/in"
order: 5
title: "Warehouse Location"
type: "string"
destinationType:
title: "s3-data-lake"
const: "s3-data-lake"
enum:
- "s3-data-lake"
order: 0
type: "string"
required:
- "s3_bucket_name"
- "s3_bucket_region"
- "warehouse_location"
- "main_branch_name"
- "catalog_type"
- "destinationType"
title: "Iceberg V2 Destination Specification"
type: "object"
destination-s3-data-lake-update:
description: "Defines the configurations required to connect to an Iceberg catalog,\
\ including warehouse location, main branch name, and catalog type specifics."
properties:
access_key_id:
airbyte_secret: true
always_show: true
description: "The AWS Access Key ID with permissions for S3 and Glue operations."
order: 0
title: "AWS Access Key ID"
type: "string"
catalog_type:
always_show: true
description: "Specifies the type of Iceberg catalog (e.g., NESSIE, GLUE,\
\ REST, POLARIS) and its associated configuration."
oneOf:
- additionalProperties: true
description: "Configuration details for connecting to a Nessie-based Iceberg\
\ catalog."
properties:
access_token:
airbyte_secret: true
description: "Optional token for authentication with the Nessie server."
examples:
- "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY"
order: 2
title: "Nessie Access Token"
type: "string"
catalog_type:
default: "NESSIE"
enum:
- "NESSIE"
type: "string"
namespace:
description: "The Nessie namespace to be used in the Table identifier.\
\ \n This will ONLY be used if the `Destination Namespace`\
\ setting for the connection is set to\n `Destination-defined`\
\ or `Source-defined`"
title: "Default namespace"
type: "string"
server_uri:
description: "The base URL of the Nessie server used to connect to\
\ the Nessie catalog."
order: 1
title: "Nessie Server URI"
type: "string"
required:
- "catalog_type"
- "server_uri"
- "namespace"
title: "Nessie Catalog"
type: "object"
- additionalProperties: true
description: "Configuration details for connecting to an AWS Glue-based\
\ Iceberg catalog."
properties:
catalog_type:
default: "GLUE"
enum:
- "GLUE"
type: "string"
database_name:
description: "The Glue database name. This will ONLY be used if the\
\ `Destination Namespace` setting for the connection is set to `Destination-defined`\
\ or `Source-defined`"
title: "Default database"
type: "string"
glue_id:
description: "The AWS Account ID associated with the Glue service\
\ used by the Iceberg catalog."
order: 1
title: "AWS Account ID"
type: "string"
role_arn:
description: "The ARN of the AWS role to assume. Only usable in Airbyte\
\ Cloud."
title: "Role ARN"
type: "string"
required:
- "catalog_type"
- "glue_id"
- "database_name"
title: "Glue Catalog"
type: "object"
- additionalProperties: true
description: "Configuration details for connecting to a REST catalog."
properties:
catalog_type:
default: "REST"
enum:
- "REST"
type: "string"
namespace:
description: "The namespace to be used in the Table identifier. \n\
\ This will ONLY be used if the `Destination Namespace`\
\ setting for the connection is set to\n `Destination-defined`\
\ or `Source-defined`"
title: "Default namespace"
type: "string"
server_uri:
description: "The base URL of the Rest server used to connect to the\
\ Rest catalog."
order: 1
title: "Rest Server URI"
type: "string"
required:
- "catalog_type"
- "server_uri"
- "namespace"
title: "Rest Catalog"
type: "object"
- additionalProperties: true
description: "Configuration details for connecting to an Apache Polaris-based\
\ Iceberg catalog."
properties:
catalog_name:
description: "The name of the catalog in Polaris. This corresponds\
\ to the catalog name created via the Polaris Management API."
order: 2
title: "Polaris Catalog Name"
type: "string"
catalog_type:
default: "POLARIS"
enum:
- "POLARIS"
type: "string"
client_id:
airbyte_secret: true
description: "The OAuth Client ID for authenticating with the Polaris\
\ server."
examples:
- "abc123clientid"
order: 3
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "The OAuth Client Secret for authenticating with the\
\ Polaris server."
examples:
- "secretkey123"
order: 4
title: "Client Secret"
type: "string"
namespace:
description: "The Polaris namespace to be used in the Table identifier.\n\
\ This will ONLY be used if the `Destination Namespace`\
\ setting for the connection is set to\n `Destination-defined`\
\ or `Source-defined`"
order: 5
title: "Default namespace"
type: "string"
server_uri:
description: "The base URL of the Polaris server used to connect to\
\ the Polaris catalog."
order: 1
title: "Polaris Server URI"
type: "string"
required:
- "catalog_type"
- "server_uri"
- "catalog_name"
- "client_id"
- "client_secret"
- "namespace"
title: "Polaris Catalog"
type: "object"
order: 7
title: "Catalog Type"
type: "object"
main_branch_name:
always_show: true
default: "main"
description: "The primary or default branch name in the catalog. Most query\
\ engines will use \"main\" by default. See Iceberg documentation for more information."
order: 6
title: "Main Branch Name"
type: "string"
s3_bucket_name:
always_show: true
description: "The name of the S3 bucket that will host the Iceberg data."
order: 2
title: "S3 Bucket Name"
type: "string"
s3_bucket_region:
always_show: true
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"
examples:
- "us-east-1"
order: 3
title: "S3 Bucket Region"
type: "string"
s3_endpoint:
description: "Your S3 endpoint url. Read more here"
order: 4
title: "S3 Endpoint"
type: "string"
secret_access_key:
airbyte_secret: true
always_show: true
description: "The AWS Secret Access Key paired with the Access Key ID for\
\ AWS authentication."
order: 1
title: "AWS Secret Access Key"
type: "string"
warehouse_location:
always_show: true
description: "The root location of the data warehouse used by the Iceberg\
\ catalog. Typically includes a bucket name and path within that bucket.\
\ For AWS Glue and Nessie, must include the storage protocol (such as\
\ \"s3://\" for Amazon S3)."
examples:
- "s3://your-bucket/path/to/store/files/in"
order: 5
title: "Warehouse Location"
type: "string"
required:
- "s3_bucket_name"
- "s3_bucket_region"
- "warehouse_location"
- "main_branch_name"
- "catalog_type"
title: "Iceberg V2 Destination Specification"
type: "object"
destination-gcs:
properties:
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."
oneOf:
- properties:
credential_type:
default: "HMAC_KEY"
enum:
- "HMAC_KEY"
type: "string"
hmac_key_access_id:
airbyte_secret: true
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."
examples:
- "1234567890abcdefghij1234"
order: 0
title: "Access ID"
type: "string"
x-speakeasy-param-sensitive: true
hmac_key_secret:
airbyte_secret: true
description: "The corresponding secret for the access ID. It is a\
\ 40-character base-64 encoded string. Read more here."
examples:
- "1234567890abcdefghij1234567890ABCDEFGHIJ"
order: 1
title: "Secret"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "credential_type"
- "hmac_key_access_id"
- "hmac_key_secret"
title: "HMAC Key"
order: 0
title: "Authentication"
type: "object"
format:
description: "Output data format. One of the following formats must be selected\
\ - AVRO format, PARQUET format, CSV format, or JSONL format."
oneOf:
- properties:
compression_codec:
description: "The compression algorithm used to compress data. Default\
\ to no compression."
oneOf:
- properties:
codec:
default: "no compression"
enum:
- "no compression"
type: "string"
required:
- "codec"
title: "No Compression"
- properties:
codec:
default: "Deflate"
enum:
- "Deflate"
type: "string"
compression_level:
default: 0
description: "0: no compression & fastest, 9: best compression\
\ & slowest."
maximum: 9
minimum: 0
title: "Deflate level"
type: "integer"
required:
- "codec"
title: "Deflate"
- properties:
codec:
default: "bzip2"
enum:
- "bzip2"
type: "string"
required:
- "codec"
title: "bzip2"
- properties:
codec:
default: "xz"
enum:
- "xz"
type: "string"
compression_level:
default: 6
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."
maximum: 9
minimum: 0
title: "Compression Level"
type: "integer"
required:
- "codec"
title: "xz"
- properties:
codec:
default: "zstandard"
enum:
- "zstandard"
type: "string"
compression_level:
default: 3
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."
maximum: 22
minimum: -5
title: "Compression Level"
type: "integer"
include_checksum:
default: false
description: "If true, include a checksum with each data block."
title: "Include Checksum"
type: "boolean"
required:
- "codec"
title: "zstandard"
- properties:
codec:
default: "snappy"
enum:
- "snappy"
type: "string"
required:
- "codec"
title: "snappy"
title: "Compression Codec"
type: "object"
format_type:
default: "Avro"
enum:
- "Avro"
type: "string"
required:
- "format_type"
- "compression_codec"
title: "Avro: Apache Avro"
- properties:
compression:
description: "Whether the output files should be compressed. If compression\
\ is selected, the output filename will have an extra extension\
\ (GZIP: \".csv.gz\")."
oneOf:
- properties:
compression_type:
default: "No Compression"
enum:
- "No Compression"
type: "string"
requires:
- "compression_type"
title: "No Compression"
- properties:
compression_type:
default: "GZIP"
enum:
- "GZIP"
type: "string"
requires:
- "compression_type"
title: "GZIP"
title: "Compression"
type: "object"
flattening:
default: "No flattening"
description: "Whether the input JSON data should be normalized (flattened)\
\ in the output CSV. Please refer to docs for details."
enum:
- "No flattening"
- "Root level flattening"
title: "Normalization"
type: "string"
format_type:
default: "CSV"
enum:
- "CSV"
type: "string"
required:
- "format_type"
title: "CSV: Comma-Separated Values"
- properties:
compression:
description: "Whether the output files should be compressed. If compression\
\ is selected, the output filename will have an extra extension\
\ (GZIP: \".jsonl.gz\")."
oneOf:
- properties:
compression_type:
default: "No Compression"
enum:
- "No Compression"
type: "string"
requires: "compression_type"
title: "No Compression"
- properties:
compression_type:
default: "GZIP"
enum:
- "GZIP"
type: "string"
requires: "compression_type"
title: "GZIP"
title: "Compression"
type: "object"
format_type:
default: "JSONL"
enum:
- "JSONL"
type: "string"
required:
- "format_type"
title: "JSON Lines: newline-delimited JSON"
- properties:
block_size_mb:
default: 128
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."
examples:
- 128
title: "Block Size (Row Group Size) (MB)"
type: "integer"
compression_codec:
default: "UNCOMPRESSED"
description: "The compression algorithm used to compress data pages."
enum:
- "UNCOMPRESSED"
- "SNAPPY"
- "GZIP"
- "LZO"
- "BROTLI"
- "LZ4"
- "ZSTD"
title: "Compression Codec"
type: "string"
dictionary_encoding:
default: true
description: "Default: true."
title: "Dictionary Encoding"
type: "boolean"
dictionary_page_size_kb:
default: 1024
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."
examples:
- 1024
title: "Dictionary Page Size (KB)"
type: "integer"
format_type:
default: "Parquet"
enum:
- "Parquet"
type: "string"
max_padding_size_mb:
default: 8
description: "Maximum size allowed as padding to align row groups.\
\ This is also the minimum size of a row group. Default: 8 MB."
examples:
- 8
title: "Max Padding Size (MB)"
type: "integer"
page_size_kb:
default: 1024
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."
examples:
- 1024
title: "Page Size (KB)"
type: "integer"
required:
- "format_type"
title: "Parquet: Columnar Storage"
order: 4
title: "Output Format"
type: "object"
gcs_bucket_name:
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"
order: 1
title: "GCS Bucket Name"
type: "string"
gcs_bucket_path:
description: "GCS Bucket Path string Subdirectory under the above bucket\
\ to sync the data into."
examples:
- "data_sync/test"
order: 2
title: "GCS Bucket Path"
type: "string"
gcs_bucket_region:
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"
order: 3
title: "GCS Bucket Region"
type: "string"
destinationType:
title: "gcs"
const: "gcs"
enum:
- "gcs"
order: 0
type: "string"
required:
- "gcs_bucket_name"
- "gcs_bucket_path"
- "credential"
- "format"
- "destinationType"
title: "GCS Destination Spec"
type: "object"
destination-gcs-update:
properties:
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."
oneOf:
- properties:
credential_type:
default: "HMAC_KEY"
enum:
- "HMAC_KEY"
type: "string"
hmac_key_access_id:
airbyte_secret: true
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."
examples:
- "1234567890abcdefghij1234"
order: 0
title: "Access ID"
type: "string"
hmac_key_secret:
airbyte_secret: true
description: "The corresponding secret for the access ID. It is a\
\ 40-character base-64 encoded string. Read more here."
examples:
- "1234567890abcdefghij1234567890ABCDEFGHIJ"
order: 1
title: "Secret"
type: "string"
required:
- "credential_type"
- "hmac_key_access_id"
- "hmac_key_secret"
title: "HMAC Key"
order: 0
title: "Authentication"
type: "object"
format:
description: "Output data format. One of the following formats must be selected\
\ - AVRO format, PARQUET format, CSV format, or JSONL format."
oneOf:
- properties:
compression_codec:
description: "The compression algorithm used to compress data. Default\
\ to no compression."
oneOf:
- properties:
codec:
default: "no compression"
enum:
- "no compression"
type: "string"
required:
- "codec"
title: "No Compression"
- properties:
codec:
default: "Deflate"
enum:
- "Deflate"
type: "string"
compression_level:
default: 0
description: "0: no compression & fastest, 9: best compression\
\ & slowest."
maximum: 9
minimum: 0
title: "Deflate level"
type: "integer"
required:
- "codec"
title: "Deflate"
- properties:
codec:
default: "bzip2"
enum:
- "bzip2"
type: "string"
required:
- "codec"
title: "bzip2"
- properties:
codec:
default: "xz"
enum:
- "xz"
type: "string"
compression_level:
default: 6
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."
maximum: 9
minimum: 0
title: "Compression Level"
type: "integer"
required:
- "codec"
title: "xz"
- properties:
codec:
default: "zstandard"
enum:
- "zstandard"
type: "string"
compression_level:
default: 3
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."
maximum: 22
minimum: -5
title: "Compression Level"
type: "integer"
include_checksum:
default: false
description: "If true, include a checksum with each data block."
title: "Include Checksum"
type: "boolean"
required:
- "codec"
title: "zstandard"
- properties:
codec:
default: "snappy"
enum:
- "snappy"
type: "string"
required:
- "codec"
title: "snappy"
title: "Compression Codec"
type: "object"
format_type:
default: "Avro"
enum:
- "Avro"
type: "string"
required:
- "format_type"
- "compression_codec"
title: "Avro: Apache Avro"
- properties:
compression:
description: "Whether the output files should be compressed. If compression\
\ is selected, the output filename will have an extra extension\
\ (GZIP: \".csv.gz\")."
oneOf:
- properties:
compression_type:
default: "No Compression"
enum:
- "No Compression"
type: "string"
requires:
- "compression_type"
title: "No Compression"
- properties:
compression_type:
default: "GZIP"
enum:
- "GZIP"
type: "string"
requires:
- "compression_type"
title: "GZIP"
title: "Compression"
type: "object"
flattening:
default: "No flattening"
description: "Whether the input JSON data should be normalized (flattened)\
\ in the output CSV. Please refer to docs for details."
enum:
- "No flattening"
- "Root level flattening"
title: "Normalization"
type: "string"
format_type:
default: "CSV"
enum:
- "CSV"
type: "string"
required:
- "format_type"
title: "CSV: Comma-Separated Values"
- properties:
compression:
description: "Whether the output files should be compressed. If compression\
\ is selected, the output filename will have an extra extension\
\ (GZIP: \".jsonl.gz\")."
oneOf:
- properties:
compression_type:
default: "No Compression"
enum:
- "No Compression"
type: "string"
requires: "compression_type"
title: "No Compression"
- properties:
compression_type:
default: "GZIP"
enum:
- "GZIP"
type: "string"
requires: "compression_type"
title: "GZIP"
title: "Compression"
type: "object"
format_type:
default: "JSONL"
enum:
- "JSONL"
type: "string"
required:
- "format_type"
title: "JSON Lines: newline-delimited JSON"
- properties:
block_size_mb:
default: 128
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."
examples:
- 128
title: "Block Size (Row Group Size) (MB)"
type: "integer"
compression_codec:
default: "UNCOMPRESSED"
description: "The compression algorithm used to compress data pages."
enum:
- "UNCOMPRESSED"
- "SNAPPY"
- "GZIP"
- "LZO"
- "BROTLI"
- "LZ4"
- "ZSTD"
title: "Compression Codec"
type: "string"
dictionary_encoding:
default: true
description: "Default: true."
title: "Dictionary Encoding"
type: "boolean"
dictionary_page_size_kb:
default: 1024
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."
examples:
- 1024
title: "Dictionary Page Size (KB)"
type: "integer"
format_type:
default: "Parquet"
enum:
- "Parquet"
type: "string"
max_padding_size_mb:
default: 8
description: "Maximum size allowed as padding to align row groups.\
\ This is also the minimum size of a row group. Default: 8 MB."
examples:
- 8
title: "Max Padding Size (MB)"
type: "integer"
page_size_kb:
default: 1024
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."
examples:
- 1024
title: "Page Size (KB)"
type: "integer"
required:
- "format_type"
title: "Parquet: Columnar Storage"
order: 4
title: "Output Format"
type: "object"
gcs_bucket_name:
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"
order: 1
title: "GCS Bucket Name"
type: "string"
gcs_bucket_path:
description: "GCS Bucket Path string Subdirectory under the above bucket\
\ to sync the data into."
examples:
- "data_sync/test"
order: 2
title: "GCS Bucket Path"
type: "string"
gcs_bucket_region:
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"
order: 3
title: "GCS Bucket Region"
type: "string"
required:
- "gcs_bucket_name"
- "gcs_bucket_path"
- "credential"
- "format"
title: "GCS Destination Spec"
type: "object"
destination-pubsub:
properties:
batching_delay_threshold:
default: 1
description: "Number of ms before the buffer is flushed"
minimum: 1
title: "Message Batching: Delay Threshold"
type: "integer"
batching_element_count_threshold:
default: 1
description: "Number of messages before the buffer is flushed"
minimum: 1
title: "Message Batching: Element Count Threshold"
type: "integer"
batching_enabled:
default: false
description: "If TRUE messages will be buffered instead of sending them\
\ one by one"
title: "Message Batching Enabled"
type: "boolean"
batching_request_bytes_threshold:
default: 1
description: "Number of bytes before the buffer is flushed"
minimum: 1
title: "Message Batching: Request Bytes Threshold"
type: "integer"
credentials_json:
airbyte_secret: true
description: "The contents of the JSON service account key. Check out the\
\ docs if you need help generating this key."
title: "Credentials JSON"
type: "string"
x-speakeasy-param-sensitive: true
ordering_enabled:
default: false
description: "If TRUE PubSub publisher will have message ordering enabled. Every message will have an ordering key\
\ of stream"
title: "Message Ordering Enabled"
type: "boolean"
project_id:
description: "The GCP project ID for the project containing the target PubSub."
title: "Project ID"
type: "string"
topic_id:
description: "The PubSub topic ID in the given GCP project ID."
title: "PubSub Topic ID"
type: "string"
destinationType:
title: "pubsub"
const: "pubsub"
enum:
- "pubsub"
order: 0
type: "string"
required:
- "project_id"
- "topic_id"
- "credentials_json"
- "ordering_enabled"
- "batching_enabled"
- "destinationType"
title: "Google PubSub Destination Spec"
type: "object"
destination-pubsub-update:
properties:
batching_delay_threshold:
default: 1
description: "Number of ms before the buffer is flushed"
minimum: 1
title: "Message Batching: Delay Threshold"
type: "integer"
batching_element_count_threshold:
default: 1
description: "Number of messages before the buffer is flushed"
minimum: 1
title: "Message Batching: Element Count Threshold"
type: "integer"
batching_enabled:
default: false
description: "If TRUE messages will be buffered instead of sending them\
\ one by one"
title: "Message Batching Enabled"
type: "boolean"
batching_request_bytes_threshold:
default: 1
description: "Number of bytes before the buffer is flushed"
minimum: 1
title: "Message Batching: Request Bytes Threshold"
type: "integer"
credentials_json:
airbyte_secret: true
description: "The contents of the JSON service account key. Check out the\
\ docs if you need help generating this key."
title: "Credentials JSON"
type: "string"
ordering_enabled:
default: false
description: "If TRUE PubSub publisher will have message ordering enabled. Every message will have an ordering key\
\ of stream"
title: "Message Ordering Enabled"
type: "boolean"
project_id:
description: "The GCP project ID for the project containing the target PubSub."
title: "Project ID"
type: "string"
topic_id:
description: "The PubSub topic ID in the given GCP project ID."
title: "PubSub Topic ID"
type: "string"
required:
- "project_id"
- "topic_id"
- "credentials_json"
- "ordering_enabled"
- "batching_enabled"
title: "Google PubSub Destination Spec"
type: "object"
destination-deepset:
properties:
api_key:
airbyte_secret: true
description: "Your deepset cloud API key"
order: 0
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
base_url:
default: "https://api.cloud.deepset.ai"
description: "URL of deepset Cloud API (e.g. https://api.cloud.deepset.ai,\
\ https://api.us.deepset.ai, etc). Defaults to https://api.cloud.deepset.ai."
order: 1
title: "Base URL"
type: "string"
retries:
default: 5
description: "Number of times to retry an action before giving up."
order: 3
title: "Retry Count"
type: "number"
workspace:
description: "Name of workspace to which to sync the data."
order: 2
title: "Workspace Name"
type: "string"
destinationType:
title: "deepset"
const: "deepset"
enum:
- "deepset"
order: 0
type: "string"
required:
- "api_key"
- "workspace"
- "destinationType"
title: "Deepset Destination Spec"
type: "object"
destination-deepset-update:
properties:
api_key:
airbyte_secret: true
description: "Your deepset cloud API key"
order: 0
title: "API Key"
type: "string"
base_url:
default: "https://api.cloud.deepset.ai"
description: "URL of deepset Cloud API (e.g. https://api.cloud.deepset.ai,\
\ https://api.us.deepset.ai, etc). Defaults to https://api.cloud.deepset.ai."
order: 1
title: "Base URL"
type: "string"
retries:
default: 5
description: "Number of times to retry an action before giving up."
order: 3
title: "Retry Count"
type: "number"
workspace:
description: "Name of workspace to which to sync the data."
order: 2
title: "Workspace Name"
type: "string"
required:
- "api_key"
- "workspace"
title: "Deepset Destination Spec"
type: "object"
destination-weaviate:
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."
groups:
- id: "processing"
title: "Processing"
- id: "embedding"
title: "Embedding"
- id: "indexing"
title: "Indexing"
- id: "advanced"
title: "Advanced"
properties:
embedding:
description: "Embedding configuration"
group: "embedding"
oneOf:
- 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."
properties:
mode:
const: "no_embedding"
default: "no_embedding"
enum:
- "no_embedding"
title: "Mode"
type: "string"
required:
- "mode"
title: "No external embedding"
type: "object"
- description: "Use the Azure-hosted OpenAI API to embed text. This option\
\ is using the text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
api_base:
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"
title: "Resource base URL"
type: "string"
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"
title: "Deployment"
type: "string"
mode:
const: "azure_openai"
default: "azure_openai"
enum:
- "azure_openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
description: "The API key for your Azure OpenAI resource. You can\
\ find this in the Azure portal under your Azure OpenAI resource"
title: "Azure OpenAI API key"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "openai_key"
- "api_base"
- "deployment"
- "mode"
title: "Azure OpenAI"
type: "object"
- description: "Use the OpenAI API to embed text. This option is using the\
\ text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
mode:
const: "openai"
default: "openai"
enum:
- "openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
title: "OpenAI API key"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "openai_key"
- "mode"
title: "OpenAI"
type: "object"
- description: "Use the Cohere API to embed text."
properties:
cohere_key:
airbyte_secret: true
title: "Cohere API key"
type: "string"
x-speakeasy-param-sensitive: true
mode:
const: "cohere"
default: "cohere"
enum:
- "cohere"
title: "Mode"
type: "string"
required:
- "cohere_key"
- "mode"
title: "Cohere"
type: "object"
- 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."
properties:
dimensions:
description: "The number of dimensions the embedding model is generating"
examples:
- 1536
- 384
title: "Embedding dimensions"
type: "integer"
field_name:
description: "Name of the field in the record that contains the embedding"
examples:
- "embedding"
- "vector"
title: "Field name"
type: "string"
mode:
const: "from_field"
default: "from_field"
enum:
- "from_field"
title: "Mode"
type: "string"
required:
- "field_name"
- "dimensions"
- "mode"
title: "From Field"
type: "object"
- 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."
properties:
mode:
const: "fake"
default: "fake"
enum:
- "fake"
title: "Mode"
type: "string"
required:
- "mode"
title: "Fake"
type: "object"
- description: "Use a service that's compatible with the OpenAI API to embed\
\ text."
properties:
api_key:
airbyte_secret: true
default: ""
title: "API key"
type: "string"
x-speakeasy-param-sensitive: true
base_url:
description: "The base URL for your OpenAI-compatible service"
examples:
- "https://your-service-name.com"
title: "Base URL"
type: "string"
dimensions:
description: "The number of dimensions the embedding model is generating"
examples:
- 1536
- 384
title: "Embedding dimensions"
type: "integer"
mode:
const: "openai_compatible"
default: "openai_compatible"
enum:
- "openai_compatible"
title: "Mode"
type: "string"
model_name:
default: "text-embedding-ada-002"
description: "The name of the model to use for embedding"
examples:
- "text-embedding-ada-002"
title: "Model name"
type: "string"
required:
- "base_url"
- "dimensions"
- "mode"
title: "OpenAI-compatible"
type: "object"
title: "Embedding"
type: "object"
indexing:
description: "Indexing configuration"
group: "indexing"
properties:
additional_headers:
default: []
description: "Additional HTTP headers to send with every request."
examples:
- header_key: "X-OpenAI-Api-Key"
value: "my-openai-api-key"
items:
properties:
header_key:
title: "Header Key"
type: "string"
value:
airbyte_secret: true
title: "Header Value"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "header_key"
- "value"
title: "Header"
type: "object"
title: "Additional headers"
type: "array"
auth:
description: "Authentication method"
oneOf:
- description: "Authenticate using an API token (suitable for Weaviate\
\ Cloud)"
properties:
mode:
const: "token"
default: "token"
enum:
- "token"
title: "Mode"
type: "string"
token:
airbyte_secret: true
description: "API Token for the Weaviate instance"
title: "API Token"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "token"
- "mode"
title: "API Token"
type: "object"
- description: "Authenticate using username and password (suitable for\
\ self-managed Weaviate clusters)"
properties:
mode:
const: "username_password"
default: "username_password"
enum:
- "username_password"
title: "Mode"
type: "string"
password:
airbyte_secret: true
description: "Password for the Weaviate cluster"
order: 2
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
username:
description: "Username for the Weaviate cluster"
order: 1
title: "Username"
type: "string"
required:
- "username"
- "password"
- "mode"
title: "Username/Password"
type: "object"
- description: "Do not authenticate (suitable for locally running test\
\ clusters, do not use for clusters with public IP addresses)"
properties:
mode:
const: "no_auth"
default: "no_auth"
enum:
- "no_auth"
title: "Mode"
type: "string"
required:
- "mode"
title: "No Authentication"
type: "object"
order: 2
title: "Authentication"
type: "object"
batch_size:
default: 128
description: "The number of records to send to Weaviate in each batch"
title: "Batch Size"
type: "integer"
default_vectorizer:
default: "none"
description: "The vectorizer to use if new classes need to be created"
enum:
- "none"
- "text2vec-cohere"
- "text2vec-huggingface"
- "text2vec-openai"
- "text2vec-palm"
- "text2vec-contextionary"
- "text2vec-transformers"
- "text2vec-gpt4all"
title: "Default Vectorizer"
type: "string"
host:
description: "The public endpoint of the Weaviate cluster."
examples:
- "https://my-cluster.weaviate.network"
order: 1
title: "Public Endpoint"
type: "string"
tenant_id:
airbyte_secret: true
default: ""
description: "The tenant ID to use for multi tenancy"
title: "Tenant ID"
type: "string"
x-speakeasy-param-sensitive: true
text_field:
default: "text"
description: "The field in the object that contains the embedded text"
title: "Text Field"
type: "string"
required:
- "host"
- "auth"
title: "Indexing"
type: "object"
omit_raw_text:
default: false
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."
group: "advanced"
title: "Do not store raw text"
type: "boolean"
processing:
group: "processing"
properties:
chunk_overlap:
default: 0
description: "Size of overlap between chunks in tokens to store in vector\
\ store to better capture relevant context"
title: "Chunk overlap"
type: "integer"
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
title: "Chunk size"
type: "integer"
field_name_mappings:
default: []
description: "List of fields to rename. Not applicable for nested fields,\
\ but can be used to rename fields already flattened via dot notation."
items:
properties:
from_field:
description: "The field name in the source"
title: "From field name"
type: "string"
to_field:
description: "The field name to use in the destination"
title: "To field name"
type: "string"
required:
- "from_field"
- "to_field"
title: "FieldNameMappingConfigModel"
type: "object"
title: "Field name mappings"
type: "array"
metadata_fields:
always_show: true
default: []
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."
examples:
- "age"
- "user"
- "user.name"
items:
type: "string"
title: "Fields to store as metadata"
type: "array"
text_fields:
always_show: true
default: []
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."
examples:
- "text"
- "user.name"
- "users.*.name"
items:
type: "string"
title: "Text fields to embed"
type: "array"
text_splitter:
description: "Split text fields into chunks based on the specified method."
oneOf:
- 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."
properties:
keep_separator:
default: false
description: "Whether to keep the separator in the resulting chunks"
title: "Keep separator"
type: "boolean"
mode:
const: "separator"
default: "separator"
enum:
- "separator"
title: "Mode"
type: "string"
separators:
default:
- "\"\\n\\n\""
- "\"\\n\""
- "\" \""
- "\"\""
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\"."
items:
type: "string"
title: "Separators"
type: "array"
required:
- "mode"
title: "By Separator"
type: "object"
- 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."
properties:
mode:
const: "markdown"
default: "markdown"
enum:
- "markdown"
title: "Mode"
type: "string"
split_level:
default: 1
description: "Level of markdown headers to split text fields by.\
\ Headings down to the specified level will be used as split\
\ points"
maximum: 6
minimum: 1
title: "Split level"
type: "integer"
required:
- "mode"
title: "By Markdown header"
type: "object"
- description: "Split the text by suitable delimiters based on the programming\
\ language. This is useful for splitting code into chunks."
properties:
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"
title: "Language"
type: "string"
mode:
const: "code"
default: "code"
enum:
- "code"
title: "Mode"
type: "string"
required:
- "language"
- "mode"
title: "By Programming Language"
type: "object"
title: "Text splitter"
type: "object"
required:
- "chunk_size"
title: "ProcessingConfigModel"
type: "object"
destinationType:
title: "weaviate"
const: "weaviate"
enum:
- "weaviate"
order: 0
type: "string"
required:
- "embedding"
- "processing"
- "indexing"
- "destinationType"
title: "Destination Config"
type: "object"
destination-weaviate-update:
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."
groups:
- id: "processing"
title: "Processing"
- id: "embedding"
title: "Embedding"
- id: "indexing"
title: "Indexing"
- id: "advanced"
title: "Advanced"
properties:
embedding:
description: "Embedding configuration"
group: "embedding"
oneOf:
- 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."
properties:
mode:
const: "no_embedding"
default: "no_embedding"
enum:
- "no_embedding"
title: "Mode"
type: "string"
required:
- "mode"
title: "No external embedding"
type: "object"
- description: "Use the Azure-hosted OpenAI API to embed text. This option\
\ is using the text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
api_base:
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"
title: "Resource base URL"
type: "string"
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"
title: "Deployment"
type: "string"
mode:
const: "azure_openai"
default: "azure_openai"
enum:
- "azure_openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
description: "The API key for your Azure OpenAI resource. You can\
\ find this in the Azure portal under your Azure OpenAI resource"
title: "Azure OpenAI API key"
type: "string"
required:
- "openai_key"
- "api_base"
- "deployment"
- "mode"
title: "Azure OpenAI"
type: "object"
- description: "Use the OpenAI API to embed text. This option is using the\
\ text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
mode:
const: "openai"
default: "openai"
enum:
- "openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
title: "OpenAI API key"
type: "string"
required:
- "openai_key"
- "mode"
title: "OpenAI"
type: "object"
- description: "Use the Cohere API to embed text."
properties:
cohere_key:
airbyte_secret: true
title: "Cohere API key"
type: "string"
mode:
const: "cohere"
default: "cohere"
enum:
- "cohere"
title: "Mode"
type: "string"
required:
- "cohere_key"
- "mode"
title: "Cohere"
type: "object"
- 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."
properties:
dimensions:
description: "The number of dimensions the embedding model is generating"
examples:
- 1536
- 384
title: "Embedding dimensions"
type: "integer"
field_name:
description: "Name of the field in the record that contains the embedding"
examples:
- "embedding"
- "vector"
title: "Field name"
type: "string"
mode:
const: "from_field"
default: "from_field"
enum:
- "from_field"
title: "Mode"
type: "string"
required:
- "field_name"
- "dimensions"
- "mode"
title: "From Field"
type: "object"
- 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."
properties:
mode:
const: "fake"
default: "fake"
enum:
- "fake"
title: "Mode"
type: "string"
required:
- "mode"
title: "Fake"
type: "object"
- description: "Use a service that's compatible with the OpenAI API to embed\
\ text."
properties:
api_key:
airbyte_secret: true
default: ""
title: "API key"
type: "string"
base_url:
description: "The base URL for your OpenAI-compatible service"
examples:
- "https://your-service-name.com"
title: "Base URL"
type: "string"
dimensions:
description: "The number of dimensions the embedding model is generating"
examples:
- 1536
- 384
title: "Embedding dimensions"
type: "integer"
mode:
const: "openai_compatible"
default: "openai_compatible"
enum:
- "openai_compatible"
title: "Mode"
type: "string"
model_name:
default: "text-embedding-ada-002"
description: "The name of the model to use for embedding"
examples:
- "text-embedding-ada-002"
title: "Model name"
type: "string"
required:
- "base_url"
- "dimensions"
- "mode"
title: "OpenAI-compatible"
type: "object"
title: "Embedding"
type: "object"
indexing:
description: "Indexing configuration"
group: "indexing"
properties:
additional_headers:
default: []
description: "Additional HTTP headers to send with every request."
examples:
- header_key: "X-OpenAI-Api-Key"
value: "my-openai-api-key"
items:
properties:
header_key:
title: "Header Key"
type: "string"
value:
airbyte_secret: true
title: "Header Value"
type: "string"
required:
- "header_key"
- "value"
title: "Header"
type: "object"
title: "Additional headers"
type: "array"
auth:
description: "Authentication method"
oneOf:
- description: "Authenticate using an API token (suitable for Weaviate\
\ Cloud)"
properties:
mode:
const: "token"
default: "token"
enum:
- "token"
title: "Mode"
type: "string"
token:
airbyte_secret: true
description: "API Token for the Weaviate instance"
title: "API Token"
type: "string"
required:
- "token"
- "mode"
title: "API Token"
type: "object"
- description: "Authenticate using username and password (suitable for\
\ self-managed Weaviate clusters)"
properties:
mode:
const: "username_password"
default: "username_password"
enum:
- "username_password"
title: "Mode"
type: "string"
password:
airbyte_secret: true
description: "Password for the Weaviate cluster"
order: 2
title: "Password"
type: "string"
username:
description: "Username for the Weaviate cluster"
order: 1
title: "Username"
type: "string"
required:
- "username"
- "password"
- "mode"
title: "Username/Password"
type: "object"
- description: "Do not authenticate (suitable for locally running test\
\ clusters, do not use for clusters with public IP addresses)"
properties:
mode:
const: "no_auth"
default: "no_auth"
enum:
- "no_auth"
title: "Mode"
type: "string"
required:
- "mode"
title: "No Authentication"
type: "object"
order: 2
title: "Authentication"
type: "object"
batch_size:
default: 128
description: "The number of records to send to Weaviate in each batch"
title: "Batch Size"
type: "integer"
default_vectorizer:
default: "none"
description: "The vectorizer to use if new classes need to be created"
enum:
- "none"
- "text2vec-cohere"
- "text2vec-huggingface"
- "text2vec-openai"
- "text2vec-palm"
- "text2vec-contextionary"
- "text2vec-transformers"
- "text2vec-gpt4all"
title: "Default Vectorizer"
type: "string"
host:
description: "The public endpoint of the Weaviate cluster."
examples:
- "https://my-cluster.weaviate.network"
order: 1
title: "Public Endpoint"
type: "string"
tenant_id:
airbyte_secret: true
default: ""
description: "The tenant ID to use for multi tenancy"
title: "Tenant ID"
type: "string"
text_field:
default: "text"
description: "The field in the object that contains the embedded text"
title: "Text Field"
type: "string"
required:
- "host"
- "auth"
title: "Indexing"
type: "object"
omit_raw_text:
default: false
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."
group: "advanced"
title: "Do not store raw text"
type: "boolean"
processing:
group: "processing"
properties:
chunk_overlap:
default: 0
description: "Size of overlap between chunks in tokens to store in vector\
\ store to better capture relevant context"
title: "Chunk overlap"
type: "integer"
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
title: "Chunk size"
type: "integer"
field_name_mappings:
default: []
description: "List of fields to rename. Not applicable for nested fields,\
\ but can be used to rename fields already flattened via dot notation."
items:
properties:
from_field:
description: "The field name in the source"
title: "From field name"
type: "string"
to_field:
description: "The field name to use in the destination"
title: "To field name"
type: "string"
required:
- "from_field"
- "to_field"
title: "FieldNameMappingConfigModel"
type: "object"
title: "Field name mappings"
type: "array"
metadata_fields:
always_show: true
default: []
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."
examples:
- "age"
- "user"
- "user.name"
items:
type: "string"
title: "Fields to store as metadata"
type: "array"
text_fields:
always_show: true
default: []
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."
examples:
- "text"
- "user.name"
- "users.*.name"
items:
type: "string"
title: "Text fields to embed"
type: "array"
text_splitter:
description: "Split text fields into chunks based on the specified method."
oneOf:
- 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."
properties:
keep_separator:
default: false
description: "Whether to keep the separator in the resulting chunks"
title: "Keep separator"
type: "boolean"
mode:
const: "separator"
default: "separator"
enum:
- "separator"
title: "Mode"
type: "string"
separators:
default:
- "\"\\n\\n\""
- "\"\\n\""
- "\" \""
- "\"\""
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\"."
items:
type: "string"
title: "Separators"
type: "array"
required:
- "mode"
title: "By Separator"
type: "object"
- 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."
properties:
mode:
const: "markdown"
default: "markdown"
enum:
- "markdown"
title: "Mode"
type: "string"
split_level:
default: 1
description: "Level of markdown headers to split text fields by.\
\ Headings down to the specified level will be used as split\
\ points"
maximum: 6
minimum: 1
title: "Split level"
type: "integer"
required:
- "mode"
title: "By Markdown header"
type: "object"
- description: "Split the text by suitable delimiters based on the programming\
\ language. This is useful for splitting code into chunks."
properties:
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"
title: "Language"
type: "string"
mode:
const: "code"
default: "code"
enum:
- "code"
title: "Mode"
type: "string"
required:
- "language"
- "mode"
title: "By Programming Language"
type: "object"
title: "Text splitter"
type: "object"
required:
- "chunk_size"
title: "ProcessingConfigModel"
type: "object"
required:
- "embedding"
- "processing"
- "indexing"
title: "Destination Config"
type: "object"
destination-vectara:
description: "Configuration to connect to the Vectara instance"
groups:
- id: "account"
title: "Account"
- id: "auth"
title: "Authentication"
properties:
corpus_name:
description: "The Name of Corpus to load data into"
group: "account"
order: 3
title: "Corpus Name"
type: "string"
customer_id:
description: "Your customer id as it is in the authenticaion url"
group: "account"
order: 2
title: "Customer ID"
type: "string"
metadata_fields:
always_show: true
default: []
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."
examples:
- "age"
- "user"
items:
type: "string"
title: "Fields to store as metadata"
type: "array"
oauth2:
description: "OAuth2.0 credentials used to authenticate admin actions (creating/deleting\
\ corpora)"
group: "auth"
properties:
client_id:
description: "OAuth2.0 client id"
order: 0
title: "OAuth Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "OAuth2.0 client secret"
order: 1
title: "OAuth Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "client_id"
- "client_secret"
title: "OAuth2.0 Credentials"
type: "object"
parallelize:
always_show: true
default: false
description: "Parallelize indexing into Vectara with multiple threads"
group: "account"
title: "Parallelize"
type: "boolean"
text_fields:
always_show: true
default: []
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."
examples:
- "text"
- "user.name"
- "users.*.name"
items:
type: "string"
title: "Text fields to index with Vectara"
type: "array"
title_field:
always_show: true
default: ""
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."
examples:
- "document_key"
title: "Text field to use as document title with Vectara"
type: "string"
destinationType:
title: "vectara"
const: "vectara"
enum:
- "vectara"
order: 0
type: "string"
required:
- "oauth2"
- "customer_id"
- "corpus_name"
- "destinationType"
title: "Vectara Config"
type: "object"
destination-vectara-update:
description: "Configuration to connect to the Vectara instance"
groups:
- id: "account"
title: "Account"
- id: "auth"
title: "Authentication"
properties:
corpus_name:
description: "The Name of Corpus to load data into"
group: "account"
order: 3
title: "Corpus Name"
type: "string"
customer_id:
description: "Your customer id as it is in the authenticaion url"
group: "account"
order: 2
title: "Customer ID"
type: "string"
metadata_fields:
always_show: true
default: []
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."
examples:
- "age"
- "user"
items:
type: "string"
title: "Fields to store as metadata"
type: "array"
oauth2:
description: "OAuth2.0 credentials used to authenticate admin actions (creating/deleting\
\ corpora)"
group: "auth"
properties:
client_id:
description: "OAuth2.0 client id"
order: 0
title: "OAuth Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "OAuth2.0 client secret"
order: 1
title: "OAuth Client Secret"
type: "string"
required:
- "client_id"
- "client_secret"
title: "OAuth2.0 Credentials"
type: "object"
parallelize:
always_show: true
default: false
description: "Parallelize indexing into Vectara with multiple threads"
group: "account"
title: "Parallelize"
type: "boolean"
text_fields:
always_show: true
default: []
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."
examples:
- "text"
- "user.name"
- "users.*.name"
items:
type: "string"
title: "Text fields to index with Vectara"
type: "array"
title_field:
always_show: true
default: ""
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."
examples:
- "document_key"
title: "Text field to use as document title with Vectara"
type: "string"
required:
- "oauth2"
- "customer_id"
- "corpus_name"
title: "Vectara Config"
type: "object"
destination-dev-null:
properties:
test_destination:
description: "The type of destination to be used"
oneOf:
- additionalProperties: true
properties:
logging_config:
description: "Configurate how the messages are logged."
oneOf:
- additionalProperties: true
description: "Log first N entries per stream."
properties:
logging_type:
default: "FirstN"
enum:
- "FirstN"
type: "string"
max_entry_count:
default: 100
description: "Number of entries to log. This destination is\
\ for testing only. So it won't make sense to log infinitely.\
\ The maximum is 1,000 entries."
examples:
- 100
maximum: 1000
minimum: 1
title: "N"
type: "number"
required:
- "logging_type"
- "max_entry_count"
title: "First N Entries"
type: "object"
- additionalProperties: true
description: "For each stream, log every N-th entry with a maximum\
\ cap."
properties:
logging_type:
default: "EveryNth"
enum:
- "EveryNth"
type: "string"
max_entry_count:
default: 100
description: "Number of entries to log. This destination is\
\ for testing only. So it won't make sense to log infinitely.\
\ The maximum is 1,000 entries."
examples:
- 100
maximum: 1000
minimum: 1
title: "Max Log Entries"
type: "number"
nth_entry_to_log:
description: "The N-th entry to log for each stream. N starts\
\ from 1. For example, when N = 1, every entry is logged;\
\ when N = 2, every other entry is logged; when N = 3, one\
\ out of three entries is logged."
examples:
- 3
maximum: 1000
minimum: 1
title: "N"
type: "integer"
required:
- "logging_type"
- "nth_entry_to_log"
- "max_entry_count"
title: "Every N-th Entry"
type: "object"
- additionalProperties: true
description: "For each stream, randomly log a percentage of the\
\ entries with a maximum cap."
properties:
logging_type:
default: "RandomSampling"
enum:
- "RandomSampling"
type: "string"
max_entry_count:
default: 100
description: "Number of entries to log. This destination is\
\ for testing only. So it won't make sense to log infinitely.\
\ The maximum is 1,000 entries."
examples:
- 100
maximum: 1000
minimum: 1
title: "Max Log Entries"
type: "number"
sampling_ratio:
default: 0.001
description: "A positive floating number smaller than 1."
examples:
- 0.001
maximum: 1
minimum: 0
title: "Sampling Ratio"
type: "number"
seed:
description: "When the seed is unspecified, the current time\
\ millis will be used as the seed."
examples:
- 1900
title: "Random Number Generator Seed"
type: "number"
required:
- "logging_type"
- "sampling_ratio"
- "max_entry_count"
title: "Random Sampling"
type: "object"
title: "Logging Configuration"
type: "object"
test_destination_type:
default: "LOGGING"
enum:
- "LOGGING"
type: "string"
required:
- "test_destination_type"
- "logging_config"
title: "Logging"
type: "object"
- additionalProperties: true
properties:
test_destination_type:
default: "SILENT"
enum:
- "SILENT"
type: "string"
required:
- "test_destination_type"
title: "Silent"
type: "object"
- additionalProperties: true
properties:
millis_per_record:
description: "The number of milliseconds to wait between each record."
type: "integer"
test_destination_type:
default: "THROTTLED"
enum:
- "THROTTLED"
type: "string"
required:
- "test_destination_type"
- "millis_per_record"
title: "Throttled"
type: "object"
- additionalProperties: true
properties:
num_messages:
description: "Number of messages after which to fail."
type: "integer"
test_destination_type:
default: "FAILING"
enum:
- "FAILING"
type: "string"
required:
- "test_destination_type"
- "num_messages"
title: "Failing"
type: "object"
title: "Test Destination"
type: "object"
destinationType:
title: "dev-null"
const: "dev-null"
enum:
- "dev-null"
order: 0
type: "string"
required:
- "test_destination"
- "destinationType"
title: "E2E Test Destination Spec"
type: "object"
destination-dev-null-update:
properties:
test_destination:
description: "The type of destination to be used"
oneOf:
- additionalProperties: true
properties:
logging_config:
description: "Configurate how the messages are logged."
oneOf:
- additionalProperties: true
description: "Log first N entries per stream."
properties:
logging_type:
default: "FirstN"
enum:
- "FirstN"
type: "string"
max_entry_count:
default: 100
description: "Number of entries to log. This destination is\
\ for testing only. So it won't make sense to log infinitely.\
\ The maximum is 1,000 entries."
examples:
- 100
maximum: 1000
minimum: 1
title: "N"
type: "number"
required:
- "logging_type"
- "max_entry_count"
title: "First N Entries"
type: "object"
- additionalProperties: true
description: "For each stream, log every N-th entry with a maximum\
\ cap."
properties:
logging_type:
default: "EveryNth"
enum:
- "EveryNth"
type: "string"
max_entry_count:
default: 100
description: "Number of entries to log. This destination is\
\ for testing only. So it won't make sense to log infinitely.\
\ The maximum is 1,000 entries."
examples:
- 100
maximum: 1000
minimum: 1
title: "Max Log Entries"
type: "number"
nth_entry_to_log:
description: "The N-th entry to log for each stream. N starts\
\ from 1. For example, when N = 1, every entry is logged;\
\ when N = 2, every other entry is logged; when N = 3, one\
\ out of three entries is logged."
examples:
- 3
maximum: 1000
minimum: 1
title: "N"
type: "integer"
required:
- "logging_type"
- "nth_entry_to_log"
- "max_entry_count"
title: "Every N-th Entry"
type: "object"
- additionalProperties: true
description: "For each stream, randomly log a percentage of the\
\ entries with a maximum cap."
properties:
logging_type:
default: "RandomSampling"
enum:
- "RandomSampling"
type: "string"
max_entry_count:
default: 100
description: "Number of entries to log. This destination is\
\ for testing only. So it won't make sense to log infinitely.\
\ The maximum is 1,000 entries."
examples:
- 100
maximum: 1000
minimum: 1
title: "Max Log Entries"
type: "number"
sampling_ratio:
default: 0.001
description: "A positive floating number smaller than 1."
examples:
- 0.001
maximum: 1
minimum: 0
title: "Sampling Ratio"
type: "number"
seed:
description: "When the seed is unspecified, the current time\
\ millis will be used as the seed."
examples:
- 1900
title: "Random Number Generator Seed"
type: "number"
required:
- "logging_type"
- "sampling_ratio"
- "max_entry_count"
title: "Random Sampling"
type: "object"
title: "Logging Configuration"
type: "object"
test_destination_type:
default: "LOGGING"
enum:
- "LOGGING"
type: "string"
required:
- "test_destination_type"
- "logging_config"
title: "Logging"
type: "object"
- additionalProperties: true
properties:
test_destination_type:
default: "SILENT"
enum:
- "SILENT"
type: "string"
required:
- "test_destination_type"
title: "Silent"
type: "object"
- additionalProperties: true
properties:
millis_per_record:
description: "The number of milliseconds to wait between each record."
type: "integer"
test_destination_type:
default: "THROTTLED"
enum:
- "THROTTLED"
type: "string"
required:
- "test_destination_type"
- "millis_per_record"
title: "Throttled"
type: "object"
- additionalProperties: true
properties:
num_messages:
description: "Number of messages after which to fail."
type: "integer"
test_destination_type:
default: "FAILING"
enum:
- "FAILING"
type: "string"
required:
- "test_destination_type"
- "num_messages"
title: "Failing"
type: "object"
title: "Test Destination"
type: "object"
required:
- "test_destination"
title: "E2E Test Destination Spec"
type: "object"
destination-snowflake-cortex:
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."
groups:
- id: "processing"
title: "Processing"
- id: "embedding"
title: "Embedding"
- id: "indexing"
title: "Indexing"
- id: "advanced"
title: "Advanced"
properties:
embedding:
description: "Embedding configuration"
group: "embedding"
oneOf:
- description: "Use the OpenAI API to embed text. This option is using the\
\ text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
mode:
const: "openai"
default: "openai"
enum:
- "openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
title: "OpenAI API key"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "openai_key"
- "mode"
title: "OpenAI"
type: "object"
- description: "Use the Cohere API to embed text."
properties:
cohere_key:
airbyte_secret: true
title: "Cohere API key"
type: "string"
x-speakeasy-param-sensitive: true
mode:
const: "cohere"
default: "cohere"
enum:
- "cohere"
title: "Mode"
type: "string"
required:
- "cohere_key"
- "mode"
title: "Cohere"
type: "object"
- 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."
properties:
mode:
const: "fake"
default: "fake"
enum:
- "fake"
title: "Mode"
type: "string"
required:
- "mode"
title: "Fake"
type: "object"
- description: "Use the Azure-hosted OpenAI API to embed text. This option\
\ is using the text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
api_base:
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"
title: "Resource base URL"
type: "string"
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"
title: "Deployment"
type: "string"
mode:
const: "azure_openai"
default: "azure_openai"
enum:
- "azure_openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
description: "The API key for your Azure OpenAI resource. You can\
\ find this in the Azure portal under your Azure OpenAI resource"
title: "Azure OpenAI API key"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "openai_key"
- "api_base"
- "deployment"
- "mode"
title: "Azure OpenAI"
type: "object"
- description: "Use a service that's compatible with the OpenAI API to embed\
\ text."
properties:
api_key:
airbyte_secret: true
default: ""
title: "API key"
type: "string"
x-speakeasy-param-sensitive: true
base_url:
description: "The base URL for your OpenAI-compatible service"
examples:
- "https://your-service-name.com"
title: "Base URL"
type: "string"
dimensions:
description: "The number of dimensions the embedding model is generating"
examples:
- 1536
- 384
title: "Embedding dimensions"
type: "integer"
mode:
const: "openai_compatible"
default: "openai_compatible"
enum:
- "openai_compatible"
title: "Mode"
type: "string"
model_name:
default: "text-embedding-ada-002"
description: "The name of the model to use for embedding"
examples:
- "text-embedding-ada-002"
title: "Model name"
type: "string"
required:
- "base_url"
- "dimensions"
- "mode"
title: "OpenAI-compatible"
type: "object"
title: "Embedding"
type: "object"
indexing:
description: "Snowflake can be used to store vector data and retrieve embeddings."
group: "indexing"
properties:
credentials:
properties:
password:
airbyte_secret: true
description: "Enter the password you want to use to access the database"
examples:
- "AIRBYTE_PASSWORD"
order: 7
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "password"
title: "Credentials"
type: "object"
database:
description: "Enter the name of the database that you want to sync data\
\ into"
examples:
- "AIRBYTE_DATABASE"
order: 4
title: "Database"
type: "string"
default_schema:
description: "Enter the name of the default schema"
examples:
- "AIRBYTE_SCHEMA"
order: 5
title: "Default Schema"
type: "string"
host:
description: "Enter the account name you want to use to access the database.\
\ This is usually the identifier before .snowflakecomputing.com"
examples:
- "AIRBYTE_ACCOUNT"
order: 1
title: "Host"
type: "string"
role:
description: "Enter the role that you want to use to access Snowflake"
examples:
- "AIRBYTE_ROLE"
- "ACCOUNTADMIN"
order: 2
title: "Role"
type: "string"
username:
description: "Enter the name of the user you want to use to access the\
\ database"
examples:
- "AIRBYTE_USER"
order: 6
title: "Username"
type: "string"
warehouse:
description: "Enter the name of the warehouse that you want to use as\
\ a compute cluster"
examples:
- "AIRBYTE_WAREHOUSE"
order: 3
title: "Warehouse"
type: "string"
required:
- "host"
- "role"
- "warehouse"
- "database"
- "default_schema"
- "username"
- "credentials"
title: "Snowflake Connection"
type: "object"
omit_raw_text:
default: false
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."
group: "advanced"
title: "Do not store raw text"
type: "boolean"
processing:
group: "processing"
properties:
chunk_overlap:
default: 0
description: "Size of overlap between chunks in tokens to store in vector\
\ store to better capture relevant context"
title: "Chunk overlap"
type: "integer"
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
title: "Chunk size"
type: "integer"
field_name_mappings:
default: []
description: "List of fields to rename. Not applicable for nested fields,\
\ but can be used to rename fields already flattened via dot notation."
items:
properties:
from_field:
description: "The field name in the source"
title: "From field name"
type: "string"
to_field:
description: "The field name to use in the destination"
title: "To field name"
type: "string"
required:
- "from_field"
- "to_field"
title: "FieldNameMappingConfigModel"
type: "object"
title: "Field name mappings"
type: "array"
metadata_fields:
always_show: true
default: []
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."
examples:
- "age"
- "user"
- "user.name"
items:
type: "string"
title: "Fields to store as metadata"
type: "array"
text_fields:
always_show: true
default: []
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."
examples:
- "text"
- "user.name"
- "users.*.name"
items:
type: "string"
title: "Text fields to embed"
type: "array"
text_splitter:
description: "Split text fields into chunks based on the specified method."
oneOf:
- 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."
properties:
keep_separator:
default: false
description: "Whether to keep the separator in the resulting chunks"
title: "Keep separator"
type: "boolean"
mode:
const: "separator"
default: "separator"
enum:
- "separator"
title: "Mode"
type: "string"
separators:
default:
- "\"\\n\\n\""
- "\"\\n\""
- "\" \""
- "\"\""
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\"."
items:
type: "string"
title: "Separators"
type: "array"
required:
- "mode"
title: "By Separator"
type: "object"
- 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."
properties:
mode:
const: "markdown"
default: "markdown"
enum:
- "markdown"
title: "Mode"
type: "string"
split_level:
default: 1
description: "Level of markdown headers to split text fields by.\
\ Headings down to the specified level will be used as split\
\ points"
maximum: 6
minimum: 1
title: "Split level"
type: "integer"
required:
- "mode"
title: "By Markdown header"
type: "object"
- description: "Split the text by suitable delimiters based on the programming\
\ language. This is useful for splitting code into chunks."
properties:
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"
title: "Language"
type: "string"
mode:
const: "code"
default: "code"
enum:
- "code"
title: "Mode"
type: "string"
required:
- "language"
- "mode"
title: "By Programming Language"
type: "object"
title: "Text splitter"
type: "object"
required:
- "chunk_size"
title: "ProcessingConfigModel"
type: "object"
destinationType:
title: "snowflake-cortex"
const: "snowflake-cortex"
enum:
- "snowflake-cortex"
order: 0
type: "string"
required:
- "embedding"
- "processing"
- "indexing"
- "destinationType"
title: "Destination Config"
type: "object"
destination-snowflake-cortex-update:
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."
groups:
- id: "processing"
title: "Processing"
- id: "embedding"
title: "Embedding"
- id: "indexing"
title: "Indexing"
- id: "advanced"
title: "Advanced"
properties:
embedding:
description: "Embedding configuration"
group: "embedding"
oneOf:
- description: "Use the OpenAI API to embed text. This option is using the\
\ text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
mode:
const: "openai"
default: "openai"
enum:
- "openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
title: "OpenAI API key"
type: "string"
required:
- "openai_key"
- "mode"
title: "OpenAI"
type: "object"
- description: "Use the Cohere API to embed text."
properties:
cohere_key:
airbyte_secret: true
title: "Cohere API key"
type: "string"
mode:
const: "cohere"
default: "cohere"
enum:
- "cohere"
title: "Mode"
type: "string"
required:
- "cohere_key"
- "mode"
title: "Cohere"
type: "object"
- 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."
properties:
mode:
const: "fake"
default: "fake"
enum:
- "fake"
title: "Mode"
type: "string"
required:
- "mode"
title: "Fake"
type: "object"
- description: "Use the Azure-hosted OpenAI API to embed text. This option\
\ is using the text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
api_base:
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"
title: "Resource base URL"
type: "string"
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"
title: "Deployment"
type: "string"
mode:
const: "azure_openai"
default: "azure_openai"
enum:
- "azure_openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
description: "The API key for your Azure OpenAI resource. You can\
\ find this in the Azure portal under your Azure OpenAI resource"
title: "Azure OpenAI API key"
type: "string"
required:
- "openai_key"
- "api_base"
- "deployment"
- "mode"
title: "Azure OpenAI"
type: "object"
- description: "Use a service that's compatible with the OpenAI API to embed\
\ text."
properties:
api_key:
airbyte_secret: true
default: ""
title: "API key"
type: "string"
base_url:
description: "The base URL for your OpenAI-compatible service"
examples:
- "https://your-service-name.com"
title: "Base URL"
type: "string"
dimensions:
description: "The number of dimensions the embedding model is generating"
examples:
- 1536
- 384
title: "Embedding dimensions"
type: "integer"
mode:
const: "openai_compatible"
default: "openai_compatible"
enum:
- "openai_compatible"
title: "Mode"
type: "string"
model_name:
default: "text-embedding-ada-002"
description: "The name of the model to use for embedding"
examples:
- "text-embedding-ada-002"
title: "Model name"
type: "string"
required:
- "base_url"
- "dimensions"
- "mode"
title: "OpenAI-compatible"
type: "object"
title: "Embedding"
type: "object"
indexing:
description: "Snowflake can be used to store vector data and retrieve embeddings."
group: "indexing"
properties:
credentials:
properties:
password:
airbyte_secret: true
description: "Enter the password you want to use to access the database"
examples:
- "AIRBYTE_PASSWORD"
order: 7
title: "Password"
type: "string"
required:
- "password"
title: "Credentials"
type: "object"
database:
description: "Enter the name of the database that you want to sync data\
\ into"
examples:
- "AIRBYTE_DATABASE"
order: 4
title: "Database"
type: "string"
default_schema:
description: "Enter the name of the default schema"
examples:
- "AIRBYTE_SCHEMA"
order: 5
title: "Default Schema"
type: "string"
host:
description: "Enter the account name you want to use to access the database.\
\ This is usually the identifier before .snowflakecomputing.com"
examples:
- "AIRBYTE_ACCOUNT"
order: 1
title: "Host"
type: "string"
role:
description: "Enter the role that you want to use to access Snowflake"
examples:
- "AIRBYTE_ROLE"
- "ACCOUNTADMIN"
order: 2
title: "Role"
type: "string"
username:
description: "Enter the name of the user you want to use to access the\
\ database"
examples:
- "AIRBYTE_USER"
order: 6
title: "Username"
type: "string"
warehouse:
description: "Enter the name of the warehouse that you want to use as\
\ a compute cluster"
examples:
- "AIRBYTE_WAREHOUSE"
order: 3
title: "Warehouse"
type: "string"
required:
- "host"
- "role"
- "warehouse"
- "database"
- "default_schema"
- "username"
- "credentials"
title: "Snowflake Connection"
type: "object"
omit_raw_text:
default: false
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."
group: "advanced"
title: "Do not store raw text"
type: "boolean"
processing:
group: "processing"
properties:
chunk_overlap:
default: 0
description: "Size of overlap between chunks in tokens to store in vector\
\ store to better capture relevant context"
title: "Chunk overlap"
type: "integer"
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
title: "Chunk size"
type: "integer"
field_name_mappings:
default: []
description: "List of fields to rename. Not applicable for nested fields,\
\ but can be used to rename fields already flattened via dot notation."
items:
properties:
from_field:
description: "The field name in the source"
title: "From field name"
type: "string"
to_field:
description: "The field name to use in the destination"
title: "To field name"
type: "string"
required:
- "from_field"
- "to_field"
title: "FieldNameMappingConfigModel"
type: "object"
title: "Field name mappings"
type: "array"
metadata_fields:
always_show: true
default: []
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."
examples:
- "age"
- "user"
- "user.name"
items:
type: "string"
title: "Fields to store as metadata"
type: "array"
text_fields:
always_show: true
default: []
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."
examples:
- "text"
- "user.name"
- "users.*.name"
items:
type: "string"
title: "Text fields to embed"
type: "array"
text_splitter:
description: "Split text fields into chunks based on the specified method."
oneOf:
- 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."
properties:
keep_separator:
default: false
description: "Whether to keep the separator in the resulting chunks"
title: "Keep separator"
type: "boolean"
mode:
const: "separator"
default: "separator"
enum:
- "separator"
title: "Mode"
type: "string"
separators:
default:
- "\"\\n\\n\""
- "\"\\n\""
- "\" \""
- "\"\""
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\"."
items:
type: "string"
title: "Separators"
type: "array"
required:
- "mode"
title: "By Separator"
type: "object"
- 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."
properties:
mode:
const: "markdown"
default: "markdown"
enum:
- "markdown"
title: "Mode"
type: "string"
split_level:
default: 1
description: "Level of markdown headers to split text fields by.\
\ Headings down to the specified level will be used as split\
\ points"
maximum: 6
minimum: 1
title: "Split level"
type: "integer"
required:
- "mode"
title: "By Markdown header"
type: "object"
- description: "Split the text by suitable delimiters based on the programming\
\ language. This is useful for splitting code into chunks."
properties:
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"
title: "Language"
type: "string"
mode:
const: "code"
default: "code"
enum:
- "code"
title: "Mode"
type: "string"
required:
- "language"
- "mode"
title: "By Programming Language"
type: "object"
title: "Text splitter"
type: "object"
required:
- "chunk_size"
title: "ProcessingConfigModel"
type: "object"
required:
- "embedding"
- "processing"
- "indexing"
title: "Destination Config"
type: "object"
destination-timeplus:
properties:
apikey:
airbyte_secret: true
description: "Personal API key"
order: 1
title: "API key"
type: "string"
x-speakeasy-param-sensitive: true
endpoint:
default: "https://us-west-2.timeplus.cloud/"
description: "Timeplus workspace endpoint"
examples:
- "https://us-west-2.timeplus.cloud/workspace_id"
order: 0
title: "Endpoint"
type: "string"
destinationType:
title: "timeplus"
const: "timeplus"
enum:
- "timeplus"
order: 0
type: "string"
required:
- "endpoint"
- "apikey"
- "destinationType"
title: "Destination Timeplus"
type: "object"
destination-timeplus-update:
properties:
apikey:
airbyte_secret: true
description: "Personal API key"
order: 1
title: "API key"
type: "string"
endpoint:
default: "https://us-west-2.timeplus.cloud/"
description: "Timeplus workspace endpoint"
examples:
- "https://us-west-2.timeplus.cloud/workspace_id"
order: 0
title: "Endpoint"
type: "string"
required:
- "endpoint"
- "apikey"
title: "Destination Timeplus"
type: "object"
destination-surrealdb:
properties:
surrealdb_database:
default: "airbyte"
description: "The database to use in SurrealDB."
type: "string"
surrealdb_namespace:
default: "airbyte"
description: "The namespace to use in SurrealDB."
type: "string"
surrealdb_password:
description: "The password to use in SurrealDB."
type: "string"
surrealdb_url:
description: "The URL of the SurrealDB instance."
type: "string"
surrealdb_username:
description: "The username to use in SurrealDB."
type: "string"
destinationType:
title: "surrealdb"
const: "surrealdb"
enum:
- "surrealdb"
order: 0
type: "string"
required:
- "surrealdb_url"
- "surrealdb_namespace"
- "surrealdb_database"
- "surrealdb_username"
- "surrealdb_password"
- "destinationType"
title: "SurrealDB Destination"
type: "object"
destination-surrealdb-update:
properties:
surrealdb_database:
default: "airbyte"
description: "The database to use in SurrealDB."
type: "string"
surrealdb_namespace:
default: "airbyte"
description: "The namespace to use in SurrealDB."
type: "string"
surrealdb_password:
description: "The password to use in SurrealDB."
type: "string"
surrealdb_url:
description: "The URL of the SurrealDB instance."
type: "string"
surrealdb_username:
description: "The username to use in SurrealDB."
type: "string"
required:
- "surrealdb_url"
- "surrealdb_namespace"
- "surrealdb_database"
- "surrealdb_username"
- "surrealdb_password"
title: "SurrealDB Destination"
type: "object"
destination-convex:
properties:
access_key:
airbyte_secret: "true"
description: "API access key used to send data to a Convex deployment."
type: "string"
x-speakeasy-param-sensitive: true
deployment_url:
description: "URL of the Convex deployment that is the destination"
examples:
- "https://murky-swan-635.convex.cloud"
- "https://cluttered-owl-337.convex.cloud"
type: "string"
destinationType:
title: "convex"
const: "convex"
enum:
- "convex"
order: 0
type: "string"
required:
- "deployment_url"
- "access_key"
- "destinationType"
title: "Destination Convex"
type: "object"
destination-convex-update:
properties:
access_key:
airbyte_secret: "true"
description: "API access key used to send data to a Convex deployment."
type: "string"
deployment_url:
description: "URL of the Convex deployment that is the destination"
examples:
- "https://murky-swan-635.convex.cloud"
- "https://cluttered-owl-337.convex.cloud"
type: "string"
required:
- "deployment_url"
- "access_key"
title: "Destination Convex"
type: "object"
destination-firestore:
properties:
credentials_json:
airbyte_secret: true
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"
type: "string"
x-speakeasy-param-sensitive: true
project_id:
description: "The GCP project ID for the project containing the target BigQuery\
\ dataset."
title: "Project ID"
type: "string"
destinationType:
title: "firestore"
const: "firestore"
enum:
- "firestore"
order: 0
type: "string"
required:
- "project_id"
- "destinationType"
title: "Destination Google Firestore"
type: "object"
destination-firestore-update:
properties:
credentials_json:
airbyte_secret: true
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"
type: "string"
project_id:
description: "The GCP project ID for the project containing the target BigQuery\
\ dataset."
title: "Project ID"
type: "string"
required:
- "project_id"
title: "Destination Google Firestore"
type: "object"
destination-qdrant:
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."
groups:
- id: "processing"
title: "Processing"
- id: "embedding"
title: "Embedding"
- id: "indexing"
title: "Indexing"
- id: "advanced"
title: "Advanced"
properties:
embedding:
description: "Embedding configuration"
group: "embedding"
oneOf:
- description: "Use the OpenAI API to embed text. This option is using the\
\ text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
mode:
const: "openai"
default: "openai"
enum:
- "openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
title: "OpenAI API key"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "openai_key"
- "mode"
title: "OpenAI"
type: "object"
- description: "Use the Cohere API to embed text."
properties:
cohere_key:
airbyte_secret: true
title: "Cohere API key"
type: "string"
x-speakeasy-param-sensitive: true
mode:
const: "cohere"
default: "cohere"
enum:
- "cohere"
title: "Mode"
type: "string"
required:
- "cohere_key"
- "mode"
title: "Cohere"
type: "object"
- 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."
properties:
mode:
const: "fake"
default: "fake"
enum:
- "fake"
title: "Mode"
type: "string"
required:
- "mode"
title: "Fake"
type: "object"
- description: "Use the Azure-hosted OpenAI API to embed text. This option\
\ is using the text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
api_base:
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"
title: "Resource base URL"
type: "string"
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"
title: "Deployment"
type: "string"
mode:
const: "azure_openai"
default: "azure_openai"
enum:
- "azure_openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
description: "The API key for your Azure OpenAI resource. You can\
\ find this in the Azure portal under your Azure OpenAI resource"
title: "Azure OpenAI API key"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "openai_key"
- "api_base"
- "deployment"
- "mode"
title: "Azure OpenAI"
type: "object"
- description: "Use a service that's compatible with the OpenAI API to embed\
\ text."
properties:
api_key:
airbyte_secret: true
default: ""
title: "API key"
type: "string"
x-speakeasy-param-sensitive: true
base_url:
description: "The base URL for your OpenAI-compatible service"
examples:
- "https://your-service-name.com"
title: "Base URL"
type: "string"
dimensions:
description: "The number of dimensions the embedding model is generating"
examples:
- 1536
- 384
title: "Embedding dimensions"
type: "integer"
mode:
const: "openai_compatible"
default: "openai_compatible"
enum:
- "openai_compatible"
title: "Mode"
type: "string"
model_name:
default: "text-embedding-ada-002"
description: "The name of the model to use for embedding"
examples:
- "text-embedding-ada-002"
title: "Model name"
type: "string"
required:
- "base_url"
- "dimensions"
- "mode"
title: "OpenAI-compatible"
type: "object"
title: "Embedding"
type: "object"
indexing:
description: "Indexing configuration"
group: "Indexing"
properties:
auth_method:
default: "api_key_auth"
description: "Method to authenticate with the Qdrant Instance"
oneOf:
- properties:
api_key:
airbyte_secret: true
description: "API Key for the Qdrant instance"
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
mode:
const: "api_key_auth"
default: "api_key_auth"
enum:
- "api_key_auth"
title: "Mode"
type: "string"
required:
- "api_key"
title: "ApiKeyAuth"
type: "object"
- properties:
mode:
const: "no_auth"
default: "no_auth"
enum:
- "no_auth"
title: "Mode"
type: "string"
title: "NoAuth"
type: "object"
order: 1
title: "Authentication Method"
type: "object"
collection:
description: "The collection to load data into"
order: 2
title: "Collection Name"
type: "string"
distance_metric:
default: "cos"
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."
enum:
- "dot"
- "cos"
- "euc"
title: "Distance Metric"
type: "string"
prefer_grpc:
default: true
description: "Whether to prefer gRPC over HTTP. Set to true for Qdrant\
\ cloud clusters"
title: "Prefer gRPC"
type: "boolean"
text_field:
default: "text"
description: "The field in the payload that contains the embedded text"
title: "Text Field"
type: "string"
url:
description: "Public Endpoint of the Qdrant cluser"
order: 0
title: "Public Endpoint"
type: "string"
required:
- "url"
- "collection"
title: "Indexing"
type: "object"
omit_raw_text:
default: false
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."
group: "advanced"
title: "Do not store raw text"
type: "boolean"
processing:
group: "processing"
properties:
chunk_overlap:
default: 0
description: "Size of overlap between chunks in tokens to store in vector\
\ store to better capture relevant context"
title: "Chunk overlap"
type: "integer"
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
title: "Chunk size"
type: "integer"
field_name_mappings:
default: []
description: "List of fields to rename. Not applicable for nested fields,\
\ but can be used to rename fields already flattened via dot notation."
items:
properties:
from_field:
description: "The field name in the source"
title: "From field name"
type: "string"
to_field:
description: "The field name to use in the destination"
title: "To field name"
type: "string"
required:
- "from_field"
- "to_field"
title: "FieldNameMappingConfigModel"
type: "object"
title: "Field name mappings"
type: "array"
metadata_fields:
always_show: true
default: []
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."
examples:
- "age"
- "user"
- "user.name"
items:
type: "string"
title: "Fields to store as metadata"
type: "array"
text_fields:
always_show: true
default: []
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."
examples:
- "text"
- "user.name"
- "users.*.name"
items:
type: "string"
title: "Text fields to embed"
type: "array"
text_splitter:
description: "Split text fields into chunks based on the specified method."
oneOf:
- 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."
properties:
keep_separator:
default: false
description: "Whether to keep the separator in the resulting chunks"
title: "Keep separator"
type: "boolean"
mode:
const: "separator"
default: "separator"
enum:
- "separator"
title: "Mode"
type: "string"
separators:
default:
- "\"\\n\\n\""
- "\"\\n\""
- "\" \""
- "\"\""
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\"."
items:
type: "string"
title: "Separators"
type: "array"
required:
- "mode"
title: "By Separator"
type: "object"
- 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."
properties:
mode:
const: "markdown"
default: "markdown"
enum:
- "markdown"
title: "Mode"
type: "string"
split_level:
default: 1
description: "Level of markdown headers to split text fields by.\
\ Headings down to the specified level will be used as split\
\ points"
maximum: 6
minimum: 1
title: "Split level"
type: "integer"
required:
- "mode"
title: "By Markdown header"
type: "object"
- description: "Split the text by suitable delimiters based on the programming\
\ language. This is useful for splitting code into chunks."
properties:
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"
title: "Language"
type: "string"
mode:
const: "code"
default: "code"
enum:
- "code"
title: "Mode"
type: "string"
required:
- "language"
- "mode"
title: "By Programming Language"
type: "object"
title: "Text splitter"
type: "object"
required:
- "chunk_size"
title: "ProcessingConfigModel"
type: "object"
destinationType:
title: "qdrant"
const: "qdrant"
enum:
- "qdrant"
order: 0
type: "string"
required:
- "embedding"
- "processing"
- "indexing"
- "destinationType"
title: "Destination Config"
type: "object"
destination-qdrant-update:
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."
groups:
- id: "processing"
title: "Processing"
- id: "embedding"
title: "Embedding"
- id: "indexing"
title: "Indexing"
- id: "advanced"
title: "Advanced"
properties:
embedding:
description: "Embedding configuration"
group: "embedding"
oneOf:
- description: "Use the OpenAI API to embed text. This option is using the\
\ text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
mode:
const: "openai"
default: "openai"
enum:
- "openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
title: "OpenAI API key"
type: "string"
required:
- "openai_key"
- "mode"
title: "OpenAI"
type: "object"
- description: "Use the Cohere API to embed text."
properties:
cohere_key:
airbyte_secret: true
title: "Cohere API key"
type: "string"
mode:
const: "cohere"
default: "cohere"
enum:
- "cohere"
title: "Mode"
type: "string"
required:
- "cohere_key"
- "mode"
title: "Cohere"
type: "object"
- 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."
properties:
mode:
const: "fake"
default: "fake"
enum:
- "fake"
title: "Mode"
type: "string"
required:
- "mode"
title: "Fake"
type: "object"
- description: "Use the Azure-hosted OpenAI API to embed text. This option\
\ is using the text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
api_base:
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"
title: "Resource base URL"
type: "string"
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"
title: "Deployment"
type: "string"
mode:
const: "azure_openai"
default: "azure_openai"
enum:
- "azure_openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
description: "The API key for your Azure OpenAI resource. You can\
\ find this in the Azure portal under your Azure OpenAI resource"
title: "Azure OpenAI API key"
type: "string"
required:
- "openai_key"
- "api_base"
- "deployment"
- "mode"
title: "Azure OpenAI"
type: "object"
- description: "Use a service that's compatible with the OpenAI API to embed\
\ text."
properties:
api_key:
airbyte_secret: true
default: ""
title: "API key"
type: "string"
base_url:
description: "The base URL for your OpenAI-compatible service"
examples:
- "https://your-service-name.com"
title: "Base URL"
type: "string"
dimensions:
description: "The number of dimensions the embedding model is generating"
examples:
- 1536
- 384
title: "Embedding dimensions"
type: "integer"
mode:
const: "openai_compatible"
default: "openai_compatible"
enum:
- "openai_compatible"
title: "Mode"
type: "string"
model_name:
default: "text-embedding-ada-002"
description: "The name of the model to use for embedding"
examples:
- "text-embedding-ada-002"
title: "Model name"
type: "string"
required:
- "base_url"
- "dimensions"
- "mode"
title: "OpenAI-compatible"
type: "object"
title: "Embedding"
type: "object"
indexing:
description: "Indexing configuration"
group: "Indexing"
properties:
auth_method:
default: "api_key_auth"
description: "Method to authenticate with the Qdrant Instance"
oneOf:
- properties:
api_key:
airbyte_secret: true
description: "API Key for the Qdrant instance"
title: "API Key"
type: "string"
mode:
const: "api_key_auth"
default: "api_key_auth"
enum:
- "api_key_auth"
title: "Mode"
type: "string"
required:
- "api_key"
title: "ApiKeyAuth"
type: "object"
- properties:
mode:
const: "no_auth"
default: "no_auth"
enum:
- "no_auth"
title: "Mode"
type: "string"
title: "NoAuth"
type: "object"
order: 1
title: "Authentication Method"
type: "object"
collection:
description: "The collection to load data into"
order: 2
title: "Collection Name"
type: "string"
distance_metric:
default: "cos"
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."
enum:
- "dot"
- "cos"
- "euc"
title: "Distance Metric"
type: "string"
prefer_grpc:
default: true
description: "Whether to prefer gRPC over HTTP. Set to true for Qdrant\
\ cloud clusters"
title: "Prefer gRPC"
type: "boolean"
text_field:
default: "text"
description: "The field in the payload that contains the embedded text"
title: "Text Field"
type: "string"
url:
description: "Public Endpoint of the Qdrant cluser"
order: 0
title: "Public Endpoint"
type: "string"
required:
- "url"
- "collection"
title: "Indexing"
type: "object"
omit_raw_text:
default: false
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."
group: "advanced"
title: "Do not store raw text"
type: "boolean"
processing:
group: "processing"
properties:
chunk_overlap:
default: 0
description: "Size of overlap between chunks in tokens to store in vector\
\ store to better capture relevant context"
title: "Chunk overlap"
type: "integer"
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
title: "Chunk size"
type: "integer"
field_name_mappings:
default: []
description: "List of fields to rename. Not applicable for nested fields,\
\ but can be used to rename fields already flattened via dot notation."
items:
properties:
from_field:
description: "The field name in the source"
title: "From field name"
type: "string"
to_field:
description: "The field name to use in the destination"
title: "To field name"
type: "string"
required:
- "from_field"
- "to_field"
title: "FieldNameMappingConfigModel"
type: "object"
title: "Field name mappings"
type: "array"
metadata_fields:
always_show: true
default: []
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."
examples:
- "age"
- "user"
- "user.name"
items:
type: "string"
title: "Fields to store as metadata"
type: "array"
text_fields:
always_show: true
default: []
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."
examples:
- "text"
- "user.name"
- "users.*.name"
items:
type: "string"
title: "Text fields to embed"
type: "array"
text_splitter:
description: "Split text fields into chunks based on the specified method."
oneOf:
- 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."
properties:
keep_separator:
default: false
description: "Whether to keep the separator in the resulting chunks"
title: "Keep separator"
type: "boolean"
mode:
const: "separator"
default: "separator"
enum:
- "separator"
title: "Mode"
type: "string"
separators:
default:
- "\"\\n\\n\""
- "\"\\n\""
- "\" \""
- "\"\""
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\"."
items:
type: "string"
title: "Separators"
type: "array"
required:
- "mode"
title: "By Separator"
type: "object"
- 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."
properties:
mode:
const: "markdown"
default: "markdown"
enum:
- "markdown"
title: "Mode"
type: "string"
split_level:
default: 1
description: "Level of markdown headers to split text fields by.\
\ Headings down to the specified level will be used as split\
\ points"
maximum: 6
minimum: 1
title: "Split level"
type: "integer"
required:
- "mode"
title: "By Markdown header"
type: "object"
- description: "Split the text by suitable delimiters based on the programming\
\ language. This is useful for splitting code into chunks."
properties:
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"
title: "Language"
type: "string"
mode:
const: "code"
default: "code"
enum:
- "code"
title: "Mode"
type: "string"
required:
- "language"
- "mode"
title: "By Programming Language"
type: "object"
title: "Text splitter"
type: "object"
required:
- "chunk_size"
title: "ProcessingConfigModel"
type: "object"
required:
- "embedding"
- "processing"
- "indexing"
title: "Destination Config"
type: "object"
destination-databricks:
properties:
accept_terms:
default: false
description: "You must agree to the Databricks JDBC Driver Terms & Conditions to use this connector."
order: 1
title: "Agree to the Databricks JDBC Driver Terms & Conditions"
type: "boolean"
authentication:
default: "OAUTH"
description: "Authentication mechanism for Staging files and running queries"
oneOf:
- properties:
auth_type:
const: "OAUTH"
order: 0
type: "string"
enum:
- "OAUTH"
client_id:
order: 1
type: "string"
secret:
airbyte_secret: true
order: 2
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_type"
- "client_id"
- "secret"
title: "OAuth2 (Recommended)"
- properties:
auth_type:
const: "BASIC"
order: 0
type: "string"
enum:
- "BASIC"
personal_access_token:
airbyte_secret: true
order: 1
type: "string"
x-speakeasy-param-sensitive: true
required:
- "auth_type"
- "personal_access_token"
title: "Personal Access Token"
order: 8
title: "Authentication"
type: "object"
database:
description: "The name of the unity catalog for the database"
order: 5
title: "Databricks Unity Catalog Name"
type: "string"
hostname:
description: "Databricks Cluster Server Hostname."
examples:
- "abc-12345678-wxyz.cloud.databricks.com"
order: 2
title: "Server Hostname"
type: "string"
http_path:
description: "Databricks Cluster HTTP Path."
examples:
- "sql/1.0/warehouses/0000-1111111-abcd90"
order: 3
title: "HTTP Path"
type: "string"
port:
default: "443"
description: "Databricks Cluster Port."
examples:
- "443"
order: 4
title: "Port"
type: "string"
purge_staging_data:
default: true
description: "Default to 'true'. Switch it to 'false' for debugging purpose."
order: 9
title: "Purge Staging Files and Tables"
type: "boolean"
raw_schema_override:
default: "airbyte_internal"
description: "The schema to write raw tables into (default: airbyte_internal)"
order: 10
title: "Raw Table Schema Name"
type: "string"
schema:
default: "default"
description: "The default schema tables are written. If not specified otherwise,\
\ the \"default\" will be used."
examples:
- "default"
order: 6
title: "Default Schema"
type: "string"
destinationType:
title: "databricks"
const: "databricks"
enum:
- "databricks"
order: 0
type: "string"
required:
- "accept_terms"
- "hostname"
- "http_path"
- "database"
- "authentication"
- "destinationType"
title: "Databricks Lakehouse Destination Spec"
type: "object"
destination-databricks-update:
properties:
accept_terms:
default: false
description: "You must agree to the Databricks JDBC Driver Terms & Conditions to use this connector."
order: 1
title: "Agree to the Databricks JDBC Driver Terms & Conditions"
type: "boolean"
authentication:
default: "OAUTH"
description: "Authentication mechanism for Staging files and running queries"
oneOf:
- properties:
auth_type:
const: "OAUTH"
order: 0
type: "string"
enum:
- "OAUTH"
client_id:
order: 1
type: "string"
secret:
airbyte_secret: true
order: 2
type: "string"
required:
- "auth_type"
- "client_id"
- "secret"
title: "OAuth2 (Recommended)"
- properties:
auth_type:
const: "BASIC"
order: 0
type: "string"
enum:
- "BASIC"
personal_access_token:
airbyte_secret: true
order: 1
type: "string"
required:
- "auth_type"
- "personal_access_token"
title: "Personal Access Token"
order: 8
title: "Authentication"
type: "object"
database:
description: "The name of the unity catalog for the database"
order: 5
title: "Databricks Unity Catalog Name"
type: "string"
hostname:
description: "Databricks Cluster Server Hostname."
examples:
- "abc-12345678-wxyz.cloud.databricks.com"
order: 2
title: "Server Hostname"
type: "string"
http_path:
description: "Databricks Cluster HTTP Path."
examples:
- "sql/1.0/warehouses/0000-1111111-abcd90"
order: 3
title: "HTTP Path"
type: "string"
port:
default: "443"
description: "Databricks Cluster Port."
examples:
- "443"
order: 4
title: "Port"
type: "string"
purge_staging_data:
default: true
description: "Default to 'true'. Switch it to 'false' for debugging purpose."
order: 9
title: "Purge Staging Files and Tables"
type: "boolean"
raw_schema_override:
default: "airbyte_internal"
description: "The schema to write raw tables into (default: airbyte_internal)"
order: 10
title: "Raw Table Schema Name"
type: "string"
schema:
default: "default"
description: "The default schema tables are written. If not specified otherwise,\
\ the \"default\" will be used."
examples:
- "default"
order: 6
title: "Default Schema"
type: "string"
required:
- "accept_terms"
- "hostname"
- "http_path"
- "database"
- "authentication"
title: "Databricks Lakehouse Destination Spec"
type: "object"
destination-aws-datalake:
properties:
aws_account_id:
description: "target aws account id"
examples:
- "111111111111"
order: 1
title: "AWS Account Id"
type: "string"
bucket_name:
description: "The name of the S3 bucket. Read more here."
order: 4
title: "S3 Bucket Name"
type: "string"
bucket_prefix:
description: "S3 prefix"
order: 5
title: "Target S3 Bucket Prefix"
type: "string"
credentials:
description: "Choose How to Authenticate to AWS."
oneOf:
- properties:
credentials_title:
const: "IAM Role"
default: "IAM Role"
description: "Name of the credentials"
enum:
- "IAM Role"
order: 0
title: "Credentials Title"
type: "string"
role_arn:
airbyte_secret: false
description: "Will assume this role to write data to s3"
title: "Target Role Arn"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "role_arn"
- "credentials_title"
title: "IAM Role"
type: "object"
- properties:
aws_access_key_id:
airbyte_secret: true
description: "AWS User Access Key Id"
title: "Access Key Id"
type: "string"
x-speakeasy-param-sensitive: true
aws_secret_access_key:
airbyte_secret: true
description: "Secret Access Key"
title: "Secret Access Key"
type: "string"
x-speakeasy-param-sensitive: true
credentials_title:
const: "IAM User"
default: "IAM User"
description: "Name of the credentials"
enum:
- "IAM User"
order: 0
title: "Credentials Title"
type: "string"
required:
- "credentials_title"
- "aws_access_key_id"
- "aws_secret_access_key"
title: "IAM User"
type: "object"
order: 2
title: "Authentication mode"
type: "object"
format:
description: "Format of the data output."
oneOf:
- properties:
compression_codec:
default: "UNCOMPRESSED"
description: "The compression algorithm used to compress data."
enum:
- "UNCOMPRESSED"
- "GZIP"
title: "Compression Codec (Optional)"
type: "string"
format_type:
default: "JSONL"
enum:
- "JSONL"
title: "Format Type *"
type: "string"
required:
- "format_type"
title: "JSON Lines: Newline-delimited JSON"
- properties:
compression_codec:
default: "SNAPPY"
description: "The compression algorithm used to compress data."
enum:
- "UNCOMPRESSED"
- "SNAPPY"
- "GZIP"
- "ZSTD"
title: "Compression Codec (Optional)"
type: "string"
format_type:
default: "Parquet"
enum:
- "Parquet"
title: "Format Type *"
type: "string"
required:
- "format_type"
title: "Parquet: Columnar Storage"
order: 10
title: "Output Format *"
type: "object"
glue_catalog_float_as_decimal:
default: false
description: "Cast float/double as decimal(38,18). This can help achieve\
\ higher accuracy and represent numbers correctly as received from the\
\ source."
order: 12
title: "Glue Catalog: Float as Decimal"
type: "boolean"
lakeformation_database_default_tag_key:
description: "Add a default tag key to databases created by this destination"
examples:
- "pii_level"
order: 7
title: "Lake Formation Database Tag Key"
type: "string"
lakeformation_database_default_tag_values:
description: "Add default values for the `Tag Key` to databases created\
\ by this destination. Comma separate for multiple values."
examples:
- "private,public"
order: 8
title: "Lake Formation Database Tag Values"
type: "string"
lakeformation_database_name:
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
title: "Lake Formation Database Name"
type: "string"
lakeformation_governed_tables:
default: false
description: "Whether to create tables as LF governed tables."
order: 9
title: "Lake Formation Governed Tables"
type: "boolean"
partitioning:
default: "NO PARTITIONING"
description: "Partition data by cursor fields when a cursor field is a date"
enum:
- "NO PARTITIONING"
- "DATE"
- "YEAR"
- "MONTH"
- "DAY"
- "YEAR/MONTH"
- "YEAR/MONTH/DAY"
order: 11
title: "Choose how to partition data"
type: "string"
region:
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
title: "S3 Bucket Region"
type: "string"
destinationType:
title: "aws-datalake"
const: "aws-datalake"
enum:
- "aws-datalake"
order: 0
type: "string"
required:
- "credentials"
- "region"
- "bucket_name"
- "lakeformation_database_name"
- "destinationType"
title: "AWS Datalake Destination Spec"
type: "object"
destination-aws-datalake-update:
properties:
aws_account_id:
description: "target aws account id"
examples:
- "111111111111"
order: 1
title: "AWS Account Id"
type: "string"
bucket_name:
description: "The name of the S3 bucket. Read more here."
order: 4
title: "S3 Bucket Name"
type: "string"
bucket_prefix:
description: "S3 prefix"
order: 5
title: "Target S3 Bucket Prefix"
type: "string"
credentials:
description: "Choose How to Authenticate to AWS."
oneOf:
- properties:
credentials_title:
const: "IAM Role"
default: "IAM Role"
description: "Name of the credentials"
enum:
- "IAM Role"
order: 0
title: "Credentials Title"
type: "string"
role_arn:
airbyte_secret: false
description: "Will assume this role to write data to s3"
title: "Target Role Arn"
type: "string"
required:
- "role_arn"
- "credentials_title"
title: "IAM Role"
type: "object"
- properties:
aws_access_key_id:
airbyte_secret: true
description: "AWS User Access Key Id"
title: "Access Key Id"
type: "string"
aws_secret_access_key:
airbyte_secret: true
description: "Secret Access Key"
title: "Secret Access Key"
type: "string"
credentials_title:
const: "IAM User"
default: "IAM User"
description: "Name of the credentials"
enum:
- "IAM User"
order: 0
title: "Credentials Title"
type: "string"
required:
- "credentials_title"
- "aws_access_key_id"
- "aws_secret_access_key"
title: "IAM User"
type: "object"
order: 2
title: "Authentication mode"
type: "object"
format:
description: "Format of the data output."
oneOf:
- properties:
compression_codec:
default: "UNCOMPRESSED"
description: "The compression algorithm used to compress data."
enum:
- "UNCOMPRESSED"
- "GZIP"
title: "Compression Codec (Optional)"
type: "string"
format_type:
default: "JSONL"
enum:
- "JSONL"
title: "Format Type *"
type: "string"
required:
- "format_type"
title: "JSON Lines: Newline-delimited JSON"
- properties:
compression_codec:
default: "SNAPPY"
description: "The compression algorithm used to compress data."
enum:
- "UNCOMPRESSED"
- "SNAPPY"
- "GZIP"
- "ZSTD"
title: "Compression Codec (Optional)"
type: "string"
format_type:
default: "Parquet"
enum:
- "Parquet"
title: "Format Type *"
type: "string"
required:
- "format_type"
title: "Parquet: Columnar Storage"
order: 10
title: "Output Format *"
type: "object"
glue_catalog_float_as_decimal:
default: false
description: "Cast float/double as decimal(38,18). This can help achieve\
\ higher accuracy and represent numbers correctly as received from the\
\ source."
order: 12
title: "Glue Catalog: Float as Decimal"
type: "boolean"
lakeformation_database_default_tag_key:
description: "Add a default tag key to databases created by this destination"
examples:
- "pii_level"
order: 7
title: "Lake Formation Database Tag Key"
type: "string"
lakeformation_database_default_tag_values:
description: "Add default values for the `Tag Key` to databases created\
\ by this destination. Comma separate for multiple values."
examples:
- "private,public"
order: 8
title: "Lake Formation Database Tag Values"
type: "string"
lakeformation_database_name:
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
title: "Lake Formation Database Name"
type: "string"
lakeformation_governed_tables:
default: false
description: "Whether to create tables as LF governed tables."
order: 9
title: "Lake Formation Governed Tables"
type: "boolean"
partitioning:
default: "NO PARTITIONING"
description: "Partition data by cursor fields when a cursor field is a date"
enum:
- "NO PARTITIONING"
- "DATE"
- "YEAR"
- "MONTH"
- "DAY"
- "YEAR/MONTH"
- "YEAR/MONTH/DAY"
order: 11
title: "Choose how to partition data"
type: "string"
region:
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
title: "S3 Bucket Region"
type: "string"
required:
- "credentials"
- "region"
- "bucket_name"
- "lakeformation_database_name"
title: "AWS Datalake Destination Spec"
type: "object"
destination-astra:
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."
groups:
- id: "processing"
title: "Processing"
- id: "embedding"
title: "Embedding"
- id: "indexing"
title: "Indexing"
- id: "advanced"
title: "Advanced"
properties:
embedding:
description: "Embedding configuration"
group: "embedding"
oneOf:
- description: "Use the OpenAI API to embed text. This option is using the\
\ text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
mode:
const: "openai"
default: "openai"
enum:
- "openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
title: "OpenAI API key"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "openai_key"
- "mode"
title: "OpenAI"
type: "object"
- description: "Use the Cohere API to embed text."
properties:
cohere_key:
airbyte_secret: true
title: "Cohere API key"
type: "string"
x-speakeasy-param-sensitive: true
mode:
const: "cohere"
default: "cohere"
enum:
- "cohere"
title: "Mode"
type: "string"
required:
- "cohere_key"
- "mode"
title: "Cohere"
type: "object"
- 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."
properties:
mode:
const: "fake"
default: "fake"
enum:
- "fake"
title: "Mode"
type: "string"
required:
- "mode"
title: "Fake"
type: "object"
- description: "Use the Azure-hosted OpenAI API to embed text. This option\
\ is using the text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
api_base:
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"
title: "Resource base URL"
type: "string"
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"
title: "Deployment"
type: "string"
mode:
const: "azure_openai"
default: "azure_openai"
enum:
- "azure_openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
description: "The API key for your Azure OpenAI resource. You can\
\ find this in the Azure portal under your Azure OpenAI resource"
title: "Azure OpenAI API key"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "openai_key"
- "api_base"
- "deployment"
- "mode"
title: "Azure OpenAI"
type: "object"
- description: "Use a service that's compatible with the OpenAI API to embed\
\ text."
properties:
api_key:
airbyte_secret: true
default: ""
title: "API key"
type: "string"
x-speakeasy-param-sensitive: true
base_url:
description: "The base URL for your OpenAI-compatible service"
examples:
- "https://your-service-name.com"
title: "Base URL"
type: "string"
dimensions:
description: "The number of dimensions the embedding model is generating"
examples:
- 1536
- 384
title: "Embedding dimensions"
type: "integer"
mode:
const: "openai_compatible"
default: "openai_compatible"
enum:
- "openai_compatible"
title: "Mode"
type: "string"
model_name:
default: "text-embedding-ada-002"
description: "The name of the model to use for embedding"
examples:
- "text-embedding-ada-002"
title: "Model name"
type: "string"
required:
- "base_url"
- "dimensions"
- "mode"
title: "OpenAI-compatible"
type: "object"
title: "Embedding"
type: "object"
indexing:
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"
properties:
astra_db_app_token:
airbyte_secret: true
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."
title: "Astra DB Application Token"
type: "string"
x-speakeasy-param-sensitive: true
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."
examples:
- "https://8292d414-dd1b-4c33-8431-e838bedc04f7-us-east1.apps.astra.datastax.com"
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"
title: "Astra DB Endpoint"
type: "string"
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."
title: "Astra DB Keyspace"
type: "string"
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."
title: "Astra DB collection"
type: "string"
required:
- "astra_db_app_token"
- "astra_db_endpoint"
- "astra_db_keyspace"
- "collection"
title: "Indexing"
type: "object"
omit_raw_text:
default: false
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."
group: "advanced"
title: "Do not store raw text"
type: "boolean"
processing:
group: "processing"
properties:
chunk_overlap:
default: 0
description: "Size of overlap between chunks in tokens to store in vector\
\ store to better capture relevant context"
title: "Chunk overlap"
type: "integer"
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
title: "Chunk size"
type: "integer"
field_name_mappings:
default: []
description: "List of fields to rename. Not applicable for nested fields,\
\ but can be used to rename fields already flattened via dot notation."
items:
properties:
from_field:
description: "The field name in the source"
title: "From field name"
type: "string"
to_field:
description: "The field name to use in the destination"
title: "To field name"
type: "string"
required:
- "from_field"
- "to_field"
title: "FieldNameMappingConfigModel"
type: "object"
title: "Field name mappings"
type: "array"
metadata_fields:
always_show: true
default: []
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."
examples:
- "age"
- "user"
- "user.name"
items:
type: "string"
title: "Fields to store as metadata"
type: "array"
text_fields:
always_show: true
default: []
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."
examples:
- "text"
- "user.name"
- "users.*.name"
items:
type: "string"
title: "Text fields to embed"
type: "array"
text_splitter:
description: "Split text fields into chunks based on the specified method."
oneOf:
- 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."
properties:
keep_separator:
default: false
description: "Whether to keep the separator in the resulting chunks"
title: "Keep separator"
type: "boolean"
mode:
const: "separator"
default: "separator"
enum:
- "separator"
title: "Mode"
type: "string"
separators:
default:
- "\"\\n\\n\""
- "\"\\n\""
- "\" \""
- "\"\""
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\"."
items:
type: "string"
title: "Separators"
type: "array"
required:
- "mode"
title: "By Separator"
type: "object"
- 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."
properties:
mode:
const: "markdown"
default: "markdown"
enum:
- "markdown"
title: "Mode"
type: "string"
split_level:
default: 1
description: "Level of markdown headers to split text fields by.\
\ Headings down to the specified level will be used as split\
\ points"
maximum: 6
minimum: 1
title: "Split level"
type: "integer"
required:
- "mode"
title: "By Markdown header"
type: "object"
- description: "Split the text by suitable delimiters based on the programming\
\ language. This is useful for splitting code into chunks."
properties:
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"
title: "Language"
type: "string"
mode:
const: "code"
default: "code"
enum:
- "code"
title: "Mode"
type: "string"
required:
- "language"
- "mode"
title: "By Programming Language"
type: "object"
title: "Text splitter"
type: "object"
required:
- "chunk_size"
title: "ProcessingConfigModel"
type: "object"
destinationType:
title: "astra"
const: "astra"
enum:
- "astra"
order: 0
type: "string"
required:
- "embedding"
- "processing"
- "indexing"
- "destinationType"
title: "Destination Config"
type: "object"
destination-astra-update:
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."
groups:
- id: "processing"
title: "Processing"
- id: "embedding"
title: "Embedding"
- id: "indexing"
title: "Indexing"
- id: "advanced"
title: "Advanced"
properties:
embedding:
description: "Embedding configuration"
group: "embedding"
oneOf:
- description: "Use the OpenAI API to embed text. This option is using the\
\ text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
mode:
const: "openai"
default: "openai"
enum:
- "openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
title: "OpenAI API key"
type: "string"
required:
- "openai_key"
- "mode"
title: "OpenAI"
type: "object"
- description: "Use the Cohere API to embed text."
properties:
cohere_key:
airbyte_secret: true
title: "Cohere API key"
type: "string"
mode:
const: "cohere"
default: "cohere"
enum:
- "cohere"
title: "Mode"
type: "string"
required:
- "cohere_key"
- "mode"
title: "Cohere"
type: "object"
- 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."
properties:
mode:
const: "fake"
default: "fake"
enum:
- "fake"
title: "Mode"
type: "string"
required:
- "mode"
title: "Fake"
type: "object"
- description: "Use the Azure-hosted OpenAI API to embed text. This option\
\ is using the text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
api_base:
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"
title: "Resource base URL"
type: "string"
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"
title: "Deployment"
type: "string"
mode:
const: "azure_openai"
default: "azure_openai"
enum:
- "azure_openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
description: "The API key for your Azure OpenAI resource. You can\
\ find this in the Azure portal under your Azure OpenAI resource"
title: "Azure OpenAI API key"
type: "string"
required:
- "openai_key"
- "api_base"
- "deployment"
- "mode"
title: "Azure OpenAI"
type: "object"
- description: "Use a service that's compatible with the OpenAI API to embed\
\ text."
properties:
api_key:
airbyte_secret: true
default: ""
title: "API key"
type: "string"
base_url:
description: "The base URL for your OpenAI-compatible service"
examples:
- "https://your-service-name.com"
title: "Base URL"
type: "string"
dimensions:
description: "The number of dimensions the embedding model is generating"
examples:
- 1536
- 384
title: "Embedding dimensions"
type: "integer"
mode:
const: "openai_compatible"
default: "openai_compatible"
enum:
- "openai_compatible"
title: "Mode"
type: "string"
model_name:
default: "text-embedding-ada-002"
description: "The name of the model to use for embedding"
examples:
- "text-embedding-ada-002"
title: "Model name"
type: "string"
required:
- "base_url"
- "dimensions"
- "mode"
title: "OpenAI-compatible"
type: "object"
title: "Embedding"
type: "object"
indexing:
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"
properties:
astra_db_app_token:
airbyte_secret: true
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."
title: "Astra DB Application Token"
type: "string"
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."
examples:
- "https://8292d414-dd1b-4c33-8431-e838bedc04f7-us-east1.apps.astra.datastax.com"
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"
title: "Astra DB Endpoint"
type: "string"
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."
title: "Astra DB Keyspace"
type: "string"
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."
title: "Astra DB collection"
type: "string"
required:
- "astra_db_app_token"
- "astra_db_endpoint"
- "astra_db_keyspace"
- "collection"
title: "Indexing"
type: "object"
omit_raw_text:
default: false
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."
group: "advanced"
title: "Do not store raw text"
type: "boolean"
processing:
group: "processing"
properties:
chunk_overlap:
default: 0
description: "Size of overlap between chunks in tokens to store in vector\
\ store to better capture relevant context"
title: "Chunk overlap"
type: "integer"
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
title: "Chunk size"
type: "integer"
field_name_mappings:
default: []
description: "List of fields to rename. Not applicable for nested fields,\
\ but can be used to rename fields already flattened via dot notation."
items:
properties:
from_field:
description: "The field name in the source"
title: "From field name"
type: "string"
to_field:
description: "The field name to use in the destination"
title: "To field name"
type: "string"
required:
- "from_field"
- "to_field"
title: "FieldNameMappingConfigModel"
type: "object"
title: "Field name mappings"
type: "array"
metadata_fields:
always_show: true
default: []
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."
examples:
- "age"
- "user"
- "user.name"
items:
type: "string"
title: "Fields to store as metadata"
type: "array"
text_fields:
always_show: true
default: []
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."
examples:
- "text"
- "user.name"
- "users.*.name"
items:
type: "string"
title: "Text fields to embed"
type: "array"
text_splitter:
description: "Split text fields into chunks based on the specified method."
oneOf:
- 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."
properties:
keep_separator:
default: false
description: "Whether to keep the separator in the resulting chunks"
title: "Keep separator"
type: "boolean"
mode:
const: "separator"
default: "separator"
enum:
- "separator"
title: "Mode"
type: "string"
separators:
default:
- "\"\\n\\n\""
- "\"\\n\""
- "\" \""
- "\"\""
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\"."
items:
type: "string"
title: "Separators"
type: "array"
required:
- "mode"
title: "By Separator"
type: "object"
- 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."
properties:
mode:
const: "markdown"
default: "markdown"
enum:
- "markdown"
title: "Mode"
type: "string"
split_level:
default: 1
description: "Level of markdown headers to split text fields by.\
\ Headings down to the specified level will be used as split\
\ points"
maximum: 6
minimum: 1
title: "Split level"
type: "integer"
required:
- "mode"
title: "By Markdown header"
type: "object"
- description: "Split the text by suitable delimiters based on the programming\
\ language. This is useful for splitting code into chunks."
properties:
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"
title: "Language"
type: "string"
mode:
const: "code"
default: "code"
enum:
- "code"
title: "Mode"
type: "string"
required:
- "language"
- "mode"
title: "By Programming Language"
type: "object"
title: "Text splitter"
type: "object"
required:
- "chunk_size"
title: "ProcessingConfigModel"
type: "object"
required:
- "embedding"
- "processing"
- "indexing"
title: "Destination Config"
type: "object"
destination-customer-io:
properties:
credentials:
additionalProperties: true
description: "Enter the site ID and API key to authenticate."
order: 0
properties:
apiKey:
airbyte_secret: true
always_show: true
description: "Enter your Customer IO API Key."
order: 2
title: "API Key"
type: "string"
x-speakeasy-param-sensitive: true
siteId:
airbyte_secret: true
always_show: true
description: "Enter your Customer IO Site ID."
order: 1
title: "Site ID"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "siteId"
- "apiKey"
title: "Credentials"
type: "object"
object_storage_config:
oneOf:
- additionalProperties: true
properties:
storage_type:
default: "None"
enum:
- "None"
type: "string"
required:
- "storage_type"
title: "None"
type: "object"
- additionalProperties: true
properties:
access_key_id:
airbyte_secret: true
always_show: true
description: "The access key ID to access the S3 bucket. Airbyte requires\
\ Read and Write permissions to the given bucket. Read more here."
examples:
- "A012345678910EXAMPLE"
order: 1
title: "Access Key ID"
type: "string"
x-speakeasy-param-sensitive: true
bucket_path:
description: "All files in the bucket will be prefixed by this."
examples:
- "prefix/"
order: 7
title: "Prefix Path in the Bucket"
type: "string"
role_arn:
description: "The ARN of the AWS role to assume. Only usable in Airbyte\
\ Cloud."
examples:
- "arn:aws:iam::123456789:role/ExternalIdIsYourWorkspaceId"
order: 3
title: "Role ARN"
type: "string"
s3_bucket_name:
description: "The name of the S3 bucket. Read more here."
examples:
- "airbyte_sync"
order: 4
title: "S3 Bucket Name"
type: "string"
s3_bucket_region:
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"
examples:
- "us-east-1"
order: 5
title: "S3 Bucket Region"
type: "string"
s3_endpoint:
description: "Your S3 endpoint url. Read more here"
examples:
- "http://localhost:9000"
order: 6
title: "S3 Endpoint"
type: "string"
secret_access_key:
airbyte_secret: true
always_show: true
description: "The corresponding secret to the access key ID. Read\
\ more here"
examples:
- "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY"
order: 2
title: "Secret Access Key"
type: "string"
x-speakeasy-param-sensitive: true
storage_type:
default: "S3"
enum:
- "S3"
type: "string"
required:
- "storage_type"
- "s3_bucket_name"
- "s3_bucket_region"
- "bucket_path"
- "format"
title: "S3"
type: "object"
title: "Object Storage Spec"
type: "object"
destinationType:
title: "customer-io"
const: "customer-io"
enum:
- "customer-io"
order: 0
type: "string"
required:
- "credentials"
- "destinationType"
title: "Customer Io Specification"
type: "object"
destination-customer-io-update:
properties:
credentials:
additionalProperties: true
description: "Enter the site ID and API key to authenticate."
order: 0
properties:
apiKey:
airbyte_secret: true
always_show: true
description: "Enter your Customer IO API Key."
order: 2
title: "API Key"
type: "string"
siteId:
airbyte_secret: true
always_show: true
description: "Enter your Customer IO Site ID."
order: 1
title: "Site ID"
type: "string"
required:
- "siteId"
- "apiKey"
title: "Credentials"
type: "object"
object_storage_config:
oneOf:
- additionalProperties: true
properties:
storage_type:
default: "None"
enum:
- "None"
type: "string"
required:
- "storage_type"
title: "None"
type: "object"
- additionalProperties: true
properties:
access_key_id:
airbyte_secret: true
always_show: true
description: "The access key ID to access the S3 bucket. Airbyte requires\
\ Read and Write permissions to the given bucket. Read more here."
examples:
- "A012345678910EXAMPLE"
order: 1
title: "Access Key ID"
type: "string"
bucket_path:
description: "All files in the bucket will be prefixed by this."
examples:
- "prefix/"
order: 7
title: "Prefix Path in the Bucket"
type: "string"
role_arn:
description: "The ARN of the AWS role to assume. Only usable in Airbyte\
\ Cloud."
examples:
- "arn:aws:iam::123456789:role/ExternalIdIsYourWorkspaceId"
order: 3
title: "Role ARN"
type: "string"
s3_bucket_name:
description: "The name of the S3 bucket. Read more here."
examples:
- "airbyte_sync"
order: 4
title: "S3 Bucket Name"
type: "string"
s3_bucket_region:
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"
examples:
- "us-east-1"
order: 5
title: "S3 Bucket Region"
type: "string"
s3_endpoint:
description: "Your S3 endpoint url. Read more here"
examples:
- "http://localhost:9000"
order: 6
title: "S3 Endpoint"
type: "string"
secret_access_key:
airbyte_secret: true
always_show: true
description: "The corresponding secret to the access key ID. Read\
\ more here"
examples:
- "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY"
order: 2
title: "Secret Access Key"
type: "string"
storage_type:
default: "S3"
enum:
- "S3"
type: "string"
required:
- "storage_type"
- "s3_bucket_name"
- "s3_bucket_region"
- "bucket_path"
- "format"
title: "S3"
type: "object"
title: "Object Storage Spec"
type: "object"
required:
- "credentials"
title: "Customer Io Specification"
type: "object"
destination-pinecone:
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."
groups:
- id: "processing"
title: "Processing"
- id: "embedding"
title: "Embedding"
- id: "indexing"
title: "Indexing"
- id: "advanced"
title: "Advanced"
properties:
embedding:
description: "Embedding configuration"
group: "embedding"
oneOf:
- description: "Use the OpenAI API to embed text. This option is using the\
\ text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
mode:
const: "openai"
default: "openai"
enum:
- "openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
title: "OpenAI API key"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "openai_key"
- "mode"
title: "OpenAI"
type: "object"
- description: "Use the Cohere API to embed text."
properties:
cohere_key:
airbyte_secret: true
title: "Cohere API key"
type: "string"
x-speakeasy-param-sensitive: true
mode:
const: "cohere"
default: "cohere"
enum:
- "cohere"
title: "Mode"
type: "string"
required:
- "cohere_key"
- "mode"
title: "Cohere"
type: "object"
- 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."
properties:
mode:
const: "fake"
default: "fake"
enum:
- "fake"
title: "Mode"
type: "string"
required:
- "mode"
title: "Fake"
type: "object"
- description: "Use the Azure-hosted OpenAI API to embed text. This option\
\ is using the text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
api_base:
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"
title: "Resource base URL"
type: "string"
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"
title: "Deployment"
type: "string"
mode:
const: "azure_openai"
default: "azure_openai"
enum:
- "azure_openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
description: "The API key for your Azure OpenAI resource. You can\
\ find this in the Azure portal under your Azure OpenAI resource"
title: "Azure OpenAI API key"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "openai_key"
- "api_base"
- "deployment"
- "mode"
title: "Azure OpenAI"
type: "object"
- description: "Use a service that's compatible with the OpenAI API to embed\
\ text."
properties:
api_key:
airbyte_secret: true
default: ""
title: "API key"
type: "string"
x-speakeasy-param-sensitive: true
base_url:
description: "The base URL for your OpenAI-compatible service"
examples:
- "https://your-service-name.com"
title: "Base URL"
type: "string"
dimensions:
description: "The number of dimensions the embedding model is generating"
examples:
- 1536
- 384
title: "Embedding dimensions"
type: "integer"
mode:
const: "openai_compatible"
default: "openai_compatible"
enum:
- "openai_compatible"
title: "Mode"
type: "string"
model_name:
default: "text-embedding-ada-002"
description: "The name of the model to use for embedding"
examples:
- "text-embedding-ada-002"
title: "Model name"
type: "string"
required:
- "base_url"
- "dimensions"
- "mode"
title: "OpenAI-compatible"
type: "object"
title: "Embedding"
type: "object"
indexing:
description: "Pinecone is a popular vector store that can be used to store\
\ and retrieve embeddings."
group: "indexing"
properties:
index:
description: "Pinecone index in your project to load data into"
title: "Index"
type: "string"
pinecone_environment:
description: "Pinecone Cloud environment to use"
examples:
- "us-west1-gcp"
- "gcp-starter"
title: "Pinecone Environment"
type: "string"
pinecone_key:
airbyte_secret: true
description: "The Pinecone API key to use matching the environment (copy\
\ from Pinecone console)"
title: "Pinecone API key"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "pinecone_key"
- "pinecone_environment"
- "index"
title: "Indexing"
type: "object"
omit_raw_text:
default: false
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."
group: "advanced"
title: "Do not store raw text"
type: "boolean"
processing:
group: "processing"
properties:
chunk_overlap:
default: 0
description: "Size of overlap between chunks in tokens to store in vector\
\ store to better capture relevant context"
title: "Chunk overlap"
type: "integer"
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
title: "Chunk size"
type: "integer"
field_name_mappings:
default: []
description: "List of fields to rename. Not applicable for nested fields,\
\ but can be used to rename fields already flattened via dot notation."
items:
properties:
from_field:
description: "The field name in the source"
title: "From field name"
type: "string"
to_field:
description: "The field name to use in the destination"
title: "To field name"
type: "string"
required:
- "from_field"
- "to_field"
title: "FieldNameMappingConfigModel"
type: "object"
title: "Field name mappings"
type: "array"
metadata_fields:
always_show: true
default: []
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."
examples:
- "age"
- "user"
- "user.name"
items:
type: "string"
title: "Fields to store as metadata"
type: "array"
text_fields:
always_show: true
default: []
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."
examples:
- "text"
- "user.name"
- "users.*.name"
items:
type: "string"
title: "Text fields to embed"
type: "array"
text_splitter:
description: "Split text fields into chunks based on the specified method."
oneOf:
- 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."
properties:
keep_separator:
default: false
description: "Whether to keep the separator in the resulting chunks"
title: "Keep separator"
type: "boolean"
mode:
const: "separator"
default: "separator"
enum:
- "separator"
title: "Mode"
type: "string"
separators:
default:
- "\"\\n\\n\""
- "\"\\n\""
- "\" \""
- "\"\""
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\"."
items:
type: "string"
title: "Separators"
type: "array"
required:
- "mode"
title: "By Separator"
type: "object"
- 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."
properties:
mode:
const: "markdown"
default: "markdown"
enum:
- "markdown"
title: "Mode"
type: "string"
split_level:
default: 1
description: "Level of markdown headers to split text fields by.\
\ Headings down to the specified level will be used as split\
\ points"
maximum: 6
minimum: 1
title: "Split level"
type: "integer"
required:
- "mode"
title: "By Markdown header"
type: "object"
- description: "Split the text by suitable delimiters based on the programming\
\ language. This is useful for splitting code into chunks."
properties:
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"
title: "Language"
type: "string"
mode:
const: "code"
default: "code"
enum:
- "code"
title: "Mode"
type: "string"
required:
- "language"
- "mode"
title: "By Programming Language"
type: "object"
title: "Text splitter"
type: "object"
required:
- "chunk_size"
title: "ProcessingConfigModel"
type: "object"
destinationType:
title: "pinecone"
const: "pinecone"
enum:
- "pinecone"
order: 0
type: "string"
required:
- "embedding"
- "processing"
- "indexing"
- "destinationType"
title: "Destination Config"
type: "object"
destination-pinecone-update:
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."
groups:
- id: "processing"
title: "Processing"
- id: "embedding"
title: "Embedding"
- id: "indexing"
title: "Indexing"
- id: "advanced"
title: "Advanced"
properties:
embedding:
description: "Embedding configuration"
group: "embedding"
oneOf:
- description: "Use the OpenAI API to embed text. This option is using the\
\ text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
mode:
const: "openai"
default: "openai"
enum:
- "openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
title: "OpenAI API key"
type: "string"
required:
- "openai_key"
- "mode"
title: "OpenAI"
type: "object"
- description: "Use the Cohere API to embed text."
properties:
cohere_key:
airbyte_secret: true
title: "Cohere API key"
type: "string"
mode:
const: "cohere"
default: "cohere"
enum:
- "cohere"
title: "Mode"
type: "string"
required:
- "cohere_key"
- "mode"
title: "Cohere"
type: "object"
- 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."
properties:
mode:
const: "fake"
default: "fake"
enum:
- "fake"
title: "Mode"
type: "string"
required:
- "mode"
title: "Fake"
type: "object"
- description: "Use the Azure-hosted OpenAI API to embed text. This option\
\ is using the text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
api_base:
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"
title: "Resource base URL"
type: "string"
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"
title: "Deployment"
type: "string"
mode:
const: "azure_openai"
default: "azure_openai"
enum:
- "azure_openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
description: "The API key for your Azure OpenAI resource. You can\
\ find this in the Azure portal under your Azure OpenAI resource"
title: "Azure OpenAI API key"
type: "string"
required:
- "openai_key"
- "api_base"
- "deployment"
- "mode"
title: "Azure OpenAI"
type: "object"
- description: "Use a service that's compatible with the OpenAI API to embed\
\ text."
properties:
api_key:
airbyte_secret: true
default: ""
title: "API key"
type: "string"
base_url:
description: "The base URL for your OpenAI-compatible service"
examples:
- "https://your-service-name.com"
title: "Base URL"
type: "string"
dimensions:
description: "The number of dimensions the embedding model is generating"
examples:
- 1536
- 384
title: "Embedding dimensions"
type: "integer"
mode:
const: "openai_compatible"
default: "openai_compatible"
enum:
- "openai_compatible"
title: "Mode"
type: "string"
model_name:
default: "text-embedding-ada-002"
description: "The name of the model to use for embedding"
examples:
- "text-embedding-ada-002"
title: "Model name"
type: "string"
required:
- "base_url"
- "dimensions"
- "mode"
title: "OpenAI-compatible"
type: "object"
title: "Embedding"
type: "object"
indexing:
description: "Pinecone is a popular vector store that can be used to store\
\ and retrieve embeddings."
group: "indexing"
properties:
index:
description: "Pinecone index in your project to load data into"
title: "Index"
type: "string"
pinecone_environment:
description: "Pinecone Cloud environment to use"
examples:
- "us-west1-gcp"
- "gcp-starter"
title: "Pinecone Environment"
type: "string"
pinecone_key:
airbyte_secret: true
description: "The Pinecone API key to use matching the environment (copy\
\ from Pinecone console)"
title: "Pinecone API key"
type: "string"
required:
- "pinecone_key"
- "pinecone_environment"
- "index"
title: "Indexing"
type: "object"
omit_raw_text:
default: false
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."
group: "advanced"
title: "Do not store raw text"
type: "boolean"
processing:
group: "processing"
properties:
chunk_overlap:
default: 0
description: "Size of overlap between chunks in tokens to store in vector\
\ store to better capture relevant context"
title: "Chunk overlap"
type: "integer"
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
title: "Chunk size"
type: "integer"
field_name_mappings:
default: []
description: "List of fields to rename. Not applicable for nested fields,\
\ but can be used to rename fields already flattened via dot notation."
items:
properties:
from_field:
description: "The field name in the source"
title: "From field name"
type: "string"
to_field:
description: "The field name to use in the destination"
title: "To field name"
type: "string"
required:
- "from_field"
- "to_field"
title: "FieldNameMappingConfigModel"
type: "object"
title: "Field name mappings"
type: "array"
metadata_fields:
always_show: true
default: []
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."
examples:
- "age"
- "user"
- "user.name"
items:
type: "string"
title: "Fields to store as metadata"
type: "array"
text_fields:
always_show: true
default: []
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."
examples:
- "text"
- "user.name"
- "users.*.name"
items:
type: "string"
title: "Text fields to embed"
type: "array"
text_splitter:
description: "Split text fields into chunks based on the specified method."
oneOf:
- 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."
properties:
keep_separator:
default: false
description: "Whether to keep the separator in the resulting chunks"
title: "Keep separator"
type: "boolean"
mode:
const: "separator"
default: "separator"
enum:
- "separator"
title: "Mode"
type: "string"
separators:
default:
- "\"\\n\\n\""
- "\"\\n\""
- "\" \""
- "\"\""
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\"."
items:
type: "string"
title: "Separators"
type: "array"
required:
- "mode"
title: "By Separator"
type: "object"
- 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."
properties:
mode:
const: "markdown"
default: "markdown"
enum:
- "markdown"
title: "Mode"
type: "string"
split_level:
default: 1
description: "Level of markdown headers to split text fields by.\
\ Headings down to the specified level will be used as split\
\ points"
maximum: 6
minimum: 1
title: "Split level"
type: "integer"
required:
- "mode"
title: "By Markdown header"
type: "object"
- description: "Split the text by suitable delimiters based on the programming\
\ language. This is useful for splitting code into chunks."
properties:
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"
title: "Language"
type: "string"
mode:
const: "code"
default: "code"
enum:
- "code"
title: "Mode"
type: "string"
required:
- "language"
- "mode"
title: "By Programming Language"
type: "object"
title: "Text splitter"
type: "object"
required:
- "chunk_size"
title: "ProcessingConfigModel"
type: "object"
required:
- "embedding"
- "processing"
- "indexing"
title: "Destination Config"
type: "object"
destination-salesforce:
properties:
auth_type:
const: "Client"
type: "string"
enum:
- "Client"
client_id:
description: "Enter your Salesforce developer application's Client ID."
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Enter your Salesforce developer application's Client secret."
order: 1
title: "Client Secret"
type: "string"
x-speakeasy-param-sensitive: true
is_sandbox:
default: false
description: "Toggle if you're using a Salesforce Sandbox."
order: 3
title: "Is Sandbox"
type: "boolean"
object_storage_config:
oneOf:
- additionalProperties: true
properties:
storage_type:
default: "None"
enum:
- "None"
type: "string"
required:
- "storage_type"
title: "None"
type: "object"
- additionalProperties: true
properties:
access_key_id:
airbyte_secret: true
always_show: true
description: "The access key ID to access the S3 bucket. Airbyte requires\
\ Read and Write permissions to the given bucket. Read more here."
examples:
- "A012345678910EXAMPLE"
order: 1
title: "Access Key ID"
type: "string"
x-speakeasy-param-sensitive: true
bucket_path:
description: "All files in the bucket will be prefixed by this."
examples:
- "prefix/"
order: 7
title: "Prefix Path in the Bucket"
type: "string"
role_arn:
description: "The ARN of the AWS role to assume. Only usable in Airbyte\
\ Cloud."
examples:
- "arn:aws:iam::123456789:role/ExternalIdIsYourWorkspaceId"
order: 3
title: "Role ARN"
type: "string"
s3_bucket_name:
description: "The name of the S3 bucket. Read more here."
examples:
- "airbyte_sync"
order: 4
title: "S3 Bucket Name"
type: "string"
s3_bucket_region:
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"
examples:
- "us-east-1"
order: 5
title: "S3 Bucket Region"
type: "string"
s3_endpoint:
description: "Your S3 endpoint url. Read more here"
examples:
- "http://localhost:9000"
order: 6
title: "S3 Endpoint"
type: "string"
secret_access_key:
airbyte_secret: true
always_show: true
description: "The corresponding secret to the access key ID. Read\
\ more here"
examples:
- "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY"
order: 2
title: "Secret Access Key"
type: "string"
x-speakeasy-param-sensitive: true
storage_type:
default: "S3"
enum:
- "S3"
type: "string"
required:
- "storage_type"
- "s3_bucket_name"
- "s3_bucket_region"
- "bucket_path"
- "format"
title: "S3"
type: "object"
title: "Object Storage Spec"
type: "object"
refresh_token:
airbyte_secret: true
description: "Enter your application's Salesforce Refresh Token used for Airbyte to access your Salesforce\
\ account."
order: 2
title: "Refresh Token"
type: "string"
x-speakeasy-param-sensitive: true
destinationType:
title: "salesforce"
const: "salesforce"
enum:
- "salesforce"
order: 0
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "is_sandbox"
- "auth_type"
- "destinationType"
title: "Salesforce Specification"
type: "object"
destination-salesforce-update:
properties:
auth_type:
const: "Client"
type: "string"
enum:
- "Client"
client_id:
description: "Enter your Salesforce developer application's Client ID."
order: 0
title: "Client ID"
type: "string"
client_secret:
airbyte_secret: true
description: "Enter your Salesforce developer application's Client secret."
order: 1
title: "Client Secret"
type: "string"
is_sandbox:
default: false
description: "Toggle if you're using a Salesforce Sandbox."
order: 3
title: "Is Sandbox"
type: "boolean"
object_storage_config:
oneOf:
- additionalProperties: true
properties:
storage_type:
default: "None"
enum:
- "None"
type: "string"
required:
- "storage_type"
title: "None"
type: "object"
- additionalProperties: true
properties:
access_key_id:
airbyte_secret: true
always_show: true
description: "The access key ID to access the S3 bucket. Airbyte requires\
\ Read and Write permissions to the given bucket. Read more here."
examples:
- "A012345678910EXAMPLE"
order: 1
title: "Access Key ID"
type: "string"
bucket_path:
description: "All files in the bucket will be prefixed by this."
examples:
- "prefix/"
order: 7
title: "Prefix Path in the Bucket"
type: "string"
role_arn:
description: "The ARN of the AWS role to assume. Only usable in Airbyte\
\ Cloud."
examples:
- "arn:aws:iam::123456789:role/ExternalIdIsYourWorkspaceId"
order: 3
title: "Role ARN"
type: "string"
s3_bucket_name:
description: "The name of the S3 bucket. Read more here."
examples:
- "airbyte_sync"
order: 4
title: "S3 Bucket Name"
type: "string"
s3_bucket_region:
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"
examples:
- "us-east-1"
order: 5
title: "S3 Bucket Region"
type: "string"
s3_endpoint:
description: "Your S3 endpoint url. Read more here"
examples:
- "http://localhost:9000"
order: 6
title: "S3 Endpoint"
type: "string"
secret_access_key:
airbyte_secret: true
always_show: true
description: "The corresponding secret to the access key ID. Read\
\ more here"
examples:
- "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY"
order: 2
title: "Secret Access Key"
type: "string"
storage_type:
default: "S3"
enum:
- "S3"
type: "string"
required:
- "storage_type"
- "s3_bucket_name"
- "s3_bucket_region"
- "bucket_path"
- "format"
title: "S3"
type: "object"
title: "Object Storage Spec"
type: "object"
refresh_token:
airbyte_secret: true
description: "Enter your application's Salesforce Refresh Token used for Airbyte to access your Salesforce\
\ account."
order: 2
title: "Refresh Token"
type: "string"
required:
- "client_id"
- "client_secret"
- "refresh_token"
- "is_sandbox"
- "auth_type"
title: "Salesforce Specification"
type: "object"
destination-bigquery:
groups:
- id: "connection"
title: "Connection"
- id: "sync_behavior"
title: "Sync Behavior"
- id: "advanced"
title: "Advanced"
properties:
cdc_deletion_mode:
always_show: true
default: "Hard delete"
description: "Whether to execute CDC deletions as hard deletes (i.e. propagate\
\ source deletions to the destination), or soft deletes (i.e. leave a\
\ tombstone record in the destination). Defaults to hard deletes."
enum:
- "Hard delete"
- "Soft delete"
group: "sync_behavior"
order: 5
title: "CDC deletion mode"
type: "string"
credentials_json:
airbyte_secret: true
always_show: true
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."
group: "connection"
order: 4
title: "Service Account Key JSON (Required for cloud, optional for open-source)"
type: "string"
x-speakeasy-param-sensitive: true
dataset_id:
description: "The default BigQuery Dataset ID that tables are replicated\
\ to if the source does not specify a namespace. Read more here."
group: "connection"
order: 2
title: "Default Dataset ID"
type: "string"
dataset_location:
description: "The location of the dataset. Warning: Changes made after creation\
\ will not be applied. Read more here."
enum:
- "EU"
- "US"
- "africa-south1"
- "asia-east1"
- "asia-east2"
- "asia-northeast1"
- "asia-northeast2"
- "asia-northeast3"
- "asia-south1"
- "asia-south2"
- "asia-southeast1"
- "asia-southeast2"
- "australia-southeast1"
- "australia-southeast2"
- "europe-central2"
- "europe-north1"
- "europe-north2"
- "europe-southwest1"
- "europe-west1"
- "europe-west2"
- "europe-west3"
- "europe-west4"
- "europe-west6"
- "europe-west8"
- "europe-west9"
- "europe-west10"
- "europe-west12"
- "me-central1"
- "me-central2"
- "me-west1"
- "northamerica-northeast1"
- "northamerica-northeast2"
- "northamerica-south1"
- "southamerica-east1"
- "southamerica-west1"
- "us-central1"
- "us-east1"
- "us-east4"
- "us-east5"
- "us-south1"
- "us-west1"
- "us-west2"
- "us-west3"
- "us-west4"
group: "connection"
order: 1
title: "Dataset Location"
type: "string"
disable_type_dedupe:
default: false
description: "Write the legacy \"raw tables\" format, to enable backwards\
\ compatibility with older versions of this connector."
group: "advanced"
order: 7
title: "Legacy raw tables"
type: "boolean"
loading_method:
description: "The way data will be uploaded to BigQuery."
display_type: "radio"
group: "connection"
oneOf:
- additionalProperties: true
description: "Direct loading using batched SQL INSERT statements. This\
\ method uses the BigQuery driver to convert large INSERT statements\
\ into file uploads automatically."
properties:
method:
default: "Standard"
enum:
- "Standard"
type: "string"
required:
- "method"
title: "Batched Standard Inserts"
type: "object"
- additionalProperties: true
description: "Writes large batches of records to a file, uploads the file\
\ to GCS, then uses COPY INTO to load your data into BigQuery."
properties:
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."
oneOf:
- additionalProperties: true
properties:
credential_type:
default: "HMAC_KEY"
enum:
- "HMAC_KEY"
type: "string"
hmac_key_access_id:
airbyte_secret: true
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."
examples:
- "1234567890abcdefghij1234"
order: 0
title: "HMAC Access Key"
type: "string"
x-speakeasy-param-sensitive: true
hmac_key_secret:
airbyte_secret: true
description: "The corresponding secret for the access ID. It\
\ is a 40-character base-64 encoded string."
examples:
- "1234567890abcdefghij1234567890ABCDEFGHIJ"
order: 1
title: "HMAC Secret"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "credential_type"
- "hmac_key_access_id"
- "hmac_key_secret"
title: "HMAC key"
type: "object"
order: 0
title: "Credential"
type: "object"
gcs_bucket_name:
description: "The name of the GCS bucket. Read more here."
examples:
- "airbyte_sync"
order: 1
title: "GCS Bucket Name"
type: "string"
gcs_bucket_path:
description: "Directory under the GCS bucket where data will be written."
examples:
- "data_sync/test"
order: 2
title: "GCS Bucket Path"
type: "string"
keep_files_in_gcs-bucket:
default: "Delete all tmp files from GCS"
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."
enum:
- "Delete all tmp files from GCS"
- "Keep all tmp files in GCS"
order: 3
title: "GCS Tmp Files Post-Processing"
type: "string"
method:
default: "GCS Staging"
enum:
- "GCS Staging"
type: "string"
required:
- "method"
- "credential"
- "gcs_bucket_name"
- "gcs_bucket_path"
title: "GCS Staging"
type: "object"
order: 3
title: "Loading Method"
type: "object"
project_id:
description: "The GCP project ID for the project containing the target BigQuery\
\ dataset. Read more here."
group: "connection"
order: 0
title: "Project ID"
type: "string"
raw_data_dataset:
description: "Airbyte will use this dataset for various internal tables.\
\ In legacy raw tables mode, the raw tables will be stored in this dataset.\
\ Defaults to \"airbyte_internal\"."
group: "advanced"
order: 8
title: "Airbyte Internal Table Dataset Name"
type: "string"
destinationType:
title: "bigquery"
const: "bigquery"
enum:
- "bigquery"
order: 0
type: "string"
required:
- "project_id"
- "dataset_location"
- "dataset_id"
- "destinationType"
title: "Bigquery Specification"
type: "object"
destination-bigquery-update:
groups:
- id: "connection"
title: "Connection"
- id: "sync_behavior"
title: "Sync Behavior"
- id: "advanced"
title: "Advanced"
properties:
cdc_deletion_mode:
always_show: true
default: "Hard delete"
description: "Whether to execute CDC deletions as hard deletes (i.e. propagate\
\ source deletions to the destination), or soft deletes (i.e. leave a\
\ tombstone record in the destination). Defaults to hard deletes."
enum:
- "Hard delete"
- "Soft delete"
group: "sync_behavior"
order: 5
title: "CDC deletion mode"
type: "string"
credentials_json:
airbyte_secret: true
always_show: true
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."
group: "connection"
order: 4
title: "Service Account Key JSON (Required for cloud, optional for open-source)"
type: "string"
dataset_id:
description: "The default BigQuery Dataset ID that tables are replicated\
\ to if the source does not specify a namespace. Read more here."
group: "connection"
order: 2
title: "Default Dataset ID"
type: "string"
dataset_location:
description: "The location of the dataset. Warning: Changes made after creation\
\ will not be applied. Read more here."
enum:
- "EU"
- "US"
- "africa-south1"
- "asia-east1"
- "asia-east2"
- "asia-northeast1"
- "asia-northeast2"
- "asia-northeast3"
- "asia-south1"
- "asia-south2"
- "asia-southeast1"
- "asia-southeast2"
- "australia-southeast1"
- "australia-southeast2"
- "europe-central2"
- "europe-north1"
- "europe-north2"
- "europe-southwest1"
- "europe-west1"
- "europe-west2"
- "europe-west3"
- "europe-west4"
- "europe-west6"
- "europe-west8"
- "europe-west9"
- "europe-west10"
- "europe-west12"
- "me-central1"
- "me-central2"
- "me-west1"
- "northamerica-northeast1"
- "northamerica-northeast2"
- "northamerica-south1"
- "southamerica-east1"
- "southamerica-west1"
- "us-central1"
- "us-east1"
- "us-east4"
- "us-east5"
- "us-south1"
- "us-west1"
- "us-west2"
- "us-west3"
- "us-west4"
group: "connection"
order: 1
title: "Dataset Location"
type: "string"
disable_type_dedupe:
default: false
description: "Write the legacy \"raw tables\" format, to enable backwards\
\ compatibility with older versions of this connector."
group: "advanced"
order: 7
title: "Legacy raw tables"
type: "boolean"
loading_method:
description: "The way data will be uploaded to BigQuery."
display_type: "radio"
group: "connection"
oneOf:
- additionalProperties: true
description: "Direct loading using batched SQL INSERT statements. This\
\ method uses the BigQuery driver to convert large INSERT statements\
\ into file uploads automatically."
properties:
method:
default: "Standard"
enum:
- "Standard"
type: "string"
required:
- "method"
title: "Batched Standard Inserts"
type: "object"
- additionalProperties: true
description: "Writes large batches of records to a file, uploads the file\
\ to GCS, then uses COPY INTO to load your data into BigQuery."
properties:
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."
oneOf:
- additionalProperties: true
properties:
credential_type:
default: "HMAC_KEY"
enum:
- "HMAC_KEY"
type: "string"
hmac_key_access_id:
airbyte_secret: true
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."
examples:
- "1234567890abcdefghij1234"
order: 0
title: "HMAC Access Key"
type: "string"
hmac_key_secret:
airbyte_secret: true
description: "The corresponding secret for the access ID. It\
\ is a 40-character base-64 encoded string."
examples:
- "1234567890abcdefghij1234567890ABCDEFGHIJ"
order: 1
title: "HMAC Secret"
type: "string"
required:
- "credential_type"
- "hmac_key_access_id"
- "hmac_key_secret"
title: "HMAC key"
type: "object"
order: 0
title: "Credential"
type: "object"
gcs_bucket_name:
description: "The name of the GCS bucket. Read more here."
examples:
- "airbyte_sync"
order: 1
title: "GCS Bucket Name"
type: "string"
gcs_bucket_path:
description: "Directory under the GCS bucket where data will be written."
examples:
- "data_sync/test"
order: 2
title: "GCS Bucket Path"
type: "string"
keep_files_in_gcs-bucket:
default: "Delete all tmp files from GCS"
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."
enum:
- "Delete all tmp files from GCS"
- "Keep all tmp files in GCS"
order: 3
title: "GCS Tmp Files Post-Processing"
type: "string"
method:
default: "GCS Staging"
enum:
- "GCS Staging"
type: "string"
required:
- "method"
- "credential"
- "gcs_bucket_name"
- "gcs_bucket_path"
title: "GCS Staging"
type: "object"
order: 3
title: "Loading Method"
type: "object"
project_id:
description: "The GCP project ID for the project containing the target BigQuery\
\ dataset. Read more here."
group: "connection"
order: 0
title: "Project ID"
type: "string"
raw_data_dataset:
description: "Airbyte will use this dataset for various internal tables.\
\ In legacy raw tables mode, the raw tables will be stored in this dataset.\
\ Defaults to \"airbyte_internal\"."
group: "advanced"
order: 8
title: "Airbyte Internal Table Dataset Name"
type: "string"
required:
- "project_id"
- "dataset_location"
- "dataset_id"
title: "Bigquery Specification"
type: "object"
destination-pgvector:
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."
groups:
- id: "processing"
title: "Processing"
- id: "embedding"
title: "Embedding"
- id: "indexing"
title: "Indexing"
- id: "advanced"
title: "Advanced"
properties:
embedding:
description: "Embedding configuration"
group: "embedding"
oneOf:
- description: "Use the OpenAI API to embed text. This option is using the\
\ text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
mode:
const: "openai"
default: "openai"
enum:
- "openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
title: "OpenAI API key"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "openai_key"
- "mode"
title: "OpenAI"
type: "object"
- description: "Use the Cohere API to embed text."
properties:
cohere_key:
airbyte_secret: true
title: "Cohere API key"
type: "string"
x-speakeasy-param-sensitive: true
mode:
const: "cohere"
default: "cohere"
enum:
- "cohere"
title: "Mode"
type: "string"
required:
- "cohere_key"
- "mode"
title: "Cohere"
type: "object"
- 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."
properties:
mode:
const: "fake"
default: "fake"
enum:
- "fake"
title: "Mode"
type: "string"
required:
- "mode"
title: "Fake"
type: "object"
- description: "Use the Azure-hosted OpenAI API to embed text. This option\
\ is using the text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
api_base:
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"
title: "Resource base URL"
type: "string"
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"
title: "Deployment"
type: "string"
mode:
const: "azure_openai"
default: "azure_openai"
enum:
- "azure_openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
description: "The API key for your Azure OpenAI resource. You can\
\ find this in the Azure portal under your Azure OpenAI resource"
title: "Azure OpenAI API key"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "openai_key"
- "api_base"
- "deployment"
- "mode"
title: "Azure OpenAI"
type: "object"
- description: "Use a service that's compatible with the OpenAI API to embed\
\ text."
properties:
api_key:
airbyte_secret: true
default: ""
title: "API key"
type: "string"
x-speakeasy-param-sensitive: true
base_url:
description: "The base URL for your OpenAI-compatible service"
examples:
- "https://your-service-name.com"
title: "Base URL"
type: "string"
dimensions:
description: "The number of dimensions the embedding model is generating"
examples:
- 1536
- 384
title: "Embedding dimensions"
type: "integer"
mode:
const: "openai_compatible"
default: "openai_compatible"
enum:
- "openai_compatible"
title: "Mode"
type: "string"
model_name:
default: "text-embedding-ada-002"
description: "The name of the model to use for embedding"
examples:
- "text-embedding-ada-002"
title: "Model name"
type: "string"
required:
- "base_url"
- "dimensions"
- "mode"
title: "OpenAI-compatible"
type: "object"
title: "Embedding"
type: "object"
indexing:
description: "Postgres can be used to store vector data and retrieve embeddings."
group: "indexing"
properties:
credentials:
properties:
password:
airbyte_secret: true
description: "Enter the password you want to use to access the database"
examples:
- "AIRBYTE_PASSWORD"
order: 7
title: "Password"
type: "string"
x-speakeasy-param-sensitive: true
required:
- "password"
title: "Credentials"
type: "object"
database:
description: "Enter the name of the database that you want to sync data\
\ into"
examples:
- "AIRBYTE_DATABASE"
order: 4
title: "Database"
type: "string"
default_schema:
default: "public"
description: "Enter the name of the default schema"
examples:
- "AIRBYTE_SCHEMA"
order: 5
title: "Default Schema"
type: "string"
host:
description: "Enter the account name you want to use to access the database."
examples:
- "AIRBYTE_ACCOUNT"
order: 1
title: "Host"
type: "string"
port:
default: 5432
description: "Enter the port you want to use to access the database"
examples:
- "5432"
order: 2
title: "Port"
type: "integer"
username:
description: "Enter the name of the user you want to use to access the\
\ database"
examples:
- "AIRBYTE_USER"
order: 6
title: "Username"
type: "string"
required:
- "host"
- "database"
- "username"
- "credentials"
title: "Postgres Connection"
type: "object"
omit_raw_text:
default: false
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."
group: "advanced"
title: "Do not store raw text"
type: "boolean"
processing:
group: "processing"
properties:
chunk_overlap:
default: 0
description: "Size of overlap between chunks in tokens to store in vector\
\ store to better capture relevant context"
title: "Chunk overlap"
type: "integer"
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
title: "Chunk size"
type: "integer"
field_name_mappings:
default: []
description: "List of fields to rename. Not applicable for nested fields,\
\ but can be used to rename fields already flattened via dot notation."
items:
properties:
from_field:
description: "The field name in the source"
title: "From field name"
type: "string"
to_field:
description: "The field name to use in the destination"
title: "To field name"
type: "string"
required:
- "from_field"
- "to_field"
title: "FieldNameMappingConfigModel"
type: "object"
title: "Field name mappings"
type: "array"
metadata_fields:
always_show: true
default: []
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."
examples:
- "age"
- "user"
- "user.name"
items:
type: "string"
title: "Fields to store as metadata"
type: "array"
text_fields:
always_show: true
default: []
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."
examples:
- "text"
- "user.name"
- "users.*.name"
items:
type: "string"
title: "Text fields to embed"
type: "array"
text_splitter:
description: "Split text fields into chunks based on the specified method."
oneOf:
- 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."
properties:
keep_separator:
default: false
description: "Whether to keep the separator in the resulting chunks"
title: "Keep separator"
type: "boolean"
mode:
const: "separator"
default: "separator"
enum:
- "separator"
title: "Mode"
type: "string"
separators:
default:
- "\"\\n\\n\""
- "\"\\n\""
- "\" \""
- "\"\""
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\"."
items:
type: "string"
title: "Separators"
type: "array"
required:
- "mode"
title: "By Separator"
type: "object"
- 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."
properties:
mode:
const: "markdown"
default: "markdown"
enum:
- "markdown"
title: "Mode"
type: "string"
split_level:
default: 1
description: "Level of markdown headers to split text fields by.\
\ Headings down to the specified level will be used as split\
\ points"
maximum: 6
minimum: 1
title: "Split level"
type: "integer"
required:
- "mode"
title: "By Markdown header"
type: "object"
- description: "Split the text by suitable delimiters based on the programming\
\ language. This is useful for splitting code into chunks."
properties:
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"
title: "Language"
type: "string"
mode:
const: "code"
default: "code"
enum:
- "code"
title: "Mode"
type: "string"
required:
- "language"
- "mode"
title: "By Programming Language"
type: "object"
title: "Text splitter"
type: "object"
required:
- "chunk_size"
title: "ProcessingConfigModel"
type: "object"
destinationType:
title: "pgvector"
const: "pgvector"
enum:
- "pgvector"
order: 0
type: "string"
required:
- "embedding"
- "processing"
- "indexing"
- "destinationType"
title: "Destination Config"
type: "object"
destination-pgvector-update:
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."
groups:
- id: "processing"
title: "Processing"
- id: "embedding"
title: "Embedding"
- id: "indexing"
title: "Indexing"
- id: "advanced"
title: "Advanced"
properties:
embedding:
description: "Embedding configuration"
group: "embedding"
oneOf:
- description: "Use the OpenAI API to embed text. This option is using the\
\ text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
mode:
const: "openai"
default: "openai"
enum:
- "openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
title: "OpenAI API key"
type: "string"
required:
- "openai_key"
- "mode"
title: "OpenAI"
type: "object"
- description: "Use the Cohere API to embed text."
properties:
cohere_key:
airbyte_secret: true
title: "Cohere API key"
type: "string"
mode:
const: "cohere"
default: "cohere"
enum:
- "cohere"
title: "Mode"
type: "string"
required:
- "cohere_key"
- "mode"
title: "Cohere"
type: "object"
- 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."
properties:
mode:
const: "fake"
default: "fake"
enum:
- "fake"
title: "Mode"
type: "string"
required:
- "mode"
title: "Fake"
type: "object"
- description: "Use the Azure-hosted OpenAI API to embed text. This option\
\ is using the text-embedding-ada-002 model with 1536 embedding dimensions."
properties:
api_base:
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"
title: "Resource base URL"
type: "string"
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"
title: "Deployment"
type: "string"
mode:
const: "azure_openai"
default: "azure_openai"
enum:
- "azure_openai"
title: "Mode"
type: "string"
openai_key:
airbyte_secret: true
description: "The API key for your Azure OpenAI resource. You can\
\ find this in the Azure portal under your Azure OpenAI resource"
title: "Azure OpenAI API key"
type: "string"
required:
- "openai_key"
- "api_base"
- "deployment"
- "mode"
title: "Azure OpenAI"
type: "object"
- description: "Use a service that's compatible with the OpenAI API to embed\
\ text."
properties:
api_key:
airbyte_secret: true
default: ""
title: "API key"
type: "string"
base_url:
description: "The base URL for your OpenAI-compatible service"
examples:
- "https://your-service-name.com"
title: "Base URL"
type: "string"
dimensions:
description: "The number of dimensions the embedding model is generating"
examples:
- 1536
- 384
title: "Embedding dimensions"
type: "integer"
mode:
const: "openai_compatible"
default: "openai_compatible"
enum:
- "openai_compatible"
title: "Mode"
type: "string"
model_name:
default: "text-embedding-ada-002"
description: "The name of the model to use for embedding"
examples:
- "text-embedding-ada-002"
title: "Model name"
type: "string"
required:
- "base_url"
- "dimensions"
- "mode"
title: "OpenAI-compatible"
type: "object"
title: "Embedding"
type: "object"
indexing:
description: "Postgres can be used to store vector data and retrieve embeddings."
group: "indexing"
properties:
credentials:
properties:
password:
airbyte_secret: true
description: "Enter the password you want to use to access the database"
examples:
- "AIRBYTE_PASSWORD"
order: 7
title: "Password"
type: "string"
required:
- "password"
title: "Credentials"
type: "object"
database:
description: "Enter the name of the database that you want to sync data\
\ into"
examples:
- "AIRBYTE_DATABASE"
order: 4
title: "Database"
type: "string"
default_schema:
default: "public"
description: "Enter the name of the default schema"
examples:
- "AIRBYTE_SCHEMA"
order: 5
title: "Default Schema"
type: "string"
host:
description: "Enter the account name you want to use to access the database."
examples:
- "AIRBYTE_ACCOUNT"
order: 1
title: "Host"
type: "string"
port:
default: 5432
description: "Enter the port you want to use to access the database"
examples:
- "5432"
order: 2
title: "Port"
type: "integer"
username:
description: "Enter the name of the user you want to use to access the\
\ database"
examples:
- "AIRBYTE_USER"
order: 6
title: "Username"
type: "string"
required:
- "host"
- "database"
- "username"
- "credentials"
title: "Postgres Connection"
type: "object"
omit_raw_text:
default: false
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."
group: "advanced"
title: "Do not store raw text"
type: "boolean"
processing:
group: "processing"
properties:
chunk_overlap:
default: 0
description: "Size of overlap between chunks in tokens to store in vector\
\ store to better capture relevant context"
title: "Chunk overlap"
type: "integer"
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
title: "Chunk size"
type: "integer"
field_name_mappings:
default: []
description: "List of fields to rename. Not applicable for nested fields,\
\ but can be used to rename fields already flattened via dot notation."
items:
properties:
from_field:
description: "The field name in the source"
title: "From field name"
type: "string"
to_field:
description: "The field name to use in the destination"
title: "To field name"
type: "string"
required:
- "from_field"
- "to_field"
title: "FieldNameMappingConfigModel"
type: "object"
title: "Field name mappings"
type: "array"
metadata_fields:
always_show: true
default: []
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."
examples:
- "age"
- "user"
- "user.name"
items:
type: "string"
title: "Fields to store as metadata"
type: "array"
text_fields:
always_show: true
default: []
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."
examples:
- "text"
- "user.name"
- "users.*.name"
items:
type: "string"
title: "Text fields to embed"
type: "array"
text_splitter:
description: "Split text fields into chunks based on the specified method."
oneOf:
- 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."
properties:
keep_separator:
default: false
description: "Whether to keep the separator in the resulting chunks"
title: "Keep separator"
type: "boolean"
mode:
const: "separator"
default: "separator"
enum:
- "separator"
title: "Mode"
type: "string"
separators:
default:
- "\"\\n\\n\""
- "\"\\n\""
- "\" \""
- "\"\""
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\"."
items:
type: "string"
title: "Separators"
type: "array"
required:
- "mode"
title: "By Separator"
type: "object"
- 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."
properties:
mode:
const: "markdown"
default: "markdown"
enum:
- "markdown"
title: "Mode"
type: "string"
split_level:
default: 1
description: "Level of markdown headers to split text fields by.\
\ Headings down to the specified level will be used as split\
\ points"
maximum: 6
minimum: 1
title: "Split level"
type: "integer"
required:
- "mode"
title: "By Markdown header"
type: "object"
- description: "Split the text by suitable delimiters based on the programming\
\ language. This is useful for splitting code into chunks."
properties:
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"
title: "Language"
type: "string"
mode:
const: "code"
default: "code"
enum:
- "code"
title: "Mode"
type: "string"
required:
- "language"
- "mode"
title: "By Programming Language"
type: "object"
title: "Text splitter"
type: "object"
required:
- "chunk_size"
title: "ProcessingConfigModel"
type: "object"
required:
- "embedding"
- "processing"
- "indexing"
title: "Destination Config"
type: "object"
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"
requestedScopes:
type: array
description: >-
Optional OAuth scopes to request, overriding the connector's default scopes.
Only supported for connectors that define scopes as an array.
items:
type: string
requestedOptionalScopes:
type: array
description: >-
Optional OAuth optional_scopes to request, overriding the connector's default
optional_scopes. Only applied when requestedScopes is also provided.
items:
type: string
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
- azure-blob-storage
- bing-ads
- drift
- facebook-marketing
- facebook-pages
- gcs
- github
- gitlab
- google-ads
- google-analytics-data-api
- google-drive
- google-search-console
- google-sheets
- hubspot
- instagram
- intercom
- lever-hiring
- linkedin-ads
- mailchimp
- microsoft-onedrive
- microsoft-sharepoint
- microsoft-teams
- monday
- notion
- pinterest
- rd-station-marketing
- salesforce
- sharepoint-enterprise
- slack
- smartsheets
- snapchat-marketing
- surveymonkey
- ticktick
- tiktok-marketing
- trello
- typeform
- youtube-analytics
- zendesk-support
- zendesk-talk
SourceConfiguration:
description: The values required to configure the source.
example: { user: "charles" }
oneOf:
- title: source-aha
$ref: "#/components/schemas/source-aha"
- title: source-100ms
$ref: "#/components/schemas/source-100ms"
- title: source-7shifts
$ref: "#/components/schemas/source-7shifts"
- title: source-activecampaign
$ref: "#/components/schemas/source-activecampaign"
- title: source-acuity-scheduling
$ref: "#/components/schemas/source-acuity-scheduling"
- title: source-adobe-commerce-magento
$ref: "#/components/schemas/source-adobe-commerce-magento"
- title: source-agilecrm
$ref: "#/components/schemas/source-agilecrm"
- title: source-airbyte
$ref: "#/components/schemas/source-airbyte"
- title: source-aircall
$ref: "#/components/schemas/source-aircall"
- title: source-airtable
$ref: "#/components/schemas/source-airtable"
- title: source-akeneo
$ref: "#/components/schemas/source-akeneo"
- title: source-algolia
$ref: "#/components/schemas/source-algolia"
- title: source-alpaca-broker-api
$ref: "#/components/schemas/source-alpaca-broker-api"
- title: source-alpha-vantage
$ref: "#/components/schemas/source-alpha-vantage"
- 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-appcues
$ref: "#/components/schemas/source-appcues"
- title: source-appfigures
$ref: "#/components/schemas/source-appfigures"
- title: source-appfollow
$ref: "#/components/schemas/source-appfollow"
- title: source-apple-search-ads
$ref: "#/components/schemas/source-apple-search-ads"
- title: source-appsflyer
$ref: "#/components/schemas/source-appsflyer"
- title: source-apptivo
$ref: "#/components/schemas/source-apptivo"
- title: source-asana
$ref: "#/components/schemas/source-asana"
- title: source-ashby
$ref: "#/components/schemas/source-ashby"
- title: source-assemblyai
$ref: "#/components/schemas/source-assemblyai"
- title: source-auth0
$ref: "#/components/schemas/source-auth0"
- title: source-aviationstack
$ref: "#/components/schemas/source-aviationstack"
- title: source-awin-advertiser
$ref: "#/components/schemas/source-awin-advertiser"
- 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-babelforce
$ref: "#/components/schemas/source-babelforce"
- title: source-bamboo-hr
$ref: "#/components/schemas/source-bamboo-hr"
- title: source-basecamp
$ref: "#/components/schemas/source-basecamp"
- title: source-beamer
$ref: "#/components/schemas/source-beamer"
- title: source-bigmailer
$ref: "#/components/schemas/source-bigmailer"
- title: source-bigquery
$ref: "#/components/schemas/source-bigquery"
- title: source-bing-ads
$ref: "#/components/schemas/source-bing-ads"
- title: source-bitly
$ref: "#/components/schemas/source-bitly"
- title: source-blogger
$ref: "#/components/schemas/source-blogger"
- title: source-bluetally
$ref: "#/components/schemas/source-bluetally"
- title: source-boldsign
$ref: "#/components/schemas/source-boldsign"
- title: source-box
$ref: "#/components/schemas/source-box"
- title: source-braintree
$ref: "#/components/schemas/source-braintree"
- title: source-braze
$ref: "#/components/schemas/source-braze"
- title: source-breezometer
$ref: "#/components/schemas/source-breezometer"
- title: source-breezy-hr
$ref: "#/components/schemas/source-breezy-hr"
- title: source-brevo
$ref: "#/components/schemas/source-brevo"
- title: source-brex
$ref: "#/components/schemas/source-brex"
- title: source-bugsnag
$ref: "#/components/schemas/source-bugsnag"
- title: source-buildkite
$ref: "#/components/schemas/source-buildkite"
- title: source-bunny-inc
$ref: "#/components/schemas/source-bunny-inc"
- title: source-buzzsprout
$ref: "#/components/schemas/source-buzzsprout"
- title: source-cal-com
$ref: "#/components/schemas/source-cal-com"
- title: source-calendly
$ref: "#/components/schemas/source-calendly"
- title: source-callrail
$ref: "#/components/schemas/source-callrail"
- title: source-campaign-monitor
$ref: "#/components/schemas/source-campaign-monitor"
- title: source-campayn
$ref: "#/components/schemas/source-campayn"
- title: source-canny
$ref: "#/components/schemas/source-canny"
- title: source-capsule-crm
$ref: "#/components/schemas/source-capsule-crm"
- title: source-captain-data
$ref: "#/components/schemas/source-captain-data"
- title: source-care-quality-commission
$ref: "#/components/schemas/source-care-quality-commission"
- title: source-cart
$ref: "#/components/schemas/source-cart"
- title: source-castor-edc
$ref: "#/components/schemas/source-castor-edc"
- title: source-chameleon
$ref: "#/components/schemas/source-chameleon"
- title: source-chargebee
$ref: "#/components/schemas/source-chargebee"
- title: source-chargedesk
$ref: "#/components/schemas/source-chargedesk"
- title: source-chargify
$ref: "#/components/schemas/source-chargify"
- title: source-chartmogul
$ref: "#/components/schemas/source-chartmogul"
- title: source-churnkey
$ref: "#/components/schemas/source-churnkey"
- title: source-cimis
$ref: "#/components/schemas/source-cimis"
- title: source-cin7
$ref: "#/components/schemas/source-cin7"
- title: source-circa
$ref: "#/components/schemas/source-circa"
- title: source-circleci
$ref: "#/components/schemas/source-circleci"
- title: source-cisco-meraki
$ref: "#/components/schemas/source-cisco-meraki"
- title: source-clarif-ai
$ref: "#/components/schemas/source-clarif-ai"
- title: source-clazar
$ref: "#/components/schemas/source-clazar"
- 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-clockodo
$ref: "#/components/schemas/source-clockodo"
- title: source-close-com
$ref: "#/components/schemas/source-close-com"
- title: source-cloudbeds
$ref: "#/components/schemas/source-cloudbeds"
- title: source-coassemble
$ref: "#/components/schemas/source-coassemble"
- title: source-coda
$ref: "#/components/schemas/source-coda"
- title: source-codefresh
$ref: "#/components/schemas/source-codefresh"
- title: source-coin-api
$ref: "#/components/schemas/source-coin-api"
- title: source-coingecko-coins
$ref: "#/components/schemas/source-coingecko-coins"
- title: source-coinmarketcap
$ref: "#/components/schemas/source-coinmarketcap"
- title: source-concord
$ref: "#/components/schemas/source-concord"
- title: source-configcat
$ref: "#/components/schemas/source-configcat"
- title: source-confluence
$ref: "#/components/schemas/source-confluence"
- title: source-convertkit
$ref: "#/components/schemas/source-convertkit"
- title: source-convex
$ref: "#/components/schemas/source-convex"
- title: source-copper
$ref: "#/components/schemas/source-copper"
- title: source-couchbase
$ref: "#/components/schemas/source-couchbase"
- title: source-countercyclical
$ref: "#/components/schemas/source-countercyclical"
- title: source-customer-io
$ref: "#/components/schemas/source-customer-io"
- title: source-customerly
$ref: "#/components/schemas/source-customerly"
- title: source-datadog
$ref: "#/components/schemas/source-datadog"
- title: source-datagen
$ref: "#/components/schemas/source-datagen"
- title: source-datascope
$ref: "#/components/schemas/source-datascope"
- title: source-db2-enterprise
$ref: "#/components/schemas/source-db2-enterprise"
- title: source-dbt
$ref: "#/components/schemas/source-dbt"
- title: source-defillama
$ref: "#/components/schemas/source-defillama"
- title: source-delighted
$ref: "#/components/schemas/source-delighted"
- title: source-deputy
$ref: "#/components/schemas/source-deputy"
- title: source-ding-connect
$ref: "#/components/schemas/source-ding-connect"
- title: source-dixa
$ref: "#/components/schemas/source-dixa"
- title: source-dockerhub
$ref: "#/components/schemas/source-dockerhub"
- title: source-docuseal
$ref: "#/components/schemas/source-docuseal"
- title: source-dolibarr
$ref: "#/components/schemas/source-dolibarr"
- title: source-dremio
$ref: "#/components/schemas/source-dremio"
- title: source-drift
$ref: "#/components/schemas/source-drift"
- title: source-drip
$ref: "#/components/schemas/source-drip"
- title: source-dropbox-sign
$ref: "#/components/schemas/source-dropbox-sign"
- title: source-dwolla
$ref: "#/components/schemas/source-dwolla"
- title: source-dynamodb
$ref: "#/components/schemas/source-dynamodb"
- title: source-e-conomic
$ref: "#/components/schemas/source-e-conomic"
- title: source-easypost
$ref: "#/components/schemas/source-easypost"
- title: source-easypromos
$ref: "#/components/schemas/source-easypromos"
- title: source-ebay-finance
$ref: "#/components/schemas/source-ebay-finance"
- title: source-ebay-fulfillment
$ref: "#/components/schemas/source-ebay-fulfillment"
- title: source-elasticemail
$ref: "#/components/schemas/source-elasticemail"
- title: source-elasticsearch
$ref: "#/components/schemas/source-elasticsearch"
- title: source-emailoctopus
$ref: "#/components/schemas/source-emailoctopus"
- title: source-employment-hero
$ref: "#/components/schemas/source-employment-hero"
- title: source-encharge
$ref: "#/components/schemas/source-encharge"
- title: source-eventbrite
$ref: "#/components/schemas/source-eventbrite"
- title: source-eventee
$ref: "#/components/schemas/source-eventee"
- title: source-eventzilla
$ref: "#/components/schemas/source-eventzilla"
- title: source-everhour
$ref: "#/components/schemas/source-everhour"
- title: source-exchange-rates
$ref: "#/components/schemas/source-exchange-rates"
- title: source-ezofficeinventory
$ref: "#/components/schemas/source-ezofficeinventory"
- title: source-facebook-marketing
$ref: "#/components/schemas/source-facebook-marketing"
- title: source-facebook-pages
$ref: "#/components/schemas/source-facebook-pages"
- title: source-factorial
$ref: "#/components/schemas/source-factorial"
- title: source-faker
$ref: "#/components/schemas/source-faker"
- title: source-fastbill
$ref: "#/components/schemas/source-fastbill"
- title: source-fastly
$ref: "#/components/schemas/source-fastly"
- title: source-fauna
$ref: "#/components/schemas/source-fauna"
- title: source-file
$ref: "#/components/schemas/source-file"
- title: source-fillout
$ref: "#/components/schemas/source-fillout"
- title: source-finage
$ref: "#/components/schemas/source-finage"
- title: source-financial-modelling
$ref: "#/components/schemas/source-financial-modelling"
- title: source-finnhub
$ref: "#/components/schemas/source-finnhub"
- title: source-finnworlds
$ref: "#/components/schemas/source-finnworlds"
- title: source-firebolt
$ref: "#/components/schemas/source-firebolt"
- title: source-firehydrant
$ref: "#/components/schemas/source-firehydrant"
- title: source-fleetio
$ref: "#/components/schemas/source-fleetio"
- title: source-flexmail
$ref: "#/components/schemas/source-flexmail"
- title: source-flexport
$ref: "#/components/schemas/source-flexport"
- title: source-float
$ref: "#/components/schemas/source-float"
- title: source-flowlu
$ref: "#/components/schemas/source-flowlu"
- title: source-formbricks
$ref: "#/components/schemas/source-formbricks"
- title: source-free-agent-connector
$ref: "#/components/schemas/source-free-agent-connector"
- title: source-freightview
$ref: "#/components/schemas/source-freightview"
- title: source-freshbooks
$ref: "#/components/schemas/source-freshbooks"
- title: source-freshcaller
$ref: "#/components/schemas/source-freshcaller"
- title: source-freshchat
$ref: "#/components/schemas/source-freshchat"
- title: source-freshdesk
$ref: "#/components/schemas/source-freshdesk"
- title: source-freshsales
$ref: "#/components/schemas/source-freshsales"
- title: source-freshservice
$ref: "#/components/schemas/source-freshservice"
- title: source-front
$ref: "#/components/schemas/source-front"
- title: source-fulcrum
$ref: "#/components/schemas/source-fulcrum"
- title: source-fullstory
$ref: "#/components/schemas/source-fullstory"
- title: source-gainsight-px
$ref: "#/components/schemas/source-gainsight-px"
- title: source-gcs
$ref: "#/components/schemas/source-gcs"
- title: source-getgist
$ref: "#/components/schemas/source-getgist"
- title: source-getlago
$ref: "#/components/schemas/source-getlago"
- title: source-giphy
$ref: "#/components/schemas/source-giphy"
- title: source-gitbook
$ref: "#/components/schemas/source-gitbook"
- 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-gmail
$ref: "#/components/schemas/source-gmail"
- title: source-gnews
$ref: "#/components/schemas/source-gnews"
- title: source-gocardless
$ref: "#/components/schemas/source-gocardless"
- title: source-goldcast
$ref: "#/components/schemas/source-goldcast"
- title: source-gologin
$ref: "#/components/schemas/source-gologin"
- title: source-gong
$ref: "#/components/schemas/source-gong"
- 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-calendar
$ref: "#/components/schemas/source-google-calendar"
- title: source-google-classroom
$ref: "#/components/schemas/source-google-classroom"
- title: source-google-directory
$ref: "#/components/schemas/source-google-directory"
- title: source-google-drive
$ref: "#/components/schemas/source-google-drive"
- title: source-google-forms
$ref: "#/components/schemas/source-google-forms"
- 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-tasks
$ref: "#/components/schemas/source-google-tasks"
- title: source-google-webfonts
$ref: "#/components/schemas/source-google-webfonts"
- title: source-gorgias
$ref: "#/components/schemas/source-gorgias"
- title: source-greenhouse
$ref: "#/components/schemas/source-greenhouse"
- title: source-greythr
$ref: "#/components/schemas/source-greythr"
- title: source-gridly
$ref: "#/components/schemas/source-gridly"
- title: source-guru
$ref: "#/components/schemas/source-guru"
- title: source-gutendex
$ref: "#/components/schemas/source-gutendex"
- title: source-hardcoded-records
$ref: "#/components/schemas/source-hardcoded-records"
- title: source-harness
$ref: "#/components/schemas/source-harness"
- title: source-harvest
$ref: "#/components/schemas/source-harvest"
- title: source-height
$ref: "#/components/schemas/source-height"
- title: source-hellobaton
$ref: "#/components/schemas/source-hellobaton"
- title: source-help-scout
$ref: "#/components/schemas/source-help-scout"
- title: source-hibob
$ref: "#/components/schemas/source-hibob"
- title: source-high-level
$ref: "#/components/schemas/source-high-level"
- title: source-hoorayhr
$ref: "#/components/schemas/source-hoorayhr"
- title: source-hubplanner
$ref: "#/components/schemas/source-hubplanner"
- title: source-hubspot
$ref: "#/components/schemas/source-hubspot"
- title: source-hugging-face-datasets
$ref: "#/components/schemas/source-hugging-face-datasets"
- title: source-humanitix
$ref: "#/components/schemas/source-humanitix"
- title: source-huntr
$ref: "#/components/schemas/source-huntr"
- title: source-illumina-basespace
$ref: "#/components/schemas/source-illumina-basespace"
- title: source-imagga
$ref: "#/components/schemas/source-imagga"
- title: source-incident-io
$ref: "#/components/schemas/source-incident-io"
- title: source-inflowinventory
$ref: "#/components/schemas/source-inflowinventory"
- title: source-insightful
$ref: "#/components/schemas/source-insightful"
- 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-intruder
$ref: "#/components/schemas/source-intruder"
- title: source-invoiced
$ref: "#/components/schemas/source-invoiced"
- title: source-invoiceninja
$ref: "#/components/schemas/source-invoiceninja"
- title: source-ip2whois
$ref: "#/components/schemas/source-ip2whois"
- title: source-iterable
$ref: "#/components/schemas/source-iterable"
- title: source-jamf-pro
$ref: "#/components/schemas/source-jamf-pro"
- title: source-jira
$ref: "#/components/schemas/source-jira"
- title: source-jobnimbus
$ref: "#/components/schemas/source-jobnimbus"
- title: source-jotform
$ref: "#/components/schemas/source-jotform"
- title: source-judge-me-reviews
$ref: "#/components/schemas/source-judge-me-reviews"
- title: source-just-sift
$ref: "#/components/schemas/source-just-sift"
- title: source-justcall
$ref: "#/components/schemas/source-justcall"
- title: source-k6-cloud
$ref: "#/components/schemas/source-k6-cloud"
- title: source-katana
$ref: "#/components/schemas/source-katana"
- title: source-keka
$ref: "#/components/schemas/source-keka"
- title: source-kisi
$ref: "#/components/schemas/source-kisi"
- title: source-kissmetrics
$ref: "#/components/schemas/source-kissmetrics"
- title: source-klarna
$ref: "#/components/schemas/source-klarna"
- title: source-klaus-api
$ref: "#/components/schemas/source-klaus-api"
- 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-leadfeeder
$ref: "#/components/schemas/source-leadfeeder"
- title: source-lemlist
$ref: "#/components/schemas/source-lemlist"
- title: source-less-annoying-crm
$ref: "#/components/schemas/source-less-annoying-crm"
- title: source-lever-hiring
$ref: "#/components/schemas/source-lever-hiring"
- title: source-lightspeed-retail
$ref: "#/components/schemas/source-lightspeed-retail"
- title: source-linear
$ref: "#/components/schemas/source-linear"
- 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-lob
$ref: "#/components/schemas/source-lob"
- title: source-lokalise
$ref: "#/components/schemas/source-lokalise"
- title: source-looker
$ref: "#/components/schemas/source-looker"
- title: source-luma
$ref: "#/components/schemas/source-luma"
- title: source-mailchimp
$ref: "#/components/schemas/source-mailchimp"
- title: source-mailerlite
$ref: "#/components/schemas/source-mailerlite"
- title: source-mailersend
$ref: "#/components/schemas/source-mailersend"
- title: source-mailgun
$ref: "#/components/schemas/source-mailgun"
- title: source-mailjet-mail
$ref: "#/components/schemas/source-mailjet-mail"
- title: source-mailjet-sms
$ref: "#/components/schemas/source-mailjet-sms"
- title: source-mailosaur
$ref: "#/components/schemas/source-mailosaur"
- title: source-mailtrap
$ref: "#/components/schemas/source-mailtrap"
- title: source-mantle
$ref: "#/components/schemas/source-mantle"
- title: source-marketo
$ref: "#/components/schemas/source-marketo"
- title: source-marketstack
$ref: "#/components/schemas/source-marketstack"
- title: source-mendeley
$ref: "#/components/schemas/source-mendeley"
- title: source-mention
$ref: "#/components/schemas/source-mention"
- title: source-mercado-ads
$ref: "#/components/schemas/source-mercado-ads"
- title: source-merge
$ref: "#/components/schemas/source-merge"
- title: source-metabase
$ref: "#/components/schemas/source-metabase"
- title: source-metricool
$ref: "#/components/schemas/source-metricool"
- title: source-microsoft-dataverse
$ref: "#/components/schemas/source-microsoft-dataverse"
- title: source-microsoft-entra-id
$ref: "#/components/schemas/source-microsoft-entra-id"
- title: source-microsoft-lists
$ref: "#/components/schemas/source-microsoft-lists"
- 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-miro
$ref: "#/components/schemas/source-miro"
- title: source-missive
$ref: "#/components/schemas/source-missive"
- title: source-mixmax
$ref: "#/components/schemas/source-mixmax"
- title: source-mixpanel
$ref: "#/components/schemas/source-mixpanel"
- title: source-mode
$ref: "#/components/schemas/source-mode"
- title: source-monday
$ref: "#/components/schemas/source-monday"
- title: source-mongodb-v2
$ref: "#/components/schemas/source-mongodb-v2"
- title: source-mssql
$ref: "#/components/schemas/source-mssql"
- title: source-mux
$ref: "#/components/schemas/source-mux"
- title: source-my-hours
$ref: "#/components/schemas/source-my-hours"
- title: source-mysql
$ref: "#/components/schemas/source-mysql"
- title: source-n8n
$ref: "#/components/schemas/source-n8n"
- title: source-nasa
$ref: "#/components/schemas/source-nasa"
- title: source-navan
$ref: "#/components/schemas/source-navan"
- title: source-nebius-ai
$ref: "#/components/schemas/source-nebius-ai"
- title: source-netsuite
$ref: "#/components/schemas/source-netsuite"
- title: source-netsuite-enterprise
$ref: "#/components/schemas/source-netsuite-enterprise"
- title: source-news-api
$ref: "#/components/schemas/source-news-api"
- title: source-newsdata
$ref: "#/components/schemas/source-newsdata"
- title: source-newsdata-io
$ref: "#/components/schemas/source-newsdata-io"
- title: source-nexiopay
$ref: "#/components/schemas/source-nexiopay"
- title: source-ninjaone-rmm
$ref: "#/components/schemas/source-ninjaone-rmm"
- title: source-nocrm
$ref: "#/components/schemas/source-nocrm"
- title: source-northpass-lms
$ref: "#/components/schemas/source-northpass-lms"
- title: source-notion
$ref: "#/components/schemas/source-notion"
- title: source-nutshell
$ref: "#/components/schemas/source-nutshell"
- title: source-nylas
$ref: "#/components/schemas/source-nylas"
- 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-oncehub
$ref: "#/components/schemas/source-oncehub"
- title: source-onepagecrm
$ref: "#/components/schemas/source-onepagecrm"
- title: source-onesignal
$ref: "#/components/schemas/source-onesignal"
- title: source-onfleet
$ref: "#/components/schemas/source-onfleet"
- title: source-open-data-dc
$ref: "#/components/schemas/source-open-data-dc"
- title: source-open-exchange-rates
$ref: "#/components/schemas/source-open-exchange-rates"
- title: source-openaq
$ref: "#/components/schemas/source-openaq"
- title: source-openfda
$ref: "#/components/schemas/source-openfda"
- title: source-openweather
$ref: "#/components/schemas/source-openweather"
- title: source-opinion-stage
$ref: "#/components/schemas/source-opinion-stage"
- title: source-opsgenie
$ref: "#/components/schemas/source-opsgenie"
- title: source-opuswatch
$ref: "#/components/schemas/source-opuswatch"
- title: source-oracle
$ref: "#/components/schemas/source-oracle"
- title: source-oracle-enterprise
$ref: "#/components/schemas/source-oracle-enterprise"
- title: source-orb
$ref: "#/components/schemas/source-orb"
- title: source-oura
$ref: "#/components/schemas/source-oura"
- title: source-outbrain-amplify
$ref: "#/components/schemas/source-outbrain-amplify"
- title: source-outlook
$ref: "#/components/schemas/source-outlook"
- title: source-outreach
$ref: "#/components/schemas/source-outreach"
- title: source-oveit
$ref: "#/components/schemas/source-oveit"
- title: source-pabbly-subscriptions-billing
$ref: "#/components/schemas/source-pabbly-subscriptions-billing"
- title: source-paddle
$ref: "#/components/schemas/source-paddle"
- title: source-pagerduty
$ref: "#/components/schemas/source-pagerduty"
- title: source-pandadoc
$ref: "#/components/schemas/source-pandadoc"
- title: source-paperform
$ref: "#/components/schemas/source-paperform"
- title: source-papersign
$ref: "#/components/schemas/source-papersign"
- title: source-pardot
$ref: "#/components/schemas/source-pardot"
- title: source-partnerize
$ref: "#/components/schemas/source-partnerize"
- title: source-partnerstack
$ref: "#/components/schemas/source-partnerstack"
- title: source-payfit
$ref: "#/components/schemas/source-payfit"
- 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-pennylane
$ref: "#/components/schemas/source-pennylane"
- title: source-perigon
$ref: "#/components/schemas/source-perigon"
- title: source-persistiq
$ref: "#/components/schemas/source-persistiq"
- title: source-persona
$ref: "#/components/schemas/source-persona"
- title: source-pexels-api
$ref: "#/components/schemas/source-pexels-api"
- title: source-phyllo
$ref: "#/components/schemas/source-phyllo"
- title: source-picqer
$ref: "#/components/schemas/source-picqer"
- title: source-pingdom
$ref: "#/components/schemas/source-pingdom"
- title: source-pinterest
$ref: "#/components/schemas/source-pinterest"
- title: source-pipedrive
$ref: "#/components/schemas/source-pipedrive"
- title: source-pipeliner
$ref: "#/components/schemas/source-pipeliner"
- title: source-pivotal-tracker
$ref: "#/components/schemas/source-pivotal-tracker"
- title: source-piwik
$ref: "#/components/schemas/source-piwik"
- title: source-plaid
$ref: "#/components/schemas/source-plaid"
- title: source-planhat
$ref: "#/components/schemas/source-planhat"
- title: source-plausible
$ref: "#/components/schemas/source-plausible"
- 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-poplar
$ref: "#/components/schemas/source-poplar"
- 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-pretix
$ref: "#/components/schemas/source-pretix"
- title: source-primetric
$ref: "#/components/schemas/source-primetric"
- title: source-printify
$ref: "#/components/schemas/source-printify"
- title: source-productboard
$ref: "#/components/schemas/source-productboard"
- title: source-productive
$ref: "#/components/schemas/source-productive"
- 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-rd-station-marketing
$ref: "#/components/schemas/source-rd-station-marketing"
- 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-reddit
$ref: "#/components/schemas/source-reddit"
- title: source-redshift
$ref: "#/components/schemas/source-redshift"
- title: source-referralhero
$ref: "#/components/schemas/source-referralhero"
- title: source-rentcast
$ref: "#/components/schemas/source-rentcast"
- title: source-repairshopr
$ref: "#/components/schemas/source-repairshopr"
- title: source-reply-io
$ref: "#/components/schemas/source-reply-io"
- title: source-retailexpress-by-maropost
$ref: "#/components/schemas/source-retailexpress-by-maropost"
- title: source-retently
$ref: "#/components/schemas/source-retently"
- title: source-revenuecat
$ref: "#/components/schemas/source-revenuecat"
- title: source-revolut-merchant
$ref: "#/components/schemas/source-revolut-merchant"
- title: source-ringcentral
$ref: "#/components/schemas/source-ringcentral"
- title: source-rki-covid
$ref: "#/components/schemas/source-rki-covid"
- title: source-rocket-chat
$ref: "#/components/schemas/source-rocket-chat"
- title: source-rocketlane
$ref: "#/components/schemas/source-rocketlane"
- title: source-rollbar
$ref: "#/components/schemas/source-rollbar"
- title: source-rootly
$ref: "#/components/schemas/source-rootly"
- title: source-rss
$ref: "#/components/schemas/source-rss"
- title: source-ruddr
$ref: "#/components/schemas/source-ruddr"
- title: source-s3
$ref: "#/components/schemas/source-s3"
- title: source-safetyculture
$ref: "#/components/schemas/source-safetyculture"
- title: source-sage-hr
$ref: "#/components/schemas/source-sage-hr"
- title: source-salesflare
$ref: "#/components/schemas/source-salesflare"
- 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-sap-hana-enterprise
$ref: "#/components/schemas/source-sap-hana-enterprise"
- title: source-savvycal
$ref: "#/components/schemas/source-savvycal"
- title: source-scryfall
$ref: "#/components/schemas/source-scryfall"
- title: source-secoda
$ref: "#/components/schemas/source-secoda"
- title: source-segment
$ref: "#/components/schemas/source-segment"
- title: source-sendgrid
$ref: "#/components/schemas/source-sendgrid"
- title: source-sendinblue
$ref: "#/components/schemas/source-sendinblue"
- title: source-sendowl
$ref: "#/components/schemas/source-sendowl"
- title: source-sendpulse
$ref: "#/components/schemas/source-sendpulse"
- title: source-senseforce
$ref: "#/components/schemas/source-senseforce"
- title: source-sentry
$ref: "#/components/schemas/source-sentry"
- title: source-serpstat
$ref: "#/components/schemas/source-serpstat"
- title: source-service-now
$ref: "#/components/schemas/source-service-now"
- title: source-sftp
$ref: "#/components/schemas/source-sftp"
- title: source-sftp-bulk
$ref: "#/components/schemas/source-sftp-bulk"
- title: source-sharepoint-enterprise
$ref: "#/components/schemas/source-sharepoint-enterprise"
- title: source-sharetribe
$ref: "#/components/schemas/source-sharetribe"
- title: source-shippo
$ref: "#/components/schemas/source-shippo"
- title: source-shipstation
$ref: "#/components/schemas/source-shipstation"
- title: source-shopify
$ref: "#/components/schemas/source-shopify"
- title: source-shopwired
$ref: "#/components/schemas/source-shopwired"
- title: source-shortcut
$ref: "#/components/schemas/source-shortcut"
- title: source-shortio
$ref: "#/components/schemas/source-shortio"
- title: source-shutterstock
$ref: "#/components/schemas/source-shutterstock"
- title: source-sigma-computing
$ref: "#/components/schemas/source-sigma-computing"
- title: source-signnow
$ref: "#/components/schemas/source-signnow"
- title: source-simfin
$ref: "#/components/schemas/source-simfin"
- title: source-simplecast
$ref: "#/components/schemas/source-simplecast"
- title: source-simplesat
$ref: "#/components/schemas/source-simplesat"
- 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-smartreach
$ref: "#/components/schemas/source-smartreach"
- title: source-smartsheets
$ref: "#/components/schemas/source-smartsheets"
- title: source-smartwaiver
$ref: "#/components/schemas/source-smartwaiver"
- title: source-snapchat-marketing
$ref: "#/components/schemas/source-snapchat-marketing"
- title: source-snowflake
$ref: "#/components/schemas/source-snowflake"
- title: source-solarwinds-service-desk
$ref: "#/components/schemas/source-solarwinds-service-desk"
- title: source-sonar-cloud
$ref: "#/components/schemas/source-sonar-cloud"
- title: source-spacex-api
$ref: "#/components/schemas/source-spacex-api"
- title: source-sparkpost
$ref: "#/components/schemas/source-sparkpost"
- title: source-split-io
$ref: "#/components/schemas/source-split-io"
- title: source-spotify-ads
$ref: "#/components/schemas/source-spotify-ads"
- title: source-spotlercrm
$ref: "#/components/schemas/source-spotlercrm"
- title: source-square
$ref: "#/components/schemas/source-square"
- title: source-squarespace
$ref: "#/components/schemas/source-squarespace"
- title: source-statsig
$ref: "#/components/schemas/source-statsig"
- title: source-statuspage
$ref: "#/components/schemas/source-statuspage"
- title: source-stockdata
$ref: "#/components/schemas/source-stockdata"
- 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-survicate
$ref: "#/components/schemas/source-survicate"
- title: source-svix
$ref: "#/components/schemas/source-svix"
- title: source-systeme
$ref: "#/components/schemas/source-systeme"
- title: source-taboola
$ref: "#/components/schemas/source-taboola"
- title: source-tavus
$ref: "#/components/schemas/source-tavus"
- title: source-teamtailor
$ref: "#/components/schemas/source-teamtailor"
- title: source-teamwork
$ref: "#/components/schemas/source-teamwork"
- title: source-tempo
$ref: "#/components/schemas/source-tempo"
- title: source-testrail
$ref: "#/components/schemas/source-testrail"
- title: source-the-guardian-api
$ref: "#/components/schemas/source-the-guardian-api"
- title: source-thinkific
$ref: "#/components/schemas/source-thinkific"
- title: source-thinkific-courses
$ref: "#/components/schemas/source-thinkific-courses"
- title: source-thrive-learning
$ref: "#/components/schemas/source-thrive-learning"
- title: source-ticketmaster
$ref: "#/components/schemas/source-ticketmaster"
- title: source-tickettailor
$ref: "#/components/schemas/source-tickettailor"
- title: source-ticktick
$ref: "#/components/schemas/source-ticktick"
- title: source-tiktok-marketing
$ref: "#/components/schemas/source-tiktok-marketing"
- title: source-timely
$ref: "#/components/schemas/source-timely"
- title: source-tinyemail
$ref: "#/components/schemas/source-tinyemail"
- title: source-tmdb
$ref: "#/components/schemas/source-tmdb"
- title: source-todoist
$ref: "#/components/schemas/source-todoist"
- title: source-toggl
$ref: "#/components/schemas/source-toggl"
- title: source-track-pms
$ref: "#/components/schemas/source-track-pms"
- title: source-trello
$ref: "#/components/schemas/source-trello"
- title: source-tremendous
$ref: "#/components/schemas/source-tremendous"
- title: source-trustpilot
$ref: "#/components/schemas/source-trustpilot"
- title: source-tvmaze-schedule
$ref: "#/components/schemas/source-tvmaze-schedule"
- title: source-twelve-data
$ref: "#/components/schemas/source-twelve-data"
- 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-tyntec-sms
$ref: "#/components/schemas/source-tyntec-sms"
- title: source-typeform
$ref: "#/components/schemas/source-typeform"
- title: source-ubidots
$ref: "#/components/schemas/source-ubidots"
- title: source-unleash
$ref: "#/components/schemas/source-unleash"
- title: source-uppromote
$ref: "#/components/schemas/source-uppromote"
- title: source-uptick
$ref: "#/components/schemas/source-uptick"
- title: source-us-census
$ref: "#/components/schemas/source-us-census"
- title: source-uservoice
$ref: "#/components/schemas/source-uservoice"
- title: source-vantage
$ref: "#/components/schemas/source-vantage"
- title: source-veeqo
$ref: "#/components/schemas/source-veeqo"
- title: source-vercel
$ref: "#/components/schemas/source-vercel"
- title: source-visma-economic
$ref: "#/components/schemas/source-visma-economic"
- title: source-vitally
$ref: "#/components/schemas/source-vitally"
- title: source-vwo
$ref: "#/components/schemas/source-vwo"
- title: source-waiteraid
$ref: "#/components/schemas/source-waiteraid"
- title: source-wasabi-stats-api
$ref: "#/components/schemas/source-wasabi-stats-api"
- title: source-watchmode
$ref: "#/components/schemas/source-watchmode"
- title: source-weatherstack
$ref: "#/components/schemas/source-weatherstack"
- title: source-web-scrapper
$ref: "#/components/schemas/source-web-scrapper"
- title: source-webflow
$ref: "#/components/schemas/source-webflow"
- title: source-when-i-work
$ref: "#/components/schemas/source-when-i-work"
- 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-wordpress
$ref: "#/components/schemas/source-wordpress"
- title: source-workable
$ref: "#/components/schemas/source-workable"
- title: source-workday
$ref: "#/components/schemas/source-workday"
- title: source-workday-rest
$ref: "#/components/schemas/source-workday-rest"
- title: source-workflowmax
$ref: "#/components/schemas/source-workflowmax"
- title: source-workramp
$ref: "#/components/schemas/source-workramp"
- title: source-wrike
$ref: "#/components/schemas/source-wrike"
- title: source-wufoo
$ref: "#/components/schemas/source-wufoo"
- title: source-xkcd
$ref: "#/components/schemas/source-xkcd"
- title: source-xsolla
$ref: "#/components/schemas/source-xsolla"
- title: source-yahoo-finance-price
$ref: "#/components/schemas/source-yahoo-finance-price"
- title: source-yandex-metrica
$ref: "#/components/schemas/source-yandex-metrica"
- title: source-yotpo
$ref: "#/components/schemas/source-yotpo"
- title: source-you-need-a-budget-ynab
$ref: "#/components/schemas/source-you-need-a-budget-ynab"
- title: source-younium
$ref: "#/components/schemas/source-younium"
- title: source-yousign
$ref: "#/components/schemas/source-yousign"
- title: source-youtube-analytics
$ref: "#/components/schemas/source-youtube-analytics"
- title: source-youtube-data
$ref: "#/components/schemas/source-youtube-data"
- title: source-zapier-supported-storage
$ref: "#/components/schemas/source-zapier-supported-storage"
- title: source-zapsign
$ref: "#/components/schemas/source-zapsign"
- title: source-zendesk-chat
$ref: "#/components/schemas/source-zendesk-chat"
- 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-zenefits
$ref: "#/components/schemas/source-zenefits"
- title: source-zenloop
$ref: "#/components/schemas/source-zenloop"
- title: source-zoho-analytics-metadata-api
$ref: "#/components/schemas/source-zoho-analytics-metadata-api"
- title: source-zoho-bigin
$ref: "#/components/schemas/source-zoho-bigin"
- title: source-zoho-billing
$ref: "#/components/schemas/source-zoho-billing"
- title: source-zoho-books
$ref: "#/components/schemas/source-zoho-books"
- title: source-zoho-campaign
$ref: "#/components/schemas/source-zoho-campaign"
- title: source-zoho-crm
$ref: "#/components/schemas/source-zoho-crm"
- title: source-zoho-desk
$ref: "#/components/schemas/source-zoho-desk"
- title: source-zoho-expense
$ref: "#/components/schemas/source-zoho-expense"
- title: source-zoho-inventory
$ref: "#/components/schemas/source-zoho-inventory"
- title: source-zoho-invoice
$ref: "#/components/schemas/source-zoho-invoice"
- title: source-zonka-feedback
$ref: "#/components/schemas/source-zonka-feedback"
- 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-customer-io
$ref: "#/components/schemas/destination-customer-io"
- title: destination-databricks
$ref: "#/components/schemas/destination-databricks"
- title: destination-deepset
$ref: "#/components/schemas/destination-deepset"
- 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-firebolt
$ref: "#/components/schemas/destination-firebolt"
- title: destination-firestore
$ref: "#/components/schemas/destination-firestore"
- title: destination-gcs
$ref: "#/components/schemas/destination-gcs"
- title: destination-hubspot
$ref: "#/components/schemas/destination-hubspot"
- title: destination-milvus
$ref: "#/components/schemas/destination-milvus"
- title: destination-mongodb
$ref: "#/components/schemas/destination-mongodb"
- title: destination-motherduck
$ref: "#/components/schemas/destination-motherduck"
- title: destination-mssql
$ref: "#/components/schemas/destination-mssql"
- title: destination-mssql-v2
$ref: "#/components/schemas/destination-mssql-v2"
- title: destination-mysql
$ref: "#/components/schemas/destination-mysql"
- title: destination-oracle
$ref: "#/components/schemas/destination-oracle"
- title: destination-pgvector
$ref: "#/components/schemas/destination-pgvector"
- 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-data-lake
$ref: "#/components/schemas/destination-s3-data-lake"
- title: destination-salesforce
$ref: "#/components/schemas/destination-salesforce"
- title: destination-sftp-json
$ref: "#/components/schemas/destination-sftp-json"
- title: destination-snowflake
$ref: "#/components/schemas/destination-snowflake"
- title: destination-snowflake-cortex
$ref: "#/components/schemas/destination-snowflake-cortex"
- title: destination-surrealdb
$ref: "#/components/schemas/destination-surrealdb"
- title: destination-teradata
$ref: "#/components/schemas/destination-teradata"
- title: destination-timeplus
$ref: "#/components/schemas/destination-timeplus"
- title: destination-typesense
$ref: "#/components/schemas/destination-typesense"
- title: destination-vectara
$ref: "#/components/schemas/destination-vectara"
- title: destination-weaviate
$ref: "#/components/schemas/destination-weaviate"
- title: destination-yellowbrick
$ref: "#/components/schemas/destination-yellowbrick"
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: azure-blob-storage
$ref: "#/components/schemas/azure-blob-storage"
- title: bing-ads
$ref: "#/components/schemas/bing-ads"
- title: drift
$ref: "#/components/schemas/drift"
- title: facebook-marketing
$ref: "#/components/schemas/facebook-marketing"
- title: facebook-pages
$ref: "#/components/schemas/facebook-pages"
- title: gcs
$ref: "#/components/schemas/gcs"
- 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: 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: rd-station-marketing
$ref: "#/components/schemas/rd-station-marketing"
- title: salesforce
$ref: "#/components/schemas/salesforce"
- title: sharepoint-enterprise
$ref: "#/components/schemas/sharepoint-enterprise"
- 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: surveymonkey
$ref: "#/components/schemas/surveymonkey"
- title: ticktick
$ref: "#/components/schemas/ticktick"
- 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-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
clientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: /applications/token
scopes: {}
security:
- bearerAuth: []
- basicAuth: []
- clientCredentials: []