EnvelopeDefinition (docusign-esign-java 3.2.0 API)

java.lang.Object
- com.docusign.esign.model.EnvelopeDefinition

public class EnvelopeDefinition
extends Object

EnvelopeDefinition

Constructor Summary

Constructors
Constructor and Description

EnvelopeDefinition()

Constructors
Constructor and Description
`EnvelopeDefinition()`

Method Summary

Methods
Modifier and Type	Method and Description
`EnvelopeDefinition`	`accessControlListBase64(String accessControlListBase64)`
`EnvelopeDefinition`	`accessibility(String accessibility)`
`EnvelopeDefinition`	`addAttachmentsItem(Attachment attachmentsItem)`
`EnvelopeDefinition`	`addCompositeTemplatesItem(CompositeTemplate compositeTemplatesItem)`
`EnvelopeDefinition`	`addDocumentsItem(Document documentsItem)`
`EnvelopeDefinition`	`addEnvelopeAttachmentsItem(Attachment envelopeAttachmentsItem)`
`EnvelopeDefinition`	`addEnvelopeDocumentsItem(EnvelopeDocument envelopeDocumentsItem)`
`EnvelopeDefinition`	`addEventNotificationsItem(EventNotification eventNotificationsItem)`
`EnvelopeDefinition`	`addFoldersItem(Folder foldersItem)`
`EnvelopeDefinition`	`addTemplateRolesItem(TemplateRole templateRolesItem)`
`EnvelopeDefinition`	`allowComments(String allowComments)`
`EnvelopeDefinition`	`allowMarkup(String allowMarkup)`
`EnvelopeDefinition`	`allowReassign(String allowReassign)`
`EnvelopeDefinition`	`allowRecipientRecursion(String allowRecipientRecursion)`
`EnvelopeDefinition`	`allowViewHistory(String allowViewHistory)`
`EnvelopeDefinition`	`anySigner(String anySigner)`
`EnvelopeDefinition`	`asynchronous(String asynchronous)`
`EnvelopeDefinition`	`attachments(List<Attachment> attachments)`
`EnvelopeDefinition`	`attachmentsUri(String attachmentsUri)`
`EnvelopeDefinition`	`authoritativeCopy(String authoritativeCopy)`
`EnvelopeDefinition`	`authoritativeCopyDefault(String authoritativeCopyDefault)`
`EnvelopeDefinition`	`autoNavigation(String autoNavigation)`
`EnvelopeDefinition`	`brandId(String brandId)`
`EnvelopeDefinition`	`brandLock(String brandLock)`
`EnvelopeDefinition`	`certificateUri(String certificateUri)`
`EnvelopeDefinition`	`completedDateTime(String completedDateTime)`
`EnvelopeDefinition`	`compositeTemplates(List<CompositeTemplate> compositeTemplates)`
`EnvelopeDefinition`	`createdDateTime(String createdDateTime)`
`EnvelopeDefinition`	`customFields(CustomFields customFields)`
`EnvelopeDefinition`	`customFieldsUri(String customFieldsUri)`
`EnvelopeDefinition`	`declinedDateTime(String declinedDateTime)`
`EnvelopeDefinition`	`deletedDateTime(String deletedDateTime)`
`EnvelopeDefinition`	`deliveredDateTime(String deliveredDateTime)`
`EnvelopeDefinition`	`disableResponsiveDocument(String disableResponsiveDocument)`
`EnvelopeDefinition`	`documents(List<Document> documents)`
`EnvelopeDefinition`	`documentsCombinedUri(String documentsCombinedUri)`
`EnvelopeDefinition`	`documentsUri(String documentsUri)`
`EnvelopeDefinition`	`emailBlurb(String emailBlurb)`
`EnvelopeDefinition`	`emailSettings(EmailSettings emailSettings)`
`EnvelopeDefinition`	`emailSubject(String emailSubject)`
`EnvelopeDefinition`	`enableWetSign(String enableWetSign)`
`EnvelopeDefinition`	`enforceSignerVisibility(String enforceSignerVisibility)`
`EnvelopeDefinition`	`envelopeAttachments(List<Attachment> envelopeAttachments)`
`EnvelopeDefinition`	`envelopeDocuments(List<EnvelopeDocument> envelopeDocuments)`
`EnvelopeDefinition`	`envelopeId(String envelopeId)`
`EnvelopeDefinition`	`envelopeIdStamping(String envelopeIdStamping)`
`EnvelopeDefinition`	`envelopeLocation(String envelopeLocation)`
`EnvelopeDefinition`	`envelopeMetadata(EnvelopeMetadata envelopeMetadata)`
`EnvelopeDefinition`	`envelopeUri(String envelopeUri)`
`boolean`	`equals(Object o)`
`EnvelopeDefinition`	`eventNotification(EventNotification eventNotification)`
`EnvelopeDefinition`	`eventNotifications(List<EventNotification> eventNotifications)`
`EnvelopeDefinition`	`expireAfter(String expireAfter)`
`EnvelopeDefinition`	`expireDateTime(String expireDateTime)`
`EnvelopeDefinition`	`expireEnabled(String expireEnabled)`
`EnvelopeDefinition`	`externalEnvelopeId(String externalEnvelopeId)`
`EnvelopeDefinition`	`folders(List<Folder> folders)`
`String`	`getAccessControlListBase64()`
`String`	`getAccessibility()` Sets the document reading zones for screen reader applications.
`String`	`getAllowComments()`
`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`	`getAllowRecipientRecursion()` When set to true, this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order.
`String`	`getAllowViewHistory()`
`String`	`getAnySigner()`
`String`	`getAsynchronous()` When set to true, the envelope is queued for processing and the value of the `status` property is set to 'Processing'.
`List<Attachment>`	`getAttachments()`
`String`	`getAttachmentsUri()`
`String`	`getAuthoritativeCopy()` Specifies the Authoritative copy feature.
`String`	`getAuthoritativeCopyDefault()`
`String`	`getAutoNavigation()`
`String`	`getBrandId()` This sets the brand profile format used for the envelope.
`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.
`List<CompositeTemplate>`	`getCompositeTemplates()` A complex type that can be added to create envelopes from a combination of DocuSign templates and PDF forms.
`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.
`String`	`getDisableResponsiveDocument()`
`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()` Optional element.
`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.
`List<Attachment>`	`getEnvelopeAttachments()`
`List<EnvelopeDocument>`	`getEnvelopeDocuments()`
`String`	`getEnvelopeId()` The envelope ID of the envelope status that failed to post.
`String`	`getEnvelopeIdStamping()` When set to true, Envelope ID Stamping is enabled.
`String`	`getEnvelopeLocation()`
`EnvelopeMetadata`	`getEnvelopeMetadata()` Get envelopeMetadata
`String`	`getEnvelopeUri()` Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
`EventNotification`	`getEventNotification()` Get eventNotification
`List<EventNotification>`	`getEventNotifications()`
`String`	`getExpireAfter()`
`String`	`getExpireDateTime()`
`String`	`getExpireEnabled()`
`String`	`getExternalEnvelopeId()`
`List<Folder>`	`getFolders()`
`String`	`getHasComments()`
`String`	`getHasFormDataChanged()`
`String`	`getHasWavFile()`
`String`	`getHolder()`
`String`	`getInitialSentDateTime()`
`String`	`getIs21CFRPart11()` When set to true, indicates that this module is enabled on the account.
`String`	`getIsDynamicEnvelope()`
`String`	`getIsSignatureProviderEnvelope()`
`String`	`getLastModifiedDateTime()` The date and time the item was last modified.
`String`	`getLocation()`
`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`	`getPassword()`
`PowerForm`	`getPowerForm()` Get powerForm
`String`	`getPurgeCompletedDate()`
`String`	`getPurgeRequestDate()`
`String`	`getPurgeState()` Initiates a purge request.
`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.
`UserInfo`	`getSender()` Get sender
`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`	`getStatusDateTime()`
`String`	`getTemplateId()` The unique identifier of the template.
`List<TemplateRole>`	`getTemplateRoles()` Specifies the template recipients.
`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.
`EnvelopeDefinition`	`hasComments(String hasComments)`
`EnvelopeDefinition`	`hasFormDataChanged(String hasFormDataChanged)`
`int`	`hashCode()`
`EnvelopeDefinition`	`hasWavFile(String hasWavFile)`
`EnvelopeDefinition`	`holder(String holder)`
`EnvelopeDefinition`	`initialSentDateTime(String initialSentDateTime)`
`EnvelopeDefinition`	`is21CFRPart11(String is21CFRPart11)`
`EnvelopeDefinition`	`isDynamicEnvelope(String isDynamicEnvelope)`
`EnvelopeDefinition`	`isSignatureProviderEnvelope(String isSignatureProviderEnvelope)`
`EnvelopeDefinition`	`lastModifiedDateTime(String lastModifiedDateTime)`
`EnvelopeDefinition`	`location(String location)`
`EnvelopeDefinition`	`lockInformation(LockInformation lockInformation)`
`EnvelopeDefinition`	`messageLock(String messageLock)`
`EnvelopeDefinition`	`notification(Notification notification)`
`EnvelopeDefinition`	`notificationUri(String notificationUri)`
`EnvelopeDefinition`	`password(String password)`
`EnvelopeDefinition`	`powerForm(PowerForm powerForm)`
`EnvelopeDefinition`	`purgeCompletedDate(String purgeCompletedDate)`
`EnvelopeDefinition`	`purgeRequestDate(String purgeRequestDate)`
`EnvelopeDefinition`	`purgeState(String purgeState)`
`EnvelopeDefinition`	`recipients(Recipients recipients)`
`EnvelopeDefinition`	`recipientsLock(String recipientsLock)`
`EnvelopeDefinition`	`recipientsUri(String recipientsUri)`
`EnvelopeDefinition`	`sender(UserInfo sender)`
`EnvelopeDefinition`	`sentDateTime(String sentDateTime)`
`void`	`setAccessControlListBase64(String accessControlListBase64)`
`void`	`setAccessibility(String accessibility)`
`void`	`setAllowComments(String allowComments)`
`void`	`setAllowMarkup(String allowMarkup)`
`void`	`setAllowReassign(String allowReassign)`
`void`	`setAllowRecipientRecursion(String allowRecipientRecursion)`
`void`	`setAllowViewHistory(String allowViewHistory)`
`void`	`setAnySigner(String anySigner)`
`void`	`setAsynchronous(String asynchronous)`
`void`	`setAttachments(List<Attachment> attachments)`
`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`	`setCompositeTemplates(List<CompositeTemplate> compositeTemplates)`
`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`	`setDisableResponsiveDocument(String disableResponsiveDocument)`
`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`	`setEnvelopeAttachments(List<Attachment> envelopeAttachments)`
`void`	`setEnvelopeDocuments(List<EnvelopeDocument> envelopeDocuments)`
`void`	`setEnvelopeId(String envelopeId)`
`void`	`setEnvelopeIdStamping(String envelopeIdStamping)`
`void`	`setEnvelopeLocation(String envelopeLocation)`
`void`	`setEnvelopeMetadata(EnvelopeMetadata envelopeMetadata)`
`void`	`setEnvelopeUri(String envelopeUri)`
`void`	`setEventNotification(EventNotification eventNotification)`
`void`	`setEventNotifications(List<EventNotification> eventNotifications)`
`void`	`setExpireAfter(String expireAfter)`
`void`	`setExpireDateTime(String expireDateTime)`
`void`	`setExpireEnabled(String expireEnabled)`
`void`	`setExternalEnvelopeId(String externalEnvelopeId)`
`void`	`setFolders(List<Folder> folders)`
`void`	`setHasComments(String hasComments)`
`void`	`setHasFormDataChanged(String hasFormDataChanged)`
`void`	`setHasWavFile(String hasWavFile)`
`void`	`setHolder(String holder)`
`void`	`setInitialSentDateTime(String initialSentDateTime)`
`void`	`setIs21CFRPart11(String is21CFRPart11)`
`void`	`setIsDynamicEnvelope(String isDynamicEnvelope)`
`void`	`setIsSignatureProviderEnvelope(String isSignatureProviderEnvelope)`
`void`	`setLastModifiedDateTime(String lastModifiedDateTime)`
`void`	`setLocation(String location)`
`void`	`setLockInformation(LockInformation lockInformation)`
`void`	`setMessageLock(String messageLock)`
`void`	`setNotification(Notification notification)`
`void`	`setNotificationUri(String notificationUri)`
`void`	`setPassword(String password)`
`void`	`setPowerForm(PowerForm powerForm)`
`void`	`setPurgeCompletedDate(String purgeCompletedDate)`
`void`	`setPurgeRequestDate(String purgeRequestDate)`
`void`	`setPurgeState(String purgeState)`
`void`	`setRecipients(Recipients recipients)`
`void`	`setRecipientsLock(String recipientsLock)`
`void`	`setRecipientsUri(String recipientsUri)`
`void`	`setSender(UserInfo sender)`
`void`	`setSentDateTime(String sentDateTime)`
`void`	`setSignerCanSignOnMobile(String signerCanSignOnMobile)`
`void`	`setSigningLocation(String signingLocation)`
`void`	`setStatus(String status)`
`void`	`setStatusChangedDateTime(String statusChangedDateTime)`
`void`	`setStatusDateTime(String statusDateTime)`
`void`	`setTemplateId(String templateId)`
`void`	`setTemplateRoles(List<TemplateRole> templateRoles)`
`void`	`setTemplatesUri(String templatesUri)`
`void`	`setTransactionId(String transactionId)`
`void`	`setUseDisclosure(String useDisclosure)`
`void`	`setVoidedDateTime(String voidedDateTime)`
`void`	`setVoidedReason(String voidedReason)`
`EnvelopeDefinition`	`signerCanSignOnMobile(String signerCanSignOnMobile)`
`EnvelopeDefinition`	`signingLocation(String signingLocation)`
`EnvelopeDefinition`	`status(String status)`
`EnvelopeDefinition`	`statusChangedDateTime(String statusChangedDateTime)`
`EnvelopeDefinition`	`statusDateTime(String statusDateTime)`
`EnvelopeDefinition`	`templateId(String templateId)`
`EnvelopeDefinition`	`templateRoles(List<TemplateRole> templateRoles)`
`EnvelopeDefinition`	`templatesUri(String templatesUri)`
`String`	`toString()`
`EnvelopeDefinition`	`transactionId(String transactionId)`
`EnvelopeDefinition`	`useDisclosure(String useDisclosure)`
`EnvelopeDefinition`	`voidedDateTime(String voidedDateTime)`
`EnvelopeDefinition`	`voidedReason(String voidedReason)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail
- EnvelopeDefinition
```
public EnvelopeDefinition()
```

