Class: PureCloud::ExternalContact

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/external_contact.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExternalContact

Returns a new instance of ExternalContact.



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
214
215
216
217
218
219
220
 
# File 'lib/purecloud/models/external_contact.rb', line 135

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

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

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'firstName']
    self.first_name = attributes[:'firstName']
  end
  
  if attributes[:'middleName']
    self.middle_name = attributes[:'middleName']
  end
  
  if attributes[:'lastName']
    self.last_name = attributes[:'lastName']
  end
  
  if attributes[:'salutation']
    self.salutation = attributes[:'salutation']
  end
  
  if attributes[:'title']
    self.title = attributes[:'title']
  end
  
  if attributes[:'workPhone']
    self.work_phone = attributes[:'workPhone']
  end
  
  if attributes[:'cellPhone']
    self.cell_phone = attributes[:'cellPhone']
  end
  
  if attributes[:'homePhone']
    self.home_phone = attributes[:'homePhone']
  end
  
  if attributes[:'otherPhone']
    self.other_phone = attributes[:'otherPhone']
  end
  
  if attributes[:'workEmail']
    self.work_email = attributes[:'workEmail']
  end
  
  if attributes[:'personalEmail']
    self.personal_email = attributes[:'personalEmail']
  end
  
  if attributes[:'otherEmail']
    self.other_email = attributes[:'otherEmail']
  end
  
  if attributes[:'address']
    self.address = attributes[:'address']
  end
  
  if attributes[:'modifyDate']
    self.modify_date = attributes[:'modifyDate']
  end
  
  if attributes[:'createDate']
    self.create_date = attributes[:'createDate']
  end
  
  if attributes[:'externalOrganization']
    self.external_organization = attributes[:'externalOrganization']
  end
  
  if attributes[:'externalDataSources']
    if (value = attributes[:'externalDataSources']).is_a?(Array)
      self.external_data_sources = value
    end
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



48
49
50
 
# File 'lib/purecloud/models/external_contact.rb', line 48

def address
  @address
end

#cell_phone ⇒ Object

Returns the value of attribute cell_phone.



36
37
38
 
# File 'lib/purecloud/models/external_contact.rb', line 36

def cell_phone
  @cell_phone
end

#create_date ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



54
55
56
 
# File 'lib/purecloud/models/external_contact.rb', line 54

def create_date
  @create_date
end

#external_data_sources ⇒ Object

Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.



59
60
61
 
# File 'lib/purecloud/models/external_contact.rb', line 59

def external_data_sources
  @external_data_sources
end

#external_organization ⇒ Object

Returns the value of attribute external_organization.



56
57
58
 
# File 'lib/purecloud/models/external_contact.rb', line 56

def external_organization
  @external_organization
end

#first_name ⇒ Object

Returns the value of attribute first_name.



24
25
26
 
# File 'lib/purecloud/models/external_contact.rb', line 24

def first_name
  @first_name
end

#home_phone ⇒ Object

Returns the value of attribute home_phone.



38
39
40
 
# File 'lib/purecloud/models/external_contact.rb', line 38

def home_phone
  @home_phone
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloud/models/external_contact.rb', line 22

def id
  @id
end

#last_name ⇒ Object

Returns the value of attribute last_name.



28
29
30
 
# File 'lib/purecloud/models/external_contact.rb', line 28

def last_name
  @last_name
end

#middle_name ⇒ Object

Returns the value of attribute middle_name.



26
27
28
 
# File 'lib/purecloud/models/external_contact.rb', line 26

def middle_name
  @middle_name
end

#modify_date ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



51
52
53
 
# File 'lib/purecloud/models/external_contact.rb', line 51

def modify_date
  @modify_date
end

#other_email ⇒ Object

Returns the value of attribute other_email.



46
47
48
 
# File 'lib/purecloud/models/external_contact.rb', line 46

def other_email
  @other_email
end

#other_phone ⇒ Object

Returns the value of attribute other_phone.



40
41
42
 
# File 'lib/purecloud/models/external_contact.rb', line 40

def other_phone
  @other_phone
end

#personal_email ⇒ Object

Returns the value of attribute personal_email.



44
45
46
 
# File 'lib/purecloud/models/external_contact.rb', line 44

def personal_email
  @personal_email
