Class: MetronomeSDK::Models::PrepaidBalanceThresholdConfiguration

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/metronome_sdk/models/prepaid_balance_threshold_configuration.rb

Defined Under Namespace

Classes: Commit

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(commit: , is_enabled: , payment_gate_config: , recharge_to_amount: , threshold_amount: , custom_credit_type_id: nil) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::PrepaidBalanceThresholdConfiguration for more details.

Parameters:

  • commit (MetronomeSDK::Models::PrepaidBalanceThresholdConfiguration::Commit) (defaults to: )
  • is_enabled (Boolean) (defaults to: ) —

    When set to false, the contract will not be evaluated against the threshold_amou

  • payment_gate_config (MetronomeSDK::Models::PaymentGateConfig) (defaults to: )
  • recharge_to_amount (Float) (defaults to: ) —

    Specify the amount the balance should be recharged to.

  • threshold_amount (Float) (defaults to: ) —

    Specify the threshold amount for the contract. Each time the contract’s prepaid

  • custom_credit_type_id (String) (defaults to: nil) —

    If provided, the threshold, recharge-to amount, and the resulting threshold comm




# File 'lib/metronome_sdk/models/prepaid_balance_threshold_configuration.rb', line 44

Instance Attribute Details

#commit ⇒ MetronomeSDK::Models::PrepaidBalanceThresholdConfiguration::Commit

Returns:



9
 
# File 'lib/metronome_sdk/models/prepaid_balance_threshold_configuration.rb', line 9

required :commit, -> { MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit }

#custom_credit_type_id ⇒ String?

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.

Returns:

  • (String, nil) 


42
 
# File 'lib/metronome_sdk/models/prepaid_balance_threshold_configuration.rb', line 42

optional :custom_credit_type_id, String

#is_enabled ⇒ Boolean

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.

Returns:

  • (Boolean) 


17
 
# File 'lib/metronome_sdk/models/prepaid_balance_threshold_configuration.rb', line 17

required :is_enabled, MetronomeSDK::Internal::Type::Boolean

#payment_gate_config ⇒ MetronomeSDK::Models::PaymentGateConfig

Returns:



22
 
# File 'lib/metronome_sdk/models/prepaid_balance_threshold_configuration.rb', line 22

required :payment_gate_config, -> { MetronomeSDK::PaymentGateConfig }

#recharge_to_amount ⇒ Float

Specify the amount the balance should be recharged to.

Returns:

  • (Float) 


28
 
# File 'lib/metronome_sdk/models/prepaid_balance_threshold_configuration.rb', line 28

required :recharge_to_amount, Float

#threshold_amount ⇒ Float

Specify the threshold amount for the contract. Each time the contract’s prepaid balance lowers to this amount, a threshold charge will be initiated.

Returns:

  • (Float) 


35
 
# File 'lib/metronome_sdk/models/prepaid_balance_threshold_configuration.rb', line 35

required :threshold_amount, Float