class Onfido::DocumentPropertiesNfc

Attributes

address[RW]
date_of_birth[RW]
date_of_expiry[RW]
document_number[RW]
document_type[RW]
full_name[RW]
gender[RW]
issuing_authority[RW]
issuing_country[RW]
issuing_date[RW]
nationality[RW]
personal_number[RW]
place_of_birth[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_nfc.rb, line 235
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_nfc.rb, line 64
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_nfc.rb, line 45
def self.attribute_map
  {
    :'document_type' => :'document_type',
    :'issuing_country' => :'issuing_country',
    :'full_name' => :'full_name',
    :'document_number' => :'document_number',
    :'nationality' => :'nationality',
    :'date_of_birth' => :'date_of_birth',
    :'gender' => :'gender',
    :'date_of_expiry' => :'date_of_expiry',
    :'personal_number' => :'personal_number',
    :'place_of_birth' => :'place_of_birth',
    :'address' => :'address',
    :'issuing_date' => :'issuing_date',
    :'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_nfc.rb, line 211
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_nfc.rb, line 95
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Onfido::DocumentPropertiesNfc` 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::DocumentPropertiesNfc`. 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_type')
    self.document_type = attributes[:'document_type']
  end

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'issuing_date')
    self.issuing_date = attributes[:'issuing_date']
  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_nfc.rb, line 88
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/onfido/models/document_properties_nfc.rb, line 69
def self.openapi_types
  {
    :'document_type' => :'String',
    :'issuing_country' => :'String',
    :'full_name' => :'String',
    :'document_number' => :'String',
    :'nationality' => :'String',
    :'date_of_birth' => :'Date',
    :'gender' => :'String',
    :'date_of_expiry' => :'Date',
    :'personal_number' => :'String',
    :'place_of_birth' => :'String',
    :'address' => :'String',
    :'issuing_date' => :'Date',
    :'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_nfc.rb, line 178
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      document_type == o.document_type &&
      issuing_country == o.issuing_country &&
      full_name == o.full_name &&
      document_number == o.document_number &&
      nationality == o.nationality &&
      date_of_birth == o.date_of_birth &&
      gender == o.gender &&
      date_of_expiry == o.date_of_expiry &&
      personal_number == o.personal_number &&
      place_of_birth == o.place_of_birth &&
      address == o.address &&
      issuing_date == o.issuing_date &&
      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_nfc.rb, line 306
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_nfc.rb, line 198
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_nfc.rb, line 204
def hash
  [document_type, issuing_country, full_name, document_number, nationality, date_of_birth, gender, date_of_expiry, personal_number, place_of_birth, address, issuing_date, 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_nfc.rb, line 163
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_nfc.rb, line 282
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_nfc.rb, line 288
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_nfc.rb, line 276
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_nfc.rb, line 171
def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end