metronome-sdk 1.0.0 → 2.1.0

data/rbi/metronome_sdk/models/v1/alert_create_params.rbi

@@ -15,39 +15,41 @@ module MetronomeSDK
             )
           end
 
-        # Type of the alert
+        # Type of the threshold notification
         sig do
           returns(MetronomeSDK::V1::AlertCreateParams::AlertType::OrSymbol)
         end
         attr_accessor :alert_type
 
-        # Name of the alert
+        # Name of the threshold notification
         sig { returns(String) }
         attr_accessor :name
 
-        # Threshold value of the alert policy. Depending upon the alert type, this number
-        # may represent a financial amount, the days remaining, or a percentage reached.
+        # Threshold value of the notification policy. Depending upon the notification
+        # type, this number may represent a financial amount, the days remaining, or a
+        # percentage reached.
         sig { returns(Float) }
         attr_accessor :threshold
 
-        # For alerts of type `usage_threshold_reached`, specifies which billable metric to
-        # track the usage for.
+        # For threshold notifications of type `usage_threshold_reached`, specifies which
+        # billable metric to track the usage for.
         sig { returns(T.nilable(String)) }
         attr_reader :billable_metric_id
 
         sig { params(billable_metric_id: String).void }
         attr_writer :billable_metric_id
 
-        # 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
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :credit_grant_type_filters
 
         sig { params(credit_grant_type_filters: T::Array[String]).void }
         attr_writer :credit_grant_type_filters
 
-        # ID of the credit's currency, defaults to USD. If the specific alert type
+        # ID of the credit's currency, defaults to USD. If the specific notification type
         # requires a pricing unit/currency, find the ID in the
         # [Metronome app](https://app.metronome.com/offering/pricing-units).
         sig { returns(T.nilable(String)) }
@@ -56,8 +58,8 @@ module MetronomeSDK
         sig { params(credit_type_id: String).void }
         attr_writer :credit_type_id
 
