Class DocumentSigner

java.lang.Object

com.boldsign.model.DocumentSigner

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

DocumentSigner

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DocumentSigner.AuthenticationTypeEnum	Gets or Sets authenticationType
static class	DocumentSigner.CustomTypeAdapterFactory
static enum	DocumentSigner.DeliveryModeEnum	Gets or Sets deliveryMode
static enum	DocumentSigner.LanguageEnum	<p>Description:</p><ul><li><i>0</i> - None</li><li><i>1</i> - English</li><li><i>2</i> - Spanish</li><li><i>3</i> - German</li><li><i>4</i> - French</li><li><i>5</i> - Romanian</li><li><i>6</i> - Norwegian</li><li><i>7</i> - Bulgarian</li><li><i>8</i> - Italian</li><li><i>9</i> - Danish</li><li><i>10</i> - Polish</li><li><i>11</i> - Portuguese</li><li><i>12</i> - Czech</li><li><i>13</i> - Dutch</li><li><i>14</i> - Swedish</li><li><i>15</i> - Russian</li></ul>
static enum	DocumentSigner.LocaleEnum	Gets or Sets locale
static enum	DocumentSigner.SignerTypeEnum	Gets or Sets signerType

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_ALLOW_FIELD_CONFIGURATION
static final String	SERIALIZED_NAME_AUTHENTICATION_CODE
static final String	SERIALIZED_NAME_AUTHENTICATION_RETRY_COUNT
static final String	SERIALIZED_NAME_AUTHENTICATION_TYPE
static final String	SERIALIZED_NAME_DELIVERY_MODE
static final String	SERIALIZED_NAME_EMAIL_ADDRESS
static final String	SERIALIZED_NAME_ENABLE_EMAIL_O_T_P
static final String	SERIALIZED_NAME_FORM_FIELDS
static final String	SERIALIZED_NAME_HOST_EMAIL
static final String	SERIALIZED_NAME_IDENTITY_VERIFICATION_SETTINGS
static final String	SERIALIZED_NAME_LANGUAGE
static final String	SERIALIZED_NAME_LOCALE
static final String	SERIALIZED_NAME_NAME
static final String	SERIALIZED_NAME_PHONE_NUMBER
static final String	SERIALIZED_NAME_PRIVATE_MESSAGE
static final String	SERIALIZED_NAME_SIGNER_ORDER
static final String	SERIALIZED_NAME_SIGNER_ROLE
static final String	SERIALIZED_NAME_SIGNER_TYPE

Constructor Summary

Constructors

Constructor	Description
DocumentSigner()

Method Summary

