Package com.onfido.model

Class UsDrivingLicenceShared

java.lang.Object

com.onfido.model.UsDrivingLicenceShared

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

An object that contains all accepted fields for the Driver's License Data Verification report.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UsDrivingLicenceShared.CustomTypeAdapterFactory
static class	UsDrivingLicenceShared.DocumentCategoryEnum	Document category.
static class	UsDrivingLicenceShared.EyeColorCodeEnum	Eye color code.
static class	UsDrivingLicenceShared.GenderEnum	Gets or Sets gender

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_ADDRESS_LINE1
static String	SERIALIZED_NAME_ADDRESS_LINE2
static String	SERIALIZED_NAME_CITY
static String	SERIALIZED_NAME_DATE_OF_BIRTH
static String	SERIALIZED_NAME_DOCUMENT_CATEGORY
static String	SERIALIZED_NAME_EXPIRATION_DATE
static String	SERIALIZED_NAME_EYE_COLOR_CODE
static String	SERIALIZED_NAME_FIRST_NAME
static String	SERIALIZED_NAME_GENDER
static String	SERIALIZED_NAME_ID_NUMBER
static String	SERIALIZED_NAME_ISSUE_DATE
static String	SERIALIZED_NAME_ISSUE_STATE
static String	SERIALIZED_NAME_LAST_NAME
static String	SERIALIZED_NAME_MIDDLE_NAME
static String	SERIALIZED_NAME_NAME_SUFFIX
static String	SERIALIZED_NAME_POSTAL_CODE
static String	SERIALIZED_NAME_STATE
static String	SERIALIZED_NAME_WEIGHT_MEASURE

Constructor Summary

Constructors

Constructor	Description
UsDrivingLicenceShared()
UsDrivingLicenceShared(UsDrivingLicenceShared.GenderEnum gender)

Method Summary

Modifier and Type	Method	Description
UsDrivingLicenceShared	addressLine1(String addressLine1)
UsDrivingLicenceShared	addressLine2(String addressLine2)
UsDrivingLicenceShared	city(String city)
UsDrivingLicenceShared	dateOfBirth(LocalDate dateOfBirth)
UsDrivingLicenceShared	documentCategory(UsDrivingLicenceShared.DocumentCategoryEnum documentCategory)
boolean	equals(Object o)
UsDrivingLicenceShared	expirationDate(LocalDate expirationDate)
UsDrivingLicenceShared	eyeColorCode(UsDrivingLicenceShared.EyeColorCodeEnum eyeColorCode)
UsDrivingLicenceShared	firstName(String firstName)
static UsDrivingLicenceShared	fromJson(String jsonString)	Create an instance of UsDrivingLicenceShared 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.
String	getAddressLine1()	Line 1 of the address
String	getAddressLine2()	Line 2 of the address
String	getCity()	The city of the owner's address
LocalDate	getDateOfBirth()	Date of birth in yyyy-mm-dd format
UsDrivingLicenceShared.DocumentCategoryEnum	getDocumentCategory()	Document category.
LocalDate	getExpirationDate()	Expiration date of the driving licence in yyyy-mm-dd format
UsDrivingLicenceShared.EyeColorCodeEnum	getEyeColorCode()	Eye color code.
String	getFirstName()	The owner's first name
UsDrivingLicenceShared.GenderEnum	getGender()	Get gender
String	getIdNumber()	Driving licence ID number
LocalDate	getIssueDate()	Issue date in yyyy-mm-dd format
String	getIssueState()	Two letter code of issuing state (state-issued driving licenses only)
String	getLastName()	The owner's surname
String	getMiddleName()	The owner's middle name
String	getNameSuffix()	The owner's name suffix
String	getPostalCode()	The postcode or ZIP of the owner's address
String	getState()	2-characters state code
Integer	getWeightMeasure()	Weight in pounds
int	hashCode()
UsDrivingLicenceShared	idNumber(String idNumber)
UsDrivingLicenceShared	issueDate(LocalDate issueDate)
UsDrivingLicenceShared	issueState(String issueState)
UsDrivingLicenceShared	lastName(String lastName)
UsDrivingLicenceShared	middleName(String middleName)
UsDrivingLicenceShared	nameSuffix(String nameSuffix)
UsDrivingLicenceShared	postalCode(String postalCode)
UsDrivingLicenceShared	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
void	setAddressLine1(String addressLine1)
void	setAddressLine2(String addressLine2)
void	setCity(String city)
void	setDateOfBirth(LocalDate dateOfBirth)
void	setDocumentCategory(UsDrivingLicenceShared.DocumentCategoryEnum documentCategory)
void	setExpirationDate(LocalDate expirationDate)
void	setEyeColorCode(UsDrivingLicenceShared.EyeColorCodeEnum eyeColorCode)
void	setFirstName(String firstName)
void	setIdNumber(String idNumber)
void	setIssueDate(LocalDate issueDate)
void	setIssueState(String issueState)
void	setLastName(String lastName)
void	setMiddleName(String middleName)
void	setNameSuffix(String nameSuffix)
void	setPostalCode(String postalCode)
void	setState(String state)
void	setWeightMeasure(Integer weightMeasure)
UsDrivingLicenceShared	state(String state)
String	toJson()	Convert an instance of UsDrivingLicenceShared to an JSON string
String	toString()
static void	validateJsonElement(com.google.gson.JsonElement jsonElement)	Validates the JSON Element and throws an exception if issues found
UsDrivingLicenceShared	weightMeasure(Integer weightMeasure)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_ID_NUMBER

