com.docusign.esign.model

Class EnvelopeTemplate

java.lang.Object

com.docusign.esign.model.EnvelopeTemplate

public class EnvelopeTemplate
extends Object

EnvelopeTemplate

Constructor Summary

Constructors

Constructor and Description
EnvelopeTemplate()

Method Summary

Methods

Modifier and Type	Method and Description
EnvelopeTemplate	addDocumentsItem(Document documentsItem)
EnvelopeTemplate	allowMarkup(String allowMarkup)
EnvelopeTemplate	allowReassign(String allowReassign)
EnvelopeTemplate	allowViewHistory(String allowViewHistory)
EnvelopeTemplate	asynchronous(String asynchronous)
EnvelopeTemplate	attachmentsUri(String attachmentsUri)
EnvelopeTemplate	authoritativeCopy(String authoritativeCopy)
EnvelopeTemplate	authoritativeCopyDefault(String authoritativeCopyDefault)
EnvelopeTemplate	autoNavigation(String autoNavigation)
EnvelopeTemplate	brandId(String brandId)
EnvelopeTemplate	brandLock(String brandLock)
EnvelopeTemplate	certificateUri(String certificateUri)
EnvelopeTemplate	completedDateTime(String completedDateTime)
EnvelopeTemplate	createdDateTime(String createdDateTime)
EnvelopeTemplate	customFields(CustomFields customFields)
EnvelopeTemplate	customFieldsUri(String customFieldsUri)
EnvelopeTemplate	declinedDateTime(String declinedDateTime)
EnvelopeTemplate	deletedDateTime(String deletedDateTime)
EnvelopeTemplate	deliveredDateTime(String deliveredDateTime)
EnvelopeTemplate	documents(List<Document> documents)
EnvelopeTemplate	documentsCombinedUri(String documentsCombinedUri)
EnvelopeTemplate	documentsUri(String documentsUri)
EnvelopeTemplate	emailBlurb(String emailBlurb)
EnvelopeTemplate	emailSettings(EmailSettings emailSettings)
EnvelopeTemplate	emailSubject(String emailSubject)
EnvelopeTemplate	enableWetSign(String enableWetSign)
EnvelopeTemplate	enforceSignerVisibility(String enforceSignerVisibility)
EnvelopeTemplate	envelopeId(String envelopeId)
EnvelopeTemplate	envelopeIdStamping(String envelopeIdStamping)
EnvelopeTemplate	envelopeTemplateDefinition(EnvelopeTemplateDefinition envelopeTemplateDefinition)
EnvelopeTemplate	envelopeUri(String envelopeUri)
boolean	equals(Object o)
String	getAllowMarkup() When set to **true**, Document Markup is enabled for envelope.
String	getAllowReassign() When set to **true**, the recipient can redirect an envelope to a more appropriate recipient.
String	getAllowViewHistory()
String	getAsynchronous() When set to **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'.
String	getAttachmentsUri()
String	getAuthoritativeCopy() Specifies the Authoritative copy feature.
String	getAuthoritativeCopyDefault()
String	getAutoNavigation()
String	getBrandId()
String	getBrandLock()
String	getCertificateUri() Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.
String	getCompletedDateTime() Specifies the date and time this item was completed.
String	getCreatedDateTime() Indicates the date and time the item was created.
CustomFields	getCustomFields() Get customFields
String	getCustomFieldsUri() Contains a URI for an endpoint that you can use to retrieve the custom fields.
String	getDeclinedDateTime() The date and time the recipient declined the document.
String	getDeletedDateTime() Specifies the data and time the item was deleted.
String	getDeliveredDateTime() Reserved: For DocuSign use only.
List<Document>	getDocuments() Complex element contains the details on the documents in the envelope.
String	getDocumentsCombinedUri()
String	getDocumentsUri() Contains a URI for an endpoint that you can use to retrieve the documents.
String	getEmailBlurb()
EmailSettings	getEmailSettings() Get emailSettings
String	getEmailSubject() Specifies the subject of the email that is sent to all recipients.
String	getEnableWetSign() When set to **true**, the signer is allowed to print the document and sign it on paper.
String	getEnforceSignerVisibility() When set to **true**, documents with tabs can only be viewed by signers that have a tab on that document.
String	getEnvelopeId() The envelope ID of the envelope status that failed to post.
String	getEnvelopeIdStamping() When set to **true**, Envelope ID Stamping is enabled.
EnvelopeTemplateDefinition	getEnvelopeTemplateDefinition() Get envelopeTemplateDefinition
String	getEnvelopeUri() Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
String	getInitialSentDateTime()
String	getIs21CFRPart11() When set to **true**, indicates that this module is enabled on the account.
String	getIsSignatureProviderEnvelope()
String	getLastModifiedDateTime() The date and time the item was last modified.
LockInformation	getLockInformation() Get lockInformation
String	getMessageLock() When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope.
Notification	getNotification() Get notification
String	getNotificationUri() Contains a URI for an endpoint that you can use to retrieve the notifications.
String	getPurgeState()
Recipients	getRecipients() Get recipients
String	getRecipientsLock() When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
String	getRecipientsUri() Contains a URI for an endpoint that you can use to retrieve the recipients.
String	getSentDateTime() The date and time the envelope was sent.
String	getSignerCanSignOnMobile()
String	getSigningLocation() Specifies the physical location where the signing takes place.
String	getStatus() Indicates the envelope status.
String	getStatusChangedDateTime() The data and time the status changed.
String	getTemplatesUri() Contains a URI for an endpoint which you can use to retrieve the templates.
String	getTransactionId() Used to identify an envelope.
String	getUseDisclosure() When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting.
String	getVoidedDateTime() The date and time the envelope or template was voided.
String	getVoidedReason() The reason the envelope or template was voided.
int	hashCode()
EnvelopeTemplate	initialSentDateTime(String initialSentDateTime)
EnvelopeTemplate	is21CFRPart11(String is21CFRPart11)
EnvelopeTemplate	isSignatureProviderEnvelope(String isSignatureProviderEnvelope)
EnvelopeTemplate	lastModifiedDateTime(String lastModifiedDateTime)
EnvelopeTemplate	lockInformation(LockInformation lockInformation)
EnvelopeTemplate	messageLock(String messageLock)
EnvelopeTemplate	notification(Notification notification)
EnvelopeTemplate	notificationUri(String notificationUri)
EnvelopeTemplate	purgeState(String purgeState)
EnvelopeTemplate	recipients(Recipients recipients)
EnvelopeTemplate	recipientsLock(String recipientsLock)
EnvelopeTemplate	recipientsUri(String recipientsUri)
EnvelopeTemplate	sentDateTime(String sentDateTime)
void	setAllowMarkup(String allowMarkup)
void	setAllowReassign(String allowReassign)
void	setAllowViewHistory(String allowViewHistory)
void	setAsynchronous(String asynchronous)
void	setAttachmentsUri(String attachmentsUri)
void	setAuthoritativeCopy(String authoritativeCopy)
void	setAuthoritativeCopyDefault(String authoritativeCopyDefault)
void	setAutoNavigation(String autoNavigation)
void	setBrandId(String brandId)
void	setBrandLock(String brandLock)
void	setCertificateUri(String certificateUri)
void	setCompletedDateTime(String completedDateTime)
void	setCreatedDateTime(String createdDateTime)
void	setCustomFields(CustomFields customFields)
void	setCustomFieldsUri(String customFieldsUri)
void	setDeclinedDateTime(String declinedDateTime)
void	setDeletedDateTime(String deletedDateTime)
void	setDeliveredDateTime(String deliveredDateTime)
void	setDocuments(List<Document> documents)
void	setDocumentsCombinedUri(String documentsCombinedUri)
void	setDocumentsUri(String documentsUri)
void	setEmailBlurb(String emailBlurb)
void	setEmailSettings(EmailSettings emailSettings)
void	setEmailSubject(String emailSubject)
void	setEnableWetSign(String enableWetSign)
void	setEnforceSignerVisibility(String enforceSignerVisibility)
void	setEnvelopeId(String envelopeId)
void	setEnvelopeIdStamping(String envelopeIdStamping)
void	setEnvelopeTemplateDefinition(EnvelopeTemplateDefinition envelopeTemplateDefinition)
void	setEnvelopeUri(String envelopeUri)
void	setInitialSentDateTime(String initialSentDateTime)
void	setIs21CFRPart11(String is21CFRPart11)
void	setIsSignatureProviderEnvelope(String isSignatureProviderEnvelope)
void	setLastModifiedDateTime(String lastModifiedDateTime)
void	setLockInformation(LockInformation lockInformation)
void	setMessageLock(String messageLock)
void	setNotification(Notification notification)
void	setNotificationUri(String notificationUri)
void	setPurgeState(String purgeState)
void	setRecipients(Recipients recipients)
void	setRecipientsLock(String recipientsLock)
void	setRecipientsUri(String recipientsUri)
void	setSentDateTime(String sentDateTime)
void	setSignerCanSignOnMobile(String signerCanSignOnMobile)
void	setSigningLocation(String signingLocation)
void	setStatus(String status)
void	setStatusChangedDateTime(String statusChangedDateTime)
void	setTemplatesUri(String templatesUri)
void	setTransactionId(String transactionId)
void	setUseDisclosure(String useDisclosure)
void	setVoidedDateTime(String voidedDateTime)
void	setVoidedReason(String voidedReason)
EnvelopeTemplate	signerCanSignOnMobile(String signerCanSignOnMobile)
EnvelopeTemplate	signingLocation(String signingLocation)
EnvelopeTemplate	status(String status)
EnvelopeTemplate	statusChangedDateTime(String statusChangedDateTime)
EnvelopeTemplate	templatesUri(String templatesUri)
String	toString()
EnvelopeTemplate	transactionId(String transactionId)
EnvelopeTemplate	useDisclosure(String useDisclosure)
EnvelopeTemplate	voidedDateTime(String voidedDateTime)
EnvelopeTemplate	voidedReason(String voidedReason)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EnvelopeTemplate

public EnvelopeTemplate()

Method Detail

allowMarkup

public EnvelopeTemplate allowMarkup(String allowMarkup)

getAllowMarkup

public String getAllowMarkup()

When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this

Returns:

allowMarkup

setAllowMarkup

public void setAllowMarkup(String allowMarkup)

allowReassign

public EnvelopeTemplate allowReassign(String allowReassign)

getAllowReassign

public String getAllowReassign()

When set to **true**, the recipient can redirect an envelope to a more appropriate recipient.

Returns:

allowReassign

setAllowReassign

public void setAllowReassign(String allowReassign)

allowViewHistory

public EnvelopeTemplate allowViewHistory(String allowViewHistory)

getAllowViewHistory

public String getAllowViewHistory()

Returns:

allowViewHistory

setAllowViewHistory

public void setAllowViewHistory(String allowViewHistory)

asynchronous

public EnvelopeTemplate asynchronous(String asynchronous)

getAsynchronous

public String getAsynchronous()

When set to **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed.

Returns:

asynchronous

setAsynchronous

public void setAsynchronous(String asynchronous)

attachmentsUri

public EnvelopeTemplate attachmentsUri(String attachmentsUri)

getAttachmentsUri

public String getAttachmentsUri()

Returns:

attachmentsUri

setAttachmentsUri

