Class: PureCloud::UserRoutingSkill

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

Overview

Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserRoutingSkill

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

  
end

Instance Attribute Details

#id ⇒ Object

The globally unique identifier for the object.



23
24
25
 
# File 'lib/purecloudclient_v2a/models/user_routing_skill.rb', line 23

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



25
26
27
 
# File 'lib/purecloudclient_v2a/models/user_routing_skill.rb', line 25

def name
  @name
end

#proficiency ⇒ Object

Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular skill. It is used when a queue is set to "Best available skills" mode to allow acd interactions to target agents with higher proficiency ratings.



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

def proficiency
  @proficiency
end

#self_uri ⇒ Object

The URI for this object



37
38
39
 
# File 'lib/purecloudclient_v2a/models/user_routing_skill.rb', line 37

def self_uri
  @self_uri
end

#skill_uri ⇒ Object

URI to the organization skill used by this user skill.



34
35
36
 
# File 'lib/purecloudclient_v2a/models/user_routing_skill.rb', line 34

def skill_uri
  @skill_uri
end

#state ⇒ Object

Activate or deactivate this routing skill.



31
32
33
 
# File 'lib/purecloudclient_v2a/models/user_routing_skill.rb', line 31

def state
  @state
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/purecloudclient_v2a/models/user_routing_skill.rb', line 40

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'proficiency' => :'proficiency',
    
    :'state' => :'state',
    
    :'skill_uri' => :'skillUri',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/purecloudclient_v2a/models/user_routing_skill.rb', line 59

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'proficiency' => :'Float',
    
    :'state' => :'String',
    
    :'skill_uri' => :'String',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



228
229
230
231
232
233
234
235
236
237
 
# File 'lib/purecloudclient_v2a/models/user_routing_skill.rb', line 228

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      proficiency == o.proficiency &&
      state == o.state &&
      skill_uri == o.skill_uri &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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

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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/purecloudclient_v2a/models/user_routing_skill.rb', line 331

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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/purecloudclient_v2a/models/user_routing_skill.rb', line 252

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


241
242
243
 
# File 'lib/purecloudclient_v2a/models/user_routing_skill.rb', line 241

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



247
248
249
 
# File 'lib/purecloudclient_v2a/models/user_routing_skill.rb', line 247

def hash
  [id, name, proficiency, state, skill_uri, 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



144
145
146
147
148
149
 
# File 'lib/purecloudclient_v2a/models/user_routing_skill.rb', line 144

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



314
315
316
 
# File 'lib/purecloudclient_v2a/models/user_routing_skill.rb', line 314

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



319
320
321
322
323
324
325
326
327
 
# File 'lib/purecloudclient_v2a/models/user_routing_skill.rb', line 319

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 



309
310
311
 
# File 'lib/purecloudclient_v2a/models/user_routing_skill.rb', line 309

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



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

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