Class SendForSign
java.lang.Object
com.boldsign.model.SendForSign
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
comments="Generator version: 7.8.0")
public class SendForSign
extends Object
SendForSign
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic enumGets or Sets documentDownloadOptionstatic enumGets or Sets expiryDateType -
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 Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddCcItem(DocumentCC ccItem) addDocumentInfoItem(DocumentInfo documentInfoItem) addFilesItem(File filesItem) addFileUrlsItem(URI fileUrlsItem) addFormGroupsItem(FormGroup formGroupsItem) addLabelsItem(String labelsItem) addSignersItem(DocumentSigner signersItem) addTextTagDefinitionsItem(TextTagDefinition textTagDefinitionsItem) allowScheduledSend(Boolean allowScheduledSend) autoDetectFields(Boolean autoDetectFields) cc(List<DocumentCC> cc) disableEmails(Boolean disableEmails) disableExpiryAlert(Boolean disableExpiryAlert) disableSMS(Boolean disableSMS) documentDownloadOption(SendForSign.DocumentDownloadOptionEnum documentDownloadOption) documentInfo(List<DocumentInfo> documentInfo) downloadFileName(String downloadFileName) enableAuditTrailLocalization(Boolean enableAuditTrailLocalization) enableEmbeddedSigning(Boolean enableEmbeddedSigning) Deprecated.enablePrintAndSign(Boolean enablePrintAndSign) enableReassign(Boolean enableReassign) enableSigningOrder(Boolean enableSigningOrder) booleanexpiryDateType(SendForSign.ExpiryDateTypeEnum expiryDateType) expiryDays(Integer expiryDays) Deprecated.expiryValue(Long expiryValue) formGroups(List<FormGroup> formGroups) static SendForSignCreate an instance of SendForSign given an JSON stringGet allowScheduledSendGet autoDetectFieldsGet brandIdgetCc()Get ccGet disableEmailsGet disableExpiryAlertGet disableSMSGet documentDownloadOptionGet documentInfoGet downloadFileNameGet enableAuditTrailLocalizationDeprecated.Get enablePrintAndSignGet enableReassignGet enableSigningOrderGet expiryDateTypeDeprecated.Get expiryValuegetFiles()Get filesGet fileUrlsGet formGroupsGet hideDocumentIdGet isSandboxGet labelsGet messageGet metaDataGet onBehalfOfGet recipientNotificationSettingsGet reminderSettingsGet scheduledSendTimeGet sendLinkValidTillGet signersGet textTagDefinitionsgetTitle()Get titleGet useTextTagsinthashCode()hideDocumentId(Boolean hideDocumentId) onBehalfOf(String onBehalfOf) putMetaDataItem(String key, String metaDataItem) recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings) reminderSettings(ReminderSettings reminderSettings) scheduledSendTime(Long scheduledSendTime) sendLinkValidTill(OffsetDateTime sendLinkValidTill) voidsetAllowScheduledSend(Boolean allowScheduledSend) voidsetAutoDetectFields(Boolean autoDetectFields) voidsetBrandId(String brandId) voidsetCc(List<DocumentCC> cc) voidsetDisableEmails(Boolean disableEmails) voidsetDisableExpiryAlert(Boolean disableExpiryAlert) voidsetDisableSMS(Boolean disableSMS) voidsetDocumentDownloadOption(SendForSign.DocumentDownloadOptionEnum documentDownloadOption) voidsetDocumentInfo(List<DocumentInfo> documentInfo) voidsetDownloadFileName(String downloadFileName) voidsetEnableAuditTrailLocalization(Boolean enableAuditTrailLocalization) voidsetEnableEmbeddedSigning(Boolean enableEmbeddedSigning) Deprecated.voidsetEnablePrintAndSign(Boolean enablePrintAndSign) voidsetEnableReassign(Boolean enableReassign) voidsetEnableSigningOrder(Boolean enableSigningOrder) voidsetExpiryDateType(SendForSign.ExpiryDateTypeEnum expiryDateType) voidsetExpiryDays(Integer expiryDays) Deprecated.voidsetExpiryValue(Long expiryValue) voidvoidsetFileUrls(List<URI> fileUrls) voidsetFormGroups(List<FormGroup> formGroups) voidsetHideDocumentId(Boolean hideDocumentId) voidsetIsSandbox(Boolean isSandbox) voidvoidsetMessage(String message) voidsetMetaData(Map<String, String> metaData) voidsetOnBehalfOf(String onBehalfOf) voidsetRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings) voidsetReminderSettings(ReminderSettings reminderSettings) voidsetScheduledSendTime(Long scheduledSendTime) voidsetSendLinkValidTill(OffsetDateTime sendLinkValidTill) voidsetSigners(List<DocumentSigner> signers) voidsetTextTagDefinitions(List<TextTagDefinition> textTagDefinitions) voidvoidsetUseTextTags(Boolean useTextTags) signers(List<DocumentSigner> signers) textTagDefinitions(List<TextTagDefinition> textTagDefinitions) toJson()Convert an instance of SendForSign to an JSON stringtoString()useTextTags(Boolean useTextTags) static voidvalidateJsonElement(com.google.gson.JsonElement jsonElement) Validates the JSON Element and throws an exception if issues found
-
Field Details
-
SERIALIZED_NAME_FILES
- See Also:
-
SERIALIZED_NAME_TITLE
- See Also:
-
SERIALIZED_NAME_MESSAGE
- See Also:
-
SERIALIZED_NAME_SIGNERS
- See Also:
-
SERIALIZED_NAME_CC
- See Also:
-
SERIALIZED_NAME_ENABLE_SIGNING_ORDER
- See Also:
-
SERIALIZED_NAME_EXPIRY_DAYS
- See Also:
-
SERIALIZED_NAME_EXPIRY_DATE_TYPE
- See Also:
-
SERIALIZED_NAME_EXPIRY_VALUE
- See Also:
-
SERIALIZED_NAME_REMINDER_SETTINGS
- See Also:
-
SERIALIZED_NAME_ENABLE_EMBEDDED_SIGNING
- See Also:
-
SERIALIZED_NAME_DISABLE_EMAILS
- See Also:
-
SERIALIZED_NAME_DISABLE_S_M_S
- See Also:
-
SERIALIZED_NAME_BRAND_ID
- See Also:
-
SERIALIZED_NAME_HIDE_DOCUMENT_ID
- See Also:
-
SERIALIZED_NAME_LABELS
- See Also:
-
SERIALIZED_NAME_FILE_URLS
- See Also:
-
SERIALIZED_NAME_SEND_LINK_VALID_TILL
- See Also:
-
SERIALIZED_NAME_USE_TEXT_TAGS
- See Also:
-
SERIALIZED_NAME_TEXT_TAG_DEFINITIONS
- See Also:
-
SERIALIZED_NAME_ENABLE_PRINT_AND_SIGN
- See Also:
-
SERIALIZED_NAME_ENABLE_REASSIGN
- See Also:
-
SERIALIZED_NAME_DISABLE_EXPIRY_ALERT
- See Also:
-
SERIALIZED_NAME_DOCUMENT_INFO
- See Also:
-
SERIALIZED_NAME_ON_BEHALF_OF
- See Also:
-
SERIALIZED_NAME_AUTO_DETECT_FIELDS
- See Also:
-
SERIALIZED_NAME_DOCUMENT_DOWNLOAD_OPTION
- See Also:
-
SERIALIZED_NAME_IS_SANDBOX
- See Also:
-
SERIALIZED_NAME_META_DATA
- See Also:
-
SERIALIZED_NAME_FORM_GROUPS
- See Also:
-
SERIALIZED_NAME_RECIPIENT_NOTIFICATION_SETTINGS
- See Also:
-
SERIALIZED_NAME_ENABLE_AUDIT_TRAIL_LOCALIZATION
- See Also:
-
SERIALIZED_NAME_DOWNLOAD_FILE_NAME
- See Also:
-
SERIALIZED_NAME_SCHEDULED_SEND_TIME
- See Also:
-
SERIALIZED_NAME_ALLOW_SCHEDULED_SEND
- See Also:
-
openapiFields
-
openapiRequiredFields
-
-
Constructor Details
-
SendForSign
public SendForSign()
-
-
Method Details
-
files
-
addFilesItem
-
getFiles
-
setFiles
-
title
-
getTitle
-
setTitle
-
message
-
getMessage
-
setMessage
-
signers
-
addSignersItem
-
getSigners
-
setSigners
-
cc
-
addCcItem
-
getCc
-
setCc
-
enableSigningOrder
-
getEnableSigningOrder
-
setEnableSigningOrder
-
expiryDays
Deprecated. -
getExpiryDays
-
setExpiryDays
Deprecated. -
expiryDateType
-
getExpiryDateType
Get expiryDateType- Returns:
- expiryDateType
-
setExpiryDateType
-
expiryValue
-
getExpiryValue
-
setExpiryValue
-
reminderSettings
-
getReminderSettings
Get reminderSettings- Returns:
- reminderSettings
-
setReminderSettings
-
enableEmbeddedSigning
Deprecated. -
getEnableEmbeddedSigning
Deprecated.Get enableEmbeddedSigning- Returns:
- enableEmbeddedSigning
-
setEnableEmbeddedSigning
Deprecated. -
disableEmails
-
getDisableEmails
-
setDisableEmails
-
disableSMS
-
getDisableSMS
-
setDisableSMS
-
brandId
-
getBrandId
-
setBrandId
-
hideDocumentId
-
getHideDocumentId
-
setHideDocumentId
-
labels
-
addLabelsItem
-
getLabels
-
setLabels
-
fileUrls
-
addFileUrlsItem
-
getFileUrls
-
setFileUrls
-
sendLinkValidTill
-
getSendLinkValidTill
Get sendLinkValidTill- Returns:
- sendLinkValidTill
-
setSendLinkValidTill
-
useTextTags
-
getUseTextTags
-
setUseTextTags
-
textTagDefinitions
-
addTextTagDefinitionsItem
-
getTextTagDefinitions
Get textTagDefinitions- Returns:
- textTagDefinitions
-
setTextTagDefinitions
-
enablePrintAndSign
-
getEnablePrintAndSign
-
setEnablePrintAndSign
-
enableReassign
-
getEnableReassign
-
setEnableReassign
-
disableExpiryAlert
-
getDisableExpiryAlert
-
setDisableExpiryAlert
-
documentInfo
-
addDocumentInfoItem
-
getDocumentInfo
-
setDocumentInfo
-
onBehalfOf
-
getOnBehalfOf
-
setOnBehalfOf
-
autoDetectFields
-
getAutoDetectFields
-
setAutoDetectFields
-
documentDownloadOption
public SendForSign documentDownloadOption(SendForSign.DocumentDownloadOptionEnum documentDownloadOption) -
getDocumentDownloadOption
Get documentDownloadOption- Returns:
- documentDownloadOption
-
setDocumentDownloadOption
public void setDocumentDownloadOption(SendForSign.DocumentDownloadOptionEnum documentDownloadOption) -
isSandbox
-
getIsSandbox
-
setIsSandbox
-
metaData
-
putMetaDataItem
-
getMetaData
-
setMetaData
-
formGroups
-
addFormGroupsItem
-
getFormGroups
-
setFormGroups
-
recipientNotificationSettings
public SendForSign recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings) -
getRecipientNotificationSettings
Get recipientNotificationSettings- Returns:
- recipientNotificationSettings
-
setRecipientNotificationSettings
public void setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings) -
enableAuditTrailLocalization
-
getEnableAuditTrailLocalization
-
setEnableAuditTrailLocalization
-
downloadFileName
-
getDownloadFileName
-
setDownloadFileName
-
scheduledSendTime
-
getScheduledSendTime
-
setScheduledSendTime
-
allowScheduledSend
-
getAllowScheduledSend
-
setAllowScheduledSend
-
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 SendForSign
-
fromJson
Create an instance of SendForSign given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of SendForSign
- Throws:
IOException- if the JSON string is invalid with respect to SendForSign
-
toJson
-