metronome-sdk 1.0.0 → 2.1.0

data/lib/metronome_sdk/models/v1/customer_preview_events_params.rb

@@ -14,21 +14,24 @@ module MetronomeSDK
         required :customer_id, String
 
         # @!attribute events
+        #   Array of usage events to include in the preview calculation. Must contain at
+        #   least one event in `merge` mode.
         #
         #   @return [Array<MetronomeSDK::Models::V1::CustomerPreviewEventsParams::Event>]
         required :events,
                  -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::CustomerPreviewEventsParams::Event] }
 
         # @!attribute mode
-        #   If set to "replace", the preview will be generated as if those were the only
-        #   events for the specified customer. If set to "merge", the events will be merged
-        #   with any existing events for the specified customer. Defaults to "replace".
+        #   Controls how the provided events are combined with existing usage data. Use
+        #   `replace` to calculate the preview as if these are the only events for the
+        #   customer, ignoring all historical usage. Use `merge` to combine these events
+        #   with the customer's existing usage. Defaults to `replace`.
         #
         #   @return [Symbol, MetronomeSDK::Models::V1::CustomerPreviewEventsParams::Mode, nil]
         optional :mode, enum: -> { MetronomeSDK::V1::CustomerPreviewEventsParams::Mode }
 
         # @!attribute skip_zero_qty_line_items
-        #   If set, all zero quantity line items will be filtered out of the response.
+        #   When `true`, line items with zero quantity are excluded from the response.
         #
         #   @return [Boolean, nil]
         optional :skip_zero_qty_line_items, MetronomeSDK::Internal::Type::Boolean
@@ -39,11 +42,11 @@ module MetronomeSDK
         #
         #   @param customer_id [String]
         #
-        #   @param events [Array<MetronomeSDK::Models::V1::CustomerPreviewEventsParams::Event>]
+        #   @param events [Array<MetronomeSDK::Models::V1::CustomerPreviewEventsParams::Event>] Array of usage events to include in the preview calculation. Must contain at lea
         #
-        #   @param mode [Symbol, MetronomeSDK::Models::V1::CustomerPreviewEventsParams::Mode] If set to "replace", the preview will be generated as if those were the only eve
+        #   @param mode [Symbol, MetronomeSDK::Models::V1::CustomerPreviewEventsParams::Mode] Controls how the provided events are combined with existing usage data. Use `rep
         #
-        #   @param skip_zero_qty_line_items [Boolean] If set, all zero quantity line items will be filtered out of the response.
+        #   @param skip_zero_qty_line_items [Boolean] When `true`, line items with zero quantity are excluded from the response.
         #
         #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
 
@@ -53,14 +56,6 @@ module MetronomeSDK
           #   @return [String]
           required :event_type, String
 
-          # @!attribute customer_id
-          #   This has no effect for preview events, but may be set for consistency with Event
-          #   objects. They will be processed even if they do not match the customer's ID or
-          #   ingest aliases.
-          #
-          #   @return [String, nil]
-          optional :customer_id, String
-
           # @!attribute properties
           #
           #   @return [Hash{Symbol=>Object}, nil]
@@ -73,31 +68,30 @@ module MetronomeSDK
           optional :timestamp, String
 
           # @!attribute transaction_id
-          #   This has no effect for preview events, but may be set for consistency with Event
-          #   objects. Duplicate transaction_ids are NOT filtered out, even within the same
-          #   request.
+          #   Optional unique identifier for event deduplication. When provided, preview
+          #   events are automatically deduplicated against historical events from the past 34
+          #   days. Duplicate transaction IDs within the same request will return an error.
           #
           #   @return [String, nil]
           optional :transaction_id, String
 
-          # @!method initialize(event_type:, customer_id: nil, properties: nil, timestamp: nil, transaction_id: nil)
+          # @!method initialize(event_type:, properties: nil, timestamp: nil, transaction_id: nil)
           #   Some parameter documentations has been truncated, see
           #   {MetronomeSDK::Models::V1::CustomerPreviewEventsParams::Event} for more details.
           #
           #   @param event_type [String]
           #
