class Pipedrive::BaseUser

Attributes

activated[RW]

Boolean that indicates if the User is activated

active_flag[RW]

Boolean that indicates if the User is activated

created[RW]

The User creation date and time. Format: YYYY-MM-DD HH:MM:SS

default_currency[RW]

The User default currency

email[RW]

The User email

has_created_company[RW]

Boolean that indicates if the User has created a Company

icon_url[RW]

The User icon URL

id[RW]

The User ID

is_admin[RW]

Indication if the User is admin (1 = true, 0 = false)

is_you[RW]

Boolean that indicates if the requested User is the same which is logged in (in this case, always true)

lang[RW]

The User language ID

last_login[RW]

The User last login date and time. Format: YYYY-MM-DD HH:MM:SS

locale[RW]

The User locale

modified[RW]

The User last modification date and time. Format: YYYY-MM-DD HH:MM:SS

name[RW]

The User name

phone[RW]

The User phone

role_id[RW]

The ID of the User role

signup_flow_variation[RW]

The variation of signup flow (if exists). E.g. google

timezone_name[RW]

The User timezone name

timezone_offset[RW]

The User timezone offset

Public Class Methods

attribute_map() click to toggle source

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

# File lib/pipedrive-openapi-client/models/base_user.rb, line 78
def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'default_currency' => :'default_currency',
    :'locale' => :'locale',
    :'lang' => :'lang',
    :'email' => :'email',
    :'phone' => :'phone',
    :'activated' => :'activated',
    :'last_login' => :'last_login',
    :'created' => :'created',
    :'modified' => :'modified',
    :'signup_flow_variation' => :'signup_flow_variation',
    :'has_created_company' => :'has_created_company',
    :'is_admin' => :'is_admin',
    :'active_flag' => :'active_flag',
    :'timezone_name' => :'timezone_name',
    :'timezone_offset' => :'timezone_offset',
    :'role_id' => :'role_id',
    :'icon_url' => :'icon_url',
    :'is_you' => :'is_you'
  }
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/pipedrive-openapi-client/models/base_user.rb, line 288
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

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

# File lib/pipedrive-openapi-client/models/base_user.rb, line 139
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Pipedrive::BaseUser` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Pipedrive::BaseUser`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'default_currency')
    self.default_currency = attributes[:'default_currency']
  end

  if attributes.key?(:'locale')
    self.locale = attributes[:'locale']
  end

  if attributes.key?(:'lang')
    self.lang = attributes[:'lang']
  end

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

  if attributes.key?(:'phone')
    self.phone = attributes[:'phone']
  end

  if attributes.key?(:'activated')
    self.activated = attributes[:'activated']
  end

  if attributes.key?(:'last_login')
    self.last_login = attributes[:'last_login']
  end

  if attributes.key?(:'created')
    self.created = attributes[:'created']
  end

  if attributes.key?(:'modified')
    self.modified = attributes[:'modified']
  end

  if attributes.key?(:'signup_flow_variation')
    self.signup_flow_variation = attributes[:'signup_flow_variation']
  end

  if attributes.key?(:'has_created_company')
    self.has_created_company = attributes[:'has_created_company']
  end

  if attributes.key?(:'is_admin')
    self.is_admin = attributes[:'is_admin']
  end

  if attributes.key?(:'active_flag')
    self.active_flag = attributes[:'active_flag']
  end

  if attributes.key?(:'timezone_name')
    self.timezone_name = attributes[:'timezone_name']
  end

  if attributes.key?(:'timezone_offset')
    self.timezone_offset = attributes[:'timezone_offset']
  end

  if attributes.key?(:'role_id')
    self.role_id = attributes[:'role_id']
  end

  if attributes.key?(:'icon_url')
    self.icon_url = attributes[:'icon_url']
  end

  if attributes.key?(:'is_you')
    self.is_you = attributes[:'is_you']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/pipedrive-openapi-client/models/base_user.rb, line 130
def self.openapi_nullable
  Set.new([
    :'signup_flow_variation',
    :'icon_url',
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/pipedrive-openapi-client/models/base_user.rb, line 104
def self.openapi_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'default_currency' => :'String',
    :'locale' => :'String',
    :'lang' => :'Integer',
    :'email' => :'String',
    :'phone' => :'String',
    :'activated' => :'Boolean',
    :'last_login' => :'String',
    :'created' => :'String',
    :'modified' => :'String',
    :'signup_flow_variation' => :'String',
    :'has_created_company' => :'Boolean',
    :'is_admin' => :'NumberBoolean',
    :'active_flag' => :'Boolean',
    :'timezone_name' => :'String',
    :'timezone_offset' => :'String',
    :'role_id' => :'Integer',
    :'icon_url' => :'String',
    :'is_you' => :'Boolean'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/pipedrive-openapi-client/models/base_user.rb, line 248
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      default_currency == o.default_currency &&
      locale == o.locale &&
      lang == o.lang &&
      email == o.email &&
      phone == o.phone &&
      activated == o.activated &&
      last_login == o.last_login &&
      created == o.created &&
      modified == o.modified &&
      signup_flow_variation == o.signup_flow_variation &&
      has_created_company == o.has_created_company &&
      is_admin == o.is_admin &&
      active_flag == o.active_flag &&
      timezone_name == o.timezone_name &&
      timezone_offset == o.timezone_offset &&
      role_id == o.role_id &&
      icon_url == o.icon_url &&
      is_you == o.is_you
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/pipedrive-openapi-client/models/base_user.rb, line 316
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
    Pipedrive.const_get(type).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/pipedrive-openapi-client/models/base_user.rb, line 385
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/pipedrive-openapi-client/models/base_user.rb, line 295
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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/pipedrive-openapi-client/models/base_user.rb, line 275
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/pipedrive-openapi-client/models/base_user.rb, line 281
def hash
  [id, name, default_currency, locale, lang, email, phone, activated, last_login, created, modified, signup_flow_variation, has_created_company, is_admin, active_flag, timezone_name, timezone_offset, role_id, icon_url, is_you].hash
end
list_invalid_properties() click to toggle source

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

# File lib/pipedrive-openapi-client/models/base_user.rb, line 235
def list_invalid_properties
  invalid_properties = Array.new
  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/pipedrive-openapi-client/models/base_user.rb, line 361
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/pipedrive-openapi-client/models/base_user.rb, line 367
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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/pipedrive-openapi-client/models/base_user.rb, line 355
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/pipedrive-openapi-client/models/base_user.rb, line 242
def valid?
  true
end