Method Detail

accessControlListBase64

public EnvelopeDefinition accessControlListBase64(String accessControlListBase64)

getAccessControlListBase64
```
public String getAccessControlListBase64()
```
Returns:
accessControlListBase64

setAccessControlListBase64

public void setAccessControlListBase64(String accessControlListBase64)

accessibility

public EnvelopeDefinition accessibility(String accessibility)

getAccessibility
```
public String getAccessibility()
```
Sets the document reading zones for screen reader applications. This element can only be used if Document Accessibility is enabled for the account. ###### Note: This information is currently generated from the DocuSign web console by setting the reading zones when creating a template, exporting the reading zone string information, and adding it here.

Returns:
accessibility

setAccessibility

public void setAccessibility(String accessibility)

allowComments

public EnvelopeDefinition allowComments(String allowComments)

getAllowComments
```
public String getAllowComments()
```
Returns:
allowComments

setAllowComments

public void setAllowComments(String allowComments)

allowMarkup

public EnvelopeDefinition 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 EnvelopeDefinition 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)

allowRecipientRecursion

public EnvelopeDefinition allowRecipientRecursion(String allowRecipientRecursion)

getAllowRecipientRecursion
```
public String getAllowRecipientRecursion()
```
When set to **true**, this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order.

Returns:
allowRecipientRecursion

