metronome-sdk 3.6.0 → 3.8.0

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
@@ -1985,9 +2039,10 @@ module MetronomeSDK
           attr_writer :entitled
 
           # Indicates whether the override should only apply to commits. Defaults to
-          # `false`. If `true`, you can specify relevant commits in `override_specifiers` by
-          # passing `commit_ids`. if you do not specify `commit_ids`, then the override will
-          # apply when consuming any prepaid or postpaid commit.
+          # `false`. If `true` you can specify relevant commits in `override_specifiers` by
+          # passing `commit_ids`, `recurring_commit_ids`, or `any_commit_or_credit_ids`. If
+          # you do not specify any of these fields, the override will apply when consuming
+          # any prepaid commit, postpaid commit, or credit
           sig { returns(T.nilable(T::Boolean)) }
           attr_reader :is_commit_specific
 
@@ -2154,9 +2209,10 @@ module MetronomeSDK
             ending_before: nil,
             entitled: nil,
             # Indicates whether the override should only apply to commits. Defaults to
-            # `false`. If `true`, you can specify relevant commits in `override_specifiers` by
-            # passing `commit_ids`. if you do not specify `commit_ids`, then the override will
-            # apply when consuming any prepaid or postpaid commit.
+            # `false`. If `true` you can specify relevant commits in `override_specifiers` by
+            # passing `commit_ids`, `recurring_commit_ids`, or `any_commit_or_credit_ids`. If
+            # you do not specify any of these fields, the override will apply when consuming
+            # any prepaid commit, postpaid commit, or credit
             is_commit_specific: nil,
             # Required for MULTIPLIER type. Must be >=0.
             multiplier: nil,
@@ -2224,6 +2280,17 @@ module MetronomeSDK
                 )
               end
 
+            # Can only be used for commit specific overrides. Must be used in conjunction with
+            # one of `product_id`, `product_tags`, `pricing_group_values`, or
+            # `presentation_group_values`. Must be used instead of both `commit_ids` and
+            # `recurring_commit_ids` If provided, the override will apply to any specified
+            # commit, credit, recurring commit or recurring credit IDs.
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :any_commit_or_credit_ids
+
+            sig { params(any_commit_or_credit_ids: T::Array[String]).void }
+            attr_writer :any_commit_or_credit_ids
+
             sig do
               returns(
                 T.nilable(
@@ -2296,6 +2363,7 @@ module MetronomeSDK
 
             sig do
               params(
+                any_commit_or_credit_ids: T::Array[String],
                 billing_frequency:
                   MetronomeSDK::V1::ContractAmendParams::Override::OverrideSpecifier::BillingFrequency::OrSymbol,
                 commit_ids: T::Array[String],
@@ -2307,6 +2375,12 @@ module MetronomeSDK
               ).returns(T.attached_class)
             end
             def self.new(
+              # Can only be used for commit specific overrides. Must be used in conjunction with
+              # one of `product_id`, `product_tags`, `pricing_group_values`, or
+              # `presentation_group_values`. Must be used instead of both `commit_ids` and
+              # `recurring_commit_ids` If provided, the override will apply to any specified
+              # commit, credit, recurring commit or recurring credit IDs.
+              any_commit_or_credit_ids: nil,
               billing_frequency: nil,
               # Can only be used for commit specific overrides. Must be used in conjunction with
               # one of `product_id`, `product_tags`, `pricing_group_values`, or
@@ -2335,6 +2409,7 @@ module MetronomeSDK
             sig do
               override.returns(
                 {
+                  any_commit_or_credit_ids: T::Array[String],
                   billing_frequency:
                     MetronomeSDK::V1::ContractAmendParams::Override::OverrideSpecifier::BillingFrequency::OrSymbol,
                   commit_ids: T::Array[String],