class Plaid::DocumentAnalysis
High level descriptions of how the associated document was processed. If a document fails verification, the details in the ‘analysis` object should help clarify why the document was rejected.
Attributes
Public Class Methods
Source
# File lib/plaid/models/document_analysis.rb, line 66 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/document_analysis.rb, line 54 def self.attribute_map { :'authenticity' => :'authenticity', :'image_quality' => :'image_quality', :'extracted_data' => :'extracted_data', :'fraud_analysis_details' => :'fraud_analysis_details', :'image_quality_details' => :'image_quality_details', :'human_review' => :'human_review' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/document_analysis.rb, line 183 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/document_analysis.rb, line 94 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::DocumentAnalysis` 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 `Plaid::DocumentAnalysis`. 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?(:'authenticity') self.authenticity = attributes[:'authenticity'] end if attributes.key?(:'image_quality') self.image_quality = attributes[:'image_quality'] end if attributes.key?(:'extracted_data') self.extracted_data = attributes[:'extracted_data'] end if attributes.key?(:'fraud_analysis_details') self.fraud_analysis_details = attributes[:'fraud_analysis_details'] end if attributes.key?(:'image_quality_details') self.image_quality_details = attributes[:'image_quality_details'] end if attributes.key?(:'human_review') self.human_review = attributes[:'human_review'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/document_analysis.rb, line 83 def self.openapi_nullable Set.new([ :'extracted_data', :'fraud_analysis_details', :'image_quality_details', :'human_review' ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/document_analysis.rb, line 71 def self.openapi_types { :'authenticity' => :'DocumentAuthenticityMatchCode', :'image_quality' => :'ImageQuality', :'extracted_data' => :'PhysicalDocumentExtractedDataAnalysis', :'fraud_analysis_details' => :'FraudAnalysisDetails', :'image_quality_details' => :'ImageQualityDetails', :'human_review' => :'HumanReview' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/document_analysis.rb, line 157 def ==(o) return true if self.equal?(o) self.class == o.class && authenticity == o.authenticity && image_quality == o.image_quality && extracted_data == o.extracted_data && fraud_analysis_details == o.fraud_analysis_details && image_quality_details == o.image_quality_details && human_review == o.human_review end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/document_analysis.rb, line 214 def _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 = Plaid.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/plaid/models/document_analysis.rb, line 285 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
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
Source
# File lib/plaid/models/document_analysis.rb, line 190 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{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[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 end self end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/document_analysis.rb, line 170 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/document_analysis.rb, line 176 def hash [authenticity, image_quality, extracted_data, fraud_analysis_details, image_quality_details, human_review].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/document_analysis.rb, line 134 def list_invalid_properties invalid_properties = Array.new if @authenticity.nil? invalid_properties.push('invalid value for "authenticity", authenticity cannot be nil.') end if @image_quality.nil? invalid_properties.push('invalid value for "image_quality", image_quality cannot be nil.') end invalid_properties end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
Source
# File lib/plaid/models/document_analysis.rb, line 267 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 object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/plaid/models/document_analysis.rb, line 255 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/plaid/models/document_analysis.rb, line 149 def valid? return false if @authenticity.nil? return false if @image_quality.nil? true end
Check to see if the all the properties in the model are valid @return true if the model is valid