Modifier and Type	Method	Description
DocumentSigner	addFormFieldsItem(FormField formFieldsItem)
DocumentSigner	allowFieldConfiguration(Boolean allowFieldConfiguration)
DocumentSigner	authenticationCode(String authenticationCode)
DocumentSigner	authenticationRetryCount(Integer authenticationRetryCount)
DocumentSigner	authenticationType(DocumentSigner.AuthenticationTypeEnum authenticationType)
Map<String,Object>	createFormData()
DocumentSigner	deliveryMode(DocumentSigner.DeliveryModeEnum deliveryMode)
DocumentSigner	emailAddress(String emailAddress)
DocumentSigner	enableEmailOTP(Boolean enableEmailOTP)
boolean	equals(Object o)
DocumentSigner	formFields(List<FormField> formFields)
static DocumentSigner	fromJson(String jsonString)	Create an instance of DocumentSigner given an JSON string
Boolean	getAllowFieldConfiguration()	Get allowFieldConfiguration
String	getAuthenticationCode()	Get authenticationCode
Integer	getAuthenticationRetryCount()	Get authenticationRetryCount minimum: 1 maximum: 10
DocumentSigner.AuthenticationTypeEnum	getAuthenticationType()	Get authenticationType
DocumentSigner.DeliveryModeEnum	getDeliveryMode()	Get deliveryMode
String	getEmailAddress()	Get emailAddress
Boolean	getEnableEmailOTP()	Get enableEmailOTP
List<FormField>	getFormFields()	Get formFields
String	getHostEmail()	Get hostEmail
IdentityVerificationSettings	getIdentityVerificationSettings()	Get identityVerificationSettings
DocumentSigner.LanguageEnum	getLanguage()	<p>Description:</p><ul><li><i>0</i> - None</li><li><i>1</i> - English</li><li><i>2</i> - Spanish</li><li><i>3</i> - German</li><li><i>4</i> - French</li><li><i>5</i> - Romanian</li><li><i>6</i> - Norwegian</li><li><i>7</i> - Bulgarian</li><li><i>8</i> - Italian</li><li><i>9</i> - Danish</li><li><i>10</i> - Polish</li><li><i>11</i> - Portuguese</li><li><i>12</i> - Czech</li><li><i>13</i> - Dutch</li><li><i>14</i> - Swedish</li><li><i>15</i> - Russian</li></ul>
DocumentSigner.LocaleEnum	getLocale()	Get locale
String	getName()	Get name
PhoneNumber	getPhoneNumber()	Get phoneNumber
String	getPrivateMessage()	Get privateMessage
Integer	getSignerOrder()	Get signerOrder
String	getSignerRole()	Get signerRole
DocumentSigner.SignerTypeEnum	getSignerType()	Get signerType
int	hashCode()
DocumentSigner	hostEmail(String hostEmail)
DocumentSigner	identityVerificationSettings(IdentityVerificationSettings identityVerificationSettings)
DocumentSigner	language(DocumentSigner.LanguageEnum language)
DocumentSigner	locale(DocumentSigner.LocaleEnum locale)
DocumentSigner	name(String name)
DocumentSigner	phoneNumber(PhoneNumber phoneNumber)
DocumentSigner	privateMessage(String privateMessage)
void	setAllowFieldConfiguration(Boolean allowFieldConfiguration)
void	setAuthenticationCode(String authenticationCode)
void	setAuthenticationRetryCount(Integer authenticationRetryCount)
void	setAuthenticationType(DocumentSigner.AuthenticationTypeEnum authenticationType)
void	setDeliveryMode(DocumentSigner.DeliveryModeEnum deliveryMode)
void	setEmailAddress(String emailAddress)
void	setEnableEmailOTP(Boolean enableEmailOTP)
void	setFormFields(List<FormField> formFields)
void	setHostEmail(String hostEmail)
void	setIdentityVerificationSettings(IdentityVerificationSettings identityVerificationSettings)
void	setLanguage(DocumentSigner.LanguageEnum language)
void	setLocale(DocumentSigner.LocaleEnum locale)
void	setName(String name)
void	setPhoneNumber(PhoneNumber phoneNumber)
void	setPrivateMessage(String privateMessage)
void	setSignerOrder(Integer signerOrder)
void	setSignerRole(String signerRole)
void	setSignerType(DocumentSigner.SignerTypeEnum signerType)
DocumentSigner	signerOrder(Integer signerOrder)
DocumentSigner	signerRole(String signerRole)
DocumentSigner	signerType(DocumentSigner.SignerTypeEnum signerType)
String	toJson()	Convert an instance of DocumentSigner 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 Details

SERIALIZED_NAME_NAME

public static final String SERIALIZED_NAME_NAME

See Also:

• Constant Field Values

SERIALIZED_NAME_EMAIL_ADDRESS

public static final String SERIALIZED_NAME_EMAIL_ADDRESS

See Also:

• Constant Field Values

SERIALIZED_NAME_PRIVATE_MESSAGE

public static final String SERIALIZED_NAME_PRIVATE_MESSAGE

See Also:

• Constant Field Values

SERIALIZED_NAME_AUTHENTICATION_TYPE

public static final String SERIALIZED_NAME_AUTHENTICATION_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_PHONE_NUMBER

public static final String SERIALIZED_NAME_PHONE_NUMBER

See Also:

• Constant Field Values

SERIALIZED_NAME_DELIVERY_MODE

public static final String SERIALIZED_NAME_DELIVERY_MODE

See Also:

• Constant Field Values

SERIALIZED_NAME_AUTHENTICATION_CODE

public static final String SERIALIZED_NAME_AUTHENTICATION_CODE

See Also:

• Constant Field Values

SERIALIZED_NAME_IDENTITY_VERIFICATION_SETTINGS