setAllowRecipientRecursion

public void setAllowRecipientRecursion(String allowRecipientRecursion)

allowViewHistory

public EnvelopeDefinition allowViewHistory(String allowViewHistory)

getAllowViewHistory
```
public String getAllowViewHistory()
```
Returns:
allowViewHistory

setAllowViewHistory

public void setAllowViewHistory(String allowViewHistory)

anySigner

public EnvelopeDefinition anySigner(String anySigner)

getAnySigner
```
public String getAnySigner()
```
Returns:
anySigner

setAnySigner

public void setAnySigner(String anySigner)

asynchronous

public EnvelopeDefinition 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)

attachments

public EnvelopeDefinition attachments(List<Attachment> attachments)

addAttachmentsItem

public EnvelopeDefinition addAttachmentsItem(Attachment attachmentsItem)

getAttachments

public List<Attachment> getAttachments()

Returns:: attachments

setAttachments

public void setAttachments(List<Attachment> attachments)

attachmentsUri

public EnvelopeDefinition attachmentsUri(String attachmentsUri)

getAttachmentsUri
```
public String getAttachmentsUri()
```
Returns:
attachmentsUri

setAttachmentsUri

public void setAttachmentsUri(String attachmentsUri)

authoritativeCopy

public EnvelopeDefinition 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 EnvelopeDefinition authoritativeCopyDefault(String authoritativeCopyDefault)

