metronome-sdk 3.5.0 → 3.6.0

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

@@ -206,12 +206,6 @@ module MetronomeSDK
           #   @return [String, nil]
           optional :netsuite_sales_order_id, String
 
-          # @!attribute payment_gate_config
-          #   optionally payment gate this commit
-          #
-          #   @return [MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig, nil]
-          optional :payment_gate_config, -> { MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig }
-
           # @!attribute priority
           #   If multiple commits are applicable, the one with the lower priority will apply
           #   first.
@@ -246,7 +240,7 @@ module MetronomeSDK
           #   @return [String, nil]
           optional :temporary_id, String
 
-          # @!method initialize(product_id:, type:, access_schedule: nil, amount: nil, applicable_product_ids: nil, applicable_product_tags: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, invoice_schedule: nil, name: nil, netsuite_sales_order_id: nil, payment_gate_config: nil, priority: nil, rate_type: nil, rollover_fraction: nil, specifiers: nil, temporary_id: nil)
+          # @!method initialize(product_id:, type:, access_schedule: nil, amount: nil, applicable_product_ids: nil, applicable_product_tags: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, invoice_schedule: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, rollover_fraction: nil, specifiers: nil, temporary_id: nil)
           #   Some parameter documentations has been truncated, see
           #   {MetronomeSDK::Models::V1::ContractAmendParams::Commit} for more details.
           #
@@ -274,8 +268,6 @@ module MetronomeSDK
           #
           #   @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
           #
-          #   @param payment_gate_config [MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig] optionally payment gate this commit
-          #
           #   @param priority [Float] If multiple commits are applicable, the one with the lower priority will apply f
           #
           #   @param rate_type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::RateType]
@@ -541,174 +533,6 @@ module MetronomeSDK
             end
           end
 
