com.docusign.esign.model

Class TemplateRecipients

java.lang.Object

com.docusign.esign.model.TemplateRecipients

public class TemplateRecipients
extends Object

TemplateRecipients

Constructor Summary

Constructors

Constructor and Description
TemplateRecipients()

Method Summary

Methods

Modifier and Type	Method and Description
TemplateRecipients	addAgentsItem(Agent agentsItem)
TemplateRecipients	addCarbonCopiesItem(CarbonCopy carbonCopiesItem)
TemplateRecipients	addCertifiedDeliveriesItem(CertifiedDelivery certifiedDeliveriesItem)
TemplateRecipients	addEditorsItem(Editor editorsItem)
TemplateRecipients	addInPersonSignersItem(InPersonSigner inPersonSignersItem)
TemplateRecipients	addIntermediariesItem(Intermediary intermediariesItem)
TemplateRecipients	addSealsItem(SealSign sealsItem)
TemplateRecipients	addSignersItem(Signer signersItem)
TemplateRecipients	addWitnessesItem(Witness witnessesItem)
TemplateRecipients	agents(List<Agent> agents)
TemplateRecipients	carbonCopies(List<CarbonCopy> carbonCopies)
TemplateRecipients	certifiedDeliveries(List<CertifiedDelivery> certifiedDeliveries)
TemplateRecipients	currentRoutingOrder(String currentRoutingOrder)
TemplateRecipients	editors(List<Editor> editors)
boolean	equals(Object o)
TemplateRecipients	errorDetails(ErrorDetails errorDetails)
List<Agent>	getAgents() A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document.
List<CarbonCopy>	getCarbonCopies() A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it.
List<CertifiedDelivery>	getCertifiedDeliveries() 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.
String	getCurrentRoutingOrder()
List<Editor>	getEditors()
ErrorDetails	getErrorDetails() Get errorDetails
List<InPersonSigner>	getInPersonSigners() Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction.
List<Intermediary>	getIntermediaries() 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).
String	getRecipientCount() The list of recipient event statuses that will trigger Connect to send updates to the url.
List<SealSign>	getSeals()
List<Signer>	getSigners() A complex type containing information about the Signer recipient.
List<Witness>	getWitnesses()
int	hashCode()
TemplateRecipients	inPersonSigners(List<InPersonSigner> inPersonSigners)
TemplateRecipients	intermediaries(List<Intermediary> intermediaries)
TemplateRecipients	recipientCount(String recipientCount)
TemplateRecipients	seals(List<SealSign> seals)
void	setAgents(List<Agent> agents)
void	setCarbonCopies(List<CarbonCopy> carbonCopies)
void	setCertifiedDeliveries(List<CertifiedDelivery> certifiedDeliveries)
void	setCurrentRoutingOrder(String currentRoutingOrder)
void	setEditors(List<Editor> editors)
void	setErrorDetails(ErrorDetails errorDetails)
void	setInPersonSigners(List<InPersonSigner> inPersonSigners)
void	setIntermediaries(List<Intermediary> intermediaries)
void	setRecipientCount(String recipientCount)
void	setSeals(List<SealSign> seals)
void	setSigners(List<Signer> signers)
void	setWitnesses(List<Witness> witnesses)
TemplateRecipients	signers(List<Signer> signers)
String	toString()
TemplateRecipients	witnesses(List<Witness> witnesses)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TemplateRecipients

public TemplateRecipients()

Method Detail

agents

public TemplateRecipients agents(List<Agent> agents)

addAgentsItem

public TemplateRecipients addAgentsItem(Agent agentsItem)

getAgents

public List<Agent> getAgents()

A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document.

Returns:

agents

setAgents

public void setAgents(List<Agent> agents)

carbonCopies

public TemplateRecipients carbonCopies(List<CarbonCopy> carbonCopies)

addCarbonCopiesItem

public TemplateRecipients addCarbonCopiesItem(CarbonCopy carbonCopiesItem)

getCarbonCopies

public List<CarbonCopy> getCarbonCopies()

A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it.

Returns:

carbonCopies

setCarbonCopies

public void setCarbonCopies(List<CarbonCopy> carbonCopies)

certifiedDeliveries

public TemplateRecipients certifiedDeliveries(List<CertifiedDelivery> certifiedDeliveries)

addCertifiedDeliveriesItem

public TemplateRecipients addCertifiedDeliveriesItem(CertifiedDelivery certifiedDeliveriesItem)

getCertifiedDeliveries

public List<CertifiedDelivery> getCertifiedDeliveries()

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.

Returns:

certifiedDeliveries

setCertifiedDeliveries

public void setCertifiedDeliveries(List<CertifiedDelivery> certifiedDeliveries)

currentRoutingOrder

public TemplateRecipients currentRoutingOrder(String currentRoutingOrder)

getCurrentRoutingOrder

public String getCurrentRoutingOrder()

Returns:

currentRoutingOrder

setCurrentRoutingOrder

public void setCurrentRoutingOrder(String currentRoutingOrder)

editors

public TemplateRecipients editors(List<Editor> editors)

addEditorsItem

public TemplateRecipients addEditorsItem(Editor editorsItem)

getEditors

public List<Editor> getEditors()

Returns:

editors

setEditors

public void setEditors(List<Editor> editors)

errorDetails

public TemplateRecipients errorDetails(ErrorDetails errorDetails)

getErrorDetails

public ErrorDetails getErrorDetails()

Get errorDetails

Returns:

errorDetails

setErrorDetails

public void setErrorDetails(ErrorDetails errorDetails)

inPersonSigners

public TemplateRecipients inPersonSigners(List<InPersonSigner> inPersonSigners)

addInPersonSignersItem

public TemplateRecipients addInPersonSignersItem(InPersonSigner inPersonSignersItem)

getInPersonSigners

public List<InPersonSigner> getInPersonSigners()

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.

Returns:

inPersonSigners

setInPersonSigners

public void setInPersonSigners(List<InPersonSigner> inPersonSigners)

intermediaries

public TemplateRecipients intermediaries(List<Intermediary> intermediaries)

addIntermediariesItem

public TemplateRecipients addIntermediariesItem(Intermediary intermediariesItem)

getIntermediaries

public List<Intermediary> getIntermediaries()

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

Returns:

intermediaries

setIntermediaries

public void setIntermediaries(List<Intermediary> intermediaries)

recipientCount

public TemplateRecipients recipientCount(String recipientCount)

getRecipientCount

public String getRecipientCount()

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.

Returns:

recipientCount

setRecipientCount

public void setRecipientCount(String recipientCount)

seals

public TemplateRecipients seals(List<SealSign> seals)

addSealsItem

public TemplateRecipients addSealsItem(SealSign sealsItem)

getSeals

public List<SealSign> getSeals()

Returns:

seals

setSeals

public void setSeals(List<SealSign> seals)

signers

public TemplateRecipients signers(List<Signer> signers)

addSignersItem

public TemplateRecipients addSignersItem(Signer signersItem)

getSigners

public List<Signer> getSigners()

A complex type containing information about the Signer recipient.

Returns:

signers

setSigners

public void setSigners(List<Signer> signers)

witnesses

public TemplateRecipients witnesses(List<Witness> witnesses)

addWitnessesItem

public TemplateRecipients addWitnessesItem(Witness witnessesItem)

getWitnesses

public List<Witness> getWitnesses()

Returns:

witnesses

setWitnesses

public void setWitnesses(List<Witness> witnesses)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object