Package com.boldsign.model
Class MergeAndSendForSignForm
- java.lang.Object
-
- com.boldsign.model.MergeAndSendForSignForm
-
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.8.0") public class MergeAndSendForSignForm extends Object
MergeAndSendForSignForm
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMergeAndSendForSignForm.AllowedSignatureTypesEnumGets or Sets allowedSignatureTypesstatic classMergeAndSendForSignForm.CustomTypeAdapterFactorystatic classMergeAndSendForSignForm.DocumentDownloadOptionEnumGets or Sets documentDownloadOptionstatic classMergeAndSendForSignForm.ExpiryDateTypeEnumGets or Sets expiryDateType
-
Field Summary
-
Constructor Summary
Constructors Constructor Description MergeAndSendForSignForm()
-
Method Summary
-
-
-
Field Detail
-
SERIALIZED_NAME_FILES
public static final String SERIALIZED_NAME_FILES
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_FILE_URLS
public static final String SERIALIZED_NAME_FILE_URLS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TEMPLATE_IDS
public static final String SERIALIZED_NAME_TEMPLATE_IDS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_USE_TEXT_TAGS
public static final String SERIALIZED_NAME_USE_TEXT_TAGS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TEXT_TAG_DEFINITIONS
public static final String SERIALIZED_NAME_TEXT_TAG_DEFINITIONS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DOCUMENT_ID
public static final String SERIALIZED_NAME_DOCUMENT_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TITLE
public static final String SERIALIZED_NAME_TITLE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_MESSAGE
public static final String SERIALIZED_NAME_MESSAGE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ROLES
public static final String SERIALIZED_NAME_ROLES
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_BRAND_ID
public static final String SERIALIZED_NAME_BRAND_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_LABELS
public static final String SERIALIZED_NAME_LABELS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DISABLE_EMAILS
public static final String SERIALIZED_NAME_DISABLE_EMAILS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DISABLE_S_M_S
public static final String SERIALIZED_NAME_DISABLE_S_M_S
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_HIDE_DOCUMENT_ID
public static final String SERIALIZED_NAME_HIDE_DOCUMENT_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_REMINDER_SETTINGS
public static final String SERIALIZED_NAME_REMINDER_SETTINGS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_CC
public static final String SERIALIZED_NAME_CC
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_EXPIRY_DAYS
public static final String SERIALIZED_NAME_EXPIRY_DAYS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_EXPIRY_DATE_TYPE
public static final String SERIALIZED_NAME_EXPIRY_DATE_TYPE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_EXPIRY_VALUE
public static final String SERIALIZED_NAME_EXPIRY_VALUE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ENABLE_PRINT_AND_SIGN
public static final String SERIALIZED_NAME_ENABLE_PRINT_AND_SIGN
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ENABLE_REASSIGN
public static final String SERIALIZED_NAME_ENABLE_REASSIGN
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ENABLE_SIGNING_ORDER
public static final String SERIALIZED_NAME_ENABLE_SIGNING_ORDER
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DISABLE_EXPIRY_ALERT
public static final String SERIALIZED_NAME_DISABLE_EXPIRY_ALERT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DOCUMENT_INFO
public static final String SERIALIZED_NAME_DOCUMENT_INFO
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ON_BEHALF_OF
public static final String SERIALIZED_NAME_ON_BEHALF_OF
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_IS_SANDBOX
public static final String SERIALIZED_NAME_IS_SANDBOX
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ROLE_REMOVAL_INDICES
public static final String SERIALIZED_NAME_ROLE_REMOVAL_INDICES
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DOCUMENT_DOWNLOAD_OPTION
public static final String SERIALIZED_NAME_DOCUMENT_DOWNLOAD_OPTION
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_META_DATA
public static final String SERIALIZED_NAME_META_DATA
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_FORM_GROUPS
public static final String SERIALIZED_NAME_FORM_GROUPS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_REMOVE_FORM_FIELDS
public static final String SERIALIZED_NAME_REMOVE_FORM_FIELDS
- 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_ENABLE_AUDIT_TRAIL_LOCALIZATION
public static final String SERIALIZED_NAME_ENABLE_AUDIT_TRAIL_LOCALIZATION
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DOWNLOAD_FILE_NAME
public static final String SERIALIZED_NAME_DOWNLOAD_FILE_NAME
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_SCHEDULED_SEND_TIME
public static final String SERIALIZED_NAME_SCHEDULED_SEND_TIME
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ALLOW_SCHEDULED_SEND
public static final String SERIALIZED_NAME_ALLOW_SCHEDULED_SEND
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ALLOWED_SIGNATURE_TYPES
public static final String SERIALIZED_NAME_ALLOWED_SIGNATURE_TYPES
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_GROUP_SIGNER_SETTINGS
public static final String SERIALIZED_NAME_GROUP_SIGNER_SETTINGS
- See Also:
- Constant Field Values
-
-
Method Detail
-
files
public MergeAndSendForSignForm files(List<File> files)
-
addFilesItem
public MergeAndSendForSignForm addFilesItem(File filesItem)
-
fileUrls
public MergeAndSendForSignForm fileUrls(List<URI> fileUrls)
-
addFileUrlsItem
public MergeAndSendForSignForm addFileUrlsItem(URI fileUrlsItem)
-
templateIds
public MergeAndSendForSignForm templateIds(List<String> templateIds)
-
addTemplateIdsItem
public MergeAndSendForSignForm addTemplateIdsItem(String templateIdsItem)
-
useTextTags
public MergeAndSendForSignForm useTextTags(Boolean useTextTags)
-
setUseTextTags
public void setUseTextTags(Boolean useTextTags)
-
textTagDefinitions
public MergeAndSendForSignForm textTagDefinitions(List<TextTagDefinition> textTagDefinitions)
-
addTextTagDefinitionsItem
public MergeAndSendForSignForm addTextTagDefinitionsItem(TextTagDefinition textTagDefinitionsItem)
-
getTextTagDefinitions
@Nullable public List<TextTagDefinition> getTextTagDefinitions()
Get textTagDefinitions- Returns:
- textTagDefinitions
-
setTextTagDefinitions
public void setTextTagDefinitions(List<TextTagDefinition> textTagDefinitions)
-
documentId
public MergeAndSendForSignForm documentId(String documentId)
-
setDocumentId
public void setDocumentId(String documentId)
-
title
public MergeAndSendForSignForm title(String title)
-
setTitle
public void setTitle(String title)
-
message
public MergeAndSendForSignForm message(String message)
-
setMessage
public void setMessage(String message)
-
roles
public MergeAndSendForSignForm roles(List<Role> roles)
-
addRolesItem
public MergeAndSendForSignForm addRolesItem(Role rolesItem)
-
brandId
public MergeAndSendForSignForm brandId(String brandId)
-
setBrandId
public void setBrandId(String brandId)
-
labels
public MergeAndSendForSignForm labels(List<String> labels)
-
addLabelsItem
public MergeAndSendForSignForm addLabelsItem(String labelsItem)
-
disableEmails
public MergeAndSendForSignForm disableEmails(Boolean disableEmails)
-
getDisableEmails
@Nullable public Boolean getDisableEmails()
Get disableEmails- Returns:
- disableEmails
-
setDisableEmails
public void setDisableEmails(Boolean disableEmails)
-
disableSMS
public MergeAndSendForSignForm disableSMS(Boolean disableSMS)
-
setDisableSMS
public void setDisableSMS(Boolean disableSMS)
-
hideDocumentId
public MergeAndSendForSignForm hideDocumentId(Boolean hideDocumentId)
-
getHideDocumentId
@Nullable public Boolean getHideDocumentId()
Get hideDocumentId- Returns:
- hideDocumentId
-
setHideDocumentId
public void setHideDocumentId(Boolean hideDocumentId)
-
reminderSettings
public MergeAndSendForSignForm reminderSettings(ReminderSettings reminderSettings)
-
getReminderSettings
@Nullable public ReminderSettings getReminderSettings()
Get reminderSettings- Returns:
- reminderSettings
-
setReminderSettings
public void setReminderSettings(ReminderSettings reminderSettings)
-
cc
public MergeAndSendForSignForm cc(List<DocumentCC> cc)
-
addCcItem
public MergeAndSendForSignForm addCcItem(DocumentCC ccItem)
-
getCc
@Nullable public List<DocumentCC> getCc()
Get cc- Returns:
- cc
-
setCc
public void setCc(List<DocumentCC> cc)
-
expiryDays
@Deprecated public MergeAndSendForSignForm expiryDays(Integer expiryDays)
Deprecated.
-
getExpiryDays
@Deprecated @Nullable public Integer getExpiryDays()
Deprecated.Get expiryDays- Returns:
- expiryDays
-
setExpiryDays
@Deprecated public void setExpiryDays(Integer expiryDays)
Deprecated.
-
expiryDateType
public MergeAndSendForSignForm expiryDateType(MergeAndSendForSignForm.ExpiryDateTypeEnum expiryDateType)
-
getExpiryDateType
@Nullable public MergeAndSendForSignForm.ExpiryDateTypeEnum getExpiryDateType()
Get expiryDateType- Returns:
- expiryDateType
-
setExpiryDateType
public void setExpiryDateType(MergeAndSendForSignForm.ExpiryDateTypeEnum expiryDateType)
-
expiryValue
public MergeAndSendForSignForm expiryValue(Long expiryValue)
-
setExpiryValue
public void setExpiryValue(Long expiryValue)
-
enablePrintAndSign
public MergeAndSendForSignForm enablePrintAndSign(Boolean enablePrintAndSign)
-
getEnablePrintAndSign
@Nullable public Boolean getEnablePrintAndSign()
Get enablePrintAndSign- Returns:
- enablePrintAndSign
-
setEnablePrintAndSign
public void setEnablePrintAndSign(Boolean enablePrintAndSign)
-
enableReassign
public MergeAndSendForSignForm enableReassign(Boolean enableReassign)
-
getEnableReassign
@Nullable public Boolean getEnableReassign()
Get enableReassign- Returns:
- enableReassign
-
setEnableReassign
public void setEnableReassign(Boolean enableReassign)
-
enableSigningOrder
public MergeAndSendForSignForm enableSigningOrder(Boolean enableSigningOrder)
-
getEnableSigningOrder
@Nullable public Boolean getEnableSigningOrder()
Get enableSigningOrder- Returns:
- enableSigningOrder
-
setEnableSigningOrder
public void setEnableSigningOrder(Boolean enableSigningOrder)
-
disableExpiryAlert
public MergeAndSendForSignForm disableExpiryAlert(Boolean disableExpiryAlert)
-
getDisableExpiryAlert
@Nullable public Boolean getDisableExpiryAlert()
Get disableExpiryAlert- Returns:
- disableExpiryAlert
-
setDisableExpiryAlert
public void setDisableExpiryAlert(Boolean disableExpiryAlert)
-
documentInfo
public MergeAndSendForSignForm documentInfo(List<DocumentInfo> documentInfo)
-
addDocumentInfoItem
public MergeAndSendForSignForm addDocumentInfoItem(DocumentInfo documentInfoItem)
-
getDocumentInfo
@Nullable public List<DocumentInfo> getDocumentInfo()
Get documentInfo- Returns:
- documentInfo
-
setDocumentInfo
public void setDocumentInfo(List<DocumentInfo> documentInfo)
-
onBehalfOf
public MergeAndSendForSignForm onBehalfOf(String onBehalfOf)
-
setOnBehalfOf
public void setOnBehalfOf(String onBehalfOf)
-
isSandbox
public MergeAndSendForSignForm isSandbox(Boolean isSandbox)
-
setIsSandbox
public void setIsSandbox(Boolean isSandbox)
-
roleRemovalIndices
public MergeAndSendForSignForm roleRemovalIndices(List<Integer> roleRemovalIndices)
-
addRoleRemovalIndicesItem
public MergeAndSendForSignForm addRoleRemovalIndicesItem(Integer roleRemovalIndicesItem)
-
getRoleRemovalIndices
@Nullable public List<Integer> getRoleRemovalIndices()
Get roleRemovalIndices- Returns:
- roleRemovalIndices
-
documentDownloadOption
public MergeAndSendForSignForm documentDownloadOption(MergeAndSendForSignForm.DocumentDownloadOptionEnum documentDownloadOption)
-
getDocumentDownloadOption
@Nullable public MergeAndSendForSignForm.DocumentDownloadOptionEnum getDocumentDownloadOption()
Get documentDownloadOption- Returns:
- documentDownloadOption
-
setDocumentDownloadOption
public void setDocumentDownloadOption(MergeAndSendForSignForm.DocumentDownloadOptionEnum documentDownloadOption)
-
metaData
public MergeAndSendForSignForm metaData(Map<String,String> metaData)
-
putMetaDataItem
public MergeAndSendForSignForm putMetaDataItem(String key, String metaDataItem)
-
formGroups
public MergeAndSendForSignForm formGroups(List<FormGroup> formGroups)
-
addFormGroupsItem
public MergeAndSendForSignForm addFormGroupsItem(FormGroup formGroupsItem)
-
removeFormFields
public MergeAndSendForSignForm removeFormFields(List<String> removeFormFields)
-
addRemoveFormFieldsItem
public MergeAndSendForSignForm addRemoveFormFieldsItem(String removeFormFieldsItem)
-
getRemoveFormFields
@Nullable public List<String> getRemoveFormFields()
Get removeFormFields- Returns:
- removeFormFields
-
recipientNotificationSettings
public MergeAndSendForSignForm recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)
-
getRecipientNotificationSettings
@Nullable public RecipientNotificationSettings getRecipientNotificationSettings()
Get recipientNotificationSettings- Returns:
- recipientNotificationSettings
-
setRecipientNotificationSettings
public void setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)
-
enableAuditTrailLocalization
public MergeAndSendForSignForm enableAuditTrailLocalization(Boolean enableAuditTrailLocalization)
-
getEnableAuditTrailLocalization
@Nullable public Boolean getEnableAuditTrailLocalization()
Get enableAuditTrailLocalization- Returns:
- enableAuditTrailLocalization
-
setEnableAuditTrailLocalization
public void setEnableAuditTrailLocalization(Boolean enableAuditTrailLocalization)
-
downloadFileName
public MergeAndSendForSignForm downloadFileName(String downloadFileName)
-
getDownloadFileName
@Nullable public String getDownloadFileName()
Get downloadFileName- Returns:
- downloadFileName
-
setDownloadFileName
public void setDownloadFileName(String downloadFileName)
-
scheduledSendTime
public MergeAndSendForSignForm scheduledSendTime(Long scheduledSendTime)
-
getScheduledSendTime
@Nullable public Long getScheduledSendTime()
Get scheduledSendTime- Returns:
- scheduledSendTime
-
setScheduledSendTime
public void setScheduledSendTime(Long scheduledSendTime)
-
allowScheduledSend
public MergeAndSendForSignForm allowScheduledSend(Boolean allowScheduledSend)
-
getAllowScheduledSend
@Nullable public Boolean getAllowScheduledSend()
Get allowScheduledSend- Returns:
- allowScheduledSend
-
setAllowScheduledSend
public void setAllowScheduledSend(Boolean allowScheduledSend)
-
allowedSignatureTypes
public MergeAndSendForSignForm allowedSignatureTypes(List<MergeAndSendForSignForm.AllowedSignatureTypesEnum> allowedSignatureTypes)
-
addAllowedSignatureTypesItem
public MergeAndSendForSignForm addAllowedSignatureTypesItem(MergeAndSendForSignForm.AllowedSignatureTypesEnum allowedSignatureTypesItem)
-
getAllowedSignatureTypes
@Nullable public List<MergeAndSendForSignForm.AllowedSignatureTypesEnum> getAllowedSignatureTypes()
Get allowedSignatureTypes- Returns:
- allowedSignatureTypes
-
setAllowedSignatureTypes
public void setAllowedSignatureTypes(List<MergeAndSendForSignForm.AllowedSignatureTypesEnum> allowedSignatureTypes)
-
groupSignerSettings
public MergeAndSendForSignForm groupSignerSettings(GroupSignerSettings groupSignerSettings)
-
getGroupSignerSettings
@Nullable public GroupSignerSettings getGroupSignerSettings()
Get groupSignerSettings- Returns:
- groupSignerSettings
-
setGroupSignerSettings
public void setGroupSignerSettings(GroupSignerSettings groupSignerSettings)
-
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 MergeAndSendForSignForm
-
fromJson
public static MergeAndSendForSignForm fromJson(String jsonString) throws IOException
Create an instance of MergeAndSendForSignForm given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of MergeAndSendForSignForm
- Throws:
IOException- if the JSON string is invalid with respect to MergeAndSendForSignForm
-
toJson
public String toJson()
Convert an instance of MergeAndSendForSignForm to an JSON string- Returns:
- JSON string
-
-