public void setAttachmentsUri(String attachmentsUri)

authoritativeCopy

public EnvelopeTemplate authoritativeCopy(String authoritativeCopy)

getAuthoritativeCopy

public String getAuthoritativeCopy()

Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.

Returns:

authoritativeCopy

setAuthoritativeCopy

public void setAuthoritativeCopy(String authoritativeCopy)

authoritativeCopyDefault

public EnvelopeTemplate authoritativeCopyDefault(String authoritativeCopyDefault)

getAuthoritativeCopyDefault

public String getAuthoritativeCopyDefault()

Returns:

authoritativeCopyDefault

setAuthoritativeCopyDefault

public void setAuthoritativeCopyDefault(String authoritativeCopyDefault)

autoNavigation

public EnvelopeTemplate autoNavigation(String autoNavigation)

getAutoNavigation

public String getAutoNavigation()

Returns:

autoNavigation

setAutoNavigation

public void setAutoNavigation(String autoNavigation)

brandId

public EnvelopeTemplate brandId(String brandId)

getBrandId

public String getBrandId()

Returns:

brandId

setBrandId

public void setBrandId(String brandId)

brandLock

public EnvelopeTemplate brandLock(String brandLock)

getBrandLock

public String getBrandLock()

Returns:

brandLock

setBrandLock

