Package com.onfido.model
Class ProofOfAddressProperties
- java.lang.Object
-
- com.onfido.model.ProofOfAddressProperties
-
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.9.0") public class ProofOfAddressProperties extends Object
ProofOfAddressProperties
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classProofOfAddressProperties.CustomTypeAdapterFactorystatic classProofOfAddressProperties.DocumentTypeEnumThis property provides the document type according to the set of supported documents.
-
Field Summary
Fields Modifier and Type Field Description static HashSet<String>openapiFieldsstatic HashSet<String>openapiRequiredFieldsstatic StringSERIALIZED_NAME_ADDRESSstatic StringSERIALIZED_NAME_DOCUMENT_TYPEstatic StringSERIALIZED_NAME_FIRST_NAMESstatic StringSERIALIZED_NAME_ISSUE_DATEstatic StringSERIALIZED_NAME_ISSUERstatic StringSERIALIZED_NAME_LAST_NAMESstatic StringSERIALIZED_NAME_SUMMARY_PERIOD_ENDstatic StringSERIALIZED_NAME_SUMMARY_PERIOD_START
-
Constructor Summary
Constructors Constructor Description ProofOfAddressProperties()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ProofOfAddressPropertiesaddress(String address)ProofOfAddressPropertiesdocumentType(ProofOfAddressProperties.DocumentTypeEnum documentType)booleanequals(Object o)ProofOfAddressPropertiesfirstNames(String firstNames)static ProofOfAddressPropertiesfromJson(String jsonString)Create an instance of ProofOfAddressProperties given an JSON stringMap<String,Object>getAdditionalProperties()Return the additional (undeclared) property.ObjectgetAdditionalProperty(String key)Return the additional (undeclared) property with the specified name.StringgetAddress()This property provides the address on the document.ProofOfAddressProperties.DocumentTypeEnumgetDocumentType()This property provides the document type according to the set of supported documents.StringgetFirstNames()This property provides the first names on the document, including any initials and middle names.LocalDategetIssueDate()This property provides the issue date of the document.StringgetIssuer()This property provides the document issuer (e.g.StringgetLastNames()This property provided the last names on the document.LocalDategetSummaryPeriodEnd()This property provides the summary period end date.LocalDategetSummaryPeriodStart()This property provides the summary period start date.inthashCode()ProofOfAddressPropertiesissueDate(LocalDate issueDate)ProofOfAddressPropertiesissuer(String issuer)ProofOfAddressPropertieslastNames(String lastNames)ProofOfAddressPropertiesputAdditionalProperty(String key, Object value)Set the additional (undeclared) property with the specified name and value.voidsetAddress(String address)voidsetDocumentType(ProofOfAddressProperties.DocumentTypeEnum documentType)voidsetFirstNames(String firstNames)voidsetIssueDate(LocalDate issueDate)voidsetIssuer(String issuer)voidsetLastNames(String lastNames)voidsetSummaryPeriodEnd(LocalDate summaryPeriodEnd)voidsetSummaryPeriodStart(LocalDate summaryPeriodStart)ProofOfAddressPropertiessummaryPeriodEnd(LocalDate summaryPeriodEnd)ProofOfAddressPropertiessummaryPeriodStart(LocalDate summaryPeriodStart)StringtoJson()Convert an instance of ProofOfAddressProperties to an JSON stringStringtoString()static voidvalidateJsonElement(com.google.gson.JsonElement jsonElement)Validates the JSON Element and throws an exception if issues found
-
-
-
Field Detail
-
SERIALIZED_NAME_ADDRESS
public static final String SERIALIZED_NAME_ADDRESS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DOCUMENT_TYPE
public static final String SERIALIZED_NAME_DOCUMENT_TYPE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_FIRST_NAMES
public static final String SERIALIZED_NAME_FIRST_NAMES
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_LAST_NAMES
public static final String SERIALIZED_NAME_LAST_NAMES
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ISSUE_DATE
public static final String SERIALIZED_NAME_ISSUE_DATE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ISSUER
public static final String SERIALIZED_NAME_ISSUER
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_SUMMARY_PERIOD_START
public static final String SERIALIZED_NAME_SUMMARY_PERIOD_START
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_SUMMARY_PERIOD_END
public static final String SERIALIZED_NAME_SUMMARY_PERIOD_END
- See Also:
- Constant Field Values
-
-
Method Detail
-
address
public ProofOfAddressProperties address(String address)
-
getAddress
@Nullable public String getAddress()
This property provides the address on the document.- Returns:
- address
-
setAddress
public void setAddress(String address)
-
documentType
public ProofOfAddressProperties documentType(ProofOfAddressProperties.DocumentTypeEnum documentType)
-
getDocumentType
@Nullable public ProofOfAddressProperties.DocumentTypeEnum getDocumentType()
This property provides the document type according to the set of supported documents.- Returns:
- documentType
-
setDocumentType
public void setDocumentType(ProofOfAddressProperties.DocumentTypeEnum documentType)
-
firstNames
public ProofOfAddressProperties firstNames(String firstNames)
-
getFirstNames
@Nullable public String getFirstNames()
This property provides the first names on the document, including any initials and middle names.- Returns:
- firstNames
-
setFirstNames
public void setFirstNames(String firstNames)
-
lastNames
public ProofOfAddressProperties lastNames(String lastNames)
-
getLastNames
@Nullable public String getLastNames()
This property provided the last names on the document.- Returns:
- lastNames
-
setLastNames
public void setLastNames(String lastNames)
-
issueDate
public ProofOfAddressProperties issueDate(LocalDate issueDate)
-
getIssueDate
@Nullable public LocalDate getIssueDate()
This property provides the issue date of the document.- Returns:
- issueDate
-
setIssueDate
public void setIssueDate(LocalDate issueDate)
-
issuer
public ProofOfAddressProperties issuer(String issuer)
-
getIssuer
@Nullable public String getIssuer()
This property provides the document issuer (e.g. HSBC, British Gas).- Returns:
- issuer
-
setIssuer
public void setIssuer(String issuer)
-
summaryPeriodStart
public ProofOfAddressProperties summaryPeriodStart(LocalDate summaryPeriodStart)
-
getSummaryPeriodStart
@Nullable public LocalDate getSummaryPeriodStart()
This property provides the summary period start date.- Returns:
- summaryPeriodStart
-
setSummaryPeriodStart
public void setSummaryPeriodStart(LocalDate summaryPeriodStart)
-
summaryPeriodEnd
public ProofOfAddressProperties summaryPeriodEnd(LocalDate summaryPeriodEnd)
-
getSummaryPeriodEnd
@Nullable public LocalDate getSummaryPeriodEnd()
This property provides the summary period end date.- Returns:
- summaryPeriodEnd
-
setSummaryPeriodEnd
public void setSummaryPeriodEnd(LocalDate summaryPeriodEnd)
-
putAdditionalProperty
public ProofOfAddressProperties 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 propertyvalue- value of the property- Returns:
- the ProofOfAddressProperties 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
-
validateJsonElement
public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOExceptionValidates 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 ProofOfAddressProperties
-
fromJson
public static ProofOfAddressProperties fromJson(String jsonString) throws IOException
Create an instance of ProofOfAddressProperties given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of ProofOfAddressProperties
- Throws:
IOException- if the JSON string is invalid with respect to ProofOfAddressProperties
-
toJson
public String toJson()
Convert an instance of ProofOfAddressProperties to an JSON string- Returns:
- JSON string
-
-