class NucleusApi::Client

Client Object

Attributes

address[RW]
business_id[RW]
citizenship_status[RW]

citizenshipStatus

client_type[RW]

clientTypeId

country_of_citizenship[RW]

countryOfCitizenship

country_of_residence[RW]

countryOfResidence

create_date[RW]
date_of_birth[RW]

dateOfBirth

email[RW]

email

employment[RW]
firm_name[RW]

firmName

firm_type[RW]

firmType

first_name[RW]

firstName

gender[RW]

gender

hydro_id[RW]

hydroId

id[RW]
identification_number[RW]

identificationNumber

identification_number_type[RW]

identificationNumberType

image[RW]

image

income[RW]

income

is_active[RW]

isActive

is_verified[RW]

isVerified

last_name[RW]
liquid_net_worth[RW]

liquidNetWorth

metadata[RW]

metadata

middle_name[RW]

middleName

phone_number[RW]

phoneNumber

secondary_id[RW]
status[RW]

status

suffix[RW]

suffix

title[RW]

title

total_net_worth[RW]

totalNetWorth

update_date[RW]
username[RW]

username

Public Class Methods

attribute_map() click to toggle source

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

# File lib/nucleus_api/models/client.rb, line 115
def self.attribute_map
  {
    :'address' => :'address',
    :'business_id' => :'business_id',
    :'citizenship_status' => :'citizenship_status',
    :'client_type' => :'client_type',
    :'country_of_citizenship' => :'country_of_citizenship',
    :'country_of_residence' => :'country_of_residence',
    :'create_date' => :'create_date',
    :'date_of_birth' => :'date_of_birth',
    :'email' => :'email',
    :'employment' => :'employment',
    :'firm_name' => :'firm_name',
    :'firm_type' => :'firm_type',
    :'first_name' => :'first_name',
    :'gender' => :'gender',
    :'hydro_id' => :'hydro_id',
    :'id' => :'id',
    :'identification_number' => :'identification_number',
    :'identification_number_type' => :'identification_number_type',
    :'image' => :'image',
    :'income' => :'income',
    :'is_active' => :'is_active',
    :'is_verified' => :'is_verified',
    :'last_name' => :'last_name',
    :'liquid_net_worth' => :'liquid_net_worth',
    :'metadata' => :'metadata',
    :'middle_name' => :'middle_name',
    :'phone_number' => :'phone_number',
    :'secondary_id' => :'secondary_id',
    :'status' => :'status',
    :'suffix' => :'suffix',
    :'title' => :'title',
    :'total_net_worth' => :'total_net_worth',
    :'update_date' => :'update_date',
    :'username' => :'username'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/nucleus_api/models/client.rb, line 196
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?(:'address')
    if (value = attributes[:'address']).is_a?(Array)
      self.address = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'username')
    self.username = attributes[:'username']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/nucleus_api/models/client.rb, line 155
def self.swagger_types
  {
    :'address' => :'Array<ClientAddress>',
    :'business_id' => :'String',
    :'citizenship_status' => :'String',
    :'client_type' => :'String',
    :'country_of_citizenship' => :'Array<String>',
    :'country_of_residence' => :'String',
    :'create_date' => :'DateTime',
    :'date_of_birth' => :'String',
    :'email' => :'String',
    :'employment' => :'Employment',
    :'firm_name' => :'String',
    :'firm_type' => :'String',
    :'first_name' => :'String',
    :'gender' => :'String',
    :'hydro_id' => :'String',
    :'id' => :'String',
    :'identification_number' => :'String',
    :'identification_number_type' => :'String',
    :'image' => :'String',
    :'income' => :'Integer',
    :'is_active' => :'BOOLEAN',
    :'is_verified' => :'BOOLEAN',
    :'last_name' => :'String',
    :'liquid_net_worth' => :'Float',
    :'metadata' => :'Hash<String, String>',
    :'middle_name' => :'String',
    :'phone_number' => :'String',
    :'secondary_id' => :'String',
    :'status' => :'String',
    :'suffix' => :'String',
    :'title' => :'String',
    :'total_net_worth' => :'Float',
    :'update_date' => :'DateTime',
    :'username' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/nucleus_api/models/client.rb, line 370
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address == o.address &&
      business_id == o.business_id &&
      citizenship_status == o.citizenship_status &&
      client_type == o.client_type &&
      country_of_citizenship == o.country_of_citizenship &&
      country_of_residence == o.country_of_residence &&
      create_date == o.create_date &&
      date_of_birth == o.date_of_birth &&
      email == o.email &&
      employment == o.employment &&
      firm_name == o.firm_name &&
      firm_type == o.firm_type &&
      first_name == o.first_name &&
      gender == o.gender &&
      hydro_id == o.hydro_id &&
      id == o.id &&
      identification_number == o.identification_number &&
      identification_number_type == o.identification_number_type &&
      image == o.image &&
      income == o.income &&
      is_active == o.is_active &&
      is_verified == o.is_verified &&
      last_name == o.last_name &&
      liquid_net_worth == o.liquid_net_worth &&
      metadata == o.metadata &&
      middle_name == o.middle_name &&
      phone_number == o.phone_number &&
      secondary_id == o.secondary_id &&
      status == o.status &&
      suffix == o.suffix &&
      title == o.title &&
      total_net_worth == o.total_net_worth &&
      update_date == o.update_date &&
      username == o.username
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/nucleus_api/models/client.rb, line 443
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    (value)
  when :Date
    (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 = NucleusApi.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/nucleus_api/models/client.rb, line 509
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/nucleus_api/models/client.rb, line 424
def build_from_hash(attributes)
  self.class.swagger_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/nucleus_api/models/client.rb, line 411
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/nucleus_api/models/client.rb, line 417
def hash
  [address, business_id, citizenship_status, client_type, country_of_citizenship, country_of_residence, create_date, date_of_birth, email, employment, firm_name, firm_type, first_name, gender, hydro_id, id, identification_number, identification_number_type, image, income, is_active, is_verified, last_name, liquid_net_worth, metadata, middle_name, phone_number, secondary_id, status, suffix, title, total_net_worth, update_date, username].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/nucleus_api/models/client.rb, line 347
def list_invalid_properties
  invalid_properties = Array.new
  if @client_type.nil?
    invalid_properties.push('invalid value for "client_type", client_type cannot be nil.')
  end

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

  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/nucleus_api/models/client.rb, line 490
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/nucleus_api/models/client.rb, line 496
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    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/nucleus_api/models/client.rb, line 484
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/nucleus_api/models/client.rb, line 362
def valid?
  return false if @client_type.nil?
  return false if @username.nil?
  true
end