Class: Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/orb/models/price_evaluate_multiple_params.rb

Defined Under Namespace

Modules: Price

Instance Attribute 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(external_price_id: nil, filter: nil, grouping_keys: nil, price: nil, price_id: nil) ⇒ Object

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

Parameters:



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/orb/models/price_evaluate_multiple_params.rb', line 54

class PriceEvaluation < Orb::Internal::Type::BaseModel
  # @!attribute external_price_id
  #   The external ID of a price to evaluate that exists in your Orb account.
  #
  #   @return [String, nil]
  optional :external_price_id, String, nil?: true

  # @!attribute filter
  #   A boolean
  #   [computed property](/extensibility/advanced-metrics#computed-properties) used to
  #   filter the underlying billable metric
  #
  #   @return [String, nil]
  optional :filter, String, nil?: true

  # @!attribute grouping_keys
  #   Properties (or
  #   [computed properties](/extensibility/advanced-metrics#computed-properties)) used
  #   to group the underlying billable metric
  #
  #   @return [Array<String>, nil]
  optional :grouping_keys, Orb::Internal::Type::ArrayOf[String]

  # @!attribute price
  #   An inline price definition to evaluate, allowing you to test price
  #   configurations before adding them to Orb.
  #
  #   @return [Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingTieredBPSPrice, Orb::Models::NewFloatingBPSPrice, Orb::Models::NewFloatingBulkBPSPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, nil]
  optional :price, union: -> { Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price }, nil?: true

  # @!attribute price_id
  #   The ID of a price to evaluate that exists in your Orb account.
  #
  #   @return [String, nil]
  optional :price_id, String, nil?: true

  # @!method initialize(external_price_id: nil, filter: nil, grouping_keys: nil, price: nil, price_id: nil)
  #   Some parameter documentations has been truncated, see
  #   {Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation} for more details.
  #
  #   @param external_price_id [String, nil] The external ID of a price to evaluate that exists in your Orb account.
  #
  #   @param filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
  #
  #   @param grouping_keys [Array<String>] Properties (or [computed properties](/extensibility/advanced-metrics#computed-pr
  #
  #   @param price [Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingTieredBPSPrice, Orb::Models::NewFloatingBPSPrice, Orb::Models::NewFloatingBulkBPSPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, nil] An inline price definition to evaluate, allowing you to test price configuration
  #
  #   @param price_id [String, nil] The ID of a price to evaluate that exists in your Orb account.

  # An inline price definition to evaluate, allowing you to test price
  # configurations before adding them to Orb.
  #
  # @see Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation#price
  module Price
    extend Orb::Internal::Type::Union

    discriminator :model_type

    variant :unit, -> { Orb::NewFloatingUnitPrice }

    variant :package, -> { Orb::NewFloatingPackagePrice }

    variant :matrix, -> { Orb::NewFloatingMatrixPrice }

    variant :matrix_with_allocation, -> { Orb::NewFloatingMatrixWithAllocationPrice }

    variant :tiered, -> { Orb::NewFloatingTieredPrice }

    variant :tiered_bps, -> { Orb::NewFloatingTieredBPSPrice }

    variant :bps, -> { Orb::NewFloatingBPSPrice }

    variant :bulk_bps, -> { Orb::NewFloatingBulkBPSPrice }

    variant :bulk, -> { Orb::NewFloatingBulkPrice }

    variant :threshold_total_amount, -> { Orb::NewFloatingThresholdTotalAmountPrice }

    variant :tiered_package, -> { Orb::NewFloatingTieredPackagePrice }

    variant :grouped_tiered, -> { Orb::NewFloatingGroupedTieredPrice }

    variant :max_group_tiered_package, -> { Orb::NewFloatingMaxGroupTieredPackagePrice }

    variant :tiered_with_minimum, -> { Orb::NewFloatingTieredWithMinimumPrice }

    variant :package_with_allocation, -> { Orb::NewFloatingPackageWithAllocationPrice }

    variant :tiered_package_with_minimum, -> { Orb::NewFloatingTieredPackageWithMinimumPrice }

    variant :unit_with_percent, -> { Orb::NewFloatingUnitWithPercentPrice }

    variant :tiered_with_proration, -> { Orb::NewFloatingTieredWithProrationPrice }

    variant :unit_with_proration, -> { Orb::NewFloatingUnitWithProrationPrice }

    variant :grouped_allocation, -> { Orb::NewFloatingGroupedAllocationPrice }

    variant :grouped_with_prorated_minimum, -> { Orb::NewFloatingGroupedWithProratedMinimumPrice }

    variant :grouped_with_metered_minimum, -> { Orb::NewFloatingGroupedWithMeteredMinimumPrice }

    variant :matrix_with_display_name, -> { Orb::NewFloatingMatrixWithDisplayNamePrice }

    variant :bulk_with_proration, -> { Orb::NewFloatingBulkWithProrationPrice }

    variant :grouped_tiered_package, -> { Orb::NewFloatingGroupedTieredPackagePrice }

    variant :scalable_matrix_with_unit_pricing, -> { Orb::NewFloatingScalableMatrixWithUnitPricingPrice }

    variant :scalable_matrix_with_tiered_pricing, -> { Orb::NewFloatingScalableMatrixWithTieredPricingPrice }

    variant :cumulative_grouped_bulk, -> { Orb::NewFloatingCumulativeGroupedBulkPrice }

    # @!method self.variants
    #   @return [Array(Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingTieredBPSPrice, Orb::Models::NewFloatingBPSPrice, Orb::Models::NewFloatingBulkBPSPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice)]
  end
end

Instance Attribute Details

#external_price_id ⇒ String?

The external ID of a price to evaluate that exists in your Orb account.

Returns:

  • (String, nil) 


59
 
# File 'lib/orb/models/price_evaluate_multiple_params.rb', line 59

optional :external_price_id, String, nil?: true

#filter ⇒ String?

A boolean [computed property](/extensibility/advanced-metrics#computed-properties) used to filter the underlying billable metric

Returns:

  • (String, nil) 


67
 
# File 'lib/orb/models/price_evaluate_multiple_params.rb', line 67

optional :filter, String, nil?: true

#grouping_keys ⇒ Array<String>?

Properties (or [computed properties](/extensibility/advanced-metrics#computed-properties)) used to group the underlying billable metric

Returns:

  • (Array<String>, nil) 


75
 
# File 'lib/orb/models/price_evaluate_multiple_params.rb', line 75

optional :grouping_keys, Orb::Internal::Type::ArrayOf[String]

#price ⇒ Orb::Models::NewFloatingUnitPrice, ...

An inline price definition to evaluate, allowing you to test price configurations before adding them to Orb.

Returns:



82
 
# File 'lib/orb/models/price_evaluate_multiple_params.rb', line 82

optional :price, union: -> { Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price }, nil?: true

#price_id ⇒ String?

The ID of a price to evaluate that exists in your Orb account.

Returns:

  • (String, nil) 


88
 
# File 'lib/orb/models/price_evaluate_multiple_params.rb', line 88

optional :price_id, String, nil?: true