Class: PureCloud::User

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ User

Returns a new instance of User.



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

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[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'username']
    self.username = attributes[:'username']
  end
  
  if attributes[:'email']
    self.email = attributes[:'email']
  end
  
  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end
  
  if attributes[:'phoneNumber']
    self.phone_number = attributes[:'phoneNumber']
  end
  
  if attributes[:'userImages']
    if (value = attributes[:'userImages']).is_a?(Array)
      self.user_images = value
    end
  end
  
  if attributes[:'chat']
    self.chat = attributes[:'chat']
  end
  
  if attributes[:'roles']
    if (value = attributes[:'roles']).is_a?(Array)
      self.roles = value
    end
  end
  
  if attributes[:'voicemailEnabled']
    self.voicemail_enabled = attributes[:'voicemailEnabled']
  else
    self.voicemail_enabled = false
  end
  
  if attributes[:'department']
    self.department = attributes[:'department']
  end
  
  if attributes[:'title']
    self.title = attributes[:'title']
  end
  
  if attributes[:'routingStatus']
    self.routing_status = attributes[:'routingStatus']
  end
  
  if attributes[:'password']
    self.password = attributes[:'password']
  end
  
  if attributes[:'primaryPresence']
    self.primary_presence = attributes[:'primaryPresence']
  end
  
  if attributes[:'conversations']
    self.conversations = attributes[:'conversations']
  end
  
  if attributes[:'conversationSummary']
    self.conversation_summary = attributes[:'conversationSummary']
  end
  
  if attributes[:'outOfOffice']
    self.out_of_office = attributes[:'outOfOffice']
  end
  
  if attributes[:'geolocation']
    self.geolocation = attributes[:'geolocation']
  end
  
  if attributes[:'permissions']
    if (value = attributes[:'permissions']).is_a?(Array)
      self.permissions = value
    end
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
  if attributes[:'requestedStatus']
    self.requested_status = attributes[:'requestedStatus']
  end
  
  if attributes[:'defaultStationUri']
    self.default_station_uri = attributes[:'defaultStationUri']
  end
  
  if attributes[:'stationUri']
    self.station_uri = attributes[:'stationUri']
  end
  
  if attributes[:'lastStationUri']
    self.last_station_uri = attributes[:'lastStationUri']
  end
  
end

Instance Attribute Details

#chat ⇒ Object

Returns the value of attribute chat.



20
21
22
 
# File 'lib/purecloud/models/user.rb', line 20

def chat
  @chat
end

#conversation_summary ⇒ Object

Returns the value of attribute conversation_summary.



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

def conversation_summary
  @conversation_summary
end

#conversations ⇒ Object

Returns the value of attribute conversations.



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

def conversations
  @conversations
end

#default_station_uri ⇒ Object

Returns the value of attribute default_station_uri.



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

def default_station_uri
  @default_station_uri
end

#department ⇒ Object

Returns the value of attribute department.



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

def department
  @department
end

#display_name ⇒ Object

Returns the value of attribute display_name.



14
15
16
 
# File 'lib/purecloud/models/user.rb', line 14

def display_name
  @display_name
end

#email ⇒ Object

Returns the value of attribute email.



12
13
14
 
# File 'lib/purecloud/models/user.rb', line 12

def email
  @email
end

#geolocation ⇒ Object

Returns the value of attribute geolocation.



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

def geolocation
  @geolocation
end

#id ⇒ Object

The globally unique identifier for the object.



6
7
8
 
# File 'lib/purecloud/models/user.rb', line 6

def id
  @id
end

#last_station_uri ⇒ Object

Returns the value of attribute last_station_uri.



55
56
57
 
# File 'lib/purecloud/models/user.rb', line 55

def last_station_uri
  @last_station_uri
end

#name ⇒ Object

Returns the value of attribute name.



8
9
10
 
# File 'lib/purecloud/models/user.rb', line 8

def name
  @name
end

#out_of_office ⇒ Object

Returns the value of attribute out_of_office.



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

def out_of_office
  @out_of_office
end

#password ⇒ Object

Returns the value of attribute password.



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

def password
  @password
end

#permissions ⇒ Object

Returns the value of attribute permissions.



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

def permissions
  @permissions
end

#phone_number ⇒ Object

Returns the value of attribute phone_number.



16
17
18
 
# File 'lib/purecloud/models/user.rb', line 16

def phone_number
  @phone_number
end

#primary_presence ⇒ Object

Returns the value of attribute primary_presence.



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

def primary_presence
  @primary_presence
end

#requested_status ⇒ Object

Returns the value of attribute requested_status.



49
50
51
 
# File 'lib/purecloud/models/user.rb', line 49

def requested_status
  @requested_status
end

#roles ⇒ Object

Returns the value of attribute roles.



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

