Skip to content
Open

XY/v1 #597

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions _data/taps/versions/xy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# -------------------------- #
# USING THIS TEMPLATE #
# -------------------------- #

## NEED HELP USING THIS TEMPLATE? SEE:
## https://docs-about-stitch-docs.netlify.com/reference/integration-templates/integration-versions/
## FOR INSTRUCTIONS & REFERENCE INFO


# -------------------------- #
# XY VERSIONS #
# -------------------------- #

latest-version: "1"

released-versions:
- number: "1"
status: "beta" ## beta, released, deprecated
date-released: ""
# date-last-connection:
deprecation-date: ""
sunset-date: ""
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
# -------------------------- #
# USING THIS TEMPLATE #
# -------------------------- #

## NEED HELP USING THIS TEMPLATE? SEE:
## https://docs-about-stitch-docs.netlify.com/reference/connect-templates/destination-form-property/
## FOR INSTRUCTIONS & REFERENCE INFO


# -------------------------- #
# CONTENT TYPE #
# -------------------------- #

product-type: "connect"
content-type: "api-form"
form-type: "source"
key: "source-form-properties-[integration]-object"


# -------------------------- #
# OBJECT INFO #
# -------------------------- #

title: "[INTEGRATION] Source Form Property"
api-type: "platform.[integration]"
display-name: "[INTEGRATION]"

source-type: "saas"
docs-name: "" # This should be whatever integration.name is. Ex: LinkedIn Ads is linkedin-ads

property-description: ""
## Used to create a description for the object that doesn't adhere to the standard in _developers/connect/api/documentation/api-form-properties.html
## See the Heap object for an example


# -------------------------- #
# OBJECT ATTRIBUTES #
# -------------------------- #

uses-start-date: true

# Only source-specific attributes need to be listed here.
# The following attributes are considered common,
# and therefore don't need to be listed:
# anchor_time, cron_expression, frequency_in_minutes, image_version, start_date

# object-attributes:
# - name: ""
# type: ""
# required: true/false
# description: ""
# value: ""
---
104 changes: 104 additions & 0 deletions _integration-schemas/xy/v1/customer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
---
tap: "x-y"
version: "1.0"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
version: "1.0"
version: "1"

key: "customer"

name: "customer"
doc-link: ""
singer-schema: "https://github.com/singer-io/tap-x-y/blob/master/tap_x_y/schemas/customer.json"
description: |
The `{{ table.name }}` table contains information about customers in your {{ integration.display_name }} account.

replication-method: "Key-based Incremental"

api-method:
name: ""
doc-link: ""
Comment on lines +14 to +16
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know XY doesn't have public docs, so it's fine that this isn't filled out. When this isn't being used, please comment it out. That way it won't create an empty field when Jekyll builds the site.


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

- name: "last_modified"
type: "integer"
description: "The time the customer's information was last modified."
replication-key: true

- name: "city"
type: "string"
description: ""
- name: "country"
type: "string"
description: ""
- name: "email"
type: "string"
description: ""
- name: "first_name"
type: "string"
description: ""
- name: "first_txn_date"
type: "integer"
description: ""

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

- name: "last_name"
type: "string"
description: ""
- name: "last_txn_amount_amount"
type: "integer"
description: ""
- name: "last_txn_amount_currency"
type: "string"
description: ""
- name: "last_txn_date"
type: "integer"
description: ""
- name: "online_spend_charges_net_amount"
type: "integer"
description: ""
- name: "online_spend_charges_net_currency"
type: "string"
description: ""
- name: "phone"
type: "string"
description: ""
- name: "promotion_spend_charges_net_amount_amount"
type: "integer"
description: ""
- name: "promotion_spend_charges_net_amount_currency"
type: "string"
description: ""
- name: "state"
type: "string"
description: ""
- name: "status"
type: "string"
description: ""
- name: "total_spend_aus_amount"
type: "integer"
description: ""
- name: "total_spend_aus_currency"
type: "string"
description: ""
- name: "total_spend_charges_net_amount_amount"
type: "integer"
description: ""
- name: "total_spend_charges_net_amount_currency"
type: "string"
description: ""
- name: "total_spend_net_quantity"
type: "integer"
description: ""
- name: "total_spend_order_count"
type: "integer"
description: ""
- name: "total_spend_sold_quantity"
type: "integer"
description: ""
---
40 changes: 40 additions & 0 deletions _integration-schemas/xy/v1/foreign-keys.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
# -------------------------- #
# 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: "x-y"

version: "1"

foreign-keys:
- id: "item-id"
table: "item"
attribute: "id"
all-foreign-keys:
- table: "item"
join-on: "id"
- table: "inventory"
join-on: "item_uri"
- table: "inventory_movement"
join-on: "item_uri"
- table: "sales_order_line"
join-on: "item_uri"
- table: "stock_transfer"
join-on: "item_uri"

- id: "order-id"
table: "sales_order_line"
attribute: "id"
all-foreign-keys:
- table: "sales_order_line"
join-on: "id"
- table: "inventory_movement"
join-on: "order"
- table: "sales_order_line"
join-on: "order_uri"
---
96 changes: 96 additions & 0 deletions _integration-schemas/xy/v1/inventory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
---
tap: "x-y"
version: "1.0"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
version: "1.0"
version: "1"

key: "inventory"

name: "inventory"
doc-link: ""
singer-schema: "https://github.com/singer-io/tap-x-y/blob/master/tap_x_y/schemas/inventory.json"
description: |
The `{{ table.name }}` table contains information about product inventory in your {{ integration.display_name }} account.

replication-method: "Key-based Incremental"

api-method:
name: ""
doc-link: ""

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

- name: "last_modified"
type: "integer"
description: "The time the inventory was last modified."
replication-key: true

- name: "available"
type: "integer"
description: ""
- name: "available_msrp_amount"
type: "integer"
description: ""
- name: "available_msrp_currency"
type: "string"
description: ""
- name: "available_price_amount"
type: "integer"
description: ""
- name: "available_price_currency"
type: "string"
description: ""
- name: "consigned_msrp_amount"
type: "integer"
description: ""
- name: "consigned_msrp_currency"
type: "string"
description: ""
- name: "consigned_price_amount"
type: "integer"
description: ""
- name: "consigned_price_currency"
type: "string"
description: ""
- name: "currency"
type: "string"
description: ""
- name: "held_msrp_amount"
type: "integer"
description: ""
- name: "held_msrp_currency"
type: "string"
description: ""
- name: "held_price_amount"
type: "integer"
description: ""
- name: "held_price_currency"
type: "string"
description: ""

- name: "item_uri"
type: "string"
description: "The item URI."
foreign-key-id: "item-id"

- name: "on_hand"
type: "string"
description: ""
- name: "on_hand_msrp_amount"
type: "integer"
description: ""
- name: "on_hand_msrp_currency"
type: "string"
description: ""
- name: "on_hand_price_amount"
type: "integer"
description: ""
- name: "on_hand_price_currency"
type: "string"
description: ""
- name: "store_uri"
type: "string"
description: ""
---
Loading