Class: PureCloud::ExternalContact

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExternalContact

Initializes the object

Parameters:

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

    Model attributes in the form of hash



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
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
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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 209

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



50
51
52
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 50

def address
  @address
end

#cell_phone ⇒ Object

Returns the value of attribute cell_phone.



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

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



64
65
66
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 64

def create_date
  @create_date
end

#custom_fields ⇒ Object

Custom fields defined in the schema referenced by schemaId and schemaVersion.



77
78
79
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 77

def custom_fields
  @custom_fields
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.



80
81
82
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 80

def external_data_sources
  @external_data_sources
end

#external_organization ⇒ Object

Returns the value of attribute external_organization.



66
67
68
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 66

def external_organization
  @external_organization
end

#external_system_url ⇒ Object

A string that identifies an external system-of-record resource that may have more detailed information on the contact. It should be a valid URL (including the http/https protocol, port, and path [if any]). The value is automatically trimmed of any leading and trailing whitespace.



71
72
73
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 71

def external_system_url
  @external_system_url
end

#facebook_id ⇒ Object

Returns the value of attribute facebook_id.



58
59
60
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 58

def facebook_id
  @facebook_id
end

#first_name ⇒ Object

The first name of the contact.



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 25

def first_name
  @first_name
end

#home_phone ⇒ Object

Returns the value of attribute home_phone.



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

def home_phone
  @home_phone
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#last_name ⇒ Object

The last name of the contact.



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

def last_name
  @last_name
end

#line_id ⇒ Object

Returns the value of attribute line_id.



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

def line_id
  @line_id
end

#middle_name ⇒ Object

Returns the value of attribute middle_name.



27
28
29
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 27

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



61
62
63
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 61

def modify_date
  @modify_date
end

#other_email ⇒ Object

Returns the value of attribute other_email.



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

def other_email
  @other_email
end

#other_phone ⇒ Object

Returns the value of attribute other_phone.



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

def other_phone
  @other_phone
end

#personal_email ⇒ Object

Returns the value of attribute personal_email.



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

def personal_email
  @personal_email
end

#salutation ⇒ Object

Returns the value of attribute salutation.



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

def salutation
  @salutation
end

#schema ⇒ Object

The schema defining custom fields for this contact



74
75
76
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 74

def schema
  @schema
end

#self_uri ⇒ Object

The URI for this object



83
84
85
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 83

def self_uri
  @self_uri
end

#survey_opt_out ⇒ Object

Returns the value of attribute survey_opt_out.



68
69
70
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 68

def survey_opt_out
  @survey_opt_out
end

#title ⇒ Object

Returns the value of attribute title.



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

def title
  @title
end

#twitter_id ⇒ Object

Returns the value of attribute twitter_id.



52
53
54
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 52

def twitter_id
  @twitter_id
end

#whats_app_id ⇒ Object

Returns the value of attribute whats_app_id.



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

def whats_app_id
  @whats_app_id
end

#work_email ⇒ Object

Returns the value of attribute work_email.



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

def work_email
  @work_email
end

#work_phone ⇒ Object

Returns the value of attribute work_phone.



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

def work_phone
  @work_phone
end

Class Method Details

.attribute_map ⇒ Object

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
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
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 86

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',
    
    :'twitter_id' => :'twitterId',
    
    :'line_id' => :'lineId',
    
    :'whats_app_id' => :'whatsAppId',
    
    :'facebook_id' => :'facebookId',
    
    :'modify_date' => :'modifyDate',
    
    :'create_date' => :'createDate',
    
    :'external_organization' => :'externalOrganization',
    
    :'survey_opt_out' => :'surveyOptOut',
    
    :'external_system_url' => :'externalSystemUrl',
    
    :'schema' => :'schema',
    
    :'custom_fields' => :'customFields',
    
    :'external_data_sources' => :'externalDataSources',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 147

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',
    
    :'twitter_id' => :'TwitterId',
    
    :'line_id' => :'LineId',
    
    :'whats_app_id' => :'WhatsAppId',
    
    :'facebook_id' => :'FacebookId',
    
    :'modify_date' => :'DateTime',
    
    :'create_date' => :'DateTime',
    
    :'external_organization' => :'ExternalOrganization',
    
    :'survey_opt_out' => :'BOOLEAN',
    
    :'external_system_url' => :'String',
    
    :'schema' => :'DataSchema',
    
    :'custom_fields' => :'Hash<String, Object>',
    
    :'external_data_sources' => :'Array<ExternalDataSource>',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 736

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 &&
      twitter_id == o.twitter_id &&
      line_id == o.line_id &&
      whats_app_id == o.whats_app_id &&
      facebook_id == o.facebook_id &&
      modify_date == o.modify_date &&
      create_date == o.create_date &&
      external_organization == o.external_organization &&
      survey_opt_out == o.survey_opt_out &&
      external_system_url == o.external_system_url &&
      schema == o.schema &&
      custom_fields == o.custom_fields &&
      external_data_sources == o.external_data_sources &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 800

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



860
861
862
863
864
865
866
867
868
869
870
871
872
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 860

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



781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 781

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


770
771
772
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 770

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



776
777
778
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 776

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, twitter_id, line_id, whats_app_id, facebook_id, modify_date, create_date, external_organization, survey_opt_out, external_system_url, schema, custom_fields, external_data_sources, self_uri].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



467
468
469
470
471
472
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 467

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



843
844
845
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 843

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



848
849
850
851
852
853
854
855
856
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 848

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 



838
839
840
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 838

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



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/purecloudplatformclientv2/models/external_contact.rb', line 476

def valid?
  
  
  
  
  
  
  if @first_name.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  if @last_name.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end