67a8c05b7f
* Removed comma from the value of order field for square source connector specification, which was causing it to be a String instead of an Integer * increment connector version * add changelog entry --------- Co-authored-by: Sunny Hashmi <6833405+sh4sh@users.noreply.github.com>
115 lines
3.4 KiB
YAML
115 lines
3.4 KiB
YAML
documentationUrl: https://docs.airbyte.com/integrations/sources/square
|
|
connectionSpecification:
|
|
$schema: http://json-schema.org/draft-07/schema#
|
|
title: Square Spec
|
|
type: object
|
|
required:
|
|
- is_sandbox
|
|
additionalProperties: true
|
|
properties:
|
|
credentials:
|
|
title: Authentication
|
|
description: Choose how to authenticate to Square.
|
|
type: object
|
|
order: 0
|
|
oneOf:
|
|
- title: Oauth authentication
|
|
type: object
|
|
required:
|
|
- auth_type
|
|
- client_id
|
|
- client_secret
|
|
- refresh_token
|
|
properties:
|
|
auth_type:
|
|
type: string
|
|
const: OAuth
|
|
order: 0
|
|
client_id:
|
|
type: string
|
|
title: Client ID
|
|
description: The Square-issued ID of your application
|
|
airbyte_secret: true
|
|
client_secret:
|
|
type: string
|
|
title: Client Secret
|
|
description: The Square-issued application secret for your application
|
|
airbyte_secret: true
|
|
refresh_token:
|
|
title: Refresh Token
|
|
type: string
|
|
description: A refresh token generated using the above client ID and secret
|
|
airbyte_secret: true
|
|
- title: API key
|
|
type: object
|
|
required:
|
|
- auth_type
|
|
- api_key
|
|
properties:
|
|
auth_type:
|
|
type: string
|
|
const: API Key
|
|
order: 1
|
|
api_key:
|
|
type: string
|
|
title: API key token
|
|
description: The API key for a Square application
|
|
airbyte_secret: true
|
|
is_sandbox:
|
|
type: boolean
|
|
description: Determines whether to use the sandbox or production environment.
|
|
title: Sandbox
|
|
default: false
|
|
order: 1
|
|
start_date:
|
|
type: string
|
|
description: UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated. If not set, all data will be replicated.
|
|
title: Start Date
|
|
default: "2021-01-01"
|
|
pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
|
|
order: 2
|
|
format: date
|
|
include_deleted_objects:
|
|
type: boolean
|
|
description: In some streams there is an option to include deleted objects (Items, Categories, Discounts, Taxes)
|
|
title: Include Deleted Objects
|
|
default: false
|
|
order: 3
|
|
advanced_auth:
|
|
auth_flow_type: oauth2.0
|
|
predicate_key:
|
|
- credentials
|
|
- auth_type
|
|
predicate_value: OAuth
|
|
oauth_config_specification:
|
|
complete_oauth_output_specification:
|
|
type: object
|
|
additionalProperties: false
|
|
properties:
|
|
refresh_token:
|
|
type: string
|
|
path_in_connector_config:
|
|
- credentials
|
|
- refresh_token
|
|
complete_oauth_server_input_specification:
|
|
type: object
|
|
additionalProperties: false
|
|
properties:
|
|
client_id:
|
|
type: string
|
|
client_secret:
|
|
type: string
|
|
complete_oauth_server_output_specification:
|
|
type: object
|
|
additionalProperties: false
|
|
properties:
|
|
client_id:
|
|
type: string
|
|
path_in_connector_config:
|
|
- credentials
|
|
- client_id
|
|
client_secret:
|
|
type: string
|
|
path_in_connector_config:
|
|
- credentials
|
|
- client_secret |