-          #   @param customer_id [String] This has no effect for preview events, but may be set for consistency with Event
-          #
           #   @param properties [Hash{Symbol=>Object}]
           #
           #   @param timestamp [String] RFC 3339 formatted. If not provided, the current time will be used.
           #
-          #   @param transaction_id [String] This has no effect for preview events, but may be set for consistency with Event
+          #   @param transaction_id [String] Optional unique identifier for event deduplication. When provided, preview event
         end
 
-        # If set to "replace", the preview will be generated as if those were the only
-        # events for the specified customer. If set to "merge", the events will be merged
-        # with any existing events for the specified customer. Defaults to "replace".
+        # Controls how the provided events are combined with existing usage data. Use
+        # `replace` to calculate the preview as if these are the only events for the
+        # customer, ignoring all historical usage. Use `merge` to combine these events
+        # with the customer's existing usage. Defaults to `replace`.
         module Mode
           extend MetronomeSDK::Internal::Type::Enum
 

data/lib/metronome_sdk/models/v1/customer_preview_events_response.rb

@@ -7,11 +7,11 @@ module MetronomeSDK
       class CustomerPreviewEventsResponse < MetronomeSDK::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [MetronomeSDK::Models::V1::Customers::Invoice]
-        required :data, -> { MetronomeSDK::V1::Customers::Invoice }
+        #   @return [Array<MetronomeSDK::Models::V1::Customers::Invoice>]
+        required :data, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::Invoice] }
 
         # @!method initialize(data:)
-        #   @param data [MetronomeSDK::Models::V1::Customers::Invoice]
+        #   @param data [Array<MetronomeSDK::Models::V1::Customers::Invoice>]
       end
     end
   end

data/lib/metronome_sdk/models/v1/customer_retrieve_billing_configurations_response.rb

@@ -102,6 +102,7 @@ module MetronomeSDK
             QUICKBOOKS_ONLINE = :quickbooks_online
             WORKDAY = :workday
             GCP_MARKETPLACE = :gcp_marketplace
+            METRONOME = :metronome
 
             # @!method self.values
             #   @return [Array<Symbol>]

data/lib/metronome_sdk/models/v1/customer_set_billing_configurations_params.rb

@@ -99,6 +99,7 @@ module MetronomeSDK
             QUICKBOOKS_ONLINE = :quickbooks_online
             WORKDAY = :workday
             GCP_MARKETPLACE = :gcp_marketplace
+            METRONOME = :metronome
 
             # @!method self.values
             #   @return [Array<Symbol>]

data/lib/metronome_sdk/models/v1/customers/alert_list_params.rb

@@ -22,8 +22,8 @@ module MetronomeSDK
           optional :next_page, String
 
           # @!attribute alert_statuses
-          #   Optionally filter by alert status. If absent, only enabled alerts will be
-          #   returned.
+          #   Optionally filter by threshold notification status. If absent, only enabled
+          #   notifications will be returned.
           #
           #   @return [Array<Symbol, MetronomeSDK::Models::V1::Customers::AlertListParams::AlertStatus>, nil]
           optional :alert_statuses,
@@ -37,7 +37,7 @@ module MetronomeSDK
           #
           #   @param next_page [String] Cursor that indicates where the next page of results should start.
           #
-          #   @param alert_statuses [Array<Symbol, MetronomeSDK::Models::V1::Customers::AlertListParams::AlertStatus>] Optionally filter by alert status. If absent, only enabled alerts will be return
+          #   @param alert_statuses [Array<Symbol, MetronomeSDK::Models::V1::Customers::AlertListParams::AlertStatus>] Optionally filter by threshold notification status. If absent, only enabled noti
           #
           #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/metronome_sdk/models/v1/customers/alert_reset_params.rb

@@ -10,7 +10,7 @@ module MetronomeSDK
           include MetronomeSDK::Internal::Type::RequestParameters
 
           # @!attribute alert_id
-          #   The Metronome ID of the alert
+          #   The Metronome ID of the threshold notification
           #
           #   @return [String]
           required :alert_id, String
