Class: Telnyx::Models::EmailInboxes::DraftListParams

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

Overview

See Also:

  • Telnyx::Resources::EmailInboxes::Drafts#list

Defined Under Namespace

Modules: FilterStatus

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

Parameters:

  • (defaults to: nil)

    Restrict results to drafts in this state.

  • (defaults to: nil)

    Opaque cursor returned by the previous page.

  • (defaults to: nil)

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

  • (defaults to: {}) 



# File 'lib/telnyx/models/email_inboxes/draft_list_params.rb', line 34

Instance Attribute Details

#filter_status ⇒ Symbol, ...

Restrict results to drafts in this state.

Returns:



20
 
# File 'lib/telnyx/models/email_inboxes/draft_list_params.rb', line 20

optional :filter_status, enum: -> { Telnyx::EmailInboxes::DraftListParams::FilterStatus }

#inbox_id ⇒ String

Parameters:

Returns:



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

required :inbox_id, String

#page_after ⇒ String?

Opaque cursor returned by the previous page.

Parameters:

Returns:



26
 
# File 'lib/telnyx/models/email_inboxes/draft_list_params.rb', line 26

optional :page_after, String

#page_size ⇒ Integer?

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

Parameters:

Returns:



32
 
# File 'lib/telnyx/models/email_inboxes/draft_list_params.rb', line 32

optional :page_size, Integer

Instance Method Details

#to_hash ⇒ {

Returns:



41
 
# File 'sig/telnyx/models/email_inboxes/draft_list_params.rbs', line 41

def to_hash: -> {