Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceSquare
airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq
airbytehq/terraform-provider-airbyte

airbyte.SourceSquare

Explore with Pulumi AI

airbyte logo
airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq
airbytehq/terraform-provider-airbyte

    SourceSquare Resource

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.SourceSquare;
import com.pulumi.airbyte.SourceSquareArgs;
import com.pulumi.airbyte.inputs.SourceSquareConfigurationArgs;
import com.pulumi.airbyte.inputs.SourceSquareConfigurationCredentialsArgs;
import com.pulumi.airbyte.inputs.SourceSquareConfigurationCredentialsApiKeyArgs;
import com.pulumi.airbyte.inputs.SourceSquareConfigurationCredentialsOauthAuthenticationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var mySourceSquare = new SourceSquare("mySourceSquare", SourceSquareArgs.builder()
            .configuration(SourceSquareConfigurationArgs.builder()
                .credentials(SourceSquareConfigurationCredentialsArgs.builder()
                    .apiKey(SourceSquareConfigurationCredentialsApiKeyArgs.builder()
                        .apiKey("...my_api_key...")
                        .build())
                    .oauthAuthentication(SourceSquareConfigurationCredentialsOauthAuthenticationArgs.builder()
                        .clientId("...my_client_id...")
                        .clientSecret("...my_client_secret...")
                        .refreshToken("...my_refresh_token...")
                        .build())
                    .build())
                .include_deleted_objects(true)
                .is_sandbox(false)
                .start_date("2022-12-06")
                .build())
            .definitionId("62738d12-88d2-4454-b175-22fec285b6ec")
            .secretId("...my_secret_id...")
            .workspaceId("873caa16-3a7f-42ab-8efd-b0ccb2d1796d")
            .build());

    }
}

    resources:
  mySourceSquare:
    type: airbyte:SourceSquare
    properties:
      configuration:
        credentials:
          apiKey:
            apiKey: '...my_api_key...'
          oauthAuthentication:
            clientId: '...my_client_id...'
            clientSecret: '...my_client_secret...'
            refreshToken: '...my_refresh_token...'
        include_deleted_objects: true
        is_sandbox: false
        start_date: 2022-12-06
      definitionId: 62738d12-88d2-4454-b175-22fec285b6ec
      secretId: '...my_secret_id...'
      workspaceId: 873caa16-3a7f-42ab-8efd-b0ccb2d1796d

    Create SourceSquare Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SourceSquare(name: string, args: SourceSquareArgs, opts?: CustomResourceOptions);
    @overload