@@ -22,7 +22,7 @@ module MetronomeSDK
           required :customer_id, String
 
           # @!method initialize(alert_id:, customer_id:, request_options: {})
-          #   @param alert_id [String] The Metronome ID of the alert
+          #   @param alert_id [String] The Metronome ID of the threshold notification
           #
           #   @param customer_id [String] The Metronome ID of the customer
           #

data/lib/metronome_sdk/models/v1/customers/alert_retrieve_params.rb

@@ -10,7 +10,7 @@ module MetronomeSDK
           include MetronomeSDK::Internal::Type::RequestParameters
 
           # @!attribute alert_id
-          #   The Metronome ID of the alert
+          #   The Metronome ID of the threshold notification
           #
           #   @return [String]
           required :alert_id, String
@@ -22,16 +22,16 @@ module MetronomeSDK
           required :customer_id, String
 
           # @!attribute group_values
-          #   Only present for `spend_threshold_reached` alerts. Retrieve the alert for a
-          #   specific group key-value pair.
+          #   Only present for `spend_threshold_reached` notifications. Retrieve the
+          #   notification for a specific group key-value pair.
           #
           #   @return [Array<MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::GroupValue>, nil]
           optional :group_values,
                    -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::AlertRetrieveParams::GroupValue] }
 
           # @!attribute plans_or_contracts
-          #   When parallel alerts are enabled during migration, this flag denotes whether to
-          #   fetch alerts for plans or contracts.
+          #   When parallel threshold notifications are enabled during migration, this flag
+          #   denotes whether to fetch notifications for plans or contracts.
           #
           #   @return [Symbol, MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::PlansOrContracts, nil]
           optional :plans_or_contracts,
@@ -41,13 +41,13 @@ module MetronomeSDK
           #   Some parameter documentations has been truncated, see
           #   {MetronomeSDK::Models::V1::Customers::AlertRetrieveParams} for more details.
           #
-          #   @param alert_id [String] The Metronome ID of the alert
+          #   @param alert_id [String] The Metronome ID of the threshold notification
           #
           #   @param customer_id [String] The Metronome ID of the customer
           #
-          #   @param group_values [Array<MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::GroupValue>] Only present for `spend_threshold_reached` alerts. Retrieve the alert for a spec
+          #   @param group_values [Array<MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::GroupValue>] Only present for `spend_threshold_reached` notifications. Retrieve the notificat
           #
-          #   @param plans_or_contracts [Symbol, MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::PlansOrContracts] When parallel alerts are enabled during migration, this flag denotes whether to
+          #   @param plans_or_contracts [Symbol, MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::PlansOrContracts] When parallel threshold notifications are enabled during migration, this flag de
           #
           #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
 
@@ -63,15 +63,15 @@ module MetronomeSDK
             required :value, String
 
             # @!method initialize(key:, value:)
-            #   Scopes alert evaluation to a specific presentation group key on individual line
-            #   items. Only present for spend alerts.
+            #   Scopes threshold notification evaluation to a specific presentation group key on
+            #   individual line items. Only present for spend notifications.
             #
             #   @param key [String]
             #   @param value [String]
           end
 
-          # When parallel alerts are enabled during migration, this flag denotes whether to
-          # fetch alerts for plans or contracts.
+          # When parallel threshold notifications are enabled during migration, this flag
+          # denotes whether to fetch notifications for plans or contracts.
           module PlansOrContracts
             extend MetronomeSDK::Internal::Type::Enum
 

data/lib/metronome_sdk/models/v1/customers/billing_config_create_params.rb

@@ -38,6 +38,8 @@ module MetronomeSDK
           optional :aws_region, enum: -> { MetronomeSDK::V1::Customers::BillingConfigCreateParams::AwsRegion }
 
           # @!attribute stripe_collection_method
+          #   The collection method for the customer's invoices. NOTE:
+          #   `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
           #
           #   @return [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::StripeCollectionMethod, nil]
           optional :stripe_collection_method,
@@ -58,7 +60,7 @@ module MetronomeSDK
           #
           #   @param aws_region [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::AwsRegion]
           #
