Gorgias Connector (#2444)

Co-authored-by: Adrian Galvan <[email protected]>
Co-authored-by: vivek <[email protected]>

CHANGELOG.md

@@ -19,6 +19,7 @@ The types of changes are:
 
 ### Added
 - Access and erasure support for Amplitude [#2569](https://github.com/ethyca/fides/pull/2569)
+- Access and erasure support for Gorgias [#2444](https://github.com/ethyca/fides/pull/2444)
 
 ## [2.12.0](https://github.com/ethyca/fides/compare/2.11.0...2.12.0)
 

data/saas/config/gorgias_config.yml

@@ -0,0 +1,126 @@
+saas_config:
+  fides_key: <instance_fides_key>
+  name: Gorgias
+  type: gorgias
+  description: A sample schema representing the Gorgias connector for Fides
+  version: 0.1.0
+
+  connector_params:
+    - name: domain
+    - name: username
+    - name: api_key
+      label: API Key
+
+  client_config:
+    protocol: https
+    host: <domain>
+    authentication:
+      strategy: basic
+      configuration:
+        username: <username>
+        password: <api_key>
+
+  test_request:
+    method: GET
+    path: /api/customers
+
+  endpoints:
+    - name: customer
+      requests:
+        read:
+          method: GET
+          path: /api/customers
+          query_params:
+            - name: email
+              value: <email>
+          data_path: data
+          param_values:
+            - name: email
+              identity: email
+        update:
+          method: PUT
+          path: /api/customers/<customer_id>/
+          body: |
+            {
+              <masked_object_fields>  
+            }
+          param_values:
+            - name: customer_id
+              references:
+                - dataset: <instance_fides_key>
+                  field: customer.id
+                  direction: from
+    - name: tickets
+      requests:
+        read:
+          method: GET
+          path: /api/tickets
+          query_params:
+            - name: customer_id
+              value: <customer_id>
+            - name: limit
+              value: "30"
+          data_path: data
+          pagination:
+            strategy: cursor
+            configuration:
+              cursor_param: cursor
+              field: meta.next_cursor
+          param_values:
+            - name: customer_id
+              references:
+                - dataset: <instance_fides_key>
+                  field: customer.id
+                  direction: from
+        update:
+          method: PUT
+          path: /api/tickets/<tickets_id>/
+          body: |
+            {
+              <masked_object_fields>
+            }
+          param_values:
+            - name: tickets_id
+              references:
+                - dataset: <instance_fides_key>
+                  field: tickets.id
+                  direction: from
+    - name: ticket_messages
+      requests:
+        read:
+          method: GET
+          path: /api/messages
+          query_params:
+            - name: ticket_id
+              value: <tickets_id>
+          data_path: data
+          pagination:
+            strategy: cursor
+            configuration:
+              cursor_param: cursor
+              field: meta.next_cursor
+          param_values:
+            - name: tickets_id
+              references:
+                - dataset: <instance_fides_key>
+                  field: tickets.id
+                  direction: from
+        update:
+          method: PUT
+          path: /api/tickets/<ticket_id>/messages/<ticket_message_id>/
+          grouped_inputs: [ticket_id, ticket_message_id]
+          body: |
+            {
+              <masked_object_fields>
+            }
+          param_values:
+            - name: ticket_id
+              references:
+                - dataset: <instance_fides_key>
+                  field: ticket_messages.ticket_id
+                  direction: from
+            - name: ticket_message_id
+              references:
+                - dataset: <instance_fides_key>
+                  field: ticket_messages.id
+                  direction: from