getAuthoritativeCopyDefault
```
public String getAuthoritativeCopyDefault()
```
Returns:
authoritativeCopyDefault

setAuthoritativeCopyDefault

public void setAuthoritativeCopyDefault(String authoritativeCopyDefault)

autoNavigation

public EnvelopeDefinition autoNavigation(String autoNavigation)

getAutoNavigation
```
public String getAutoNavigation()
```
Returns:
autoNavigation

setAutoNavigation

public void setAutoNavigation(String autoNavigation)

brandId

public EnvelopeDefinition brandId(String brandId)

getBrandId
```
public String getBrandId()
```
This sets the brand profile format used for the envelope. The value in the string is the brandId associated with the profile. Account branding must be enabled for the account to use this option.

Returns:
brandId

setBrandId

public void setBrandId(String brandId)

brandLock

public EnvelopeDefinition brandLock(String brandLock)

getBrandLock
```
public String getBrandLock()
```
Returns:
brandLock

setBrandLock

public void setBrandLock(String brandLock)

certificateUri

public EnvelopeDefinition 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 EnvelopeDefinition completedDateTime(String completedDateTime)

getCompletedDateTime
```
public String getCompletedDateTime()
```
Specifies the date and time this item was completed.

Returns:
completedDateTime

setCompletedDateTime

