Package com.docusign.esign.model

Class Envelope

  • public class Envelope
extends Object
    Envelope.

    • Constructor Detail

      • Envelope

        public Envelope()

    • Method Detail

      • allowMarkup

        public Envelope allowMarkup​(String allowMarkup)
        allowMarkup.
        Returns:
        Envelope

      • 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.

      • allowReassign

        public Envelope allowReassign​(String allowReassign)
        allowReassign.
        Returns:
        Envelope

      • 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.

      • asynchronous

        public Envelope asynchronous​(String asynchronous)
        asynchronous.
        Returns:
        Envelope

      • 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.

      • brandId

        public Envelope brandId​(String brandId)
        brandId.
        Returns:
        Envelope

      • getBrandId

        public String getBrandId()
        .
        Returns:
        brandId

      • setBrandId

        public void setBrandId​(String brandId)
        setBrandId.

      • brandLock

        public Envelope brandLock​(String brandLock)
        brandLock.
        Returns:
        Envelope

      • getBrandLock

        public String getBrandLock()
        .
        Returns:
        brandLock

      • setBrandLock

        public void setBrandLock​(String brandLock)
        setBrandLock.

      • 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()
        Get customFields.
        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.

      • documentsCombinedUri

        public Envelope documentsCombinedUri​(String documentsCombinedUri)
        documentsCombinedUri.
        Returns:
        Envelope

      • getDocumentsCombinedUri

        public String getDocumentsCombinedUri()
        .
        Returns:
        documentsCombinedUri

      • setDocumentsCombinedUri

        public void setDocumentsCombinedUri​(String documentsCombinedUri)
        setDocumentsCombinedUri.

      • documentsUri

        public Envelope documentsUri​(String documentsUri)
        documentsUri.
        Returns:
        Envelope

      • 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.

      • emailBlurb

        public Envelope emailBlurb​(String emailBlurb)
        emailBlurb.
        Returns:
        Envelope

      • 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()
        Get emailSettings.
        Returns:
        emailSettings

      • setEmailSettings

        public void setEmailSettings​(EmailSettings emailSettings)
        setEmailSettings.

      • emailSubject

        public Envelope emailSubject​(String emailSubject)
        emailSubject.
        Returns:
        Envelope

      • 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.

      • enableWetSign

        public Envelope enableWetSign​(String enableWetSign)
        enableWetSign.
        Returns:
        Envelope

      • 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.

      • envelopeId

        public Envelope envelopeId​(String envelopeId)
        envelopeId.
        Returns:
        Envelope

      • 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.

      • envelopeUri

        public Envelope envelopeUri​(String envelopeUri)
        envelopeUri.
        Returns:
        Envelope

      • 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.

      • initialSentDateTime

        public Envelope initialSentDateTime​(String initialSentDateTime)
        initialSentDateTime.
        Returns:
        Envelope

      • getInitialSentDateTime

        public String getInitialSentDateTime()
        .
        Returns:
        initialSentDateTime

      • setInitialSentDateTime

        public void setInitialSentDateTime​(String initialSentDateTime)
        setInitialSentDateTime.

      • is21CFRPart11

        public Envelope is21CFRPart11​(String is21CFRPart11)
        is21CFRPart11.
        Returns:
        Envelope

      • 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.

      • 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.

      • lockInformation

        public Envelope lockInformation​(LockInformation lockInformation)
        lockInformation.
        Returns:
        Envelope

      • getLockInformation

        public LockInformation getLockInformation()
        Get lockInformation.
        Returns:
        lockInformation

      • setLockInformation

        public void setLockInformation​(LockInformation lockInformation)
        setLockInformation.

      • messageLock

        public Envelope messageLock​(String messageLock)
        messageLock.
        Returns:
        Envelope

      • 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()
        Get notification.
        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.

      • purgeState

        public Envelope purgeState​(String purgeState)
        purgeState.
        Returns:
        Envelope

      • 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()
        Get 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.

      • recipientsUri

        public Envelope recipientsUri​(String recipientsUri)
        recipientsUri.
        Returns:
        Envelope

      • 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.

      • sentDateTime

        public Envelope sentDateTime​(String sentDateTime)
        sentDateTime.
        Returns:
        Envelope

      • 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.

      • status

        public Envelope status​(String status)
        status.
        Returns:
        Envelope

      • 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.

      • templatesUri

        public Envelope templatesUri​(String templatesUri)
        templatesUri.
        Returns:
        Envelope

      • 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.

      • transactionId

        public Envelope transactionId​(String transactionId)
        transactionId.
        Returns:
        Envelope

      • 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.

      • useDisclosure

        public Envelope useDisclosure​(String useDisclosure)
        useDisclosure.
        Returns:
        Envelope

      • 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.

      • 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.

      • voidedReason

        public Envelope voidedReason​(String voidedReason)
        voidedReason.
        Returns:
        Envelope

      • getVoidedReason

        public String getVoidedReason()
        The reason the envelope or template was voided..
        Returns:
        voidedReason

      • setVoidedReason

        public void setVoidedReason​(String voidedReason)
        setVoidedReason.

      • equals

        public boolean equals​(Object o)
        Compares objects.
        Overrides:
        equals in class Object
        Returns:
        true or false depending on comparison result.

      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class Object

      • toString

        public String toString()
        Converts the given object to string.
        Overrides:
        toString in class Object