metronome-sdk 3.4.0 → 3.6.0

data/rbi/metronome_sdk/models/v1/package_list_response.rbi

@@ -101,6 +101,13 @@ module MetronomeSDK
         end
         attr_writer :billing_provider
 
+        # The name to use for contracts created from this package.
+        sig { returns(T.nilable(String)) }
+        attr_reader :contract_name
+
+        sig { params(contract_name: String).void }
+        attr_writer :contract_name
+
         sig do
           returns(
             T.nilable(
@@ -335,6 +342,7 @@ module MetronomeSDK
             archived_at: Time,
             billing_provider:
               MetronomeSDK::Models::V1::PackageListResponse::BillingProvider::OrSymbol,
+            contract_name: String,
             credits:
               T::Array[
                 MetronomeSDK::Models::V1::PackageListResponse::Credit::OrHash
@@ -380,6 +388,8 @@ module MetronomeSDK
           aliases: nil,
           archived_at: nil,
           billing_provider: nil,
+          # The name to use for contracts created from this package.
+          contract_name: nil,
           credits: nil,
           delivery_method: nil,
           duration: nil,
@@ -432,6 +442,7 @@ module MetronomeSDK
               archived_at: Time,
               billing_provider:
                 MetronomeSDK::Models::V1::PackageListResponse::BillingProvider::TaggedSymbol,
+              contract_name: String,
               credits:
                 T::Array[MetronomeSDK::Models::V1::PackageListResponse::Credit],
               delivery_method:
@@ -1589,12 +1600,6 @@ module MetronomeSDK
             sig { params(recurring_commit_template_ids: T::Array[String]).void }
             attr_writer :recurring_commit_template_ids
 
-            sig { returns(T.nilable(T::Array[String])) }
-            attr_reader :recurring_credit_template_ids
-
-            sig { params(recurring_credit_template_ids: T::Array[String]).void }
-            attr_writer :recurring_credit_template_ids
-
             sig do
               params(
                 billing_frequency:
@@ -1604,8 +1609,7 @@ module MetronomeSDK
                 pricing_group_values: T::Hash[Symbol, String],
                 product_id: String,
                 product_tags: T::Array[String],
-                recurring_commit_template_ids: T::Array[String],
-                recurring_credit_template_ids: T::Array[String]
+                recurring_commit_template_ids: T::Array[String]
               ).returns(T.attached_class)
             end
             def self.new(
@@ -1615,8 +1619,7 @@ module MetronomeSDK
               pricing_group_values: nil,
               product_id: nil,
               product_tags: nil,
-              recurring_commit_template_ids: nil,
-              recurring_credit_template_ids: nil
+              recurring_commit_template_ids: nil
             )
             end
 
@@ -1630,8 +1633,7 @@ module MetronomeSDK
                   pricing_group_values: T::Hash[Symbol, String],
                   product_id: String,
                   product_tags: T::Array[String],
-                  recurring_commit_template_ids: T::Array[String],
-                  recurring_credit_template_ids: T::Array[String]
+                  recurring_commit_template_ids: T::Array[String]
                 }
               )
             end
@@ -2294,20 +2296,41 @@ module MetronomeSDK
           end
           attr_accessor :frequency
 
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::Models::V1::PackageListResponse::UsageStatementSchedule::Day::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :day
+
+          sig do
+            params(
+              day:
+                MetronomeSDK::Models::V1::PackageListResponse::UsageStatementSchedule::Day::OrSymbol
+            ).void
+          end
+          attr_writer :day
+
           sig do
             params(
               frequency:
-                MetronomeSDK::Models::V1::PackageListResponse::UsageStatementSchedule::Frequency::OrSymbol
+                MetronomeSDK::Models::V1::PackageListResponse::UsageStatementSchedule::Frequency::OrSymbol,
+              day:
+                MetronomeSDK::Models::V1::PackageListResponse::UsageStatementSchedule::Day::OrSymbol
             ).returns(T.attached_class)
           end
-          def self.new(frequency:)
+          def self.new(frequency:, day: nil)
           end
 
           sig do
             override.returns(
               {
                 frequency:
-                  MetronomeSDK::Models::V1::PackageListResponse::UsageStatementSchedule::Frequency::TaggedSymbol
+                  MetronomeSDK::Models::V1::PackageListResponse::UsageStatementSchedule::Frequency::TaggedSymbol,
+                day:
+                  MetronomeSDK::Models::V1::PackageListResponse::UsageStatementSchedule::Day::TaggedSymbol
               }
             )
           end
@@ -2357,6 +2380,40 @@ module MetronomeSDK
             def self.values
             end
           end
+
+          module Day
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::Models::V1::PackageListResponse::UsageStatementSchedule::Day
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            FIRST_OF_MONTH =
+              T.let(
+                :FIRST_OF_MONTH,
+                MetronomeSDK::Models::V1::PackageListResponse::UsageStatementSchedule::Day::TaggedSymbol
+              )
+            CONTRACT_START =
+              T.let(
+                :CONTRACT_START,
+                MetronomeSDK::Models::V1::PackageListResponse::UsageStatementSchedule::Day::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::Models::V1::PackageListResponse::UsageStatementSchedule::Day::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
 
         class Alias < MetronomeSDK::Internal::Type::BaseModel

data/rbi/metronome_sdk/models/v1/package_retrieve_response.rbi

@@ -144,6 +144,13 @@ module MetronomeSDK
           end
           attr_writer :billing_provider
 
+          # The name to use for contracts created from this package.
+          sig { returns(T.nilable(String)) }
+          attr_reader :contract_name
+
+          sig { params(contract_name: String).void }
+          attr_writer :contract_name
+
           sig do
             returns(
               T.nilable(
@@ -384,6 +391,7 @@ module MetronomeSDK
               archived_at: Time,
               billing_provider:
                 MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::BillingProvider::OrSymbol,
+              contract_name: String,
               credits:
                 T::Array[
                   MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Credit::OrHash
@@ -429,6 +437,8 @@ module MetronomeSDK
             aliases: nil,
             archived_at: nil,
             billing_provider: nil,
+            # The name to use for contracts created from this package.
+            contract_name: nil,
             credits: nil,
             delivery_method: nil,
             duration: nil,
@@ -485,6 +495,7 @@ module MetronomeSDK
                 archived_at: Time,
                 billing_provider:
                   MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::BillingProvider::TaggedSymbol,
+                contract_name: String,
                 credits:
                   T::Array[
                     MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Credit
@@ -1647,14 +1658,6 @@ module MetronomeSDK
               end
               attr_writer :recurring_commit_template_ids
 
-              sig { returns(T.nilable(T::Array[String])) }
-              attr_reader :recurring_credit_template_ids
-
-              sig do
-                params(recurring_credit_template_ids: T::Array[String]).void
-              end
-              attr_writer :recurring_credit_template_ids
-
               sig do
                 params(
                   billing_frequency:
@@ -1664,8 +1667,7 @@ module MetronomeSDK
                   pricing_group_values: T::Hash[Symbol, String],
                   product_id: String,
                   product_tags: T::Array[String],
-                  recurring_commit_template_ids: T::Array[String],
-                  recurring_credit_template_ids: T::Array[String]
+                  recurring_commit_template_ids: T::Array[String]
                 ).returns(T.attached_class)
               end
               def self.new(
@@ -1675,8 +1677,7 @@ module MetronomeSDK
                 pricing_group_values: nil,
                 product_id: nil,
                 product_tags: nil,
-                recurring_commit_template_ids: nil,
-                recurring_credit_template_ids: nil
+                recurring_commit_template_ids: nil
               )
               end
 
@@ -1691,8 +1692,7 @@ module MetronomeSDK
                     pricing_group_values: T::Hash[Symbol, String],
                     product_id: String,
                     product_tags: T::Array[String],
-                    recurring_commit_template_ids: T::Array[String],
-                    recurring_credit_template_ids: T::Array[String]
+                    recurring_commit_template_ids: T::Array[String]
                   }
                 )
               end
@@ -2355,20 +2355,41 @@ module MetronomeSDK
             end
             attr_accessor :frequency
 
+            sig do
+              returns(
+                T.nilable(
+                  MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::UsageStatementSchedule::Day::TaggedSymbol
+                )
+              )
+            end
+            attr_reader :day
+
+            sig do
+              params(
+                day:
+                  MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::UsageStatementSchedule::Day::OrSymbol
+              ).void
+            end
+            attr_writer :day
+
             sig do
               params(
                 frequency:
-                  MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::UsageStatementSchedule::Frequency::OrSymbol
+                  MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::UsageStatementSchedule::Frequency::OrSymbol,
+                day:
+                  MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::UsageStatementSchedule::Day::OrSymbol
               ).returns(T.attached_class)
             end
-            def self.new(frequency:)
+            def self.new(frequency:, day: nil)
             end
 
             sig do
               override.returns(
                 {
                   frequency:
-                    MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::UsageStatementSchedule::Frequency::TaggedSymbol
+                    MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::UsageStatementSchedule::Frequency::TaggedSymbol,
+                  day:
+                    MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::UsageStatementSchedule::Day::TaggedSymbol
                 }
               )
             end
@@ -2418,6 +2439,40 @@ module MetronomeSDK
               def self.values
               end
             end
+
+            module Day
+              extend MetronomeSDK::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::UsageStatementSchedule::Day
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              FIRST_OF_MONTH =
+                T.let(
+                  :FIRST_OF_MONTH,
+                  MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::UsageStatementSchedule::Day::TaggedSymbol
+                )
+              CONTRACT_START =
+                T.let(
+                  :CONTRACT_START,
+                  MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::UsageStatementSchedule::Day::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::UsageStatementSchedule::Day::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
           end
 
           class Alias < MetronomeSDK::Internal::Type::BaseModel

data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi

@@ -3576,16 +3576,6 @@ module MetronomeSDK
             sig { params(recurring_commit_ids: T::Array[String]).void }
             attr_writer :recurring_commit_ids
 
-            # 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. If provided, the override will only apply to commits
-            # created by the specified recurring credit 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:
@@ -3595,8 +3585,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(
@@ -3621,12 +3610,7 @@ module MetronomeSDK
               # one of product_id, product_tags, pricing_group_values, or
               # presentation_group_values. If provided, the override will only apply to commits
               # created by the specified recurring commit ids.
-              recurring_commit_ids: 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
-              # presentation_group_values. If provided, the override will only apply to commits
-              # created by the specified recurring credit ids.
-              recurring_credit_ids: nil
+              recurring_commit_ids: nil
             )
             end
 
@@ -3640,8 +3624,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
@@ -8087,14 +8070,14 @@ module MetronomeSDK
           end
           attr_writer :access_schedule
 
-          # Which products the commit applies to. If applicable_product_ids,
-          # applicable_product_tags or specifiers are not provided, the commit applies to
+          # Which products the credit applies to. If applicable_product_ids,
+          # applicable_product_tags or specifiers are not provided, the credit applies to
           # all products.
           sig { returns(T.nilable(T::Array[String])) }
           attr_accessor :applicable_product_ids
 
-          # Which tags the commit applies to. If applicable_product_ids,
-          # applicable_product_tags or specifiers are not provided, the commit applies to
+          # Which tags the credit applies to. If applicable_product_ids,
+          # applicable_product_tags or specifiers are not provided, the credit applies to
           # all products.
           sig { returns(T.nilable(T::Array[String])) }
           attr_accessor :applicable_product_tags
@@ -8180,12 +8163,12 @@ module MetronomeSDK
           def self.new(
             credit_id:,
             access_schedule: nil,
-            # Which products the commit applies to. If applicable_product_ids,
-            # applicable_product_tags or specifiers are not provided, the commit applies to
+            # Which products the credit applies to. If applicable_product_ids,
+            # applicable_product_tags or specifiers are not provided, the credit applies to
             # all products.
             applicable_product_ids: nil,
-            # Which tags the commit applies to. If applicable_product_ids,
-            # applicable_product_tags or specifiers are not provided, the commit applies to
+            # Which tags the credit applies to. If applicable_product_ids,
+            # applicable_product_tags or specifiers are not provided, the credit applies to
             # all products.
             applicable_product_tags: nil,
             description: nil,
@@ -8531,6 +8514,25 @@ module MetronomeSDK
           sig { returns(T.nilable(String)) }
           attr_accessor :custom_credit_type_id
 
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::DiscountConfiguration
+              )
+            )
+          end
+          attr_reader :discount_configuration
+
+          sig do
+            params(
+              discount_configuration:
+                T.nilable(
+                  MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::DiscountConfiguration::OrHash
+                )
+            ).void
+          end
+          attr_writer :discount_configuration
+
           # When set to false, the contract will not be evaluated against the
           # threshold_amount. Toggling to true will result an immediate evaluation,
           # regardless of prior state.
@@ -8570,6 +8572,10 @@ module MetronomeSDK
               commit:
                 MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::Commit::OrHash,
               custom_credit_type_id: T.nilable(String),
+              discount_configuration:
+                T.nilable(
+                  MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::DiscountConfiguration::OrHash
+                ),
               is_enabled: T::Boolean,
               payment_gate_config: MetronomeSDK::PaymentGateConfigV2::OrHash,
               recharge_to_amount: Float,
@@ -8581,6 +8587,7 @@ 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,
             # When set to false, the contract will not be evaluated against the
             # threshold_amount. Toggling to true will result an immediate evaluation,
             # regardless of prior state.
@@ -8600,6 +8607,10 @@ module MetronomeSDK
                 commit:
                   MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::Commit,
                 custom_credit_type_id: T.nilable(String),
+                discount_configuration:
+                  T.nilable(
+                    MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::DiscountConfiguration
+                  ),
                 is_enabled: T::Boolean,
                 payment_gate_config: MetronomeSDK::PaymentGateConfigV2,
                 recharge_to_amount: Float,
@@ -8682,6 +8693,39 @@ module MetronomeSDK
             def to_hash
             end
           end
+
+          class DiscountConfiguration < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::DiscountConfiguration,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            # The fraction of the original amount that the customer pays after applying the
+            # discount. Set to null to remove the discount fraction. For example, 0.85 means
+            # the customer pays 85% of the original amount (a 15% discount).
+            sig { returns(T.nilable(Float)) }
+            attr_accessor :payment_fraction
+
+            sig do
+              params(payment_fraction: T.nilable(Float)).returns(
+                T.attached_class
+              )
+            end
+            def self.new(
+              # The fraction of the original amount that the customer pays after applying the
+              # discount. Set to null to remove the discount fraction. For example, 0.85 means
+              # the customer pays 85% of the original amount (a 15% discount).
+              payment_fraction: nil
+            )
+            end
+
+            sig { override.returns({ payment_fraction: T.nilable(Float) }) }
+            def to_hash
+            end
+          end
         end
 
         class UpdateRecurringCommit < MetronomeSDK::Internal::Type::BaseModel
@@ -9399,6 +9443,25 @@ module MetronomeSDK
           end
           attr_writer :commit
 
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::DiscountConfiguration
+              )
+            )
+          end
+          attr_reader :discount_configuration
+
+          sig do
+            params(
+              discount_configuration:
+                T.nilable(
+                  MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::DiscountConfiguration::OrHash
+                )
+            ).void
+          end
+          attr_writer :discount_configuration
+
           # When set to false, the contract will not be evaluated against the
           # threshold_amount. Toggling to true will result an immediate evaluation,
           # regardless of prior state.
@@ -9429,6 +9492,10 @@ module MetronomeSDK
           sig do
             params(
               commit: MetronomeSDK::UpdateBaseThresholdCommit::OrHash,
+              discount_configuration:
+                T.nilable(
+                  MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::DiscountConfiguration::OrHash
+                ),
               is_enabled: T::Boolean,
               payment_gate_config: MetronomeSDK::PaymentGateConfigV2::OrHash,
               threshold_amount: Float
@@ -9436,6 +9503,7 @@ module MetronomeSDK
           end
           def self.new(
             commit: nil,
+            discount_configuration: nil,
             # When set to false, the contract will not be evaluated against the
             # threshold_amount. Toggling to true will result an immediate evaluation,
             # regardless of prior state.
@@ -9451,6 +9519,10 @@ module MetronomeSDK
             override.returns(
               {
                 commit: MetronomeSDK::UpdateBaseThresholdCommit,
+                discount_configuration:
+                  T.nilable(
+                    MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::DiscountConfiguration
+                  ),
                 is_enabled: T::Boolean,
                 payment_gate_config: MetronomeSDK::PaymentGateConfigV2,
                 threshold_amount: Float
@@ -9459,6 +9531,39 @@ module MetronomeSDK
           end
           def to_hash
           end
+
+          class DiscountConfiguration < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration::DiscountConfiguration,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            # The fraction of the original amount that the customer pays after applying the
+            # discount. Set to null to remove the discount fraction. For example, 0.85 means
+            # the customer pays 85% of the original amount (a 15% discount).
+            sig { returns(T.nilable(Float)) }
+            attr_accessor :payment_fraction
+
+            sig do
+              params(payment_fraction: T.nilable(Float)).returns(
+                T.attached_class
+              )
+            end
+            def self.new(
+              # The fraction of the original amount that the customer pays after applying the
+              # discount. Set to null to remove the discount fraction. For example, 0.85 means
+              # the customer pays 85% of the original amount (a 15% discount).
+              payment_fraction: nil
+            )
+            end
+
+            sig { override.returns({ payment_fraction: T.nilable(Float) }) }
+            def to_hash
+            end
+          end
         end
 
         class UpdateSubscription < MetronomeSDK::Internal::Type::BaseModel