Class: Orb::Models::BetaCreatePlanVersionParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/orb/models/beta_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_create_plan_version_params.rb', line 238

Instance Attribute Details

#add_adjustments ⇒ Array<Orb::Models::BetaCreatePlanVersionParams::AddAdjustment>?

Additional adjustments to be added to the plan.

Returns:



20
21
22
 
# File 'lib/orb/models/beta_create_plan_version_params.rb', line 20

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

#add_prices ⇒ Array<Orb::Models::BetaCreatePlanVersionParams::AddPrice>?

Additional prices to be added to the plan.

Returns:



28
29
30
 
# File 'lib/orb/models/beta_create_plan_version_params.rb', line 28

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

#remove_adjustments ⇒ Array<Orb::Models::BetaCreatePlanVersionParams::RemoveAdjustment>?

Adjustments to be removed from the plan.

Returns:



36
37
38
 
# File 'lib/orb/models/beta_create_plan_version_params.rb', line 36

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

#remove_prices ⇒ Array<Orb::Models::BetaCreatePlanVersionParams::RemovePrice>?

Prices to be removed from the plan.

Returns:



44
45
46
 
# File 'lib/orb/models/beta_create_plan_version_params.rb', line 44

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

#replace_adjustments ⇒ Array<Orb::Models::BetaCreatePlanVersionParams::ReplaceAdjustment>?

Adjustments to be replaced with additional adjustments on the plan.

Returns:



52
53
54
 
# File 'lib/orb/models/beta_create_plan_version_params.rb', line 52

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

#replace_prices ⇒ Array<Orb::Models::BetaCreatePlanVersionParams::ReplacePrice>?

Prices to be replaced with additional prices on the plan.

Returns:



60
61
62
 
# File 'lib/orb/models/beta_create_plan_version_params.rb', line 60

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

#set_as_default ⇒ Boolean?

Set this new plan version as the default

Returns:

  • (Boolean, nil) 


68
 
# File 'lib/orb/models/beta_create_plan_version_params.rb', line 68

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

#version ⇒ Integer

New version number.

Returns:

  • (Integer) 


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

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_create_plan_version_params.rb', line 125