Square

tap-square (singer-io variant)🥈

Financial and Merchant Services

The tap-square extractor pulls data from Square that can then be sent to a destination using a loader.

Alternate Implementations

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-square extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-square --variant singer-io
  3. Configure the tap-square settings using
    meltano config
    :
  4. meltano config tap-square set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-square test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-square may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

  • catalog
  • discover
  • state

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-square settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can also list these settings using

meltano config
with the list subcommand:

meltano config tap-square list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Client ID (client_id)

  • Environment variable: TAP_SQUARE_CLIENT_ID

Your client ID.


Configure this setting directly using the following Meltano command:

meltano config tap-square set client_id [value]

Client Secret (client_secret)

  • Environment variable: TAP_SQUARE_CLIENT_SECRET

Your client secret.


Configure this setting directly using the following Meltano command:

meltano config tap-square set client_secret [value]

Refresh Token (refresh_token)

  • Environment variable: TAP_SQUARE_REFRESH_TOKEN

Your refresh token.


Configure this setting directly using the following Meltano command:

meltano config tap-square set refresh_token [value]

Sandbox (sandbox)

  • Environment variable: TAP_SQUARE_SANDBOX

Whether to use a sandbox account or not. Default, False.


Configure this setting directly using the following Meltano command:

meltano config tap-square set sandbox [value]

Start Date (start_date)

  • Environment variable: TAP_SQUARE_START_DATE

Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.


Configure this setting directly using the following Meltano command:

meltano config tap-square set start_date [value]

User Agent (user_agent)

  • Environment variable: TAP_SQUARE_USER_AGENT

The user agent to send with requests.


Configure this setting directly using the following Meltano command:

meltano config tap-square set user_agent [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-square extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the
#plugins-general
channel.

Install

meltano add extractor tap-square --variant singer-io

Maintenance Status

  • Maintenance Status

Repo

https://github.com/singer-io/tap-square
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Stitch Data

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

Keywords

  • api