class Trulioo::AppendedField
<p>Types of fields you will see here include</p> <table class="help-page-table"> <thead> <tr> <td> FieldName </td> <td> Data </td> <td> Comments </td> </tr> </thead> <tbody> <tr> <td>WatchlistState</td> <td>Clear</td> <td>If the submitted individual did not match any watchlist checks, the appended field data will appear as clear</td> </tr> <tr> <td>WatchlistState</td> <td>Hit</td> <td>If the submitted individual triggered a watchlist hit, the watchlistdata field also be included as below:</td> </tr> <tr> <td>WatchlistData</td> <td>Name|URL\tName2|URL</td> <td> Name of the source a pipe (|) the url of the source each source is separated with a tab (\t )</td> </tr> <tr> <td>CanadaSixMonthResidency</td> <td>YES</td> <td>The Canadian Credit Agency provides a flag to indicate that an individual has been at the specified residence for at least six months.The canadasixmonthresidency field is returned with a value of either YES or NO.</td> </tr> <tr> <td>IsDeceased</td> <td>False</td> <td>The IsDeceased field is returned by various datasources to indicate whether the input information was screened against an available death file. Check with your Trulioo
Technical Account Manager to see which datasources support this option.</td> </tr> <tr> <td>IsDeceased</td> <td>True</td> <td></td> </tr> <tr> <td>FraudFlag</td> <td>True</td> <td></td> </tr> <tr> <td>FraudFlag</td> <td>False</td> <td></td> </tr> </tbody> </table> <p>If you are retrieving transaction with address corrected values you will also see address fields in appended data</p>
Attributes
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/trulioo_sdk/models/appended_field.rb, line 28 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/trulioo_sdk/models/appended_field.rb, line 20 def self.attribute_map { :'field_name' => :'FieldName', :'data' => :'Data' } end
:nocov: Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/trulioo_sdk/models/appended_field.rb, line 108 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/trulioo_sdk/models/appended_field.rb, line 48 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Trulioo::AppendedField` 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 `Trulioo::AppendedField`. 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?(:'field_name') self.field_name = attributes[:'field_name'] end if attributes.key?(:'data') self.data = attributes[:'data'] end end
List of attributes with nullable: true
# File lib/trulioo_sdk/models/appended_field.rb, line 41 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/trulioo_sdk/models/appended_field.rb, line 33 def self.openapi_types { :'field_name' => :'String', :'data' => :'Object' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/trulioo_sdk/models/appended_field.rb, line 85 def ==(o) return true if self.equal?(o) self.class == o.class && field_name == o.field_name && data == o.data end
:nocov: Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/trulioo_sdk/models/appended_field.rb, line 142 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 = Trulioo.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end
:nocov: 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/trulioo_sdk/models/appended_field.rb, line 221 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
:nocov: Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/trulioo_sdk/models/appended_field.rb, line 117 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) 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
@see the `==` method @param [Object] Object to be compared
# File lib/trulioo_sdk/models/appended_field.rb, line 94 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/trulioo_sdk/models/appended_field.rb, line 100 def hash [field_name, data].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/trulioo_sdk/models/appended_field.rb, line 72 def list_invalid_properties invalid_properties = Array.new invalid_properties end
:nocov: Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/trulioo_sdk/models/appended_field.rb, line 201 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
:nocov: Returns the string representation of the object @return [String] String presentation of the object
# File lib/trulioo_sdk/models/appended_field.rb, line 185 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/trulioo_sdk/models/appended_field.rb, line 79 def valid? true end