Feature/new union macro metadata fields and variable configs

.buildkite/scripts/run_models.sh

@@ -20,9 +20,9 @@ dbt seed --target "$db" --full-refresh
 dbt source freshness --target "$db" || echo "...Only verifying freshness runs…"
 dbt run --target "$db" --full-refresh
 dbt test --target "$db"
-dbt run --vars '{stripe__using_invoices: false, stripe__using_payment_method: false, stripe__using_subscriptions: false, stripe_timezone: "America/New_York", stripe__using_subscription_history: false, stripe__using_price: false, stripe__convert_values: true, stripe__using_credit_notes: true, stripe__standardized_billing_model_enabled: false}' --target "$db"
+dbt run --vars '{stripe__using_payouts: false, stripe__using_transfers: false, stripe__using_invoices: false, stripe__using_payment_method: false, stripe__using_subscriptions: false, stripe_timezone: "America/New_York", stripe__using_subscription_history: false, stripe__using_price: false, stripe__convert_values: true, stripe__using_credit_notes: true, stripe__standardized_billing_model_enabled: false}' --target "$db"
 dbt test --target "$db"
-dbt run --vars '{stripe__using_invoices: true, stripe__using_payment_method: false, stripe__using_subscriptions: false, stripe_timezone: "America/New_York", stripe__using_subscription_history: false, stripe__using_price: false, stripe__convert_values: true, stripe__using_credit_notes: true, stripe__standardized_billing_model_enabled: true}' --target "$db"
+dbt run --vars '{stripe__using_payouts: false, stripe__using_invoices: true, stripe__using_payment_method: false, stripe__using_subscriptions: false, stripe_timezone: "America/New_York", stripe__using_subscription_history: false, stripe__using_price: false, stripe__convert_values: true, stripe__using_credit_notes: true, stripe__standardized_billing_model_enabled: true}' --target "$db"
 dbt test --target "$db"
 
 dbt run-operation fivetran_utils.drop_schemas_automation --target "$db"

.quickstart/quickstart.yml

@@ -16,6 +16,11 @@ table_variables:
   stripe__using_credit_notes:
     - credit_note_line_item
     - credit_note
+  stripe__using_transfers:
+    - transfer
+  stripe__using_payouts:
+    - payout
+    - payout_balance_transaction
   stripe__using_coupons:
     - coupon
 
@@ -47,9 +52,24 @@ public_models: [
 supported_vars:
   stripe__customer_metadata:
     type: dictionary
-    description: "`CUSTOMER.metadata` properties that will be pivoted into columns in `stripe__customer_overview`"
+    description: "`customer.metadata` properties that will be pivoted into columns in `stripe__customer_overview`, `stripe__balance_transactions`, `stripe__invoice_details`, and `stripe__subscription_details`."
     display_name: "Customer Metadata Properties"
 
+  stripe__charge_metadata:
+    type: dictionary
+    description: "`charge.metadata` properties that will be pivoted into columns in `stripe__balance_transactions` and `stripe__invoice_details`."
+    display_name: "Charge Metadata Properties"
+
+  stripe__invoice_metadata:
+    type: dictionary
+    description: "`invoice.metadata` properties that will be pivoted into columns in `stripe__invoice_details` and `stripe__balance_transactions`."
+    display_name: "Invoice Metadata Properties"
+
+  stripe__subscription_metadata:
+    type: dictionary
+    description: "`subscription.metadata` properties that will be pivoted into columns in `stripe__subscription_details`, `stripe__balance_transactions`, `stripe__invoice_line_item_details`, and `stripe__invoice_details`."
+    display_name: "Subscription Metadata Properties"
+
   stripe__convert_values:
     type: boolean
     value: false

CHANGELOG.md

@@ -1,3 +1,45 @@
+# dbt_stripe v1.5.0
+
+## Schema Changes
+**2 total changes • 1 possible breaking change**
+| **Data Model** | **Change type** | **Old** | **New** | **Notes** |
+| -------------- | --------------- | ------------ | ------------ | --------- |
+| All models | Single-connection `source_relation` value | Empty string (`''`) | `<stripe_database>.<stripe_schema>` |  |
+| `stg_stripe__coupon` | New column |  | `metadata` | optional custom JSON field |
+
+## Feature Updates
+- Adds configurable table variables `stripe__using_transfers` and `stripe__using_payouts`, which are set to true by default. For dbt Core users, [See the README](https://github.com/fivetran/dbt_stripe?tab=readme-ov-file#disable-models-for-non-existent-sources) for more details on how to disable these variables. 
+  - `stripe__using_transfers` disables the Transfers source and any relevant downstream components.
+  - `stripe__using_payouts` disables both the Payouts and Payout Balance Transactions sources, along with any related downstream components.
+- Introduces support for the newer, more flexible unioning framework. Previously, to run the package on multiple Stripe sources at once, you could only use the `union_schemas` variable OR `union_databases` (mutually exclusive). While these setups are still supported for backwards compatibility, we recommend using `stripe_sources` instead. See the [README](https://github.com/fivetran/dbt_stripe/blob/main/README.md#option-b-union-multiple-connections) for more details.
+
+```yml
+# dbt_project.yml
+
+vars:
+  stripe:
+    stripe_sources:
+      - database: connection_1_destination_name # Required
+        schema: connection_1_schema_name # Required
+        name: connection_1_source_name # Required only if following this step: https://github.com/fivetran/dbt_stripe/blob/main/README.md#recommended-incorporate-unioned-sources-into-dag
+
+      - database: connection_2_destination_name
+        schema: connection_2_schema_name
+        name: connection_2_source_name
+```
+- Updates end models (`stripe__balance_transactions`, `stripe__customer_overview`, `stripe__invoice_details`, `stripe__invoice_line_item_details`, `stripe__subscription_details`) to dynamically include metadata fields from staging models when metadata variables are configured.  See the [README](https://github.com/fivetran/dbt_stripe/blob/main/README.md#pivoting-out-metadata-properties) for more details.
+
+## Quickstart Updates
+- Creates table variables for sources `transfer`,`payout`, and `payout_balance_transactions`. These source tables must be selected in the Fievetran connector UI for the variables to be set to True and the dependent models to be run.
+- Adds `stripe__charge_metadata`, `stripe__invoice_metatdata`, and `stripe__subscription_metadata` to `supported_vars` as optional properties to be pivoted into columns in various end models. These variables can be configured directly through the `supportedVars` section in the Quickstart UI.
+
+## Under the Hood
+- Updates all tmp staging models to conditionally use either the new `stripe_union_connections` macro (when `stripe_sources` is configured) or the legacy `fivetran_utils.union_data` macro (for backward compatibility).
+- Updates all staging models to use the new `stripe.apply_source_relation()` macro instead of `fivetran_utils.source_relation()`.
+- Adds `stripe.select_metadata_columns()` macro to handle both dictionary and alias variable metadata inputs.
+- Adds `metadata` column to `get_coupon_columns()` macro and `coupon_data.csv` seed file.
+- Updates integration test seed data for customer and invoice tables.
+
 # dbt_stripe v1.4.0
 [PR #138](https://github.com/fivetran/dbt_stripe/pull/138) includes the following updates:
 
@@ -423,8 +465,6 @@ Stripe passes amount-based fields, such as `amount`, `net`, and `fee`, in the sm
   - Updated `customer_facing_amount` to include for refunds and disputes as well
   - Updated `charge_id` to charge, refund, then dispute objects consecutively
 
-
-
 ## Under the Hood:
 
 - Incorporated the new `fivetran_utils.drop_schemas_automation` macro into the end of each Buildkite integration test job.