Package com.boldsign.model

Class EditDocumentRequest

java.lang.Object

com.boldsign.model.EditDocumentRequest

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

EditDocumentRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EditDocumentRequest.CustomTypeAdapterFactory
static class	EditDocumentRequest.DocumentDownloadOptionEnum	Gets or Sets documentDownloadOption
static class	EditDocumentRequest.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_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_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_VALUE
static String	SERIALIZED_NAME_FILES
static String	SERIALIZED_NAME_FORM_GROUPS
static String	SERIALIZED_NAME_HIDE_DOCUMENT_ID
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_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
EditDocumentRequest()

Method Summary

Modifier and Type	Method	Description
EditDocumentRequest	addCcItem(DocumentCC ccItem)
EditDocumentRequest	addDocumentInfoItem(DocumentInfo documentInfoItem)
EditDocumentRequest	addFilesItem(EditDocumentFile filesItem)
EditDocumentRequest	addFormGroupsItem(FormGroup formGroupsItem)
EditDocumentRequest	addLabelsItem(String labelsItem)
EditDocumentRequest	addSignersItem(EditDocumentSigner signersItem)
EditDocumentRequest	addTextTagDefinitionsItem(TextTagDefinition textTagDefinitionsItem)
EditDocumentRequest	brandId(String brandId)
EditDocumentRequest	cc(List<DocumentCC> cc)
Map<String,Object>	createFormData()
EditDocumentRequest	disableEmails(Boolean disableEmails)
EditDocumentRequest	disableExpiryAlert(Boolean disableExpiryAlert)
EditDocumentRequest	disableSMS(Boolean disableSMS)
EditDocumentRequest	documentDownloadOption(EditDocumentRequest.DocumentDownloadOptionEnum documentDownloadOption)
EditDocumentRequest	documentInfo(List<DocumentInfo> documentInfo)
EditDocumentRequest	downloadFileName(String downloadFileName)
EditDocumentRequest	enableAuditTrailLocalization(Boolean enableAuditTrailLocalization)
EditDocumentRequest	enablePrintAndSign(Boolean enablePrintAndSign)
EditDocumentRequest	enableReassign(Boolean enableReassign)
EditDocumentRequest	enableSigningOrder(Boolean enableSigningOrder)
boolean	equals(Object o)
EditDocumentRequest	expiryDateType(EditDocumentRequest.ExpiryDateTypeEnum expiryDateType)
EditDocumentRequest	expiryValue(Long expiryValue)
EditDocumentRequest	files(List<EditDocumentFile> files)
EditDocumentRequest	formGroups(List<FormGroup> formGroups)
static EditDocumentRequest	fromJson(String jsonString)	Create an instance of EditDocumentRequest given an JSON string
String	getBrandId()	Get brandId
List<DocumentCC>	getCc()	Get cc
Boolean	getDisableEmails()	Get disableEmails
Boolean	getDisableExpiryAlert()	Get disableExpiryAlert
Boolean	getDisableSMS()	Get disableSMS
EditDocumentRequest.DocumentDownloadOptionEnum	getDocumentDownloadOption()	Get documentDownloadOption
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
EditDocumentRequest.ExpiryDateTypeEnum	getExpiryDateType()	Get expiryDateType
Long	getExpiryValue()	Get expiryValue
List<EditDocumentFile>	getFiles()	Get files
List<FormGroup>	getFormGroups()	Get formGroups
Boolean	getHideDocumentId()	Get hideDocumentId
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
List<EditDocumentSigner>	getSigners()	Get signers
List<TextTagDefinition>	getTextTagDefinitions()	Get textTagDefinitions
String	getTitle()	Get title
Boolean	getUseTextTags()	Get useTextTags
int	hashCode()
EditDocumentRequest	hideDocumentId(Boolean hideDocumentId)
EditDocumentRequest	labels(List<String> labels)
EditDocumentRequest	message(String message)
EditDocumentRequest	metaData(Map<String,String> metaData)
EditDocumentRequest	onBehalfOf(String onBehalfOf)
EditDocumentRequest	putMetaDataItem(String key, String metaDataItem)
EditDocumentRequest	recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)
EditDocumentRequest	reminderSettings(ReminderSettings reminderSettings)
EditDocumentRequest	scheduledSendTime(Long scheduledSendTime)
void	setBrandId(String brandId)
void	setCc(List<DocumentCC> cc)
void	setDisableEmails(Boolean disableEmails)
void	setDisableExpiryAlert(Boolean disableExpiryAlert)
void	setDisableSMS(Boolean disableSMS)
void	setDocumentDownloadOption(EditDocumentRequest.DocumentDownloadOptionEnum documentDownloadOption)
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(EditDocumentRequest.ExpiryDateTypeEnum expiryDateType)
void	setExpiryValue(Long expiryValue)
void	setFiles(List<EditDocumentFile> files)
void	setFormGroups(List<FormGroup> formGroups)
void	setHideDocumentId(Boolean hideDocumentId)
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	setSigners(List<EditDocumentSigner> signers)
void	setTextTagDefinitions(List<TextTagDefinition> textTagDefinitions)
void	setTitle(String title)
void	setUseTextTags(Boolean useTextTags)
EditDocumentRequest	signers(List<EditDocumentSigner> signers)
EditDocumentRequest	textTagDefinitions(List<TextTagDefinition> textTagDefinitions)
EditDocumentRequest	title(String title)
String	toJson()	Convert an instance of EditDocumentRequest to an JSON string
String	toString()
EditDocumentRequest	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_ENABLE_AUDIT_TRAIL_LOCALIZATION

