class Plaid::AssetReportUser
The user object allows you to provide additional information about the user to be appended to the Asset
Report. All fields are optional. The ‘first_name`, `last_name`, and `ssn` fields are required if you would like the Report to be eligible for Fannie Mae’s Day 1 Certainty™ program.
Attributes
An identifier you determine and submit for the user. If using the Credit Dashboard, Customers should pass in the ‘user_token` created in `/user/create`.
The user’s email address.
The user’s first name. Required for the Fannie Mae Day 1 Certainty™ program.
The user’s last name. Required for the Fannie Mae Day 1 Certainty™ program.
The user’s middle name
The user’s phone number, in E.164 format: +{countrycode}{number}. For example: "+14151234567". Phone numbers provided in other formats will be parsed on a best-effort basis.
Public Class Methods
Source
# File lib/plaid/models/asset_report_user.rb, line 54 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/asset_report_user.rb, line 41 def self.attribute_map { :'client_user_id' => :'client_user_id', :'first_name' => :'first_name', :'middle_name' => :'middle_name', :'last_name' => :'last_name', :'ssn' => :'ssn', :'phone_number' => :'phone_number', :'email' => :'email' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/asset_report_user.rb, line 170 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/asset_report_user.rb, line 86 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::AssetReportUser` 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::AssetReportUser`. 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?(:'client_user_id') self.client_user_id = attributes[:'client_user_id'] end if attributes.key?(:'first_name') self.first_name = attributes[:'first_name'] end if attributes.key?(:'middle_name') self.middle_name = attributes[:'middle_name'] end if attributes.key?(:'last_name') self.last_name = attributes[:'last_name'] end if attributes.key?(:'ssn') self.ssn = attributes[:'ssn'] end if attributes.key?(:'phone_number') self.phone_number = attributes[:'phone_number'] end if attributes.key?(:'email') self.email = attributes[:'email'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/asset_report_user.rb, line 72 def self.openapi_nullable Set.new([ :'client_user_id', :'first_name', :'middle_name', :'last_name', :'ssn', :'phone_number', :'email' ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/asset_report_user.rb, line 59 def self.openapi_types { :'client_user_id' => :'String', :'first_name' => :'String', :'middle_name' => :'String', :'last_name' => :'String', :'ssn' => :'String', :'phone_number' => :'String', :'email' => :'String' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/asset_report_user.rb, line 143 def ==(o) return true if self.equal?(o) self.class == o.class && client_user_id == o.client_user_id && first_name == o.first_name && middle_name == o.middle_name && last_name == o.last_name && ssn == o.ssn && phone_number == o.phone_number && email == o.email end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/asset_report_user.rb, line 201 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/asset_report_user.rb, line 272 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/asset_report_user.rb, line 177 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/asset_report_user.rb, line 157 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/asset_report_user.rb, line 163 def hash [client_user_id, first_name, middle_name, last_name, ssn, phone_number, email].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/asset_report_user.rb, line 130 def list_invalid_properties invalid_properties = Array.new 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/asset_report_user.rb, line 254 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/asset_report_user.rb, line 242 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/asset_report_user.rb, line 137 def valid? true end
Check to see if the all the properties in the model are valid @return true if the model is valid