Class EmbeddedSendTemplateFormRequest

java.lang.Object

com.boldsign.model.EmbeddedSendTemplateFormRequest

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

EmbeddedSendTemplateFormRequest

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_ALLOW_SCHEDULED_SEND
static final String	SERIALIZED_NAME_BRAND_ID
static final String	SERIALIZED_NAME_CC
static final String	SERIALIZED_NAME_DISABLE_EMAILS
static final String	SERIALIZED_NAME_DISABLE_EXPIRY_ALERT
static final String	SERIALIZED_NAME_DISABLE_S_M_S
static final String	SERIALIZED_NAME_DOCUMENT_DOWNLOAD_OPTION
static final String	SERIALIZED_NAME_DOCUMENT_ID
static final String	SERIALIZED_NAME_DOCUMENT_INFO
static final String	SERIALIZED_NAME_DOWNLOAD_FILE_NAME
static final String	SERIALIZED_NAME_ENABLE_AUDIT_TRAIL_LOCALIZATION
static final String	SERIALIZED_NAME_ENABLE_PRINT_AND_SIGN
static final String	SERIALIZED_NAME_ENABLE_REASSIGN
static final String	SERIALIZED_NAME_ENABLE_SIGNING_ORDER
static final String	SERIALIZED_NAME_EXPIRY_DATE_TYPE
static final String	SERIALIZED_NAME_EXPIRY_DAYS
static final String	SERIALIZED_NAME_EXPIRY_VALUE
static final String	SERIALIZED_NAME_FILE_URLS
static final String	SERIALIZED_NAME_FILES
static final String	SERIALIZED_NAME_FORM_GROUPS
static final String	SERIALIZED_NAME_HIDE_DOCUMENT_ID
static final String	SERIALIZED_NAME_IS_SANDBOX
static final String	SERIALIZED_NAME_LABELS
static final String	SERIALIZED_NAME_LOCALE
static final String	SERIALIZED_NAME_MESSAGE
static final String	SERIALIZED_NAME_META_DATA
static final String	SERIALIZED_NAME_ON_BEHALF_OF
static final String	SERIALIZED_NAME_RECIPIENT_NOTIFICATION_SETTINGS
static final String	SERIALIZED_NAME_REDIRECT_URL
static final String	SERIALIZED_NAME_REMINDER_SETTINGS
static final String	SERIALIZED_NAME_REMOVE_FORM_FIELDS
static final String	SERIALIZED_NAME_ROLE_REMOVAL_INDICES
static final String	SERIALIZED_NAME_ROLES
static final String	SERIALIZED_NAME_SCHEDULED_SEND_TIME
static final String	SERIALIZED_NAME_SEND_LINK_VALID_TILL
static final String	SERIALIZED_NAME_SEND_VIEW_OPTION
static final String	SERIALIZED_NAME_SHOW_NAVIGATION_BUTTONS
static final String	SERIALIZED_NAME_SHOW_PREVIEW_BUTTON
static final String	SERIALIZED_NAME_SHOW_SAVE_BUTTON
static final String	SERIALIZED_NAME_SHOW_SEND_BUTTON
static final String	SERIALIZED_NAME_SHOW_TOOLBAR
static final String	SERIALIZED_NAME_SHOW_TOOLTIP
static final String	SERIALIZED_NAME_TITLE

Constructor Summary

Constructors

Constructor	Description
EmbeddedSendTemplateFormRequest()

Method Summary

