Package com.docusign.esign.model
Class Envelope
- java.lang.Object
-
- com.docusign.esign.model.Envelope
-
- All Implemented Interfaces:
Serializable
public class Envelope extends Object implements Serializable
Envelope.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Envelope()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EnvelopeaccessControlListBase64(String accessControlListBase64)accessControlListBase64.EnvelopeaddEnvelopeAttachmentsItem(Attachment envelopeAttachmentsItem)addEnvelopeAttachmentsItem.EnvelopeaddEnvelopeDocumentsItem(EnvelopeDocument envelopeDocumentsItem)addEnvelopeDocumentsItem.EnvelopeaddFoldersItem(Folder foldersItem)addFoldersItem.EnvelopeallowComments(String allowComments)allowComments.EnvelopeallowMarkup(String allowMarkup)allowMarkup.EnvelopeallowReassign(String allowReassign)allowReassign.EnvelopeallowViewHistory(String allowViewHistory)allowViewHistory.EnvelopeanySigner(String anySigner)anySigner.Envelopeasynchronous(String asynchronous)asynchronous.EnvelopeattachmentsUri(String attachmentsUri)attachmentsUri.EnvelopeauthoritativeCopy(String authoritativeCopy)authoritativeCopy.EnvelopeauthoritativeCopyDefault(String authoritativeCopyDefault)authoritativeCopyDefault.EnvelopeautoNavigation(String autoNavigation)autoNavigation.EnvelopebrandId(String brandId)brandId.EnvelopebrandLock(String brandLock)brandLock.EnvelopeburnDefaultTabData(String burnDefaultTabData)burnDefaultTabData.EnvelopecertificateUri(String certificateUri)certificateUri.EnvelopecompletedDateTime(String completedDateTime)completedDateTime.EnvelopecopyRecipientData(String copyRecipientData)copyRecipientData.EnvelopecreatedDateTime(String createdDateTime)createdDateTime.EnvelopecustomFields(CustomFields customFields)customFields.EnvelopecustomFieldsUri(String customFieldsUri)customFieldsUri.EnvelopedeclinedDateTime(String declinedDateTime)declinedDateTime.EnvelopedeletedDateTime(String deletedDateTime)deletedDateTime.EnvelopedeliveredDateTime(String deliveredDateTime)deliveredDateTime.EnvelopedisableResponsiveDocument(String disableResponsiveDocument)disableResponsiveDocument.EnvelopedocumentBase64(String documentBase64)documentBase64.EnvelopedocumentsCombinedUri(String documentsCombinedUri)documentsCombinedUri.EnvelopedocumentsUri(String documentsUri)documentsUri.EnvelopeemailBlurb(String emailBlurb)emailBlurb.EnvelopeemailSettings(EmailSettings emailSettings)emailSettings.EnvelopeemailSubject(String emailSubject)emailSubject.EnvelopeenableWetSign(String enableWetSign)enableWetSign.EnvelopeenforceSignerVisibility(String enforceSignerVisibility)enforceSignerVisibility.EnvelopeenvelopeAttachments(List<Attachment> envelopeAttachments)envelopeAttachments.EnvelopeenvelopeCustomMetadata(EnvelopeCustomMetadata envelopeCustomMetadata)envelopeCustomMetadata.EnvelopeenvelopeDocuments(List<EnvelopeDocument> envelopeDocuments)envelopeDocuments.EnvelopeenvelopeId(String envelopeId)envelopeId.EnvelopeenvelopeIdStamping(String envelopeIdStamping)envelopeIdStamping.EnvelopeenvelopeLocation(String envelopeLocation)envelopeLocation.EnvelopeenvelopeMetadata(EnvelopeMetadata envelopeMetadata)envelopeMetadata.EnvelopeenvelopeUri(String envelopeUri)envelopeUri.booleanequals(Object o)Compares objects.EnvelopeexpireAfter(String expireAfter)expireAfter.EnvelopeexpireDateTime(String expireDateTime)expireDateTime.EnvelopeexpireEnabled(String expireEnabled)expireEnabled.EnvelopeexternalEnvelopeId(String externalEnvelopeId)externalEnvelopeId.Envelopefolders(List<Folder> folders)folders.StringgetAccessControlListBase64().StringgetAllowComments().StringgetAllowMarkup()When set to **true**, Document Markup is enabled for envelope.StringgetAllowReassign()When set to **true**, the recipient can redirect an envelope to a more appropriate recipient..StringgetAllowViewHistory().StringgetAnySigner().StringgetAsynchronous()When set to **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'.StringgetAttachmentsUri().StringgetAuthoritativeCopy()Specifies the Authoritative copy feature.StringgetAuthoritativeCopyDefault().StringgetAutoNavigation().StringgetBrandId().StringgetBrandLock().StringgetBurnDefaultTabData().StringgetCertificateUri()Retrieves a URI for an endpoint that allows you to easily retrieve certificate information..StringgetCompletedDateTime()Specifies the date and time this item was completed..StringgetCopyRecipientData().StringgetCreatedDateTime()Indicates the date and time the item was created..CustomFieldsgetCustomFields()An optional array of strings that allows the sender to provide custom data about the recipient.StringgetCustomFieldsUri()Contains a URI for an endpoint that you can use to retrieve the custom fields..StringgetDeclinedDateTime()The date and time the recipient declined the document..StringgetDeletedDateTime()Specifies the data and time the item was deleted..StringgetDeliveredDateTime()Reserved: For DocuSign use only..StringgetDisableResponsiveDocument().StringgetDocumentBase64().StringgetDocumentsCombinedUri().StringgetDocumentsUri()Contains a URI for an endpoint that you can use to retrieve the documents..StringgetEmailBlurb()This is the same as the email body.EmailSettingsgetEmailSettings()A complex type that contains email settings..StringgetEmailSubject()Specifies the subject of the email that is sent to all recipients.StringgetEnableWetSign()When set to **true**, the signer is allowed to print the document and sign it on paper..StringgetEnforceSignerVisibility()When set to **true**, documents with tabs can only be viewed by signers that have a tab on that document.List<Attachment>getEnvelopeAttachments().EnvelopeCustomMetadatagetEnvelopeCustomMetadata().List<EnvelopeDocument>getEnvelopeDocuments().StringgetEnvelopeId()The envelope ID of the envelope status that failed to post..StringgetEnvelopeIdStamping()When set to **true**, Envelope ID Stamping is enabled..StringgetEnvelopeLocation().EnvelopeMetadatagetEnvelopeMetadata()Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service..StringgetEnvelopeUri()Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes..StringgetExpireAfter().StringgetExpireDateTime().StringgetExpireEnabled().StringgetExternalEnvelopeId().List<Folder>getFolders().StringgetHasComments().StringgetHasFormDataChanged().StringgetHasWavFile().StringgetHolder().StringgetInitialSentDateTime().StringgetIs21CFRPart11()When set to **true**, indicates that this module is enabled on the account..StringgetIsDynamicEnvelope().StringgetIsSignatureProviderEnvelope().StringgetLastModifiedDateTime()The date and time the item was last modified..StringgetLocation().LockInformationgetLockInformation()Provides lock information about an envelope that a user has locked..StringgetMessageLock()When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope.NotificationgetNotification().StringgetNotificationUri()Contains a URI for an endpoint that you can use to retrieve the notifications..PowerFormgetPowerForm()Information about any PowerForms that are included in the envelope..StringgetPurgeCompletedDate().StringgetPurgeRequestDate().StringgetPurgeState().RecipientsgetRecipients()An array of powerform recipients..StringgetRecipientsLock()When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope..StringgetRecipientsUri()Contains a URI for an endpoint that you can use to retrieve the recipients..UserInfogetSender()Information about the sender of the envelope..StringgetSentDateTime()The date and time the envelope was sent..StringgetSignerCanSignOnMobile().StringgetSigningLocation()Specifies the physical location where the signing takes place.StringgetStatus()Indicates the envelope status.StringgetStatusChangedDateTime()The data and time the status changed..StringgetStatusDateTime().StringgetTemplatesUri()Contains a URI for an endpoint which you can use to retrieve the templates..StringgetTransactionId()Used to identify an envelope.StringgetUseDisclosure()When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting.StringgetUSigState().StringgetVoidedDateTime()The date and time the envelope or template was voided..StringgetVoidedReason()The reason the envelope or template was voided..WorkflowgetWorkflow().EnvelopehasComments(String hasComments)hasComments.EnvelopehasFormDataChanged(String hasFormDataChanged)hasFormDataChanged.inthashCode()Returns the HashCode.EnvelopehasWavFile(String hasWavFile)hasWavFile.Envelopeholder(String holder)holder.EnvelopeinitialSentDateTime(String initialSentDateTime)initialSentDateTime.Envelopeis21CFRPart11(String is21CFRPart11)is21CFRPart11.EnvelopeisDynamicEnvelope(String isDynamicEnvelope)isDynamicEnvelope.EnvelopeisSignatureProviderEnvelope(String isSignatureProviderEnvelope)isSignatureProviderEnvelope.EnvelopelastModifiedDateTime(String lastModifiedDateTime)lastModifiedDateTime.Envelopelocation(String location)location.EnvelopelockInformation(LockInformation lockInformation)lockInformation.EnvelopemessageLock(String messageLock)messageLock.Envelopenotification(Notification notification)notification.EnvelopenotificationUri(String notificationUri)notificationUri.EnvelopepowerForm(PowerForm powerForm)powerForm.EnvelopepurgeCompletedDate(String purgeCompletedDate)purgeCompletedDate.EnvelopepurgeRequestDate(String purgeRequestDate)purgeRequestDate.EnvelopepurgeState(String purgeState)purgeState.Enveloperecipients(Recipients recipients)recipients.EnveloperecipientsLock(String recipientsLock)recipientsLock.EnveloperecipientsUri(String recipientsUri)recipientsUri.Envelopesender(UserInfo sender)sender.EnvelopesentDateTime(String sentDateTime)sentDateTime.voidsetAccessControlListBase64(String accessControlListBase64)setAccessControlListBase64.voidsetAllowComments(String allowComments)setAllowComments.voidsetAllowMarkup(String allowMarkup)setAllowMarkup.voidsetAllowReassign(String allowReassign)setAllowReassign.voidsetAllowViewHistory(String allowViewHistory)setAllowViewHistory.voidsetAnySigner(String anySigner)setAnySigner.voidsetAsynchronous(String asynchronous)setAsynchronous.voidsetAttachmentsUri(String attachmentsUri)setAttachmentsUri.voidsetAuthoritativeCopy(String authoritativeCopy)setAuthoritativeCopy.voidsetAuthoritativeCopyDefault(String authoritativeCopyDefault)setAuthoritativeCopyDefault.voidsetAutoNavigation(String autoNavigation)setAutoNavigation.voidsetBrandId(String brandId)setBrandId.voidsetBrandLock(String brandLock)setBrandLock.voidsetBurnDefaultTabData(String burnDefaultTabData)setBurnDefaultTabData.voidsetCertificateUri(String certificateUri)setCertificateUri.voidsetCompletedDateTime(String completedDateTime)setCompletedDateTime.voidsetCopyRecipientData(String copyRecipientData)setCopyRecipientData.voidsetCreatedDateTime(String createdDateTime)setCreatedDateTime.voidsetCustomFields(CustomFields customFields)setCustomFields.voidsetCustomFieldsUri(String customFieldsUri)setCustomFieldsUri.voidsetDeclinedDateTime(String declinedDateTime)setDeclinedDateTime.voidsetDeletedDateTime(String deletedDateTime)setDeletedDateTime.voidsetDeliveredDateTime(String deliveredDateTime)setDeliveredDateTime.voidsetDisableResponsiveDocument(String disableResponsiveDocument)setDisableResponsiveDocument.voidsetDocumentBase64(String documentBase64)setDocumentBase64.voidsetDocumentsCombinedUri(String documentsCombinedUri)setDocumentsCombinedUri.voidsetDocumentsUri(String documentsUri)setDocumentsUri.voidsetEmailBlurb(String emailBlurb)setEmailBlurb.voidsetEmailSettings(EmailSettings emailSettings)setEmailSettings.voidsetEmailSubject(String emailSubject)setEmailSubject.voidsetEnableWetSign(String enableWetSign)setEnableWetSign.voidsetEnforceSignerVisibility(String enforceSignerVisibility)setEnforceSignerVisibility.voidsetEnvelopeAttachments(List<Attachment> envelopeAttachments)setEnvelopeAttachments.voidsetEnvelopeCustomMetadata(EnvelopeCustomMetadata envelopeCustomMetadata)setEnvelopeCustomMetadata.voidsetEnvelopeDocuments(List<EnvelopeDocument> envelopeDocuments)setEnvelopeDocuments.voidsetEnvelopeId(String envelopeId)setEnvelopeId.voidsetEnvelopeIdStamping(String envelopeIdStamping)setEnvelopeIdStamping.voidsetEnvelopeLocation(String envelopeLocation)setEnvelopeLocation.voidsetEnvelopeMetadata(EnvelopeMetadata envelopeMetadata)setEnvelopeMetadata.voidsetEnvelopeUri(String envelopeUri)setEnvelopeUri.voidsetExpireAfter(String expireAfter)setExpireAfter.voidsetExpireDateTime(String expireDateTime)setExpireDateTime.voidsetExpireEnabled(String expireEnabled)setExpireEnabled.voidsetExternalEnvelopeId(String externalEnvelopeId)setExternalEnvelopeId.voidsetFolders(List<Folder> folders)setFolders.voidsetHasComments(String hasComments)setHasComments.voidsetHasFormDataChanged(String hasFormDataChanged)setHasFormDataChanged.voidsetHasWavFile(String hasWavFile)setHasWavFile.voidsetHolder(String holder)setHolder.voidsetInitialSentDateTime(String initialSentDateTime)setInitialSentDateTime.voidsetIs21CFRPart11(String is21CFRPart11)setIs21CFRPart11.voidsetIsDynamicEnvelope(String isDynamicEnvelope)setIsDynamicEnvelope.voidsetIsSignatureProviderEnvelope(String isSignatureProviderEnvelope)setIsSignatureProviderEnvelope.voidsetLastModifiedDateTime(String lastModifiedDateTime)setLastModifiedDateTime.voidsetLocation(String location)setLocation.voidsetLockInformation(LockInformation lockInformation)setLockInformation.voidsetMessageLock(String messageLock)setMessageLock.voidsetNotification(Notification notification)setNotification.voidsetNotificationUri(String notificationUri)setNotificationUri.voidsetPowerForm(PowerForm powerForm)setPowerForm.voidsetPurgeCompletedDate(String purgeCompletedDate)setPurgeCompletedDate.voidsetPurgeRequestDate(String purgeRequestDate)setPurgeRequestDate.voidsetPurgeState(String purgeState)setPurgeState.voidsetRecipients(Recipients recipients)setRecipients.voidsetRecipientsLock(String recipientsLock)setRecipientsLock.voidsetRecipientsUri(String recipientsUri)setRecipientsUri.voidsetSender(UserInfo sender)setSender.voidsetSentDateTime(String sentDateTime)setSentDateTime.voidsetSignerCanSignOnMobile(String signerCanSignOnMobile)setSignerCanSignOnMobile.voidsetSigningLocation(String signingLocation)setSigningLocation.voidsetStatus(String status)setStatus.voidsetStatusChangedDateTime(String statusChangedDateTime)setStatusChangedDateTime.voidsetStatusDateTime(String statusDateTime)setStatusDateTime.voidsetTemplatesUri(String templatesUri)setTemplatesUri.voidsetTransactionId(String transactionId)setTransactionId.voidsetUseDisclosure(String useDisclosure)setUseDisclosure.voidsetUSigState(String uSigState)setUSigState.voidsetVoidedDateTime(String voidedDateTime)setVoidedDateTime.voidsetVoidedReason(String voidedReason)setVoidedReason.voidsetWorkflow(Workflow workflow)setWorkflow.EnvelopesignerCanSignOnMobile(String signerCanSignOnMobile)signerCanSignOnMobile.EnvelopesigningLocation(String signingLocation)signingLocation.Envelopestatus(String status)status.EnvelopestatusChangedDateTime(String statusChangedDateTime)statusChangedDateTime.EnvelopestatusDateTime(String statusDateTime)statusDateTime.EnvelopetemplatesUri(String templatesUri)templatesUri.StringtoString()Converts the given object to string.EnvelopetransactionId(String transactionId)transactionId.EnvelopeuseDisclosure(String useDisclosure)useDisclosure.EnvelopeuSigState(String uSigState)uSigState.EnvelopevoidedDateTime(String voidedDateTime)voidedDateTime.EnvelopevoidedReason(String voidedReason)voidedReason.Envelopeworkflow(Workflow workflow)workflow.
-
-
-
Method Detail
-
accessControlListBase64
public Envelope accessControlListBase64(String accessControlListBase64)
accessControlListBase64.- Returns:
- Envelope
-
getAccessControlListBase64
public String getAccessControlListBase64()
.- Returns:
- accessControlListBase64
-
setAccessControlListBase64
public void setAccessControlListBase64(String accessControlListBase64)
setAccessControlListBase64.
-
getAllowComments
public String getAllowComments()
.- Returns:
- allowComments
-
setAllowComments
public void setAllowComments(String allowComments)
setAllowComments.
-
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)
setAllowMarkup.
-
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)
setAllowReassign.
-
allowViewHistory
public Envelope allowViewHistory(String allowViewHistory)
allowViewHistory.- Returns:
- Envelope
-
getAllowViewHistory
public String getAllowViewHistory()
.- Returns:
- allowViewHistory
-
setAllowViewHistory
public void setAllowViewHistory(String allowViewHistory)
setAllowViewHistory.
-
getAnySigner
public String getAnySigner()
.- Returns:
- anySigner
-
setAnySigner
public void setAnySigner(String anySigner)
setAnySigner.
-
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)
setAsynchronous.
-
attachmentsUri
public Envelope attachmentsUri(String attachmentsUri)
attachmentsUri.- Returns:
- Envelope
-
getAttachmentsUri
public String getAttachmentsUri()
.- Returns:
- attachmentsUri
-
setAttachmentsUri
public void setAttachmentsUri(String attachmentsUri)
setAttachmentsUri.
-
authoritativeCopy
public Envelope authoritativeCopy(String authoritativeCopy)
authoritativeCopy.- Returns:
- Envelope
-
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)
setAuthoritativeCopy.
-
authoritativeCopyDefault
public Envelope authoritativeCopyDefault(String authoritativeCopyDefault)
authoritativeCopyDefault.- Returns:
- Envelope
-
getAuthoritativeCopyDefault
public String getAuthoritativeCopyDefault()
.- Returns:
- authoritativeCopyDefault
-
setAuthoritativeCopyDefault
public void setAuthoritativeCopyDefault(String authoritativeCopyDefault)
setAuthoritativeCopyDefault.
-
autoNavigation
public Envelope autoNavigation(String autoNavigation)
autoNavigation.- Returns:
- Envelope
-
getAutoNavigation
public String getAutoNavigation()
.- Returns:
- autoNavigation
-
setAutoNavigation
public void setAutoNavigation(String autoNavigation)
setAutoNavigation.
-
getBrandId
public String getBrandId()
.- Returns:
- brandId
-
setBrandId
public void setBrandId(String brandId)
setBrandId.
-
getBrandLock
public String getBrandLock()
.- Returns:
- brandLock
-
setBrandLock
public void setBrandLock(String brandLock)
setBrandLock.
-
burnDefaultTabData
public Envelope burnDefaultTabData(String burnDefaultTabData)
burnDefaultTabData.- Returns:
- Envelope
-
getBurnDefaultTabData
public String getBurnDefaultTabData()
.- Returns:
- burnDefaultTabData
-
setBurnDefaultTabData
public void setBurnDefaultTabData(String burnDefaultTabData)
setBurnDefaultTabData.
-
certificateUri
public Envelope certificateUri(String certificateUri)
certificateUri.- Returns:
- Envelope
-
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)
setCertificateUri.
-
completedDateTime
public Envelope completedDateTime(String completedDateTime)
completedDateTime.- Returns:
- Envelope
-
getCompletedDateTime
public String getCompletedDateTime()
Specifies the date and time this item was completed..- Returns:
- completedDateTime
-
setCompletedDateTime
public void setCompletedDateTime(String completedDateTime)
setCompletedDateTime.
-
copyRecipientData
public Envelope copyRecipientData(String copyRecipientData)
copyRecipientData.- Returns:
- Envelope
-
getCopyRecipientData
public String getCopyRecipientData()
.- Returns:
- copyRecipientData
-
setCopyRecipientData
public void setCopyRecipientData(String copyRecipientData)
setCopyRecipientData.
-
createdDateTime
public Envelope createdDateTime(String createdDateTime)
createdDateTime.- Returns:
- Envelope
-
getCreatedDateTime
public String getCreatedDateTime()
Indicates the date and time the item was created..- Returns:
- createdDateTime
-
setCreatedDateTime
public void setCreatedDateTime(String createdDateTime)
setCreatedDateTime.
-
customFields
public Envelope customFields(CustomFields customFields)
customFields.- Returns:
- Envelope
-
getCustomFields
public CustomFields getCustomFields()
An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters..- Returns:
- customFields
-
setCustomFields
public void setCustomFields(CustomFields customFields)
setCustomFields.
-
customFieldsUri
public Envelope customFieldsUri(String customFieldsUri)
customFieldsUri.- Returns:
- Envelope
-
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)
setCustomFieldsUri.
-
declinedDateTime
public Envelope declinedDateTime(String declinedDateTime)
declinedDateTime.- Returns:
- Envelope
-
getDeclinedDateTime
public String getDeclinedDateTime()
The date and time the recipient declined the document..- Returns:
- declinedDateTime
-
setDeclinedDateTime
public void setDeclinedDateTime(String declinedDateTime)
setDeclinedDateTime.
-
deletedDateTime
public Envelope deletedDateTime(String deletedDateTime)
deletedDateTime.- Returns:
- Envelope
-
getDeletedDateTime
public String getDeletedDateTime()
Specifies the data and time the item was deleted..- Returns:
- deletedDateTime
-
setDeletedDateTime
public void setDeletedDateTime(String deletedDateTime)
setDeletedDateTime.
-
deliveredDateTime
public Envelope deliveredDateTime(String deliveredDateTime)
deliveredDateTime.- Returns:
- Envelope
-
getDeliveredDateTime
public String getDeliveredDateTime()
Reserved: For DocuSign use only..- Returns:
- deliveredDateTime
-
setDeliveredDateTime
public void setDeliveredDateTime(String deliveredDateTime)
setDeliveredDateTime.
-
disableResponsiveDocument
public Envelope disableResponsiveDocument(String disableResponsiveDocument)
disableResponsiveDocument.- Returns:
- Envelope
-
getDisableResponsiveDocument
public String getDisableResponsiveDocument()
.- Returns:
- disableResponsiveDocument
-
setDisableResponsiveDocument
public void setDisableResponsiveDocument(String disableResponsiveDocument)
setDisableResponsiveDocument.
-
documentBase64
public Envelope documentBase64(String documentBase64)
documentBase64.- Returns:
- Envelope
-
getDocumentBase64
public String getDocumentBase64()
.- Returns:
- documentBase64
-
setDocumentBase64
public void setDocumentBase64(String documentBase64)
setDocumentBase64.
-
documentsCombinedUri
public Envelope documentsCombinedUri(String documentsCombinedUri)
documentsCombinedUri.- Returns:
- Envelope
-
getDocumentsCombinedUri
public String getDocumentsCombinedUri()
.- Returns:
- documentsCombinedUri
-
setDocumentsCombinedUri
public void setDocumentsCombinedUri(String documentsCombinedUri)
setDocumentsCombinedUri.
-
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)
setDocumentsUri.
-
getEmailBlurb
public String getEmailBlurb()
This is the same as the email body. If specified it is included in email body for all envelope recipients..- Returns:
- emailBlurb
-
setEmailBlurb
public void setEmailBlurb(String emailBlurb)
setEmailBlurb.
-
emailSettings
public Envelope emailSettings(EmailSettings emailSettings)
emailSettings.- Returns:
- Envelope
-
getEmailSettings
public EmailSettings getEmailSettings()
A complex type that contains email settings..- Returns:
- emailSettings
-
setEmailSettings
public void setEmailSettings(EmailSettings emailSettings)
setEmailSettings.
-
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)
setEmailSubject.
-
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)
setEnableWetSign.
-
enforceSignerVisibility
public Envelope enforceSignerVisibility(String enforceSignerVisibility)
enforceSignerVisibility.- Returns:
- Envelope
-
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)
setEnforceSignerVisibility.
-
envelopeAttachments
public Envelope envelopeAttachments(List<Attachment> envelopeAttachments)
envelopeAttachments.- Returns:
- Envelope
-
addEnvelopeAttachmentsItem
public Envelope addEnvelopeAttachmentsItem(Attachment envelopeAttachmentsItem)
addEnvelopeAttachmentsItem.- Returns:
- Envelope
-
getEnvelopeAttachments
public List<Attachment> getEnvelopeAttachments()
.- Returns:
- envelopeAttachments
-
setEnvelopeAttachments
public void setEnvelopeAttachments(List<Attachment> envelopeAttachments)
setEnvelopeAttachments.
-
envelopeCustomMetadata
public Envelope envelopeCustomMetadata(EnvelopeCustomMetadata envelopeCustomMetadata)
envelopeCustomMetadata.- Returns:
- Envelope
-
getEnvelopeCustomMetadata
public EnvelopeCustomMetadata getEnvelopeCustomMetadata()
.- Returns:
- envelopeCustomMetadata
-
setEnvelopeCustomMetadata
public void setEnvelopeCustomMetadata(EnvelopeCustomMetadata envelopeCustomMetadata)
setEnvelopeCustomMetadata.
-
envelopeDocuments
public Envelope envelopeDocuments(List<EnvelopeDocument> envelopeDocuments)
envelopeDocuments.- Returns:
- Envelope
-
addEnvelopeDocumentsItem
public Envelope addEnvelopeDocumentsItem(EnvelopeDocument envelopeDocumentsItem)
addEnvelopeDocumentsItem.- Returns:
- Envelope
-
getEnvelopeDocuments
public List<EnvelopeDocument> getEnvelopeDocuments()
.- Returns:
- envelopeDocuments
-
setEnvelopeDocuments
public void setEnvelopeDocuments(List<EnvelopeDocument> envelopeDocuments)
setEnvelopeDocuments.
-
getEnvelopeId
public String getEnvelopeId()
The envelope ID of the envelope status that failed to post..- Returns:
- envelopeId
-
setEnvelopeId
public void setEnvelopeId(String envelopeId)
setEnvelopeId.
-
envelopeIdStamping
public Envelope envelopeIdStamping(String envelopeIdStamping)
envelopeIdStamping.- Returns:
- Envelope
-
getEnvelopeIdStamping
public String getEnvelopeIdStamping()
When set to **true**, Envelope ID Stamping is enabled..- Returns:
- envelopeIdStamping
-
setEnvelopeIdStamping
public void setEnvelopeIdStamping(String envelopeIdStamping)
setEnvelopeIdStamping.
-
envelopeLocation
public Envelope envelopeLocation(String envelopeLocation)
envelopeLocation.- Returns:
- Envelope
-
getEnvelopeLocation
public String getEnvelopeLocation()
.- Returns:
- envelopeLocation
-
setEnvelopeLocation
public void setEnvelopeLocation(String envelopeLocation)
setEnvelopeLocation.
-
envelopeMetadata
public Envelope envelopeMetadata(EnvelopeMetadata envelopeMetadata)
envelopeMetadata.- Returns:
- Envelope
-
getEnvelopeMetadata
public EnvelopeMetadata getEnvelopeMetadata()
Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service..- Returns:
- envelopeMetadata
-
setEnvelopeMetadata
public void setEnvelopeMetadata(EnvelopeMetadata envelopeMetadata)
setEnvelopeMetadata.
-
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)
setEnvelopeUri.
-
getExpireAfter
public String getExpireAfter()
.- Returns:
- expireAfter
-
setExpireAfter
public void setExpireAfter(String expireAfter)
setExpireAfter.
-
expireDateTime
public Envelope expireDateTime(String expireDateTime)
expireDateTime.- Returns:
- Envelope
-
getExpireDateTime
public String getExpireDateTime()
.- Returns:
- expireDateTime
-
setExpireDateTime
public void setExpireDateTime(String expireDateTime)
setExpireDateTime.
-
getExpireEnabled
public String getExpireEnabled()
.- Returns:
- expireEnabled
-
setExpireEnabled
public void setExpireEnabled(String expireEnabled)
setExpireEnabled.
-
externalEnvelopeId
public Envelope externalEnvelopeId(String externalEnvelopeId)
externalEnvelopeId.- Returns:
- Envelope
-
getExternalEnvelopeId
public String getExternalEnvelopeId()
.- Returns:
- externalEnvelopeId
-
setExternalEnvelopeId
public void setExternalEnvelopeId(String externalEnvelopeId)
setExternalEnvelopeId.
-
addFoldersItem
public Envelope addFoldersItem(Folder foldersItem)
addFoldersItem.- Returns:
- Envelope
-
getHasComments
public String getHasComments()
.- Returns:
- hasComments
-
setHasComments
public void setHasComments(String hasComments)
setHasComments.
-
hasFormDataChanged
public Envelope hasFormDataChanged(String hasFormDataChanged)
hasFormDataChanged.- Returns:
- Envelope
-
getHasFormDataChanged
public String getHasFormDataChanged()
.- Returns:
- hasFormDataChanged
-
setHasFormDataChanged
public void setHasFormDataChanged(String hasFormDataChanged)
setHasFormDataChanged.
-
getHasWavFile
public String getHasWavFile()
.- Returns:
- hasWavFile
-
setHasWavFile
public void setHasWavFile(String hasWavFile)
setHasWavFile.
-
getHolder
public String getHolder()
.- Returns:
- holder
-
setHolder
public void setHolder(String holder)
setHolder.
-
initialSentDateTime
public Envelope initialSentDateTime(String initialSentDateTime)
initialSentDateTime.- Returns:
- Envelope
-
getInitialSentDateTime
public String getInitialSentDateTime()
.- Returns:
- initialSentDateTime
-
setInitialSentDateTime
public void setInitialSentDateTime(String initialSentDateTime)
setInitialSentDateTime.
-
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)
setIs21CFRPart11.
-
isDynamicEnvelope
public Envelope isDynamicEnvelope(String isDynamicEnvelope)
isDynamicEnvelope.- Returns:
- Envelope
-
getIsDynamicEnvelope
public String getIsDynamicEnvelope()
.- Returns:
- isDynamicEnvelope
-
setIsDynamicEnvelope
public void setIsDynamicEnvelope(String isDynamicEnvelope)
setIsDynamicEnvelope.
-
isSignatureProviderEnvelope
public Envelope isSignatureProviderEnvelope(String isSignatureProviderEnvelope)
isSignatureProviderEnvelope.- Returns:
- Envelope
-
getIsSignatureProviderEnvelope
public String getIsSignatureProviderEnvelope()
.- Returns:
- isSignatureProviderEnvelope
-
setIsSignatureProviderEnvelope
public void setIsSignatureProviderEnvelope(String isSignatureProviderEnvelope)
setIsSignatureProviderEnvelope.
-
lastModifiedDateTime
public Envelope lastModifiedDateTime(String lastModifiedDateTime)
lastModifiedDateTime.- Returns:
- Envelope
-
getLastModifiedDateTime
public String getLastModifiedDateTime()
The date and time the item was last modified..- Returns:
- lastModifiedDateTime
-
setLastModifiedDateTime
public void setLastModifiedDateTime(String lastModifiedDateTime)
setLastModifiedDateTime.
-
getLocation
public String getLocation()
.- Returns:
- location
-
setLocation
public void setLocation(String location)
setLocation.
-
lockInformation
public Envelope lockInformation(LockInformation lockInformation)
lockInformation.- Returns:
- Envelope
-
getLockInformation
public LockInformation getLockInformation()
Provides lock information about an envelope that a user has locked..- Returns:
- lockInformation
-
setLockInformation
public void setLockInformation(LockInformation lockInformation)
setLockInformation.
-
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)
setMessageLock.
-
notification
public Envelope notification(Notification notification)
notification.- Returns:
- Envelope
-
getNotification
public Notification getNotification()
.- Returns:
- notification
-
setNotification
public void setNotification(Notification notification)
setNotification.
-
notificationUri
public Envelope notificationUri(String notificationUri)
notificationUri.- Returns:
- Envelope
-
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)
setNotificationUri.
-
getPowerForm
public PowerForm getPowerForm()
Information about any PowerForms that are included in the envelope..- Returns:
- powerForm
-
setPowerForm
public void setPowerForm(PowerForm powerForm)
setPowerForm.
-
purgeCompletedDate
public Envelope purgeCompletedDate(String purgeCompletedDate)
purgeCompletedDate.- Returns:
- Envelope
-
getPurgeCompletedDate
public String getPurgeCompletedDate()
.- Returns:
- purgeCompletedDate
-
setPurgeCompletedDate
public void setPurgeCompletedDate(String purgeCompletedDate)
setPurgeCompletedDate.
-
purgeRequestDate
public Envelope purgeRequestDate(String purgeRequestDate)
purgeRequestDate.- Returns:
- Envelope
-
getPurgeRequestDate
public String getPurgeRequestDate()
.- Returns:
- purgeRequestDate
-
setPurgeRequestDate
public void setPurgeRequestDate(String purgeRequestDate)
setPurgeRequestDate.
-
getPurgeState
public String getPurgeState()
.- Returns:
- purgeState
-
setPurgeState
public void setPurgeState(String purgeState)
setPurgeState.
-
recipients
public Envelope recipients(Recipients recipients)
recipients.- Returns:
- Envelope
-
getRecipients
public Recipients getRecipients()
An array of powerform recipients..- Returns:
- recipients
-
setRecipients
public void setRecipients(Recipients recipients)
setRecipients.
-
recipientsLock
public Envelope recipientsLock(String recipientsLock)
recipientsLock.- Returns:
- Envelope
-
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)
setRecipientsLock.
-
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)
setRecipientsUri.
-
getSender
public UserInfo getSender()
Information about the sender of the envelope..- Returns:
- sender
-
setSender
public void setSender(UserInfo sender)
setSender.
-
getSentDateTime
public String getSentDateTime()
The date and time the envelope was sent..- Returns:
- sentDateTime
-
setSentDateTime
public void setSentDateTime(String sentDateTime)
setSentDateTime.
-
signerCanSignOnMobile
public Envelope signerCanSignOnMobile(String signerCanSignOnMobile)
signerCanSignOnMobile.- Returns:
- Envelope
-
getSignerCanSignOnMobile
public String getSignerCanSignOnMobile()
.- Returns:
- signerCanSignOnMobile
-
setSignerCanSignOnMobile
public void setSignerCanSignOnMobile(String signerCanSignOnMobile)
setSignerCanSignOnMobile.
-
signingLocation
public Envelope signingLocation(String signingLocation)
signingLocation.- Returns:
- Envelope
-
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)
setSigningLocation.
-
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)
setStatus.
-
statusChangedDateTime
public Envelope statusChangedDateTime(String statusChangedDateTime)
statusChangedDateTime.- Returns:
- Envelope
-
getStatusChangedDateTime
public String getStatusChangedDateTime()
The data and time the status changed..- Returns:
- statusChangedDateTime
-
setStatusChangedDateTime
public void setStatusChangedDateTime(String statusChangedDateTime)
setStatusChangedDateTime.
-
statusDateTime
public Envelope statusDateTime(String statusDateTime)
statusDateTime.- Returns:
- Envelope
-
getStatusDateTime
public String getStatusDateTime()
.- Returns:
- statusDateTime
-
setStatusDateTime
public void setStatusDateTime(String statusDateTime)
setStatusDateTime.
-
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)
setTemplatesUri.
-
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)
setTransactionId.
-
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)
setUseDisclosure.
-
getUSigState
public String getUSigState()
.- Returns:
- uSigState
-
setUSigState
public void setUSigState(String uSigState)
setUSigState.
-
voidedDateTime
public Envelope voidedDateTime(String voidedDateTime)
voidedDateTime.- Returns:
- Envelope
-
getVoidedDateTime
public String getVoidedDateTime()
The date and time the envelope or template was voided..- Returns:
- voidedDateTime
-
setVoidedDateTime
public void setVoidedDateTime(String voidedDateTime)
setVoidedDateTime.
-
getVoidedReason
public String getVoidedReason()
The reason the envelope or template was voided..- Returns:
- voidedReason
-
setVoidedReason
public void setVoidedReason(String voidedReason)
setVoidedReason.
-
getWorkflow
public Workflow getWorkflow()
.- Returns:
- workflow
-
setWorkflow
public void setWorkflow(Workflow workflow)
setWorkflow.
-
equals
public boolean equals(Object o)
Compares objects.
-
-