Class DocumentSignerDetails
java.lang.Object
com.boldsign.model.DocumentSignerDetails
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
comments="Generator version: 7.8.0")
public class DocumentSignerDetails
extends Object
DocumentSignerDetails
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumGets or Sets authenticationTypestatic classstatic enumGets or Sets deliveryModestatic enum<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 enumGets or Sets localestatic enumGets or Sets signerTypestatic enumGets or Sets status -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddFormFieldsItem(DocumentFormFields formFieldsItem) allowFieldConfiguration(Boolean allowFieldConfiguration) authenticationRetryCount(Integer authenticationRetryCount) authenticationSettings(SignerAuthenticationSettings authenticationSettings) authenticationType(DocumentSignerDetails.AuthenticationTypeEnum authenticationType) deliveryMode(DocumentSignerDetails.DeliveryModeEnum deliveryMode) enableAccessCode(Boolean enableAccessCode) enableEmailOTP(Boolean enableEmailOTP) booleanformFields(List<DocumentFormFields> formFields) static DocumentSignerDetailsCreate an instance of DocumentSignerDetails given an JSON stringGet allowFieldConfigurationGet authenticationRetryCountGet authenticationSettingsGet authenticationTypeGet deliveryModeGet enableAccessCodeGet enableEmailOTPGet enableQesGet formFieldsGet hostEmailGet hostNamegetId()Get idGet idVerificationGet isAuthenticationFailedGet isDeliveryFailedGet isReassignedGet isViewed<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>Get localegetOrder()Get orderGet phoneNumberGet privateMessageGet recipientNotificationSettingsGet signerEmailGet signerNameGet signerRoleGet signerTypeGet statusinthashCode()idVerification(IdVerification idVerification) isAuthenticationFailed(Boolean isAuthenticationFailed) isDeliveryFailed(Boolean isDeliveryFailed) isReassigned(Boolean isReassigned) language(DocumentSignerDetails.LanguageEnum language) phoneNumber(PhoneNumber phoneNumber) privateMessage(String privateMessage) recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings) voidsetAllowFieldConfiguration(Boolean allowFieldConfiguration) voidsetAuthenticationRetryCount(Integer authenticationRetryCount) voidsetAuthenticationSettings(SignerAuthenticationSettings authenticationSettings) voidsetAuthenticationType(DocumentSignerDetails.AuthenticationTypeEnum authenticationType) voidsetDeliveryMode(DocumentSignerDetails.DeliveryModeEnum deliveryMode) voidsetEnableAccessCode(Boolean enableAccessCode) voidsetEnableEmailOTP(Boolean enableEmailOTP) voidsetEnableQes(Boolean enableQes) voidsetFormFields(List<DocumentFormFields> formFields) voidsetHostEmail(String hostEmail) voidsetHostName(String hostName) voidvoidsetIdVerification(IdVerification idVerification) voidsetIsAuthenticationFailed(Boolean isAuthenticationFailed) voidsetIsDeliveryFailed(Boolean isDeliveryFailed) voidsetIsReassigned(Boolean isReassigned) voidsetIsViewed(Boolean isViewed) voidvoidvoidvoidsetPhoneNumber(PhoneNumber phoneNumber) voidsetPrivateMessage(String privateMessage) voidsetRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings) voidsetSignerEmail(String signerEmail) voidsetSignerName(String signerName) voidsetSignerRole(String signerRole) voidsetSignerType(DocumentSignerDetails.SignerTypeEnum signerType) voidsignerEmail(String signerEmail) signerName(String signerName) signerRole(String signerRole) signerType(DocumentSignerDetails.SignerTypeEnum signerType) toJson()Convert an instance of DocumentSignerDetails to an JSON stringtoString()static voidvalidateJsonElement(com.google.gson.JsonElement jsonElement) Validates the JSON Element and throws an exception if issues found
-
Field Details
-
SERIALIZED_NAME_ID
- See Also:
-
SERIALIZED_NAME_SIGNER_NAME
- See Also:
-
SERIALIZED_NAME_SIGNER_ROLE
- See Also:
-
SERIALIZED_NAME_SIGNER_EMAIL
- See Also:
-
SERIALIZED_NAME_STATUS
- See Also:
-
SERIALIZED_NAME_ENABLE_ACCESS_CODE
- See Also:
-
SERIALIZED_NAME_IS_AUTHENTICATION_FAILED
- See Also:
-
SERIALIZED_NAME_ENABLE_EMAIL_O_T_P
- See Also:
-
SERIALIZED_NAME_AUTHENTICATION_TYPE
- See Also:
-
SERIALIZED_NAME_IS_DELIVERY_FAILED
- See Also:
-
SERIALIZED_NAME_IS_VIEWED
- See Also:
-
SERIALIZED_NAME_ORDER
- See Also:
-
SERIALIZED_NAME_SIGNER_TYPE
- See Also:
-
SERIALIZED_NAME_HOST_EMAIL
- See Also:
-
SERIALIZED_NAME_HOST_NAME
- See Also:
-
SERIALIZED_NAME_IS_REASSIGNED
- See Also:
-
SERIALIZED_NAME_PRIVATE_MESSAGE
- See Also:
-
SERIALIZED_NAME_ALLOW_FIELD_CONFIGURATION
- See Also:
-
SERIALIZED_NAME_FORM_FIELDS
- See Also:
-
SERIALIZED_NAME_LANGUAGE
- See Also:
-
SERIALIZED_NAME_LOCALE
- See Also:
-
SERIALIZED_NAME_PHONE_NUMBER
- See Also:
-
SERIALIZED_NAME_ID_VERIFICATION
- See Also:
-
SERIALIZED_NAME_RECIPIENT_NOTIFICATION_SETTINGS
- See Also:
-
SERIALIZED_NAME_AUTHENTICATION_RETRY_COUNT
- See Also:
-
SERIALIZED_NAME_ENABLE_QES
- See Also:
-
SERIALIZED_NAME_DELIVERY_MODE
- See Also:
-
SERIALIZED_NAME_AUTHENTICATION_SETTINGS
- See Also:
-
openapiFields
-
openapiRequiredFields
-
-
Constructor Details
-
DocumentSignerDetails
public DocumentSignerDetails()
-
-
Method Details
-
id
-
getId
-
setId
-
signerName
-
getSignerName
-
setSignerName
-
signerRole
-
getSignerRole
-
setSignerRole
-
signerEmail
-
getSignerEmail
-
setSignerEmail
-
status
-
getStatus
-
setStatus
-
enableAccessCode
-
getEnableAccessCode
-
setEnableAccessCode
-
isAuthenticationFailed
-
getIsAuthenticationFailed
-
setIsAuthenticationFailed
-
enableEmailOTP
-
getEnableEmailOTP
-
setEnableEmailOTP
-
authenticationType
public DocumentSignerDetails authenticationType(DocumentSignerDetails.AuthenticationTypeEnum authenticationType) -
getAuthenticationType
Get authenticationType- Returns:
- authenticationType
-
setAuthenticationType
-
isDeliveryFailed
-
getIsDeliveryFailed
-
setIsDeliveryFailed
-
isViewed
-
getIsViewed
-
setIsViewed
-
order
-
getOrder
-
setOrder
-
signerType
-
getSignerType
Get signerType- Returns:
- signerType
-
setSignerType
-
hostEmail
-
getHostEmail
-
setHostEmail
-
hostName
-
getHostName
-
setHostName
-
isReassigned
-
getIsReassigned
-
setIsReassigned
-
privateMessage
-
getPrivateMessage
-
setPrivateMessage
-
allowFieldConfiguration
-
getAllowFieldConfiguration
-
setAllowFieldConfiguration
-
formFields
-
addFormFieldsItem
-
getFormFields
-
setFormFields
-
language
-
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
-
locale
-
getLocale
-
setLocale
-
phoneNumber
-
getPhoneNumber
-
setPhoneNumber
-
idVerification
-
getIdVerification
-
setIdVerification
-
recipientNotificationSettings
public DocumentSignerDetails recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings) -
getRecipientNotificationSettings
Get recipientNotificationSettings- Returns:
- recipientNotificationSettings
-
setRecipientNotificationSettings
public void setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings) -
authenticationRetryCount
-
getAuthenticationRetryCount
-
setAuthenticationRetryCount
-
enableQes
-
getEnableQes
-
setEnableQes
-
deliveryMode
-
getDeliveryMode
Get deliveryMode- Returns:
- deliveryMode
-
setDeliveryMode
-
authenticationSettings
public DocumentSignerDetails authenticationSettings(SignerAuthenticationSettings authenticationSettings) -
getAuthenticationSettings
Get authenticationSettings- Returns:
- authenticationSettings
-
setAuthenticationSettings
-
equals
-
hashCode
-
toString
-
createFormData
- Throws:
ApiException
-
validateJsonElement
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 DocumentSignerDetails
-
fromJson
Create an instance of DocumentSignerDetails given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of DocumentSignerDetails
- Throws:
IOException- if the JSON string is invalid with respect to DocumentSignerDetails
-
toJson
Convert an instance of DocumentSignerDetails to an JSON string- Returns:
- JSON string
-