public static final String SERIALIZED_NAME_ENABLE_AUDIT_TRAIL_LOCALIZATION

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

public static final String SERIALIZED_NAME_DISABLE_EXPIRY_ALERT

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

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

EditDocumentRequest

public EditDocumentRequest()

Method Detail

files

public EditDocumentRequest files(List<EditDocumentFile> files)

addFilesItem

public EditDocumentRequest addFilesItem(EditDocumentFile filesItem)

getFiles

@Nullable
public List<EditDocumentFile> getFiles()

Get files

Returns:

files

setFiles

public void setFiles(List<EditDocumentFile> files)

title

public EditDocumentRequest title(String title)

getTitle

@Nullable
public String getTitle()

Get title

Returns:

title

setTitle

public void setTitle(String title)

message

public EditDocumentRequest message(String message)

getMessage

@Nullable
public String getMessage()

Get message

Returns:

message

setMessage

public void setMessage(String message)

signers

public EditDocumentRequest signers(List<EditDocumentSigner> signers)

addSignersItem

public EditDocumentRequest addSignersItem(EditDocumentSigner signersItem)

getSigners

@Nullable
public List<EditDocumentSigner> getSigners()

Get signers

Returns:

signers

setSigners

public void setSigners(List<EditDocumentSigner> signers)

cc

public EditDocumentRequest cc(List<DocumentCC> cc)

addCcItem

public EditDocumentRequest addCcItem(DocumentCC ccItem)

getCc

@Nullable
public List<DocumentCC> getCc()

Get cc

Returns:

cc

setCc

public void setCc(List<DocumentCC> cc)

enableSigningOrder

public EditDocumentRequest enableSigningOrder(Boolean enableSigningOrder)

getEnableSigningOrder

@Nullable
public Boolean getEnableSigningOrder()

Get enableSigningOrder

Returns:

enableSigningOrder

setEnableSigningOrder

public void setEnableSigningOrder(Boolean enableSigningOrder)

enableAuditTrailLocalization

public EditDocumentRequest enableAuditTrailLocalization(Boolean enableAuditTrailLocalization)

getEnableAuditTrailLocalization

@Nullable
public Boolean getEnableAuditTrailLocalization()

Get enableAuditTrailLocalization

Returns:

enableAuditTrailLocalization

setEnableAuditTrailLocalization

public void setEnableAuditTrailLocalization(Boolean enableAuditTrailLocalization)

expiryDateType

public EditDocumentRequest expiryDateType(EditDocumentRequest.ExpiryDateTypeEnum expiryDateType)

getExpiryDateType

@Nullable
public EditDocumentRequest.ExpiryDateTypeEnum getExpiryDateType()

Get expiryDateType

Returns:

expiryDateType

setExpiryDateType

public void setExpiryDateType(EditDocumentRequest.ExpiryDateTypeEnum expiryDateType)

expiryValue

public EditDocumentRequest expiryValue(Long expiryValue)

getExpiryValue

@Nullable
public Long getExpiryValue()

Get expiryValue

Returns:

expiryValue

setExpiryValue

public void setExpiryValue(Long expiryValue)

reminderSettings

public EditDocumentRequest reminderSettings(ReminderSettings reminderSettings)

getReminderSettings

@Nullable
public ReminderSettings getReminderSettings()

Get reminderSettings

Returns:

reminderSettings

setReminderSettings

public void setReminderSettings(ReminderSettings reminderSettings)

disableEmails

public EditDocumentRequest disableEmails(Boolean disableEmails)

getDisableEmails

@Nullable
public Boolean getDisableEmails()

Get disableEmails

Returns:

disableEmails

setDisableEmails

public void setDisableEmails(Boolean disableEmails)

disableSMS

public EditDocumentRequest disableSMS(Boolean disableSMS)

getDisableSMS

@Nullable
public Boolean getDisableSMS()

Get disableSMS

Returns:

disableSMS

setDisableSMS

public void setDisableSMS(Boolean disableSMS)

brandId

public EditDocumentRequest brandId(String brandId)

getBrandId

@Nullable
public String getBrandId()

Get brandId

Returns:

brandId

setBrandId

public void setBrandId(String brandId)

hideDocumentId

public EditDocumentRequest hideDocumentId(Boolean hideDocumentId)

getHideDocumentId

@Nullable
public Boolean getHideDocumentId()

Get hideDocumentId

Returns:

hideDocumentId

setHideDocumentId

public void setHideDocumentId(Boolean hideDocumentId)

