Package com.docusign.esign.model

Class EnvelopeDefinition

  • public class EnvelopeDefinition
extends java.lang.Object
    EnvelopeDefinition.

    • Constructor Detail

      • EnvelopeDefinition

        public EnvelopeDefinition()

    • Method Detail

      • accessControlListBase64

        public EnvelopeDefinition accessControlListBase64​(java.lang.String accessControlListBase64)
        accessControlListBase64.
        Returns:
        EnvelopeDefinition

      • getAccessControlListBase64

        public java.lang.String getAccessControlListBase64()
        .
        Returns:
        accessControlListBase64

      • setAccessControlListBase64

        public void setAccessControlListBase64​(java.lang.String accessControlListBase64)
        setAccessControlListBase64.

      • accessibility

        public EnvelopeDefinition accessibility​(java.lang.String accessibility)
        accessibility.
        Returns:
        EnvelopeDefinition

      • getAccessibility

        public java.lang.String getAccessibility()
        Sets the document reading zones for screen reader applications. This element can only be used if Document Accessibility is enabled for the account. ###### Note: This information is currently generated from the DocuSign web console by setting the reading zones when creating a template, exporting the reading zone string information, and adding it here..
        Returns:
        accessibility

      • setAccessibility

        public void setAccessibility​(java.lang.String accessibility)
        setAccessibility.

      • allowComments

        public EnvelopeDefinition allowComments​(java.lang.String allowComments)
        allowComments.
        Returns:
        EnvelopeDefinition

      • getAllowComments

        public java.lang.String getAllowComments()
        .
        Returns:
        allowComments

      • setAllowComments

        public void setAllowComments​(java.lang.String allowComments)
        setAllowComments.

      • allowMarkup

        public EnvelopeDefinition allowMarkup​(java.lang.String allowMarkup)
        allowMarkup.
        Returns:
        EnvelopeDefinition

      • getAllowMarkup

        public java.lang.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​(java.lang.String allowMarkup)
        setAllowMarkup.

      • allowReassign

        public EnvelopeDefinition allowReassign​(java.lang.String allowReassign)
        allowReassign.
        Returns:
        EnvelopeDefinition

      • getAllowReassign

        public java.lang.String getAllowReassign()
        When set to **true**, the recipient can redirect an envelope to a more appropriate recipient..
        Returns:
        allowReassign

      • setAllowReassign

        public void setAllowReassign​(java.lang.String allowReassign)
        setAllowReassign.

      • allowRecipientRecursion

        public EnvelopeDefinition allowRecipientRecursion​(java.lang.String allowRecipientRecursion)
        allowRecipientRecursion.
        Returns:
        EnvelopeDefinition

      • getAllowRecipientRecursion

        public java.lang.String getAllowRecipientRecursion()
        When set to **true**, this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order..
        Returns:
        allowRecipientRecursion

      • setAllowRecipientRecursion

        public void setAllowRecipientRecursion​(java.lang.String allowRecipientRecursion)
        setAllowRecipientRecursion.

      • allowViewHistory

        public EnvelopeDefinition allowViewHistory​(java.lang.String allowViewHistory)
        allowViewHistory.
        Returns:
        EnvelopeDefinition

      • getAllowViewHistory

        public java.lang.String getAllowViewHistory()
        .
        Returns:
        allowViewHistory

      • setAllowViewHistory

        public void setAllowViewHistory​(java.lang.String allowViewHistory)
        setAllowViewHistory.

      • anySigner

        public EnvelopeDefinition anySigner​(java.lang.String anySigner)
        anySigner.
        Returns:
        EnvelopeDefinition

      • getAnySigner

        public java.lang.String getAnySigner()
        .
        Returns:
        anySigner

      • setAnySigner

        public void setAnySigner​(java.lang.String anySigner)
        setAnySigner.

      • asynchronous

        public EnvelopeDefinition asynchronous​(java.lang.String asynchronous)
        asynchronous.
        Returns:
        EnvelopeDefinition

      • getAsynchronous

        public java.lang.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​(java.lang.String asynchronous)
        setAsynchronous.

      • addAttachmentsItem

        public EnvelopeDefinition addAttachmentsItem​(Attachment attachmentsItem)
        addAttachmentsItem.
        Returns:
        EnvelopeDefinition

      • getAttachments

        public java.util.List<Attachment> getAttachments()
        .
        Returns:
        attachments

      • setAttachments

        public void setAttachments​(java.util.List<Attachment> attachments)
        setAttachments.

      • attachmentsUri

        public EnvelopeDefinition attachmentsUri​(java.lang.String attachmentsUri)
        attachmentsUri.
        Returns:
        EnvelopeDefinition

      • getAttachmentsUri

        public java.lang.String getAttachmentsUri()
        .
        Returns:
        attachmentsUri

      • setAttachmentsUri

        public void setAttachmentsUri​(java.lang.String attachmentsUri)
        setAttachmentsUri.

      • authoritativeCopy

        public EnvelopeDefinition authoritativeCopy​(java.lang.String authoritativeCopy)
        authoritativeCopy.
        Returns:
        EnvelopeDefinition

      • getAuthoritativeCopy

        public java.lang.String getAuthoritativeCopy()
        Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled..
        Returns:
        authoritativeCopy

      • setAuthoritativeCopy

        public void setAuthoritativeCopy​(java.lang.String authoritativeCopy)
        setAuthoritativeCopy.

      • authoritativeCopyDefault

        public EnvelopeDefinition authoritativeCopyDefault​(java.lang.String authoritativeCopyDefault)
        authoritativeCopyDefault.
        Returns:
        EnvelopeDefinition

      • getAuthoritativeCopyDefault

        public java.lang.String getAuthoritativeCopyDefault()
        .
        Returns:
        authoritativeCopyDefault

      • setAuthoritativeCopyDefault

        public void setAuthoritativeCopyDefault​(java.lang.String authoritativeCopyDefault)
        setAuthoritativeCopyDefault.

      • autoNavigation

        public EnvelopeDefinition autoNavigation​(java.lang.String autoNavigation)
        autoNavigation.
        Returns:
        EnvelopeDefinition

      • getAutoNavigation

        public java.lang.String getAutoNavigation()
        .
        Returns:
        autoNavigation

      • setAutoNavigation

        public void setAutoNavigation​(java.lang.String autoNavigation)
        setAutoNavigation.

      • brandId

        public EnvelopeDefinition brandId​(java.lang.String brandId)
        brandId.
        Returns:
        EnvelopeDefinition

      • getBrandId

        public java.lang.String getBrandId()
        This sets the brand profile format used for the envelope. The value in the string is the brandId associated with the profile. Account branding must be enabled for the account to use this option..
        Returns:
        brandId

      • setBrandId

        public void setBrandId​(java.lang.String brandId)
        setBrandId.

      • brandLock

        public EnvelopeDefinition brandLock​(java.lang.String brandLock)
        brandLock.
        Returns:
        EnvelopeDefinition

      • getBrandLock

        public java.lang.String getBrandLock()
        .
        Returns:
        brandLock

      • setBrandLock

        public void setBrandLock​(java.lang.String brandLock)
        setBrandLock.

      • certificateUri

        public EnvelopeDefinition certificateUri​(java.lang.String certificateUri)
        certificateUri.
        Returns:
        EnvelopeDefinition

      • getCertificateUri

        public java.lang.String getCertificateUri()
        Retrieves a URI for an endpoint that allows you to easily retrieve certificate information..
        Returns:
        certificateUri

      • setCertificateUri

        public void setCertificateUri​(java.lang.String certificateUri)
        setCertificateUri.

      • completedDateTime

        public EnvelopeDefinition completedDateTime​(java.lang.String completedDateTime)
        completedDateTime.
        Returns:
        EnvelopeDefinition

      • getCompletedDateTime

        public java.lang.String getCompletedDateTime()
        Specifies the date and time this item was completed..
        Returns:
        completedDateTime

      • setCompletedDateTime

        public void setCompletedDateTime​(java.lang.String completedDateTime)
        setCompletedDateTime.

      • addCompositeTemplatesItem

        public EnvelopeDefinition addCompositeTemplatesItem​(CompositeTemplate compositeTemplatesItem)
        addCompositeTemplatesItem.
        Returns:
        EnvelopeDefinition

      • getCompositeTemplates

        public java.util.List<CompositeTemplate> getCompositeTemplates()
        A complex type that can be added to create envelopes from a combination of DocuSign templates and PDF forms. The basic envelope remains the same, while the Composite Template adds new document and template overlays into the envelope. There can be any number of Composite Template structures in the envelope..
        Returns:
        compositeTemplates

      • setCompositeTemplates

        public void setCompositeTemplates​(java.util.List<CompositeTemplate> compositeTemplates)
        setCompositeTemplates.

      • copyRecipientData

        public EnvelopeDefinition copyRecipientData​(java.lang.String copyRecipientData)
        copyRecipientData.
        Returns:
        EnvelopeDefinition

      • getCopyRecipientData

        public java.lang.String getCopyRecipientData()
        .
        Returns:
        copyRecipientData

      • setCopyRecipientData

        public void setCopyRecipientData​(java.lang.String copyRecipientData)
        setCopyRecipientData.

      • createdDateTime

        public EnvelopeDefinition createdDateTime​(java.lang.String createdDateTime)
        createdDateTime.
        Returns:
        EnvelopeDefinition

      • getCreatedDateTime

        public java.lang.String getCreatedDateTime()
        Indicates the date and time the item was created..
        Returns:
        createdDateTime

      • setCreatedDateTime

        public void setCreatedDateTime​(java.lang.String createdDateTime)
        setCreatedDateTime.

      • getCustomFields

        public CustomFields getCustomFields()
        Get customFields.
        Returns:
        customFields

      • setCustomFields

        public void setCustomFields​(CustomFields customFields)
        setCustomFields.

      • customFieldsUri

        public EnvelopeDefinition customFieldsUri​(java.lang.String customFieldsUri)
        customFieldsUri.
        Returns:
        EnvelopeDefinition

      • getCustomFieldsUri

        public java.lang.String getCustomFieldsUri()
        Contains a URI for an endpoint that you can use to retrieve the custom fields..
        Returns:
        customFieldsUri

      • setCustomFieldsUri

        public void setCustomFieldsUri​(java.lang.String customFieldsUri)
        setCustomFieldsUri.

      • declinedDateTime

        public EnvelopeDefinition declinedDateTime​(java.lang.String declinedDateTime)
        declinedDateTime.
        Returns:
        EnvelopeDefinition

      • getDeclinedDateTime

        public java.lang.String getDeclinedDateTime()
        The date and time the recipient declined the document..
        Returns:
        declinedDateTime

      • setDeclinedDateTime

        public void setDeclinedDateTime​(java.lang.String declinedDateTime)
        setDeclinedDateTime.

      • deletedDateTime

        public EnvelopeDefinition deletedDateTime​(java.lang.String deletedDateTime)
        deletedDateTime.
        Returns:
        EnvelopeDefinition

      • getDeletedDateTime

        public java.lang.String getDeletedDateTime()
        Specifies the data and time the item was deleted..
        Returns:
        deletedDateTime

      • setDeletedDateTime

        public void setDeletedDateTime​(java.lang.String deletedDateTime)
        setDeletedDateTime.

      • deliveredDateTime

        public EnvelopeDefinition deliveredDateTime​(java.lang.String deliveredDateTime)
        deliveredDateTime.
        Returns:
        EnvelopeDefinition

      • getDeliveredDateTime

        public java.lang.String getDeliveredDateTime()
        Reserved: For DocuSign use only..
        Returns:
        deliveredDateTime

      • setDeliveredDateTime

        public void setDeliveredDateTime​(java.lang.String deliveredDateTime)
        setDeliveredDateTime.

      • disableResponsiveDocument

        public EnvelopeDefinition disableResponsiveDocument​(java.lang.String disableResponsiveDocument)
        disableResponsiveDocument.
        Returns:
        EnvelopeDefinition

      • getDisableResponsiveDocument

        public java.lang.String getDisableResponsiveDocument()
        .
        Returns:
        disableResponsiveDocument

      • setDisableResponsiveDocument

        public void setDisableResponsiveDocument​(java.lang.String disableResponsiveDocument)
        setDisableResponsiveDocument.

      • documentBase64

        public EnvelopeDefinition documentBase64​(java.lang.String documentBase64)
        documentBase64.
        Returns:
        EnvelopeDefinition

      • getDocumentBase64

        public java.lang.String getDocumentBase64()
        .
        Returns:
        documentBase64

      • setDocumentBase64

        public void setDocumentBase64​(java.lang.String documentBase64)
        setDocumentBase64.

      • addDocumentsItem

        public EnvelopeDefinition addDocumentsItem​(Document documentsItem)
        addDocumentsItem.
        Returns:
        EnvelopeDefinition

      • getDocuments

        public java.util.List<Document> getDocuments()
        Complex element contains the details on the documents in the envelope..
        Returns:
        documents

      • setDocuments

        public void setDocuments​(java.util.List<Document> documents)
        setDocuments.

      • documentsCombinedUri

        public EnvelopeDefinition documentsCombinedUri​(java.lang.String documentsCombinedUri)
        documentsCombinedUri.
        Returns:
        EnvelopeDefinition

      • getDocumentsCombinedUri

        public java.lang.String getDocumentsCombinedUri()
        .
        Returns:
        documentsCombinedUri

      • setDocumentsCombinedUri

        public void setDocumentsCombinedUri​(java.lang.String documentsCombinedUri)
        setDocumentsCombinedUri.

      • documentsUri

        public EnvelopeDefinition documentsUri​(java.lang.String documentsUri)
        documentsUri.
        Returns:
        EnvelopeDefinition

      • getDocumentsUri

        public java.lang.String getDocumentsUri()
        Contains a URI for an endpoint that you can use to retrieve the documents..
        Returns:
        documentsUri

      • setDocumentsUri

        public void setDocumentsUri​(java.lang.String documentsUri)
        setDocumentsUri.

      • emailBlurb

        public EnvelopeDefinition emailBlurb​(java.lang.String emailBlurb)
        emailBlurb.
        Returns:
        EnvelopeDefinition

      • getEmailBlurb

        public java.lang.String getEmailBlurb()
        Optional element. This is the same as the email body. If specified it is included in email body for all envelope recipients. This can be a maximum of 10000 characters.
        Returns:
        emailBlurb

      • setEmailBlurb

        public void setEmailBlurb​(java.lang.String emailBlurb)
        setEmailBlurb.

      • getEmailSettings

        public EmailSettings getEmailSettings()
        Get emailSettings.
        Returns:
        emailSettings

      • setEmailSettings

        public void setEmailSettings​(EmailSettings emailSettings)
        setEmailSettings.

      • emailSubject

        public EnvelopeDefinition emailSubject​(java.lang.String emailSubject)
        emailSubject.
        Returns:
        EnvelopeDefinition

      • getEmailSubject

        public java.lang.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​(java.lang.String emailSubject)
        setEmailSubject.

      • enableWetSign

        public EnvelopeDefinition enableWetSign​(java.lang.String enableWetSign)
        enableWetSign.
        Returns:
        EnvelopeDefinition

      • getEnableWetSign

        public java.lang.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​(java.lang.String enableWetSign)
        setEnableWetSign.

      • enforceSignerVisibility

        public EnvelopeDefinition enforceSignerVisibility​(java.lang.String enforceSignerVisibility)
        enforceSignerVisibility.
        Returns:
        EnvelopeDefinition

      • getEnforceSignerVisibility

        public java.lang.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​(java.lang.String enforceSignerVisibility)
        setEnforceSignerVisibility.

      • envelopeAttachments

        public EnvelopeDefinition envelopeAttachments​(java.util.List<Attachment> envelopeAttachments)
        envelopeAttachments.
        Returns:
        EnvelopeDefinition

      • addEnvelopeAttachmentsItem

        public EnvelopeDefinition addEnvelopeAttachmentsItem​(Attachment envelopeAttachmentsItem)
        addEnvelopeAttachmentsItem.
        Returns:
        EnvelopeDefinition

      • getEnvelopeAttachments

        public java.util.List<Attachment> getEnvelopeAttachments()
        .
        Returns:
        envelopeAttachments

      • setEnvelopeAttachments

        public void setEnvelopeAttachments​(java.util.List<Attachment> envelopeAttachments)
        setEnvelopeAttachments.

      • getEnvelopeCustomMetadata

        public EnvelopeCustomMetadata getEnvelopeCustomMetadata()
        Get envelopeCustomMetadata.
        Returns:
        envelopeCustomMetadata

      • setEnvelopeCustomMetadata

        public void setEnvelopeCustomMetadata​(EnvelopeCustomMetadata envelopeCustomMetadata)
        setEnvelopeCustomMetadata.

      • addEnvelopeDocumentsItem

        public EnvelopeDefinition addEnvelopeDocumentsItem​(EnvelopeDocument envelopeDocumentsItem)
        addEnvelopeDocumentsItem.
        Returns:
        EnvelopeDefinition

      • getEnvelopeDocuments

        public java.util.List<EnvelopeDocument> getEnvelopeDocuments()
        .
        Returns:
        envelopeDocuments

      • setEnvelopeDocuments

        public void setEnvelopeDocuments​(java.util.List<EnvelopeDocument> envelopeDocuments)
        setEnvelopeDocuments.

      • envelopeId

        public EnvelopeDefinition envelopeId​(java.lang.String envelopeId)
        envelopeId.
        Returns:
        EnvelopeDefinition

      • getEnvelopeId

        public java.lang.String getEnvelopeId()
        The envelope ID of the envelope status that failed to post..
        Returns:
        envelopeId

      • setEnvelopeId

        public void setEnvelopeId​(java.lang.String envelopeId)
        setEnvelopeId.

      • envelopeIdStamping

        public EnvelopeDefinition envelopeIdStamping​(java.lang.String envelopeIdStamping)
        envelopeIdStamping.
        Returns:
        EnvelopeDefinition

      • getEnvelopeIdStamping

        public java.lang.String getEnvelopeIdStamping()
        When set to **true**, Envelope ID Stamping is enabled..
        Returns:
        envelopeIdStamping

      • setEnvelopeIdStamping

        public void setEnvelopeIdStamping​(java.lang.String envelopeIdStamping)
        setEnvelopeIdStamping.

      • envelopeLocation

        public EnvelopeDefinition envelopeLocation​(java.lang.String envelopeLocation)
        envelopeLocation.
        Returns:
        EnvelopeDefinition

      • getEnvelopeLocation

        public java.lang.String getEnvelopeLocation()
        .
        Returns:
        envelopeLocation

      • setEnvelopeLocation

        public void setEnvelopeLocation​(java.lang.String envelopeLocation)
        setEnvelopeLocation.

      • getEnvelopeMetadata

        public EnvelopeMetadata getEnvelopeMetadata()
        Get envelopeMetadata.
        Returns:
        envelopeMetadata

      • setEnvelopeMetadata

        public void setEnvelopeMetadata​(EnvelopeMetadata envelopeMetadata)
        setEnvelopeMetadata.

      • envelopeUri

        public EnvelopeDefinition envelopeUri​(java.lang.String envelopeUri)
        envelopeUri.
        Returns:
        EnvelopeDefinition

      • getEnvelopeUri

        public java.lang.String getEnvelopeUri()
        Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes..
        Returns:
        envelopeUri

      • setEnvelopeUri

        public void setEnvelopeUri​(java.lang.String envelopeUri)
        setEnvelopeUri.

      • getEventNotification

        public EventNotification getEventNotification()
        Get eventNotification.
        Returns:
        eventNotification

      • setEventNotification

        public void setEventNotification​(EventNotification eventNotification)
        setEventNotification.

      • addEventNotificationsItem

        public EnvelopeDefinition addEventNotificationsItem​(EventNotification eventNotificationsItem)
        addEventNotificationsItem.
        Returns:
        EnvelopeDefinition

      • getEventNotifications

        public java.util.List<EventNotification> getEventNotifications()
        .
        Returns:
        eventNotifications

      • setEventNotifications

        public void setEventNotifications​(java.util.List<EventNotification> eventNotifications)
        setEventNotifications.

      • expireAfter

        public EnvelopeDefinition expireAfter​(java.lang.String expireAfter)
        expireAfter.
        Returns:
        EnvelopeDefinition

      • getExpireAfter

        public java.lang.String getExpireAfter()
        .
        Returns:
        expireAfter

      • setExpireAfter

        public void setExpireAfter​(java.lang.String expireAfter)
        setExpireAfter.

      • expireDateTime

        public EnvelopeDefinition expireDateTime​(java.lang.String expireDateTime)
        expireDateTime.
        Returns:
        EnvelopeDefinition

      • getExpireDateTime

        public java.lang.String getExpireDateTime()
        .
        Returns:
        expireDateTime

      • setExpireDateTime

        public void setExpireDateTime​(java.lang.String expireDateTime)
        setExpireDateTime.

      • expireEnabled

        public EnvelopeDefinition expireEnabled​(java.lang.String expireEnabled)
        expireEnabled.
        Returns:
        EnvelopeDefinition

      • getExpireEnabled

        public java.lang.String getExpireEnabled()
        .
        Returns:
        expireEnabled

      • setExpireEnabled

        public void setExpireEnabled​(java.lang.String expireEnabled)
        setExpireEnabled.

      • externalEnvelopeId

        public EnvelopeDefinition externalEnvelopeId​(java.lang.String externalEnvelopeId)
        externalEnvelopeId.
        Returns:
        EnvelopeDefinition

      • getExternalEnvelopeId

        public java.lang.String getExternalEnvelopeId()
        .
        Returns:
        externalEnvelopeId

      • setExternalEnvelopeId

        public void setExternalEnvelopeId​(java.lang.String externalEnvelopeId)
        setExternalEnvelopeId.

      • addFoldersItem

        public EnvelopeDefinition addFoldersItem​(Folder foldersItem)
        addFoldersItem.
        Returns:
        EnvelopeDefinition

      • getFolders

        public java.util.List<Folder> getFolders()
        .
        Returns:
        folders

      • setFolders

        public void setFolders​(java.util.List<Folder> folders)
        setFolders.

      • hasComments

        public EnvelopeDefinition hasComments​(java.lang.String hasComments)
        hasComments.
        Returns:
        EnvelopeDefinition

      • getHasComments

        public java.lang.String getHasComments()
        .
        Returns:
        hasComments

      • setHasComments

        public void setHasComments​(java.lang.String hasComments)
        setHasComments.

      • hasFormDataChanged

        public EnvelopeDefinition hasFormDataChanged​(java.lang.String hasFormDataChanged)
        hasFormDataChanged.
        Returns:
        EnvelopeDefinition

      • getHasFormDataChanged

        public java.lang.String getHasFormDataChanged()
        .
        Returns:
        hasFormDataChanged

      • setHasFormDataChanged

        public void setHasFormDataChanged​(java.lang.String hasFormDataChanged)
        setHasFormDataChanged.

      • hasWavFile

        public EnvelopeDefinition hasWavFile​(java.lang.String hasWavFile)
        hasWavFile.
        Returns:
        EnvelopeDefinition

      • getHasWavFile

        public java.lang.String getHasWavFile()
        .
        Returns:
        hasWavFile

      • setHasWavFile

        public void setHasWavFile​(java.lang.String hasWavFile)
        setHasWavFile.

      • holder

        public EnvelopeDefinition holder​(java.lang.String holder)
        holder.
        Returns:
        EnvelopeDefinition

      • getHolder

        public java.lang.String getHolder()
        .
        Returns:
        holder

      • setHolder

        public void setHolder​(java.lang.String holder)
        setHolder.

      • initialSentDateTime

        public EnvelopeDefinition initialSentDateTime​(java.lang.String initialSentDateTime)
        initialSentDateTime.
        Returns:
        EnvelopeDefinition

      • getInitialSentDateTime

        public java.lang.String getInitialSentDateTime()
        .
        Returns:
        initialSentDateTime

      • setInitialSentDateTime

        public void setInitialSentDateTime​(java.lang.String initialSentDateTime)
        setInitialSentDateTime.

      • is21CFRPart11

        public EnvelopeDefinition is21CFRPart11​(java.lang.String is21CFRPart11)
        is21CFRPart11.
        Returns:
        EnvelopeDefinition

      • getIs21CFRPart11

        public java.lang.String getIs21CFRPart11()
        When set to **true**, indicates that this module is enabled on the account..
        Returns:
        is21CFRPart11

      • setIs21CFRPart11

        public void setIs21CFRPart11​(java.lang.String is21CFRPart11)
        setIs21CFRPart11.

      • isDynamicEnvelope

        public EnvelopeDefinition isDynamicEnvelope​(java.lang.String isDynamicEnvelope)
        isDynamicEnvelope.
        Returns:
        EnvelopeDefinition

      • getIsDynamicEnvelope

        public java.lang.String getIsDynamicEnvelope()
        .
        Returns:
        isDynamicEnvelope

      • setIsDynamicEnvelope

        public void setIsDynamicEnvelope​(java.lang.String isDynamicEnvelope)
        setIsDynamicEnvelope.

      • isSignatureProviderEnvelope

        public EnvelopeDefinition isSignatureProviderEnvelope​(java.lang.String isSignatureProviderEnvelope)
        isSignatureProviderEnvelope.
        Returns:
        EnvelopeDefinition

      • getIsSignatureProviderEnvelope

        public java.lang.String getIsSignatureProviderEnvelope()
        .
        Returns:
        isSignatureProviderEnvelope

      • setIsSignatureProviderEnvelope

        public void setIsSignatureProviderEnvelope​(java.lang.String isSignatureProviderEnvelope)
        setIsSignatureProviderEnvelope.

      • lastModifiedDateTime

        public EnvelopeDefinition lastModifiedDateTime​(java.lang.String lastModifiedDateTime)
        lastModifiedDateTime.
        Returns:
        EnvelopeDefinition

      • getLastModifiedDateTime

        public java.lang.String getLastModifiedDateTime()
        The date and time the item was last modified..
        Returns:
        lastModifiedDateTime

      • setLastModifiedDateTime

        public void setLastModifiedDateTime​(java.lang.String lastModifiedDateTime)
        setLastModifiedDateTime.

      • location

        public EnvelopeDefinition location​(java.lang.String location)
        location.
        Returns:
        EnvelopeDefinition

      • getLocation

        public java.lang.String getLocation()
        .
        Returns:
        location

      • setLocation

        public void setLocation​(java.lang.String location)
        setLocation.

      • getLockInformation

        public LockInformation getLockInformation()
        Get lockInformation.
        Returns:
        lockInformation

      • setLockInformation

        public void setLockInformation​(LockInformation lockInformation)
        setLockInformation.

      • messageLock

        public EnvelopeDefinition messageLock​(java.lang.String messageLock)
        messageLock.
        Returns:
        EnvelopeDefinition

      • getMessageLock

        public java.lang.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​(java.lang.String messageLock)
        setMessageLock.

      • getNotification

        public Notification getNotification()
        Get notification.
        Returns:
        notification

      • setNotification

        public void setNotification​(Notification notification)
        setNotification.

      • notificationUri

        public EnvelopeDefinition notificationUri​(java.lang.String notificationUri)
        notificationUri.
        Returns:
        EnvelopeDefinition

      • getNotificationUri

        public java.lang.String getNotificationUri()
        Contains a URI for an endpoint that you can use to retrieve the notifications..
        Returns:
        notificationUri

      • setNotificationUri

        public void setNotificationUri​(java.lang.String notificationUri)
        setNotificationUri.

      • password

        public EnvelopeDefinition password​(java.lang.String password)
        password.
        Returns:
        EnvelopeDefinition

      • getPassword

        public java.lang.String getPassword()
        .
        Returns:
        password

      • setPassword

        public void setPassword​(java.lang.String password)
        setPassword.

      • getPowerForm

        public PowerForm getPowerForm()
        Get powerForm.
        Returns:
        powerForm

      • setPowerForm

        public void setPowerForm​(PowerForm powerForm)
        setPowerForm.

      • purgeCompletedDate

        public EnvelopeDefinition purgeCompletedDate​(java.lang.String purgeCompletedDate)
        purgeCompletedDate.
        Returns:
        EnvelopeDefinition

      • getPurgeCompletedDate

        public java.lang.String getPurgeCompletedDate()
        .
        Returns:
        purgeCompletedDate

      • setPurgeCompletedDate

        public void setPurgeCompletedDate​(java.lang.String purgeCompletedDate)
        setPurgeCompletedDate.

      • purgeRequestDate

        public EnvelopeDefinition purgeRequestDate​(java.lang.String purgeRequestDate)
        purgeRequestDate.
        Returns:
        EnvelopeDefinition

      • getPurgeRequestDate

        public java.lang.String getPurgeRequestDate()
        .
        Returns:
        purgeRequestDate

      • setPurgeRequestDate

        public void setPurgeRequestDate​(java.lang.String purgeRequestDate)
        setPurgeRequestDate.

      • purgeState

        public EnvelopeDefinition purgeState​(java.lang.String purgeState)
        purgeState.
        Returns:
        EnvelopeDefinition

      • getPurgeState

        public java.lang.String getPurgeState()
        Initiates a purge request. Valid values are: * documents_queued: Places envelope documents in the purge queue. * documents_and_metadata_queued: Places envelope documents and metadata in the purge queue. .
        Returns:
        purgeState

      • setPurgeState

        public void setPurgeState​(java.lang.String purgeState)
        setPurgeState.

      • getRecipients

        public Recipients getRecipients()
        Get recipients.
        Returns:
        recipients

      • setRecipients

        public void setRecipients​(Recipients recipients)
        setRecipients.

      • recipientsLock

        public EnvelopeDefinition recipientsLock​(java.lang.String recipientsLock)
        recipientsLock.
        Returns:
        EnvelopeDefinition

      • getRecipientsLock

        public java.lang.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​(java.lang.String recipientsLock)
        setRecipientsLock.

      • recipientsUri

        public EnvelopeDefinition recipientsUri​(java.lang.String recipientsUri)
        recipientsUri.
        Returns:
        EnvelopeDefinition

      • getRecipientsUri

        public java.lang.String getRecipientsUri()
        Contains a URI for an endpoint that you can use to retrieve the recipients..
        Returns:
        recipientsUri

      • setRecipientsUri

        public void setRecipientsUri​(java.lang.String recipientsUri)
        setRecipientsUri.

      • getRecipientViewRequest

        public RecipientViewRequest getRecipientViewRequest()
        Get recipientViewRequest.
        Returns:
        recipientViewRequest

      • setRecipientViewRequest

        public void setRecipientViewRequest​(RecipientViewRequest recipientViewRequest)
        setRecipientViewRequest.

      • getSender

        public UserInfo getSender()
        Get sender.
        Returns:
        sender

      • setSender

        public void setSender​(UserInfo sender)
        setSender.

      • sentDateTime

        public EnvelopeDefinition sentDateTime​(java.lang.String sentDateTime)
        sentDateTime.
        Returns:
        EnvelopeDefinition

      • getSentDateTime

        public java.lang.String getSentDateTime()
        The date and time the envelope was sent..
        Returns:
        sentDateTime

      • setSentDateTime

        public void setSentDateTime​(java.lang.String sentDateTime)
        setSentDateTime.

      • signerCanSignOnMobile

        public EnvelopeDefinition signerCanSignOnMobile​(java.lang.String signerCanSignOnMobile)
        signerCanSignOnMobile.
        Returns:
        EnvelopeDefinition

      • getSignerCanSignOnMobile

        public java.lang.String getSignerCanSignOnMobile()
        .
        Returns:
        signerCanSignOnMobile

      • setSignerCanSignOnMobile

        public void setSignerCanSignOnMobile​(java.lang.String signerCanSignOnMobile)
        setSignerCanSignOnMobile.

      • signingLocation

        public EnvelopeDefinition signingLocation​(java.lang.String signingLocation)
        signingLocation.
        Returns:
        EnvelopeDefinition

      • getSigningLocation

        public java.lang.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​(java.lang.String signingLocation)
        setSigningLocation.

      • status

        public EnvelopeDefinition status​(java.lang.String status)
        status.
        Returns:
        EnvelopeDefinition

      • getStatus

        public java.lang.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​(java.lang.String status)
        setStatus.

      • statusChangedDateTime

        public EnvelopeDefinition statusChangedDateTime​(java.lang.String statusChangedDateTime)
        statusChangedDateTime.
        Returns:
        EnvelopeDefinition

      • getStatusChangedDateTime

        public java.lang.String getStatusChangedDateTime()
        The data and time the status changed..
        Returns:
        statusChangedDateTime

      • setStatusChangedDateTime

        public void setStatusChangedDateTime​(java.lang.String statusChangedDateTime)
        setStatusChangedDateTime.

      • statusDateTime

        public EnvelopeDefinition statusDateTime​(java.lang.String statusDateTime)
        statusDateTime.
        Returns:
        EnvelopeDefinition

      • getStatusDateTime

        public java.lang.String getStatusDateTime()
        .
        Returns:
        statusDateTime

      • setStatusDateTime

        public void setStatusDateTime​(java.lang.String statusDateTime)
        setStatusDateTime.

      • templateId

        public EnvelopeDefinition templateId​(java.lang.String templateId)
        templateId.
        Returns:
        EnvelopeDefinition

      • getTemplateId

        public java.lang.String getTemplateId()
        The unique identifier of the template. If this is not provided, DocuSign will generate a value. .
        Returns:
        templateId

      • setTemplateId

        public void setTemplateId​(java.lang.String templateId)
        setTemplateId.

      • addTemplateRolesItem

        public EnvelopeDefinition addTemplateRolesItem​(TemplateRole templateRolesItem)
        addTemplateRolesItem.
        Returns:
        EnvelopeDefinition

      • getTemplateRoles

        public java.util.List<TemplateRole> getTemplateRoles()
        Specifies the template recipients. Each roleName in the template must have a recipient assigned to it. This is made up elements: * email - The recipient's email address. * name - The recipient's name. * roleName - The template roleName associated with the recipient. * clientUserId - Optional, this sets if the signer is This specifies if the recipient is embedded or remote. If the clientUserId is not null then the recipient is embedded. Note that if a ClientUserId is used and the account settings SignerMustHaveAccount or SignerMustLoginToSign are true, an error is generated on sending. * defaultRecipient - Optional, When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. * routingOrder - This specifies the routing order of the recipient in the envelope. * accessCode - This optional element specifies the access code a recipient has to enter to validate the identity. This can be a maximum of 50 characters. * inPersonSignerName - Optional, if the template role is an in person signer, this is the full legal name of the signer. This can be a maximum of 100 characters. * emailNotification - This is an optional complex element that has a role specific emailSubject, emailBody, and language. It follows the same format as the emailNotification node for Recipients. * tabs - This allows the tab values to be specified for matching to tabs in the template. .
        Returns:
        templateRoles

      • setTemplateRoles

        public void setTemplateRoles​(java.util.List<TemplateRole> templateRoles)
        setTemplateRoles.

      • templatesUri

        public EnvelopeDefinition templatesUri​(java.lang.String templatesUri)
        templatesUri.
        Returns:
        EnvelopeDefinition

      • getTemplatesUri

        public java.lang.String getTemplatesUri()
        Contains a URI for an endpoint which you can use to retrieve the templates..
        Returns:
        templatesUri

      • setTemplatesUri

        public void setTemplatesUri​(java.lang.String templatesUri)
        setTemplatesUri.

      • transactionId

        public EnvelopeDefinition transactionId​(java.lang.String transactionId)
        transactionId.
        Returns:
        EnvelopeDefinition

      • getTransactionId

        public java.lang.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​(java.lang.String transactionId)
        setTransactionId.

      • useDisclosure

        public EnvelopeDefinition useDisclosure​(java.lang.String useDisclosure)
        useDisclosure.
        Returns:
        EnvelopeDefinition

      • getUseDisclosure

        public java.lang.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​(java.lang.String useDisclosure)
        setUseDisclosure.

      • voidedDateTime

        public EnvelopeDefinition voidedDateTime​(java.lang.String voidedDateTime)
        voidedDateTime.
        Returns:
        EnvelopeDefinition

      • getVoidedDateTime

        public java.lang.String getVoidedDateTime()
        The date and time the envelope or template was voided..
        Returns:
        voidedDateTime

      • setVoidedDateTime

        public void setVoidedDateTime​(java.lang.String voidedDateTime)
        setVoidedDateTime.

      • voidedReason

        public EnvelopeDefinition voidedReason​(java.lang.String voidedReason)
        voidedReason.
        Returns:
        EnvelopeDefinition

      • getVoidedReason

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

      • setVoidedReason

        public void setVoidedReason​(java.lang.String voidedReason)
        setVoidedReason.

      • getWorkflow

        public Workflow getWorkflow()
        Get workflow.
        Returns:
        workflow

      • setWorkflow

        public void setWorkflow​(Workflow workflow)
        setWorkflow.

      • equals

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

      • hashCode

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

      • toString

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