From 053277e59c06eb82cbb29b2dd8d1095426d62416 Mon Sep 17 00:00:00 2001 From: Jazmin Smith Date: Tue, 28 Jul 2020 10:44:45 -0400 Subject: [PATCH 01/11] new v1 files --- _account-security/testing.md | 12 ++ .../sources/saas/intercom-object.md | 53 ++++++ _data/taps/versions/intercom.yml | 21 +++ _integration-schemas/intercom/v1/admins.md | 53 ++++++ _integration-schemas/intercom/v1/companies.md | 105 +++++++++++ .../intercom/v1/company_attributes.md | 64 +++++++ .../intercom/v1/company_segments.md | 40 ++++ .../intercom/v1/conversation_parts.md | 78 ++++++++ .../intercom/v1/conversations.md | 177 ++++++++++++++++++ .../intercom/v1/customer_attributes.md | 64 +++++++ .../intercom/v1/foreign-keys.md | 157 ++++++++++++++++ _integration-schemas/intercom/v1/leads.md | 170 +++++++++++++++++ _integration-schemas/intercom/v1/segments.md | 42 +++++ _integration-schemas/intercom/v1/tags.md | 30 +++ _integration-schemas/intercom/v1/teams.md | 37 ++++ _integration-schemas/intercom/v1/users.md | 173 +++++++++++++++++ .../intercom/{ => v15-10-2015}/admins.md | 2 +- .../intercom/{ => v15-10-2015}/companies.md | 0 .../{ => v15-10-2015}/company_segments.md | 0 .../intercom/{ => v15-10-2015}/contacts.md | 0 .../{ => v15-10-2015}/conversations.md | 0 .../{ => v15-10-2015}/foreign-keys.md | 0 .../intercom/{ => v15-10-2015}/segments.md | 0 .../intercom/{ => v15-10-2015}/tags.md | 0 .../intercom/{ => v15-10-2015}/users.md | 0 _saas-integrations/intercom/v1/intercom-v1.md | 126 +++++++++++++ .../{ => v15-10-2015}/intercom-latest.md | 0 27 files changed, 1403 insertions(+), 1 deletion(-) create mode 100644 _account-security/testing.md create mode 100644 _connect-files/api/objects/form-properties/sources/saas/intercom-object.md create mode 100644 _data/taps/versions/intercom.yml create mode 100644 _integration-schemas/intercom/v1/admins.md create mode 100644 _integration-schemas/intercom/v1/companies.md create mode 100644 _integration-schemas/intercom/v1/company_attributes.md create mode 100644 _integration-schemas/intercom/v1/company_segments.md create mode 100644 _integration-schemas/intercom/v1/conversation_parts.md create mode 100644 _integration-schemas/intercom/v1/conversations.md create mode 100644 _integration-schemas/intercom/v1/customer_attributes.md create mode 100644 _integration-schemas/intercom/v1/foreign-keys.md create mode 100644 _integration-schemas/intercom/v1/leads.md create mode 100644 _integration-schemas/intercom/v1/segments.md create mode 100644 _integration-schemas/intercom/v1/tags.md create mode 100644 _integration-schemas/intercom/v1/teams.md create mode 100644 _integration-schemas/intercom/v1/users.md rename _integration-schemas/intercom/{ => v15-10-2015}/admins.md (98%) rename _integration-schemas/intercom/{ => v15-10-2015}/companies.md (100%) rename _integration-schemas/intercom/{ => v15-10-2015}/company_segments.md (100%) rename _integration-schemas/intercom/{ => v15-10-2015}/contacts.md (100%) rename _integration-schemas/intercom/{ => v15-10-2015}/conversations.md (100%) rename _integration-schemas/intercom/{ => v15-10-2015}/foreign-keys.md (100%) rename _integration-schemas/intercom/{ => v15-10-2015}/segments.md (100%) rename _integration-schemas/intercom/{ => v15-10-2015}/tags.md (100%) rename _integration-schemas/intercom/{ => v15-10-2015}/users.md (100%) create mode 100644 _saas-integrations/intercom/v1/intercom-v1.md rename _saas-integrations/intercom/{ => v15-10-2015}/intercom-latest.md (100%) diff --git a/_account-security/testing.md b/_account-security/testing.md new file mode 100644 index 000000000..a10e826ea --- /dev/null +++ b/_account-security/testing.md @@ -0,0 +1,12 @@ +--- +title: testing +permalink: /testing/ +--- + +{% assign intercom-tables = site.integration-schemas | where:"tap","intercom" %} + +{% assign this-versions-tables = intercom-tables | where:"version","15-10-2015" %} + +{% for table in this-versions-tables %} +- {{ table.name }} : {{ table.version }} +{% endfor %} \ No newline at end of file diff --git a/_connect-files/api/objects/form-properties/sources/saas/intercom-object.md b/_connect-files/api/objects/form-properties/sources/saas/intercom-object.md new file mode 100644 index 000000000..2b879dd80 --- /dev/null +++ b/_connect-files/api/objects/form-properties/sources/saas/intercom-object.md @@ -0,0 +1,53 @@ +--- +# -------------------------- # +# 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 # +# -------------------------- # + +content-type: "api-form" +form-type: "source" +key: "source-form-properties-intercom-object" + + +# -------------------------- # +# OBJECT INFO # +# -------------------------- # + +title: "Intercom Source Form Property" +api-type: "platform.intercom" +display-name: "Intercom" + +source-type: "saas" +docs-name: "intercom" + +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: "access_token" + type: "string" + required: true + description: "The token used to access your workspace's data via API." + value: "YOU_API_ACCESS_TOKEN" +--- \ No newline at end of file diff --git a/_data/taps/versions/intercom.yml b/_data/taps/versions/intercom.yml new file mode 100644 index 000000000..c1876c0f6 --- /dev/null +++ b/_data/taps/versions/intercom.yml @@ -0,0 +1,21 @@ +# -------------------------- # +# 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 + + +# -------------------------- # +# [INTEGRATION] VERSIONS # +# -------------------------- # + +latest-version: "1.0" + +released-versions: + - number: "1.0" + date-released: "11-05-2019" + # date-last-connection: + deprecated: false + deprecation-date: "n/a" \ No newline at end of file diff --git a/_integration-schemas/intercom/v1/admins.md b/_integration-schemas/intercom/v1/admins.md new file mode 100644 index 000000000..2c7bbe34d --- /dev/null +++ b/_integration-schemas/intercom/v1/admins.md @@ -0,0 +1,53 @@ +--- +tap: "intercom" +version: "1" + +name: "admins" +doc-link: "https://developers.intercom.com/intercom-api-reference/reference#admin-model" +singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/admins.json" +description: | + The `{{ table.name }}` table lists info about the admins in your {{ integration.display_name }} account. + +replication-method: "Full Table" + +api-method: + name: "listAllAdmins" + doc-link: "https://developers.intercom.com/intercom-api-reference/reference#list-admins" + +attributes: + - name: "id" + type: "integer" + primary-key: true + description: "The admin ID." + foreign-key-id: "admin-id" + + - name: "admin_ids" + type: "null" + description: "" + - name: "away_mode_enabled" + type: "boolean" + description: "" + - name: "away_mode_reassign" + type: "boolean" + description: "" + - name: "email" + type: "string" + description: "" + - name: "has_inbox_seat" + type: "boolean" + description: "" + + - name: "job_title" + type: "string" + description: "" + - name: "name" + type: "string" + description: "" + - name: "team_ids" + type: "array" + description: "A list of the of team IDs that the admin is part of." + foreign-key-id: "team-id" + - name: "type" + type: "string" + description: "" +--- diff --git a/_integration-schemas/intercom/v1/companies.md b/_integration-schemas/intercom/v1/companies.md new file mode 100644 index 000000000..b5c124702 --- /dev/null +++ b/_integration-schemas/intercom/v1/companies.md @@ -0,0 +1,105 @@ +--- +tap: "intercom" +version: "1" + +name: "companies" +doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#company-model" +singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/companies.json" +description: | + The `{{ table.name }}` table contains info about companies that use your {{ integration.display_name }} product. + + #### Custom Attributes + + If applicable, Stitch will replicate custom fields related to `{{ table.name }}` in Intercom. + +replication-method: "Key-based Incremental" + +api-method: + name: "scrollOverAllCompanies" + doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#iterating-over-all-companies" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The company ID." + foreign-key-id: "company-id" + + - name: "updated_at" + type: "date-time" + description: "The time the company was last updated." + replication-key: true + + - name: "company_id" + type: "string" + description: "" + - name: "created_at" + type: "date-time" + description: "" + - name: "custom_attributes" + type: "object" + description: "" + subattributes: + - name: "DELETEME" + type: "string" + description: "" + + - name: "industry" + type: "string" + description: "" + - name: "monthly_spend" + type: "number" + description: "" + - name: "name" + type: "string" + description: "" + - name: "plan" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "name" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "remote_created_at" + type: "date-time" + description: "" + - name: "segments" + type: "array" + description: "A list of segments within a company." + subattributes: + - name: "id" + type: "string" + description: "The segment ID." + foreign-key-id: "segment-id" + + - name: "session_count" + type: "integer" + description: "" + - name: "size" + type: "integer" + description: "" + - name: "tags" + type: "array" + description: "A list of tags within a company." + subattributes: + - name: "id" + type: "string" + description: "The tag ID." + foreign-key-id: "tag-id" + - name: "type" + type: "string" + description: "" + + - name: "user_count" + type: "integer" + description: "" + - name: "website" + type: "string" + description: "" +--- diff --git a/_integration-schemas/intercom/v1/company_attributes.md b/_integration-schemas/intercom/v1/company_attributes.md new file mode 100644 index 000000000..52525f412 --- /dev/null +++ b/_integration-schemas/intercom/v1/company_attributes.md @@ -0,0 +1,64 @@ +--- +tap: "intercom" +version: "1" + +name: "company_attributes" +doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#data-attribute-model" +singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/company_attributes.json" +description: | + The `{{ table.name }}` lists data attributes for a specified company in your {{ integration.display_name }} account. + +replication-method: "Full Table" + +api-method: + name: "listAllDataAttributes" + doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#list-data-attributes" + +attributes: + - name: "name" + type: "string" + primary-key: true + description: "The name of the attribute." + foreign-key-id: "attribute-name" + + - name: "admin_id" + type: "integer" + description: "" + - name: "api_writable" + type: "boolean" + description: "" + - name: "archived" + type: "boolean" + description: "" + - name: "created_at" + type: "date-time" + description: "" + - name: "custom" + type: "boolean" + description: "" + - name: "data_type" + type: "string" + description: "" + - name: "description" + type: "string" + description: "" + - name: "full_name" + type: "string" + description: "" + - name: "label" + type: "string" + description: "" + + - name: "options" + type: "null" + description: "" + - name: "type" + type: "string" + description: "" + - name: "ui_writable" + type: "boolean" + description: "" + - name: "updated_at" + type: "date-time" + description: "" +--- diff --git a/_integration-schemas/intercom/v1/company_segments.md b/_integration-schemas/intercom/v1/company_segments.md new file mode 100644 index 000000000..fec838b81 --- /dev/null +++ b/_integration-schemas/intercom/v1/company_segments.md @@ -0,0 +1,40 @@ +--- +tap: "intercom" +version: "1" +name: "company_segments" +doc-link: "" + +singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/company_segments.json" +description: "" + +replication-method: "Key-based Incremental" + +api-method: + name: "" + doc-link: "" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The company segment ID." + foreign-key-id: "company-segment" + + - name: "updated_at" + type: "date-time" + description: "The time the company segment was last updated." + replication-key: true + + - name: "count" + type: "integer" + description: "" + - name: "created_at" + type: "date-time" + description: "" + - name: "name" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" +--- diff --git a/_integration-schemas/intercom/v1/conversation_parts.md b/_integration-schemas/intercom/v1/conversation_parts.md new file mode 100644 index 000000000..5614db876 --- /dev/null +++ b/_integration-schemas/intercom/v1/conversation_parts.md @@ -0,0 +1,78 @@ +--- +tap: "intercom" +version: "1" + +name: "conversation_parts" +doc-link: "" +singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/conversation_parts.json" +description: | + The `{{ table.name }}` table lists parts of a conversation from the `conversations`table in your {{ integration.display_name }} account. + +replication-method: "Full Table" + +api-method: + name: "" + doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#retrieve-a-conversation" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The conversation part ID." + foreign-key-id: "part-id" + + - name: "assigned_to" + type: "string" + description: "" + - name: "attachments" + type: "null" + description: "" + - name: "author" + type: "object" + description: "A list of conversation authors." + subattributes: + - name: "id" + type: "string" + description: "The author ID." + foreign-key-id: "author-id" + - name: "type" + type: "string" + description: "" + - name: "body" + type: "string" + description: "" + - name: "conversation_created_at" + type: "date-time" + description: "" + + - name: "conversation_id" + type: "string" + description: "The conversation ID." + foreign-key-id: "conversation-id" + + - name: "conversation_total_parts" + type: "integer" + description: "" + - name: "conversation_updated_at" + type: "date-time" + description: "" + - name: "created_at" + type: "date-time" + description: "" + - name: "external_id" + type: "string" + description: "" + + - name: "notified_at" + type: "date-time" + description: "" + - name: "part_type" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "updated_at" + type: "date-time" + description: "" +--- diff --git a/_integration-schemas/intercom/v1/conversations.md b/_integration-schemas/intercom/v1/conversations.md new file mode 100644 index 000000000..293a7f036 --- /dev/null +++ b/_integration-schemas/intercom/v1/conversations.md @@ -0,0 +1,177 @@ +--- +tap: "intercom" +version: "1" + +name: "conversations" +doc-link: "" +singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/conversations.json" +description: | + The `{{ table.name }}` table contains info about user conversations 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 conversation ID." + foreign-key-id: "conversation-id" + + - name: "updated_at" + type: "date-time" + description: "The time that the conversation was last updated." + replication-key: true + + - name: "assignee" + type: "object" + description: "A list of conversation assignees." + subattributes: + - name: "id" + type: "integer" + description: "The assignee ID." + foreign-key-id: "asignee-id" + + - name: "type" + type: "string" + description: "" + - name: "conversation_message" + type: "object" + description: "A list of message details." + subattributes: + - name: "attachments" + type: "null" + description: "" + - name: "author" + type: "object" + description: "A list of authors." + subattributes: + - name: "id" + type: "string" + description: "The author ID." + foreign-key-id: "author-ID" + - name: "type" + type: "string" + description: "" + - name: "body" + type: "string" + description: "" + - name: "delivered_as" + type: "string" + description: "" + - name: "id" + type: "string" + description: "" + - name: "subject" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "url" + type: "string" + description: "" + - name: "conversation_rating" + type: "object" + description: "" + subattributes: + - name: "created_at" + type: "date-time" + description: "" + - name: "customer" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "rating" + type: "integer" + description: "" + - name: "remark" + type: "string" + description: "" + - name: "teammate" + type: "object" + description: "" + subattributes: + - name: "id" + type: "integer" + description: "" + - name: "type" + type: "string" + description: "" + - name: "created_at" + type: "date-time" + description: "" + - name: "customer_first_reply" + type: "object" + description: "" + subattributes: + - name: "created_at" + type: "date-time" + description: "" + - name: "type" + type: "string" + description: "" + - name: "url" + type: "string" + description: "" + - name: "customers" + type: "array" + description: "A list of customers." + subattributes: + - name: "id" + type: "string" + description: "The customer ID." + foreign-key-id: "customer-id" + + - name: "open" + type: "boolean" + description: "" + - name: "read" + type: "boolean" + description: "" + - name: "sent_at" + type: "date-time" + description: "" + - name: "snoozed_until" + type: "date-time" + description: "" + - name: "state" + type: "string" + description: "" + - name: "tags" + type: "array" + description: "A list of tags." + subattributes: + - name: "id" + type: "string" + description: "The tag ID." + foreign-key-id: "tag-id" + + - name: "type" + type: "string" + description: "" + + - name: "user" + type: "object" + description: "A list of users." + subattributes: + - name: "id" + type: "string" + description: "The user ID." + foreign-key-id: "user-id" + - name: "type" + type: "string" + description: "" + - name: "waiting_since" + type: "date-time" + description: "" +--- diff --git a/_integration-schemas/intercom/v1/customer_attributes.md b/_integration-schemas/intercom/v1/customer_attributes.md new file mode 100644 index 000000000..7917ed8f8 --- /dev/null +++ b/_integration-schemas/intercom/v1/customer_attributes.md @@ -0,0 +1,64 @@ +--- +tap: "intercom" +version: "1" + +name: "customer_attributes" +doc-link: "" +singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/customer_attributes.json" +description: | + The `{{ table.name }}` table contains information about your customers in your {{ integration.display_name }} account. + +replication-method: "Full Table" + +api-method: + name: "" + doc-link: "" + +attributes: + - name: "name" + type: "string" + primary-key: true + description: "The name of the customer attribute." + foreign-key-id: "customer-attribute-name" + + - name: "admin_id" + type: "integer" + description: "" + - name: "api_writable" + type: "boolean" + description: "" + - name: "archived" + type: "boolean" + description: "" + - name: "created_at" + type: "date-time" + description: "" + - name: "custom" + type: "boolean" + description: "" + - name: "data_type" + type: "string" + description: "" + - name: "description" + type: "string" + description: "" + - name: "full_name" + type: "string" + description: "" + - name: "label" + type: "string" + description: "" + + - name: "options" + type: "null" + description: "" + - name: "type" + type: "string" + description: "" + - name: "ui_writable" + type: "boolean" + description: "" + - name: "updated_at" + type: "date-time" + description: "" +--- diff --git a/_integration-schemas/intercom/v1/foreign-keys.md b/_integration-schemas/intercom/v1/foreign-keys.md new file mode 100644 index 000000000..803748bee --- /dev/null +++ b/_integration-schemas/intercom/v1/foreign-keys.md @@ -0,0 +1,157 @@ +--- +# -------------------------- # +# 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: "intercom" + +version: "1" + +foreign-keys: + - id: "admin-id" + table: "admins" + attribute: "id" + all-foreign-keys: + - table: "admins" + join-on: "id" + - table: "teams" + subattribute: "admin_ids" + join-on: "id" + + - id: "team-id" + table: "teams" + attribute: "id" + all-foreign-keys: + - table: "teams" + join-on: "id" + - table: "admins" + join-on: "team_ids" + + - id: "company-id" + table: "companies" + attribute: "id" + all-foreign-keys: + - table: "companies" + join-on: "id" + - table: "leads" + subattribute: "companies" + join-on: "id" + - table: "users" + subattribute: "companies" + join-on: "id" + + - id: "segment-id" + table: "segment" + attribute: "id" + all-foreign-keys: + - table: "segment" + join-on: "id" + - table: "companies" + subattribute: "segments" + join-on: "id" + - table: "leads" + subattribute: "segments" + join-on: "id" + - table: "users" + subattribute: "segments" + join-on: "id" + + - id: "tag-id" + table: "tags" + attribute: "id" + all-foreign-keys: + - table: "tags" + join-on: "id" + - table: "companies" + subattribute: "tags" + join-on: "id" + - table: "conversations" + subattribute: "tags" + join-on: "id" + - table: "leads" + subattribute: "tags" + join-on: "id" + - table: "users" + subattribute: "tags" + join-on: "id" + + - id: "attribute-name" + table: "company_attributes" + attribute: "name" + all-foreign-keys: + - table: "company_attributes" + join-on: "name" + + - id: "company-segment" + table: "company_segments" + attribute: "id" + all-foreign-keys: + - table: "company_segments" + join-on: "id" + + - id: "part-id" + table: "conversation_parts" + attribute: "id" + all-foreign-keys: + - table: "conversation_parts" + join-on: "id" + + - id: "conversation-id" + table: "conversations" + attribute: "id" + all-foreign-keys: + - table: "conversations" + join-on: "id" + - table: "conversation_parts" + join-on: "conversation_id" + + - id: "author-id" + table: "authors" + attribute: "id" + all-foreign-keys: + - table: "conversation_parts" + subattribute: "author" + join-on: "id" + - table: "conversations" + subattribute: "conversation_message.author" + join-on: "id" + + - id: "assignee-id" + table: "assignees" + attribute: "id" + all-foreign-keys: + - table: "conversations" + subattribute: "assignee" + join-on: "id" + + - id: "customer-id" + table: "customers" + attribute: "id" + all-foreign-keys: + - table: "customers" + join-on: "id" + - table: "conversations" + subattribute: "customers" + join-on: "id" + + - id: "user-id" + table: "users" + attribute: "id" + all-foreign-keys: + - table: "users" + join-on: "id" + - table: "conversations" + subattribute: "user" + join-on: "id" + + - id: "customer-attribute-name" + table: "customer_attributes" + attribute: "name" + all-foreign-keys: + - table: "customer_attributes" + join-on: "name" +--- \ No newline at end of file diff --git a/_integration-schemas/intercom/v1/leads.md b/_integration-schemas/intercom/v1/leads.md new file mode 100644 index 000000000..ae6e937bc --- /dev/null +++ b/_integration-schemas/intercom/v1/leads.md @@ -0,0 +1,170 @@ +--- +tap: "intercom" +version: "1" + +name: "leads" +doc-link: "" +singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/leads.json" +description: | + The `{{ table.name }}` table contains information about leads in your {{ integration.display_name }}. + +replication-method: "Key-based Incremental" + +api-method: + name: "" + doc-link: "" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The lead ID." + foreign-key-id: "lead-id" + + - name: "updated_at" + type: "date-time" + description: "The time the the lead was last updated." + replication-key: true + + - name: "anonymous" + type: "boolean" + description: "" + - name: "app_id" + type: "string" + description: "" + - name: "avatar" + type: "object" + description: "" + subattributes: + - name: "image_url" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "companies" + type: "array" + description: "A list of companies" + subattributes: + - name: "id" + type: "string" + description: "The company ID." + - name: "created_at" + type: "date-time" + description: "" + - name: "custom_attributes" + type: "object" + description: "" + subattributes: + - name: "DELETEME" + type: "string" + description: "" + - name: "do_not_track" + type: "boolean" + description: "" + - name: "email" + type: "string" + description: "" + - name: "has_hard_bounced" + type: "boolean" + description: "" + + - name: "last_request_at" + type: "date-time" + description: "" + - name: "location_data" + type: "object" + description: "" + subattributes: + - name: "city_name" + type: "string" + description: "" + - name: "continent_code" + type: "string" + description: "" + - name: "country_code" + type: "string" + description: "" + - name: "country_name" + type: "string" + description: "" + - name: "postal_code" + type: "string" + description: "" + - name: "region_name" + type: "string" + description: "" + - name: "timezone" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "marked_email_as_spam" + type: "boolean" + description: "" + - name: "name" + type: "string" + description: "" + - name: "phone" + type: "string" + description: "" + - name: "pseudonym" + type: "string" + description: "" + - name: "referrer" + type: "string" + description: "" + - name: "remote_created_at" + type: "date-time" + description: "" + - name: "segments" + type: "array" + description: "A list of segments." + subattributes: + - name: "id" + type: "string" + description: "The segment ID." + foreign-key-id: "segment-id" + - name: "session_count" + type: "integer" + description: "" + - name: "signed_up_at" + type: "date-time" + description: "" + - name: "social_profiles" + type: "null" + description: "" + - name: "tags" + type: "array" + description: "A list of tags." + subattributes: + - name: "id" + type: "string" + description: "The tag ID." + - name: "type" + type: "string" + description: "" + - name: "unsubscribed_from_emails" + type: "boolean" + description: "" + + - name: "user_id" + type: "string" + description: "" + - name: "utm_campaign" + type: "string" + description: "" + - name: "utm_content" + type: "string" + description: "" + - name: "utm_medium" + type: "string" + description: "" + - name: "utm_source" + type: "string" + description: "" + - name: "utm_term" + type: "string" + description: "" +--- diff --git a/_integration-schemas/intercom/v1/segments.md b/_integration-schemas/intercom/v1/segments.md new file mode 100644 index 000000000..aef8e3c25 --- /dev/null +++ b/_integration-schemas/intercom/v1/segments.md @@ -0,0 +1,42 @@ +--- +tap: "intercom" +version: "1" + +name: "segments" +doc-link: "" +singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/segments.json" +description: + The `{{ table.name }}` table contains information about segments within 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 segment ID." + foreign-key-id: "segment-id" + + - name: "updated_at" + type: "date-time" + description: "The time the segment was last updated." + replication-key: true + + - name: "count" + type: "integer" + description: "" + - name: "created_at" + type: "date-time" + description: "" + + - name: "name" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" +--- diff --git a/_integration-schemas/intercom/v1/tags.md b/_integration-schemas/intercom/v1/tags.md new file mode 100644 index 000000000..d2177371d --- /dev/null +++ b/_integration-schemas/intercom/v1/tags.md @@ -0,0 +1,30 @@ +--- +tap: "intercom" +version: "1" + +name: "tags" +doc-link: "" +singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/tags.json" +description: | + The `{{ table.name }}` table contains information about tags within your {{ integration.display_name }} account. + +replication-method: "Full Table" + +api-method: + name: "" + doc-link: "" + +attributes: + - name: "id" + type: "integer" + primary-key: true + description: "The tag ID." + foreign-key-id: "tag-id" + + - name: "name" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" +--- diff --git a/_integration-schemas/intercom/v1/teams.md b/_integration-schemas/intercom/v1/teams.md new file mode 100644 index 000000000..c5eb21d9d --- /dev/null +++ b/_integration-schemas/intercom/v1/teams.md @@ -0,0 +1,37 @@ +--- +tap: "intercom" +version: "1" + +name: "teams" +doc-link: "" +singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/teams.json" +description: "" + +replication-method: "Full Table" + +api-method: + name: "" + doc-link: "" + +attributes: + - name: "id" + type: "integer" + primary-key: true + description: "The team ID." + foreign-key-id: "team-id" + + - name: "admin_ids" + type: "array" + description: "A list of admin IDs." + subattributes: + - name: "id" + type: "string" + description: "The admin ID." + + - name: "name" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" +--- diff --git a/_integration-schemas/intercom/v1/users.md b/_integration-schemas/intercom/v1/users.md new file mode 100644 index 000000000..61540855a --- /dev/null +++ b/_integration-schemas/intercom/v1/users.md @@ -0,0 +1,173 @@ +--- +tap: "intercom" +version: "1" + +name: "users" +doc-link: "" +singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/users.json" +description: "" + +replication-method: "Key-based Incremental" + +api-method: + name: "" + doc-link: "" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The user ID." + foreign-key-id: "user-id" + + - name: "updated_at" + type: "date-time" + description: "The time the user was last updated." + replication-key: true + + - name: "anonymous" + type: "boolean" + description: "" + - name: "app_id" + type: "string" + description: "" + - name: "avatar" + type: "object" + description: "" + subattributes: + - name: "image_url" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "companies" + type: "array" + description: "A list of companies." + subattributes: + - name: "id" + type: "string" + description: "The company ID." + foreign-key-id: "company-id" + + - name: "created_at" + type: "date-time" + description: "" + - name: "custom_attributes" + type: "object" + description: "" + subattributes: + - name: "DELETEME" + type: "string" + description: "" + - name: "do_not_track" + type: "boolean" + description: "" + - name: "email" + type: "string" + description: "" + - name: "has_hard_bounced" + type: "boolean" + description: "" + + - name: "last_request_at" + type: "date-time" + description: "" + - name: "location_data" + type: "object" + description: "" + subattributes: + - name: "city_name" + type: "string" + description: "" + - name: "continent_code" + type: "string" + description: "" + - name: "country_code" + type: "string" + description: "" + - name: "country_name" + type: "string" + description: "" + - name: "postal_code" + type: "string" + description: "" + - name: "region_name" + type: "string" + description: "" + - name: "timezone" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "marked_email_as_spam" + type: "boolean" + description: "" + - name: "name" + type: "string" + description: "" + - name: "phone" + type: "string" + description: "" + - name: "pseudonym" + type: "string" + description: "" + - name: "referrer" + type: "string" + description: "" + - name: "remote_created_at" + type: "date-time" + description: "" + - name: "segments" + type: "array" + description: "A list of segments." + subattributes: + - name: "id" + type: "string" + description: "The segment ID." + foreign-key-id: "segment-id" + + - name: "session_count" + type: "integer" + description: "" + - name: "signed_up_at" + type: "date-time" + description: "" + - name: "social_profiles" + type: "null" + description: "" + - name: "tags" + type: "array" + description: "A list of tags." + subattributes: + - name: "id" + type: "string" + description: "The tag ID." + foreign-key-id: "tag-id" + - name: "type" + type: "string" + description: "" + - name: "unsubscribed_from_emails" + type: "boolean" + description: "" + + - name: "user_id" + type: "string" + description: "" + - name: "utm_campaign" + type: "string" + description: "" + - name: "utm_content" + type: "string" + description: "" + - name: "utm_medium" + type: "string" + description: "" + - name: "utm_source" + type: "string" + description: "" + - name: "utm_term" + type: "string" + description: "" +--- diff --git a/_integration-schemas/intercom/admins.md b/_integration-schemas/intercom/v15-10-2015/admins.md similarity index 98% rename from _integration-schemas/intercom/admins.md rename to _integration-schemas/intercom/v15-10-2015/admins.md index 456096861..912f0405f 100755 --- a/_integration-schemas/intercom/admins.md +++ b/_integration-schemas/intercom/v15-10-2015/admins.md @@ -1,6 +1,6 @@ --- tap: "intercom" -# version: "15-10-2015" +#version: "15-10-2015" name: "admins" doc-link: https://developers.intercom.io/docs/admins diff --git a/_integration-schemas/intercom/companies.md b/_integration-schemas/intercom/v15-10-2015/companies.md similarity index 100% rename from _integration-schemas/intercom/companies.md rename to _integration-schemas/intercom/v15-10-2015/companies.md diff --git a/_integration-schemas/intercom/company_segments.md b/_integration-schemas/intercom/v15-10-2015/company_segments.md similarity index 100% rename from _integration-schemas/intercom/company_segments.md rename to _integration-schemas/intercom/v15-10-2015/company_segments.md diff --git a/_integration-schemas/intercom/contacts.md b/_integration-schemas/intercom/v15-10-2015/contacts.md similarity index 100% rename from _integration-schemas/intercom/contacts.md rename to _integration-schemas/intercom/v15-10-2015/contacts.md diff --git a/_integration-schemas/intercom/conversations.md b/_integration-schemas/intercom/v15-10-2015/conversations.md similarity index 100% rename from _integration-schemas/intercom/conversations.md rename to _integration-schemas/intercom/v15-10-2015/conversations.md diff --git a/_integration-schemas/intercom/foreign-keys.md b/_integration-schemas/intercom/v15-10-2015/foreign-keys.md similarity index 100% rename from _integration-schemas/intercom/foreign-keys.md rename to _integration-schemas/intercom/v15-10-2015/foreign-keys.md diff --git a/_integration-schemas/intercom/segments.md b/_integration-schemas/intercom/v15-10-2015/segments.md similarity index 100% rename from _integration-schemas/intercom/segments.md rename to _integration-schemas/intercom/v15-10-2015/segments.md diff --git a/_integration-schemas/intercom/tags.md b/_integration-schemas/intercom/v15-10-2015/tags.md similarity index 100% rename from _integration-schemas/intercom/tags.md rename to _integration-schemas/intercom/v15-10-2015/tags.md diff --git a/_integration-schemas/intercom/users.md b/_integration-schemas/intercom/v15-10-2015/users.md similarity index 100% rename from _integration-schemas/intercom/users.md rename to _integration-schemas/intercom/v15-10-2015/users.md diff --git a/_saas-integrations/intercom/v1/intercom-v1.md b/_saas-integrations/intercom/v1/intercom-v1.md new file mode 100644 index 000000000..9afaabc2e --- /dev/null +++ b/_saas-integrations/intercom/v1/intercom-v1.md @@ -0,0 +1,126 @@ +--- +# -------------------------- # +# USING THIS TEMPLATE # +# -------------------------- # + +## NEED HELP USING THIS TEMPLATE? SEE: +## https://docs-about-stitch-docs.netlify.com/reference/integration-templates/saas/ +## FOR INSTRUCTIONS & REFERENCE INFO + + +# -------------------------- # +# Page & Formatting # +# -------------------------- # + +title: Intercom +permalink: /integrations/saas/intercom +keywords: intercom, integration, schema, etl intercom, intercom etl, intercom schema +layout: singer +# input: false + +# -------------------------- # +# Tap Details # +# -------------------------- # + +name: "intercom" +display_name: "Intercom" + +singer: true +tap-name: "intercom" +repo-url: https://github.com/singer-io/tap-intercom + +api: | + [{{ integration.display_name }} API (V2.0)](https://developers.intercom.com/intercom-api-reference/v2.0/reference){:target="new"} + +# this-version: "1.0" + +# -------------------------- # +# Stitch Details # +# -------------------------- # + +status: "Released" +certified: true + +historical: "1 year" +frequency: "30 minutes" +tier: "Standard" +status-url: "https://status.intercom.io/" + +anchor-scheduling: true +cron-scheduling: false + +extraction-logs: true +loading-reports: true + +table-selection: false +column-selection: false + +## Row usage details + +row-usage-hog: true +row-usage-hog-reasons: + data-structure: true + data-volume: true + lots-of-full-table: false + +# -------------------------- # +# Querying Details # +# -------------------------- # + +## Intercom's default attribution window. Stitch queries for +## this number of days during each replication job to +## account for any updates to existing records made during +## this time. + +replication-notes: true +attribution-window: "30 days" +# attribution-is-configurable: + +# setup-name: "" + +# -------------------------- # +# Incompatibilities # +# -------------------------- # + +## uncomment section below if integration is compatible with any Stitch destinations +## if incompatible with multiple destinations, create a section for each destination + +## incompatible: + ## [redshift]: "always,sometimes,never" + ## reason: "copy" + +# -------------------------- # +# Setup Instructions # +# -------------------------- # + +requirements-list: + - item: "**Your {{ integration.display_name }} App ID.** You can find your {{ integration.display_name }} App ID by following [these instructions](https://docs.intercom.com/faqs-and-troubleshooting/getting-set-up/where-can-i-find-my-app-id)." + +setup-steps: + - title: "add integration" + content: | + 4. In the **{{ integration.display_name }} App ID** field, enter your [{{ integration.display_name }} App ID](https://docs.intercom.com/faqs-and-troubleshooting/getting-set-up/where-can-i-find-my-app-id). + - title: "historical sync" + - title: "replication frequency" + - title: "track data" + - title: "Authorize Stitch to Access {{ integration.display_name }}" + anchor: "authorize-stitch" + content: | + Lastly, you'll be directed to Intercom's website to complete the setup. + + {% include layout/inline_image.html type="right" file="integrations/intercom-access-request.png" alt="List of permissions requested by Stitch to access Intercom" max-width="400px" %}1. If you aren't already logged into Intercom, you'll be prompted to do so. + 2. Next, a screen requesting access to Intercom will display. **Note**: Stitch will only ever read your data. + 3. Click **Connect.** + 4. After the authorization process successfully completes, you'll be redirected back to Stitch. + 5. Click {{ app.buttons.finish-int-setup }}. + +# -------------------------- # +# Integration Tables # +# -------------------------- # + +# Looking for the table schemas & info? +# Each table has a its own .md file in /_integration-schemas/saas-integration + +--- +{% assign integration = page %} +{% include misc/data-files.html %} \ No newline at end of file diff --git a/_saas-integrations/intercom/intercom-latest.md b/_saas-integrations/intercom/v15-10-2015/intercom-latest.md similarity index 100% rename from _saas-integrations/intercom/intercom-latest.md rename to _saas-integrations/intercom/v15-10-2015/intercom-latest.md From 862f2d97cfa72afcca13e4d9ecafcacef7b6663c Mon Sep 17 00:00:00 2001 From: Jazmin Smith Date: Wed, 29 Jul 2020 01:31:30 -0400 Subject: [PATCH 02/11] missing tables + table removal --- .../intercom/v1/company_segments.md | 11 +- ...er_attributes.md => contact_attributes.md} | 27 +- .../intercom/v1/conversation_parts.md | 4 +- .../intercom/v1/conversations.md | 6 +- .../intercom/v1/foreign-keys.md | 8 +- _integration-schemas/intercom/v1/leads.md | 170 --------- _integration-schemas/intercom/v1/users.md | 173 --------- scripts/tap-generate-docs/admins.md | 50 +++ scripts/tap-generate-docs/company_segments.md | 31 ++ .../tap-generate-docs/conversation_parts.md | 71 ++++ scripts/tap-generate-docs/conversations.md | 340 ++++++++++++++++++ scripts/tap-generate-docs/segments.md | 31 ++ scripts/tap-generate-docs/teams.md | 25 ++ 13 files changed, 580 insertions(+), 367 deletions(-) rename _integration-schemas/intercom/v1/{customer_attributes.md => contact_attributes.md} (58%) delete mode 100644 _integration-schemas/intercom/v1/leads.md delete mode 100644 _integration-schemas/intercom/v1/users.md create mode 100644 scripts/tap-generate-docs/admins.md create mode 100644 scripts/tap-generate-docs/company_segments.md create mode 100644 scripts/tap-generate-docs/conversation_parts.md create mode 100644 scripts/tap-generate-docs/conversations.md create mode 100644 scripts/tap-generate-docs/segments.md create mode 100644 scripts/tap-generate-docs/teams.md diff --git a/_integration-schemas/intercom/v1/company_segments.md b/_integration-schemas/intercom/v1/company_segments.md index fec838b81..097d57769 100644 --- a/_integration-schemas/intercom/v1/company_segments.md +++ b/_integration-schemas/intercom/v1/company_segments.md @@ -1,17 +1,18 @@ --- tap: "intercom" version: "1" -name: "company_segments" -doc-link: "" +name: "company_segments" +doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#company-model" singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/company_segments.json" -description: "" +description: | + The `{{ table.name }}` table contains information about company segments in your {{ integration.display_name }} account. replication-method: "Key-based Incremental" api-method: - name: "" - doc-link: "" + name: "listAllSegments" + doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#list-segments" attributes: - name: "id" diff --git a/_integration-schemas/intercom/v1/customer_attributes.md b/_integration-schemas/intercom/v1/contact_attributes.md similarity index 58% rename from _integration-schemas/intercom/v1/customer_attributes.md rename to _integration-schemas/intercom/v1/contact_attributes.md index 7917ed8f8..2283cc7ae 100644 --- a/_integration-schemas/intercom/v1/customer_attributes.md +++ b/_integration-schemas/intercom/v1/contact_attributes.md @@ -2,27 +2,27 @@ tap: "intercom" version: "1" -name: "customer_attributes" -doc-link: "" -singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/customer_attributes.json" +name: "contact_attributes" +doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#data-attribute-model" +singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/contact_attributes.json" description: | - The `{{ table.name }}` table contains information about your customers in your {{ integration.display_name }} account. + The `{{ table.name }}` table contains information about contact attributes in your {{ integration.display_name }} account. replication-method: "Full Table" api-method: - name: "" - doc-link: "" + name: "listAllDataAttributes" + doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#list-data-attributes" attributes: - name: "name" type: "string" primary-key: true - description: "The name of the customer attribute." - foreign-key-id: "customer-attribute-name" + description: "The name of the attribute." + foreign-key-id: "contact-attribute-name" - name: "admin_id" - type: "integer" + type: "string" description: "" - name: "api_writable" type: "boolean" @@ -48,10 +48,17 @@ attributes: - name: "label" type: "string" description: "" + - name: "model" + type: "string" + description: "" - name: "options" - type: "null" + type: "array" description: "" + subattributes: + - name: "value" + type: "string" + description: "" - name: "type" type: "string" description: "" diff --git a/_integration-schemas/intercom/v1/conversation_parts.md b/_integration-schemas/intercom/v1/conversation_parts.md index 5614db876..5abf559e1 100644 --- a/_integration-schemas/intercom/v1/conversation_parts.md +++ b/_integration-schemas/intercom/v1/conversation_parts.md @@ -3,7 +3,7 @@ tap: "intercom" version: "1" name: "conversation_parts" -doc-link: "" +doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#conversation-model" singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/conversation_parts.json" description: | The `{{ table.name }}` table lists parts of a conversation from the `conversations`table in your {{ integration.display_name }} account. @@ -11,7 +11,7 @@ description: | replication-method: "Full Table" api-method: - name: "" + name: "retrieveAConversation" doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#retrieve-a-conversation" attributes: diff --git a/_integration-schemas/intercom/v1/conversations.md b/_integration-schemas/intercom/v1/conversations.md index 293a7f036..f69756637 100644 --- a/_integration-schemas/intercom/v1/conversations.md +++ b/_integration-schemas/intercom/v1/conversations.md @@ -3,7 +3,7 @@ tap: "intercom" version: "1" name: "conversations" -doc-link: "" +doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#conversation-model" singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/conversations.json" description: | The `{{ table.name }}` table contains info about user conversations in your {{ integration.display_name }} account. @@ -11,8 +11,8 @@ description: | replication-method: "Key-based Incremental" api-method: - name: "" - doc-link: "" + name: "listAllConversations" + doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#list-conversations" attributes: - name: "id" diff --git a/_integration-schemas/intercom/v1/foreign-keys.md b/_integration-schemas/intercom/v1/foreign-keys.md index 803748bee..3c066bc44 100644 --- a/_integration-schemas/intercom/v1/foreign-keys.md +++ b/_integration-schemas/intercom/v1/foreign-keys.md @@ -148,10 +148,10 @@ foreign-keys: subattribute: "user" join-on: "id" - - id: "customer-attribute-name" - table: "customer_attributes" + - id: "contact-attribute-name" + table: "contact_attributes" attribute: "name" all-foreign-keys: - - table: "customer_attributes" - join-on: "name" + - table: "contact_attributes" + join-on: "name" --- \ No newline at end of file diff --git a/_integration-schemas/intercom/v1/leads.md b/_integration-schemas/intercom/v1/leads.md deleted file mode 100644 index ae6e937bc..000000000 --- a/_integration-schemas/intercom/v1/leads.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -tap: "intercom" -version: "1" - -name: "leads" -doc-link: "" -singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/leads.json" -description: | - The `{{ table.name }}` table contains information about leads in your {{ integration.display_name }}. - -replication-method: "Key-based Incremental" - -api-method: - name: "" - doc-link: "" - -attributes: - - name: "id" - type: "string" - primary-key: true - description: "The lead ID." - foreign-key-id: "lead-id" - - - name: "updated_at" - type: "date-time" - description: "The time the the lead was last updated." - replication-key: true - - - name: "anonymous" - type: "boolean" - description: "" - - name: "app_id" - type: "string" - description: "" - - name: "avatar" - type: "object" - description: "" - subattributes: - - name: "image_url" - type: "string" - description: "" - - name: "type" - type: "string" - description: "" - - name: "companies" - type: "array" - description: "A list of companies" - subattributes: - - name: "id" - type: "string" - description: "The company ID." - - name: "created_at" - type: "date-time" - description: "" - - name: "custom_attributes" - type: "object" - description: "" - subattributes: - - name: "DELETEME" - type: "string" - description: "" - - name: "do_not_track" - type: "boolean" - description: "" - - name: "email" - type: "string" - description: "" - - name: "has_hard_bounced" - type: "boolean" - description: "" - - - name: "last_request_at" - type: "date-time" - description: "" - - name: "location_data" - type: "object" - description: "" - subattributes: - - name: "city_name" - type: "string" - description: "" - - name: "continent_code" - type: "string" - description: "" - - name: "country_code" - type: "string" - description: "" - - name: "country_name" - type: "string" - description: "" - - name: "postal_code" - type: "string" - description: "" - - name: "region_name" - type: "string" - description: "" - - name: "timezone" - type: "string" - description: "" - - name: "type" - type: "string" - description: "" - - name: "marked_email_as_spam" - type: "boolean" - description: "" - - name: "name" - type: "string" - description: "" - - name: "phone" - type: "string" - description: "" - - name: "pseudonym" - type: "string" - description: "" - - name: "referrer" - type: "string" - description: "" - - name: "remote_created_at" - type: "date-time" - description: "" - - name: "segments" - type: "array" - description: "A list of segments." - subattributes: - - name: "id" - type: "string" - description: "The segment ID." - foreign-key-id: "segment-id" - - name: "session_count" - type: "integer" - description: "" - - name: "signed_up_at" - type: "date-time" - description: "" - - name: "social_profiles" - type: "null" - description: "" - - name: "tags" - type: "array" - description: "A list of tags." - subattributes: - - name: "id" - type: "string" - description: "The tag ID." - - name: "type" - type: "string" - description: "" - - name: "unsubscribed_from_emails" - type: "boolean" - description: "" - - - name: "user_id" - type: "string" - description: "" - - name: "utm_campaign" - type: "string" - description: "" - - name: "utm_content" - type: "string" - description: "" - - name: "utm_medium" - type: "string" - description: "" - - name: "utm_source" - type: "string" - description: "" - - name: "utm_term" - type: "string" - description: "" ---- diff --git a/_integration-schemas/intercom/v1/users.md b/_integration-schemas/intercom/v1/users.md deleted file mode 100644 index 61540855a..000000000 --- a/_integration-schemas/intercom/v1/users.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -tap: "intercom" -version: "1" - -name: "users" -doc-link: "" -singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/users.json" -description: "" - -replication-method: "Key-based Incremental" - -api-method: - name: "" - doc-link: "" - -attributes: - - name: "id" - type: "string" - primary-key: true - description: "The user ID." - foreign-key-id: "user-id" - - - name: "updated_at" - type: "date-time" - description: "The time the user was last updated." - replication-key: true - - - name: "anonymous" - type: "boolean" - description: "" - - name: "app_id" - type: "string" - description: "" - - name: "avatar" - type: "object" - description: "" - subattributes: - - name: "image_url" - type: "string" - description: "" - - name: "type" - type: "string" - description: "" - - name: "companies" - type: "array" - description: "A list of companies." - subattributes: - - name: "id" - type: "string" - description: "The company ID." - foreign-key-id: "company-id" - - - name: "created_at" - type: "date-time" - description: "" - - name: "custom_attributes" - type: "object" - description: "" - subattributes: - - name: "DELETEME" - type: "string" - description: "" - - name: "do_not_track" - type: "boolean" - description: "" - - name: "email" - type: "string" - description: "" - - name: "has_hard_bounced" - type: "boolean" - description: "" - - - name: "last_request_at" - type: "date-time" - description: "" - - name: "location_data" - type: "object" - description: "" - subattributes: - - name: "city_name" - type: "string" - description: "" - - name: "continent_code" - type: "string" - description: "" - - name: "country_code" - type: "string" - description: "" - - name: "country_name" - type: "string" - description: "" - - name: "postal_code" - type: "string" - description: "" - - name: "region_name" - type: "string" - description: "" - - name: "timezone" - type: "string" - description: "" - - name: "type" - type: "string" - description: "" - - name: "marked_email_as_spam" - type: "boolean" - description: "" - - name: "name" - type: "string" - description: "" - - name: "phone" - type: "string" - description: "" - - name: "pseudonym" - type: "string" - description: "" - - name: "referrer" - type: "string" - description: "" - - name: "remote_created_at" - type: "date-time" - description: "" - - name: "segments" - type: "array" - description: "A list of segments." - subattributes: - - name: "id" - type: "string" - description: "The segment ID." - foreign-key-id: "segment-id" - - - name: "session_count" - type: "integer" - description: "" - - name: "signed_up_at" - type: "date-time" - description: "" - - name: "social_profiles" - type: "null" - description: "" - - name: "tags" - type: "array" - description: "A list of tags." - subattributes: - - name: "id" - type: "string" - description: "The tag ID." - foreign-key-id: "tag-id" - - name: "type" - type: "string" - description: "" - - name: "unsubscribed_from_emails" - type: "boolean" - description: "" - - - name: "user_id" - type: "string" - description: "" - - name: "utm_campaign" - type: "string" - description: "" - - name: "utm_content" - type: "string" - description: "" - - name: "utm_medium" - type: "string" - description: "" - - name: "utm_source" - type: "string" - description: "" - - name: "utm_term" - type: "string" - description: "" ---- diff --git a/scripts/tap-generate-docs/admins.md b/scripts/tap-generate-docs/admins.md new file mode 100644 index 000000000..8a07b5c60 --- /dev/null +++ b/scripts/tap-generate-docs/admins.md @@ -0,0 +1,50 @@ +--- +tap: "intercom" +version: "0.x" +name: "admins" +doc-link: "" +singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/admins.json" +description: "" +replication-method: "" +api-method: + name: "" + doc-link: "" +attributes: + - name: "admin_ids" + type: "null" + description: "" + - name: "avatar" + type: "object" + description: "" + subattributes: + - name: "image_url" + type: "string" + description: "" + - name: "away_mode_enabled" + type: "boolean" + description: "" + - name: "away_mode_reassign" + type: "boolean" + description: "" + - name: "email" + type: "string" + description: "" + - name: "has_inbox_seat" + type: "boolean" + description: "" + - name: "id" + type: "string" + description: "" + - name: "job_title" + type: "string" + description: "" + - name: "name" + type: "string" + description: "" + - name: "team_ids" + type: "null" + description: "" + - name: "type" + type: "string" + description: "" +--- diff --git a/scripts/tap-generate-docs/company_segments.md b/scripts/tap-generate-docs/company_segments.md new file mode 100644 index 000000000..4c05c16e9 --- /dev/null +++ b/scripts/tap-generate-docs/company_segments.md @@ -0,0 +1,31 @@ +--- +tap: "intercom" +version: "0.x" +name: "company_segments" +doc-link: "" +singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/company_segments.json" +description: "" +replication-method: "" +api-method: + name: "" + doc-link: "" +attributes: + - name: "count" + type: "integer" + description: "" + - name: "created_at" + type: "date-time" + description: "" + - name: "id" + type: "string" + description: "" + - name: "name" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "updated_at" + type: "date-time" + description: "" +--- diff --git a/scripts/tap-generate-docs/conversation_parts.md b/scripts/tap-generate-docs/conversation_parts.md new file mode 100644 index 000000000..b3ed337d6 --- /dev/null +++ b/scripts/tap-generate-docs/conversation_parts.md @@ -0,0 +1,71 @@ +--- +tap: "intercom" +version: "0.x" +name: "conversation_parts" +doc-link: "" +singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/conversation_parts.json" +description: "" +replication-method: "" +api-method: + name: "" + doc-link: "" +attributes: + - name: "assigned_to" + type: "string" + description: "" + - name: "attachments" + type: "null" + description: "" + - name: "author" + type: "object" + description: "" + subattributes: + - name: "email" + type: "string" + description: "" + - name: "id" + type: "string" + description: "" + - name: "name" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "body" + type: "string" + description: "" + - name: "conversation_created_at" + type: "date-time" + description: "" + - name: "conversation_id" + type: "string" + description: "" + - name: "conversation_total_parts" + type: "integer" + description: "" + - name: "conversation_updated_at" + type: "date-time" + description: "" + - name: "created_at" + type: "date-time" + description: "" + - name: "external_id" + type: "string" + description: "" + - name: "id" + type: "string" + description: "" + - name: "notified_at" + type: "date-time" + description: "" + - name: "part_type" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "updated_at" + type: "date-time" + description: "" +--- diff --git a/scripts/tap-generate-docs/conversations.md b/scripts/tap-generate-docs/conversations.md new file mode 100644 index 000000000..b74c22b99 --- /dev/null +++ b/scripts/tap-generate-docs/conversations.md @@ -0,0 +1,340 @@ +--- +tap: "intercom" +version: "0.x" +name: "conversations" +doc-link: "" +singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/conversations.json" +description: "" +replication-method: "" +api-method: + name: "" + doc-link: "" +attributes: + - name: "assignee" + type: "object" + description: "" + subattributes: + - name: "email" + type: "string" + description: "" + - name: "id" + type: "string" + description: "" + - name: "name" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "contacts" + type: "array" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "conversation_message" + type: "object" + description: "" + subattributes: + - name: "attachments" + type: "null" + description: "" + - name: "author" + type: "object" + description: "" + subattributes: + - name: "email" + type: "string" + description: "" + - name: "id" + type: "string" + description: "" + - name: "name" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "body" + type: "string" + description: "" + - name: "delivered_as" + type: "string" + description: "" + - name: "id" + type: "string" + description: "" + - name: "subject" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "url" + type: "string" + description: "" + - name: "conversation_rating" + type: "object" + description: "" + subattributes: + - name: "created_at" + type: "date-time" + description: "" + - name: "customer" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "rating" + type: "integer" + description: "" + - name: "remark" + type: "string" + description: "" + - name: "teammate" + type: "object" + description: "" + subattributes: + - name: "id" + type: "integer" + description: "" + - name: "type" + type: "string" + description: "" + - name: "created_at" + type: "date-time" + description: "" + - name: "customer_first_reply" + type: "object" + description: "" + subattributes: + - name: "created_at" + type: "date-time" + description: "" + - name: "type" + type: "string" + description: "" + - name: "url" + type: "string" + description: "" + - name: "customers" + type: "null" + description: "" + - name: "first_contact_reply" + type: "object" + description: "" + subattributes: + - name: "created_at" + type: "date-time" + description: "" + - name: "type" + type: "string" + description: "" + - name: "url" + type: "string" + description: "" + - name: "id" + type: "string" + description: "" + - name: "open" + type: "boolean" + description: "" + - name: "priority" + type: "string" + description: "" + - name: "read" + type: "boolean" + description: "" + - name: "sent_at" + type: "date-time" + description: "" + - name: "sla_applied" + type: "object" + description: "" + subattributes: + - name: "sla_name" + type: "string" + description: "" + - name: "sla_status" + type: "string" + description: "" + - name: "snoozed_until" + type: "date-time" + description: "" + - name: "source" + type: "object" + description: "" + subattributes: + - name: "attachments" + type: "array" + description: "" + - name: "author" + type: "object" + description: "" + subattributes: + - name: "email" + type: "string" + description: "" + - name: "id" + type: "string" + description: "" + - name: "name" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "body" + type: "string" + description: "" + - name: "delivered_as" + type: "string" + description: "" + - name: "id" + type: "string" + description: "" + - name: "subject" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "url" + type: "string" + description: "" + - name: "state" + type: "string" + description: "" + - name: "statistics" + type: "object" + description: "" + subattributes: + - name: "count_assignments" + type: "integer" + description: "" + - name: "count_conversation_parts" + type: "integer" + description: "" + - name: "count_reopens" + type: "integer" + description: "" + - name: "first_admin_reply_at" + type: "date-time" + description: "" + - name: "first_assignment_at" + type: "date-time" + description: "" + - name: "first_close_at" + type: "date-time" + description: "" + - name: "first_contact_reply_at" + type: "date-time" + description: "" + - name: "last_admin_reply_at" + type: "date-time" + description: "" + - name: "last_assignment_admin_reply_at" + type: "date-time" + description: "" + - name: "last_assignment_at" + type: "date-time" + description: "" + - name: "last_close_at" + type: "date-time" + description: "" + - name: "last_closed_by_id" + type: "integer" + description: "" + - name: "last_contact_reply_at" + type: "date-time" + description: "" + - name: "median_time_to_reply" + type: "integer" + description: "" + - name: "time_to_admin_reply" + type: "integer" + description: "" + - name: "time_to_assignment" + type: "integer" + description: "" + - name: "time_to_first_close" + type: "integer" + description: "" + - name: "time_to_last_close" + type: "integer" + description: "" + - name: "type" + type: "string" + description: "" + - name: "tags" + type: "array" + description: "" + subattributes: + - name: "applied_at" + type: "date-time" + description: "" + - name: "applied_by" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "id" + type: "string" + description: "" + - name: "name" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "teammates" + type: "object" + description: "" + subattributes: + - name: "admins" + type: "array" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "updated_at" + type: "date-time" + description: "" + - name: "user" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "waiting_since" + type: "date-time" + description: "" +--- diff --git a/scripts/tap-generate-docs/segments.md b/scripts/tap-generate-docs/segments.md new file mode 100644 index 000000000..9526fbd83 --- /dev/null +++ b/scripts/tap-generate-docs/segments.md @@ -0,0 +1,31 @@ +--- +tap: "intercom" +version: "0.x" +name: "segments" +doc-link: "" +singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/segments.json" +description: "" +replication-method: "" +api-method: + name: "" + doc-link: "" +attributes: + - name: "count" + type: "integer" + description: "" + - name: "created_at" + type: "date-time" + description: "" + - name: "id" + type: "string" + description: "" + - name: "name" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "updated_at" + type: "date-time" + description: "" +--- diff --git a/scripts/tap-generate-docs/teams.md b/scripts/tap-generate-docs/teams.md new file mode 100644 index 000000000..72d743e3a --- /dev/null +++ b/scripts/tap-generate-docs/teams.md @@ -0,0 +1,25 @@ +--- +tap: "intercom" +version: "0.x" +name: "teams" +doc-link: "" +singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/teams.json" +description: "" +replication-method: "" +api-method: + name: "" + doc-link: "" +attributes: + - name: "admin_ids" + type: "null" + description: "" + - name: "id" + type: "string" + description: "" + - name: "name" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" +--- From 377dad87b85a38e46b5f8083a98e84d0a66381ff Mon Sep 17 00:00:00 2001 From: Erin Cochran Date: Mon, 3 Aug 2020 15:56:57 -0400 Subject: [PATCH 03/11] Remove testing page --- _account-security/testing.md | 12 ------------ 1 file changed, 12 deletions(-) delete mode 100644 _account-security/testing.md diff --git a/_account-security/testing.md b/_account-security/testing.md deleted file mode 100644 index a10e826ea..000000000 --- a/_account-security/testing.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: testing -permalink: /testing/ ---- - -{% assign intercom-tables = site.integration-schemas | where:"tap","intercom" %} - -{% assign this-versions-tables = intercom-tables | where:"version","15-10-2015" %} - -{% for table in this-versions-tables %} -- {{ table.name }} : {{ table.version }} -{% endfor %} \ No newline at end of file From 264fd258bb1dfbef31705cbf832e417eaee99011 Mon Sep 17 00:00:00 2001 From: Jazmin Smith Date: Thu, 13 Aug 2020 05:39:04 -0400 Subject: [PATCH 04/11] remaining changes Changed the "{{ integration.display_name }}" in the image include (the screenshot in the setup steps) to "Intercom" because of the build error it was creating. --- .../sources/saas/intercom-object.md | 22 +- _integration-schemas/intercom/v1/admins.md | 6 +- _integration-schemas/intercom/v1/companies.md | 7 +- .../intercom/v1/company_attributes.md | 7 +- .../intercom/v1/conversation_parts.md | 8 +- .../intercom/v1/conversations.md | 14 +- .../intercom/v1/foreign-keys.md | 19 +- _integration-schemas/intercom/v1/segments.md | 6 +- _integration-schemas/intercom/v1/tags.md | 6 +- _integration-schemas/intercom/v1/teams.md | 10 +- .../intercom/v15-10-2015/admins.md | 2 +- .../intercom/v15-10-2015/companies.md | 2 +- .../intercom/v15-10-2015/company_segments.md | 2 +- .../intercom/v15-10-2015/contacts.md | 2 +- .../intercom/v15-10-2015/conversations.md | 2 +- .../intercom/v15-10-2015/segments.md | 2 +- .../intercom/v15-10-2015/tags.md | 2 +- .../intercom/v15-10-2015/users.md | 2 +- .../ intercom-v02-02-2016.md} | 2 +- _saas-integrations/intercom/v1/intercom-v1.md | 55 +-- scripts/tap-generate-docs/admins.md | 50 --- scripts/tap-generate-docs/company_segments.md | 31 -- .../tap-generate-docs/conversation_parts.md | 71 ---- scripts/tap-generate-docs/conversations.md | 340 ------------------ scripts/tap-generate-docs/segments.md | 31 -- 25 files changed, 75 insertions(+), 626 deletions(-) rename _saas-integrations/intercom/{v15-10-2015/intercom-latest.md => v02-02-2016/ intercom-v02-02-2016.md} (98%) delete mode 100644 scripts/tap-generate-docs/admins.md delete mode 100644 scripts/tap-generate-docs/company_segments.md delete mode 100644 scripts/tap-generate-docs/conversation_parts.md delete mode 100644 scripts/tap-generate-docs/conversations.md delete mode 100644 scripts/tap-generate-docs/segments.md diff --git a/_developer-files/connect/api/objects/form-properties/sources/saas/intercom-object.md b/_developer-files/connect/api/objects/form-properties/sources/saas/intercom-object.md index 2b879dd80..fc216e7f5 100644 --- a/_developer-files/connect/api/objects/form-properties/sources/saas/intercom-object.md +++ b/_developer-files/connect/api/objects/form-properties/sources/saas/intercom-object.md @@ -28,11 +28,6 @@ display-name: "Intercom" source-type: "saas" docs-name: "intercom" -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 # # -------------------------- # @@ -44,10 +39,21 @@ uses-start-date: true # and therefore don't need to be listed: # anchor_time, cron_expression, frequency_in_minutes, image_version, start_date -object-attributes: + +# -------------------------- # +# OAUTH PROPERTIES # +# -------------------------- # + +oauth-link: "https://developers.intercom.com/building-apps/docs/setting-up-oauth" + +oauth-description: "" + +oauth-attributes: - name: "access_token" type: "string" required: true - description: "The token used to access your workspace's data via API." - value: "YOU_API_ACCESS_TOKEN" + credential: true + description: | + The token used to access your {{ form-property.display-name }} workspace's data via API. + value: "" --- \ No newline at end of file diff --git a/_integration-schemas/intercom/v1/admins.md b/_integration-schemas/intercom/v1/admins.md index 2c7bbe34d..5859cfd34 100644 --- a/_integration-schemas/intercom/v1/admins.md +++ b/_integration-schemas/intercom/v1/admins.md @@ -46,7 +46,11 @@ attributes: - name: "team_ids" type: "array" description: "A list of the of team IDs that the admin is part of." - foreign-key-id: "team-id" + subattributes: + - name: "value" + type: "integer" + description: "[DESCRIPTION]" + foreign-key-id: "team-id" - name: "type" type: "string" description: "" diff --git a/_integration-schemas/intercom/v1/companies.md b/_integration-schemas/intercom/v1/companies.md index b5c124702..f1f23c9aa 100644 --- a/_integration-schemas/intercom/v1/companies.md +++ b/_integration-schemas/intercom/v1/companies.md @@ -10,7 +10,7 @@ description: | #### Custom Attributes - If applicable, Stitch will replicate custom fields related to `{{ table.name }}` in Intercom. + If applicable, Stitch will replicate custom fields related to `{{ table.name }}` in {{ integration.display_name }}. replication-method: "Key-based Incremental" @@ -39,11 +39,6 @@ attributes: - name: "custom_attributes" type: "object" description: "" - subattributes: - - name: "DELETEME" - type: "string" - description: "" - - name: "industry" type: "string" description: "" diff --git a/_integration-schemas/intercom/v1/company_attributes.md b/_integration-schemas/intercom/v1/company_attributes.md index 52525f412..3b4ab2a21 100644 --- a/_integration-schemas/intercom/v1/company_attributes.md +++ b/_integration-schemas/intercom/v1/company_attributes.md @@ -48,10 +48,13 @@ attributes: - name: "label" type: "string" description: "" - - name: "options" - type: "null" + type: "array" description: "" + subattributes: + - name: "value" + type: "[TYPE]" + description: "[DESCRIPTION]" - name: "type" type: "string" description: "" diff --git a/_integration-schemas/intercom/v1/conversation_parts.md b/_integration-schemas/intercom/v1/conversation_parts.md index 5abf559e1..c283bb2bf 100644 --- a/_integration-schemas/intercom/v1/conversation_parts.md +++ b/_integration-schemas/intercom/v1/conversation_parts.md @@ -6,7 +6,7 @@ name: "conversation_parts" doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#conversation-model" singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/conversation_parts.json" description: | - The `{{ table.name }}` table lists parts of a conversation from the `conversations`table in your {{ integration.display_name }} account. + The `{{ table.name }}` table lists parts of a conversation from the `conversations`table in your {{ integration.display_name }} account. The only conversation parts that will replicate in full will be the ones whose parent conversation in the `conversations` table have updated. replication-method: "Full Table" @@ -23,7 +23,8 @@ attributes: - name: "assigned_to" type: "string" - description: "" + description: "The admin ID that the conversation part is assigned to." + foreign-key-id: "admin-id" - name: "attachments" type: "null" description: "" @@ -33,8 +34,7 @@ attributes: subattributes: - name: "id" type: "string" - description: "The author ID." - foreign-key-id: "author-id" + description: "The author ID. This could either be the user ID or admin ID." - name: "type" type: "string" description: "" diff --git a/_integration-schemas/intercom/v1/conversations.md b/_integration-schemas/intercom/v1/conversations.md index f69756637..4541fb611 100644 --- a/_integration-schemas/intercom/v1/conversations.md +++ b/_integration-schemas/intercom/v1/conversations.md @@ -32,8 +32,7 @@ attributes: subattributes: - name: "id" type: "integer" - description: "The assignee ID." - foreign-key-id: "asignee-id" + description: "The assignee ID. This could either be a team ID or admin ID depending on the type assigned to this subattribute." - name: "type" type: "string" @@ -43,8 +42,12 @@ attributes: description: "A list of message details." subattributes: - name: "attachments" - type: "null" - description: "" + type: "array" + description: "A list of attachment details" + subattributes: + - name: "value" + type: "[TYPE]" + description: "[DESCRIPTION]" - name: "author" type: "object" description: "A list of authors." @@ -103,7 +106,8 @@ attributes: subattributes: - name: "id" type: "integer" - description: "" + description: "The admin ID of the teammate." + foreign-key-id: "admin-id" - name: "type" type: "string" description: "" diff --git a/_integration-schemas/intercom/v1/foreign-keys.md b/_integration-schemas/intercom/v1/foreign-keys.md index 3c066bc44..a2a2127e4 100644 --- a/_integration-schemas/intercom/v1/foreign-keys.md +++ b/_integration-schemas/intercom/v1/foreign-keys.md @@ -18,6 +18,14 @@ foreign-keys: all-foreign-keys: - table: "admins" join-on: "id" + - table: "teams" + subattribute: "admin_ids" + join-on: "id" + - table: "conversation_parts" + join-on: "admin-id" + - table: "conversations" + subattribute: "conversation_rating.teammate" + join-on: "id" - table: "teams" subattribute: "admin_ids" join-on: "id" @@ -113,21 +121,10 @@ foreign-keys: table: "authors" attribute: "id" all-foreign-keys: - - table: "conversation_parts" - subattribute: "author" - join-on: "id" - table: "conversations" subattribute: "conversation_message.author" join-on: "id" - - id: "assignee-id" - table: "assignees" - attribute: "id" - all-foreign-keys: - - table: "conversations" - subattribute: "assignee" - join-on: "id" - - id: "customer-id" table: "customers" attribute: "id" diff --git a/_integration-schemas/intercom/v1/segments.md b/_integration-schemas/intercom/v1/segments.md index aef8e3c25..0b6bc0dc1 100644 --- a/_integration-schemas/intercom/v1/segments.md +++ b/_integration-schemas/intercom/v1/segments.md @@ -3,7 +3,7 @@ tap: "intercom" version: "1" name: "segments" -doc-link: "" +doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#segment-model" singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/segments.json" description: The `{{ table.name }}` table contains information about segments within your {{ integration.display_name }} account. @@ -11,8 +11,8 @@ description: replication-method: "Key-based Incremental" api-method: - name: "" - doc-link: "" + name: "List all segments" + doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#list-segments" attributes: - name: "id" diff --git a/_integration-schemas/intercom/v1/tags.md b/_integration-schemas/intercom/v1/tags.md index d2177371d..4f943f5f2 100644 --- a/_integration-schemas/intercom/v1/tags.md +++ b/_integration-schemas/intercom/v1/tags.md @@ -3,7 +3,7 @@ tap: "intercom" version: "1" name: "tags" -doc-link: "" +doc-link: "https://developers.intercom.com/intercom-api-reference/reference#tag-model" singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/tags.json" description: | The `{{ table.name }}` table contains information about tags within your {{ integration.display_name }} account. @@ -11,8 +11,8 @@ description: | replication-method: "Full Table" api-method: - name: "" - doc-link: "" + name: "List all tags" + doc-link: "https://developers.intercom.com/intercom-api-reference/reference#list-tags-for-an-app" attributes: - name: "id" diff --git a/_integration-schemas/intercom/v1/teams.md b/_integration-schemas/intercom/v1/teams.md index c5eb21d9d..37562e23d 100644 --- a/_integration-schemas/intercom/v1/teams.md +++ b/_integration-schemas/intercom/v1/teams.md @@ -3,15 +3,16 @@ tap: "intercom" version: "1" name: "teams" -doc-link: "" +doc-link: "https://developers.intercom.com/intercom-api-reference/reference#teams-model" singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/teams.json" -description: "" +description: | + The `{{ table.name }}` table contains information about teams in your {{ integration.display_name }} account. replication-method: "Full Table" api-method: - name: "" - doc-link: "" + name: "List all teams" + doc-link: "https://developers.intercom.com/intercom-api-reference/reference#list-teams" attributes: - name: "id" @@ -27,6 +28,7 @@ attributes: - name: "id" type: "string" description: "The admin ID." + foreign-key-id: "admin-id" - name: "name" type: "string" diff --git a/_integration-schemas/intercom/v15-10-2015/admins.md b/_integration-schemas/intercom/v15-10-2015/admins.md index 912f0405f..731eb401b 100755 --- a/_integration-schemas/intercom/v15-10-2015/admins.md +++ b/_integration-schemas/intercom/v15-10-2015/admins.md @@ -1,6 +1,6 @@ --- tap: "intercom" -#version: "15-10-2015" +version: "15-10-2015" name: "admins" doc-link: https://developers.intercom.io/docs/admins diff --git a/_integration-schemas/intercom/v15-10-2015/companies.md b/_integration-schemas/intercom/v15-10-2015/companies.md index cc8dc3930..163975606 100755 --- a/_integration-schemas/intercom/v15-10-2015/companies.md +++ b/_integration-schemas/intercom/v15-10-2015/companies.md @@ -1,6 +1,6 @@ --- tap: "intercom" -# version: "15-10-2015" +version: "15-10-2015" name: "companies" doc-link: https://developers.intercom.com/reference#companies diff --git a/_integration-schemas/intercom/v15-10-2015/company_segments.md b/_integration-schemas/intercom/v15-10-2015/company_segments.md index ede413111..2aef5ec02 100755 --- a/_integration-schemas/intercom/v15-10-2015/company_segments.md +++ b/_integration-schemas/intercom/v15-10-2015/company_segments.md @@ -1,6 +1,6 @@ --- tap: "intercom" -# version: "15-10-2015" +version: "15-10-2015" name: "company_segments" doc-link: https://developers.intercom.io/docs/companies diff --git a/_integration-schemas/intercom/v15-10-2015/contacts.md b/_integration-schemas/intercom/v15-10-2015/contacts.md index 05048c8f0..bd153e9bc 100755 --- a/_integration-schemas/intercom/v15-10-2015/contacts.md +++ b/_integration-schemas/intercom/v15-10-2015/contacts.md @@ -1,6 +1,6 @@ --- tap: "intercom" -# version: "15-10-2015" +version: "15-10-2015" name: "contacts" doc-link: https://developers.intercom.com/reference#leads diff --git a/_integration-schemas/intercom/v15-10-2015/conversations.md b/_integration-schemas/intercom/v15-10-2015/conversations.md index 9708e0737..91376e613 100755 --- a/_integration-schemas/intercom/v15-10-2015/conversations.md +++ b/_integration-schemas/intercom/v15-10-2015/conversations.md @@ -1,6 +1,6 @@ --- tap: "intercom" -# version: "15-10-2015" +version: "15-10-2015" name: "conversations" doc-link: https://developers.intercom.com/reference#conversations diff --git a/_integration-schemas/intercom/v15-10-2015/segments.md b/_integration-schemas/intercom/v15-10-2015/segments.md index df1242d28..d632e3506 100755 --- a/_integration-schemas/intercom/v15-10-2015/segments.md +++ b/_integration-schemas/intercom/v15-10-2015/segments.md @@ -1,6 +1,6 @@ --- tap: "intercom" -# version: "15-10-2015" +version: "15-10-2015" name: "segments" doc-link: https://developers.intercom.com/reference#segments diff --git a/_integration-schemas/intercom/v15-10-2015/tags.md b/_integration-schemas/intercom/v15-10-2015/tags.md index a47a0474f..49c5c5e44 100755 --- a/_integration-schemas/intercom/v15-10-2015/tags.md +++ b/_integration-schemas/intercom/v15-10-2015/tags.md @@ -1,6 +1,6 @@ --- tap: "intercom" -# version: "15-10-2015" +version: "15-10-2015" name: "tags" doc-link: https://developers.intercom.io/docs/tags diff --git a/_integration-schemas/intercom/v15-10-2015/users.md b/_integration-schemas/intercom/v15-10-2015/users.md index 10ff0c014..2daf3bd85 100755 --- a/_integration-schemas/intercom/v15-10-2015/users.md +++ b/_integration-schemas/intercom/v15-10-2015/users.md @@ -1,6 +1,6 @@ --- tap: "intercom" -# version: "15-10-2015" +version: "15-10-2015" name: "users" doc-link: https://developers.intercom.io/docs/users diff --git a/_saas-integrations/intercom/v15-10-2015/intercom-latest.md b/_saas-integrations/intercom/v02-02-2016/ intercom-v02-02-2016.md similarity index 98% rename from _saas-integrations/intercom/v15-10-2015/intercom-latest.md rename to _saas-integrations/intercom/v02-02-2016/ intercom-v02-02-2016.md index cd1091fbd..9785b0f27 100644 --- a/_saas-integrations/intercom/v15-10-2015/intercom-latest.md +++ b/_saas-integrations/intercom/v02-02-2016/ intercom-v02-02-2016.md @@ -1,6 +1,6 @@ --- title: Intercom -permalink: /integrations/saas/intercom +permalink: /integrations/saas/intercom/v02-02-2016 keywords: intercom, integration, schema, etl intercom, intercom etl, intercom schema summary: "Connection instructions, replication info, and schema details for Stitch's Intercom integration." layout: singer diff --git a/_saas-integrations/intercom/v1/intercom-v1.md b/_saas-integrations/intercom/v1/intercom-v1.md index 9afaabc2e..09575e136 100644 --- a/_saas-integrations/intercom/v1/intercom-v1.md +++ b/_saas-integrations/intercom/v1/intercom-v1.md @@ -13,7 +13,7 @@ # -------------------------- # title: Intercom -permalink: /integrations/saas/intercom +permalink: /integrations/saas/intercom/ keywords: intercom, integration, schema, etl intercom, intercom etl, intercom schema layout: singer # input: false @@ -32,13 +32,12 @@ repo-url: https://github.com/singer-io/tap-intercom api: | [{{ integration.display_name }} API (V2.0)](https://developers.intercom.com/intercom-api-reference/v2.0/reference){:target="new"} -# this-version: "1.0" +this-version: "1" # -------------------------- # # Stitch Details # # -------------------------- # -status: "Released" certified: true historical: "1 year" @@ -47,69 +46,31 @@ tier: "Standard" status-url: "https://status.intercom.io/" anchor-scheduling: true -cron-scheduling: false +cron-scheduling: true extraction-logs: true loading-reports: true -table-selection: false -column-selection: false +table-selection: true +column-selection: true -## Row usage details - -row-usage-hog: true -row-usage-hog-reasons: - data-structure: true - data-volume: true - lots-of-full-table: false - -# -------------------------- # -# Querying Details # -# -------------------------- # - -## Intercom's default attribution window. Stitch queries for -## this number of days during each replication job to -## account for any updates to existing records made during -## this time. - -replication-notes: true -attribution-window: "30 days" -# attribution-is-configurable: - -# setup-name: "" - -# -------------------------- # -# Incompatibilities # -# -------------------------- # - -## uncomment section below if integration is compatible with any Stitch destinations -## if incompatible with multiple destinations, create a section for each destination - -## incompatible: - ## [redshift]: "always,sometimes,never" - ## reason: "copy" # -------------------------- # # Setup Instructions # # -------------------------- # -requirements-list: - - item: "**Your {{ integration.display_name }} App ID.** You can find your {{ integration.display_name }} App ID by following [these instructions](https://docs.intercom.com/faqs-and-troubleshooting/getting-set-up/where-can-i-find-my-app-id)." - setup-steps: - title: "add integration" - content: | - 4. In the **{{ integration.display_name }} App ID** field, enter your [{{ integration.display_name }} App ID](https://docs.intercom.com/faqs-and-troubleshooting/getting-set-up/where-can-i-find-my-app-id). - title: "historical sync" - title: "replication frequency" - title: "track data" - title: "Authorize Stitch to Access {{ integration.display_name }}" anchor: "authorize-stitch" content: | - Lastly, you'll be directed to Intercom's website to complete the setup. + Lastly, you'll be directed to {{ integration.display_name }}'s website to complete the setup. - {% include layout/inline_image.html type="right" file="integrations/intercom-access-request.png" alt="List of permissions requested by Stitch to access Intercom" max-width="400px" %}1. If you aren't already logged into Intercom, you'll be prompted to do so. - 2. Next, a screen requesting access to Intercom will display. **Note**: Stitch will only ever read your data. + {% include layout/inline_image.html type="right" file="integrations/intercom-access-request.png" alt="List of permissions requested by Stitch to access Intercom" max-width="400px" %}1. If you aren't already logged into {{ integration.display_name }}, you'll be prompted to do so. + 2. Next, a screen requesting access to {{ integration.display_name }} will display. **Note**: Stitch will only ever read your data. 3. Click **Connect.** 4. After the authorization process successfully completes, you'll be redirected back to Stitch. 5. Click {{ app.buttons.finish-int-setup }}. diff --git a/scripts/tap-generate-docs/admins.md b/scripts/tap-generate-docs/admins.md deleted file mode 100644 index 8a07b5c60..000000000 --- a/scripts/tap-generate-docs/admins.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -tap: "intercom" -version: "0.x" -name: "admins" -doc-link: "" -singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/admins.json" -description: "" -replication-method: "" -api-method: - name: "" - doc-link: "" -attributes: - - name: "admin_ids" - type: "null" - description: "" - - name: "avatar" - type: "object" - description: "" - subattributes: - - name: "image_url" - type: "string" - description: "" - - name: "away_mode_enabled" - type: "boolean" - description: "" - - name: "away_mode_reassign" - type: "boolean" - description: "" - - name: "email" - type: "string" - description: "" - - name: "has_inbox_seat" - type: "boolean" - description: "" - - name: "id" - type: "string" - description: "" - - name: "job_title" - type: "string" - description: "" - - name: "name" - type: "string" - description: "" - - name: "team_ids" - type: "null" - description: "" - - name: "type" - type: "string" - description: "" ---- diff --git a/scripts/tap-generate-docs/company_segments.md b/scripts/tap-generate-docs/company_segments.md deleted file mode 100644 index 4c05c16e9..000000000 --- a/scripts/tap-generate-docs/company_segments.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -tap: "intercom" -version: "0.x" -name: "company_segments" -doc-link: "" -singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/company_segments.json" -description: "" -replication-method: "" -api-method: - name: "" - doc-link: "" -attributes: - - name: "count" - type: "integer" - description: "" - - name: "created_at" - type: "date-time" - description: "" - - name: "id" - type: "string" - description: "" - - name: "name" - type: "string" - description: "" - - name: "type" - type: "string" - description: "" - - name: "updated_at" - type: "date-time" - description: "" ---- diff --git a/scripts/tap-generate-docs/conversation_parts.md b/scripts/tap-generate-docs/conversation_parts.md deleted file mode 100644 index b3ed337d6..000000000 --- a/scripts/tap-generate-docs/conversation_parts.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -tap: "intercom" -version: "0.x" -name: "conversation_parts" -doc-link: "" -singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/conversation_parts.json" -description: "" -replication-method: "" -api-method: - name: "" - doc-link: "" -attributes: - - name: "assigned_to" - type: "string" - description: "" - - name: "attachments" - type: "null" - description: "" - - name: "author" - type: "object" - description: "" - subattributes: - - name: "email" - type: "string" - description: "" - - name: "id" - type: "string" - description: "" - - name: "name" - type: "string" - description: "" - - name: "type" - type: "string" - description: "" - - name: "body" - type: "string" - description: "" - - name: "conversation_created_at" - type: "date-time" - description: "" - - name: "conversation_id" - type: "string" - description: "" - - name: "conversation_total_parts" - type: "integer" - description: "" - - name: "conversation_updated_at" - type: "date-time" - description: "" - - name: "created_at" - type: "date-time" - description: "" - - name: "external_id" - type: "string" - description: "" - - name: "id" - type: "string" - description: "" - - name: "notified_at" - type: "date-time" - description: "" - - name: "part_type" - type: "string" - description: "" - - name: "type" - type: "string" - description: "" - - name: "updated_at" - type: "date-time" - description: "" ---- diff --git a/scripts/tap-generate-docs/conversations.md b/scripts/tap-generate-docs/conversations.md deleted file mode 100644 index b74c22b99..000000000 --- a/scripts/tap-generate-docs/conversations.md +++ /dev/null @@ -1,340 +0,0 @@ ---- -tap: "intercom" -version: "0.x" -name: "conversations" -doc-link: "" -singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/conversations.json" -description: "" -replication-method: "" -api-method: - name: "" - doc-link: "" -attributes: - - name: "assignee" - type: "object" - description: "" - subattributes: - - name: "email" - type: "string" - description: "" - - name: "id" - type: "string" - description: "" - - name: "name" - type: "string" - description: "" - - name: "type" - type: "string" - description: "" - - name: "contacts" - type: "array" - description: "" - subattributes: - - name: "id" - type: "string" - description: "" - - name: "type" - type: "string" - description: "" - - name: "conversation_message" - type: "object" - description: "" - subattributes: - - name: "attachments" - type: "null" - description: "" - - name: "author" - type: "object" - description: "" - subattributes: - - name: "email" - type: "string" - description: "" - - name: "id" - type: "string" - description: "" - - name: "name" - type: "string" - description: "" - - name: "type" - type: "string" - description: "" - - name: "body" - type: "string" - description: "" - - name: "delivered_as" - type: "string" - description: "" - - name: "id" - type: "string" - description: "" - - name: "subject" - type: "string" - description: "" - - name: "type" - type: "string" - description: "" - - name: "url" - type: "string" - description: "" - - name: "conversation_rating" - type: "object" - description: "" - subattributes: - - name: "created_at" - type: "date-time" - description: "" - - name: "customer" - type: "object" - description: "" - subattributes: - - name: "id" - type: "string" - description: "" - - name: "type" - type: "string" - description: "" - - name: "rating" - type: "integer" - description: "" - - name: "remark" - type: "string" - description: "" - - name: "teammate" - type: "object" - description: "" - subattributes: - - name: "id" - type: "integer" - description: "" - - name: "type" - type: "string" - description: "" - - name: "created_at" - type: "date-time" - description: "" - - name: "customer_first_reply" - type: "object" - description: "" - subattributes: - - name: "created_at" - type: "date-time" - description: "" - - name: "type" - type: "string" - description: "" - - name: "url" - type: "string" - description: "" - - name: "customers" - type: "null" - description: "" - - name: "first_contact_reply" - type: "object" - description: "" - subattributes: - - name: "created_at" - type: "date-time" - description: "" - - name: "type" - type: "string" - description: "" - - name: "url" - type: "string" - description: "" - - name: "id" - type: "string" - description: "" - - name: "open" - type: "boolean" - description: "" - - name: "priority" - type: "string" - description: "" - - name: "read" - type: "boolean" - description: "" - - name: "sent_at" - type: "date-time" - description: "" - - name: "sla_applied" - type: "object" - description: "" - subattributes: - - name: "sla_name" - type: "string" - description: "" - - name: "sla_status" - type: "string" - description: "" - - name: "snoozed_until" - type: "date-time" - description: "" - - name: "source" - type: "object" - description: "" - subattributes: - - name: "attachments" - type: "array" - description: "" - - name: "author" - type: "object" - description: "" - subattributes: - - name: "email" - type: "string" - description: "" - - name: "id" - type: "string" - description: "" - - name: "name" - type: "string" - description: "" - - name: "type" - type: "string" - description: "" - - name: "body" - type: "string" - description: "" - - name: "delivered_as" - type: "string" - description: "" - - name: "id" - type: "string" - description: "" - - name: "subject" - type: "string" - description: "" - - name: "type" - type: "string" - description: "" - - name: "url" - type: "string" - description: "" - - name: "state" - type: "string" - description: "" - - name: "statistics" - type: "object" - description: "" - subattributes: - - name: "count_assignments" - type: "integer" - description: "" - - name: "count_conversation_parts" - type: "integer" - description: "" - - name: "count_reopens" - type: "integer" - description: "" - - name: "first_admin_reply_at" - type: "date-time" - description: "" - - name: "first_assignment_at" - type: "date-time" - description: "" - - name: "first_close_at" - type: "date-time" - description: "" - - name: "first_contact_reply_at" - type: "date-time" - description: "" - - name: "last_admin_reply_at" - type: "date-time" - description: "" - - name: "last_assignment_admin_reply_at" - type: "date-time" - description: "" - - name: "last_assignment_at" - type: "date-time" - description: "" - - name: "last_close_at" - type: "date-time" - description: "" - - name: "last_closed_by_id" - type: "integer" - description: "" - - name: "last_contact_reply_at" - type: "date-time" - description: "" - - name: "median_time_to_reply" - type: "integer" - description: "" - - name: "time_to_admin_reply" - type: "integer" - description: "" - - name: "time_to_assignment" - type: "integer" - description: "" - - name: "time_to_first_close" - type: "integer" - description: "" - - name: "time_to_last_close" - type: "integer" - description: "" - - name: "type" - type: "string" - description: "" - - name: "tags" - type: "array" - description: "" - subattributes: - - name: "applied_at" - type: "date-time" - description: "" - - name: "applied_by" - type: "object" - description: "" - subattributes: - - name: "id" - type: "string" - description: "" - - name: "type" - type: "string" - description: "" - - name: "id" - type: "string" - description: "" - - name: "name" - type: "string" - description: "" - - name: "type" - type: "string" - description: "" - - name: "teammates" - type: "object" - description: "" - subattributes: - - name: "admins" - type: "array" - description: "" - subattributes: - - name: "id" - type: "string" - description: "" - - name: "type" - type: "string" - description: "" - - name: "type" - type: "string" - description: "" - - name: "type" - type: "string" - description: "" - - name: "updated_at" - type: "date-time" - description: "" - - name: "user" - type: "object" - description: "" - subattributes: - - name: "id" - type: "string" - description: "" - - name: "type" - type: "string" - description: "" - - name: "waiting_since" - type: "date-time" - description: "" ---- diff --git a/scripts/tap-generate-docs/segments.md b/scripts/tap-generate-docs/segments.md deleted file mode 100644 index 9526fbd83..000000000 --- a/scripts/tap-generate-docs/segments.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -tap: "intercom" -version: "0.x" -name: "segments" -doc-link: "" -singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/segments.json" -description: "" -replication-method: "" -api-method: - name: "" - doc-link: "" -attributes: - - name: "count" - type: "integer" - description: "" - - name: "created_at" - type: "date-time" - description: "" - - name: "id" - type: "string" - description: "" - - name: "name" - type: "string" - description: "" - - name: "type" - type: "string" - description: "" - - name: "updated_at" - type: "date-time" - description: "" ---- From 3915e39157ba99f714858d2dfd3b6b044ab71a95 Mon Sep 17 00:00:00 2001 From: Erin Cochran Date: Fri, 14 Aug 2020 12:58:57 -0400 Subject: [PATCH 05/11] Clean up v1 schemas --- _integration-schemas/intercom/v1/admins.md | 48 ++- _integration-schemas/intercom/v1/companies.md | 57 +-- .../intercom/v1/company_attributes.md | 54 ++- .../intercom/v1/company_segments.md | 18 +- .../intercom/v1/contact_attributes.md | 58 +-- _integration-schemas/intercom/v1/contacts.md | 336 ++++++++++++++++++ .../intercom/v1/conversation_parts.md | 89 +++-- .../intercom/v1/conversations.md | 200 ++++++++--- .../intercom/v1/foreign-keys.md | 133 +++---- _integration-schemas/intercom/v1/segments.md | 16 +- _integration-schemas/intercom/v1/tags.md | 8 +- _integration-schemas/intercom/v1/teams.md | 14 +- scripts/tap-generate-docs/teams.md | 25 -- 13 files changed, 776 insertions(+), 280 deletions(-) create mode 100644 _integration-schemas/intercom/v1/contacts.md delete mode 100644 scripts/tap-generate-docs/teams.md diff --git a/_integration-schemas/intercom/v1/admins.md b/_integration-schemas/intercom/v1/admins.md index 5859cfd34..fbaa06afd 100644 --- a/_integration-schemas/intercom/v1/admins.md +++ b/_integration-schemas/intercom/v1/admins.md @@ -1,18 +1,19 @@ --- tap: "intercom" version: "1" +key: "admin" name: "admins" doc-link: "https://developers.intercom.com/intercom-api-reference/reference#admin-model" singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/admins.json" description: | - The `{{ table.name }}` table lists info about the admins in your {{ integration.display_name }} account. + The `{{ table.name }}` table lists info about the admins in your {{ integration.display_name }} account. An admin is a user, or teammate, in your {{ integration.display_name }} account. replication-method: "Full Table" api-method: - name: "listAllAdmins" - doc-link: "https://developers.intercom.com/intercom-api-reference/reference#list-admins" + name: "List all admins" + doc-link: "https://developers.intercom.com/intercom-api-reference/reference#list-admins" attributes: - name: "id" @@ -22,36 +23,55 @@ attributes: foreign-key-id: "admin-id" - name: "admin_ids" - type: "null" + type: "array" description: "" + subattributes: + - name: "value" + type: "integer" + description: "" + + - name: "avatar" + type: "object" + description: "The admin's avatar." + subattributes: + - name: "image_url" + type: "string" + description: "The URL to the admin's avatar." + - name: "away_mode_enabled" type: "boolean" - description: "" + description: "Indicates if the admin is currently set in away mode." + - name: "away_mode_reassign" type: "boolean" - description: "" + description: "Indicates if the admin is set to automatically reassign new conversations to the app's default inbox." + - name: "email" type: "string" - description: "" + description: "The email address of the admin." + - name: "has_inbox_seat" type: "boolean" - description: "" + description: "Indicates if the admin has a paid inbox seat to restrict/allow features." - name: "job_title" type: "string" - description: "" + description: "The job title of the admin." + - name: "name" type: "string" - description: "" + description: "The name of the admin." + - name: "team_ids" type: "array" - description: "A list of the of team IDs that the admin is part of." + description: "The IDs of the teams the admin is a member of." subattributes: - name: "value" type: "integer" - description: "[DESCRIPTION]" + description: "" foreign-key-id: "team-id" + - name: "type" type: "string" - description: "" ---- + description: "This will be `admin`." +--- \ No newline at end of file diff --git a/_integration-schemas/intercom/v1/companies.md b/_integration-schemas/intercom/v1/companies.md index f1f23c9aa..5f0906fe6 100644 --- a/_integration-schemas/intercom/v1/companies.md +++ b/_integration-schemas/intercom/v1/companies.md @@ -1,6 +1,7 @@ --- tap: "intercom" version: "1" +key: "company" name: "companies" doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#company-model" @@ -15,14 +16,14 @@ description: | replication-method: "Key-based Incremental" api-method: - name: "scrollOverAllCompanies" - doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#iterating-over-all-companies" + name: "Scroll over all companies" + doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#iterating-over-all-companies" attributes: - name: "id" type: "string" primary-key: true - description: "The company ID." + description: "The {{ integration.display_name }}-generated company ID." foreign-key-id: "company-id" - name: "updated_at" @@ -32,38 +33,48 @@ attributes: - name: "company_id" type: "string" - description: "" + description: "The ID for the company, as defined by you." + - name: "created_at" type: "date-time" - description: "" + description: "The time the company was added to {{ integration.display_name }}." + - name: "custom_attributes" type: "object" - description: "" + description: "If applicable, the custom attributes you've applied to the company." + - name: "industry" type: "string" - description: "" + description: "The industry the company operates in." + - name: "monthly_spend" type: "number" - description: "" + description: "The amount of revenue the company generates for your business." + - name: "name" type: "string" - description: "" + description: "The name of the company." + - name: "plan" type: "object" - description: "" + description: "The name of the plan associated with the company." subattributes: - name: "id" type: "string" - description: "" + description: "The plan ID." + - name: "name" type: "string" - description: "" + description: "The name of the plan." + - name: "type" type: "string" - description: "" + description: "This will be `plan`." + - name: "remote_created_at" type: "date-time" - description: "" + description: "The time the company was created, as a Unix timestamp." + - name: "segments" type: "array" description: "A list of segments within a company." @@ -75,10 +86,12 @@ attributes: - name: "session_count" type: "integer" - description: "" + description: "The number of recorded sessions for the company." + - name: "size" type: "integer" - description: "" + description: "The number of employees in the company." + - name: "tags" type: "array" description: "A list of tags within a company." @@ -87,14 +100,16 @@ attributes: type: "string" description: "The tag ID." foreign-key-id: "tag-id" + - name: "type" type: "string" - description: "" - + description: "This will be `company`." + - name: "user_count" type: "integer" - description: "" + description: "The number of users in the company." + - name: "website" type: "string" - description: "" ---- + description: "The URL for the company's website." +--- \ No newline at end of file diff --git a/_integration-schemas/intercom/v1/company_attributes.md b/_integration-schemas/intercom/v1/company_attributes.md index 3b4ab2a21..a843db555 100644 --- a/_integration-schemas/intercom/v1/company_attributes.md +++ b/_integration-schemas/intercom/v1/company_attributes.md @@ -1,6 +1,7 @@ --- tap: "intercom" version: "1" +key: "company-attribute" name: "company_attributes" doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#data-attribute-model" @@ -11,8 +12,8 @@ description: | replication-method: "Full Table" api-method: - name: "listAllDataAttributes" - doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#list-data-attributes" + name: "List all data attributes" + doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#list-data-attributes" attributes: - name: "name" @@ -23,45 +24,66 @@ attributes: - name: "admin_id" type: "integer" - description: "" + description: "The ID of the admin that created the attribute." + foreign-key-id: "admin-id" + - name: "api_writable" type: "boolean" - description: "" + description: "Indicates if the attribute can be updated via {{ integration.display_name }}'s API." + - name: "archived" type: "boolean" - description: "" + description: "Indicates if the attribute is archived." + - name: "created_at" type: "date-time" - description: "" + description: "The time the attribute was created." + - name: "custom" type: "boolean" description: "" + - name: "data_type" type: "string" - description: "" + description: | + The type of data stored for the attribute. Possible values are: + + - `string` + - `fixnum` + - `float` + - `boolean` + - `date` + - `options` + - name: "description" type: "string" - description: "" + description: "The description for the attribute." + - name: "full_name" type: "string" description: "" + - name: "label" type: "string" - description: "" + description: "The name of the attribute." + - name: "options" type: "array" - description: "" + description: "The pre-defined options for the attribute." subattributes: - name: "value" - type: "[TYPE]" - description: "[DESCRIPTION]" + type: "varies" + description: "" + - name: "type" type: "string" - description: "" + description: "This will be `data_attribute`." + - name: "ui_writable" type: "boolean" - description: "" + description: "Indicates if the attribute can be updated via {{ integration.display_name }}'s UI." + - name: "updated_at" type: "date-time" - description: "" ---- + description: "The last time the attribute was updated." +--- \ No newline at end of file diff --git a/_integration-schemas/intercom/v1/company_segments.md b/_integration-schemas/intercom/v1/company_segments.md index 097d57769..df373a44a 100644 --- a/_integration-schemas/intercom/v1/company_segments.md +++ b/_integration-schemas/intercom/v1/company_segments.md @@ -1,6 +1,7 @@ --- tap: "intercom" version: "1" +key: "company-segment" name: "company_segments" doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#company-model" @@ -11,15 +12,15 @@ description: | replication-method: "Key-based Incremental" api-method: - name: "listAllSegments" - doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#list-segments" + name: "List all segments" + doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#list-segments" attributes: - name: "id" type: "string" primary-key: true description: "The company segment ID." - foreign-key-id: "company-segment" + # foreign-key-id: "company-segment-id" - name: "updated_at" type: "date-time" @@ -29,13 +30,16 @@ attributes: - name: "count" type: "integer" description: "" + - name: "created_at" type: "date-time" - description: "" + description: "The time the company segment was created." + - name: "name" type: "string" - description: "" + description: "The name of the segment." + - name: "type" type: "string" - description: "" ---- + description: "The value of this field will be `segment`." +--- \ No newline at end of file diff --git a/_integration-schemas/intercom/v1/contact_attributes.md b/_integration-schemas/intercom/v1/contact_attributes.md index 2283cc7ae..ce8a55bf3 100644 --- a/_integration-schemas/intercom/v1/contact_attributes.md +++ b/_integration-schemas/intercom/v1/contact_attributes.md @@ -1,6 +1,7 @@ --- tap: "intercom" version: "1" +key: "contact-attribute" name: "contact_attributes" doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#data-attribute-model" @@ -11,8 +12,8 @@ description: | replication-method: "Full Table" api-method: - name: "listAllDataAttributes" - doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#list-data-attributes" + name: "List all data attributes" + doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#list-data-attributes" attributes: - name: "name" @@ -22,50 +23,67 @@ attributes: foreign-key-id: "contact-attribute-name" - name: "admin_id" - type: "string" - description: "" + type: "integer" + description: "The ID of the admin that created the attribute." + foreign-key-id: "admin-id" + - name: "api_writable" type: "boolean" - description: "" + description: "Indicates if the attribute can be updated via {{ integration.display_name }}'s API." + - name: "archived" type: "boolean" - description: "" + description: "Indicates if the attribute is archived." + - name: "created_at" type: "date-time" - description: "" + description: "The time the attribute was created." + - name: "custom" type: "boolean" description: "" + - name: "data_type" type: "string" - description: "" + description: | + The type of data stored for the attribute. Possible values are: + + - `string` + - `fixnum` + - `float` + - `boolean` + - `date` + - `options` + - name: "description" type: "string" - description: "" + description: "The description for the attribute." + - name: "full_name" type: "string" description: "" + - name: "label" type: "string" - description: "" - - name: "model" - type: "string" - description: "" - + description: "The name of the attribute." + - name: "options" type: "array" - description: "" + description: "The pre-defined options for the attribute." subattributes: - name: "value" - type: "string" + type: "varies" description: "" + - name: "type" type: "string" - description: "" + description: "This will be `data_attribute`." + - name: "ui_writable" type: "boolean" - description: "" + description: "Indicates if the attribute can be updated via {{ integration.display_name }}'s UI." + - name: "updated_at" type: "date-time" - description: "" ---- + description: "The last time the attribute was updated." +--- \ No newline at end of file diff --git a/_integration-schemas/intercom/v1/contacts.md b/_integration-schemas/intercom/v1/contacts.md new file mode 100644 index 000000000..c3e87c7c0 --- /dev/null +++ b/_integration-schemas/intercom/v1/contacts.md @@ -0,0 +1,336 @@ +--- +tap: "intercom" +version: "1" +key: "contact" + +name: "contacts" +doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#contacts-model" +singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/contacts.json" +description: | + The `{{ table.name }}` table contains info about users and leads in your {{ integration.display_name }} account. + + #### Custom attributes + + If applicable, Stitch will replicate custom fields related to `{{ table.name }}` in {{ integration.display_name }}. + +replication-method: "Key-based Incremental" + +api-method: + name: "List all contacts" + doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#list-contacts" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The contact ID." + foreign-key-id: "contact-id" + + - name: "updated_at" + type: "date-time" + replication-key: true + description: "The time the contact was last updated." + + - name: "android_app_name" + type: "string" + description: "The name of the Android app the contact is using, if applicable." + + - name: "android_app_version" + type: "string" + description: "The version of the Android app the contact is using, if applicable." + + - name: "android_device" + type: "string" + description: "The Android device the contact is using, if applicable." + + - name: "android_last_seen_at" + type: "date-time" + description: "The last time the contact used the Android app, if applicable." + + - name: "android_os_version" + type: "string" + description: "The version of the Android OS the contact is using, if applicable." + + - name: "android_sdk_version" + type: "string" + description: "The version of the Android SDK the contact is using, if applicable." + + - name: "avatar" + type: "string" + description: "" + + - name: "browser" + type: "string" + description: "The name of the browser the contact is using." + + - name: "browser_language" + type: "string" + description: "The language set by the browser the contact is using." + + - name: "browser_version" + type: "string" + description: The version of the browser the contact is using." + + - name: "companies" + type: "object" + description: "Details about the company the contact is associated with." + subattributes: + - name: "data" + type: "array" + description: "Details about the company the contact is associated with." + subattributes: + - name: "id" + type: "string" + description: "The {{ integration.display_name }}-defined company ID." + foreign-key-id: "company-id" + + - name: "type" + type: "string" + description: "This will be `company`." + + - name: "url" + type: "string" + description: "" + + - name: "has_more" + type: "boolean" + description: "" + + - name: "total_count" + type: "integer" + description: "" + + - name: "type" + type: "string" + description: "This will be `list`." + + - name: "url" + type: "string" + description: "" + + - name: "created_at" + type: "date-time" + description: "The time the contact was created." + + - name: "custom_attributes" + type: "object" + description: "The custom attributes set for the contact." + + - name: "email" + type: "string" + description: "The email associated with the lead." + + - name: "external_id" + type: "string" + description: "The unique ID for the contact." + + - name: "has_hard_bounced" + type: "boolean" + description: "Indicates whether the contact has had an email sent to them hard bounce." + + - name: "ios_app_name" + type: "string" + description: "The name of the iOS app the contact is using, if applicable." + + - name: "ios_app_version" + type: "string" + description: "The version of the iOS app the contact is using, if applicable." + + - name: "ios_device" + type: "string" + description: "The iOS device the contact is using, if applicable." + + - name: "ios_last_seen_at" + type: "date-time" + description: "The last time the contact used the iOS app, if applicable." + + - name: "ios_os_version" + type: "string" + description: "The version of the iOS OS the contact is using, if applicable." + + - name: "ios_sdk_version" + type: "string" + description: "The version of the iOS SDK the contact is using, if applicable." + + - name: "language_override" + type: "string" + description: "The preferred language setting for the contact." + + - name: "last_contacted_at" + type: "date-time" + description: "The time when the contact was last messaged." + + - name: "last_email_clicked_at" + type: "date-time" + description: "The time when the contact last clicked a link in an email sent to them, as a Unix timestamp." + + - name: "last_email_opened_at" + type: "date-time" + description: "The time when the contact last opened an email sent to them, as a Unix timestamp." + + - name: "last_replied_at" + type: "date-time" + description: "The time when the contact last sent a message, as a Unix timestamp." + + - name: "last_seen_at" + type: "date-time" + description: "The time the contact was last seen, as a Unix timestamp." + + - name: "location" + type: "object" + description: "Details about the contact's location." + subattributes: + - name: "city" + type: "string" + description: "The contact's city." + + - name: "country" + type: "string" + description: "The contact's country." + + - name: "region" + type: "string" + description: "The contact's region." + + - name: "type" + type: "string" + description: "This will be `location`." + + - name: "marked_email_as_spam" + type: "boolean" + description: "Indicates if the contact has marked an email sent to them as spam." + + - name: "name" + type: "string" + description: "The name of the lead." + + - name: "notes" + type: "object" + description: "The notes that have been added to the contact." + subattributes: + - name: "data" + type: "array" + description: "The notes that have been added to the contact." + subattributes: + - name: "id" + type: "string" + description: "The note ID." + + - name: "type" + type: "string" + description: "This will be `note`." + + - name: "url" + type: "string" + description: "" + + - name: "has_more" + type: "boolean" + description: "" + + - name: "total_count" + type: "integer" + description: "" + + - name: "type" + type: "string" + description: "This will be `list`." + + - name: "url" + type: "string" + description: "" + + - name: "os" + type: "string" + description: "The operating system the contact is using." + + - name: "owner_id" + type: "integer" + description: "The ID of the admin that has been assigned account ownership of the contact." + foreign-key-id: "admin-id" + + - name: "phone" + type: "string" + description: "The phone number associated with the lead." + + - name: "role" + type: "string" + description: "The role of the contact. This will be either `lead` or `user`." + + - name: "signed_up_at" + type: "date-time" + description: "The time when a contact signed up, as a Unix timestamp." + + - name: "social_profiles" + type: "object" + description: "Details about the social profiles the lead is associated with." + subattributes: + - name: "data" + type: "array" + description: "" + subattributes: + - name: "name" + type: "string" + description: "The name of the social service. Ex: `facebook`" + + - name: "type" + type: "string" + description: "This will be `social_profile`." + + - name: "url" + type: "string" + description: "The URL of the social profile." + + - name: "type" + type: "string" + description: "" + + - name: "tags" + type: "object" + description: "Details about the tags applied to the contact." + subattributes: + - name: "data" + type: "array" + description: "Details about the tags applied to the contact." + subattributes: + - name: "id" + type: "string" + description: "The ID of the tag." + foreign-key-id: "tag-id" + + - name: "type" + type: "string" + description: "This will be `tag`." + + - name: "url" + type: "string" + description: "" + + - name: "has_more" + type: "boolean" + description: "" + + - name: "total_count" + type: "integer" + description: "" + + - name: "type" + type: "string" + description: "This will be `list`." + + - name: "url" + type: "string" + description: "" + + - name: "type" + type: "string" + description: "This will be `contact`." + + - name: "unsubscribed_from_emails" + type: "boolean" + description: "Indicates if the contact has unsubscribed from emails." + + - name: "workspace_id" + type: "string" + description: "The ID of the workspace the contact is associated with." +--- \ No newline at end of file diff --git a/_integration-schemas/intercom/v1/conversation_parts.md b/_integration-schemas/intercom/v1/conversation_parts.md index c283bb2bf..35e7fa727 100644 --- a/_integration-schemas/intercom/v1/conversation_parts.md +++ b/_integration-schemas/intercom/v1/conversation_parts.md @@ -1,78 +1,123 @@ --- tap: "intercom" version: "1" +key: "conversation-part" name: "conversation_parts" doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#conversation-model" singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/conversation_parts.json" description: | - The `{{ table.name }}` table lists parts of a conversation from the `conversations`table in your {{ integration.display_name }} account. The only conversation parts that will replicate in full will be the ones whose parent conversation in the `conversations` table have updated. + The `{{ table.name }}` table lists the individual parts of conversations in your {{ integration.display_name }} account. + + **Note**: When this table is replicated, all conversation parts associated with an updated conversation will be replicated. replication-method: "Full Table" api-method: - name: "retrieveAConversation" - doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#retrieve-a-conversation" + name: "Retrieve a conversation" + doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#retrieve-a-conversation" attributes: - name: "id" type: "string" primary-key: true description: "The conversation part ID." - foreign-key-id: "part-id" + # foreign-key-id: "part-id" - name: "assigned_to" type: "string" - description: "The admin ID that the conversation part is assigned to." + description: "The ID of the admin that the conversation part is assigned to." foreign-key-id: "admin-id" + - name: "attachments" - type: "null" - description: "" + type: "array" + description: "Details about the attachments, if any, that are a part of the conversation part." + subattributes: + - name: "url" + type: "string" + description: "The attachment URL." + + - name: "name" + type: "string" + description: "The name of the attachment. Ex: `image001.png`, `presentation.pdf`" + + - name: "content_type" + type: "string" + description: "The content type of the attachment. Ex: `image/png`, `application/pdf`" + + - name: "height" + type: "integer" + description: "For image attachments, the height of the image." + + - name: "width" + type: "integer" + description: "For image attachments, the width of the image." + + - name: "filesize" + type: "integer" + description: "The file size of the attachment." + + - name: "type" + type: "string" + description: "The value of this field will be `upload`." + - name: "author" type: "object" - description: "A list of conversation authors." + description: "Details about the admin or user that created the conversation part." subattributes: - name: "id" type: "string" - description: "The author ID. This could either be the user ID or admin ID." + description: | + The ID of the admin or end-user that created the conversation part. + + Depending on the author's `type`, this will be a foreign key to either the [`admins`](#admins) or [`contacts`](#contacts) table. + - name: "type" type: "string" - description: "" + description: "The type of user that created the conversation part." + - name: "body" type: "string" - description: "" + description: "The HTML-encoded body of the conversation part." + - name: "conversation_created_at" type: "date-time" - description: "" + description: "The time the parent conversation associated with the part was created." - name: "conversation_id" type: "string" - description: "The conversation ID." + description: "The ID of the conversation associated with the part." foreign-key-id: "conversation-id" - name: "conversation_total_parts" type: "integer" - description: "" + description: "The total number of conversation parts associated with the parent conversation." + - name: "conversation_updated_at" type: "date-time" - description: "" + description: "The time the parent conversation associated with the part was last updated." + - name: "created_at" type: "date-time" - description: "" + description: "The time the conversation part was created." + - name: "external_id" type: "string" description: "" - + - name: "notified_at" type: "date-time" - description: "" + description: "The time the user was notified with the conversation part." + - name: "part_type" type: "string" - description: "" + description: "The type of the conversation part." + - name: "type" type: "string" - description: "" + description: "This will be `conversation_part`." + - name: "updated_at" type: "date-time" - description: "" ---- + description: "The time the conversation part was updated." +--- \ No newline at end of file diff --git a/_integration-schemas/intercom/v1/conversations.md b/_integration-schemas/intercom/v1/conversations.md index 4541fb611..7434cf0d0 100644 --- a/_integration-schemas/intercom/v1/conversations.md +++ b/_integration-schemas/intercom/v1/conversations.md @@ -1,6 +1,7 @@ --- tap: "intercom" version: "1" +key: "conversation" name: "conversations" doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#conversation-model" @@ -11,8 +12,8 @@ description: | replication-method: "Key-based Incremental" api-method: - name: "listAllConversations" - doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#list-conversations" + name: "List all conversations" + doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#list-conversations" attributes: - name: "id" @@ -28,154 +29,253 @@ attributes: - name: "assignee" type: "object" - description: "A list of conversation assignees." - subattributes: - - name: "id" - type: "integer" - description: "The assignee ID. This could either be a team ID or admin ID depending on the type assigned to this subattribute." + description: "Details about the admin or team assigned to the conversation." - - name: "type" - type: "string" - description: "" - name: "conversation_message" type: "object" description: "A list of message details." subattributes: - name: "attachments" type: "array" - description: "A list of attachment details" + description: "Details about the attachments, if any, that are a part of the conversation message." subattributes: - - name: "value" - type: "[TYPE]" - description: "[DESCRIPTION]" + - name: "url" + type: "string" + description: "The attachment URL." + + - name: "name" + type: "string" + description: "The name of the attachment. Ex: `image001.png`, `presentation.pdf`" + + - name: "content_type" + type: "string" + description: "The content type of the attachment. Ex: `image/png`, `application/pdf`" + + - name: "height" + type: "integer" + description: "For image attachments, the height of the image." + + - name: "width" + type: "integer" + description: "For image attachments, the width of the image." + + - name: "filesize" + type: "integer" + description: "The file size of the attachment." + + - name: "type" + type: "string" + description: "The value of this field will be `upload`." + - name: "author" type: "object" - description: "A list of authors." + description: "Details about the user that created the conversation message." subattributes: - name: "id" type: "string" - description: "The author ID." - foreign-key-id: "author-ID" + description: | + The ID of the user who created the conversation message. + + Depending on the author's `type`, this will be a foreign key to either the [`admins`](#admins) or [`contacts`](#contacts) table. + - name: "type" type: "string" - description: "" + description: | + The type of user that created the conversation message. Possible values are: + + - `user` + - `lead` + - `admin` + - name: "body" type: "string" - description: "" + description: "The conversation message body, which may contain HTML. This is the body of the message that started the conversation." + - name: "delivered_as" type: "string" description: "" + - name: "id" type: "string" - description: "" + description: "The ID of the conversation message." + - name: "subject" type: "string" - description: "" + description: "The conversation message subject, or the subject of the message that started the conversation." + - name: "type" type: "string" - description: "" + description: | + The type of the conversation message. Possible values are: + + - `conversation` + - `push` + - `facebook` + - `twitter` + - `email` + - name: "url" type: "string" - description: "" + description: "The URL where the conversation was started. For Twitter, Email, and Bots, this will be `null`." + - name: "conversation_rating" type: "object" - description: "" + description: "Details about the rating for the conversation." subattributes: - name: "created_at" type: "date-time" - description: "" + description: "The time that the conversation being rated was created." + - name: "customer" type: "object" - description: "" + description: "Details about the customer who rated the conversation." subattributes: - name: "id" type: "string" - description: "" + description: "The customer ID." + foreign-key-id: "contact-id" + - name: "type" type: "string" - description: "" + description: "This will be `contact`." + - name: "rating" type: "integer" - description: "" + description: "The rating, between 1 and 5, for the conversation." + - name: "remark" type: "string" - description: "" + description: "A remark about the rating, if any." + - name: "teammate" type: "object" - description: "" + description: "The ID of the teammate associated with the conversation when it was rated." subattributes: - name: "id" type: "integer" - description: "The admin ID of the teammate." + description: "The ID of the teammate." foreign-key-id: "admin-id" + - name: "type" type: "string" - description: "" + description: "The type of the teammate." + - name: "created_at" type: "date-time" - description: "" + description: "The time the conversation was created." + - name: "customer_first_reply" type: "object" - description: "" + description: "Details about the customer's first reply to the conversation." subattributes: - name: "created_at" type: "date-time" - description: "" + description: "The time the user's message was created, in Unix timestamp format." + - name: "type" type: "string" - description: "" + description: | + The channel over which the first reply occurred. Possible values are: + + - `conversation` + - `push` + - `facebook` + - `twitter` + - `email` + - name: "url" type: "string" - description: "" + description: "The URL where the first reply originated from." + - name: "customers" type: "array" - description: "A list of customers." + description: "Details about the customers involved in the conversation." subattributes: - name: "id" type: "string" description: "The customer ID." - foreign-key-id: "customer-id" + foreign-key-id: "contact-id" + + - name: "type" + type: "string" + description: "The type of the customer. This will be either `lead` or `user`." - name: "open" type: "boolean" - description: "" + description: "Indicates whether a conversation is open/snoozed (`true`) or closed (`false`)." + - name: "read" type: "boolean" - description: "" + description: "Indicates whether a conversation has been read." + - name: "sent_at" type: "date-time" description: "" + - name: "snoozed_until" type: "date-time" - description: "" + description: "If set, this is the time in the future when the conversation will be marked as open." + - name: "state" type: "string" - description: "" + description: | + The current state of the conversation. Possible values are: + + - `open` + - `closed` + - `snoozed` + - name: "tags" type: "array" - description: "A list of tags." + description: "Details about the tags applied to the conversation." subattributes: - name: "id" type: "string" description: "The tag ID." foreign-key-id: "tag-id" + - name: "applied_at" + type: "date-time" + description: "The time the tag was applied." + + - name: "applied_by" + type: "object" + description: "Details about the admin that applied the tag." + subattributes: + - name: "id" + type: "integer" + description: "The admin ID." + foreign-key-id: "admin-id" + + - name: "type" + type: "string" + description: "This will be `tag`." + + - name: "name" + type: "string" + description: "The name of the tag." + + - name: "type" + type: "string" + description: "This will be `tags.list`." + - name: "type" type: "string" - description: "" + description: "This will be `conversation`." - name: "user" type: "object" - description: "A list of users." + description: "A list of users associated with the conversation." subattributes: - name: "id" type: "string" description: "The user ID." - foreign-key-id: "user-id" + - name: "type" type: "string" description: "" + - name: "waiting_since" type: "date-time" - description: "" ---- + description: "The last time a contact responded to an admin. In other words, the time a customer started waiting for a response. This will be `null` if last reply is from an admin." +--- \ No newline at end of file diff --git a/_integration-schemas/intercom/v1/foreign-keys.md b/_integration-schemas/intercom/v1/foreign-keys.md index a2a2127e4..54ee3f5bd 100644 --- a/_integration-schemas/intercom/v1/foreign-keys.md +++ b/_integration-schemas/intercom/v1/foreign-keys.md @@ -14,30 +14,25 @@ version: "1" foreign-keys: - id: "admin-id" table: "admins" - attribute: "id" + attribute: "admin_id" all-foreign-keys: - table: "admins" join-on: "id" - - table: "teams" - subattribute: "admin_ids" - join-on: "id" + - table: "company_attributes" + - table: "contact_attributes" + - table: "contacts" + join-on: "owner_id" - table: "conversation_parts" - join-on: "admin-id" + join-on: "assigned_to" - table: "conversations" subattribute: "conversation_rating.teammate" join-on: "id" + - table: "conversations" + subattribute: "tags.applied_by" + join-on: "id" - table: "teams" subattribute: "admin_ids" - join-on: "id" - - - id: "team-id" - table: "teams" - attribute: "id" - all-foreign-keys: - - table: "teams" join-on: "id" - - table: "admins" - join-on: "team_ids" - id: "company-id" table: "companies" @@ -45,69 +40,18 @@ foreign-keys: all-foreign-keys: - table: "companies" join-on: "id" - - table: "leads" - subattribute: "companies" - join-on: "id" - - table: "users" - subattribute: "companies" - join-on: "id" - - id: "segment-id" - table: "segment" - attribute: "id" - all-foreign-keys: - - table: "segment" - join-on: "id" - - table: "companies" - subattribute: "segments" - join-on: "id" - - table: "leads" - subattribute: "segments" - join-on: "id" - - table: "users" - subattribute: "segments" - join-on: "id" - - - id: "tag-id" - table: "tags" - attribute: "id" - all-foreign-keys: - - table: "tags" - join-on: "id" - - table: "companies" - subattribute: "tags" - join-on: "id" - - table: "conversations" - subattribute: "tags" + - table: "contacts" + subattribute: "companies.data" join-on: "id" - - table: "leads" - subattribute: "tags" - join-on: "id" - - table: "users" - subattribute: "tags" - join-on: "id" - - id: "attribute-name" - table: "company_attributes" - attribute: "name" - all-foreign-keys: - - table: "company_attributes" - join-on: "name" - - - id: "company-segment" + - id: "company-segment-id" table: "company_segments" attribute: "id" all-foreign-keys: - table: "company_segments" join-on: "id" - - id: "part-id" - table: "conversation_parts" - attribute: "id" - all-foreign-keys: - - table: "conversation_parts" - join-on: "id" - - id: "conversation-id" table: "conversations" attribute: "id" @@ -117,38 +61,49 @@ foreign-keys: - table: "conversation_parts" join-on: "conversation_id" - - id: "author-id" - table: "authors" + - id: "contact-id" + table: "contacts" attribute: "id" - all-foreign-keys: + subattributes: + - table: "contacts" - table: "conversations" - subattribute: "conversation_message.author" - join-on: "id" + subattribute: "conversation_rating.customer" + - table: "conversations" + subattribute: "customers" - - id: "customer-id" - table: "customers" + - id: "segment-id" + table: "segment" attribute: "id" all-foreign-keys: - - table: "customers" - join-on: "id" - - table: "conversations" - subattribute: "customers" + - table: "companies" + subattribute: "segments" join-on: "id" + - table: "segment" + join-on: "id" - - id: "user-id" - table: "users" + - id: "tag-id" + table: "tags" attribute: "id" all-foreign-keys: - - table: "users" + - table: "contacts" + subattribute: "tags.data" join-on: "id" - table: "conversations" - subattribute: "user" - join-on: "id" + subattribute: "tags" + join-on: "id" + - table: "companies" + subattribute: "tags" + join-on: "id" + - table: "tags" + join-on: "id" - - id: "contact-attribute-name" - table: "contact_attributes" - attribute: "name" + - id: "team-id" + table: "teams" + attribute: "id" all-foreign-keys: - - table: "contact_attributes" - join-on: "name" + - table: "admins" + subattribute: "team_ids" + join-on: "value" + - table: "teams" + join-on: "id" --- \ No newline at end of file diff --git a/_integration-schemas/intercom/v1/segments.md b/_integration-schemas/intercom/v1/segments.md index 0b6bc0dc1..b9985cb52 100644 --- a/_integration-schemas/intercom/v1/segments.md +++ b/_integration-schemas/intercom/v1/segments.md @@ -11,8 +11,8 @@ description: replication-method: "Key-based Incremental" api-method: - name: "List all segments" - doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#list-segments" + name: "List all segments" + doc-link: "https://developers.intercom.com/intercom-api-reference/v2.0/reference#list-segments" attributes: - name: "id" @@ -28,15 +28,17 @@ attributes: - name: "count" type: "integer" - description: "" + description: "The number of items in the segment." + - name: "created_at" type: "date-time" - description: "" + description: "The time the segment was created." - name: "name" type: "string" - description: "" + description: "The name of the segment." + - name: "type" type: "string" - description: "" ---- + description: "This will be `segment`." +--- \ No newline at end of file diff --git a/_integration-schemas/intercom/v1/tags.md b/_integration-schemas/intercom/v1/tags.md index 4f943f5f2..175101fea 100644 --- a/_integration-schemas/intercom/v1/tags.md +++ b/_integration-schemas/intercom/v1/tags.md @@ -1,6 +1,7 @@ --- tap: "intercom" version: "1" +key: "tag" name: "tags" doc-link: "https://developers.intercom.com/intercom-api-reference/reference#tag-model" @@ -23,8 +24,9 @@ attributes: - name: "name" type: "string" - description: "" + description: "The name of the tag." + - name: "type" type: "string" - description: "" ---- + description: "This will be `tag`." +--- \ No newline at end of file diff --git a/_integration-schemas/intercom/v1/teams.md b/_integration-schemas/intercom/v1/teams.md index 37562e23d..f7f12b0be 100644 --- a/_integration-schemas/intercom/v1/teams.md +++ b/_integration-schemas/intercom/v1/teams.md @@ -1,6 +1,7 @@ --- tap: "intercom" version: "1" +key: "team" name: "teams" doc-link: "https://developers.intercom.com/intercom-api-reference/reference#teams-model" @@ -11,8 +12,8 @@ description: | replication-method: "Full Table" api-method: - name: "List all teams" - doc-link: "https://developers.intercom.com/intercom-api-reference/reference#list-teams" + name: "List all teams" + doc-link: "https://developers.intercom.com/intercom-api-reference/reference#list-teams" attributes: - name: "id" @@ -23,7 +24,7 @@ attributes: - name: "admin_ids" type: "array" - description: "A list of admin IDs." + description: "The admins that belong to the team." subattributes: - name: "id" type: "string" @@ -32,8 +33,9 @@ attributes: - name: "name" type: "string" - description: "" + description: "The name of the team." + - name: "type" type: "string" - description: "" ---- + description: "This will be `team`." +--- \ No newline at end of file diff --git a/scripts/tap-generate-docs/teams.md b/scripts/tap-generate-docs/teams.md deleted file mode 100644 index 72d743e3a..000000000 --- a/scripts/tap-generate-docs/teams.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -tap: "intercom" -version: "0.x" -name: "teams" -doc-link: "" -singer-schema: "https://github.com/singer-io/tap-intercom/blob/master/tap_intercom/schemas/teams.json" -description: "" -replication-method: "" -api-method: - name: "" - doc-link: "" -attributes: - - name: "admin_ids" - type: "null" - description: "" - - name: "id" - type: "string" - description: "" - - name: "name" - type: "string" - description: "" - - name: "type" - type: "string" - description: "" ---- From 3b19fa6b53d782a2ef8ea4a28be4a3c4410a0e42 Mon Sep 17 00:00:00 2001 From: Erin Cochran Date: Fri, 14 Aug 2020 12:59:13 -0400 Subject: [PATCH 06/11] Correct version in sourcerer files --- .../intercom/{v15-10-2015 => v02-02-2016}/admins.md | 2 +- .../intercom/{v15-10-2015 => v02-02-2016}/companies.md | 2 +- .../intercom/{v15-10-2015 => v02-02-2016}/company_segments.md | 2 +- .../intercom/{v15-10-2015 => v02-02-2016}/contacts.md | 2 +- .../intercom/{v15-10-2015 => v02-02-2016}/conversations.md | 2 +- .../intercom/{v15-10-2015 => v02-02-2016}/foreign-keys.md | 2 +- .../intercom/{v15-10-2015 => v02-02-2016}/segments.md | 2 +- .../intercom/{v15-10-2015 => v02-02-2016}/tags.md | 2 +- .../intercom/{v15-10-2015 => v02-02-2016}/users.md | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) rename _integration-schemas/intercom/{v15-10-2015 => v02-02-2016}/admins.md (98%) rename _integration-schemas/intercom/{v15-10-2015 => v02-02-2016}/companies.md (99%) rename _integration-schemas/intercom/{v15-10-2015 => v02-02-2016}/company_segments.md (97%) rename _integration-schemas/intercom/{v15-10-2015 => v02-02-2016}/contacts.md (99%) rename _integration-schemas/intercom/{v15-10-2015 => v02-02-2016}/conversations.md (99%) rename _integration-schemas/intercom/{v15-10-2015 => v02-02-2016}/foreign-keys.md (99%) rename _integration-schemas/intercom/{v15-10-2015 => v02-02-2016}/segments.md (97%) rename _integration-schemas/intercom/{v15-10-2015 => v02-02-2016}/tags.md (96%) rename _integration-schemas/intercom/{v15-10-2015 => v02-02-2016}/users.md (99%) diff --git a/_integration-schemas/intercom/v15-10-2015/admins.md b/_integration-schemas/intercom/v02-02-2016/admins.md similarity index 98% rename from _integration-schemas/intercom/v15-10-2015/admins.md rename to _integration-schemas/intercom/v02-02-2016/admins.md index 731eb401b..83ac952cb 100755 --- a/_integration-schemas/intercom/v15-10-2015/admins.md +++ b/_integration-schemas/intercom/v02-02-2016/admins.md @@ -1,6 +1,6 @@ --- tap: "intercom" -version: "15-10-2015" +version: "02-02-2016" name: "admins" doc-link: https://developers.intercom.io/docs/admins diff --git a/_integration-schemas/intercom/v15-10-2015/companies.md b/_integration-schemas/intercom/v02-02-2016/companies.md similarity index 99% rename from _integration-schemas/intercom/v15-10-2015/companies.md rename to _integration-schemas/intercom/v02-02-2016/companies.md index 163975606..9544756f9 100755 --- a/_integration-schemas/intercom/v15-10-2015/companies.md +++ b/_integration-schemas/intercom/v02-02-2016/companies.md @@ -1,6 +1,6 @@ --- tap: "intercom" -version: "15-10-2015" +version: "02-02-2016" name: "companies" doc-link: https://developers.intercom.com/reference#companies diff --git a/_integration-schemas/intercom/v15-10-2015/company_segments.md b/_integration-schemas/intercom/v02-02-2016/company_segments.md similarity index 97% rename from _integration-schemas/intercom/v15-10-2015/company_segments.md rename to _integration-schemas/intercom/v02-02-2016/company_segments.md index 2aef5ec02..a6219874e 100755 --- a/_integration-schemas/intercom/v15-10-2015/company_segments.md +++ b/_integration-schemas/intercom/v02-02-2016/company_segments.md @@ -1,6 +1,6 @@ --- tap: "intercom" -version: "15-10-2015" +version: "02-02-2016" name: "company_segments" doc-link: https://developers.intercom.io/docs/companies diff --git a/_integration-schemas/intercom/v15-10-2015/contacts.md b/_integration-schemas/intercom/v02-02-2016/contacts.md similarity index 99% rename from _integration-schemas/intercom/v15-10-2015/contacts.md rename to _integration-schemas/intercom/v02-02-2016/contacts.md index bd153e9bc..f252c90c2 100755 --- a/_integration-schemas/intercom/v15-10-2015/contacts.md +++ b/_integration-schemas/intercom/v02-02-2016/contacts.md @@ -1,6 +1,6 @@ --- tap: "intercom" -version: "15-10-2015" +version: "02-02-2016" name: "contacts" doc-link: https://developers.intercom.com/reference#leads diff --git a/_integration-schemas/intercom/v15-10-2015/conversations.md b/_integration-schemas/intercom/v02-02-2016/conversations.md similarity index 99% rename from _integration-schemas/intercom/v15-10-2015/conversations.md rename to _integration-schemas/intercom/v02-02-2016/conversations.md index 91376e613..b81e3945a 100755 --- a/_integration-schemas/intercom/v15-10-2015/conversations.md +++ b/_integration-schemas/intercom/v02-02-2016/conversations.md @@ -1,6 +1,6 @@ --- tap: "intercom" -version: "15-10-2015" +version: "02-02-2016" name: "conversations" doc-link: https://developers.intercom.com/reference#conversations diff --git a/_integration-schemas/intercom/v15-10-2015/foreign-keys.md b/_integration-schemas/intercom/v02-02-2016/foreign-keys.md similarity index 99% rename from _integration-schemas/intercom/v15-10-2015/foreign-keys.md rename to _integration-schemas/intercom/v02-02-2016/foreign-keys.md index bf3dbdf8e..3bb37b7dc 100644 --- a/_integration-schemas/intercom/v15-10-2015/foreign-keys.md +++ b/_integration-schemas/intercom/v02-02-2016/foreign-keys.md @@ -1,7 +1,7 @@ --- tap-reference: "intercom" -version: "15-10-2015" +version: "02-02-2016" foreign-keys: - id: "admin-id" diff --git a/_integration-schemas/intercom/v15-10-2015/segments.md b/_integration-schemas/intercom/v02-02-2016/segments.md similarity index 97% rename from _integration-schemas/intercom/v15-10-2015/segments.md rename to _integration-schemas/intercom/v02-02-2016/segments.md index d632e3506..aa46b877d 100755 --- a/_integration-schemas/intercom/v15-10-2015/segments.md +++ b/_integration-schemas/intercom/v02-02-2016/segments.md @@ -1,6 +1,6 @@ --- tap: "intercom" -version: "15-10-2015" +version: "02-02-2016" name: "segments" doc-link: https://developers.intercom.com/reference#segments diff --git a/_integration-schemas/intercom/v15-10-2015/tags.md b/_integration-schemas/intercom/v02-02-2016/tags.md similarity index 96% rename from _integration-schemas/intercom/v15-10-2015/tags.md rename to _integration-schemas/intercom/v02-02-2016/tags.md index 49c5c5e44..af902b115 100755 --- a/_integration-schemas/intercom/v15-10-2015/tags.md +++ b/_integration-schemas/intercom/v02-02-2016/tags.md @@ -1,6 +1,6 @@ --- tap: "intercom" -version: "15-10-2015" +version: "02-02-2016" name: "tags" doc-link: https://developers.intercom.io/docs/tags diff --git a/_integration-schemas/intercom/v15-10-2015/users.md b/_integration-schemas/intercom/v02-02-2016/users.md similarity index 99% rename from _integration-schemas/intercom/v15-10-2015/users.md rename to _integration-schemas/intercom/v02-02-2016/users.md index 2daf3bd85..ec2e56ef7 100755 --- a/_integration-schemas/intercom/v15-10-2015/users.md +++ b/_integration-schemas/intercom/v02-02-2016/users.md @@ -1,6 +1,6 @@ --- tap: "intercom" -version: "15-10-2015" +version: "02-02-2016" name: "users" doc-link: https://developers.intercom.io/docs/users From db8427b885524653b5460eb74bf9b941f02e6006 Mon Sep 17 00:00:00 2001 From: Erin Cochran Date: Fri, 14 Aug 2020 13:42:22 -0400 Subject: [PATCH 07/11] Add fields to templates --- _templates/integrations/databases/database-base.md | 1 + _templates/integrations/saas/saas-base.md | 8 +++++--- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/_templates/integrations/databases/database-base.md b/_templates/integrations/databases/database-base.md index 02ad1914c..e6a282071 100644 --- a/_templates/integrations/databases/database-base.md +++ b/_templates/integrations/databases/database-base.md @@ -60,6 +60,7 @@ db-type: "" ## Stitch features +api-type: "" versions: "n/a" ssh: true/false ssl: true/false diff --git a/_templates/integrations/saas/saas-base.md b/_templates/integrations/saas/saas-base.md index 3b0687296..572e05c0a 100644 --- a/_templates/integrations/saas/saas-base.md +++ b/_templates/integrations/saas/saas-base.md @@ -12,8 +12,8 @@ # Page & Formatting # # -------------------------- # -title: SAAS-INTEGRATION -permalink: /integrations/saas/saas-integration +title: SAAS-INTEGRATION (vVERSION) +permalink: /integrations/saas/saas-integration ## Add if there are multiple versions: /vVERSION keywords: saas-integration, integration, schema, etl saas-integration, saas-integration etl, saas-integration schema layout: singer # input: false @@ -31,7 +31,7 @@ display_name: "SAAS-INTEGRATION" singer: true status-url: "" -tap-name: "" +tap-name: "" ## Ex: Intercom, not intercom repo-url: https://github.com/singer-io/tap-saas-integration this-version: "" @@ -50,6 +50,8 @@ historical: "1 year" frequency: "1 hour" tier: "Free/Standard/Enterprise" +api-type: "" + anchor-scheduling: true cron-scheduling: true From c551eba8ddcf885957e3c656f54bf36df9221fba Mon Sep 17 00:00:00 2001 From: Erin Cochran Date: Fri, 14 Aug 2020 13:42:35 -0400 Subject: [PATCH 08/11] Fix file name issue --- ...om-v02-02-2016.md => intercom-v02-02-2016.md} | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) rename _saas-integrations/intercom/v02-02-2016/{ intercom-v02-02-2016.md => intercom-v02-02-2016.md} (89%) diff --git a/_saas-integrations/intercom/v02-02-2016/ intercom-v02-02-2016.md b/_saas-integrations/intercom/v02-02-2016/intercom-v02-02-2016.md similarity index 89% rename from _saas-integrations/intercom/v02-02-2016/ intercom-v02-02-2016.md rename to _saas-integrations/intercom/v02-02-2016/intercom-v02-02-2016.md index 9785b0f27..bac1e5aad 100644 --- a/_saas-integrations/intercom/v02-02-2016/ intercom-v02-02-2016.md +++ b/_saas-integrations/intercom/v02-02-2016/intercom-v02-02-2016.md @@ -1,9 +1,23 @@ --- -title: Intercom +# -------------------------- # +# USING THIS TEMPLATE # +# -------------------------- # + +## NEED HELP USING THIS TEMPLATE? SEE: +## https://docs-about-stitch-docs.netlify.com/reference/integration-templates/saas/ +## FOR INSTRUCTIONS & REFERENCE INFO + + +# -------------------------- # +# Page & Formatting # +# -------------------------- # + +title: Intercom (v02-02-2016) permalink: /integrations/saas/intercom/v02-02-2016 keywords: intercom, integration, schema, etl intercom, intercom etl, intercom schema summary: "Connection instructions, replication info, and schema details for Stitch's Intercom integration." layout: singer +input: false key: "intercom-setup" From 188d06c41af57999c5cdd1262bca1a51cfcfc7d9 Mon Sep 17 00:00:00 2001 From: Erin Cochran Date: Fri, 14 Aug 2020 13:42:43 -0400 Subject: [PATCH 09/11] Correct beta release date for v1 --- _data/taps/versions/intercom.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_data/taps/versions/intercom.yml b/_data/taps/versions/intercom.yml index ce18f854c..cf0d29cdf 100644 --- a/_data/taps/versions/intercom.yml +++ b/_data/taps/versions/intercom.yml @@ -16,7 +16,7 @@ latest-version: "1" released-versions: - number: "1" status: "beta" - date-released: "11-05-2019" + date-released: "August 14, 2020" # date-last-connection: deprecation-date: "" sunset-date: "" From cb1c11f8f98626eba1cc09e072e2f15abe5c22d7 Mon Sep 17 00:00:00 2001 From: Erin Cochran Date: Fri, 14 Aug 2020 13:43:00 -0400 Subject: [PATCH 10/11] Clean up for v1 --- _saas-integrations/intercom/v1/intercom-v1.md | 22 +++++++++++++------ 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/_saas-integrations/intercom/v1/intercom-v1.md b/_saas-integrations/intercom/v1/intercom-v1.md index 09575e136..ec0ff69c4 100644 --- a/_saas-integrations/intercom/v1/intercom-v1.md +++ b/_saas-integrations/intercom/v1/intercom-v1.md @@ -12,12 +12,15 @@ # Page & Formatting # # -------------------------- # -title: Intercom -permalink: /integrations/saas/intercom/ +title: Intercom (v1) +permalink: /integrations/saas/intercom keywords: intercom, integration, schema, etl intercom, intercom etl, intercom schema layout: singer # input: false +key: "intercom-setup" + + # -------------------------- # # Tap Details # # -------------------------- # @@ -26,25 +29,28 @@ name: "intercom" display_name: "Intercom" singer: true -tap-name: "intercom" +tap-name: "Intercom" repo-url: https://github.com/singer-io/tap-intercom +this-version: "1" + api: | [{{ integration.display_name }} API (V2.0)](https://developers.intercom.com/intercom-api-reference/v2.0/reference){:target="new"} -this-version: "1" # -------------------------- # # Stitch Details # # -------------------------- # -certified: true +certified: true historical: "1 year" frequency: "30 minutes" tier: "Standard" status-url: "https://status.intercom.io/" +api-type: "platform.intercom" + anchor-scheduling: true cron-scheduling: true @@ -63,8 +69,7 @@ setup-steps: - title: "add integration" - title: "historical sync" - title: "replication frequency" - - title: "track data" - - title: "Authorize Stitch to Access {{ integration.display_name }}" + - title: "Authorize Stitch to access {{ integration.display_name }}" anchor: "authorize-stitch" content: | Lastly, you'll be directed to {{ integration.display_name }}'s website to complete the setup. @@ -75,6 +80,9 @@ setup-steps: 4. After the authorization process successfully completes, you'll be redirected back to Stitch. 5. Click {{ app.buttons.finish-int-setup }}. + - title: "track data" + + # -------------------------- # # Integration Tables # # -------------------------- # From b723bbc6366b3781e1e380f3bf6d2ca68e96e61e Mon Sep 17 00:00:00 2001 From: Erin Cochran Date: Fri, 14 Aug 2020 13:48:06 -0400 Subject: [PATCH 11/11] Fix spacing --- _integration-schemas/intercom/v1/tags.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_integration-schemas/intercom/v1/tags.md b/_integration-schemas/intercom/v1/tags.md index 175101fea..b84dd1dc5 100644 --- a/_integration-schemas/intercom/v1/tags.md +++ b/_integration-schemas/intercom/v1/tags.md @@ -12,8 +12,8 @@ description: | replication-method: "Full Table" api-method: - name: "List all tags" - doc-link: "https://developers.intercom.com/intercom-api-reference/reference#list-tags-for-an-app" + name: "List all tags" + doc-link: "https://developers.intercom.com/intercom-api-reference/reference#list-tags-for-an-app" attributes: - name: "id"