metronome-sdk 3.6.0 → 3.7.0

data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi

@@ -6700,6 +6700,17 @@ module MetronomeSDK
             sig { params(threshold_amount: Float).void }
             attr_writer :threshold_amount
 
+            sig do
+              returns(
+                T.nilable(
+                  T::Array[
+                    MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier
+                  ]
+                )
+              )
+            end
+            attr_accessor :threshold_balance_specifiers
+
             sig do
               params(
                 commit:
@@ -6712,7 +6723,13 @@ module MetronomeSDK
                 is_enabled: T::Boolean,
                 payment_gate_config: MetronomeSDK::PaymentGateConfigV2::OrHash,
                 recharge_to_amount: Float,
-                threshold_amount: Float
+                threshold_amount: Float,
+                threshold_balance_specifiers:
+                  T.nilable(
+                    T::Array[
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::OrHash
+                    ]
+                  )
               ).returns(T.attached_class)
             end
             def self.new(
@@ -6730,7 +6747,8 @@ module MetronomeSDK
               recharge_to_amount: nil,
               # Specify the threshold amount for the contract. Each time the contract's balance
               # lowers to this amount, a threshold charge will be initiated.
-              threshold_amount: nil
+              threshold_amount: nil,
+              threshold_balance_specifiers: nil
             )
             end
 
@@ -6747,7 +6765,13 @@ module MetronomeSDK
                   is_enabled: T::Boolean,
                   payment_gate_config: MetronomeSDK::PaymentGateConfigV2,
                   recharge_to_amount: Float,
-                  threshold_amount: Float
+                  threshold_amount: Float,
+                  threshold_balance_specifiers:
+                    T.nilable(
+                      T::Array[
+                        MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier
+                      ]
+                    )
                 }
               )
             end
@@ -6836,6 +6860,26 @@ module MetronomeSDK
                   )
                 end
 
+              # Update the discount cap. Set to null to remove an existing cap.
+              sig do
+                returns(
+                  T.nilable(
+                    MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::DiscountConfiguration::Cap
+                  )
+                )
+              end
+              attr_reader :cap
+
+              sig do
+                params(
+                  cap:
+                    T.nilable(
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::DiscountConfiguration::Cap::OrHash
+                    )
+                ).void
+              end
+              attr_writer :cap
+
               # The fraction of the original amount that the customer pays after applying the
               # discount. Set to null to remove the discount fraction. For example, 0.85 means
               # the customer pays 85% of the original amount (a 15% discount).
@@ -6843,11 +6887,17 @@ module MetronomeSDK
               attr_accessor :payment_fraction
 
               sig do
-                params(payment_fraction: T.nilable(Float)).returns(
-                  T.attached_class
-                )
+                params(
+                  cap:
+                    T.nilable(
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::DiscountConfiguration::Cap::OrHash
+                    ),
+                  payment_fraction: T.nilable(Float)
+                ).returns(T.attached_class)
               end
               def self.new(
+                # Update the discount cap. Set to null to remove an existing cap.
+                cap: nil,
                 # The fraction of the original amount that the customer pays after applying the
                 # discount. Set to null to remove the discount fraction. For example, 0.85 means
                 # the customer pays 85% of the original amount (a 15% discount).
@@ -6855,9 +6905,231 @@ module MetronomeSDK
               )
               end
 
-              sig { override.returns({ payment_fraction: T.nilable(Float) }) }
+              sig do
+                override.returns(
+                  {
+                    cap:
+                      T.nilable(
+                        MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::DiscountConfiguration::Cap
+                      ),
+                    payment_fraction: T.nilable(Float)
+                  }
+                )
+              end
               def to_hash
               end
