Class: Telnyx::Models::EmailEventRetrieveStatsParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::EmailEventRetrieveStatsParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/email_event_retrieve_stats_params.rb,
sig/telnyx/models/email_event_retrieve_stats_params.rbs

Overview

See Also:

• Telnyx::Resources::EmailEvents#retrieve_stats

Instance Attribute Summary

• #from ⇒ Time^?

  Inclusive ISO 8601 start timestamp.

• #to ⇒ Time^?

  Inclusive ISO 8601 end timestamp.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(from: nil, to: nil, request_options: {}) ⇒ Object constructor

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

• #to_hash ⇒ {

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(from: nil, to: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::EmailEventRetrieveStatsParams for more details.

Parameters:

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

  Inclusive ISO 8601 start timestamp. Defaults to 30 days ago when omitted.

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

  Inclusive ISO 8601 end timestamp. When from is provided without to, defaults

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

# File 'lib/telnyx/models/email_event_retrieve_stats_params.rb', line 23

Instance Attribute Details

#from ⇒ Time^?

Inclusive ISO 8601 start timestamp. Defaults to 30 days ago when omitted.

Parameters:

• (Time)

Returns:

• (Time, nil)

# File 'lib/telnyx/models/email_event_retrieve_stats_params.rb', line 14

optional :from, Time

#to ⇒ Time^?

Inclusive ISO 8601 end timestamp. When from is provided without to, defaults to from + 30 days.

Parameters:

• (Time)

Returns:

• (Time, nil)

# File 'lib/telnyx/models/email_event_retrieve_stats_params.rb', line 21

optional :to, Time

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/telnyx/models/email_event_retrieve_stats_params.rbs', line 24

def to_hash: -> {