Class: PureCloud::WfmAgent

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

Overview

Workforce management agent data

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WfmAgent

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#accept_direct_shift_trades ⇒ Object

Whether the agent accepts direct shift trade requests



35
36
37
 
# File 'lib/purecloudplatformclientv2/models/wfm_agent.rb', line 35

def accept_direct_shift_trades
  @accept_direct_shift_trades
end

#id ⇒ Object

The globally unique identifier for the object.



23
24
25
 
# File 'lib/purecloudplatformclientv2/models/wfm_agent.rb', line 23

def id
  @id
end

#languages ⇒ Object

The list of languages



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

def languages
  @languages
end

#metadata ⇒ Object

Metadata for this agent



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

def metadata
  @metadata
end

#queues ⇒ Object

List of queues to which the agent belongs and which are defined in the service goal groups in this management unit



41
42
43
 
# File 'lib/purecloudplatformclientv2/models/wfm_agent.rb', line 41

def queues
  @queues
end

#schedulable ⇒ Object

Whether the agent has the permission to be included in schedule generation



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

def schedulable
  @schedulable
end

#self_uri ⇒ Object

The URI for this object



53
54
55
 
# File 'lib/purecloudplatformclientv2/models/wfm_agent.rb', line 53

def self_uri
  @self_uri
end

#skills ⇒ Object

The list of skills



47
48
49
 
# File 'lib/purecloudplatformclientv2/models/wfm_agent.rb', line 47

def skills
  @skills
end

#time_zone ⇒ Object

The time zone for this agent. Defaults to the time zone of the management unit to which the agent belongs



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

def time_zone
  @time_zone
end

#user ⇒ Object

The user associated with this data



26
27
28
 
# File 'lib/purecloudplatformclientv2/models/wfm_agent.rb', line 26

def user
  @user
end

#work_plan ⇒ Object

The work plan associated with this agent



29
30
31
 
# File 'lib/purecloudplatformclientv2/models/wfm_agent.rb', line 29

def work_plan
  @work_plan
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
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
 
# File 'lib/purecloudplatformclientv2/models/wfm_agent.rb', line 56

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'user' => :'user',
    
    :'work_plan' => :'workPlan',
    
    :'time_zone' => :'timeZone',
    
    :'accept_direct_shift_trades' => :'acceptDirectShiftTrades',
    
    :'metadata' => :'metadata',
    
    :'queues' => :'queues',
    
    :'languages' => :'languages',
    
    :'skills' => :'skills',
    
    :'schedulable' => :'schedulable',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'user' => :'UserReference',
    
    :'work_plan' => :'WorkPlanReference',
    
    :'time_zone' => :'WfmTimeZone',
    
    :'accept_direct_shift_trades' => :'BOOLEAN',
    
    :'metadata' => :'WfmVersionedEntityMetadata',
    
    :'queues' => :'Array<QueueReference>',
    
    :'languages' => :'Array<LanguageReference>',
    
    :'skills' => :'Array<RoutingSkillReference>',
    
    :'schedulable' => :'BOOLEAN',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/purecloudplatformclientv2/models/wfm_agent.rb', line 346

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      user == o.user &&
      work_plan == o.work_plan &&
      time_zone == o.time_zone &&
      accept_direct_shift_trades == o.accept_direct_shift_trades &&
      metadata == o.metadata &&
      queues == o.queues &&
      languages == o.languages &&
      skills == o.skills &&
      schedulable == o.schedulable &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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

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



454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/purecloudplatformclientv2/models/wfm_agent.rb', line 454

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



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/purecloudplatformclientv2/models/wfm_agent.rb', line 375

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


364
365
366
 
# File 'lib/purecloudplatformclientv2/models/wfm_agent.rb', line 364

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



370
371
372
 
# File 'lib/purecloudplatformclientv2/models/wfm_agent.rb', line 370

def hash
  [id, user, work_plan, time_zone, accept_direct_shift_trades, metadata, queues, languages, skills, schedulable, 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



231
232
233
234
235
236
 
# File 'lib/purecloudplatformclientv2/models/wfm_agent.rb', line 231

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



437
438
439
 
# File 'lib/purecloudplatformclientv2/models/wfm_agent.rb', line 437

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



442
443
444
445
446
447
448
449
450
 
# File 'lib/purecloudplatformclientv2/models/wfm_agent.rb', line 442

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 



432
433
434
 
# File 'lib/purecloudplatformclientv2/models/wfm_agent.rb', line 432

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



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

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end