TDL-24120 SurveyMonkey: add surveys stream

_changelog-files/2023/2023-10-03-surveymonkey-v2.md

@@ -0,0 +1,15 @@
+---
+title: "SurveyMonkey integration: New version (v2) now available!"
+content-type: "changelog-entry"
+date: 2023-10-03
+entry-type: new-feature
+entry-category: integration
+connection-id: surveymonkey
+connection-version: 2
+pull-request: "https://github.com/singer-io/tap-surveymonkey/pull/27"
+---
+{{ site.data.changelog.metadata.single-integration | flatify }}
+
+A new version (v{{ this-connection.this-version }}) of our {{ this-connection.display_name }} integration is now available!
+
+We've added a new `surveys` stream.

_data/taps/versions/surveymonkey.yml

@@ -11,9 +11,16 @@
 #   SURVEYMONKEY VERSIONS   #
 # ------------------------- #
 
-latest-version: "1"
+latest-version: "2"
 
 released-versions:
+  - number: "2"
+    status: "released" ## beta, released, deprecated
+    date-released: "October 3, 2023" # Full release: September 2, 2020
+    # date-last-connection:
+    deprecation-date: ""
+    sunset-date: ""
+
   - number: "1"
     status: "released" ## beta, released, deprecated
     date-released: "February 26, 2020" # Full release: September 2, 2020

_integration-schemas/surveymonkey/v2/foreign-keys.md

@@ -0,0 +1,34 @@
+---
+# -------------------------- #
+#     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: "surveymonkey"
+
+version: "2"
+
+foreign-keys:
+  - id: "response-id"
+    table: "responses"
+    attribute: "id"
+    all-foreign-keys:
+      - table: "responses"
+        join-on: "id"
+      - table: "simplified_responses"
+        join-on: "id"  
+
+  - id: "survey-id"
+    table: "survey_details"
+    attribute: "id"
+    all-foreign-keys:
+      - table: "survey_details"
+        join-on: "id"
+      - table: "responses"
+        join-on: "survey_id"
+      - table: "simplified_responses"
+        join-on: "survey_id"  
+---

_integration-schemas/surveymonkey/v2/responses.md

@@ -0,0 +1,154 @@
+---
+tap: "surveymonkey"
+version: "2"
+key: ""
+
+name: "responses"
+doc-link: "https://developer.surveymonkey.com/api/v3/"
+singer-schema: "https://github.com/singer-io/tap-surveymonkey/blob/master/tap_surveymonkey/schemas/responses.json"
+description: "This table contains information about your survey responses."
+
+replication-method: "Key-based Incremental"
+
+api-method:
+    name: "GET Survey Responses"
+    doc-link: "https://developer.surveymonkey.com/api/v3/#collectors-id-responses-id-details"
+
+attributes:
+  - name: "id"
+    type: "string"
+    primary-key: true
+    description: "The response ID."
+    foreign-key-id: "response-id"
+
+  - name: "date_modified"
+    type: "date-time"
+    description: "The date the response was last modified."
+    replication-key: true
+
+  - name: "analyze_url"
+    type: "string"
+    description: "The weblink to the analyze page to view the response."
+
+  - name: "collection_mode"
+    type: "string"
+    description: |
+      The collection mode of the response: `default`, `preview`, `data_entry`, `survey_preview`, or `edit`.
+
+  - name: "collector_id"
+    type: "string"
+    description: "The ID of the collector the response was taken for."
+
+  - name: "custom_value"
+    type: "string"
+    description: "The custom value associated with a response."
+
+  - name: "custom_variables"
+    type: "object"
+    description: "The values to any available custom variables in the survey."
+    subattributes:
+
+  - name: "date_created"
+    type: "date-time"
+    description: "The date the response was created."
+
+  - name: "edit_url"
+    type: "string"
+    description: "The weblink to the survey taking page to edit the response."
+
+  - name: "email_address"
+    type: "string"
+    description: "The email address of the responder."  
+
+  - name: "first_name"
+    type: "string"
+    description: "The first name of the responder."  
+
+  - name: "href"
+    type: "string"
+    description: "The **Resource API** URL."
+
+  - name: "ip_address"
+    type: "string"
+    description: "The IP Address the response was taken from."
+
+  - name: "last_name"
+    type: "string"
+    description: "The last name of the responder."  
+
+  - name: "logic_path"
+    type: "object"
+    description: "The logic path taken during the survey."
+    subattributes:
+
+  - name: "metadata"
+    type: "object"
+    description: "Other associated metadata or custom values."
+    subattributes:
+
+  - name: "page_path"
+    type: "array"
+    description: "The order in which the pages were responded to."
+    subattributes:
+      - name: "value"
+        type: "string"
+        description: ""
+
+  - name: "pages"
+    type: "array"
+    description: "Pages from the survey and their associated responses."
+    subattributes:
+      - name: "id"
+        type: "string"
+        description: "The ID of the page with responses."
+      - name: "questions"
+        type: "array"
+        description: "The questions on that page with responses."
+        subattributes:
+          - name: "answers"
+            type: "array"
+            description: "The answers for the question with responses."
+            subattributes:
+              - name: "choice_id"
+                type: "string"
+                description: "The choice selected."
+              - name: "col_id"
+                type: "string"
+                description: "The column selected."
+              - name: "image"
+                type: "string"
+                description: ""
+              - name: "other_id"
+                type: "string"
+                description: "The other text choice selected."
+              - name: "row_id"
+                type: "string"
+                description: "The row selected."
+              - name: "text"
+                type: "string"
+                description: "Any open ended text."
+          - name: "id"
+            type: "string"
+            description: "ID of the question with responses."
+          - name: "variable_id"
+            type: "string"
+            description: "ID of the random assignment variable for the question."
+
+  - name: "recipient_id"
+    type: "string"
+    description: "The ID of the recipient."
+
+  - name: "response_status"
+    type: "string"
+    description: |
+      The status of the response: `completed`, `partial`, `overquota`, or `disqualified`.
+
+  - name: "survey_id"
+    type: "string"
+    description: "ID of the survey the response was taken for."
+    foreign-key-id: "survey-id"
+
+  - name: "total_time"
+    type: "integer"
+    description: "Total time in seconds spent on the survey."
+---

