diff --git a/_integration-schemas/square/v1/bank_accounts.md b/_integration-schemas/square/v1/bank_accounts.md new file mode 100644 index 000000000..7ba6efed3 --- /dev/null +++ b/_integration-schemas/square/v1/bank_accounts.md @@ -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: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v1/cash_drawer_shifts.md b/_integration-schemas/square/v1/cash_drawer_shifts.md new file mode 100644 index 000000000..d2224c831 --- /dev/null +++ b/_integration-schemas/square/v1/cash_drawer_shifts.md @@ -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: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v1/categories.md b/_integration-schemas/square/v1/categories.md new file mode 100644 index 000000000..9f599b0f4 --- /dev/null +++ b/_integration-schemas/square/v1/categories.md @@ -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: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v1/customers.md b/_integration-schemas/square/v1/customers.md new file mode 100644 index 000000000..2794473fb --- /dev/null +++ b/_integration-schemas/square/v1/customers.md @@ -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: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v1/discounts.md b/_integration-schemas/square/v1/discounts.md new file mode 100644 index 000000000..86c647579 --- /dev/null +++ b/_integration-schemas/square/v1/discounts.md @@ -0,0 +1,98 @@ +--- +tap: "square" +version: "1" +key: "discount" + +name: "discounts" +doc-link: "" +singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/discounts.json" +description: | + The `{{ table.name }}` table contains information about discounts for a given location in {{ integration.display_name }}. + +replication-method: "Key-based Incremental" + +api-method: + name: "List catalog (`type: discount`) (V2)" + doc-link: "https://developer.squareup.com/reference/square/catalog-api/list-catalog" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The discount ID." + # foreign-key-id: "discount-id" + + - name: "updated_at" + type: "date-time" + replication-key: true + description: "The time the location was last updated." + + - name: "absent_at_location_ids" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "The IDs of locations where the discount isn't applicable." + foreign-key-id: "location-id" + + - name: "discount_data" + type: "object" + description: "" + subattributes: + - name: "amount_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "application_method" + type: "string" + description: "" + + - name: "discount_type" + type: "string" + description: "" + + - name: "label_color" + type: "string" + description: "" + + - name: "modify_tax_basis" + type: "string" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "percentage" + type: "string" + description: "" + + - name: "pin_required" + type: "boolean" + 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: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v1/employees.md b/_integration-schemas/square/v1/employees.md new file mode 100644 index 000000000..658e32a92 --- /dev/null +++ b/_integration-schemas/square/v1/employees.md @@ -0,0 +1,61 @@ +--- +tap: "square" +version: "1" +key: "employee" + +name: "employees" +doc-link: "https://developer.squareup.com/reference/square/employees-api" +singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/employees.json" +description: | + The `{{ table.name }}` table contains information about your employees in {{ integration.display_name }}. + +replication-method: "Full Table" + +api-method: + name: "List employees (V1)" + doc-link: "https://developer.squareup.com/reference/square/employees-api/v1-list-employees" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The employee ID." + foreign-key-id: "employee-id" + + - name: "created_at" + type: "date-time" + description: "" + + - name: "email" + type: "string" + description: "" + + - name: "first_name" + type: "string" + description: "" + + - name: "is_owner" + type: "boolean" + description: "" + + - name: "last_name" + type: "string" + description: "" + + - name: "location_ids" + type: "array" + description: "A list of locations associated with the employee." + subattributes: + - name: "value" + type: "string" + description: "The ID of the location associated with the employee." + foreign-key-id: "location-id" + + - name: "status" + type: "string" + description: "" + + - name: "updated_at" + type: "date-time" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v1/foreign-keys.md b/_integration-schemas/square/v1/foreign-keys.md new file mode 100644 index 000000000..d4f426597 --- /dev/null +++ b/_integration-schemas/square/v1/foreign-keys.md @@ -0,0 +1,218 @@ +--- +# -------------------------- # +# USING THIS TEMPLATE # +# -------------------------- # + +## NEED HELP USING THIS TEMPLATE? SEE: +## https://docs-about-stitch-docs.netlify.com/reference/integration-templates/saas-foreign-keys/ +## FOR INSTRUCTIONS & REFERENCE INFO + +tap-reference: "square" + +version: "1" + +foreign-keys: + - id: "bank-account-id" + table: "bank_accounts" + attribute: "id" + all-foreign-keys: + - table: "bank_accounts" + join-on: "id" + - table: "settlements" + join-on: "bank_account_id" + + # - id: "cash-drawer-id" + # table: "cash_drawer_shifts" + # attribute: "id" + # all-foreign-keys: + # - table: "" + # join-on: "" + + - id: "category-id" + table: "categories" + attribute: "category_id" + all-foreign-keys: + - table: "categories" + join-on: "id" + - table: "items" + subattribute: "item_data" + + - id: "discount-id" + table: "discounts" + attribute: "" + all-foreign-keys: + - table: "discounts" + join-on: "id" + + - id: "employee-id" + table: "employees" + attribute: "id" + all-foreign-keys: + - table: "employees" + join-on: "id" + - table: "shifts" + join-on: "employee_id" + + - id: "item-id" + table: "items" + attribute: "item_id" + all-foreign-keys: + - table: "items" + join-on: "id" + + - table: "items" + subattribute: "item_data.variations.item_variation_data" + + - table: "orders" + subattribute: "item_data.variations.item_variation_data" + + - id: "location-id" + table: "locations" + attribute: "id" + all-foreign-keys: + - table: "bank_accounts" + - table: "categories" + subattribute: "absent_at_location_ids" + join-on: "value" + + - table: "discounts" + subattribute: "absent_at_location_ids" + join-on: "value" + + - table: "employees" + subattribute: "location_ids" + join-on: "value" + + - table: "inventories" + + - table: "items" + subattribute: "absent_at_location_ids" + join-on: "value" + + - table: "items" + subattribute: "item_data.variations.item_variation_data.location_overrides" + + - table: "items" + subattribute: "item_data.variations.item_variation_data.present_at_location_ids" + join-on: "value" + + - table: "items" + subattribute: "present_at_location_ids" + join-on: "value" + + - table: "location" + join-on: "id" + + - table: "modifier_lists" + subattribute: "absent_at_location_ids" + join-on: "value" + + - table: "orders" + subattribute: "item_data.variations.item_variation_data.item_variation_data.location_overrides" + + - table: "orders" + + - table: "orders" + subattribute: "refunds" + + - table: "orders" + subattribute: "tenders" + + - table: "payments" + + - table: "refunds" + + - table: "shifts" + + - table: "taxes" + subattribute: "absent_at_location_ids" + join-on: "value" + + - id: "modifier-list-id" + table: "modifier_lists" + attribute: "modifier_list_id" + all-foreign-keys: + - table: "items" + subattribute: "item_data.modifier_list_info" + + - table: "modifier_lists" + join-on: "id" + - table: "modifier_lists" + subattribute: "modifier_list_data.modifiers.modifier_data" + + - id: "order-id" + table: "orders" + attribute: "id" + all-foreign-keys: + - table: "orders" + join-on: "id" + - table: "orders" + join-on: "order_id" + - table: "orders" + subattribute: "returns" + join-on: "source_order_id" + - table: "payments" + join-on: "order_id" + - table: "refunds" + join-on: "order_id" + + - id: "payment-id" + table: "payments" + attribute: "id" + all-foreign-keys: + - table: "orders" + join-on: "payment_id" + - table: "orders" + subattribute: "tenders" + - table: "payments" + join-on: "id" + - table: "refunds" + join-on: "payment_id" + + - id: "refund-id" + table: "refunds" + attribute: "id" + all-foreign-keys: + - table: "orders" + subattribute: "refund_ids" + join-on: "value" + - table: "orders" + subattribute: "refunds" + join-on: "id" + - table: "payments" + join-on: "order_id" + - table: "payments" + subattribute: "refund_ids" + join-on: "value" + - table: "refunds" + join-on: "id" + + - id: "role-id" + table: "roles" + attribute: "id" + all-foreign-keys: + - table: "roles" + join-on: "id" + + - id: "tax-id" + table: "taxes" + attribute: "id" + all-foreign-keys: + - table: "items" + subattribute: "item_data.tax_ids" + join-on: "value" + + - table: "taxes" + join-on: "id" + + - id: "tender-id" + table: "" + attribute: "tender_id" + all-foreign-keys: + - table: "orders" + - table: "orders" + subattribute: "refunds" + - table: "orders" + subattribute: "tenders" + join-on: "id" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v1/inventories.md b/_integration-schemas/square/v1/inventories.md new file mode 100644 index 000000000..64472ce9b --- /dev/null +++ b/_integration-schemas/square/v1/inventories.md @@ -0,0 +1,44 @@ +--- +tap: "square" +version: "1" +key: "inventory" + +name: "inventories" +doc-link: "https://developer.squareup.com/reference/square/inventory-api" +singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/inventories.json" +description: | + The `{{ table.name }}` table contains info about the current calculated stock count for a {{ integration.display_name }} location. + +replication-method: "Full Table" +loading-behavior: "Append-Only" + +api-method: + name: "Retrieve inventory count (V2)" + doc-link: "https://developer.squareup.com/reference/square/inventory-api/retrieve-inventory-count" + +attributes: + - name: "calculated_at" + type: "date-time" + description: "" + + - name: "catalog_object_id" + type: "string" + description: "" + + - name: "catalog_object_type" + type: "string" + description: "" + + - name: "location_id" + type: "string" + description: "The ID of the location associated with the inventory." + foreign-key-id: "location-id" + + - name: "quantity" + type: "string" + description: "" + + - name: "state" + type: "string" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v1/items.md b/_integration-schemas/square/v1/items.md new file mode 100644 index 000000000..915c71736 --- /dev/null +++ b/_integration-schemas/square/v1/items.md @@ -0,0 +1,249 @@ +--- +tap: "square" +version: "1" +key: "item" + +name: "items" +doc-link: "https://developer.squareup.com/reference/square/catalog-api" +singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/items.json" +description: | + The `{{ table.name }}` table contains information about items for a given location in {{ integration.display_name }}. + +replication-method: "Key-based Incremental" + +api-method: + name: "List catalog (`type: item`) (V2)" + doc-link: "https://developer.squareup.com/reference/square/catalog-api/list-catalog" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The item ID." + foreign-key-id: "item-id" + + - name: "updated_at" + type: "date-time" + description: "The time the item was last updated." + replication-key: true + + - name: "absent_at_location_ids" + type: "array" + description: "A list of locations where the item is unavailable." + subattributes: + - name: "value" + type: "string" + description: "The ID of the location where the item is unavailable." + foreign-key-id: "location-id" + + - name: "is_deleted" + type: "boolean" + description: "" + + - name: "item_data" + type: "object" + description: "" + subattributes: + - name: "abbreviation" + type: "string" + description: "" + + - name: "available_electronically" + type: "boolean" + description: "" + + - name: "available_for_pickup" + type: "boolean" + description: "" + + - name: "available_online" + type: "boolean" + description: "" + + - name: "category_id" + type: "string" + description: "" + foreign-key-id: "category-id" + + - name: "description" + type: "string" + description: "" + + - name: "item_options" + type: "array" + description: "" + subattributes: + - name: "item_option_id" + type: "string" + description: "" + + - name: "label_color" + type: "string" + description: "" + + - name: "modifier_list_info" + type: "array" + description: "" + subattributes: + - name: "enabled" + type: "boolean" + description: "" + + - name: "modifier_list_id" + type: "string" + description: "" + foreign-key-id: "modifier-list-id" + + - name: "name" + type: "string" + description: "" + + - name: "product_type" + type: "string" + description: "" + + - name: "skip_modifier_screen" + type: "boolean" + description: "" + + - name: "tax_ids" + type: "array" + description: "A list of taxes enabled for the item." + subattributes: + - name: "value" + type: "string" + description: "The ID of the tax enabled for the item." + foreign-key-id: "tax-id" + + - name: "variations" + type: "array" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + + - name: "is_deleted" + type: "boolean" + description: "" + + - name: "item_variation_data" + type: "object" + description: "" + subattributes: + - name: "inventory_alert_type" + type: "string" + description: "" + + - name: "item_id" + type: "string" + description: "The item ID." + foreign-key-id: "item-id" + + - name: "location_overrides" + type: "array" + description: "" + subattributes: + - name: "inventory_alert_threshold" + type: "integer" + description: "" + + - name: "inventory_alert_type" + type: "string" + description: "" + + - name: "location_id" + type: "string" + description: "The location ID." + foreign-key-id: "location-id" + + - name: "track_inventory" + type: "boolean" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "ordinal" + type: "integer" + description: "" + + - name: "price_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "pricing_type" + type: "string" + description: "" + + - name: "sku" + type: "string" + description: "" + + - name: "track_inventory" + type: "boolean" + description: "" + + - name: "user_data" + type: "string" + description: "" + + - name: "present_at_all_locations" + type: "boolean" + description: "" + + - name: "present_at_location_ids" + type: "array" + description: "A list of locations where the item is available." + subattributes: + - name: "value" + type: "string" + description: "The ID of the location where the item is available." + foreign-key-id: "location-id" + + - name: "type" + type: "string" + description: "" + + - name: "updated_at" + type: "date-time" + description: "" + + - name: "version" + type: "integer" + description: "" + + - name: "visibility" + type: "string" + description: "" + + - name: "present_at_all_locations" + type: "boolean" + description: "" + + - name: "present_at_location_ids" + type: "array" + description: "A list of locations where the item is available." + subattributes: + - name: "value" + type: "string" + description: "The location IDs where the items are available." + foreign-key-id: "location-id" + + - name: "type" + type: "string" + description: "" + + - name: "version" + type: "integer" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v1/locations.md b/_integration-schemas/square/v1/locations.md new file mode 100644 index 000000000..504894599 --- /dev/null +++ b/_integration-schemas/square/v1/locations.md @@ -0,0 +1,201 @@ +--- +tap: "square" +version: "1" +key: "location" + +name: "locations" +doc-link: "https://developer.squareup.com/reference/square/locations-api" +singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/locations.json" +description: | + The `{{ table.name }}` table contains information about all of your business locations in {{ integration.display_name }}. + +replication-method: "Full Table" + +api-method: + name: "List locations (V2)" + doc-link: "https://developer.squareup.com/reference/square/locations-api/list-locations" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The location ID." + foreign-key-id: "location-id" + + - name: "address" + type: "object" + description: "" + subattributes: + - name: "address_line_1" + type: "string" + description: "" + + - name: "address_line_2" + type: "string" + description: "" + + - name: "address_line_3" + type: "string" + description: "" + + - name: "administrative_district_level_1" + type: "string" + description: "" + + - name: "administrative_district_level_2" + type: "string" + description: "" + + - name: "administrative_district_level_3" + type: "string" + description: "" + + - name: "country" + type: "string" + description: "" + + - name: "first_name" + type: "string" + description: "" + + - name: "last_name" + type: "string" + description: "" + + - name: "locality" + type: "string" + description: "" + + - name: "organization" + type: "string" + description: "" + + - name: "postal_code" + type: "string" + description: "" + + - name: "sublocality" + type: "string" + description: "" + + - name: "sublocality_2" + type: "string" + description: "" + + - name: "sublocality_3" + type: "string" + description: "" + + - name: "business_email" + type: "string" + description: "" + + - name: "business_hours" + type: "object" + description: "" + subattributes: + - name: "periods" + type: "array" + description: "" + subattributes: + - name: "day_of_week" + type: "string" + description: "" + + - name: "end_local_time" + type: "string" + description: "" + + - name: "start_local_time" + type: "string" + description: "" + + - name: "business_name" + type: "string" + description: "" + + - name: "capabilities" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + + - name: "coordinates" + type: "object" + description: "" + subattributes: + - name: "latitude" + type: "singer-decimal" + description: "" + + - name: "longitude" + type: "singer-decimal" + description: "" + + - name: "country" + type: "string" + description: "" + + - name: "created_at" + type: "date-time" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "description" + type: "string" + description: "" + + - name: "facebook_url" + type: "string" + description: "" + + - name: "instagram_username" + type: "string" + description: "" + + - name: "language_code" + type: "string" + description: "" + + - name: "mcc" + type: "string" + description: "" + + - name: "merchant_id" + type: "string" + description: "" + # foreign-key-id: "merchant-id" + + - name: "name" + type: "string" + description: "" + + - name: "phone_number" + type: "string" + description: "" + + - name: "status" + type: "string" + description: "" + + - name: "timezone" + type: "string" + description: "" + + - name: "twitter_username" + type: "string" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "website_url" + type: "string" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v1/modifier_lists.md b/_integration-schemas/square/v1/modifier_lists.md new file mode 100644 index 000000000..52193d9e7 --- /dev/null +++ b/_integration-schemas/square/v1/modifier_lists.md @@ -0,0 +1,131 @@ +--- +tap: "square" +version: "1" +key: "modifier-list" + +name: "modifier_lists" +doc-link: "https://developer.squareup.com/reference/square/catalog-api/v1-list-modifier-lists" +singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/modifier_lists.json" +description: | + The `{{ table.name }}` table contains information about modifier lists for a given location in {{ integration.display_name }}. + +replication-method: "Key-based Incremental" + +api-method: + name: "List catalog (`type: modifier_list`) (V2)" + doc-link: "https://developer.squareup.com/reference/square/catalog-api/list-catalog" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The modifier list ID." + foreign-key-id: "modifier-list-id" + + - name: "updated_at" + type: "date-time" + description: "The time the modifier list was last updated." + replication-key: true + + - name: "absent_at_location_ids" + type: "array" + description: "A list of locations where the modifier list is unavailable." + subattributes: + - name: "value" + type: "string" + description: "The ID of the location where modifier list is unavailable." + foreign-key-id: "location-id" + + - name: "is_deleted" + type: "boolean" + description: "" + + - name: "modifier_list_data" + type: "object" + description: "" + subattributes: + - name: "modifiers" + type: "array" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + + - name: "is_deleted" + type: "boolean" + description: "" + + - name: "modifier_data" + type: "object" + description: "" + subattributes: + - name: "modifier_list_id" + type: "string" + description: "The modifier list ID." + foreign-key-id: "modifier-list-id" + + - name: "name" + type: "string" + description: "" + + - name: "on_by_default" + type: "boolean" + description: "" + + - name: "ordinal" + type: "integer" + description: "" + + - name: "price_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "present_at_all_locations" + type: "boolean" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "updated_at" + type: "date-time" + description: "" + + - name: "version" + type: "integer" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "ordinal" + type: "integer" + description: "" + + - name: "selection_type" + type: "string" + description: "" + + - name: "present_at_all_locations" + type: "boolean" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "version" + type: "integer" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v1/orders.md b/_integration-schemas/square/v1/orders.md new file mode 100644 index 000000000..8a211a56a --- /dev/null +++ b/_integration-schemas/square/v1/orders.md @@ -0,0 +1,854 @@ +--- +tap: "square" +version: "1" +key: "order" + +name: "orders" +doc-link: "https://developer.squareup.com/reference/square/orders-api" +singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/orders.json" +description: | + The `{{ table.name }}` table contains information about order updates in {{ integration.display_name }}. + +replication-method: "Key-based Incremental" + +api-method: + name: "Search orders (V2)" + doc-link: "https://developer.squareup.com/reference/square/orders-api/search-orders" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The order ID." + foreign-key-id: "order-id" + + - name: "updated_at" + type: "date-time" + description: "" + replication-key: true + + - name: "amount_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "card_details" + type: "object" + description: "" + subattributes: + - name: "avs_status" + type: "string" + description: "" + + - name: "card" + type: "object" + description: "" + subattributes: + - name: "bin" + type: "string" + description: "" + + - name: "card_brand" + type: "string" + description: "" + + - name: "card_type" + type: "string" + description: "" + + - name: "exp_month" + type: "integer" + description: "" + + - name: "exp_year" + type: "integer" + description: "" + + - name: "fingerprint" + type: "string" + description: "" + + - name: "last_4" + type: "string" + description: "" + + - name: "prepaid_type" + type: "string" + description: "" + + - name: "cvv_status" + type: "string" + description: "" + + - name: "entry_method" + type: "string" + description: "" + + - name: "statement_description" + type: "string" + description: "" + + - name: "status" + type: "string" + description: "" + + - name: "category_data" + type: "object" + description: "" + subattributes: + - name: "name" + type: "string" + description: "" + + - name: "closed_at" + type: "date-time" + description: "" + + - name: "created_at" + type: "date-time" + description: "" + + - name: "delay_action" + type: "string" + description: "" + + - name: "delay_duration" + type: "string" + description: "" + + - name: "delayed_until" + type: "string" + description: "" + + - name: "discount_data" + type: "object" + description: "" + subattributes: + - name: "amount_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "discount_type" + type: "string" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "fulfillments" + type: "array" + description: "" + subattributes: + - name: "pickup_details" + type: "object" + description: "" + subattributes: + - name: "canceled_at" + type: "date-time" + description: "" + + - name: "expired_at" + type: "date-time" + description: "" + + - name: "expires_at" + type: "date-time" + description: "" + + - name: "note" + type: "string" + description: "" + + - name: "pickup_at" + type: "date-time" + description: "" + + - name: "recipient" + type: "object" + description: "" + subattributes: + - name: "display_name" + type: "string" + description: "" + + - name: "rejected_at" + type: "date-time" + description: "" + + - name: "state" + type: "string" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "uid" + type: "string" + description: "" + + - name: "is_deleted" + type: "boolean" + description: "" + + - name: "line_items" + type: "array" + description: "" + subattributes: + - name: "base_price_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "catalog_object_id" + type: "string" + description: "" + + - name: "gross_sales_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "note" + type: "string" + description: "" + + - name: "quantity" + type: "string" + description: "" + + - name: "total_discount_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "total_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "total_tax_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "uid" + type: "string" + description: "" + + - name: "variation_name" + type: "string" + description: "" + + - name: "variation_total_price_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "location_id" + type: "string" + description: "The ID of the location associated with the order." + foreign-key-id: "location-id" + + - name: "net_amounts" + type: "object" + description: "" + subattributes: + - name: "discount_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "service_charge_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "tax_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "tip_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "total_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "note" + type: "string" + description: "" + + - name: "order_id" + type: "string" + description: "The order ID." + foreign-key-id: "order-id" + + - name: "payment_id" + type: "string" + description: "The order payment ID." + foreign-key-id: "payment-id" + + - name: "present_at_all_locations" + type: "boolean" + description: "" + + - name: "processing_fee" + type: "array" + description: "" + subattributes: + - name: "amount_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "effective_at" + type: "string" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "reason" + type: "string" + description: "" + + - name: "receipt_number" + type: "string" + description: "" + + - name: "receipt_url" + type: "string" + description: "" + + - name: "refund_ids" + type: "array" + description: "A list of refunds associated with the order." + subattributes: + - name: "value" + type: "string" + description: "The refund IDs." + foreign-key-id: "refund-id" + + - name: "refunded_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "refunds" + type: "array" + description: "" + subattributes: + - name: "amount_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "created_at" + type: "date-time" + description: "" + + - name: "id" + type: "string" + description: "The refund ID." + foreign-key-id: "refund-id" + + - name: "location_id" + type: "string" + description: "The location ID." + foreign-key-id: "location-id" + + - name: "reason" + type: "string" + description: "" + + - name: "status" + type: "string" + description: "" + + - name: "tender_id" + type: "string" + description: "" + foreign-key-id: "tender-id" + + - name: "transaction_id" + type: "string" + description: "" + # foreign-key-id: "transaction-id" + + - name: "return_amounts" + type: "object" + description: "" + subattributes: + - name: "discount_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "service_charge_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "tax_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "tip_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "total_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "returns" + type: "array" + description: "" + subattributes: + - name: "return_line_items" + type: "array" + description: "" + subattributes: + - name: "base_price_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "gross_return_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "quantity" + type: "string" + description: "" + + - name: "total_discount_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "total_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "total_tax_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "uid" + type: "string" + description: "" + + - name: "variation_total_price_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "source_order_id" + type: "string" + description: "" + foreign-key-id: "order-id" + + - name: "uid" + type: "string" + description: "" + + - name: "source" + type: "object" + description: "" + subattributes: + - name: "name" + type: "string" + description: "" + + - name: "source_type" + type: "string" + description: "" + + - name: "state" + type: "string" + description: "" + + - name: "status" + type: "string" + description: "" + + - name: "tax_data" + type: "object" + description: "" + subattributes: + - name: "name" + type: "string" + description: "" + + - name: "tenders" + type: "array" + description: "" + subattributes: + - name: "amount_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "card_details" + type: "object" + description: "" + subattributes: + - name: "card" + type: "object" + description: "" + subattributes: + - name: "bin" + type: "string" + description: "" + + - name: "card_brand" + type: "string" + description: "" + + - name: "card_type" + type: "string" + description: "" + + - name: "exp_month" + type: "integer" + description: "" + + - name: "exp_year" + type: "integer" + description: "" + + - name: "fingerprint" + type: "string" + description: "" + + - name: "last_4" + type: "string" + description: "" + + - name: "prepaid_type" + type: "string" + description: "" + + - name: "entry_method" + type: "string" + description: "" + + - name: "status" + type: "string" + description: "" + + - name: "created_at" + type: "date-time" + description: "" + + - name: "id" + type: "string" + description: "" + foreign-key-id: "tender-id" + + - name: "location_id" + type: "string" + description: "" + foreign-key-id: "location-id" + + - name: "note" + type: "string" + description: "" + + - name: "payment_id" + type: "string" + description: "" + foreign-key-id: "payment-id" + + - name: "transaction_id" + type: "string" + description: "" + # foreign-key-id: "transaction-id" + + - name: "type" + type: "string" + description: "" + + - name: "total_discount_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "total_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "total_service_charge_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "total_tax_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "total_tip_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "version" + type: "integer" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v1/payments.md b/_integration-schemas/square/v1/payments.md new file mode 100644 index 000000000..1a5c43172 --- /dev/null +++ b/_integration-schemas/square/v1/payments.md @@ -0,0 +1,240 @@ +--- +tap: "square" +version: "1" +key: "payment" + +name: "payments" +doc-link: "https://developer.squareup.com/reference/square/payments-api" +singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/payments.json" +description: | + The `{{ table.name }}` table contains information about all payments taken in {{ integration.display_name }}. + +replication-method: "Key-based Incremental" + +api-method: + name: "List payments (V2)" + doc-link: "https://developer.squareup.com/reference/square/payments-api/list-payments" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The payment ID." + foreign-key-id: "payment-id" + + - name: "amount_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "card_details" + type: "object" + description: "" + subattributes: + - name: "auth_result_code" + type: "string" + description: "" + + - name: "avs_status" + type: "string" + description: "" + + - name: "card" + type: "object" + description: "" + subattributes: + - name: "bin" + type: "string" + description: "" + + - name: "card_brand" + type: "string" + description: "" + + - name: "card_type" + type: "string" + description: "" + + - name: "exp_month" + type: "integer" + description: "" + + - name: "exp_year" + type: "integer" + description: "" + + - name: "fingerprint" + type: "string" + description: "" + + - name: "last_4" + type: "string" + description: "" + + - name: "prepaid_type" + type: "string" + description: "" + + - name: "cvv_status" + type: "string" + description: "" + + - name: "entry_method" + type: "string" + description: "" + + - name: "errors" + type: "array" + description: "" + subattributes: + - name: "category" + type: "string" + description: "" + + - name: "code" + type: "string" + description: "" + + - name: "detail" + type: "string" + description: "" + + - name: "field" + type: "string" + description: "" + + - name: "statement_description" + type: "string" + description: "" + + - name: "status" + type: "string" + description: "" + + - name: "cardholder_name" + type: "string" + description: "" + + - name: "created_at" + type: "date-time" + description: "" + + - name: "customer_id" + type: "string" + description: "" + # foreign-key-id: "customer-id" + + - name: "delay_action" + type: "string" + description: "" + + - name: "delay_duration" + type: "string" + description: "" + + - name: "delayed_until" + type: "date-time" + description: "" + + - name: "location_id" + type: "string" + description: "The ID of the location associated with the payment." + foreign-key-id: "location-id" + + - name: "note" + type: "string" + description: "" + + - name: "order_id" + type: "string" + description: "The ID of the order associated with the payment." + foreign-key-id: "order-id" + + - name: "processing_fee" + type: "array" + description: "" + subattributes: + - name: "amount_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "effective_at" + type: "date-time" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "receipt_number" + type: "string" + description: "" + + - name: "receipt_url" + type: "string" + description: "" + + - name: "reference_id" + type: "string" + description: "" + + - name: "refund_ids" + type: "array" + description: "A list of refunds associated with the payment." + subattributes: + - name: "value" + type: "string" + description: "The refund ID." + foreign-key-id: "refund-id" + + - name: "refunded_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "source_type" + type: "string" + description: "" + + - name: "status" + type: "string" + description: "" + + - name: "total_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "updated_at" + type: "date-time" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v1/refunds.md b/_integration-schemas/square/v1/refunds.md new file mode 100644 index 000000000..4c7d4063b --- /dev/null +++ b/_integration-schemas/square/v1/refunds.md @@ -0,0 +1,91 @@ +--- +tap: "square" +version: "1" +key: "refund" + +name: "refunds" +doc-link: "https://developer.squareup.com/reference/square/refunds-api" +singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/refunds.json" +description: | + The `{{ table.name }}` table contains information about refunds on items in {{ integration.display_name }}. + +replication-method: "Full Table" + +api-method: + name: "List payment refunds (V2)" + doc-link: "https://developer.squareup.com/reference/square/refunds-api/list-payment-refunds" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The refund ID." + foreign-key-id: "refund-id" + + - name: "amount_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "created_at" + type: "date-time" + description: "" + + - name: "location_id" + type: "string" + description: "The ID of the location associated with the refund." + foreign-key-id: "location-id" + + - name: "order_id" + type: "string" + description: "The ID of the order associated with the refund." + foreign-key-id: "order-id" + + - name: "payment_id" + type: "string" + description: "The ID of the payment associated with the refund." + foreign-key-id: "payment-id" + + - name: "processing_fee" + type: "array" + description: "" + subattributes: + - name: "amount_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "effective_at" + type: "date-time" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "reason" + type: "string" + description: "" + + - name: "status" + type: "string" + description: "" + + - name: "updated_at" + type: "date-time" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v1/roles.md b/_integration-schemas/square/v1/roles.md new file mode 100644 index 000000000..09cd9a52e --- /dev/null +++ b/_integration-schemas/square/v1/roles.md @@ -0,0 +1,50 @@ +--- +tap: "square" +version: "1" +key: "role" + +name: "roles" +doc-link: "https://developer.squareup.com/reference/square/employees-api" +singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/roles.json" +description: | + The `{{ table.name }}` table contains information about employees' roles 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 employee roles (V1)" + doc-link: "https://developer.squareup.com/reference/square/employees-api/v1-list-employee-roles" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The role ID." + # foreign-key-id: "role-id" + + - name: "created_at" + type: "date-time" + description: "" + + - name: "is_owner" + type: "boolean" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "permissions" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + + - name: "updated_at" + type: "date-time" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v1/settlements.md b/_integration-schemas/square/v1/settlements.md new file mode 100644 index 000000000..99f19462d --- /dev/null +++ b/_integration-schemas/square/v1/settlements.md @@ -0,0 +1,59 @@ +--- +tap: "square" +version: "1" +key: "settlement" + +name: "settlements" +doc-link: "https://developer.squareup.com/reference/square/settlements-api" +singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/settlements.json" +description: | + The `{{ table.name }}` table contains information about deposits and withdrawals issued by {{ 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 settlements (V1)" + doc-link: "https://developer.squareup.com/reference/square/settlements-api/v1-list-settlements" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The settlement ID." + # foreign-key-id: "settlement-id" + + - name: "bank_account_id" + type: "string" + description: "The ID of the bank account associated with the settlement." + foreign-key-id: "bank-account-id" + + - name: "entries" + type: "array" + description: "" + subattributes: + - name: "value" + type: "null" + description: "" + + - name: "initiated_at" + type: "date-time" + description: "" + + - name: "status" + type: "string" + description: "" + + - name: "total_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency_code" + type: "string" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v1/shifts.md b/_integration-schemas/square/v1/shifts.md new file mode 100644 index 000000000..35b0d37a5 --- /dev/null +++ b/_integration-schemas/square/v1/shifts.md @@ -0,0 +1,115 @@ +--- +tap: "square" +version: "1" +key: "shift" + +name: "shifts" +doc-link: "https://developer.squareup.com/reference/square/labor-api" +singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/shifts.json" +description: | + The `{{ table.name }}` table contains information about employee's shifts in {{ integration.display_name }}. + +replication-method: "Key-based Incremental" + +api-method: + name: "Search shifts (V2)" + doc-link: "https://developer.squareup.com/reference/square/labor-api/search-shifts" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The shift ID." + # foreign-key-id: "shift-id" + + - name: "updated_at" + type: "date-time" + description: "The time the shift was last updated." + replication-key: true + + - name: "breaks" + type: "array" + description: "" + subattributes: + - name: "break_type_id" + type: "string" + description: "" + + - name: "end_at" + type: "date-time" + description: "" + + - name: "expected_duration" + type: "string" + description: "" + + - name: "id" + type: "string" + description: "" + + - name: "is_paid" + type: "boolean" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "start_at" + type: "date-time" + description: "" + + - name: "created_at" + type: "date-time" + description: "" + + - name: "employee_id" + type: "string" + description: "The ID of the employee that the shift belongs to." + foreign-key-id: "employee-id" + + - name: "end_at" + type: "date-time" + description: "" + + - name: "location_id" + type: "string" + description: "The ID of the location associated with the shift." + foreign-key-id: "location-id" + + - name: "start_at" + type: "date-time" + description: "" + + - name: "status" + type: "string" + description: "" + + - name: "timezone" + type: "string" + description: "" + + - name: "version" + type: "integer" + description: "" + + - name: "wage" + type: "object" + description: "" + subattributes: + - name: "hourly_rate" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "title" + type: "string" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v1/taxes.md b/_integration-schemas/square/v1/taxes.md new file mode 100644 index 000000000..5fda8a509 --- /dev/null +++ b/_integration-schemas/square/v1/taxes.md @@ -0,0 +1,90 @@ +--- +tap: "square" +version: "1" +key: "tax" + +name: "taxes" +doc-link: "" +singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/taxes.json" +description: | + The `{{ table.name }}` table contains information about taxes enabled on your items in {{ integration.display_name }}. + +replication-method: "Key-based Incremental" + +api-method: + name: "List catalog (`type: tax`) (V2)" + doc-link: "https://developer.squareup.com/reference/square/catalog-api/list-catalog" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The tax ID." + foreign-key-id: "tax-id" + + - name: "updated_at" + type: "date-time" + description: "The time the tax was last updated." + replication-key: true + + - name: "absent_at_location_ids" + type: "array" + description: "A list of locations where the tax is not applicable." + subattributes: + - name: "value" + type: "string" + description: "The ID of the location where the tax is not applicable." + foreign-key-id: "location-id" + + - name: "is_deleted" + type: "boolean" + description: "" + + - name: "present_at_all_locations" + type: "boolean" + description: "" + + - name: "tax_data" + type: "object" + description: "" + subattributes: + - name: "applies_to_custom_amounts" + type: "boolean" + description: "" + + - name: "calculation_phase" + type: "string" + description: "" + + - name: "enabled" + type: "boolean" + description: "" + + - name: "inclusion_type" + type: "string" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "percentage" + type: "string" + description: "" + + - name: "tax_type_id" + type: "string" + description: "" + + - name: "tax_type_name" + type: "string" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "version" + type: "integer" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v2/bank_accounts.md b/_integration-schemas/square/v2/bank_accounts.md new file mode 100644 index 000000000..60aab9bb1 --- /dev/null +++ b/_integration-schemas/square/v2/bank_accounts.md @@ -0,0 +1,87 @@ +--- +tap: "square" +version: "2" +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: "debit_mandate_reference_id" + type: "string" + description: "Reference identifier that will be displayed to UK bank account owners when collecting direct debit authorization. Only required for UK bank accounts." + + - 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: "Primary identifier for the bank" + + - name: "secondary_bank_identification_number" + type: "string" + description: "Secondary identifier for the bank" + + - name: "reference_id" + type: "string" + description: "Client-provided identifier for linking the banking account to an entity in a third-party system (for example, a bank account number or a user identifier)." + + - name: "status" + type: "string" + description: "" + + - name: "version" + type: "integer" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v2/cash_drawer_shifts.md b/_integration-schemas/square/v2/cash_drawer_shifts.md new file mode 100644 index 000000000..589f99d63 --- /dev/null +++ b/_integration-schemas/square/v2/cash_drawer_shifts.md @@ -0,0 +1,93 @@ +--- +tap: "square" +version: "2" +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: "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: "created_at" + type: "date-time" + 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: "id" + type: "string" + description: "" + + - name: "location_id" + 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: "" + + - name: "updated_at" + type: "date-time" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v2/categories.md b/_integration-schemas/square/v2/categories.md new file mode 100644 index 000000000..1c9c5dc33 --- /dev/null +++ b/_integration-schemas/square/v2/categories.md @@ -0,0 +1,62 @@ +--- +tap: "square" +version: "2" +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: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v2/customers.md b/_integration-schemas/square/v2/customers.md new file mode 100644 index 000000000..93b77a491 --- /dev/null +++ b/_integration-schemas/square/v2/customers.md @@ -0,0 +1,177 @@ +--- +tap: "square" +version: "2" +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: +attributes: + - name: "address" + type: "object" + description: "" + subattributes: + - name: "locality" + type: "string" + description: "" + + - name: "sublocality" + type: "string" + description: "" + + - name: "sublocality_2" + type: "string" + description: "" + + - name: "sublocality_3" + type: "string" + description: "" + + - name: "administrative_district_level_1" + type: "string" + description: "" + + - name: "administrative_district_level_2" + type: "string" + description: "" + + - name: "administrative_district_level_3" + type: "string" + description: "" + + - name: "country" + type: "string" + description: "" + + - name: "address_line_1" + type: "string" + description: "" + + - name: "address_line_2" + type: "string" + description: "" + + - name: "address_line_3" + type: "string" + description: "" + + - name: "postal_code" + type: "string" + description: "" + + - name: "first_name" + type: "string" + description: "" + + - name: "last_name" + type: "string" + description: "" + + + - name: "birthday" + type: "date-time" + description: "" + + + - name: "birthday" + type: "string" + 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: "group_ids" + type: "array" + description: "" + subattributes: + - name: "items" + type: "string" + description: "" + + - name: "id" + 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: "" + + + - name: "reference_id" + type: "string" + description: "" + + - name: "segment_ids" + type: "array" + description: "" + subattributes: + - name: "items" + type: "string" + description: "" + + - name: "tax_ids" + type: "object" + description: "" + subattributes: + - name: "eu_vat" + type: "string" + description: "" + + + - name: "updated_at" + type: "date-time" + description: "" + replication-key: true + + - name: "version" + type: "integer" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v2/discounts.md b/_integration-schemas/square/v2/discounts.md new file mode 100644 index 000000000..9b6dd2c9a --- /dev/null +++ b/_integration-schemas/square/v2/discounts.md @@ -0,0 +1,98 @@ +--- +tap: "square" +version: "2" +key: "discount" + +name: "discounts" +doc-link: "" +singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/discounts.json" +description: | + The `{{ table.name }}` table contains information about discounts for a given location in {{ integration.display_name }}. + +replication-method: "Key-based Incremental" + +api-method: + name: "List catalog (`type: discount`) (V2)" + doc-link: "https://developer.squareup.com/reference/square/catalog-api/list-catalog" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The discount ID." + # foreign-key-id: "discount-id" + + - name: "updated_at" + type: "date-time" + replication-key: true + description: "The time the location was last updated." + + - name: "absent_at_location_ids" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "The IDs of locations where the discount isn't applicable." + foreign-key-id: "location-id" + + - name: "discount_data" + type: "object" + description: "" + subattributes: + - name: "amount_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "application_method" + type: "string" + description: "" + + - name: "discount_type" + type: "string" + description: "" + + - name: "label_color" + type: "string" + description: "" + + - name: "modify_tax_basis" + type: "string" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "percentage" + type: "string" + description: "" + + - name: "pin_required" + type: "boolean" + 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: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v2/foreign-keys.md b/_integration-schemas/square/v2/foreign-keys.md new file mode 100644 index 000000000..1c3d5e7e5 --- /dev/null +++ b/_integration-schemas/square/v2/foreign-keys.md @@ -0,0 +1,218 @@ +--- +# -------------------------- # +# USING THIS TEMPLATE # +# -------------------------- # + +## NEED HELP USING THIS TEMPLATE? SEE: +## https://docs-about-stitch-docs.netlify.com/reference/integration-templates/saas-foreign-keys/ +## FOR INSTRUCTIONS & REFERENCE INFO + +tap-reference: "square" + +version: "2" + +foreign-keys: + - id: "bank-account-id" + table: "bank_accounts" + attribute: "id" + all-foreign-keys: + - table: "bank_accounts" + join-on: "id" + - table: "settlements" + join-on: "bank_account_id" + + # - id: "cash-drawer-id" + # table: "cash_drawer_shifts" + # attribute: "id" + # all-foreign-keys: + # - table: "" + # join-on: "" + + - id: "category-id" + table: "categories" + attribute: "category_id" + all-foreign-keys: + - table: "categories" + join-on: "id" + - table: "items" + subattribute: "item_data" + + - id: "discount-id" + table: "discounts" + attribute: "" + all-foreign-keys: + - table: "discounts" + join-on: "id" + + - id: "employee-id" + table: "employees" + attribute: "id" + all-foreign-keys: + - table: "employees" + join-on: "id" + - table: "shifts" + join-on: "employee_id" + + - id: "item-id" + table: "items" + attribute: "item_id" + all-foreign-keys: + - table: "items" + join-on: "id" + + - table: "items" + subattribute: "item_data.variations.item_variation_data" + + - table: "orders" + subattribute: "item_data.variations.item_variation_data" + + - id: "location-id" + table: "locations" + attribute: "id" + all-foreign-keys: + - table: "bank_accounts" + - table: "categories" + subattribute: "absent_at_location_ids" + join-on: "value" + + - table: "discounts" + subattribute: "absent_at_location_ids" + join-on: "value" + + - table: "employees" + subattribute: "location_ids" + join-on: "value" + + - table: "inventories" + + - table: "items" + subattribute: "absent_at_location_ids" + join-on: "value" + + - table: "items" + subattribute: "item_data.variations.item_variation_data.location_overrides" + + - table: "items" + subattribute: "item_data.variations.item_variation_data.present_at_location_ids" + join-on: "value" + + - table: "items" + subattribute: "present_at_location_ids" + join-on: "value" + + - table: "location" + join-on: "id" + + - table: "modifier_lists" + subattribute: "absent_at_location_ids" + join-on: "value" + + - table: "orders" + subattribute: "item_data.variations.item_variation_data.item_variation_data.location_overrides" + + - table: "orders" + + - table: "orders" + subattribute: "refunds" + + - table: "orders" + subattribute: "tenders" + + - table: "payments" + + - table: "refunds" + + - table: "shifts" + + - table: "taxes" + subattribute: "absent_at_location_ids" + join-on: "value" + + - id: "modifier-list-id" + table: "modifier_lists" + attribute: "modifier_list_id" + all-foreign-keys: + - table: "items" + subattribute: "item_data.modifier_list_info" + + - table: "modifier_lists" + join-on: "id" + - table: "modifier_lists" + subattribute: "modifier_list_data.modifiers.modifier_data" + + - id: "order-id" + table: "orders" + attribute: "id" + all-foreign-keys: + - table: "orders" + join-on: "id" + - table: "orders" + join-on: "order_id" + - table: "orders" + subattribute: "returns" + join-on: "source_order_id" + - table: "payments" + join-on: "order_id" + - table: "refunds" + join-on: "order_id" + + - id: "payment-id" + table: "payments" + attribute: "id" + all-foreign-keys: + - table: "orders" + join-on: "payment_id" + - table: "orders" + subattribute: "tenders" + - table: "payments" + join-on: "id" + - table: "refunds" + join-on: "payment_id" + + - id: "refund-id" + table: "refunds" + attribute: "id" + all-foreign-keys: + - table: "orders" + subattribute: "refund_ids" + join-on: "value" + - table: "orders" + subattribute: "refunds" + join-on: "id" + - table: "payments" + join-on: "order_id" + - table: "payments" + subattribute: "refund_ids" + join-on: "value" + - table: "refunds" + join-on: "id" + + - id: "role-id" + table: "roles" + attribute: "id" + all-foreign-keys: + - table: "roles" + join-on: "id" + + - id: "tax-id" + table: "taxes" + attribute: "id" + all-foreign-keys: + - table: "items" + subattribute: "item_data.tax_ids" + join-on: "value" + + - table: "taxes" + join-on: "id" + + - id: "tender-id" + table: "" + attribute: "tender_id" + all-foreign-keys: + - table: "orders" + - table: "orders" + subattribute: "refunds" + - table: "orders" + subattribute: "tenders" + join-on: "id" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v2/inventories.md b/_integration-schemas/square/v2/inventories.md new file mode 100644 index 000000000..82f881a58 --- /dev/null +++ b/_integration-schemas/square/v2/inventories.md @@ -0,0 +1,44 @@ +--- +tap: "square" +version: "2" +key: "inventory" + +name: "inventories" +doc-link: "https://developer.squareup.com/reference/square/inventory-api" +singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/inventories.json" +description: | + The `{{ table.name }}` table contains info about the current calculated stock count for a {{ integration.display_name }} location. + +replication-method: "Full Table" +loading-behavior: "Append-Only" + +api-method: + name: "Retrieve inventory count (V2)" + doc-link: "https://developer.squareup.com/reference/square/inventory-api/retrieve-inventory-count" + +attributes: + - name: "calculated_at" + type: "date-time" + description: "" + + - name: "catalog_object_id" + type: "string" + description: "" + + - name: "catalog_object_type" + type: "string" + description: "" + + - name: "location_id" + type: "string" + description: "The ID of the location associated with the inventory." + foreign-key-id: "location-id" + + - name: "quantity" + type: "string" + description: "" + + - name: "state" + type: "string" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v2/items.md b/_integration-schemas/square/v2/items.md new file mode 100644 index 000000000..3619ba3e8 --- /dev/null +++ b/_integration-schemas/square/v2/items.md @@ -0,0 +1,249 @@ +--- +tap: "square" +version: "2" +key: "item" + +name: "items" +doc-link: "https://developer.squareup.com/reference/square/catalog-api" +singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/items.json" +description: | + The `{{ table.name }}` table contains information about items for a given location in {{ integration.display_name }}. + +replication-method: "Key-based Incremental" + +api-method: + name: "List catalog (`type: item`) (V2)" + doc-link: "https://developer.squareup.com/reference/square/catalog-api/list-catalog" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The item ID." + foreign-key-id: "item-id" + + - name: "updated_at" + type: "date-time" + description: "The time the item was last updated." + replication-key: true + + - name: "absent_at_location_ids" + type: "array" + description: "A list of locations where the item is unavailable." + subattributes: + - name: "value" + type: "string" + description: "The ID of the location where the item is unavailable." + foreign-key-id: "location-id" + + - name: "is_deleted" + type: "boolean" + description: "" + + - name: "item_data" + type: "object" + description: "" + subattributes: + - name: "abbreviation" + type: "string" + description: "" + + - name: "available_electronically" + type: "boolean" + description: "" + + - name: "available_for_pickup" + type: "boolean" + description: "" + + - name: "available_online" + type: "boolean" + description: "" + + - name: "category_id" + type: "string" + description: "" + foreign-key-id: "category-id" + + - name: "description" + type: "string" + description: "" + + - name: "item_options" + type: "array" + description: "" + subattributes: + - name: "item_option_id" + type: "string" + description: "" + + - name: "label_color" + type: "string" + description: "" + + - name: "modifier_list_info" + type: "array" + description: "" + subattributes: + - name: "enabled" + type: "boolean" + description: "" + + - name: "modifier_list_id" + type: "string" + description: "" + foreign-key-id: "modifier-list-id" + + - name: "name" + type: "string" + description: "" + + - name: "product_type" + type: "string" + description: "" + + - name: "skip_modifier_screen" + type: "boolean" + description: "" + + - name: "tax_ids" + type: "array" + description: "A list of taxes enabled for the item." + subattributes: + - name: "value" + type: "string" + description: "The ID of the tax enabled for the item." + foreign-key-id: "tax-id" + + - name: "variations" + type: "array" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + + - name: "is_deleted" + type: "boolean" + description: "" + + - name: "item_variation_data" + type: "object" + description: "" + subattributes: + - name: "inventory_alert_type" + type: "string" + description: "" + + - name: "item_id" + type: "string" + description: "The item ID." + foreign-key-id: "item-id" + + - name: "location_overrides" + type: "array" + description: "" + subattributes: + - name: "inventory_alert_threshold" + type: "integer" + description: "" + + - name: "inventory_alert_type" + type: "string" + description: "" + + - name: "location_id" + type: "string" + description: "The location ID." + foreign-key-id: "location-id" + + - name: "track_inventory" + type: "boolean" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "ordinal" + type: "integer" + description: "" + + - name: "price_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "pricing_type" + type: "string" + description: "" + + - name: "sku" + type: "string" + description: "" + + - name: "track_inventory" + type: "boolean" + description: "" + + - name: "user_data" + type: "string" + description: "" + + - name: "present_at_all_locations" + type: "boolean" + description: "" + + - name: "present_at_location_ids" + type: "array" + description: "A list of locations where the item is available." + subattributes: + - name: "value" + type: "string" + description: "The ID of the location where the item is available." + foreign-key-id: "location-id" + + - name: "type" + type: "string" + description: "" + + - name: "updated_at" + type: "date-time" + description: "" + + - name: "version" + type: "integer" + description: "" + + - name: "visibility" + type: "string" + description: "" + + - name: "present_at_all_locations" + type: "boolean" + description: "" + + - name: "present_at_location_ids" + type: "array" + description: "A list of locations where the item is available." + subattributes: + - name: "value" + type: "string" + description: "The location IDs where the items are available." + foreign-key-id: "location-id" + + - name: "type" + type: "string" + description: "" + + - name: "version" + type: "integer" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v2/locations.md b/_integration-schemas/square/v2/locations.md new file mode 100644 index 000000000..43d5bcc0e --- /dev/null +++ b/_integration-schemas/square/v2/locations.md @@ -0,0 +1,212 @@ +--- +tap: "square" +version: "2" +key: "location" + +name: "locations" +doc-link: "https://developer.squareup.com/reference/square/locations-api" +singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/locations.json" +description: | + The `{{ table.name }}` table contains information about all of your business locations in {{ integration.display_name }}. + +replication-method: "Full Table" + +api-method: + name: "List locations (V2)" + doc-link: "https://developer.squareup.com/reference/square/locations-api/list-locations" + +attributes: + - name: "address" + type: "object" + description: "" + subattributes: + - name: "address_line_1" + type: "string" + description: "" + + - name: "address_line_2" + type: "string" + description: "" + + - name: "address_line_3" + type: "string" + description: "" + + - name: "postal_code" + type: "string" + description: "" + + - name: "locality" + type: "string" + description: "" + + - name: "administrative_district_level_1" + type: "string" + description: "" + + - name: "administrative_district_level_2" + type: "string" + description: "" + + - name: "administrative_district_level_3" + type: "string" + description: "" + + - name: "country" + type: "string" + description: "" + + - name: "first_name" + type: "string" + description: "" + + - name: "last_name" + type: "string" + description: "" + + - name: "sublocality" + type: "string" + description: "" + + - name: "sublocality_2" + type: "string" + description: "" + + - name: "sublocality_3" + type: "string" + description: "" + + + - name: "business_email" + type: "string" + description: "" + + - name: "business_hours" + type: "object" + description: "" + subattributes: + - name: "periods" + type: "array" + description: "" + subattributes: + - name: "start_local_time" + type: "string" + description: "" + + - name: "end_local_time" + type: "string" + description: "" + + - name: "day_of_week" + type: "string" + description: "" + + + + - name: "business_name" + type: "string" + description: "" + + - name: "capabilities" + type: "array" + description: "" + subattributes: + - name: "items" + type: "string" + description: "" + + - name: "coordinates" + type: "object" + description: "" + subattributes: + - name: "latitude" + type: "string" + format: "singer-decimal" + description: "" + + - name: "longitude" + type: "string" + format: "singer-decimal" + description: "" + + + - name: "country" + type: "string" + description: "" + + - name: "created_at" + type: "date-time" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "description" + type: "string" + description: "" + + - name: "facebook_url" + type: "string" + description: "" + + - name: "full_format_logo_url" + type: "string" + description: "" + + - name: "id" + type: "string" + description: "" + + - name: "instagram_username" + type: "string" + description: "" + + - name: "language_code" + type: "string" + description: "" + + - name: "logo_url" + type: "string" + description: "" + + - name: "mcc" + type: "string" + description: "" + + - name: "merchant_id" + type: "string" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "phone_number" + type: "string" + description: "" + + - name: "pos_background_url" + type: "string" + description: "" + + - name: "status" + type: "string" + description: "" + + - name: "timezone" + type: "string" + description: "" + + - name: "twitter_username" + type: "string" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "website_url" + type: "string" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v2/modifier_lists.md b/_integration-schemas/square/v2/modifier_lists.md new file mode 100644 index 000000000..94d6122e4 --- /dev/null +++ b/_integration-schemas/square/v2/modifier_lists.md @@ -0,0 +1,131 @@ +--- +tap: "square" +version: "2" +key: "modifier-list" + +name: "modifier_lists" +doc-link: "https://developer.squareup.com/reference/square/catalog-api/v1-list-modifier-lists" +singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/modifier_lists.json" +description: | + The `{{ table.name }}` table contains information about modifier lists for a given location in {{ integration.display_name }}. + +replication-method: "Key-based Incremental" + +api-method: + name: "List catalog (`type: modifier_list`) (V2)" + doc-link: "https://developer.squareup.com/reference/square/catalog-api/list-catalog" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The modifier list ID." + foreign-key-id: "modifier-list-id" + + - name: "updated_at" + type: "date-time" + description: "The time the modifier list was last updated." + replication-key: true + + - name: "absent_at_location_ids" + type: "array" + description: "A list of locations where the modifier list is unavailable." + subattributes: + - name: "value" + type: "string" + description: "The ID of the location where modifier list is unavailable." + foreign-key-id: "location-id" + + - name: "is_deleted" + type: "boolean" + description: "" + + - name: "modifier_list_data" + type: "object" + description: "" + subattributes: + - name: "modifiers" + type: "array" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + + - name: "is_deleted" + type: "boolean" + description: "" + + - name: "modifier_data" + type: "object" + description: "" + subattributes: + - name: "modifier_list_id" + type: "string" + description: "The modifier list ID." + foreign-key-id: "modifier-list-id" + + - name: "name" + type: "string" + description: "" + + - name: "on_by_default" + type: "boolean" + description: "" + + - name: "ordinal" + type: "integer" + description: "" + + - name: "price_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + - name: "present_at_all_locations" + type: "boolean" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "updated_at" + type: "date-time" + description: "" + + - name: "version" + type: "integer" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "ordinal" + type: "integer" + description: "" + + - name: "selection_type" + type: "string" + description: "" + + - name: "present_at_all_locations" + type: "boolean" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "version" + type: "integer" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v2/orders.md b/_integration-schemas/square/v2/orders.md new file mode 100644 index 000000000..41d224cd5 --- /dev/null +++ b/_integration-schemas/square/v2/orders.md @@ -0,0 +1,1745 @@ +--- +tap: "square" +version: "2" +key: "order" + +name: "orders" +doc-link: "https://developer.squareup.com/reference/square/orders-api" +singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/orders.json" +description: | + The `{{ table.name }}` table contains information about order updates in {{ integration.display_name }}. + +replication-method: "Key-based Incremental" + +api-method: + name: "Search orders (V2)" + doc-link: "https://developer.squareup.com/reference/square/orders-api/search-orders" + +attributes: + - name: "closed_at" + type: "date-time" + description: "" + + - name: "created_at" + type: "date-time" + description: "" + + - name: "discounts" + type: "array" + description: "" + subattributes: + - name: "catalog_object_id" + type: "string" + description: "" + + - name: "catalog_version" + type: "integer" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "percentage" + type: "string" + description: "" + + - name: "amount_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "applied_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "scope" + type: "string" + description: "" + + - name: "pricing_rule_id" + type: "string" + description: "" + + + - name: "fulfillments" + type: "array" + description: "" + subattributes: + - name: "type" + type: "string" + description: "" + + - name: "pickup_details" + type: "object" + description: "" + subattributes: + - name: "placed_at" + type: "date-time" + description: "" + + - name: "accepted_at" + type: "date-time" + description: "" + + - name: "rejected_at" + type: "date-time" + description: "" + + - name: "ready_at" + type: "date-time" + description: "" + + - name: "picked_up_at" + type: "date-time" + description: "" + + - name: "canceled_at" + type: "date-time" + description: "" + + - name: "expired_at" + type: "date-time" + description: "" + + - name: "expires_at" + type: "date-time" + description: "" + + - name: "auto_complete_duration" + type: "string" + description: "" + + - name: "schedule_type" + type: "string" + description: "" + + - name: "cancel_reason" + type: "string" + description: "" + + - name: "pickup_at" + type: "date-time" + description: "" + + - name: "pickup_window_duration" + type: "string" + description: "" + + - name: "prep_time_duration" + type: "string" + description: "" + + - name: "note" + type: "string" + description: "" + + - name: "recipient" + type: "object" + description: "" + subattributes: + - name: "customer_id" + type: "string" + description: "" + + - name: "display_name" + type: "string" + description: "" + + - name: "email_address" + type: "string" + description: "" + + - name: "phone_number" + type: "string" + description: "" + + + + - name: "state" + type: "string" + description: "" + + - name: "uid" + type: "string" + description: "" + + + - name: "id" + type: "string" + description: "" + + - name: "line_items" + type: "array" + description: "" + subattributes: + - name: "base_price_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "total_discount_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "variation_total_price_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "name" + type: "string" + description: "" + + - name: "quantity" + type: "string" + description: "" + + - name: "quantity_unit" + type: "object" + description: "" + subattributes: + - name: "precision" + type: "integer" + description: "" + + - name: "measurement_unit" + type: "object" + description: "" + subattributes: + - name: "custom_unit" + type: "object" + description: "" + subattributes: + - name: "name" + type: "string" + description: "" + + - name: "abbreviation" + type: "string" + description: "" + + + - name: "area_unit" + type: "string" + description: "" + + - name: "length_unit" + type: "string" + description: "" + + - name: "volume_unit" + type: "string" + description: "" + + - name: "weight_unit" + type: "string" + description: "" + + - name: "generic_unit" + type: "string" + description: "" + + - name: "time_unit" + type: "string" + description: "" + + - name: "type" + type: "string" + description: "" + + + - name: "catalog_object_id" + type: "string" + description: "" + + - name: "catalog_version" + type: "integer" + description: "" + + + - name: "note" + type: "string" + description: "" + + - name: "uid" + type: "string" + description: "" + + - name: "gross_sales_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "total_tax_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "total_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "catalog_object_id" + type: "string" + description: "" + + - name: "catalog_version" + type: "integer" + description: "" + + - name: "variation_name" + type: "string" + description: "" + + - name: "item_type" + type: "string" + description: "" + + - name: "modifiers" + type: "array" + description: "" + subattributes: + - name: "catalog_object_id" + type: "string" + description: "" + + - name: "catalog_version" + type: "integer" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "quantity" + type: "string" + description: "" + + - name: "base_price_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + + - name: "total_price_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + + + + - name: "location_id" + type: "string" + description: "" + + - name: "net_amount_due_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "net_amounts" + type: "object" + description: "" + subattributes: + - name: "tip_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "service_charge_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "tax_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "discount_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "total_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + + - name: "pricing_options" + type: "object" + description: "" + subattributes: + - name: "auto_apply_discounts" + type: "boolean" + description: "" + + + - name: "reference_id" + type: "string" + description: "" + + - name: "refunds" + type: "array" + description: "" + subattributes: + - name: "location_id" + type: "string" + description: "" + + - name: "transaction_id" + type: "string" + description: "" + + - name: "created_at" + type: "date-time" + description: "" + + - name: "tender_id" + type: "string" + description: "" + + - name: "amount_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "processing_fee_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "status" + type: "string" + description: "" + + - name: "id" + type: "string" + description: "" + + - name: "reason" + type: "string" + description: "" + + + - name: "return_amounts" + type: "object" + description: "" + subattributes: + - name: "tip_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "service_charge_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "tax_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "discount_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "total_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + + - name: "returns" + type: "array" + description: "" + subattributes: + - name: "source_order_id" + type: "string" + description: "" + + - name: "return_line_items" + type: "array" + description: "" + subattributes: + - name: "base_price_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "catalog_object_id" + type: "string" + description: "" + + - name: "catalog_version" + type: "integer" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "note" + type: "string" + description: "" + + - name: "quantity_unit" + type: "object" + description: "" + subattributes: + - name: "precision" + type: "integer" + description: "" + + - name: "measurement_unit" + type: "object" + description: "" + subattributes: + - name: "area_unit" + type: "string" + description: "" + + - name: "custom_unit" + type: "object" + description: "" + subattributes: + - name: "abbreviation" + type: "string" + description: "" + + - name: "name" + type: "string" + description: "" + + + - name: "generic_unit" + type: "string" + description: "" + + - name: "length_unit" + type: "string" + description: "" + + - name: "time_unit" + type: "string" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "volume_unit" + type: "string" + description: "" + + - name: "weight_unit" + type: "string" + description: "" + + + - name: "catalog_object_id" + type: "string" + description: "" + + - name: "catalog_version" + type: "integer" + description: "" + + + - name: "return_modifiers" + type: "array" + description: "" + subattributes: + - name: "base_price_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "catalog_object_id" + type: "string" + description: "" + + - name: "catalog_version" + type: "integer" + description: "" + + - name: "quantity" + type: "string" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "source_modifier_uid" + type: "string" + description: "" + + - name: "total_price_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "uid" + type: "string" + description: "" + + + - name: "source_line_item_uid" + type: "string" + description: "" + + - name: "variation_name" + type: "string" + description: "" + + - name: "item_type" + type: "string" + description: "" + + - name: "total_tax_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "gross_return_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "total_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "variation_total_price_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "quantity" + type: "string" + description: "" + + - name: "applied_discounts" + type: "array" + description: "" + subattributes: + - name: "discount_uid" + type: "string" + description: "" + + - name: "applied_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "uid" + type: "string" + description: "" + + + - name: "applied_taxes" + type: "array" + description: "" + subattributes: + - name: "tax_uid" + type: "string" + description: "" + + - name: "applied_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "uid" + type: "string" + description: "" + + + - name: "total_discount_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "total_service_charge_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "applied_service_charges" + type: "array" + description: "" + subattributes: + - name: "uid" + type: "string" + description: "" + + - name: "service_charge_uid" + type: "string" + description: "" + + - name: "applied_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + + - name: "uid" + type: "string" + description: "" + + + - name: "uid" + type: "string" + description: "" + + - name: "return_service_charges" + type: "array" + description: "" + subattributes: + - name: "source_service_charge_uid" + type: "string" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "catalog_object_id" + type: "string" + description: "" + + - name: "catalog_version" + type: "integer" + description: "" + + - name: "percentage" + type: "string" + description: "" + + - name: "amount_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "applied_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "total_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "total_tax_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "calculation_phase" + type: "string" + description: "" + + - name: "taxable" + type: "boolean" + description: "" + + + - name: "return_taxes" + type: "array" + description: "" + subattributes: + - name: "uid" + type: "string" + description: "" + + - name: "source_tax_uid" + type: "string" + description: "" + + - name: "catalog_object_id" + type: "string" + description: "" + + - name: "catalog_version" + type: "integer" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "percentage" + type: "string" + description: "" + + - name: "applied_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "scope" + type: "string" + description: "" + + + - name: "return_discounts" + type: "array" + description: "" + subattributes: + - name: "uid" + type: "string" + description: "" + + - name: "source_discount_uid" + type: "string" + description: "" + + - name: "catalog_object_id" + type: "string" + description: "" + + - name: "catalog_version" + type: "integer" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "percentage" + type: "string" + description: "" + + - name: "amount_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "applied_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "scope" + type: "string" + description: "" + + + - name: "rounding_adjustment" + type: "object" + description: "" + subattributes: + - name: "uid" + type: "string" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "amount_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + + - name: "return_amounts" + type: "object" + description: "" + subattributes: + - name: "total_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "tax_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "discount_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "tip_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "service_charge_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + + + - name: "service_charges" + type: "array" + description: "" + subattributes: + - name: "catalog_object_id" + type: "string" + description: "" + + - name: "catalog_version" + type: "integer" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "percentage" + type: "string" + description: "" + + - name: "amount_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "applied_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "total_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "total_tax_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "calculation_phase" + type: "string" + description: "" + + - name: "taxable" + type: "boolean" + description: "" + + + - name: "source" + type: "object" + description: "" + subattributes: + - name: "name" + type: "string" + description: "" + + + - name: "state" + type: "string" + description: "" + + - name: "taxes" + type: "array" + description: "" + subattributes: + - name: "catalog_object_id" + type: "string" + description: "" + + - name: "catalog_version" + type: "integer" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "percentage" + type: "string" + description: "" + + - name: "applied_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "scope" + type: "string" + description: "" + + + - name: "tenders" + type: "array" + description: "" + subattributes: + - name: "location_id" + type: "string" + description: "" + + - name: "transaction_id" + type: "string" + description: "" + + - name: "created_at" + type: "date-time" + description: "" + + - name: "card_details" + type: "object" + description: "" + subattributes: + - name: "card" + type: "object" + description: "" + subattributes: + - name: "exp_year" + type: "integer" + description: "" + + - name: "last_4" + type: "string" + description: "" + + - name: "billing_address" + type: "object" + description: "" + subattributes: + - name: "address_line_1" + type: "string" + description: "" + + - name: "address_line_2" + type: "string" + description: "" + + - name: "address_line_3" + type: "string" + description: "" + + - name: "locality" + type: "string" + description: "" + + - name: "sublocality" + type: "string" + description: "" + + - name: "sublocality_2" + type: "string" + description: "" + + - name: "sublocality_3" + type: "string" + description: "" + + - name: "administrative_district_level_1" + type: "string" + description: "" + + - name: "administrative_district_level_2" + type: "string" + description: "" + + - name: "administrative_district_level_3" + type: "string" + description: "" + + - name: "postal_code" + type: "string" + description: "" + + - name: "country" + type: "string" + description: "" + + - name: "first_name" + type: "string" + description: "" + + - name: "last_name" + type: "string" + description: "" + + + - name: "fingerprint" + type: "string" + description: "" + + - name: "exp_month" + type: "integer" + description: "" + + - name: "bin" + type: "string" + description: "" + + - name: "card_type" + type: "string" + description: "" + + - name: "cardholder_name " + type: "string" + description: "" + + - name: "id" + type: "string" + description: "" + + - name: "customer_id" + type: "string" + description: "" + + - name: "merchant_id" + type: "string" + description: "" + + - name: "reference_id" + type: "string" + description: "" + + - name: "enabled" + type: "boolean" + description: "" + + - name: "version" + type: "integer" + description: "" + + - name: "card_co_brand" + type: "string" + description: "" + + - name: "card_brand" + type: "string" + description: "" + + - name: "prepaid_type" + type: "string" + description: "" + + + - name: "entry_method" + type: "string" + description: "" + + - name: "status" + type: "string" + description: "" + + + - name: "cash_details" + type: "object" + description: "" + subattributes: + - name: "buyer_tendered_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "change_back_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + + - name: "payment_id" + type: "string" + description: "" + + - name: "customer_id" + type: "string" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "amount_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "tip_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "processing_fee_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "id" + type: "string" + description: "" + + - name: "note" + type: "string" + description: "" + + + - name: "total_discount_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "total_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "total_service_charge_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "total_tax_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "total_tip_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "updated_at" + type: "date-time" + description: "" + replication-key: true + + - name: "version" + type: "integer" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v2/payments.md b/_integration-schemas/square/v2/payments.md new file mode 100644 index 000000000..7b3dda636 --- /dev/null +++ b/_integration-schemas/square/v2/payments.md @@ -0,0 +1,779 @@ +--- +tap: "square" +version: "2" +key: "payment" + +name: "payments" +doc-link: "https://developer.squareup.com/reference/square/payments-api" +singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/payments.json" +description: | + The `{{ table.name }}` table contains information about all payments taken in {{ integration.display_name }}. + +replication-method: "Key-based Incremental" + +api-method: + name: "List payments (V2)" + doc-link: "https://developer.squareup.com/reference/square/payments-api/list-payments" + +attributes: + - name: "amount_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + + - name: "app_fee_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + + - name: "application_details" + type: "object" + description: "" + subattributes: + - name: "square_product" + type: "string" + description: "" + + - name: "application_id" + type: "string" + description: "" + + + - name: "approved_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + + - name: "bank_account_details" + type: "object" + description: "" + subattributes: + - name: "bank_name" + type: "string" + description: "" + + - name: "transfer_type" + type: "string" + description: "" + + - name: "account_ownership_type" + type: "string" + description: "" + + - name: "fingerprint" + type: "string" + description: "" + + - name: "country" + type: "string" + description: "" + + - name: "statement_description" + type: "string" + description: "" + + - name: "ach_details" + type: "object" + description: "" + subattributes: + - name: "routing_number" + type: "string" + description: "" + + - name: "account_number_suffix" + type: "string" + description: "" + + - name: "account_type" + type: "string" + description: "" + + + - name: "errors" + type: "array" + description: "" + subattributes: + - name: "category" + type: "string" + description: "" + + - name: "code" + type: "string" + description: "" + + - name: "detail" + type: "string" + description: "" + + - name: "field" + type: "string" + description: "" + + + + - name: "billing_address" + type: "object" + description: "" + subattributes: + - name: "address_line_1" + type: "string" + description: "" + + - name: "address_line_2" + type: "string" + description: "" + + - name: "address_line_3" + type: "string" + description: "" + + - name: "locality" + type: "string" + description: "" + + - name: "sublocality" + type: "string" + description: "" + + - name: "sublocality_2" + type: "string" + description: "" + + - name: "sublocality_3" + type: "string" + description: "" + + - name: "administrative_district_level_1" + type: "string" + description: "" + + - name: "administrative_district_level_2" + type: "string" + description: "" + + - name: "administrative_district_level_3" + type: "string" + description: "" + + - name: "postal_code" + type: "string" + description: "" + + - name: "country" + type: "string" + description: "" + + - name: "first_name" + type: "string" + description: "" + + - name: "last_name" + type: "string" + description: "" + + + - name: "buy_now_pay_later_details" + type: "object" + description: "" + subattributes: + - name: "brand" + type: "string" + description: "" + + - name: "afterpay_details" + type: "object" + description: "" + subattributes: + - name: "email_address" + type: "string" + description: "" + + + - name: "clearpay_details" + type: "object" + description: "" + subattributes: + - name: "email_address" + type: "string" + description: "" + + + + - name: "buyer_email_address" + type: "string" + description: "" + + - name: "capabilities" + type: "array" + description: "" + subattributes: + - name: "items" + type: "string" + description: "" + + - name: "card_details" + type: "object" + description: "" + subattributes: + - name: "status" + type: "string" + description: "" + + - name: "card" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + + - name: "card_brand" + type: "string" + description: "" + + - name: "last_4" + type: "string" + description: "" + + - name: "exp_month" + type: "integer" + description: "" + + - name: "exp_year" + type: "integer" + description: "" + + - name: "cardholder_name" + type: "string" + description: "" + + - name: "billing_address" + type: "object" + description: "" + subattributes: + - name: "address_line_1" + type: "string" + description: "" + + - name: "address_line_2" + type: "string" + description: "" + + - name: "address_line_3" + type: "string" + description: "" + + - name: "locality" + type: "string" + description: "" + + - name: "sublocality" + type: "string" + description: "" + + - name: "sublocality_2" + type: "string" + description: "" + + - name: "sublocality_3" + type: "string" + description: "" + + - name: "administrative_district_level_1" + type: "string" + description: "" + + - name: "administrative_district_level_2" + type: "string" + description: "" + + - name: "administrative_district_level_3" + type: "string" + description: "" + + - name: "postal_code" + type: "string" + description: "" + + - name: "country" + type: "string" + description: "" + + - name: "first_name" + type: "string" + description: "" + + - name: "last_name" + type: "string" + description: "" + + + - name: "fingerprint" + type: "string" + description: "" + + - name: "customer_id" + type: "string" + description: "" + + - name: "merchant_id" + type: "string" + description: "" + + - name: "reference_id" + type: "string" + description: "" + + - name: "enabled" + type: "boolean" + description: "" + + - name: "card_type" + type: "string" + description: "" + + - name: "prepaid_type" + type: "string" + description: "" + + - name: "bin" + type: "string" + description: "" + + - name: "version" + type: "integer" + description: "" + + - name: "card_co_brand" + type: "string" + description: "" + + + - name: "entry_method" + type: "string" + description: "" + + - name: "cvv_status" + type: "string" + description: "" + + - name: "avs_status" + type: "string" + description: "" + + - name: "auth_result_code" + type: "string" + description: "" + + - name: "application_identifier" + type: "string" + description: "" + + - name: "application_name" + type: "string" + description: "" + + - name: "application_cryptogram" + type: "string" + description: "" + + - name: "verification_method" + type: "string" + description: "" + + - name: "verification_results" + type: "string" + description: "" + + - name: "errors" + type: "array" + description: "" + subattributes: + - name: "category" + type: "string" + description: "" + + - name: "code" + type: "string" + description: "" + + - name: "detail" + type: "string" + description: "" + + - name: "field" + type: "string" + description: "" + + + - name: "statement_description" + type: "string" + description: "" + + - name: "card_payment_timeline" + type: "object" + description: "" + subattributes: + - name: "authorized_at" + type: "date-time" + description: "" + + - name: "captured_at" + type: "date-time" + description: "" + + - name: "voided_at" + type: "date-time" + description: "" + + + + - name: "cash_details" + type: "object" + description: "" + subattributes: + - name: "buyer_supplied_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + + - name: "change_back_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + + + - name: "created_at" + type: "date-time" + description: "" + + - name: "customer_id" + type: "string" + description: "" + + - name: "delay_action" + type: "string" + description: "" + + - name: "delay_duration" + type: "string" + description: "" + + - name: "delayed_until" + type: "date-time" + description: "" + + - name: "device_details" + type: "object" + description: "" + subattributes: + - name: "device_id" + type: "string" + description: "" + + - name: "device_installation_id" + type: "string" + description: "" + + - name: "device_name" + type: "string" + description: "" + + + - name: "external_details" + type: "object" + description: "" + subattributes: + - name: "type" + type: "string" + description: "" + + - name: "source" + type: "string" + description: "" + + - name: "source_id" + type: "string" + description: "" + + - name: "source_fee_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + + + - name: "id" + type: "string" + description: "" + + - name: "location_id" + type: "string" + description: "" + + - name: "note" + type: "string" + description: "" + + - name: "order_id" + type: "string" + description: "" + + - name: "processing_fee" + type: "array" + description: "" + subattributes: + - name: "effective_at" + type: "date-time" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "amount_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + + + - name: "receipt_number" + type: "string" + description: "" + + - name: "receipt_url" + type: "string" + description: "" + + - name: "reference_id" + type: "string" + description: "" + + - name: "refund_ids" + type: "array" + description: "" + subattributes: + - name: "items" + type: "string" + description: "" + + - name: "refunded_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + + - name: "risk_evaluation" + type: "object" + description: "" + subattributes: + - name: "created_at" + type: "date-time" + description: "" + + - name: "risk_level" + type: "string" + description: "" + + + - name: "shipping_address" + type: "object" + description: "" + subattributes: + - name: "address_line_1" + type: "string" + description: "" + + - name: "address_line_2" + type: "string" + description: "" + + - name: "address_line_3" + type: "string" + description: "" + + - name: "locality" + type: "string" + description: "" + + - name: "sublocality" + type: "string" + description: "" + + - name: "sublocality_2" + type: "string" + description: "" + + - name: "sublocality_3" + type: "string" + description: "" + + - name: "administrative_district_level_1" + type: "string" + description: "" + + - name: "administrative_district_level_2" + type: "string" + description: "" + + - name: "administrative_district_level_3" + type: "string" + description: "" + + - name: "postal_code" + type: "string" + description: "" + + - name: "country" + type: "string" + description: "" + + - name: "first_name" + type: "string" + description: "" + + - name: "last_name" + type: "string" + description: "" + + + - name: "source_type" + type: "string" + description: "" + + - name: "statement_description_identifier" + type: "string" + description: "" + + - name: "status" + type: "string" + description: "" + + - name: "team_member_id" + type: "string" + description: "" + + - name: "tip_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + + - name: "total_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + + - name: "updated_at" + type: "date-time" + description: "" + + - name: "version_token" + type: "string" + description: "" + + - name: "wallet_details" + type: "object" + description: "" + subattributes: + - name: "status" + type: "string" + description: "" + + - name: "brand" + type: "string" + description: "" + + - name: "cash_app_details" + type: "object" + description: "" + subattributes: + - name: "buyer_full_name" + type: "string" + description: "" + + - name: "buyer_country_code" + type: "string" + description: "" + + - name: "buyer_cashtag" + type: "string" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v2/payouts.md b/_integration-schemas/square/v2/payouts.md new file mode 100644 index 000000000..f4aae35c6 --- /dev/null +++ b/_integration-schemas/square/v2/payouts.md @@ -0,0 +1,104 @@ +--- +tap: "square" +version: "2" +key: "payouts" + +name: "payouts" +doc-link: "https://developer.squareup.com/reference/square/payouts-api" +singer-schema: https://github.com/singer-io/tap-square/tree/TDL-23235-add-payouts-stream/tap_square/schemas/payouts.json +description: "The `{{ table.name }}` table contains information about all payouts made in {{ integration.display_name }}." + +replication-method: "Full Table" + +api-method: + name: "List payouts (V2)" + doc-link: "https://developer.squareup.com/reference/square/payouts-api/list-payouts" + +attributes: + - name: "id" + type: "string" + description: "" + + - name: "status" + type: "string" + description: "" + + - name: "location_id" + type: "string" + description: "" + + - name: "created_at" + type: "date-time" + description: "" + + - name: "updated_at" + type: "date-time" + description: "" + + + - name: "amount_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + + - name: "destination" + type: "object" + description: "" + subattributes: + - name: "type" + type: "string" + description: "" + + - name: "id" + type: "string" + description: "" + + - name: "version" + type: "integer" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "payout_fee" + type: "array" + description: "" + subattributes: + - name: "effective_at" + type: "date-time" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "amount_money" + type: "object" + description: "" + subattributes: + - name: "currency" + type: "string" + description: "" + + - name: "amount" + type: "integer" + description: "" + + + - name: "arrival_date" + type: "date-time" + description: "" + + - name: "end_to_end_id" + type: "string" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v2/refunds.md b/_integration-schemas/square/v2/refunds.md new file mode 100644 index 000000000..f72e55a37 --- /dev/null +++ b/_integration-schemas/square/v2/refunds.md @@ -0,0 +1,258 @@ +--- +tap: "square" +version: "2" +key: "refund" + +name: "refunds" +doc-link: "https://developer.squareup.com/reference/square/refunds-api" +singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/refunds.json" +description: | + The `{{ table.name }}` table contains information about refunds on items in {{ integration.display_name }}. + +replication-method: "Full Table" + +api-method: + name: "List payment refunds (V2)" + doc-link: "https://developer.squareup.com/reference/square/refunds-api/list-payment-refunds" + +attributes: + - name: "amount_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + + - name: "app_fee_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + + - name: "created_at" + type: "date-time" + description: "" + + - name: "destination_details" + type: "object" + description: "" + subattributes: + - name: "card_details" + type: "object" + description: "" + subattributes: + - name: "card" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + + - name: "card_brand" + type: "string" + description: "" + + - name: "last_4" + type: "string" + description: "" + + - name: "exp_month" + type: "integer" + description: "" + + - name: "exp_year" + type: "integer" + description: "" + + - name: "cardholder_name" + type: "string" + description: "" + + - name: "billing_address" + type: "object" + description: "" + subattributes: + - name: "address_line_1" + type: "string" + description: "" + + - name: "address_line_2" + type: "string" + description: "" + + - name: "address_line_3" + type: "string" + description: "" + + - name: "locality" + type: "string" + description: "" + + - name: "sublocality" + type: "string" + description: "" + + - name: "sublocality_2" + type: "string" + description: "" + + - name: "sublocality_3" + type: "string" + description: "" + + - name: "administrative_district_level_1" + type: "string" + description: "" + + - name: "administrative_district_level_2" + type: "string" + description: "" + + - name: "administrative_district_level_3" + type: "string" + description: "" + + - name: "postal_code" + type: "string" + description: "" + + - name: "country" + type: "string" + description: "" + + - name: "first_name" + type: "string" + description: "" + + - name: "last_name" + type: "string" + description: "" + + + - name: "fingerprint" + type: "string" + description: "" + + - name: "customer_id" + type: "string" + description: "" + + - name: "merchant_id" + type: "string" + description: "" + + - name: "reference_id" + type: "string" + description: "" + + - name: "enabled" + type: "boolean" + description: "" + + - name: "card_type" + type: "string" + description: "" + + - name: "prepaid_type" + type: "string" + description: "" + + - name: "bin" + type: "string" + description: "" + + - name: "version" + type: "integer" + description: "" + + - name: "card_co_brand" + type: "string" + description: "" + + + - name: "entry_method" + type: "string" + description: "" + + + + - name: "destination_type" + type: "string" + description: "" + + - name: "id" + type: "string" + description: "" + + - name: "location_id" + type: "string" + description: "" + + - name: "order_id" + type: "string" + description: "" + + - name: "payment_id" + type: "string" + description: "" + + - name: "processing_fee" + type: "array" + description: "" + subattributes: + - name: "effective_at" + type: "date-time" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "amount_money" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + + + - name: "reason" + type: "string" + description: "" + + - name: "status" + type: "string" + description: "" + + - name: "team_member_id" + type: "string" + description: "" + + - name: "unlinked" + type: "boolean" + description: "" + + - name: "updated_at" + type: "date-time" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v2/roles.md b/_integration-schemas/square/v2/roles.md new file mode 100644 index 000000000..cb46dc901 --- /dev/null +++ b/_integration-schemas/square/v2/roles.md @@ -0,0 +1,50 @@ +--- +tap: "square" +version: "2" +key: "role" + +name: "roles" +doc-link: "https://developer.squareup.com/reference/square/employees-api" +singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/roles.json" +description: | + The `{{ table.name }}` table contains information about employees' roles 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 employee roles (V1)" + doc-link: "https://developer.squareup.com/reference/square/employees-api/v1-list-employee-roles" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The role ID." + # foreign-key-id: "role-id" + + - name: "created_at" + type: "date-time" + description: "" + + - name: "is_owner" + type: "boolean" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "permissions" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + + - name: "updated_at" + type: "date-time" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v2/shifts.md b/_integration-schemas/square/v2/shifts.md new file mode 100644 index 000000000..fcaf9acd2 --- /dev/null +++ b/_integration-schemas/square/v2/shifts.md @@ -0,0 +1,117 @@ +--- +tap: "square" +version: "2" +key: "shift" + +name: "shifts" +doc-link: "https://developer.squareup.com/reference/square/labor-api" +singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/shifts.json" +description: | + The `{{ table.name }}` table contains information about employee's shifts in {{ integration.display_name }}. + +replication-method: "Key-based Incremental" + +api-method: + name: "Search shifts (V2)" + doc-link: "https://developer.squareup.com/reference/square/labor-api/search-shifts" + +attributes: + - name: "breaks" + type: "array" + description: "" + subattributes: + - name: "expected_duration" + type: "string" + description: "" + + - name: "id" + type: "string" + description: "" + + - name: "is_paid" + type: "boolean" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "end_at" + type: "date-time" + description: "" + + - name: "start_at" + type: "date-time" + description: "" + + - name: "break_type_id" + type: "string" + description: "" + + + - name: "created_at" + type: "date-time" + description: "" + + - name: "end_at" + type: "date-time" + description: "" + + - name: "id" + type: "string" + description: "" + + - name: "location_id" + type: "string" + description: "" + + - name: "start_at" + type: "date-time" + description: "" + + - name: "status" + type: "string" + description: "" + + - name: "team_member_id" + type: "string" + description: "" + + - name: "timezone" + type: "string" + description: "" + + - name: "updated_at" + type: "date-time" + description: "" + replication-key: true + + - name: "version" + type: "integer" + description: "" + + - name: "wage" + type: "object" + description: "" + subattributes: + - name: "hourly_rate" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "integer" + description: "" + + - name: "currency" + type: "string" + description: "" + + + - name: "job_id" + type: "string" + description: "" + + - name: "title" + type: "string" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v2/taxes.md b/_integration-schemas/square/v2/taxes.md new file mode 100644 index 000000000..29e61b24e --- /dev/null +++ b/_integration-schemas/square/v2/taxes.md @@ -0,0 +1,90 @@ +--- +tap: "square" +version: "2" +key: "tax" + +name: "taxes" +doc-link: "" +singer-schema: "https://github.com/singer-io/tap-square/blob/master/tap_square/schemas/taxes.json" +description: | + The `{{ table.name }}` table contains information about taxes enabled on your items in {{ integration.display_name }}. + +replication-method: "Key-based Incremental" + +api-method: + name: "List catalog (`type: tax`) (V2)" + doc-link: "https://developer.squareup.com/reference/square/catalog-api/list-catalog" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The tax ID." + foreign-key-id: "tax-id" + + - name: "updated_at" + type: "date-time" + description: "The time the tax was last updated." + replication-key: true + + - name: "absent_at_location_ids" + type: "array" + description: "A list of locations where the tax is not applicable." + subattributes: + - name: "value" + type: "string" + description: "The ID of the location where the tax is not applicable." + foreign-key-id: "location-id" + + - name: "is_deleted" + type: "boolean" + description: "" + + - name: "present_at_all_locations" + type: "boolean" + description: "" + + - name: "tax_data" + type: "object" + description: "" + subattributes: + - name: "applies_to_custom_amounts" + type: "boolean" + description: "" + + - name: "calculation_phase" + type: "string" + description: "" + + - name: "enabled" + type: "boolean" + description: "" + + - name: "inclusion_type" + type: "string" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "percentage" + type: "string" + description: "" + + - name: "tax_type_id" + type: "string" + description: "" + + - name: "tax_type_name" + type: "string" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "version" + type: "integer" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/square/v2/team_members.md b/_integration-schemas/square/v2/team_members.md new file mode 100644 index 000000000..270af55e0 --- /dev/null +++ b/_integration-schemas/square/v2/team_members.md @@ -0,0 +1,78 @@ +--- +tap: "square" +version: "2" +key: "" + +name: "team_members" +doc-link: +singer-schema: https://github.com/singer-io/tap-square/tree/TDL-23352-schema-changes/tap_square/schemas/team_members.json +description: "" + +replication-method: "Key-based Incremental" + +api-method: + name: "Search team members" + doc-link: "https://developer.squareup.com/reference/square/team-api/search-team-members" + +table-key-properties: "" +valid-replication-keys: "updated_at" + +attributes: + - name: "assigned_locations" + type: "object" + description: "" + subattributes: + - name: "assignment_type" + type: "string" + description: "" + + - name: "location_ids" + type: "array" + description: "" + subattributes: + - name: "items" + type: "string" + description: "" + + + - name: "created_at" + type: "date-time" + description: "" + + - name: "email_address" + type: "string" + description: "" + + - name: "family_name" + type: "string" + description: "" + + - name: "given_name" + type: "string" + description: "" + + - name: "id" + type: "string" + description: "" + + - name: "is_owner" + type: "boolean" + description: "" + + - name: "phone_number" + type: "string" + description: "" + + - name: "reference_id" + type: "string" + description: "" + + - name: "status" + type: "string" + description: "" + + - name: "updated_at" + type: "date-time" + description: "" + replication-key: true +--- \ No newline at end of file