-          # @see MetronomeSDK::Models::V1::ContractAmendParams::Commit#payment_gate_config
-          class PaymentGateConfig < MetronomeSDK::Internal::Type::BaseModel
-            # @!attribute payment_gate_type
-            #   Gate access to the commit balance based on successful collection of payment.
-            #   Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
-            #   facilitate payment using your own payment integration. Select NONE if you do not
-            #   wish to payment gate the commit balance.
-            #
-            #   @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::PaymentGateType]
-            required :payment_gate_type,
-                     enum: -> { MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::PaymentGateType }
-
-            # @!attribute precalculated_tax_config
-            #   Only applicable if using PRECALCULATED as your tax type.
-            #
-            #   @return [MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::PrecalculatedTaxConfig, nil]
-            optional :precalculated_tax_config,
-                     -> { MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::PrecalculatedTaxConfig }
-
-            # @!attribute stripe_config
-            #   Only applicable if using STRIPE as your payment gate type.
-            #
-            #   @return [MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig, nil]
-            optional :stripe_config,
-                     -> { MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig }
-
-            # @!attribute tax_type
-            #   Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
-            #   not wish Metronome to calculate tax on your behalf. Leaving this field blank
-            #   will default to NONE.
-            #
-            #   @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::TaxType, nil]
-            optional :tax_type, enum: -> { MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::TaxType }
-
-            # @!method initialize(payment_gate_type:, precalculated_tax_config: nil, stripe_config: nil, tax_type: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig} for
-            #   more details.
-            #
-            #   optionally payment gate this commit
-            #
-            #   @param payment_gate_type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
-            #
-            #   @param precalculated_tax_config [MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::PrecalculatedTaxConfig] Only applicable if using PRECALCULATED as your tax type.
-            #
-            #   @param stripe_config [MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig] Only applicable if using STRIPE as your payment gate type.
-            #
-            #   @param tax_type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
-
-            # Gate access to the commit balance based on successful collection of payment.
-            # Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
-            # facilitate payment using your own payment integration. Select NONE if you do not
-            # wish to payment gate the commit balance.
-            #
-            # @see MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig#payment_gate_type
-            module PaymentGateType
-              extend MetronomeSDK::Internal::Type::Enum
-
-              NONE = :NONE
-              STRIPE = :STRIPE
-              EXTERNAL = :EXTERNAL
-
-              # @!method self.values
-              #   @return [Array<Symbol>]
-            end
-
-            # @see MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig#precalculated_tax_config
-            class PrecalculatedTaxConfig < MetronomeSDK::Internal::Type::BaseModel
-              # @!attribute tax_amount
-              #   Amount of tax to be applied. This should be in the same currency and
-              #   denomination as the commit's invoice schedule
-              #
-              #   @return [Float]
-              required :tax_amount, Float
-
-              # @!attribute tax_name
-              #   Name of the tax to be applied. This may be used in an invoice line item
-              #   description.
-              #
-              #   @return [String, nil]
-              optional :tax_name, String
-
-              # @!method initialize(tax_amount:, tax_name: nil)
-              #   Some parameter documentations has been truncated, see
-              #   {MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::PrecalculatedTaxConfig}
-              #   for more details.
-              #
-              #   Only applicable if using PRECALCULATED as your tax type.
-              #
-              #   @param tax_amount [Float] Amount of tax to be applied. This should be in the same currency and denominatio
-              #
-              #   @param tax_name [String] Name of the tax to be applied. This may be used in an invoice line item descript
-            end
-
-            # @see MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig#stripe_config
-            class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
-              # @!attribute payment_type
-              #   If left blank, will default to INVOICE
-              #
-              #   @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig::PaymentType]
-              required :payment_type,
-                       enum: -> { MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig::PaymentType }
-
-              # @!attribute invoice_metadata
-              #   Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
-              #   your payment type.
-              #
-              #   @return [Hash{Symbol=>String}, nil]
-              optional :invoice_metadata, MetronomeSDK::Internal::Type::HashOf[String]
-
-              # @!attribute on_session_payment
-              #   If true, the payment will be made assuming the customer is present (i.e. on
-              #   session).
-              #
-              #   If false, the payment will be made assuming the customer is not present (i.e.
-              #   off session). For cardholders from a country with an e-mandate requirement (e.g.
-              #   India), the payment may be declined.
-              #
-              #   If left blank, will default to false.
-              #
-              #   @return [Boolean, nil]
-              optional :on_session_payment, MetronomeSDK::Internal::Type::Boolean
-
-              # @!method initialize(payment_type:, invoice_metadata: nil, on_session_payment: nil)
-              #   Some parameter documentations has been truncated, see
-              #   {MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig}
-              #   for more details.
-              #
-              #   Only applicable if using STRIPE as your payment gate type.
-              #
-              #   @param payment_type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
-              #
-              #   @param invoice_metadata [Hash{Symbol=>String}] Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
-              #
-              #   @param on_session_payment [Boolean] If true, the payment will be made assuming the customer is present (i.e. on sess
-
-              # If left blank, will default to INVOICE
-              #
-              # @see MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig#payment_type
-              module PaymentType
-                extend MetronomeSDK::Internal::Type::Enum
-
-                INVOICE = :INVOICE
-                PAYMENT_INTENT = :PAYMENT_INTENT
-
-                # @!method self.values
-                #   @return [Array<Symbol>]
-              end
-            end
-
-            # Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
-            # not wish Metronome to calculate tax on your behalf. Leaving this field blank
-            # will default to NONE.
-            #
-            # @see MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig#tax_type
-            module TaxType
-              extend MetronomeSDK::Internal::Type::Enum
-
-              NONE = :NONE
-              STRIPE = :STRIPE
-              ANROK = :ANROK
-              PRECALCULATED = :PRECALCULATED
-
-              # @!method self.values
-              #   @return [Array<Symbol>]
-            end
-          end
-
           # @see MetronomeSDK::Models::V1::ContractAmendParams::Commit#rate_type
           module RateType
             extend MetronomeSDK::Internal::Type::Enum

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

@@ -105,7 +105,7 @@ module MetronomeSDK
         # @!attribute package_id
         #   If provided, provisions a customer on a package instead of creating a
         #   traditional contract. When specified, only customer_id, starting_at, package_id,
