Class: PureCloud::UserRoutingSkillPost

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/user_routing_skill_post.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 = {}) ⇒ UserRoutingSkillPost

Initializes the object

Parameters:

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

    Model attributes in the form of hash



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/purecloudplatformclientv2/models/user_routing_skill_post.rb', line 56

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?(:'proficiency')
    self.proficiency = attributes[:'proficiency']
  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 id of the existing routing skill to add to the user



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

def id
  @id
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.



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

def proficiency
  @proficiency
end

#self_uri ⇒ Object

The URI for this object



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

def self_uri
  @self_uri
end

#skill_uri ⇒ Object

URI to the organization skill used by this user skill.



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

def skill_uri
  @skill_uri
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
 
# File 'lib/purecloudplatformclientv2/models/user_routing_skill_post.rb', line 35

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

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
 
# File 'lib/purecloudplatformclientv2/models/user_routing_skill_post.rb', line 45

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



102
103
104
105
106
107
108
109
 
# File 'lib/purecloudplatformclientv2/models/user_routing_skill_post.rb', line 102

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

#_deserialize(type, value) ⇒ Object 



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

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



203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/purecloudplatformclientv2/models/user_routing_skill_post.rb', line 203

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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/purecloudplatformclientv2/models/user_routing_skill_post.rb', line 124

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


113
114
115
 
# File 'lib/purecloudplatformclientv2/models/user_routing_skill_post.rb', line 113

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



119
120
121
 
# File 'lib/purecloudplatformclientv2/models/user_routing_skill_post.rb', line 119

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



82
83
84
85
 
# File 'lib/purecloudplatformclientv2/models/user_routing_skill_post.rb', line 82

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



186
187
188
 
# File 'lib/purecloudplatformclientv2/models/user_routing_skill_post.rb', line 186

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



191
192
193
194
195
196
197
198
199
 
# File 'lib/purecloudplatformclientv2/models/user_routing_skill_post.rb', line 191

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 



181
182
183
 
# File 'lib/purecloudplatformclientv2/models/user_routing_skill_post.rb', line 181

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



89
90
91
92
93
94
95
96
97
98
 
# File 'lib/purecloudplatformclientv2/models/user_routing_skill_post.rb', line 89

def valid?
  if @id.nil?
    return false
  end

  if @proficiency.nil?
    return false
  end

end