Package com.boldsign.model
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 Classes Modifier and Type Class Description static classDocumentSignerDetails.AuthenticationTypeEnumGets or Sets authenticationTypestatic classDocumentSignerDetails.CustomTypeAdapterFactorystatic classDocumentSignerDetails.DeliveryModeEnumGets or Sets deliveryModestatic classDocumentSignerDetails.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><li><i>16</i> - Japanese</li><li><i>17</i> - Thai</li><li><i>18</i> - SimplifiedChinese</li><li><i>19</i> - TraditionalChinese</li><li><i>20</i> - Korean</li></ul>static classDocumentSignerDetails.LocaleEnumGets or Sets localestatic classDocumentSignerDetails.SignerTypeEnumGets or Sets signerTypestatic classDocumentSignerDetails.StatusEnumGets or Sets status
-
Field Summary
-
Constructor Summary
Constructors Constructor Description DocumentSignerDetails()
-
Method Summary
-
-
-
Field Detail
-
SERIALIZED_NAME_ID
public static final String SERIALIZED_NAME_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_SIGNER_NAME
public static final String SERIALIZED_NAME_SIGNER_NAME
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_SIGNER_ROLE
public static final String SERIALIZED_NAME_SIGNER_ROLE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_SIGNER_EMAIL
public static final String SERIALIZED_NAME_SIGNER_EMAIL
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_STATUS
public static final String SERIALIZED_NAME_STATUS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ENABLE_ACCESS_CODE
public static final String SERIALIZED_NAME_ENABLE_ACCESS_CODE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_IS_AUTHENTICATION_FAILED
public static final String SERIALIZED_NAME_IS_AUTHENTICATION_FAILED
- 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_AUTHENTICATION_TYPE
public static final String SERIALIZED_NAME_AUTHENTICATION_TYPE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_IS_DELIVERY_FAILED
public static final String SERIALIZED_NAME_IS_DELIVERY_FAILED
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_IS_VIEWED
public static final String SERIALIZED_NAME_IS_VIEWED
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ORDER
public static final String SERIALIZED_NAME_ORDER
- 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_HOST_NAME
public static final String SERIALIZED_NAME_HOST_NAME
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_IS_REASSIGNED
public static final String SERIALIZED_NAME_IS_REASSIGNED
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_PRIVATE_MESSAGE
public static final String SERIALIZED_NAME_PRIVATE_MESSAGE
- 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_PHONE_NUMBER
public static final String SERIALIZED_NAME_PHONE_NUMBER
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ID_VERIFICATION
public static final String SERIALIZED_NAME_ID_VERIFICATION
- 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_DELIVERY_MODE
public static final String SERIALIZED_NAME_DELIVERY_MODE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_AUTHENTICATION_SETTINGS
public static final String SERIALIZED_NAME_AUTHENTICATION_SETTINGS
- See Also:
- Constant Field Values
-
-
Method Detail
-
id
public DocumentSignerDetails id(String id)
-
setId
public void setId(String id)
-
signerName
public DocumentSignerDetails signerName(String signerName)
-
setSignerName
public void setSignerName(String signerName)
-
signerRole
public DocumentSignerDetails signerRole(String signerRole)
-
setSignerRole
public void setSignerRole(String signerRole)
-
signerEmail
public DocumentSignerDetails signerEmail(String signerEmail)
-
setSignerEmail
public void setSignerEmail(String signerEmail)
-
status
public DocumentSignerDetails status(DocumentSignerDetails.StatusEnum status)
-
getStatus
@Nullable public DocumentSignerDetails.StatusEnum getStatus()
Get status- Returns:
- status
-
setStatus
public void setStatus(DocumentSignerDetails.StatusEnum status)
-
enableAccessCode
public DocumentSignerDetails enableAccessCode(Boolean enableAccessCode)
-
getEnableAccessCode
@Nullable public Boolean getEnableAccessCode()
Get enableAccessCode- Returns:
- enableAccessCode
-
setEnableAccessCode
public void setEnableAccessCode(Boolean enableAccessCode)
-
isAuthenticationFailed
public DocumentSignerDetails isAuthenticationFailed(Boolean isAuthenticationFailed)
-
getIsAuthenticationFailed
@Nullable public Boolean getIsAuthenticationFailed()
Get isAuthenticationFailed- Returns:
- isAuthenticationFailed
-
setIsAuthenticationFailed
public void setIsAuthenticationFailed(Boolean isAuthenticationFailed)
-
enableEmailOTP
public DocumentSignerDetails enableEmailOTP(Boolean enableEmailOTP)
-
getEnableEmailOTP
@Nullable public Boolean getEnableEmailOTP()
Get enableEmailOTP- Returns:
- enableEmailOTP
-
setEnableEmailOTP
public void setEnableEmailOTP(Boolean enableEmailOTP)
-
authenticationType
public DocumentSignerDetails authenticationType(DocumentSignerDetails.AuthenticationTypeEnum authenticationType)
-
getAuthenticationType
@Nullable public DocumentSignerDetails.AuthenticationTypeEnum getAuthenticationType()
Get authenticationType- Returns:
- authenticationType
-
setAuthenticationType
public void setAuthenticationType(DocumentSignerDetails.AuthenticationTypeEnum authenticationType)
-
isDeliveryFailed
public DocumentSignerDetails isDeliveryFailed(Boolean isDeliveryFailed)
-
getIsDeliveryFailed
@Nullable public Boolean getIsDeliveryFailed()
Get isDeliveryFailed- Returns:
- isDeliveryFailed
-
setIsDeliveryFailed
public void setIsDeliveryFailed(Boolean isDeliveryFailed)
-
isViewed
public DocumentSignerDetails isViewed(Boolean isViewed)
-
setIsViewed
public void setIsViewed(Boolean isViewed)
-
order
public DocumentSignerDetails order(Integer order)
-
setOrder
public void setOrder(Integer order)
-
signerType
public DocumentSignerDetails signerType(DocumentSignerDetails.SignerTypeEnum signerType)
-
getSignerType
@Nullable public DocumentSignerDetails.SignerTypeEnum getSignerType()
Get signerType- Returns:
- signerType
-
setSignerType
public void setSignerType(DocumentSignerDetails.SignerTypeEnum signerType)
-
hostEmail
public DocumentSignerDetails hostEmail(String hostEmail)
-
setHostEmail
public void setHostEmail(String hostEmail)
-
hostName
public DocumentSignerDetails hostName(String hostName)
-
setHostName
public void setHostName(String hostName)
-
isReassigned
public DocumentSignerDetails isReassigned(Boolean isReassigned)
-
setIsReassigned
public void setIsReassigned(Boolean isReassigned)
-
privateMessage
public DocumentSignerDetails privateMessage(String privateMessage)
-
getPrivateMessage
@Nullable public String getPrivateMessage()
Get privateMessage- Returns:
- privateMessage
-
setPrivateMessage
public void setPrivateMessage(String privateMessage)
-
allowFieldConfiguration
public DocumentSignerDetails allowFieldConfiguration(Boolean allowFieldConfiguration)
-
getAllowFieldConfiguration
@Nullable public Boolean getAllowFieldConfiguration()
Get allowFieldConfiguration- Returns:
- allowFieldConfiguration
-
setAllowFieldConfiguration
public void setAllowFieldConfiguration(Boolean allowFieldConfiguration)
-
formFields
public DocumentSignerDetails formFields(List<DocumentFormFields> formFields)
-
addFormFieldsItem
public DocumentSignerDetails addFormFieldsItem(DocumentFormFields formFieldsItem)
-
getFormFields
@Nullable public List<DocumentFormFields> getFormFields()
Get formFields- Returns:
- formFields
-
setFormFields
public void setFormFields(List<DocumentFormFields> formFields)
-
language
public DocumentSignerDetails language(DocumentSignerDetails.LanguageEnum language)
-
getLanguage
@Nullable public DocumentSignerDetails.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><li><i>16</i> - Japanese</li><li><i>17</i> - Thai</li><li><i>18</i> - SimplifiedChinese</li><li><i>19</i> - TraditionalChinese</li><li><i>20</i> - Korean</li></ul>- Returns:
- language
-
setLanguage
public void setLanguage(DocumentSignerDetails.LanguageEnum language)
-
locale
public DocumentSignerDetails locale(DocumentSignerDetails.LocaleEnum locale)
-
getLocale
@Nullable public DocumentSignerDetails.LocaleEnum getLocale()
Get locale- Returns:
- locale
-
setLocale
public void setLocale(DocumentSignerDetails.LocaleEnum locale)
-
phoneNumber
public DocumentSignerDetails phoneNumber(PhoneNumber phoneNumber)
-
getPhoneNumber
@Nullable public PhoneNumber getPhoneNumber()
Get phoneNumber- Returns:
- phoneNumber
-
setPhoneNumber
public void setPhoneNumber(PhoneNumber phoneNumber)
-
idVerification
public DocumentSignerDetails idVerification(IdVerificationDetails idVerification)
-
getIdVerification
@Nullable public IdVerificationDetails getIdVerification()
Get idVerification- Returns:
- idVerification
-
setIdVerification
public void setIdVerification(IdVerificationDetails idVerification)
-
recipientNotificationSettings
public DocumentSignerDetails recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)
-
getRecipientNotificationSettings
@Nullable public RecipientNotificationSettings getRecipientNotificationSettings()
Get recipientNotificationSettings- Returns:
- recipientNotificationSettings
-
setRecipientNotificationSettings
public void setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)
-
authenticationRetryCount
public DocumentSignerDetails authenticationRetryCount(Integer authenticationRetryCount)
-
getAuthenticationRetryCount
@Nullable public Integer getAuthenticationRetryCount()
Get authenticationRetryCount- Returns:
- authenticationRetryCount
-
setAuthenticationRetryCount
public void setAuthenticationRetryCount(Integer authenticationRetryCount)
-
enableQes
public DocumentSignerDetails enableQes(Boolean enableQes)
-
setEnableQes
public void setEnableQes(Boolean enableQes)
-
deliveryMode
public DocumentSignerDetails deliveryMode(DocumentSignerDetails.DeliveryModeEnum deliveryMode)
-
getDeliveryMode
@Nullable public DocumentSignerDetails.DeliveryModeEnum getDeliveryMode()
Get deliveryMode- Returns:
- deliveryMode
-
setDeliveryMode
public void setDeliveryMode(DocumentSignerDetails.DeliveryModeEnum deliveryMode)
-
authenticationSettings
public DocumentSignerDetails authenticationSettings(SignerAuthenticationSettings authenticationSettings)
-
getAuthenticationSettings
@Nullable public SignerAuthenticationSettings getAuthenticationSettings()
Get authenticationSettings- Returns:
- authenticationSettings
-
setAuthenticationSettings
public void setAuthenticationSettings(SignerAuthenticationSettings authenticationSettings)
-
createFormData
public Map<String,Object> createFormData() throws ApiException
- Throws:
ApiException
-
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 DocumentSignerDetails
-
fromJson
public static DocumentSignerDetails fromJson(String jsonString) throws IOException
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
public String toJson()
Convert an instance of DocumentSignerDetails to an JSON string- Returns:
- JSON string
-
-