-          #   @param stripe_collection_method [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::StripeCollectionMethod]
+          #   @param stripe_collection_method [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::StripeCollectionMethod] The collection method for the customer's invoices.
           #
           #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
 
@@ -73,6 +75,7 @@ module MetronomeSDK
             QUICKBOOKS_ONLINE = :quickbooks_online
             WORKDAY = :workday
             GCP_MARKETPLACE = :gcp_marketplace
+            METRONOME = :metronome
 
             # @!method self.values
             #   @return [Array<Symbol>]
@@ -111,6 +114,8 @@ module MetronomeSDK
             #   @return [Array<Symbol>]
           end
 
+          # The collection method for the customer's invoices. NOTE:
+          # `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
           module StripeCollectionMethod
             extend MetronomeSDK::Internal::Type::Enum
 

data/lib/metronome_sdk/models/v1/customers/billing_config_delete_params.rb

@@ -36,6 +36,7 @@ module MetronomeSDK
             QUICKBOOKS_ONLINE = :quickbooks_online
             WORKDAY = :workday
             GCP_MARKETPLACE = :gcp_marketplace
+            METRONOME = :metronome
 
             # @!method self.values
             #   @return [Array<Symbol>]

data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_params.rb

@@ -36,6 +36,7 @@ module MetronomeSDK
             QUICKBOOKS_ONLINE = :quickbooks_online
             WORKDAY = :workday
             GCP_MARKETPLACE = :gcp_marketplace
+            METRONOME = :metronome
 
             # @!method self.values
             #   @return [Array<Symbol>]

data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rb

@@ -74,6 +74,8 @@ module MetronomeSDK
             optional :billing_provider_customer_id, String
 
             # @!attribute stripe_collection_method
+            #   The collection method for the customer's invoices. NOTE:
+            #   `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
             #
             #   @return [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse::Data::StripeCollectionMethod, nil]
             optional :stripe_collection_method,
@@ -102,7 +104,7 @@ module MetronomeSDK
             #
             #   @param billing_provider_customer_id [String]
             #
-            #   @param stripe_collection_method [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse::Data::StripeCollectionMethod]
+            #   @param stripe_collection_method [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse::Data::StripeCollectionMethod] The collection method for the customer's invoices.
 
             # @see MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse::Data#aws_region
             module AwsRegion
@@ -151,6 +153,9 @@ module MetronomeSDK
               #   @return [Array<Symbol>]
             end
 
+            # The collection method for the customer's invoices. NOTE:
+            # `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
+            #
             # @see MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse::Data#stripe_collection_method
             module StripeCollectionMethod
               extend MetronomeSDK::Internal::Type::Enum

data/lib/metronome_sdk/models/v1/customers/commit_create_params.rb

@@ -78,7 +78,7 @@ module MetronomeSDK
           # @!attribute invoice_contract_id
           #   The contract that this commit will be billed on. This is required for "POSTPAID"
           #   commits and for "PREPAID" commits unless there is no invoice schedule above
-          #   (i.e., the commit is 'free').
+          #   (i.e., the commit is 'free'), or if do_not_invoice is set to true.
           #
           #   @return [String, nil]
           optional :invoice_contract_id, String

data/lib/metronome_sdk/models/v1/customers/customer_alert.rb

@@ -12,8 +12,8 @@ module MetronomeSDK
           required :alert, -> { MetronomeSDK::V1::Customers::CustomerAlert::Alert }
 
           # @!attribute customer_status
-          #   The status of the customer alert. If the alert is archived, null will be
-          #   returned.
+          #   The status of the threshold notification. If the notification is archived, null
+          #   will be returned.
           #
           #   @return [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::CustomerStatus, nil]
           required :customer_status,
@@ -21,7 +21,7 @@ module MetronomeSDK
                    nil?: true
 
           # @!attribute triggered_by
-          #   If present, indicates the reason the alert was triggered.
+          #   If present, indicates the reason the threshold notification was triggered.
           #
           #   @return [String, nil]
           optional :triggered_by, String, nil?: true
