class PhoneComClient::ContactFull

The Full Contact Object includes all of the properties in the Contact Summary Object, along with several more:

Attributes

addresses[RW]

Array of Contact Address Objects. See below for details.

company[RW]

Name of the contact's company

created_at[RW]

Integer UNIX timestamp when the contact was created. Read-only.

department[RW]

Name of the contact's department

emails[RW]

Array of Contact Email Objects. See below for details.

first_name[RW]

First name or given name

group[RW]
id[RW]

Integer ID. Read-only.

job_title[RW]

Contact's job title

last_name[RW]

Last name or surname

middle_name[RW]

Middle or second name

nickname[RW]

Nickname, or a shortened informal version of the contact's name

phone_numbers[RW]

Array of Contact Phone Number Objects. See below for details.

phonetic_first_name[RW]

Phonetic first name. Useful for remembering how to pronounce the contact's name.

phonetic_last_name[RW]

Phonetic last name. Useful for remembering how to pronounce the contact's name.

phonetic_middle_name[RW]

Phonetic middle name. Useful for remembering how to pronounce the contact's name.

prefix[RW]

Salutation, such as Mr, Mrs, or Dr

suffix[RW]

Suffix, such as "Jr.", "Sr.", "II", or "III"

updated_at[RW]

Integer UNIX timestamp when the contact was created. Read-only.

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/phone_com_client/models/contact_full.rb, line 75
def self.attribute_map
  {
    :'id' => :'id',
    :'prefix' => :'prefix',
    :'first_name' => :'first_name',
    :'middle_name' => :'middle_name',
    :'last_name' => :'last_name',
    :'suffix' => :'suffix',
    :'nickname' => :'nickname',
    :'company' => :'company',
    :'phonetic_first_name' => :'phonetic_first_name',
    :'phonetic_middle_name' => :'phonetic_middle_name',
    :'phonetic_last_name' => :'phonetic_last_name',
    :'department' => :'department',
    :'job_title' => :'job_title',
    :'emails' => :'emails',
    :'phone_numbers' => :'phone_numbers',
    :'addresses' => :'addresses',
    :'group' => :'group',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/phone_com_client/models/contact_full.rb, line 126
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'prefix')
    self.prefix = attributes[:'prefix']
  end

  if attributes.has_key?(:'first_name')
    self.first_name = attributes[:'first_name']
  end

  if attributes.has_key?(:'middle_name')
    self.middle_name = attributes[:'middle_name']
  end

  if attributes.has_key?(:'last_name')
    self.last_name = attributes[:'last_name']
  end

  if attributes.has_key?(:'suffix')
    self.suffix = attributes[:'suffix']
  end

  if attributes.has_key?(:'nickname')
    self.nickname = attributes[:'nickname']
  end

  if attributes.has_key?(:'company')
    self.company = attributes[:'company']
  end

  if attributes.has_key?(:'phonetic_first_name')
    self.phonetic_first_name = attributes[:'phonetic_first_name']
  end

  if attributes.has_key?(:'phonetic_middle_name')
    self.phonetic_middle_name = attributes[:'phonetic_middle_name']
  end

  if attributes.has_key?(:'phonetic_last_name')
    self.phonetic_last_name = attributes[:'phonetic_last_name']
  end

  if attributes.has_key?(:'department')
    self.department = attributes[:'department']
  end

  if attributes.has_key?(:'job_title')
    self.job_title = attributes[:'job_title']
  end

  if attributes.has_key?(:'emails')
    if (value = attributes[:'emails']).is_a?(Array)
      self.emails = value
    end
  end

  if attributes.has_key?(:'phone_numbers')
    if (value = attributes[:'phone_numbers']).is_a?(Array)
      self.phone_numbers = value
    end
  end

  if attributes.has_key?(:'addresses')
    if (value = attributes[:'addresses']).is_a?(Array)
      self.addresses = value
    end
  end

  if attributes.has_key?(:'group')
    self.group = attributes[:'group']
  end

  if attributes.has_key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.has_key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/phone_com_client/models/contact_full.rb, line 100
def self.swagger_types
  {
    :'id' => :'Integer',
    :'prefix' => :'String',
    :'first_name' => :'String',
    :'middle_name' => :'String',
    :'last_name' => :'String',
    :'suffix' => :'String',
    :'nickname' => :'String',
    :'company' => :'String',
    :'phonetic_first_name' => :'String',
    :'phonetic_middle_name' => :'String',
    :'phonetic_last_name' => :'String',
    :'department' => :'String',
    :'job_title' => :'String',
    :'emails' => :'Array<Email>',
    :'phone_numbers' => :'Array<PhoneNumberContact>',
    :'addresses' => :'Array<AddressListContacts>',
    :'group' => :'GroupListContacts',
    :'created_at' => :'Integer',
    :'updated_at' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/phone_com_client/models/contact_full.rb, line 230
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      prefix == o.prefix &&
      first_name == o.first_name &&
      middle_name == o.middle_name &&
      last_name == o.last_name &&
      suffix == o.suffix &&
      nickname == o.nickname &&
      company == o.company &&
      phonetic_first_name == o.phonetic_first_name &&
      phonetic_middle_name == o.phonetic_middle_name &&
      phonetic_last_name == o.phonetic_last_name &&
      department == o.department &&
      job_title == o.job_title &&
      emails == o.emails &&
      phone_numbers == o.phone_numbers &&
      addresses == o.addresses &&
      group == o.group &&
      created_at == o.created_at &&
      updated_at == o.updated_at
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/phone_com_client/models/contact_full.rb, line 290
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = PhoneComClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/phone_com_client/models/contact_full.rb, line 356
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/phone_com_client/models/contact_full.rb, line 269
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/phone_com_client/models/contact_full.rb, line 256
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/phone_com_client/models/contact_full.rb, line 262
def hash
  [id, prefix, first_name, middle_name, last_name, suffix, nickname, company, phonetic_first_name, phonetic_middle_name, phonetic_last_name, department, job_title, emails, phone_numbers, addresses, group, created_at, updated_at].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/phone_com_client/models/contact_full.rb, line 217
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/phone_com_client/models/contact_full.rb, line 336
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/phone_com_client/models/contact_full.rb, line 342
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/phone_com_client/models/contact_full.rb, line 330
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/phone_com_client/models/contact_full.rb, line 224
def valid?
  true
end