public static final String SERIALIZED_NAME_ID_NUMBER

See Also:

Constant Field Values

SERIALIZED_NAME_ISSUE_STATE

public static final String SERIALIZED_NAME_ISSUE_STATE

See Also:

Constant Field Values

SERIALIZED_NAME_ADDRESS_LINE1

public static final String SERIALIZED_NAME_ADDRESS_LINE1

See Also:

Constant Field Values

SERIALIZED_NAME_ADDRESS_LINE2

public static final String SERIALIZED_NAME_ADDRESS_LINE2

See Also:

Constant Field Values

SERIALIZED_NAME_CITY

public static final String SERIALIZED_NAME_CITY

See Also:

Constant Field Values

SERIALIZED_NAME_DATE_OF_BIRTH

public static final String SERIALIZED_NAME_DATE_OF_BIRTH

See Also:

Constant Field Values

SERIALIZED_NAME_DOCUMENT_CATEGORY

public static final String SERIALIZED_NAME_DOCUMENT_CATEGORY

See Also:

Constant Field Values

SERIALIZED_NAME_EXPIRATION_DATE

public static final String SERIALIZED_NAME_EXPIRATION_DATE

See Also:

Constant Field Values

SERIALIZED_NAME_EYE_COLOR_CODE

public static final String SERIALIZED_NAME_EYE_COLOR_CODE

See Also:

Constant Field Values

SERIALIZED_NAME_FIRST_NAME

public static final String SERIALIZED_NAME_FIRST_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_GENDER

public static final String SERIALIZED_NAME_GENDER

See Also:

Constant Field Values

SERIALIZED_NAME_ISSUE_DATE

public static final String SERIALIZED_NAME_ISSUE_DATE

See Also:

Constant Field Values

SERIALIZED_NAME_LAST_NAME

public static final String SERIALIZED_NAME_LAST_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_MIDDLE_NAME

public static final String SERIALIZED_NAME_MIDDLE_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_NAME_SUFFIX

public static final String SERIALIZED_NAME_NAME_SUFFIX

See Also:

Constant Field Values

SERIALIZED_NAME_POSTAL_CODE

public static final String SERIALIZED_NAME_POSTAL_CODE

See Also:

Constant Field Values

SERIALIZED_NAME_STATE

public static final String SERIALIZED_NAME_STATE

See Also:

Constant Field Values

SERIALIZED_NAME_WEIGHT_MEASURE

public static final String SERIALIZED_NAME_WEIGHT_MEASURE

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

UsDrivingLicenceShared

public UsDrivingLicenceShared()

UsDrivingLicenceShared

public UsDrivingLicenceShared(UsDrivingLicenceShared.GenderEnum gender)

Method Detail

idNumber

public UsDrivingLicenceShared idNumber(String idNumber)

getIdNumber

@Nonnull
public String getIdNumber()

Driving licence ID number

Returns:

idNumber

setIdNumber

public void setIdNumber(String idNumber)

issueState

public UsDrivingLicenceShared issueState(String issueState)

getIssueState

@Nonnull
public String getIssueState()

Two letter code of issuing state (state-issued driving licenses only)

Returns:

issueState

setIssueState

public void setIssueState(String issueState)

addressLine1

public UsDrivingLicenceShared addressLine1(String addressLine1)

getAddressLine1

@Nullable
public String getAddressLine1()

Line 1 of the address

Returns:

addressLine1

setAddressLine1

public void setAddressLine1(String addressLine1)

