class CloudmersiveValidateApiClient::FullNameValidationResponse

Result of a full name validation operation

Attributes

display_name[RW]

The full display name of the name

first_name[RW]

The first name (given name)

last_name[RW]

The last name (surname)

middle_name[RW]

The middle name(s); if there are multiple names they will be separated by spaces

nick_name[RW]

Nickname (if supplied)

successful[RW]

True if the validation operation was successful, false otherwise

suffix[RW]

Suffix to the name, e.g. "Jr." or "Sr."

title[RW]

The person's title (if supplied), e.g. "Mr." or "Ms."

validation_result_first_name[RW]

Possible values are: ValidFirstName, ValidUnknownFirstName, InvalidSpamInput, InvalidCharacters, InvalidEmpty

validation_result_last_name[RW]

Possible values are: ValidLastName, ValidUnknownLastName, InvalidSpamInput, InvalidCharacters, InvalidEmpty

Public Class Methods

attribute_map() click to toggle source

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

# File lib/cloudmersive-validate-api-client/models/full_name_validation_response.rb, line 49
def self.attribute_map
  {
    :'successful' => :'Successful',
    :'validation_result_first_name' => :'ValidationResult_FirstName',
    :'validation_result_last_name' => :'ValidationResult_LastName',
    :'title' => :'Title',
    :'first_name' => :'FirstName',
    :'middle_name' => :'MiddleName',
    :'last_name' => :'LastName',
    :'nick_name' => :'NickName',
    :'suffix' => :'Suffix',
    :'display_name' => :'DisplayName'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/cloudmersive-validate-api-client/models/full_name_validation_response.rb, line 82
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?(:'Successful')
    self.successful = attributes[:'Successful']
  end

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/cloudmersive-validate-api-client/models/full_name_validation_response.rb, line 65
def self.swagger_types
  {
    :'successful' => :'BOOLEAN',
    :'validation_result_first_name' => :'String',
    :'validation_result_last_name' => :'String',
    :'title' => :'String',
    :'first_name' => :'String',
    :'middle_name' => :'String',
    :'last_name' => :'String',
    :'nick_name' => :'String',
    :'suffix' => :'String',
    :'display_name' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/cloudmersive-validate-api-client/models/full_name_validation_response.rb, line 144
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      successful == o.successful &&
      validation_result_first_name == o.validation_result_first_name &&
      validation_result_last_name == o.validation_result_last_name &&
      title == o.title &&
      first_name == o.first_name &&
      middle_name == o.middle_name &&
      last_name == o.last_name &&
      nick_name == o.nick_name &&
      suffix == o.suffix &&
      display_name == o.display_name
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/cloudmersive-validate-api-client/models/full_name_validation_response.rb, line 195
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 = CloudmersiveValidateApiClient.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/cloudmersive-validate-api-client/models/full_name_validation_response.rb, line 261
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/cloudmersive-validate-api-client/models/full_name_validation_response.rb, line 174
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 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/cloudmersive-validate-api-client/models/full_name_validation_response.rb, line 161
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/cloudmersive-validate-api-client/models/full_name_validation_response.rb, line 167
def hash
  [successful, validation_result_first_name, validation_result_last_name, title, first_name, middle_name, last_name, nick_name, suffix, display_name].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/cloudmersive-validate-api-client/models/full_name_validation_response.rb, line 131
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/cloudmersive-validate-api-client/models/full_name_validation_response.rb, line 241
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/cloudmersive-validate-api-client/models/full_name_validation_response.rb, line 247
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/cloudmersive-validate-api-client/models/full_name_validation_response.rb, line 235
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/cloudmersive-validate-api-client/models/full_name_validation_response.rb, line 138
def valid?
  true
end