@@ -32,52 +32,53 @@ module MetronomeSDK
           #
           #   @param alert [MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert]
           #
-          #   @param customer_status [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::CustomerStatus, nil] The status of the customer alert. If the alert is archived, null will be returne
+          #   @param customer_status [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::CustomerStatus, nil] The status of the threshold notification. If the notification is archived, null
           #
-          #   @param triggered_by [String, nil] If present, indicates the reason the alert was triggered.
+          #   @param triggered_by [String, nil] If present, indicates the reason the threshold notification was triggered.
 
           # @see MetronomeSDK::Models::V1::Customers::CustomerAlert#alert
           class Alert < MetronomeSDK::Internal::Type::BaseModel
             # @!attribute id
-            #   the Metronome ID of the alert
+            #   the Metronome ID of the threshold notification
             #
             #   @return [String]
             required :id, String
 
             # @!attribute name
-            #   Name of the alert
+            #   Name of the threshold notification
             #
             #   @return [String]
             required :name, String
 
             # @!attribute status
-            #   Status of the alert
+            #   Status of the threshold notification
             #
             #   @return [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::Status]
             required :status, enum: -> { MetronomeSDK::V1::Customers::CustomerAlert::Alert::Status }
 
             # @!attribute threshold
-            #   Threshold value of the alert policy
+            #   Threshold value of the notification policy
             #
             #   @return [Float]
             required :threshold, Float
 
             # @!attribute type
-            #   Type of the alert
+            #   Type of the threshold notification
             #
             #   @return [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::Type]
             required :type, enum: -> { MetronomeSDK::V1::Customers::CustomerAlert::Alert::Type }
 
             # @!attribute updated_at
-            #   Timestamp for when the alert was last updated
+            #   Timestamp for when the threshold notification was last updated
             #
             #   @return [Time]
             required :updated_at, Time
 
             # @!attribute credit_grant_type_filters
-            #   An array of strings, representing a way to filter the credit grant this alert
-            #   applies to, by looking at the credit_grant_type field on the credit grant. This
-            #   field is only defined for CreditPercentage and CreditBalance alerts
+            #   An array of strings, representing a way to filter the credit grant this
+            #   threshold notification applies to, by looking at the credit_grant_type field on
+            #   the credit grant. This field is only defined for CreditPercentage and
+            #   CreditBalance notifications
             #
             #   @return [Array<String>, nil]
             optional :credit_grant_type_filters, MetronomeSDK::Internal::Type::ArrayOf[String]
@@ -88,30 +89,31 @@ module MetronomeSDK
             optional :credit_type, -> { MetronomeSDK::CreditTypeData }, nil?: true
 
             # @!attribute custom_field_filters
-            #   A list of custom field filters for alert types that support advanced filtering
+            #   A list of custom field filters for notification types that support advanced
+            #   filtering
             #
             #   @return [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::CustomFieldFilter>, nil]
             optional :custom_field_filters,
                      -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CustomerAlert::Alert::CustomFieldFilter] }
 
             # @!attribute group_key_filter
-            #   Scopes alert evaluation to a specific presentation group key on individual line
-            #   items. Only present for spend alerts.
+            #   Scopes threshold notification evaluation to a specific presentation group key on
+            #   individual line items. Only present for spend notifications.
             #
             #   @return [MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::GroupKeyFilter, nil]
             optional :group_key_filter, -> { MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupKeyFilter }
 
             # @!attribute group_values
-            #   Only present for `spend_threshold_reached` alerts. Scope alert to a specific
-            #   group key on individual line items.
+            #   Only present for `spend_threshold_reached` notifications. Scope notification to
+            #   a specific group key on individual line items.
             #
             #   @return [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::GroupValue>, nil]
             optional :group_values,
                      -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupValue] }
 
             # @!attribute invoice_types_filter
-            #   Only supported for invoice_total_reached alerts. A list of invoice types to
-            #   evaluate.
+            #   Only supported for invoice_total_reached threshold notifications. A list of
+            #   invoice types to evaluate.
             #
             #   @return [Array<String>, nil]
             optional :invoice_types_filter, MetronomeSDK::Internal::Type::ArrayOf[String]
