Skip to content

Latest commit

 

History

History
100 lines (73 loc) · 3.29 KB

source_square.md

File metadata and controls

100 lines (73 loc) · 3.29 KB
page_title subcategory description
airbyte_source_square Resource - terraform-provider-airbyte
SourceSquare Resource

airbyte_source_square (Resource)

SourceSquare Resource

Example Usage

resource "airbyte_source_square" "my_source_square" {
  configuration = {
    credentials = {
      api_key = {
        api_key = "...my_api_key..."
      }
      oauth_authentication = {
        client_id     = "...my_client_id..."
        client_secret = "...my_client_secret..."
        refresh_token = "...my_refresh_token..."
      }
    }
    include_deleted_objects = true
    is_sandbox              = false
    start_date              = "2022-12-06"
  }
  definition_id = "62738d12-88d2-4454-b175-22fec285b6ec"
  name          = "...my_name..."
  secret_id     = "...my_secret_id..."
  workspace_id  = "873caa16-3a7f-42ab-8efd-b0ccb2d1796d"
}

Schema

Required

  • configuration (Attributes) (see below for nested schema)
  • name (String) Name of the source e.g. dev-mysql-instance.
  • workspace_id (String)

Optional

  • definition_id (String) The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
  • secret_id (String) Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Read-Only

  • created_at (Number)
  • source_id (String)
  • source_type (String)

Nested Schema for configuration

Optional:

  • credentials (Attributes) Choose how to authenticate to Square. (see below for nested schema)
  • include_deleted_objects (Boolean) In some streams there is an option to include deleted objects (Items, Categories, Discounts, Taxes). Default: false
  • is_sandbox (Boolean) Determines whether to use the sandbox or production environment. Default: false
  • start_date (String) 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. Default: "2021-01-01"

Nested Schema for configuration.credentials

Optional:

Nested Schema for configuration.credentials.api_key

Required:

  • api_key (String, Sensitive) The API key for a Square application

Nested Schema for configuration.credentials.oauth_authentication

Required:

  • client_id (String, Sensitive) The Square-issued ID of your application
  • client_secret (String, Sensitive) The Square-issued application secret for your application
  • refresh_token (String, Sensitive) A refresh token generated using the above client ID and secret

Import

Import is supported using the following syntax:

terraform import airbyte_source_square.my_airbyte_source_square ""