Class: Orb::Models::Events::VolumeListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/orb/models/events/volume_list_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_start: , cursor: nil, limit: nil, timeframe_end: nil, request_options: {}) ⇒ Object

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

Parameters:

  • timeframe_start (Time) (defaults to: ) —

    The start of the timeframe, inclusive, in which to return event volume. All date

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

    Cursor for pagination. This can be populated by the ‘next_cursor` value returned

  • limit (Integer) (defaults to: nil) —

    The number of items to fetch. Defaults to 20.

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

    The end of the timeframe, exclusive, in which to return event volume. If not spe

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



# File 'lib/orb/models/events/volume_list_params.rb', line 42

Instance Attribute Details

#cursor ⇒ String?

Cursor for pagination. This can be populated by the ‘next_cursor` value returned from the initial request.

Returns:

  • (String, nil) 


25
 
# File 'lib/orb/models/events/volume_list_params.rb', line 25

optional :cursor, String, nil?: true

#limit ⇒ Integer?

The number of items to fetch. Defaults to 20.

Returns:

  • (Integer, nil) 


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

optional :limit, Integer

#timeframe_end ⇒ Time?

The end of the timeframe, exclusive, in which to return event volume. If not specified, the current time is used. All datetime values are converted to UTC time.If the specified time isn’t hour-aligned, the response includes the event volumecount for the hour the time falls in.

Returns:

  • (Time, nil) 


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

optional :timeframe_end, Time

#timeframe_start ⇒ Time

The start of the timeframe, inclusive, in which to return event volume. All datetime values are converted to UTC time. If the specified time isn’t hour-aligned, the response includes the event volume count for the hour the time falls in.

Returns:

  • (Time) 


18
 
# File 'lib/orb/models/events/volume_list_params.rb', line 18

required :timeframe_start, Time