Class: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/orb/models/beta/external_plan_id_create_plan_version_params.rb,
sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs

Overview

See Also:

  • Orb::Resources::Beta::ExternalPlanID#create_plan_version

Defined Under Namespace

Classes: AddAdjustment, AddPrice, RemoveAdjustment, RemovePrice, ReplaceAdjustment, ReplacePrice

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(price_id:, plan_phase_order: nil) ⇒ Object

Parameters:

  • price_id (String) —

    The id of the price to remove from the plan.

  • plan_phase_order (Integer, nil) (defaults to: nil) —

    The phase to remove this price from.




# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 2983

Instance Attribute Details

#add_adjustments ⇒ Array<Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddAdjustment>?

Additional adjustments to be added to the plan.

Parameters:

  • value (::Array[Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddAdjustment], nil)

Returns:



26
27
28
29
30
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 26

optional :add_adjustments,
-> {
  Orb::Internal::Type::ArrayOf[Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddAdjustment]
},
nil?: true

#add_prices ⇒ Array<Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice>?

Additional prices to be added to the plan.

Parameters:

  • value (::Array[Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice], nil)

Returns:



36
37
38
39
40
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 36

optional :add_prices,
-> {
  Orb::Internal::Type::ArrayOf[Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice]
},
nil?: true

#external_plan_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 14

required :external_plan_id, String

#remove_adjustments ⇒ Array<Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::RemoveAdjustment>?

Adjustments to be removed from the plan.

Parameters:

  • value (::Array[Orb::Beta::ExternalPlanIDCreatePlanVersionParams::RemoveAdjustment], nil)

Returns:



46
47
48
49
50
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 46

optional :remove_adjustments,
-> {
  Orb::Internal::Type::ArrayOf[Orb::Beta::ExternalPlanIDCreatePlanVersionParams::RemoveAdjustment]
},
nil?: true

#remove_prices ⇒ Array<Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::RemovePrice>?

Prices to be removed from the plan.

Parameters:

  • value (::Array[Orb::Beta::ExternalPlanIDCreatePlanVersionParams::RemovePrice], nil)

Returns:



56
57
58
59
60
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 56

optional :remove_prices,
-> {
  Orb::Internal::Type::ArrayOf[Orb::Beta::ExternalPlanIDCreatePlanVersionParams::RemovePrice]
},
nil?: true

#replace_adjustments ⇒ Array<Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::ReplaceAdjustment>?

Adjustments to be replaced with additional adjustments on the plan.

Parameters:

  • value (::Array[Orb::Beta::ExternalPlanIDCreatePlanVersionParams::ReplaceAdjustment], nil)

Returns:



66
67
68
69
70
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 66

optional :replace_adjustments,
-> {
  Orb::Internal::Type::ArrayOf[Orb::Beta::ExternalPlanIDCreatePlanVersionParams::ReplaceAdjustment]
},
nil?: true

#replace_prices ⇒ Array<Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice>?

Prices to be replaced with additional prices on the plan.

Parameters:

  • value (::Array[Orb::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice], nil)

Returns:



76
77
78
79
80
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 76

optional :replace_prices,
-> {
  Orb::Internal::Type::ArrayOf[Orb::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice]
},
nil?: true

#set_as_default ⇒ Boolean?

Set this new plan version as the default

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


86
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 86

optional :set_as_default, Orb::Internal::Type::Boolean, nil?: true

#version ⇒ Integer

New version number.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


20
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 20

required :version, Integer

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


53
 
# File 'sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs', line 53

def to_hash: -> {