Class: Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/orb/models/price_evaluate_preview_events_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::PriceEvaluatePreviewEventsParams::PriceEvaluation for more details.

Parameters:




# File 'lib/orb/models/price_evaluate_preview_events_params.rb', line 152

Instance Attribute Details

#external_price_id ⇒ String?

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

Returns:

  • (String, nil) 


117
 
# File 'lib/orb/models/price_evaluate_preview_events_params.rb', line 117

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) 


125
 
# File 'lib/orb/models/price_evaluate_preview_events_params.rb', line 125

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) 


133
 
# File 'lib/orb/models/price_evaluate_preview_events_params.rb', line 133

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:



140
141
142
143
144
 
# File 'lib/orb/models/price_evaluate_preview_events_params.rb', line 140

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

#price_id ⇒ String?

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

Returns:

  • (String, nil) 


150
 
# File 'lib/orb/models/price_evaluate_preview_events_params.rb', line 150

optional :price_id, String, nil?: true