metronome-sdk 3.4.0 → 3.6.0

data/rbi/metronome_sdk/models/credit.rbi

@@ -110,7 +110,8 @@ module MetronomeSDK
                 MetronomeSDK::Credit::Ledger::CreditCanceledLedgerEntry::OrHash,
                 MetronomeSDK::Credit::Ledger::CreditCreditedLedgerEntry::OrHash,
                 MetronomeSDK::Credit::Ledger::CreditManualLedgerEntry::OrHash,
-                MetronomeSDK::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry::OrHash
+                MetronomeSDK::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry::OrHash,
+                MetronomeSDK::Credit::Ledger::CreditRolloverLedgerEntry::OrHash
               )
             ]
         ).void
@@ -152,6 +153,16 @@ module MetronomeSDK
       sig { params(recurring_credit_id: String).void }
       attr_writer :recurring_credit_id
 
+      sig { returns(T.nilable(MetronomeSDK::Credit::RolledOverFrom)) }
+      attr_reader :rolled_over_from
+
+      sig do
+        params(
+          rolled_over_from: MetronomeSDK::Credit::RolledOverFrom::OrHash
+        ).void
+      end
+      attr_writer :rolled_over_from
+
       # This field's availability is dependent on your client's configuration.
       sig { returns(T.nilable(String)) }
       attr_reader :salesforce_opportunity_id
@@ -216,7 +227,8 @@ module MetronomeSDK
                 MetronomeSDK::Credit::Ledger::CreditCanceledLedgerEntry::OrHash,
                 MetronomeSDK::Credit::Ledger::CreditCreditedLedgerEntry::OrHash,
                 MetronomeSDK::Credit::Ledger::CreditManualLedgerEntry::OrHash,
-                MetronomeSDK::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry::OrHash
+                MetronomeSDK::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry::OrHash,
+                MetronomeSDK::Credit::Ledger::CreditRolloverLedgerEntry::OrHash
               )
             ],
           name: String,
@@ -224,6 +236,7 @@ module MetronomeSDK
           priority: Float,
           rate_type: MetronomeSDK::Credit::RateType::OrSymbol,
           recurring_credit_id: String,
+          rolled_over_from: MetronomeSDK::Credit::RolledOverFrom::OrHash,
           salesforce_opportunity_id: String,
           specifiers: T::Array[MetronomeSDK::CommitSpecifier::OrHash],
           subscription_config: MetronomeSDK::Credit::SubscriptionConfig::OrHash,
@@ -267,6 +280,7 @@ module MetronomeSDK
         # The ID of the recurring credit that this credit was generated from, if
         # applicable.
         recurring_credit_id: nil,
+        rolled_over_from: nil,
         # This field's availability is dependent on your client's configuration.
         salesforce_opportunity_id: nil,
         # List of filters that determine what kind of customer usage draws down a commit
@@ -305,6 +319,7 @@ module MetronomeSDK
             priority: Float,
             rate_type: MetronomeSDK::Credit::RateType::TaggedSymbol,
             recurring_credit_id: String,
+            rolled_over_from: MetronomeSDK::Credit::RolledOverFrom,
             salesforce_opportunity_id: String,
             specifiers: T::Array[MetronomeSDK::CommitSpecifier],
             subscription_config: MetronomeSDK::Credit::SubscriptionConfig,
@@ -388,7 +403,8 @@ module MetronomeSDK
               MetronomeSDK::Credit::Ledger::CreditCanceledLedgerEntry,
               MetronomeSDK::Credit::Ledger::CreditCreditedLedgerEntry,
               MetronomeSDK::Credit::Ledger::CreditManualLedgerEntry,
-              MetronomeSDK::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry
+              MetronomeSDK::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry,
+              MetronomeSDK::Credit::Ledger::CreditRolloverLedgerEntry
             )
           end
 
@@ -1019,6 +1035,98 @@ module MetronomeSDK
           end
         end
 
