Class: Telnyx::Models::PhoneNumbers::MessagingListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::PhoneNumbers::MessagingListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/phone_numbers/messaging_list_params.rb

Overview

See Also:

• Resources::PhoneNumbers::Messaging#list

Defined Under Namespace

Modules: FilterType, SortPhoneNumber

Instance Attribute Summary

• #filter_messaging_profile_id ⇒ String^?

  Filter by messaging profile ID.

• #filter_phone_number ⇒ String^?

  Filter by exact phone number (supports comma-separated list).

• #filter_phone_number_contains ⇒ String^?

  Filter by phone number substring.

• #filter_type ⇒ Symbol, ...

  Filter by phone number type.

• #page_number ⇒ Integer^?
• #page_size ⇒ Integer^?
• #sort_phone_number ⇒ Symbol, ...

  Sort by phone number.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(filter_messaging_profile_id: nil, filter_phone_number: nil, filter_phone_number_contains: nil, filter_type: nil, page_number: nil, page_size: nil, sort_phone_number: nil, request_options: {}) ⇒ Object constructor

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_messaging_profile_id: nil, filter_phone_number: nil, filter_phone_number_contains: nil, filter_type: nil, page_number: nil, page_size: nil, sort_phone_number: nil, request_options: {}) ⇒ Object

Parameters:

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

  Filter by messaging profile ID.

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

  Filter by exact phone number (supports comma-separated list).

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

  Filter by phone number substring.

• filter_type (Symbol, Telnyx::Models::PhoneNumbers::MessagingListParams::FilterType) (defaults to: nil) —

  Filter by phone number type.

• page_number (Integer) (defaults to: nil)
• page_size (Integer) (defaults to: nil)
• sort_phone_number (Symbol, Telnyx::Models::PhoneNumbers::MessagingListParams::SortPhoneNumber) (defaults to: nil) —

  Sort by phone number.

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

# File 'lib/telnyx/models/phone_numbers/messaging_list_params.rb', line 51

Instance Attribute Details

#filter_messaging_profile_id ⇒ String^?

Filter by messaging profile ID.

Returns:

• (String, nil)

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

optional :filter_messaging_profile_id, String

#filter_phone_number ⇒ String^?

Filter by exact phone number (supports comma-separated list).

Returns:

• (String, nil)

# File 'lib/telnyx/models/phone_numbers/messaging_list_params.rb', line 21

optional :filter_phone_number, String

#filter_phone_number_contains ⇒ String^?

Filter by phone number substring.

Returns:

• (String, nil)

# File 'lib/telnyx/models/phone_numbers/messaging_list_params.rb', line 27

optional :filter_phone_number_contains, String

#filter_type ⇒ Symbol, ...

Filter by phone number type.

Returns:

• (Symbol, Telnyx::Models::PhoneNumbers::MessagingListParams::FilterType, nil)

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

optional :filter_type, enum: -> { Telnyx::PhoneNumbers::MessagingListParams::FilterType }

#page_number ⇒ Integer^?

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/phone_numbers/messaging_list_params.rb', line 38

optional :page_number, Integer

#page_size ⇒ Integer^?

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/phone_numbers/messaging_list_params.rb', line 43

optional :page_size, Integer

#sort_phone_number ⇒ Symbol, ...

Sort by phone number.

Returns:

• (Symbol, Telnyx::Models::PhoneNumbers::MessagingListParams::SortPhoneNumber, nil)

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

optional :sort_phone_number, enum: -> { Telnyx::PhoneNumbers::MessagingListParams::SortPhoneNumber }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/phone_numbers/messaging_list_params.rb', line 76