-        #   and uniqueness_key are allowed.
+        #   uniqueness_key, transition, and custom_fields are allowed.
         #
         #   @return [String, nil]
         optional :package_id, String
@@ -451,12 +451,6 @@ module MetronomeSDK
           #   @return [String, nil]
           optional :netsuite_sales_order_id, String
 
-          # @!attribute payment_gate_config
-          #   optionally payment gate this commit
-          #
-          #   @return [MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig, nil]
-          optional :payment_gate_config, -> { MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig }
-
           # @!attribute priority
           #   If multiple commits are applicable, the one with the lower priority will apply
           #   first.
@@ -491,7 +485,7 @@ module MetronomeSDK
           #   @return [String, nil]
           optional :temporary_id, String
 
-          # @!method initialize(product_id:, type:, access_schedule: nil, amount: nil, applicable_product_ids: nil, applicable_product_tags: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, invoice_schedule: nil, name: nil, netsuite_sales_order_id: nil, payment_gate_config: nil, priority: nil, rate_type: nil, rollover_fraction: nil, specifiers: nil, temporary_id: nil)
+          # @!method initialize(product_id:, type:, access_schedule: nil, amount: nil, applicable_product_ids: nil, applicable_product_tags: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, invoice_schedule: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, rollover_fraction: nil, specifiers: nil, temporary_id: nil)
           #   Some parameter documentations has been truncated, see
           #   {MetronomeSDK::Models::V1::ContractCreateParams::Commit} for more details.
           #
@@ -519,8 +513,6 @@ module MetronomeSDK
           #
           #   @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
           #
-          #   @param payment_gate_config [MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig] optionally payment gate this commit
-          #
           #   @param priority [Float] If multiple commits are applicable, the one with the lower priority will apply f
           #
           #   @param rate_type [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Commit::RateType]
@@ -786,175 +778,6 @@ module MetronomeSDK
             end
           end
 