+
+              class Cap < MetronomeSDK::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::DiscountConfiguration::Cap,
+                      MetronomeSDK::Internal::AnyHash
+                    )
+                  end
+
+                # Accumulated spend ceiling above which the discount stops applying.
+                sig { returns(Float) }
+                attr_accessor :amount
+
+                # Alias of the spend tracker this cap is measured against.
+                sig { returns(String) }
+                attr_accessor :spend_tracker_alias
+
+                # Update the discount cap. Set to null to remove an existing cap.
+                sig do
+                  params(amount: Float, spend_tracker_alias: String).returns(
+                    T.attached_class
+                  )
+                end
+                def self.new(
+                  # Accumulated spend ceiling above which the discount stops applying.
+                  amount:,
+                  # Alias of the spend tracker this cap is measured against.
+                  spend_tracker_alias:
+                )
+                end
+
+                sig do
+                  override.returns(
+                    { amount: Float, spend_tracker_alias: String }
+                  )
+                end
+                def to_hash
+                end
+              end
+            end
+
+            class ThresholdBalanceSpecifier < MetronomeSDK::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              sig do
+                returns(
+                  T::Array[
+                    MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude
+                  ]
+                )
+              end
+              attr_accessor :exclude
+
+              sig do
+                params(
+                  exclude:
+                    T::Array[
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::OrHash
+                    ]
+                ).returns(T.attached_class)
+              end
+              def self.new(exclude:)
+              end
+
+              sig do
+                override.returns(
+                  {
+                    exclude:
+                      T::Array[
+                        MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude
+                      ]
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              class Exclude < MetronomeSDK::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude,
+                      MetronomeSDK::Internal::AnyHash
+                    )
+                  end
+
+                sig do
+                  returns(
+                    T::Array[
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter
+                    ]
+                  )
+                end
+                attr_accessor :custom_field_filters
+
+                sig do
+                  params(
+                    custom_field_filters:
+                      T::Array[
+                        MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter::OrHash
+                      ]
+                  ).returns(T.attached_class)
+                end
+                def self.new(custom_field_filters:)
+                end
+
+                sig do
+                  override.returns(
+                    {
+                      custom_field_filters:
+                        T::Array[
+                          MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter
+                        ]
+                    }
+                  )
+                end
+                def to_hash
+                end
+
+                class CustomFieldFilter < MetronomeSDK::Internal::Type::BaseModel
+                  OrHash =
+                    T.type_alias do
+                      T.any(
+                        MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter,
+                        MetronomeSDK::Internal::AnyHash
+                      )
+                    end
+
+                  sig do
+                    returns(
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter::Entity::TaggedSymbol
+                    )
+                  end
+                  attr_accessor :entity
+
+                  sig { returns(String) }
+                  attr_accessor :key
+
+                  sig { returns(String) }
+                  attr_accessor :value
+
+                  sig do
+                    params(
+                      entity:
+                        MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter::Entity::OrSymbol,
+                      key: String,
+                      value: String
+                    ).returns(T.attached_class)
+                  end
+                  def self.new(entity:, key:, value:)
+                  end
+
+                  sig do
+                    override.returns(
+                      {
+                        entity:
+                          MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter::Entity::TaggedSymbol,
+                        key: String,
+                        value: String
+                      }
+                    )
+                  end
+                  def to_hash
+                  end
+
+                  module Entity
+                    extend MetronomeSDK::Internal::Type::Enum
+
+                    TaggedSymbol =
+                      T.type_alias do
+                        T.all(
+                          Symbol,
+                          MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter::Entity
+                        )
+                      end
+                    OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                    COMMIT =
+                      T.let(
+                        :Commit,
+                        MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter::Entity::TaggedSymbol
+                      )
+                    CONTRACT_CREDIT =
+                      T.let(
+                        :ContractCredit,
+                        MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter::Entity::TaggedSymbol
+                      )
+                    CONTRACT_CREDIT_OR_COMMIT =
+                      T.let(
+                        :ContractCreditOrCommit,
+                        MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter::Entity::TaggedSymbol
+                      )
+
+                    sig do
+                      override.returns(
+                        T::Array[
+                          MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter::Entity::TaggedSymbol
+                        ]
+                      )
+                    end
+                    def self.values
+                    end
+                  end
+                end
+              end
             end
           end
 
@@ -7705,6 +7977,26 @@ module MetronomeSDK
                   )
                 end
 
+              # Update the discount cap. Set to null to remove an existing cap.
+              sig do
+                returns(
+                  T.nilable(
+                    MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::DiscountConfiguration::Cap
+                  )
+                )
+              end
+              attr_reader :cap
+
+              sig do
+                params(
+                  cap:
+                    T.nilable(
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::DiscountConfiguration::Cap::OrHash
+                    )
+                ).void
+              end
+              attr_writer :cap
+
               # The fraction of the original amount that the customer pays after applying the
               # discount. Set to null to remove the discount fraction. For example, 0.85 means
               # the customer pays 85% of the original amount (a 15% discount).
@@ -7712,11 +8004,17 @@ module MetronomeSDK
               attr_accessor :payment_fraction
 
               sig do
-                params(payment_fraction: T.nilable(Float)).returns(
-                  T.attached_class
-                )
+                params(
+                  cap:
+                    T.nilable(
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::DiscountConfiguration::Cap::OrHash
+                    ),
+                  payment_fraction: T.nilable(Float)
+                ).returns(T.attached_class)
               end
               def self.new(
+                # Update the discount cap. Set to null to remove an existing cap.
+                cap: nil,
                 # The fraction of the original amount that the customer pays after applying the
                 # discount. Set to null to remove the discount fraction. For example, 0.85 means
                 # the customer pays 85% of the original amount (a 15% discount).
@@ -7724,9 +8022,59 @@ module MetronomeSDK
               )
               end
 
