class

Plaid::CreditDocumentMetadata

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

Object representing metadata pertaining to the document.

Constructors

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

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

Source

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

document_type

The type of document. PAYSTUB: A paystub. BANK_STATEMENT: A bank statement. US_TAX_W2: A W-2 wage and tax statement provided by a US employer reflecting wages earned by the employee. US_MILITARY_ERAS: An electronic Retirement Account Statement (eRAS) issued by the US military. US_MILITARY_LES: A Leave and Earnings Statement (LES) issued by the US military. US_MILITARY_CLES: A Civilian Leave and Earnings Statment (CLES) issued by the US military. GIG: Used to indicate that the income is related to gig work. Does not necessarily correspond to a specific document type. PLAID_GENERATED_PAYSTUB_PDF: Used to indicate that the PDF for the paystub was generated by Plaid. NONE: Used to indicate that there is no underlying document for the data. UNKNOWN: Document type could not be determined.

Source

document_type=(new_value : String | Nil)

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

Source

download_url

Signed URL to retrieve the underlying file. For Payroll Income, the file type will always be PDF, and the file may not be available, in which case the field will be null. If you would like Plaid to generate a PDF if the original is not available, contact your Account Manager. For Document Income, this field will not be null, and the file type will be the original file type uploaded by the user. For more details on available file types, see the Document Income documentation. This download URL can only be used once and expires after two minutes. To generate a new download URL, call /credit/payroll_income/get again.

Source

download_url=(new_value : String | Nil)

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

Source

hash(hasher)

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

list_invalid_properties

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

Source

name

The name of the document.

Source

name=(new_value : String | Nil)

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

Source

page_count

The number of pages of the uploaded document (if available).

Source

page_count=(new_value : Int32 | Nil)

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

Source

page_count_present=(page_count_present : Bool)

Source

page_count_present?

Source

status

The processing status of the document. PROCESSING_COMPLETE: The document was successfully processed. DOCUMENT_ERROR: The document could not be processed. Possible causes include: The document was an unacceptable document type such as an offer letter or bank statement, the document image was cropped or blurry, or the document was corrupted. UNKNOWN or null: An internal error occurred. If this happens repeatedly, contact support or your Plaid account manager.

Source

status=(new_value : String | Nil)

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

Source

valid?

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

Source