class

Plaid::DocumentMetadata

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

An object representing metadata from the end user's uploaded document.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, name : String | Nil = nil, status : String | Nil = nil, doc_id : String | Nil = nil, doc_type : Plaid::DocType | Nil = nil)

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

doc_id

An identifier of the document that is also present in the paystub response.

Source
doc_id=(new_value : String | Nil)

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

Source
doc_type
Source
doc_type=(new_value : Plaid::DocType | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] doc_type 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
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
status_present=(status_present : Bool)
Source
status_present?
Source
valid?

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

Source