EnvelopeTemplateResult (docusign-esign-java 3.6.0 API)

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

public class EnvelopeTemplateResult
extends Object

EnvelopeTemplateResult

Constructor Summary

Constructors
Constructor and Description

EnvelopeTemplateResult()

Constructors
Constructor and Description
`EnvelopeTemplateResult()`

Method Summary

Methods
Modifier and Type	Method and Description
`EnvelopeTemplateResult`	`addDocumentsItem(Document documentsItem)`
`EnvelopeTemplateResult`	`allowMarkup(String allowMarkup)`
`EnvelopeTemplateResult`	`allowReassign(String allowReassign)`
`EnvelopeTemplateResult`	`allowViewHistory(String allowViewHistory)`
`EnvelopeTemplateResult`	`asynchronous(String asynchronous)`
`EnvelopeTemplateResult`	`attachmentsUri(String attachmentsUri)`
`EnvelopeTemplateResult`	`authoritativeCopy(String authoritativeCopy)`
`EnvelopeTemplateResult`	`authoritativeCopyDefault(String authoritativeCopyDefault)`
`EnvelopeTemplateResult`	`autoNavigation(String autoNavigation)`
`EnvelopeTemplateResult`	`brandId(String brandId)`
`EnvelopeTemplateResult`	`brandLock(String brandLock)`
`EnvelopeTemplateResult`	`certificateUri(String certificateUri)`
`EnvelopeTemplateResult`	`completedDateTime(String completedDateTime)`
`EnvelopeTemplateResult`	`created(String created)`
`EnvelopeTemplateResult`	`createdDateTime(String createdDateTime)`
`EnvelopeTemplateResult`	`customFields(CustomFields customFields)`
`EnvelopeTemplateResult`	`customFieldsUri(String customFieldsUri)`
`EnvelopeTemplateResult`	`declinedDateTime(String declinedDateTime)`
`EnvelopeTemplateResult`	`deletedDateTime(String deletedDateTime)`
`EnvelopeTemplateResult`	`deliveredDateTime(String deliveredDateTime)`
`EnvelopeTemplateResult`	`description(String description)`
`EnvelopeTemplateResult`	`documents(List<Document> documents)`
`EnvelopeTemplateResult`	`documentsCombinedUri(String documentsCombinedUri)`
`EnvelopeTemplateResult`	`documentsUri(String documentsUri)`
`EnvelopeTemplateResult`	`emailBlurb(String emailBlurb)`
`EnvelopeTemplateResult`	`emailSettings(EmailSettings emailSettings)`
`EnvelopeTemplateResult`	`emailSubject(String emailSubject)`
`EnvelopeTemplateResult`	`enableWetSign(String enableWetSign)`
`EnvelopeTemplateResult`	`enforceSignerVisibility(String enforceSignerVisibility)`
`EnvelopeTemplateResult`	`envelopeId(String envelopeId)`
`EnvelopeTemplateResult`	`envelopeIdStamping(String envelopeIdStamping)`
`EnvelopeTemplateResult`	`envelopeUri(String envelopeUri)`
`boolean`	`equals(Object o)`
`EnvelopeTemplateResult`	`folderId(String folderId)`
`EnvelopeTemplateResult`	`folderName(String folderName)`
`EnvelopeTemplateResult`	`folderUri(String folderUri)`
`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`	`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`	`getCreated()`
`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`	`getDescription()`
`List<Document>`	`getDocuments()` Complex element contains the details on the documents in the envelope.
`String`	`getDocumentsCombinedUri()`
`String`	`getDocumentsUri()` Contains a URI for an endpoint that you can use to retrieve the documents.
`String`	`getEmailBlurb()`
`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.
`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`	`getFolderId()`
`String`	`getFolderName()`
`String`	`getFolderUri()`
`String`	`getInitialSentDateTime()`
`String`	`getIs21CFRPart11()` When set to true, indicates that this module is enabled on the account.
`String`	`getIsSignatureProviderEnvelope()`
`String`	`getLastModified()`
`String`	`getLastModifiedDateTime()` The date and time the item was last modified.
`LockInformation`	`getLockInformation()` Get lockInformation
`String`	`getMessageLock()` When set to true, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope.
`String`	`getName()`
`Notification`	`getNotification()` Get notification
`String`	`getNotificationUri()` Contains a URI for an endpoint that you can use to retrieve the notifications.
`UserInfo`	`getOwner()` Get owner
`Integer`	`getPageCount()`
`String`	`getParentFolderUri()`
`String`	`getPassword()`
`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.
`String`	`getSentDateTime()` The date and time the envelope was sent.
`String`	`getShared()` When set to true, this custom tab is shared.
`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`	`getTemplateId()` The unique identifier of the template.
`String`	`getTemplatesUri()` Contains a URI for an endpoint which you can use to retrieve the templates.
`String`	`getTransactionId()` Used to identify an envelope.
`String`	`getUri()`
`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()`
`EnvelopeTemplateResult`	`initialSentDateTime(String initialSentDateTime)`
`EnvelopeTemplateResult`	`is21CFRPart11(String is21CFRPart11)`
`EnvelopeTemplateResult`	`isSignatureProviderEnvelope(String isSignatureProviderEnvelope)`
`EnvelopeTemplateResult`	`lastModified(String lastModified)`
`EnvelopeTemplateResult`	`lastModifiedDateTime(String lastModifiedDateTime)`
`EnvelopeTemplateResult`	`lockInformation(LockInformation lockInformation)`
`EnvelopeTemplateResult`	`messageLock(String messageLock)`
`EnvelopeTemplateResult`	`name(String name)`
`EnvelopeTemplateResult`	`notification(Notification notification)`
`EnvelopeTemplateResult`	`notificationUri(String notificationUri)`
`EnvelopeTemplateResult`	`owner(UserInfo owner)`
`EnvelopeTemplateResult`	`pageCount(Integer pageCount)`
`EnvelopeTemplateResult`	`parentFolderUri(String parentFolderUri)`
`EnvelopeTemplateResult`	`password(String password)`
`EnvelopeTemplateResult`	`purgeState(String purgeState)`
`EnvelopeTemplateResult`	`recipients(Recipients recipients)`
`EnvelopeTemplateResult`	`recipientsLock(String recipientsLock)`
`EnvelopeTemplateResult`	`recipientsUri(String recipientsUri)`
`EnvelopeTemplateResult`	`sentDateTime(String sentDateTime)`
`void`	`setAllowMarkup(String allowMarkup)`
`void`	`setAllowReassign(String allowReassign)`
`void`	`setAllowViewHistory(String allowViewHistory)`
`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`	`setCreated(String created)`
`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`	`setDescription(String description)`
`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`	`setFolderId(String folderId)`
`void`	`setFolderName(String folderName)`
`void`	`setFolderUri(String folderUri)`
`void`	`setInitialSentDateTime(String initialSentDateTime)`
`void`	`setIs21CFRPart11(String is21CFRPart11)`
`void`	`setIsSignatureProviderEnvelope(String isSignatureProviderEnvelope)`
`void`	`setLastModified(String lastModified)`
`void`	`setLastModifiedDateTime(String lastModifiedDateTime)`
`void`	`setLockInformation(LockInformation lockInformation)`
`void`	`setMessageLock(String messageLock)`
`void`	`setName(String name)`
`void`	`setNotification(Notification notification)`
`void`	`setNotificationUri(String notificationUri)`
`void`	`setOwner(UserInfo owner)`
`void`	`setPageCount(Integer pageCount)`
`void`	`setParentFolderUri(String parentFolderUri)`
`void`	`setPassword(String password)`
`void`	`setPurgeState(String purgeState)`
`void`	`setRecipients(Recipients recipients)`
`void`	`setRecipientsLock(String recipientsLock)`
`void`	`setRecipientsUri(String recipientsUri)`
`void`	`setSentDateTime(String sentDateTime)`
`void`	`setShared(String shared)`
`void`	`setSignerCanSignOnMobile(String signerCanSignOnMobile)`
`void`	`setSigningLocation(String signingLocation)`
`void`	`setStatus(String status)`
`void`	`setStatusChangedDateTime(String statusChangedDateTime)`
`void`	`setTemplateId(String templateId)`
`void`	`setTemplatesUri(String templatesUri)`
`void`	`setTransactionId(String transactionId)`
`void`	`setUri(String uri)`
`void`	`setUseDisclosure(String useDisclosure)`
`void`	`setVoidedDateTime(String voidedDateTime)`
`void`	`setVoidedReason(String voidedReason)`
`EnvelopeTemplateResult`	`shared(String shared)`
`EnvelopeTemplateResult`	`signerCanSignOnMobile(String signerCanSignOnMobile)`
`EnvelopeTemplateResult`	`signingLocation(String signingLocation)`
`EnvelopeTemplateResult`	`status(String status)`
`EnvelopeTemplateResult`	`statusChangedDateTime(String statusChangedDateTime)`
`EnvelopeTemplateResult`	`templateId(String templateId)`
`EnvelopeTemplateResult`	`templatesUri(String templatesUri)`
`String`	`toString()`
`EnvelopeTemplateResult`	`transactionId(String transactionId)`
`EnvelopeTemplateResult`	`uri(String uri)`
`EnvelopeTemplateResult`	`useDisclosure(String useDisclosure)`
`EnvelopeTemplateResult`	`voidedDateTime(String voidedDateTime)`
`EnvelopeTemplateResult`	`voidedReason(String voidedReason)`

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

