class Onfido::DocumentPropertiesExtractedData

Attributes

address_line_1[RW]
address_line_2[RW]
address_line_3[RW]
address_line_4[RW]
address_line_5[RW]
alias_name[RW]
date_of_birth[RW]
date_of_expiry[RW]
document_number[RW]
first_name[RW]
full_name[RW]
gender[RW]
issuing_authority[RW]
last_name[RW]
middle_name[RW]
mrz_line1[RW]
mrz_line2[RW]
mrz_line3[RW]
nationality[RW]
spouse_name[RW]
widow_name[RW]

Public Class Methods

_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/onfido/models/document_properties_extracted_data.rb, line 307
def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Onfido.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end
acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/onfido/models/document_properties_extracted_data.rb, line 88
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# File lib/onfido/models/document_properties_extracted_data.rb, line 61
def self.attribute_map
  {
    :'document_number' => :'document_number',
    :'date_of_birth' => :'date_of_birth',
    :'date_of_expiry' => :'date_of_expiry',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'middle_name' => :'middle_name',
    :'full_name' => :'full_name',
    :'spouse_name' => :'spouse_name',
    :'widow_name' => :'widow_name',
    :'alias_name' => :'alias_name',
    :'gender' => :'gender',
    :'mrz_line1' => :'mrz_line1',
    :'mrz_line2' => :'mrz_line2',
    :'mrz_line3' => :'mrz_line3',
    :'nationality' => :'nationality',
    :'address_line_1' => :'address_line_1',
    :'address_line_2' => :'address_line_2',
    :'address_line_3' => :'address_line_3',
    :'address_line_4' => :'address_line_4',
    :'address_line_5' => :'address_line_5',
    :'issuing_authority' => :'issuing_authority'
  }
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/onfido/models/document_properties_extracted_data.rb, line 283
def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end
new(attributes = {}) click to toggle source

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

# File lib/onfido/models/document_properties_extracted_data.rb, line 127
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Onfido::DocumentPropertiesExtractedData` 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 `Onfido::DocumentPropertiesExtractedData`. 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?(:'document_number')
    self.document_number = attributes[:'document_number']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

List of attributes with nullable: true

# File lib/onfido/models/document_properties_extracted_data.rb, line 120
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/onfido/models/document_properties_extracted_data.rb, line 93
def self.openapi_types
  {
    :'document_number' => :'String',
    :'date_of_birth' => :'Date',
    :'date_of_expiry' => :'Date',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'middle_name' => :'String',
    :'full_name' => :'String',
    :'spouse_name' => :'String',
    :'widow_name' => :'String',
    :'alias_name' => :'String',
    :'gender' => :'String',
    :'mrz_line1' => :'String',
    :'mrz_line2' => :'String',
    :'mrz_line3' => :'String',
    :'nationality' => :'String',
    :'address_line_1' => :'String',
    :'address_line_2' => :'String',
    :'address_line_3' => :'String',
    :'address_line_4' => :'String',
    :'address_line_5' => :'String',
    :'issuing_authority' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/onfido/models/document_properties_extracted_data.rb, line 242
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      document_number == o.document_number &&
      date_of_birth == o.date_of_birth &&
      date_of_expiry == o.date_of_expiry &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      middle_name == o.middle_name &&
      full_name == o.full_name &&
      spouse_name == o.spouse_name &&
      widow_name == o.widow_name &&
      alias_name == o.alias_name &&
      gender == o.gender &&
      mrz_line1 == o.mrz_line1 &&
      mrz_line2 == o.mrz_line2 &&
      mrz_line3 == o.mrz_line3 &&
      nationality == o.nationality &&
      address_line_1 == o.address_line_1 &&
      address_line_2 == o.address_line_2 &&
      address_line_3 == o.address_line_3 &&
      address_line_4 == o.address_line_4 &&
      address_line_5 == o.address_line_5 &&
      issuing_authority == o.issuing_authority
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/onfido/models/document_properties_extracted_data.rb, line 378
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
eql?(o) click to toggle source

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

# File lib/onfido/models/document_properties_extracted_data.rb, line 270
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/onfido/models/document_properties_extracted_data.rb, line 276
def hash
  [document_number, date_of_birth, date_of_expiry, first_name, last_name, middle_name, full_name, spouse_name, widow_name, alias_name, gender, mrz_line1, mrz_line2, mrz_line3, nationality, address_line_1, address_line_2, address_line_3, address_line_4, address_line_5, issuing_authority].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/onfido/models/document_properties_extracted_data.rb, line 227
def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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/onfido/models/document_properties_extracted_data.rb, line 354
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/onfido/models/document_properties_extracted_data.rb, line 360
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/onfido/models/document_properties_extracted_data.rb, line 348
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/onfido/models/document_properties_extracted_data.rb, line 235
def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end