Package com.docusign.esign.model

Class EnvelopeTemplate

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

    • Constructor Detail

      • EnvelopeTemplate

        public EnvelopeTemplate()

    • Method Detail

      • accessControlListBase64

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

      • getAccessControlListBase64

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

      • setAccessControlListBase64

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

      • allowComments

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

      • getAllowComments

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

      • setAllowComments

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

      • allowMarkup

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

      • 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 EnvelopeTemplate allowReassign​(java.lang.String allowReassign)
        allowReassign.
        Returns:
        EnvelopeTemplate

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

      • allowViewHistory

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

      • getAllowViewHistory

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

      • setAllowViewHistory

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

      • anySigner

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

      • getAnySigner

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

      • setAnySigner

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

      • asynchronous

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

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

      • attachmentsUri

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

      • getAttachmentsUri

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

      • setAttachmentsUri

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

      • authoritativeCopy

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

      • 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 EnvelopeTemplate authoritativeCopyDefault​(java.lang.String authoritativeCopyDefault)
        authoritativeCopyDefault.
        Returns:
        EnvelopeTemplate

      • getAuthoritativeCopyDefault

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

      • setAuthoritativeCopyDefault

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

      • autoMatch

        public EnvelopeTemplate autoMatch​(java.lang.String autoMatch)
        autoMatch.
        Returns:
        EnvelopeTemplate

      • getAutoMatch

        public java.lang.String getAutoMatch()
        .
        Returns:
        autoMatch

      • setAutoMatch

        public void setAutoMatch​(java.lang.String autoMatch)
        setAutoMatch.

      • autoMatchSpecifiedByUser

        public EnvelopeTemplate autoMatchSpecifiedByUser​(java.lang.String autoMatchSpecifiedByUser)
        autoMatchSpecifiedByUser.
        Returns:
        EnvelopeTemplate

      • getAutoMatchSpecifiedByUser

        public java.lang.String getAutoMatchSpecifiedByUser()
        .
        Returns:
        autoMatchSpecifiedByUser

      • setAutoMatchSpecifiedByUser

        public void setAutoMatchSpecifiedByUser​(java.lang.String autoMatchSpecifiedByUser)
        setAutoMatchSpecifiedByUser.

      • autoNavigation

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

      • getAutoNavigation

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

      • setAutoNavigation

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

      • brandId

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

      • getBrandId

        public java.lang.String getBrandId()
        .
        Returns:
        brandId

      • setBrandId

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

      • brandLock

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

      • getBrandLock

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

      • setBrandLock

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

      • certificateUri

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

      • 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 EnvelopeTemplate completedDateTime​(java.lang.String completedDateTime)
        completedDateTime.
        Returns:
        EnvelopeTemplate

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

      • copyRecipientData

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

      • getCopyRecipientData

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

      • setCopyRecipientData

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

      • created

        public EnvelopeTemplate created​(java.lang.String created)
        created.
        Returns:
        EnvelopeTemplate

      • getCreated

        public java.lang.String getCreated()
        .
        Returns:
        created

      • setCreated

        public void setCreated​(java.lang.String created)
        setCreated.

      • createdDateTime

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

      • 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 EnvelopeTemplate customFieldsUri​(java.lang.String customFieldsUri)
        customFieldsUri.
        Returns:
        EnvelopeTemplate

      • 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 EnvelopeTemplate declinedDateTime​(java.lang.String declinedDateTime)
        declinedDateTime.
        Returns:
        EnvelopeTemplate

      • 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 EnvelopeTemplate deletedDateTime​(java.lang.String deletedDateTime)
        deletedDateTime.
        Returns:
        EnvelopeTemplate

      • 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 EnvelopeTemplate deliveredDateTime​(java.lang.String deliveredDateTime)
        deliveredDateTime.
        Returns:
        EnvelopeTemplate

      • getDeliveredDateTime

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

      • setDeliveredDateTime

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

      • description

        public EnvelopeTemplate description​(java.lang.String description)
        description.
        Returns:
        EnvelopeTemplate

      • getDescription

        public java.lang.String getDescription()
        .
        Returns:
        description

      • setDescription

        public void setDescription​(java.lang.String description)
        setDescription.

      • disableResponsiveDocument

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

      • getDisableResponsiveDocument

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

      • setDisableResponsiveDocument

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

      • documentBase64

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

      • getDocumentBase64

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

      • setDocumentBase64

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

      • documents

        public EnvelopeTemplate documents​(java.util.List<Document> documents)
        documents.
        Returns:
        EnvelopeTemplate

      • addDocumentsItem

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

      • 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 EnvelopeTemplate documentsCombinedUri​(java.lang.String documentsCombinedUri)
        documentsCombinedUri.
        Returns:
        EnvelopeTemplate

      • getDocumentsCombinedUri

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

      • setDocumentsCombinedUri

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

      • documentsUri

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

      • 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 EnvelopeTemplate emailBlurb​(java.lang.String emailBlurb)
        emailBlurb.
        Returns:
        EnvelopeTemplate

      • getEmailBlurb

        public java.lang.String getEmailBlurb()
        .
        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 EnvelopeTemplate emailSubject​(java.lang.String emailSubject)
        emailSubject.
        Returns:
        EnvelopeTemplate

      • 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 EnvelopeTemplate enableWetSign​(java.lang.String enableWetSign)
        enableWetSign.
        Returns:
        EnvelopeTemplate

      • 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 EnvelopeTemplate enforceSignerVisibility​(java.lang.String enforceSignerVisibility)
        enforceSignerVisibility.
        Returns:
        EnvelopeTemplate

      • 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 EnvelopeTemplate envelopeAttachments​(java.util.List<Attachment> envelopeAttachments)
        envelopeAttachments.
        Returns:
        EnvelopeTemplate

      • addEnvelopeAttachmentsItem

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

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

      • envelopeDocuments

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

      • addEnvelopeDocumentsItem

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

      • getEnvelopeDocuments

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

      • setEnvelopeDocuments

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

      • envelopeId

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

      • 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 EnvelopeTemplate envelopeIdStamping​(java.lang.String envelopeIdStamping)
        envelopeIdStamping.
        Returns:
        EnvelopeTemplate

      • 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 EnvelopeTemplate envelopeLocation​(java.lang.String envelopeLocation)
        envelopeLocation.
        Returns:
        EnvelopeTemplate

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

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

      • expireAfter

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

      • getExpireAfter

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

      • setExpireAfter

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

      • expireDateTime

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

      • getExpireDateTime

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

      • setExpireDateTime

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

      • expireEnabled

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

      • getExpireEnabled

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

      • setExpireEnabled

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

      • externalEnvelopeId

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

      • getExternalEnvelopeId

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

      • setExternalEnvelopeId

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

      • favoritedByMe

        public EnvelopeTemplate favoritedByMe​(java.lang.String favoritedByMe)
        favoritedByMe.
        Returns:
        EnvelopeTemplate

      • getFavoritedByMe

        public java.lang.String getFavoritedByMe()
        .
        Returns:
        favoritedByMe

      • setFavoritedByMe

        public void setFavoritedByMe​(java.lang.String favoritedByMe)
        setFavoritedByMe.

      • folderId

        public EnvelopeTemplate folderId​(java.lang.String folderId)
        folderId.
        Returns:
        EnvelopeTemplate

      • getFolderId

        public java.lang.String getFolderId()
        .
        Returns:
        folderId

      • setFolderId

        public void setFolderId​(java.lang.String folderId)
        setFolderId.

      • folderIds

        public EnvelopeTemplate folderIds​(java.util.List<java.lang.String> folderIds)
        folderIds.
        Returns:
        EnvelopeTemplate

      • addFolderIdsItem

        public EnvelopeTemplate addFolderIdsItem​(java.lang.String folderIdsItem)
        addFolderIdsItem.
        Returns:
        EnvelopeTemplate

      • getFolderIds

        public java.util.List<java.lang.String> getFolderIds()
        .
        Returns:
        folderIds

      • setFolderIds

        public void setFolderIds​(java.util.List<java.lang.String> folderIds)
        setFolderIds.

      • folderName

        public EnvelopeTemplate folderName​(java.lang.String folderName)
        folderName.
        Returns:
        EnvelopeTemplate

      • getFolderName

        public java.lang.String getFolderName()
        .
        Returns:
        folderName

      • setFolderName

        public void setFolderName​(java.lang.String folderName)
        setFolderName.

      • folders

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

      • addFoldersItem

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

      • getFolders

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

      • setFolders

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

      • hasComments

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

      • getHasComments

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

      • setHasComments

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

      • hasFormDataChanged

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

      • getHasFormDataChanged

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

      • setHasFormDataChanged

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

      • hasWavFile

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

      • getHasWavFile

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

      • setHasWavFile

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

      • holder

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

      • getHolder

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

      • setHolder

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

      • initialSentDateTime

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

      • getInitialSentDateTime

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

      • setInitialSentDateTime

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

      • is21CFRPart11

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

      • 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 EnvelopeTemplate isDynamicEnvelope​(java.lang.String isDynamicEnvelope)
        isDynamicEnvelope.
        Returns:
        EnvelopeTemplate

      • getIsDynamicEnvelope

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

      • setIsDynamicEnvelope

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

      • isSignatureProviderEnvelope

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

      • getIsSignatureProviderEnvelope

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

      • setIsSignatureProviderEnvelope

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

      • lastModified

        public EnvelopeTemplate lastModified​(java.lang.String lastModified)
        lastModified.
        Returns:
        EnvelopeTemplate

      • getLastModified

        public java.lang.String getLastModified()
        .
        Returns:
        lastModified

      • setLastModified

        public void setLastModified​(java.lang.String lastModified)
        setLastModified.

      • lastModifiedBy

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

      • getLastModifiedBy

        public UserInfo getLastModifiedBy()
        Get lastModifiedBy.
        Returns:
        lastModifiedBy

      • setLastModifiedBy

        public void setLastModifiedBy​(UserInfo lastModifiedBy)
        setLastModifiedBy.

      • lastModifiedDateTime

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

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

      • lastUsed

        public EnvelopeTemplate lastUsed​(java.lang.String lastUsed)
        lastUsed.
        Returns:
        EnvelopeTemplate

      • getLastUsed

        public java.lang.String getLastUsed()
        .
        Returns:
        lastUsed

      • setLastUsed

        public void setLastUsed​(java.lang.String lastUsed)
        setLastUsed.

      • location

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

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

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

      • name

        public EnvelopeTemplate name​(java.lang.String name)
        name.
        Returns:
        EnvelopeTemplate

      • getName

        public java.lang.String getName()
        .
        Returns:
        name

      • setName

        public void setName​(java.lang.String name)
        setName.

      • newPassword

        public EnvelopeTemplate newPassword​(java.lang.String newPassword)
        newPassword.
        Returns:
        EnvelopeTemplate

      • getNewPassword

        public java.lang.String getNewPassword()
        .
        Returns:
        newPassword

      • setNewPassword

        public void setNewPassword​(java.lang.String newPassword)
        setNewPassword.

      • getNotification

        public Notification getNotification()
        Get notification.
        Returns:
        notification

      • setNotification

        public void setNotification​(Notification notification)
        setNotification.

      • notificationUri

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

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

      • getOwner

        public UserInfo getOwner()
        Get owner.
        Returns:
        owner

      • setOwner

        public void setOwner​(UserInfo owner)
        setOwner.

      • pageCount

        public EnvelopeTemplate pageCount​(java.lang.String pageCount)
        pageCount.
        Returns:
        EnvelopeTemplate

      • getPageCount

        public java.lang.String getPageCount()
        .
        Returns:
        pageCount

      • setPageCount

        public void setPageCount​(java.lang.String pageCount)
        setPageCount.

      • password

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

      • getPassword

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

      • setPassword

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

      • passwordProtected

        public EnvelopeTemplate passwordProtected​(java.lang.String passwordProtected)
        passwordProtected.
        Returns:
        EnvelopeTemplate

      • getPasswordProtected

        public java.lang.String getPasswordProtected()
        .
        Returns:
        passwordProtected

      • setPasswordProtected

        public void setPasswordProtected​(java.lang.String passwordProtected)
        setPasswordProtected.

      • getPowerForm

        public PowerForm getPowerForm()
        Get powerForm.
        Returns:
        powerForm

      • setPowerForm

        public void setPowerForm​(PowerForm powerForm)
        setPowerForm.

      • powerForms

        public EnvelopeTemplate powerForms​(java.util.List<PowerForm> powerForms)
        powerForms.
        Returns:
        EnvelopeTemplate

      • addPowerFormsItem

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

      • getPowerForms

        public java.util.List<PowerForm> getPowerForms()
        .
        Returns:
        powerForms

      • setPowerForms

        public void setPowerForms​(java.util.List<PowerForm> powerForms)
        setPowerForms.

      • purgeCompletedDate

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

      • getPurgeCompletedDate

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

      • setPurgeCompletedDate

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

      • purgeRequestDate

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

      • getPurgeRequestDate

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

      • setPurgeRequestDate

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

      • purgeState

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

      • getPurgeState

        public java.lang.String getPurgeState()
        .
        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 EnvelopeTemplate recipientsLock​(java.lang.String recipientsLock)
        recipientsLock.
        Returns:
        EnvelopeTemplate

      • 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 EnvelopeTemplate recipientsUri​(java.lang.String recipientsUri)
        recipientsUri.
        Returns:
        EnvelopeTemplate

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

      • getSender

        public UserInfo getSender()
        Get sender.
        Returns:
        sender

      • setSender

        public void setSender​(UserInfo sender)
        setSender.

      • sentDateTime

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

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

      • shared

        public EnvelopeTemplate shared​(java.lang.String shared)
        shared.
        Returns:
        EnvelopeTemplate

      • getShared

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

      • setShared

        public void setShared​(java.lang.String shared)
        setShared.

      • signerCanSignOnMobile

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

      • getSignerCanSignOnMobile

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

      • setSignerCanSignOnMobile

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

      • signingLocation

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

      • 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 EnvelopeTemplate status​(java.lang.String status)
        status.
        Returns:
        EnvelopeTemplate

      • 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 EnvelopeTemplate statusChangedDateTime​(java.lang.String statusChangedDateTime)
        statusChangedDateTime.
        Returns:
        EnvelopeTemplate

      • 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 EnvelopeTemplate statusDateTime​(java.lang.String statusDateTime)
        statusDateTime.
        Returns:
        EnvelopeTemplate

      • getStatusDateTime

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

      • setStatusDateTime

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

      • templateId

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

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

      • templatesUri

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

      • 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 EnvelopeTemplate transactionId​(java.lang.String transactionId)
        transactionId.
        Returns:
        EnvelopeTemplate

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

      • uri

        public EnvelopeTemplate uri​(java.lang.String uri)
        uri.
        Returns:
        EnvelopeTemplate

      • getUri

        public java.lang.String getUri()
        .
        Returns:
        uri

      • setUri

        public void setUri​(java.lang.String uri)
        setUri.

      • useDisclosure

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

      • 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 EnvelopeTemplate voidedDateTime​(java.lang.String voidedDateTime)
        voidedDateTime.
        Returns:
        EnvelopeTemplate

      • 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 EnvelopeTemplate voidedReason​(java.lang.String voidedReason)
        voidedReason.
        Returns:
        EnvelopeTemplate

      • 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