def SourceSquare(resource_name: str,
                 args: SourceSquareArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def SourceSquare(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 configuration: Optional[SourceSquareConfigurationArgs] = None,
                 workspace_id: Optional[str] = None,
                 definition_id: Optional[str] = None,
                 name: Optional[str] = None,
                 secret_id: Optional[str] = None)
    func NewSourceSquare(ctx *Context, name string, args SourceSquareArgs, opts ...ResourceOption) (*SourceSquare, error)
    public SourceSquare(string name, SourceSquareArgs args, CustomResourceOptions? opts = null)
    public SourceSquare(String name, SourceSquareArgs args)
public SourceSquare(String name, SourceSquareArgs args, CustomResourceOptions options)

    type: airbyte:SourceSquare
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SourceSquareArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SourceSquareArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SourceSquareArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SourceSquareArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SourceSquareArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var sourceSquareResource = new Airbyte.SourceSquare("sourceSquareResource", new()
{
    Configuration = new Airbyte.Inputs.SourceSquareConfigurationArgs
    {
        Credentials = new Airbyte.Inputs.SourceSquareConfigurationCredentialsArgs
        {
            ApiKey = new Airbyte.Inputs.SourceSquareConfigurationCredentialsApiKeyArgs
            {
                ApiKey = "string",
            },
            OauthAuthentication = new Airbyte.Inputs.SourceSquareConfigurationCredentialsOauthAuthenticationArgs
            {
                ClientId = "string",
                ClientSecret = "string",
                RefreshToken = "string",
            },
        },
        IncludeDeletedObjects = false,
        IsSandbox = false,
        StartDate = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

    example, err := airbyte.NewSourceSquare(ctx, "sourceSquareResource", &airbyte.SourceSquareArgs{
Configuration: &.SourceSquareConfigurationArgs{
Credentials: &.SourceSquareConfigurationCredentialsArgs{
ApiKey: &.SourceSquareConfigurationCredentialsApiKeyArgs{
ApiKey: pulumi.String("string"),
},
OauthAuthentication: &.SourceSquareConfigurationCredentialsOauthAuthenticationArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
RefreshToken: pulumi.String("string"),
},
},
IncludeDeletedObjects: pulumi.Bool(false),
IsSandbox: pulumi.Bool(false),
StartDate: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

    var sourceSquareResource = new SourceSquare("sourceSquareResource", SourceSquareArgs.builder()
    .configuration(SourceSquareConfigurationArgs.builder()
        .credentials(SourceSquareConfigurationCredentialsArgs.builder()
            .apiKey(SourceSquareConfigurationCredentialsApiKeyArgs.builder()
                .apiKey("string")
                .build())
            .oauthAuthentication(SourceSquareConfigurationCredentialsOauthAuthenticationArgs.builder()
                .clientId("string")
                .clientSecret("string")
                .refreshToken("string")
                .build())
            .build())
        .includeDeletedObjects(false)
        .isSandbox(false)
        .startDate("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

    source_square_resource = airbyte.SourceSquare("sourceSquareResource",
    configuration={
        "credentials": {
            "api_key": {
                "api_key": "string",
            },
            "oauth_authentication": {
                "client_id": "string",
                "client_secret": "string",
                "refresh_token": "string",
            },
        },
        "include_deleted_objects": False,
        "is_sandbox": False,
        "start_date": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

    const sourceSquareResource = new airbyte.SourceSquare("sourceSquareResource", {
    configuration: {
        credentials: {
            apiKey: {
                apiKey: "string",
            },
            oauthAuthentication: {
                clientId: "string",
                clientSecret: "string",
                refreshToken: "string",
            },
        },
        includeDeletedObjects: false,
        isSandbox: false,
        startDate: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

    type: airbyte:SourceSquare
properties:
    configuration:
        credentials:
            apiKey:
                apiKey: string
            oauthAuthentication:
                clientId: string
                clientSecret: string
                refreshToken: string
        includeDeletedObjects: false
        isSandbox: false
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

    SourceSquare Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SourceSquare resource accepts the following input properties:

    Configuration SourceSquareConfiguration
    WorkspaceId string
    DefinitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    Name string
    Name of the source e.g. dev-mysql-instance.
    SecretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    Configuration SourceSquareConfigurationArgs
    WorkspaceId string
    DefinitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    Name string
    Name of the source e.g. dev-mysql-instance.
    SecretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    configuration SourceSquareConfiguration
    workspaceId String
    definitionId String
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name String
    Name of the source e.g. dev-mysql-instance.
    secretId String
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    configuration SourceSquareConfiguration
    workspaceId string
    definitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name string
    Name of the source e.g. dev-mysql-instance.
    secretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    configuration SourceSquareConfigurationArgs
    workspace_id str
    definition_id str
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name str
    Name of the source e.g. dev-mysql-instance.
    secret_id str
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    configuration Property Map
    workspaceId String
    definitionId String
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name String
    Name of the source e.g. dev-mysql-instance.
    secretId String
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SourceSquare resource produces the following output properties:

    CreatedAt double
    Id string
    The provider-assigned unique ID for this managed resource.
    SourceId string
    SourceType string
    CreatedAt float64
    Id string
    The provider-assigned unique ID for this managed resource.
    SourceId string
    SourceType string
    createdAt Double
    id String
    The provider-assigned unique ID for this managed resource.
    sourceId String
    sourceType String
    createdAt number
    id string
    The provider-assigned unique ID for this managed resource.
    sourceId string
    sourceType string
    created_at float
    id str
    The provider-assigned unique ID for this managed resource.
    source_id str
    source_type str
    createdAt Number
    id String
    The provider-assigned unique ID for this managed resource.
    sourceId String
    sourceType String

    Look up Existing SourceSquare Resource

    Get an existing SourceSquare resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SourceSquareState, opts?: CustomResourceOptions): SourceSquare
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceSquareConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceSquare
    func GetSourceSquare(ctx *Context, name string, id IDInput, state *SourceSquareState, opts ...ResourceOption) (*SourceSquare, error)
    public static SourceSquare Get(string name, Input<string> id, SourceSquareState? state, CustomResourceOptions? opts = null)
    public static SourceSquare get(String name, Output<String> id, SourceSquareState state, CustomResourceOptions options)
    resources:  _:    type: airbyte:SourceSquare    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Configuration SourceSquareConfiguration
    CreatedAt double
    DefinitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    Name string
    Name of the source e.g. dev-mysql-instance.
    SecretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    SourceId string
    SourceType string
    WorkspaceId string
    Configuration SourceSquareConfigurationArgs
    CreatedAt float64
    DefinitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    Name string
    Name of the source e.g. dev-mysql-instance.
    SecretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    SourceId string
    SourceType string
    WorkspaceId string
    configuration SourceSquareConfiguration
    createdAt Double
    definitionId String
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name String
    Name of the source e.g. dev-mysql-instance.
    secretId String
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    sourceId String
    sourceType String
    workspaceId String
    configuration SourceSquareConfiguration
    createdAt number
    definitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name string
    Name of the source e.g. dev-mysql-instance.
    secretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    sourceId string
    sourceType string
    workspaceId string
    configuration SourceSquareConfigurationArgs
    created_at float
    definition_id str
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name str
    Name of the source e.g. dev-mysql-instance.
    secret_id str
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    source_id str
    source_type str
    workspace_id str
    configuration Property Map
    createdAt Number
    definitionId String
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name String
    Name of the source e.g. dev-mysql-instance.
    secretId String
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    sourceId String
    sourceType String
    workspaceId String

    Supporting Types

    SourceSquareConfiguration, SourceSquareConfigurationArgs

    Credentials SourceSquareConfigurationCredentials
    Choose how to authenticate to Square.
    IncludeDeletedObjects bool
    In some streams there is an option to include deleted objects (Items, Categories, Discounts, Taxes). Default: false
    IsSandbox bool
    Determines whether to use the sandbox or production environment. Default: false
    StartDate 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"
    Credentials SourceSquareConfigurationCredentials
    Choose how to authenticate to Square.
    IncludeDeletedObjects bool
    In some streams there is an option to include deleted objects (Items, Categories, Discounts, Taxes). Default: false
    IsSandbox bool
    Determines whether to use the sandbox or production environment. Default: false
    StartDate 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"
    credentials SourceSquareConfigurationCredentials
    Choose how to authenticate to Square.
    includeDeletedObjects Boolean
    In some streams there is an option to include deleted objects (Items, Categories, Discounts, Taxes). Default: false
    isSandbox Boolean
    Determines whether to use the sandbox or production environment. Default: false
    startDate 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"
    credentials SourceSquareConfigurationCredentials
    Choose how to authenticate to Square.
    includeDeletedObjects boolean
    In some streams there is an option to include deleted objects (Items, Categories, Discounts, Taxes). Default: false
    isSandbox boolean
    Determines whether to use the sandbox or production environment. Default: false
    startDate 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"
    credentials SourceSquareConfigurationCredentials
    Choose how to authenticate to Square.
    include_deleted_objects bool
    In some streams there is an option to include deleted objects (Items, Categories, Discounts, Taxes). Default: false
    is_sandbox bool
    Determines whether to use the sandbox or production environment. Default: false
    start_date str
    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"
    credentials Property Map
    Choose how to authenticate to Square.
    includeDeletedObjects Boolean
    In some streams there is an option to include deleted objects (Items, Categories, Discounts, Taxes). Default: false
    isSandbox Boolean
    Determines whether to use the sandbox or production environment. Default: false
    startDate 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"

    SourceSquareConfigurationCredentials, SourceSquareConfigurationCredentialsArgs

    SourceSquareConfigurationCredentialsApiKey, SourceSquareConfigurationCredentialsApiKeyArgs

    ApiKey string
    The API key for a Square application
    ApiKey string
    The API key for a Square application
    apiKey String
    The API key for a Square application
    apiKey string
    The API key for a Square application
    api_key str
    The API key for a Square application
    apiKey String
    The API key for a Square application

    SourceSquareConfigurationCredentialsOauthAuthentication, SourceSquareConfigurationCredentialsOauthAuthenticationArgs

    ClientId string
    The Square-issued ID of your application
    ClientSecret string
    The Square-issued application secret for your application
    RefreshToken string
    A refresh token generated using the above client ID and secret
    ClientId string
    The Square-issued ID of your application
    ClientSecret string
    The Square-issued application secret for your application
    RefreshToken string
    A refresh token generated using the above client ID and secret
    clientId String
    The Square-issued ID of your application
    clientSecret String
    The Square-issued application secret for your application
    refreshToken String
    A refresh token generated using the above client ID and secret
    clientId string
    The Square-issued ID of your application
    clientSecret string
    The Square-issued application secret for your application
    refreshToken string
    A refresh token generated using the above client ID and secret
    client_id str
    The Square-issued ID of your application
    client_secret str
    The Square-issued application secret for your application
    refresh_token str
    A refresh token generated using the above client ID and secret
    clientId String
    The Square-issued ID of your application
    clientSecret String
    The Square-issued application secret for your application
    refreshToken String
    A refresh token generated using the above client ID and secret

    Import

    $ pulumi import airbyte:index/sourceSquare:SourceSquare my_airbyte_source_square ""

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    airbyte airbytehq/terraform-provider-airbyte
    License
    Notes
    This Pulumi package is based on the airbyte Terraform Provider.
    airbyte logo
    airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq
    airbytehq/terraform-provider-airbyte