Package com.docusign.esign.model

Class EnvelopeTemplateResult

  • public class EnvelopeTemplateResult
extends java.lang.Object
    EnvelopeTemplateResult

    • Constructor Detail

      • EnvelopeTemplateResult

        public EnvelopeTemplateResult()

    • Method Detail

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

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

      • getAllowViewHistory

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

      • setAllowViewHistory

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

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

      • getAttachmentsUri

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

      • setAttachmentsUri

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

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

      • authoritativeCopyDefault

        public EnvelopeTemplateResult authoritativeCopyDefault​(java.lang.String authoritativeCopyDefault)

      • getAuthoritativeCopyDefault

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

      • setAuthoritativeCopyDefault

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

      • getAutoNavigation

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

      • setAutoNavigation

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

      • getBrandId

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

      • setBrandId

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

      • getBrandLock

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

      • setBrandLock

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

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

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

      • getCreated

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

      • setCreated

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

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

      • getCustomFields

        public CustomFields getCustomFields()
        Get customFields
        Returns:
        customFields

      • setCustomFields

        public void setCustomFields​(CustomFields customFields)

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

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

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

      • getDeliveredDateTime

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

      • setDeliveredDateTime

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

      • getDescription

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

      • setDescription

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

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

      • documentsCombinedUri

        public EnvelopeTemplateResult documentsCombinedUri​(java.lang.String documentsCombinedUri)

      • getDocumentsCombinedUri

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

      • setDocumentsCombinedUri

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

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

      • getEmailBlurb

        public java.lang.String getEmailBlurb()
        Returns:
        emailBlurb

      • setEmailBlurb

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

      • getEmailSettings

        public EmailSettings getEmailSettings()
        Get emailSettings
        Returns:
        emailSettings

      • setEmailSettings

        public void setEmailSettings​(EmailSettings emailSettings)

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

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

      • enforceSignerVisibility

        public EnvelopeTemplateResult enforceSignerVisibility​(java.lang.String enforceSignerVisibility)

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

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

      • envelopeIdStamping

        public EnvelopeTemplateResult envelopeIdStamping​(java.lang.String envelopeIdStamping)

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

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

      • getFolderId

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

      • setFolderId

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

      • getFolderName

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

      • setFolderName

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

      • getFolderUri

        public java.lang.String getFolderUri()
        Returns:
        folderUri

      • setFolderUri

        public void setFolderUri​(java.lang.String folderUri)

      • initialSentDateTime

        public EnvelopeTemplateResult initialSentDateTime​(java.lang.String initialSentDateTime)

      • getInitialSentDateTime

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

      • setInitialSentDateTime

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

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

      • isSignatureProviderEnvelope

        public EnvelopeTemplateResult isSignatureProviderEnvelope​(java.lang.String isSignatureProviderEnvelope)

      • getIsSignatureProviderEnvelope

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

      • setIsSignatureProviderEnvelope

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

      • getLastModified

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

      • setLastModified

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

      • lastModifiedDateTime

        public EnvelopeTemplateResult lastModifiedDateTime​(java.lang.String lastModifiedDateTime)

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

      • getLockInformation

        public LockInformation getLockInformation()
        Get lockInformation
        Returns:
        lockInformation

      • setLockInformation

        public void setLockInformation​(LockInformation lockInformation)

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

      • getName

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

      • setName

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

      • getNotification

        public Notification getNotification()
        Get notification
        Returns:
        notification

      • setNotification

        public void setNotification​(Notification notification)

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

      • getOwner

        public UserInfo getOwner()
        Get owner
        Returns:
        owner

      • setOwner

        public void setOwner​(UserInfo owner)

      • getPageCount

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

      • setPageCount

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

      • getParentFolderUri

        public java.lang.String getParentFolderUri()
        Returns:
        parentFolderUri

      • setParentFolderUri

        public void setParentFolderUri​(java.lang.String parentFolderUri)

      • getPassword

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

      • setPassword

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

      • getPurgeState

        public java.lang.String getPurgeState()
        Returns:
        purgeState

      • setPurgeState

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

      • getRecipients

        public Recipients getRecipients()
        Get recipients
        Returns:
        recipients

      • setRecipients

        public void setRecipients​(Recipients recipients)

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

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

      • getSentDateTime

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

      • setSentDateTime

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

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

      • signerCanSignOnMobile

        public EnvelopeTemplateResult signerCanSignOnMobile​(java.lang.String signerCanSignOnMobile)

      • getSignerCanSignOnMobile

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

      • setSignerCanSignOnMobile

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

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

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

      • statusChangedDateTime

        public EnvelopeTemplateResult statusChangedDateTime​(java.lang.String statusChangedDateTime)

      • getStatusChangedDateTime

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

      • setStatusChangedDateTime

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

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

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

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

      • getUri

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

      • setUri

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

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

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

      • getVoidedReason

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

      • setVoidedReason

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

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

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

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object