public void setBrandLock(String brandLock)

certificateUri

public EnvelopeTemplate certificateUri(String certificateUri)

getCertificateUri

public String getCertificateUri()

Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.

Returns:

certificateUri

setCertificateUri

public void setCertificateUri(String certificateUri)

completedDateTime

public EnvelopeTemplate completedDateTime(String completedDateTime)

getCompletedDateTime

public String getCompletedDateTime()

Specifies the date and time this item was completed.

Returns:

completedDateTime

setCompletedDateTime

public void setCompletedDateTime(String completedDateTime)

createdDateTime

public EnvelopeTemplate createdDateTime(String createdDateTime)

getCreatedDateTime

public String getCreatedDateTime()

Indicates the date and time the item was created.

Returns:

createdDateTime

setCreatedDateTime

public void setCreatedDateTime(String createdDateTime)

customFields

public EnvelopeTemplate customFields(CustomFields customFields)

getCustomFields

public CustomFields getCustomFields()

Get customFields

Returns:

customFields

setCustomFields

public void setCustomFields(CustomFields customFields)

customFieldsUri

public EnvelopeTemplate customFieldsUri(String customFieldsUri)

getCustomFieldsUri

public String getCustomFieldsUri()

Contains a URI for an endpoint that you can use to retrieve the custom fields.

Returns:

customFieldsUri

setCustomFieldsUri

public void setCustomFieldsUri(String customFieldsUri)

declinedDateTime

public EnvelopeTemplate declinedDateTime(String declinedDateTime)

getDeclinedDateTime

public String getDeclinedDateTime()

The date and time the recipient declined the document.

Returns:

declinedDateTime

setDeclinedDateTime

public void setDeclinedDateTime(String declinedDateTime)

deletedDateTime

public EnvelopeTemplate deletedDateTime(String deletedDateTime)

getDeletedDateTime

public String getDeletedDateTime()

Specifies the data and time the item was deleted.

Returns:

deletedDateTime

setDeletedDateTime

public void setDeletedDateTime(String deletedDateTime)

deliveredDateTime

public EnvelopeTemplate deliveredDateTime(String deliveredDateTime)

getDeliveredDateTime

public String getDeliveredDateTime()

Reserved: For DocuSign use only.

Returns:

deliveredDateTime

setDeliveredDateTime

public void setDeliveredDateTime(String deliveredDateTime)

documents

public EnvelopeTemplate documents(List<Document> documents)

addDocumentsItem

public EnvelopeTemplate addDocumentsItem(Document documentsItem)

getDocuments

public List<Document> getDocuments()

Complex element contains the details on the documents in the envelope.

Returns:

documents

setDocuments

public void setDocuments(List<Document> documents)

documentsCombinedUri

public EnvelopeTemplate documentsCombinedUri(String documentsCombinedUri)

getDocumentsCombinedUri

public String getDocumentsCombinedUri()

Returns:

documentsCombinedUri

setDocumentsCombinedUri

public void setDocumentsCombinedUri(String documentsCombinedUri)

documentsUri

public EnvelopeTemplate documentsUri(String documentsUri)

getDocumentsUri

public String getDocumentsUri()

Contains a URI for an endpoint that you can use to retrieve the documents.

Returns:

documentsUri

setDocumentsUri

public void setDocumentsUri(String documentsUri)

emailBlurb

public EnvelopeTemplate emailBlurb(String emailBlurb)

getEmailBlurb

public String getEmailBlurb()

Returns:

emailBlurb

setEmailBlurb

public void setEmailBlurb(String emailBlurb)

emailSettings

public EnvelopeTemplate emailSettings(EmailSettings emailSettings)

getEmailSettings

public EmailSettings getEmailSettings()

Get emailSettings

Returns:

emailSettings

setEmailSettings

public void setEmailSettings(EmailSettings emailSettings)

emailSubject