public void setCompletedDateTime(String completedDateTime)

compositeTemplates

public EnvelopeDefinition compositeTemplates(List<CompositeTemplate> compositeTemplates)

addCompositeTemplatesItem

public EnvelopeDefinition addCompositeTemplatesItem(CompositeTemplate compositeTemplatesItem)

getCompositeTemplates
```
public List<CompositeTemplate> getCompositeTemplates()
```
A complex type that can be added to create envelopes from a combination of DocuSign templates and PDF forms. The basic envelope remains the same, while the Composite Template adds new document and template overlays into the envelope. There can be any number of Composite Template structures in the envelope.

Returns:
compositeTemplates

setCompositeTemplates

public void setCompositeTemplates(List<CompositeTemplate> compositeTemplates)

createdDateTime

public EnvelopeDefinition 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 EnvelopeDefinition customFields(CustomFields customFields)

getCustomFields
```
public CustomFields getCustomFields()
```
Get customFields

Returns:
customFields

setCustomFields

public void setCustomFields(CustomFields customFields)

customFieldsUri

public EnvelopeDefinition 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 EnvelopeDefinition 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 EnvelopeDefinition 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 EnvelopeDefinition deliveredDateTime(String deliveredDateTime)

getDeliveredDateTime
```
public String getDeliveredDateTime()
```
Reserved: For DocuSign use only.

Returns:
deliveredDateTime

setDeliveredDateTime

public void setDeliveredDateTime(String deliveredDateTime)

disableResponsiveDocument

public EnvelopeDefinition disableResponsiveDocument(String disableResponsiveDocument)

getDisableResponsiveDocument
```
public String getDisableResponsiveDocument()
```
Returns:
disableResponsiveDocument

setDisableResponsiveDocument

public void setDisableResponsiveDocument(String disableResponsiveDocument)

documents

public EnvelopeDefinition documents(List<Document> documents)

addDocumentsItem

public EnvelopeDefinition 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 EnvelopeDefinition documentsCombinedUri(String documentsCombinedUri)

getDocumentsCombinedUri
```
public String getDocumentsCombinedUri()
```
Returns:
documentsCombinedUri

setDocumentsCombinedUri

public void setDocumentsCombinedUri(String documentsCombinedUri)

documentsUri

public EnvelopeDefinition 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 EnvelopeDefinition emailBlurb(String emailBlurb)

getEmailBlurb
```
public String getEmailBlurb()
```
Optional element. This is the same as the email body. If specified it is included in email body for all envelope recipients. This can be a maximum of 10000 characters

Returns:
emailBlurb

setEmailBlurb

public void setEmailBlurb(String emailBlurb)

emailSettings

public EnvelopeDefinition emailSettings(EmailSettings emailSettings)

getEmailSettings
```
public EmailSettings getEmailSettings()
```
Get emailSettings

Returns:
emailSettings

setEmailSettings

public void setEmailSettings(EmailSettings emailSettings)

emailSubject

public EnvelopeDefinition 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 EnvelopeDefinition 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 EnvelopeDefinition 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)

envelopeAttachments

public EnvelopeDefinition envelopeAttachments(List<Attachment> envelopeAttachments)

addEnvelopeAttachmentsItem

public EnvelopeDefinition addEnvelopeAttachmentsItem(Attachment envelopeAttachmentsItem)