-              sig { override.returns({ payment_fraction: T.nilable(Float) }) }
+              sig do
+                override.returns(
+                  {
+                    cap:
+                      T.nilable(
+                        MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::DiscountConfiguration::Cap
+                      ),
+                    payment_fraction: T.nilable(Float)
+                  }
+                )
+              end
               def to_hash
               end
+
+              class Cap < MetronomeSDK::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSpendThresholdConfiguration::DiscountConfiguration::Cap,
+                      MetronomeSDK::Internal::AnyHash
+                    )
+                  end
+
+                # Accumulated spend ceiling above which the discount stops applying.
+                sig { returns(Float) }
+                attr_accessor :amount
+
+                # Alias of the spend tracker this cap is measured against.
+                sig { returns(String) }
+                attr_accessor :spend_tracker_alias
+
+                # Update the discount cap. Set to null to remove an existing cap.
+                sig do
+                  params(amount: Float, spend_tracker_alias: String).returns(
+                    T.attached_class
+                  )
+                end
+                def self.new(
+                  # Accumulated spend ceiling above which the discount stops applying.
+                  amount:,
+                  # Alias of the spend tracker this cap is measured against.
+                  spend_tracker_alias:
+                )
+                end
+
+                sig do
+                  override.returns(
+                    { amount: Float, spend_tracker_alias: String }
+                  )
+                end
+                def to_hash
+                end
+              end
             end
           end
 

data/rbi/metronome_sdk/resources/v1/contracts.rbi

@@ -200,6 +200,10 @@ module MetronomeSDK
               MetronomeSDK::V1::ContractCreateParams::ScheduledChargesOnUsageInvoices::OrSymbol,
             spend_threshold_configuration:
               MetronomeSDK::SpendThresholdConfiguration::OrHash,
