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

Overview

See Also:

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) (defaults to: ) —

    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 254

Instance Attribute Details

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

Additional adjustments to be added to the plan.

Returns:



21
22
23
24
25
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 21

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.

Returns:



31
32
33
34
35
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 31

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

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

Adjustments to be removed from the plan.

Returns:



41
42
43
44
45
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 41

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.

Returns:



51
52
53
54
55
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 51

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.

Returns:



61
62
63
64
65
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 61

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.

Returns:



71
72
73
74
75
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 71

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

Returns:

  • (Boolean, nil) 


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

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

#version ⇒ Integer

New version number.

Returns:

  • (Integer) 


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

required :version, Integer

Class Method Details

.variants ⇒ Array(Orb::Models::NewPercentageDiscount, Orb::Models::NewUsageDiscount, Orb::Models::NewAmountDiscount, Orb::Models::NewMinimum, Orb::Models::NewMaximum)

Returns:




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