metronome-sdk 3.7.0 → 3.8.0

data/rbi/metronome_sdk/models/contract_without_amendments.rbi

@@ -776,6 +776,26 @@ module MetronomeSDK
         end
         attr_writer :proration
 
+        # Rounding configuration for prorated recurring commit amounts.
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding
+            )
+          )
+        end
+        attr_reader :proration_rounding
+
+        sig do
+          params(
+            proration_rounding:
+              T.nilable(
+                MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::OrHash
+              )
+          ).void
+        end
+        attr_writer :proration_rounding
+
         # The frequency at which the recurring commits will be created. If not provided: -
         # The commits will be created on the usage invoice frequency. If provided: - The
         # period defined in the duration will correspond to this frequency. - Commits will
@@ -861,6 +881,10 @@ module MetronomeSDK
             netsuite_sales_order_id: String,
             proration:
               MetronomeSDK::ContractWithoutAmendments::RecurringCommit::Proration::OrSymbol,
+            proration_rounding:
+              T.nilable(
+                MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::OrHash
+              ),
             recurrence_frequency:
               MetronomeSDK::ContractWithoutAmendments::RecurringCommit::RecurrenceFrequency::OrSymbol,
             rollover_fraction: Float,
@@ -902,6 +926,8 @@ module MetronomeSDK
           # Determines whether the first and last commit will be prorated. If not provided,
           # the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
           proration: nil,
+          # Rounding configuration for prorated recurring commit amounts.
+          proration_rounding: nil,
           # The frequency at which the recurring commits will be created. If not provided: -
           # The commits will be created on the usage invoice frequency. If provided: - The
           # period defined in the duration will correspond to this frequency. - Commits will
@@ -949,6 +975,10 @@ module MetronomeSDK
               netsuite_sales_order_id: String,
               proration:
                 MetronomeSDK::ContractWithoutAmendments::RecurringCommit::Proration::TaggedSymbol,
+              proration_rounding:
+                T.nilable(
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding
+                ),
               recurrence_frequency:
                 MetronomeSDK::ContractWithoutAmendments::RecurringCommit::RecurrenceFrequency::TaggedSymbol,
               rollover_fraction: Float,
@@ -1248,6 +1278,259 @@ module MetronomeSDK
           end
         end
 
