Class: Sentdm::Models::ContactListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/sentdm/models/contact_list_params.rb

Overview

See Also:

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

Parameters:

  • page (Integer) —

    Page number (1-indexed)

  • page_size (Integer)
  • 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

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



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

Instance Attribute Details

#channel ⇒ String?

Optional channel filter (sms, whatsapp)

Returns:

  • (String, nil) 


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

optional :channel, String, nil?: true

#page ⇒ Integer

Page number (1-indexed)

Returns:

  • (Integer) 


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

required :page, Integer

#page_size ⇒ Integer

Returns:

  • (Integer) 


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

required :page_size, Integer

#phone ⇒ String?

Optional phone number filter (alternative to list view)

Returns:

  • (String, nil) 


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

optional :phone, String, nil?: true

#search ⇒ String?

Optional search term for filtering contacts

Returns:

  • (String, nil) 


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

optional :search, String, nil?: true