addressLine2

public UsDrivingLicenceShared addressLine2(String addressLine2)

getAddressLine2

@Nullable
public String getAddressLine2()

Line 2 of the address

Returns:

addressLine2

setAddressLine2

public void setAddressLine2(String addressLine2)

city

public UsDrivingLicenceShared city(String city)

getCity

@Nullable
public String getCity()

The city of the owner's address

Returns:

city

setCity

public void setCity(String city)

dateOfBirth

public UsDrivingLicenceShared dateOfBirth(LocalDate dateOfBirth)

getDateOfBirth

@Nullable
public LocalDate getDateOfBirth()

Date of birth in yyyy-mm-dd format

Returns:

dateOfBirth

setDateOfBirth

public void setDateOfBirth(LocalDate dateOfBirth)

documentCategory

public UsDrivingLicenceShared documentCategory(UsDrivingLicenceShared.DocumentCategoryEnum documentCategory)

getDocumentCategory

@Nullable
public UsDrivingLicenceShared.DocumentCategoryEnum getDocumentCategory()

Document category.

Returns:

documentCategory

setDocumentCategory

public void setDocumentCategory(UsDrivingLicenceShared.DocumentCategoryEnum documentCategory)

expirationDate

public UsDrivingLicenceShared expirationDate(LocalDate expirationDate)

getExpirationDate

@Nullable
public LocalDate getExpirationDate()

Expiration date of the driving licence in yyyy-mm-dd format

Returns:

expirationDate

setExpirationDate

public void setExpirationDate(LocalDate expirationDate)

eyeColorCode

public UsDrivingLicenceShared eyeColorCode(UsDrivingLicenceShared.EyeColorCodeEnum eyeColorCode)

getEyeColorCode

@Nullable
public UsDrivingLicenceShared.EyeColorCodeEnum getEyeColorCode()

Eye color code.

Returns:

eyeColorCode

setEyeColorCode

public void setEyeColorCode(UsDrivingLicenceShared.EyeColorCodeEnum eyeColorCode)

firstName

public UsDrivingLicenceShared firstName(String firstName)

getFirstName

@Nullable
public String getFirstName()

The owner's first name

Returns:

firstName

setFirstName

public void setFirstName(String firstName)

getGender

@Nullable
public UsDrivingLicenceShared.GenderEnum getGender()

Get gender

Returns:

gender

issueDate

public UsDrivingLicenceShared issueDate(LocalDate issueDate)

getIssueDate

@Nullable
public LocalDate getIssueDate()

Issue date in yyyy-mm-dd format

Returns:

issueDate

setIssueDate

public void setIssueDate(LocalDate issueDate)

lastName

public UsDrivingLicenceShared lastName(String lastName)

getLastName

@Nullable
public String getLastName()

The owner's surname

Returns:

lastName

setLastName

public void setLastName(String lastName)

middleName

public UsDrivingLicenceShared middleName(String middleName)

getMiddleName

@Nullable
public String getMiddleName()

The owner's middle name

Returns:

middleName

setMiddleName

public void setMiddleName(String middleName)

nameSuffix

public UsDrivingLicenceShared nameSuffix(String nameSuffix)

getNameSuffix

@Nullable
public String getNameSuffix()

The owner's name suffix

Returns:

nameSuffix

setNameSuffix

public void setNameSuffix(String nameSuffix)

postalCode

public UsDrivingLicenceShared postalCode(String postalCode)

getPostalCode

@Nullable
public String getPostalCode()

The postcode or ZIP of the owner's address

Returns:

postalCode

setPostalCode

public void setPostalCode(String postalCode)

state

public UsDrivingLicenceShared state(String state)

getState

@Nullable
public String getState()

2-characters state code

Returns:

state

setState

public void setState(String state)

weightMeasure

public UsDrivingLicenceShared weightMeasure(Integer weightMeasure)

getWeightMeasure

@Nullable
public Integer getWeightMeasure()

Weight in pounds

Returns:

weightMeasure

setWeightMeasure

public void setWeightMeasure(Integer weightMeasure)

putAdditionalProperty

public UsDrivingLicenceShared 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 UsDrivingLicenceShared 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 UsDrivingLicenceShared

fromJson

public static UsDrivingLicenceShared fromJson(String jsonString)
                                       throws IOException

Create an instance of UsDrivingLicenceShared given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of UsDrivingLicenceShared

Throws:

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

toJson

public String toJson()

Convert an instance of UsDrivingLicenceShared to an JSON string

Returns:

JSON string