feature/contact-list-api-updates (#137)

* feature/contact-list-api-updates

* seed file and integration test changes

* changelog and github template updates

* slight deprecation tracker update

* changelog updates

* Update models/src_hubspot.yml

Co-authored-by: fivetran-catfritz <111930712+fivetran-catfritz@users.noreply.github.com>

* review updates and docs regen

* comment out variables

* release review update

* Update CHANGELOG.md

Co-authored-by: Avinash Kunnath <108772760+fivetran-avinash@users.noreply.github.com>

* Update deprecation-tracker.yml

* Update deprecation-tracker.yml

* docs regen

* Update CHANGELOG.md

---------

Co-authored-by: fivetran-catfritz <111930712+fivetran-catfritz@users.noreply.github.com>
Co-authored-by: Avinash Kunnath <108772760+fivetran-avinash@users.noreply.github.com>

Author: 3 people

.github/ISSUE_TEMPLATE/deprecation-tracker.yml

@@ -0,0 +1,65 @@
+name: ⚠️ Deprecation Tracker
+description: Use this template to flag and track deprecated items (field, model, or functionality) scheduled for removal.
+title: "[Deprecation] <Item Name>"
+labels: ["type:deprecation"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for helping manage our deprecation process. This template is intended to track deprecated items and plan for their ultimate removal. Providing complete information below will help us ensure a smooth transition and keep our users informed.
+  - type: input
+    attributes:
+      label: Planned Removal Date
+      description: Enter the date when this deprecated item will be fully removed (format - "Month Day, Year". eg. "May 10th, 2025").
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Original Deprecation Issue Link
+      description: Provide the link to the issue where the deprecation was initially proposed or discussed.
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Original Deprecation PR Link
+      description: Provide the link to the pull request that implemented the deprecation.
+    validations:
+      required: true
+  - type: dropdown
+    attributes:
+      label: Deprecated Item Type
+      description: Select the type(s) of item(s) being deprecated.
+      options:
+        - Field
+        - Model
+        - Functionality
+        - Other
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Deprecated Item
+      description: Specify the name(s) and any other relevant information of the deprecated item(s).
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Rationale and Impact Analysis
+      description: |
+        Explain why this item is being deprecated and discuss any potential impacts.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Migration Path / Alternatives
+      description: |
+        Provide details on how users should transition away from this deprecated item, including any recommended alternatives.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Additional Context or Notes
+      description: |
+        Include any other relevant information or context that might be important for planning or executing the deprecation process.
+    validations:
+      required: false

CHANGELOG.md

@@ -1,8 +1,35 @@
-# dbt_hubspot_source version.version
+# dbt_hubspot_source v0.18.0
+
+## Deprecations
+- Select fields have been deprecated from the `stg_hubspot__contact_list` model. The full removal date is planned for May 10th, 2025. Follow [Deprecation Issue #138](https://github.com/fivetran/dbt_hubspot_source/issues/138) for more details and updates around the planned sunsetting of the fields. ([#137](https://github.com/fivetran/dbt_hubspot_source/pull/137))
+  - The deprecated fields include the following:
+    - `is_deletable`
+    - `is_dynamic`
+    - `metadata_error`
+    - `metadata_last_processing_state_change_at`
+    - `metadata_last_size_change_at`
+    - `metadata_processing`
+    - `metadata_size`
+    - `portal_id`
+
+## Breaking Changes
+- Select fields have been added to the `stg_hubspot__contact_list` model. ([#137](https://github.com/fivetran/dbt_hubspot_source/pull/137))
+  - The newly added fields include the following:
+    - `created_by_id`
+    - `object_type_id`
+    - `processing_status`
+    - `processing_type`
+    - `list_version`
+    - `filters_updated_at`
 
 ## Documentation
+- All deprecated fields have been documented as notice of deprecation in the respective yml documents. ([#137](https://github.com/fivetran/dbt_hubspot_source/pull/137))
+- All added fields have been documented. ([#137](https://github.com/fivetran/dbt_hubspot_source/pull/137))
 - Corrected references to connectors and connections in the README. ([#136](https://github.com/fivetran/dbt_hubspot_source/pull/136))
 
+## Under the Hood
+- Added a deprecation tracker GitHub issue template to ensure deprecated fields are appropriately tracked for full removal in a future planned update. ([#137](https://github.com/fivetran/dbt_hubspot_source/pull/137))
+
 # dbt_hubspot_source v0.17.0
 
 ## Breaking Change (`--full-refresh` required after upgrading)  

README.md

@@ -44,7 +44,7 @@ Include the following hubspot_source package version in your `packages.yml` file
 ```yaml
 packages:
   - package: fivetran/hubspot_source
-    version: [">=0.17.0", "<0.18.0"]
+    version: [">=0.18.0", "<0.19.0"]
 ```
 ### Step 3: Define database and schema variables
 By default, this package runs using your destination and the `hubspot` schema. If this is not where your HubSpot data is (for example, if your HubSpot schema is named `hubspot_fivetran`), add the following configuration to your root `dbt_project.yml` file:

dbt_project.yml

@@ -1,5 +1,5 @@
 name: 'hubspot_source'
-version: '0.17.0'
+version: '0.18.0'
 config-version: 2
 require-dbt-version: [">=1.3.0", "<2.0.0"]
 models:

docs/catalog.json

@@ -1,5 +1,5 @@
 name: 'hubspot_source_integration_tests'
-version: '0.17.0'
+version: '0.18.0'
 profile: 'integration_tests'
 config-version: 2
 
@@ -192,11 +192,6 @@ seeds:
       +enabled: "{{ true if target.type == 'postgres' else false }}"
     email_event_dropped_data:
       +enabled: "{{ true if target.type not in ('snowflake', 'postgres') else false }}"
-    contact_list_data:
-      +enabled: "{{ true if target.type != 'postgres' else false }}"
-    contact_list_data_postgres:
-      +alias: contact_list_data
-      +enabled: "{{ true if target.type == 'postgres' else false }}"
     email_event_data: 
       +column_types:
         _fivetran_synced: timestamp