Class Document
- java.lang.Object
-
- com.adyen.model.legalentitymanagement.Document
-
public class Document extends Object
Document
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDocument.CustomTypeAdapterFactorystatic classDocument.TypeEnumType of document, used when providing an ID number or uploading a document.
-
Field Summary
Fields Modifier and Type Field Description static HashSet<String>openapiFieldsstatic HashSet<String>openapiRequiredFieldsstatic StringSERIALIZED_NAME_ATTACHMENTstatic StringSERIALIZED_NAME_ATTACHMENTSstatic StringSERIALIZED_NAME_CREATION_DATEstatic StringSERIALIZED_NAME_DESCRIPTIONstatic StringSERIALIZED_NAME_EXPIRY_DATEstatic StringSERIALIZED_NAME_FILE_NAMEstatic StringSERIALIZED_NAME_IDstatic StringSERIALIZED_NAME_ISSUER_COUNTRYstatic StringSERIALIZED_NAME_ISSUER_STATEstatic StringSERIALIZED_NAME_MODIFICATION_DATEstatic StringSERIALIZED_NAME_NUMBERstatic StringSERIALIZED_NAME_OWNERstatic StringSERIALIZED_NAME_TYPE
-
Constructor Summary
Constructors Constructor Description Document()Document(OffsetDateTime creationDate, String id, OffsetDateTime modificationDate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description DocumentaddAttachmentsItem(Attachment attachmentsItem)Documentattachment(Attachment attachment)Documentattachments(List<Attachment> attachments)Documentdescription(String description)booleanequals(Object o)DocumentexpiryDate(String expiryDate)Deprecated.DocumentfileName(String fileName)static DocumentfromJson(String jsonString)Create an instance of Document given an JSON stringAttachmentgetAttachment()Get attachmentList<Attachment>getAttachments()Array that contains the document.OffsetDateTimegetCreationDate()The creation date of the document.StringgetDescription()Your description for the document.StringgetExpiryDate()Deprecated.StringgetFileName()The filename of the document.StringgetId()The unique identifier of the document.StringgetIssuerCountry()Deprecated.StringgetIssuerState()Deprecated.OffsetDateTimegetModificationDate()The modification date of the document.StringgetNumber()The number in the document.OwnerEntitygetOwner()Get ownerDocument.TypeEnumgetType()Type of document, used when providing an ID number or uploading a document.inthashCode()DocumentissuerCountry(String issuerCountry)Deprecated.DocumentissuerState(String issuerState)Deprecated.Documentnumber(String number)Documentowner(OwnerEntity owner)voidsetAttachment(Attachment attachment)voidsetAttachments(List<Attachment> attachments)voidsetDescription(String description)voidsetExpiryDate(String expiryDate)Deprecated.voidsetFileName(String fileName)voidsetIssuerCountry(String issuerCountry)Deprecated.voidsetIssuerState(String issuerState)Deprecated.voidsetNumber(String number)voidsetOwner(OwnerEntity owner)voidsetType(Document.TypeEnum type)StringtoJson()Convert an instance of Document to an JSON stringStringtoString()Documenttype(Document.TypeEnum type)static voidvalidateJsonObject(com.google.gson.JsonObject jsonObj)Validates the JSON Object and throws an exception if issues found
-
-
-
Field Detail
-
SERIALIZED_NAME_ATTACHMENT
public static final String SERIALIZED_NAME_ATTACHMENT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ATTACHMENTS
public static final String SERIALIZED_NAME_ATTACHMENTS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_CREATION_DATE
public static final String SERIALIZED_NAME_CREATION_DATE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DESCRIPTION
public static final String SERIALIZED_NAME_DESCRIPTION
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_EXPIRY_DATE
public static final String SERIALIZED_NAME_EXPIRY_DATE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_FILE_NAME
public static final String SERIALIZED_NAME_FILE_NAME
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ID
public static final String SERIALIZED_NAME_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ISSUER_COUNTRY
public static final String SERIALIZED_NAME_ISSUER_COUNTRY
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ISSUER_STATE
public static final String SERIALIZED_NAME_ISSUER_STATE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_MODIFICATION_DATE
public static final String SERIALIZED_NAME_MODIFICATION_DATE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_NUMBER
public static final String SERIALIZED_NAME_NUMBER
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_OWNER
public static final String SERIALIZED_NAME_OWNER
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TYPE
public static final String SERIALIZED_NAME_TYPE
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Document
public Document()
-
Document
public Document(OffsetDateTime creationDate, String id, OffsetDateTime modificationDate)
-
-
Method Detail
-
attachment
public Document attachment(Attachment attachment)
-
getAttachment
public Attachment getAttachment()
Get attachment- Returns:
- attachment
-
setAttachment
public void setAttachment(Attachment attachment)
-
attachments
public Document attachments(List<Attachment> attachments)
-
addAttachmentsItem
public Document addAttachmentsItem(Attachment attachmentsItem)
-
getAttachments
public List<Attachment> getAttachments()
Array that contains the document. The array supports multiple attachments for uploading different sides or pages of a document.- Returns:
- attachments
-
setAttachments
public void setAttachments(List<Attachment> attachments)
-
getCreationDate
public OffsetDateTime getCreationDate()
The creation date of the document.- Returns:
- creationDate
-
getDescription
public String getDescription()
Your description for the document.- Returns:
- description
-
setDescription
public void setDescription(String description)
-
expiryDate
@Deprecated public Document expiryDate(String expiryDate)
Deprecated.
-
getExpiryDate
@Deprecated public String getExpiryDate()
Deprecated.The expiry date of the document, in YYYY-MM-DD format.- Returns:
- expiryDate
-
setExpiryDate
@Deprecated public void setExpiryDate(String expiryDate)
Deprecated.
-
getFileName
public String getFileName()
The filename of the document.- Returns:
- fileName
-
setFileName
public void setFileName(String fileName)
-
getId
public String getId()
The unique identifier of the document.- Returns:
- id
-
issuerCountry
@Deprecated public Document issuerCountry(String issuerCountry)
Deprecated.
-
getIssuerCountry
@Deprecated public String getIssuerCountry()
Deprecated.The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the document was issued. For example, **US**.- Returns:
- issuerCountry
-
setIssuerCountry
@Deprecated public void setIssuerCountry(String issuerCountry)
Deprecated.
-
issuerState
@Deprecated public Document issuerState(String issuerState)
Deprecated.
-
getIssuerState
@Deprecated public String getIssuerState()
Deprecated.The state or province where the document was issued (AU only).- Returns:
- issuerState
-
setIssuerState
@Deprecated public void setIssuerState(String issuerState)
Deprecated.
-
getModificationDate
public OffsetDateTime getModificationDate()
The modification date of the document.- Returns:
- modificationDate
-
getNumber
public String getNumber()
The number in the document.- Returns:
- number
-
setNumber
public void setNumber(String number)
-
owner
public Document owner(OwnerEntity owner)
-
getOwner
public OwnerEntity getOwner()
Get owner- Returns:
- owner
-
setOwner
public void setOwner(OwnerEntity owner)
-
type
public Document type(Document.TypeEnum type)
-
getType
public Document.TypeEnum getType()
Type of document, used when providing an ID number or uploading a document. The possible values depend on the legal entity type. When providing ID numbers: * For **individual**, the `type` values can be **driversLicense**, **identityCard**, **nationalIdNumber**, or **passport**. When uploading photo IDs: * For **individual**, the `type` values can be **identityCard**, **driversLicense**, or **passport**. When uploading other documents: * For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**, or **proofOfIndustry**. * For **individual**, the `type` values can be **identityCard**, **driversLicense**, **passport**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**, or **proofOfIndividualTaxId**. * For **soleProprietorship**, the `type` values can be **constitutionalDocument**, **proofOfAddress**, or **proofOfIndustry**. * Use **bankStatement** to upload documents for a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).- Returns:
- type
-
setType
public void setType(Document.TypeEnum type)
-
validateJsonObject
public static void validateJsonObject(com.google.gson.JsonObject jsonObj) throws IOExceptionValidates the JSON Object and throws an exception if issues found- Parameters:
jsonObj- JSON Object- Throws:
IOException- if the JSON Object is invalid with respect to Document
-
fromJson
public static Document fromJson(String jsonString) throws IOException
Create an instance of Document given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of Document
- Throws:
IOException- if the JSON string is invalid with respect to Document
-
toJson
public String toJson()
Convert an instance of Document to an JSON string- Returns:
- JSON string
-
-