[non-forked] Source Freshservice API: add stream for customer satisfa…

…ction survey responses endpoint (#25929) * Source Freshservice API: change field data type from integer to string to match API * Source Freshservice API: correct data types for phone number fields * Source Freshservice API: correct data types for phone number fields * add missing testing dependencies * remove unnecessary install * Source Freshservice: add stream for customer satisfaction survey responses * version bump * fix: linting * update integration test files with new stream * bump dockerfile, readme and metadata.yaml * fix dockerfile and broken cat schema file * Automated Change * Automated Change * fix dockerfile whitespace and add null to schema fields for csat stream * Automated Change * Update freshservice.md * Automated Change --------- Co-authored-by: Adam Roderick <aroder@gmail.com> Co-authored-by: Adam Roderick <23650+aroder@users.noreply.github.com> Co-authored-by: sajarin <sajarin@users.noreply.github.com> Co-authored-by: Marcos Marx <marcosmarxm@users.noreply.github.com>
airbytehq · May 19, 2023 · a3cd983 · a3cd983
1 parent dcec1b2
commit a3cd983
Show file tree

Hide file tree

Showing 13 changed files with 207 additions and 153 deletions.
diff --git a/airbyte-config-oss/init-oss/src/main/resources/seed/oss_registry.json b/airbyte-config-oss/init-oss/src/main/resources/seed/oss_registry.json
diff --git a/airbyte-integrations/connectors/source-freshservice/Dockerfile b/airbyte-integrations/connectors/source-freshservice/Dockerfile
@@ -12,5 +12,5 @@ RUN pip install .
 ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
 ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
 
-LABEL io.airbyte.version=1.0.0
+LABEL io.airbyte.version=1.1.0
 LABEL io.airbyte.name=airbyte/source-freshservice
diff --git a/airbyte-integrations/connectors/source-freshservice/acceptance-test-config.yml b/airbyte-integrations/connectors/source-freshservice/acceptance-test-config.yml
@@ -26,6 +26,7 @@ tests:
           "changes",
           "vendors",
           "purchase_orders",
+          "satisfaction_survey_responses",
         ]
   incremental:
     - config_path: "secrets/config.json"

diff --git a/...yte-integrations/connectors/source-freshservice/integration_tests/configured_catalog.json b/...yte-integrations/connectors/source-freshservice/integration_tests/configured_catalog.json
@@ -143,6 +143,18 @@
       },
       "sync_mode": "full_refresh",
       "destination_sync_mode": "overwrite"
+    },
+    {
+      "stream": {
+        "name": "satisfaction_survey_responses",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh"],
+        "source_defined_cursor": true,
+        "default_cursor_field": ["updated_at"],
+        "source_defined_primary_key": [["id"]]
+      },
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "overwrite"
     }
   ]
 }
diff --git a/airbyte-integrations/connectors/source-freshservice/metadata.yaml b/airbyte-integrations/connectors/source-freshservice/metadata.yaml
@@ -2,7 +2,7 @@ data:
   connectorSubtype: api
   connectorType: source
   definitionId: 9bb85338-ea95-4c93-b267-6be89125b267
-  dockerImageTag: 1.0.0
+  dockerImageTag: 1.1.0
   dockerRepository: airbyte/source-freshservice
   githubIssueLabel: source-freshservice
   icon: freshservice.svg

diff --git a/airbyte-integrations/connectors/source-freshservice/source_freshservice/schemas/agents.json b/airbyte-integrations/connectors/source-freshservice/source_freshservice/schemas/agents.json
@@ -57,6 +57,9 @@
     "scoreboard_level_id": {
       "type": ["null", "integer"]
     },
+    "scoreboard_points": {
+      "type": ["null", "integer"]
+    },
     "ticket_scope": {
       "type": ["null", "string"]
     },