labels

public EditDocumentRequest labels(List<String> labels)

addLabelsItem

public EditDocumentRequest addLabelsItem(String labelsItem)

getLabels

@Nullable
public List<String> getLabels()

Get labels

Returns:

labels

setLabels

public void setLabels(List<String> labels)

disableExpiryAlert

public EditDocumentRequest disableExpiryAlert(Boolean disableExpiryAlert)

getDisableExpiryAlert

@Nullable
public Boolean getDisableExpiryAlert()

Get disableExpiryAlert

Returns:

disableExpiryAlert

setDisableExpiryAlert

public void setDisableExpiryAlert(Boolean disableExpiryAlert)

enablePrintAndSign

public EditDocumentRequest enablePrintAndSign(Boolean enablePrintAndSign)

getEnablePrintAndSign

@Nullable
public Boolean getEnablePrintAndSign()

Get enablePrintAndSign

Returns:

enablePrintAndSign

setEnablePrintAndSign

public void setEnablePrintAndSign(Boolean enablePrintAndSign)

enableReassign

public EditDocumentRequest enableReassign(Boolean enableReassign)

getEnableReassign

@Nullable
public Boolean getEnableReassign()

Get enableReassign

Returns:

enableReassign

setEnableReassign

public void setEnableReassign(Boolean enableReassign)

useTextTags

public EditDocumentRequest useTextTags(Boolean useTextTags)

getUseTextTags

@Nullable
public Boolean getUseTextTags()

Get useTextTags

Returns:

useTextTags

setUseTextTags

public void setUseTextTags(Boolean useTextTags)

textTagDefinitions

public EditDocumentRequest textTagDefinitions(List<TextTagDefinition> textTagDefinitions)

addTextTagDefinitionsItem

public EditDocumentRequest addTextTagDefinitionsItem(TextTagDefinition textTagDefinitionsItem)

getTextTagDefinitions

@Nullable
public List<TextTagDefinition> getTextTagDefinitions()

Get textTagDefinitions

Returns:

textTagDefinitions

setTextTagDefinitions

public void setTextTagDefinitions(List<TextTagDefinition> textTagDefinitions)

documentInfo

public EditDocumentRequest documentInfo(List<DocumentInfo> documentInfo)

addDocumentInfoItem

public EditDocumentRequest addDocumentInfoItem(DocumentInfo documentInfoItem)

getDocumentInfo

@Nullable
public List<DocumentInfo> getDocumentInfo()

Get documentInfo

Returns:

documentInfo

setDocumentInfo

public void setDocumentInfo(List<DocumentInfo> documentInfo)

onBehalfOf

public EditDocumentRequest onBehalfOf(String onBehalfOf)

getOnBehalfOf

@Nullable
public String getOnBehalfOf()

Get onBehalfOf

Returns:

onBehalfOf

setOnBehalfOf

public void setOnBehalfOf(String onBehalfOf)

documentDownloadOption

public EditDocumentRequest documentDownloadOption(EditDocumentRequest.DocumentDownloadOptionEnum documentDownloadOption)

getDocumentDownloadOption

@Nullable
public EditDocumentRequest.DocumentDownloadOptionEnum getDocumentDownloadOption()

Get documentDownloadOption

Returns:

documentDownloadOption

setDocumentDownloadOption

public void setDocumentDownloadOption(EditDocumentRequest.DocumentDownloadOptionEnum documentDownloadOption)

metaData

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

putMetaDataItem

public EditDocumentRequest 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 EditDocumentRequest recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)

getRecipientNotificationSettings

@Nullable
public RecipientNotificationSettings getRecipientNotificationSettings()

Get recipientNotificationSettings

Returns:

recipientNotificationSettings

setRecipientNotificationSettings

public void setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)

formGroups

public EditDocumentRequest formGroups(List<FormGroup> formGroups)

addFormGroupsItem

public EditDocumentRequest addFormGroupsItem(FormGroup formGroupsItem)

getFormGroups

@Nullable
public List<FormGroup> getFormGroups()

Get formGroups

Returns:

formGroups

setFormGroups

public void setFormGroups(List<FormGroup> formGroups)

downloadFileName

public EditDocumentRequest downloadFileName(String downloadFileName)

getDownloadFileName

@Nullable
public String getDownloadFileName()

Get downloadFileName

Returns:

downloadFileName

setDownloadFileName

public void setDownloadFileName(String downloadFileName)

scheduledSendTime

public EditDocumentRequest scheduledSendTime(Long scheduledSendTime)

getScheduledSendTime

@Nullable
public Long getScheduledSendTime()

Get scheduledSendTime

Returns:

scheduledSendTime

setScheduledSendTime

public void setScheduledSendTime(Long scheduledSendTime)

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 EditDocumentRequest

fromJson

public static EditDocumentRequest fromJson(String jsonString)
                                    throws IOException

Create an instance of EditDocumentRequest given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of EditDocumentRequest

Throws:

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

toJson

public String toJson()

Convert an instance of EditDocumentRequest to an JSON string

Returns:

JSON string