Package com.docusign.esign.model
Class BulkEnvelope
- java.lang.Object
-
- com.docusign.esign.model.BulkEnvelope
-
- All Implemented Interfaces:
Serializable
public class BulkEnvelope extends Object implements Serializable
BulkEnvelope.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description BulkEnvelope()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BulkEnvelopebulkRecipientRow(String bulkRecipientRow)bulkRecipientRow.BulkEnvelopebulkStatus(String bulkStatus)bulkStatus.BulkEnvelopeemail(String email)email.BulkEnvelopeenvelopeId(String envelopeId)envelopeId.BulkEnvelopeenvelopeUri(String envelopeUri)envelopeUri.booleanequals(Object o)Compares objects.BulkEnvelopeerrorDetails(ErrorDetails errorDetails)errorDetails.StringgetBulkRecipientRow()Reserved: TBD.StringgetBulkStatus()Indicates the status of the bulk send operation.StringgetEmail().StringgetEnvelopeId()The envelope ID of the envelope status that failed to post..StringgetEnvelopeUri()Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes..ErrorDetailsgetErrorDetails()Array or errors..StringgetName().StringgetSubmittedDateTime().StringgetTransactionId()Used to identify an envelope.inthashCode()Returns the HashCode.BulkEnvelopename(String name)name.voidsetBulkRecipientRow(String bulkRecipientRow)setBulkRecipientRow.voidsetBulkStatus(String bulkStatus)setBulkStatus.voidsetEmail(String email)setEmail.voidsetEnvelopeId(String envelopeId)setEnvelopeId.voidsetEnvelopeUri(String envelopeUri)setEnvelopeUri.voidsetErrorDetails(ErrorDetails errorDetails)setErrorDetails.voidsetName(String name)setName.voidsetSubmittedDateTime(String submittedDateTime)setSubmittedDateTime.voidsetTransactionId(String transactionId)setTransactionId.BulkEnvelopesubmittedDateTime(String submittedDateTime)submittedDateTime.StringtoString()Converts the given object to string.BulkEnvelopetransactionId(String transactionId)transactionId.
-
-
-
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.
-
email
public BulkEnvelope email(String email)
email.- Returns:
- BulkEnvelope
-
getEmail
public String getEmail()
.- Returns:
-
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.
-
errorDetails
public BulkEnvelope errorDetails(ErrorDetails errorDetails)
errorDetails.- Returns:
- BulkEnvelope
-
getErrorDetails
public ErrorDetails getErrorDetails()
Array or errors..- Returns:
- errorDetails
-
setErrorDetails
public void setErrorDetails(ErrorDetails errorDetails)
setErrorDetails.
-
name
public BulkEnvelope name(String name)
name.- Returns:
- BulkEnvelope
-
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.
-
-