Class: PureCloud::User

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/models/user.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ User

Initializes the object

Parameters:

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

    Model attributes in the form of hash



197
198
199
200
201
202
203
204
205
206
207
208
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
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 197

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#addresses ⇒ Object

Email addresses and phone numbers for this user



36
37
38
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 36

def addresses
  @addresses
end

#authorization ⇒ Object

Roles and permissions assigned to the user



71
72
73
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 71

def authorization
  @authorization
end

#chat ⇒ Object

Returns the value of attribute chat.



26
27
28
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 26

def chat
  @chat
end

#conversation_summary ⇒ Object

Summary of conversion statistics for conversation types.



59
60
61
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 59

def conversation_summary
  @conversation_summary
end

#department ⇒ Object

Returns the value of attribute department.



28
29
30
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 28

def department
  @department
end

#email ⇒ Object

Returns the value of attribute email.



30
31
32
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 30

def email
  @email
end

#geolocation ⇒ Object

Current geolocation position



65
66
67
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 65

def geolocation
  @geolocation
end

#groups ⇒ Object

The groups the user is a member of



80
81
82
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 80

def groups
  @groups
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 22

def id
  @id
end

#images ⇒ Object

Returns the value of attribute images.



47
48
49
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 47

def images
  @images
end

#locations ⇒ Object

The user placement at each site location.



77
78
79
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 77

def locations
  @locations
end

#manager ⇒ Object

Returns the value of attribute manager.



45
46
47
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 45

def manager
  @manager
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 24

def name
  @name
end

#out_of_office ⇒ Object

Determine if out of office is enabled



62
63
64
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 62

def out_of_office
  @out_of_office
end

#presence ⇒ Object

Active presence



56
57
58
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 56

def presence
  @presence
end

#primary_contact_info ⇒ Object

Auto populated from addresses.



33
34
35
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 33

def primary_contact_info
  @primary_contact_info
end

#profile_skills ⇒ Object

Skills possessed by the user



74
75
76
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 74

def profile_skills
  @profile_skills
end

#routing_status ⇒ Object

ACD routing status



53
54
55
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 53

def routing_status
  @routing_status
end

#self_uri ⇒ Object

The URI for this object



83
84
85
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 83

def self_uri
  @self_uri
end

#state ⇒ Object

The current state for this user.



39
40
41
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 39

def state
  @state
end

#station ⇒ Object

Effective, default, and last station information



68
69
70
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 68

def station
  @station
end

#title ⇒ Object

Returns the value of attribute title.



41
42
43
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 41

def title
  @title
end

#username ⇒ Object

Returns the value of attribute username.



43
44
45
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 43

def username
  @username
end

#version ⇒ Object

Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH.



50
51
52
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 50

def version
  @version
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
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 86

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'chat' => :'chat',
    
    :'department' => :'department',
    
    :'email' => :'email',
    
    :'primary_contact_info' => :'primaryContactInfo',
    
    :'addresses' => :'addresses',
    
    :'state' => :'state',
    
    :'title' => :'title',
    
    :'username' => :'username',
    
    :'manager' => :'manager',
    
    :'images' => :'images',
    
    :'version' => :'version',
    
    :'routing_status' => :'routingStatus',
    
    :'presence' => :'presence',
    
    :'conversation_summary' => :'conversationSummary',
    
    :'out_of_office' => :'outOfOffice',
    
    :'geolocation' => :'geolocation',
    
    :'station' => :'station',
    
    :'authorization' => :'authorization',
    
    :'profile_skills' => :'profileSkills',
    
    :'locations' => :'locations',
    
    :'groups' => :'groups',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 141

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'chat' => :'Chat',
    
    :'department' => :'String',
    
    :'email' => :'String',
    
    :'primary_contact_info' => :'Array<Contact>',
    
    :'addresses' => :'Array<Contact>',
    
    :'state' => :'String',
    
    :'title' => :'String',
    
    :'username' => :'String',
    
    :'manager' => :'User',
    
    :'images' => :'Array<UserImage>',
    
    :'version' => :'Integer',
    
    :'routing_status' => :'RoutingStatus',
    
    :'presence' => :'UserPresence',
    
    :'conversation_summary' => :'UserConversationSummary',
    
    :'out_of_office' => :'OutOfOffice',
    
    :'geolocation' => :'Geolocation',
    
    :'station' => :'UserStations',
    
    :'authorization' => :'UserAuthorization',
    
    :'profile_skills' => :'Array<String>',
    
    :'locations' => :'Array<Location>',
    
    :'groups' => :'Array<Group>',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 687

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      chat == o.chat &&
      department == o.department &&
      email == o.email &&
      primary_contact_info == o.primary_contact_info &&
      addresses == o.addresses &&
      state == o.state &&
      title == o.title &&
      username == o.username &&
      manager == o.manager &&
      images == o.images &&
      version == o.version &&
      routing_status == o.routing_status &&
      presence == o.presence &&
      conversation_summary == o.conversation_summary &&
      out_of_office == o.out_of_office &&
      geolocation == o.geolocation &&
      station == o.station &&
      authorization == o.authorization &&
      profile_skills == o.profile_skills &&
      locations == o.locations &&
      groups == o.groups &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 748

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



808
809
810
811
812
813
814
815
816
817
818
819
820
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 808

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



729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 729

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


718
719
720
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 718

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



724
725
726
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 724

def hash
  [id, name, chat, department, email, primary_contact_info, addresses, state, title, username, manager, images, version, routing_status, presence, conversation_summary, out_of_office, geolocation, station, authorization, profile_skills, locations, groups, 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



436
437
438
439
440
441
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 436

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))



791
792
793
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 791

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



796
797
798
799
800
801
802
803
804
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 796

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 



786
787
788
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 786

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



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
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
 
# File 'lib/purecloudclient_v2a/models/user.rb', line 445

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["active", "inactive", "deleted"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if @version.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end