metronome-sdk 3.6.0 → 3.8.0

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,29 @@ module MetronomeSDK
       end
       attr_writer :discount_configuration
 
+      # Determines which balances are excluded from remaining balance calculation for
+      # threshold billing.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[
+              MetronomeSDK::PrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier
+            ]
+          )
+        )
+      end
+      attr_reader :threshold_balance_specifiers
+
+      sig do
+        params(
+          threshold_balance_specifiers:
+            T::Array[
+              MetronomeSDK::PrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::OrHash
+            ]
+        ).void
+      end
+      attr_writer :threshold_balance_specifiers
+
       sig do
         params(
           commit:
@@ -84,7 +107,11 @@ module MetronomeSDK
           threshold_amount: Float,
           custom_credit_type_id: String,
           discount_configuration:
-            MetronomeSDK::PrepaidBalanceThresholdConfiguration::DiscountConfiguration::OrHash
+            MetronomeSDK::PrepaidBalanceThresholdConfiguration::DiscountConfiguration::OrHash,
+          threshold_balance_specifiers:
+            T::Array[
+              MetronomeSDK::PrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::OrHash
+            ]
         ).returns(T.attached_class)
       end
       def self.new(
@@ -102,7 +129,10 @@ module MetronomeSDK
         # 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,
-        discount_configuration: nil
+        discount_configuration: nil,
+        # Determines which balances are excluded from remaining balance calculation for
+        # threshold billing.
+        threshold_balance_specifiers: nil
       )
       end
 
@@ -116,7 +146,11 @@ module MetronomeSDK
             threshold_amount: Float,
             custom_credit_type_id: String,
             discount_configuration:
-              MetronomeSDK::PrepaidBalanceThresholdConfiguration::DiscountConfiguration
+              MetronomeSDK::PrepaidBalanceThresholdConfiguration::DiscountConfiguration,
+            threshold_balance_specifiers:
+              T::Array[
+                MetronomeSDK::PrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier
+              ]
           }
         )
       end
@@ -216,18 +250,277 @@ 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::PrepaidBalanceThresholdConfiguration::DiscountConfiguration::Cap
+            )
+          )
+        end
+        attr_reader :cap
+
+        sig do
+          params(
+            cap:
+              MetronomeSDK::PrepaidBalanceThresholdConfiguration::DiscountConfiguration::Cap::OrHash
+          ).void
+        end
+        attr_writer :cap
+
+        sig do
+          params(
+            payment_fraction: Float,
+            cap:
+              MetronomeSDK::PrepaidBalanceThresholdConfiguration::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::PrepaidBalanceThresholdConfiguration::DiscountConfiguration::Cap
+            }
+          )
+        end
         def to_hash
         end
+
+        class Cap < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::PrepaidBalanceThresholdConfiguration::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
+
+      class ThresholdBalanceSpecifier < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::PrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        # If any of the exclude specifier is met, the balance is not considered when
+        # evaluating threshold billing
+        sig do
+          returns(
+            T::Array[
+              MetronomeSDK::PrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude
+            ]
+          )
+        end
+        attr_accessor :exclude
+
+        sig do
+          params(
+            exclude:
+              T::Array[
+                MetronomeSDK::PrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::OrHash
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # If any of the exclude specifier is met, the balance is not considered when
+          # evaluating threshold billing
+          exclude:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              exclude:
+                T::Array[
+                  MetronomeSDK::PrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Exclude < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::PrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          # If provided, balances with all the custom fields will not be considered when
+          # evaluating threshold billing
+          sig do
+            returns(
+              T::Array[
+                MetronomeSDK::PrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter
+              ]
+            )
+          end
+          attr_accessor :custom_field_filters
+
+          sig do
+            params(
+              custom_field_filters:
+                T::Array[
+                  MetronomeSDK::PrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter::OrHash
+                ]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # If provided, balances with all the custom fields will not be considered when
+            # evaluating threshold billing
+            custom_field_filters:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                custom_field_filters:
+                  T::Array[
+                    MetronomeSDK::PrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter
+                  ]
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class CustomFieldFilter < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::PrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                MetronomeSDK::PrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter::Entity::OrSymbol
+              )
+            end
+            attr_accessor :entity
+
+            sig { returns(String) }
+            attr_accessor :key
+
+            sig { returns(String) }
+            attr_accessor :value
+
+            sig do
+              params(
+                entity:
+                  MetronomeSDK::PrepaidBalanceThresholdConfiguration::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::PrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter::Entity::OrSymbol,
+                  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::PrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter::Entity
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              COMMIT =
+                T.let(
+                  :Commit,
+                  MetronomeSDK::PrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter::Entity::TaggedSymbol
+                )
+              CONTRACT_CREDIT =
+                T.let(
+                  :ContractCredit,
+                  MetronomeSDK::PrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter::Entity::TaggedSymbol
+                )
+              CONTRACT_CREDIT_OR_COMMIT =
+                T.let(
+                  :ContractCreditOrCommit,
+                  MetronomeSDK::PrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter::Entity::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::PrepaidBalanceThresholdConfiguration::ThresholdBalanceSpecifier::Exclude::CustomFieldFilter::Entity::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+        end
       end
     end
   end