Package com.boldsign.model

Class EditDocumentSigner

java.lang.Object

com.boldsign.model.EditDocumentSigner

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

EditDocumentSigner

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EditDocumentSigner.AuthenticationTypeEnum	Gets or Sets authenticationType
static class	EditDocumentSigner.CustomTypeAdapterFactory
static class	EditDocumentSigner.DeliveryModeEnum	Gets or Sets deliveryMode
static class	EditDocumentSigner.EditActionEnum	Gets or Sets editAction
static class	EditDocumentSigner.LanguageEnum	Gets or Sets language
static class	EditDocumentSigner.LocaleEnum	Gets or Sets locale
static class	EditDocumentSigner.SignerTypeEnum	Gets or Sets signerType
static class	EditDocumentSigner.SignTypeEnum	Gets or Sets signType

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_ALLOW_FIELD_CONFIGURATION
static String	SERIALIZED_NAME_AUTHENTICATION_CODE
static String	SERIALIZED_NAME_AUTHENTICATION_RETRY_COUNT
static String	SERIALIZED_NAME_AUTHENTICATION_SETTINGS
static String	SERIALIZED_NAME_AUTHENTICATION_TYPE
static String	SERIALIZED_NAME_DELIVERY_MODE
static String	SERIALIZED_NAME_EDIT_ACTION
static String	SERIALIZED_NAME_EMAIL_ADDRESS
static String	SERIALIZED_NAME_ENABLE_EMAIL_O_T_P
static String	SERIALIZED_NAME_ENABLE_QES
static String	SERIALIZED_NAME_FORM_FIELDS
static String	SERIALIZED_NAME_GROUP_ID
static String	SERIALIZED_NAME_HOST_EMAIL
static String	SERIALIZED_NAME_ID
static String	SERIALIZED_NAME_IDENTITY_VERIFICATION_SETTINGS
static String	SERIALIZED_NAME_LANGUAGE
static String	SERIALIZED_NAME_LOCALE
static String	SERIALIZED_NAME_NAME
static String	SERIALIZED_NAME_PHONE_NUMBER
static String	SERIALIZED_NAME_PRIVATE_MESSAGE
static String	SERIALIZED_NAME_RECIPIENT_NOTIFICATION_SETTINGS
static String	SERIALIZED_NAME_SIGN_TYPE
static String	SERIALIZED_NAME_SIGNER_ORDER
static String	SERIALIZED_NAME_SIGNER_ROLE
static String	SERIALIZED_NAME_SIGNER_TYPE

Constructor Summary

Constructors

Constructor	Description
EditDocumentSigner()

Method Summary