public EnvelopeTemplate emailSubject(String emailSubject)

getEmailSubject

public String getEmailSubject()

Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.

Returns:

emailSubject

setEmailSubject

public void setEmailSubject(String emailSubject)

enableWetSign

public EnvelopeTemplate enableWetSign(String enableWetSign)

getEnableWetSign

public String getEnableWetSign()

When set to **true**, the signer is allowed to print the document and sign it on paper.

Returns:

enableWetSign

setEnableWetSign

public void setEnableWetSign(String enableWetSign)

enforceSignerVisibility

public EnvelopeTemplate enforceSignerVisibility(String enforceSignerVisibility)

getEnforceSignerVisibility

public String getEnforceSignerVisibility()

When set to **true**, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. Your account must have Document Visibility enabled to use this.

Returns:

enforceSignerVisibility

setEnforceSignerVisibility

public void setEnforceSignerVisibility(String enforceSignerVisibility)

envelopeId

public EnvelopeTemplate envelopeId(String envelopeId)

getEnvelopeId

public String getEnvelopeId()

The envelope ID of the envelope status that failed to post.

Returns:

envelopeId

setEnvelopeId

public void setEnvelopeId(String envelopeId)

envelopeIdStamping

public EnvelopeTemplate envelopeIdStamping(String envelopeIdStamping)

getEnvelopeIdStamping

public String getEnvelopeIdStamping()

When set to **true**, Envelope ID Stamping is enabled.

Returns:

envelopeIdStamping

setEnvelopeIdStamping

public void setEnvelopeIdStamping(String envelopeIdStamping)

envelopeTemplateDefinition

public EnvelopeTemplate envelopeTemplateDefinition(EnvelopeTemplateDefinition envelopeTemplateDefinition)

getEnvelopeTemplateDefinition

public EnvelopeTemplateDefinition getEnvelopeTemplateDefinition()

Get envelopeTemplateDefinition

Returns:

envelopeTemplateDefinition

setEnvelopeTemplateDefinition

public void setEnvelopeTemplateDefinition(EnvelopeTemplateDefinition envelopeTemplateDefinition)

envelopeUri

public EnvelopeTemplate envelopeUri(String envelopeUri)

getEnvelopeUri

public String getEnvelopeUri()

Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.

Returns:

envelopeUri

setEnvelopeUri

public void setEnvelopeUri(String envelopeUri)

initialSentDateTime

public EnvelopeTemplate initialSentDateTime(String initialSentDateTime)

getInitialSentDateTime

public String getInitialSentDateTime()

Returns:

initialSentDateTime

setInitialSentDateTime

public void setInitialSentDateTime(String initialSentDateTime)

is21CFRPart11

public EnvelopeTemplate is21CFRPart11(String is21CFRPart11)

getIs21CFRPart11

public String getIs21CFRPart11()

When set to **true**, indicates that this module is enabled on the account.

Returns:

is21CFRPart11

setIs21CFRPart11

public void setIs21CFRPart11(String is21CFRPart11)

isSignatureProviderEnvelope

public EnvelopeTemplate isSignatureProviderEnvelope(String isSignatureProviderEnvelope)

getIsSignatureProviderEnvelope

public String getIsSignatureProviderEnvelope()

Returns:

isSignatureProviderEnvelope

setIsSignatureProviderEnvelope

public void setIsSignatureProviderEnvelope(String isSignatureProviderEnvelope)

lastModifiedDateTime

public EnvelopeTemplate lastModifiedDateTime(String lastModifiedDateTime)

getLastModifiedDateTime

public String getLastModifiedDateTime()

The date and time the item was last modified.

Returns:

lastModifiedDateTime

setLastModifiedDateTime

public void setLastModifiedDateTime(String lastModifiedDateTime)

lockInformation

public EnvelopeTemplate lockInformation(LockInformation lockInformation)

getLockInformation

public LockInformation getLockInformation()

Get lockInformation

Returns:

lockInformation

setLockInformation

public void setLockInformation(LockInformation lockInformation)

messageLock

public EnvelopeTemplate messageLock(String messageLock)

getMessageLock

public String getMessageLock()

When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. However, if the `messageLock` node is set to true**** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope.