end

#salutation ⇒ Object

Returns the value of attribute salutation.



30
31
32
 
# File 'lib/purecloud/models/external_contact.rb', line 30

def salutation
  @salutation
end

#self_uri ⇒ Object

The URI for this object



62
63
64
 
# File 'lib/purecloud/models/external_contact.rb', line 62

def self_uri
  @self_uri
end

#title ⇒ Object

Returns the value of attribute title.



32
33
34
 
# File 'lib/purecloud/models/external_contact.rb', line 32

def title
  @title
end

#work_email ⇒ Object

Returns the value of attribute work_email.



42
43
44
 
# File 'lib/purecloud/models/external_contact.rb', line 42

def work_email
  @work_email
end

#work_phone ⇒ Object

Returns the value of attribute work_phone.



34
35
36
 
# File 'lib/purecloud/models/external_contact.rb', line 34

def work_phone
  @work_phone
end

Class Method Details

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/purecloud/models/external_contact.rb', line 65

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'first_name' => :'firstName',
    
    :'middle_name' => :'middleName',
    
    :'last_name' => :'lastName',
    
    :'salutation' => :'salutation',
    
    :'title' => :'title',
    
    :'work_phone' => :'workPhone',
    
    :'cell_phone' => :'cellPhone',
    
    :'home_phone' => :'homePhone',
    
    :'other_phone' => :'otherPhone',
    
    :'work_email' => :'workEmail',
    
    :'personal_email' => :'personalEmail',
    
    :'other_email' => :'otherEmail',
    
    :'address' => :'address',
    
    :'modify_date' => :'modifyDate',
    
    :'create_date' => :'createDate',
    
    :'external_organization' => :'externalOrganization',
    
    :'external_data_sources' => :'externalDataSources',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/purecloud/models/external_contact.rb', line 110

def self.swagger_types
  {
    :'id' => :'String',
    :'first_name' => :'String',
    :'middle_name' => :'String',
    :'last_name' => :'String',
    :'salutation' => :'String',
    :'title' => :'String',
    :'work_phone' => :'PhoneNumber',
    :'cell_phone' => :'PhoneNumber',
    :'home_phone' => :'PhoneNumber',
    :'other_phone' => :'PhoneNumber',
    :'work_email' => :'String',
    :'personal_email' => :'String',
    :'other_email' => :'String',
    :'address' => :'ContactAddress',
    :'modify_date' => :'DateTime',
    :'create_date' => :'DateTime',
    :'external_organization' => :'ExternalOrganization',
    :'external_data_sources' => :'Array<ExternalDataSource>',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/purecloud/models/external_contact.rb', line 223

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      first_name == o.first_name &&
      middle_name == o.middle_name &&
      last_name == o.last_name &&
      salutation == o.salutation &&
      title == o.title &&
      work_phone == o.work_phone &&
      cell_phone == o.cell_phone &&
      home_phone == o.home_phone &&
      other_phone == o.other_phone &&
      work_email == o.work_email &&
      personal_email == o.personal_email &&
      other_email == o.other_email &&
      address == o.address &&
      modify_date == o.modify_date &&
      create_date == o.create_date &&
      external_organization == o.external_organization &&
      external_data_sources == o.external_data_sources &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/purecloud/models/external_contact.rb', line 277

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 =~ /^(true|t|yes|y|1)$/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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

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



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/purecloud/models/external_contact.rb', line 337

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

build the object from hash



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/purecloud/models/external_contact.rb', line 258

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


248
249
250
 
# File 'lib/purecloud/models/external_contact.rb', line 248

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



253
254
255
 
# File 'lib/purecloud/models/external_contact.rb', line 253

def hash
  [id, first_name, middle_name, last_name, salutation, title, work_phone, cell_phone, home_phone, other_phone, work_email, personal_email, other_email, address, modify_date, create_date, external_organization, external_data_sources, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



320
321
322
 
# File 'lib/purecloud/models/external_contact.rb', line 320

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



325
326
327
328
329
330
331
332
333
 
# File 'lib/purecloud/models/external_contact.rb', line 325

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 ⇒ Object 



315
316
317
 
# File 'lib/purecloud/models/external_contact.rb', line 315

def to_s
  to_hash.to_s
end