-        # A list of custom field filters for alert types that support advanced filtering.
-        # Only present for contract invoices.
+        # A list of custom field filters for threshold notification types that support
+        # advanced filtering. Only present for contract invoices.
         sig do
           returns(
             T.nilable(
@@ -77,25 +79,25 @@ module MetronomeSDK
         end
         attr_writer :custom_field_filters
 
-        # If provided, will create this alert for this specific customer. To create an
-        # alert for all customers, do not specify a `customer_id`.
+        # If provided, will create this threshold notification for this specific customer.
+        # To create a notification for all customers, do not specify a `customer_id`.
         sig { returns(T.nilable(String)) }
         attr_reader :customer_id
 
         sig { params(customer_id: String).void }
         attr_writer :customer_id
 
-        # If true, the alert will evaluate immediately on customers that already meet the
-        # alert threshold. If false, it will only evaluate on future customers that
-        # trigger the alert threshold. Defaults to true.
+        # If true, the threshold notification will evaluate immediately on customers that
+        # already meet the notification threshold. If false, it will only evaluate on
+        # future customers that trigger the threshold. Defaults to true.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :evaluate_on_create
 
         sig { params(evaluate_on_create: T::Boolean).void }
         attr_writer :evaluate_on_create
 
-        # 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.
         sig do
           returns(
             T.nilable(T::Array[MetronomeSDK::V1::AlertCreateParams::GroupValue])
@@ -111,16 +113,16 @@ module MetronomeSDK
         end
         attr_writer :group_values
 
-        # 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.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :invoice_types_filter
 
         sig { params(invoice_types_filter: T::Array[String]).void }
         attr_writer :invoice_types_filter
 
-        # If provided, will create this alert for this specific plan. To create an alert
-        # for all customers, do not specify a `plan_id`.
+        # If provided, will create this threshold notification for this specific plan. To
+        # create a notification for all customers, do not specify a `plan_id`.
         sig { returns(T.nilable(String)) }
         attr_reader :plan_id
 
@@ -160,42 +162,44 @@ module MetronomeSDK
           ).returns(T.attached_class)
         end
         def self.new(
-          # Type of the alert
+          # Type of the threshold notification
           alert_type:,
-          # Name of the alert
+          # Name of the threshold notification
           name:,
-          # Threshold value of the alert policy. Depending upon the alert type, this number
-          # may represent a financial amount, the days remaining, or a percentage reached.
+          # Threshold value of the notification policy. Depending upon the notification
+          # type, this number may represent a financial amount, the days remaining, or a
+          # percentage reached.
           threshold:,
-          # For alerts of type `usage_threshold_reached`, specifies which billable metric to
-          # track the usage for.
+          # For threshold notifications of type `usage_threshold_reached`, specifies which
+          # billable metric to track the usage for.
           billable_metric_id: nil,
-          # 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
           credit_grant_type_filters: nil,
-          # ID of the credit's currency, defaults to USD. If the specific alert type
+          # ID of the credit's currency, defaults to USD. If the specific notification type
           # requires a pricing unit/currency, find the ID in the
           # [Metronome app](https://app.metronome.com/offering/pricing-units).
           credit_type_id: nil,
-          # A list of custom field filters for alert types that support advanced filtering.
-          # Only present for contract invoices.
+          # A list of custom field filters for threshold notification types that support
+          # advanced filtering. Only present for contract invoices.
           custom_field_filters: nil,
-          # If provided, will create this alert for this specific customer. To create an
-          # alert for all customers, do not specify a `customer_id`.
+          # If provided, will create this threshold notification for this specific customer.
+          # To create a notification for all customers, do not specify a `customer_id`.
           customer_id: nil,
-          # If true, the alert will evaluate immediately on customers that already meet the
-          # alert threshold. If false, it will only evaluate on future customers that
-          # trigger the alert threshold. Defaults to true.
+          # If true, the threshold notification will evaluate immediately on customers that
+          # already meet the notification threshold. If false, it will only evaluate on
+          # future customers that trigger the threshold. Defaults to true.
           evaluate_on_create: nil,
-          # 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.
           group_values: nil,
-          # 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.
           invoice_types_filter: nil,
-          # If provided, will create this alert for this specific plan. To create an alert
-          # for all customers, do not specify a `plan_id`.
+          # If provided, will create this threshold notification for this specific plan. To
+          # create a notification for all customers, do not specify a `plan_id`.
           plan_id: nil,
           # Prevents the creation of duplicates. If a request to create a record is made
           # with a previously used uniqueness key, a new record will not be created and the
@@ -233,7 +237,7 @@ module MetronomeSDK
         def to_hash
         end
 
-        # Type of the alert
+        # Type of the threshold notification
         module AlertType
           extend MetronomeSDK::Internal::Type::Enum
 

data/rbi/metronome_sdk/models/v1/contract_amend_params.rbi

@@ -1469,6 +1469,11 @@ module MetronomeSDK
                   :ANROK,
                   MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::TaxType::TaggedSymbol
                 )
+              AVALARA =
+                T.let(
+                  :AVALARA,
+                  MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::TaxType::TaggedSymbol
+                )
               PRECALCULATED =
                 T.let(
                   :PRECALCULATED,

data/rbi/metronome_sdk/models/v1/contract_create_params.rbi

@@ -2011,6 +2011,11 @@ module MetronomeSDK
                   :ANROK,
                   MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig::TaxType::TaggedSymbol
                 )
+              AVALARA =
+                T.let(
+                  :AVALARA,
+                  MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig::TaxType::TaggedSymbol
+                )
               PRECALCULATED =
                 T.let(
                   :PRECALCULATED,
@@ -2888,7 +2893,9 @@ module MetronomeSDK
 
           sig do
             returns(
-              MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::Parent
+              T.nilable(
+                MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::Parent
+              )
             )
           end
           attr_reader :parent
@@ -2901,20 +2908,116 @@ module MetronomeSDK
           end
           attr_writer :parent
 
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior
+              )
+            )
+          end
+          attr_reader :parent_behavior
+
+          sig do
+            params(
+              parent_behavior:
+                MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior::OrHash
+            ).void
+          end
+          attr_writer :parent_behavior
+
+          # Account hierarchy M3 - Indicates which customer should pay for the child's
+          # invoice charges
+          #
+          # **SELF**: The child pays for its own invoice charges
+          #
+          # **PARENT**: The parent pays for the child's invoice charges
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::Payer::OrSymbol
+              )
+            )
+          end
+          attr_reader :payer
+
+          sig do
+            params(
+              payer:
+                MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::Payer::OrSymbol
+            ).void
+          end
+          attr_writer :payer
+
+          # Account hierarchy M3 - Indicates the behavior of the child's invoice statements
+          # on the parent's invoices.
+          #
+          # **CONSOLIDATE**: Child's invoice statements will be added to parent's
+          # consolidated invoices
+          #
+          # **SEPARATE**: Child's invoice statements will appear not appear on parent's
+          # consolidated invoices
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::UsageStatementBehavior::OrSymbol
+              )
+            )
+          end
+          attr_reader :usage_statement_behavior
+
+          sig do
+            params(
+              usage_statement_behavior:
+                MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::UsageStatementBehavior::OrSymbol
+            ).void
+          end
+          attr_writer :usage_statement_behavior
+
           sig do
             params(
               parent:
-                MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::Parent::OrHash
+                MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::Parent::OrHash,
+              parent_behavior:
+                MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior::OrHash,
+              payer:
+                MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::Payer::OrSymbol,
+              usage_statement_behavior:
+                MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::UsageStatementBehavior::OrSymbol
             ).returns(T.attached_class)
           end
