Module: Orb::Models::PlanVersion::Adjustment

Extended by:

Internal::Type::Union

Defined in:

lib/orb/models/plan_version.rb

Class Method Summary

• .variants ⇒ Array(Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment)

Instance Method Summary

• #initialize(adjustments: , created_at: , plan_phases: , prices: , version: ) ⇒ Object

  Some parameter documentations has been truncated, see Orb::Models::PlanVersion for more details.

Methods included from Internal::Type::Union

==, ===, coerce, dump, hash, inspect, to_sorbet_type, variants

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Class Method Details

.variants ⇒ Array(Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment)

Returns:

• (Array(Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment))

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

Instance Method Details

#initialize(adjustments: , created_at: , plan_phases: , prices: , version: ) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::PlanVersion for more details.

The PlanVersion resource represents the prices and adjustments present on a specific version of a plan.

Parameters:

• adjustments (Array<Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment>) (defaults to: ) —

  Adjustments for this plan. If the plan has phases, this includes adjustments acr

• created_at (Time) (defaults to: )
• plan_phases (Array<Orb::Models::PlanVersionPhase>, nil) (defaults to: )
• prices (Array<Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::GroupedWithMinMaxThresholds>) (defaults to: ) —

  Prices for this plan. If the plan has phases, this includes prices across all ph

• version (Integer) (defaults to: )

# File 'lib/orb/models/plan_version.rb', line 53

module Adjustment
  extend Orb::Internal::Type::Union

  discriminator :adjustment_type

  variant :usage_discount, -> { Orb::PlanPhaseUsageDiscountAdjustment }

  variant :amount_discount, -> { Orb::PlanPhaseAmountDiscountAdjustment }

  variant :percentage_discount, -> { Orb::PlanPhasePercentageDiscountAdjustment }

  variant :minimum, -> { Orb::PlanPhaseMinimumAdjustment }

  variant :maximum, -> { Orb::PlanPhaseMaximumAdjustment }

  # @!method self.variants
  #   @return [Array(Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment)]
end