getEnvelopeAttachments

public List<Attachment> getEnvelopeAttachments()

Returns:: envelopeAttachments

setEnvelopeAttachments

public void setEnvelopeAttachments(List<Attachment> envelopeAttachments)

envelopeDocuments

public EnvelopeDefinition envelopeDocuments(List<EnvelopeDocument> envelopeDocuments)

addEnvelopeDocumentsItem

public EnvelopeDefinition addEnvelopeDocumentsItem(EnvelopeDocument envelopeDocumentsItem)

getEnvelopeDocuments

public List<EnvelopeDocument> getEnvelopeDocuments()

Returns:: envelopeDocuments

setEnvelopeDocuments

public void setEnvelopeDocuments(List<EnvelopeDocument> envelopeDocuments)

envelopeId

public EnvelopeDefinition 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 EnvelopeDefinition envelopeIdStamping(String envelopeIdStamping)

getEnvelopeIdStamping
```
public String getEnvelopeIdStamping()
```
When set to **true**, Envelope ID Stamping is enabled.

Returns:
envelopeIdStamping

setEnvelopeIdStamping

public void setEnvelopeIdStamping(String envelopeIdStamping)

envelopeLocation

public EnvelopeDefinition envelopeLocation(String envelopeLocation)

getEnvelopeLocation
```
public String getEnvelopeLocation()
```
Returns:
envelopeLocation

setEnvelopeLocation

public void setEnvelopeLocation(String envelopeLocation)

envelopeMetadata

public EnvelopeDefinition envelopeMetadata(EnvelopeMetadata envelopeMetadata)

getEnvelopeMetadata
```
public EnvelopeMetadata getEnvelopeMetadata()
```
Get envelopeMetadata

Returns:
envelopeMetadata

setEnvelopeMetadata

public void setEnvelopeMetadata(EnvelopeMetadata envelopeMetadata)

envelopeUri

public EnvelopeDefinition 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)

eventNotification

public EnvelopeDefinition eventNotification(EventNotification eventNotification)

getEventNotification
```
public EventNotification getEventNotification()
```
Get eventNotification

Returns:
eventNotification

setEventNotification

public void setEventNotification(EventNotification eventNotification)

eventNotifications

public EnvelopeDefinition eventNotifications(List<EventNotification> eventNotifications)

addEventNotificationsItem

public EnvelopeDefinition addEventNotificationsItem(EventNotification eventNotificationsItem)

getEventNotifications

public List<EventNotification> getEventNotifications()

Returns:: eventNotifications

setEventNotifications

public void setEventNotifications(List<EventNotification> eventNotifications)

expireAfter

public EnvelopeDefinition expireAfter(String expireAfter)

getExpireAfter
```
public String getExpireAfter()
```
Returns:
expireAfter

setExpireAfter

public void setExpireAfter(String expireAfter)

expireDateTime

public EnvelopeDefinition expireDateTime(String expireDateTime)

getExpireDateTime
```
public String getExpireDateTime()
```
Returns:
expireDateTime

setExpireDateTime

public void setExpireDateTime(String expireDateTime)

expireEnabled

public EnvelopeDefinition expireEnabled(String expireEnabled)

getExpireEnabled
```
public String getExpireEnabled()
```
Returns:
expireEnabled

setExpireEnabled

public void setExpireEnabled(String expireEnabled)

externalEnvelopeId

public EnvelopeDefinition externalEnvelopeId(String externalEnvelopeId)

getExternalEnvelopeId
```
public String getExternalEnvelopeId()
```
Returns:
externalEnvelopeId

setExternalEnvelopeId

public void setExternalEnvelopeId(String externalEnvelopeId)

folders

public EnvelopeDefinition folders(List<Folder> folders)

addFoldersItem

public EnvelopeDefinition addFoldersItem(Folder foldersItem)

getFolders
```
public List<Folder> getFolders()
```
Returns:
folders

setFolders

public void setFolders(List<Folder> folders)

hasComments

public EnvelopeDefinition hasComments(String hasComments)

getHasComments
```
public String getHasComments()
```
Returns:
hasComments

setHasComments

public void setHasComments(String hasComments)

hasFormDataChanged

public EnvelopeDefinition hasFormDataChanged(String hasFormDataChanged)

getHasFormDataChanged
```
public String getHasFormDataChanged()
```
Returns:
hasFormDataChanged

setHasFormDataChanged

