com.plaid.client.model

Class CreditDocumentMetadata

java.lang.Object

com.plaid.client.model.CreditDocumentMetadata

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-01-18T17:46:09.980340Z[Etc/UTC]")
public class CreditDocumentMetadata
extends Object

Object representing metadata pertaining to the document.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_DOCUMENT_TYPE
static String	SERIALIZED_NAME_DOWNLOAD_URL
static String	SERIALIZED_NAME_NAME
static String	SERIALIZED_NAME_STATUS

Constructor Summary

Constructors

Constructor and Description
CreditDocumentMetadata()

Method Summary

Modifier and Type	Method and Description
CreditDocumentMetadata	documentType(String documentType)
CreditDocumentMetadata	downloadUrl(String downloadUrl)
boolean	equals(Object o)
String	getDocumentType() The type of document.
String	getDownloadUrl() Signed URL to retrieve the underlying file.
String	getName() The name of the document.
String	getStatus() The processing status of the document.
int	hashCode()
CreditDocumentMetadata	name(String name)
void	setDocumentType(String documentType)
void	setDownloadUrl(String downloadUrl)
void	setName(String name)
void	setStatus(String status)
CreditDocumentMetadata	status(String status)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_NAME

public static final String SERIALIZED_NAME_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_DOCUMENT_TYPE

public static final String SERIALIZED_NAME_DOCUMENT_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_DOWNLOAD_URL

public static final String SERIALIZED_NAME_DOWNLOAD_URL

See Also:

Constant Field Values

SERIALIZED_NAME_STATUS

public static final String SERIALIZED_NAME_STATUS

See Also:

Constant Field Values

Constructor Detail

CreditDocumentMetadata

public CreditDocumentMetadata()

Method Detail

name

public CreditDocumentMetadata name(String name)

getName

public String getName()

The name of the document.

Returns:

name

setName

public void setName(String name)

documentType

public CreditDocumentMetadata documentType(String documentType)

getDocumentType

@Nullable
public String getDocumentType()

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.

Returns:

documentType

setDocumentType

public void setDocumentType(String documentType)

downloadUrl

public CreditDocumentMetadata downloadUrl(String downloadUrl)

getDownloadUrl

@Nullable
public String getDownloadUrl()

Signed URL to retrieve the underlying file.

Returns:

downloadUrl

setDownloadUrl

public void setDownloadUrl(String downloadUrl)

status

public CreditDocumentMetadata status(String status)

getStatus

@Nullable
public String getStatus()

The processing status of the document.

Returns:

status

setStatus

public void setStatus(String status)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object