Package com.boldsign.model

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 Classes

Modifier and Type	Class	Description
static class	SendForSign.AllowedSignatureTypesEnum	Gets or Sets allowedSignatureTypes
static class	SendForSign.CustomTypeAdapterFactory
static class	SendForSign.DocumentDownloadOptionEnum	Gets or Sets documentDownloadOption
static class	SendForSign.ExpiryDateTypeEnum	Gets or Sets expiryDateType

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_ALLOW_SCHEDULED_SEND
static String	SERIALIZED_NAME_ALLOWED_SIGNATURE_TYPES
static String	SERIALIZED_NAME_AUTO_DETECT_FIELDS
static String	SERIALIZED_NAME_BRAND_ID
static String	SERIALIZED_NAME_CC
static String	SERIALIZED_NAME_DISABLE_EMAILS
static String	SERIALIZED_NAME_DISABLE_EXPIRY_ALERT
static String	SERIALIZED_NAME_DISABLE_S_M_S
static String	SERIALIZED_NAME_DOCUMENT_DOWNLOAD_OPTION
static String	SERIALIZED_NAME_DOCUMENT_INFO
static String	SERIALIZED_NAME_DOWNLOAD_FILE_NAME
static String	SERIALIZED_NAME_ENABLE_AUDIT_TRAIL_LOCALIZATION
static String	SERIALIZED_NAME_ENABLE_EMBEDDED_SIGNING
static String	SERIALIZED_NAME_ENABLE_PRINT_AND_SIGN
static String	SERIALIZED_NAME_ENABLE_REASSIGN
static String	SERIALIZED_NAME_ENABLE_SIGNING_ORDER
static String	SERIALIZED_NAME_EXPIRY_DATE_TYPE
static String	SERIALIZED_NAME_EXPIRY_DAYS
static String	SERIALIZED_NAME_EXPIRY_VALUE
static String	SERIALIZED_NAME_FILE_URLS
static String	SERIALIZED_NAME_FILES
static String	SERIALIZED_NAME_FORM_GROUPS
static String	SERIALIZED_NAME_GROUP_SIGNER_SETTINGS
static String	SERIALIZED_NAME_HIDE_DOCUMENT_ID
static String	SERIALIZED_NAME_IS_SANDBOX
static String	SERIALIZED_NAME_LABELS
static String	SERIALIZED_NAME_MESSAGE
static String	SERIALIZED_NAME_META_DATA
static String	SERIALIZED_NAME_ON_BEHALF_OF
static String	SERIALIZED_NAME_RECIPIENT_NOTIFICATION_SETTINGS
static String	SERIALIZED_NAME_REMINDER_SETTINGS
static String	SERIALIZED_NAME_SCHEDULED_SEND_TIME
static String	SERIALIZED_NAME_SEND_LINK_VALID_TILL
static String	SERIALIZED_NAME_SIGNERS
static String	SERIALIZED_NAME_TEXT_TAG_DEFINITIONS
static String	SERIALIZED_NAME_TITLE
static String	SERIALIZED_NAME_USE_TEXT_TAGS

Constructor Summary

Constructors

Constructor	Description
SendForSign()

Method Summary

