Add calls/ stream. (#35)

* feat: Add `activityType` and `teamId` attributes to engagements stream. * tidy: remove references to `engagements` stream as it's no longer supported. * feat: Add /calls stream. * docs: Add references to Calls and Meetings API docs.
potloc · Nov 22, 2022 · 9abc312 · 9abc312
1 parent 2a98e9e
commit 9abc312
Show file tree

Hide file tree

Showing 5 changed files with 99 additions and 180 deletions.
diff --git a/README.md b/README.md
@@ -44,9 +44,10 @@ This tap:
   - [Contacts](https://developers.hubspot.com/docs/methods/contacts/get_contacts)
   - [Contact Lists](http://developers.hubspot.com/docs/methods/lists/get_lists)
   - [Deals](http://developers.hubspot.com/docs/methods/deals/get_deals_modified)
+  - [Meetings](https://developers.hubspot.com/docs/api/crm/meetings)
+  - [Calls](https://developers.hubspot.com/docs/api/crm/calls)
   - [Deal Pipelines](https://developers.hubspot.com/docs/methods/deal-pipelines/get-all-deal-pipelines)
   - [Email Events](http://developers.hubspot.com/docs/methods/email/get_events)
-  - [Engagements](https://developers.hubspot.com/docs/methods/engagements/get-all-engagements)
   - [Forms](http://developers.hubspot.com/docs/methods/forms/v2/get_forms)
   - [Keywords](http://developers.hubspot.com/docs/methods/keywords/get_keywords)
   - [Owners](http://developers.hubspot.com/docs/methods/owners/get_owners)

diff --git a/tap_hubspot/schemas/calls.json b/tap_hubspot/schemas/calls.json
@@ -0,0 +1,76 @@
+{
+    "type": "object",
+    "properties":{
+        "id": {
+            "type": ["null","string"]
+        },
+        "createdAt": {
+            "type": ["null", "string"],
+            "format": "date-time"
+        },
+        "updatedAt": {
+            "type": ["null", "string"],
+            "format": "date-time"
+        },
+        "archived": {
+            "type": ["null", "boolean"]
+        },
+        "properties": {
+            "type": "object",
+            "properties": {
+                "createdate": {
+                    "type": ["null", "string"],
+                    "format": "date-time"
+                },
+                "hs_call_body": {
+                    "type": ["null", "string"]
+                },
+                "hs_call_duration": {
+                    "type": ["null", "string"],
+                    "format": "number"
+                },
+                "hs_call_from_number": {
+                    "type": ["null", "string"]
+                }, 
+                "hs_call_recording_url": {
+                    "type": ["null", "string"]              
+                },
+                "hs_call_status": {
+                    "type": ["null", "string"]
+                },
+                "hs_call_title": {
+                    "type": ["null", "string"]
+                },
+                "hs_call_to_number": {
+                    "type": ["null", "string"]
+                },
+                "hs_call_direction": {
+                    "type": ["null", "string"]
+                },
+                "hs_activity_type": {
+                    "type": ["null", "string"]
+                },
+                "hs_call_disposition": {
+                    "type": ["null", "string"]
+                },
+                "hs_call_callee_object_type_id": {
+                    "type": ["null", "string"]
+                },
+                "hs_call_callee_object_id": {
+                    "type": ["null", "string"]
+                },
+                "hs_lastmodifieddate": {
+                    "type": ["null", "string"],
+                    "format": "date-time"
+                },
+                "hs_timestamp": {
+                    "type": ["null", "string"],
+                    "format": "date-time"
+                },
+                "hubspot_owner_id": {
+                    "type": ["null", "string"]
+                }
+            }
+        }
+    }
+}
diff --git a/tap_hubspot/schemas/engagements.json b/tap_hubspot/schemas/engagements.json
diff --git a/tap_hubspot/streams.py b/tap_hubspot/streams.py
@@ -47,6 +47,25 @@ def schema(self) -> dict:
         return self.cached_schema
 
 
+class CallsStream(HubspotStream):
+    name = "calls"
+    path = f"/crm/v3/objects/calls"
+    primary_keys = ["id"]
+
+    def get_url_params(
+        self, context: Optional[dict], next_page_token: Optional[Any]
+    ) -> Dict[str, Any]:
+        params = super().get_url_params(context, next_page_token)
+        params["properties"] = ",".join(self.properties)
+        return params
+
+    @property
+    def schema(self) -> dict:
+        if self.cached_schema is None:
+            self.cached_schema, self.properties = self.get_custom_schema()
+        return self.cached_schema
+
+
 class OwnersStream(HubspotStream):
     """Define custom stream."""
 

diff --git a/tap_hubspot/tap.py b/tap_hubspot/tap.py
@@ -17,6 +17,7 @@
     CompaniesStream,
     DealsStream,
     MeetingsStream,
+    CallsStream,
     OwnersStream,
     PropertiesCompaniesStream,
     PropertiesContactsStream,
@@ -59,6 +60,7 @@
     CompaniesStream,
     DealsStream,
     MeetingsStream,
+    CallsStream,
     PropertiesCompaniesStream,
     PropertiesContactsStream,
     PropertiesDealsStream,