+        class CreditRolloverLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Credit::Ledger::CreditRolloverLedgerEntry,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig { returns(Float) }
+          attr_accessor :amount
+
+          sig { returns(String) }
+          attr_accessor :new_contract_id
+
+          sig { returns(String) }
+          attr_accessor :segment_id
+
+          sig { returns(Time) }
+          attr_accessor :timestamp
+
+          sig do
+            returns(
+              MetronomeSDK::Credit::Ledger::CreditRolloverLedgerEntry::Type::TaggedSymbol
+            )
+          end
+          attr_accessor :type
+
+          sig do
+            params(
+              amount: Float,
+              new_contract_id: String,
+              segment_id: String,
+              timestamp: Time,
+              type:
+                MetronomeSDK::Credit::Ledger::CreditRolloverLedgerEntry::Type::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            amount:,
+            new_contract_id:,
+            segment_id:,
+            timestamp:,
+            type:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                amount: Float,
+                new_contract_id: String,
+                segment_id: String,
+                timestamp: Time,
+                type:
+                  MetronomeSDK::Credit::Ledger::CreditRolloverLedgerEntry::Type::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module Type
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::Credit::Ledger::CreditRolloverLedgerEntry::Type
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CREDIT_ROLLOVER =
+              T.let(
+                :CREDIT_ROLLOVER,
+                MetronomeSDK::Credit::Ledger::CreditRolloverLedgerEntry::Type::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::Credit::Ledger::CreditRolloverLedgerEntry::Type::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
         sig do
           override.returns(T::Array[MetronomeSDK::Credit::Ledger::Variants])
         end
@@ -1047,6 +1155,34 @@ module MetronomeSDK
         end
       end
 
+      class RolledOverFrom < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::Credit::RolledOverFrom,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :contract_id
+
+        sig { returns(String) }
+        attr_accessor :credit_id
+
+        sig do
+          params(contract_id: String, credit_id: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(contract_id:, credit_id:)
+        end
+
+        sig { override.returns({ contract_id: String, credit_id: String }) }
+        def to_hash
+        end
+      end
+
       class SubscriptionConfig < MetronomeSDK::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/metronome_sdk/models/override.rbi

@@ -11,6 +11,9 @@ module MetronomeSDK
       sig { returns(String) }
       attr_accessor :id
 
+      sig { returns(Time) }
+      attr_accessor :created_at
+
       sig { returns(Time) }
       attr_accessor :starting_at
 
@@ -150,6 +153,7 @@ module MetronomeSDK
       sig do
         params(
           id: String,
+          created_at: Time,
           starting_at: Time,
           applicable_product_tags: T::Array[String],
           credit_type: MetronomeSDK::CreditTypeData::OrHash,
@@ -175,6 +179,7 @@ module MetronomeSDK
       end
       def self.new(
         id:,
+        created_at:,
         starting_at:,
         applicable_product_tags: nil,
         credit_type: nil,
@@ -210,6 +215,7 @@ module MetronomeSDK
         override.returns(
           {
             id: String,
+            created_at: Time,
             starting_at: Time,
             applicable_product_tags: T::Array[String],
             credit_type: MetronomeSDK::CreditTypeData,
@@ -303,12 +309,6 @@ module MetronomeSDK
         sig { params(recurring_commit_ids: T::Array[String]).void }
         attr_writer :recurring_commit_ids
 
-        sig { returns(T.nilable(T::Array[String])) }
-        attr_reader :recurring_credit_ids
-
-        sig { params(recurring_credit_ids: T::Array[String]).void }
-        attr_writer :recurring_credit_ids
-
         sig do
           params(
             billing_frequency:
@@ -318,8 +318,7 @@ module MetronomeSDK
             pricing_group_values: T::Hash[Symbol, String],
             product_id: String,
             product_tags: T::Array[String],
-            recurring_commit_ids: T::Array[String],
-            recurring_credit_ids: T::Array[String]
+            recurring_commit_ids: T::Array[String]
           ).returns(T.attached_class)
         end
         def self.new(
@@ -329,8 +328,7 @@ module MetronomeSDK
           pricing_group_values: nil,
           product_id: nil,
           product_tags: nil,
-          recurring_commit_ids: nil,
-          recurring_credit_ids: nil
+          recurring_commit_ids: nil
         )
         end
 
@@ -344,8 +342,7 @@ module MetronomeSDK
               pricing_group_values: T::Hash[Symbol, String],
               product_id: String,
               product_tags: T::Array[String],
-              recurring_commit_ids: T::Array[String],
-              recurring_credit_ids: T::Array[String]
+              recurring_commit_ids: T::Array[String]
             }
           )
         end

data/rbi/metronome_sdk/models/prepaid_balance_threshold_configuration.rbi

@@ -57,6 +57,23 @@ module MetronomeSDK
       sig { params(custom_credit_type_id: String).void }
       attr_writer :custom_credit_type_id
 
+      sig do
+        returns(
+          T.nilable(
+            MetronomeSDK::PrepaidBalanceThresholdConfiguration::DiscountConfiguration
+          )
+        )
+      end
+      attr_reader :discount_configuration
+
+      sig do
+        params(
+          discount_configuration:
+            MetronomeSDK::PrepaidBalanceThresholdConfiguration::DiscountConfiguration::OrHash
+        ).void
+      end
+      attr_writer :discount_configuration
+
       sig do
         params(
           commit:
@@ -65,7 +82,9 @@ module MetronomeSDK
           payment_gate_config: MetronomeSDK::PaymentGateConfig::OrHash,
           recharge_to_amount: Float,
           threshold_amount: Float,
-          custom_credit_type_id: String
+          custom_credit_type_id: String,
+          discount_configuration:
+            MetronomeSDK::PrepaidBalanceThresholdConfiguration::DiscountConfiguration::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
@@ -82,7 +101,8 @@ module MetronomeSDK
         threshold_amount:,
         # If provided, the threshold, recharge-to amount, and the resulting threshold
         # commit amount will be in terms of this credit type instead of the fiat currency.
-        custom_credit_type_id: nil
+        custom_credit_type_id: nil,
+        discount_configuration: nil
       )
       end
 
@@ -94,7 +114,9 @@ module MetronomeSDK
             payment_gate_config: MetronomeSDK::PaymentGateConfig,
             recharge_to_amount: Float,
             threshold_amount: Float,
-            custom_credit_type_id: String
+            custom_credit_type_id: String,
+            discount_configuration:
+              MetronomeSDK::PrepaidBalanceThresholdConfiguration::DiscountConfiguration
           }
         )
       end
@@ -178,6 +200,35 @@ module MetronomeSDK
         def to_hash
         end
       end
+
+      class DiscountConfiguration < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::PrepaidBalanceThresholdConfiguration::DiscountConfiguration,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        # 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).
+        sig { returns(Float) }
+        attr_accessor :payment_fraction
+
+        sig { params(payment_fraction: Float).returns(T.attached_class) }
+        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:
+        )
+        end
+
+        sig { override.returns({ payment_fraction: Float }) }
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rbi

@@ -57,6 +57,23 @@ module MetronomeSDK
       sig { params(custom_credit_type_id: String).void }
       attr_writer :custom_credit_type_id
 
+      sig do
+        returns(
+          T.nilable(
+            MetronomeSDK::PrepaidBalanceThresholdConfigurationV2::DiscountConfiguration
+          )
+        )
+      end
+      attr_reader :discount_configuration
+
+      sig do
+        params(
+          discount_configuration:
+            MetronomeSDK::PrepaidBalanceThresholdConfigurationV2::DiscountConfiguration::OrHash
+        ).void
+      end
+      attr_writer :discount_configuration
+
       sig do
         params(
           commit:
@@ -65,7 +82,9 @@ module MetronomeSDK
           payment_gate_config: MetronomeSDK::PaymentGateConfigV2::OrHash,
           recharge_to_amount: Float,
           threshold_amount: Float,
-          custom_credit_type_id: String
+          custom_credit_type_id: String,
+          discount_configuration:
+            MetronomeSDK::PrepaidBalanceThresholdConfigurationV2::DiscountConfiguration::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
@@ -82,7 +101,8 @@ module MetronomeSDK
         threshold_amount:,
         # If provided, the threshold, recharge-to amount, and the resulting threshold
         # commit amount will be in terms of this credit type instead of the fiat currency.
-        custom_credit_type_id: nil
+        custom_credit_type_id: nil,
+        discount_configuration: nil
       )
       end
 
@@ -95,14 +115,16 @@ module MetronomeSDK
             payment_gate_config: MetronomeSDK::PaymentGateConfigV2,
             recharge_to_amount: Float,
             threshold_amount: Float,
-            custom_credit_type_id: String
+            custom_credit_type_id: String,
+            discount_configuration:
+              MetronomeSDK::PrepaidBalanceThresholdConfigurationV2::DiscountConfiguration
           }
         )
       end
       def to_hash
       end
 