Modifier and Type	Method	Description
SendForSign	addAllowedSignatureTypesItem(SendForSign.AllowedSignatureTypesEnum allowedSignatureTypesItem)
SendForSign	addCcItem(DocumentCC ccItem)
SendForSign	addDocumentInfoItem(DocumentInfo documentInfoItem)
SendForSign	addFilesItem(File filesItem)
SendForSign	addFileUrlsItem(URI fileUrlsItem)
SendForSign	addFormGroupsItem(FormGroup formGroupsItem)
SendForSign	addLabelsItem(String labelsItem)
SendForSign	addSignersItem(DocumentSigner signersItem)
SendForSign	addTextTagDefinitionsItem(TextTagDefinition textTagDefinitionsItem)
SendForSign	allowedSignatureTypes(List<SendForSign.AllowedSignatureTypesEnum> allowedSignatureTypes)
SendForSign	allowScheduledSend(Boolean allowScheduledSend)
SendForSign	autoDetectFields(Boolean autoDetectFields)
SendForSign	brandId(String brandId)
SendForSign	cc(List<DocumentCC> cc)
Map<String,Object>	createFormData()
SendForSign	disableEmails(Boolean disableEmails)
SendForSign	disableExpiryAlert(Boolean disableExpiryAlert)
SendForSign	disableSMS(Boolean disableSMS)
SendForSign	documentDownloadOption(SendForSign.DocumentDownloadOptionEnum documentDownloadOption)
SendForSign	documentInfo(List<DocumentInfo> documentInfo)
SendForSign	downloadFileName(String downloadFileName)
SendForSign	enableAuditTrailLocalization(Boolean enableAuditTrailLocalization)
SendForSign	enableEmbeddedSigning(Boolean enableEmbeddedSigning)	Deprecated.
SendForSign	enablePrintAndSign(Boolean enablePrintAndSign)
SendForSign	enableReassign(Boolean enableReassign)
SendForSign	enableSigningOrder(Boolean enableSigningOrder)
boolean	equals(Object o)
SendForSign	expiryDateType(SendForSign.ExpiryDateTypeEnum expiryDateType)
SendForSign	expiryDays(Integer expiryDays)	Deprecated.
SendForSign	expiryValue(Long expiryValue)
SendForSign	files(List<File> files)
SendForSign	fileUrls(List<URI> fileUrls)
SendForSign	formGroups(List<FormGroup> formGroups)
static SendForSign	fromJson(String jsonString)	Create an instance of SendForSign given an JSON string
List<SendForSign.AllowedSignatureTypesEnum>	getAllowedSignatureTypes()	Get allowedSignatureTypes
Boolean	getAllowScheduledSend()	Get allowScheduledSend
Boolean	getAutoDetectFields()	Get autoDetectFields
String	getBrandId()	Get brandId
List<DocumentCC>	getCc()	Get cc
Boolean	getDisableEmails()	Get disableEmails
Boolean	getDisableExpiryAlert()	Get disableExpiryAlert
Boolean	getDisableSMS()	Get disableSMS
SendForSign.DocumentDownloadOptionEnum	getDocumentDownloadOption()	Get documentDownloadOption
List<DocumentInfo>	getDocumentInfo()	Get documentInfo
String	getDownloadFileName()	Get downloadFileName
Boolean	getEnableAuditTrailLocalization()	Get enableAuditTrailLocalization
Boolean	getEnableEmbeddedSigning()	Deprecated.
Boolean	getEnablePrintAndSign()	Get enablePrintAndSign
Boolean	getEnableReassign()	Get enableReassign
Boolean	getEnableSigningOrder()	Get enableSigningOrder
SendForSign.ExpiryDateTypeEnum	getExpiryDateType()	Get expiryDateType
Integer	getExpiryDays()	Deprecated.
Long	getExpiryValue()	Get expiryValue
List<File>	getFiles()	Get files
List<URI>	getFileUrls()	Get fileUrls
List<FormGroup>	getFormGroups()	Get formGroups
GroupSignerSettings	getGroupSignerSettings()	Get groupSignerSettings
Boolean	getHideDocumentId()	Get hideDocumentId
Boolean	getIsSandbox()	Get isSandbox
List<String>	getLabels()	Get labels
String	getMessage()	Get message
Map<String,String>	getMetaData()	Get metaData
String	getOnBehalfOf()	Get onBehalfOf
RecipientNotificationSettings	getRecipientNotificationSettings()	Get recipientNotificationSettings
ReminderSettings	getReminderSettings()	Get reminderSettings
Long	getScheduledSendTime()	Get scheduledSendTime
OffsetDateTime	getSendLinkValidTill()	Get sendLinkValidTill
List<DocumentSigner>	getSigners()	Get signers
List<TextTagDefinition>	getTextTagDefinitions()	Get textTagDefinitions
String	getTitle()	Get title
Boolean	getUseTextTags()	Get useTextTags
SendForSign	groupSignerSettings(GroupSignerSettings groupSignerSettings)
int	hashCode()
SendForSign	hideDocumentId(Boolean hideDocumentId)
SendForSign	isSandbox(Boolean isSandbox)
SendForSign	labels(List<String> labels)
SendForSign	message(String message)
SendForSign	metaData(Map<String,String> metaData)
SendForSign	onBehalfOf(String onBehalfOf)
SendForSign	putMetaDataItem(String key, String metaDataItem)
SendForSign	recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)
SendForSign	reminderSettings(ReminderSettings reminderSettings)
SendForSign	scheduledSendTime(Long scheduledSendTime)
SendForSign	sendLinkValidTill(OffsetDateTime sendLinkValidTill)
void	setAllowedSignatureTypes(List<SendForSign.AllowedSignatureTypesEnum> allowedSignatureTypes)
void	setAllowScheduledSend(Boolean allowScheduledSend)
void	setAutoDetectFields(Boolean autoDetectFields)
void	setBrandId(String brandId)
void	setCc(List<DocumentCC> cc)
void	setDisableEmails(Boolean disableEmails)
void	setDisableExpiryAlert(Boolean disableExpiryAlert)
void	setDisableSMS(Boolean disableSMS)
void	setDocumentDownloadOption(SendForSign.DocumentDownloadOptionEnum documentDownloadOption)
void	setDocumentInfo(List<DocumentInfo> documentInfo)
void	setDownloadFileName(String downloadFileName)
void	setEnableAuditTrailLocalization(Boolean enableAuditTrailLocalization)
void	setEnableEmbeddedSigning(Boolean enableEmbeddedSigning)	Deprecated.
void	setEnablePrintAndSign(Boolean enablePrintAndSign)
void	setEnableReassign(Boolean enableReassign)
void	setEnableSigningOrder(Boolean enableSigningOrder)
void	setExpiryDateType(SendForSign.ExpiryDateTypeEnum expiryDateType)
void	setExpiryDays(Integer expiryDays)	Deprecated.
void	setExpiryValue(Long expiryValue)
void	setFiles(List<File> files)
void	setFileUrls(List<URI> fileUrls)
void	setFormGroups(List<FormGroup> formGroups)
void	setGroupSignerSettings(GroupSignerSettings groupSignerSettings)
void	setHideDocumentId(Boolean hideDocumentId)
void	setIsSandbox(Boolean isSandbox)
void	setLabels(List<String> labels)
void	setMessage(String message)
void	setMetaData(Map<String,String> metaData)
void	setOnBehalfOf(String onBehalfOf)
void	setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)
void	setReminderSettings(ReminderSettings reminderSettings)
void	setScheduledSendTime(Long scheduledSendTime)
void	setSendLinkValidTill(OffsetDateTime sendLinkValidTill)
void	setSigners(List<DocumentSigner> signers)
void	setTextTagDefinitions(List<TextTagDefinition> textTagDefinitions)
void	setTitle(String title)
void	setUseTextTags(Boolean useTextTags)
SendForSign	signers(List<DocumentSigner> signers)
SendForSign	textTagDefinitions(List<TextTagDefinition> textTagDefinitions)
SendForSign	title(String title)
String	toJson()	Convert an instance of SendForSign to an JSON string
String	toString()
SendForSign	useTextTags(Boolean useTextTags)
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_FILES

