Merge pull request #88 from fivetran/bug/add_descriptions

Bug/add descriptions
fivetran · Oct 13, 2022 · f5612dc · f5612dc
2 parents dbb51e2 + 1447998
commit f5612dc
Show file tree

Hide file tree

Showing 12 changed files with 165 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+# dbt_hubspot_source v0.6.4
+PR [#88](https://github.com/fivetran/dbt_hubspot_source/pull/88) incorporates the following updates:
+## Fixes
+- Added column descriptions that were missing in [our documentation](https://fivetran.github.io/dbt_hubspot_source/#!/overview).
+
 # dbt_hubspot_source v0.6.3
 ## Fixes
 - Fixes a bug in the models `stg_hubspot__engagement_meeting.sql` and `stg_hubspot__engagement_meeting_tmp.sql` where the `fivetran_utils.enabled_vars` macro was referencing the wrong variable (`hubspot_engagement_email_enabled`) from the vars list in the `dbt_project.yml`. 

diff --git a/dbt_project.yml b/dbt_project.yml
@@ -1,5 +1,5 @@
 name: 'hubspot_source'
-version: '0.6.3'
+version: '0.6.4'
 
 config-version: 2
 require-dbt-version: [">=1.0.0", "<2.0.0"]

diff --git a/docs/catalog.json b/docs/catalog.json
diff --git a/docs/manifest.json b/docs/manifest.json
diff --git a/docs/run_results.json b/docs/run_results.json
diff --git a/integration_tests/dbt_project.yml b/integration_tests/dbt_project.yml
@@ -1,6 +1,6 @@
 
 name: 'hubspot_source_integration_tests'
-version: '0.6.3'
+version: '0.6.4'
 
 profile: 'integration_tests'
 config-version: 2

diff --git a/models/src_hubspot.yml b/models/src_hubspot.yml
@@ -91,6 +91,9 @@ sources:
         config:
           enabled: "{{ var('hubspot_sales_enabled', true) and var('hubspot_company_enabled', true) }}"
         columns:
+          - name: _fivetran_synced
+            description: '{{ doc("_fivetran_synced") }}'
+
           - name: id
             description: The ID of the company.
 
@@ -193,10 +196,16 @@ sources:
         config:
           enabled: "{{ var('hubspot_marketing_enabled', true) and var('hubspot_contact_enabled', true) }}"
         columns:
+          - name: _fivetran_deleted
+            description: '{{ doc("_fivetran_deleted") }}'
+
+          - name: _fivetran_synced
+            description: '{{ doc("_fivetran_synced") }}'
+
           - name: id
             description: The ID of the contact.
 
-          - name: property_email
+          - name: property_email_1
             description: The email address of the contact.
 
           - name: property_company
@@ -355,7 +364,7 @@ sources:
         config:
           enabled: "{{ var('hubspot_sales_enabled', true) and var('hubspot_deal_enabled', true) }}"
         columns:
-          - name: id
+          - name: deal_id
             description: The ID of the deal.
 
           - name: is_deleted
@@ -998,6 +1007,12 @@ sources:
           - name: body
             description: The details or notes of the call
 
+          - name: callee_object_id
+            description: The ID of the HubSpot record associated with the call. This will be the recipient of the call for OUTBOUND calls, or the dialer of the call for INBOUND calls.
+
+          - name: callee_object_type
+            description: The ID of the object to which the call's associated record belongs (e.g., specifies if the record is a contact or company). This will be the object of the recipient for OUTBOUND calls, or the object of the dialer for INBOUND calls.
+
           - name: disposition
             description: The internal ID for the call outcome.
 
@@ -1025,6 +1040,12 @@ sources:
           - name: to_number
             description: The phone number that was called.
 
+          - name: transcription_id
+            description: The ID of the transcription for the call.
+
+          - name: unknown_visitor_conversation
+            description: If a visitor is unknown.
+
       - name: engagement_company
         identifier: "{{ var('hubspot_engagement_company_identifier', 'engagement_company')}}"
         description: Each record represents a 'link' between a company and an engagement.
@@ -1100,6 +1121,9 @@ sources:
           - name: error_message
             description: The error message, if applicable.
 
+          - name: facsimile_send_id
+            description: facsimile_send_id
+
           - name: from_email
             description: The email address of the sender.
 
@@ -1112,12 +1136,21 @@ sources:
           - name: html
             description: The body of the HTML email.
 
+          - name: logged_from
+            description: The source of the logged email.
+
           - name: media_processing_status
             description: The processing status of the media content in the email.
 
           - name: message_id
             description: The ID of the message.
 
+          - name: post_send_status
+            description: Indicates if the post was sent.
+
+          - name: recipient_drop_reasons
+            description: recipient_drop_reasons
+
           - name: sent_via
             description: How the email was sent.
 
@@ -1133,6 +1166,12 @@ sources:
           - name: thread_id
             description: The ID of the email thread.
 
+          - name: tracker_key
+            description: The ID of the tracker.
+
+          - name: validation_skipped
+            description: validation_skipped
+
       - name: engagement_email_cc
         identifier: "{{ var('hubspot_engagement_email_cc_identifier', 'engagement_email_cc')}}"
         description: Each record represents a CC'd email address as part of an EMAIL engagement.
@@ -1183,6 +1222,9 @@ sources:
           - name: body
             description: The details or body of the meeting.
 
+          - name: created_from_link_id
+            description: created_from_link_id
+
           - name: end_time
             description: A timestamp representing the end time of the meeting
 

diff --git a/models/stg_hubspot__company.yml b/models/stg_hubspot__company.yml
@@ -29,6 +29,12 @@ models:
   - name: stg_hubspot__company
     description: Each record represents a company in Hubspot.
     columns:
+      - name: _fivetran_synced
+        description: '{{ doc("_fivetran_synced") }}'
+
+      - name: is_deleted
+        description: '{{ doc("is_deleted") }}'
+
       - name: company_id
         description: The ID of the company.
         tests:

diff --git a/models/stg_hubspot__contact.yml b/models/stg_hubspot__contact.yml
@@ -120,6 +120,12 @@ models:
   - name: stg_hubspot__contact
     description: Each record represents a contact in Hubspot.
     columns:
+      - name: _fivetran_deleted
+        description: '{{ doc("_fivetran_deleted") }}'
+
+      - name: _fivetran_synced
+        description: '{{ doc("_fivetran_synced") }}'
+
       - name: contact_id
         description: The ID of the contact.
         tests:

diff --git a/models/stg_hubspot__deal.yml b/models/stg_hubspot__deal.yml
@@ -62,6 +62,12 @@ models:
   - name: stg_hubspot__deal
     description: Each record represents a deal in Hubspot.
     columns:
+      - name: _fivetran_deleted
+        description: '{{ doc("_fivetran_deleted") }}'
+
+      - name: _fivetran_synced
+        description: '{{ doc("_fivetran_synced") }}'
+
       - name: deal_id
         description: The ID of the deal
         tests:
@@ -126,6 +132,21 @@ models:
       - name: deal_id
         description: The ID of the deal.
 
+      - name: _fivetran_synced
+        description: '{{ doc("_fivetran_synced") }}'
+
+  - name: stg_hubspot__deal_contact
+    description: Each record represents a 'link' between a deal and contact.
+    columns:
+      - name: contact_id
+        description: The ID of the contact.
+
+      - name: deal_id
+        description: The ID of the deal.
+
+      - name: _fivetran_synced
+        description: '{{ doc("_fivetran_synced") }}'
+
   - name: stg_hubspot__deal_property_history
     description: Each record represents the details of your deal properties.
     columns:

diff --git a/models/stg_hubspot__engagement.yml b/models/stg_hubspot__engagement.yml
@@ -8,6 +8,24 @@ models:
       - name: _fivetran_synced
         description: '{{ doc("_fivetran_synced") }}'
 
+      - name: call_notes
+        description: The description of the call, including any notes that you want to add.
+
+      - name: callee_object_id
+        description: The ID of the HubSpot record associated with the call. This will be the recipient of the call for OUTBOUND calls, or the dialer of the call for INBOUND calls.
+
+      - name: callee_object_type
+        description: The ID of the object to which the call's associated record belongs (e.g., specifies if the record is a contact or company). This will be the object of the recipient for OUTBOUND calls, or the object of the dialer for INBOUND calls.
+
+      - name: call_status
+        description: The status of the call. The statuses are BUSY, CALLING_CRM_USER, CANCELED, COMPLETED, CONNECTING, FAILED, IN_PROGRESS, NO_ANSWER, QUEUED, and RINGING.
+
+      - name: transcription_id
+        description: The ID of the transcription for the call.
+
+      - name: unknown_visitor_conversation
+        description: If a visitor is unknown.
+
       - name: call_duration_milliseconds
         description: The length of the call in milliseconds
 
@@ -106,6 +124,9 @@ models:
 
       - name: error_message
         description: The error message, if applicable.
+
+      - name: facsimile_send_id
+        description: facsimile_send_id
 
       - name: from_email
         description: The email address of the sender.
@@ -115,19 +136,34 @@ models:
 
       - name: from_last_name
         description: The last name of the sender.
+
+      - name: logged_from
+        description: The source of the logged email.
 
       - name: media_processing_status
         description: The processing status of the media content in the email.
 
       - name: message_id
         description: The ID of the message.
 
+      - name: post_send_status
+        description: Indicates if the post was sent.
+
+      - name: recipient_drop_reasons
+        description: recipient_drop_reasons
+
       - name: sent_via
         description: How the email was sent.
 
       - name: thread_id
         description: The ID of the email thread.
 
+      - name: tracker_key
+        description: The ID of the tracker.
+
+      - name: validation_skipped
+        description: validation_skipped
+
       - name: was_attached_video_opened
         description: Whether the the attached video was opened.
 
@@ -140,6 +176,9 @@ models:
       - name: _fivetran_synced
         description: '{{ doc("_fivetran_synced") }}'
 
+      - name: created_from_link_id
+        description: created_from_link_id
+
       - name: end_timestamp
         description: A timestamp representing the end time of the meeting
 
@@ -161,6 +200,9 @@ models:
       - name: meeting_title
         description: The title or subject of the meeting
 
+      - name: pre_meeting_prospect_reminders
+        description: pre_meeting_prospect_reminders
+
       - name: source
         description: The source of the meeting.
 

diff --git a/models/stg_hubspot__owner.yml b/models/stg_hubspot__owner.yml
@@ -0,0 +1,36 @@
+version: 2
+
+models:
+
+  - name: stg_hubspot__owner
+    description: Each record represents an owner/user in Hubspot.
+    columns:
+      - name: _fivetran_synced
+        description: '{{ doc("_fivetran_synced") }}'
+
+      - name: created_timestamp
+        description: A timestamp for when the owner was created.
+
+      - name: email_address
+        description: The email address of the owner.
+
+      - name: first_name
+        description: The first name of the owner.
+
+      - name: full_name
+        description: Full name of the owner.
+
+      - name: last_name
+        description: The last name of the owner.
+
+      - name: owner_id
+        description: The ID of the owner.
+
+      - name: portal_id
+        description: '{{ doc("portal_id") }}'
+
+      - name: owner_type
+        description: The type of owner.
+
+      - name: updated_timestamp
+        description: A timestamp for when the owner was last updated.