Package com.boldsign.model

Class DocumentProperties

java.lang.Object

com.boldsign.model.DocumentProperties

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

DocumentProperties

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentProperties.ActivityActionEnum	Gets or Sets activityAction
static class	DocumentProperties.CustomTypeAdapterFactory
static class	DocumentProperties.DocumentDownloadOptionEnum	Gets or Sets documentDownloadOption
static class	DocumentProperties.ExpiryDateTypeEnum	Gets or Sets expiryDateType
static class	DocumentProperties.StatusEnum	Gets or Sets status

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_ACTIVITY_ACTION
static String	SERIALIZED_NAME_ACTIVITY_BY
static String	SERIALIZED_NAME_ACTIVITY_DATE
static String	SERIALIZED_NAME_APPLICATION_ID
static String	SERIALIZED_NAME_BEHALF_OF
static String	SERIALIZED_NAME_BRAND_ID
static String	SERIALIZED_NAME_CC_DETAILS
static String	SERIALIZED_NAME_COMMON_FIELDS
static String	SERIALIZED_NAME_CREATED_DATE
static String	SERIALIZED_NAME_DECLINE_MESSAGE
static String	SERIALIZED_NAME_DISABLE_EMAILS
static String	SERIALIZED_NAME_DISABLE_EXPIRY_ALERT
static String	SERIALIZED_NAME_DOCUMENT_DESCRIPTION
static String	SERIALIZED_NAME_DOCUMENT_DOWNLOAD_OPTION
static String	SERIALIZED_NAME_DOCUMENT_HISTORY
static String	SERIALIZED_NAME_DOCUMENT_ID
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
static String	SERIALIZED_NAME_EXPIRY_DATE_TYPE
static String	SERIALIZED_NAME_EXPIRY_DAYS
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_IS_DELETED
static String	SERIALIZED_NAME_LABELS
static String	SERIALIZED_NAME_MESSAGE_TITLE
static String	SERIALIZED_NAME_META_DATA
static String	SERIALIZED_NAME_REASSIGN
static String	SERIALIZED_NAME_RECIPIENT_NOTIFICATION_SETTINGS
static String	SERIALIZED_NAME_REMINDER_SETTINGS
static String	SERIALIZED_NAME_REVOKE_MESSAGE
static String	SERIALIZED_NAME_SCHEDULED_SEND_TIME
static String	SERIALIZED_NAME_SENDER_DETAIL
static String	SERIALIZED_NAME_SIGNER_DETAILS
static String	SERIALIZED_NAME_STATUS

Constructor Summary

Constructors

Constructor	Description
DocumentProperties()

Method Summary

