class

Plaid::AssetReportUser

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

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.

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

new(*, client_user_id : String | Nil = nil, first_name : String | Nil = nil, middle_name : String | Nil = nil, last_name : String | Nil = nil, ssn : String | Nil = nil, phone_number : String | Nil = nil, email : String | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

client_user_id

An identifier you determine and submit for the user.

client_user_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] client_user_id Object to be assigned

client_user_id_present=(client_user_id_present : Bool)

client_user_id_present?

email

The user's email address.

email=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] email Object to be assigned

email_present=(email_present : Bool)

email_present?

first_name

The user's first name. Required for the Fannie Mae Day 1 Certainty™ program.

first_name=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] first_name Object to be assigned

first_name_present=(first_name_present : Bool)

first_name_present?

hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

last_name

The user's last name. Required for the Fannie Mae Day 1 Certainty™ program.

last_name=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] last_name Object to be assigned

last_name_present=(last_name_present : Bool)

last_name_present?

list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

middle_name

The user's middle name

middle_name=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] middle_name Object to be assigned

middle_name_present=(middle_name_present : Bool)

middle_name_present?

phone_number

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.

phone_number=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] phone_number Object to be assigned

phone_number_present=(phone_number_present : Bool)

phone_number_present?

ssn

The user's Social Security Number. Required for the Fannie Mae Day 1 Certainty™ program. Format: "ddd-dd-dddd"

ssn=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] ssn Object to be assigned

ssn_present=(ssn_present : Bool)

ssn_present?

valid?

Check to see if the all the properties in the model are valid @return true if the model is valid