public static final String SERIALIZED_NAME_IDENTITY_VERIFICATION_SETTINGS

See Also:

• Constant Field Values

SERIALIZED_NAME_SIGNER_ORDER

public static final String SERIALIZED_NAME_SIGNER_ORDER

See Also:

• Constant Field Values

SERIALIZED_NAME_ENABLE_EMAIL_O_T_P

public static final String SERIALIZED_NAME_ENABLE_EMAIL_O_T_P

See Also:

• Constant Field Values

SERIALIZED_NAME_SIGNER_TYPE

public static final String SERIALIZED_NAME_SIGNER_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_HOST_EMAIL

public static final String SERIALIZED_NAME_HOST_EMAIL

See Also:

• Constant Field Values

SERIALIZED_NAME_SIGNER_ROLE

public static final String SERIALIZED_NAME_SIGNER_ROLE

See Also:

• Constant Field Values

SERIALIZED_NAME_ALLOW_FIELD_CONFIGURATION

public static final String SERIALIZED_NAME_ALLOW_FIELD_CONFIGURATION

See Also:

• Constant Field Values

SERIALIZED_NAME_FORM_FIELDS

public static final String SERIALIZED_NAME_FORM_FIELDS

See Also:

• Constant Field Values

SERIALIZED_NAME_LANGUAGE

public static final String SERIALIZED_NAME_LANGUAGE

See Also:

• Constant Field Values

SERIALIZED_NAME_LOCALE

public static final String SERIALIZED_NAME_LOCALE

See Also:

• Constant Field Values

SERIALIZED_NAME_AUTHENTICATION_RETRY_COUNT

public static final String SERIALIZED_NAME_AUTHENTICATION_RETRY_COUNT

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

DocumentSigner

public DocumentSigner()

Method Details

name

public DocumentSigner name(String name)

getName

@Nonnull
public String getName()

Get name

Returns:

name

setName

public void setName(String name)

emailAddress

public DocumentSigner emailAddress(String emailAddress)

getEmailAddress

@Nullable
public String getEmailAddress()

Get emailAddress

Returns:

emailAddress

setEmailAddress

public void setEmailAddress(String emailAddress)

privateMessage

public DocumentSigner privateMessage(String privateMessage)

getPrivateMessage

@Nullable
public String getPrivateMessage()

Get privateMessage

Returns:

privateMessage

setPrivateMessage

public void setPrivateMessage(String privateMessage)

authenticationType

public DocumentSigner authenticationType(DocumentSigner.AuthenticationTypeEnum authenticationType)

getAuthenticationType

@Nullable
public DocumentSigner.AuthenticationTypeEnum getAuthenticationType()

Get authenticationType

Returns:

authenticationType

setAuthenticationType

public void setAuthenticationType(DocumentSigner.AuthenticationTypeEnum authenticationType)

phoneNumber

public DocumentSigner phoneNumber(PhoneNumber phoneNumber)

getPhoneNumber

@Nullable
public PhoneNumber getPhoneNumber()

Get phoneNumber

Returns:

phoneNumber

setPhoneNumber

public void setPhoneNumber(PhoneNumber phoneNumber)

deliveryMode

public DocumentSigner deliveryMode(DocumentSigner.DeliveryModeEnum deliveryMode)

getDeliveryMode

@Nullable
public DocumentSigner.DeliveryModeEnum getDeliveryMode()

Get deliveryMode

Returns:

deliveryMode

setDeliveryMode

public void setDeliveryMode(DocumentSigner.DeliveryModeEnum deliveryMode)

authenticationCode

public DocumentSigner authenticationCode(String authenticationCode)

getAuthenticationCode

@Nullable
public String getAuthenticationCode()

Get authenticationCode

Returns:

authenticationCode

setAuthenticationCode

public void setAuthenticationCode(String authenticationCode)

identityVerificationSettings

public DocumentSigner identityVerificationSettings(IdentityVerificationSettings identityVerificationSettings)

getIdentityVerificationSettings

@Nullable
public IdentityVerificationSettings getIdentityVerificationSettings()

Get identityVerificationSettings

Returns:

identityVerificationSettings

setIdentityVerificationSettings

