Class: PhoneComClient::ContactFull

Inherits:
Object
  • Object
show all
Defined in:
lib/phone_com_client/models/contact_full.rb

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ContactFull

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# 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

Instance Attribute Details

#addresses ⇒ Object

Array of Contact Address Objects. See below for details.



64
65
66
 
# File 'lib/phone_com_client/models/contact_full.rb', line 64

def addresses
  @addresses
end

#company ⇒ Object

Name of the contact’s company



40
41
42
 
# File 'lib/phone_com_client/models/contact_full.rb', line 40

def company
  @company
end

#created_at ⇒ Object

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



69
70
71
 
# File 'lib/phone_com_client/models/contact_full.rb', line 69

def created_at
  @created_at
end

#department ⇒ Object

Name of the contact’s department



52
53
54
 
# File 'lib/phone_com_client/models/contact_full.rb', line 52

def department
  @department
end

#emails ⇒ Object

Array of Contact Email Objects. See below for details.



58
59
60
 
# File 'lib/phone_com_client/models/contact_full.rb', line 58

def emails
  @emails
end

#first_name ⇒ Object

First name or given name



25
26
27
 
# File 'lib/phone_com_client/models/contact_full.rb', line 25

def first_name
  @first_name
end

#group ⇒ Object

Returns the value of attribute group.



66
67
68
 
# File 'lib/phone_com_client/models/contact_full.rb', line 66

def group
  @group
end

#id ⇒ Object

Integer ID. Read-only.



19
20
21
 
# File 'lib/phone_com_client/models/contact_full.rb', line 19

def id
  @id
end

#job_title ⇒ Object

Contact’s job title



55
56
57
 
# File 'lib/phone_com_client/models/contact_full.rb', line 55

def job_title
  @job_title
end

#last_name ⇒ Object

Last name or surname



31
32
33
 
# File 'lib/phone_com_client/models/contact_full.rb', line 31

def last_name
  @last_name
end

#middle_name ⇒ Object

Middle or second name



28
29
30
 
# File 'lib/phone_com_client/models/contact_full.rb', line 28

def middle_name
  @middle_name
end

#nickname ⇒ Object

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



37
38
39
 
# File 'lib/phone_com_client/models/contact_full.rb', line 37

def nickname
  @nickname
end

#phone_numbers ⇒ Object

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



61
62
63
 
# File 'lib/phone_com_client/models/contact_full.rb', line 61

def phone_numbers
  @phone_numbers
end

#phonetic_first_name ⇒ Object

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



43
44
45
 
# File 'lib/phone_com_client/models/contact_full.rb', line 43

def phonetic_first_name
  @phonetic_first_name
end

#phonetic_last_name ⇒ Object

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



49
50
51
 
# File 'lib/phone_com_client/models/contact_full.rb', line 49

def phonetic_last_name
  @phonetic_last_name
end

#phonetic_middle_name ⇒ Object

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



46
47
48
 
# File 'lib/phone_com_client/models/contact_full.rb', line 46

def phonetic_middle_name
  @phonetic_middle_name
end

#prefix ⇒ Object

Salutation, such as Mr, Mrs, or Dr



22
23
24
 
# File 'lib/phone_com_client/models/contact_full.rb', line 22

def prefix
  @prefix
end

#suffix ⇒ Object

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



34
35
36
 
# File 'lib/phone_com_client/models/contact_full.rb', line 34

def suffix
  @suffix
end

#updated_at ⇒ Object

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



72
73
74
 
# File 'lib/phone_com_client/models/contact_full.rb', line 72

def updated_at
  @updated_at
end

Class Method Details

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# 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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# 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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# 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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


256
257
258
 
# File 'lib/phone_com_client/models/contact_full.rb', line 256

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



262
263
264
 
# 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 ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



217
218
219
220
 
# File 'lib/phone_com_client/models/contact_full.rb', line 217

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



336
337
338
 
# File 'lib/phone_com_client/models/contact_full.rb', line 336

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



342
343
344
345
346
347
348
349
350
 
# 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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



330
331
332
 
# File 'lib/phone_com_client/models/contact_full.rb', line 330

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



224
225
226
 
# File 'lib/phone_com_client/models/contact_full.rb', line 224

def valid?
  true
end