Class: Sentdm::Models::ContactListResponse::Data

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Sentdm::Models::ContactListResponse::Data

Defined in:

lib/sentdm/models/contact_list_response.rb

Overview

See Also:

• #data

Defined Under Namespace

Classes: Contact, Pagination

Instance Attribute Summary

• #contacts ⇒ Array<Sentdm::Models::ContactListResponse::Data::Contact>^?

  List of contacts.

• #pagination ⇒ Sentdm::Models::ContactListResponse::Data::Pagination^?

  Pagination metadata for list responses.

Instance Method Summary

• #initialize(id: nil, available_channels: nil, country_code: nil, created_at: nil, default_channel: nil, format_e164: nil, format_international: nil, format_national: nil, format_rfc: nil, is_inherited: nil, opt_out: nil, phone_number: nil, region_code: nil, updated_at: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see Contact for more details.

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(id: nil, available_channels: nil, country_code: nil, created_at: nil, default_channel: nil, format_e164: nil, format_international: nil, format_national: nil, format_rfc: nil, is_inherited: nil, opt_out: nil, phone_number: nil, region_code: nil, updated_at: nil) ⇒ Object

Some parameter documentations has been truncated, see Contact for more details.

Contact response for v3 API Uses snake_case for JSON property names

Parameters:

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

  Unique identifier for the contact

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

  Comma-separated list of available messaging channels (e.g., “sms,whatsapp”)

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

  Country calling code (e.g., 1 for US/Canada)

• created_at (Time) (defaults to: nil) —

  When the contact was created

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

  Default messaging channel to use (e.g., “sms” or “whatsapp”)

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

  Phone number in E.164 format (e.g., +1234567890)

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

  Phone number in international format (e.g., +1 234-567-890)

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

  Phone number in national format (e.g., (234) 567-890)

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

  Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)

• is_inherited (Boolean) (defaults to: nil) —

  Whether this is an inherited contact (read-only)

• opt_out (Boolean) (defaults to: nil) —

  Whether the contact has opted out of messaging. Single source of truth — opt-out

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

  Phone number in original format

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

  ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)

• updated_at (Time, nil) (defaults to: nil) —

  When the contact was last updated

# File 'lib/sentdm/models/contact_list_response.rb', line 150

Instance Attribute Details

#contacts ⇒ Array<Sentdm::Models::ContactListResponse::Data::Contact>^?

List of contacts

Returns:

• (Array<Sentdm::Models::ContactListResponse::Data::Contact>, nil)

# File 'lib/sentdm/models/contact_list_response.rb', line 48

optional :contacts,
-> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::ContactListResponse::Data::Contact] }

#pagination ⇒ Sentdm::Models::ContactListResponse::Data::Pagination^?

Pagination metadata for list responses

Returns:

• (Sentdm::Models::ContactListResponse::Data::Pagination, nil)

# File 'lib/sentdm/models/contact_list_response.rb', line 55

optional :pagination, -> { Sentdm::Models::ContactListResponse::Data::Pagination }