Package com.docusign.esign.model

Class BulkEnvelope

  • public class BulkEnvelope
extends Object
    BulkEnvelope.

    • Constructor Detail

      • BulkEnvelope

        public BulkEnvelope()

    • Method Detail

      • bulkRecipientRow

        public BulkEnvelope bulkRecipientRow​(String bulkRecipientRow)
        bulkRecipientRow.
        Returns:
        BulkEnvelope

      • getBulkRecipientRow

        public String getBulkRecipientRow()
        Reserved: TBD.
        Returns:
        bulkRecipientRow

      • setBulkRecipientRow

        public void setBulkRecipientRow​(String bulkRecipientRow)
        setBulkRecipientRow.

      • bulkStatus

        public BulkEnvelope bulkStatus​(String bulkStatus)
        bulkStatus.
        Returns:
        BulkEnvelope

      • getBulkStatus

        public String getBulkStatus()
        Indicates the status of the bulk send operation. Returned values can be: * queued * processing * sent * failed.
        Returns:
        bulkStatus

      • setBulkStatus

        public void setBulkStatus​(String bulkStatus)
        setBulkStatus.

      • getEmail

        public String getEmail()
        .
        Returns:
        email

      • setEmail

        public void setEmail​(String email)
        setEmail.

      • envelopeId

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

      • getEnvelopeId

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

      • setEnvelopeId

        public void setEnvelopeId​(String envelopeId)
        setEnvelopeId.

      • envelopeUri

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

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

      • getErrorDetails

        public ErrorDetails getErrorDetails()
        This object describes errors that occur. It is only valid for responses and ignored in requests..
        Returns:
        errorDetails

      • setErrorDetails

        public void setErrorDetails​(ErrorDetails errorDetails)
        setErrorDetails.

      • getName

        public String getName()
        .
        Returns:
        name

      • setName

        public void setName​(String name)
        setName.

      • submittedDateTime

        public BulkEnvelope submittedDateTime​(String submittedDateTime)
        submittedDateTime.
        Returns:
        BulkEnvelope

      • getSubmittedDateTime

        public String getSubmittedDateTime()
        .
        Returns:
        submittedDateTime

      • setSubmittedDateTime

        public void setSubmittedDateTime​(String submittedDateTime)
        setSubmittedDateTime.

      • transactionId

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

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

      • 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