Envelope (docusign-esign-java 2.0.2 API)

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

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2016-07-18T18:11:15.675-07:00")
public class Envelope
extends Object

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`	`allowMarkup(String allowMarkup)` When set to true, Document Markup is enabled for envelope.
`Envelope`	`allowReassign(String allowReassign)` When set to true, the recipient can redirect an envelope to a more appropriate recipient.
`Envelope`	`asynchronous(String asynchronous)` When set to true, the envelope is queued for processing and the value of the `status` property is set to 'Processing'.
`Envelope`	`authoritativeCopy(String authoritativeCopy)` Specifies the Authoritative copy feature.
`Envelope`	`autoNavigation(String autoNavigation)`
`Envelope`	`brandId(String brandId)`
`Envelope`	`brandLock(String brandLock)`
`Envelope`	`certificateUri(String certificateUri)` Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.
`Envelope`	`completedDateTime(String completedDateTime)` Specifies the date and time this item was completed.
`Envelope`	`createdDateTime(String createdDateTime)` Indicates the date and time the item was created.
`Envelope`	`customFields(CustomFields customFields)`
`Envelope`	`customFieldsUri(String customFieldsUri)` Contains a URI for an endpoint that you can use to retrieve the custom fields.
`Envelope`	`declinedDateTime(String declinedDateTime)` The date and time the recipient declined the document.
`Envelope`	`deletedDateTime(String deletedDateTime)` Specifies the data and time the item was deleted.
`Envelope`	`deliveredDateTime(String deliveredDateTime)` Reserved: For DocuSign use only.
`Envelope`	`documentsCombinedUri(String documentsCombinedUri)`
`Envelope`	`documentsUri(String documentsUri)` Contains a URI for an endpoint that you can use to retrieve the documents.
`Envelope`	`emailBlurb(String emailBlurb)` This is the same as the email body.
`Envelope`	`emailSettings(EmailSettings emailSettings)`
`Envelope`	`emailSubject(String emailSubject)` Specifies the subject of the email that is sent to all recipients.\n\nSee [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.
`Envelope`	`enableWetSign(String enableWetSign)` When set to true, the signer is allowed to print the document and sign it on paper.
`Envelope`	`enforceSignerVisibility(String enforceSignerVisibility)` When set to true, documents with tabs can only be viewed by signers that have a tab on that document.
`Envelope`	`envelopeId(String envelopeId)` The envelope ID of the envelope status that failed to post.
`Envelope`	`envelopeIdStamping(String envelopeIdStamping)` When set to true, Envelope ID Stamping is enabled.
`Envelope`	`envelopeUri(String envelopeUri)` Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
`boolean`	`equals(Object o)`
`String`	`getAllowMarkup()`
`String`	`getAllowReassign()`
`String`	`getAsynchronous()`
`String`	`getAuthoritativeCopy()`
`String`	`getAutoNavigation()`
`String`	`getBrandId()`
`String`	`getBrandLock()`
`String`	`getCertificateUri()`
`String`	`getCompletedDateTime()`
`String`	`getCreatedDateTime()`
`CustomFields`	`getCustomFields()`
`String`	`getCustomFieldsUri()`
`String`	`getDeclinedDateTime()`
`String`	`getDeletedDateTime()`
`String`	`getDeliveredDateTime()`
`String`	`getDocumentsCombinedUri()`
`String`	`getDocumentsUri()`
`String`	`getEmailBlurb()`
`EmailSettings`	`getEmailSettings()`
`String`	`getEmailSubject()`
`String`	`getEnableWetSign()`
`String`	`getEnforceSignerVisibility()`
`String`	`getEnvelopeId()`
`String`	`getEnvelopeIdStamping()`
`String`	`getEnvelopeUri()`
`String`	`getInitialSentDateTime()`
`String`	`getIs21CFRPart11()`
`String`	`getIsSignatureProviderEnvelope()`
`String`	`getLastModifiedDateTime()`
`LockInformation`	`getLockInformation()`
`String`	`getMessageLock()`
`Notification`	`getNotification()`
`String`	`getNotificationUri()`
`String`	`getPurgeState()`
`Recipients`	`getRecipients()`
`String`	`getRecipientsLock()`
`String`	`getRecipientsUri()`
`String`	`getSentDateTime()`
`String`	`getSigningLocation()`
`String`	`getStatus()`
`String`	`getStatusChangedDateTime()`
`String`	`getTemplatesUri()`
`String`	`getTransactionId()`
`String`	`getUseDisclosure()`
`String`	`getVoidedDateTime()`
`String`	`getVoidedReason()`
`int`	`hashCode()`
`Envelope`	`initialSentDateTime(String initialSentDateTime)`
`Envelope`	`is21CFRPart11(String is21CFRPart11)` When set to true, indicates that this module is enabled on the account.
`Envelope`	`isSignatureProviderEnvelope(String isSignatureProviderEnvelope)`
`Envelope`	`lastModifiedDateTime(String lastModifiedDateTime)` The date and time the item was last modified.
`Envelope`	`lockInformation(LockInformation lockInformation)`
`Envelope`	`messageLock(String messageLock)` When set to true, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope.
`Envelope`	`notification(Notification notification)`
`Envelope`	`notificationUri(String notificationUri)` Contains a URI for an endpoint that you can use to retrieve the notifications.
`Envelope`	`purgeState(String purgeState)`
`Envelope`	`recipients(Recipients recipients)`
`Envelope`	`recipientsLock(String recipientsLock)` When set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
`Envelope`	`recipientsUri(String recipientsUri)` Contains a URI for an endpoint that you can use to retrieve the recipients.
`Envelope`	`sentDateTime(String sentDateTime)` The date and time the envelope was sent.
`void`	`setAllowMarkup(String allowMarkup)`
`void`	`setAllowReassign(String allowReassign)`
`void`	`setAsynchronous(String asynchronous)`
`void`	`setAuthoritativeCopy(String authoritativeCopy)`
`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`	`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`	`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`	`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)`
`Envelope`	`signingLocation(String signingLocation)` Specifies the physical location where the signing takes place.
`Envelope`	`status(String status)` Indicates the envelope status.
`Envelope`	`statusChangedDateTime(String statusChangedDateTime)` The data and time the status changed.
`Envelope`	`templatesUri(String templatesUri)` Contains a URI for an endpoint which you can use to retrieve the templates.
`String`	`toString()`
`Envelope`	`transactionId(String transactionId)` Used to identify an envelope.
`Envelope`	`useDisclosure(String useDisclosure)` When set to true, the disclosure is shown to recipients in accordance with the account’s Electronic Record and Signature Disclosure frequency setting.
`Envelope`	`voidedDateTime(String voidedDateTime)` The date and time the envelope or template was voided.
`Envelope`	`voidedReason(String voidedReason)` The reason the envelope or template was voided.

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

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

Method Detail

transactionId
```
public Envelope transactionId(String transactionId)
```
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.

getTransactionId
```
public String getTransactionId()
```

setTransactionId

public void setTransactionId(String transactionId)

status
```
public Envelope status(String status)
```
Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n*created - The envelope is saved as a draft and can be modified and sent later.

getStatus
```
public String getStatus()
```

setStatus
```
public void setStatus(String status)
```

documentsUri
```
public Envelope documentsUri(String documentsUri)
```
Contains a URI for an endpoint that you can use to retrieve the documents.

getDocumentsUri
```
public String getDocumentsUri()
```

setDocumentsUri

public void setDocumentsUri(String documentsUri)

recipientsUri
```
public Envelope recipientsUri(String recipientsUri)
```
Contains a URI for an endpoint that you can use to retrieve the recipients.

getRecipientsUri
```
public String getRecipientsUri()
```

setRecipientsUri

public void setRecipientsUri(String recipientsUri)

asynchronous
```
public Envelope asynchronous(String asynchronous)
```
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.

getAsynchronous
```
public String getAsynchronous()
```

setAsynchronous

public void setAsynchronous(String asynchronous)

envelopeUri
```
public Envelope envelopeUri(String envelopeUri)
```
Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.

getEnvelopeUri
```
public String getEnvelopeUri()
```

setEnvelopeUri

public void setEnvelopeUri(String envelopeUri)

emailSubject
```
public Envelope emailSubject(String emailSubject)
```
Specifies the subject of the email that is sent to all recipients.\n\nSee [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.

getEmailSubject
```
public String getEmailSubject()
```

setEmailSubject

public void setEmailSubject(String emailSubject)

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

getEmailBlurb
```
public String getEmailBlurb()
```

setEmailBlurb

public void setEmailBlurb(String emailBlurb)

envelopeId
```
public Envelope envelopeId(String envelopeId)
```
The envelope ID of the envelope status that failed to post.

getEnvelopeId
```
public String getEnvelopeId()
```

setEnvelopeId

public void setEnvelopeId(String envelopeId)

signingLocation
```
public Envelope signingLocation(String signingLocation)
```
Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.

getSigningLocation
```
public String getSigningLocation()
```

setSigningLocation

public void setSigningLocation(String signingLocation)

customFieldsUri
```
public Envelope customFieldsUri(String customFieldsUri)
```
Contains a URI for an endpoint that you can use to retrieve the custom fields.

getCustomFieldsUri
```
public String getCustomFieldsUri()
```

setCustomFieldsUri

public void setCustomFieldsUri(String customFieldsUri)

customFields

public Envelope customFields(CustomFields customFields)

getCustomFields
```
public CustomFields getCustomFields()
```

setCustomFields

public void setCustomFields(CustomFields customFields)

autoNavigation

public Envelope autoNavigation(String autoNavigation)

getAutoNavigation
```
public String getAutoNavigation()
```

setAutoNavigation

public void setAutoNavigation(String autoNavigation)

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

getEnvelopeIdStamping
```
public String getEnvelopeIdStamping()
```

setEnvelopeIdStamping

public void setEnvelopeIdStamping(String envelopeIdStamping)

authoritativeCopy
```
public Envelope authoritativeCopy(String authoritativeCopy)
```
Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.

getAuthoritativeCopy
```
public String getAuthoritativeCopy()
```

setAuthoritativeCopy

public void setAuthoritativeCopy(String authoritativeCopy)

notification

public Envelope notification(Notification notification)

getNotification
```
public Notification getNotification()
```

setNotification

public void setNotification(Notification notification)

notificationUri
```
public Envelope notificationUri(String notificationUri)
```
Contains a URI for an endpoint that you can use to retrieve the notifications.

getNotificationUri
```
public String getNotificationUri()
```

setNotificationUri

public void setNotificationUri(String notificationUri)

enforceSignerVisibility
```
public Envelope enforceSignerVisibility(String enforceSignerVisibility)
```
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.\n\nYour account must have Document Visibility enabled to use this.

getEnforceSignerVisibility

public String getEnforceSignerVisibility()

setEnforceSignerVisibility

public void setEnforceSignerVisibility(String enforceSignerVisibility)

enableWetSign
```
public Envelope enableWetSign(String enableWetSign)
```
When set to **true**, the signer is allowed to print the document and sign it on paper.

getEnableWetSign
```
public String getEnableWetSign()
```

setEnableWetSign

public void setEnableWetSign(String enableWetSign)

allowMarkup
```
public Envelope allowMarkup(String allowMarkup)
```
When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this

getAllowMarkup
```
public String getAllowMarkup()
```

setAllowMarkup

public void setAllowMarkup(String allowMarkup)

allowReassign
```
public Envelope allowReassign(String allowReassign)
```
When set to **true**, the recipient can redirect an envelope to a more appropriate recipient.

getAllowReassign
```
public String getAllowReassign()
```

setAllowReassign

public void setAllowReassign(String allowReassign)

createdDateTime

public Envelope createdDateTime(String createdDateTime)

Indicates the date and time the item was created.

getCreatedDateTime
```
public String getCreatedDateTime()
```

setCreatedDateTime

public void setCreatedDateTime(String createdDateTime)

lastModifiedDateTime

public Envelope lastModifiedDateTime(String lastModifiedDateTime)

The date and time the item was last modified.

getLastModifiedDateTime

public String getLastModifiedDateTime()

setLastModifiedDateTime

public void setLastModifiedDateTime(String lastModifiedDateTime)

deliveredDateTime

public Envelope deliveredDateTime(String deliveredDateTime)

Reserved: For DocuSign use only.

getDeliveredDateTime
```
public String getDeliveredDateTime()
```

setDeliveredDateTime

public void setDeliveredDateTime(String deliveredDateTime)

initialSentDateTime

public Envelope initialSentDateTime(String initialSentDateTime)

getInitialSentDateTime

public String getInitialSentDateTime()

setInitialSentDateTime

public void setInitialSentDateTime(String initialSentDateTime)

sentDateTime

public Envelope sentDateTime(String sentDateTime)

The date and time the envelope was sent.

getSentDateTime
```
public String getSentDateTime()
```

setSentDateTime

public void setSentDateTime(String sentDateTime)

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

getCompletedDateTime
```
public String getCompletedDateTime()
```

setCompletedDateTime

public void setCompletedDateTime(String completedDateTime)

voidedDateTime
```
public Envelope voidedDateTime(String voidedDateTime)
```
The date and time the envelope or template was voided.

getVoidedDateTime
```
public String getVoidedDateTime()
```

setVoidedDateTime

public void setVoidedDateTime(String voidedDateTime)

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

getVoidedReason
```
public String getVoidedReason()
```

setVoidedReason

public void setVoidedReason(String voidedReason)

deletedDateTime

public Envelope deletedDateTime(String deletedDateTime)

Specifies the data and time the item was deleted.

getDeletedDateTime
```
public String getDeletedDateTime()
```

setDeletedDateTime

public void setDeletedDateTime(String deletedDateTime)

declinedDateTime
```
public Envelope declinedDateTime(String declinedDateTime)
```
The date and time the recipient declined the document.

getDeclinedDateTime
```
public String getDeclinedDateTime()
```

setDeclinedDateTime

public void setDeclinedDateTime(String declinedDateTime)

statusChangedDateTime

public Envelope statusChangedDateTime(String statusChangedDateTime)

The data and time the status changed.

getStatusChangedDateTime

public String getStatusChangedDateTime()

setStatusChangedDateTime

public void setStatusChangedDateTime(String statusChangedDateTime)

documentsCombinedUri

public Envelope documentsCombinedUri(String documentsCombinedUri)

getDocumentsCombinedUri

public String getDocumentsCombinedUri()

setDocumentsCombinedUri

public void setDocumentsCombinedUri(String documentsCombinedUri)

certificateUri
```
public Envelope certificateUri(String certificateUri)
```
Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.

getCertificateUri
```
public String getCertificateUri()
```

setCertificateUri

public void setCertificateUri(String certificateUri)

templatesUri
```
public Envelope templatesUri(String templatesUri)
```
Contains a URI for an endpoint which you can use to retrieve the templates.

getTemplatesUri
```
public String getTemplatesUri()
```

setTemplatesUri

public void setTemplatesUri(String templatesUri)

messageLock
```
public Envelope messageLock(String messageLock)
```
When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. \n\nAdditionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. \n\nHowever, 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.

getMessageLock
```
public String getMessageLock()
```

setMessageLock

public void setMessageLock(String messageLock)

recipientsLock
```
public Envelope recipientsLock(String recipientsLock)
```
When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.

getRecipientsLock
```
public String getRecipientsLock()
```

setRecipientsLock

public void setRecipientsLock(String recipientsLock)

recipients

public Envelope recipients(Recipients recipients)

getRecipients
```
public Recipients getRecipients()
```

setRecipients

public void setRecipients(Recipients recipients)

brandLock

public Envelope brandLock(String brandLock)

getBrandLock
```
public String getBrandLock()
```

setBrandLock

public void setBrandLock(String brandLock)

brandId

public Envelope brandId(String brandId)

getBrandId
```
public String getBrandId()
```

setBrandId

public void setBrandId(String brandId)

useDisclosure
```
public Envelope useDisclosure(String useDisclosure)
```
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. \n\nIf 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.

getUseDisclosure
```
public String getUseDisclosure()
```

setUseDisclosure

public void setUseDisclosure(String useDisclosure)

emailSettings

public Envelope emailSettings(EmailSettings emailSettings)

getEmailSettings

public EmailSettings getEmailSettings()

setEmailSettings

public void setEmailSettings(EmailSettings emailSettings)

purgeState

public Envelope purgeState(String purgeState)

getPurgeState
```
public String getPurgeState()
```

setPurgeState

public void setPurgeState(String purgeState)

lockInformation

public Envelope lockInformation(LockInformation lockInformation)

getLockInformation

public LockInformation getLockInformation()

setLockInformation

public void setLockInformation(LockInformation lockInformation)

is21CFRPart11
```
public Envelope is21CFRPart11(String is21CFRPart11)
```
When set to **true**, indicates that this module is enabled on the account.

getIs21CFRPart11
```
public String getIs21CFRPart11()
```

setIs21CFRPart11

public void setIs21CFRPart11(String is21CFRPart11)

isSignatureProviderEnvelope

public Envelope isSignatureProviderEnvelope(String isSignatureProviderEnvelope)

getIsSignatureProviderEnvelope

public String getIsSignatureProviderEnvelope()

setIsSignatureProviderEnvelope

public void setIsSignatureProviderEnvelope(String isSignatureProviderEnvelope)

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

transactionId

getTransactionId

setTransactionId

status

getStatus

setStatus

documentsUri

getDocumentsUri

setDocumentsUri

recipientsUri

getRecipientsUri

setRecipientsUri

asynchronous

getAsynchronous

setAsynchronous

envelopeUri

getEnvelopeUri

setEnvelopeUri

emailSubject

getEmailSubject

setEmailSubject

emailBlurb

getEmailBlurb

setEmailBlurb

envelopeId

getEnvelopeId

setEnvelopeId

signingLocation

getSigningLocation

setSigningLocation

customFieldsUri

getCustomFieldsUri

setCustomFieldsUri

customFields

getCustomFields

setCustomFields

autoNavigation

getAutoNavigation

setAutoNavigation

envelopeIdStamping

getEnvelopeIdStamping

setEnvelopeIdStamping

authoritativeCopy

getAuthoritativeCopy

setAuthoritativeCopy

notification

getNotification

setNotification

notificationUri

getNotificationUri

setNotificationUri

enforceSignerVisibility

getEnforceSignerVisibility

setEnforceSignerVisibility

enableWetSign

getEnableWetSign

setEnableWetSign

allowMarkup

getAllowMarkup