public void setIdentityVerificationSettings(IdentityVerificationSettings identityVerificationSettings)

signerOrder

public DocumentSigner signerOrder(Integer signerOrder)

getSignerOrder

@Nullable
public Integer getSignerOrder()

Get signerOrder

Returns:

signerOrder

setSignerOrder

public void setSignerOrder(Integer signerOrder)

enableEmailOTP

public DocumentSigner enableEmailOTP(Boolean enableEmailOTP)

getEnableEmailOTP

@Nullable
public Boolean getEnableEmailOTP()

Get enableEmailOTP

Returns:

enableEmailOTP

setEnableEmailOTP

public void setEnableEmailOTP(Boolean enableEmailOTP)

signerType

public DocumentSigner signerType(DocumentSigner.SignerTypeEnum signerType)

getSignerType

@Nullable
public DocumentSigner.SignerTypeEnum getSignerType()

Get signerType

Returns:

signerType

setSignerType

public void setSignerType(DocumentSigner.SignerTypeEnum signerType)

hostEmail

public DocumentSigner hostEmail(String hostEmail)

getHostEmail

@Nullable
public String getHostEmail()

Get hostEmail

Returns:

hostEmail

setHostEmail

public void setHostEmail(String hostEmail)

signerRole

public DocumentSigner signerRole(String signerRole)

getSignerRole

@Nullable
public String getSignerRole()

Get signerRole

Returns:

signerRole

setSignerRole

public void setSignerRole(String signerRole)

allowFieldConfiguration

public DocumentSigner allowFieldConfiguration(Boolean allowFieldConfiguration)

getAllowFieldConfiguration

@Nullable
public Boolean getAllowFieldConfiguration()

Get allowFieldConfiguration

Returns:

allowFieldConfiguration

setAllowFieldConfiguration

public void setAllowFieldConfiguration(Boolean allowFieldConfiguration)

formFields

public DocumentSigner formFields(List<FormField> formFields)

addFormFieldsItem

public DocumentSigner addFormFieldsItem(FormField formFieldsItem)

getFormFields

@Nullable
public List<FormField> getFormFields()

Get formFields

Returns:

formFields

setFormFields

public void setFormFields(List<FormField> formFields)

language

public DocumentSigner language(DocumentSigner.LanguageEnum language)

getLanguage

@Nullable
public DocumentSigner.LanguageEnum getLanguage()

<p>Description:</p><ul><li><i>0</i> - None</li><li><i>1</i> - English</li><li><i>2</i> - Spanish</li><li><i>3</i> - German</li><li><i>4</i> - French</li><li><i>5</i> - Romanian</li><li><i>6</i> - Norwegian</li><li><i>7</i> - Bulgarian</li><li><i>8</i> - Italian</li><li><i>9</i> - Danish</li><li><i>10</i> - Polish</li><li><i>11</i> - Portuguese</li><li><i>12</i> - Czech</li><li><i>13</i> - Dutch</li><li><i>14</i> - Swedish</li><li><i>15</i> - Russian</li></ul>

Returns:

language

setLanguage

public void setLanguage(DocumentSigner.LanguageEnum language)

locale

public DocumentSigner locale(DocumentSigner.LocaleEnum locale)

getLocale

@Nullable
public DocumentSigner.LocaleEnum getLocale()

Get locale

Returns:

locale

setLocale

public void setLocale(DocumentSigner.LocaleEnum locale)

authenticationRetryCount

public DocumentSigner authenticationRetryCount(Integer authenticationRetryCount)

getAuthenticationRetryCount

@Nullable
public Integer getAuthenticationRetryCount()

Get authenticationRetryCount minimum: 1 maximum: 10

Returns:

authenticationRetryCount

setAuthenticationRetryCount

public void setAuthenticationRetryCount(Integer authenticationRetryCount)

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

createFormData

public Map<String,Object> createFormData()
                                  throws ApiException

Throws:

ApiException

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 DocumentSigner

fromJson

public static DocumentSigner fromJson(String jsonString)
                               throws IOException

Create an instance of DocumentSigner given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of DocumentSigner

Throws:

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

toJson

public String toJson()

Convert an instance of DocumentSigner to an JSON string

Returns:

JSON string