class Onfido::DocumentBreakdown
Attributes
Public Class Methods
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_breakdown.rb, line 199 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
Returns all the JSON keys this model knows about
# File lib/onfido/models/document_breakdown.rb, line 52 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/onfido/models/document_breakdown.rb, line 37 def self.attribute_map { :'data_comparison' => :'data_comparison', :'data_validation' => :'data_validation', :'image_integrity' => :'image_integrity', :'visual_authenticity' => :'visual_authenticity', :'data_consistency' => :'data_consistency', :'police_record' => :'police_record', :'compromised_document' => :'compromised_document', :'age_validation' => :'age_validation', :'issuing_authority' => :'issuing_authority' } end
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_breakdown.rb, line 175 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/onfido/models/document_breakdown.rb, line 79 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Onfido::DocumentBreakdown` 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::DocumentBreakdown`. 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?(:'data_comparison') self.data_comparison = attributes[:'data_comparison'] end if attributes.key?(:'data_validation') self.data_validation = attributes[:'data_validation'] end if attributes.key?(:'image_integrity') self.image_integrity = attributes[:'image_integrity'] end if attributes.key?(:'visual_authenticity') self.visual_authenticity = attributes[:'visual_authenticity'] end if attributes.key?(:'data_consistency') self.data_consistency = attributes[:'data_consistency'] end if attributes.key?(:'police_record') self.police_record = attributes[:'police_record'] end if attributes.key?(:'compromised_document') self.compromised_document = attributes[:'compromised_document'] end if attributes.key?(:'age_validation') self.age_validation = attributes[:'age_validation'] end if attributes.key?(:'issuing_authority') self.issuing_authority = attributes[:'issuing_authority'] end end
List of attributes with nullable: true
# File lib/onfido/models/document_breakdown.rb, line 72 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/onfido/models/document_breakdown.rb, line 57 def self.openapi_types { :'data_comparison' => :'DocumentBreakdownDataComparison', :'data_validation' => :'DocumentBreakdownDataValidation', :'image_integrity' => :'DocumentBreakdownImageIntegrity', :'visual_authenticity' => :'DocumentBreakdownVisualAuthenticity', :'data_consistency' => :'DocumentBreakdownDataConsistency', :'police_record' => :'DocumentBreakdownPoliceRecord', :'compromised_document' => :'DocumentBreakdownCompromisedDocument', :'age_validation' => :'DocumentBreakdownAgeValidation', :'issuing_authority' => :'DocumentBreakdownIssuingAuthority' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/onfido/models/document_breakdown.rb, line 146 def ==(o) return true if self.equal?(o) self.class == o.class && data_comparison == o.data_comparison && data_validation == o.data_validation && image_integrity == o.image_integrity && visual_authenticity == o.visual_authenticity && data_consistency == o.data_consistency && police_record == o.police_record && compromised_document == o.compromised_document && age_validation == o.age_validation && issuing_authority == o.issuing_authority end
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_breakdown.rb, line 270 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
@see the ‘==` method @param [Object] Object to be compared
# File lib/onfido/models/document_breakdown.rb, line 162 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/onfido/models/document_breakdown.rb, line 168 def hash [data_comparison, data_validation, image_integrity, visual_authenticity, data_consistency, police_record, compromised_document, age_validation, issuing_authority].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/onfido/models/document_breakdown.rb, line 131 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/onfido/models/document_breakdown.rb, line 252 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/onfido/models/document_breakdown.rb, line 240 def to_s to_hash.to_s end
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_breakdown.rb, line 139 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' true end