Modifier and Type	Method	Description
DocumentProperties	activityAction(DocumentProperties.ActivityActionEnum activityAction)
DocumentProperties	activityBy(String activityBy)
DocumentProperties	activityDate(Long activityDate)
DocumentProperties	addCcDetailsItem(DocumentCcDetails ccDetailsItem)
DocumentProperties	addCommonFieldsItem(DocumentFormFields commonFieldsItem)
DocumentProperties	addDocumentHistoryItem(AuditTrail documentHistoryItem)
DocumentProperties	addFilesItem(DocumentFiles filesItem)
DocumentProperties	addFormGroupsItem(FormGroup formGroupsItem)
DocumentProperties	addLabelsItem(String labelsItem)
DocumentProperties	addReassignItem(DocumentReassign reassignItem)
DocumentProperties	addSignerDetailsItem(DocumentSignerDetails signerDetailsItem)
DocumentProperties	applicationId(String applicationId)
DocumentProperties	behalfOf(BehalfOf behalfOf)
DocumentProperties	brandId(String brandId)
DocumentProperties	ccDetails(List<DocumentCcDetails> ccDetails)
DocumentProperties	commonFields(List<DocumentFormFields> commonFields)
DocumentProperties	createdDate(Long createdDate)
Map<String,Object>	createFormData()
DocumentProperties	declineMessage(String declineMessage)
DocumentProperties	disableEmails(Boolean disableEmails)
DocumentProperties	disableExpiryAlert(Boolean disableExpiryAlert)
DocumentProperties	documentDescription(String documentDescription)
DocumentProperties	documentDownloadOption(DocumentProperties.DocumentDownloadOptionEnum documentDownloadOption)
DocumentProperties	documentHistory(List<AuditTrail> documentHistory)
DocumentProperties	documentId(String documentId)
DocumentProperties	downloadFileName(String downloadFileName)
DocumentProperties	enableAuditTrailLocalization(Boolean enableAuditTrailLocalization)
DocumentProperties	enablePrintAndSign(Boolean enablePrintAndSign)
DocumentProperties	enableReassign(Boolean enableReassign)
DocumentProperties	enableSigningOrder(Boolean enableSigningOrder)
boolean	equals(Object o)
DocumentProperties	expiryDate(Long expiryDate)
DocumentProperties	expiryDateType(DocumentProperties.ExpiryDateTypeEnum expiryDateType)
DocumentProperties	expiryDays(Integer expiryDays)
DocumentProperties	expiryValue(Long expiryValue)
DocumentProperties	files(List<DocumentFiles> files)
DocumentProperties	formGroups(List<FormGroup> formGroups)
static DocumentProperties	fromJson(String jsonString)	Create an instance of DocumentProperties given an JSON string
DocumentProperties.ActivityActionEnum	getActivityAction()	Get activityAction
String	getActivityBy()	Get activityBy
Long	getActivityDate()	Get activityDate
String	getApplicationId()	Get applicationId
BehalfOf	getBehalfOf()	Get behalfOf
String	getBrandId()	Get brandId
List<DocumentCcDetails>	getCcDetails()	Get ccDetails
List<DocumentFormFields>	getCommonFields()	Get commonFields
Long	getCreatedDate()	Get createdDate
String	getDeclineMessage()	Get declineMessage
Boolean	getDisableEmails()	Get disableEmails
Boolean	getDisableExpiryAlert()	Get disableExpiryAlert
String	getDocumentDescription()	Get documentDescription
DocumentProperties.DocumentDownloadOptionEnum	getDocumentDownloadOption()	Get documentDownloadOption
List<AuditTrail>	getDocumentHistory()	Get documentHistory
String	getDocumentId()	Get documentId
String	getDownloadFileName()	Get downloadFileName
Boolean	getEnableAuditTrailLocalization()	Get enableAuditTrailLocalization
Boolean	getEnablePrintAndSign()	Get enablePrintAndSign
Boolean	getEnableReassign()	Get enableReassign
Boolean	getEnableSigningOrder()	Get enableSigningOrder
Long	getExpiryDate()	Get expiryDate
DocumentProperties.ExpiryDateTypeEnum	getExpiryDateType()	Get expiryDateType
Integer	getExpiryDays()	Get expiryDays
Long	getExpiryValue()	Get expiryValue
List<DocumentFiles>	getFiles()	Get files
List<FormGroup>	getFormGroups()	Get formGroups
Boolean	getHideDocumentId()	Get hideDocumentId
Boolean	getIsDeleted()	Get isDeleted
List<String>	getLabels()	Get labels
String	getMessageTitle()	Get messageTitle
Map<String,String>	getMetaData()	Get metaData
List<DocumentReassign>	getReassign()	Get reassign
RecipientNotificationSettings	getRecipientNotificationSettings()	Get recipientNotificationSettings
ReminderSettings	getReminderSettings()	Get reminderSettings
String	getRevokeMessage()	Get revokeMessage
Long	getScheduledSendTime()	Get scheduledSendTime
DocumentSenderDetail	getSenderDetail()	Get senderDetail
List<DocumentSignerDetails>	getSignerDetails()	Get signerDetails
DocumentProperties.StatusEnum	getStatus()	Get status
int	hashCode()
DocumentProperties	hideDocumentId(Boolean hideDocumentId)
DocumentProperties	isDeleted(Boolean isDeleted)
DocumentProperties	labels(List<String> labels)
DocumentProperties	messageTitle(String messageTitle)
DocumentProperties	metaData(Map<String,String> metaData)
DocumentProperties	putMetaDataItem(String key, String metaDataItem)
DocumentProperties	reassign(List<DocumentReassign> reassign)
DocumentProperties	recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)
DocumentProperties	reminderSettings(ReminderSettings reminderSettings)
DocumentProperties	revokeMessage(String revokeMessage)
DocumentProperties	scheduledSendTime(Long scheduledSendTime)
DocumentProperties	senderDetail(DocumentSenderDetail senderDetail)
void	setActivityAction(DocumentProperties.ActivityActionEnum activityAction)
void	setActivityBy(String activityBy)
void	setActivityDate(Long activityDate)
void	setApplicationId(String applicationId)
void	setBehalfOf(BehalfOf behalfOf)
void	setBrandId(String brandId)
void	setCcDetails(List<DocumentCcDetails> ccDetails)
void	setCommonFields(List<DocumentFormFields> commonFields)
void	setCreatedDate(Long createdDate)
void	setDeclineMessage(String declineMessage)
void	setDisableEmails(Boolean disableEmails)
void	setDisableExpiryAlert(Boolean disableExpiryAlert)
void	setDocumentDescription(String documentDescription)
void	setDocumentDownloadOption(DocumentProperties.DocumentDownloadOptionEnum documentDownloadOption)
void	setDocumentHistory(List<AuditTrail> documentHistory)
void	setDocumentId(String documentId)
void	setDownloadFileName(String downloadFileName)
void	setEnableAuditTrailLocalization(Boolean enableAuditTrailLocalization)
void	setEnablePrintAndSign(Boolean enablePrintAndSign)
void	setEnableReassign(Boolean enableReassign)
void	setEnableSigningOrder(Boolean enableSigningOrder)
void	setExpiryDate(Long expiryDate)
void	setExpiryDateType(DocumentProperties.ExpiryDateTypeEnum expiryDateType)
void	setExpiryDays(Integer expiryDays)
void	setExpiryValue(Long expiryValue)
void	setFiles(List<DocumentFiles> files)
void	setFormGroups(List<FormGroup> formGroups)
void	setHideDocumentId(Boolean hideDocumentId)
void	setIsDeleted(Boolean isDeleted)
void	setLabels(List<String> labels)
void	setMessageTitle(String messageTitle)
void	setMetaData(Map<String,String> metaData)
void	setReassign(List<DocumentReassign> reassign)
void	setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)
void	setReminderSettings(ReminderSettings reminderSettings)
void	setRevokeMessage(String revokeMessage)
void	setScheduledSendTime(Long scheduledSendTime)
void	setSenderDetail(DocumentSenderDetail senderDetail)
void	setSignerDetails(List<DocumentSignerDetails> signerDetails)
void	setStatus(DocumentProperties.StatusEnum status)
DocumentProperties	signerDetails(List<DocumentSignerDetails> signerDetails)
DocumentProperties	status(DocumentProperties.StatusEnum status)
String	toJson()	Convert an instance of DocumentProperties 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 Detail

