Class: Orb::Models::EventSearchParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/orb/models/event_search_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(event_ids: , timeframe_end: nil, timeframe_start: nil, request_options: {}) ⇒ Object

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

Parameters:

  • event_ids (Array<String>) (defaults to: ) —

    This is an explicit array of IDs to filter by. Note that an event’s ID is the id

  • timeframe_end (Time, nil) (defaults to: nil) —

    The end of the timeframe, exclusive, in which to search events. If not specified

  • timeframe_start (Time, nil) (defaults to: nil) —

    The start of the timeframe, inclusive, in which to search events. If not specifi

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



# File 'lib/orb/models/event_search_params.rb', line 33

Instance Attribute Details

#event_ids ⇒ Array<String>

This is an explicit array of IDs to filter by. Note that an event’s ID is the idempotency_key that was originally used for ingestion, and this only supports events that have not been amended. Values in this array will be treated case sensitively.

Returns:

  • (Array<String>) 


17
 
# File 'lib/orb/models/event_search_params.rb', line 17

required :event_ids, Orb::Internal::Type::ArrayOf[String]

#timeframe_end ⇒ Time?

The end of the timeframe, exclusive, in which to search events. If not specified, the current time is used.

Returns:

  • (Time, nil) 


24
 
# File 'lib/orb/models/event_search_params.rb', line 24

optional :timeframe_end, Time, nil?: true

#timeframe_start ⇒ Time?

The start of the timeframe, inclusive, in which to search events. If not specified, the one week ago is used.

Returns:

  • (Time, nil) 


31
 
# File 'lib/orb/models/event_search_params.rb', line 31

optional :timeframe_start, Time, nil?: true