class Plaid::KYCCheckDetails
Additional information for the ‘kyc_check` (Data Source
Verification) step. This field will be `null` unless `steps.kyc_check` has reached a terminal state of either `success` or `failed`.
Attributes
The outcome status for the associated Identity Verification attempt’s ‘kyc_check` step. This field will always have the same value as `steps.kyc_check`.
Public Class Methods
Source
# File lib/plaid/models/kyc_check_details.rb, line 45 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/kyc_check_details.rb, line 33 def self.attribute_map { :'status' => :'status', :'address' => :'address', :'name' => :'name', :'date_of_birth' => :'date_of_birth', :'id_number' => :'id_number', :'phone_number' => :'phone_number' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/kyc_check_details.rb, line 178 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/kyc_check_details.rb, line 69 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::KYCCheckDetails` 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::KYCCheckDetails`. 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?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'address') self.address = attributes[:'address'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'date_of_birth') self.date_of_birth = attributes[:'date_of_birth'] end if attributes.key?(:'id_number') self.id_number = attributes[:'id_number'] end if attributes.key?(:'phone_number') self.phone_number = attributes[:'phone_number'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/kyc_check_details.rb, line 62 def self.openapi_nullable Set.new([ ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/kyc_check_details.rb, line 50 def self.openapi_types { :'status' => :'String', :'address' => :'KYCCheckAddressSummary', :'name' => :'KYCCheckNameSummary', :'date_of_birth' => :'KYCCheckDateOfBirthSummary', :'id_number' => :'KYCCheckIDNumberSummary', :'phone_number' => :'KYCCheckPhoneSummary' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/kyc_check_details.rb, line 152 def ==(o) return true if self.equal?(o) self.class == o.class && status == o.status && address == o.address && name == o.name && date_of_birth == o.date_of_birth && id_number == o.id_number && phone_number == o.phone_number end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/kyc_check_details.rb, line 209 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/kyc_check_details.rb, line 280 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/kyc_check_details.rb, line 185 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/kyc_check_details.rb, line 165 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/kyc_check_details.rb, line 171 def hash [status, address, name, date_of_birth, id_number, phone_number].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/kyc_check_details.rb, line 109 def list_invalid_properties invalid_properties = Array.new if @status.nil? invalid_properties.push('invalid value for "status", status cannot be nil.') end if @address.nil? invalid_properties.push('invalid value for "address", address cannot be nil.') end if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @date_of_birth.nil? invalid_properties.push('invalid value for "date_of_birth", date_of_birth cannot be nil.') end if @id_number.nil? invalid_properties.push('invalid value for "id_number", id_number cannot be nil.') end if @phone_number.nil? invalid_properties.push('invalid value for "phone_number", phone_number 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/kyc_check_details.rb, line 262 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/kyc_check_details.rb, line 250 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/kyc_check_details.rb, line 140 def valid? return false if @status.nil? return false if @address.nil? return false if @name.nil? return false if @date_of_birth.nil? return false if @id_number.nil? return false if @phone_number.nil? true end
Check to see if the all the properties in the model are valid @return true if the model is valid