Package com.onfido.model

Class DocumentShared

java.lang.Object

com.onfido.model.DocumentShared

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.9.0")
public class DocumentShared
extends Object

DocumentShared

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentShared.CustomTypeAdapterFactory
static class	DocumentShared.FileTypeEnum	The file type of the uploaded file
static class	DocumentShared.SideEnum	The side of the document, if applicable.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_APPLICANT_ID
static String	SERIALIZED_NAME_FILE_TYPE
static String	SERIALIZED_NAME_ISSUING_COUNTRY
static String	SERIALIZED_NAME_SIDE
static String	SERIALIZED_NAME_TYPE

Constructor Summary

Constructors

Constructor	Description
DocumentShared()

Method Summary

Modifier and Type	Method	Description
DocumentShared	applicantId(UUID applicantId)
boolean	equals(Object o)
DocumentShared	fileType(DocumentShared.FileTypeEnum fileType)
static DocumentShared	fromJson(String jsonString)	Create an instance of DocumentShared given an JSON string
Map<String,Object>	getAdditionalProperties()	Return the additional (undeclared) property.
Object	getAdditionalProperty(String key)	Return the additional (undeclared) property with the specified name.
UUID	getApplicantId()	The ID of the applicant whose document is being uploaded.
DocumentShared.FileTypeEnum	getFileType()	The file type of the uploaded file
CountryCodes	getIssuingCountry()	The issuing country of the document, a 3-letter ISO code.
DocumentShared.SideEnum	getSide()	The side of the document, if applicable.
DocumentTypes	getType()	The type of document
int	hashCode()
DocumentShared	issuingCountry(CountryCodes issuingCountry)
DocumentShared	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
void	setApplicantId(UUID applicantId)
void	setFileType(DocumentShared.FileTypeEnum fileType)
void	setIssuingCountry(CountryCodes issuingCountry)
void	setSide(DocumentShared.SideEnum side)
void	setType(DocumentTypes type)
DocumentShared	side(DocumentShared.SideEnum side)
String	toJson()	Convert an instance of DocumentShared to an JSON string
String	toString()
DocumentShared	type(DocumentTypes type)
static void	validateJsonElement(com.google.gson.JsonElement jsonElement)	Validates the JSON Element and throws an exception if issues found

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_FILE_TYPE

public static final String SERIALIZED_NAME_FILE_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_SIDE

public static final String SERIALIZED_NAME_SIDE

See Also:

Constant Field Values

SERIALIZED_NAME_ISSUING_COUNTRY

public static final String SERIALIZED_NAME_ISSUING_COUNTRY

See Also:

Constant Field Values

SERIALIZED_NAME_APPLICANT_ID

public static final String SERIALIZED_NAME_APPLICANT_ID

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

DocumentShared

public DocumentShared()

Method Detail

fileType

public DocumentShared fileType(DocumentShared.FileTypeEnum fileType)

getFileType

@Nullable
public DocumentShared.FileTypeEnum getFileType()

The file type of the uploaded file

Returns:

fileType

setFileType

public void setFileType(DocumentShared.FileTypeEnum fileType)

type

public DocumentShared type(DocumentTypes type)

getType

@Nullable
public DocumentTypes getType()

The type of document

Returns:

type

setType

public void setType(DocumentTypes type)

side

public DocumentShared side(DocumentShared.SideEnum side)

getSide

@Nullable
public DocumentShared.SideEnum getSide()

The side of the document, if applicable. The possible values are front and back

Returns:

side

setSide

public void setSide(DocumentShared.SideEnum side)

issuingCountry

public DocumentShared issuingCountry(CountryCodes issuingCountry)

getIssuingCountry

@Nullable
public CountryCodes getIssuingCountry()

The issuing country of the document, a 3-letter ISO code.

Returns:

issuingCountry

setIssuingCountry

public void setIssuingCountry(CountryCodes issuingCountry)

applicantId

public DocumentShared applicantId(UUID applicantId)

getApplicantId

@Nullable
public UUID getApplicantId()

The ID of the applicant whose document is being uploaded.

Returns:

applicantId

setApplicantId

public void setApplicantId(UUID applicantId)

putAdditionalProperty

public DocumentShared putAdditionalProperty(String key,
                                            Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - name of the property

value - value of the property

Returns:

the DocumentShared instance itself

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

a map of objects

getAdditionalProperty

public Object getAdditionalProperty(String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - name of the property

Returns:

an object

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

validateJsonElement

public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws IOException

Validates the JSON Element and throws an exception if issues found

Parameters:

jsonElement - JSON Element

Throws:

IOException - if the JSON Element is invalid with respect to DocumentShared

fromJson

public static DocumentShared fromJson(String jsonString)
                               throws IOException

Create an instance of DocumentShared given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of DocumentShared

Throws:

IOException - if the JSON string is invalid with respect to DocumentShared

toJson

public String toJson()

Convert an instance of DocumentShared to an JSON string

Returns:

JSON string