Modifier and Type	Method	Description
EditDocumentSigner	addFormFieldsItem(EditFormField formFieldsItem)
EditDocumentSigner	allowFieldConfiguration(Boolean allowFieldConfiguration)
EditDocumentSigner	authenticationCode(String authenticationCode)
EditDocumentSigner	authenticationRetryCount(Integer authenticationRetryCount)
EditDocumentSigner	authenticationSettings(AuthenticationSettings authenticationSettings)
EditDocumentSigner	authenticationType(EditDocumentSigner.AuthenticationTypeEnum authenticationType)
Map<String,Object>	createFormData()
EditDocumentSigner	deliveryMode(EditDocumentSigner.DeliveryModeEnum deliveryMode)
EditDocumentSigner	editAction(EditDocumentSigner.EditActionEnum editAction)
EditDocumentSigner	emailAddress(String emailAddress)
EditDocumentSigner	enableEmailOTP(Boolean enableEmailOTP)
EditDocumentSigner	enableQes(Boolean enableQes)
boolean	equals(Object o)
EditDocumentSigner	formFields(List<EditFormField> formFields)
static EditDocumentSigner	fromJson(String jsonString)	Create an instance of EditDocumentSigner given an JSON string
Boolean	getAllowFieldConfiguration()	Get allowFieldConfiguration
String	getAuthenticationCode()	Get authenticationCode
Integer	getAuthenticationRetryCount()	Get authenticationRetryCount minimum: 1 maximum: 10
AuthenticationSettings	getAuthenticationSettings()	Get authenticationSettings
EditDocumentSigner.AuthenticationTypeEnum	getAuthenticationType()	Get authenticationType
EditDocumentSigner.DeliveryModeEnum	getDeliveryMode()	Get deliveryMode
EditDocumentSigner.EditActionEnum	getEditAction()	Get editAction
String	getEmailAddress()	Get emailAddress
Boolean	getEnableEmailOTP()	Get enableEmailOTP
Boolean	getEnableQes()	Get enableQes
List<EditFormField>	getFormFields()	Get formFields
String	getGroupId()	Get groupId
String	getHostEmail()	Get hostEmail
String	getId()	Get id
IdentityVerificationSettings	getIdentityVerificationSettings()	Get identityVerificationSettings
EditDocumentSigner.LanguageEnum	getLanguage()	Get language
EditDocumentSigner.LocaleEnum	getLocale()	Get locale
String	getName()	Get name
PhoneNumber	getPhoneNumber()	Get phoneNumber
String	getPrivateMessage()	Get privateMessage
RecipientNotificationSettings	getRecipientNotificationSettings()	Get recipientNotificationSettings
Integer	getSignerOrder()	Get signerOrder
String	getSignerRole()	Get signerRole
EditDocumentSigner.SignerTypeEnum	getSignerType()	Get signerType
EditDocumentSigner.SignTypeEnum	getSignType()	Get signType
EditDocumentSigner	groupId(String groupId)
int	hashCode()
EditDocumentSigner	hostEmail(String hostEmail)
EditDocumentSigner	id(String id)
EditDocumentSigner	identityVerificationSettings(IdentityVerificationSettings identityVerificationSettings)
EditDocumentSigner	language(EditDocumentSigner.LanguageEnum language)
EditDocumentSigner	locale(EditDocumentSigner.LocaleEnum locale)
EditDocumentSigner	name(String name)
EditDocumentSigner	phoneNumber(PhoneNumber phoneNumber)
EditDocumentSigner	privateMessage(String privateMessage)
EditDocumentSigner	recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)
void	setAllowFieldConfiguration(Boolean allowFieldConfiguration)
void	setAuthenticationCode(String authenticationCode)
void	setAuthenticationRetryCount(Integer authenticationRetryCount)
void	setAuthenticationSettings(AuthenticationSettings authenticationSettings)
void	setAuthenticationType(EditDocumentSigner.AuthenticationTypeEnum authenticationType)
void	setDeliveryMode(EditDocumentSigner.DeliveryModeEnum deliveryMode)
void	setEditAction(EditDocumentSigner.EditActionEnum editAction)
void	setEmailAddress(String emailAddress)
void	setEnableEmailOTP(Boolean enableEmailOTP)
void	setEnableQes(Boolean enableQes)
void	setFormFields(List<EditFormField> formFields)
void	setGroupId(String groupId)
void	setHostEmail(String hostEmail)
void	setId(String id)
void	setIdentityVerificationSettings(IdentityVerificationSettings identityVerificationSettings)
void	setLanguage(EditDocumentSigner.LanguageEnum language)
void	setLocale(EditDocumentSigner.LocaleEnum locale)
void	setName(String name)
void	setPhoneNumber(PhoneNumber phoneNumber)
void	setPrivateMessage(String privateMessage)
void	setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)
void	setSignerOrder(Integer signerOrder)
void	setSignerRole(String signerRole)
void	setSignerType(EditDocumentSigner.SignerTypeEnum signerType)
void	setSignType(EditDocumentSigner.SignTypeEnum signType)
EditDocumentSigner	signerOrder(Integer signerOrder)
EditDocumentSigner	signerRole(String signerRole)
EditDocumentSigner	signerType(EditDocumentSigner.SignerTypeEnum signerType)
EditDocumentSigner	signType(EditDocumentSigner.SignTypeEnum signType)
String	toJson()	Convert an instance of EditDocumentSigner 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_EDIT_ACTION

public static final String SERIALIZED_NAME_EDIT_ACTION

See Also:

Constant Field Values

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

Constant Field Values

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_SIGN_TYPE

public static final String SERIALIZED_NAME_SIGN_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_GROUP_ID

public static final String SERIALIZED_NAME_GROUP_ID

See Also:

Constant Field Values

SERIALIZED_NAME_RECIPIENT_NOTIFICATION_SETTINGS

public static final String SERIALIZED_NAME_RECIPIENT_NOTIFICATION_SETTINGS