def roles
  @roles
end

#routing_status ⇒ Object

Returns the value of attribute routing_status.



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

def routing_status
  @routing_status
end

#self_uri ⇒ Object

The URI for this object



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

def self_uri
  @self_uri
end

#station_uri ⇒ Object

Returns the value of attribute station_uri.



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

def station_uri
  @station_uri
end

#title ⇒ Object

Returns the value of attribute title.



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

def title
  @title
end

#user_images ⇒ Object

Returns the value of attribute user_images.



18
19
20
 
# File 'lib/purecloud/models/user.rb', line 18

def user_images
  @user_images
end

#username ⇒ Object

Returns the value of attribute username.



10
11
12
 
# File 'lib/purecloud/models/user.rb', line 10

def username
  @username
end

#voicemail_enabled ⇒ Object

Returns the value of attribute voicemail_enabled.



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

def voicemail_enabled
  @voicemail_enabled
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
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
108
109
110
111
112
 
# File 'lib/purecloud/models/user.rb', line 58

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'username' => :'username',
    
    :'email' => :'email',
    
    :'display_name' => :'displayName',
    
    :'phone_number' => :'phoneNumber',
    
    :'user_images' => :'userImages',
    
    :'chat' => :'chat',
    
    :'roles' => :'roles',
    
    :'voicemail_enabled' => :'voicemailEnabled',
    
    :'department' => :'department',
    
    :'title' => :'title',
    
    :'routing_status' => :'routingStatus',
    
    :'password' => :'password',
    
    :'primary_presence' => :'primaryPresence',
    
    :'conversations' => :'conversations',
    
    :'conversation_summary' => :'conversationSummary',
    
    :'out_of_office' => :'outOfOffice',
    
    :'geolocation' => :'geolocation',
    
    :'permissions' => :'permissions',
    
    :'self_uri' => :'selfUri',
    
    :'requested_status' => :'requestedStatus',
    
    :'default_station_uri' => :'defaultStationUri',
    
    :'station_uri' => :'stationUri',
    
    :'last_station_uri' => :'lastStationUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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/purecloud/models/user.rb', line 115

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'username' => :'String',
    :'email' => :'String',
    :'display_name' => :'String',
    :'phone_number' => :'String',
    :'user_images' => :'Array<UserImage>',
    :'chat' => :'Chat',
    :'roles' => :'Array<DomainOrganizationRole>',
    :'voicemail_enabled' => :'BOOLEAN',
    :'department' => :'String',
    :'title' => :'String',
    :'routing_status' => :'RoutingStatus',
    :'password' => :'String',
    :'primary_presence' => :'UserPresence',
    :'conversations' => :'UserConversationSummary',
    :'conversation_summary' => :'UserConversationSummary',
    :'out_of_office' => :'OutOfOffice',
    :'geolocation' => :'Geolocation',
    :'permissions' => :'Array<String>',
    :'self_uri' => :'String',
    :'requested_status' => :'UserStatus',
    :'default_station_uri' => :'String',
    :'station_uri' => :'String',
    :'last_station_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      username == o.username &&
      email == o.email &&
      display_name == o.display_name &&
      phone_number == o.phone_number &&
      user_images == o.user_images &&
      chat == o.chat &&
      roles == o.roles &&
      voicemail_enabled == o.voicemail_enabled &&
      department == o.department &&
      title == o.title &&
      routing_status == o.routing_status &&
      password == o.password &&
      primary_presence == o.primary_presence &&
      conversations == o.conversations &&
      conversation_summary == o.conversation_summary &&
      out_of_office == o.out_of_office &&
      geolocation == o.geolocation &&
      permissions == o.permissions &&
      self_uri == o.self_uri &&
      requested_status == o.requested_status &&
      default_station_uri == o.default_station_uri &&
      station_uri == o.station_uri &&
      last_station_uri == o.last_station_uri
end

#_deserialize(type, value) ⇒ Object 



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

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/purecloud/models/user.rb', line 381

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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/purecloud/models/user.rb', line 305

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


295
296
297
 
# File 'lib/purecloud/models/user.rb', line 295

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



300
301
302
 
# File 'lib/purecloud/models/user.rb', line 300

def hash
  [id, name, username, email, display_name, phone_number, user_images, chat, roles, voicemail_enabled, department, title, routing_status, password, primary_presence, conversations, conversation_summary, out_of_office, geolocation, permissions, self_uri, requested_status, default_station_uri, station_uri, last_station_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



364
365
366
 
# File 'lib/purecloud/models/user.rb', line 364

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



369
370
371
372
373
374
375
376
377
 
# File 'lib/purecloud/models/user.rb', line 369

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 



359
360
361
 
# File 'lib/purecloud/models/user.rb', line 359

def to_s
  to_hash.to_s
end