Package com.onfido.model

Class ApplicantBuilder

java.lang.Object

com.onfido.model.ApplicantBuilder

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

ApplicantBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ApplicantBuilder.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_ADDRESS
static String	SERIALIZED_NAME_CONSENTS
static String	SERIALIZED_NAME_DOB
static String	SERIALIZED_NAME_EMAIL
static String	SERIALIZED_NAME_FIRST_NAME
static String	SERIALIZED_NAME_ID_NUMBERS
static String	SERIALIZED_NAME_LAST_NAME
static String	SERIALIZED_NAME_LOCATION
static String	SERIALIZED_NAME_PHONE_NUMBER

Constructor Summary

Constructors

Constructor	Description
ApplicantBuilder()

Method Summary

Modifier and Type	Method	Description
ApplicantBuilder	addConsentsItem(ApplicantConsentBuilder consentsItem)
ApplicantBuilder	addIdNumbersItem(IdNumber idNumbersItem)
ApplicantBuilder	address(AddressBuilder address)
ApplicantBuilder	consents(List<ApplicantConsentBuilder> consents)
ApplicantBuilder	dob(LocalDate dob)
ApplicantBuilder	email(String email)
boolean	equals(Object o)
ApplicantBuilder	firstName(String firstName)
static ApplicantBuilder	fromJson(String jsonString)	Create an instance of ApplicantBuilder 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.
AddressBuilder	getAddress()	Get address
List<ApplicantConsentBuilder>	getConsents()	The applicant's consents
LocalDate	getDob()	The applicant's date of birth
String	getEmail()	The applicant's email address.
String	getFirstName()	The applicant's first name
List<IdNumber>	getIdNumbers()	Get idNumbers
String	getLastName()	The applicant's surname
LocationBuilder	getLocation()	Get location
String	getPhoneNumber()	The applicant's phone number
int	hashCode()
ApplicantBuilder	idNumbers(List<IdNumber> idNumbers)
ApplicantBuilder	lastName(String lastName)
ApplicantBuilder	location(LocationBuilder location)
ApplicantBuilder	phoneNumber(String phoneNumber)
ApplicantBuilder	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
void	setAddress(AddressBuilder address)
void	setConsents(List<ApplicantConsentBuilder> consents)
void	setDob(LocalDate dob)
void	setEmail(String email)
void	setFirstName(String firstName)
void	setIdNumbers(List<IdNumber> idNumbers)
void	setLastName(String lastName)
void	setLocation(LocationBuilder location)
void	setPhoneNumber(String phoneNumber)
String	toJson()	Convert an instance of ApplicantBuilder 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

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_EMAIL

public static final String SERIALIZED_NAME_EMAIL

See Also:

Constant Field Values

SERIALIZED_NAME_DOB

public static final String SERIALIZED_NAME_DOB

See Also:

Constant Field Values

SERIALIZED_NAME_ID_NUMBERS

public static final String SERIALIZED_NAME_ID_NUMBERS

See Also:

Constant Field Values

SERIALIZED_NAME_PHONE_NUMBER

public static final String SERIALIZED_NAME_PHONE_NUMBER

See Also:

Constant Field Values

SERIALIZED_NAME_CONSENTS

public static final String SERIALIZED_NAME_CONSENTS

See Also:

Constant Field Values

SERIALIZED_NAME_ADDRESS

public static final String SERIALIZED_NAME_ADDRESS

See Also:

Constant Field Values

SERIALIZED_NAME_LOCATION

public static final String SERIALIZED_NAME_LOCATION

See Also:

Constant Field Values

SERIALIZED_NAME_FIRST_NAME

public static final String SERIALIZED_NAME_FIRST_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_LAST_NAME

public static final String SERIALIZED_NAME_LAST_NAME

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

ApplicantBuilder

public ApplicantBuilder()

Method Detail

email

public ApplicantBuilder email(String email)

getEmail

@Nullable
public String getEmail()

The applicant's email address. Required if doing a US check, or a UK check for which `applicant_provides_data` is `true`.

Returns:

email

setEmail

public void setEmail(String email)

dob

public ApplicantBuilder dob(LocalDate dob)

getDob

@Nullable
public LocalDate getDob()

The applicant's date of birth

Returns:

dob

setDob

public void setDob(LocalDate dob)

idNumbers

public ApplicantBuilder idNumbers(List<IdNumber> idNumbers)

addIdNumbersItem

public ApplicantBuilder addIdNumbersItem(IdNumber idNumbersItem)

getIdNumbers

@Nullable
public List<IdNumber> getIdNumbers()

Get idNumbers

Returns:

idNumbers

setIdNumbers

public void setIdNumbers(List<IdNumber> idNumbers)

phoneNumber

public ApplicantBuilder phoneNumber(String phoneNumber)

getPhoneNumber

@Nullable
public String getPhoneNumber()

The applicant's phone number

Returns:

phoneNumber

setPhoneNumber

public void setPhoneNumber(String phoneNumber)

consents

public ApplicantBuilder consents(List<ApplicantConsentBuilder> consents)

addConsentsItem

public ApplicantBuilder addConsentsItem(ApplicantConsentBuilder consentsItem)

getConsents

@Nullable
public List<ApplicantConsentBuilder> getConsents()

The applicant's consents

Returns:

consents

setConsents

public void setConsents(List<ApplicantConsentBuilder> consents)

address

public ApplicantBuilder address(AddressBuilder address)

getAddress

@Nullable
public AddressBuilder getAddress()

Get address

Returns:

address

setAddress

public void setAddress(AddressBuilder address)

location

public ApplicantBuilder location(LocationBuilder location)

getLocation

@Nullable
public LocationBuilder getLocation()

Get location

Returns:

location

setLocation

public void setLocation(LocationBuilder location)

firstName

public ApplicantBuilder firstName(String firstName)

getFirstName

@Nonnull
public String getFirstName()

The applicant's first name

Returns:

firstName

setFirstName

public void setFirstName(String firstName)

lastName

public ApplicantBuilder lastName(String lastName)

getLastName

@Nonnull
public String getLastName()

The applicant's surname

Returns:

lastName

setLastName

public void setLastName(String lastName)

putAdditionalProperty

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

fromJson

public static ApplicantBuilder fromJson(String jsonString)
                                 throws IOException

Create an instance of ApplicantBuilder given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of ApplicantBuilder

Throws:

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

toJson

public String toJson()

Convert an instance of ApplicantBuilder to an JSON string

Returns:

JSON string