+            spend_trackers:
+              T::Array[
+                MetronomeSDK::V1::ContractCreateParams::SpendTracker::OrHash
+              ],
             subscriptions:
               T::Array[
                 MetronomeSDK::V1::ContractCreateParams::Subscription::OrHash
@@ -271,6 +275,9 @@ module MetronomeSDK
           # on a separate invoice from usage charges.
           scheduled_charges_on_usage_invoices: nil,
           spend_threshold_configuration: nil,
+          # Spend trackers to attach to this contract. Aliases must be unique within a
+          # contract.
+          spend_trackers: nil,
           # Optional list of
           # [subscriptions](https://docs.metronome.com/manage-product-access/create-subscription/)
           # to add to the contract.

data/rbi/metronome_sdk/resources/v1/packages.rbi

@@ -94,6 +94,10 @@ module MetronomeSDK
               MetronomeSDK::V1::PackageCreateParams::ScheduledChargesOnUsageInvoices::OrSymbol,
             spend_threshold_configuration:
               MetronomeSDK::SpendThresholdConfiguration::OrHash,
+            spend_trackers:
+              T::Array[
+                MetronomeSDK::V1::PackageCreateParams::SpendTracker::OrHash
+              ],
             subscriptions:
               T::Array[
                 MetronomeSDK::V1::PackageCreateParams::Subscription::OrHash
@@ -138,6 +142,7 @@ module MetronomeSDK
           # on a separate invoice from usage charges.
           scheduled_charges_on_usage_invoices: nil,
           spend_threshold_configuration: nil,
+          spend_trackers: nil,
           subscriptions: 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
@@ -216,10 +221,9 @@ module MetronomeSDK
         #
         # ### **Usage guidelines:**
         #
-        # Use the **`starting_at`**, **`covering_date`**,
-        # and **`include_archived`** parameters to filter the list of returned contracts.
-        # For example, to list only currently active contracts,
-        # pass **`covering_date`** equal to the current time.
+        # Use the **`starting_at`**, **`covering_date`**, and **`include_archived`**
+        # parameters to filter the list of returned contracts. For example, to list only
+        # currently active contracts, pass **`covering_date`** equal to the current time.
         sig do
           params(
             package_id: String,

data/rbi/metronome_sdk/resources/v1.rbi

@@ -80,9 +80,6 @@ module MetronomeSDK
       sig { returns(MetronomeSDK::Resources::V1::Packages) }
       attr_reader :packages
 
-      sig { returns(MetronomeSDK::Resources::V1::Payments) }
-      attr_reader :payments
-
       # Use these endpoints to configure a billing API key, a webhook secret, or invoice
       # finalization behavior.
       sig { returns(MetronomeSDK::Resources::V1::Settings) }

data/rbi/metronome_sdk/resources/v2/contracts.rbi

@@ -159,6 +159,10 @@ module MetronomeSDK
               ],
             add_spend_threshold_configuration:
               MetronomeSDK::SpendThresholdConfigurationV2::OrHash,
+            add_spend_trackers:
+              T::Array[
+                MetronomeSDK::V2::ContractEditParams::AddSpendTracker::OrHash
+              ],
             add_subscriptions:
               T::Array[
                 MetronomeSDK::V2::ContractEditParams::AddSubscription::OrHash
@@ -176,6 +180,7 @@ module MetronomeSDK
               T::Array[
                 MetronomeSDK::V2::ContractEditParams::ArchiveScheduledCharge::OrHash
               ],
+            archive_spend_trackers: T::Array[String],
             remove_overrides:
               T::Array[
                 MetronomeSDK::V2::ContractEditParams::RemoveOverride::OrHash
@@ -240,6 +245,9 @@ module MetronomeSDK
           add_revenue_system_configuration_update: nil,
           add_scheduled_charges: nil,
           add_spend_threshold_configuration: nil,
+          # Spend trackers to add to this contract. Aliases must be unique within a
+          # contract.
+          add_spend_trackers: nil,
           # Optional list of
           # [subscriptions](https://docs.metronome.com/manage-product-access/create-subscription/)
           # to add to the contract.
@@ -255,6 +263,8 @@ module MetronomeSDK
           archive_credits: nil,
           # IDs of scheduled charges to archive
           archive_scheduled_charges: nil,
+          # Aliases of spend trackers to archive.
+          archive_spend_trackers: nil,
           # IDs of overrides to remove
           remove_overrides: nil,
           # Optional uniqueness key to prevent duplicate contract edits.

data/sig/metronome_sdk/models/commit.rbs

@@ -29,6 +29,7 @@ module MetronomeSDK
         rollover_fraction: Float,
         salesforce_opportunity_id: String,
         specifiers: ::Array[MetronomeSDK::CommitSpecifier],
+        spend_tracker_attributes: MetronomeSDK::Commit::SpendTrackerAttributes,
         subscription_config: MetronomeSDK::Commit::SubscriptionConfig,
         uniqueness_key: String
       }
@@ -152,6 +153,12 @@ module MetronomeSDK
         ::Array[MetronomeSDK::CommitSpecifier]
       ) -> ::Array[MetronomeSDK::CommitSpecifier]
 
+      attr_reader spend_tracker_attributes: MetronomeSDK::Commit::SpendTrackerAttributes?
+
+      def spend_tracker_attributes=: (
+        MetronomeSDK::Commit::SpendTrackerAttributes
+      ) -> MetronomeSDK::Commit::SpendTrackerAttributes
+
       attr_reader subscription_config: MetronomeSDK::Commit::SubscriptionConfig?
 
       def subscription_config=: (
@@ -190,6 +197,7 @@ module MetronomeSDK
         ?rollover_fraction: Float,
         ?salesforce_opportunity_id: String,
         ?specifiers: ::Array[MetronomeSDK::CommitSpecifier],
+        ?spend_tracker_attributes: MetronomeSDK::Commit::SpendTrackerAttributes,
         ?subscription_config: MetronomeSDK::Commit::SubscriptionConfig,
         ?uniqueness_key: String
       ) -> void
@@ -222,6 +230,7 @@ module MetronomeSDK
         rollover_fraction: Float,
         salesforce_opportunity_id: String,
         specifiers: ::Array[MetronomeSDK::CommitSpecifier],
+        spend_tracker_attributes: MetronomeSDK::Commit::SpendTrackerAttributes,
         subscription_config: MetronomeSDK::Commit::SubscriptionConfig,
         uniqueness_key: String
       }
@@ -957,6 +966,16 @@ module MetronomeSDK
         def to_hash: -> { commit_id: String, contract_id: String }
       end
 
+      type spend_tracker_attributes = { counts_as_discounted: bool }
+
+      class SpendTrackerAttributes < MetronomeSDK::Internal::Type::BaseModel
+        attr_accessor counts_as_discounted: bool
+
+        def initialize: (counts_as_discounted: bool) -> void
+
+        def to_hash: -> { counts_as_discounted: bool }
+      end
+
       type subscription_config =
         {
           allocation: MetronomeSDK::Models::Commit::SubscriptionConfig::allocation,