diff --git a/_data/taps/versions/kustomer.yml b/_data/taps/versions/kustomer.yml new file mode 100644 index 000000000..8f610f2e5 --- /dev/null +++ b/_data/taps/versions/kustomer.yml @@ -0,0 +1,22 @@ +# -------------------------- # +# USING THIS TEMPLATE # +# -------------------------- # + +## NEED HELP USING THIS TEMPLATE? SEE: +## https://docs-about-stitch-docs.netlify.com/reference/integration-templates/integration-versions/ +## FOR INSTRUCTIONS & REFERENCE INFO + + +# -------------------------- # +# KUSTOMER VERSIONS # +# -------------------------- # + +latest-version: "1" + +released-versions: + - number: "1" + status: "beta" ## beta, released, deprecated + date-released: "March 26, 2020" + # date-last-connection: + deprecation-date: "" + sunset-date: "" \ No newline at end of file diff --git a/_developer-files/connect/api/objects/form-properties/sources/saas/kustomer-object.md b/_developer-files/connect/api/objects/form-properties/sources/saas/kustomer-object.md new file mode 100644 index 000000000..8c937f183 --- /dev/null +++ b/_developer-files/connect/api/objects/form-properties/sources/saas/kustomer-object.md @@ -0,0 +1,62 @@ +--- +# -------------------------- # +# USING THIS TEMPLATE # +# -------------------------- # + +## NEED HELP USING THIS TEMPLATE? SEE: +## https://docs-about-stitch-docs.netlify.com/reference/connect-templates/destination-form-property/ +## FOR INSTRUCTIONS & REFERENCE INFO + + +# -------------------------- # +# CONTENT TYPE # +# -------------------------- # + +product-type: "connect" +content-type: "api-form" +form-type: "source" +key: "source-form-properties-kustomer-object" + + +# -------------------------- # +# OBJECT INFO # +# -------------------------- # + +title: "Kustomer Source Form Property" +api-type: "platform.kustomer" +display-name: "Kustomer" + +source-type: "saas" +docs-name: "kustomer" # This should be whatever integration.name is. Ex: LinkedIn Ads is linkedin-ads + +# -------------------------- # +# 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: "api_token" + type: "string" + required: true + description: | + Your {{ form-propery.display-name }} API key. Refer to the [{{ form-property.display-name }} documentation]({{ doc-link | append: "#obtain-api-key" }}) for instructions on obtaining this. + value: "" + + - name: "date_window_size" + type: "string" + required: false + description: "This is an internal field for Stitch use." + value: "" + + - name: "page_size_limit" + type: "string" + required: false + description: "This is an internal field for Stitch use." + value: "" +--- \ No newline at end of file diff --git a/_integration-schemas/kustomer/v1/conversations.md b/_integration-schemas/kustomer/v1/conversations.md new file mode 100644 index 000000000..2827a786e --- /dev/null +++ b/_integration-schemas/kustomer/v1/conversations.md @@ -0,0 +1,808 @@ +--- +tap: "kustomer" +version: "1" +key: "conversations" + +name: "conversations" +doc-link: "https://dev.kustomer.com/v1/conversations/" +singer-schema: "https://github.com/singer-io/tap-kustomer/blob/master/tap_kustomer/schemas/conversations.json" +description: | + The `{{ table.name }}` table contains information about conversations in the {{ integration.display_name }} app. + +replication-method: "Key-based Incremental" + +api-method: + name: "getConversations" + doc-link: "https://dev.kustomer.com/v1/conversations/get-conversations" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The conversation ID." + #foreign-key-id: "conversation-id" + + - name: "updated_at" + type: "string" + replication-key: true + description: "" + + - name: "assigned_teams" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + + - name: "assigned_users" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + + - name: "channels" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + + - name: "created_at" + type: "string" + description: "" + - name: "created_by" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "custom" + type: "object" + description: "" + subattributes: + - name: "auto_response_at" + type: "string" + description: "" + - name: "brand_str" + type: "string" + description: "" + - name: "case_id_str" + type: "string" + description: "" + - name: "close_out_tree" + type: "string" + description: "" + - name: "contact_reason_tree" + type: "string" + description: "" + - name: "desk_ticket_url" + type: "string" + description: "" + - name: "new_primary_menu_str" + type: "string" + description: "" + - name: "refund_status_str" + type: "string" + description: "" + - name: "return_requested_str" + type: "string" + description: "" + - name: "return_str" + type: "string" + description: "" + - name: "rma_id_str" + type: "string" + description: "" + - name: "serial_number_str" + type: "string" + description: "" + - name: "yale_call_reason_tree" + type: "string" + description: "" + - name: "yale_connectivity_str" + type: "string" + description: "" + - name: "yale_finish_str" + type: "string" + description: "" + - name: "yale_model_str" + type: "string" + description: "" + - name: "yale_notes_txt" + type: "string" + description: "" + - name: "yale_resolution_str" + type: "string" + description: "" + - name: "yale_serial_number_str" + type: "string" + description: "" + - name: "customer" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "direction" + type: "string" + description: "" + - name: "done_count" + type: "integer" + description: "" + - name: "ended" + type: "boolean" + description: "" + - name: "ended_at" + type: "string" + description: "" + - name: "ended_by" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "ended_by_type" + type: "string" + description: "" + - name: "ended_reason" + type: "string" + description: "" + - name: "external_id" + type: "string" + description: "" + - name: "first_done" + type: "object" + description: "" + subattributes: + - name: "assigned_teams" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "assigned_users" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "business_time" + type: "integer" + description: "" + - name: "created_at" + type: "string" + description: "" + - name: "created_by" + type: "string" + description: "" + - name: "created_by_teams" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "last_message_direction" + type: "string" + description: "" + - name: "last_message_direction_type" + type: "string" + description: "" + - name: "message_count" + type: "integer" + description: "" + - name: "message_count_by_channel" + type: "object" + description: "" + subattributes: + - name: "email" + type: "integer" + description: "" + - name: "sms" + type: "integer" + description: "" + - name: "voice" + type: "integer" + description: "" + - name: "note_count" + type: "integer" + description: "" + - name: "outbound_message_count" + type: "integer" + description: "" + - name: "outbound_message_count_by_channel" + type: "object" + description: "" + subattributes: + - name: "email" + type: "integer" + description: "" + - name: "sms" + type: "integer" + description: "" + - name: "voice" + type: "integer" + description: "" + - name: "time" + type: "integer" + description: "" + - name: "first_message_in" + type: "object" + description: "" + subattributes: + - name: "channel" + type: "string" + description: "" + - name: "created_at" + type: "string" + description: "" + - name: "direction_type" + type: "string" + description: "" + - name: "id" + type: "string" + description: "" + - name: "sent_at" + type: "string" + description: "" + - name: "first_message_out" + type: "object" + description: "" + subattributes: + - name: "channel" + type: "string" + description: "" + - name: "created_at" + type: "string" + description: "" + - name: "created_by" + type: "string" + description: "" + - name: "created_by_teams" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "direction_type" + type: "string" + description: "" + - name: "id" + type: "string" + description: "" + - name: "sent_at" + type: "string" + description: "" + - name: "first_response" + type: "object" + description: "" + subattributes: + - name: "assigned_teams" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "assigned_users" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "business_time" + type: "integer" + description: "" + - name: "created_at" + type: "string" + description: "" + - name: "created_by" + type: "string" + description: "" + - name: "created_by_teams" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "id" + type: "string" + description: "" + - name: "response_time" + type: "integer" + description: "" + - name: "sent_at" + type: "string" + description: "" + - name: "time" + type: "integer" + description: "" + - name: "first_response_since_last_done" + type: "object" + description: "" + subattributes: + - name: "assigned_teams" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "assigned_users" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "business_time" + type: "integer" + description: "" + - name: "created_at" + type: "string" + description: "" + - name: "created_by" + type: "string" + description: "" + - name: "created_by_teams" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "id" + type: "string" + description: "" + - name: "response_time" + type: "integer" + description: "" + - name: "sent_at" + type: "string" + description: "" + - name: "time" + type: "integer" + description: "" + + - name: "imported_at" + type: "string" + description: "" + - name: "last_activity_at" + type: "string" + description: "" + - name: "last_done" + type: "object" + description: "" + subattributes: + - name: "assigned_teams" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "assigned_users" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "business_time" + type: "integer" + description: "" + - name: "created_at" + type: "string" + description: "" + - name: "created_by" + type: "string" + description: "" + - name: "created_by_teams" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "last_message_direction" + type: "string" + description: "" + - name: "last_message_direction_type" + type: "string" + description: "" + - name: "message_count" + type: "integer" + description: "" + - name: "message_count_by_channel" + type: "object" + description: "" + subattributes: + - name: "email" + type: "integer" + description: "" + - name: "sms" + type: "integer" + description: "" + - name: "voice" + type: "integer" + description: "" + - name: "note_count" + type: "integer" + description: "" + - name: "outbound_message_count" + type: "integer" + description: "" + - name: "outbound_message_count_by_channel" + type: "object" + description: "" + subattributes: + - name: "email" + type: "integer" + description: "" + - name: "sms" + type: "integer" + description: "" + - name: "voice" + type: "integer" + description: "" + - name: "time" + type: "integer" + description: "" + - name: "last_message_at" + type: "string" + description: "" + - name: "last_message_direction" + type: "string" + description: "" + - name: "last_message_in" + type: "object" + description: "" + subattributes: + - name: "created_at" + type: "string" + description: "" + - name: "id" + type: "string" + description: "" + - name: "sent_at" + type: "string" + description: "" + - name: "last_message_out" + type: "object" + description: "" + subattributes: + - name: "created_at" + type: "string" + description: "" + - name: "id" + type: "string" + description: "" + - name: "sent_at" + type: "string" + description: "" + - name: "last_message_unresponded_to" + type: "object" + description: "" + subattributes: + - name: "created_at" + type: "string" + description: "" + - name: "id" + type: "string" + description: "" + - name: "sent_at" + type: "string" + description: "" + - name: "last_message_unresponded_to_since_last_done" + type: "object" + description: "" + subattributes: + - name: "created_at" + type: "string" + description: "" + - name: "id" + type: "string" + description: "" + - name: "sent_at" + type: "string" + description: "" + - name: "last_received_at" + type: "string" + description: "" + - name: "last_response" + type: "object" + description: "" + subattributes: + - name: "assigned_teams" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "assigned_users" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "business_time" + type: "integer" + description: "" + - name: "created_at" + type: "string" + description: "" + - name: "created_by" + type: "string" + description: "" + - name: "created_by_teams" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "id" + type: "string" + description: "" + - name: "time" + type: "integer" + description: "" + - name: "links" + type: "object" + description: "" + subattributes: + - name: "self" + type: "string" + description: "" + - name: "merged_target" + type: "boolean" + description: "" + - name: "message_count" + type: "integer" + description: "" + - name: "modified_at" + type: "string" + description: "" + - name: "modified_by" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "name" + type: "string" + description: "" + - name: "note_count" + type: "integer" + description: "" + - name: "org" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "outbound_message_count" + type: "integer" + description: "" + - name: "preview" + type: "string" + description: "" + - name: "priority" + type: "integer" + description: "" + - name: "queue" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "reopen_count" + type: "integer" + description: "" + - name: "rev" + type: "integer" + description: "" + - name: "role_group_versions" + type: "string" + description: "" + - name: "satisfaction" + type: "string" + description: "" + - name: "satisfaction_level" + type: "object" + description: "" + subattributes: + - name: "sent_by_teams" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "sla" + type: "object" + description: "" + subattributes: + - name: "breach" + type: "object" + description: "" + subattributes: + - name: "at" + type: "string" + description: "" + - name: "metric" + type: "string" + description: "" + - name: "breached" + type: "boolean" + description: "" + - name: "matched_at" + type: "string" + description: "" + - name: "metrics" + type: "object" + description: "" + subattributes: + - name: "first_response" + type: "object" + description: "" + subattributes: + - name: "breach_at" + type: "string" + description: "" + - name: "satisfied_at" + type: "string" + description: "" + - name: "longest_unresponded_message" + type: "object" + description: "" + subattributes: + - name: "breach_at" + type: "string" + description: "" + - name: "satisfied_at" + type: "string" + description: "" + - name: "status" + type: "string" + description: "" + - name: "summary" + type: "object" + description: "" + subattributes: + - name: "first_breach_at" + type: "string" + description: "" + - name: "satisfied_at" + type: "string" + description: "" + - name: "version" + type: "integer" + description: "" + - name: "sla_data" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "sla_version" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "snooze" + type: "object" + description: "" + subattributes: + - name: "status" + type: "string" + description: "" + - name: "status_at" + type: "string" + description: "" + - name: "time" + type: "string" + description: "" + - name: "snooze_count" + type: "integer" + description: "" + - name: "status" + type: "string" + description: "" + - name: "suggested_shortcuts" + type: "string" + description: "" + - name: "suggested_tags" + type: "string" + description: "" + - name: "tags" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "total_done" + type: "object" + description: "" + subattributes: + - name: "business_time" + type: "integer" + description: "" + - name: "time" + type: "integer" + description: "" + - name: "total_open" + type: "object" + description: "" + subattributes: + - name: "business_time" + type: "integer" + description: "" + - name: "business_time_since_last_done" + type: "integer" + description: "" + - name: "time" + type: "integer" + description: "" + - name: "time_since_last_done" + type: "integer" + description: "" + - name: "total_snooze" + type: "object" + description: "" + subattributes: + - name: "business_time" + type: "integer" + description: "" + - name: "time" + type: "integer" + description: "" + - name: "type" + type: "string" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/kustomer/v1/customers.md b/_integration-schemas/kustomer/v1/customers.md new file mode 100644 index 000000000..ead85847e --- /dev/null +++ b/_integration-schemas/kustomer/v1/customers.md @@ -0,0 +1,492 @@ +--- +tap: "kustomer" +version: "1" +key: "customers" + +name: "customers" +doc-link: "https://dev.kustomer.com/v1/customers/" +singer-schema: "https://github.com/singer-io/tap-kustomer/blob/master/tap_kustomer/schemas/customers.json" +description: | + The `{{ table.name }}` table contains information about customers in the {{ integration.display_name }} app. + +replication-method: "Key-based Incremental" + +api-method: + name: "getCustomers" + doc-link: "https://dev.kustomer.com/v1/customers/get-customers" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The customer ID." + #foreign-key-id: "customer-id" + + - name: "updated_at" + type: "string" + replication-key: true + description: "" + + - name: "active_users" + type: "string" + description: "" + - name: "avatar_url" + type: "string" + description: "" + - name: "birthday_at" + type: "string" + description: "" + - name: "conversation_counts" + type: "object" + description: "" + subattributes: + - name: "all" + type: "integer" + description: "" + - name: "done" + type: "integer" + description: "" + - name: "open" + type: "integer" + description: "" + - name: "snoozed" + type: "integer" + description: "" + - name: "created_at" + type: "string" + description: "" + - name: "created_by" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "custom" + type: "object" + description: "" + subattributes: + - name: "accepts_marketing_bool" + type: "boolean" + description: "" + - name: "activation_date_str" + type: "string" + description: "" + - name: "app_version_str" + type: "string" + description: "" + - name: "august_id_str" + type: "string" + description: "" + - name: "august_serial_number_str" + type: "string" + description: "" + - name: "bridge_date_installed_at" + type: "string" + description: "" + - name: "bridge_serial_number_str" + type: "string" + description: "" + - name: "connect_firmware_version_str" + type: "string" + description: "" + - name: "connect_serial_number_str" + type: "string" + description: "" + - name: "doorbell_date_installed_at" + type: "string" + description: "" + - name: "doorbell_firmware_version_str" + type: "string" + description: "" + - name: "doorbell_serial_str" + type: "string" + description: "" + - name: "firmware_version_str" + type: "string" + description: "" + - name: "keypad_firmware_version_str" + type: "string" + description: "" + - name: "keypad_installed_at" + type: "string" + description: "" + - name: "keypad_serial_str" + type: "string" + description: "" + - name: "last_autoresponse_at" + type: "string" + description: "" + - name: "last_order_id_num" + type: "integer" + description: "" + - name: "last_order_name_str" + type: "string" + description: "" + - name: "latest_csat_num" + type: "integer" + description: "" + - name: "latest_nps_num" + type: "integer" + description: "" + - name: "lock_date_installed_at" + type: "string" + description: "" + - name: "lock_firmware_version_str" + type: "string" + description: "" + - name: "lock_serial_number_str" + type: "string" + description: "" + - name: "orders_count_num" + type: "integer" + description: "" + - name: "os00_str" + type: "string" + description: "" + - name: "owner_guest_str" + type: "string" + description: "" + - name: "products_owned_str" + type: "string" + description: "" + - name: "proof_of_purchase_str" + type: "string" + description: "" + - name: "purchase_date_str" + type: "string" + description: "" + - name: "sales_force_id_str" + type: "string" + description: "" + - name: "total_spent_num" + type: "integer" + description: "" + - name: "deleted" + type: "string" + description: "" + - name: "display_color" + type: "string" + description: "" + - name: "display_icon" + type: "string" + description: "" + - name: "display_name" + type: "string" + description: "" + - name: "emails" + type: "array" + description: "" + subattributes: + - name: "email" + type: "string" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "verified" + type: "boolean" + description: "" + - name: "external_id" + type: "string" + description: "" + - name: "external_ids" + type: "array" + description: "" + subattributes: + - name: "type" + type: "string" + description: "" + + - name: "verified" + type: "boolean" + description: "" + - name: "facebook_ids" + type: "string" + description: "" + - name: "first_name" + type: "string" + description: "" + - name: "gender" + type: "string" + description: "" + + - name: "imported_at" + type: "date-time" + description: "" + - name: "instagram_ids" + type: "string" + description: "" + - name: "last_activity_at" + type: "date-time" + description: "" + - name: "last_conversation" + type: "object" + description: "" + subattributes: + - name: "channels" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "id" + type: "string" + description: "" + - name: "sentiment" + type: "object" + description: "" + subattributes: + - name: "confidence" + type: "number" + description: "" + - name: "polarity" + type: "integer" + description: "" + - name: "tags" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "last_customer_activity_at" + type: "string" + description: "" + - name: "last_message_at" + type: "string" + description: "" + - name: "last_message_in" + type: "object" + description: "" + subattributes: + - name: "channel" + type: "string" + description: "" + - name: "sent_at" + type: "string" + description: "" + - name: "sentiment" + type: "string" + description: "" + - name: "last_message_out" + type: "object" + description: "" + subattributes: + - name: "sent_at" + type: "string" + description: "" + - name: "last_message_unresponded_to" + type: "object" + description: "" + subattributes: + - name: "channel" + type: "string" + description: "" + - name: "sent_at" + type: "string" + description: "" + - name: "last_name" + type: "string" + description: "" + - name: "last_seen_at" + type: "string" + description: "" + - name: "links" + type: "object" + description: "" + subattributes: + - name: "self" + type: "string" + description: "" + - name: "locale" + type: "string" + description: "" + - name: "locations" + type: "string" + description: "" + - name: "modified_at" + type: "string" + description: "" + - name: "modified_by" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "name" + type: "string" + description: "" + - name: "org" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "phones" + type: "array" + description: "" + subattributes: + - name: "phone" + type: "string" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "verified" + type: "boolean" + description: "" + - name: "preview" + type: "object" + description: "" + subattributes: + - name: "channel" + type: "string" + description: "" + - name: "preview_at" + type: "string" + description: "" + - name: "subject" + type: "string" + description: "" + - name: "text" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "progressive_status" + type: "string" + description: "" + - name: "recent_items" + type: "array" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + + - name: "meta" + type: "object" + description: "" + subattributes: + - name: "klass_name" + type: + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "updated_at" + type: "string" + description: "" + - name: "recent_location" + type: "object" + description: "" + subattributes: + - name: "updated_at" + type: "string" + description: "" + - name: "rev" + type: "integer" + description: "" + - name: "role_group_versions" + type: "string" + description: "" + - name: "satisfaction_level" + type: "object" + description: "" + subattributes: + - name: "first_satisfaction" + type: "object" + description: "" + subattributes: + - name: "sent_by_teams" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "last_satisfaction" + type: "object" + description: "" + subattributes: + - name: "sent_by_teams" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "sentiment" + type: "object" + description: "" + subattributes: + - name: "confidence" + type: "number" + description: "" + - name: "polarity" + type: "integer" + description: "" + - name: "shared_emails" + type: "string" + description: "" + - name: "shared_external_ids" + type: "string" + description: "" + - name: "shared_phones" + type: "string" + description: "" + - name: "shared_socials" + type: "string" + description: "" + - name: "signed_up_at" + type: "string" + description: "" + - name: "smooch_ids" + type: "string" + description: "" + - name: "socials" + type: "string" + description: "" + - name: "tags" + type: "string" + description: "" + - name: "time_zone" + type: "string" + description: "" + + - name: "urls" + type: "string" + description: "" + - name: "username" + type: "string" + description: "" + - name: "verified" + type: "boolean" + description: "" + - name: "watchers" + type: "string" + description: "" + - name: "whatsapps" + type: "string" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/kustomer/v1/foreign-keys.md b/_integration-schemas/kustomer/v1/foreign-keys.md new file mode 100644 index 000000000..bbc8b7778 --- /dev/null +++ b/_integration-schemas/kustomer/v1/foreign-keys.md @@ -0,0 +1,77 @@ +--- +# -------------------------- # +# 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: "kustomer" + +version: "1" + +foreign-keys: + - id: "user-id" + table: "users" + attribute: "id" + all-foreign-keys: + - table: "users" + join-on: "id" + + - id: "team-id" + table: "teams" + attribute: "id" + all-foreign-keys: + - table: "teams" + join-on: "id" + + - id: "tag-id" + table: "tags" + attribute: "id" + all-foreign-keys: + - table: "tags" + join-on: "id" + + - id: "shortcut-id" + table: "shortcuts" + attribute: "id" + all-foreign-keys: + - table: "shortcuts" + join-on: "id" + + - id: "note-id" + table: "notes" + attribute: "id" + all-foreign-keys: + - table: "notes" + join-on: "id" + + - id: "kobject-id" + table: "kobjects" + attribute: "id" + all-foreign-keys: + - table: "kobjects" + join-on: "id" + + - id: "customer-id" + table: "customers" + attribute: "id" + all-foreign-keys: + - table: "customers" + join-on: "id" + + - id: "conversation-id" + table: "conversations" + attribute: "id" + all-foreign-keys: + - table: "conversations" + join-on: "id" + + - id: "message-id" + table: "messages" + attribute: "id" + all-foreign-keys: + - table: "messages" + join-on: "id" +--- \ No newline at end of file diff --git a/_integration-schemas/kustomer/v1/kobjects.md b/_integration-schemas/kustomer/v1/kobjects.md new file mode 100644 index 000000000..4bd8afc21 --- /dev/null +++ b/_integration-schemas/kustomer/v1/kobjects.md @@ -0,0 +1,140 @@ +--- +tap: "kustomer" +version: "1" + +name: "kobjects" +doc-link: "https://dev.kustomer.com/v1/klasses/" +singer-schema: "https://github.com/singer-io/tap-kustomer/blob/master/tap_kustomer/schemas/kobjects.json" +description: | + The `{{ table.name }}` table contains information about {{ integration.display_name }} objects in the {{ integration.display_name }} app. + +replication-method: "Key-based Incremental" + +api-method: + name: "getKObject" + doc-link: "https://dev.kustomer.com/v1/klasses/get-kobject" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The KObject ID." + #foreign-key-id: "kobject-id" + + - name: "updated_at" + type: "string" + description: "The date the object was last updated." + replication-key: true + + - name: "created_at" + type: "string" + description: "" + - name: "custom" + type: "object" + description: "" + subattributes: + - name: "billing_status_str" + type: "string" + description: "" + - name: "comment_txt" + type: "string" + description: "" + - name: "delighted_link_str" + type: "string" + description: "" + - name: "order_created_at" + type: "string" + description: "" + - name: "order_number_str" + type: "string" + description: "" + - name: "order_updated_at" + type: "string" + description: "" + - name: "purchase_amount_num" + type: "integer" + description: "" + - name: "score_num" + type: "integer" + description: "" + - name: "shipping_address_str" + type: "string" + description: "" + - name: "shipping_country_str" + type: "string" + description: "" + - name: "shipping_state_str" + type: "string" + description: "" + - name: "shipping_zip_str" + type: "string" + description: "" + - name: "skus_txt" + type: "string" + description: "" + - name: "special_instructions_str" + type: "string" + description: "" + - name: "tags_str" + type: "string" + description: "" + - name: "total_price_num" + type: "number" + description: "" + - name: "total_price_str" + type: "string" + description: "" + - name: "updated_at" + type: "string" + description: "" + - name: "customer" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "description" + type: "string" + description: "" + - name: "external_id" + type: "string" + description: "" + - name: "icon" + type: "string" + description: "" + + - name: "klass" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "links" + type: "object" + description: "" + subattributes: + - name: "self" + type: "string" + description: "" + - name: "org" + type: "object" + description: "" + subattributes: + - name: "type" + type: "string" + description: "" + - name: "title" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" +--- diff --git a/_integration-schemas/kustomer/v1/messages.md b/_integration-schemas/kustomer/v1/messages.md new file mode 100755 index 000000000..4f028b782 --- /dev/null +++ b/_integration-schemas/kustomer/v1/messages.md @@ -0,0 +1,154 @@ +--- +tap: "kustomer" +version: "1.0" + +name: "messages" +doc-link: "https://dev.kustomer.com/v1/messages/" +singer-schema: "https://github.com/singer-io/tap-kustomer/blob/master/tap_kustomer/schemas/messages.json" +description: | + The `{{ table.name }}` table contains information about messages in the {{ integration.display_name }} app. + +replication-method: "Key-based Incremental" + +api-method: + name: "getMessages" + doc-link: "https://dev.kustomer.com/v1/messages/get-message" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The message ID." + #foreign-key-id: "message-id" + + - name: "updated_at" + type: "string" + description: "The day the message was last updated." + replication-key: true + + - name: "created_at" + type: "string" + description: "" + - name: "custom" + type: "object" + description: "" + subattributes: + - name: "billing_status_str" + type: "string" + description: "" + - name: "comment_txt" + type: "string" + description: "" + - name: "delighted_link_str" + type: "string" + description: "" + - name: "order_created_at" + type: "string" + description: "" + - name: "order_number_str" + type: "string" + description: "" + - name: "order_updated_at" + type: "string" + description: "" + - name: "purchase_amount_num" + type: "integer" + description: "" + - name: "score_num" + type: "integer" + description: "" + - name: "shipping_address_str" + type: "string" + description: "" + - name: "shipping_country_str" + type: "string" + description: "" + - name: "shipping_state_str" + type: "string" + description: "" + - name: "shipping_zip_str" + type: "string" + description: "" + - name: "skus_txt" + type: "string" + description: "" + - name: "special_instructions_str" + type: "string" + description: "" + - name: "tags_str" + type: "string" + description: "" + - name: "total_price_num" + type: "number" + description: "" + - name: "total_price_str" + type: "string" + description: "" + - name: "updated_at" + type: "string" + description: "" + - name: "customer" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "description" + type: "string" + description: "" + - name: "external_id" + type: "string" + description: "" + - name: "icon" + type: "string" + description: "" + - name: "images" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "klass" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "links" + type: "object" + description: "" + subattributes: + - name: "self" + type: "string" + description: "" + - name: "org" + type: "object" + description: "" + subattributes: + - name: "type" + type: "string" + description: "" + - name: "tags" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "title" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + +--- diff --git a/_integration-schemas/kustomer/v1/notes.md b/_integration-schemas/kustomer/v1/notes.md new file mode 100644 index 000000000..7f1b6b07a --- /dev/null +++ b/_integration-schemas/kustomer/v1/notes.md @@ -0,0 +1,131 @@ +--- +tap: "kustomer" +version: "1" + +name: "notes" +doc-link: "https://dev.kustomer.com/v1/notes/" +singer-schema: "https://github.com/singer-io/tap-kustomer/blob/master/tap_kustomer/schemas/notes.json" +description: | + The `{{ table.name }}` table contains information about notes in the {{ integration.display_name }} app. + +replication-method: "Key-based Incremental" + +api-method: + name: "getNotes" + doc-link: "https://dev.kustomer.com/v1/notes/get-notes" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The note ID." + #foreign-key-id: "note-id" + + - name: "updated_at" + type: "date-time" + replication-key: true + description: "" + + - name: "body" + type: "string" + description: "" + - name: "conversation" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "created_at" + type: "date-time" + description: "" + - name: "created_by" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "customer" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "deleted" + type: "boolean" + description: "" + - name: "deleted_at" + type: "date-time" + description: "" + - name: "deleted_by" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "external_id" + type: "string" + description: "" + + - name: "imported_at" + type: "date-time" + description: "" + - name: "links" + type: "object" + description: "" + subattributes: + - name: "self" + type: "string" + description: "" + - name: "modified_at" + type: "date-time" + description: "" + - name: "modified_by" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "org" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "user_mentions" + type: "array" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/kustomer/v1/shortcuts.md b/_integration-schemas/kustomer/v1/shortcuts.md new file mode 100644 index 000000000..0e7ef85f7 --- /dev/null +++ b/_integration-schemas/kustomer/v1/shortcuts.md @@ -0,0 +1,270 @@ +--- +tap: "kustomer" +version: "1" + +name: "shortcuts" +doc-link: "https://dev.kustomer.com/v1/shortcuts" +singer-schema: "https://github.com/singer-io/tap-kustomer/blob/master/tap_kustomer/schemas/shortcuts.json" +description: | + The `{{ table.name }}` table contains information about shortcuts in the {{ integration.display_name }} app. + +replication-method: "Key-based Incremental" + +api-method: + name: "getShortcuts" + doc-link: "https://dev.kustomer.com/v1/shortcuts/KaRhy9CmfHsmaG4gZ" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The shortcut ID." + #foreign-key-id: "shortcut-id" + + - name: "updated_at" + type: "date-time" + description: "The time the shortcut was last updated." + replication-key: true + + - name: "conversation" + type: "object" + description: "" + subattributes: + - name: "name" + type: "object" + description: "" + subattributes: + - name: "operator" + type: "string" + description: "" + - name: "value" + type: "string" + description: "" + - name: "tags" + type: "object" + description: "" + subattributes: + - name: "operator" + type: "string" + description: "" + - name: "value" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + + - name: "created_at" + type: "date-time" + description: "" + + - name: "created_by" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + + - name: "deleted" + type: "boolean" + description: "" + + - name: "draft" + type: "object" + description: "" + subattributes: + - name: "text" + type: "string" + description: "" + + - name: "is_private" + type: "boolean" + description: "" + + - name: "links" + type: "object" + description: "" + subattributes: + - name: "self" + type: "string" + description: "" + + - name: "modified_at" + type: "string" + description: "" + + - name: "modified_by" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "org" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + + - name: "payload" + type: "object" + description: "" + subattributes: + - name: "text" + type: "object" + description: "" + subattributes: + - name: "blocks" + type: "array" + description: "" + subattributes: + - name: "data" + type: "object" + description: "" + subattributes: [ + ] + - name: "depth" + type: "integer" + description: "" + - name: "entity_ranges" + type: "array" + description: "" + subattributes: + - name: "key" + type: "integer" + description: "" + - name: "length" + type: "integer" + description: "" + - name: "offset" + type: "integer" + description: "" + - name: "inline_style_ranges" + type: "array" + description: "" + subattributes: + - name: "length" + type: "integer" + description: "" + - name: "offset" + type: "integer" + description: "" + - name: "style" + type: "string" + description: "" + - name: "key" + type: "string" + description: "" + - name: "text" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "entity_map" + type: "object" + description: "" + subattributes: + - name: "0" + type: "object" + description: "" + subattributes: + - name: "data" + type: "object" + description: "" + subattributes: + - name: "fallback_text" + type: "string" + description: "" + - name: "key" + type: "string" + description: "" + - name: "url" + type: "string" + description: "" + - name: "mutability" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "1" + type: "object" + description: "" + subattributes: + - name: "data" + type: "object" + description: "" + subattributes: + - name: "fallback_text" + type: "string" + description: "" + - name: "key" + type: "string" + description: "" + - name: "url" + type: "string" + description: "" + - name: "mutability" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "2" + type: "object" + description: "" + subattributes: + - name: "data" + type: "object" + description: "" + subattributes: + - name: "url" + type: "string" + description: "" + - name: "mutability" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "3" + type: "object" + description: "" + subattributes: + - name: "data" + type: "object" + description: "" + subattributes: + - name: "url" + type: "string" + description: "" + - name: "mutability" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + + - name: "type" + type: "string" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/kustomer/v1/tags.md b/_integration-schemas/kustomer/v1/tags.md new file mode 100644 index 000000000..85a5e3d55 --- /dev/null +++ b/_integration-schemas/kustomer/v1/tags.md @@ -0,0 +1,93 @@ +--- +tap: "kustomer" +version: "1" + +name: "tags" +doc-link: "https://dev.kustomer.com/v1/tags/" +singer-schema: "https://github.com/singer-io/tap-kustomer/blob/master/tap_kustomer/schemas/tags.json" +description: | + The `{{ table.name }}` table contains information about tags in the {{ integration.display_name }} app. + +replication-method: "Key-based Incremental" + +api-method: + name: "getTags" + doc-link: "https://dev.kustomer.com/v1/tags/NWydnz3xaPBWCePQp" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The tag ID." + #foreign-key-id: "tag-id" + + - name: "updated_at" + type: "date-time" + replication-key: true + description: "The last time the tag was updated." + + - name: "color" + type: "string" + description: "" + + - name: "created_at" + type: "date-time" + description: "" + + - name: "created_by" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + + - name: "deleted" + type: "boolean" + description: "" + + - name: "links" + type: "object" + description: "" + subattributes: + - name: "self" + type: "string" + description: "" + + - name: "modified_at" + type: "string" + description: "" + + - name: "modified_by" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "org" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + + - name: "type" + type: "string" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/kustomer/v1/teams.md b/_integration-schemas/kustomer/v1/teams.md new file mode 100644 index 000000000..b8df12991 --- /dev/null +++ b/_integration-schemas/kustomer/v1/teams.md @@ -0,0 +1,128 @@ +--- +tap: "kustomer" +version: "1" + +name: "teams" +doc-link: "https://dev.kustomer.com/v1/teams/" +singer-schema: "https://github.com/singer-io/tap-kustomer/blob/master/tap_kustomer/schemas/teams.json" +description: | + The `{{ table.name }}` table contains information about teams in the {{ integration.display_name }} app. + +replication-method: "Key-based Incremental" + +api-method: + name: "getTeams" + doc-link: "https://dev.kustomer.com/v1/teams/get-team" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The team ID." + #foreign-key-id: "team-id" + + - name: "updated_at" + type: "date-time" + description: "The time the team was last updated." + replication-key: true + + - name: "created_at" + type: "date-time" + description: "" + + - name: "created_by" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + + - name: "deleted" + type: "boolean" + description: "" + + - name: "deleted_at" + type: "string" + description: "" + + - name: "deleted_by" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + + - name: "display_name" + type: "string" + description: "" + + - name: "icon" + type: "string" + description: "" + + - name: "links" + type: "object" + description: "" + subattributes: + - name: "self" + type: "string" + description: "" + + - name: "members" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + + - name: "modified_at" + type: "string" + description: "" + + - name: "modified_by" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "org" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + + - name: "role_groups" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + + - name: "type" + type: "string" + description: "" +--- \ No newline at end of file diff --git a/_integration-schemas/kustomer/v1/users.md b/_integration-schemas/kustomer/v1/users.md new file mode 100644 index 000000000..18d715fbf --- /dev/null +++ b/_integration-schemas/kustomer/v1/users.md @@ -0,0 +1,151 @@ +--- +tap: "kustomer" +version: "1" + +name: "users" +doc-link: "https://dev.kustomer.com/v1/users/" +singer-schema: "https://github.com/singer-io/tap-kustomer/blob/master/tap_kustomer/schemas/users.json" +description: | + The `{{ table.name }}` table contains information about users in the {{ integration.display_name }} app. + +replication-method: "Key-based Incremental" + +api-method: + name: "getUsers" + doc-link: "https://dev.kustomer.com/v1/users/get-user" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The user ID." + #foreign-key-id: "user-id" + + - name: "updated_at" + type: "date-time" + replication-key: true + description: "The last time the user was updated." + + - name: "avatar_url" + type: "string" + description: "" + + - name: "created_at" + type: "date-time" + description: "" + + - name: "created_by" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + + - name: "deleted_at" + type: "string" + description: "" + + - name: "display_name" + type: "string" + description: "" + + - name: "email" + type: "string" + description: "" + + - name: "email_signature" + type: "string" + description: "" + + - name: "email_verified_at" + type: "string" + description: "" + + - name: "first_email_verified_at" + type: "string" + description: "" + + - name: "links" + type: "object" + description: "" + subattributes: + - name: "self" + type: "string" + description: "" + + - name: "mobile" + type: "string" + description: "" + + - name: "modified_at" + type: "string" + description: "" + + - name: "modified_by" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + + - name: "name" + type: "string" + description: "" + + - name: "org" + type: "object" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + + - name: "password" + type: "object" + description: "" + subattributes: + - name: "allow_new" + type: "boolean" + description: "" + - name: "force_new" + type: "boolean" + description: "" + - name: "updated_at" + type: "date-time" + description: "" + + - name: "role_groups" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + + - name: "roles" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + + - name: "type" + type: "string" + description: "" + + - name: "user_type" + type: "string" + description: "" +--- \ No newline at end of file diff --git a/_saas-integrations/kustomer/v1/kustomer-v1.md b/_saas-integrations/kustomer/v1/kustomer-v1.md new file mode 100644 index 000000000..e4092f17c --- /dev/null +++ b/_saas-integrations/kustomer/v1/kustomer-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: Kustomer +permalink: /integrations/saas/kustomer +keywords: kustomer, integration, schema, etl kustomer, kustomer etl, kustomer schema +layout: singer +# input: false + +key: "kustomer-setup" + + +# -------------------------- # +# Tap Details # +# -------------------------- # + +name: "kustomer" +display_name: "Kustomer" + +singer: true +status-url: "" + +tap-name: "Kustomer" +repo-url: https://github.com/singer-io/tap-kustomer + +this-version: "1" + +api: | + [Kustomer REST API v1](https://apidocs.kustomer.com/?version=latest){:target="new"} + + +# -------------------------- # +# Stitch Details # +# -------------------------- # + +certified: true + +historical: "1 year" +frequency: "1 hour" +tier: "Free" + +api-type: "platform.kustomer" + +anchor-scheduling: true +cron-scheduling: true + +extraction-logs: true +loading-reports: true + +table-selection: true +column-selection: true + +# attribution-window: "# days" +# attribution-is-configurable: + +# setup-name: "" + + +# -------------------------- # +# Feature Summary # +# -------------------------- # + +feature-summary: | + Stitch's {{ integration.display_name }} integration replicates data using the {{ integration.api | flatify | strip }}. Refer to the [Schema](#schema) section for a list of objects available for replication. + + +# -------------------------- # +# 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: | + **A {{ integration.display_name }} admin role**. Admin permissions or a role with **read** and **write** security permissions are required to create an API key in {{ integration.display_name }}. + +setup-steps: + - title: "Create a {{ integration.display_name }} API key" + anchor: "obtain-api-key" + content: | + 1. Login to your {{ integration.display_name }} account. + 2. Navigate to **Settings > API Keys** + 3. Click **New API Key**. + 4. Select the roles that can have access to the API key. + 5. **Leave the API expriation options blank.** If you set an expiration date, the API key will expire and break the connection to Stitch. In the event that this happens, you'll need to re-generate the API key in {{ integration.display_name }} and enter the new key into Stitch. + 6. Click **Create**. + 7. Copy the API key and keep it readily available for the next step. + + **Note**: {{ integration.display_name }} will only display the key once, so save it somewhere secure for future reference. + - title: "add integration" + content: | + 4. In the **API Key** field, paste the API key you obtained in [Step 1](#obtain-api-key). + - title: "historical sync" + - title: "replication frequency" + - title: "track data" + + +# -------------------------- # +# Integration Tables # +# -------------------------- # + +# Looking for the table schemas & info? +# Each table has a its own .md file in /_integration-schemas/kustomer/v1 +--- +{% assign integration = page %} +{% include misc/data-files.html %} \ No newline at end of file