-          def self.new(parent:)
+          def self.new(
+            parent: nil,
+            parent_behavior: nil,
+            # Account hierarchy M3 - Indicates which customer should pay for the child's
+            # invoice charges
+            #
+            # **SELF**: The child pays for its own invoice charges
+            #
+            # **PARENT**: The parent pays for the child's invoice charges
+            payer: nil,
+            # Account hierarchy M3 - Indicates the behavior of the child's invoice statements
+            # on the parent's invoices.
+            #
+            # **CONSOLIDATE**: Child's invoice statements will be added to parent's
+            # consolidated invoices
+            #
+            # **SEPARATE**: Child's invoice statements will appear not appear on parent's
+            # consolidated invoices
+            usage_statement_behavior: nil
+          )
           end
 
           sig do
             override.returns(
               {
                 parent:
-                  MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::Parent
+                  MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::Parent,
+                parent_behavior:
+                  MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior,
+                payer:
+                  MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::Payer::OrSymbol,
+                usage_statement_behavior:
+                  MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::UsageStatementBehavior::OrSymbol
               }
             )
           end
@@ -2950,6 +3053,192 @@ module MetronomeSDK
             def to_hash
             end
           end
+
+          class ParentBehavior < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            # Account hierarchy M3 - Indicates the desired behavior of consolidated invoices
+            # generated by the parent in a customer hierarchy
+            #
+            # **CONCATENATE**: Statements on the invoices of child customers will be appended
+            # to the consolidated invoice
+            #
+            # **NONE**: Do not generate consolidated invoices
+            sig do
+              returns(
+                T.nilable(
+                  MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior::InvoiceConsolidationType::OrSymbol
+                )
+              )
+            end
+            attr_reader :invoice_consolidation_type
+
+            sig do
+              params(
+                invoice_consolidation_type:
+                  MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior::InvoiceConsolidationType::OrSymbol
+              ).void
+            end
+            attr_writer :invoice_consolidation_type
+
+            sig do
+              params(
+                invoice_consolidation_type:
+                  MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior::InvoiceConsolidationType::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Account hierarchy M3 - Indicates the desired behavior of consolidated invoices
+              # generated by the parent in a customer hierarchy
+              #
+              # **CONCATENATE**: Statements on the invoices of child customers will be appended
+              # to the consolidated invoice
+              #
+              # **NONE**: Do not generate consolidated invoices
+              invoice_consolidation_type: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  invoice_consolidation_type:
+                    MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior::InvoiceConsolidationType::OrSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # Account hierarchy M3 - Indicates the desired behavior of consolidated invoices
+            # generated by the parent in a customer hierarchy
+            #
+            # **CONCATENATE**: Statements on the invoices of child customers will be appended
+            # to the consolidated invoice
+            #
+            # **NONE**: Do not generate consolidated invoices
+            module InvoiceConsolidationType
+              extend MetronomeSDK::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior::InvoiceConsolidationType
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              CONCATENATE =
+                T.let(
+                  :CONCATENATE,
+                  MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior::InvoiceConsolidationType::TaggedSymbol
+                )
+              NONE =
+                T.let(
+                  :NONE,
+                  MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior::InvoiceConsolidationType::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior::InvoiceConsolidationType::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+
+          # Account hierarchy M3 - Indicates which customer should pay for the child's
+          # invoice charges
+          #
+          # **SELF**: The child pays for its own invoice charges
+          #
+          # **PARENT**: The parent pays for the child's invoice charges
+          module Payer
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::Payer
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            SELF =
+              T.let(
+                :SELF,
+                MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::Payer::TaggedSymbol
+              )
+            PARENT =
+              T.let(
+                :PARENT,
+                MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::Payer::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::Payer::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # Account hierarchy M3 - Indicates the behavior of the child's invoice statements
+          # on the parent's invoices.
+          #
+          # **CONSOLIDATE**: Child's invoice statements will be added to parent's
+          # consolidated invoices
+          #
+          # **SEPARATE**: Child's invoice statements will appear not appear on parent's
+          # consolidated invoices
+          module UsageStatementBehavior
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::UsageStatementBehavior
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CONSOLIDATE =
+              T.let(
+                :CONSOLIDATE,
+                MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::UsageStatementBehavior::TaggedSymbol
+              )
+            SEPARATE =
+              T.let(
+                :SEPARATE,
+                MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::UsageStatementBehavior::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::UsageStatementBehavior::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
 
         # Defaults to LOWEST_MULTIPLIER, which applies the greatest discount to list
@@ -4499,7 +4788,9 @@ module MetronomeSDK
             sig { returns(String) }
             attr_accessor :subscription_id
 
-            # If set to POOLED, allocation added per seat is pooled across the account.
+            # If set to POOLED, allocation added per seat is pooled across the account. (BETA)
+            # If set to INDIVIDUAL, each seat in the subscription will have its own
+            # allocation.
             sig do
               returns(
                 T.nilable(
@@ -4531,7 +4822,9 @@ module MetronomeSDK
               apply_seat_increase_config:,
               # ID of the subscription to configure on the recurring commit/credit.
               subscription_id:,
-              # If set to POOLED, allocation added per seat is pooled across the account.
+              # If set to POOLED, allocation added per seat is pooled across the account. (BETA)
+              # If set to INDIVIDUAL, each seat in the subscription will have its own
+              # allocation.
               allocation: nil
             )
             end
@@ -4575,7 +4868,9 @@ module MetronomeSDK
               end
             end
 
-            # If set to POOLED, allocation added per seat is pooled across the account.
+            # If set to POOLED, allocation added per seat is pooled across the account. (BETA)
+            # If set to INDIVIDUAL, each seat in the subscription will have its own
+            # allocation.
             module Allocation
               extend MetronomeSDK::Internal::Type::Enum
 
@@ -5240,7 +5535,9 @@ module MetronomeSDK
             sig { returns(String) }
             attr_accessor :subscription_id
 
-            # If set to POOLED, allocation added per seat is pooled across the account.
+            # If set to POOLED, allocation added per seat is pooled across the account. (BETA)
+            # If set to INDIVIDUAL, each seat in the subscription will have its own
+            # allocation.
             sig do
               returns(
                 T.nilable(
@@ -5272,7 +5569,9 @@ module MetronomeSDK
               apply_seat_increase_config:,
               # ID of the subscription to configure on the recurring commit/credit.
               subscription_id:,
-              # If set to POOLED, allocation added per seat is pooled across the account.
+              # If set to POOLED, allocation added per seat is pooled across the account. (BETA)
+              # If set to INDIVIDUAL, each seat in the subscription will have its own
+              # allocation.
               allocation: nil
             )
             end
@@ -5316,7 +5615,9 @@ module MetronomeSDK
               end
             end
 
-            # If set to POOLED, allocation added per seat is pooled across the account.
+            # If set to POOLED, allocation added per seat is pooled across the account. (BETA)
+            # If set to INDIVIDUAL, each seat in the subscription will have its own
+            # allocation.
             module Allocation
               extend MetronomeSDK::Internal::Type::Enum
 
@@ -6225,6 +6526,11 @@ module MetronomeSDK
           # QUANTITY_ONLY. **QUANTITY_ONLY**: The subscription quantity is specified
           # directly on the subscription. `initial_quantity` must be provided with this
           # option. Compatible with recurring commits/credits that use POOLED allocation.
+          # **SEAT_BASED**: (BETA) Use when you want to pass specific seat identifiers (e.g.
+          # add user_123) to increment and decrement a subscription quantity, rather than
+          # directly providing the quantity. You must use a **SEAT_BASED** subscription to
+          # use a linked recurring credit with an allocation per seat. `seat_config` must be
+          # provided with this option.
           sig do
             returns(
               T.nilable(
@@ -6295,6 +6601,11 @@ module MetronomeSDK
             # QUANTITY_ONLY. **QUANTITY_ONLY**: The subscription quantity is specified
             # directly on the subscription. `initial_quantity` must be provided with this
             # option. Compatible with recurring commits/credits that use POOLED allocation.
+            # **SEAT_BASED**: (BETA) Use when you want to pass specific seat identifiers (e.g.
+            # add user_123) to increment and decrement a subscription quantity, rather than
+            # directly providing the quantity. You must use a **SEAT_BASED** subscription to
+            # use a linked recurring credit with an allocation per seat. `seat_config` must be
+            # provided with this option.
             quantity_management_mode: nil,
             # Inclusive start time for the subscription. If not provided, defaults to contract
             # start date
@@ -6573,6 +6884,11 @@ module MetronomeSDK
           # QUANTITY_ONLY. **QUANTITY_ONLY**: The subscription quantity is specified
           # directly on the subscription. `initial_quantity` must be provided with this
           # option. Compatible with recurring commits/credits that use POOLED allocation.
+          # **SEAT_BASED**: (BETA) Use when you want to pass specific seat identifiers (e.g.
+          # add user_123) to increment and decrement a subscription quantity, rather than
+          # directly providing the quantity. You must use a **SEAT_BASED** subscription to
+          # use a linked recurring credit with an allocation per seat. `seat_config` must be
+          # provided with this option.
           module QuantityManagementMode
             extend MetronomeSDK::Internal::Type::Enum
 

data/rbi/metronome_sdk/models/v1/contract_list_balances_params.rbi

@@ -38,6 +38,13 @@ module MetronomeSDK
         sig { params(effective_before: Time).void }
         attr_writer :effective_before
 
+        # Exclude balances with zero amounts from the response.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :exclude_zero_balances
+
+        sig { params(exclude_zero_balances: T::Boolean).void }
+        attr_writer :exclude_zero_balances
+
         # Include archived credits and credits from archived contracts.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :include_archived
@@ -95,6 +102,7 @@ module MetronomeSDK
             id: String,
             covering_date: Time,
             effective_before: Time,
+            exclude_zero_balances: T::Boolean,
             include_archived: T::Boolean,
             include_balance: T::Boolean,
             include_contract_balances: T::Boolean,
@@ -112,6 +120,8 @@ module MetronomeSDK
           covering_date: nil,
           # Include only balances that have any access before the provided date (exclusive)
           effective_before: nil,
+          # Exclude balances with zero amounts from the response.
+          exclude_zero_balances: nil,
           # Include archived credits and credits from archived contracts.
           include_archived: nil,
           # Include the balance of credits and commits in the response. Setting this flag
@@ -139,6 +149,7 @@ module MetronomeSDK
               id: String,
               covering_date: Time,
               effective_before: Time,
+              exclude_zero_balances: T::Boolean,
               include_archived: T::Boolean,
               include_balance: T::Boolean,
               include_contract_balances: T::Boolean,