SERIALIZED_NAME_DOCUMENT_ID

public static final String SERIALIZED_NAME_DOCUMENT_ID

See Also:

Constant Field Values

SERIALIZED_NAME_BRAND_ID

public static final String SERIALIZED_NAME_BRAND_ID

See Also:

Constant Field Values

SERIALIZED_NAME_MESSAGE_TITLE

public static final String SERIALIZED_NAME_MESSAGE_TITLE

See Also:

Constant Field Values

SERIALIZED_NAME_DOCUMENT_DESCRIPTION

public static final String SERIALIZED_NAME_DOCUMENT_DESCRIPTION

See Also:

Constant Field Values

SERIALIZED_NAME_STATUS

public static final String SERIALIZED_NAME_STATUS

See Also:

Constant Field Values

SERIALIZED_NAME_FILES

public static final String SERIALIZED_NAME_FILES

See Also:

Constant Field Values

SERIALIZED_NAME_SENDER_DETAIL

public static final String SERIALIZED_NAME_SENDER_DETAIL

See Also:

Constant Field Values

SERIALIZED_NAME_SIGNER_DETAILS

public static final String SERIALIZED_NAME_SIGNER_DETAILS

See Also:

Constant Field Values

SERIALIZED_NAME_FORM_GROUPS

public static final String SERIALIZED_NAME_FORM_GROUPS

See Also:

Constant Field Values

SERIALIZED_NAME_COMMON_FIELDS

public static final String SERIALIZED_NAME_COMMON_FIELDS

See Also:

Constant Field Values

SERIALIZED_NAME_BEHALF_OF

public static final String SERIALIZED_NAME_BEHALF_OF

See Also:

Constant Field Values

SERIALIZED_NAME_CC_DETAILS

public static final String SERIALIZED_NAME_CC_DETAILS

See Also:

Constant Field Values

SERIALIZED_NAME_REMINDER_SETTINGS

public static final String SERIALIZED_NAME_REMINDER_SETTINGS

See Also:

Constant Field Values

SERIALIZED_NAME_REASSIGN

public static final String SERIALIZED_NAME_REASSIGN

See Also:

Constant Field Values

SERIALIZED_NAME_DOCUMENT_HISTORY

public static final String SERIALIZED_NAME_DOCUMENT_HISTORY

See Also:

Constant Field Values

SERIALIZED_NAME_ACTIVITY_BY

