Class: Telnyx::Models::EmailMessages::RecipientListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::EmailMessages::RecipientListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/email_messages/recipient_list_params.rb,
sig/telnyx/models/email_messages/recipient_list_params.rbs

Overview

See Also:

• Telnyx::Resources::EmailMessages::Recipients#list

Defined Under Namespace

Modules: Kind, Status

Instance Attribute Summary

• #email_id ⇒ String
• #kind ⇒ Symbol, ...

  Filter recipients by address kind.

• #page_cursor ⇒ String^?

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

• #page_size ⇒ Integer^?

  Number of results to return.

• #status ⇒ Symbol, ...

  Filter recipients by status.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(email_id:, kind: nil, page_cursor: nil, page_size: nil, status: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see RecipientListParams 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(email_id:, kind: nil, page_cursor: nil, page_size: nil, status: nil, request_options: {}) ⇒ Object

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

Parameters:

• email_id (String)
• kind (Symbol, Telnyx::Models::EmailMessages::RecipientListParams::Kind) (defaults to: nil) —

  Filter recipients by address kind.

• 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

• status (Symbol, Telnyx::Models::EmailMessages::RecipientListParams::Status) (defaults to: nil) —

  Filter recipients by status.

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

# File 'lib/telnyx/models/email_messages/recipient_list_params.rb', line 41

Instance Attribute Details

#email_id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :email_id, String

#kind ⇒ Symbol, ...

Filter recipients by address kind.

Returns:

• (Symbol, Telnyx::Models::EmailMessages::RecipientListParams::Kind, nil)

# File 'lib/telnyx/models/email_messages/recipient_list_params.rb', line 20

optional :kind, enum: -> { Telnyx::EmailMessages::RecipientListParams::Kind }

#page_cursor ⇒ String^?

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

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/email_messages/recipient_list_params.rb', line 26

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)

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

optional :page_size, Integer

#status ⇒ Symbol, ...

Filter recipients by status.

Returns:

• (Symbol, Telnyx::Models::EmailMessages::RecipientListParams::Status, nil)

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

optional :status, enum: -> { Telnyx::EmailMessages::RecipientListParams::Status }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/email_messages/recipient_list_params.rb', line 65

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/telnyx/models/email_messages/recipient_list_params.rbs', line 49

def to_hash: -> {