Envelope (docusign-esign-java 3.9.0 API)

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

```
public class Envelope
extends Object
```
Envelope

Constructor Summary

Constructors
Constructor and Description

Envelope()

Constructors
Constructor and Description
`Envelope()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Envelope`	`accessControlListBase64(String accessControlListBase64)`
`Envelope`	`addEnvelopeAttachmentsItem(Attachment envelopeAttachmentsItem)`
`Envelope`	`addEnvelopeDocumentsItem(EnvelopeDocument envelopeDocumentsItem)`
`Envelope`	`addFoldersItem(Folder foldersItem)`
`Envelope`	`allowComments(String allowComments)`
`Envelope`	`allowMarkup(String allowMarkup)`
`Envelope`	`allowReassign(String allowReassign)`
`Envelope`	`allowViewHistory(String allowViewHistory)`
`Envelope`	`anySigner(String anySigner)`
`Envelope`	`asynchronous(String asynchronous)`
`Envelope`	`attachmentsUri(String attachmentsUri)`
`Envelope`	`authoritativeCopy(String authoritativeCopy)`
`Envelope`	`authoritativeCopyDefault(String authoritativeCopyDefault)`
`Envelope`	`autoNavigation(String autoNavigation)`
`Envelope`	`brandId(String brandId)`
`Envelope`	`brandLock(String brandLock)`
`Envelope`	`certificateUri(String certificateUri)`
`Envelope`	`completedDateTime(String completedDateTime)`
`Envelope`	`copyRecipientData(String copyRecipientData)`
`Envelope`	`createdDateTime(String createdDateTime)`
`Envelope`	`customFields(CustomFields customFields)`
`Envelope`	`customFieldsUri(String customFieldsUri)`
`Envelope`	`declinedDateTime(String declinedDateTime)`
`Envelope`	`deletedDateTime(String deletedDateTime)`
`Envelope`	`deliveredDateTime(String deliveredDateTime)`
`Envelope`	`disableResponsiveDocument(String disableResponsiveDocument)`
`Envelope`	`documentsCombinedUri(String documentsCombinedUri)`
`Envelope`	`documentsUri(String documentsUri)`
`Envelope`	`emailBlurb(String emailBlurb)`
`Envelope`	`emailSettings(EmailSettings emailSettings)`
`Envelope`	`emailSubject(String emailSubject)`
`Envelope`	`enableWetSign(String enableWetSign)`
`Envelope`	`enforceSignerVisibility(String enforceSignerVisibility)`
`Envelope`	`envelopeAttachments(List<Attachment> envelopeAttachments)`
`Envelope`	`envelopeDocuments(List<EnvelopeDocument> envelopeDocuments)`
`Envelope`	`envelopeId(String envelopeId)`
`Envelope`	`envelopeIdStamping(String envelopeIdStamping)`
`Envelope`	`envelopeLocation(String envelopeLocation)`
`Envelope`	`envelopeMetadata(EnvelopeMetadata envelopeMetadata)`
`Envelope`	`envelopeUri(String envelopeUri)`
`boolean`	`equals(Object o)`
`Envelope`	`expireAfter(String expireAfter)`
`Envelope`	`expireDateTime(String expireDateTime)`
`Envelope`	`expireEnabled(String expireEnabled)`
`Envelope`	`externalEnvelopeId(String externalEnvelopeId)`
`Envelope`	`folders(List<Folder> folders)`
`String`	`getAccessControlListBase64()`
`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`	`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'.
`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`	`getCopyRecipientData()`
`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()`
`String`	`getDocumentsCombinedUri()`
`String`	`getDocumentsUri()` Contains a URI for an endpoint that you can use to retrieve the documents.
`String`	`getEmailBlurb()` This is the same as the email body.
`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.
`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.
`PowerForm`	`getPowerForm()` Get powerForm
`String`	`getPurgeCompletedDate()`
`String`	`getPurgeRequestDate()`
`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.
`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`	`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.
`Workflow`	`getWorkflow()` Get workflow
`Envelope`	`hasComments(String hasComments)`
`Envelope`	`hasFormDataChanged(String hasFormDataChanged)`
`int`	`hashCode()`
`Envelope`	`hasWavFile(String hasWavFile)`
`Envelope`	`holder(String holder)`
`Envelope`	`initialSentDateTime(String initialSentDateTime)`
`Envelope`	`is21CFRPart11(String is21CFRPart11)`
`Envelope`	`isDynamicEnvelope(String isDynamicEnvelope)`
`Envelope`	`isSignatureProviderEnvelope(String isSignatureProviderEnvelope)`
`Envelope`	`lastModifiedDateTime(String lastModifiedDateTime)`
`Envelope`	`location(String location)`
`Envelope`	`lockInformation(LockInformation lockInformation)`
`Envelope`	`messageLock(String messageLock)`
`Envelope`	`notification(Notification notification)`
`Envelope`	`notificationUri(String notificationUri)`
`Envelope`	`powerForm(PowerForm powerForm)`
`Envelope`	`purgeCompletedDate(String purgeCompletedDate)`
`Envelope`	`purgeRequestDate(String purgeRequestDate)`
`Envelope`	`purgeState(String purgeState)`
`Envelope`	`recipients(Recipients recipients)`
`Envelope`	`recipientsLock(String recipientsLock)`
`Envelope`	`recipientsUri(String recipientsUri)`
`Envelope`	`sender(UserInfo sender)`
`Envelope`	`sentDateTime(String sentDateTime)`
`void`	`setAccessControlListBase64(String accessControlListBase64)`
`void`	`setAllowComments(String allowComments)`
`void`	`setAllowMarkup(String allowMarkup)`
`void`	`setAllowReassign(String allowReassign)`
`void`	`setAllowViewHistory(String allowViewHistory)`
`void`	`setAnySigner(String anySigner)`
`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`	`setCopyRecipientData(String copyRecipientData)`
`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`	`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`	`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`	`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`	`setTemplatesUri(String templatesUri)`
`void`	`setTransactionId(String transactionId)`
`void`	`setUseDisclosure(String useDisclosure)`
`void`	`setVoidedDateTime(String voidedDateTime)`
`void`	`setVoidedReason(String voidedReason)`
`void`	`setWorkflow(Workflow workflow)`
`Envelope`	`signerCanSignOnMobile(String signerCanSignOnMobile)`
`Envelope`	`signingLocation(String signingLocation)`
`Envelope`	`status(String status)`
`Envelope`	`statusChangedDateTime(String statusChangedDateTime)`
`Envelope`	`statusDateTime(String statusDateTime)`
`Envelope`	`templatesUri(String templatesUri)`
`String`	`toString()`
`Envelope`	`transactionId(String transactionId)`
`Envelope`	`useDisclosure(String useDisclosure)`
`Envelope`	`voidedDateTime(String voidedDateTime)`
`Envelope`	`voidedReason(String voidedReason)`
`Envelope`	`workflow(Workflow workflow)`

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

Constructor Detail
- Envelope
```
public Envelope()
```

Method Detail

accessControlListBase64

public Envelope accessControlListBase64(String accessControlListBase64)

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

accessControlListBase64

setAccessControlListBase64

public void setAccessControlListBase64(String accessControlListBase64)

allowComments

public Envelope allowComments(String allowComments)

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

allowComments

setAllowComments

public void setAllowComments(String allowComments)

allowMarkup

public Envelope 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 Envelope 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 Envelope allowViewHistory(String allowViewHistory)

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

allowViewHistory

setAllowViewHistory

public void setAllowViewHistory(String allowViewHistory)

anySigner

public Envelope anySigner(String anySigner)

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

anySigner

setAnySigner

public void setAnySigner(String anySigner)

asynchronous

public Envelope 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 Envelope attachmentsUri(String attachmentsUri)

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

attachmentsUri

setAttachmentsUri

public void setAttachmentsUri(String attachmentsUri)

authoritativeCopy

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

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

authoritativeCopyDefault

setAuthoritativeCopyDefault

public void setAuthoritativeCopyDefault(String authoritativeCopyDefault)

autoNavigation

public Envelope autoNavigation(String autoNavigation)

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

autoNavigation

setAutoNavigation

public void setAutoNavigation(String autoNavigation)

brandId

public Envelope brandId(String brandId)

getBrandId
```
public String getBrandId()
```
Returns:

brandId

setBrandId

public void setBrandId(String brandId)

brandLock

public Envelope brandLock(String brandLock)

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

brandLock

setBrandLock

public void setBrandLock(String brandLock)

certificateUri

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

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

Returns:

completedDateTime

setCompletedDateTime

public void setCompletedDateTime(String completedDateTime)

copyRecipientData

public Envelope copyRecipientData(String copyRecipientData)

getCopyRecipientData
```
public String getCopyRecipientData()
```
Returns:

copyRecipientData

setCopyRecipientData

public void setCopyRecipientData(String copyRecipientData)

createdDateTime

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

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

Returns:

customFields

setCustomFields

public void setCustomFields(CustomFields customFields)

customFieldsUri

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

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

Returns:

deliveredDateTime

setDeliveredDateTime

public void setDeliveredDateTime(String deliveredDateTime)

disableResponsiveDocument

public Envelope disableResponsiveDocument(String disableResponsiveDocument)

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

disableResponsiveDocument

setDisableResponsiveDocument

public void setDisableResponsiveDocument(String disableResponsiveDocument)

documentsCombinedUri

public Envelope documentsCombinedUri(String documentsCombinedUri)

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

documentsCombinedUri

setDocumentsCombinedUri

public void setDocumentsCombinedUri(String documentsCombinedUri)

documentsUri

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

getEmailBlurb
```
public String getEmailBlurb()
```
This is the same as the email body. If specified it is included in email body for all envelope recipients.

Returns:

emailBlurb

setEmailBlurb

public void setEmailBlurb(String emailBlurb)

emailSettings

public Envelope emailSettings(EmailSettings emailSettings)

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

Returns:

emailSettings

setEmailSettings

public void setEmailSettings(EmailSettings emailSettings)

emailSubject

public Envelope 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 Envelope 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 Envelope 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 Envelope envelopeAttachments(List<Attachment> envelopeAttachments)

addEnvelopeAttachmentsItem

public Envelope addEnvelopeAttachmentsItem(Attachment envelopeAttachmentsItem)

getEnvelopeAttachments

public List<Attachment> getEnvelopeAttachments()

Returns:: envelopeAttachments

setEnvelopeAttachments

public void setEnvelopeAttachments(List<Attachment> envelopeAttachments)

envelopeDocuments

public Envelope envelopeDocuments(List<EnvelopeDocument> envelopeDocuments)

addEnvelopeDocumentsItem

public Envelope addEnvelopeDocumentsItem(EnvelopeDocument envelopeDocumentsItem)

getEnvelopeDocuments

public List<EnvelopeDocument> getEnvelopeDocuments()

Returns:: envelopeDocuments

setEnvelopeDocuments

public void setEnvelopeDocuments(List<EnvelopeDocument> envelopeDocuments)

envelopeId

public Envelope 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 Envelope 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 Envelope envelopeLocation(String envelopeLocation)

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

envelopeLocation

setEnvelopeLocation

public void setEnvelopeLocation(String envelopeLocation)

envelopeMetadata

public Envelope envelopeMetadata(EnvelopeMetadata envelopeMetadata)

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

Returns:

envelopeMetadata

setEnvelopeMetadata

public void setEnvelopeMetadata(EnvelopeMetadata envelopeMetadata)

envelopeUri

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

expireAfter

public Envelope expireAfter(String expireAfter)

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

expireAfter

setExpireAfter

public void setExpireAfter(String expireAfter)

expireDateTime

public Envelope expireDateTime(String expireDateTime)

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

expireDateTime

setExpireDateTime

public void setExpireDateTime(String expireDateTime)

expireEnabled

public Envelope expireEnabled(String expireEnabled)

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

expireEnabled

setExpireEnabled

public void setExpireEnabled(String expireEnabled)

externalEnvelopeId

public Envelope externalEnvelopeId(String externalEnvelopeId)

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

externalEnvelopeId

setExternalEnvelopeId

public void setExternalEnvelopeId(String externalEnvelopeId)

folders

public Envelope folders(List<Folder> folders)

addFoldersItem

public Envelope addFoldersItem(Folder foldersItem)

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

folders

setFolders

public void setFolders(List<Folder> folders)

hasComments

public Envelope hasComments(String hasComments)

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

hasComments

setHasComments

public void setHasComments(String hasComments)

hasFormDataChanged

public Envelope hasFormDataChanged(String hasFormDataChanged)

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

hasFormDataChanged

setHasFormDataChanged

public void setHasFormDataChanged(String hasFormDataChanged)

hasWavFile

public Envelope hasWavFile(String hasWavFile)

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

hasWavFile

setHasWavFile

public void setHasWavFile(String hasWavFile)

holder

public Envelope holder(String holder)

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

holder

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

initialSentDateTime

public Envelope initialSentDateTime(String initialSentDateTime)

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

initialSentDateTime

setInitialSentDateTime

public void setInitialSentDateTime(String initialSentDateTime)

is21CFRPart11

public Envelope 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 Envelope isDynamicEnvelope(String isDynamicEnvelope)

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

isDynamicEnvelope

setIsDynamicEnvelope

public void setIsDynamicEnvelope(String isDynamicEnvelope)

isSignatureProviderEnvelope

public Envelope isSignatureProviderEnvelope(String isSignatureProviderEnvelope)

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

isSignatureProviderEnvelope

setIsSignatureProviderEnvelope

public void setIsSignatureProviderEnvelope(String isSignatureProviderEnvelope)

lastModifiedDateTime

public Envelope 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 Envelope location(String location)

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

location

setLocation

public void setLocation(String location)

lockInformation

public Envelope lockInformation(LockInformation lockInformation)

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

Returns:

lockInformation

setLockInformation

public void setLockInformation(LockInformation lockInformation)

messageLock

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

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

Returns:

notification

setNotification

public void setNotification(Notification notification)

notificationUri

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

powerForm

public Envelope powerForm(PowerForm powerForm)

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

Returns:

powerForm

setPowerForm

public void setPowerForm(PowerForm powerForm)

purgeCompletedDate

public Envelope purgeCompletedDate(String purgeCompletedDate)

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

purgeCompletedDate

setPurgeCompletedDate

public void setPurgeCompletedDate(String purgeCompletedDate)

purgeRequestDate

public Envelope purgeRequestDate(String purgeRequestDate)

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

purgeRequestDate

setPurgeRequestDate

public void setPurgeRequestDate(String purgeRequestDate)

purgeState

public Envelope purgeState(String purgeState)

getPurgeState
```
public String getPurgeState()
```
Returns:

purgeState

setPurgeState

public void setPurgeState(String purgeState)

recipients

public Envelope recipients(Recipients recipients)

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

Returns:

recipients

setRecipients

public void setRecipients(Recipients recipients)

recipientsLock

public Envelope 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 Envelope 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 Envelope sender(UserInfo sender)

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

Returns:

sender

setSender

public void setSender(UserInfo sender)

sentDateTime

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

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

signerCanSignOnMobile

setSignerCanSignOnMobile

public void setSignerCanSignOnMobile(String signerCanSignOnMobile)

signingLocation

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

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

Returns:

statusChangedDateTime

setStatusChangedDateTime

public void setStatusChangedDateTime(String statusChangedDateTime)

statusDateTime

public Envelope statusDateTime(String statusDateTime)

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

statusDateTime

setStatusDateTime

public void setStatusDateTime(String statusDateTime)

templatesUri

public Envelope 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 Envelope 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 Envelope 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 Envelope 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 Envelope voidedReason(String voidedReason)

getVoidedReason
```
public String getVoidedReason()
```
The reason the envelope or template was voided.

Returns:

voidedReason

setVoidedReason

public void setVoidedReason(String voidedReason)

workflow

public Envelope workflow(Workflow workflow)

getWorkflow
```
public Workflow getWorkflow()
```
Get workflow

Returns:

workflow

setWorkflow

public void setWorkflow(Workflow workflow)

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 Envelope

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Envelope

Method Detail

accessControlListBase64

getAccessControlListBase64

setAccessControlListBase64

allowComments

getAllowComments

setAllowComments

allowMarkup

getAllowMarkup

setAllowMarkup

allowReassign

getAllowReassign

setAllowReassign

allowViewHistory

getAllowViewHistory

setAllowViewHistory

anySigner

getAnySigner

setAnySigner

asynchronous

getAsynchronous

setAsynchronous

attachmentsUri

getAttachmentsUri

setAttachmentsUri

authoritativeCopy

getAuthoritativeCopy

setAuthoritativeCopy

authoritativeCopyDefault

getAuthoritativeCopyDefault

setAuthoritativeCopyDefault

autoNavigation

getAutoNavigation

setAutoNavigation

brandId

getBrandId

setBrandId

brandLock

getBrandLock

setBrandLock

certificateUri

getCertificateUri

setCertificateUri

completedDateTime

getCompletedDateTime

setCompletedDateTime

copyRecipientData

getCopyRecipientData

setCopyRecipientData

createdDateTime

getCreatedDateTime

setCreatedDateTime

customFields

getCustomFields

setCustomFields

customFieldsUri

getCustomFieldsUri

setCustomFieldsUri

declinedDateTime

getDeclinedDateTime

setDeclinedDateTime

deletedDateTime

getDeletedDateTime

setDeletedDateTime

deliveredDateTime

getDeliveredDateTime

setDeliveredDateTime

disableResponsiveDocument

getDisableResponsiveDocument

setDisableResponsiveDocument

documentsCombinedUri

getDocumentsCombinedUri

setDocumentsCombinedUri

documentsUri