See Also:

Constant Field Values

SERIALIZED_NAME_AUTHENTICATION_RETRY_COUNT

public static final String SERIALIZED_NAME_AUTHENTICATION_RETRY_COUNT

See Also:

Constant Field Values

SERIALIZED_NAME_ENABLE_QES

public static final String SERIALIZED_NAME_ENABLE_QES

See Also:

Constant Field Values

SERIALIZED_NAME_AUTHENTICATION_SETTINGS

public static final String SERIALIZED_NAME_AUTHENTICATION_SETTINGS

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

EditDocumentSigner

public EditDocumentSigner()

Method Detail

editAction

public EditDocumentSigner editAction(EditDocumentSigner.EditActionEnum editAction)

getEditAction

@Nonnull
public EditDocumentSigner.EditActionEnum getEditAction()

Get editAction

Returns:

editAction

setEditAction

public void setEditAction(EditDocumentSigner.EditActionEnum editAction)

id

public EditDocumentSigner id(String id)

getId

@Nullable
public String getId()

Get id

Returns:

id

setId

public void setId(String id)

name

public EditDocumentSigner name(String name)

getName

@Nullable
public String getName()

Get name

Returns:

name

setName

public void setName(String name)

emailAddress

public EditDocumentSigner emailAddress(String emailAddress)

getEmailAddress

@Nullable
public String getEmailAddress()

Get emailAddress

Returns:

emailAddress

setEmailAddress

public void setEmailAddress(String emailAddress)

privateMessage

public EditDocumentSigner privateMessage(String privateMessage)

getPrivateMessage

@Nullable
public String getPrivateMessage()

Get privateMessage

Returns:

privateMessage

setPrivateMessage

public void setPrivateMessage(String privateMessage)

authenticationType

public EditDocumentSigner authenticationType(EditDocumentSigner.AuthenticationTypeEnum authenticationType)

getAuthenticationType

@Nullable
public EditDocumentSigner.AuthenticationTypeEnum getAuthenticationType()

Get authenticationType

Returns:

authenticationType

setAuthenticationType

public void setAuthenticationType(EditDocumentSigner.AuthenticationTypeEnum authenticationType)

phoneNumber

public EditDocumentSigner phoneNumber(PhoneNumber phoneNumber)

getPhoneNumber

@Nullable
public PhoneNumber getPhoneNumber()

Get phoneNumber

Returns:

phoneNumber

setPhoneNumber

public void setPhoneNumber(PhoneNumber phoneNumber)

deliveryMode

public EditDocumentSigner deliveryMode(EditDocumentSigner.DeliveryModeEnum deliveryMode)

getDeliveryMode

@Nullable
public EditDocumentSigner.DeliveryModeEnum getDeliveryMode()

Get deliveryMode

Returns:

deliveryMode

setDeliveryMode

public void setDeliveryMode(EditDocumentSigner.DeliveryModeEnum deliveryMode)

authenticationCode

public EditDocumentSigner authenticationCode(String authenticationCode)

getAuthenticationCode

@Nullable
public String getAuthenticationCode()

Get authenticationCode

Returns:

authenticationCode

setAuthenticationCode

public void setAuthenticationCode(String authenticationCode)

identityVerificationSettings

public EditDocumentSigner identityVerificationSettings(IdentityVerificationSettings identityVerificationSettings)

getIdentityVerificationSettings

@Nullable
public IdentityVerificationSettings getIdentityVerificationSettings()

Get identityVerificationSettings

Returns:

identityVerificationSettings

setIdentityVerificationSettings

public void setIdentityVerificationSettings(IdentityVerificationSettings identityVerificationSettings)

signerOrder

public EditDocumentSigner signerOrder(Integer signerOrder)

getSignerOrder

@Nullable
public Integer getSignerOrder()

Get signerOrder

Returns:

signerOrder

setSignerOrder

public void setSignerOrder(Integer signerOrder)

enableEmailOTP

public EditDocumentSigner enableEmailOTP(Boolean enableEmailOTP)

getEnableEmailOTP

@Nullable
public Boolean getEnableEmailOTP()

Get enableEmailOTP

Returns:

enableEmailOTP

setEnableEmailOTP

public void setEnableEmailOTP(Boolean enableEmailOTP)

signerType