public static final String SERIALIZED_NAME_FILES

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_SIGNERS

public static final String SERIALIZED_NAME_SIGNERS

See Also:

Constant Field Values

SERIALIZED_NAME_CC

public static final String SERIALIZED_NAME_CC

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_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_REMINDER_SETTINGS

public static final String SERIALIZED_NAME_REMINDER_SETTINGS

See Also:

Constant Field Values

SERIALIZED_NAME_ENABLE_EMBEDDED_SIGNING

public static final String SERIALIZED_NAME_ENABLE_EMBEDDED_SIGNING

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_BRAND_ID

public static final String SERIALIZED_NAME_BRAND_ID

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_LABELS

public static final String SERIALIZED_NAME_LABELS

See Also:

Constant Field Values

SERIALIZED_NAME_FILE_URLS

public static final String SERIALIZED_NAME_FILE_URLS

See Also:

Constant Field Values

SERIALIZED_NAME_SEND_LINK_VALID_TILL

public static final String SERIALIZED_NAME_SEND_LINK_VALID_TILL

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_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_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_AUTO_DETECT_FIELDS

public static final String SERIALIZED_NAME_AUTO_DETECT_FIELDS

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_IS_SANDBOX

public static final String SERIALIZED_NAME_IS_SANDBOX

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_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

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

SendForSign

public SendForSign()

Method Detail

files

public SendForSign files(List<File> files)

addFilesItem

public SendForSign addFilesItem(File filesItem)

getFiles

@Nullable
public List<File> getFiles()

Get files

Returns:

files

setFiles

public void setFiles(List<File> files)

title

public SendForSign title(String title)

getTitle

@Nullable
public String getTitle()

Get title

Returns:

title

setTitle

public void setTitle(String title)

message

public SendForSign message(String message)

getMessage

@Nullable
public String getMessage()

Get message

Returns:

message

setMessage

public void setMessage(String message)

signers

public SendForSign signers(List<DocumentSigner> signers)

addSignersItem

public SendForSign addSignersItem(DocumentSigner signersItem)

getSigners

@Nullable
public List<DocumentSigner> getSigners()

Get signers

Returns:

signers

setSigners

public void setSigners(List<DocumentSigner> signers)

cc

public SendForSign cc(List<DocumentCC> cc)

addCcItem

public SendForSign addCcItem(DocumentCC ccItem)

getCc

@Nullable
public List<DocumentCC> getCc()

Get cc

Returns:

cc

setCc

public void setCc(List<DocumentCC> cc)

enableSigningOrder

public SendForSign enableSigningOrder(Boolean enableSigningOrder)

getEnableSigningOrder

@Nullable
public Boolean getEnableSigningOrder()

Get enableSigningOrder

Returns:

enableSigningOrder

setEnableSigningOrder

public void setEnableSigningOrder(Boolean enableSigningOrder)

expiryDays

@Deprecated
public SendForSign 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 SendForSign expiryDateType(SendForSign.ExpiryDateTypeEnum expiryDateType)

getExpiryDateType

@Nullable
public SendForSign.ExpiryDateTypeEnum getExpiryDateType()

Get expiryDateType

Returns:

expiryDateType

setExpiryDateType

public void setExpiryDateType(SendForSign.ExpiryDateTypeEnum expiryDateType)

expiryValue

public SendForSign expiryValue(Long expiryValue)

getExpiryValue

@Nullable
public Long getExpiryValue()

Get expiryValue

Returns:

expiryValue

setExpiryValue

public void setExpiryValue(Long expiryValue)

reminderSettings

public SendForSign reminderSettings(ReminderSettings reminderSettings)

getReminderSettings

@Nullable
public ReminderSettings getReminderSettings()

Get reminderSettings

Returns:

reminderSettings

setReminderSettings

public void setReminderSettings(ReminderSettings reminderSettings)

enableEmbeddedSigning

@Deprecated
public SendForSign enableEmbeddedSigning(Boolean enableEmbeddedSigning)

Deprecated.

getEnableEmbeddedSigning

@Deprecated
@Nullable
public Boolean getEnableEmbeddedSigning()

Deprecated.

Get enableEmbeddedSigning

Returns:

enableEmbeddedSigning

setEnableEmbeddedSigning

@Deprecated
public void setEnableEmbeddedSigning(Boolean enableEmbeddedSigning)

Deprecated.

disableEmails

public SendForSign disableEmails(Boolean disableEmails)

getDisableEmails

@Nullable
public Boolean getDisableEmails()

Get disableEmails

Returns:

disableEmails

setDisableEmails

public void setDisableEmails(Boolean disableEmails)

disableSMS

public SendForSign disableSMS(Boolean disableSMS)

getDisableSMS

@Nullable
public Boolean getDisableSMS()

Get disableSMS

Returns:

disableSMS

setDisableSMS

public void setDisableSMS(Boolean disableSMS)

brandId

public SendForSign brandId(String brandId)

getBrandId

@Nullable
public String getBrandId()

Get brandId

Returns:

brandId

setBrandId

public void setBrandId(String brandId)

hideDocumentId

public SendForSign hideDocumentId(Boolean hideDocumentId)

getHideDocumentId

@Nullable
public Boolean getHideDocumentId()

Get hideDocumentId

Returns:

hideDocumentId

setHideDocumentId

public void setHideDocumentId(Boolean hideDocumentId)

labels

public SendForSign labels(List<String> labels)

addLabelsItem

public SendForSign addLabelsItem(String labelsItem)

getLabels

@Nullable
public List<String> getLabels()

Get labels

Returns:

labels

setLabels

public void setLabels(List<String> labels)

fileUrls

public SendForSign fileUrls(List<URI> fileUrls)

addFileUrlsItem

public SendForSign addFileUrlsItem(URI fileUrlsItem)

getFileUrls

@Nullable
public List<URI> getFileUrls()

Get fileUrls

Returns:

fileUrls

setFileUrls

public void setFileUrls(List<URI> fileUrls)

sendLinkValidTill

public SendForSign sendLinkValidTill(OffsetDateTime sendLinkValidTill)

getSendLinkValidTill

@Nullable
public OffsetDateTime getSendLinkValidTill()

Get sendLinkValidTill

Returns:

sendLinkValidTill

setSendLinkValidTill

public void setSendLinkValidTill(OffsetDateTime sendLinkValidTill)

useTextTags

public SendForSign useTextTags(Boolean useTextTags)

getUseTextTags

@Nullable
public Boolean getUseTextTags()

Get useTextTags

Returns:

useTextTags

setUseTextTags

public void setUseTextTags(Boolean useTextTags)

textTagDefinitions

public SendForSign textTagDefinitions(List<TextTagDefinition> textTagDefinitions)

addTextTagDefinitionsItem

public SendForSign addTextTagDefinitionsItem(TextTagDefinition textTagDefinitionsItem)

getTextTagDefinitions

@Nullable
public List<TextTagDefinition> getTextTagDefinitions()

Get textTagDefinitions

Returns:

textTagDefinitions

setTextTagDefinitions

public void setTextTagDefinitions(List<TextTagDefinition> textTagDefinitions)

enablePrintAndSign

public SendForSign enablePrintAndSign(Boolean enablePrintAndSign)

getEnablePrintAndSign

@Nullable
public Boolean getEnablePrintAndSign()

Get enablePrintAndSign

Returns:

enablePrintAndSign

setEnablePrintAndSign

public void setEnablePrintAndSign(Boolean enablePrintAndSign)

enableReassign

public SendForSign enableReassign(Boolean enableReassign)

getEnableReassign

@Nullable
public Boolean getEnableReassign()

Get enableReassign

Returns:

enableReassign

setEnableReassign

public void setEnableReassign(Boolean enableReassign)

disableExpiryAlert

public SendForSign disableExpiryAlert(Boolean disableExpiryAlert)

getDisableExpiryAlert

@Nullable
public Boolean getDisableExpiryAlert()

Get disableExpiryAlert

Returns:

disableExpiryAlert

setDisableExpiryAlert

public void setDisableExpiryAlert(Boolean disableExpiryAlert)

documentInfo

public SendForSign documentInfo(List<DocumentInfo> documentInfo)

addDocumentInfoItem

public SendForSign addDocumentInfoItem(DocumentInfo documentInfoItem)

getDocumentInfo

@Nullable
public List<DocumentInfo> getDocumentInfo()

Get documentInfo

Returns:

documentInfo

setDocumentInfo

public void setDocumentInfo(List<DocumentInfo> documentInfo)

onBehalfOf

public SendForSign onBehalfOf(String onBehalfOf)

getOnBehalfOf

@Nullable
public String getOnBehalfOf()

Get onBehalfOf

Returns:

onBehalfOf

setOnBehalfOf

public void setOnBehalfOf(String onBehalfOf)

autoDetectFields

public SendForSign autoDetectFields(Boolean autoDetectFields)

getAutoDetectFields

@Nullable
public Boolean getAutoDetectFields()

Get autoDetectFields

Returns:

autoDetectFields

setAutoDetectFields

public void setAutoDetectFields(Boolean autoDetectFields)

documentDownloadOption

public SendForSign documentDownloadOption(SendForSign.DocumentDownloadOptionEnum documentDownloadOption)

getDocumentDownloadOption

