Class: Orb::Models::PriceEvaluatePreviewEventsParams::Event

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

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

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.

  • events (Array<Orb::Models::PriceEvaluatePreviewEventsParams::Event>) (defaults to: nil) —

    List of preview events to use instead of actual usage data

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

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

  • price_evaluations (Array<Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation>) (defaults to: nil) —

    List of prices to evaluate (max 100)

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


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
 
# File 'lib/orb/models/price_evaluate_preview_events_params.rb', line 62

class Event < Orb::Internal::Type::BaseModel
  # @!attribute event_name
  #   A name to meaningfully identify the action or event type.
  #
  #   @return [String]
  required :event_name, String

  # @!attribute properties
  #   A dictionary of custom properties. Values in this dictionary must be numeric,
  #   boolean, or strings. Nested dictionaries are disallowed.
  #
  #   @return [Hash{Symbol=>Object}]
  required :properties, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown]

  # @!attribute timestamp
  #   An ISO 8601 format date with no timezone offset (i.e. UTC). This should
  #   represent the time that usage was recorded, and is particularly important to
  #   attribute usage to a given billing period.
  #
  #   @return [Time]
  required :timestamp, Time

  # @!attribute customer_id
  #   The Orb Customer identifier
  #
  #   @return [String, nil]
  optional :customer_id, String, nil?: true

  # @!attribute external_customer_id
  #   An alias for the Orb customer, whose mapping is specified when creating the
  #   customer
  #
  #   @return [String, nil]
  optional :external_customer_id, String, nil?: true

  # @!method initialize(event_name:, properties:, timestamp:, customer_id: nil, external_customer_id: nil)
  #   Some parameter documentations has been truncated, see
  #   {Orb::Models::PriceEvaluatePreviewEventsParams::Event} for more details.
  #
  #   @param event_name [String] A name to meaningfully identify the action or event type.
  #
  #   @param properties [Hash{Symbol=>Object}] A dictionary of custom properties. Values in this dictionary must be numeric, bo
  #
  #   @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen
  #
  #   @param customer_id [String, nil] The Orb Customer identifier
  #
  #   @param external_customer_id [String, nil] An alias for the Orb customer, whose mapping is specified when creating the cust
end

Instance Attribute Details

#customer_id ⇒ String?

The Orb Customer identifier

Returns:

  • (String, nil) 


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

optional :customer_id, String, nil?: true

#event_name ⇒ String

A name to meaningfully identify the action or event type.

Returns:

  • (String) 


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

required :event_name, String

#external_customer_id ⇒ String?

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

Returns:

  • (String, nil) 


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

optional :external_customer_id, String, nil?: true

#properties ⇒ Hash{Symbol=>Object}

A dictionary of custom properties. Values in this dictionary must be numeric, boolean, or strings. Nested dictionaries are disallowed.

Returns:

  • (Hash{Symbol=>Object}) 


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

required :properties, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown]

#timestamp ⇒ Time

An ISO 8601 format date with no timezone offset (i.e. UTC). This should represent the time that usage was recorded, and is particularly important to attribute usage to a given billing period.

Returns:

  • (Time) 


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

required :timestamp, Time