Class EnvelopeTemplate


  • public class EnvelopeTemplate
    extends Object
    EnvelopeTemplate.
    • Constructor Detail

      • EnvelopeTemplate

        public EnvelopeTemplate()
    • Method Detail

      • accessControlListBase64

        public EnvelopeTemplate accessControlListBase64​(String accessControlListBase64)
        accessControlListBase64.
        Returns:
        EnvelopeTemplate
      • getAccessControlListBase64

        public String getAccessControlListBase64()
        .
        Returns:
        accessControlListBase64
      • setAccessControlListBase64

        public void setAccessControlListBase64​(String accessControlListBase64)
        setAccessControlListBase64.
      • allowComments

        public EnvelopeTemplate allowComments​(String allowComments)
        allowComments.
        Returns:
        EnvelopeTemplate
      • getAllowComments

        public String getAllowComments()
        .
        Returns:
        allowComments
      • setAllowComments

        public void setAllowComments​(String allowComments)
        setAllowComments.
      • allowMarkup

        public EnvelopeTemplate allowMarkup​(String allowMarkup)
        allowMarkup.
        Returns:
        EnvelopeTemplate
      • 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 EnvelopeTemplate allowReassign​(String allowReassign)
        allowReassign.
        Returns:
        EnvelopeTemplate
      • 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 EnvelopeTemplate allowViewHistory​(String allowViewHistory)
        allowViewHistory.
        Returns:
        EnvelopeTemplate
      • 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.
      • asynchronous

        public EnvelopeTemplate asynchronous​(String asynchronous)
        asynchronous.
        Returns:
        EnvelopeTemplate
      • 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 EnvelopeTemplate attachmentsUri​(String attachmentsUri)
        attachmentsUri.
        Returns:
        EnvelopeTemplate
      • getAttachmentsUri

        public String getAttachmentsUri()
        .
        Returns:
        attachmentsUri
      • setAttachmentsUri

        public void setAttachmentsUri​(String attachmentsUri)
        setAttachmentsUri.
      • authoritativeCopy

        public EnvelopeTemplate authoritativeCopy​(String authoritativeCopy)
        authoritativeCopy.
        Returns:
        EnvelopeTemplate
      • 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 EnvelopeTemplate authoritativeCopyDefault​(String authoritativeCopyDefault)
        authoritativeCopyDefault.
        Returns:
        EnvelopeTemplate
      • getAuthoritativeCopyDefault

        public String getAuthoritativeCopyDefault()
        .
        Returns:
        authoritativeCopyDefault
      • setAuthoritativeCopyDefault

        public void setAuthoritativeCopyDefault​(String authoritativeCopyDefault)
        setAuthoritativeCopyDefault.
      • getAutoMatch

        public String getAutoMatch()
        .
        Returns:
        autoMatch
      • setAutoMatch

        public void setAutoMatch​(String autoMatch)
        setAutoMatch.
      • autoMatchSpecifiedByUser

        public EnvelopeTemplate autoMatchSpecifiedByUser​(String autoMatchSpecifiedByUser)
        autoMatchSpecifiedByUser.
        Returns:
        EnvelopeTemplate
      • getAutoMatchSpecifiedByUser

        public String getAutoMatchSpecifiedByUser()
        .
        Returns:
        autoMatchSpecifiedByUser
      • setAutoMatchSpecifiedByUser

        public void setAutoMatchSpecifiedByUser​(String autoMatchSpecifiedByUser)
        setAutoMatchSpecifiedByUser.
      • autoNavigation

        public EnvelopeTemplate autoNavigation​(String autoNavigation)
        autoNavigation.
        Returns:
        EnvelopeTemplate
      • 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.
      • certificateUri

        public EnvelopeTemplate certificateUri​(String certificateUri)
        certificateUri.
        Returns:
        EnvelopeTemplate
      • 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 EnvelopeTemplate completedDateTime​(String completedDateTime)
        completedDateTime.
        Returns:
        EnvelopeTemplate
      • getCompletedDateTime

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

        public void setCompletedDateTime​(String completedDateTime)
        setCompletedDateTime.
      • copyRecipientData

        public EnvelopeTemplate copyRecipientData​(String copyRecipientData)
        copyRecipientData.
        Returns:
        EnvelopeTemplate
      • getCopyRecipientData

        public String getCopyRecipientData()
        .
        Returns:
        copyRecipientData
      • setCopyRecipientData

        public void setCopyRecipientData​(String copyRecipientData)
        setCopyRecipientData.
      • getCreated

        public String getCreated()
        .
        Returns:
        created
      • setCreated

        public void setCreated​(String created)
        setCreated.
      • createdDateTime

        public EnvelopeTemplate createdDateTime​(String createdDateTime)
        createdDateTime.
        Returns:
        EnvelopeTemplate
      • getCreatedDateTime

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

        public void setCreatedDateTime​(String createdDateTime)
        setCreatedDateTime.
      • getCustomFields

        public CustomFields getCustomFields()
        An optional array of strings that enables 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 EnvelopeTemplate customFieldsUri​(String customFieldsUri)
        customFieldsUri.
        Returns:
        EnvelopeTemplate
      • 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 EnvelopeTemplate declinedDateTime​(String declinedDateTime)
        declinedDateTime.
        Returns:
        EnvelopeTemplate
      • getDeclinedDateTime

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

        public void setDeclinedDateTime​(String declinedDateTime)
        setDeclinedDateTime.
      • deletedDateTime

        public EnvelopeTemplate deletedDateTime​(String deletedDateTime)
        deletedDateTime.
        Returns:
        EnvelopeTemplate
      • getDeletedDateTime

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

        public void setDeletedDateTime​(String deletedDateTime)
        setDeletedDateTime.
      • deliveredDateTime

        public EnvelopeTemplate deliveredDateTime​(String deliveredDateTime)
        deliveredDateTime.
        Returns:
        EnvelopeTemplate
      • getDeliveredDateTime

        public String getDeliveredDateTime()
        Reserved: For DocuSign use only..
        Returns:
        deliveredDateTime
      • setDeliveredDateTime

        public void setDeliveredDateTime​(String deliveredDateTime)
        setDeliveredDateTime.
      • description

        public EnvelopeTemplate description​(String description)
        description.
        Returns:
        EnvelopeTemplate
      • getDescription

        public String getDescription()
        .
        Returns:
        description
      • setDescription

        public void setDescription​(String description)
        setDescription.
      • disableResponsiveDocument

        public EnvelopeTemplate disableResponsiveDocument​(String disableResponsiveDocument)
        disableResponsiveDocument.
        Returns:
        EnvelopeTemplate
      • getDisableResponsiveDocument

        public String getDisableResponsiveDocument()
        .
        Returns:
        disableResponsiveDocument
      • setDisableResponsiveDocument

        public void setDisableResponsiveDocument​(String disableResponsiveDocument)
        setDisableResponsiveDocument.
      • documentBase64

        public EnvelopeTemplate documentBase64​(String documentBase64)
        documentBase64.
        Returns:
        EnvelopeTemplate
      • getDocumentBase64

        public String getDocumentBase64()
        .
        Returns:
        documentBase64
      • setDocumentBase64

        public void setDocumentBase64​(String documentBase64)
        setDocumentBase64.
      • addDocumentsItem

        public EnvelopeTemplate addDocumentsItem​(Document documentsItem)
        addDocumentsItem.
        Returns:
        EnvelopeTemplate
      • getDocuments

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

        public void setDocuments​(List<Document> documents)
        setDocuments.
      • documentsCombinedUri

        public EnvelopeTemplate documentsCombinedUri​(String documentsCombinedUri)
        documentsCombinedUri.
        Returns:
        EnvelopeTemplate
      • getDocumentsCombinedUri

        public String getDocumentsCombinedUri()
        .
        Returns:
        documentsCombinedUri
      • setDocumentsCombinedUri

        public void setDocumentsCombinedUri​(String documentsCombinedUri)
        setDocumentsCombinedUri.
      • documentsUri

        public EnvelopeTemplate documentsUri​(String documentsUri)
        documentsUri.
        Returns:
        EnvelopeTemplate
      • 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 EnvelopeTemplate emailBlurb​(String emailBlurb)
        emailBlurb.
        Returns:
        EnvelopeTemplate
      • getEmailBlurb

        public String getEmailBlurb()
        .
        Returns:
        emailBlurb
      • setEmailBlurb

        public void setEmailBlurb​(String emailBlurb)
        setEmailBlurb.
      • getEmailSettings

        public EmailSettings getEmailSettings()
        A complex type that contains email settings..
        Returns:
        emailSettings
      • setEmailSettings

        public void setEmailSettings​(EmailSettings emailSettings)
        setEmailSettings.
      • emailSubject

        public EnvelopeTemplate emailSubject​(String emailSubject)
        emailSubject.
        Returns:
        EnvelopeTemplate
      • 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 EnvelopeTemplate enableWetSign​(String enableWetSign)
        enableWetSign.
        Returns:
        EnvelopeTemplate
      • 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 EnvelopeTemplate enforceSignerVisibility​(String enforceSignerVisibility)
        enforceSignerVisibility.
        Returns:
        EnvelopeTemplate
      • 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 EnvelopeTemplate envelopeAttachments​(List<Attachment> envelopeAttachments)
        envelopeAttachments.
        Returns:
        EnvelopeTemplate
      • addEnvelopeAttachmentsItem

        public EnvelopeTemplate addEnvelopeAttachmentsItem​(Attachment envelopeAttachmentsItem)
        addEnvelopeAttachmentsItem.
        Returns:
        EnvelopeTemplate
      • getEnvelopeAttachments

        public List<Attachment> getEnvelopeAttachments()
        .
        Returns:
        envelopeAttachments
      • setEnvelopeAttachments

        public void setEnvelopeAttachments​(List<Attachment> envelopeAttachments)
        setEnvelopeAttachments.
      • getEnvelopeCustomMetadata

        public EnvelopeCustomMetadata getEnvelopeCustomMetadata()
        .
        Returns:
        envelopeCustomMetadata
      • setEnvelopeCustomMetadata

        public void setEnvelopeCustomMetadata​(EnvelopeCustomMetadata envelopeCustomMetadata)
        setEnvelopeCustomMetadata.
      • addEnvelopeDocumentsItem

        public EnvelopeTemplate addEnvelopeDocumentsItem​(EnvelopeDocument envelopeDocumentsItem)
        addEnvelopeDocumentsItem.
        Returns:
        EnvelopeTemplate
      • getEnvelopeDocuments

        public List<EnvelopeDocument> getEnvelopeDocuments()
        .
        Returns:
        envelopeDocuments
      • setEnvelopeDocuments

        public void setEnvelopeDocuments​(List<EnvelopeDocument> envelopeDocuments)
        setEnvelopeDocuments.
      • envelopeId

        public EnvelopeTemplate envelopeId​(String envelopeId)
        envelopeId.
        Returns:
        EnvelopeTemplate
      • 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 EnvelopeTemplate envelopeIdStamping​(String envelopeIdStamping)
        envelopeIdStamping.
        Returns:
        EnvelopeTemplate
      • getEnvelopeIdStamping

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

        public void setEnvelopeIdStamping​(String envelopeIdStamping)
        setEnvelopeIdStamping.
      • envelopeLocation

        public EnvelopeTemplate envelopeLocation​(String envelopeLocation)
        envelopeLocation.
        Returns:
        EnvelopeTemplate
      • getEnvelopeLocation

        public String getEnvelopeLocation()
        .
        Returns:
        envelopeLocation
      • setEnvelopeLocation

        public void setEnvelopeLocation​(String envelopeLocation)
        setEnvelopeLocation.
      • 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.
      • envelopeUri

        public EnvelopeTemplate envelopeUri​(String envelopeUri)
        envelopeUri.
        Returns:
        EnvelopeTemplate
      • 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.
      • expireAfter

        public EnvelopeTemplate expireAfter​(String expireAfter)
        expireAfter.
        Returns:
        EnvelopeTemplate
      • getExpireAfter

        public String getExpireAfter()
        .
        Returns:
        expireAfter
      • setExpireAfter

        public void setExpireAfter​(String expireAfter)
        setExpireAfter.
      • expireDateTime

        public EnvelopeTemplate expireDateTime​(String expireDateTime)
        expireDateTime.
        Returns:
        EnvelopeTemplate
      • getExpireDateTime

        public String getExpireDateTime()
        .
        Returns:
        expireDateTime
      • setExpireDateTime

        public void setExpireDateTime​(String expireDateTime)
        setExpireDateTime.
      • expireEnabled

        public EnvelopeTemplate expireEnabled​(String expireEnabled)
        expireEnabled.
        Returns:
        EnvelopeTemplate
      • getExpireEnabled

        public String getExpireEnabled()
        .
        Returns:
        expireEnabled
      • setExpireEnabled

        public void setExpireEnabled​(String expireEnabled)
        setExpireEnabled.
      • externalEnvelopeId

        public EnvelopeTemplate externalEnvelopeId​(String externalEnvelopeId)
        externalEnvelopeId.
        Returns:
        EnvelopeTemplate
      • getExternalEnvelopeId

        public String getExternalEnvelopeId()
        .
        Returns:
        externalEnvelopeId
      • setExternalEnvelopeId

        public void setExternalEnvelopeId​(String externalEnvelopeId)
        setExternalEnvelopeId.
      • favoritedByMe

        public EnvelopeTemplate favoritedByMe​(String favoritedByMe)
        favoritedByMe.
        Returns:
        EnvelopeTemplate
      • getFavoritedByMe

        public String getFavoritedByMe()
        .
        Returns:
        favoritedByMe
      • setFavoritedByMe

        public void setFavoritedByMe​(String favoritedByMe)
        setFavoritedByMe.
      • getFolderId

        public String getFolderId()
        .
        Returns:
        folderId
      • setFolderId

        public void setFolderId​(String folderId)
        setFolderId.
      • addFolderIdsItem

        public EnvelopeTemplate addFolderIdsItem​(String folderIdsItem)
        addFolderIdsItem.
        Returns:
        EnvelopeTemplate
      • getFolderIds

        public List<String> getFolderIds()
        .
        Returns:
        folderIds
      • setFolderIds

        public void setFolderIds​(List<String> folderIds)
        setFolderIds.
      • folderName

        public EnvelopeTemplate folderName​(String folderName)
        folderName.
        Returns:
        EnvelopeTemplate
      • getFolderName

        public String getFolderName()
        .
        Returns:
        folderName
      • setFolderName

        public void setFolderName​(String folderName)
        setFolderName.
      • addFoldersItem

        public EnvelopeTemplate addFoldersItem​(Folder foldersItem)
        addFoldersItem.
        Returns:
        EnvelopeTemplate
      • getFolders

        public List<Folder> getFolders()
        .
        Returns:
        folders
      • setFolders

        public void setFolders​(List<Folder> folders)
        setFolders.
      • hasComments

        public EnvelopeTemplate hasComments​(String hasComments)
        hasComments.
        Returns:
        EnvelopeTemplate
      • getHasComments

        public String getHasComments()
        .
        Returns:
        hasComments
      • setHasComments

        public void setHasComments​(String hasComments)
        setHasComments.
      • hasFormDataChanged

        public EnvelopeTemplate hasFormDataChanged​(String hasFormDataChanged)
        hasFormDataChanged.
        Returns:
        EnvelopeTemplate
      • getHasFormDataChanged

        public String getHasFormDataChanged()
        .
        Returns:
        hasFormDataChanged
      • setHasFormDataChanged

        public void setHasFormDataChanged​(String hasFormDataChanged)
        setHasFormDataChanged.
      • hasWavFile

        public EnvelopeTemplate hasWavFile​(String hasWavFile)
        hasWavFile.
        Returns:
        EnvelopeTemplate
      • 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 EnvelopeTemplate initialSentDateTime​(String initialSentDateTime)
        initialSentDateTime.
        Returns:
        EnvelopeTemplate
      • getInitialSentDateTime

        public String getInitialSentDateTime()
        .
        Returns:
        initialSentDateTime
      • setInitialSentDateTime

        public void setInitialSentDateTime​(String initialSentDateTime)
        setInitialSentDateTime.
      • is21CFRPart11

        public EnvelopeTemplate is21CFRPart11​(String is21CFRPart11)
        is21CFRPart11.
        Returns:
        EnvelopeTemplate
      • 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 EnvelopeTemplate isDynamicEnvelope​(String isDynamicEnvelope)
        isDynamicEnvelope.
        Returns:
        EnvelopeTemplate
      • getIsDynamicEnvelope

        public String getIsDynamicEnvelope()
        .
        Returns:
        isDynamicEnvelope
      • setIsDynamicEnvelope

        public void setIsDynamicEnvelope​(String isDynamicEnvelope)
        setIsDynamicEnvelope.
      • isSignatureProviderEnvelope

        public EnvelopeTemplate isSignatureProviderEnvelope​(String isSignatureProviderEnvelope)
        isSignatureProviderEnvelope.
        Returns:
        EnvelopeTemplate
      • getIsSignatureProviderEnvelope

        public String getIsSignatureProviderEnvelope()
        .
        Returns:
        isSignatureProviderEnvelope
      • setIsSignatureProviderEnvelope

        public void setIsSignatureProviderEnvelope​(String isSignatureProviderEnvelope)
        setIsSignatureProviderEnvelope.
      • lastModified

        public EnvelopeTemplate lastModified​(String lastModified)
        lastModified.
        Returns:
        EnvelopeTemplate
      • getLastModified

        public String getLastModified()
        .
        Returns:
        lastModified
      • setLastModified

        public void setLastModified​(String lastModified)
        setLastModified.
      • lastModifiedBy

        public EnvelopeTemplate lastModifiedBy​(UserInfo lastModifiedBy)
        lastModifiedBy.
        Returns:
        EnvelopeTemplate
      • getLastModifiedBy

        public UserInfo getLastModifiedBy()
        .
        Returns:
        lastModifiedBy
      • setLastModifiedBy

        public void setLastModifiedBy​(UserInfo lastModifiedBy)
        setLastModifiedBy.
      • lastModifiedDateTime

        public EnvelopeTemplate lastModifiedDateTime​(String lastModifiedDateTime)
        lastModifiedDateTime.
        Returns:
        EnvelopeTemplate
      • getLastModifiedDateTime

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

        public void setLastModifiedDateTime​(String lastModifiedDateTime)
        setLastModifiedDateTime.
      • getLastUsed

        public String getLastUsed()
        .
        Returns:
        lastUsed
      • setLastUsed

        public void setLastUsed​(String lastUsed)
        setLastUsed.
      • getLocation

        public String getLocation()
        .
        Returns:
        location
      • setLocation

        public void setLocation​(String location)
        setLocation.
      • getLockInformation

        public LockInformation getLockInformation()
        Provides lock information about an envelope that a user has locked..
        Returns:
        lockInformation
      • setLockInformation

        public void setLockInformation​(LockInformation lockInformation)
        setLockInformation.
      • messageLock

        public EnvelopeTemplate messageLock​(String messageLock)
        messageLock.
        Returns:
        EnvelopeTemplate
      • 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.
      • getName

        public String getName()
        .
        Returns:
        name
      • setName

        public void setName​(String name)
        setName.
      • newPassword

        public EnvelopeTemplate newPassword​(String newPassword)
        newPassword.
        Returns:
        EnvelopeTemplate
      • getNewPassword

        public String getNewPassword()
        .
        Returns:
        newPassword
      • setNewPassword

        public void setNewPassword​(String newPassword)
        setNewPassword.
      • getNotification

        public Notification getNotification()
        .
        Returns:
        notification
      • setNotification

        public void setNotification​(Notification notification)
        setNotification.
      • notificationUri

        public EnvelopeTemplate notificationUri​(String notificationUri)
        notificationUri.
        Returns:
        EnvelopeTemplate
      • 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.
      • getOwner

        public UserInfo getOwner()
        .
        Returns:
        owner
      • setOwner

        public void setOwner​(UserInfo owner)
        setOwner.
      • getPageCount

        public String getPageCount()
        .
        Returns:
        pageCount
      • setPageCount

        public void setPageCount​(String pageCount)
        setPageCount.
      • getPassword

        public String getPassword()
        .
        Returns:
        password
      • setPassword

        public void setPassword​(String password)
        setPassword.
      • passwordProtected

        public EnvelopeTemplate passwordProtected​(String passwordProtected)
        passwordProtected.
        Returns:
        EnvelopeTemplate
      • getPasswordProtected

        public String getPasswordProtected()
        .
        Returns:
        passwordProtected
      • setPasswordProtected

        public void setPasswordProtected​(String passwordProtected)
        setPasswordProtected.
      • getPowerForm

        public PowerForm getPowerForm()
        Information about any PowerForms that are included in the envelope..
        Returns:
        powerForm
      • setPowerForm

        public void setPowerForm​(PowerForm powerForm)
        setPowerForm.
      • addPowerFormsItem

        public EnvelopeTemplate addPowerFormsItem​(PowerForm powerFormsItem)
        addPowerFormsItem.
        Returns:
        EnvelopeTemplate
      • getPowerForms

        public List<PowerForm> getPowerForms()
        .
        Returns:
        powerForms
      • setPowerForms

        public void setPowerForms​(List<PowerForm> powerForms)
        setPowerForms.
      • purgeCompletedDate

        public EnvelopeTemplate purgeCompletedDate​(String purgeCompletedDate)
        purgeCompletedDate.
        Returns:
        EnvelopeTemplate
      • getPurgeCompletedDate

        public String getPurgeCompletedDate()
        .
        Returns:
        purgeCompletedDate
      • setPurgeCompletedDate

        public void setPurgeCompletedDate​(String purgeCompletedDate)
        setPurgeCompletedDate.
      • purgeRequestDate

        public EnvelopeTemplate purgeRequestDate​(String purgeRequestDate)
        purgeRequestDate.
        Returns:
        EnvelopeTemplate
      • getPurgeRequestDate

        public String getPurgeRequestDate()
        .
        Returns:
        purgeRequestDate
      • setPurgeRequestDate

        public void setPurgeRequestDate​(String purgeRequestDate)
        setPurgeRequestDate.
      • purgeState

        public EnvelopeTemplate purgeState​(String purgeState)
        purgeState.
        Returns:
        EnvelopeTemplate
      • getPurgeState

        public String getPurgeState()
        .
        Returns:
        purgeState
      • setPurgeState

        public void setPurgeState​(String purgeState)
        setPurgeState.
      • getRecipients

        public Recipients getRecipients()
        An array of recipient objects that provides details about the recipients of the envelope..
        Returns:
        recipients
      • setRecipients

        public void setRecipients​(Recipients recipients)
        setRecipients.
      • recipientsLock

        public EnvelopeTemplate recipientsLock​(String recipientsLock)
        recipientsLock.
        Returns:
        EnvelopeTemplate
      • 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 EnvelopeTemplate recipientsUri​(String recipientsUri)
        recipientsUri.
        Returns:
        EnvelopeTemplate
      • 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.
      • sentDateTime

        public EnvelopeTemplate sentDateTime​(String sentDateTime)
        sentDateTime.
        Returns:
        EnvelopeTemplate
      • getSentDateTime

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

        public void setSentDateTime​(String sentDateTime)
        setSentDateTime.
      • getShared

        public String getShared()
        When set to **true**, this custom tab is shared..
        Returns:
        shared
      • setShared

        public void setShared​(String shared)
        setShared.
      • signerCanSignOnMobile

        public EnvelopeTemplate signerCanSignOnMobile​(String signerCanSignOnMobile)
        signerCanSignOnMobile.
        Returns:
        EnvelopeTemplate
      • getSignerCanSignOnMobile

        public String getSignerCanSignOnMobile()
        .
        Returns:
        signerCanSignOnMobile
      • setSignerCanSignOnMobile

        public void setSignerCanSignOnMobile​(String signerCanSignOnMobile)
        setSignerCanSignOnMobile.
      • signingLocation

        public EnvelopeTemplate signingLocation​(String signingLocation)
        signingLocation.
        Returns:
        EnvelopeTemplate
      • 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 EnvelopeTemplate statusChangedDateTime​(String statusChangedDateTime)
        statusChangedDateTime.
        Returns:
        EnvelopeTemplate
      • getStatusChangedDateTime

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

        public void setStatusChangedDateTime​(String statusChangedDateTime)
        setStatusChangedDateTime.
      • statusDateTime

        public EnvelopeTemplate statusDateTime​(String statusDateTime)
        statusDateTime.
        Returns:
        EnvelopeTemplate
      • getStatusDateTime

        public String getStatusDateTime()
        .
        Returns:
        statusDateTime
      • setStatusDateTime

        public void setStatusDateTime​(String statusDateTime)
        setStatusDateTime.
      • templateId

        public EnvelopeTemplate templateId​(String templateId)
        templateId.
        Returns:
        EnvelopeTemplate
      • getTemplateId

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

        public void setTemplateId​(String templateId)
        setTemplateId.
      • templatesUri

        public EnvelopeTemplate templatesUri​(String templatesUri)
        templatesUri.
        Returns:
        EnvelopeTemplate
      • 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 EnvelopeTemplate transactionId​(String transactionId)
        transactionId.
        Returns:
        EnvelopeTemplate
      • 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.
      • getUri

        public String getUri()
        .
        Returns:
        uri
      • setUri

        public void setUri​(String uri)
        setUri.
      • useDisclosure

        public EnvelopeTemplate useDisclosure​(String useDisclosure)
        useDisclosure.
        Returns:
        EnvelopeTemplate
      • 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 EnvelopeTemplate voidedDateTime​(String voidedDateTime)
        voidedDateTime.
        Returns:
        EnvelopeTemplate
      • 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 EnvelopeTemplate voidedReason​(String voidedReason)
        voidedReason.
        Returns:
        EnvelopeTemplate
      • 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.
        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