Constructor Detail
- EnvelopeTemplateResult
```
public EnvelopeTemplateResult()
```

Method Detail

allowMarkup

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

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

setAllowViewHistory

public void setAllowViewHistory(String allowViewHistory)

asynchronous

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

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

setAttachmentsUri

public void setAttachmentsUri(String attachmentsUri)

authoritativeCopy

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

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

setAuthoritativeCopyDefault

public void setAuthoritativeCopyDefault(String authoritativeCopyDefault)

autoNavigation

public EnvelopeTemplateResult autoNavigation(String autoNavigation)

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

setAutoNavigation

public void setAutoNavigation(String autoNavigation)

brandId

public EnvelopeTemplateResult brandId(String brandId)

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

setBrandId

public void setBrandId(String brandId)

brandLock

public EnvelopeTemplateResult brandLock(String brandLock)

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

setBrandLock

public void setBrandLock(String brandLock)

certificateUri

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

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

Returns:
completedDateTime

setCompletedDateTime

public void setCompletedDateTime(String completedDateTime)

created

public EnvelopeTemplateResult created(String created)

getCreated
```
public String getCreated()
```
Returns:
created

setCreated

public void setCreated(String created)

createdDateTime

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

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

Returns:
customFields

setCustomFields

public void setCustomFields(CustomFields customFields)

customFieldsUri

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

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

Returns:
deliveredDateTime

setDeliveredDateTime

public void setDeliveredDateTime(String deliveredDateTime)

description

public EnvelopeTemplateResult description(String description)

getDescription
```
public String getDescription()
```
Returns:
description

setDescription

public void setDescription(String description)

documents

public EnvelopeTemplateResult documents(List<Document> documents)

addDocumentsItem

public EnvelopeTemplateResult addDocumentsItem(Document documentsItem)

getDocuments
```
public List<Document> getDocuments()
```
Complex element contains the details on the documents in the envelope.

Returns:
documents

setDocuments

public void setDocuments(List<Document> documents)

documentsCombinedUri

public EnvelopeTemplateResult documentsCombinedUri(String documentsCombinedUri)

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

setDocumentsCombinedUri

public void setDocumentsCombinedUri(String documentsCombinedUri)

documentsUri

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

getEmailBlurb
```
public String getEmailBlurb()
```
Returns:
emailBlurb

setEmailBlurb

public void setEmailBlurb(String emailBlurb)

emailSettings

public EnvelopeTemplateResult emailSettings(EmailSettings emailSettings)

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

Returns:
emailSettings

setEmailSettings

public void setEmailSettings(EmailSettings emailSettings)

emailSubject

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

envelopeId

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

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

Returns:
envelopeIdStamping

setEnvelopeIdStamping

public void setEnvelopeIdStamping(String envelopeIdStamping)

envelopeUri

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

folderId

public EnvelopeTemplateResult folderId(String folderId)

getFolderId
```
public String getFolderId()
```
Returns:
folderId

setFolderId

public void setFolderId(String folderId)

folderName

public EnvelopeTemplateResult folderName(String folderName)

getFolderName
```
public String getFolderName()
```
Returns:
folderName

setFolderName

public void setFolderName(String folderName)

folderUri

public EnvelopeTemplateResult folderUri(String folderUri)

getFolderUri
```
public String getFolderUri()
```
Returns:
folderUri

setFolderUri

public void setFolderUri(String folderUri)

initialSentDateTime

public EnvelopeTemplateResult initialSentDateTime(String initialSentDateTime)

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

setInitialSentDateTime

public void setInitialSentDateTime(String initialSentDateTime)

is21CFRPart11

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

isSignatureProviderEnvelope

public EnvelopeTemplateResult isSignatureProviderEnvelope(String isSignatureProviderEnvelope)

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

setIsSignatureProviderEnvelope

public void setIsSignatureProviderEnvelope(String isSignatureProviderEnvelope)

lastModified

public EnvelopeTemplateResult lastModified(String lastModified)

getLastModified
```
public String getLastModified()
```
Returns:
lastModified

setLastModified

public void setLastModified(String lastModified)

lastModifiedDateTime

public EnvelopeTemplateResult lastModifiedDateTime(String lastModifiedDateTime)

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

Returns:
lastModifiedDateTime

setLastModifiedDateTime

public void setLastModifiedDateTime(String lastModifiedDateTime)

lockInformation

public EnvelopeTemplateResult lockInformation(LockInformation lockInformation)

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

Returns:
lockInformation

setLockInformation

public void setLockInformation(LockInformation lockInformation)

messageLock

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

name

public EnvelopeTemplateResult name(String name)

getName
```
public String getName()
```
Returns:
name

setName
```
public void setName(String name)
```

notification

public EnvelopeTemplateResult notification(Notification notification)

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

Returns:
notification

setNotification

public void setNotification(Notification notification)

notificationUri

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

owner

public EnvelopeTemplateResult owner(UserInfo owner)

getOwner
```
public UserInfo getOwner()
```
Get owner

Returns:
owner

setOwner
```
public void setOwner(UserInfo owner)
```

pageCount

public EnvelopeTemplateResult pageCount(Integer pageCount)

getPageCount
```
public Integer getPageCount()
```
Returns:
pageCount

setPageCount

public void setPageCount(Integer pageCount)

parentFolderUri

public EnvelopeTemplateResult parentFolderUri(String parentFolderUri)

getParentFolderUri
```
public String getParentFolderUri()
```
Returns:
parentFolderUri

setParentFolderUri

public void setParentFolderUri(String parentFolderUri)

password

public EnvelopeTemplateResult password(String password)

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

setPassword

public void setPassword(String password)

purgeState

public EnvelopeTemplateResult purgeState(String purgeState)

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

setPurgeState

public void setPurgeState(String purgeState)

recipients

public EnvelopeTemplateResult recipients(Recipients recipients)

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

Returns:
recipients

setRecipients

public void setRecipients(Recipients recipients)

recipientsLock

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

sentDateTime

public EnvelopeTemplateResult sentDateTime(String sentDateTime)

getSentDateTime
```
public String getSentDateTime()
```
The date and time the envelope was sent.

Returns:
sentDateTime

setSentDateTime

public void setSentDateTime(String sentDateTime)

shared

public EnvelopeTemplateResult shared(String shared)

getShared
```
public String getShared()
```
When set to **true**, this custom tab is shared.

Returns:
shared

setShared
```
public void setShared(String shared)
```

signerCanSignOnMobile

public EnvelopeTemplateResult signerCanSignOnMobile(String signerCanSignOnMobile)

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

setSignerCanSignOnMobile

public void setSignerCanSignOnMobile(String signerCanSignOnMobile)

signingLocation

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

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

Returns:
statusChangedDateTime

setStatusChangedDateTime

public void setStatusChangedDateTime(String statusChangedDateTime)

templateId

public EnvelopeTemplateResult templateId(String templateId)

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

Returns:
templateId

setTemplateId

public void setTemplateId(String templateId)

templatesUri

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

uri

public EnvelopeTemplateResult uri(String uri)

getUri
```
public String getUri()
```
Returns:
uri

setUri
```
public void setUri(String uri)
```

useDisclosure

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

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

Returns:
voidedReason

setVoidedReason

public void setVoidedReason(String voidedReason)

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

Class EnvelopeTemplateResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EnvelopeTemplateResult

Method Detail

allowMarkup

getAllowMarkup

setAllowMarkup

allowReassign

getAllowReassign

setAllowReassign

allowViewHistory

getAllowViewHistory

setAllowViewHistory

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

created

getCreated

setCreated

createdDateTime

getCreatedDateTime

setCreatedDateTime

customFields

getCustomFields

setCustomFields

customFieldsUri

getCustomFieldsUri

setCustomFieldsUri

declinedDateTime

getDeclinedDateTime

setDeclinedDateTime

deletedDateTime

getDeletedDateTime

setDeletedDateTime

deliveredDateTime

getDeliveredDateTime

setDeliveredDateTime

description

getDescription

setDescription

documents

addDocumentsItem

getDocuments

setDocuments

documentsCombinedUri

getDocumentsCombinedUri

setDocumentsCombinedUri

documentsUri

getDocumentsUri

setDocumentsUri

emailBlurb

getEmailBlurb

setEmailBlurb