Returns:

messageLock

setMessageLock

public void setMessageLock(String messageLock)

notification

public EnvelopeTemplate notification(Notification notification)

getNotification

public Notification getNotification()

Get notification

Returns:

notification

setNotification

public void setNotification(Notification notification)

notificationUri

public EnvelopeTemplate notificationUri(String notificationUri)

getNotificationUri

public String getNotificationUri()

Contains a URI for an endpoint that you can use to retrieve the notifications.

Returns:

notificationUri

setNotificationUri

public void setNotificationUri(String notificationUri)

purgeState

public EnvelopeTemplate purgeState(String purgeState)

getPurgeState

public String getPurgeState()

Returns:

purgeState

setPurgeState

public void setPurgeState(String purgeState)

recipients

public EnvelopeTemplate recipients(Recipients recipients)

getRecipients

public Recipients getRecipients()

Get recipients

Returns:

recipients

setRecipients

public void setRecipients(Recipients recipients)

recipientsLock

public EnvelopeTemplate recipientsLock(String recipientsLock)

getRecipientsLock

public String getRecipientsLock()

When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.

Returns:

recipientsLock

setRecipientsLock

public void setRecipientsLock(String recipientsLock)

recipientsUri

public EnvelopeTemplate recipientsUri(String recipientsUri)

getRecipientsUri

public String getRecipientsUri()

Contains a URI for an endpoint that you can use to retrieve the recipients.

Returns:

recipientsUri

setRecipientsUri

public void setRecipientsUri(String recipientsUri)

sentDateTime

public EnvelopeTemplate sentDateTime(String sentDateTime)

getSentDateTime

public String getSentDateTime()

The date and time the envelope was sent.

Returns:

sentDateTime

setSentDateTime

public void setSentDateTime(String sentDateTime)

signerCanSignOnMobile

public EnvelopeTemplate signerCanSignOnMobile(String signerCanSignOnMobile)

getSignerCanSignOnMobile

public String getSignerCanSignOnMobile()

Returns:

signerCanSignOnMobile

setSignerCanSignOnMobile

public void setSignerCanSignOnMobile(String signerCanSignOnMobile)

signingLocation

public EnvelopeTemplate signingLocation(String signingLocation)

getSigningLocation

public String getSigningLocation()

Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.

Returns:

signingLocation

setSigningLocation

public void setSigningLocation(String signingLocation)

status

public EnvelopeTemplate status(String status)

getStatus

public String getStatus()

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.

Returns:

status

setStatus

public void setStatus(String status)

statusChangedDateTime

public EnvelopeTemplate statusChangedDateTime(String statusChangedDateTime)

getStatusChangedDateTime

public String getStatusChangedDateTime()

The data and time the status changed.

Returns:

statusChangedDateTime

setStatusChangedDateTime

public void setStatusChangedDateTime(String statusChangedDateTime)

templatesUri

public EnvelopeTemplate templatesUri(String templatesUri)

getTemplatesUri

public String getTemplatesUri()

Contains a URI for an endpoint which you can use to retrieve the templates.

Returns:

templatesUri

setTemplatesUri

public void setTemplatesUri(String templatesUri)

transactionId

public EnvelopeTemplate transactionId(String transactionId)

getTransactionId

public String getTransactionId()

Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.

Returns:

transactionId

setTransactionId

public void setTransactionId(String transactionId)

useDisclosure

public EnvelopeTemplate useDisclosure(String useDisclosure)

getUseDisclosure

public String getUseDisclosure()

When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information.

Returns:

useDisclosure

setUseDisclosure

public void setUseDisclosure(String useDisclosure)

voidedDateTime

public EnvelopeTemplate voidedDateTime(String voidedDateTime)

getVoidedDateTime

public String getVoidedDateTime()

The date and time the envelope or template was voided.

Returns:

voidedDateTime

setVoidedDateTime

public void setVoidedDateTime(String voidedDateTime)

voidedReason

public EnvelopeTemplate voidedReason(String voidedReason)

getVoidedReason

public String getVoidedReason()

The reason the envelope or template was voided.

Returns:

voidedReason

setVoidedReason

public void setVoidedReason(String voidedReason)

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