class AlfrescoAPI::Person

Attributes

aspect_names[RW]
avatar_id[RW]
company[RW]
description[RW]
email[RW]
email_notifications_enabled[RW]
enabled[RW]
first_name[RW]
google_id[RW]
id[RW]
instant_message_id[RW]
job_title[RW]
last_name[RW]
location[RW]
mobile[RW]
properties[RW]
skype_id[RW]
status_updated_at[RW]
telephone[RW]
user_status[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/alfresco_api/models/person.rb, line 60
def self.attribute_map
  {
    :'id' => :'id',
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'description' => :'description',
    :'avatar_id' => :'avatarId',
    :'email' => :'email',
    :'skype_id' => :'skypeId',
    :'google_id' => :'googleId',
    :'instant_message_id' => :'instantMessageId',
    :'job_title' => :'jobTitle',
    :'location' => :'location',
    :'company' => :'company',
    :'mobile' => :'mobile',
    :'telephone' => :'telephone',
    :'status_updated_at' => :'statusUpdatedAt',
    :'user_status' => :'userStatus',
    :'enabled' => :'enabled',
    :'email_notifications_enabled' => :'emailNotificationsEnabled',
    :'aspect_names' => :'aspectNames',
    :'properties' => :'properties'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/alfresco_api/models/person.rb, line 113
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?(:'firstName')
    self.first_name = attributes[:'firstName']
  end

  if attributes.has_key?(:'lastName')
    self.last_name = attributes[:'lastName']
  end

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

  if attributes.has_key?(:'avatarId')
    self.avatar_id = attributes[:'avatarId']
  end

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

  if attributes.has_key?(:'skypeId')
    self.skype_id = attributes[:'skypeId']
  end

  if attributes.has_key?(:'googleId')
    self.google_id = attributes[:'googleId']
  end

  if attributes.has_key?(:'instantMessageId')
    self.instant_message_id = attributes[:'instantMessageId']
  end

  if attributes.has_key?(:'jobTitle')
    self.job_title = attributes[:'jobTitle']
  end

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

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

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

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

  if attributes.has_key?(:'statusUpdatedAt')
    self.status_updated_at = attributes[:'statusUpdatedAt']
  end

  if attributes.has_key?(:'userStatus')
    self.user_status = attributes[:'userStatus']
  end

  if attributes.has_key?(:'enabled')
    self.enabled = attributes[:'enabled']
  else
    self.enabled = true
  end

  if attributes.has_key?(:'emailNotificationsEnabled')
    self.email_notifications_enabled = attributes[:'emailNotificationsEnabled']
  else
    self.email_notifications_enabled = true
  end

  if attributes.has_key?(:'aspectNames')
    if (value = attributes[:'aspectNames']).is_a?(Array)
      self.aspect_names = value
    end
  end

  if attributes.has_key?(:'properties')
    if (value = attributes[:'properties']).is_a?(Array)
      self.properties = value
    end
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/alfresco_api/models/person.rb, line 86
def self.swagger_types
  {
    :'id' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'description' => :'String',
    :'avatar_id' => :'String',
    :'email' => :'String',
    :'skype_id' => :'String',
    :'google_id' => :'String',
    :'instant_message_id' => :'String',
    :'job_title' => :'String',
    :'location' => :'String',
    :'company' => :'Company',
    :'mobile' => :'String',
    :'telephone' => :'String',
    :'status_updated_at' => :'DateTime',
    :'user_status' => :'String',
    :'enabled' => :'BOOLEAN',
    :'email_notifications_enabled' => :'BOOLEAN',
    :'aspect_names' => :'Array<String>',
    :'properties' => :'Hash<String, String>'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/alfresco_api/models/person.rb, line 244
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      description == o.description &&
      avatar_id == o.avatar_id &&
      email == o.email &&
      skype_id == o.skype_id &&
      google_id == o.google_id &&
      instant_message_id == o.instant_message_id &&
      job_title == o.job_title &&
      location == o.location &&
      company == o.company &&
      mobile == o.mobile &&
      telephone == o.telephone &&
      status_updated_at == o.status_updated_at &&
      user_status == o.user_status &&
      enabled == o.enabled &&
      email_notifications_enabled == o.email_notifications_enabled &&
      aspect_names == o.aspect_names &&
      properties == o.properties
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/alfresco_api/models/person.rb, line 305
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 =~ /\A(true|t|yes|y|1)\z/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
    temp_model = AlfrescoAPI.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/alfresco_api/models/person.rb, line 371
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

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/alfresco_api/models/person.rb, line 284
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

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

# File lib/alfresco_api/models/person.rb, line 271
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/alfresco_api/models/person.rb, line 277
def hash
  [id, first_name, last_name, description, avatar_id, email, skype_id, google_id, instant_message_id, job_title, location, company, mobile, telephone, status_updated_at, user_status, enabled, email_notifications_enabled, aspect_names, properties].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/alfresco_api/models/person.rb, line 211
def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push("invalid value for 'id', id cannot be nil.")
  end

  if @first_name.nil?
    invalid_properties.push("invalid value for 'first_name', first_name cannot be nil.")
  end

  if @email.nil?
    invalid_properties.push("invalid value for 'email', email cannot be nil.")
  end

  if @enabled.nil?
    invalid_properties.push("invalid value for 'enabled', enabled cannot be nil.")
  end

  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/alfresco_api/models/person.rb, line 351
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/alfresco_api/models/person.rb, line 357
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

Returns the string representation of the object @return [String] String presentation of the object

# File lib/alfresco_api/models/person.rb, line 345
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/alfresco_api/models/person.rb, line 234
def valid?
  return false if @id.nil?
  return false if @first_name.nil?
  return false if @email.nil?
  return false if @enabled.nil?
  return true
end