-      class Commit < MetronomeSDK::Models::UpdateBaseThresholdCommit
+      class Commit < MetronomeSDK::Models::BaseThresholdCommit
         OrHash =
           T.type_alias do
             T.any(
@@ -183,6 +205,35 @@ module MetronomeSDK
         def to_hash
         end
       end
+
+      class DiscountConfiguration < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::PrepaidBalanceThresholdConfigurationV2::DiscountConfiguration,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        # 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).
+        sig { returns(Float) }
+        attr_accessor :payment_fraction
+
+        sig { params(payment_fraction: Float).returns(T.attached_class) }
+        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:
+        )
+        end
+
+        sig { override.returns({ payment_fraction: Float }) }
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/metronome_sdk/models/spend_threshold_configuration.rbi

@@ -38,12 +38,31 @@ module MetronomeSDK
       sig { returns(Float) }
       attr_accessor :threshold_amount
 
+      sig do
+        returns(
+          T.nilable(
+            MetronomeSDK::SpendThresholdConfiguration::DiscountConfiguration
+          )
+        )
+      end
+      attr_reader :discount_configuration
+
+      sig do
+        params(
+          discount_configuration:
+            MetronomeSDK::SpendThresholdConfiguration::DiscountConfiguration::OrHash
+        ).void
+      end
+      attr_writer :discount_configuration
+
       sig do
         params(
           commit: MetronomeSDK::BaseThresholdCommit::OrHash,
           is_enabled: T::Boolean,
           payment_gate_config: MetronomeSDK::PaymentGateConfig::OrHash,
-          threshold_amount: Float
+          threshold_amount: Float,
+          discount_configuration:
+            MetronomeSDK::SpendThresholdConfiguration::DiscountConfiguration::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
@@ -55,7 +74,8 @@ module MetronomeSDK
         payment_gate_config:,
         # Specify the threshold amount for the contract. Each time the contract's usage
         # hits this amount, a threshold charge will be initiated.
-        threshold_amount:
+        threshold_amount:,
+        discount_configuration: nil
       )
       end
 