public static final String SERIALIZED_NAME_ACTIVITY_BY

See Also:

Constant Field Values

SERIALIZED_NAME_ACTIVITY_DATE

public static final String SERIALIZED_NAME_ACTIVITY_DATE

See Also:

Constant Field Values

SERIALIZED_NAME_ACTIVITY_ACTION

public static final String SERIALIZED_NAME_ACTIVITY_ACTION

See Also:

Constant Field Values

SERIALIZED_NAME_CREATED_DATE

public static final String SERIALIZED_NAME_CREATED_DATE

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

public static final String SERIALIZED_NAME_EXPIRY_DATE

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_IS_DELETED

public static final String SERIALIZED_NAME_IS_DELETED

See Also:

Constant Field Values

SERIALIZED_NAME_REVOKE_MESSAGE

public static final String SERIALIZED_NAME_REVOKE_MESSAGE

See Also:

Constant Field Values

SERIALIZED_NAME_DECLINE_MESSAGE

public static final String SERIALIZED_NAME_DECLINE_MESSAGE

See Also:

Constant Field Values

SERIALIZED_NAME_APPLICATION_ID

public static final String SERIALIZED_NAME_APPLICATION_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_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_HIDE_DOCUMENT_ID

public static final String SERIALIZED_NAME_HIDE_DOCUMENT_ID

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

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

DocumentProperties

public DocumentProperties()

Method Detail

documentId

public DocumentProperties documentId(String documentId)

getDocumentId

@Nullable
public String getDocumentId()

Get documentId

Returns:

documentId

setDocumentId

public void setDocumentId(String documentId)

brandId

public DocumentProperties brandId(String brandId)

getBrandId

@Nullable
public String getBrandId()

Get brandId

Returns:

brandId

setBrandId

public void setBrandId(String brandId)

messageTitle

public DocumentProperties messageTitle(String messageTitle)

getMessageTitle

@Nullable
public String getMessageTitle()

Get messageTitle

Returns:

messageTitle

setMessageTitle

public void setMessageTitle(String messageTitle)

documentDescription

public DocumentProperties documentDescription(String documentDescription)

getDocumentDescription

@Nullable
public String getDocumentDescription()

Get documentDescription

Returns:

documentDescription

setDocumentDescription

public void setDocumentDescription(String documentDescription)

status

public DocumentProperties status(DocumentProperties.StatusEnum status)

getStatus

@Nullable
public DocumentProperties.StatusEnum getStatus()

Get status

Returns:

status

setStatus

public void setStatus(DocumentProperties.StatusEnum status)

files

public DocumentProperties files(List<DocumentFiles> files)

addFilesItem

public DocumentProperties addFilesItem(DocumentFiles filesItem)

getFiles

@Nullable
public List<DocumentFiles> getFiles()

Get files

Returns:

files

setFiles

public void setFiles(List<DocumentFiles> files)

senderDetail

public DocumentProperties senderDetail(DocumentSenderDetail senderDetail)

getSenderDetail

@Nullable
public DocumentSenderDetail getSenderDetail()

Get senderDetail

Returns:

senderDetail

setSenderDetail

public void setSenderDetail(DocumentSenderDetail senderDetail)

signerDetails

public DocumentProperties signerDetails(List<DocumentSignerDetails> signerDetails)

addSignerDetailsItem

public DocumentProperties addSignerDetailsItem(DocumentSignerDetails signerDetailsItem)

getSignerDetails

@Nullable
public List<DocumentSignerDetails> getSignerDetails()

Get signerDetails

Returns:

signerDetails

setSignerDetails

public void setSignerDetails(List<DocumentSignerDetails> signerDetails)

formGroups

public DocumentProperties formGroups(List<FormGroup> formGroups)

addFormGroupsItem

public DocumentProperties addFormGroupsItem(FormGroup formGroupsItem)

getFormGroups

@Nullable
public List<FormGroup> getFormGroups()

Get formGroups

Returns:

formGroups

setFormGroups

public void setFormGroups(List<FormGroup> formGroups)

commonFields

public DocumentProperties commonFields(List<DocumentFormFields> commonFields)

addCommonFieldsItem

public DocumentProperties addCommonFieldsItem(DocumentFormFields commonFieldsItem)

getCommonFields

@Nullable
public List<DocumentFormFields> getCommonFields()

Get commonFields

Returns:

commonFields

setCommonFields

public void setCommonFields(List<DocumentFormFields> commonFields)

behalfOf