public void setHasFormDataChanged(String hasFormDataChanged)

hasWavFile

public EnvelopeDefinition hasWavFile(String hasWavFile)

getHasWavFile
```
public String getHasWavFile()
```
Returns:
hasWavFile

setHasWavFile

public void setHasWavFile(String hasWavFile)

holder

public EnvelopeDefinition holder(String holder)

getHolder
```
public String getHolder()
```
Returns:
holder

setHolder
```
public void setHolder(String holder)
```

initialSentDateTime

public EnvelopeDefinition initialSentDateTime(String initialSentDateTime)

getInitialSentDateTime
```
public String getInitialSentDateTime()
```
Returns:
initialSentDateTime

setInitialSentDateTime

public void setInitialSentDateTime(String initialSentDateTime)

is21CFRPart11

public EnvelopeDefinition 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)

isDynamicEnvelope

public EnvelopeDefinition isDynamicEnvelope(String isDynamicEnvelope)

getIsDynamicEnvelope
```
public String getIsDynamicEnvelope()
```
Returns:
isDynamicEnvelope

setIsDynamicEnvelope

public void setIsDynamicEnvelope(String isDynamicEnvelope)

isSignatureProviderEnvelope

public EnvelopeDefinition isSignatureProviderEnvelope(String isSignatureProviderEnvelope)

getIsSignatureProviderEnvelope
```
public String getIsSignatureProviderEnvelope()
```
Returns:
isSignatureProviderEnvelope

setIsSignatureProviderEnvelope

public void setIsSignatureProviderEnvelope(String isSignatureProviderEnvelope)

lastModifiedDateTime

public EnvelopeDefinition lastModifiedDateTime(String lastModifiedDateTime)

getLastModifiedDateTime
```
public String getLastModifiedDateTime()
```
The date and time the item was last modified.

Returns:
lastModifiedDateTime

setLastModifiedDateTime

public void setLastModifiedDateTime(String lastModifiedDateTime)

location

public EnvelopeDefinition location(String location)

getLocation
```
public String getLocation()
```
Returns:
location

setLocation

public void setLocation(String location)

lockInformation

public EnvelopeDefinition lockInformation(LockInformation lockInformation)

getLockInformation
```
public LockInformation getLockInformation()
```
Get lockInformation

Returns:
lockInformation

setLockInformation

public void setLockInformation(LockInformation lockInformation)

messageLock

public EnvelopeDefinition 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 EnvelopeDefinition notification(Notification notification)

getNotification
```
public Notification getNotification()
```
Get notification

Returns:
notification

setNotification

public void setNotification(Notification notification)

notificationUri

public EnvelopeDefinition 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)

password

public EnvelopeDefinition password(String password)

getPassword
```
public String getPassword()
```
Returns:
password

setPassword

public void setPassword(String password)

powerForm

public EnvelopeDefinition powerForm(PowerForm powerForm)

getPowerForm
```
public PowerForm getPowerForm()
```
Get powerForm

Returns:
powerForm

setPowerForm

public void setPowerForm(PowerForm powerForm)

purgeCompletedDate

public EnvelopeDefinition purgeCompletedDate(String purgeCompletedDate)

getPurgeCompletedDate
```
public String getPurgeCompletedDate()
```
Returns:
purgeCompletedDate

setPurgeCompletedDate

public void setPurgeCompletedDate(String purgeCompletedDate)

purgeRequestDate

public EnvelopeDefinition purgeRequestDate(String purgeRequestDate)

getPurgeRequestDate
```
public String getPurgeRequestDate()
```
Returns:
purgeRequestDate

setPurgeRequestDate

public void setPurgeRequestDate(String purgeRequestDate)

purgeState

public EnvelopeDefinition purgeState(String purgeState)

getPurgeState
```
public String getPurgeState()
```
Initiates a purge request. Valid values are: * documents_queued: Places envelope documents in the purge queue. * documents_and_metadata_queued: Places envelope documents and metadata in the purge queue.

Returns:
purgeState

setPurgeState

public void setPurgeState(String purgeState)

recipients

public EnvelopeDefinition recipients(Recipients recipients)

getRecipients
```
public Recipients getRecipients()
```
Get recipients

Returns:
recipients

setRecipients

public void setRecipients(Recipients recipients)

recipientsLock

public EnvelopeDefinition 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 EnvelopeDefinition 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)

sender

public EnvelopeDefinition sender(UserInfo sender)

getSender
```
public UserInfo getSender()
```
Get sender

