Class: Telnyx::Models::EmailEventListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/email_event_list_params.rb,
sig/telnyx/models/email_event_list_params.rbs

Overview

See Also:

  • Telnyx::Resources::EmailEvents#list

Defined Under Namespace

Modules: EventType

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

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

Parameters:

  • email_id (String) (defaults to: nil) —

    Filter events for a specific email message UUID. Invalid UUID values are silentl

  • event_type (String, Array<String>) (defaults to: nil) —

    Comma-separated list of event types to include. Also accepts repeated query para

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

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

  • page_cursor (String) (defaults to: nil) —

    Opaque URL-safe Base64 cursor returned by a previous list response.

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

    Number of results to return. Defaults to 25; maximum is 100. Invalid values are

  • 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_list_params.rb', line 51

Instance Attribute Details

#email_id ⇒ String?

Filter events for a specific email message UUID. Invalid UUID values are silently ignored (no filter applied).

Parameters:

  • (String)

Returns:

  • (String, nil) 


15
 
# File 'lib/telnyx/models/email_event_list_params.rb', line 15

optional :email_id, String

#event_type ⇒ String, ...

Comma-separated list of event types to include. Also accepts repeated query parameters (e.g. event_type=delivered&event_type=bounced). Unknown values return no matches.

Returns:

  • (String, Array<String>, nil) 


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

optional :event_type, union: -> { Telnyx::EmailEventListParams::EventType }

#from ⇒ Time?

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

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


29
 
# File 'lib/telnyx/models/email_event_list_params.rb', line 29

optional :from, Time

#page_cursor ⇒ String?

Opaque URL-safe Base64 cursor returned by a previous list response.

Parameters:

  • (String)

Returns:

  • (String, nil) 


35
 
# File 'lib/telnyx/models/email_event_list_params.rb', line 35

optional :page_cursor, String

#page_size ⇒ Integer?

Number of results to return. Defaults to 25; maximum is 100. Invalid values are clamped to the valid range.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


42
 
# File 'lib/telnyx/models/email_event_list_params.rb', line 42

optional :page_size, Integer

#to ⇒ Time?

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

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


49
 
# File 'lib/telnyx/models/email_event_list_params.rb', line 49

optional :to, Time

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


54
 
# File 'sig/telnyx/models/email_event_list_params.rbs', line 54

def to_hash: -> {