Agent (docusign-esign-java 2.0.2 API)

java.lang.Object
- com.docusign.esign.model.Agent

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2016-07-18T18:11:15.675-07:00")
public class Agent
extends Object

Contains information about agent recipients.

Constructor Summary

Constructors
Constructor and Description

Agent()

Constructors
Constructor and Description
`Agent()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Agent`	`accessCode(String accessCode)` If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.
`Agent`	`addAccessCodeToEmail(String addAccessCodeToEmail)` This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
`Agent`	`clientUserId(String clientUserId)` Specifies whether the recipient is embedded or remote.
`Agent`	`customFields(List<String> customFields)` An optional array of strings that allows the sender to provide custom data about the recipient.
`Agent`	`declinedDateTime(String declinedDateTime)` The date and time the recipient declined the document.
`Agent`	`declinedReason(String declinedReason)` The reason the recipient declined the document.
`Agent`	`deliveredDateTime(String deliveredDateTime)` Reserved: For DocuSign use only.
`Agent`	`deliveryMethod(String deliveryMethod)` Reserved: For DocuSign use only.
`Agent`	`email(String email)` Email id of the recipient.
`Agent`	`emailNotification(RecipientEmailNotification emailNotification)`
`Agent`	`emailRecipientPostSigningURL(String emailRecipientPostSigningURL)`
`Agent`	`embeddedRecipientStartURL(String embeddedRecipientStartURL)` Specifies a sender provided valid URL string for redirecting an embedded recipient.
`boolean`	`equals(Object o)`
`Agent`	`errorDetails(ErrorDetails errorDetails)`
`Agent`	`excludedDocuments(List<String> excludedDocuments)` Specifies the documents that are not visible to this recipient.
`Agent`	`faxNumber(String faxNumber)` Reserved:
`String`	`getAccessCode()`
`String`	`getAddAccessCodeToEmail()`
`String`	`getClientUserId()`
`List<String>`	`getCustomFields()`
`String`	`getDeclinedDateTime()`
`String`	`getDeclinedReason()`
`String`	`getDeliveredDateTime()`
`String`	`getDeliveryMethod()`
`String`	`getEmail()`
`RecipientEmailNotification`	`getEmailNotification()`
`String`	`getEmailRecipientPostSigningURL()`
`String`	`getEmbeddedRecipientStartURL()`
`ErrorDetails`	`getErrorDetails()`
`List<String>`	`getExcludedDocuments()`
`String`	`getFaxNumber()`
`String`	`getIdCheckConfigurationName()`
`IdCheckInformationInput`	`getIdCheckInformationInput()`
`String`	`getInheritEmailNotificationConfiguration()`
`String`	`getName()`
`String`	`getNote()`
`RecipientPhoneAuthentication`	`getPhoneAuthentication()`
`List<Attachment>`	`getRecipientAttachments()`
`AuthenticationStatus`	`getRecipientAuthenticationStatus()`
`String`	`getRecipientId()`
`String`	`getRecipientIdGuid()`
`String`	`getRequireIdLookup()`
`String`	`getRoleName()`
`String`	`getRoutingOrder()`
`RecipientSAMLAuthentication`	`getSamlAuthentication()`
`String`	`getSentDateTime()`
`String`	`getSignedDateTime()`
`String`	`getSigningGroupId()`
`String`	`getSigningGroupName()`
`List<UserInfo>`	`getSigningGroupUsers()`
`RecipientSMSAuthentication`	`getSmsAuthentication()`
`List<SocialAuthentication>`	`getSocialAuthentications()`
`String`	`getStatus()`
`String`	`getTemplateLocked()`
`String`	`getTemplateRequired()`
`String`	`getTotalTabCount()`
`String`	`getUserId()`
`int`	`hashCode()`
`Agent`	`idCheckConfigurationName(String idCheckConfigurationName)` Specifies authentication check by name.
`Agent`	`idCheckInformationInput(IdCheckInformationInput idCheckInformationInput)`
`Agent`	`inheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)` When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
`Agent`	`name(String name)`
`Agent`	`note(String note)` Specifies a note that is unique to this recipient.
`Agent`	`phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)`
`Agent`	`recipientAttachments(List<Attachment> recipientAttachments)` Reserved:
`Agent`	`recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)`
`Agent`	`recipientId(String recipientId)` Unique for the recipient.
`Agent`	`recipientIdGuid(String recipientIdGuid)`
`Agent`	`requireIdLookup(String requireIdLookup)` When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
`Agent`	`roleName(String roleName)` Optional element.
`Agent`	`routingOrder(String routingOrder)` Specifies the routing order of the recipient in the envelope.
`Agent`	`samlAuthentication(RecipientSAMLAuthentication samlAuthentication)`
`Agent`	`sentDateTime(String sentDateTime)` The date and time the envelope was sent.
`void`	`setAccessCode(String accessCode)`
`void`	`setAddAccessCodeToEmail(String addAccessCodeToEmail)`
`void`	`setClientUserId(String clientUserId)`
`void`	`setCustomFields(List<String> customFields)`
`void`	`setDeclinedDateTime(String declinedDateTime)`
`void`	`setDeclinedReason(String declinedReason)`
`void`	`setDeliveredDateTime(String deliveredDateTime)`
`void`	`setDeliveryMethod(String deliveryMethod)`
`void`	`setEmail(String email)`
`void`	`setEmailNotification(RecipientEmailNotification emailNotification)`
`void`	`setEmailRecipientPostSigningURL(String emailRecipientPostSigningURL)`
`void`	`setEmbeddedRecipientStartURL(String embeddedRecipientStartURL)`
`void`	`setErrorDetails(ErrorDetails errorDetails)`
`void`	`setExcludedDocuments(List<String> excludedDocuments)`
`void`	`setFaxNumber(String faxNumber)`
`void`	`setIdCheckConfigurationName(String idCheckConfigurationName)`
`void`	`setIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput)`
`void`	`setInheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)`
`void`	`setName(String name)`
`void`	`setNote(String note)`
`void`	`setPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)`
`void`	`setRecipientAttachments(List<Attachment> recipientAttachments)`
`void`	`setRecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)`
`void`	`setRecipientId(String recipientId)`
`void`	`setRecipientIdGuid(String recipientIdGuid)`
`void`	`setRequireIdLookup(String requireIdLookup)`
`void`	`setRoleName(String roleName)`
`void`	`setRoutingOrder(String routingOrder)`
`void`	`setSamlAuthentication(RecipientSAMLAuthentication samlAuthentication)`
`void`	`setSentDateTime(String sentDateTime)`
`void`	`setSignedDateTime(String signedDateTime)`
`void`	`setSigningGroupId(String signingGroupId)`
`void`	`setSigningGroupName(String signingGroupName)`
`void`	`setSigningGroupUsers(List<UserInfo> signingGroupUsers)`
`void`	`setSmsAuthentication(RecipientSMSAuthentication smsAuthentication)`
`void`	`setSocialAuthentications(List<SocialAuthentication> socialAuthentications)`
`void`	`setStatus(String status)`
`void`	`setTemplateLocked(String templateLocked)`
`void`	`setTemplateRequired(String templateRequired)`
`void`	`setTotalTabCount(String totalTabCount)`
`void`	`setUserId(String userId)`
`Agent`	`signedDateTime(String signedDateTime)` Reserved: For DocuSign use only.
`Agent`	`signingGroupId(String signingGroupId)` When set to true and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).
`Agent`	`signingGroupName(String signingGroupName)` The display name for the signing group.
`Agent`	`signingGroupUsers(List<UserInfo> signingGroupUsers)` A complex type that contains information about users in the signing group.
`Agent`	`smsAuthentication(RecipientSMSAuthentication smsAuthentication)`
`Agent`	`socialAuthentications(List<SocialAuthentication> socialAuthentications)` Lists the social ID type that can be used for recipient authentication.
`Agent`	`status(String status)` Indicates the envelope status.
`Agent`	`templateLocked(String templateLocked)` When set to true, the sender cannot change any attributes of the recipient.
`Agent`	`templateRequired(String templateRequired)` When set to true, the sender may not remove the recipient.
`String`	`toString()`
`Agent`	`totalTabCount(String totalTabCount)`
`Agent`	`userId(String userId)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Agent
```
public Agent()
```
- Method Detail
  - excludedDocuments
```
public Agent excludedDocuments(List<String> excludedDocuments)
```
    Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this.\n\nWhen enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.
  - getExcludedDocuments
```
public List<String> getExcludedDocuments()
```
  - setExcludedDocuments
```
public void setExcludedDocuments(List<String> excludedDocuments)
```
  - name
```
public Agent name(String name)
```
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
  - email
```
public Agent email(String email)
```
    Email id of the recipient. Notification of the document to sign is sent to this email id. \n\nMaximum length: 100 characters.
  - getEmail
```
public String getEmail()
```
  - setEmail
```
public void setEmail(String email)
```
  - emailRecipientPostSigningURL
```
public Agent emailRecipientPostSigningURL(String emailRecipientPostSigningURL)
```
  - getEmailRecipientPostSigningURL
```
public String getEmailRecipientPostSigningURL()
```
  - setEmailRecipientPostSigningURL
```
public void setEmailRecipientPostSigningURL(String emailRecipientPostSigningURL)
```
  - signingGroupId
```
public Agent signingGroupId(String signingGroupId)
```
    When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).
  - getSigningGroupId
```
public String getSigningGroupId()
```
  - setSigningGroupId
```
public void setSigningGroupId(String signingGroupId)
```
  - signingGroupName
```
public Agent signingGroupName(String signingGroupName)
```
    The display name for the signing group. \n\nMaximum Length: 100 characters.
  - getSigningGroupName
```
public String getSigningGroupName()
```
  - setSigningGroupName
```
public void setSigningGroupName(String signingGroupName)
```
  - signingGroupUsers
```
public Agent signingGroupUsers(List<UserInfo> signingGroupUsers)
```
    A complex type that contains information about users in the signing group.
  - getSigningGroupUsers
```
public List<UserInfo> getSigningGroupUsers()
```
  - setSigningGroupUsers
```
public void setSigningGroupUsers(List<UserInfo> signingGroupUsers)
```
  - recipientId
```
public Agent recipientId(String recipientId)
```
    Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
  - getRecipientId
```
public String getRecipientId()
```
  - setRecipientId
```
public void setRecipientId(String recipientId)
```
  - recipientIdGuid
```
public Agent recipientIdGuid(String recipientIdGuid)
```
  - getRecipientIdGuid
```
public String getRecipientIdGuid()
```
  - setRecipientIdGuid
```
public void setRecipientIdGuid(String recipientIdGuid)
```
  - accessCode
```
public Agent accessCode(String accessCode)
```
    If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account’s access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.
  - getAccessCode
```
public String getAccessCode()
```
  - setAccessCode
```
public void setAccessCode(String accessCode)
```
  - addAccessCodeToEmail
```
public Agent addAccessCodeToEmail(String addAccessCodeToEmail)
```
    This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
  - getAddAccessCodeToEmail
```
public String getAddAccessCodeToEmail()
```
  - setAddAccessCodeToEmail
```
public void setAddAccessCodeToEmail(String addAccessCodeToEmail)
```
  - requireIdLookup
```
public Agent requireIdLookup(String requireIdLookup)
```
    When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
  - getRequireIdLookup
```
public String getRequireIdLookup()
```
  - setRequireIdLookup
```
public void setRequireIdLookup(String requireIdLookup)
```
  - idCheckConfigurationName
```
public Agent idCheckConfigurationName(String idCheckConfigurationName)
```
    Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting.\n\n*Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node.
  - getIdCheckConfigurationName
```
public String getIdCheckConfigurationName()
```
  - setIdCheckConfigurationName
```
public void setIdCheckConfigurationName(String idCheckConfigurationName)
```
  - socialAuthentications
```
public Agent socialAuthentications(List<SocialAuthentication> socialAuthentications)
```
    Lists the social ID type that can be used for recipient authentication.
  - getSocialAuthentications
```
public List<SocialAuthentication> getSocialAuthentications()
```
  - setSocialAuthentications
```
public void setSocialAuthentications(List<SocialAuthentication> socialAuthentications)
```
  - phoneAuthentication
```
public Agent phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
```
  - getPhoneAuthentication
```
public RecipientPhoneAuthentication getPhoneAuthentication()
```
  - setPhoneAuthentication
```
public void setPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
```
  - samlAuthentication
```
public Agent samlAuthentication(RecipientSAMLAuthentication samlAuthentication)
```
  - getSamlAuthentication
```
public RecipientSAMLAuthentication getSamlAuthentication()
```
  - setSamlAuthentication
```
public void setSamlAuthentication(RecipientSAMLAuthentication samlAuthentication)
```
  - smsAuthentication
```
public Agent smsAuthentication(RecipientSMSAuthentication smsAuthentication)
```
  - getSmsAuthentication
```
public RecipientSMSAuthentication getSmsAuthentication()
```
  - setSmsAuthentication
```
public void setSmsAuthentication(RecipientSMSAuthentication smsAuthentication)
```
  - userId
```
public Agent userId(String userId)
```
  - getUserId
```
public String getUserId()
```
  - setUserId
```
public void setUserId(String userId)
```
  - clientUserId
```
public Agent clientUserId(String clientUserId)
```
    Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. \n\nMaximum length: 100 characters.
  - getClientUserId
```
public String getClientUserId()
```
  - setClientUserId
```
public void setClientUserId(String clientUserId)
```
  - embeddedRecipientStartURL
```
public Agent embeddedRecipientStartURL(String embeddedRecipientStartURL)
```
    Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender’s system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.\n\nIt is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient’s identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
  - getEmbeddedRecipientStartURL
```
public String getEmbeddedRecipientStartURL()
```
  - setEmbeddedRecipientStartURL
```
public void setEmbeddedRecipientStartURL(String embeddedRecipientStartURL)
```
  - customFields
```
public Agent customFields(List<String> customFields)
```
    An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
  - getCustomFields
```
public List<String> getCustomFields()
```
  - setCustomFields
```
public void setCustomFields(List<String> customFields)
```
  - routingOrder
```
public Agent routingOrder(String routingOrder)
```
    Specifies the routing order of the recipient in the envelope.
  - getRoutingOrder
```
public String getRoutingOrder()
```
  - setRoutingOrder
```
public void setRoutingOrder(String routingOrder)
```
  - idCheckInformationInput
```
public Agent idCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
```
  - getIdCheckInformationInput
```
public IdCheckInformationInput getIdCheckInformationInput()
```
  - setIdCheckInformationInput
```
public void setIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
```
  - recipientAttachments
```
public Agent recipientAttachments(List<Attachment> recipientAttachments)
```
    Reserved:
  - getRecipientAttachments
```
public List<Attachment> getRecipientAttachments()
```
  - setRecipientAttachments
```
public void setRecipientAttachments(List<Attachment> recipientAttachments)
```
  - note
```
public Agent note(String note)
```
    Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen.\n\nMaximum Length: 1000 characters.
  - getNote
```
public String getNote()
```
  - setNote
```
public void setNote(String note)
```
  - roleName
```
public Agent roleName(String roleName)
```
    Optional element. Specifies the role name associated with the recipient.
    
    This is required when working with template recipients.
  - getRoleName
```
public String getRoleName()
```
  - setRoleName
```
public void setRoleName(String roleName)
```
  - status
```
public Agent status(String status)
```
    Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.
  - getStatus
```
public String getStatus()
```
  - setStatus
```
public void setStatus(String status)
```
  - signedDateTime
```
public Agent signedDateTime(String signedDateTime)
```
    Reserved: For DocuSign use only.
  - getSignedDateTime
```
public String getSignedDateTime()
```
  - setSignedDateTime
```
public void setSignedDateTime(String signedDateTime)
```
  - deliveredDateTime
```
public Agent deliveredDateTime(String deliveredDateTime)
```
    Reserved: For DocuSign use only.
  - getDeliveredDateTime
```
public String getDeliveredDateTime()
```
  - setDeliveredDateTime
```
public void setDeliveredDateTime(String deliveredDateTime)
```
  - declinedDateTime
```
public Agent declinedDateTime(String declinedDateTime)
```
    The date and time the recipient declined the document.
  - getDeclinedDateTime
```
public String getDeclinedDateTime()
```
  - setDeclinedDateTime
```
public void setDeclinedDateTime(String declinedDateTime)
```
  - sentDateTime
```
public Agent sentDateTime(String sentDateTime)
```
    The date and time the envelope was sent.
  - getSentDateTime
```
public String getSentDateTime()
```
  - setSentDateTime
```
public void setSentDateTime(String sentDateTime)
```
  - declinedReason
```
public Agent declinedReason(String declinedReason)
```
    The reason the recipient declined the document.
  - getDeclinedReason
```
public String getDeclinedReason()
```
  - setDeclinedReason
```
public void setDeclinedReason(String declinedReason)
```
  - deliveryMethod
```
public Agent deliveryMethod(String deliveryMethod)
```
    Reserved: For DocuSign use only.
  - getDeliveryMethod
```
public String getDeliveryMethod()
```
  - setDeliveryMethod
```
public void setDeliveryMethod(String deliveryMethod)
```
  - faxNumber
```
public Agent faxNumber(String faxNumber)
```
    Reserved:
  - getFaxNumber
```
public String getFaxNumber()
```
  - setFaxNumber
```
public void setFaxNumber(String faxNumber)
```
  - templateLocked
```
public Agent templateLocked(String templateLocked)
```
    When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
  - getTemplateLocked
```
public String getTemplateLocked()
```
  - setTemplateLocked
```
public void setTemplateLocked(String templateLocked)
```
  - templateRequired
```
public Agent templateRequired(String templateRequired)
```
    When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
  - getTemplateRequired
```
public String getTemplateRequired()
```
  - setTemplateRequired
```
public void setTemplateRequired(String templateRequired)
```
  - emailNotification
```
public Agent emailNotification(RecipientEmailNotification emailNotification)
```
  - getEmailNotification
```
public RecipientEmailNotification getEmailNotification()
```
  - setEmailNotification
```
public void setEmailNotification(RecipientEmailNotification emailNotification)
```
  - inheritEmailNotificationConfiguration
```
public Agent inheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)
```
    When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
  - getInheritEmailNotificationConfiguration
```
public String getInheritEmailNotificationConfiguration()
```
  - setInheritEmailNotificationConfiguration
```
public void setInheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)
```
  - errorDetails
```
public Agent errorDetails(ErrorDetails errorDetails)
```
  - getErrorDetails
```
public ErrorDetails getErrorDetails()
```
  - setErrorDetails
```
public void setErrorDetails(ErrorDetails errorDetails)
```
  - recipientAuthenticationStatus
```
public Agent recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
```
  - getRecipientAuthenticationStatus
```
public AuthenticationStatus getRecipientAuthenticationStatus()
```
  - setRecipientAuthenticationStatus
```
public void setRecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
```
  - totalTabCount
```
public Agent totalTabCount(String totalTabCount)
```
  - getTotalTabCount
```
public String getTotalTabCount()
```
  - setTotalTabCount
```
public void setTotalTabCount(String totalTabCount)
```
  - 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

Class Agent

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Agent

Method Detail

excludedDocuments

getExcludedDocuments

setExcludedDocuments

name

getName

setName

email

getEmail

setEmail

emailRecipientPostSigningURL

getEmailRecipientPostSigningURL

setEmailRecipientPostSigningURL

signingGroupId

getSigningGroupId

setSigningGroupId

signingGroupName

getSigningGroupName

setSigningGroupName

signingGroupUsers

getSigningGroupUsers

setSigningGroupUsers

recipientId

getRecipientId

setRecipientId

recipientIdGuid

getRecipientIdGuid

setRecipientIdGuid

accessCode

getAccessCode

setAccessCode

addAccessCodeToEmail

getAddAccessCodeToEmail

setAddAccessCodeToEmail

requireIdLookup

getRequireIdLookup

setRequireIdLookup

idCheckConfigurationName

getIdCheckConfigurationName

setIdCheckConfigurationName

socialAuthentications

getSocialAuthentications

setSocialAuthentications

phoneAuthentication

getPhoneAuthentication

setPhoneAuthentication

samlAuthentication

getSamlAuthentication

setSamlAuthentication

smsAuthentication

getSmsAuthentication

setSmsAuthentication

userId

getUserId

setUserId

clientUserId

getClientUserId

setClientUserId

embeddedRecipientStartURL

getEmbeddedRecipientStartURL

setEmbeddedRecipientStartURL

customFields

getCustomFields

setCustomFields

routingOrder

getRoutingOrder

setRoutingOrder

idCheckInformationInput

getIdCheckInformationInput

setIdCheckInformationInput

recipientAttachments

getRecipientAttachments

setRecipientAttachments

note