Package com.docusign.esign.model

Class Editor

  • public class Editor
extends Object
    A complex type defining the management and access rights of a recipient assigned as an editor on the envelope. Editors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and text tabs for the remaining recipients..

    • Constructor Detail

      • Editor

        public Editor()

    • Method Detail

      • accessCode

        public Editor accessCode​(String accessCode)
        accessCode.
        Returns:
        Editor

      • getAccessCode

        public String getAccessCode()
        If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required..
        Returns:
        accessCode

      • setAccessCode

        public void setAccessCode​(String accessCode)
        setAccessCode.

      • accessCodeMetadata

        public Editor accessCodeMetadata​(PropertyMetadata accessCodeMetadata)
        accessCodeMetadata.
        Returns:
        Editor

      • getAccessCodeMetadata

        public PropertyMetadata getAccessCodeMetadata()
        Metadata that indicates whether the `accessCode` property is editable. This property is read-only..
        Returns:
        accessCodeMetadata

      • setAccessCodeMetadata

        public void setAccessCodeMetadata​(PropertyMetadata accessCodeMetadata)
        setAccessCodeMetadata.

      • addAccessCodeToEmail

        public Editor addAccessCodeToEmail​(String addAccessCodeToEmail)
        addAccessCodeToEmail.
        Returns:
        Editor

      • getAddAccessCodeToEmail

        public String getAddAccessCodeToEmail()
        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..
        Returns:
        addAccessCodeToEmail

      • setAddAccessCodeToEmail

        public void setAddAccessCodeToEmail​(String addAccessCodeToEmail)
        setAddAccessCodeToEmail.

      • addAdditionalNotificationsItem

        public Editor addAdditionalNotificationsItem​(RecipientAdditionalNotification additionalNotificationsItem)
        addAdditionalNotificationsItem.
        Returns:
        Editor

      • allowSystemOverrideForLockedRecipient

        public Editor allowSystemOverrideForLockedRecipient​(String allowSystemOverrideForLockedRecipient)
        allowSystemOverrideForLockedRecipient.
        Returns:
        Editor

      • getAllowSystemOverrideForLockedRecipient

        public String getAllowSystemOverrideForLockedRecipient()
        .
        Returns:
        allowSystemOverrideForLockedRecipient

      • setAllowSystemOverrideForLockedRecipient

        public void setAllowSystemOverrideForLockedRecipient​(String allowSystemOverrideForLockedRecipient)
        setAllowSystemOverrideForLockedRecipient.

      • autoRespondedReason

        public Editor autoRespondedReason​(String autoRespondedReason)
        autoRespondedReason.
        Returns:
        Editor

      • getAutoRespondedReason

        public String getAutoRespondedReason()
        .
        Returns:
        autoRespondedReason

      • setAutoRespondedReason

        public void setAutoRespondedReason​(String autoRespondedReason)
        setAutoRespondedReason.

      • clientUserId

        public Editor clientUserId​(String clientUserId)
        clientUserId.
        Returns:
        Editor

      • getClientUserId

        public String getClientUserId()
        Specifies whether the recipient is embedded or remote. If 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. Maximum length: 100 characters. .
        Returns:
        clientUserId

      • setClientUserId

        public void setClientUserId​(String clientUserId)
        setClientUserId.

      • completedCount

        public Editor completedCount​(String completedCount)
        completedCount.
        Returns:
        Editor

      • getCompletedCount

        public String getCompletedCount()
        .
        Returns:
        completedCount

      • setCompletedCount

        public void setCompletedCount​(String completedCount)
        setCompletedCount.

      • consentDetailsList

        public Editor consentDetailsList​(List<ConsentDetails> consentDetailsList)
        consentDetailsList.
        Returns:
        Editor

      • addConsentDetailsListItem

        public Editor addConsentDetailsListItem​(ConsentDetails consentDetailsListItem)
        addConsentDetailsListItem.
        Returns:
        Editor

      • getConsentDetailsList

        public List<ConsentDetails> getConsentDetailsList()
        .
        Returns:
        consentDetailsList

      • setConsentDetailsList

        public void setConsentDetailsList​(List<ConsentDetails> consentDetailsList)
        setConsentDetailsList.

      • customFields

        public Editor customFields​(List<String> customFields)
        customFields.
        Returns:
        Editor

      • addCustomFieldsItem

        public Editor addCustomFieldsItem​(String customFieldsItem)
        addCustomFieldsItem.
        Returns:
        Editor

      • getCustomFields

        public List<String> getCustomFields()
        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..
        Returns:
        customFields

      • setCustomFields

        public void setCustomFields​(List<String> customFields)
        setCustomFields.

      • declinedDateTime

        public Editor declinedDateTime​(String declinedDateTime)
        declinedDateTime.
        Returns:
        Editor

      • getDeclinedDateTime

        public String getDeclinedDateTime()
        The date and time the recipient declined the document..
        Returns:
        declinedDateTime

      • setDeclinedDateTime

        public void setDeclinedDateTime​(String declinedDateTime)
        setDeclinedDateTime.

      • declinedReason

        public Editor declinedReason​(String declinedReason)
        declinedReason.
        Returns:
        Editor

      • getDeclinedReason

        public String getDeclinedReason()
        The reason the recipient declined the document..
        Returns:
        declinedReason

      • setDeclinedReason

        public void setDeclinedReason​(String declinedReason)
        setDeclinedReason.

      • deliveredDateTime

        public Editor deliveredDateTime​(String deliveredDateTime)
        deliveredDateTime.
        Returns:
        Editor

      • getDeliveredDateTime

        public String getDeliveredDateTime()
        Reserved: For DocuSign use only..
        Returns:
        deliveredDateTime

      • setDeliveredDateTime

        public void setDeliveredDateTime​(String deliveredDateTime)
        setDeliveredDateTime.

      • deliveryMethod

        public Editor deliveryMethod​(String deliveryMethod)
        deliveryMethod.
        Returns:
        Editor

      • getDeliveryMethod

        public String getDeliveryMethod()
        Reserved: For DocuSign use only..
        Returns:
        deliveryMethod

      • setDeliveryMethod

        public void setDeliveryMethod​(String deliveryMethod)
        setDeliveryMethod.

      • deliveryMethodMetadata

        public Editor deliveryMethodMetadata​(PropertyMetadata deliveryMethodMetadata)
        deliveryMethodMetadata.
        Returns:
        Editor

      • getDeliveryMethodMetadata

        public PropertyMetadata getDeliveryMethodMetadata()
        Reserved for DocuSign..
        Returns:
        deliveryMethodMetadata

      • setDeliveryMethodMetadata

        public void setDeliveryMethodMetadata​(PropertyMetadata deliveryMethodMetadata)
        setDeliveryMethodMetadata.

      • designatorId

        public Editor designatorId​(String designatorId)
        designatorId.
        Returns:
        Editor

      • getDesignatorId

        public String getDesignatorId()
        .
        Returns:
        designatorId

      • setDesignatorId

        public void setDesignatorId​(String designatorId)
        setDesignatorId.

      • designatorIdGuid

        public Editor designatorIdGuid​(String designatorIdGuid)
        designatorIdGuid.
        Returns:
        Editor

      • getDesignatorIdGuid

        public String getDesignatorIdGuid()
        .
        Returns:
        designatorIdGuid

      • setDesignatorIdGuid

        public void setDesignatorIdGuid​(String designatorIdGuid)
        setDesignatorIdGuid.

      • documentVisibility

        public Editor documentVisibility​(List<DocumentVisibility> documentVisibility)
        documentVisibility.
        Returns:
        Editor

      • addDocumentVisibilityItem

        public Editor addDocumentVisibilityItem​(DocumentVisibility documentVisibilityItem)
        addDocumentVisibilityItem.
        Returns:
        Editor

      • getDocumentVisibility

        public List<DocumentVisibility> getDocumentVisibility()
        .
        Returns:
        documentVisibility

      • setDocumentVisibility

        public void setDocumentVisibility​(List<DocumentVisibility> documentVisibility)
        setDocumentVisibility.

      • email

        public Editor email​(String email)
        email.
        Returns:
        Editor

      • getEmail

        public String getEmail()
        Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters. .
        Returns:
        email

      • setEmail

        public void setEmail​(String email)
        setEmail.

      • emailMetadata

        public Editor emailMetadata​(PropertyMetadata emailMetadata)
        emailMetadata.
        Returns:
        Editor

      • getEmailMetadata

        public PropertyMetadata getEmailMetadata()
        Metadata that indicates whether the `email` property is editable. This property is read-only..
        Returns:
        emailMetadata

      • setEmailMetadata

        public void setEmailMetadata​(PropertyMetadata emailMetadata)
        setEmailMetadata.

      • getEmailNotification

        public RecipientEmailNotification getEmailNotification()
        An optional complex type that sets a specific email subject and body for this recipient's notification email. **Note:** You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. .
        Returns:
        emailNotification

      • emailRecipientPostSigningURL

        public Editor emailRecipientPostSigningURL​(String emailRecipientPostSigningURL)
        emailRecipientPostSigningURL.
        Returns:
        Editor

      • getEmailRecipientPostSigningURL

        public String getEmailRecipientPostSigningURL()
        .
        Returns:
        emailRecipientPostSigningURL

      • setEmailRecipientPostSigningURL

        public void setEmailRecipientPostSigningURL​(String emailRecipientPostSigningURL)
        setEmailRecipientPostSigningURL.

      • embeddedRecipientStartURL

        public Editor embeddedRecipientStartURL​(String embeddedRecipientStartURL)
        embeddedRecipientStartURL.
        Returns:
        Editor

      • getEmbeddedRecipientStartURL

        public String getEmbeddedRecipientStartURL()
        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. If 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. It 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. If 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. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` .
        Returns:
        embeddedRecipientStartURL

      • setEmbeddedRecipientStartURL

        public void setEmbeddedRecipientStartURL​(String embeddedRecipientStartURL)
        setEmbeddedRecipientStartURL.

      • errorDetails

        public Editor errorDetails​(ErrorDetails errorDetails)
        errorDetails.
        Returns:
        Editor

      • getErrorDetails

        public ErrorDetails getErrorDetails()
        This object describes errors that occur. It is only valid for responses and ignored in requests..
        Returns:
        errorDetails

      • setErrorDetails

        public void setErrorDetails​(ErrorDetails errorDetails)
        setErrorDetails.

      • faxNumber

        public Editor faxNumber​(String faxNumber)
        faxNumber.
        Returns:
        Editor

      • getFaxNumber

        public String getFaxNumber()
        Reserved:.
        Returns:
        faxNumber

      • setFaxNumber

        public void setFaxNumber​(String faxNumber)
        setFaxNumber.

      • faxNumberMetadata

        public Editor faxNumberMetadata​(PropertyMetadata faxNumberMetadata)
        faxNumberMetadata.
        Returns:
        Editor

      • getFaxNumberMetadata

        public PropertyMetadata getFaxNumberMetadata()
        Reserved for DocuSign..
        Returns:
        faxNumberMetadata

      • setFaxNumberMetadata

        public void setFaxNumberMetadata​(PropertyMetadata faxNumberMetadata)
        setFaxNumberMetadata.

      • firstName

        public Editor firstName​(String firstName)
        firstName.
        Returns:
        Editor

      • getFirstName

        public String getFirstName()
        The user's first name. Maximum Length: 50 characters..
        Returns:
        firstName

      • setFirstName

        public void setFirstName​(String firstName)
        setFirstName.

      • firstNameMetadata

        public Editor firstNameMetadata​(PropertyMetadata firstNameMetadata)
        firstNameMetadata.
        Returns:
        Editor

      • getFirstNameMetadata

        public PropertyMetadata getFirstNameMetadata()
        Metadata that indicates whether the `firstName` property is editable. This property is read-only..
        Returns:
        firstNameMetadata

      • setFirstNameMetadata

        public void setFirstNameMetadata​(PropertyMetadata firstNameMetadata)
        setFirstNameMetadata.

      • fullName

        public Editor fullName​(String fullName)
        fullName.
        Returns:
        Editor

      • getFullName

        public String getFullName()
        .
        Returns:
        fullName

      • setFullName

        public void setFullName​(String fullName)
        setFullName.

      • fullNameMetadata

        public Editor fullNameMetadata​(PropertyMetadata fullNameMetadata)
        fullNameMetadata.
        Returns:
        Editor

      • getFullNameMetadata

        public PropertyMetadata getFullNameMetadata()
        Reserved for DocuSign..
        Returns:
        fullNameMetadata

      • setFullNameMetadata

        public void setFullNameMetadata​(PropertyMetadata fullNameMetadata)
        setFullNameMetadata.

      • idCheckConfigurationName

        public Editor idCheckConfigurationName​(String idCheckConfigurationName)
        idCheckConfigurationName.
        Returns:
        Editor

      • getIdCheckConfigurationName

        public String getIdCheckConfigurationName()
        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. *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..
        Returns:
        idCheckConfigurationName

      • setIdCheckConfigurationName

        public void setIdCheckConfigurationName​(String idCheckConfigurationName)
        setIdCheckConfigurationName.

      • idCheckConfigurationNameMetadata

        public Editor idCheckConfigurationNameMetadata​(PropertyMetadata idCheckConfigurationNameMetadata)
        idCheckConfigurationNameMetadata.
        Returns:
        Editor

      • getIdCheckConfigurationNameMetadata

        public PropertyMetadata getIdCheckConfigurationNameMetadata()
        Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only..
        Returns:
        idCheckConfigurationNameMetadata

      • setIdCheckConfigurationNameMetadata

        public void setIdCheckConfigurationNameMetadata​(PropertyMetadata idCheckConfigurationNameMetadata)
        setIdCheckConfigurationNameMetadata.

      • idCheckInformationInput

        public Editor idCheckInformationInput​(IdCheckInformationInput idCheckInformationInput)
        idCheckInformationInput.
        Returns:
        Editor

      • getIdCheckInformationInput

        public IdCheckInformationInput getIdCheckInformationInput()
        An object that contains input information related to a recipient ID check..
        Returns:
        idCheckInformationInput

      • setIdCheckInformationInput

        public void setIdCheckInformationInput​(IdCheckInformationInput idCheckInformationInput)
        setIdCheckInformationInput.

      • getIdentityVerification

        public RecipientIdentityVerification getIdentityVerification()
        Specifies the ID Verification workflow applied on an envelope by workflow ID.
        See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account.
        This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
        Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)..
        Returns:
        identityVerification

      • inheritEmailNotificationConfiguration

        public Editor inheritEmailNotificationConfiguration​(String inheritEmailNotificationConfiguration)
        inheritEmailNotificationConfiguration.
        Returns:
        Editor

      • getInheritEmailNotificationConfiguration

        public String getInheritEmailNotificationConfiguration()
        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. .
        Returns:
        inheritEmailNotificationConfiguration

      • setInheritEmailNotificationConfiguration

        public void setInheritEmailNotificationConfiguration​(String inheritEmailNotificationConfiguration)
        setInheritEmailNotificationConfiguration.

      • lastName

        public Editor lastName​(String lastName)
        lastName.
        Returns:
        Editor

      • getLastName

        public String getLastName()
        .
        Returns:
        lastName

      • setLastName

        public void setLastName​(String lastName)
        setLastName.

      • lastNameMetadata

        public Editor lastNameMetadata​(PropertyMetadata lastNameMetadata)
        lastNameMetadata.
        Returns:
        Editor

      • getLastNameMetadata

        public PropertyMetadata getLastNameMetadata()
        Metadata that indicates whether the `lastName` property is editable. This property is read-only..
        Returns:
        lastNameMetadata

      • setLastNameMetadata

        public void setLastNameMetadata​(PropertyMetadata lastNameMetadata)
        setLastNameMetadata.

      • lockedRecipientPhoneAuthEditable

        public Editor lockedRecipientPhoneAuthEditable​(String lockedRecipientPhoneAuthEditable)
        lockedRecipientPhoneAuthEditable.
        Returns:
        Editor

      • getLockedRecipientPhoneAuthEditable

        public String getLockedRecipientPhoneAuthEditable()
        .
        Returns:
        lockedRecipientPhoneAuthEditable

      • setLockedRecipientPhoneAuthEditable

        public void setLockedRecipientPhoneAuthEditable​(String lockedRecipientPhoneAuthEditable)
        setLockedRecipientPhoneAuthEditable.

      • lockedRecipientSmsEditable

        public Editor lockedRecipientSmsEditable​(String lockedRecipientSmsEditable)
        lockedRecipientSmsEditable.
        Returns:
        Editor

      • getLockedRecipientSmsEditable

        public String getLockedRecipientSmsEditable()
        .
        Returns:
        lockedRecipientSmsEditable

      • setLockedRecipientSmsEditable

        public void setLockedRecipientSmsEditable​(String lockedRecipientSmsEditable)
        setLockedRecipientSmsEditable.

      • name

        public Editor name​(String name)
        name.
        Returns:
        Editor

      • getName

        public String getName()
        legal name of the recipient. Maximum Length: 100 characters..
        Returns:
        name

      • setName

        public void setName​(String name)
        setName.

      • getNameMetadata

        public PropertyMetadata getNameMetadata()
        Metadata that indicates whether the `name` property is editable. This property is read-only..
        Returns:
        nameMetadata

      • setNameMetadata

        public void setNameMetadata​(PropertyMetadata nameMetadata)
        setNameMetadata.

      • note

        public Editor note​(String note)
        note.
        Returns:
        Editor

      • getNote

        public String getNote()
        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. Maximum Length: 1000 characters..
        Returns:
        note

      • setNote

        public void setNote​(String note)
        setNote.

      • getNoteMetadata

        public PropertyMetadata getNoteMetadata()
        Metadata that indicates whether the `note` property is editable. This property is read-only..
        Returns:
        noteMetadata

      • setNoteMetadata

        public void setNoteMetadata​(PropertyMetadata noteMetadata)
        setNoteMetadata.

      • getPhoneAuthentication

        public RecipientPhoneAuthentication getPhoneAuthentication()
        When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: * `recipMayProvideNumber`: Boolean. When **true,** the recipient can use whatever phone number they choose. * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. * `recordVoicePrint`: Reserved for DocuSign. * `validateRecipProvidedNumber`: Reserved for DocuSign. .
        Returns:
        phoneAuthentication

      • getPhoneNumber

        public RecipientPhoneNumber getPhoneNumber()
        Describes the recipient phone number..
        Returns:
        phoneNumber

      • recipientAttachments

        public Editor recipientAttachments​(List<RecipientAttachment> recipientAttachments)
        recipientAttachments.
        Returns:
        Editor

      • addRecipientAttachmentsItem

        public Editor addRecipientAttachmentsItem​(RecipientAttachment recipientAttachmentsItem)
        addRecipientAttachmentsItem.
        Returns:
        Editor

      • getRecipientAttachments

        public List<RecipientAttachment> getRecipientAttachments()
        Reserved:.
        Returns:
        recipientAttachments

      • setRecipientAttachments

        public void setRecipientAttachments​(List<RecipientAttachment> recipientAttachments)
        setRecipientAttachments.

      • recipientAuthenticationStatus

        public Editor recipientAuthenticationStatus​(AuthenticationStatus recipientAuthenticationStatus)
        recipientAuthenticationStatus.
        Returns:
        Editor

      • getRecipientAuthenticationStatus

        public AuthenticationStatus getRecipientAuthenticationStatus()
        Information about the recipient's authentication status. This property is read-only..
        Returns:
        recipientAuthenticationStatus

      • setRecipientAuthenticationStatus

        public void setRecipientAuthenticationStatus​(AuthenticationStatus recipientAuthenticationStatus)
        setRecipientAuthenticationStatus.

      • recipientFeatureMetadata

        public Editor recipientFeatureMetadata​(List<FeatureAvailableMetadata> recipientFeatureMetadata)
        recipientFeatureMetadata.
        Returns:
        Editor

      • addRecipientFeatureMetadataItem

        public Editor addRecipientFeatureMetadataItem​(FeatureAvailableMetadata recipientFeatureMetadataItem)
        addRecipientFeatureMetadataItem.
        Returns:
        Editor

      • setRecipientFeatureMetadata

        public void setRecipientFeatureMetadata​(List<FeatureAvailableMetadata> recipientFeatureMetadata)
        setRecipientFeatureMetadata.

      • recipientId

        public Editor recipientId​(String recipientId)
        recipientId.
        Returns:
        Editor

      • getRecipientId

        public String getRecipientId()
        Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document..
        Returns:
        recipientId

      • setRecipientId

        public void setRecipientId​(String recipientId)
        setRecipientId.

      • recipientIdGuid

        public Editor recipientIdGuid​(String recipientIdGuid)
        recipientIdGuid.
        Returns:
        Editor

      • getRecipientIdGuid

        public String getRecipientIdGuid()
        .
        Returns:
        recipientIdGuid

      • setRecipientIdGuid

        public void setRecipientIdGuid​(String recipientIdGuid)
        setRecipientIdGuid.

      • recipientType

        public Editor recipientType​(String recipientType)
        recipientType.
        Returns:
        Editor

      • getRecipientType

        public String getRecipientType()
        .
        Returns:
        recipientType

      • setRecipientType

        public void setRecipientType​(String recipientType)
        setRecipientType.

      • recipientTypeMetadata

        public Editor recipientTypeMetadata​(PropertyMetadata recipientTypeMetadata)
        recipientTypeMetadata.
        Returns:
        Editor

      • getRecipientTypeMetadata

        public PropertyMetadata getRecipientTypeMetadata()
        Metadata that indicates whether the `recipientType` property is editable. This property is read-only..
        Returns:
        recipientTypeMetadata

      • setRecipientTypeMetadata

        public void setRecipientTypeMetadata​(PropertyMetadata recipientTypeMetadata)
        setRecipientTypeMetadata.

      • requireIdLookup

        public Editor requireIdLookup​(String requireIdLookup)
        requireIdLookup.
        Returns:
        Editor

      • getRequireIdLookup

        public String getRequireIdLookup()
        When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. .
        Returns:
        requireIdLookup

      • setRequireIdLookup

        public void setRequireIdLookup​(String requireIdLookup)
        setRequireIdLookup.

      • requireIdLookupMetadata

        public Editor requireIdLookupMetadata​(PropertyMetadata requireIdLookupMetadata)
        requireIdLookupMetadata.
        Returns:
        Editor

      • getRequireIdLookupMetadata

        public PropertyMetadata getRequireIdLookupMetadata()
        Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only..
        Returns:
        requireIdLookupMetadata

      • setRequireIdLookupMetadata

        public void setRequireIdLookupMetadata​(PropertyMetadata requireIdLookupMetadata)
        setRequireIdLookupMetadata.

      • roleName

        public Editor roleName​(String roleName)
        roleName.
        Returns:
        Editor

      • getRoleName

        public String getRoleName()
        Optional element. Specifies the role name associated with the recipient.

        This is required when working with template recipients..
        Returns:
        roleName

      • setRoleName

        public void setRoleName​(String roleName)
        setRoleName.

      • routingOrder

        public Editor routingOrder​(String routingOrder)
        routingOrder.
        Returns:
        Editor

      • getRoutingOrder

        public String getRoutingOrder()
        Specifies the routing order of the recipient in the envelope. .
        Returns:
        routingOrder

      • setRoutingOrder

        public void setRoutingOrder​(String routingOrder)
        setRoutingOrder.

      • routingOrderMetadata

        public Editor routingOrderMetadata​(PropertyMetadata routingOrderMetadata)
        routingOrderMetadata.
        Returns:
        Editor

      • getRoutingOrderMetadata

        public PropertyMetadata getRoutingOrderMetadata()
        Metadata that indicates whether the `routingOrder` property is editable. This property is read-only..
        Returns:
        routingOrderMetadata

      • setRoutingOrderMetadata

        public void setRoutingOrderMetadata​(PropertyMetadata routingOrderMetadata)
        setRoutingOrderMetadata.

      • sentDateTime

        public Editor sentDateTime​(String sentDateTime)
        sentDateTime.
        Returns:
        Editor

      • getSentDateTime

        public String getSentDateTime()
        The date and time the envelope was sent..
        Returns:
        sentDateTime

      • setSentDateTime

        public void setSentDateTime​(String sentDateTime)
        setSentDateTime.

      • signedDateTime

        public Editor signedDateTime​(String signedDateTime)
        signedDateTime.
        Returns:
        Editor

      • getSignedDateTime

        public String getSignedDateTime()
        Reserved: For DocuSign use only. .
        Returns:
        signedDateTime

      • setSignedDateTime

        public void setSignedDateTime​(String signedDateTime)
        setSignedDateTime.

      • signingGroupId

        public Editor signingGroupId​(String signingGroupId)
        signingGroupId.
        Returns:
        Editor

      • getSigningGroupId

        public String getSigningGroupId()
        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)..
        Returns:
        signingGroupId

      • setSigningGroupId

        public void setSigningGroupId​(String signingGroupId)
        setSigningGroupId.

      • signingGroupIdMetadata

        public Editor signingGroupIdMetadata​(PropertyMetadata signingGroupIdMetadata)
        signingGroupIdMetadata.
        Returns:
        Editor

      • getSigningGroupIdMetadata

        public PropertyMetadata getSigningGroupIdMetadata()
        Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only..
        Returns:
        signingGroupIdMetadata

      • setSigningGroupIdMetadata

        public void setSigningGroupIdMetadata​(PropertyMetadata signingGroupIdMetadata)
        setSigningGroupIdMetadata.

      • signingGroupName

        public Editor signingGroupName​(String signingGroupName)
        signingGroupName.
        Returns:
        Editor

      • getSigningGroupName

        public String getSigningGroupName()
        The display name for the signing group. Maximum Length: 100 characters. .
        Returns:
        signingGroupName

      • setSigningGroupName

        public void setSigningGroupName​(String signingGroupName)
        setSigningGroupName.

      • signingGroupUsers

        public Editor signingGroupUsers​(List<UserInfo> signingGroupUsers)
        signingGroupUsers.
        Returns:
        Editor

      • addSigningGroupUsersItem

        public Editor addSigningGroupUsersItem​(UserInfo signingGroupUsersItem)
        addSigningGroupUsersItem.
        Returns:
        Editor

      • getSigningGroupUsers

        public List<UserInfo> getSigningGroupUsers()
        A complex type that contains information about users in the signing group..
        Returns:
        signingGroupUsers

      • setSigningGroupUsers

        public void setSigningGroupUsers​(List<UserInfo> signingGroupUsers)
        setSigningGroupUsers.

      • getSmsAuthentication

        public RecipientSMSAuthentication getSmsAuthentication()
        When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. .
        Returns:
        smsAuthentication

      • socialAuthentications

        public Editor socialAuthentications​(List<SocialAuthentication> socialAuthentications)
        socialAuthentications.
        Returns:
        Editor

      • addSocialAuthenticationsItem

        public Editor addSocialAuthenticationsItem​(SocialAuthentication socialAuthenticationsItem)
        addSocialAuthenticationsItem.
        Returns:
        Editor

      • getSocialAuthentications

        public List<SocialAuthentication> getSocialAuthentications()
        Lists the social ID type that can be used for recipient authentication..
        Returns:
        socialAuthentications

      • setSocialAuthentications

        public void setSocialAuthentications​(List<SocialAuthentication> socialAuthentications)
        setSocialAuthentications.

      • status

        public Editor status​(String status)
        status.
        Returns:
        Editor

      • getStatus

        public String getStatus()
        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..
        Returns:
        status

      • setStatus

        public void setStatus​(String status)
        setStatus.

      • statusCode

        public Editor statusCode​(String statusCode)
        statusCode.
        Returns:
        Editor

      • getStatusCode

        public String getStatusCode()
        .
        Returns:
        statusCode

      • setStatusCode

        public void setStatusCode​(String statusCode)
        setStatusCode.

      • suppressEmails

        public Editor suppressEmails​(String suppressEmails)
        suppressEmails.
        Returns:
        Editor

      • getSuppressEmails

        public String getSuppressEmails()
        .
        Returns:
        suppressEmails

      • setSuppressEmails

        public void setSuppressEmails​(String suppressEmails)
        setSuppressEmails.

      • templateLocked

        public Editor templateLocked​(String templateLocked)
        templateLocked.
        Returns:
        Editor

      • getTemplateLocked

        public String getTemplateLocked()
        When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. .
        Returns:
        templateLocked

      • setTemplateLocked

        public void setTemplateLocked​(String templateLocked)
        setTemplateLocked.

      • templateRequired

        public Editor templateRequired​(String templateRequired)
        templateRequired.
        Returns:
        Editor

      • getTemplateRequired

        public String getTemplateRequired()
        When set to **true**, the sender may not remove the recipient. Used only when working with template recipients..
        Returns:
        templateRequired

      • setTemplateRequired

        public void setTemplateRequired​(String templateRequired)
        setTemplateRequired.

      • totalTabCount

        public Editor totalTabCount​(String totalTabCount)
        totalTabCount.
        Returns:
        Editor

      • getTotalTabCount

        public String getTotalTabCount()
        .
        Returns:
        totalTabCount

      • setTotalTabCount

        public void setTotalTabCount​(String totalTabCount)
        setTotalTabCount.

      • userId

        public Editor userId​(String userId)
        userId.
        Returns:
        Editor

      • getUserId

        public String getUserId()
        .
        Returns:
        userId

      • setUserId

        public void setUserId​(String userId)
        setUserId.

      • equals

        public boolean equals​(Object o)
        Compares objects.
        Overrides:
        equals in class Object
        Returns:
        true or false depending on comparison result.

      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class Object

      • toString

        public String toString()
        Converts the given object to string.
        Overrides:
        toString in class Object