com.docusign.esign.model.EnvelopeSummary Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of docusign-esign-java Show documentation
Show all versions of docusign-esign-java Show documentation
The official Docusign eSignature JAVA client is based on version 2.1 of the Docusign REST API and provides libraries for JAVA application integration. It is recommended that you use this version of the library for new development.
package com.docusign.esign.model;
import com.fasterxml.jackson.annotation.JsonProperty;
import io.swagger.v3.oas.annotations.media.Schema;
import java.util.Objects;
/** This object describes an envelope.. */
@Schema(description = " This object describes an envelope.")
public class EnvelopeSummary {
@JsonProperty("bulkEnvelopeStatus")
private BulkEnvelopeStatus bulkEnvelopeStatus = null;
@JsonProperty("envelopeId")
private String envelopeId = null;
@JsonProperty("errorDetails")
private ErrorDetails errorDetails = null;
@JsonProperty("recipientSigningUri")
private String recipientSigningUri = null;
@JsonProperty("recipientSigningUriError")
private String recipientSigningUriError = null;
@JsonProperty("status")
private String status = null;
@JsonProperty("statusDateTime")
private String statusDateTime = null;
@JsonProperty("uri")
private String uri = null;
/**
* bulkEnvelopeStatus.
*
* @return EnvelopeSummary
*/
public EnvelopeSummary bulkEnvelopeStatus(BulkEnvelopeStatus bulkEnvelopeStatus) {
this.bulkEnvelopeStatus = bulkEnvelopeStatus;
return this;
}
/**
* An object that describes the status of the bulk send envelopes..
*
* @return bulkEnvelopeStatus
*/
@Schema(description = "An object that describes the status of the bulk send envelopes.")
public BulkEnvelopeStatus getBulkEnvelopeStatus() {
return bulkEnvelopeStatus;
}
/** setBulkEnvelopeStatus. */
public void setBulkEnvelopeStatus(BulkEnvelopeStatus bulkEnvelopeStatus) {
this.bulkEnvelopeStatus = bulkEnvelopeStatus;
}
/**
* envelopeId.
*
* @return EnvelopeSummary
*/
public EnvelopeSummary envelopeId(String envelopeId) {
this.envelopeId = envelopeId;
return this;
}
/**
* The envelope ID of the envelope status that failed to post..
*
* @return envelopeId
*/
@Schema(description = "The envelope ID of the envelope status that failed to post.")
public String getEnvelopeId() {
return envelopeId;
}
/** setEnvelopeId. */
public void setEnvelopeId(String envelopeId) {
this.envelopeId = envelopeId;
}
/**
* errorDetails.
*
* @return EnvelopeSummary
*/
public EnvelopeSummary errorDetails(ErrorDetails errorDetails) {
this.errorDetails = errorDetails;
return this;
}
/**
* Array or errors..
*
* @return errorDetails
*/
@Schema(description = "Array or errors.")
public ErrorDetails getErrorDetails() {
return errorDetails;
}
/** setErrorDetails. */
public void setErrorDetails(ErrorDetails errorDetails) {
this.errorDetails = errorDetails;
}
/**
* recipientSigningUri.
*
* @return EnvelopeSummary
*/
public EnvelopeSummary recipientSigningUri(String recipientSigningUri) {
this.recipientSigningUri = recipientSigningUri;
return this;
}
/**
* .
*
* @return recipientSigningUri
*/
@Schema(description = "")
public String getRecipientSigningUri() {
return recipientSigningUri;
}
/** setRecipientSigningUri. */
public void setRecipientSigningUri(String recipientSigningUri) {
this.recipientSigningUri = recipientSigningUri;
}
/**
* recipientSigningUriError.
*
* @return EnvelopeSummary
*/
public EnvelopeSummary recipientSigningUriError(String recipientSigningUriError) {
this.recipientSigningUriError = recipientSigningUriError;
return this;
}
/**
* .
*
* @return recipientSigningUriError
*/
@Schema(description = "")
public String getRecipientSigningUriError() {
return recipientSigningUriError;
}
/** setRecipientSigningUriError. */
public void setRecipientSigningUriError(String recipientSigningUriError) {
this.recipientSigningUriError = recipientSigningUriError;
}
/**
* status.
*
* @return EnvelopeSummary
*/
public EnvelopeSummary status(String status) {
this.status = status;
return this;
}
/**
* 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..
*
* @return status
*/
@Schema(
description =
"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.")
public String getStatus() {
return status;
}
/** setStatus. */
public void setStatus(String status) {
this.status = status;
}
/**
* statusDateTime.
*
* @return EnvelopeSummary
*/
public EnvelopeSummary statusDateTime(String statusDateTime) {
this.statusDateTime = statusDateTime;
return this;
}
/**
* The DateTime that the envelope changed status (i.e. was created or sent.).
*
* @return statusDateTime
*/
@Schema(description = "The DateTime that the envelope changed status (i.e. was created or sent.)")
public String getStatusDateTime() {
return statusDateTime;
}
/** setStatusDateTime. */
public void setStatusDateTime(String statusDateTime) {
this.statusDateTime = statusDateTime;
}
/**
* uri.
*
* @return EnvelopeSummary
*/
public EnvelopeSummary uri(String uri) {
this.uri = uri;
return this;
}
/**
* .
*
* @return uri
*/
@Schema(description = "")
public String getUri() {
return uri;
}
/** setUri. */
public void setUri(String uri) {
this.uri = uri;
}
/**
* Compares objects.
*
* @return true or false depending on comparison result.
*/
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
EnvelopeSummary envelopeSummary = (EnvelopeSummary) o;
return Objects.equals(this.bulkEnvelopeStatus, envelopeSummary.bulkEnvelopeStatus)
&& Objects.equals(this.envelopeId, envelopeSummary.envelopeId)
&& Objects.equals(this.errorDetails, envelopeSummary.errorDetails)
&& Objects.equals(this.recipientSigningUri, envelopeSummary.recipientSigningUri)
&& Objects.equals(this.recipientSigningUriError, envelopeSummary.recipientSigningUriError)
&& Objects.equals(this.status, envelopeSummary.status)
&& Objects.equals(this.statusDateTime, envelopeSummary.statusDateTime)
&& Objects.equals(this.uri, envelopeSummary.uri);
}
/** Returns the HashCode. */
@Override
public int hashCode() {
return Objects.hash(
bulkEnvelopeStatus,
envelopeId,
errorDetails,
recipientSigningUri,
recipientSigningUriError,
status,
statusDateTime,
uri);
}
/** Converts the given object to string. */
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class EnvelopeSummary {\n");
sb.append(" bulkEnvelopeStatus: ").append(toIndentedString(bulkEnvelopeStatus)).append("\n");
sb.append(" envelopeId: ").append(toIndentedString(envelopeId)).append("\n");
sb.append(" errorDetails: ").append(toIndentedString(errorDetails)).append("\n");
sb.append(" recipientSigningUri: ")
.append(toIndentedString(recipientSigningUri))
.append("\n");
sb.append(" recipientSigningUriError: ")
.append(toIndentedString(recipientSigningUriError))
.append("\n");
sb.append(" status: ").append(toIndentedString(status)).append("\n");
sb.append(" statusDateTime: ").append(toIndentedString(statusDateTime)).append("\n");
sb.append(" uri: ").append(toIndentedString(uri)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces (except the first line).
*/
private String toIndentedString(java.lang.Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}