com.docusign.esign.model.TemplateRecipients 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 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;
/** TemplateRecipients. */
public class TemplateRecipients {
@JsonProperty("agents")
private java.util.List agents = null;
@JsonProperty("carbonCopies")
private java.util.List carbonCopies = null;
@JsonProperty("certifiedDeliveries")
private java.util.List certifiedDeliveries = null;
@JsonProperty("currentRoutingOrder")
private String currentRoutingOrder = null;
@JsonProperty("editors")
private java.util.List editors = null;
@JsonProperty("errorDetails")
private ErrorDetails errorDetails = null;
@JsonProperty("inPersonSigners")
private java.util.List inPersonSigners = null;
@JsonProperty("intermediaries")
private java.util.List intermediaries = null;
@JsonProperty("notaries")
private java.util.List notaries = null;
@JsonProperty("participants")
private java.util.List participants = null;
@JsonProperty("recipientCount")
private String recipientCount = null;
@JsonProperty("seals")
private java.util.List seals = null;
@JsonProperty("signers")
private java.util.List signers = null;
@JsonProperty("witnesses")
private java.util.List witnesses = null;
/**
* agents.
*
* @return TemplateRecipients
*/
public TemplateRecipients agents(java.util.List agents) {
this.agents = agents;
return this;
}
/**
* addAgentsItem.
*
* @return TemplateRecipients
*/
public TemplateRecipients addAgentsItem(Agent agentsItem) {
if (this.agents == null) {
this.agents = new java.util.ArrayList<>();
}
this.agents.add(agentsItem);
return this;
}
/**
* A complex type defining the management and access rights of a recipient assigned assigned as an
* agent on the document..
*
* @return agents
*/
@Schema(
description =
"A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document.")
public java.util.List getAgents() {
return agents;
}
/** setAgents. */
public void setAgents(java.util.List agents) {
this.agents = agents;
}
/**
* carbonCopies.
*
* @return TemplateRecipients
*/
public TemplateRecipients carbonCopies(java.util.List carbonCopies) {
this.carbonCopies = carbonCopies;
return this;
}
/**
* addCarbonCopiesItem.
*
* @return TemplateRecipients
*/
public TemplateRecipients addCarbonCopiesItem(CarbonCopy carbonCopiesItem) {
if (this.carbonCopies == null) {
this.carbonCopies = new java.util.ArrayList<>();
}
this.carbonCopies.add(carbonCopiesItem);
return this;
}
/**
* A complex type containing information about recipients who should receive a copy of the
* envelope, but does not need to sign it..
*
* @return carbonCopies
*/
@Schema(
description =
"A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it.")
public java.util.List getCarbonCopies() {
return carbonCopies;
}
/** setCarbonCopies. */
public void setCarbonCopies(java.util.List carbonCopies) {
this.carbonCopies = carbonCopies;
}
/**
* certifiedDeliveries.
*
* @return TemplateRecipients
*/
public TemplateRecipients certifiedDeliveries(
java.util.List certifiedDeliveries) {
this.certifiedDeliveries = certifiedDeliveries;
return this;
}
/**
* addCertifiedDeliveriesItem.
*
* @return TemplateRecipients
*/
public TemplateRecipients addCertifiedDeliveriesItem(CertifiedDelivery certifiedDeliveriesItem) {
if (this.certifiedDeliveries == null) {
this.certifiedDeliveries = new java.util.ArrayList<>();
}
this.certifiedDeliveries.add(certifiedDeliveriesItem);
return this;
}
/**
* A complex type containing information on a recipient the must receive the completed documents
* for the envelope to be completed, but the recipient does not need to sign, initial, date, or
* add information to any of the documents..
*
* @return certifiedDeliveries
*/
@Schema(
description =
"A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.")
public java.util.List getCertifiedDeliveries() {
return certifiedDeliveries;
}
/** setCertifiedDeliveries. */
public void setCertifiedDeliveries(java.util.List certifiedDeliveries) {
this.certifiedDeliveries = certifiedDeliveries;
}
/**
* currentRoutingOrder.
*
* @return TemplateRecipients
*/
public TemplateRecipients currentRoutingOrder(String currentRoutingOrder) {
this.currentRoutingOrder = currentRoutingOrder;
return this;
}
/**
* .
*
* @return currentRoutingOrder
*/
@Schema(description = "")
public String getCurrentRoutingOrder() {
return currentRoutingOrder;
}
/** setCurrentRoutingOrder. */
public void setCurrentRoutingOrder(String currentRoutingOrder) {
this.currentRoutingOrder = currentRoutingOrder;
}
/**
* editors.
*
* @return TemplateRecipients
*/
public TemplateRecipients editors(java.util.List editors) {
this.editors = editors;
return this;
}
/**
* addEditorsItem.
*
* @return TemplateRecipients
*/
public TemplateRecipients addEditorsItem(Editor editorsItem) {
if (this.editors == null) {
this.editors = new java.util.ArrayList<>();
}
this.editors.add(editorsItem);
return this;
}
/**
* .
*
* @return editors
*/
@Schema(description = "")
public java.util.List getEditors() {
return editors;
}
/** setEditors. */
public void setEditors(java.util.List editors) {
this.editors = editors;
}
/**
* errorDetails.
*
* @return TemplateRecipients
*/
public TemplateRecipients 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;
}
/**
* inPersonSigners.
*
* @return TemplateRecipients
*/
public TemplateRecipients inPersonSigners(java.util.List inPersonSigners) {
this.inPersonSigners = inPersonSigners;
return this;
}
/**
* addInPersonSignersItem.
*
* @return TemplateRecipients
*/
public TemplateRecipients addInPersonSignersItem(InPersonSigner inPersonSignersItem) {
if (this.inPersonSigners == null) {
this.inPersonSigners = new java.util.ArrayList<>();
}
this.inPersonSigners.add(inPersonSignersItem);
return this;
}
/**
* Specifies a signer that is in the same physical location as a DocuSign user who will act as a
* Signing Host for the transaction. The recipient added is the Signing Host and new separate
* Signer Name field appears after Sign in person is selected..
*
* @return inPersonSigners
*/
@Schema(
description =
"Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.")
public java.util.List getInPersonSigners() {
return inPersonSigners;
}
/** setInPersonSigners. */
public void setInPersonSigners(java.util.List inPersonSigners) {
this.inPersonSigners = inPersonSigners;
}
/**
* intermediaries.
*
* @return TemplateRecipients
*/
public TemplateRecipients intermediaries(java.util.List intermediaries) {
this.intermediaries = intermediaries;
return this;
}
/**
* addIntermediariesItem.
*
* @return TemplateRecipients
*/
public TemplateRecipients addIntermediariesItem(Intermediary intermediariesItem) {
if (this.intermediaries == null) {
this.intermediaries = new java.util.ArrayList<>();
}
this.intermediaries.add(intermediariesItem);
return this;
}
/**
* Identifies a recipient that can, but is not required to, add name and email information for
* recipients at the same or subsequent level in the routing order (until subsequent Agents,
* Editors or Intermediaries recipient types are added)..
*
* @return intermediaries
*/
@Schema(
description =
"Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).")
public java.util.List getIntermediaries() {
return intermediaries;
}
/** setIntermediaries. */
public void setIntermediaries(java.util.List intermediaries) {
this.intermediaries = intermediaries;
}
/**
* notaries.
*
* @return TemplateRecipients
*/
public TemplateRecipients notaries(java.util.List notaries) {
this.notaries = notaries;
return this;
}
/**
* addNotariesItem.
*
* @return TemplateRecipients
*/
public TemplateRecipients addNotariesItem(NotaryRecipient notariesItem) {
if (this.notaries == null) {
this.notaries = new java.util.ArrayList<>();
}
this.notaries.add(notariesItem);
return this;
}
/**
* .
*
* @return notaries
*/
@Schema(description = "")
public java.util.List getNotaries() {
return notaries;
}
/** setNotaries. */
public void setNotaries(java.util.List notaries) {
this.notaries = notaries;
}
/**
* participants.
*
* @return TemplateRecipients
*/
public TemplateRecipients participants(java.util.List participants) {
this.participants = participants;
return this;
}
/**
* addParticipantsItem.
*
* @return TemplateRecipients
*/
public TemplateRecipients addParticipantsItem(Participant participantsItem) {
if (this.participants == null) {
this.participants = new java.util.ArrayList<>();
}
this.participants.add(participantsItem);
return this;
}
/**
* .
*
* @return participants
*/
@Schema(description = "")
public java.util.List getParticipants() {
return participants;
}
/** setParticipants. */
public void setParticipants(java.util.List participants) {
this.participants = participants;
}
/**
* recipientCount.
*
* @return TemplateRecipients
*/
public TemplateRecipients recipientCount(String recipientCount) {
this.recipientCount = recipientCount;
return this;
}
/**
* The list of recipient event statuses that will trigger Connect to send updates to the url. It
* can be a two-part list with: * recipientEventStatusCode - The recipient status, this can be
* Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. *
* includeDocuments - When set to **true**, the envelope time zone information is included in the
* message..
*
* @return recipientCount
*/
@Schema(
description =
"The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with: * recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. * includeDocuments - When set to **true**, the envelope time zone information is included in the message.")
public String getRecipientCount() {
return recipientCount;
}
/** setRecipientCount. */
public void setRecipientCount(String recipientCount) {
this.recipientCount = recipientCount;
}
/**
* seals.
*
* @return TemplateRecipients
*/
public TemplateRecipients seals(java.util.List seals) {
this.seals = seals;
return this;
}
/**
* addSealsItem.
*
* @return TemplateRecipients
*/
public TemplateRecipients addSealsItem(SealSign sealsItem) {
if (this.seals == null) {
this.seals = new java.util.ArrayList<>();
}
this.seals.add(sealsItem);
return this;
}
/**
* .
*
* @return seals
*/
@Schema(description = "")
public java.util.List getSeals() {
return seals;
}
/** setSeals. */
public void setSeals(java.util.List seals) {
this.seals = seals;
}
/**
* signers.
*
* @return TemplateRecipients
*/
public TemplateRecipients signers(java.util.List signers) {
this.signers = signers;
return this;
}
/**
* addSignersItem.
*
* @return TemplateRecipients
*/
public TemplateRecipients addSignersItem(Signer signersItem) {
if (this.signers == null) {
this.signers = new java.util.ArrayList<>();
}
this.signers.add(signersItem);
return this;
}
/**
* A complex type containing information about the Signer recipient..
*
* @return signers
*/
@Schema(description = "A complex type containing information about the Signer recipient.")
public java.util.List getSigners() {
return signers;
}
/** setSigners. */
public void setSigners(java.util.List signers) {
this.signers = signers;
}
/**
* witnesses.
*
* @return TemplateRecipients
*/
public TemplateRecipients witnesses(java.util.List witnesses) {
this.witnesses = witnesses;
return this;
}
/**
* addWitnessesItem.
*
* @return TemplateRecipients
*/
public TemplateRecipients addWitnessesItem(Witness witnessesItem) {
if (this.witnesses == null) {
this.witnesses = new java.util.ArrayList<>();
}
this.witnesses.add(witnessesItem);
return this;
}
/**
* .
*
* @return witnesses
*/
@Schema(description = "")
public java.util.List getWitnesses() {
return witnesses;
}
/** setWitnesses. */
public void setWitnesses(java.util.List witnesses) {
this.witnesses = witnesses;
}
/**
* 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;
}
TemplateRecipients templateRecipients = (TemplateRecipients) o;
return Objects.equals(this.agents, templateRecipients.agents)
&& Objects.equals(this.carbonCopies, templateRecipients.carbonCopies)
&& Objects.equals(this.certifiedDeliveries, templateRecipients.certifiedDeliveries)
&& Objects.equals(this.currentRoutingOrder, templateRecipients.currentRoutingOrder)
&& Objects.equals(this.editors, templateRecipients.editors)
&& Objects.equals(this.errorDetails, templateRecipients.errorDetails)
&& Objects.equals(this.inPersonSigners, templateRecipients.inPersonSigners)
&& Objects.equals(this.intermediaries, templateRecipients.intermediaries)
&& Objects.equals(this.notaries, templateRecipients.notaries)
&& Objects.equals(this.participants, templateRecipients.participants)
&& Objects.equals(this.recipientCount, templateRecipients.recipientCount)
&& Objects.equals(this.seals, templateRecipients.seals)
&& Objects.equals(this.signers, templateRecipients.signers)
&& Objects.equals(this.witnesses, templateRecipients.witnesses);
}
/** Returns the HashCode. */
@Override
public int hashCode() {
return Objects.hash(
agents,
carbonCopies,
certifiedDeliveries,
currentRoutingOrder,
editors,
errorDetails,
inPersonSigners,
intermediaries,
notaries,
participants,
recipientCount,
seals,
signers,
witnesses);
}
/** Converts the given object to string. */
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class TemplateRecipients {\n");
sb.append(" agents: ").append(toIndentedString(agents)).append("\n");
sb.append(" carbonCopies: ").append(toIndentedString(carbonCopies)).append("\n");
sb.append(" certifiedDeliveries: ")
.append(toIndentedString(certifiedDeliveries))
.append("\n");
sb.append(" currentRoutingOrder: ")
.append(toIndentedString(currentRoutingOrder))
.append("\n");
sb.append(" editors: ").append(toIndentedString(editors)).append("\n");
sb.append(" errorDetails: ").append(toIndentedString(errorDetails)).append("\n");
sb.append(" inPersonSigners: ").append(toIndentedString(inPersonSigners)).append("\n");
sb.append(" intermediaries: ").append(toIndentedString(intermediaries)).append("\n");
sb.append(" notaries: ").append(toIndentedString(notaries)).append("\n");
sb.append(" participants: ").append(toIndentedString(participants)).append("\n");
sb.append(" recipientCount: ").append(toIndentedString(recipientCount)).append("\n");
sb.append(" seals: ").append(toIndentedString(seals)).append("\n");
sb.append(" signers: ").append(toIndentedString(signers)).append("\n");
sb.append(" witnesses: ").append(toIndentedString(witnesses)).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 ");
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy