Package com.boldsign.model

Class EmbeddedDocumentRequest

java.lang.Object

com.boldsign.model.EmbeddedDocumentRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.8.0")
public class EmbeddedDocumentRequest
extends Object

EmbeddedDocumentRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EmbeddedDocumentRequest.CustomTypeAdapterFactory
static class	EmbeddedDocumentRequest.DocumentDownloadOptionEnum	Gets or Sets documentDownloadOption
static class	EmbeddedDocumentRequest.ExpiryDateTypeEnum	Gets or Sets expiryDateType
static class	EmbeddedDocumentRequest.LocaleEnum	Gets or Sets locale
static class	EmbeddedDocumentRequest.SendViewOptionEnum	Gets or Sets sendViewOption

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_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_EMBEDDED_SEND_LINK_VALID_TILL
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_HIDE_DOCUMENT_ID
static String	SERIALIZED_NAME_IS_SANDBOX
static String	SERIALIZED_NAME_LABELS
static String	SERIALIZED_NAME_LOCALE
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_REDIRECT_URL
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_SEND_VIEW_OPTION
static String	SERIALIZED_NAME_SHOW_NAVIGATION_BUTTONS
static String	SERIALIZED_NAME_SHOW_PREVIEW_BUTTON
static String	SERIALIZED_NAME_SHOW_SAVE_BUTTON
static String	SERIALIZED_NAME_SHOW_SEND_BUTTON
static String	SERIALIZED_NAME_SHOW_TOOLBAR
static String	SERIALIZED_NAME_SHOW_TOOLTIP
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
EmbeddedDocumentRequest()

Method Summary

Modifier and Type	Method	Description
EmbeddedDocumentRequest	addCcItem(DocumentCC ccItem)
EmbeddedDocumentRequest	addDocumentInfoItem(DocumentInfo documentInfoItem)
EmbeddedDocumentRequest	addFilesItem(File filesItem)
EmbeddedDocumentRequest	addFileUrlsItem(URI fileUrlsItem)
EmbeddedDocumentRequest	addFormGroupsItem(FormGroup formGroupsItem)
EmbeddedDocumentRequest	addLabelsItem(String labelsItem)
EmbeddedDocumentRequest	addSignersItem(DocumentSigner signersItem)
EmbeddedDocumentRequest	addTextTagDefinitionsItem(TextTagDefinition textTagDefinitionsItem)
EmbeddedDocumentRequest	allowScheduledSend(Boolean allowScheduledSend)
EmbeddedDocumentRequest	autoDetectFields(Boolean autoDetectFields)
EmbeddedDocumentRequest	brandId(String brandId)
EmbeddedDocumentRequest	cc(List<DocumentCC> cc)
Map<String,Object>	createFormData()
EmbeddedDocumentRequest	disableEmails(Boolean disableEmails)
EmbeddedDocumentRequest	disableExpiryAlert(Boolean disableExpiryAlert)
EmbeddedDocumentRequest	disableSMS(Boolean disableSMS)
EmbeddedDocumentRequest	documentDownloadOption(EmbeddedDocumentRequest.DocumentDownloadOptionEnum documentDownloadOption)
EmbeddedDocumentRequest	documentInfo(List<DocumentInfo> documentInfo)
EmbeddedDocumentRequest	downloadFileName(String downloadFileName)
EmbeddedDocumentRequest	embeddedSendLinkValidTill(OffsetDateTime embeddedSendLinkValidTill)
EmbeddedDocumentRequest	enableAuditTrailLocalization(Boolean enableAuditTrailLocalization)
EmbeddedDocumentRequest	enableEmbeddedSigning(Boolean enableEmbeddedSigning)	Deprecated.
EmbeddedDocumentRequest	enablePrintAndSign(Boolean enablePrintAndSign)
EmbeddedDocumentRequest	enableReassign(Boolean enableReassign)
EmbeddedDocumentRequest	enableSigningOrder(Boolean enableSigningOrder)
boolean	equals(Object o)
EmbeddedDocumentRequest	expiryDateType(EmbeddedDocumentRequest.ExpiryDateTypeEnum expiryDateType)
EmbeddedDocumentRequest	expiryDays(Integer expiryDays)	Deprecated.
EmbeddedDocumentRequest	expiryValue(Long expiryValue)
EmbeddedDocumentRequest	files(List<File> files)
EmbeddedDocumentRequest	fileUrls(List<URI> fileUrls)
EmbeddedDocumentRequest	formGroups(List<FormGroup> formGroups)
static EmbeddedDocumentRequest	fromJson(String jsonString)	Create an instance of EmbeddedDocumentRequest given an JSON string
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
EmbeddedDocumentRequest.DocumentDownloadOptionEnum	getDocumentDownloadOption()	Get documentDownloadOption
List<DocumentInfo>	getDocumentInfo()	Get documentInfo
String	getDownloadFileName()	Get downloadFileName
OffsetDateTime	getEmbeddedSendLinkValidTill()	Get embeddedSendLinkValidTill
Boolean	getEnableAuditTrailLocalization()	Get enableAuditTrailLocalization
Boolean	getEnableEmbeddedSigning()	Deprecated.
Boolean	getEnablePrintAndSign()	Get enablePrintAndSign
Boolean	getEnableReassign()	Get enableReassign
Boolean	getEnableSigningOrder()	Get enableSigningOrder
EmbeddedDocumentRequest.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
Boolean	getHideDocumentId()	Get hideDocumentId
Boolean	getIsSandbox()	Get isSandbox
List<String>	getLabels()	Get labels
EmbeddedDocumentRequest.LocaleEnum	getLocale()	Get locale
String	getMessage()	Get message
Map<String,String>	getMetaData()	Get metaData
String	getOnBehalfOf()	Get onBehalfOf
RecipientNotificationSettings	getRecipientNotificationSettings()	Get recipientNotificationSettings
URI	getRedirectUrl()	Get redirectUrl
ReminderSettings	getReminderSettings()	Get reminderSettings
Long	getScheduledSendTime()	Get scheduledSendTime
OffsetDateTime	getSendLinkValidTill()	Get sendLinkValidTill
EmbeddedDocumentRequest.SendViewOptionEnum	getSendViewOption()	Get sendViewOption
Boolean	getShowNavigationButtons()	Get showNavigationButtons
Boolean	getShowPreviewButton()	Get showPreviewButton
Boolean	getShowSaveButton()	Get showSaveButton
Boolean	getShowSendButton()	Get showSendButton
Boolean	getShowToolbar()	Get showToolbar
Boolean	getShowTooltip()	Get showTooltip
List<DocumentSigner>	getSigners()	Get signers
List<TextTagDefinition>	getTextTagDefinitions()	Get textTagDefinitions
String	getTitle()	Get title
Boolean	getUseTextTags()	Get useTextTags
int	hashCode()
EmbeddedDocumentRequest	hideDocumentId(Boolean hideDocumentId)
EmbeddedDocumentRequest	isSandbox(Boolean isSandbox)
EmbeddedDocumentRequest	labels(List<String> labels)
EmbeddedDocumentRequest	locale(EmbeddedDocumentRequest.LocaleEnum locale)
EmbeddedDocumentRequest	message(String message)
EmbeddedDocumentRequest	metaData(Map<String,String> metaData)
EmbeddedDocumentRequest	onBehalfOf(String onBehalfOf)
EmbeddedDocumentRequest	putMetaDataItem(String key, String metaDataItem)
EmbeddedDocumentRequest	recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)
EmbeddedDocumentRequest	redirectUrl(URI redirectUrl)
EmbeddedDocumentRequest	reminderSettings(ReminderSettings reminderSettings)
EmbeddedDocumentRequest	scheduledSendTime(Long scheduledSendTime)
EmbeddedDocumentRequest	sendLinkValidTill(OffsetDateTime sendLinkValidTill)
EmbeddedDocumentRequest	sendViewOption(EmbeddedDocumentRequest.SendViewOptionEnum sendViewOption)
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(EmbeddedDocumentRequest.DocumentDownloadOptionEnum documentDownloadOption)
void	setDocumentInfo(List<DocumentInfo> documentInfo)
void	setDownloadFileName(String downloadFileName)
void	setEmbeddedSendLinkValidTill(OffsetDateTime embeddedSendLinkValidTill)
void	setEnableAuditTrailLocalization(Boolean enableAuditTrailLocalization)
void	setEnableEmbeddedSigning(Boolean enableEmbeddedSigning)	Deprecated.
void	setEnablePrintAndSign(Boolean enablePrintAndSign)
void	setEnableReassign(Boolean enableReassign)
void	setEnableSigningOrder(Boolean enableSigningOrder)
void	setExpiryDateType(EmbeddedDocumentRequest.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	setHideDocumentId(Boolean hideDocumentId)
void	setIsSandbox(Boolean isSandbox)
void	setLabels(List<String> labels)
void	setLocale(EmbeddedDocumentRequest.LocaleEnum locale)
void	setMessage(String message)
void	setMetaData(Map<String,String> metaData)
void	setOnBehalfOf(String onBehalfOf)
void	setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)
void	setRedirectUrl(URI redirectUrl)
void	setReminderSettings(ReminderSettings reminderSettings)
void	setScheduledSendTime(Long scheduledSendTime)
void	setSendLinkValidTill(OffsetDateTime sendLinkValidTill)
void	setSendViewOption(EmbeddedDocumentRequest.SendViewOptionEnum sendViewOption)
void	setShowNavigationButtons(Boolean showNavigationButtons)
void	setShowPreviewButton(Boolean showPreviewButton)
void	setShowSaveButton(Boolean showSaveButton)
void	setShowSendButton(Boolean showSendButton)
void	setShowToolbar(Boolean showToolbar)
void	setShowTooltip(Boolean showTooltip)
void	setSigners(List<DocumentSigner> signers)
void	setTextTagDefinitions(List<TextTagDefinition> textTagDefinitions)
void	setTitle(String title)
void	setUseTextTags(Boolean useTextTags)
EmbeddedDocumentRequest	showNavigationButtons(Boolean showNavigationButtons)
EmbeddedDocumentRequest	showPreviewButton(Boolean showPreviewButton)
EmbeddedDocumentRequest	showSaveButton(Boolean showSaveButton)
EmbeddedDocumentRequest	showSendButton(Boolean showSendButton)
EmbeddedDocumentRequest	showToolbar(Boolean showToolbar)
EmbeddedDocumentRequest	showTooltip(Boolean showTooltip)
EmbeddedDocumentRequest	signers(List<DocumentSigner> signers)
EmbeddedDocumentRequest	textTagDefinitions(List<TextTagDefinition> textTagDefinitions)
EmbeddedDocumentRequest	title(String title)
String	toJson()	Convert an instance of EmbeddedDocumentRequest to an JSON string
String	toString()
EmbeddedDocumentRequest	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_REDIRECT_URL

public static final String SERIALIZED_NAME_REDIRECT_URL

See Also:

Constant Field Values

SERIALIZED_NAME_SHOW_TOOLBAR

public static final String SERIALIZED_NAME_SHOW_TOOLBAR

See Also:

Constant Field Values

SERIALIZED_NAME_SEND_VIEW_OPTION

public static final String SERIALIZED_NAME_SEND_VIEW_OPTION

See Also:

Constant Field Values

SERIALIZED_NAME_SHOW_SAVE_BUTTON

public static final String SERIALIZED_NAME_SHOW_SAVE_BUTTON

See Also:

Constant Field Values

SERIALIZED_NAME_LOCALE

public static final String SERIALIZED_NAME_LOCALE

See Also:

Constant Field Values

SERIALIZED_NAME_SHOW_SEND_BUTTON

public static final String SERIALIZED_NAME_SHOW_SEND_BUTTON

See Also:

Constant Field Values

SERIALIZED_NAME_SHOW_PREVIEW_BUTTON

public static final String SERIALIZED_NAME_SHOW_PREVIEW_BUTTON

See Also:

Constant Field Values

SERIALIZED_NAME_SHOW_NAVIGATION_BUTTONS

public static final String SERIALIZED_NAME_SHOW_NAVIGATION_BUTTONS

See Also:

Constant Field Values

SERIALIZED_NAME_SHOW_TOOLTIP

public static final String SERIALIZED_NAME_SHOW_TOOLTIP

See Also:

Constant Field Values

SERIALIZED_NAME_EMBEDDED_SEND_LINK_VALID_TILL

public static final String SERIALIZED_NAME_EMBEDDED_SEND_LINK_VALID_TILL

See Also:

Constant Field Values

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

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

EmbeddedDocumentRequest

public EmbeddedDocumentRequest()

Method Detail

redirectUrl

public EmbeddedDocumentRequest redirectUrl(URI redirectUrl)

getRedirectUrl

@Nullable
public URI getRedirectUrl()

Get redirectUrl

Returns:

redirectUrl

setRedirectUrl

public void setRedirectUrl(URI redirectUrl)

showToolbar

public EmbeddedDocumentRequest showToolbar(Boolean showToolbar)

getShowToolbar

@Nullable
public Boolean getShowToolbar()

Get showToolbar

Returns:

showToolbar

setShowToolbar

public void setShowToolbar(Boolean showToolbar)

sendViewOption

public EmbeddedDocumentRequest sendViewOption(EmbeddedDocumentRequest.SendViewOptionEnum sendViewOption)

getSendViewOption

@Nullable
public EmbeddedDocumentRequest.SendViewOptionEnum getSendViewOption()

Get sendViewOption

Returns:

sendViewOption

setSendViewOption

public void setSendViewOption(EmbeddedDocumentRequest.SendViewOptionEnum sendViewOption)

showSaveButton

public EmbeddedDocumentRequest showSaveButton(Boolean showSaveButton)

getShowSaveButton

@Nullable
public Boolean getShowSaveButton()

Get showSaveButton

Returns:

showSaveButton

setShowSaveButton

public void setShowSaveButton(Boolean showSaveButton)

locale

public EmbeddedDocumentRequest locale(EmbeddedDocumentRequest.LocaleEnum locale)

getLocale

@Nullable
public EmbeddedDocumentRequest.LocaleEnum getLocale()

Get locale

Returns:

locale

setLocale

public void setLocale(EmbeddedDocumentRequest.LocaleEnum locale)

showSendButton

public EmbeddedDocumentRequest showSendButton(Boolean showSendButton)

getShowSendButton

@Nullable
public Boolean getShowSendButton()

Get showSendButton

Returns:

showSendButton

setShowSendButton

public void setShowSendButton(Boolean showSendButton)

showPreviewButton

public EmbeddedDocumentRequest showPreviewButton(Boolean showPreviewButton)

getShowPreviewButton

@Nullable
public Boolean getShowPreviewButton()

Get showPreviewButton

Returns:

showPreviewButton

setShowPreviewButton

public void setShowPreviewButton(Boolean showPreviewButton)

showNavigationButtons

public EmbeddedDocumentRequest showNavigationButtons(Boolean showNavigationButtons)

getShowNavigationButtons

@Nullable
public Boolean getShowNavigationButtons()

Get showNavigationButtons

Returns:

showNavigationButtons

setShowNavigationButtons

public void setShowNavigationButtons(Boolean showNavigationButtons)

showTooltip

public EmbeddedDocumentRequest showTooltip(Boolean showTooltip)

getShowTooltip

@Nullable
public Boolean getShowTooltip()

Get showTooltip

Returns:

showTooltip

setShowTooltip

public void setShowTooltip(Boolean showTooltip)

embeddedSendLinkValidTill

public EmbeddedDocumentRequest embeddedSendLinkValidTill(OffsetDateTime embeddedSendLinkValidTill)

getEmbeddedSendLinkValidTill

@Nullable
public OffsetDateTime getEmbeddedSendLinkValidTill()

Get embeddedSendLinkValidTill

Returns:

embeddedSendLinkValidTill

setEmbeddedSendLinkValidTill

public void setEmbeddedSendLinkValidTill(OffsetDateTime embeddedSendLinkValidTill)

files

public EmbeddedDocumentRequest files(List<File> files)

addFilesItem

public EmbeddedDocumentRequest addFilesItem(File filesItem)

getFiles

@Nullable
public List<File> getFiles()

Get files

Returns:

files

setFiles

public void setFiles(List<File> files)

title

public EmbeddedDocumentRequest title(String title)

getTitle

@Nullable
public String getTitle()

Get title

Returns:

title

setTitle

public void setTitle(String title)

message

public EmbeddedDocumentRequest message(String message)

getMessage

@Nullable
public String getMessage()

Get message

Returns:

message

setMessage

public void setMessage(String message)

signers

public EmbeddedDocumentRequest signers(List<DocumentSigner> signers)

addSignersItem

public EmbeddedDocumentRequest addSignersItem(DocumentSigner signersItem)

getSigners

@Nullable
public List<DocumentSigner> getSigners()

Get signers

Returns:

signers

setSigners

public void setSigners(List<DocumentSigner> signers)

cc

public EmbeddedDocumentRequest cc(List<DocumentCC> cc)

addCcItem

public EmbeddedDocumentRequest addCcItem(DocumentCC ccItem)

getCc

@Nullable
public List<DocumentCC> getCc()

Get cc

Returns:

cc

setCc

public void setCc(List<DocumentCC> cc)

enableSigningOrder

public EmbeddedDocumentRequest enableSigningOrder(Boolean enableSigningOrder)

getEnableSigningOrder

@Nullable
public Boolean getEnableSigningOrder()

Get enableSigningOrder

Returns:

enableSigningOrder

setEnableSigningOrder

public void setEnableSigningOrder(Boolean enableSigningOrder)

expiryDays

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

getExpiryDateType

@Nullable
public EmbeddedDocumentRequest.ExpiryDateTypeEnum getExpiryDateType()

Get expiryDateType

Returns:

expiryDateType

setExpiryDateType

public void setExpiryDateType(EmbeddedDocumentRequest.ExpiryDateTypeEnum expiryDateType)

expiryValue

public EmbeddedDocumentRequest expiryValue(Long expiryValue)

getExpiryValue

@Nullable
public Long getExpiryValue()

Get expiryValue

Returns:

expiryValue

setExpiryValue

public void setExpiryValue(Long expiryValue)

reminderSettings

public EmbeddedDocumentRequest reminderSettings(ReminderSettings reminderSettings)

getReminderSettings

@Nullable
public ReminderSettings getReminderSettings()

Get reminderSettings

Returns:

reminderSettings

setReminderSettings

public void setReminderSettings(ReminderSettings reminderSettings)

enableEmbeddedSigning

@Deprecated
public EmbeddedDocumentRequest 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 EmbeddedDocumentRequest disableEmails(Boolean disableEmails)

getDisableEmails

@Nullable
public Boolean getDisableEmails()

Get disableEmails

Returns:

disableEmails

setDisableEmails

public void setDisableEmails(Boolean disableEmails)

disableSMS

public EmbeddedDocumentRequest disableSMS(Boolean disableSMS)

getDisableSMS

@Nullable
public Boolean getDisableSMS()

Get disableSMS

Returns:

disableSMS

setDisableSMS

public void setDisableSMS(Boolean disableSMS)

brandId

public EmbeddedDocumentRequest brandId(String brandId)

getBrandId

@Nullable
public String getBrandId()

Get brandId

Returns:

brandId

setBrandId

public void setBrandId(String brandId)

hideDocumentId

public EmbeddedDocumentRequest hideDocumentId(Boolean hideDocumentId)

getHideDocumentId

@Nullable
public Boolean getHideDocumentId()

Get hideDocumentId

Returns:

hideDocumentId

setHideDocumentId

public void setHideDocumentId(Boolean hideDocumentId)

labels

public EmbeddedDocumentRequest labels(List<String> labels)

addLabelsItem

public EmbeddedDocumentRequest addLabelsItem(String labelsItem)

getLabels

@Nullable
public List<String> getLabels()

Get labels

Returns:

labels

setLabels

public void setLabels(List<String> labels)

fileUrls

public EmbeddedDocumentRequest fileUrls(List<URI> fileUrls)

addFileUrlsItem

public EmbeddedDocumentRequest addFileUrlsItem(URI fileUrlsItem)

getFileUrls

@Nullable
public List<URI> getFileUrls()

Get fileUrls

Returns:

fileUrls

setFileUrls

public void setFileUrls(List<URI> fileUrls)

sendLinkValidTill

public EmbeddedDocumentRequest sendLinkValidTill(OffsetDateTime sendLinkValidTill)

getSendLinkValidTill

@Nullable
public OffsetDateTime getSendLinkValidTill()

Get sendLinkValidTill

Returns:

sendLinkValidTill

setSendLinkValidTill

public void setSendLinkValidTill(OffsetDateTime sendLinkValidTill)

useTextTags

public EmbeddedDocumentRequest useTextTags(Boolean useTextTags)

getUseTextTags

@Nullable
public Boolean getUseTextTags()

Get useTextTags

Returns:

useTextTags

setUseTextTags

public void setUseTextTags(Boolean useTextTags)

textTagDefinitions

public EmbeddedDocumentRequest textTagDefinitions(List<TextTagDefinition> textTagDefinitions)

addTextTagDefinitionsItem

public EmbeddedDocumentRequest addTextTagDefinitionsItem(TextTagDefinition textTagDefinitionsItem)

getTextTagDefinitions

@Nullable
public List<TextTagDefinition> getTextTagDefinitions()

Get textTagDefinitions

Returns:

textTagDefinitions

setTextTagDefinitions

public void setTextTagDefinitions(List<TextTagDefinition> textTagDefinitions)

enablePrintAndSign

public EmbeddedDocumentRequest enablePrintAndSign(Boolean enablePrintAndSign)

getEnablePrintAndSign

@Nullable
public Boolean getEnablePrintAndSign()

Get enablePrintAndSign

Returns:

enablePrintAndSign

setEnablePrintAndSign

public void setEnablePrintAndSign(Boolean enablePrintAndSign)

enableReassign

public EmbeddedDocumentRequest enableReassign(Boolean enableReassign)

getEnableReassign

@Nullable
public Boolean getEnableReassign()

Get enableReassign

Returns:

enableReassign

setEnableReassign

public void setEnableReassign(Boolean enableReassign)

disableExpiryAlert

public EmbeddedDocumentRequest disableExpiryAlert(Boolean disableExpiryAlert)

getDisableExpiryAlert

@Nullable
public Boolean getDisableExpiryAlert()

Get disableExpiryAlert

Returns:

disableExpiryAlert

setDisableExpiryAlert

public void setDisableExpiryAlert(Boolean disableExpiryAlert)

documentInfo

public EmbeddedDocumentRequest documentInfo(List<DocumentInfo> documentInfo)

addDocumentInfoItem

public EmbeddedDocumentRequest addDocumentInfoItem(DocumentInfo documentInfoItem)

getDocumentInfo

@Nullable
public List<DocumentInfo> getDocumentInfo()

Get documentInfo

Returns:

documentInfo

setDocumentInfo

public void setDocumentInfo(List<DocumentInfo> documentInfo)

onBehalfOf

public EmbeddedDocumentRequest onBehalfOf(String onBehalfOf)

getOnBehalfOf

@Nullable
public String getOnBehalfOf()

Get onBehalfOf

Returns:

onBehalfOf

setOnBehalfOf

public void setOnBehalfOf(String onBehalfOf)

autoDetectFields

public EmbeddedDocumentRequest autoDetectFields(Boolean autoDetectFields)

getAutoDetectFields

@Nullable
public Boolean getAutoDetectFields()

Get autoDetectFields

Returns:

autoDetectFields

setAutoDetectFields

public void setAutoDetectFields(Boolean autoDetectFields)

documentDownloadOption

public EmbeddedDocumentRequest documentDownloadOption(EmbeddedDocumentRequest.DocumentDownloadOptionEnum documentDownloadOption)

getDocumentDownloadOption

@Nullable
public EmbeddedDocumentRequest.DocumentDownloadOptionEnum getDocumentDownloadOption()

Get documentDownloadOption

Returns:

documentDownloadOption

setDocumentDownloadOption

public void setDocumentDownloadOption(EmbeddedDocumentRequest.DocumentDownloadOptionEnum documentDownloadOption)

isSandbox

public EmbeddedDocumentRequest isSandbox(Boolean isSandbox)

getIsSandbox

@Nullable
public Boolean getIsSandbox()

Get isSandbox

Returns:

isSandbox

setIsSandbox

public void setIsSandbox(Boolean isSandbox)

metaData

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

putMetaDataItem

public EmbeddedDocumentRequest 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 EmbeddedDocumentRequest formGroups(List<FormGroup> formGroups)

addFormGroupsItem

public EmbeddedDocumentRequest addFormGroupsItem(FormGroup formGroupsItem)

getFormGroups

@Nullable
public List<FormGroup> getFormGroups()

Get formGroups

Returns:

formGroups

setFormGroups

public void setFormGroups(List<FormGroup> formGroups)

recipientNotificationSettings

public EmbeddedDocumentRequest recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)

getRecipientNotificationSettings

@Nullable
public RecipientNotificationSettings getRecipientNotificationSettings()

Get recipientNotificationSettings

Returns:

recipientNotificationSettings

setRecipientNotificationSettings

public void setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)

enableAuditTrailLocalization

public EmbeddedDocumentRequest enableAuditTrailLocalization(Boolean enableAuditTrailLocalization)

getEnableAuditTrailLocalization

@Nullable
public Boolean getEnableAuditTrailLocalization()

Get enableAuditTrailLocalization

Returns:

enableAuditTrailLocalization

setEnableAuditTrailLocalization

public void setEnableAuditTrailLocalization(Boolean enableAuditTrailLocalization)

downloadFileName

public EmbeddedDocumentRequest downloadFileName(String downloadFileName)

getDownloadFileName

@Nullable
public String getDownloadFileName()

Get downloadFileName

Returns:

downloadFileName

setDownloadFileName

public void setDownloadFileName(String downloadFileName)

scheduledSendTime

public EmbeddedDocumentRequest scheduledSendTime(Long scheduledSendTime)

getScheduledSendTime

@Nullable
public Long getScheduledSendTime()

Get scheduledSendTime

Returns:

scheduledSendTime

setScheduledSendTime

public void setScheduledSendTime(Long scheduledSendTime)

allowScheduledSend

public EmbeddedDocumentRequest allowScheduledSend(Boolean allowScheduledSend)

getAllowScheduledSend

@Nullable
public Boolean getAllowScheduledSend()

Get allowScheduledSend

Returns:

allowScheduledSend

setAllowScheduledSend

public void setAllowScheduledSend(Boolean allowScheduledSend)

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 EmbeddedDocumentRequest

fromJson

public static EmbeddedDocumentRequest fromJson(String jsonString)
                                        throws IOException

Create an instance of EmbeddedDocumentRequest given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of EmbeddedDocumentRequest

Throws:

IOException - if the JSON string is invalid with respect to EmbeddedDocumentRequest

toJson

public String toJson()

Convert an instance of EmbeddedDocumentRequest to an JSON string

Returns:

JSON string