public DocumentProperties behalfOf(BehalfOf behalfOf)

getBehalfOf

@Nullable
public BehalfOf getBehalfOf()

Get behalfOf

Returns:

behalfOf

setBehalfOf

public void setBehalfOf(BehalfOf behalfOf)

ccDetails

public DocumentProperties ccDetails(List<DocumentCcDetails> ccDetails)

addCcDetailsItem

public DocumentProperties addCcDetailsItem(DocumentCcDetails ccDetailsItem)

getCcDetails

@Nullable
public List<DocumentCcDetails> getCcDetails()

Get ccDetails

Returns:

ccDetails

setCcDetails

public void setCcDetails(List<DocumentCcDetails> ccDetails)

reminderSettings

public DocumentProperties reminderSettings(ReminderSettings reminderSettings)

getReminderSettings

@Nullable
public ReminderSettings getReminderSettings()

Get reminderSettings

Returns:

reminderSettings

setReminderSettings

public void setReminderSettings(ReminderSettings reminderSettings)

reassign

public DocumentProperties reassign(List<DocumentReassign> reassign)

addReassignItem

public DocumentProperties addReassignItem(DocumentReassign reassignItem)

getReassign

@Nullable
public List<DocumentReassign> getReassign()

Get reassign

Returns:

reassign

setReassign

public void setReassign(List<DocumentReassign> reassign)

documentHistory

public DocumentProperties documentHistory(List<AuditTrail> documentHistory)

addDocumentHistoryItem

public DocumentProperties addDocumentHistoryItem(AuditTrail documentHistoryItem)

getDocumentHistory

@Nullable
public List<AuditTrail> getDocumentHistory()

Get documentHistory

Returns:

documentHistory

setDocumentHistory

public void setDocumentHistory(List<AuditTrail> documentHistory)

activityBy

public DocumentProperties activityBy(String activityBy)

getActivityBy

@Nullable
public String getActivityBy()

Get activityBy

Returns:

activityBy

setActivityBy

public void setActivityBy(String activityBy)

activityDate

public DocumentProperties activityDate(Long activityDate)

getActivityDate

@Nullable
public Long getActivityDate()

Get activityDate

Returns:

activityDate

setActivityDate

public void setActivityDate(Long activityDate)

activityAction

public DocumentProperties activityAction(DocumentProperties.ActivityActionEnum activityAction)

getActivityAction

@Nullable
public DocumentProperties.ActivityActionEnum getActivityAction()

Get activityAction

Returns:

activityAction

setActivityAction

public void setActivityAction(DocumentProperties.ActivityActionEnum activityAction)

createdDate

public DocumentProperties createdDate(Long createdDate)

getCreatedDate

@Nullable
public Long getCreatedDate()

Get createdDate

Returns:

createdDate

setCreatedDate

public void setCreatedDate(Long createdDate)

expiryDays

public DocumentProperties expiryDays(Integer expiryDays)

getExpiryDays

@Nullable
public Integer getExpiryDays()

Get expiryDays

Returns:

expiryDays

setExpiryDays

public void setExpiryDays(Integer expiryDays)

expiryDate

public DocumentProperties expiryDate(Long expiryDate)

getExpiryDate

@Nullable
public Long getExpiryDate()

Get expiryDate

Returns:

expiryDate

setExpiryDate

public void setExpiryDate(Long expiryDate)

enableSigningOrder

public DocumentProperties enableSigningOrder(Boolean enableSigningOrder)

getEnableSigningOrder

@Nullable
public Boolean getEnableSigningOrder()

Get enableSigningOrder

Returns:

enableSigningOrder

setEnableSigningOrder

public void setEnableSigningOrder(Boolean enableSigningOrder)

isDeleted

public DocumentProperties isDeleted(Boolean isDeleted)

getIsDeleted

@Nullable
public Boolean getIsDeleted()

Get isDeleted

Returns:

isDeleted

setIsDeleted

public void setIsDeleted(Boolean isDeleted)

revokeMessage

public DocumentProperties revokeMessage(String revokeMessage)

getRevokeMessage

@Nullable
public String getRevokeMessage()

Get revokeMessage

Returns:

revokeMessage

setRevokeMessage

public void setRevokeMessage(String revokeMessage)

declineMessage

public DocumentProperties declineMessage(String declineMessage)

getDeclineMessage

@Nullable
public String getDeclineMessage()

Get declineMessage

Returns:

declineMessage

setDeclineMessage

public void setDeclineMessage(String declineMessage)

applicationId

public DocumentProperties applicationId(String applicationId)

