Class: MetronomeSDK::Models::V2::ContractEditParams::UpdateSubscription::QuantityUpdate

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

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(starting_at: , quantity: nil, quantity_delta: nil) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V2::ContractEditParams::UpdateSubscription::QuantityUpdate for more details.

Parameters:

  • starting_at (Time) (defaults to: )
  • quantity (Float) (defaults to: nil) —

    The new quantity for the subscription. Must be provided if quantity_delta is not

  • quantity_delta (Float) (defaults to: nil) —

    The delta to add to the subscription’s quantity. Must be provided if quantity is



4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 4092

class QuantityUpdate < MetronomeSDK::Internal::Type::BaseModel
  # @!attribute starting_at
  #
  #   @return [Time]
  required :starting_at, Time

  # @!attribute quantity
  #   The new quantity for the subscription. Must be provided if quantity_delta is not
  #   provided. Must be non-negative.
  #
  #   @return [Float, nil]
  optional :quantity, Float

  # @!attribute quantity_delta
  #   The delta to add to the subscription's quantity. Must be provided if quantity is
  #   not provided. Can't be zero. It also can't result in a negative quantity on the
  #   subscription.
  #
  #   @return [Float, nil]
  optional :quantity_delta, Float

  # @!method initialize(starting_at:, quantity: nil, quantity_delta: nil)
  #   Some parameter documentations has been truncated, see
  #   {MetronomeSDK::Models::V2::ContractEditParams::UpdateSubscription::QuantityUpdate}
  #   for more details.
  #
  #   @param starting_at [Time]
  #
  #   @param quantity [Float] The new quantity for the subscription. Must be provided if quantity_delta is not
  #
  #   @param quantity_delta [Float] The delta to add to the subscription's quantity. Must be provided if quantity is
end

Instance Attribute Details

#quantity ⇒ Float?

The new quantity for the subscription. Must be provided if quantity_delta is not provided. Must be non-negative.

Returns:

  • (Float, nil) 


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

optional :quantity, Float

#quantity_delta ⇒ Float?

The delta to add to the subscription’s quantity. Must be provided if quantity is not provided. Can’t be zero. It also can’t result in a negative quantity on the subscription.

Returns:

  • (Float, nil) 


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

optional :quantity_delta, Float

#starting_at ⇒ Time

Returns:

  • (Time) 


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

required :starting_at, Time