public EditDocumentSigner signerType(EditDocumentSigner.SignerTypeEnum signerType)

getSignerType

@Nullable
public EditDocumentSigner.SignerTypeEnum getSignerType()

Get signerType

Returns:

signerType

setSignerType

public void setSignerType(EditDocumentSigner.SignerTypeEnum signerType)

hostEmail

public EditDocumentSigner hostEmail(String hostEmail)

getHostEmail

@Nullable
public String getHostEmail()

Get hostEmail

Returns:

hostEmail

setHostEmail

public void setHostEmail(String hostEmail)

signerRole

public EditDocumentSigner signerRole(String signerRole)

getSignerRole

@Nullable
public String getSignerRole()

Get signerRole

Returns:

signerRole

setSignerRole

public void setSignerRole(String signerRole)

allowFieldConfiguration

public EditDocumentSigner allowFieldConfiguration(Boolean allowFieldConfiguration)

getAllowFieldConfiguration

@Nullable
public Boolean getAllowFieldConfiguration()

Get allowFieldConfiguration

Returns:

allowFieldConfiguration

setAllowFieldConfiguration

public void setAllowFieldConfiguration(Boolean allowFieldConfiguration)

formFields

public EditDocumentSigner formFields(List<EditFormField> formFields)

addFormFieldsItem

public EditDocumentSigner addFormFieldsItem(EditFormField formFieldsItem)

getFormFields

@Nullable
public List<EditFormField> getFormFields()

Get formFields

Returns:

formFields

setFormFields

public void setFormFields(List<EditFormField> formFields)

language

public EditDocumentSigner language(EditDocumentSigner.LanguageEnum language)

getLanguage

@Nullable
public EditDocumentSigner.LanguageEnum getLanguage()

Get language

Returns:

language

setLanguage

public void setLanguage(EditDocumentSigner.LanguageEnum language)

locale

public EditDocumentSigner locale(EditDocumentSigner.LocaleEnum locale)

getLocale

@Nullable
public EditDocumentSigner.LocaleEnum getLocale()

Get locale

Returns:

locale

setLocale

public void setLocale(EditDocumentSigner.LocaleEnum locale)

signType

public EditDocumentSigner signType(EditDocumentSigner.SignTypeEnum signType)

getSignType

@Nullable
public EditDocumentSigner.SignTypeEnum getSignType()

Get signType

Returns:

signType

setSignType

public void setSignType(EditDocumentSigner.SignTypeEnum signType)

groupId

public EditDocumentSigner groupId(String groupId)

getGroupId

@Nullable
public String getGroupId()

Get groupId

Returns:

groupId

setGroupId

public void setGroupId(String groupId)

recipientNotificationSettings

public EditDocumentSigner recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)

getRecipientNotificationSettings

@Nullable
public RecipientNotificationSettings getRecipientNotificationSettings()

Get recipientNotificationSettings

Returns:

recipientNotificationSettings

setRecipientNotificationSettings

public void setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)

authenticationRetryCount

public EditDocumentSigner authenticationRetryCount(Integer authenticationRetryCount)

getAuthenticationRetryCount

@Nullable
public Integer getAuthenticationRetryCount()

Get authenticationRetryCount minimum: 1 maximum: 10

Returns:

authenticationRetryCount

setAuthenticationRetryCount

public void setAuthenticationRetryCount(Integer authenticationRetryCount)

enableQes

public EditDocumentSigner enableQes(Boolean enableQes)

getEnableQes

@Nullable
public Boolean getEnableQes()

Get enableQes

Returns:

enableQes

setEnableQes

public void setEnableQes(Boolean enableQes)

authenticationSettings

public EditDocumentSigner authenticationSettings(AuthenticationSettings authenticationSettings)

getAuthenticationSettings

@Nullable
public AuthenticationSettings getAuthenticationSettings()

Get authenticationSettings

Returns:

authenticationSettings

setAuthenticationSettings

public void setAuthenticationSettings(AuthenticationSettings authenticationSettings)

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 EditDocumentSigner

fromJson

public static EditDocumentSigner fromJson(String jsonString)
                                   throws IOException

Create an instance of EditDocumentSigner given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of EditDocumentSigner

Throws:

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

toJson

public String toJson()

Convert an instance of EditDocumentSigner to an JSON string

Returns:

JSON string