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 ClassesModifier and TypeClassDescriptionstatic classstatic enumGets or Sets documentDownloadOptionstatic enumGets or Sets expiryDateTypestatic enumGets or Sets localestatic enumGets or Sets sendViewOption -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddCcItem(DocumentCC ccItem) addDocumentInfoItem(DocumentInfo documentInfoItem) addFilesItem(File filesItem) addFileUrlsItem(URI fileUrlsItem) addFormGroupsItem(FormGroup formGroupsItem) addLabelsItem(String labelsItem) addRemoveFormFieldsItem(String removeFormFieldsItem) addRoleRemovalIndicesItem(Integer roleRemovalIndicesItem) addRolesItem(Role rolesItem) cc(List<DocumentCC> cc) disableEmails(Boolean disableEmails) disableExpiryAlert(Boolean disableExpiryAlert) disableSMS(Boolean disableSMS) documentDownloadOption(EmbeddedSendTemplateFormRequest.DocumentDownloadOptionEnum documentDownloadOption) documentId(String documentId) documentInfo(List<DocumentInfo> documentInfo) downloadFileName(String downloadFileName) enableAuditTrailLocalization(Boolean enableAuditTrailLocalization) enablePrintAndSign(Boolean enablePrintAndSign) enableReassign(Boolean enableReassign) enableSigningOrder(Boolean enableSigningOrder) booleanexpiryDateType(EmbeddedSendTemplateFormRequest.ExpiryDateTypeEnum expiryDateType) expiryDays(Integer expiryDays) Deprecated.expiryValue(Long expiryValue) formGroups(List<FormGroup> formGroups) Create an instance of EmbeddedSendTemplateFormRequest given an JSON stringGet brandIdgetCc()Get ccGet disableEmailsGet disableExpiryAlertGet disableSMSGet documentDownloadOptionGet documentIdGet documentInfoGet downloadFileNameGet enableAuditTrailLocalizationGet enablePrintAndSignGet enableReassignGet enableSigningOrderGet expiryDateTypeDeprecated.Get expiryValuegetFiles()Get filesGet fileUrlsGet formGroupsGet hideDocumentIdGet isSandboxGet labelsGet localeGet messageGet metaDataGet onBehalfOfGet redirectUrlGet reminderSettingsGet removeFormFieldsGet roleRemovalIndicesgetRoles()Get rolesGet sendLinkValidTillGet sendViewOptionGet showNavigationButtonsGet showPreviewButtonGet showSaveButtonGet showSendButtonGet showToolbarGet showTooltipgetTitle()Get titleinthashCode()hideDocumentId(Boolean hideDocumentId) onBehalfOf(String onBehalfOf) putMetaDataItem(String key, String metaDataItem) redirectUrl(URI redirectUrl) reminderSettings(ReminderSettings reminderSettings) removeFormFields(List<String> removeFormFields) roleRemovalIndices(List<Integer> roleRemovalIndices) sendLinkValidTill(OffsetDateTime sendLinkValidTill) sendViewOption(EmbeddedSendTemplateFormRequest.SendViewOptionEnum sendViewOption) voidsetBrandId(String brandId) voidsetCc(List<DocumentCC> cc) voidsetDisableEmails(Boolean disableEmails) voidsetDisableExpiryAlert(Boolean disableExpiryAlert) voidsetDisableSMS(Boolean disableSMS) voidsetDocumentDownloadOption(EmbeddedSendTemplateFormRequest.DocumentDownloadOptionEnum documentDownloadOption) voidsetDocumentId(String documentId) voidsetDocumentInfo(List<DocumentInfo> documentInfo) voidsetDownloadFileName(String downloadFileName) voidsetEnableAuditTrailLocalization(Boolean enableAuditTrailLocalization) voidsetEnablePrintAndSign(Boolean enablePrintAndSign) voidsetEnableReassign(Boolean enableReassign) voidsetEnableSigningOrder(Boolean enableSigningOrder) voidsetExpiryDateType(EmbeddedSendTemplateFormRequest.ExpiryDateTypeEnum expiryDateType) voidsetExpiryDays(Integer expiryDays) Deprecated.voidsetExpiryValue(Long expiryValue) voidvoidsetFileUrls(List<URI> fileUrls) voidsetFormGroups(List<FormGroup> formGroups) voidsetHideDocumentId(Boolean hideDocumentId) voidsetIsSandbox(Boolean isSandbox) voidvoidvoidsetMessage(String message) voidsetMetaData(Map<String, String> metaData) voidsetOnBehalfOf(String onBehalfOf) voidsetRedirectUrl(URI redirectUrl) voidsetReminderSettings(ReminderSettings reminderSettings) voidsetRemoveFormFields(List<String> removeFormFields) voidsetRoleRemovalIndices(List<Integer> roleRemovalIndices) voidvoidsetSendLinkValidTill(OffsetDateTime sendLinkValidTill) voidsetSendViewOption(EmbeddedSendTemplateFormRequest.SendViewOptionEnum sendViewOption) voidsetShowNavigationButtons(Boolean showNavigationButtons) voidsetShowPreviewButton(Boolean showPreviewButton) voidsetShowSaveButton(Boolean showSaveButton) voidsetShowSendButton(Boolean showSendButton) voidsetShowToolbar(Boolean showToolbar) voidsetShowTooltip(Boolean showTooltip) voidshowNavigationButtons(Boolean showNavigationButtons) showPreviewButton(Boolean showPreviewButton) showSaveButton(Boolean showSaveButton) showSendButton(Boolean showSendButton) showToolbar(Boolean showToolbar) showTooltip(Boolean showTooltip) toJson()Convert an instance of EmbeddedSendTemplateFormRequest to an JSON stringtoString()static voidvalidateJsonElement(com.google.gson.JsonElement jsonElement) Validates the JSON Element and throws an exception if issues found
-
Field Details
-
SERIALIZED_NAME_FILES
- See Also:
-
SERIALIZED_NAME_FILE_URLS
- See Also:
-
SERIALIZED_NAME_REDIRECT_URL
- See Also:
-
SERIALIZED_NAME_SHOW_TOOLBAR
- See Also:
-
SERIALIZED_NAME_SEND_VIEW_OPTION
- See Also:
-
SERIALIZED_NAME_SHOW_SAVE_BUTTON
- See Also:
-
SERIALIZED_NAME_LOCALE
- See Also:
-
SERIALIZED_NAME_SHOW_SEND_BUTTON
- See Also:
-
SERIALIZED_NAME_SHOW_PREVIEW_BUTTON
- See Also:
-
SERIALIZED_NAME_SHOW_NAVIGATION_BUTTONS
- See Also:
-
SERIALIZED_NAME_SEND_LINK_VALID_TILL
- See Also:
-
SERIALIZED_NAME_SHOW_TOOLTIP
- See Also:
-
SERIALIZED_NAME_DOCUMENT_ID
- See Also:
-
SERIALIZED_NAME_TITLE
- See Also:
-
SERIALIZED_NAME_MESSAGE
- See Also:
-
SERIALIZED_NAME_ROLES
- See Also:
-
SERIALIZED_NAME_BRAND_ID
- See Also:
-
SERIALIZED_NAME_LABELS
- See Also:
-
SERIALIZED_NAME_DISABLE_EMAILS
- See Also:
-
SERIALIZED_NAME_DISABLE_S_M_S
- See Also:
-
SERIALIZED_NAME_HIDE_DOCUMENT_ID
- See Also:
-
SERIALIZED_NAME_REMINDER_SETTINGS
- See Also:
-
SERIALIZED_NAME_CC
- See Also:
-
SERIALIZED_NAME_EXPIRY_DAYS
- See Also:
-
SERIALIZED_NAME_EXPIRY_DATE_TYPE
- See Also:
-
SERIALIZED_NAME_EXPIRY_VALUE
- See Also:
-
SERIALIZED_NAME_ENABLE_PRINT_AND_SIGN
- See Also:
-
SERIALIZED_NAME_ENABLE_REASSIGN
- See Also:
-
SERIALIZED_NAME_ENABLE_SIGNING_ORDER
- See Also:
-
SERIALIZED_NAME_DISABLE_EXPIRY_ALERT
- See Also:
-
SERIALIZED_NAME_DOCUMENT_INFO
- See Also:
-
SERIALIZED_NAME_ON_BEHALF_OF
- See Also:
-
SERIALIZED_NAME_IS_SANDBOX
- See Also:
-
SERIALIZED_NAME_ROLE_REMOVAL_INDICES
- See Also:
-
SERIALIZED_NAME_DOCUMENT_DOWNLOAD_OPTION
- See Also:
-
SERIALIZED_NAME_META_DATA
- See Also:
-
SERIALIZED_NAME_FORM_GROUPS
- See Also:
-
SERIALIZED_NAME_REMOVE_FORM_FIELDS
- See Also:
-
SERIALIZED_NAME_ENABLE_AUDIT_TRAIL_LOCALIZATION
- See Also:
-
SERIALIZED_NAME_DOWNLOAD_FILE_NAME
- See Also:
-
openapiFields
-
openapiRequiredFields
-
-
Constructor Details
-
EmbeddedSendTemplateFormRequest
public EmbeddedSendTemplateFormRequest()
-
-
Method Details
-
files
-
addFilesItem
-
getFiles
-
setFiles
-
fileUrls
-
addFileUrlsItem
-
getFileUrls
-
setFileUrls
-
redirectUrl
-
getRedirectUrl
-
setRedirectUrl
-
showToolbar
-
getShowToolbar
-
setShowToolbar
-
sendViewOption
public EmbeddedSendTemplateFormRequest sendViewOption(EmbeddedSendTemplateFormRequest.SendViewOptionEnum sendViewOption) -
getSendViewOption
Get sendViewOption- Returns:
- sendViewOption
-
setSendViewOption
-
showSaveButton
-
getShowSaveButton
-
setShowSaveButton
-
locale
-
getLocale
-
setLocale
-
showSendButton
-
getShowSendButton
-
setShowSendButton
-
showPreviewButton
-
getShowPreviewButton
-
setShowPreviewButton
-
sendLinkValidTill
-
getSendLinkValidTill
Get sendLinkValidTill- Returns:
- sendLinkValidTill
-
setSendLinkValidTill
-
showTooltip
-
getShowTooltip
-
setShowTooltip
-
documentId
-
getDocumentId
-
setDocumentId
-
title
-
getTitle
-
setTitle
-
message
-
getMessage
-
setMessage
-
roles
-
addRolesItem
-
getRoles
-
setRoles
-
brandId
-
getBrandId
-
setBrandId
-
labels
-
addLabelsItem
-
getLabels
-
setLabels
-
disableEmails
-
getDisableEmails
-
setDisableEmails
-
disableSMS
-
getDisableSMS
-
setDisableSMS
-
hideDocumentId
-
getHideDocumentId
-
setHideDocumentId
-
reminderSettings
-
getReminderSettings
Get reminderSettings- Returns:
- reminderSettings
-
setReminderSettings
-
cc
-
addCcItem
-
getCc
-
setCc
-
expiryDays
Deprecated. -
getExpiryDays
-
setExpiryDays
Deprecated. -
expiryDateType
public EmbeddedSendTemplateFormRequest expiryDateType(EmbeddedSendTemplateFormRequest.ExpiryDateTypeEnum expiryDateType) -
getExpiryDateType
Get expiryDateType- Returns:
- expiryDateType
-
setExpiryDateType
-
expiryValue
-
getExpiryValue
-
setExpiryValue
-
enablePrintAndSign
-
getEnablePrintAndSign
-
setEnablePrintAndSign
-
enableReassign
-
getEnableReassign
-
setEnableReassign
-
enableSigningOrder
-
getEnableSigningOrder
-
setEnableSigningOrder
-
disableExpiryAlert
-
getDisableExpiryAlert
-
setDisableExpiryAlert
-
documentInfo
-
addDocumentInfoItem
-
getDocumentInfo
-
setDocumentInfo
-
onBehalfOf
-
getOnBehalfOf
-
setOnBehalfOf
-
isSandbox
-
getIsSandbox
-
setIsSandbox
-
roleRemovalIndices
-
addRoleRemovalIndicesItem
-
getRoleRemovalIndices
-
setRoleRemovalIndices
-
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
-
putMetaDataItem
-
getMetaData
-
setMetaData
-
formGroups
-
addFormGroupsItem
-
getFormGroups
-
setFormGroups
-
removeFormFields
-
addRemoveFormFieldsItem
-
getRemoveFormFields
-
setRemoveFormFields
-
enableAuditTrailLocalization
public EmbeddedSendTemplateFormRequest enableAuditTrailLocalization(Boolean enableAuditTrailLocalization) -
getEnableAuditTrailLocalization
-
setEnableAuditTrailLocalization
-
downloadFileName
-
getDownloadFileName
-
setDownloadFileName
-
equals
-
hashCode
-
toString
-
createFormData
- Throws:
ApiException
-
validateJsonElement
Validates the JSON Element and throws an exception if issues found- Parameters:
jsonElement- JSON Element- Throws:
IOException- if the JSON Element is invalid with respect to EmbeddedSendTemplateFormRequest
-
fromJson
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
Convert an instance of EmbeddedSendTemplateFormRequest to an JSON string- Returns:
- JSON string
-