Class: Telnyx::Models::EmailThreadListParams

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

Overview

See Also:

  • Telnyx::Resources::EmailThreads#list

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(filter_inbox_id: nil, filter_label: nil, page_after: nil, page_size: nil, request_options: {}) ⇒ Object

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

Parameters:

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

    Restrict results to one or more inboxes. Repeat the parameter

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

    Returns only threads carrying this label. Matching is exact and case-sensitive.

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

    Opaque cursor returned by the previous page.

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

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

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



# File 'lib/telnyx/models/email_thread_list_params.rb', line 39

Instance Attribute Details

#filter_inbox_id ⇒ Array<String>?

Restrict results to one or more inboxes. Repeat the parameter (filter[inbox_id][]=...&filter[inbox_id][]=...) or pass a comma-separated list. Omit to list every inbox in the account. Inboxes outside the account are silently excluded. If the filter is present, it must contain at least one non-empty UUID.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


18
 
# File 'lib/telnyx/models/email_thread_list_params.rb', line 18

optional :filter_inbox_id, Telnyx::Internal::Type::ArrayOf[String]

#filter_label ⇒ String?

Returns only threads carrying this label. Matching is exact and case-sensitive. Thread labels are independent of the labels on the thread's messages.

Parameters:

  • (String)

Returns:

  • (String, nil) 


25
 
# File 'lib/telnyx/models/email_thread_list_params.rb', line 25

optional :filter_label, String

#page_after ⇒ String?

Opaque cursor returned by the previous page.

Parameters:

  • (String)

Returns:

  • (String, nil) 


31
 
# File 'lib/telnyx/models/email_thread_list_params.rb', line 31

optional :page_after, String

#page_size ⇒ Integer?

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

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


37
 
# File 'lib/telnyx/models/email_thread_list_params.rb', line 37

optional :page_size, Integer

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


40
 
# File 'sig/telnyx/models/email_thread_list_params.rbs', line 40

def to_hash: -> {