Skip to content

Commit

Permalink
Test schema
Browse files Browse the repository at this point in the history
  • Loading branch information
mvistry committed Dec 16, 2024
1 parent dba196b commit b4a732c
Show file tree
Hide file tree
Showing 36 changed files with 7,411 additions and 0 deletions.
75 changes: 75 additions & 0 deletions _integration-schemas/square/v1/bank_accounts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
tap: "square"
version: "1"
key: "bank-account"

name: "bank_accounts"
doc-link: "https://developer.squareup.com/reference/square/bank-accounts-api"
singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/bank_accounts.json"
description: |
The `{{ table.name }}` contains information about a merchant's bank account in {{ integration.display_name }}.
**Note**: This table can't be replicated if the **Connect to a sandbox environment** box is checked in the [integration's settings](#add-stitch-data-source) due to limits imposed by {{ integration.display_name }}.
replication-method: "Full Table"

api-method:
name: "List bank accounts (v2)"
doc-link: "https://developer.squareup.com/reference/square/bank-accounts-api/get-bank-account"

attributes:
- name: "id"
type: "string"
primary-key: true
description: "The bank account ID."
foreign-key-id: "bank-account-id"

- name: "account_number_suffix"
type: "string"
description: ""

- name: "account_type"
type: "string"
description: ""

- name: "bank_name"
type: "string"
description: ""

- name: "country"
type: "string"
description: ""

- name: "creditable"
type: "boolean"
description: ""

- name: "currency"
type: "string"
description: ""

- name: "debitable"
type: "boolean"
description: ""

- name: "holder_name"
type: "string"
description: ""

- name: "location_id"
type: "string"
description: "The ID of the location associated with the bank account."
foreign-key-id: "location-id"

- name: "primary_bank_identification_number"
type: "string"
description: ""

- name: "status"
type: "string"
description: ""

- name: "version"
type: "integer"
description: ""
---
80 changes: 80 additions & 0 deletions _integration-schemas/square/v1/cash_drawer_shifts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
tap: "square"
version: "1"
key: "cash-drawer-shift"

name: "cash_drawer_shifts"
doc-link: "https://developer.squareup.com/reference/square/cash-drawers-api/retrieve-cash-drawer-shift#response-body"
singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/cash_drawer_shifts.json"
description: |
The `{{ table.name }}` table contains infomration about cash transactions in {{ integration.display_name }}.
replication-method: "Full Table"

api-method:
name: "Retrieve cash drawer shift (V2)"
doc-link: "https://developer.squareup.com/reference/square/cash-drawers-api/retrieve-cash-drawer-shift"

attributes:
- name: "id"
type: "string"
primary-key: true
description: "The cash drawer shift ID."
# foreign-key-id: "cash-drawer-shift-id"

- name: "closed_at"
type: "date-time"
description: ""

- name: "closed_cash_money"
type: "object"
description: ""
subattributes:
- name: "amount"
type: "integer"
description: ""

- name: "currency"
type: "string"
description: ""

- name: "description"
type: "string"
description: ""

- name: "ended_at"
type: "date-time"
description: ""

- name: "expected_cash_money"
type: "object"
description: ""
subattributes:
- name: "amount"
type: "integer"
description: ""

- name: "currency"
type: "string"
description: ""

- name: "opened_at"
type: "date-time"
description: ""

- name: "opened_cash_money"
type: "object"
description: ""
subattributes:
- name: "amount"
type: "integer"
description: ""

- name: "currency"
type: "string"
description: ""

- name: "state"
type: "string"
description: ""
---
62 changes: 62 additions & 0 deletions _integration-schemas/square/v1/categories.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
tap: "square"
version: "1"
key: "category"

name: "categories"
doc-link: "https://developer.squareup.com/reference/square/catalog-api/v1-list-categories"
singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/categories.json"
description: |
The `{{ table.name }}` table contains information about item categories for a given location in {{ integration.display_name }}.
replication-method: "Key-based Incremental"

api-method:
name: "List catalog (`type: category`) (V2)"
doc-link: "https://developer.squareup.com/reference/square/catalog-api/list-catalog"

attributes:
- name: "id"
type: "string"
primary-key: true
description: "The category ID."
foreign-key-id: "category-id"

- name: "updated_at"
type: "date-time"
description: ""
replication-key: true

- name: "absent_at_location_ids"
type: "array"
description: ""
subattributes:
- name: "value"
type: "string"
description: ""
foreign-key-id: "location-id"

- name: "category_data"
type: "object"
description: ""
subattributes:
- name: "name"
type: "string"
description: ""

- name: "is_deleted"
type: "boolean"
description: ""

- name: "present_at_all_locations"
type: "boolean"
description: ""

- name: "type"
type: "string"
description: ""

- name: "version"
type: "integer"
description: ""
---
101 changes: 101 additions & 0 deletions _integration-schemas/square/v1/customers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
---
tap: "square"
version: "1"
key: "square"

name: "customers"
doc-link: "https://developer.squareup.com/reference/square/customers-api/list-customers"
singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/customers.json"
description: |
The `{{ table.name }}` contains information about customer profiles associated with your {{ integration.display_name }} account.
replication-method: "Key-based Incremental"

api-method:
name: "List customers (v2)"
doc-link: "https://developer.squareup.com/reference/square/customers-api/list-customers"

attributes:
- name: "id"
type: "string"
primary-key: true
description: "The customer ID."
foreign-key-id: "customer-id"

- name: "updated_at"
type: "date-time"
replication-key: true
description: ""

- name: "address"
type: "object"
description: ""
subattributes:
- name: "locality"
type: "string"
description: ""

- name: "administrative_district_level_1"
type: "string"
description: ""

- name: "country"
type: "string"
description: ""

- name: "address_line_1"
type: "string"
description: ""

- name: "postal_code"
type: "string"
description: ""

- name: "birthday"
type: "date-time"
description: ""

- name: "company_name"
type: "string"
description: ""

- name: "created_at"
type: "date-time"
description: ""

- name: "creation_source"
type: "string"
description: ""

- name: "email_address"
type: "string"
description: ""

- name: "family_name"
type: "string"
description: ""

- name: "given_name"
type: "string"
description: ""

- name: "nickname"
type: "string"
description: ""

- name: "note"
type: "string"
description: ""

- name: "phone_number"
type: "string"
description: ""

- name: "preferences"
type: "object"
description: ""
subattributes:
- name: "email_unsubscribed"
type: "boolean"
description: ""
---
Loading

0 comments on commit b4a732c

Please sign in to comment.