Update required fields based on API doc

harrystech · Sep 20, 2022 · 0e4e19e · 0e4e19e
1 parent dc1693b
commit 0e4e19e
Show file tree

Hide file tree

Showing 10 changed files with 31 additions and 61 deletions.
diff --git a/README.md b/README.md
@@ -24,20 +24,35 @@ pipx install git+https://github.com/ORG_NAME/tap-gladly.git@main
 
 -->
 
+## Capabilities
+
+* `catalog`
+* `state`
+* `discover`
+* `about`
+* `stream-maps`
+* `schema-flattening`
+
+## Settings
+
+| Setting             | Required | Default | Description |
+|:--------------------|:--------:|:-------:|:------------|
+| username            | True     | None    | The username to authenticate against the API service |
+| password            | True     | None    | The username to authenticate against the API service |
+| project_ids         | False    | None    | Project IDs to replicate |
+| start_date          | True     | None    | The earliest record date to sync, format %Y-%m-%dT%H:%M:%SZ |
+| api_url_base        | True     | None    | The url for the API service |
+| stream_maps         | False    | None    | Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html). |
+| stream_map_config   | False    | None    | User-defined config values to be used within map expressions. |
+| flattening_enabled  | False    | None    | 'True' to enable schema flattening and automatically expand nested properties. |
+| flattening_max_depth| False    | None    | The max depth to flatten schemas. |
+
+A full list of supported settings and capabilities is available by running: `tap-gladly --about`
+
 ## Configuration
 
 ### Accepted Config Options
 
-<!--
-Developer TODO: Provide a list of config options accepted by the tap.
-
-This section can be created by copy-pasting the CLI output from:
-
-```
-tap-gladly --about --format=markdown
-```
--->
-
 A full list of supported settings and capabilities for this
 tap is available by running:
 

diff --git a/tap_gladly/schemas/export_conversation-chat_message.json b/tap_gladly/schemas/export_conversation-chat_message.json
@@ -55,10 +55,8 @@
   },
   "required": [
     "content",
-    "conversationId",
     "customerId",
     "id",
-    "initiator",
     "timestamp"
   ]
 }
diff --git a/tap_gladly/schemas/export_conversation-conversation_note.json b/tap_gladly/schemas/export_conversation-conversation_note.json
@@ -34,22 +34,16 @@
         "id": {
           "type": "string"
         }
-      },
-      "required": [
-        "id",
-        "type"
-      ]
+      }
     },
     "timestamp": {
       "type": "string"
     }
   },
   "required": [
     "content",
-    "conversationId",
     "customerId",
     "id",
-    "initiator",
     "timestamp"
   ]
 }
diff --git a/tap_gladly/schemas/export_conversation-conversation_status_change.json b/tap_gladly/schemas/export_conversation-conversation_status_change.json
@@ -47,7 +47,6 @@
   },
   "required": [
     "content",
-    "conversationId",
     "customerId",
     "id",
     "timestamp"

diff --git a/tap_gladly/schemas/export_conversation-phone_call.json b/tap_gladly/schemas/export_conversation-phone_call.json
@@ -40,7 +40,6 @@
         }
       },
       "required": [
-        "completedAt",
         "from",
         "startedAt",
         "to",
@@ -59,11 +58,7 @@
         "id": {
           "type": "string"
         }
-      },
-      "required": [
-        "id",
-        "type"
-      ]
+      }
     },
     "responder": {
       "type": "object",
@@ -74,22 +69,16 @@
         "id": {
           "type": "string"
         }
-      },
-      "required": [
-        "id",
-        "type"
-      ]
+      }
     },
     "timestamp": {
       "type": "string"
     }
   },
   "required": [
     "content",
-    "conversationId",
     "customerId",
     "id",
-    "initiator",
     "timestamp"
   ]
 }
diff --git a/tap_gladly/schemas/export_conversation-sms.json b/tap_gladly/schemas/export_conversation-sms.json
@@ -57,7 +57,6 @@
     "content",
     "customerId",
     "id",
-    "initiator",
     "timestamp"
   ]
 }
diff --git a/tap_gladly/schemas/export_conversation-topic_change.json b/tap_gladly/schemas/export_conversation-topic_change.json
@@ -43,22 +43,16 @@
         "id": {
           "type": "string"
         }
-      },
-      "required": [
-        "id",
-        "type"
-      ]
+      }
     },
     "timestamp": {
       "type": "string"
     }
   },
   "required": [
     "content",
-    "conversationId",
     "customerId",
     "id",
-    "initiator",
     "timestamp"
   ]
 }
diff --git a/tap_gladly/schemas/export_conversation-voicemail.json b/tap_gladly/schemas/export_conversation-voicemail.json
@@ -28,10 +28,6 @@
         }
       },
       "required": [
-        "recordingDuration",
-        "recordingStatus",
-        "recordingUrl",
-        "startedAt",
         "type"
       ]
     },
@@ -47,22 +43,16 @@
         "id": {
           "type": "string"
         }
-      },
-      "required": [
-        "id",
-        "type"
-      ]
+      }
     },
     "timestamp": {
       "type": "string"
     }
   },
   "required": [
     "content",
-    "conversationId",
     "customerId",
     "id",
-    "initiator",
     "timestamp"
   ]
 }
diff --git a/tap_gladly/schemas/export_jobs.json b/tap_gladly/schemas/export_jobs.json
@@ -36,12 +36,5 @@
         "type": "string"
       }
     }
-  },
-  "required": [
-    "files",
-    "id",
-    "parameters",
-    "status",
-    "updatedAt"
-  ]
+  }
 }
diff --git a/tap_gladly/streams.py b/tap_gladly/streams.py
@@ -27,7 +27,6 @@ class ExportJobsStream(gladlyStream):
 
     # start_date
     def post_process(self, row, context):
-        """As needed, append or transform raw data to match expected structure."""
         """As needed, append or transform raw data to match expected structure."""
         if "start_date" not in self.config:
             return row