class PureCloud::WfmAgent

Workforce management agent data

Attributes

accept_direct_shift_trades[RW]

Whether the agent accepts direct shift trade requests

id[RW]

The globally unique identifier for the object.

languages[RW]

The list of languages this agent is capable of handling

metadata[RW]

Metadata for this agent

queues[RW]

List of queues to which this agent is capable of handling

schedulable[RW]

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

self_uri[RW]

The URI for this object

skills[RW]

The list of skills this agent is capable of handling

user[RW]

The user associated with this data

work_plan[RW]

The work plan associated with this agent, if applicable

work_plan_rotation[RW]

The work plan rotation associated with this agent, if applicable

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/wfm_agent.rb, line 56
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'user' => :'user',
    
    :'work_plan' => :'workPlan',
    
    :'work_plan_rotation' => :'workPlanRotation',
    
    :'accept_direct_shift_trades' => :'acceptDirectShiftTrades',
    
    :'queues' => :'queues',
    
    :'languages' => :'languages',
    
    :'skills' => :'skills',
    
    :'schedulable' => :'schedulable',
    
    :'metadata' => :'metadata',
    
    :'self_uri' => :'selfUri'
    
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

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

  
  if attributes.has_key?(:'acceptDirectShiftTrades')
    
    
    self.accept_direct_shift_trades = attributes[:'acceptDirectShiftTrades']
    
  
  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?(:'metadata')
    
    
    self.metadata = attributes[:'metadata']
    
  
  end

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/wfm_agent.rb, line 85
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'user' => :'UserReference',
    
    :'work_plan' => :'WorkPlanReference',
    
    :'work_plan_rotation' => :'WorkPlanRotationReference',
    
    :'accept_direct_shift_trades' => :'BOOLEAN',
    
    :'queues' => :'Array<QueueReference>',
    
    :'languages' => :'Array<LanguageReference>',
    
    :'skills' => :'Array<RoutingSkillReference>',
    
    :'schedulable' => :'BOOLEAN',
    
    :'metadata' => :'WfmVersionedEntityMetadata',
    
    :'self_uri' => :'String'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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 &&
      work_plan_rotation == o.work_plan_rotation &&
      accept_direct_shift_trades == o.accept_direct_shift_trades &&
      queues == o.queues &&
      languages == o.languages &&
      skills == o.skills &&
      schedulable == o.schedulable &&
      metadata == o.metadata &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# 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) click to toggle source

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

# 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) click to toggle source

build the object from hash

# 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/wfm_agent.rb, line 364
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/purecloudplatformclientv2/models/wfm_agent.rb, line 370
def hash
  [id, user, work_plan, work_plan_rotation, accept_direct_shift_trades, queues, languages, skills, schedulable, metadata, self_uri].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/purecloudplatformclientv2/models/wfm_agent.rb, line 231
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/wfm_agent.rb, line 437
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# 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() click to toggle source
# File lib/purecloudplatformclientv2/models/wfm_agent.rb, line 432
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/purecloudplatformclientv2/models/wfm_agent.rb, line 240
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end