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

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

Classes: ProrationRounding, QuantityManagementModeUpdate, QuantityUpdate, SeatUpdates

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

Some parameter documentations has been truncated, see QuantityUpdate for more details.

Parameters:

  • starting_at (Time)
  • 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




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

Instance Attribute Details

#ending_before ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


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

optional :ending_before, Time, nil?: true

#proration_rounding ⇒ MetronomeSDK::Models::V2::ContractEditParams::UpdateSubscription::ProrationRounding?

Parameters:

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

Returns:



5084
5085
5086
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 5084

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

#quantity_management_mode_update ⇒ MetronomeSDK::Models::V2::ContractEditParams::UpdateSubscription::QuantityManagementModeUpdate?

Update the subscription's quantity management mode from QUANTITY_ONLY to SEAT_BASED with the provided seat_group_key.

Returns:



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

optional :quantity_management_mode_update,
-> { MetronomeSDK::V2::ContractEditParams::UpdateSubscription::QuantityManagementModeUpdate }

#quantity_updates ⇒ Array<MetronomeSDK::Models::V2::ContractEditParams::UpdateSubscription::QuantityUpdate>?

Quantity changes are applied on the effective date based on the order which they are sent. For example, if I scheduled the quantity to be 12 on May 21 and then scheduled a quantity delta change of -1, the result from that day would be 11.

Returns:



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

optional :quantity_updates,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::UpdateSubscription::QuantityUpdate] }

#seat_updates ⇒ MetronomeSDK::Models::V2::ContractEditParams::UpdateSubscription::SeatUpdates?

Returns:



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

optional :seat_updates, -> { MetronomeSDK::V2::ContractEditParams::UpdateSubscription::SeatUpdates }

#subscription_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :subscription_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {