Envelope (com.docusign:docusign-esign-java 2.0.0 API)

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

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2015-12-14T16:41:01.888-08:00")
public class Envelope
extends Object

Constructor Summary

Constructors
Constructor and Description

Envelope()

Constructors
Constructor and Description
`Envelope()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getAllowMarkup()` When set to true, Document Markup is enabled for envelope.
`String`	`getAllowReassign()`
`String`	`getAsynchronous()` When set to true, the envelope is queued for processing and the value of the `status` property is set to 'Processing'.
`String`	`getAuthoritativeCopy()` Specifies the Authoritative copy feature.
`String`	`getCertificateUri()` Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.
`String`	`getCompletedDateTime()` Specifies the date and time this item was completed.
`String`	`getCreatedDateTime()` Indicates the date and time the item was created.
`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`	`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()`
`String`	`getEmailSubject()` 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.
`String`	`getEnableWetSign()` When set to true, the signer is allowed to print the document and sign it on paper.
`String`	`getEnforceSignerVisibility()` When set to true, documents with tabs can only be viewed by signers that have a tab on that document.
`String`	`getEnvelopeId()` The envelope ID of the envelope status that failed to post.
`String`	`getEnvelopeIdStamping()` When set to true, Envelope ID Stamping is enabled.
`String`	`getEnvelopeUri()` Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
`String`	`getIs21CFRPart11()` When set to true, indicates that this module is enabled on the account.
`String`	`getLastModifiedDateTime()` The date and time the item was last modified.
`LockInformation`	`getLockInformation()`
`String`	`getMessageLock()` When set to true, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope.
`Notification`	`getNotification()`
`String`	`getNotificationUri()` Contains a URI for an endpoint that you can use to retrieve the notifications.
`String`	`getPurgeState()`
`String`	`getRecipientsLock()` When set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
`String`	`getRecipientsUri()` Contains a URI for an endpoint that you can use to retrieve the recipients.
`String`	`getSentDateTime()` The date and time the envelope was sent.
`String`	`getSigningLocation()` Specifies the physical location where the signing takes place.
`String`	`getStatus()` Indicates the envelope status.
`String`	`getStatusChangedDateTime()` The data and time the status changed.
`String`	`getTemplatesUri()` Contains a URI for an endpoint which you can use to retrieve the templates.
`String`	`getTransactionId()` Used to identify an envelope.
`String`	`getUseDisclosure()` When set to true, the disclosure is shown to recipients in accordance with the account’s Electronic Record and Signature Disclosure frequency setting.
`String`	`getVoidedDateTime()` The date and time the envelope or template was voided.
`String`	`getVoidedReason()` The reason the envelope or template was voided.
`int`	`hashCode()`
`void`	`setAllowMarkup(String allowMarkup)`
`void`	`setAllowReassign(String allowReassign)`
`void`	`setAsynchronous(String asynchronous)`
`void`	`setAuthoritativeCopy(String authoritativeCopy)`
`void`	`setCertificateUri(String certificateUri)`
`void`	`setCompletedDateTime(String completedDateTime)`
`void`	`setCreatedDateTime(String createdDateTime)`
`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`	`setIs21CFRPart11(String is21CFRPart11)`
`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`	`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)`
`String`	`toString()`

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

- Constructor Detail
  - Envelope
```
public Envelope()
```
- Method Detail
  - 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 if an envelope status (i.e. was created or not) for cases where an internet connection was lost before the envelope status could be returned.
  - setTransactionId
```
public void setTransactionId(String transactionId)
```
  - getStatus
```
public String getStatus()
```
    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.
  - setStatus
```
public void setStatus(String status)
```
  - getDocumentsUri
```
public String getDocumentsUri()
```
    Contains a URI for an endpoint that you can use to retrieve the documents.
  - setDocumentsUri
```
public void setDocumentsUri(String documentsUri)
```
  - getRecipientsUri
```
public String getRecipientsUri()
```
    Contains a URI for an endpoint that you can use to retrieve the recipients.
  - setRecipientsUri
```
public void setRecipientsUri(String recipientsUri)
```
  - 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.
  - setAsynchronous
```
public void setAsynchronous(String asynchronous)
```
  - getEnvelopeUri
```
public String getEnvelopeUri()
```
    Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
  - setEnvelopeUri
```
public void setEnvelopeUri(String envelopeUri)
```
  - getEmailSubject
```
public String getEmailSubject()
```
    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.
  - setEmailSubject
```
public void setEmailSubject(String emailSubject)
```
  - getEmailBlurb
```
public String getEmailBlurb()
```
    This is the same as the email body. If specified it is included in email body for all envelope recipients.
  - setEmailBlurb
```
public void setEmailBlurb(String emailBlurb)
```
  - getEnvelopeId
```
public String getEnvelopeId()
```
    The envelope ID of the envelope status that failed to post.
  - setEnvelopeId
```
public void setEnvelopeId(String envelopeId)
```
  - 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.
  - setSigningLocation
```
public void setSigningLocation(String signingLocation)
```
  - getCustomFieldsUri
```
public String getCustomFieldsUri()
```
    Contains a URI for an endpoint that you can use to retrieve the custom fields.
  - setCustomFieldsUri
```
public void setCustomFieldsUri(String customFieldsUri)
```
  - getEnvelopeIdStamping
```
public String getEnvelopeIdStamping()
```
    When set to **true**, Envelope ID Stamping is enabled.
  - setEnvelopeIdStamping
```
public void setEnvelopeIdStamping(String envelopeIdStamping)
```
  - getAuthoritativeCopy
```
public String getAuthoritativeCopy()
```
    Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.
  - setAuthoritativeCopy
```
public void setAuthoritativeCopy(String authoritativeCopy)
```
  - getNotification
```
public Notification getNotification()
```
  - setNotification
```
public void setNotification(Notification notification)
```
  - getNotificationUri
```
public String getNotificationUri()
```
    Contains a URI for an endpoint that you can use to retrieve the notifications.
  - setNotificationUri
```
public void setNotificationUri(String notificationUri)
```
  - 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.\n\nYour account must have Document Visibility enabled to use this.
  - setEnforceSignerVisibility
```
public void setEnforceSignerVisibility(String enforceSignerVisibility)
```
  - getEnableWetSign
```
public String getEnableWetSign()
```
    When set to **true**, the signer is allowed to print the document and sign it on paper.
  - setEnableWetSign
```
public void setEnableWetSign(String enableWetSign)
```
  - getAllowMarkup
```
public String getAllowMarkup()
```
    When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this
  - setAllowMarkup
```
public void setAllowMarkup(String allowMarkup)
```
  - getAllowReassign
```
public String getAllowReassign()
```
  - setAllowReassign
```
public void setAllowReassign(String allowReassign)
```
  - getCreatedDateTime
```
public String getCreatedDateTime()
```
    Indicates the date and time the item was created.
  - setCreatedDateTime
```
public void setCreatedDateTime(String createdDateTime)
```
  - getLastModifiedDateTime
```
public String getLastModifiedDateTime()
```
    The date and time the item was last modified.
  - setLastModifiedDateTime
```
public void setLastModifiedDateTime(String lastModifiedDateTime)
```
  - getDeliveredDateTime
```
public String getDeliveredDateTime()
```
    Reserved: For DocuSign use only.
  - setDeliveredDateTime
```
public void setDeliveredDateTime(String deliveredDateTime)
```
  - getSentDateTime
```
public String getSentDateTime()
```
    The date and time the envelope was sent.
  - setSentDateTime
```
public void setSentDateTime(String sentDateTime)
```
  - getCompletedDateTime
```
public String getCompletedDateTime()
```
    Specifies the date and time this item was completed.
  - setCompletedDateTime
```
public void setCompletedDateTime(String completedDateTime)
```
  - getVoidedDateTime
```
public String getVoidedDateTime()
```
    The date and time the envelope or template was voided.
  - setVoidedDateTime
```
public void setVoidedDateTime(String voidedDateTime)
```
  - getVoidedReason
```
public String getVoidedReason()
```
    The reason the envelope or template was voided.
  - setVoidedReason