+        class ProrationRounding < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Access
+              )
+            )
+          end
+          attr_reader :access
+
+          sig do
+            params(
+              access:
+                MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Access::OrHash
+            ).void
+          end
+          attr_writer :access
+
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Invoice
+              )
+            )
+          end
+          attr_reader :invoice
+
+          sig do
+            params(
+              invoice:
+                MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Invoice::OrHash
+            ).void
+          end
+          attr_writer :invoice
+
+          # Rounding configuration for prorated recurring commit amounts.
+          sig do
+            params(
+              access:
+                MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Access::OrHash,
+              invoice:
+                MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Invoice::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(access: nil, invoice: nil)
+          end
+
+          sig do
+            override.returns(
+              {
+                access:
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Access,
+                invoice:
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Invoice
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Access < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Access,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            # Number of decimal places to round to. Applied directly to the stored monetary
+            # representation. Negative values round to powers of 10 (e.g., -2 rounds to
+            # nearest 100 in the stored unit. For USD, this means rounding to the nearest
+            # dollar).
+            sig { returns(Float) }
+            attr_accessor :decimal_places
+
+            sig do
+              returns(
+                MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Access::RoundingMethod::TaggedSymbol
+              )
+            end
+            attr_accessor :rounding_method
+
+            sig do
+              params(
+                decimal_places: Float,
+                rounding_method:
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Access::RoundingMethod::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Number of decimal places to round to. Applied directly to the stored monetary
+              # representation. Negative values round to powers of 10 (e.g., -2 rounds to
+              # nearest 100 in the stored unit. For USD, this means rounding to the nearest
+              # dollar).
+              decimal_places:,
+              rounding_method:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  decimal_places: Float,
+                  rounding_method:
+                    MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Access::RoundingMethod::TaggedSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            module RoundingMethod
+              extend MetronomeSDK::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Access::RoundingMethod
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              HALF_UP =
+                T.let(
+                  :HALF_UP,
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Access::RoundingMethod::TaggedSymbol
+                )
+              FLOOR =
+                T.let(
+                  :FLOOR,
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Access::RoundingMethod::TaggedSymbol
+                )
+              CEILING =
+                T.let(
+                  :CEILING,
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Access::RoundingMethod::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Access::RoundingMethod::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+
+          class Invoice < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Invoice,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            # Number of decimal places to round to. Applied directly to the stored monetary
+            # representation. Negative values round to powers of 10 (e.g., -2 rounds to
+            # nearest 100 in the stored unit. For USD, this means rounding to the nearest
+            # dollar).
+            sig { returns(Float) }
+            attr_accessor :decimal_places
+
+            sig do
+              returns(
+                MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Invoice::RoundingMethod::TaggedSymbol
+              )
+            end
+            attr_accessor :rounding_method
+
+            sig do
+              params(
+                decimal_places: Float,
+                rounding_method:
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Invoice::RoundingMethod::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Number of decimal places to round to. Applied directly to the stored monetary
+              # representation. Negative values round to powers of 10 (e.g., -2 rounds to
+              # nearest 100 in the stored unit. For USD, this means rounding to the nearest
+              # dollar).
+              decimal_places:,
+              rounding_method:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  decimal_places: Float,
+                  rounding_method:
+                    MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Invoice::RoundingMethod::TaggedSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            module RoundingMethod
+              extend MetronomeSDK::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Invoice::RoundingMethod
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              HALF_UP =
+                T.let(
+                  :HALF_UP,
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Invoice::RoundingMethod::TaggedSymbol
+                )
+              FLOOR =
+                T.let(
+                  :FLOOR,
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Invoice::RoundingMethod::TaggedSymbol
+                )
+              CEILING =
+                T.let(
+                  :CEILING,
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Invoice::RoundingMethod::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::ContractWithoutAmendments::RecurringCommit::ProrationRounding::Invoice::RoundingMethod::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+        end
+
         # The frequency at which the recurring commits will be created. If not provided: -
         # The commits will be created on the usage invoice frequency. If provided: - The
         # period defined in the duration will correspond to this frequency. - Commits will
@@ -1285,6 +1568,11 @@ module MetronomeSDK
               :WEEKLY,
               MetronomeSDK::ContractWithoutAmendments::RecurringCommit::RecurrenceFrequency::TaggedSymbol
             )
+          DAILY =
+            T.let(
+              :DAILY,
+              MetronomeSDK::ContractWithoutAmendments::RecurringCommit::RecurrenceFrequency::TaggedSymbol
+            )
 
           sig do
             override.returns(
@@ -1463,6 +1751,26 @@ module MetronomeSDK
         end
         attr_writer :proration
 
+        # Rounding configuration for prorated recurring credit amounts.
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::ContractWithoutAmendments::RecurringCredit::ProrationRounding
+            )
+          )
+        end
+        attr_reader :proration_rounding
+
+        sig do
+          params(
+            proration_rounding:
+              T.nilable(
+                MetronomeSDK::ContractWithoutAmendments::RecurringCredit::ProrationRounding::OrHash
+              )
+          ).void
+        end
+        attr_writer :proration_rounding
+
         # The frequency at which the recurring commits will be created. If not provided: -
         # The commits will be created on the usage invoice frequency. If provided: - The
         # period defined in the duration will correspond to this frequency. - Commits will
@@ -1546,6 +1854,10 @@ module MetronomeSDK
             netsuite_sales_order_id: String,
             proration:
               MetronomeSDK::ContractWithoutAmendments::RecurringCredit::Proration::OrSymbol,
+            proration_rounding:
+              T.nilable(
+                MetronomeSDK::ContractWithoutAmendments::RecurringCredit::ProrationRounding::OrHash
+              ),
             recurrence_frequency:
               MetronomeSDK::ContractWithoutAmendments::RecurringCredit::RecurrenceFrequency::OrSymbol,
             rollover_fraction: Float,
@@ -1585,6 +1897,8 @@ module MetronomeSDK
           # Determines whether the first and last commit will be prorated. If not provided,
           # the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
           proration: nil,
+          # Rounding configuration for prorated recurring credit amounts.
+          proration_rounding: nil,
           # The frequency at which the recurring commits will be created. If not provided: -
           # The commits will be created on the usage invoice frequency. If provided: - The
           # period defined in the duration will correspond to this frequency. - Commits will
@@ -1630,6 +1944,10 @@ module MetronomeSDK
               netsuite_sales_order_id: String,
               proration:
                 MetronomeSDK::ContractWithoutAmendments::RecurringCredit::Proration::TaggedSymbol,
+              proration_rounding:
+                T.nilable(
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::ProrationRounding
+                ),
               recurrence_frequency:
                 MetronomeSDK::ContractWithoutAmendments::RecurringCredit::RecurrenceFrequency::TaggedSymbol,
               rollover_fraction: Float,
@@ -1891,6 +2209,146 @@ module MetronomeSDK
           end
         end
 
+        class ProrationRounding < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::ContractWithoutAmendments::RecurringCredit::ProrationRounding,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::ContractWithoutAmendments::RecurringCredit::ProrationRounding::Access
+              )
+            )
+          end
+          attr_reader :access
+
+          sig do
+            params(
+              access:
+                MetronomeSDK::ContractWithoutAmendments::RecurringCredit::ProrationRounding::Access::OrHash
+            ).void
+          end
+          attr_writer :access
+
+          # Rounding configuration for prorated recurring credit amounts.
+          sig do
+            params(
+              access:
+                MetronomeSDK::ContractWithoutAmendments::RecurringCredit::ProrationRounding::Access::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(access: nil)
+          end
+
+          sig do
+            override.returns(
+              {
+                access:
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::ProrationRounding::Access
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Access < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::ProrationRounding::Access,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            # Number of decimal places to round to. Applied directly to the stored monetary
+            # representation. Negative values round to powers of 10 (e.g., -2 rounds to
+            # nearest 100 in the stored unit. For USD, this means rounding to the nearest
+            # dollar).
+            sig { returns(Float) }
+            attr_accessor :decimal_places
+
+            sig do
+              returns(
+                MetronomeSDK::ContractWithoutAmendments::RecurringCredit::ProrationRounding::Access::RoundingMethod::TaggedSymbol
+              )
+            end
+            attr_accessor :rounding_method
+
+            sig do
+              params(
+                decimal_places: Float,
+                rounding_method:
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::ProrationRounding::Access::RoundingMethod::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Number of decimal places to round to. Applied directly to the stored monetary
+              # representation. Negative values round to powers of 10 (e.g., -2 rounds to
+              # nearest 100 in the stored unit. For USD, this means rounding to the nearest
+              # dollar).
+              decimal_places:,
+              rounding_method:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  decimal_places: Float,
+                  rounding_method:
+                    MetronomeSDK::ContractWithoutAmendments::RecurringCredit::ProrationRounding::Access::RoundingMethod::TaggedSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            module RoundingMethod
+              extend MetronomeSDK::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    MetronomeSDK::ContractWithoutAmendments::RecurringCredit::ProrationRounding::Access::RoundingMethod
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              HALF_UP =
+                T.let(
+                  :HALF_UP,
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::ProrationRounding::Access::RoundingMethod::TaggedSymbol
+                )
+              FLOOR =
+                T.let(
+                  :FLOOR,
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::ProrationRounding::Access::RoundingMethod::TaggedSymbol
+                )
+              CEILING =
+                T.let(
+                  :CEILING,
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::ProrationRounding::Access::RoundingMethod::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::ContractWithoutAmendments::RecurringCredit::ProrationRounding::Access::RoundingMethod::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+        end
+
         # The frequency at which the recurring commits will be created. If not provided: -
         # The commits will be created on the usage invoice frequency. If provided: - The
         # period defined in the duration will correspond to this frequency. - Commits will
@@ -1928,6 +2386,11 @@ module MetronomeSDK
               :WEEKLY,
               MetronomeSDK::ContractWithoutAmendments::RecurringCredit::RecurrenceFrequency::TaggedSymbol
             )
+          DAILY =
+            T.let(
+              :DAILY,
+              MetronomeSDK::ContractWithoutAmendments::RecurringCredit::RecurrenceFrequency::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/metronome_sdk/models/credit.rbi

@@ -67,6 +67,14 @@ module MetronomeSDK
       sig { params(contract: MetronomeSDK::Credit::Contract::OrHash).void }
       attr_writer :contract
 
+      # The actor who created this credit. Omitted for system-generated credits such as
+      # recurring credits.
+      sig { returns(T.nilable(String)) }
+      attr_reader :created_by
+
+      sig { params(created_by: String).void }
+      attr_writer :created_by
+
       # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
       sig { returns(T.nilable(T::Hash[Symbol, String])) }
       attr_reader :custom_fields
@@ -214,6 +222,7 @@ module MetronomeSDK
           applicable_product_tags: T::Array[String],
           balance: Float,
           contract: MetronomeSDK::Credit::Contract::OrHash,
+          created_by: String,
           custom_fields: T::Hash[Symbol, String],
           description: String,
           hierarchy_configuration:
@@ -262,6 +271,9 @@ module MetronomeSDK
         # included in the balance, including future-dated manual ledger entries.
         balance: nil,
         contract: nil,
+        # The actor who created this credit. Omitted for system-generated credits such as
+        # recurring credits.
+        created_by: nil,
         # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         custom_fields: nil,
         description: nil,
@@ -310,6 +322,7 @@ module MetronomeSDK
             applicable_product_tags: T::Array[String],
             balance: Float,
             contract: MetronomeSDK::Credit::Contract,
+            created_by: String,
             custom_fields: T::Hash[Symbol, String],
             description: String,
             hierarchy_configuration: MetronomeSDK::CommitHierarchyConfiguration,

data/rbi/metronome_sdk/models/override.rbi

@@ -252,6 +252,12 @@ module MetronomeSDK
             )
           end
 
+        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(
@@ -311,6 +317,7 @@ module MetronomeSDK
 
         sig do
           params(
+            any_commit_or_credit_ids: T::Array[String],
             billing_frequency:
               MetronomeSDK::Override::OverrideSpecifier::BillingFrequency::OrSymbol,
             commit_ids: T::Array[String],
@@ -322,6 +329,7 @@ module MetronomeSDK
           ).returns(T.attached_class)
         end
         def self.new(
+          any_commit_or_credit_ids: nil,
           billing_frequency: nil,
           commit_ids: nil,
           presentation_group_values: nil,
@@ -335,6 +343,7 @@ module MetronomeSDK
         sig do
           override.returns(
             {
+              any_commit_or_credit_ids: T::Array[String],
               billing_frequency:
                 MetronomeSDK::Override::OverrideSpecifier::BillingFrequency::TaggedSymbol,
               commit_ids: T::Array[String],

data/rbi/metronome_sdk/models/prepaid_balance_threshold_configuration.rbi

@@ -74,6 +74,8 @@ module MetronomeSDK
       end
       attr_writer :discount_configuration
 
+      # Determines which balances are excluded from remaining balance calculation for
+      # threshold billing.
       sig do
         returns(
           T.nilable(
@@ -128,6 +130,8 @@ module MetronomeSDK
         # commit amount will be in terms of this credit type instead of the fiat currency.
         custom_credit_type_id: nil,
         discount_configuration: nil,
+        # Determines which balances are excluded from remaining balance calculation for
+        # threshold billing.
         threshold_balance_specifiers: nil
       )
       end
@@ -344,6 +348,8 @@ module MetronomeSDK
             )
           end
 
+        # If any of the exclude specifier is met, the balance is not considered when
+        # evaluating threshold billing
         sig do
           returns(
             T::Array[
@@ -361,7 +367,11 @@ module MetronomeSDK
               ]
           ).returns(T.attached_class)
         end
-        def self.new(exclude:)
+        def self.new(
+          # If any of the exclude specifier is met, the balance is not considered when
+          # evaluating threshold billing
+          exclude:
+        )
         end
 
         sig do

data/rbi/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rbi

@@ -74,6 +74,8 @@ module MetronomeSDK
       end
       attr_writer :discount_configuration
 
+      # Determines which balances are excluded from remaining balance calculation for
+      # threshold billing.
       sig do
         returns(
           T.nilable(
@@ -128,6 +130,8 @@ module MetronomeSDK
         # commit amount will be in terms of this credit type instead of the fiat currency.
         custom_credit_type_id: nil,
         discount_configuration: nil,
+        # Determines which balances are excluded from remaining balance calculation for
+        # threshold billing.
         threshold_balance_specifiers: nil
       )
       end