class PureCloud::UpdateUser
Attributes
The value that denotes if acdAutoAnswer is set on the user
Email
address, phone number, and/or extension for this user. One entry is allowed per media type
The groups the user is a member of
The globally unique identifier for the object.
The user placement at each site location.
The address(s) used for primary contact. Updates to the corresponding address in the addresses list will be reflected here.
Profile skills possessed by the user
The URI for this object
The state of the user. This property can be used to restore a deleted user or transition between active and inactive. If specified, it is the only modifiable field.
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/update_user.rb, line 74 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'chat' => :'chat', :'department' => :'department', :'email' => :'email', :'primary_contact_info' => :'primaryContactInfo', :'addresses' => :'addresses', :'title' => :'title', :'username' => :'username', :'manager' => :'manager', :'images' => :'images', :'version' => :'version', :'profile_skills' => :'profileSkills', :'locations' => :'locations', :'groups' => :'groups', :'state' => :'state', :'acd_auto_answer' => :'acdAutoAnswer', :'certifications' => :'certifications', :'biography' => :'biography', :'employer_info' => :'employerInfo', :'self_uri' => :'selfUri' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/update_user.rb, line 173 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?(:'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?(:'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?(:'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?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'acdAutoAnswer') self.acd_auto_answer = attributes[:'acdAutoAnswer'] 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?(:'selfUri') self.self_uri = attributes[:'selfUri'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/update_user.rb, line 123 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'chat' => :'Chat', :'department' => :'String', :'email' => :'String', :'primary_contact_info' => :'Array<Contact>', :'addresses' => :'Array<Contact>', :'title' => :'String', :'username' => :'String', :'manager' => :'String', :'images' => :'Array<UserImage>', :'version' => :'Integer', :'profile_skills' => :'Array<String>', :'locations' => :'Array<Location>', :'groups' => :'Array<Group>', :'state' => :'String', :'acd_auto_answer' => :'BOOLEAN', :'certifications' => :'Array<String>', :'biography' => :'Biography', :'employer_info' => :'EmployerInfo', :'self_uri' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/update_user.rb, line 611 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 && title == o.title && username == o.username && manager == o.manager && images == o.images && version == o.version && profile_skills == o.profile_skills && locations == o.locations && groups == o.groups && state == o.state && acd_auto_answer == o.acd_auto_answer && certifications == o.certifications && biography == o.biography && employer_info == o.employer_info && self_uri == o.self_uri end
# File lib/purecloudplatformclientv2/models/update_user.rb, line 669 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/update_user.rb, line 729 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/update_user.rb, line 650 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/update_user.rb, line 639 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/update_user.rb, line 645 def hash [id, name, chat, department, email, primary_contact_info, addresses, title, username, manager, images, version, profile_skills, locations, groups, state, acd_auto_answer, certifications, biography, employer_info, 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/update_user.rb, line 387 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/update_user.rb, line 573 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/update_user.rb, line 717 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/update_user.rb, line 707 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/update_user.rb, line 396 def valid? if @version.nil? return false end allowed_values = ["active", "inactive", "deleted"] if @state && !allowed_values.include?(@state) return false end end