@Nullable
public SendForSign.DocumentDownloadOptionEnum getDocumentDownloadOption()

Get documentDownloadOption

Returns:

documentDownloadOption

setDocumentDownloadOption

public void setDocumentDownloadOption(SendForSign.DocumentDownloadOptionEnum documentDownloadOption)

isSandbox

public SendForSign isSandbox(Boolean isSandbox)

getIsSandbox

@Nullable
public Boolean getIsSandbox()

Get isSandbox

Returns:

isSandbox

setIsSandbox

public void setIsSandbox(Boolean isSandbox)

metaData

public SendForSign metaData(Map<String,String> metaData)

putMetaDataItem

public SendForSign putMetaDataItem(String key,
                                   String metaDataItem)

getMetaData

@Nullable
public Map<String,String> getMetaData()

Get metaData

Returns:

metaData

setMetaData

public void setMetaData(Map<String,String> metaData)

formGroups

public SendForSign formGroups(List<FormGroup> formGroups)

addFormGroupsItem

public SendForSign addFormGroupsItem(FormGroup formGroupsItem)

getFormGroups

@Nullable
public List<FormGroup> getFormGroups()

Get formGroups

Returns:

formGroups

setFormGroups

public void setFormGroups(List<FormGroup> formGroups)

recipientNotificationSettings

public SendForSign recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)

getRecipientNotificationSettings

@Nullable
public RecipientNotificationSettings getRecipientNotificationSettings()

Get recipientNotificationSettings

Returns:

recipientNotificationSettings

setRecipientNotificationSettings

public void setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)

enableAuditTrailLocalization

public SendForSign enableAuditTrailLocalization(Boolean enableAuditTrailLocalization)

getEnableAuditTrailLocalization

@Nullable
public Boolean getEnableAuditTrailLocalization()

Get enableAuditTrailLocalization

Returns:

enableAuditTrailLocalization

setEnableAuditTrailLocalization

public void setEnableAuditTrailLocalization(Boolean enableAuditTrailLocalization)

downloadFileName

public SendForSign downloadFileName(String downloadFileName)

getDownloadFileName

@Nullable
public String getDownloadFileName()

Get downloadFileName

Returns:

downloadFileName

setDownloadFileName

public void setDownloadFileName(String downloadFileName)

scheduledSendTime

public SendForSign scheduledSendTime(Long scheduledSendTime)

getScheduledSendTime

@Nullable
public Long getScheduledSendTime()

Get scheduledSendTime

Returns:

scheduledSendTime

setScheduledSendTime

public void setScheduledSendTime(Long scheduledSendTime)

allowScheduledSend

public SendForSign allowScheduledSend(Boolean allowScheduledSend)

getAllowScheduledSend

@Nullable
public Boolean getAllowScheduledSend()

Get allowScheduledSend

Returns:

allowScheduledSend

setAllowScheduledSend

public void setAllowScheduledSend(Boolean allowScheduledSend)

allowedSignatureTypes

public SendForSign allowedSignatureTypes(List<SendForSign.AllowedSignatureTypesEnum> allowedSignatureTypes)

addAllowedSignatureTypesItem

public SendForSign addAllowedSignatureTypesItem(SendForSign.AllowedSignatureTypesEnum allowedSignatureTypesItem)

getAllowedSignatureTypes

@Nullable
public List<SendForSign.AllowedSignatureTypesEnum> getAllowedSignatureTypes()

Get allowedSignatureTypes

Returns:

allowedSignatureTypes

setAllowedSignatureTypes

public void setAllowedSignatureTypes(List<SendForSign.AllowedSignatureTypesEnum> allowedSignatureTypes)

groupSignerSettings

public SendForSign groupSignerSettings(GroupSignerSettings groupSignerSettings)

getGroupSignerSettings

@Nullable
public GroupSignerSettings getGroupSignerSettings()

Get groupSignerSettings

Returns:

groupSignerSettings

setGroupSignerSettings

public void setGroupSignerSettings(GroupSignerSettings groupSignerSettings)

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 SendForSign

fromJson

public static SendForSign fromJson(String jsonString)
                            throws IOException

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

public String toJson()

Convert an instance of SendForSign to an JSON string

Returns:

JSON string