Modifier and Type	Method	Description
EmbeddedSendTemplateFormRequest	addCcItem(DocumentCC ccItem)
EmbeddedSendTemplateFormRequest	addDocumentInfoItem(DocumentInfo documentInfoItem)
EmbeddedSendTemplateFormRequest	addFilesItem(File filesItem)
EmbeddedSendTemplateFormRequest	addFileUrlsItem(URI fileUrlsItem)
EmbeddedSendTemplateFormRequest	addFormGroupsItem(FormGroup formGroupsItem)
EmbeddedSendTemplateFormRequest	addLabelsItem(String labelsItem)
EmbeddedSendTemplateFormRequest	addRemoveFormFieldsItem(String removeFormFieldsItem)
EmbeddedSendTemplateFormRequest	addRoleRemovalIndicesItem(Integer roleRemovalIndicesItem)
EmbeddedSendTemplateFormRequest	addRolesItem(Role rolesItem)
EmbeddedSendTemplateFormRequest	allowScheduledSend(Boolean allowScheduledSend)
EmbeddedSendTemplateFormRequest	brandId(String brandId)
EmbeddedSendTemplateFormRequest	cc(List<DocumentCC> cc)
Map<String,Object>	createFormData()
EmbeddedSendTemplateFormRequest	disableEmails(Boolean disableEmails)
EmbeddedSendTemplateFormRequest	disableExpiryAlert(Boolean disableExpiryAlert)
EmbeddedSendTemplateFormRequest	disableSMS(Boolean disableSMS)
EmbeddedSendTemplateFormRequest	documentDownloadOption(EmbeddedSendTemplateFormRequest.DocumentDownloadOptionEnum documentDownloadOption)
EmbeddedSendTemplateFormRequest	documentId(String documentId)
EmbeddedSendTemplateFormRequest	documentInfo(List<DocumentInfo> documentInfo)
EmbeddedSendTemplateFormRequest	downloadFileName(String downloadFileName)
EmbeddedSendTemplateFormRequest	enableAuditTrailLocalization(Boolean enableAuditTrailLocalization)
EmbeddedSendTemplateFormRequest	enablePrintAndSign(Boolean enablePrintAndSign)
EmbeddedSendTemplateFormRequest	enableReassign(Boolean enableReassign)
EmbeddedSendTemplateFormRequest	enableSigningOrder(Boolean enableSigningOrder)
boolean	equals(Object o)
EmbeddedSendTemplateFormRequest	expiryDateType(EmbeddedSendTemplateFormRequest.ExpiryDateTypeEnum expiryDateType)
EmbeddedSendTemplateFormRequest	expiryDays(Integer expiryDays)	Deprecated.
EmbeddedSendTemplateFormRequest	expiryValue(Long expiryValue)
EmbeddedSendTemplateFormRequest	files(List<File> files)
EmbeddedSendTemplateFormRequest	fileUrls(List<URI> fileUrls)
EmbeddedSendTemplateFormRequest	formGroups(List<FormGroup> formGroups)
static EmbeddedSendTemplateFormRequest	fromJson(String jsonString)	Create an instance of EmbeddedSendTemplateFormRequest given an JSON string
Boolean	getAllowScheduledSend()	Get allowScheduledSend
String	getBrandId()	Get brandId
List<DocumentCC>	getCc()	Get cc
Boolean	getDisableEmails()	Get disableEmails
Boolean	getDisableExpiryAlert()	Get disableExpiryAlert
Boolean	getDisableSMS()	Get disableSMS
EmbeddedSendTemplateFormRequest.DocumentDownloadOptionEnum	getDocumentDownloadOption()	Get documentDownloadOption
String	getDocumentId()	Get documentId
List<DocumentInfo>	getDocumentInfo()	Get documentInfo
String	getDownloadFileName()	Get downloadFileName
Boolean	getEnableAuditTrailLocalization()	Get enableAuditTrailLocalization
Boolean	getEnablePrintAndSign()	Get enablePrintAndSign
Boolean	getEnableReassign()	Get enableReassign
Boolean	getEnableSigningOrder()	Get enableSigningOrder
EmbeddedSendTemplateFormRequest.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
EmbeddedSendTemplateFormRequest.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
List<String>	getRemoveFormFields()	Get removeFormFields
List<Integer>	getRoleRemovalIndices()	Get roleRemovalIndices
List<Role>	getRoles()	Get roles
Long	getScheduledSendTime()	Get scheduledSendTime
OffsetDateTime	getSendLinkValidTill()	Get sendLinkValidTill
EmbeddedSendTemplateFormRequest.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
String	getTitle()	Get title
int	hashCode()
EmbeddedSendTemplateFormRequest	hideDocumentId(Boolean hideDocumentId)
EmbeddedSendTemplateFormRequest	isSandbox(Boolean isSandbox)
EmbeddedSendTemplateFormRequest	labels(List<String> labels)
EmbeddedSendTemplateFormRequest	locale(EmbeddedSendTemplateFormRequest.LocaleEnum locale)
EmbeddedSendTemplateFormRequest	message(String message)
EmbeddedSendTemplateFormRequest	metaData(Map<String,String> metaData)
EmbeddedSendTemplateFormRequest	onBehalfOf(String onBehalfOf)
EmbeddedSendTemplateFormRequest	putMetaDataItem(String key, String metaDataItem)
EmbeddedSendTemplateFormRequest	recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)
EmbeddedSendTemplateFormRequest	redirectUrl(URI redirectUrl)
EmbeddedSendTemplateFormRequest	reminderSettings(ReminderSettings reminderSettings)
EmbeddedSendTemplateFormRequest	removeFormFields(List<String> removeFormFields)
EmbeddedSendTemplateFormRequest	roleRemovalIndices(List<Integer> roleRemovalIndices)
EmbeddedSendTemplateFormRequest	roles(List<Role> roles)
EmbeddedSendTemplateFormRequest	scheduledSendTime(Long scheduledSendTime)
EmbeddedSendTemplateFormRequest	sendLinkValidTill(OffsetDateTime sendLinkValidTill)
EmbeddedSendTemplateFormRequest	sendViewOption(EmbeddedSendTemplateFormRequest.SendViewOptionEnum sendViewOption)
void	setAllowScheduledSend(Boolean allowScheduledSend)
void	setBrandId(String brandId)
void	setCc(List<DocumentCC> cc)
void	setDisableEmails(Boolean disableEmails)
void	setDisableExpiryAlert(Boolean disableExpiryAlert)
void	setDisableSMS(Boolean disableSMS)
void	setDocumentDownloadOption(EmbeddedSendTemplateFormRequest.DocumentDownloadOptionEnum documentDownloadOption)
void	setDocumentId(String documentId)
void	setDocumentInfo(List<DocumentInfo> documentInfo)
void	setDownloadFileName(String downloadFileName)
void	setEnableAuditTrailLocalization(Boolean enableAuditTrailLocalization)
void	setEnablePrintAndSign(Boolean enablePrintAndSign)
void	setEnableReassign(Boolean enableReassign)
void	setEnableSigningOrder(Boolean enableSigningOrder)
void	setExpiryDateType(EmbeddedSendTemplateFormRequest.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(EmbeddedSendTemplateFormRequest.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	setRemoveFormFields(List<String> removeFormFields)
void	setRoleRemovalIndices(List<Integer> roleRemovalIndices)
void	setRoles(List<Role> roles)
void	setScheduledSendTime(Long scheduledSendTime)
void	setSendLinkValidTill(OffsetDateTime sendLinkValidTill)
void	setSendViewOption(EmbeddedSendTemplateFormRequest.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	setTitle(String title)
EmbeddedSendTemplateFormRequest	showNavigationButtons(Boolean showNavigationButtons)
EmbeddedSendTemplateFormRequest	showPreviewButton(Boolean showPreviewButton)
EmbeddedSendTemplateFormRequest	showSaveButton(Boolean showSaveButton)
EmbeddedSendTemplateFormRequest	showSendButton(Boolean showSendButton)
EmbeddedSendTemplateFormRequest	showToolbar(Boolean showToolbar)
EmbeddedSendTemplateFormRequest	showTooltip(Boolean showTooltip)
EmbeddedSendTemplateFormRequest	title(String title)
String	toJson()	Convert an instance of EmbeddedSendTemplateFormRequest to an JSON string
String	toString()
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 Details

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

public static final String SERIALIZED_NAME_SEND_LINK_VALID_TILL

See Also:

• Constant Field Values

SERIALIZED_NAME_SHOW_TOOLTIP

public static final String SERIALIZED_NAME_SHOW_TOOLTIP

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_RECIPIENT_NOTIFICATION_SETTINGS

public static final String SERIALIZED_NAME_RECIPIENT_NOTIFICATION_SETTINGS

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

EmbeddedSendTemplateFormRequest

public EmbeddedSendTemplateFormRequest()

Method Details

files

public EmbeddedSendTemplateFormRequest files(List<File> files)

addFilesItem

public EmbeddedSendTemplateFormRequest addFilesItem(File filesItem)

getFiles

@Nullable
public List<File> getFiles()

Get files

Returns:

files

setFiles

public void setFiles(List<File> files)

fileUrls

public EmbeddedSendTemplateFormRequest fileUrls(List<URI> fileUrls)

addFileUrlsItem

public EmbeddedSendTemplateFormRequest addFileUrlsItem(URI fileUrlsItem)

getFileUrls

@Nullable
public List<URI> getFileUrls()

Get fileUrls

Returns:

fileUrls

setFileUrls

public void setFileUrls(List<URI> fileUrls)

redirectUrl

public EmbeddedSendTemplateFormRequest redirectUrl(URI redirectUrl)

getRedirectUrl

@Nullable
public URI getRedirectUrl()

Get redirectUrl

Returns:

redirectUrl

setRedirectUrl

public void setRedirectUrl(URI redirectUrl)

showToolbar

public EmbeddedSendTemplateFormRequest showToolbar(Boolean showToolbar)

getShowToolbar

@Nullable
public Boolean getShowToolbar()

Get showToolbar

Returns:

showToolbar

setShowToolbar

public void setShowToolbar(Boolean showToolbar)

sendViewOption

public EmbeddedSendTemplateFormRequest sendViewOption(EmbeddedSendTemplateFormRequest.SendViewOptionEnum sendViewOption)

getSendViewOption

@Nullable
public EmbeddedSendTemplateFormRequest.SendViewOptionEnum getSendViewOption()

Get sendViewOption

Returns:

sendViewOption

setSendViewOption

public void setSendViewOption(EmbeddedSendTemplateFormRequest.SendViewOptionEnum sendViewOption)

showSaveButton

public EmbeddedSendTemplateFormRequest showSaveButton(Boolean showSaveButton)

getShowSaveButton

@Nullable
public Boolean getShowSaveButton()

Get showSaveButton

Returns:

showSaveButton

setShowSaveButton

public void setShowSaveButton(Boolean showSaveButton)

locale

public EmbeddedSendTemplateFormRequest locale(EmbeddedSendTemplateFormRequest.LocaleEnum locale)

getLocale

@Nullable
public EmbeddedSendTemplateFormRequest.LocaleEnum getLocale()

Get locale

Returns:

locale

setLocale

public void setLocale(EmbeddedSendTemplateFormRequest.LocaleEnum locale)

showSendButton

public EmbeddedSendTemplateFormRequest showSendButton(Boolean showSendButton)

getShowSendButton

@Nullable
public Boolean getShowSendButton()

Get showSendButton

Returns:

showSendButton

setShowSendButton

public void setShowSendButton(Boolean showSendButton)

showPreviewButton

public EmbeddedSendTemplateFormRequest showPreviewButton(Boolean showPreviewButton)

getShowPreviewButton

@Nullable
public Boolean getShowPreviewButton()

Get showPreviewButton

Returns:

showPreviewButton

setShowPreviewButton

public void setShowPreviewButton(Boolean showPreviewButton)

showNavigationButtons

public EmbeddedSendTemplateFormRequest showNavigationButtons(Boolean showNavigationButtons)

getShowNavigationButtons

@Nullable
public Boolean getShowNavigationButtons()

Get showNavigationButtons

Returns:

showNavigationButtons

setShowNavigationButtons

public void setShowNavigationButtons(Boolean showNavigationButtons)

sendLinkValidTill

public EmbeddedSendTemplateFormRequest sendLinkValidTill(OffsetDateTime sendLinkValidTill)

getSendLinkValidTill

@Nullable
public OffsetDateTime getSendLinkValidTill()

Get sendLinkValidTill

Returns:

sendLinkValidTill

setSendLinkValidTill

public void setSendLinkValidTill(OffsetDateTime sendLinkValidTill)

showTooltip

public EmbeddedSendTemplateFormRequest showTooltip(Boolean showTooltip)

getShowTooltip

@Nullable
public Boolean getShowTooltip()

Get showTooltip

Returns:

showTooltip

setShowTooltip

public void setShowTooltip(Boolean showTooltip)

documentId

public EmbeddedSendTemplateFormRequest documentId(String documentId)

getDocumentId

@Nullable
public String getDocumentId()

Get documentId

Returns:

documentId

setDocumentId

public void setDocumentId(String documentId)

title

public EmbeddedSendTemplateFormRequest title(String title)

getTitle

@Nullable
public String getTitle()

Get title

Returns:

title

setTitle

public void setTitle(String title)

message

public EmbeddedSendTemplateFormRequest message(String message)

getMessage

@Nullable
public String getMessage()

Get message

Returns:

message

setMessage

public void setMessage(String message)

roles

public EmbeddedSendTemplateFormRequest roles(List<Role> roles)

addRolesItem

public EmbeddedSendTemplateFormRequest addRolesItem(Role rolesItem)

getRoles

@Nullable
public List<Role> getRoles()

Get roles

Returns:

roles

setRoles

public void setRoles(List<Role> roles)

brandId

public EmbeddedSendTemplateFormRequest brandId(String brandId)

getBrandId

@Nullable
public String getBrandId()

Get brandId

Returns:

brandId

setBrandId

public void setBrandId(String brandId)

labels

public EmbeddedSendTemplateFormRequest labels(List<String> labels)

addLabelsItem

public EmbeddedSendTemplateFormRequest addLabelsItem(String labelsItem)

getLabels

@Nullable
public List<String> getLabels()

Get labels

Returns:

labels

setLabels

public void setLabels(List<String> labels)

disableEmails

public EmbeddedSendTemplateFormRequest disableEmails(Boolean disableEmails)

getDisableEmails

@Nullable
public Boolean getDisableEmails()

Get disableEmails

Returns:

disableEmails

setDisableEmails

public void setDisableEmails(Boolean disableEmails)

disableSMS

public EmbeddedSendTemplateFormRequest disableSMS(Boolean disableSMS)

getDisableSMS

@Nullable
public Boolean getDisableSMS()

Get disableSMS

Returns:

disableSMS

setDisableSMS

public void setDisableSMS(Boolean disableSMS)

hideDocumentId

public EmbeddedSendTemplateFormRequest hideDocumentId(Boolean hideDocumentId)

getHideDocumentId

@Nullable
public Boolean getHideDocumentId()

Get hideDocumentId

Returns:

hideDocumentId

setHideDocumentId

public void setHideDocumentId(Boolean hideDocumentId)

reminderSettings

public EmbeddedSendTemplateFormRequest reminderSettings(ReminderSettings reminderSettings)

getReminderSettings

@Nullable
public ReminderSettings getReminderSettings()

Get reminderSettings

Returns:

reminderSettings

setReminderSettings

public void setReminderSettings(ReminderSettings reminderSettings)

cc

public EmbeddedSendTemplateFormRequest cc(List<DocumentCC> cc)

addCcItem

public EmbeddedSendTemplateFormRequest addCcItem(DocumentCC ccItem)

getCc

@Nullable
public List<DocumentCC> getCc()

Get cc

Returns:

cc

setCc

public void setCc(List<DocumentCC> cc)

expiryDays

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

getExpiryDateType

@Nullable
public EmbeddedSendTemplateFormRequest.ExpiryDateTypeEnum getExpiryDateType()

Get expiryDateType

Returns:

expiryDateType

setExpiryDateType

public void setExpiryDateType(EmbeddedSendTemplateFormRequest.ExpiryDateTypeEnum expiryDateType)

expiryValue

public EmbeddedSendTemplateFormRequest expiryValue(Long expiryValue)

getExpiryValue

@Nullable
public Long getExpiryValue()

Get expiryValue

Returns:

expiryValue

setExpiryValue

public void setExpiryValue(Long expiryValue)

enablePrintAndSign

public EmbeddedSendTemplateFormRequest enablePrintAndSign(Boolean enablePrintAndSign)

getEnablePrintAndSign

@Nullable
public Boolean getEnablePrintAndSign()

Get enablePrintAndSign

Returns:

enablePrintAndSign

setEnablePrintAndSign

public void setEnablePrintAndSign(Boolean enablePrintAndSign)

enableReassign

public EmbeddedSendTemplateFormRequest enableReassign(Boolean enableReassign)

getEnableReassign

@Nullable
public Boolean getEnableReassign()

Get enableReassign

Returns:

enableReassign

setEnableReassign

public void setEnableReassign(Boolean enableReassign)

enableSigningOrder

public EmbeddedSendTemplateFormRequest enableSigningOrder(Boolean enableSigningOrder)

getEnableSigningOrder

@Nullable
public Boolean getEnableSigningOrder()

Get enableSigningOrder

Returns:

enableSigningOrder

setEnableSigningOrder

public void setEnableSigningOrder(Boolean enableSigningOrder)

disableExpiryAlert

public EmbeddedSendTemplateFormRequest disableExpiryAlert(Boolean disableExpiryAlert)

getDisableExpiryAlert

@Nullable
public Boolean getDisableExpiryAlert()

Get disableExpiryAlert

Returns:

disableExpiryAlert

setDisableExpiryAlert

public void setDisableExpiryAlert(Boolean disableExpiryAlert)

documentInfo

public EmbeddedSendTemplateFormRequest documentInfo(List<DocumentInfo> documentInfo)

addDocumentInfoItem

public EmbeddedSendTemplateFormRequest addDocumentInfoItem(DocumentInfo documentInfoItem)

getDocumentInfo

@Nullable
public List<DocumentInfo> getDocumentInfo()

Get documentInfo

Returns:

documentInfo

setDocumentInfo

public void setDocumentInfo(List<DocumentInfo> documentInfo)

onBehalfOf

public EmbeddedSendTemplateFormRequest onBehalfOf(String onBehalfOf)

getOnBehalfOf

@Nullable
public String getOnBehalfOf()

Get onBehalfOf

Returns:

onBehalfOf

setOnBehalfOf

public void setOnBehalfOf(String onBehalfOf)

isSandbox

public EmbeddedSendTemplateFormRequest isSandbox(Boolean isSandbox)

getIsSandbox

@Nullable
public Boolean getIsSandbox()

Get isSandbox

Returns:

isSandbox

setIsSandbox

public void setIsSandbox(Boolean isSandbox)

roleRemovalIndices

public EmbeddedSendTemplateFormRequest roleRemovalIndices(List<Integer> roleRemovalIndices)

addRoleRemovalIndicesItem

public EmbeddedSendTemplateFormRequest addRoleRemovalIndicesItem(Integer roleRemovalIndicesItem)

getRoleRemovalIndices

@Nullable
public List<Integer> getRoleRemovalIndices()

Get roleRemovalIndices

Returns:

roleRemovalIndices

setRoleRemovalIndices

public void setRoleRemovalIndices(List<Integer> roleRemovalIndices)

documentDownloadOption

public EmbeddedSendTemplateFormRequest documentDownloadOption(EmbeddedSendTemplateFormRequest.DocumentDownloadOptionEnum documentDownloadOption)

getDocumentDownloadOption

@Nullable
public EmbeddedSendTemplateFormRequest.DocumentDownloadOptionEnum getDocumentDownloadOption()

Get documentDownloadOption

Returns:

documentDownloadOption

setDocumentDownloadOption

public void setDocumentDownloadOption(EmbeddedSendTemplateFormRequest.DocumentDownloadOptionEnum documentDownloadOption)

metaData

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

putMetaDataItem

public EmbeddedSendTemplateFormRequest putMetaDataItem(String key,
 String metaDataItem)

getMetaData

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

Get metaData

Returns:

metaData

setMetaData

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

recipientNotificationSettings

public EmbeddedSendTemplateFormRequest recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)

getRecipientNotificationSettings

@Nullable
public RecipientNotificationSettings getRecipientNotificationSettings()

Get recipientNotificationSettings

Returns:

recipientNotificationSettings

setRecipientNotificationSettings

public void setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)

formGroups

public EmbeddedSendTemplateFormRequest formGroups(List<FormGroup> formGroups)

addFormGroupsItem

public EmbeddedSendTemplateFormRequest addFormGroupsItem(FormGroup formGroupsItem)

getFormGroups

@Nullable
public List<FormGroup> getFormGroups()

Get formGroups

Returns:

formGroups

setFormGroups

public void setFormGroups(List<FormGroup> formGroups)

removeFormFields

public EmbeddedSendTemplateFormRequest removeFormFields(List<String> removeFormFields)

addRemoveFormFieldsItem

public EmbeddedSendTemplateFormRequest addRemoveFormFieldsItem(String removeFormFieldsItem)

getRemoveFormFields

@Nullable
public List<String> getRemoveFormFields()

Get removeFormFields

Returns:

removeFormFields

setRemoveFormFields

public void setRemoveFormFields(List<String> removeFormFields)

enableAuditTrailLocalization

public EmbeddedSendTemplateFormRequest enableAuditTrailLocalization(Boolean enableAuditTrailLocalization)

getEnableAuditTrailLocalization

@Nullable
public Boolean getEnableAuditTrailLocalization()

Get enableAuditTrailLocalization

Returns:

enableAuditTrailLocalization

setEnableAuditTrailLocalization

public void setEnableAuditTrailLocalization(Boolean enableAuditTrailLocalization)

downloadFileName

public EmbeddedSendTemplateFormRequest downloadFileName(String downloadFileName)

getDownloadFileName

@Nullable
public String getDownloadFileName()

Get downloadFileName

Returns:

downloadFileName

setDownloadFileName

public void setDownloadFileName(String downloadFileName)

scheduledSendTime

public EmbeddedSendTemplateFormRequest scheduledSendTime(Long scheduledSendTime)

getScheduledSendTime

@Nullable
public Long getScheduledSendTime()

Get scheduledSendTime

Returns:

scheduledSendTime

setScheduledSendTime

public void setScheduledSendTime(Long scheduledSendTime)

allowScheduledSend

public EmbeddedSendTemplateFormRequest 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 EmbeddedSendTemplateFormRequest

fromJson

public static EmbeddedSendTemplateFormRequest fromJson(String jsonString)
                                                throws IOException

Create an instance of EmbeddedSendTemplateFormRequest given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of EmbeddedSendTemplateFormRequest

Throws:

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

toJson

public String toJson()

Convert an instance of EmbeddedSendTemplateFormRequest to an JSON string

Returns:

JSON string