Package com.docusign.esign.model

Class CarbonCopy

  • public class CarbonCopy
extends Object
    CarbonCopy.

    • Constructor Detail

      • CarbonCopy

        public CarbonCopy()

    • Method Detail

      • accessCode

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

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

      • addAccessCodeToEmail

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

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

      • agentCanEditEmail

        public CarbonCopy agentCanEditEmail​(String agentCanEditEmail)
        agentCanEditEmail.
        Returns:
        CarbonCopy

      • getAgentCanEditEmail

        public String getAgentCanEditEmail()
        .
        Returns:
        agentCanEditEmail

      • setAgentCanEditEmail

        public void setAgentCanEditEmail​(String agentCanEditEmail)
        setAgentCanEditEmail.

      • agentCanEditName

        public CarbonCopy agentCanEditName​(String agentCanEditName)
        agentCanEditName.
        Returns:
        CarbonCopy

      • getAgentCanEditName

        public String getAgentCanEditName()
        .
        Returns:
        agentCanEditName

      • setAgentCanEditName

        public void setAgentCanEditName​(String agentCanEditName)
        setAgentCanEditName.

      • clientUserId

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

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

      • customFields

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

      • addCustomFieldsItem

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

      • 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 CarbonCopy declinedDateTime​(String declinedDateTime)
        declinedDateTime.
        Returns:
        CarbonCopy

      • getDeclinedDateTime

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

      • setDeclinedDateTime

        public void setDeclinedDateTime​(String declinedDateTime)
        setDeclinedDateTime.

      • declinedReason

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

      • getDeclinedReason

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

      • setDeclinedReason

        public void setDeclinedReason​(String declinedReason)
        setDeclinedReason.

      • deliveredDateTime

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

      • getDeliveredDateTime

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

      • setDeliveredDateTime

        public void setDeliveredDateTime​(String deliveredDateTime)
        setDeliveredDateTime.

      • deliveryMethod

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

      • getDeliveryMethod

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

      • setDeliveryMethod

        public void setDeliveryMethod​(String deliveryMethod)
        setDeliveryMethod.

      • addDocumentVisibilityItem

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

      • getDocumentVisibility

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

      • setDocumentVisibility

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

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

      • getEmailNotification

        public RecipientEmailNotification getEmailNotification()
        Get emailNotification.
        Returns:
        emailNotification

      • emailRecipientPostSigningURL

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

      • getEmailRecipientPostSigningURL

        public String getEmailRecipientPostSigningURL()
        .
        Returns:
        emailRecipientPostSigningURL

      • setEmailRecipientPostSigningURL

        public void setEmailRecipientPostSigningURL​(String emailRecipientPostSigningURL)
        setEmailRecipientPostSigningURL.

      • embeddedRecipientStartURL

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

      • 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 CarbonCopy errorDetails​(ErrorDetails errorDetails)
        errorDetails.
        Returns:
        CarbonCopy

      • getErrorDetails

        public ErrorDetails getErrorDetails()
        Get errorDetails.
        Returns:
        errorDetails

      • setErrorDetails

        public void setErrorDetails​(ErrorDetails errorDetails)
        setErrorDetails.

      • excludedDocuments

        public CarbonCopy excludedDocuments​(List<String> excludedDocuments)
        excludedDocuments.
        Returns:
        CarbonCopy

      • addExcludedDocumentsItem

        public CarbonCopy addExcludedDocumentsItem​(String excludedDocumentsItem)
        addExcludedDocumentsItem.
        Returns:
        CarbonCopy

      • getExcludedDocuments

        public List<String> getExcludedDocuments()
        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. When 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..
        Returns:
        excludedDocuments

      • setExcludedDocuments

        public void setExcludedDocuments​(List<String> excludedDocuments)
        setExcludedDocuments.

      • faxNumber

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

      • getFaxNumber

        public String getFaxNumber()
        Reserved:.
        Returns:
        faxNumber

      • setFaxNumber

        public void setFaxNumber​(String faxNumber)
        setFaxNumber.

      • firstName

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

      • getFirstName

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

      • setFirstName

        public void setFirstName​(String firstName)
        setFirstName.

      • fullName

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

      • getFullName

        public String getFullName()
        .
        Returns:
        fullName

      • setFullName

        public void setFullName​(String fullName)
        setFullName.

      • idCheckConfigurationName

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

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

      • idCheckInformationInput

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

      • getIdCheckInformationInput

        public IdCheckInformationInput getIdCheckInformationInput()
        Get idCheckInformationInput.
        Returns:
        idCheckInformationInput

      • setIdCheckInformationInput

        public void setIdCheckInformationInput​(IdCheckInformationInput idCheckInformationInput)
        setIdCheckInformationInput.

      • getIdentityVerification

        public RecipientIdentityVerification getIdentityVerification()
        Get identityVerification.
        Returns:
        identityVerification

      • inheritEmailNotificationConfiguration

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

      • 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 CarbonCopy lastName​(String lastName)
        lastName.
        Returns:
        CarbonCopy

      • getLastName

        public String getLastName()
        .
        Returns:
        lastName

      • setLastName

        public void setLastName​(String lastName)
        setLastName.

      • getName

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

      • setName

        public void setName​(String name)
        setName.

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

      • getPhoneAuthentication

        public RecipientPhoneAuthentication getPhoneAuthentication()
        Get phoneAuthentication.
        Returns:
        phoneAuthentication

      • getProofFile

        public RecipientProofFile getProofFile()
        Get proofFile.
        Returns:
        proofFile

      • addRecipientAttachmentsItem

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

      • getRecipientAttachments

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

      • setRecipientAttachments

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

      • recipientAuthenticationStatus

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

      • getRecipientAuthenticationStatus

        public AuthenticationStatus getRecipientAuthenticationStatus()
        Get recipientAuthenticationStatus.
        Returns:
        recipientAuthenticationStatus

      • setRecipientAuthenticationStatus

        public void setRecipientAuthenticationStatus​(AuthenticationStatus recipientAuthenticationStatus)
        setRecipientAuthenticationStatus.

      • recipientId

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

      • 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 CarbonCopy recipientIdGuid​(String recipientIdGuid)
        recipientIdGuid.
        Returns:
        CarbonCopy

      • getRecipientIdGuid

        public String getRecipientIdGuid()
        .
        Returns:
        recipientIdGuid

      • setRecipientIdGuid

        public void setRecipientIdGuid​(String recipientIdGuid)
        setRecipientIdGuid.

      • requireIdLookup

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

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

      • roleName

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

      • 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 CarbonCopy routingOrder​(String routingOrder)
        routingOrder.
        Returns:
        CarbonCopy

      • getRoutingOrder

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

      • setRoutingOrder

        public void setRoutingOrder​(String routingOrder)
        setRoutingOrder.

      • getSamlAuthentication

        public RecipientSAMLAuthentication getSamlAuthentication()
        Get samlAuthentication.
        Returns:
        samlAuthentication

      • sentDateTime

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

      • getSentDateTime

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

      • setSentDateTime

        public void setSentDateTime​(String sentDateTime)
        setSentDateTime.

      • signedDateTime

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

      • getSignedDateTime

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

      • setSignedDateTime

        public void setSignedDateTime​(String signedDateTime)
        setSignedDateTime.

      • signingGroupId

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

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

      • signingGroupName

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

      • 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 CarbonCopy signingGroupUsers​(List<UserInfo> signingGroupUsers)
        signingGroupUsers.
        Returns:
        CarbonCopy

      • addSigningGroupUsersItem

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

      • 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()
        Get smsAuthentication.
        Returns:
        smsAuthentication

      • addSocialAuthenticationsItem

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

      • 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 CarbonCopy status​(String status)
        status.
        Returns:
        CarbonCopy

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

      • templateLocked

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

      • 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 CarbonCopy templateRequired​(String templateRequired)
        templateRequired.
        Returns:
        CarbonCopy

      • 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 CarbonCopy totalTabCount​(String totalTabCount)
        totalTabCount.
        Returns:
        CarbonCopy

      • getTotalTabCount

        public String getTotalTabCount()
        .
        Returns:
        totalTabCount

      • setTotalTabCount

        public void setTotalTabCount​(String totalTabCount)
        setTotalTabCount.

      • userId

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

      • 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