diff --git a/...ectors/source-freshservice/source_freshservice/schemas/satisfaction_survey_responses.json b/...ectors/source-freshservice/source_freshservice/schemas/satisfaction_survey_responses.json
@@ -0,0 +1,57 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "additionalProperties": true,
+  "properties": {
+    "id": {
+      "type": ["null", "integer"]
+    },
+    "overall_rating": {
+      "type": ["null", "integer"]
+    },
+    "overall_rating_text": {
+      "type": ["null", "string"]
+    },
+    "primary_question": {
+      "type": ["null", "string"]
+    },
+    "questionnaire_responses": {
+      "type": ["null", "object"],
+      "items": {
+        "type": ["null", "object"],
+        "additionalProperties": true,
+        "properties": {
+          "question": {
+            "type": ["null", "object"],
+            "additionalProperties": true,
+            "properties": {
+              "question_text": {
+                "type": ["null", "string"]
+              }
+            }
+          },
+          "answers": {
+            "type": ["null", "array"],
+            "items": [
+              {
+                "type": ["null", "object"],
+                "additionalProperties": true,
+                "properties": {
+                  "answer_text": {
+                    "type": ["null", "string"]
+                  }
+                }
+              }
+            ]
+          }
+        }
+      }
+    },
+    "created_at": {
+      "type": ["null", "string"]
+    },
+    "updated_at": {
+      "type": ["null", "string"]
+    }
+  }
+}
diff --git a/airbyte-integrations/connectors/source-freshservice/source_freshservice/schemas/tickets.json b/airbyte-integrations/connectors/source-freshservice/source_freshservice/schemas/tickets.json
@@ -4,229 +4,118 @@
   "additionalProperties": true,
   "properties": {
     "attachments": {
-      "type": [
-        "null",
-        "array"
-      ]
+      "type": ["null", "array"]
     },
     "cc_emails": {
-      "type": [
-        "null",
-        "array"
-      ]
+      "type": ["null", "array"]
     },
     "department_id": {
-      "type": [
-        "null",
-        "integer"
-      ]
+      "type": ["null", "integer"]
     },
     "custom_fields": {
-      "type": [
-        "null",
-        "object"
-      ]
+      "type": ["null", "object"]
     },
     "deleted": {
-      "type": [
-        "null",
-        "boolean"
-      ]
+      "type": ["null", "boolean"]
     },
     "description": {
-      "type": [
-        "null",
-        "string"
-      ]
+      "type": ["null", "string"]
     },
     "description_text": {
-      "type": [
-        "null",
-        "string"
-      ]
+      "type": ["null", "string"]
     },
     "due_by": {
-      "type": [
-        "null",
-        "string"
-      ]
+      "type": ["null", "string"]
     },
     "email": {
-      "type": [
-        "null",
-        "string"
-      ]
+      "type": ["null", "string"]
     },
     "email_config_id": {
-      "type": [
-        "null",
-        "integer"
-      ]
+      "type": ["null", "integer"]
     },
     "fr_due_by": {
-      "type": [
-        "null",
-        "string"
-      ]
+      "type": ["null", "string"]
     },
     "fr_escalated": {
-      "type": [
-        "null",
-        "boolean"
-      ]
+      "type": ["null", "boolean"]
     },
     "fwd_emails": {
-      "type": [
-        "null",
-        "array"
-      ]
+      "type": ["null", "array"]
     },
     "group_id": {
-      "type": [
-        "null",
-        "integer"
-      ]
+      "type": ["null", "integer"]
     },
     "id": {
       "type": "integer"
     },
     "is_escalated": {
-      "type": [
-        "null",
-        "boolean"
-      ]
+      "type": ["null", "boolean"]
     },
     "name": {
-      "type": [
-        "null",
-        "string"
-      ]
+      "type": ["null", "string"]
     },
     "phone": {
-      "type": [
-        "null",
-        "string"
-      ]
+      "type": ["null", "string"]
     },
     "priority": {
-      "type": [
-        "null",
-        "integer"
-      ]
+      "type": ["null", "integer"]
     },
     "category": {
-      "type": [
-        "null",
-        "string"
-      ]
+      "type": ["null", "string"]
     },
     "sub_category": {
-      "type": [
-        "null",
-        "string"
-      ]
+      "type": ["null", "string"]
     },
     "item_category": {
-      "type": [
-        "null",
-        "string"
-      ]
+      "type": ["null", "string"]
     },
     "reply_cc_emails": {
-      "type": [
-        "null",
-        "array"
-      ]
+      "type": ["null", "array"]
     },
     "requester_id": {
-      "type": [
-        "null",
-        "integer"
-      ]
+      "type": ["null", "integer"]
     },
     "responder_id": {
-      "type": [
-        "null",
-        "integer"
-      ]
+      "type": ["null", "integer"]
     },
     "source": {
-      "type": [
-        "null",
-        "integer"
-      ]
+      "type": ["null", "integer"]
     },
     "spam": {
-      "type": [
-        "null",
-        "boolean"
-      ]
+      "type": ["null", "boolean"]
     },
     "status": {
-      "type": [
-        "null",
-        "integer"
-      ]
+      "type": ["null", "integer"]
     },
     "subject": {
-      "type": [
-        "null",
-        "string"
-      ]
+      "type": ["null", "string"]
     },
     "tags": {
-      "type": [
-        "null",
-        "array"
-      ]
+      "type": ["null", "array"]
     },
     "to_emails": {
-      "type": [
-        "null",
-        "array"
-      ]
+      "type": ["null", "array"]
     },
     "type": {
-      "type": [
-        "null",
-        "string"
-      ]
+      "type": ["null", "string"]
     },
     "created_at": {
-      "type": [
-        "null",
-        "string"
-      ]
+      "type": ["null", "string"]
     },
     "updated_at": {
-      "type": [
-        "null",
-        "string"
-      ]
+      "type": ["null", "string"]
     },
     "urgency": {
-      "type": [
-        "null",
-        "integer"
-      ]
+      "type": ["null", "integer"]
     },
     "impact": {
-      "type": [
-        "null",
-        "integer"
-      ]
+      "type": ["null", "integer"]
     },
     "workspace_id": {
-      "type": [
-        "null",
-        "integer"
-      ]
+      "type": ["null", "integer"]
     },
     "requested_for_id": {
-      "type": [
-        "null",
-        "integer"
-      ]
+      "type": ["null", "integer"]
     }
   }
-}
+}
diff --git a/airbyte-integrations/connectors/source-freshservice/source_freshservice/source.py b/airbyte-integrations/connectors/source-freshservice/source_freshservice/source.py
@@ -22,6 +22,7 @@
     PurchaseOrders,
     Releases,
     Requesters,
+    SatisfactionSurveyResponses,
     Software,
     Tickets,
     Vendors,
@@ -68,5 +69,6 @@ def streams(self, config: Mapping[str, Any]) -> List[Stream]:
             Vendors(**kwargs),
             Assets(**kwargs),
             PurchaseOrders(**kwargs),
+            SatisfactionSurveyResponses(**kwargs),
             Software(**kwargs),
         ]