_integration-schemas/surveymonkey/v2/simplified_responses.md

@@ -0,0 +1,161 @@
+---
+tap: "surveymonkey"
+version: "2"
+key: ""
+
+name: "simplified_responses"
+doc-link: "https://developer.surveymonkey.com/api/v3/"
+singer-schema: "https://github.com/singer-io/tap-surveymonkey/blob/master/tap_surveymonkey/schemas/simplified_responses.json"
+description: "This table contains a simplified version of information about your survey responses."
+
+replication-method: "Key-based Incremental"
+
+api-method:
+    name: "GET Response"
+    doc-link: "https://developer.surveymonkey.com/api/v3/#collectors-id-responses-id-details"
+
+attributes:
+  - name: "id"
+    type: "string"
+    primary-key: true
+    description: "The response ID."
+    foreign-key-id: "response-id"
+
+  - name: "date_modified"
+    type: "date-time"
+    description: "The date the response was last modified."
+    replication-key: true
+
+  - name: "analyze_url"
+    type: "string"
+    description: "The weblink to the analyze page to view the response."
+
+  - name: "collection_mode"
+    type: "string"
+    description: |
+      The collection mode of the response: `default`, `preview`, `data_entry`, `survey_preview`, or `edit`.
+
+  - name: "collector_id"
+    type: "string"
+    description: "The ID of the collector the response was taken for."
+
+  - name: "custom_value"
+    type: "string"
+    description: "The custom value associated with a response."
+
+  - name: "custom_variables"
+    type: "object"
+    description: "The values to any available custom variables in the survey."
+    subattributes:
+
+  - name: "date_created"
+    type: "date-time"
+    description: "The date the response was created."
+
+  - name: "edit_url"
+    type: "string"
+    description: "The weblink to the survey taking page to edit the response."
+
+  - name: "href"
+    type: "string"
+    description: "The **Resource API** URL."
+
+  - name: "ip_address"
+    type: "string"
+    description: "The IP Address the response was taken from."
+
+  - name: "logic_path"
+    type: "object"
+    description: "The logic path taken during the survey."
+    subattributes:
+
+  - name: "metadata"
+    type: "object"
+    description: "Other associated metadata or custom values."
+    subattributes:
+
+  - name: "page_path"
+    type: "array"
+    description: "The order in which the pages were responded to."
+    subattributes:
+      - name: "value"
+        type: "string"
+        description: ""
+
+  - name: "pages"
+    type: "array"
+    description: "Pages from the survey and their associated responses."
+    subattributes:
+      - name: "id"
+        type: "string"
+        description: "The ID of the page with responses."
+      - name: "questions"
+        type: "array"
+        description: "The questions on that page with responses."
+        subattributes:
+          - name: "answers"
+            type: "array"
+            description: "The answers for the question with responses."
+            subattributes:
+              - name: "choice_id"
+                type: "string"
+                description: "The choice selected."
+              - name: "col_id"
+                type: "string"
+                description: "The column selected."
+              - name: "image"
+                type: "string"
+                description: ""
+              - name: "other_id"
+                type: "string"
+                description: "The other text choice selected."
+              - name: "row_id"
+                type: "string"
+                description: "The row selected."
+              - name: "simple_text"
+                type: "string"
+                description: ""
+              - name: "tag_data"
+                type: "array"
+                description: ""
+                subattributes:
+                  - name: "value"
+                    type: "string"
+                    description: ""
+              - name: "text"
+                type: "string"
+                description: "Any open ended text."
+          - name: "family"
+            type: "string"
+            description: "The question family."
+          - name: "heading"
+            type: "string"
+            description: "The question heading."
+          - name: "id"
+            type: "string"
+            description: "ID of the question with responses."
+          - name: "subtype"
+            type: "string"
+            description: "The question family's subtype."
+          - name: "variable_id"
+            type: "string"
+            description: "ID of the random assignment variable for the question."
+
+  - name: "recipient_id"
+    type: "string"
+    description: "The ID of the recipient."
+
+  - name: "response_status"
+    type: "string"
+    description: |
+      The status of the response: `completed`, `partial`, `overquota`, or `disqualified`.
+
+  - name: "survey_id"
+    type: "string"
+    description: "ID of the survey the response was taken for."
+    foreign-key-id: "survey-id"
+
+  - name: "total_time"
+    type: "integer"
+    description: "Total time in seconds spent on the survey."
+---