```
public void setVoidedReason(String voidedReason)
```
  - getDeletedDateTime
```
public String getDeletedDateTime()
```
    Specifies the data and time the item was deleted.
  - setDeletedDateTime
```
public void setDeletedDateTime(String deletedDateTime)
```
  - getDeclinedDateTime
```
public String getDeclinedDateTime()
```
    The date and time the recipient declined the document.
  - setDeclinedDateTime
```
public void setDeclinedDateTime(String declinedDateTime)
```
  - getStatusChangedDateTime
```
public String getStatusChangedDateTime()
```
    The data and time the status changed.
  - setStatusChangedDateTime
```
public void setStatusChangedDateTime(String statusChangedDateTime)
```
  - getDocumentsCombinedUri
```
public String getDocumentsCombinedUri()
```
  - setDocumentsCombinedUri
```
public void setDocumentsCombinedUri(String documentsCombinedUri)
```
  - getCertificateUri
```
public String getCertificateUri()
```
    Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.
  - setCertificateUri
```
public void setCertificateUri(String certificateUri)
```
  - getTemplatesUri
```
public String getTemplatesUri()
```
    Contains a URI for an endpoint which you can use to retrieve the templates.
  - setTemplatesUri
```
public void setTemplatesUri(String templatesUri)
```
  - getMessageLock
```
public String getMessageLock()
```
    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.
  - setMessageLock
```
public void setMessageLock(String messageLock)
```
  - getRecipientsLock
```
public String getRecipientsLock()
```
    When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
  - setRecipientsLock
```
public void setRecipientsLock(String recipientsLock)
```
  - 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. \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.
  - setUseDisclosure
```
public void setUseDisclosure(String useDisclosure)
```
  - getEmailSettings
```
public EmailSettings getEmailSettings()
```
  - setEmailSettings
```
public void setEmailSettings(EmailSettings emailSettings)
```
  - getPurgeState
```
public String getPurgeState()
```
  - setPurgeState
```
public void setPurgeState(String purgeState)
```
  - getLockInformation
```
public LockInformation getLockInformation()
```
  - setLockInformation
```
public void setLockInformation(LockInformation lockInformation)
```
  - getIs21CFRPart11
```
public String getIs21CFRPart11()
```
    When set to **true**, indicates that this module is enabled on the account.
  - setIs21CFRPart11
```
public void setIs21CFRPart11(String is21CFRPart11)
```
  - 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

getTransactionId

setTransactionId

getStatus

setStatus

getDocumentsUri

setDocumentsUri

getRecipientsUri

setRecipientsUri

getAsynchronous

setAsynchronous

getEnvelopeUri

setEnvelopeUri

getEmailSubject

setEmailSubject

getEmailBlurb

setEmailBlurb

getEnvelopeId

setEnvelopeId

getSigningLocation

setSigningLocation

getCustomFieldsUri

setCustomFieldsUri

getEnvelopeIdStamping

setEnvelopeIdStamping

getAuthoritativeCopy

setAuthoritativeCopy

getNotification

setNotification

getNotificationUri

setNotificationUri

getEnforceSignerVisibility

setEnforceSignerVisibility

getEnableWetSign

setEnableWetSign

getAllowMarkup

setAllowMarkup

getAllowReassign

setAllowReassign

getCreatedDateTime

setCreatedDateTime

getLastModifiedDateTime

setLastModifiedDateTime

getDeliveredDateTime

setDeliveredDateTime

getSentDateTime

setSentDateTime

getCompletedDateTime

setCompletedDateTime

getVoidedDateTime

setVoidedDateTime

getVoidedReason

setVoidedReason

getDeletedDateTime

setDeletedDateTime

getDeclinedDateTime

setDeclinedDateTime

getStatusChangedDateTime

setStatusChangedDateTime

getDocumentsCombinedUri

setDocumentsCombinedUri

getCertificateUri

setCertificateUri

getTemplatesUri

setTemplatesUri

getMessageLock

setMessageLock

getRecipientsLock

setRecipientsLock

getUseDisclosure

setUseDisclosure

getEmailSettings

setEmailSettings

getPurgeState