diff --git a/airbyte-integrations/connectors/source-surveymonkey/metadata.yaml b/airbyte-integrations/connectors/source-surveymonkey/metadata.yaml index 007271ccde39dd..82900e195bfe0b 100644 --- a/airbyte-integrations/connectors/source-surveymonkey/metadata.yaml +++ b/airbyte-integrations/connectors/source-surveymonkey/metadata.yaml @@ -10,7 +10,7 @@ data: connectorSubtype: api connectorType: source definitionId: badc5925-0485-42be-8caa-b34096cb71b5 - dockerImageTag: 0.3.0 + dockerImageTag: 0.3.1 dockerRepository: airbyte/source-surveymonkey documentationUrl: https://docs.airbyte.com/integrations/sources/surveymonkey githubIssueLabel: source-surveymonkey diff --git a/airbyte-integrations/connectors/source-surveymonkey/poetry.lock b/airbyte-integrations/connectors/source-surveymonkey/poetry.lock index d5533600756458..fbba44a4dd5e39 100644 --- a/airbyte-integrations/connectors/source-surveymonkey/poetry.lock +++ b/airbyte-integrations/connectors/source-surveymonkey/poetry.lock @@ -1,14 +1,14 @@ -# This file is automatically @generated by Poetry 1.6.1 and should not be changed by hand. +# This file is automatically @generated by Poetry 1.7.1 and should not be changed by hand. [[package]] name = "airbyte-cdk" -version = "0.78.3" +version = "0.80.0" description = "A framework for writing Airbyte Connectors." optional = false python-versions = "<4.0,>=3.9" files = [ - {file = "airbyte_cdk-0.78.3-py3-none-any.whl", hash = "sha256:699d61ace9f8ca4477e06af3ff1bc56856e955a444081a1701c41d94629dcd74"}, - {file = "airbyte_cdk-0.78.3.tar.gz", hash = "sha256:192c2594d0e93140a7ec635fea3d4644318faada6aa986805752adf4caf9b126"}, + {file = "airbyte_cdk-0.80.0-py3-none-any.whl", hash = "sha256:060e92323a73674fa4e9e2e4a1eb312b9b9d072c9bbe5fa28f54ef21cb4974f3"}, + {file = "airbyte_cdk-0.80.0.tar.gz", hash = "sha256:1383512a83917fecca5b24cea4c72aa5c561cf96dd464485fbcefda48fe574c5"}, ] [package.dependencies] @@ -1223,4 +1223,4 @@ multidict = ">=4.0" [metadata] lock-version = "2.0" python-versions = "^3.9,<3.12" -content-hash = "600a97507b92d5147474e57857ec554ffbe7baea6eaba333ab6a44aecf6d8792" +content-hash = "e2a5eb9db06adf2519ae8c1062d3f48bb641817277b0cb3f732d396552470198" diff --git a/airbyte-integrations/connectors/source-surveymonkey/pyproject.toml b/airbyte-integrations/connectors/source-surveymonkey/pyproject.toml index 5977902f78a154..44bd2885ba89db 100644 --- a/airbyte-integrations/connectors/source-surveymonkey/pyproject.toml +++ b/airbyte-integrations/connectors/source-surveymonkey/pyproject.toml @@ -3,7 +3,7 @@ requires = [ "poetry-core>=1.0.0",] build-backend = "poetry.core.masonry.api" [tool.poetry] -version = "0.3.0" +version = "0.3.1" name = "source-surveymonkey" description = "Source implementation for Surveymonkey." authors = [ "Airbyte ",] @@ -17,7 +17,7 @@ include = "source_surveymonkey" [tool.poetry.dependencies] python = "^3.9,<3.12" -airbyte-cdk = "^0" +airbyte-cdk = "0.80.0" vcrpy = "==4.1.1" urllib3 = "==1.26.18" diff --git a/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/collectors.json b/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/collectors.json index 5726d61b54ea2a..e5675023709509 100644 --- a/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/collectors.json +++ b/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/collectors.json @@ -4,83 +4,108 @@ "additionalProperties": true, "properties": { "id": { + "description": "The unique identifier of the collector.", "type": ["string", "null"] }, "status": { + "description": "Current status of the collector (ex: open, closed).", "type": ["string", "null"] }, "survey_id": { + "description": "The unique identifier of the survey associated with the collector.", "type": ["string", "null"] }, "type": { + "description": "Type of collector.", "type": ["string", "null"] }, "name": { + "description": "The name or title of the collector.", "type": ["string", "null"] }, "thank_you_message": { + "description": "Message displayed after respondent completes the survey.", "type": ["string", "null"] }, "thank_you_page": { + "description": "Settings for the thank you page displayed post-survey submission.", "type": ["object", "null"], "additionalProperties": true, "properties": { "is_enabled": { + "description": "Indicates if the thank you page is enabled.", "type": ["boolean", "null"] }, "message": { + "description": "Custom message to be displayed on the thank you page.", "type": ["string", "null"] } } }, "disqualification_message": { + "description": "Message displayed if respondent is disqualified from survey.", "type": ["string", "null"] }, "disqualification_url": { + "description": "URL to redirect disqualified respondent to another page.", "type": ["string", "null"] }, "close_date": { + "description": "The date and time when the collector is set to close.", "type": ["string", "null"], "format": "date-time" }, "closed_page_message": { + "description": "Message displayed on the closed page of the collector.", "type": ["string", "null"] }, "redirect_url": { + "description": "URL for redirection after survey completion.", "type": ["string", "null"] }, "display_survey_results": { + "description": "Indicates whether respondents can view survey results.", "type": ["boolean", "null"] }, "edit_response_type": { + "description": "Type of editing available for responses.", "type": ["string", "null"] }, "anonymous_type": { + "description": "Specifies the anonymity type of the respondent (ex: ", "type": ["string", "null"] }, "allow_multiple_responses": { + "description": "Indicates whether multiple responses are allowed for this collector.", "type": ["boolean", "null"] }, "date_modified": { + "description": "The date and time when the collector was last modified.", "type": ["string", "null"], "format": "date-time" }, "sender_email": { + "description": "Email address used as the sender of collector notifications.", "type": ["string", "null"] }, "password_enabled": { + "description": "Indicates whether password protection is enabled for the collector.", "type": ["boolean", "null"] }, "response_limit": { + "description": "Limit on the number of responses allowed for the collector.", "type": ["number", "null"] }, "redirect_type": { + "description": "Type of redirect behavior after respondent submits the survey.", "type": ["string", "null"] }, "respondent_authentication": { + "description": "Authentication method required for respondents.", "type": ["boolean", "null"] }, "href": { + "description": "The unique URL of the collector.", "type": ["string", "null"] } } diff --git a/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/survey_collectors.json b/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/survey_collectors.json index ee17ce809fe8ec..35b25ba33f59ff 100644 --- a/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/survey_collectors.json +++ b/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/survey_collectors.json @@ -4,15 +4,19 @@ "additionalProperties": true, "properties": { "id": { + "description": "The unique identifier for the survey collector.", "type": ["string", "null"] }, "name": { + "description": "The name or title of the survey collector.", "type": ["string", "null"] }, "href": { + "description": "The URL to access the specific survey collector data.", "type": ["string", "null"] }, "survey_id": { + "description": "The unique identifier of the survey associated with the collector.", "type": ["string", "null"] } } diff --git a/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/survey_ids.json b/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/survey_ids.json index 4502c94c445d65..89b08f0df660b2 100644 --- a/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/survey_ids.json +++ b/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/survey_ids.json @@ -3,15 +3,19 @@ "type": "object", "properties": { "id": { + "description": "Unique identifier for the survey.", "type": ["string", "null"] }, "title": { + "description": "Title of the survey.", "type": ["string", "null"] }, "nickname": { + "description": "User-assigned nickname for the survey to easily identify it.", "type": ["string", "null"] }, "href": { + "description": "URL for fetching detailed information about the survey.", "type": ["string", "null"] } } diff --git a/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/survey_pages.json b/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/survey_pages.json index d1d370def75ede..e67854b65fdc68 100644 --- a/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/survey_pages.json +++ b/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/survey_pages.json @@ -3,21 +3,27 @@ "type": "object", "properties": { "title": { + "description": "Title or name of the survey page.", "type": ["string", "null"] }, "description": { + "description": "Description of the survey page.", "type": ["string", "null"] }, "position": { + "description": "Position of the survey page within the survey.", "type": ["integer", "null"] }, "question_count": { + "description": "Number of questions on the survey page.", "type": ["integer", "null"] }, "id": { + "description": "Unique identifier of the survey page.", "type": ["string", "null"] }, "href": { + "description": "The URL link to the survey page.", "type": ["string", "null"] } } diff --git a/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/survey_questions.json b/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/survey_questions.json index 149a1bd8dc9034..991836b37fb5d5 100644 --- a/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/survey_questions.json +++ b/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/survey_questions.json @@ -3,117 +3,152 @@ "type": "object", "properties": { "page_id": { + "description": "Identifier of the page the question belongs to", "type": ["string", "null"] }, "id": { + "description": "Unique identifier for the question", "type": ["string", "null"] }, "position": { + "description": "Position of the question within the survey", "type": ["integer", "null"] }, "visible": { + "description": "Indicates if the question is visible", "type": ["boolean", "null"] }, "family": { + "description": "Family to which the question belongs", "type": ["string", "null"] }, "subtype": { + "description": "Specific type of question", "type": ["string", "null"] }, "layout": { + "description": "Layout style of the question", "type": ["object", "null"] }, "sorting": { + "description": "Sorting options for the question", "type": ["object", "null"], "properties": { "ignore_last": { + "description": "Boolean to ignore the last option for sorting", "type": ["boolean", "null"] }, "type": { + "description": "Type of sorting", "type": ["string", "null"] } } }, "required": { + "description": "Indicates if the question is required", "type": ["object", "null"], "properties": { "amount": { + "description": "Number of required choices", "type": ["string", "null"] }, "text": { + "description": "Text specifying requirement", "type": ["string", "null"] }, "type": { + "description": "Type of requirement", "type": ["string", "null"] } } }, "validation": { + "description": "Validation rules for the question", "type": ["object", "null"], "properties": { "max": { + "description": "Maximum value for validation", "type": ["integer", "null"] }, "min": { + "description": "Minimum value for validation", "type": ["integer", "null"] }, "sum": { + "description": "Sum value for validation", "type": ["integer", "null"] }, "sum_text": { + "description": "Sum text for validation", "type": ["string", "null"] }, "text": { + "description": "Text validation message", "type": ["string", "null"] }, "type": { + "description": "Type of validation", "type": ["string", "null"] } } }, "forced_ranking": { + "description": "Indicates if the question uses forced ranking", "type": ["boolean", "null"] }, "headings": { + "description": "Array of headings for the question", "type": ["array", "null"], "items": { + "description": "Represents an individual heading", "type": ["object", "null"], "properties": { "heading": { + "description": "Text of the heading", "type": ["string", "null"] } } } }, "href": { + "description": "Hyperlink reference for the question", "type": ["string", "null"] }, "answers": { + "description": "Contains information about answer choices for the question", "type": ["object", "null"], "properties": { "choices": { + "description": "An array of answer choices for the question", "type": ["array", "null"], "items": { + "description": "Represents an individual answer choice", "type": ["object", "null"], "properties": { "position": { + "description": "Position of the answer choice in the list", "type": ["integer", "null"] }, "visible": { + "description": "Boolean indicating if the answer choice is visible", "type": ["boolean", "null"] }, "text": { + "description": "Text of the answer choice", "type": ["string", "null"] }, "quiz_options": { + "description": "Optional properties specific to quiz questions", "type": ["object", "null"], "properties": { "score": { + "description": "Score associated with the answer choice", "type": ["integer", "null"] } } }, "id": { + "description": "Unique identifier for the answer choice", "type": ["string", "null"] } } diff --git a/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/survey_responses.json b/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/survey_responses.json index b8d651d1d1b31e..87dca641ada03c 100644 --- a/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/survey_responses.json +++ b/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/survey_responses.json @@ -3,103 +3,132 @@ "type": "object", "properties": { "id": { + "description": "Unique identifier for the survey response", "type": ["string", "null"] }, "recipient_id": { + "description": "Unique identifier for the respondent", "type": ["string", "null"] }, "collection_mode": { + "description": "The mode in which the survey response was collected (e.g., Web, Email)", "type": ["string", "null"] }, "response_status": { + "description": "Status of the survey response (e.g., Completed, Incomplete)", "type": ["string", "null"] }, "custom_value": { + "description": "Custom value provided by the respondent during the survey", "type": ["string", "null"] }, "first_name": { + "description": "First name of the respondent", "type": ["string", "null"] }, "last_name": { + "description": "Last name of the respondent", "type": ["string", "null"] }, "email_address": { + "description": "Email address of the respondent", "type": ["string", "null"] }, "ip_address": { + "description": "IP address of the respondent", "type": ["string", "null"] }, "logic_path": { + "description": "Path taken through the survey based on logic and branching", "type": ["object", "null"] }, "metadata": { + "description": "Additional metadata associated with the survey response", "type": ["object", "null"], "properties": { "contact": { + "description": "Contact information related to the survey response", "type": ["object", "null"] } } }, "page_path": { + "description": "Path followed within the survey pages", "type": ["array", "null"], "items": { "type": ["string", "null"] } }, "collector_id": { + "description": "Unique identifier for the collector associated with the response", "type": ["string", "null"] }, "survey_id": { + "description": "Unique identifier for the survey associated with the response", "type": ["string", "null"] }, "custom_variables": { + "description": "Additional custom variables associated with the response", "type": ["object", "null"] }, "edit_url": { + "description": "URL to edit the survey response", "type": ["string", "null"] }, "analyze_url": { + "description": "URL to view analysis of survey responses", "type": ["string", "null"] }, "language": { + "description": "Language used by the respondent during the survey", "type": ["string", "null"] }, "total_time": { + "description": "Total time taken by the respondent to complete the survey", "type": ["integer", "null"] }, "date_modified": { + "description": "Date and time when the survey response was last modified", "type": ["string", "null"], "format": "date-time" }, "date_created": { + "description": "Date and time when the survey response was created", "type": ["string", "null"], "format": "date-time" }, "href": { + "description": "Hyperlink reference to the survey response", "type": ["string", "null"] }, "pages": { + "description": "List of pages within the survey", "type": ["array", "null"], "items": { "type": ["object", "null"], "properties": { "id": { + "description": "Unique identifier for the survey page", "type": ["string", "null"] }, "questions": { + "description": "List of questions within the survey page", "type": ["array", "null"], "items": { "type": ["object", "null"], "properties": { "id": { + "description": "Unique identifier for the survey question", "type": ["string", "null"] }, "answers": { + "description": "List of answers provided by the respondent for the question", "type": ["array", "null"], "items": { "type": ["object", "null"], "properties": { "choice_id": { + "description": "Identifier for the choice selected by the respondent", "type": ["string", "null"] } } diff --git a/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/surveys.json b/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/surveys.json index cbdf3a37c4625a..cbdc9e86d14e8d 100644 --- a/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/surveys.json +++ b/airbyte-integrations/connectors/source-surveymonkey/source_surveymonkey/schemas/surveys.json @@ -3,85 +3,111 @@ "type": "object", "properties": { "title": { + "description": "Title or name of the survey", "type": ["string", "null"] }, "nickname": { + "description": "Nickname or alias for the survey", "type": ["string", "null"] }, "language": { + "description": "Language in which the survey is conducted", "type": ["string", "null"] }, "theme_id": { + "description": "ID of the theme applied to the survey", "type": ["string", "null"] }, "folder_id": { + "description": "ID of the folder where the survey is stored", "type": ["string", "null"] }, "category": { + "description": "Category or topic of the survey", "type": ["string", "null"] }, "question_count": { + "description": "Total number of questions in the survey", "type": ["integer", "null"] }, "page_count": { + "description": "Number of pages in the survey", "type": ["integer", "null"] }, "response_count": { + "description": "Number of responses received for the survey", "type": ["integer", "null"] }, "date_created": { + "description": "Date and time when the survey was created", "type": ["string", "null"], "format": "date-time" }, "date_modified": { + "description": "Date and time when the survey was last modified", "type": ["string", "null"], "format": "date-time" }, "id": { + "description": "Unique identifier for the survey", "type": ["string", "null"] }, "buttons_text": { + "description": "Text displayed on buttons associated with the survey.", "type": ["object", "null"], "properties": { "next_button": { + "description": "Text for the 'Next' button", "type": ["string", "null"] }, "prev_button": { + "description": "Text for the 'Previous' button", "type": ["string", "null"] }, "done_button": { + "description": "Text for the 'Done' button", "type": ["string", "null"] }, "exit_button": { + "description": "Text for the 'Exit' button", "type": ["string", "null"] } } }, "is_owner": { + "description": "Flag indicating if the user is the owner of the survey", "type": ["boolean", "null"] }, "footer": { + "description": "Footer content for the survey", "type": ["boolean", "null"] }, "custom_variables": { + "description": "Custom variables associated with the survey", "type": ["object", "null"] }, "href": { + "description": "URL reference for the survey", "type": ["string", "null"] }, "analyze_url": { + "description": "URL for analyzing survey results", "type": ["string", "null"] }, "edit_url": { + "description": "URL for editing the survey", "type": ["string", "null"] }, "collect_url": { + "description": "URL for collecting survey responses", "type": ["string", "null"] }, "summary_url": { + "description": "URL for viewing the summary of survey results", "type": ["string", "null"] }, "preview": { + "description": "Preview content or link for the survey", "type": ["string", "null"] } } diff --git a/docs/integrations/sources/surveymonkey.md b/docs/integrations/sources/surveymonkey.md index e5909beac38339..2d3f2f180d72bd 100644 --- a/docs/integrations/sources/surveymonkey.md +++ b/docs/integrations/sources/surveymonkey.md @@ -67,6 +67,7 @@ To cover more data from this source we use caching. | Version | Date | Pull Request | Subject | |:--------|:-----------|:---------------------------------------------------------|:---------------------------------------------------------------------------------| +| 0.3.1 | 2024-04-24 | [36664](https://github.com/airbytehq/airbyte/pull/36664) | Schema descriptions and CDK 0.80.0 | | 0.3.0 | 2024-02-22 | [35561](https://github.com/airbytehq/airbyte/pull/35561) | Migrate connector to low-code | | 0.2.4 | 2024-02-12 | [35168](https://github.com/airbytehq/airbyte/pull/35168) | Manage dependencies with Poetry | | 0.2.3 | 2023-10-19 | [31599](https://github.com/airbytehq/airbyte/pull/31599) | Base image migration: remove Dockerfile and use the python-connector-base image |