@@ -128,33 +130,33 @@ module MetronomeSDK
             #   Some parameter documentations has been truncated, see
             #   {MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert} for more details.
             #
-            #   @param id [String] the Metronome ID of the alert
+            #   @param id [String] the Metronome ID of the threshold notification
             #
-            #   @param name [String] Name of the alert
+            #   @param name [String] Name of the threshold notification
             #
-            #   @param status [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::Status] Status of the alert
+            #   @param status [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::Status] Status of the threshold notification
             #
-            #   @param threshold [Float] Threshold value of the alert policy
+            #   @param threshold [Float] Threshold value of the notification policy
             #
-            #   @param type [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::Type] Type of the alert
+            #   @param type [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::Type] Type of the threshold notification
             #
-            #   @param updated_at [Time] Timestamp for when the alert was last updated
+            #   @param updated_at [Time] Timestamp for when the threshold notification was last updated
             #
-            #   @param credit_grant_type_filters [Array<String>] An array of strings, representing a way to filter the credit grant this alert ap
+            #   @param credit_grant_type_filters [Array<String>] An array of strings, representing a way to filter the credit grant this threshol
             #
             #   @param credit_type [MetronomeSDK::Models::CreditTypeData, nil]
             #
-            #   @param custom_field_filters [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::CustomFieldFilter>] A list of custom field filters for alert types that support advanced filtering
+            #   @param custom_field_filters [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::CustomFieldFilter>] A list of custom field filters for notification types that support advanced filt
             #
-            #   @param group_key_filter [MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::GroupKeyFilter] Scopes alert evaluation to a specific presentation group key on individual line
+            #   @param group_key_filter [MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::GroupKeyFilter] Scopes threshold notification evaluation to a specific presentation group key on
             #
-            #   @param group_values [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::GroupValue>] Only present for `spend_threshold_reached` alerts. Scope alert to a specific gro
+            #   @param group_values [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::GroupValue>] Only present for `spend_threshold_reached` notifications. Scope notification to
             #
-            #   @param invoice_types_filter [Array<String>] Only supported for invoice_total_reached alerts. A list of invoice types to eval
+            #   @param invoice_types_filter [Array<String>] Only supported for invoice_total_reached threshold notifications. A list of invo
             #
             #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
 
-            # Status of the alert
+            # Status of the threshold notification
             #
             # @see MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert#status
             module Status
@@ -168,7 +170,7 @@ module MetronomeSDK
               #   @return [Array<Symbol>]
             end
 
-            # Type of the alert
+            # Type of the threshold notification
             #
             # @see MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert#type
             module Type
@@ -189,6 +191,7 @@ module MetronomeSDK
               LOW_REMAINING_CONTRACT_CREDIT_PERCENTAGE_REACHED = :low_remaining_contract_credit_percentage_reached
               LOW_REMAINING_CONTRACT_CREDIT_AND_COMMIT_BALANCE_REACHED =
                 :low_remaining_contract_credit_and_commit_balance_reached
+              LOW_REMAINING_SEAT_BALANCE_REACHED = :low_remaining_seat_balance_reached
               INVOICE_TOTAL_REACHED = :invoice_total_reached
 
               # @!method self.values
@@ -243,8 +246,8 @@ module MetronomeSDK
               required :value, String
 
               # @!method initialize(key:, value:)
-              #   Scopes alert evaluation to a specific presentation group key on individual line
-              #   items. Only present for spend alerts.
+              #   Scopes threshold notification evaluation to a specific presentation group key on
+              #   individual line items. Only present for spend notifications.
               #
               #   @param key [String]
               #   @param value [String]
@@ -267,8 +270,8 @@ module MetronomeSDK
             end
           end
 
-          # The status of the customer alert. If the alert is archived, null will be
-          # returned.
+          # The status of the threshold notification. If the notification is archived, null
+          # will be returned.
           #
           # @see MetronomeSDK::Models::V1::Customers::CustomerAlert#customer_status
           module CustomerStatus