Class: MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings

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

Defined Under Namespace

Modules: RolloverAmount

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(expires_at: , priority: , rollover_amount: ) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings for more details.

Configure a rollover for this credit grant so if it expires it rolls over a configured amount to a new credit grant. This feature is currently opt-in only. Contact Metronome to be added to the beta.

Parameters:




# File 'lib/metronome_sdk/models/v1/credit_grant_create_params.rb', line 195

Instance Attribute Details

#expires_at ⇒ Time

The date to expire the rollover credits.

Returns:

  • (Time) 


179
 
# File 'lib/metronome_sdk/models/v1/credit_grant_create_params.rb', line 179

required :expires_at, Time

#priority ⇒ Float

The priority to give the rollover credit grant that gets created when a rollover happens.

Returns:

  • (Float) 


186
 
# File 'lib/metronome_sdk/models/v1/credit_grant_create_params.rb', line 186

required :priority, Float

#rollover_amount ⇒ MetronomeSDK::Models::V1::RolloverAmountMaxPercentage, MetronomeSDK::Models::V1::RolloverAmountMaxAmount

Specify how much to rollover to the rollover credit grant

Returns:



192
193
 
# File 'lib/metronome_sdk/models/v1/credit_grant_create_params.rb', line 192

required :rollover_amount,
union: -> { MetronomeSDK::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount }