class Plaid::ConsumerReportUserIdentity
To create a Plaid
Check Consumer Report for a user, this field must be present on the user token. If this field is not provided during user token creation, you can add it to the user later by calling ‘/user/update`. Once the field has been added to the user, you will be able to call `/link/token/create` with a non-empty `consumer_report_permissible_purpose` (which will automatically create a Plaid
Check Consumer Report), or call `/cra/check_report/create` for that user.
Attributes
The user’s emails
The user’s first name
The user’s last name
The user’s phone number, in E.164 format: +{countrycode}{number}. For example: "+14157452130". Phone numbers provided in other formats will be parsed on a best-effort basis. Phone number input is validated against valid number ranges; number strings that do not match a real-world phone numbering scheme may cause the request to fail, even in the Sandbox test environment.
The last 4 digits of the user’s social security number.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/plaid/models/consumer_report_user_identity.rb, line 53 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/plaid/models/consumer_report_user_identity.rb, line 40 def self.attribute_map { :'first_name' => :'first_name', :'last_name' => :'last_name', :'phone_numbers' => :'phone_numbers', :'emails' => :'emails', :'ssn_last_4' => :'ssn_last_4', :'date_of_birth' => :'date_of_birth', :'primary_address' => :'primary_address' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/plaid/models/consumer_report_user_identity.rb, line 219 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/plaid/models/consumer_report_user_identity.rb, line 80 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::ConsumerReportUserIdentity` 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::ConsumerReportUserIdentity`. 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?(:'first_name') self.first_name = attributes[:'first_name'] end if attributes.key?(:'last_name') self.last_name = attributes[:'last_name'] end if attributes.key?(:'phone_numbers') if (value = attributes[:'phone_numbers']).is_a?(Array) self.phone_numbers = value end end if attributes.key?(:'emails') if (value = attributes[:'emails']).is_a?(Array) self.emails = value end end if attributes.key?(:'ssn_last_4') self.ssn_last_4 = attributes[:'ssn_last_4'] end if attributes.key?(:'date_of_birth') self.date_of_birth = attributes[:'date_of_birth'] end if attributes.key?(:'primary_address') self.primary_address = attributes[:'primary_address'] end end
List of attributes with nullable: true
# File lib/plaid/models/consumer_report_user_identity.rb, line 71 def self.openapi_nullable Set.new([ :'ssn_last_4', :'date_of_birth', ]) end
Attribute type mapping.
# File lib/plaid/models/consumer_report_user_identity.rb, line 58 def self.openapi_types { :'first_name' => :'String', :'last_name' => :'String', :'phone_numbers' => :'Array<String>', :'emails' => :'Array<String>', :'ssn_last_4' => :'String', :'date_of_birth' => :'Date', :'primary_address' => :'AddressData' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/plaid/models/consumer_report_user_identity.rb, line 192 def ==(o) return true if self.equal?(o) self.class == o.class && first_name == o.first_name && last_name == o.last_name && phone_numbers == o.phone_numbers && emails == o.emails && ssn_last_4 == o.ssn_last_4 && date_of_birth == o.date_of_birth && primary_address == o.primary_address end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/plaid/models/consumer_report_user_identity.rb, line 250 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
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/plaid/models/consumer_report_user_identity.rb, line 321 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/plaid/models/consumer_report_user_identity.rb, line 226 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
@see the ‘==` method @param [Object] Object to be compared
# File lib/plaid/models/consumer_report_user_identity.rb, line 206 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/plaid/models/consumer_report_user_identity.rb, line 212 def hash [first_name, last_name, phone_numbers, emails, ssn_last_4, date_of_birth, primary_address].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/plaid/models/consumer_report_user_identity.rb, line 128 def list_invalid_properties invalid_properties = Array.new if @first_name.nil? invalid_properties.push('invalid value for "first_name", first_name cannot be nil.') end if @last_name.nil? invalid_properties.push('invalid value for "last_name", last_name cannot be nil.') end if @phone_numbers.nil? invalid_properties.push('invalid value for "phone_numbers", phone_numbers cannot be nil.') end if @emails.nil? invalid_properties.push('invalid value for "emails", emails cannot be nil.') end if !@ssn_last_4.nil? && @ssn_last_4.to_s.length > 4 invalid_properties.push('invalid value for "ssn_last_4", the character length must be smaller than or equal to 4.') end if !@ssn_last_4.nil? && @ssn_last_4.to_s.length < 4 invalid_properties.push('invalid value for "ssn_last_4", the character length must be great than or equal to 4.') end if @primary_address.nil? invalid_properties.push('invalid value for "primary_address", primary_address cannot be nil.') end invalid_properties end
Custom attribute writer method with validation @param [Object] ssn_last_4
Value to be assigned
# File lib/plaid/models/consumer_report_user_identity.rb, line 177 def ssn_last_4=(ssn_last_4) if !ssn_last_4.nil? && ssn_last_4.to_s.length > 4 fail ArgumentError, 'invalid value for "ssn_last_4", the character length must be smaller than or equal to 4.' end if !ssn_last_4.nil? && ssn_last_4.to_s.length < 4 fail ArgumentError, 'invalid value for "ssn_last_4", the character length must be great than or equal to 4.' end @ssn_last_4 = ssn_last_4 end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/plaid/models/consumer_report_user_identity.rb, line 303 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/plaid/models/consumer_report_user_identity.rb, line 291 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/plaid/models/consumer_report_user_identity.rb, line 164 def valid? return false if @first_name.nil? return false if @last_name.nil? return false if @phone_numbers.nil? return false if @emails.nil? return false if !@ssn_last_4.nil? && @ssn_last_4.to_s.length > 4 return false if !@ssn_last_4.nil? && @ssn_last_4.to_s.length < 4 return false if @primary_address.nil? true end