metronome-sdk 3.6.0 → 3.7.0

data/rbi/metronome_sdk/models/spend_threshold_configuration.rbi

@@ -109,18 +109,93 @@ module MetronomeSDK
         sig { returns(Float) }
         attr_accessor :payment_fraction
 
-        sig { params(payment_fraction: Float).returns(T.attached_class) }
+        # If provided, the discount stops applying once the spend tracker has accumulated
+        # this much spend in the billing period.
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::SpendThresholdConfiguration::DiscountConfiguration::Cap
+            )
+          )
+        end
+        attr_reader :cap
+
+        sig do
+          params(
+            cap:
+              MetronomeSDK::SpendThresholdConfiguration::DiscountConfiguration::Cap::OrHash
+          ).void
+        end
+        attr_writer :cap
+
+        sig do
+          params(
+            payment_fraction: Float,
+            cap:
+              MetronomeSDK::SpendThresholdConfiguration::DiscountConfiguration::Cap::OrHash
+          ).returns(T.attached_class)
+        end
         def self.new(
           # The fraction of the original amount that the customer pays after applying the
           # discount. For example, 0.85 means the customer pays 85% of the original amount
           # (a 15% discount).
-          payment_fraction:
+          payment_fraction:,
+          # If provided, the discount stops applying once the spend tracker has accumulated
+          # this much spend in the billing period.
+          cap: nil
         )
         end
 
-        sig { override.returns({ payment_fraction: Float }) }
+        sig do
+          override.returns(
+            {
+              payment_fraction: Float,
+              cap:
+                MetronomeSDK::SpendThresholdConfiguration::DiscountConfiguration::Cap
+            }
+          )
+        end
         def to_hash
         end
+
+        class Cap < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::SpendThresholdConfiguration::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
+
+          # If provided, the discount stops applying once the spend tracker has accumulated
+          # this much spend in the billing period.
+          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
   end

data/rbi/metronome_sdk/models/spend_threshold_configuration_v2.rbi

@@ -109,18 +109,93 @@ module MetronomeSDK
         sig { returns(Float) }
         attr_accessor :payment_fraction
 
-        sig { params(payment_fraction: Float).returns(T.attached_class) }
+        # If provided, the discount stops applying once the spend tracker has accumulated
+        # this much spend in the billing period.
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::SpendThresholdConfigurationV2::DiscountConfiguration::Cap
+            )
+          )
+        end
+        attr_reader :cap
+
+        sig do
+          params(
+            cap:
+              MetronomeSDK::SpendThresholdConfigurationV2::DiscountConfiguration::Cap::OrHash
+          ).void
+        end
+        attr_writer :cap
+
+        sig do
+          params(
+            payment_fraction: Float,
+            cap:
+              MetronomeSDK::SpendThresholdConfigurationV2::DiscountConfiguration::Cap::OrHash
+          ).returns(T.attached_class)
+        end
         def self.new(
           # The fraction of the original amount that the customer pays after applying the
           # discount. For example, 0.85 means the customer pays 85% of the original amount
           # (a 15% discount).
-          payment_fraction:
+          payment_fraction:,
+          # If provided, the discount stops applying once the spend tracker has accumulated
+          # this much spend in the billing period.
+          cap: nil
         )
         end
 
-        sig { override.returns({ payment_fraction: Float }) }
+        sig do
+          override.returns(
+            {
+              payment_fraction: Float,
+              cap:
+                MetronomeSDK::SpendThresholdConfigurationV2::DiscountConfiguration::Cap
+            }
+          )
+        end
         def to_hash
         end
+
+        class Cap < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::SpendThresholdConfigurationV2::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
+
+          # If provided, the discount stops applying once the spend tracker has accumulated
+          # this much spend in the billing period.
+          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
   end

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

@@ -446,6 +446,24 @@ module MetronomeSDK
           end
           attr_writer :specifiers
 
+          # Optional attributes for spend tracker integration. Immutable after creation.
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::V1::ContractAmendParams::Commit::SpendTrackerAttributes
+              )
+            )
+          end
+          attr_reader :spend_tracker_attributes
+
+          sig do
+            params(
+              spend_tracker_attributes:
+                MetronomeSDK::V1::ContractAmendParams::Commit::SpendTrackerAttributes::OrHash
+            ).void
+          end
+          attr_writer :spend_tracker_attributes
+
           # A temporary ID for the commit that can be used to reference the commit for
           # commit specific overrides.
           sig { returns(T.nilable(String)) }
@@ -477,6 +495,8 @@ module MetronomeSDK
                 MetronomeSDK::V1::ContractAmendParams::Commit::RateType::OrSymbol,
               rollover_fraction: Float,
               specifiers: T::Array[MetronomeSDK::CommitSpecifierInput::OrHash],
+              spend_tracker_attributes:
+                MetronomeSDK::V1::ContractAmendParams::Commit::SpendTrackerAttributes::OrHash,
               temporary_id: String
             ).returns(T.attached_class)
           end
@@ -523,6 +543,8 @@ module MetronomeSDK
             # specifiers to contribute to a commit's or credit's drawdown. This field cannot
             # be used together with `applicable_product_ids` or `applicable_product_tags`.
             specifiers: nil,
+            # Optional attributes for spend tracker integration. Immutable after creation.
+            spend_tracker_attributes: nil,
             # A temporary ID for the commit that can be used to reference the commit for
             # commit specific overrides.
             temporary_id: nil
@@ -553,6 +575,8 @@ module MetronomeSDK
                   MetronomeSDK::V1::ContractAmendParams::Commit::RateType::OrSymbol,
                 rollover_fraction: Float,
                 specifiers: T::Array[MetronomeSDK::CommitSpecifierInput],
+                spend_tracker_attributes:
+                  MetronomeSDK::V1::ContractAmendParams::Commit::SpendTrackerAttributes,
                 temporary_id: String
               }
             )
@@ -1124,6 +1148,36 @@ module MetronomeSDK
             def self.values
             end
           end
+
+          class SpendTrackerAttributes < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::V1::ContractAmendParams::Commit::SpendTrackerAttributes,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            # If true, this commit will be included in spend trackers with discounted set to
+            # DISCOUNTED_ONLY
+            sig { returns(T::Boolean) }
+            attr_accessor :counts_as_discounted
+
+            # Optional attributes for spend tracker integration. Immutable after creation.
+            sig do
+              params(counts_as_discounted: T::Boolean).returns(T.attached_class)
+            end
+            def self.new(
+              # If true, this commit will be included in spend trackers with discounted set to
+              # DISCOUNTED_ONLY
+              counts_as_discounted:
+            )
+            end
+
+            sig { override.returns({ counts_as_discounted: T::Boolean }) }
+            def to_hash
+            end
+          end
         end
 
         class Credit < MetronomeSDK::Internal::Type::BaseModel