Class: Sentdm::Models::ContactListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Sentdm::Models::ContactListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/sentdm/models/contact_list_params.rb

Overview

See Also:

• Resources::Contacts#list

Instance Attribute Summary

• #channel ⇒ String^?

  Optional channel filter (sms, whatsapp).

• #page ⇒ Integer

  Page number (1-indexed).

• #page_size ⇒ Integer

  Number of items per page.

• #phone ⇒ String^?

  Optional phone number filter (alternative to list view).

• #search ⇒ String^?

  Optional search term for filtering contacts.

• #x_profile_id ⇒ String^?

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(page:, page_size:, channel: nil, phone: nil, search: nil, x_profile_id: 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(page:, page_size:, channel: nil, phone: nil, search: nil, x_profile_id: nil, request_options: {}) ⇒ Object

Parameters:

• page (Integer) —

  Page number (1-indexed)

• page_size (Integer) —

  Number of items per page

• channel (String, nil) (defaults to: nil) —

  Optional channel filter (sms, whatsapp)

• phone (String, nil) (defaults to: nil) —

  Optional phone number filter (alternative to list view)

• search (String, nil) (defaults to: nil) —

  Optional search term for filtering contacts

• x_profile_id (String) (defaults to: nil)
• request_options (Sentdm::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/sentdm/models/contact_list_params.rb', line 45

Instance Attribute Details

#channel ⇒ String^?

Optional channel filter (sms, whatsapp)

Returns:

• (String, nil)

# File 'lib/sentdm/models/contact_list_params.rb', line 26

optional :channel, String, nil?: true

#page ⇒ Integer

Page number (1-indexed)

Returns:

• (Integer)

# File 'lib/sentdm/models/contact_list_params.rb', line 14

required :page, Integer

#page_size ⇒ Integer

Number of items per page

Returns:

• (Integer)

# File 'lib/sentdm/models/contact_list_params.rb', line 20

required :page_size, Integer

#phone ⇒ String^?

Optional phone number filter (alternative to list view)

Returns:

• (String, nil)

# File 'lib/sentdm/models/contact_list_params.rb', line 32

optional :phone, String, nil?: true

#search ⇒ String^?

Optional search term for filtering contacts

Returns:

• (String, nil)

# File 'lib/sentdm/models/contact_list_params.rb', line 38

optional :search, String, nil?: true

#x_profile_id ⇒ String^?

Returns:

• (String, nil)

# File 'lib/sentdm/models/contact_list_params.rb', line 43

optional :x_profile_id, String