Class: PhoneComClient::CreateContactParams

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateContactParams

Initializes the object

Parameters:

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

    Model attributes in the form of hash



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
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
# File 'lib/phone_com_client/models/create_contact_params.rb', line 111

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?(:'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?(:'prefix')
    self.prefix = attributes[:'prefix']
  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?(:'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?(:'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
end

Instance Attribute Details

#addressesObject

Addresses



60
61
62
# File 'lib/phone_com_client/models/create_contact_params.rb', line 60

def addresses
  @addresses
end

#companyObject

Company Name



45
46
47
# File 'lib/phone_com_client/models/create_contact_params.rb', line 45

def company
  @company
end

#departmentObject

Department Name



48
49
50
# File 'lib/phone_com_client/models/create_contact_params.rb', line 48

def department
  @department
end

#emailsObject

Email Addresses



54
55
56
# File 'lib/phone_com_client/models/create_contact_params.rb', line 54

def emails
  @emails
end

#first_nameObject

First Name



18
19
20
# File 'lib/phone_com_client/models/create_contact_params.rb', line 18

def first_name
  @first_name
end

#groupObject

Contact Group



63
64
65
# File 'lib/phone_com_client/models/create_contact_params.rb', line 63

def group
  @group
end

#job_titleObject

Job Title



51
52
53
# File 'lib/phone_com_client/models/create_contact_params.rb', line 51

def job_title
  @job_title
end

#last_nameObject

Last Name



24
25
26
# File 'lib/phone_com_client/models/create_contact_params.rb', line 24

def last_name
  @last_name
end

#middle_nameObject

Middle Name



21
22
23
# File 'lib/phone_com_client/models/create_contact_params.rb', line 21

def middle_name
  @middle_name
end

#nicknameObject

Nickname



42
43
44
# File 'lib/phone_com_client/models/create_contact_params.rb', line 42

def nickname
  @nickname
end

#phone_numbersObject

Phone Numbers



57
58
59
# File 'lib/phone_com_client/models/create_contact_params.rb', line 57

def phone_numbers
  @phone_numbers
end

#phonetic_first_nameObject

Phonetic First Name



30
31
32
# File 'lib/phone_com_client/models/create_contact_params.rb', line 30

def phonetic_first_name
  @phonetic_first_name
end

#phonetic_last_nameObject

Phonetic Last Name



36
37
38
# File 'lib/phone_com_client/models/create_contact_params.rb', line 36

def phonetic_last_name
  @phonetic_last_name
end

#phonetic_middle_nameObject

Phonetic Middle Name



33
34
35
# File 'lib/phone_com_client/models/create_contact_params.rb', line 33

def phonetic_middle_name
  @phonetic_middle_name
end

#prefixObject

Prefix



27
28
29
# File 'lib/phone_com_client/models/create_contact_params.rb', line 27

def prefix
  @prefix
end

#suffixObject

Suffix



39
40
41
# File 'lib/phone_com_client/models/create_contact_params.rb', line 39

def suffix
  @suffix
end

Class Method Details

.attribute_mapObject

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'lib/phone_com_client/models/create_contact_params.rb', line 66

def self.attribute_map
  {
    :'first_name' => :'first_name',
    :'middle_name' => :'middle_name',
    :'last_name' => :'last_name',
    :'prefix' => :'prefix',
    :'phonetic_first_name' => :'phonetic_first_name',
    :'phonetic_middle_name' => :'phonetic_middle_name',
    :'phonetic_last_name' => :'phonetic_last_name',
    :'suffix' => :'suffix',
    :'nickname' => :'nickname',
    :'company' => :'company',
    :'department' => :'department',
    :'job_title' => :'job_title',
    :'emails' => :'emails',
    :'phone_numbers' => :'phone_numbers',
    :'addresses' => :'addresses',
    :'group' => :'group'
  }
end

.swagger_typesObject

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# File 'lib/phone_com_client/models/create_contact_params.rb', line 88

def self.swagger_types
  {
    :'first_name' => :'String',
    :'middle_name' => :'String',
    :'last_name' => :'String',
    :'prefix' => :'String',
    :'phonetic_first_name' => :'String',
    :'phonetic_middle_name' => :'String',
    :'phonetic_last_name' => :'String',
    :'suffix' => :'String',
    :'nickname' => :'String',
    :'company' => :'String',
    :'department' => :'String',
    :'job_title' => :'String',
    :'emails' => :'Array<Email>',
    :'phone_numbers' => :'Array<PhoneNumberContact>',
    :'addresses' => :'Array<AddressListContacts>',
    :'group' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
# File 'lib/phone_com_client/models/create_contact_params.rb', line 203

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      first_name == o.first_name &&
      middle_name == o.middle_name &&
      last_name == o.last_name &&
      prefix == o.prefix &&
      phonetic_first_name == o.phonetic_first_name &&
      phonetic_middle_name == o.phonetic_middle_name &&
      phonetic_last_name == o.phonetic_last_name &&
      suffix == o.suffix &&
      nickname == o.nickname &&
      company == o.company &&
      department == o.department &&
      job_title == o.job_title &&
      emails == o.emails &&
      phone_numbers == o.phone_numbers &&
      addresses == o.addresses &&
      group == o.group
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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
# File 'lib/phone_com_client/models/create_contact_params.rb', line 260

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



326
327
328
329
330
331
332
333
334
335
336
337
338
# File 'lib/phone_com_client/models/create_contact_params.rb', line 326

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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
# File 'lib/phone_com_client/models/create_contact_params.rb', line 239

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


226
227
228
# File 'lib/phone_com_client/models/create_contact_params.rb', line 226

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



232
233
234
# File 'lib/phone_com_client/models/create_contact_params.rb', line 232

def hash
  [first_name, middle_name, last_name, prefix, phonetic_first_name, phonetic_middle_name, phonetic_last_name, suffix, nickname, company, department, job_title, emails, phone_numbers, addresses, group].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



190
191
192
193
# File 'lib/phone_com_client/models/create_contact_params.rb', line 190

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



306
307
308
# File 'lib/phone_com_client/models/create_contact_params.rb', line 306

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



312
313
314
315
316
317
318
319
320
# File 'lib/phone_com_client/models/create_contact_params.rb', line 312

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



300
301
302
# File 'lib/phone_com_client/models/create_contact_params.rb', line 300

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



197
198
199
# File 'lib/phone_com_client/models/create_contact_params.rb', line 197

def valid?
  true
end