Class: Orb::Models::PriceEvaluateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/orb/models/price_evaluate_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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(timeframe_end: , timeframe_start: , customer_id: nil, external_customer_id: nil, filter: nil, grouping_keys: nil, request_options: {}) ⇒ Object

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

Parameters:

  • timeframe_end (Time) (defaults to: ) —

    The exclusive upper bound for event timestamps

  • timeframe_start (Time) (defaults to: ) —

    The inclusive lower bound for event timestamps

  • customer_id (String, nil) (defaults to: nil) —

    The ID of the customer to which this evaluation is scoped.

  • external_customer_id (String, nil) (defaults to: nil) —

    The external customer ID of the customer to which this evaluation is scoped.

  • filter (String, nil) (defaults to: nil) —

    A boolean [computed property](/extensibility/advanced-metrics#computed-propertie

  • grouping_keys (Array<String>) (defaults to: nil) —

    Properties (or [computed properties](/extensibility/advanced-metrics#computed-pr

  • request_options (Orb::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/orb/models/price_evaluate_params.rb', line 50

Instance Attribute Details

#customer_id ⇒ String?

The ID of the customer to which this evaluation is scoped.

Returns:

  • (String, nil) 


26
 
# File 'lib/orb/models/price_evaluate_params.rb', line 26

optional :customer_id, String, nil?: true

#external_customer_id ⇒ String?

The external customer ID of the customer to which this evaluation is scoped.

Returns:

  • (String, nil) 


32
 
# File 'lib/orb/models/price_evaluate_params.rb', line 32

optional :external_customer_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) 


40
 
# File 'lib/orb/models/price_evaluate_params.rb', line 40

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) 


48
 
# File 'lib/orb/models/price_evaluate_params.rb', line 48

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

#timeframe_end ⇒ Time

The exclusive upper bound for event timestamps

Returns:

  • (Time) 


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

required :timeframe_end, Time

#timeframe_start ⇒ Time

The inclusive lower bound for event timestamps

Returns:

  • (Time) 


20
 
# File 'lib/orb/models/price_evaluate_params.rb', line 20

required :timeframe_start, Time