Class: MetronomeSDK::Models::V1::ContractCreateParams::ScheduledCharge::Schedule::RecurringSchedule

Inherits:
Internal::Type::BaseModel
  • Object
show all
Defined in:
lib/metronome_sdk/models/v1/contract_create_params.rb,
sig/metronome_sdk/models/v1/contract_create_params.rbs

Overview

See Also:

  • MetronomeSDK::Models::V1::ContractCreateParams::ScheduledCharge::Schedule#recurring_schedule

Defined Under Namespace

Modules: AmountDistribution, Frequency

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(amount_distribution:, ending_before:, frequency:, starting_at:, amount: nil, quantity: nil, unit_price: nil) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V1::ContractCreateParams::ScheduledCharge::Schedule::RecurringSchedule for more details.

Enter the unit price and quantity for the charge or instead only send the amount. If amount is sent, the unit price is assumed to be the amount and quantity is inferred to be 1.

Parameters:




# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 3039

Instance Attribute Details

#amount ⇒ Float?

Amount for the charge. Can be provided instead of unit_price and quantity. If amount is sent, the unit_price is assumed to be the amount and quantity is inferred to be 1.

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


3021
 
# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 3021

optional :amount, Float

#amount_distribution ⇒ Symbol, MetronomeSDK::Models::V1::ContractCreateParams::ScheduledCharge::Schedule::RecurringSchedule::AmountDistribution

Parameters:

  • value (MetronomeSDK::Models::V1::ContractCreateParams::ScheduledCharge::Schedule::RecurringSchedule::amount_distribution)

Returns:



2994
2995
 
# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 2994

required :amount_distribution,
enum: -> { MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule::RecurringSchedule::AmountDistribution }

#ending_before ⇒ Time

RFC 3339 timestamp (exclusive).

Parameters:

  • value (Time)

Returns:

  • (Time) 


3001
 
# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 3001

required :ending_before, Time

#frequency ⇒ Symbol, MetronomeSDK::Models::V1::ContractCreateParams::ScheduledCharge::Schedule::RecurringSchedule::Frequency

Parameters:

  • value (MetronomeSDK::Models::V1::ContractCreateParams::ScheduledCharge::Schedule::RecurringSchedule::frequency)

Returns:



3006
3007
 
# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 3006

required :frequency,
enum: -> { MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule::RecurringSchedule::Frequency }

#quantity ⇒ Float?

Quantity for the charge. Will be multiplied by unit_price to determine the amount and must be specified with unit_price. If specified amount cannot be provided.

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


3029
 
# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 3029

optional :quantity, Float

#starting_at ⇒ Time

RFC 3339 timestamp (inclusive).

Parameters:

  • value (Time)

Returns:

  • (Time) 


3013
 
# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 3013

required :starting_at, Time

#unit_price ⇒ Float?

Unit price for the charge. Will be multiplied by quantity to determine the amount and must be specified with quantity. If specified amount cannot be provided.

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


3037
 
# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 3037

optional :unit_price, Float

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 3070

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


2748
 
# File 'sig/metronome_sdk/models/v1/contract_create_params.rbs', line 2748

def to_hash: -> {