-          # @see MetronomeSDK::Models::V1::ContractCreateParams::Commit#payment_gate_config
-          class PaymentGateConfig < MetronomeSDK::Internal::Type::BaseModel
-            # @!attribute payment_gate_type
-            #   Gate access to the commit balance based on successful collection of payment.
-            #   Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
-            #   facilitate payment using your own payment integration. Select NONE if you do not
-            #   wish to payment gate the commit balance.
-            #
-            #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig::PaymentGateType]
-            required :payment_gate_type,
-                     enum: -> { MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig::PaymentGateType }
-
-            # @!attribute precalculated_tax_config
-            #   Only applicable if using PRECALCULATED as your tax type.
-            #
-            #   @return [MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig::PrecalculatedTaxConfig, nil]
-            optional :precalculated_tax_config,
-                     -> { MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig::PrecalculatedTaxConfig }
-
-            # @!attribute stripe_config
-            #   Only applicable if using STRIPE as your payment gate type.
-            #
-            #   @return [MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig, nil]
-            optional :stripe_config,
-                     -> { MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig }
-
-            # @!attribute tax_type
-            #   Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
-            #   not wish Metronome to calculate tax on your behalf. Leaving this field blank
-            #   will default to NONE.
-            #
-            #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig::TaxType, nil]
-            optional :tax_type,
-                     enum: -> { MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig::TaxType }
-
-            # @!method initialize(payment_gate_type:, precalculated_tax_config: nil, stripe_config: nil, tax_type: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig} for
-            #   more details.
-            #
-            #   optionally payment gate this commit
-            #
-            #   @param payment_gate_type [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
-            #
-            #   @param precalculated_tax_config [MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig::PrecalculatedTaxConfig] Only applicable if using PRECALCULATED as your tax type.
-            #
-            #   @param stripe_config [MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig] Only applicable if using STRIPE as your payment gate type.
-            #
-            #   @param tax_type [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
-
-            # Gate access to the commit balance based on successful collection of payment.
-            # Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
-            # facilitate payment using your own payment integration. Select NONE if you do not
-            # wish to payment gate the commit balance.
-            #
-            # @see MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig#payment_gate_type
-            module PaymentGateType
-              extend MetronomeSDK::Internal::Type::Enum
-
-              NONE = :NONE
-              STRIPE = :STRIPE
-              EXTERNAL = :EXTERNAL
-
-              # @!method self.values
-              #   @return [Array<Symbol>]
-            end
-
-            # @see MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig#precalculated_tax_config
-            class PrecalculatedTaxConfig < MetronomeSDK::Internal::Type::BaseModel
-              # @!attribute tax_amount
-              #   Amount of tax to be applied. This should be in the same currency and
-              #   denomination as the commit's invoice schedule
-              #
-              #   @return [Float]
-              required :tax_amount, Float
-
-              # @!attribute tax_name
-              #   Name of the tax to be applied. This may be used in an invoice line item
-              #   description.
-              #
-              #   @return [String, nil]
-              optional :tax_name, String
-
-              # @!method initialize(tax_amount:, tax_name: nil)
-              #   Some parameter documentations has been truncated, see
-              #   {MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig::PrecalculatedTaxConfig}
-              #   for more details.
-              #
-              #   Only applicable if using PRECALCULATED as your tax type.
-              #
-              #   @param tax_amount [Float] Amount of tax to be applied. This should be in the same currency and denominatio
-              #
-              #   @param tax_name [String] Name of the tax to be applied. This may be used in an invoice line item descript
-            end
-
-            # @see MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig#stripe_config
-            class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
-              # @!attribute payment_type
-              #   If left blank, will default to INVOICE
-              #
-              #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig::PaymentType]
-              required :payment_type,
-                       enum: -> { MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig::PaymentType }
-
-              # @!attribute invoice_metadata
-              #   Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
-              #   your payment type.
-              #
-              #   @return [Hash{Symbol=>String}, nil]
-              optional :invoice_metadata, MetronomeSDK::Internal::Type::HashOf[String]
-
-              # @!attribute on_session_payment
-              #   If true, the payment will be made assuming the customer is present (i.e. on
-              #   session).
-              #
-              #   If false, the payment will be made assuming the customer is not present (i.e.
-              #   off session). For cardholders from a country with an e-mandate requirement (e.g.
-              #   India), the payment may be declined.
-              #
-              #   If left blank, will default to false.
-              #
-              #   @return [Boolean, nil]
-              optional :on_session_payment, MetronomeSDK::Internal::Type::Boolean
-
-              # @!method initialize(payment_type:, invoice_metadata: nil, on_session_payment: nil)
-              #   Some parameter documentations has been truncated, see
-              #   {MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig}
-              #   for more details.
-              #
-              #   Only applicable if using STRIPE as your payment gate type.
-              #
-              #   @param payment_type [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
-              #
-              #   @param invoice_metadata [Hash{Symbol=>String}] Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
-              #
-              #   @param on_session_payment [Boolean] If true, the payment will be made assuming the customer is present (i.e. on sess
-
-              # If left blank, will default to INVOICE
-              #
-              # @see MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig#payment_type
-              module PaymentType
-                extend MetronomeSDK::Internal::Type::Enum
-
-                INVOICE = :INVOICE
-                PAYMENT_INTENT = :PAYMENT_INTENT
-
-                # @!method self.values
-                #   @return [Array<Symbol>]
-              end
-            end
-
-            # Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
-            # not wish Metronome to calculate tax on your behalf. Leaving this field blank
-            # will default to NONE.
-            #
-            # @see MetronomeSDK::Models::V1::ContractCreateParams::Commit::PaymentGateConfig#tax_type
-            module TaxType
-              extend MetronomeSDK::Internal::Type::Enum
-
-              NONE = :NONE
-              STRIPE = :STRIPE
-              ANROK = :ANROK
-              PRECALCULATED = :PRECALCULATED
-
-              # @!method self.values
-              #   @return [Array<Symbol>]
-            end
-          end
-
           # @see MetronomeSDK::Models::V1::ContractCreateParams::Commit#rate_type
           module RateType
             extend MetronomeSDK::Internal::Type::Enum

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

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Contracts#list_seat_balances
+      class ContractListSeatBalancesParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # @!attribute contract_id
+        #   The contract ID to retrieve seat balances for
+        #
+        #   @return [String]
+        required :contract_id, String
+
+        # @!attribute customer_id
+        #   The customer ID to retrieve seat balances for
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!attribute covering_date
+        #   Include only commits or credits with access that cover this specific date
+        #   (cannot be used with starting_at or ending_before).
+        #
+        #   @return [Time, nil]
+        optional :covering_date, Time
+
+        # @!attribute cursor
+        #   Page token from a previous response to retrieve the next page
+        #
+        #   @return [String, nil]
+        optional :cursor, String
+
+        # @!attribute effective_before
+        #   Include only commits or credits with access effective on or before this date
+        #   (cannot be used with covering_date).
+        #
+        #   @return [Time, nil]
+        optional :effective_before, Time
+
+        # @!attribute include_credits_and_commits
+        #   Include credits and commits in the response
+        #
+        #   @return [Boolean, nil]
+        optional :include_credits_and_commits, MetronomeSDK::Internal::Type::Boolean
+
+        # @!attribute include_ledgers
+        #   Include ledger entries for each commit and commit. `include_credits_and_commits`
+        #   must be set to `true` for `include_ledgers=true` to apply.
+        #
+        #   @return [Boolean, nil]
+        optional :include_ledgers, MetronomeSDK::Internal::Type::Boolean
+
+        # @!attribute limit
+        #   Maximum number of seats to return. Range: 1-100. Default: 25. When
+        #   `include_credits_and_commits = true`, if the total commits/credits across all
+        #   seats exceeds 100, a limit of 100 applies to the total credits and commits.
+        #   Seats are included greedily to maximize the number of seats returned. Example:
+        #   if seat 1 has 98 commits and seat 2 has 10 commits, both seats will be returned
+        #   (total: 108 commits). Each returned seat includes all of its associated credits
+        #   and commits.
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!attribute seat_ids
+        #   Optional filter to only include specific seats.
+        #
+        #   @return [Array<String>, nil]
+        optional :seat_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+        # @!attribute starting_at
+        #   Include only commits or credits with access effective on or after this date
+        #   (cannot be used with covering_date).
+        #
+        #   @return [Time, nil]
+        optional :starting_at, Time
+
+        # @!attribute subscription_ids
+        #   Optional filter to only include seats from specific subscriptions. If
+        #   subscriptions ids are not mapped to SEAT_BASED subscriptions, error will be
+        #   returned.
+        #
+        #   @return [Array<String>, nil]
+        optional :subscription_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(contract_id:, customer_id:, covering_date: nil, cursor: nil, effective_before: nil, include_credits_and_commits: nil, include_ledgers: nil, limit: nil, seat_ids: nil, starting_at: nil, subscription_ids: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::V1::ContractListSeatBalancesParams} for more details.
+        #
+        #   @param contract_id [String] The contract ID to retrieve seat balances for
+        #
+        #   @param customer_id [String] The customer ID to retrieve seat balances for
+        #
+        #   @param covering_date [Time] Include only commits or credits with access that cover this specific date (canno
+        #
+        #   @param cursor [String] Page token from a previous response to retrieve the next page
+        #
+        #   @param effective_before [Time] Include only commits or credits with access effective on or before this date (ca
+        #
+        #   @param include_credits_and_commits [Boolean] Include credits and commits in the response
+        #
+        #   @param include_ledgers [Boolean] Include ledger entries for each commit and commit. `include_credits_and_commits`
+        #
+        #   @param limit [Integer] Maximum number of seats to return. Range: 1-100. Default: 25.
+        #
+        #   @param seat_ids [Array<String>] Optional filter to only include specific seats.
+        #
+        #   @param starting_at [Time] Include only commits or credits with access effective on or after this date (can
+        #
+        #   @param subscription_ids [Array<String>] Optional filter to only include seats from specific subscriptions. If subscripti
+        #
+        #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end