com.docusign.esign.model.EnvelopeUpdateSummary 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.io.Serializable;
import java.util.Objects;
/** EnvelopeUpdateSummary. */
public class EnvelopeUpdateSummary implements Serializable {
private static final long serialVersionUID = 1L;
@JsonProperty("bulkEnvelopeStatus")
private BulkEnvelopeStatus bulkEnvelopeStatus = null;
@JsonProperty("envelopeId")
private String envelopeId = null;
@JsonProperty("errorDetails")
private ErrorDetails errorDetails = null;
@JsonProperty("listCustomFieldUpdateResults")
private java.util.List listCustomFieldUpdateResults = null;
@JsonProperty("lockInformation")
private LockInformation lockInformation = null;
@JsonProperty("purgeState")
private String purgeState = null;
@JsonProperty("recipientUpdateResults")
private java.util.List recipientUpdateResults = null;
@JsonProperty("tabUpdateResults")
private Tabs tabUpdateResults = null;
@JsonProperty("textCustomFieldUpdateResults")
private java.util.List textCustomFieldUpdateResults = null;
/**
* bulkEnvelopeStatus.
*
* @return EnvelopeUpdateSummary
*/
public EnvelopeUpdateSummary 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 EnvelopeUpdateSummary
*/
public EnvelopeUpdateSummary 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 EnvelopeUpdateSummary
*/
public EnvelopeUpdateSummary 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;
}
/**
* listCustomFieldUpdateResults.
*
* @return EnvelopeUpdateSummary
*/
public EnvelopeUpdateSummary listCustomFieldUpdateResults(
java.util.List listCustomFieldUpdateResults) {
this.listCustomFieldUpdateResults = listCustomFieldUpdateResults;
return this;
}
/**
* addListCustomFieldUpdateResultsItem.
*
* @return EnvelopeUpdateSummary
*/
public EnvelopeUpdateSummary addListCustomFieldUpdateResultsItem(
ListCustomField listCustomFieldUpdateResultsItem) {
if (this.listCustomFieldUpdateResults == null) {
this.listCustomFieldUpdateResults = new java.util.ArrayList<>();
}
this.listCustomFieldUpdateResults.add(listCustomFieldUpdateResultsItem);
return this;
}
/**
* .
*
* @return listCustomFieldUpdateResults
*/
@Schema(description = "")
public java.util.List getListCustomFieldUpdateResults() {
return listCustomFieldUpdateResults;
}
/** setListCustomFieldUpdateResults. */
public void setListCustomFieldUpdateResults(
java.util.List listCustomFieldUpdateResults) {
this.listCustomFieldUpdateResults = listCustomFieldUpdateResults;
}
/**
* lockInformation.
*
* @return EnvelopeUpdateSummary
*/
public EnvelopeUpdateSummary lockInformation(LockInformation lockInformation) {
this.lockInformation = lockInformation;
return this;
}
/**
* Provides lock information about an envelope that a user has locked..
*
* @return lockInformation
*/
@Schema(description = "Provides lock information about an envelope that a user has locked.")
public LockInformation getLockInformation() {
return lockInformation;
}
/** setLockInformation. */
public void setLockInformation(LockInformation lockInformation) {
this.lockInformation = lockInformation;
}
/**
* purgeState.
*
* @return EnvelopeUpdateSummary
*/
public EnvelopeUpdateSummary purgeState(String purgeState) {
this.purgeState = purgeState;
return this;
}
/**
* .
*
* @return purgeState
*/
@Schema(description = "")
public String getPurgeState() {
return purgeState;
}
/** setPurgeState. */
public void setPurgeState(String purgeState) {
this.purgeState = purgeState;
}
/**
* recipientUpdateResults.
*
* @return EnvelopeUpdateSummary
*/
public EnvelopeUpdateSummary recipientUpdateResults(
java.util.List recipientUpdateResults) {
this.recipientUpdateResults = recipientUpdateResults;
return this;
}
/**
* addRecipientUpdateResultsItem.
*
* @return EnvelopeUpdateSummary
*/
public EnvelopeUpdateSummary addRecipientUpdateResultsItem(
RecipientUpdateResponse recipientUpdateResultsItem) {
if (this.recipientUpdateResults == null) {
this.recipientUpdateResults = new java.util.ArrayList<>();
}
this.recipientUpdateResults.add(recipientUpdateResultsItem);
return this;
}
/**
* .
*
* @return recipientUpdateResults
*/
@Schema(description = "")
public java.util.List getRecipientUpdateResults() {
return recipientUpdateResults;
}
/** setRecipientUpdateResults. */
public void setRecipientUpdateResults(
java.util.List recipientUpdateResults) {
this.recipientUpdateResults = recipientUpdateResults;
}
/**
* tabUpdateResults.
*
* @return EnvelopeUpdateSummary
*/
public EnvelopeUpdateSummary tabUpdateResults(Tabs tabUpdateResults) {
this.tabUpdateResults = tabUpdateResults;
return this;
}
/**
* .
*
* @return tabUpdateResults
*/
@Schema(description = "")
public Tabs getTabUpdateResults() {
return tabUpdateResults;
}
/** setTabUpdateResults. */
public void setTabUpdateResults(Tabs tabUpdateResults) {
this.tabUpdateResults = tabUpdateResults;
}
/**
* textCustomFieldUpdateResults.
*
* @return EnvelopeUpdateSummary
*/
public EnvelopeUpdateSummary textCustomFieldUpdateResults(
java.util.List textCustomFieldUpdateResults) {
this.textCustomFieldUpdateResults = textCustomFieldUpdateResults;
return this;
}
/**
* addTextCustomFieldUpdateResultsItem.
*
* @return EnvelopeUpdateSummary
*/
public EnvelopeUpdateSummary addTextCustomFieldUpdateResultsItem(
TextCustomField textCustomFieldUpdateResultsItem) {
if (this.textCustomFieldUpdateResults == null) {
this.textCustomFieldUpdateResults = new java.util.ArrayList<>();
}
this.textCustomFieldUpdateResults.add(textCustomFieldUpdateResultsItem);
return this;
}
/**
* .
*
* @return textCustomFieldUpdateResults
*/
@Schema(description = "")
public java.util.List getTextCustomFieldUpdateResults() {
return textCustomFieldUpdateResults;
}
/** setTextCustomFieldUpdateResults. */
public void setTextCustomFieldUpdateResults(
java.util.List textCustomFieldUpdateResults) {
this.textCustomFieldUpdateResults = textCustomFieldUpdateResults;
}
/**
* 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;
}
EnvelopeUpdateSummary envelopeUpdateSummary = (EnvelopeUpdateSummary) o;
return Objects.equals(this.bulkEnvelopeStatus, envelopeUpdateSummary.bulkEnvelopeStatus)
&& Objects.equals(this.envelopeId, envelopeUpdateSummary.envelopeId)
&& Objects.equals(this.errorDetails, envelopeUpdateSummary.errorDetails)
&& Objects.equals(
this.listCustomFieldUpdateResults, envelopeUpdateSummary.listCustomFieldUpdateResults)
&& Objects.equals(this.lockInformation, envelopeUpdateSummary.lockInformation)
&& Objects.equals(this.purgeState, envelopeUpdateSummary.purgeState)
&& Objects.equals(this.recipientUpdateResults, envelopeUpdateSummary.recipientUpdateResults)
&& Objects.equals(this.tabUpdateResults, envelopeUpdateSummary.tabUpdateResults)
&& Objects.equals(
this.textCustomFieldUpdateResults, envelopeUpdateSummary.textCustomFieldUpdateResults);
}
/** Returns the HashCode. */
@Override
public int hashCode() {
return Objects.hash(
bulkEnvelopeStatus,
envelopeId,
errorDetails,
listCustomFieldUpdateResults,
lockInformation,
purgeState,
recipientUpdateResults,
tabUpdateResults,
textCustomFieldUpdateResults);
}
/** Converts the given object to string. */
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class EnvelopeUpdateSummary {\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(" listCustomFieldUpdateResults: ")
.append(toIndentedString(listCustomFieldUpdateResults))
.append("\n");
sb.append(" lockInformation: ").append(toIndentedString(lockInformation)).append("\n");
sb.append(" purgeState: ").append(toIndentedString(purgeState)).append("\n");
sb.append(" recipientUpdateResults: ")
.append(toIndentedString(recipientUpdateResults))
.append("\n");
sb.append(" tabUpdateResults: ").append(toIndentedString(tabUpdateResults)).append("\n");
sb.append(" textCustomFieldUpdateResults: ")
.append(toIndentedString(textCustomFieldUpdateResults))
.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 ");
}
}