getApplicationId

@Nullable
public String getApplicationId()

Get applicationId

Returns:

applicationId

setApplicationId

public void setApplicationId(String applicationId)

labels

public DocumentProperties labels(List<String> labels)

addLabelsItem

public DocumentProperties addLabelsItem(String labelsItem)

getLabels

@Nullable
public List<String> getLabels()

Get labels

Returns:

labels

setLabels

public void setLabels(List<String> labels)

disableEmails

public DocumentProperties disableEmails(Boolean disableEmails)

getDisableEmails

@Nullable
public Boolean getDisableEmails()

Get disableEmails

Returns:

disableEmails

setDisableEmails

public void setDisableEmails(Boolean disableEmails)

enablePrintAndSign

public DocumentProperties enablePrintAndSign(Boolean enablePrintAndSign)

getEnablePrintAndSign

@Nullable
public Boolean getEnablePrintAndSign()

Get enablePrintAndSign

Returns:

enablePrintAndSign

setEnablePrintAndSign

public void setEnablePrintAndSign(Boolean enablePrintAndSign)

enableReassign

public DocumentProperties enableReassign(Boolean enableReassign)

getEnableReassign

@Nullable
public Boolean getEnableReassign()

Get enableReassign

Returns:

enableReassign

setEnableReassign

public void setEnableReassign(Boolean enableReassign)

disableExpiryAlert

public DocumentProperties disableExpiryAlert(Boolean disableExpiryAlert)

getDisableExpiryAlert

@Nullable
public Boolean getDisableExpiryAlert()

Get disableExpiryAlert

Returns:

disableExpiryAlert

setDisableExpiryAlert

public void setDisableExpiryAlert(Boolean disableExpiryAlert)

hideDocumentId

public DocumentProperties hideDocumentId(Boolean hideDocumentId)

getHideDocumentId

@Nullable
public Boolean getHideDocumentId()

Get hideDocumentId

Returns:

hideDocumentId

setHideDocumentId

public void setHideDocumentId(Boolean hideDocumentId)

expiryDateType

public DocumentProperties expiryDateType(DocumentProperties.ExpiryDateTypeEnum expiryDateType)

getExpiryDateType

@Nullable
public DocumentProperties.ExpiryDateTypeEnum getExpiryDateType()

Get expiryDateType

Returns:

expiryDateType

setExpiryDateType

public void setExpiryDateType(DocumentProperties.ExpiryDateTypeEnum expiryDateType)

expiryValue

public DocumentProperties expiryValue(Long expiryValue)

getExpiryValue

@Nullable
public Long getExpiryValue()

Get expiryValue

Returns:

expiryValue

setExpiryValue

public void setExpiryValue(Long expiryValue)

documentDownloadOption

public DocumentProperties documentDownloadOption(DocumentProperties.DocumentDownloadOptionEnum documentDownloadOption)

getDocumentDownloadOption

@Nullable
public DocumentProperties.DocumentDownloadOptionEnum getDocumentDownloadOption()

Get documentDownloadOption

Returns:

documentDownloadOption

setDocumentDownloadOption

public void setDocumentDownloadOption(DocumentProperties.DocumentDownloadOptionEnum documentDownloadOption)

metaData

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

putMetaDataItem

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

getRecipientNotificationSettings

@Nullable
public RecipientNotificationSettings getRecipientNotificationSettings()

Get recipientNotificationSettings

Returns:

recipientNotificationSettings

setRecipientNotificationSettings

public void setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)

enableAuditTrailLocalization

public DocumentProperties enableAuditTrailLocalization(Boolean enableAuditTrailLocalization)

getEnableAuditTrailLocalization

@Nullable
public Boolean getEnableAuditTrailLocalization()

Get enableAuditTrailLocalization

Returns:

enableAuditTrailLocalization

setEnableAuditTrailLocalization

public void setEnableAuditTrailLocalization(Boolean enableAuditTrailLocalization)

downloadFileName

public DocumentProperties downloadFileName(String downloadFileName)

getDownloadFileName

@Nullable
public String getDownloadFileName()

Get downloadFileName

Returns:

downloadFileName

setDownloadFileName

public void setDownloadFileName(String downloadFileName)

scheduledSendTime

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

fromJson

public static DocumentProperties fromJson(String jsonString)
                                   throws IOException

Create an instance of DocumentProperties given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of DocumentProperties

Throws:

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

toJson

public String toJson()

Convert an instance of DocumentProperties to an JSON string

Returns:

JSON string