Class: Telnyx::Models::EmailThreadRetrieveParams

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

Overview

See Also:

  • Telnyx::Resources::EmailThreads#retrieve

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

Parameters:

  • thread_id (String)
  • inbox_id (String) —

    Inbox UUID that, together with thread_id, identifies the thread.

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

    Opaque message cursor returned by the previous thread-detail page.

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

    Number of thread messages to return. Defaults to 25; maximum is 100.

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



# File 'lib/telnyx/models/email_thread_retrieve_params.rb', line 33

Instance Attribute Details

#inbox_id ⇒ String

Inbox UUID that, together with thread_id, identifies the thread.

Parameters:

  • value (String)

Returns:

  • (String) 


19
 
# File 'lib/telnyx/models/email_thread_retrieve_params.rb', line 19

required :inbox_id, String

#page_after ⇒ String?

Opaque message cursor returned by the previous thread-detail page.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :page_after, String

#page_size ⇒ Integer?

Number of thread messages to return. Defaults to 25; maximum is 100.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :page_size, Integer

#thread_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


13
 
# File 'lib/telnyx/models/email_thread_retrieve_params.rb', line 13

required :thread_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


36
 
# File 'sig/telnyx/models/email_thread_retrieve_params.rbs', line 36

def to_hash: -> {