Returns:
sender

setSender

public void setSender(UserInfo sender)

sentDateTime

public EnvelopeDefinition 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 EnvelopeDefinition signerCanSignOnMobile(String signerCanSignOnMobile)

getSignerCanSignOnMobile
```
public String getSignerCanSignOnMobile()
```
Returns:
signerCanSignOnMobile

setSignerCanSignOnMobile

public void setSignerCanSignOnMobile(String signerCanSignOnMobile)

signingLocation

public EnvelopeDefinition 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 EnvelopeDefinition 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 EnvelopeDefinition statusChangedDateTime(String statusChangedDateTime)

getStatusChangedDateTime
```
public String getStatusChangedDateTime()
```
The data and time the status changed.

Returns:
statusChangedDateTime

setStatusChangedDateTime

public void setStatusChangedDateTime(String statusChangedDateTime)

statusDateTime

public EnvelopeDefinition statusDateTime(String statusDateTime)

getStatusDateTime
```
public String getStatusDateTime()
```
Returns:
statusDateTime

setStatusDateTime

public void setStatusDateTime(String statusDateTime)

templateId

public EnvelopeDefinition templateId(String templateId)

getTemplateId
```
public String getTemplateId()
```
The unique identifier of the template. If this is not provided, DocuSign will generate a value.

Returns:
templateId

setTemplateId

public void setTemplateId(String templateId)

templateRoles

public EnvelopeDefinition templateRoles(List<TemplateRole> templateRoles)

addTemplateRolesItem

public EnvelopeDefinition addTemplateRolesItem(TemplateRole templateRolesItem)

getTemplateRoles
```
public List<TemplateRole> getTemplateRoles()
```
Specifies the template recipients. Each roleName in the template must have a recipient assigned to it. This is made up elements: * email - The recipient's email address. * name - The recipient's name. * roleName - The template roleName associated with the recipient. * clientUserId - Optional, this sets if the signer is This specifies if the recipient is embedded or remote. If the clientUserId is not null then the recipient is embedded. Note that if a ClientUserId is used and the account settings SignerMustHaveAccount or SignerMustLoginToSign are true, an error is generated on sending. * defaultRecipient - Optional, When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. * routingOrder - This specifies the routing order of the recipient in the envelope. * accessCode - This optional element specifies the access code a recipient has to enter to validate the identity. This can be a maximum of 50 characters. * inPersonSignerName - Optional, if the template role is an in person signer, this is the full legal name of the signer. This can be a maximum of 100 characters. * emailNotification - This is an optional complex element that has a role specific emailSubject, emailBody, and language. It follows the same format as the emailNotification node for Recipients. * tabs - This allows the tab values to be specified for matching to tabs in the template.

Returns:
templateRoles

setTemplateRoles

public void setTemplateRoles(List<TemplateRole> templateRoles)

templatesUri

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

Class EnvelopeDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EnvelopeDefinition

Method Detail

accessControlListBase64

getAccessControlListBase64

setAccessControlListBase64

accessibility

getAccessibility

setAccessibility

allowComments

getAllowComments

setAllowComments

allowMarkup

getAllowMarkup

setAllowMarkup

allowReassign

getAllowReassign

setAllowReassign

allowRecipientRecursion

getAllowRecipientRecursion

setAllowRecipientRecursion

allowViewHistory

getAllowViewHistory

setAllowViewHistory

anySigner

getAnySigner

setAnySigner

asynchronous

getAsynchronous

setAsynchronous

attachments

addAttachmentsItem

getAttachments

setAttachments

attachmentsUri

getAttachmentsUri

setAttachmentsUri

authoritativeCopy

getAuthoritativeCopy

setAuthoritativeCopy

authoritativeCopyDefault

getAuthoritativeCopyDefault

setAuthoritativeCopyDefault

autoNavigation

getAutoNavigation

setAutoNavigation

brandId

getBrandId

setBrandId

brandLock

getBrandLock

setBrandLock

certificateUri

getCertificateUri

setCertificateUri

completedDateTime

getCompletedDateTime

setCompletedDateTime

compositeTemplates

addCompositeTemplatesItem

getCompositeTemplates

setCompositeTemplates

createdDateTime

getCreatedDateTime

setCreatedDateTime

customFields

getCustomFields

setCustomFields

customFieldsUri

getCustomFieldsUri

setCustomFieldsUri

declinedDateTime

getDeclinedDateTime

setDeclinedDateTime

deletedDateTime

getDeletedDateTime