Class: PureCloud::UserMe

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserMe

Returns a new instance of UserMe.



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/purecloud/models/user_me.rb', line 138

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[:'chat']
    self.chat = attributes[:'chat']
  end
  
  if attributes[:'department']
    self.department = attributes[:'department']
  end
  
  if attributes[:'email']
    self.email = attributes[:'email']
  end
  
  if attributes[:'primaryContactInfo']
    if (value = attributes[:'primaryContactInfo']).is_a?(Array)
      self.primary_contact_info = value
    end
  end
  
  if attributes[:'addresses']
    if (value = attributes[:'addresses']).is_a?(Array)
      self.addresses = value
    end
  end
  
  if attributes[:'state']
    self.state = attributes[:'state']
  end
  
  if attributes[:'title']
    self.title = attributes[:'title']
  end
  
  if attributes[:'username']
    self.username = attributes[:'username']
  end
  
  if attributes[:'images']
    if (value = attributes[:'images']).is_a?(Array)
      self.images = value
    end
  end
  
  if attributes[:'version']
    self.version = attributes[:'version']
  end
  
  if attributes[:'routingStatus']
    self.routing_status = attributes[:'routingStatus']
  end
  
  if attributes[:'presence']
    self.presence = attributes[:'presence']
  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[:'station']
    self.station = attributes[:'station']
  end
  
  if attributes[:'authorization']
    self.authorization = attributes[:'authorization']
  end
  
  if attributes[:'organization']
    self.organization = attributes[:'organization']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#addresses ⇒ Object

Email addresses and phone numbers for this user



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

def addresses
  @addresses
end

#authorization ⇒ Object

Roles and permissions assigned to the user



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

def authorization
  @authorization
end

#chat ⇒ Object

Returns the value of attribute chat.



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

def chat
  @chat
end

#conversation_summary ⇒ Object

Summary of conversion statistics for conversation types.



41
42
43
 
# File 'lib/purecloud/models/user_me.rb', line 41

def conversation_summary
  @conversation_summary
end

#department ⇒ Object

Returns the value of attribute department.



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

def department
  @department
end

#email ⇒ Object

Returns the value of attribute email.



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

def email
  @email
end

#geolocation ⇒ Object

Current geolocation position



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

def geolocation
  @geolocation
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#images ⇒ Object

Returns the value of attribute images.



29
30
31
 
# File 'lib/purecloud/models/user_me.rb', line 29

def images
  @images
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#organization ⇒ Object

Details about the organization the user is a member of



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

def organization
  @organization
end

#out_of_office ⇒ Object

Determine if out of office is enabled



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

def out_of_office
  @out_of_office
end

#presence ⇒ Object

Active presence



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

def presence
  @presence
end

#primary_contact_info ⇒ Object

Auto populated from addresses.



17
18
19
 
# File 'lib/purecloud/models/user_me.rb', line 17

def primary_contact_info
  @primary_contact_info
end

#routing_status ⇒ Object

ACD routing status



35
36
37
 
# File 'lib/purecloud/models/user_me.rb', line 35

def routing_status
  @routing_status
end

#self_uri ⇒ Object

The URI for this object



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

def self_uri
  @self_uri
end

#state ⇒ Object

The current state for this user.



23
24
25
 
# File 'lib/purecloud/models/user_me.rb', line 23

def state
  @state
end

#station ⇒ Object

Effective, default, and last station information



50
51
52
 
# File 'lib/purecloud/models/user_me.rb', line 50

def station
  @station
end

#title ⇒ Object

Returns the value of attribute title.



25
26
27
 
# File 'lib/purecloud/models/user_me.rb', line 25

def title
  @title
end

#username ⇒ Object

Returns the value of attribute username.



27
28
29
 
# File 'lib/purecloud/models/user_me.rb', line 27

def username
  @username
end

#version ⇒ Object

Required when updating. Version must be the current version. Only the system can assign version.



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



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

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',
    
    :'images' => :'images',
    
    :'version' => :'version',
    
    :'routing_status' => :'routingStatus',
    
    :'presence' => :'presence',
    
    :'conversation_summary' => :'conversationSummary',
    
    :'out_of_office' => :'outOfOffice',
    
    :'geolocation' => :'geolocation',
    
    :'station' => :'station',
    
    :'authorization' => :'authorization',
    
    :'organization' => :'organization',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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',
    :'images' => :'Array<UserImage>',
    :'version' => :'String',
    :'routing_status' => :'RoutingStatus',
    :'presence' => :'UserPresence',
    :'conversation_summary' => :'UserConversationSummary',
    :'out_of_office' => :'OutOfOffice',
    :'geolocation' => :'Geolocation',
    :'station' => :'UserStations',
    :'authorization' => :'UserAuthorization',
    :'organization' => :'Organization',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



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

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 &&
      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 &&
      organization == o.organization &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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

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



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/purecloud/models/user_me.rb', line 360

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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/purecloud/models/user_me.rb', line 284

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


274
275
276
 
# File 'lib/purecloud/models/user_me.rb', line 274

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



279
280
281
 
# File 'lib/purecloud/models/user_me.rb', line 279

def hash
  [id, name, chat, department, email, primary_contact_info, addresses, state, title, username, images, version, routing_status, presence, conversation_summary, out_of_office, geolocation, station, authorization, organization, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



343
344
345
 
# File 'lib/purecloud/models/user_me.rb', line 343

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



348
349
350
351
352
353
354
355
356
 
# File 'lib/purecloud/models/user_me.rb', line 348

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 



338
339
340
 
# File 'lib/purecloud/models/user_me.rb', line 338

def to_s
  to_hash.to_s
end