class PureCloud::UserMe
Attributes
acd auto answer
Email
addresses and phone numbers for this user
The first 50 superiors, direct reports, and siblings of this user. Mutually exclusive with superiors and direct reports expands.
Summary of conversion statistics for conversation types.
The PureCloud
system date time.
The first 50 direct reports to this user.
The division to which this entity belongs.
The first 50 favorited users.
The field config for all entities types of user's organization
Current geolocation position
Geolocation
settings for user's organization.
The groups the user is a member of
The globally unique identifier for the object.
preferred language by the user
Routing (ACD) languages possessed by the user
The first 100 site locations for user's organization
The user placement at each site location.
Products enabled in this organization
Organization
details for this user.
Determine if out of office is enabled
Active presence
The first 100 presence definitions for user's organization.
Auto populated from addresses.
Profile skills possessed by the user
The first 50 routing skills for user's organizations
ACD routing status
The URI for this object
Routing (ACD) skills possessed by the user
The current state for this user.
Effective, default, and last station information
The first 50 superiors of this user.
The team the user is a member of
Information about the current token
Organizations having this user as a trustee
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
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/user_me.rb, line 157 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'division' => :'division', :'chat' => :'chat', :'department' => :'department', :'email' => :'email', :'primary_contact_info' => :'primaryContactInfo', :'addresses' => :'addresses', :'state' => :'state', :'title' => :'title', :'username' => :'username', :'manager' => :'manager', :'images' => :'images', :'version' => :'version', :'certifications' => :'certifications', :'biography' => :'biography', :'employer_info' => :'employerInfo', :'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', :'team' => :'team', :'skills' => :'skills', :'languages' => :'languages', :'acd_auto_answer' => :'acdAutoAnswer', :'language_preference' => :'languagePreference', :'last_token_issued' => :'lastTokenIssued', :'date' => :'date', :'geolocation_settings' => :'geolocationSettings', :'organization' => :'organization', :'presence_definitions' => :'presenceDefinitions', :'location_definitions' => :'locationDefinitions', :'org_authorization' => :'orgAuthorization', :'favorites' => :'favorites', :'superiors' => :'superiors', :'direct_reports' => :'directReports', :'adjacents' => :'adjacents', :'routing_skills' => :'routingSkills', :'field_configs' => :'fieldConfigs', :'token' => :'token', :'trustors' => :'trustors', :'org_products' => :'orgProducts', :'self_uri' => :'selfUri' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/user_me.rb, line 368 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?(:'division') self.division = attributes[:'division'] end if attributes.has_key?(:'chat') self.chat = attributes[:'chat'] end if attributes.has_key?(:'department') self.department = attributes[:'department'] end if attributes.has_key?(:'email') self.email = attributes[:'email'] end if attributes.has_key?(:'primaryContactInfo') if (value = attributes[:'primaryContactInfo']).is_a?(Array) self.primary_contact_info = value end end if attributes.has_key?(:'addresses') if (value = attributes[:'addresses']).is_a?(Array) self.addresses = value end end if attributes.has_key?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'title') self.title = attributes[:'title'] end if attributes.has_key?(:'username') self.username = attributes[:'username'] end if attributes.has_key?(:'manager') self.manager = attributes[:'manager'] end if attributes.has_key?(:'images') if (value = attributes[:'images']).is_a?(Array) self.images = value end end if attributes.has_key?(:'version') self.version = attributes[:'version'] end if attributes.has_key?(:'certifications') if (value = attributes[:'certifications']).is_a?(Array) self.certifications = value end end if attributes.has_key?(:'biography') self.biography = attributes[:'biography'] end if attributes.has_key?(:'employerInfo') self.employer_info = attributes[:'employerInfo'] end if attributes.has_key?(:'routingStatus') self.routing_status = attributes[:'routingStatus'] end if attributes.has_key?(:'presence') self.presence = attributes[:'presence'] end if attributes.has_key?(:'conversationSummary') self.conversation_summary = attributes[:'conversationSummary'] end if attributes.has_key?(:'outOfOffice') self.out_of_office = attributes[:'outOfOffice'] end if attributes.has_key?(:'geolocation') self.geolocation = attributes[:'geolocation'] end if attributes.has_key?(:'station') self.station = attributes[:'station'] end if attributes.has_key?(:'authorization') self.authorization = attributes[:'authorization'] end if attributes.has_key?(:'profileSkills') if (value = attributes[:'profileSkills']).is_a?(Array) self.profile_skills = value end end if attributes.has_key?(:'locations') if (value = attributes[:'locations']).is_a?(Array) self.locations = value end end if attributes.has_key?(:'groups') if (value = attributes[:'groups']).is_a?(Array) self.groups = value end end if attributes.has_key?(:'team') self.team = attributes[:'team'] end if attributes.has_key?(:'skills') if (value = attributes[:'skills']).is_a?(Array) self.skills = value end end if attributes.has_key?(:'languages') if (value = attributes[:'languages']).is_a?(Array) self.languages = value end end if attributes.has_key?(:'acdAutoAnswer') self.acd_auto_answer = attributes[:'acdAutoAnswer'] end if attributes.has_key?(:'languagePreference') self.language_preference = attributes[:'languagePreference'] end if attributes.has_key?(:'lastTokenIssued') self.last_token_issued = attributes[:'lastTokenIssued'] end if attributes.has_key?(:'date') self.date = attributes[:'date'] end if attributes.has_key?(:'geolocationSettings') self.geolocation_settings = attributes[:'geolocationSettings'] end if attributes.has_key?(:'organization') self.organization = attributes[:'organization'] end if attributes.has_key?(:'presenceDefinitions') if (value = attributes[:'presenceDefinitions']).is_a?(Array) self.presence_definitions = value end end if attributes.has_key?(:'locationDefinitions') if (value = attributes[:'locationDefinitions']).is_a?(Array) self.location_definitions = value end end if attributes.has_key?(:'orgAuthorization') if (value = attributes[:'orgAuthorization']).is_a?(Array) self.org_authorization = value end end if attributes.has_key?(:'favorites') if (value = attributes[:'favorites']).is_a?(Array) self.favorites = value end end if attributes.has_key?(:'superiors') if (value = attributes[:'superiors']).is_a?(Array) self.superiors = value end end if attributes.has_key?(:'directReports') if (value = attributes[:'directReports']).is_a?(Array) self.direct_reports = value end end if attributes.has_key?(:'adjacents') self.adjacents = attributes[:'adjacents'] end if attributes.has_key?(:'routingSkills') if (value = attributes[:'routingSkills']).is_a?(Array) self.routing_skills = value end end if attributes.has_key?(:'fieldConfigs') self.field_configs = attributes[:'fieldConfigs'] end if attributes.has_key?(:'token') self.token = attributes[:'token'] end if attributes.has_key?(:'trustors') if (value = attributes[:'trustors']).is_a?(Array) self.trustors = value end end if attributes.has_key?(:'orgProducts') if (value = attributes[:'orgProducts']).is_a?(Array) self.org_products = value end end if attributes.has_key?(:'selfUri') self.self_uri = attributes[:'selfUri'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/user_me.rb, line 262 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'division' => :'Division', :'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', :'certifications' => :'Array<String>', :'biography' => :'Biography', :'employer_info' => :'EmployerInfo', :'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>', :'team' => :'Team', :'skills' => :'Array<UserRoutingSkill>', :'languages' => :'Array<UserRoutingLanguage>', :'acd_auto_answer' => :'BOOLEAN', :'language_preference' => :'String', :'last_token_issued' => :'OAuthLastTokenIssued', :'date' => :'ServerDate', :'geolocation_settings' => :'GeolocationSettings', :'organization' => :'Organization', :'presence_definitions' => :'Array<OrganizationPresence>', :'location_definitions' => :'Array<LocationDefinition>', :'org_authorization' => :'Array<DomainOrganizationRole>', :'favorites' => :'Array<User>', :'superiors' => :'Array<User>', :'direct_reports' => :'Array<User>', :'adjacents' => :'Adjacents', :'routing_skills' => :'Array<RoutingSkill>', :'field_configs' => :'FieldConfigs', :'token' => :'TokenInfo', :'trustors' => :'Array<Trustor>', :'org_products' => :'Array<DomainOrganizationProduct>', :'self_uri' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/user_me.rb, line 1332 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && division == o.division && 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 && certifications == o.certifications && biography == o.biography && employer_info == o.employer_info && 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 && team == o.team && skills == o.skills && languages == o.languages && acd_auto_answer == o.acd_auto_answer && language_preference == o.language_preference && last_token_issued == o.last_token_issued && date == o.date && geolocation_settings == o.geolocation_settings && organization == o.organization && presence_definitions == o.presence_definitions && location_definitions == o.location_definitions && org_authorization == o.org_authorization && favorites == o.favorites && superiors == o.superiors && direct_reports == o.direct_reports && adjacents == o.adjacents && routing_skills == o.routing_skills && field_configs == o.field_configs && token == o.token && trustors == o.trustors && org_products == o.org_products && self_uri == o.self_uri end
# File lib/purecloudplatformclientv2/models/user_me.rb, line 1418 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
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/user_me.rb, line 1478 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 the object from hash
# File lib/purecloudplatformclientv2/models/user_me.rb, line 1399 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
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/user_me.rb, line 1388 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/user_me.rb, line 1394 def hash [id, name, division, chat, department, email, primary_contact_info, addresses, state, title, username, manager, images, version, certifications, biography, employer_info, routing_status, presence, conversation_summary, out_of_office, geolocation, station, authorization, profile_skills, locations, groups, team, skills, languages, acd_auto_answer, language_preference, last_token_issued, date, geolocation_settings, organization, presence_definitions, location_definitions, org_authorization, favorites, superiors, direct_reports, adjacents, routing_skills, field_configs, token, trustors, org_products, self_uri].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/purecloudplatformclientv2/models/user_me.rb, line 856 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned
# File lib/purecloudplatformclientv2/models/user_me.rb, line 1119 def state=(state) allowed_values = ["active", "inactive", "deleted"] if state && !allowed_values.include?(state) fail ArgumentError, "invalid value for 'state', must be one of #{allowed_values}." end @state = state end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/user_me.rb, line 1466 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
# File lib/purecloudplatformclientv2/models/user_me.rb, line 1456 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/purecloudplatformclientv2/models/user_me.rb, line 865 def valid? allowed_values = ["active", "inactive", "deleted"] if @state && !allowed_values.include?(@state) return false end if @version.nil? return false end end