Class: Orb::Models::PriceEvaluatePreviewEventsParams

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

Overview

See Also:

Defined Under Namespace

Classes: Event, PriceEvaluation

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(event_name: , properties: , timestamp: , customer_id: nil, external_customer_id: nil) ⇒ Object

Some parameter documentations has been truncated, see Event for more details.

Parameters:

  • event_name (String) (defaults to: ) —

    A name to meaningfully identify the action or event type.

  • properties (Hash{Symbol=>Object}) (defaults to: ) —

    A dictionary of custom properties. Values in this dictionary must be numeric, bo

  • timestamp (Time) (defaults to: ) —

    An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen

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

    The Orb Customer identifier

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

    An alias for the Orb customer, whose mapping is specified when creating the cust




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

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_preview_events_params.rb', line 26

optional :customer_id, String, nil?: true

#events ⇒ Array<Orb::Models::PriceEvaluatePreviewEventsParams::Event>?

List of preview events to use instead of actual usage data

Returns:



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

optional :events, -> { Orb::Internal::Type::ArrayOf[Orb::PriceEvaluatePreviewEventsParams::Event] }

#external_customer_id ⇒ String?

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

Returns:

  • (String, nil) 


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

optional :external_customer_id, String, nil?: true

#price_evaluations ⇒ Array<Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation>?

List of prices to evaluate (max 100)

Returns:



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

optional :price_evaluations,
-> { Orb::Internal::Type::ArrayOf[Orb::PriceEvaluatePreviewEventsParams::PriceEvaluation] }

#timeframe_end ⇒ Time

The exclusive upper bound for event timestamps

Returns:

  • (Time) 


14
 
# File 'lib/orb/models/price_evaluate_preview_events_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_preview_events_params.rb', line 20

required :timeframe_start, Time