class PureCloud::User

Attributes

addresses[RW]

Email addresses and phone numbers for this user

authorization[RW]

Roles and permissions assigned to the user

chat[RW]
conversation_summary[RW]

Summary of conversion statistics for conversation types.

department[RW]
email[RW]
geolocation[RW]

Current geolocation position

groups[RW]

The groups the user is a member of

id[RW]

The globally unique identifier for the object.

images[RW]
locations[RW]

The user placement at each site location.

manager[RW]
name[RW]
out_of_office[RW]

Determine if out of office is enabled

presence[RW]

Active presence

primary_contact_info[RW]

Auto populated from addresses.

profile_skills[RW]

Skills possessed by the user

routing_status[RW]

ACD routing status

self_uri[RW]

The URI for this object

state[RW]

The current state for this user.

station[RW]

Effective, default, and last station information

title[RW]
username[RW]
version[RW]

Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloud/models/user.rb, line 86
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',
    
    :'manager' => :'manager',
    
    :'images' => :'images',
    
    :'version' => :'version',
    
    :'routing_status' => :'routingStatus',
    
    :'presence' => :'presence',
    
    :'conversation_summary' => :'conversationSummary',
    
    :'out_of_office' => :'outOfOffice',
    
    :'geolocation' => :'geolocation',
    
    :'station' => :'station',
    
    :'authorization' => :'authorization',
    
    :'profile_skills' => :'profileSkills',
    
    :'locations' => :'locations',
    
    :'groups' => :'groups',
    
    :'self_uri' => :'selfUri'
    
  }
end
new(attributes = {}) click to toggle source
# File lib/purecloud/models/user.rb, line 171
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[:'manager']
    self.manager = attributes[:'manager']
  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[:'profileSkills']
    if (value = attributes[:'profileSkills']).is_a?(Array)
      self.profile_skills = value
    end
  end
  
  if attributes[:'locations']
    if (value = attributes[:'locations']).is_a?(Array)
      self.locations = value
    end
  end
  
  if attributes[:'groups']
    if (value = attributes[:'groups']).is_a?(Array)
      self.groups = value
    end
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloud/models/user.rb, line 141
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',
    :'manager' => :'User',
    :'images' => :'Array<UserImage>',
    :'version' => :'Integer',
    :'routing_status' => :'RoutingStatus',
    :'presence' => :'UserPresence',
    :'conversation_summary' => :'UserConversationSummary',
    :'out_of_office' => :'OutOfOffice',
    :'geolocation' => :'Geolocation',
    :'station' => :'UserStations',
    :'authorization' => :'UserAuthorization',
    :'profile_skills' => :'Array<String>',
    :'locations' => :'Array<Location>',
    :'groups' => :'Array<Group>',
    :'self_uri' => :'String'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Check equality by comparing each attribute.

# File lib/purecloud/models/user.rb, line 298
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 &&
      manager == o.manager &&
      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 &&
      profile_skills == o.profile_skills &&
      locations == o.locations &&
      groups == o.groups &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloud/models/user.rb, line 357
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/purecloud/models/user.rb, line 417
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/purecloud/models/user.rb, line 338
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

# File lib/purecloud/models/user.rb, line 328
def eql?(o)
  self == o
end
hash() click to toggle source

Calculate hash code according to all attributes.

# File lib/purecloud/models/user.rb, line 333
def hash
  [id, name, chat, department, email, primary_contact_info, addresses, state, title, username, manager, images, version, routing_status, presence, conversation_summary, out_of_office, geolocation, station, authorization, profile_skills, locations, groups, self_uri].hash
end
state=(state) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/user.rb, line 289
def state=(state)
  allowed_values = ["active", "inactive", "deleted"]
  if state && !allowed_values.include?(state)
    fail "invalid value for 'state', must be one of #{allowed_values}"
  end
  @state = state
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloud/models/user.rb, line 400
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloud/models/user.rb, line 405
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/purecloud/models/user.rb, line 395
def to_s
  to_hash.to_s
end