EnvelopeDefinition (docusign-esign-java 2.0.1 API)

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

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2016-04-27T11:06:30.816-07:00")
public class EnvelopeDefinition
extends Object

Constructor Summary

Constructors
Constructor and Description

EnvelopeDefinition()

Constructors
Constructor and Description
`EnvelopeDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EnvelopeDefinition`	`accessibility(String accessibility)` Sets the document reading zones for screen reader applications.
`EnvelopeDefinition`	`allowMarkup(String allowMarkup)` When set to true, Document Markup is enabled for envelope.
`EnvelopeDefinition`	`allowReassign(String allowReassign)` When set to true, the recipient can redirect an envelope to a more appropriate recipient.
`EnvelopeDefinition`	`allowRecipientRecursion(String allowRecipientRecursion)` When set to true, this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order.
`EnvelopeDefinition`	`asynchronous(String asynchronous)` When set to true, the envelope is queued for processing and the value of the `status` property is set to 'Processing'.
`EnvelopeDefinition`	`authoritativeCopy(String authoritativeCopy)` Specifies the Authoritative copy feature.
`EnvelopeDefinition`	`brandId(String brandId)` This sets the brand profile format used for the envelope.
`EnvelopeDefinition`	`brandLock(String brandLock)`
`EnvelopeDefinition`	`certificateUri(String certificateUri)` Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.
`EnvelopeDefinition`	`completedDateTime(String completedDateTime)` Specifies the date and time this item was completed.
`EnvelopeDefinition`	`compositeTemplates(List<CompositeTemplate> compositeTemplates)` A complex type that can be added to create envelopes from a combination of DocuSign templates and PDF forms.
`EnvelopeDefinition`	`createdDateTime(String createdDateTime)` Indicates the date and time the item was created.
`EnvelopeDefinition`	`customFields(CustomFields customFields)`
`EnvelopeDefinition`	`customFieldsUri(String customFieldsUri)` Contains a URI for an endpoint that you can use to retrieve the custom fields.
`EnvelopeDefinition`	`declinedDateTime(String declinedDateTime)` The date and time the recipient declined the document.
`EnvelopeDefinition`	`deletedDateTime(String deletedDateTime)` Specifies the data and time the item was deleted.
`EnvelopeDefinition`	`deliveredDateTime(String deliveredDateTime)` Reserved: For DocuSign use only.
`EnvelopeDefinition`	`documents(List<Document> documents)` Complex element contains the details on the documents in the envelope.
`EnvelopeDefinition`	`documentsCombinedUri(String documentsCombinedUri)`
`EnvelopeDefinition`	`documentsUri(String documentsUri)` Contains a URI for an endpoint that you can use to retrieve the documents.
`EnvelopeDefinition`	`emailBlurb(String emailBlurb)` Optional element.
`EnvelopeDefinition`	`emailSettings(EmailSettings emailSettings)`
`EnvelopeDefinition`	`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.
`EnvelopeDefinition`	`enableWetSign(String enableWetSign)` When set to true, the signer is allowed to print the document and sign it on paper.
`EnvelopeDefinition`	`enforceSignerVisibility(String enforceSignerVisibility)` When set to true, documents with tabs can only be viewed by signers that have a tab on that document.
`EnvelopeDefinition`	`envelopeId(String envelopeId)` The envelope ID of the envelope status that failed to post.
`EnvelopeDefinition`	`envelopeIdStamping(String envelopeIdStamping)` When set to true, Envelope ID Stamping is enabled.
`EnvelopeDefinition`	`envelopeUri(String envelopeUri)` Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
`boolean`	`equals(Object o)`
`EnvelopeDefinition`	`eventNotification(EventNotification eventNotification)`
`String`	`getAccessibility()`
`String`	`getAllowMarkup()`
`String`	`getAllowReassign()`
`String`	`getAllowRecipientRecursion()`
`String`	`getAsynchronous()`
`String`	`getAuthoritativeCopy()`
`String`	`getBrandId()`
`String`	`getBrandLock()`
`String`	`getCertificateUri()`
`String`	`getCompletedDateTime()`
`List<CompositeTemplate>`	`getCompositeTemplates()`
`String`	`getCreatedDateTime()`
`CustomFields`	`getCustomFields()`
`String`	`getCustomFieldsUri()`
`String`	`getDeclinedDateTime()`
`String`	`getDeletedDateTime()`
`String`	`getDeliveredDateTime()`
`List<Document>`	`getDocuments()`
`String`	`getDocumentsCombinedUri()`
`String`	`getDocumentsUri()`
`String`	`getEmailBlurb()`
`EmailSettings`	`getEmailSettings()`
`String`	`getEmailSubject()`
`String`	`getEnableWetSign()`
`String`	`getEnforceSignerVisibility()`
`String`	`getEnvelopeId()`
`String`	`getEnvelopeIdStamping()`
`String`	`getEnvelopeUri()`
`EventNotification`	`getEventNotification()`
`String`	`getIs21CFRPart11()`
`String`	`getIsUniversalSignatureEnvelope()`
`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`	`getTemplateId()`
`List<TemplateRole>`	`getTemplateRoles()`
`String`	`getTemplatesUri()`
`String`	`getTransactionId()`
`String`	`getUseDisclosure()`
`String`	`getVoidedDateTime()`
`String`	`getVoidedReason()`
`int`	`hashCode()`
`EnvelopeDefinition`	`is21CFRPart11(String is21CFRPart11)` When set to true, indicates that this module is enabled on the account.
`EnvelopeDefinition`	`isUniversalSignatureEnvelope(String isUniversalSignatureEnvelope)`
`EnvelopeDefinition`	`lastModifiedDateTime(String lastModifiedDateTime)` The date and time the item was last modified.
`EnvelopeDefinition`	`lockInformation(LockInformation lockInformation)`
`EnvelopeDefinition`	`messageLock(String messageLock)` When set to true, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope.
`EnvelopeDefinition`	`notification(Notification notification)`
`EnvelopeDefinition`	`notificationUri(String notificationUri)` Contains a URI for an endpoint that you can use to retrieve the notifications.
`EnvelopeDefinition`	`purgeState(String purgeState)` Initiates a purge request.
`EnvelopeDefinition`	`recipients(Recipients recipients)`
`EnvelopeDefinition`	`recipientsLock(String recipientsLock)` When set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
`EnvelopeDefinition`	`recipientsUri(String recipientsUri)` Contains a URI for an endpoint that you can use to retrieve the recipients.
`EnvelopeDefinition`	`sentDateTime(String sentDateTime)` The date and time the envelope was sent.
`void`	`setAccessibility(String accessibility)`
`void`	`setAllowMarkup(String allowMarkup)`
`void`	`setAllowReassign(String allowReassign)`
`void`	`setAllowRecipientRecursion(String allowRecipientRecursion)`
`void`	`setAsynchronous(String asynchronous)`
`void`	`setAuthoritativeCopy(String authoritativeCopy)`
`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`	`setDocuments(List<Document> documents)`
`void`	`setDocumentsCombinedUri(String documentsCombinedUri)`
`void`	`setDocumentsUri(String documentsUri)`
`void`	`setEmailBlurb(String emailBlurb)`
`void`	`setEmailSettings(EmailSettings emailSettings)`
`void`	`setEmailSubject(String emailSubject)`
`void`	`setEnableWetSign(String enableWetSign)`
`void`	`setEnforceSignerVisibility(String enforceSignerVisibility)`
`void`	`setEnvelopeId(String envelopeId)`
`void`	`setEnvelopeIdStamping(String envelopeIdStamping)`
`void`	`setEnvelopeUri(String envelopeUri)`
`void`	`setEventNotification(EventNotification eventNotification)`
`void`	`setIs21CFRPart11(String is21CFRPart11)`
`void`	`setIsUniversalSignatureEnvelope(String isUniversalSignatureEnvelope)`
`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`	`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`	`signingLocation(String signingLocation)` Specifies the physical location where the signing takes place.
`EnvelopeDefinition`	`status(String status)` Indicates the envelope status.
`EnvelopeDefinition`	`statusChangedDateTime(String statusChangedDateTime)` The data and time the status changed.
`EnvelopeDefinition`	`templateId(String templateId)` The unique identifier of the template.
`EnvelopeDefinition`	`templateRoles(List<TemplateRole> templateRoles)` Specifies the template recipients.
`EnvelopeDefinition`	`templatesUri(String templatesUri)` Contains a URI for an endpoint which you can use to retrieve the templates.
`String`	`toString()`
`EnvelopeDefinition`	`transactionId(String transactionId)` Used to identify an envelope.
`EnvelopeDefinition`	`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.
`EnvelopeDefinition`	`voidedDateTime(String voidedDateTime)` The date and time the envelope or template was voided.
`EnvelopeDefinition`	`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
  - EnvelopeDefinition
```
public EnvelopeDefinition()
```
- Method Detail
  - documents
```
public EnvelopeDefinition documents(List<Document> documents)
```
    Complex element contains the details on the documents in the envelope.
  - getDocuments
```
public List<Document> getDocuments()
```
  - setDocuments
```
public void setDocuments(List<Document> documents)
```
  - recipients
```
public EnvelopeDefinition recipients(Recipients recipients)
```
  - getRecipients
```
public Recipients getRecipients()
```
  - setRecipients
```
public void setRecipients(Recipients recipients)
```
  - customFields
```
public EnvelopeDefinition customFields(CustomFields customFields)
```
  - getCustomFields
```
public CustomFields getCustomFields()
```
  - setCustomFields
```
public void setCustomFields(CustomFields customFields)
```
  - eventNotification
```
public EnvelopeDefinition eventNotification(EventNotification eventNotification)
```
  - getEventNotification
```
public EventNotification getEventNotification()
```
  - setEventNotification
```
public void setEventNotification(EventNotification eventNotification)
```
  - allowRecipientRecursion
```
public EnvelopeDefinition allowRecipientRecursion(String allowRecipientRecursion)
```
    When set to **true**, this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order.
  - getAllowRecipientRecursion
```
public String getAllowRecipientRecursion()
```
  - setAllowRecipientRecursion
```
public void setAllowRecipientRecursion(String allowRecipientRecursion)
```
  - templateId
```
public EnvelopeDefinition templateId(String templateId)
```
    The unique identifier of the template. If this is not provided, DocuSign will generate a value.
  - getTemplateId
```
public String getTemplateId()
```
  - setTemplateId
```
public void setTemplateId(String templateId)
```
  - templateRoles
```
public EnvelopeDefinition templateRoles(List<TemplateRole> templateRoles)
```
    Specifies the template recipients. Each roleName in the template must have a recipient assigned to it. This is made up elements:\n\n* email - The recipient’s email address.\n* name - The recipient’s name.\n* roleName - The template roleName associated with the recipient.\n* 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.\n* 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.\n* routingOrder - This specifies the routing order of the recipient in the envelope.\n* 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.\n* 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.\n* 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.\n* tabs - This allows the tab values to be specified for matching to tabs in the template.\n
  - getTemplateRoles
```
public List<TemplateRole> getTemplateRoles()
```
  - setTemplateRoles
```
public void setTemplateRoles(List<TemplateRole> templateRoles)
```
  - compositeTemplates
```
public EnvelopeDefinition compositeTemplates(List<CompositeTemplate> compositeTemplates)
```
    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.
  - getCompositeTemplates
```
public List<CompositeTemplate> getCompositeTemplates()
```
  - setCompositeTemplates
```
public void setCompositeTemplates(List<CompositeTemplate> compositeTemplates)
```
  - accessibility
```
public EnvelopeDefinition accessibility(String accessibility)
```
    Sets the document reading zones for screen reader applications. This element can only be used if Document Accessibility is enabled for the account. \n\n#### 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.
  - getAccessibility
```
public String getAccessibility()
```
  - setAccessibility
```
public void setAccessibility(String accessibility)
```
  - transactionId
```
public EnvelopeDefinition 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 EnvelopeDefinition 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 EnvelopeDefinition 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 EnvelopeDefinition 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 EnvelopeDefinition 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 EnvelopeDefinition 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 EnvelopeDefinition 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 EnvelopeDefinition emailBlurb(String emailBlurb)
```
    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
  - getEmailBlurb
```
public String getEmailBlurb()
```
  - setEmailBlurb
```
public void setEmailBlurb(String emailBlurb)
```
  - envelopeId
```
public EnvelopeDefinition 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 EnvelopeDefinition 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 EnvelopeDefinition 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)
```
  - envelopeIdStamping
```
public EnvelopeDefinition envelopeIdStamping(String envelopeIdStamping)
```
    When set to **true**, Envelope ID Stamping is enabled.
  - getEnvelopeIdStamping
```
public String getEnvelopeIdStamping()
```
  - setEnvelopeIdStamping
```
public void setEnvelopeIdStamping(String envelopeIdStamping)
```
  - authoritativeCopy
```
public EnvelopeDefinition 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 EnvelopeDefinition notification(Notification notification)
```
  - getNotification
```
public Notification getNotification()
```
  - setNotification
```
public void setNotification(Notification notification)
```
  - notificationUri
```
public EnvelopeDefinition 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 EnvelopeDefinition 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 EnvelopeDefinition 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 EnvelopeDefinition 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 EnvelopeDefinition 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 EnvelopeDefinition createdDateTime(String createdDateTime)
```
    Indicates the date and time the item was created.
  - getCreatedDateTime
```
public String getCreatedDateTime()
```
  - setCreatedDateTime
```
public void setCreatedDateTime(String createdDateTime)
```
  - lastModifiedDateTime
```
public EnvelopeDefinition lastModifiedDateTime(String lastModifiedDateTime)
```
    The date and time the item was last modified.
  - getLastModifiedDateTime
```
public String getLastModifiedDateTime()
```
  - setLastModifiedDateTime
```
public void setLastModifiedDateTime(String lastModifiedDateTime)
```
  - deliveredDateTime
```
public EnvelopeDefinition deliveredDateTime(String deliveredDateTime)
```
    Reserved: For DocuSign use only.
  - getDeliveredDateTime
```
public String getDeliveredDateTime()
```
  - setDeliveredDateTime
```
public void setDeliveredDateTime(String deliveredDateTime)
```
  - sentDateTime
```
public EnvelopeDefinition sentDateTime(String sentDateTime)
```
    The date and time the envelope was sent.
  - getSentDateTime
```
public String getSentDateTime()
```
  - setSentDateTime
```
public void setSentDateTime(String sentDateTime)
```
  - completedDateTime
```
public EnvelopeDefinition completedDateTime(String completedDateTime)
```
    Specifies the date and time this item was completed.
  - getCompletedDateTime
```
public String getCompletedDateTime()
```
  - setCompletedDateTime
```
public void setCompletedDateTime(String completedDateTime)
```
  - voidedDateTime
```
public EnvelopeDefinition 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 EnvelopeDefinition voidedReason(String voidedReason)
```
    The reason the envelope or template was voided.
  - getVoidedReason
```
public String getVoidedReason()
```
  - setVoidedReason
```
public void setVoidedReason(String voidedReason)
```
  - deletedDateTime
```
public EnvelopeDefinition deletedDateTime(String deletedDateTime)
```
    Specifies the data and time the item was deleted.
  - getDeletedDateTime
```
public String getDeletedDateTime()
```
  - setDeletedDateTime
```
public void setDeletedDateTime(String deletedDateTime)
```
  - declinedDateTime
```
public EnvelopeDefinition declinedDateTime(String declinedDateTime)
```
    The date and time the recipient declined the document.
  - getDeclinedDateTime
```
public String getDeclinedDateTime()
```
  - setDeclinedDateTime
```
public void setDeclinedDateTime(String declinedDateTime)
```
  - statusChangedDateTime
```
public EnvelopeDefinition statusChangedDateTime(String statusChangedDateTime)
```
    The data and time the status changed.
  - getStatusChangedDateTime
```
public String getStatusChangedDateTime()
```
  - setStatusChangedDateTime
```
public void setStatusChangedDateTime(String statusChangedDateTime)
```
  - documentsCombinedUri
```
public EnvelopeDefinition documentsCombinedUri(String documentsCombinedUri)
```
  - getDocumentsCombinedUri
```
public String getDocumentsCombinedUri()
```
  - setDocumentsCombinedUri
```
public void setDocumentsCombinedUri(String documentsCombinedUri)
```
  - certificateUri
```
public EnvelopeDefinition 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 EnvelopeDefinition 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 EnvelopeDefinition 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 EnvelopeDefinition 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)
```
  - brandLock
```
public EnvelopeDefinition brandLock(String brandLock)
```
  - getBrandLock
```
public String getBrandLock()
```
  - setBrandLock
```
public void setBrandLock(String brandLock)
```
  - brandId
```
public EnvelopeDefinition brandId(String brandId)
```
    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.
  - getBrandId
```
public String getBrandId()
```
  - setBrandId
```
public void setBrandId(String brandId)
```
  - useDisclosure
```
public EnvelopeDefinition 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 EnvelopeDefinition emailSettings(EmailSettings emailSettings)
```
  - getEmailSettings
```
public EmailSettings getEmailSettings()
```
  - setEmailSettings
```
public void setEmailSettings(EmailSettings emailSettings)
```
  - purgeState
```
public EnvelopeDefinition purgeState(String purgeState)
```
    Initiates a purge request. Valid values are:\n* documents_queued: Places envelope documents in the purge queue.\n* documents_and_metadata_queued: Places envelope documents and metadata in the purge queue.\n
  - getPurgeState
```
public String getPurgeState()
```
  - setPurgeState
```
public void setPurgeState(String purgeState)
```
  - lockInformation
```
public EnvelopeDefinition lockInformation(LockInformation lockInformation)
```
  - getLockInformation
```
public LockInformation getLockInformation()
```
  - setLockInformation
```
public void setLockInformation(LockInformation lockInformation)
```
  - is21CFRPart11
```
public EnvelopeDefinition 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)
```
  - isUniversalSignatureEnvelope
```
public EnvelopeDefinition isUniversalSignatureEnvelope(String isUniversalSignatureEnvelope)
```
  - getIsUniversalSignatureEnvelope
```
public String getIsUniversalSignatureEnvelope()
```
  - setIsUniversalSignatureEnvelope
```
public void setIsUniversalSignatureEnvelope(String isUniversalSignatureEnvelope)
```
  - 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

documents

getDocuments

setDocuments

recipients

getRecipients

setRecipients

customFields

getCustomFields

setCustomFields

eventNotification

getEventNotification

setEventNotification

allowRecipientRecursion

getAllowRecipientRecursion

setAllowRecipientRecursion

templateId

getTemplateId

setTemplateId

templateRoles

getTemplateRoles

setTemplateRoles

compositeTemplates

getCompositeTemplates

setCompositeTemplates

accessibility

getAccessibility

setAccessibility

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

envelopeIdStamping

getEnvelopeIdStamping

setEnvelopeIdStamping

authoritativeCopy

getAuthoritativeCopy

setAuthoritativeCopy

notification

getNotification

setNotification

notificationUri

getNotificationUri

setNotificationUri

enforceSignerVisibility