Class: MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCommit

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/metronome_sdk/models/v2/contract_edit_params.rb,
sig/metronome_sdk/models/v2/contract_edit_params.rbs

Defined Under Namespace

Modules: RateType Classes: AccessAmount, InvoiceAmount, ProrationRounding

Instance Attribute Summary collapse

Class Method 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(quantity: nil, unit_price: nil) ⇒ Object

Parameters:

  • quantity (Float) (defaults to: nil)
  • unit_price (Float) (defaults to: nil)


# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 4539

Instance Attribute Details

#access_amountMetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCommit::AccessAmount?



4510
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 4510

optional :access_amount, -> { MetronomeSDK::V2::ContractEditParams::UpdateRecurringCommit::AccessAmount }

#ending_beforeTime?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil)


4515
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 4515

optional :ending_before, Time, nil?: true

#invoice_amountMetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCommit::InvoiceAmount?



4520
4521
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 4520

optional :invoice_amount,
-> { MetronomeSDK::V2::ContractEditParams::UpdateRecurringCommit::InvoiceAmount }

#proration_roundingMetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCommit::ProrationRounding?

If provided, updates the rounding config on the recurring commit. Set to null to clear rounding. Omit to leave unchanged.

Parameters:

  • value (MetronomeSDK::V2::ContractEditParams::UpdateRecurringCommit::ProrationRounding, nil)

Returns:



4528
4529
4530
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 4528

optional :proration_rounding,
-> { MetronomeSDK::V2::ContractEditParams::UpdateRecurringCommit::ProrationRounding },
nil?: true

#rate_typeSymbol, ...

If provided, updates the recurring commit to use the specified rate type when generating future commits.



4537
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 4537

optional :rate_type, enum: -> { MetronomeSDK::V2::ContractEditParams::UpdateRecurringCommit::RateType }

#recurring_commit_idString

Parameters:

  • value (String)

Returns:

  • (String)


4505
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 4505

required :recurring_commit_id, String

Class Method Details

.valuesArray<Symbol>

Returns:

  • (Array<Symbol>)


# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 4688

Instance Method Details

#to_hash{

Returns:

  • ({)


4242
# File 'sig/metronome_sdk/models/v2/contract_edit_params.rbs', line 4242

def to_hash: -> {