@@ -65,12 +85,43 @@ module MetronomeSDK
             commit: MetronomeSDK::BaseThresholdCommit,
             is_enabled: T::Boolean,
             payment_gate_config: MetronomeSDK::PaymentGateConfig,
-            threshold_amount: Float
+            threshold_amount: Float,
+            discount_configuration:
+              MetronomeSDK::SpendThresholdConfiguration::DiscountConfiguration
           }
         )
       end
       def to_hash
       end
+
+      class DiscountConfiguration < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::SpendThresholdConfiguration::DiscountConfiguration,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        # 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).
+        sig { returns(Float) }
+        attr_accessor :payment_fraction
+
+        sig { params(payment_fraction: Float).returns(T.attached_class) }
+        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:
+        )
+        end
+
+        sig { override.returns({ payment_fraction: Float }) }
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/metronome_sdk/models/spend_threshold_configuration_v2.rbi

@@ -11,12 +11,10 @@ module MetronomeSDK
           )
         end
 
-      sig { returns(MetronomeSDK::UpdateBaseThresholdCommit) }
+      sig { returns(MetronomeSDK::BaseThresholdCommit) }
       attr_reader :commit
 
-      sig do
-        params(commit: MetronomeSDK::UpdateBaseThresholdCommit::OrHash).void
-      end
+      sig { params(commit: MetronomeSDK::BaseThresholdCommit::OrHash).void }
       attr_writer :commit
 
       # When set to false, the contract will not be evaluated against the
@@ -40,12 +38,31 @@ module MetronomeSDK
       sig { returns(Float) }
       attr_accessor :threshold_amount
 
+      sig do
+        returns(
+          T.nilable(
+            MetronomeSDK::SpendThresholdConfigurationV2::DiscountConfiguration
+          )
+        )
+      end
+      attr_reader :discount_configuration
+
+      sig do
+        params(
+          discount_configuration:
+            MetronomeSDK::SpendThresholdConfigurationV2::DiscountConfiguration::OrHash
+        ).void
+      end
+      attr_writer :discount_configuration
+
       sig do
         params(
-          commit: MetronomeSDK::UpdateBaseThresholdCommit::OrHash,
+          commit: MetronomeSDK::BaseThresholdCommit::OrHash,
           is_enabled: T::Boolean,
           payment_gate_config: MetronomeSDK::PaymentGateConfigV2::OrHash,
-          threshold_amount: Float
+          threshold_amount: Float,
+          discount_configuration:
+            MetronomeSDK::SpendThresholdConfigurationV2::DiscountConfiguration::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
@@ -57,22 +74,54 @@ module MetronomeSDK
         payment_gate_config:,
         # Specify the threshold amount for the contract. Each time the contract's usage
         # hits this amount, a threshold charge will be initiated.
-        threshold_amount:
+        threshold_amount:,
+        discount_configuration: nil
       )
       end
 
       sig do
         override.returns(
           {
-            commit: MetronomeSDK::UpdateBaseThresholdCommit,
+            commit: MetronomeSDK::BaseThresholdCommit,
             is_enabled: T::Boolean,
             payment_gate_config: MetronomeSDK::PaymentGateConfigV2,
-            threshold_amount: Float
+            threshold_amount: Float,
+            discount_configuration:
+              MetronomeSDK::SpendThresholdConfigurationV2::DiscountConfiguration
           }
         )
       end
       def to_hash
       end
+
+      class DiscountConfiguration < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::SpendThresholdConfigurationV2::DiscountConfiguration,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        # 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).
+        sig { returns(Float) }
+        attr_accessor :payment_fraction
+
+        sig { params(payment_fraction: Float).returns(T.attached_class) }
+        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:
+        )
+        end
+
+        sig { override.returns({ payment_fraction: Float }) }
+        def to_hash
+        end
+      end
     end
   end
 end