Package com.docusign.esign.model
Class SealSign
- java.lang.Object
-
- com.docusign.esign.model.SealSign
-
public class SealSign extends Object
Specifies one or more electronic seals to apply on documents. An electronic seal recipient is a legal entity rather than an actual person. Electronic Seals can be used by organizations and governments to show evidence of origin and integrity of documents. Even though electronic seals can be represented by a tab in a document, they do not require user interaction and apply automatically in the order specified by the sender. The sender is therefore the person authorizing usage of the electronic seal in the flow. Example: ```json \"recipients\": { \"seals\": [ { \"recipientId\": \"1\", \"routingOrder\" : 1, \"recipientSignatureProviders\": [ { \"sealName\": \"52e9d968-xxxx-xxxx-xxxx-4682bc45c106\" } ] } ] }, . . . ``` For more information about Electronic Seals, see [Apply Electronic Seals to Your Documents](https://support.docusign.com/en/guides/ndse-user-guide-apply-electronic-seals). .
-
-
Constructor Summary
Constructors Constructor Description SealSign()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SealSignaccessCode(String accessCode)accessCode.SealSignaccessCodeMetadata(PropertyMetadata accessCodeMetadata)accessCodeMetadata.SealSignaddAccessCodeToEmail(String addAccessCodeToEmail)addAccessCodeToEmail.SealSignaddCustomFieldsItem(String customFieldsItem)addCustomFieldsItem.SealSignaddDocumentVisibilityItem(DocumentVisibility documentVisibilityItem)addDocumentVisibilityItem.SealSignaddRecipientAttachmentsItem(RecipientAttachment recipientAttachmentsItem)addRecipientAttachmentsItem.SealSignaddRecipientFeatureMetadataItem(FeatureAvailableMetadata recipientFeatureMetadataItem)addRecipientFeatureMetadataItem.SealSignaddRecipientSignatureProvidersItem(RecipientSignatureProvider recipientSignatureProvidersItem)addRecipientSignatureProvidersItem.SealSignaddSocialAuthenticationsItem(SocialAuthentication socialAuthenticationsItem)addSocialAuthenticationsItem.SealSignallowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)allowSystemOverrideForLockedRecipient.SealSignautoRespondedReason(String autoRespondedReason)autoRespondedReason.SealSignclientUserId(String clientUserId)clientUserId.SealSigncompletedCount(String completedCount)completedCount.SealSigncustomFields(List<String> customFields)customFields.SealSigndeclinedDateTime(String declinedDateTime)declinedDateTime.SealSigndeclinedReason(String declinedReason)declinedReason.SealSigndeliveredDateTime(String deliveredDateTime)deliveredDateTime.SealSigndeliveryMethod(String deliveryMethod)deliveryMethod.SealSigndeliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)deliveryMethodMetadata.SealSigndesignatorId(String designatorId)designatorId.SealSigndesignatorIdGuid(String designatorIdGuid)designatorIdGuid.SealSigndocumentVisibility(List<DocumentVisibility> documentVisibility)documentVisibility.SealSignemailNotification(RecipientEmailNotification emailNotification)emailNotification.SealSignembeddedRecipientStartURL(String embeddedRecipientStartURL)embeddedRecipientStartURL.booleanequals(Object o)Compares objects.SealSignerrorDetails(ErrorDetails errorDetails)errorDetails.SealSignfaxNumber(String faxNumber)faxNumber.SealSignfaxNumberMetadata(PropertyMetadata faxNumberMetadata)faxNumberMetadata.StringgetAccessCode()If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.PropertyMetadatagetAccessCodeMetadata()Not applicable..StringgetAddAccessCodeToEmail()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..StringgetAllowSystemOverrideForLockedRecipient().StringgetAutoRespondedReason().StringgetClientUserId()Specifies whether the recipient is embedded or remote.StringgetCompletedCount().List<String>getCustomFields()An optional array of strings that allows the sender to provide custom data about the recipient.StringgetDeclinedDateTime()The date and time the recipient declined the document..StringgetDeclinedReason()The reason the recipient declined the document..StringgetDeliveredDateTime()Reserved: For DocuSign use only..StringgetDeliveryMethod()Reserved: For DocuSign use only..PropertyMetadatagetDeliveryMethodMetadata()Reserved for DocuSign..StringgetDesignatorId().StringgetDesignatorIdGuid().List<DocumentVisibility>getDocumentVisibility().RecipientEmailNotificationgetEmailNotification()Not applicable..StringgetEmbeddedRecipientStartURL()Specifies a sender provided valid URL string for redirecting an embedded recipient.ErrorDetailsgetErrorDetails()This object describes errors that occur.StringgetFaxNumber()Reserved:.PropertyMetadatagetFaxNumberMetadata()Reserved for DocuSign..StringgetIdCheckConfigurationName()Specifies authentication check by name.PropertyMetadatagetIdCheckConfigurationNameMetadata()Not applicable..IdCheckInformationInputgetIdCheckInformationInput()Not applicable..RecipientIdentityVerificationgetIdentityVerification()Specifies the ID Verification workflow applied on an envelope by workflow ID.StringgetInheritEmailNotificationConfiguration()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.StringgetLockedRecipientPhoneAuthEditable().StringgetLockedRecipientSmsEditable().StringgetName().StringgetNote()Specifies a note that is unique to this recipient.PropertyMetadatagetNoteMetadata()Not applicable..RecipientPhoneAuthenticationgetPhoneAuthentication()Not applicable..List<RecipientAttachment>getRecipientAttachments()Reserved:.AuthenticationStatusgetRecipientAuthenticationStatus()Not applicable..List<FeatureAvailableMetadata>getRecipientFeatureMetadata().StringgetRecipientId()Unique for the recipient.StringgetRecipientIdGuid().List<RecipientSignatureProvider>getRecipientSignatureProviders().StringgetRecipientType().PropertyMetadatagetRecipientTypeMetadata()Metadata that indicates whether the `recipientType` property is editable.StringgetRequireIdLookup()When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.PropertyMetadatagetRequireIdLookupMetadata()Not applicable..StringgetRoleName()Optional element.StringgetRoutingOrder()Specifies the routing order of the recipient in the envelope.PropertyMetadatagetRoutingOrderMetadata()Metadata that indicates whether the `routingOrder` property is editable.StringgetSentDateTime()The date and time the envelope was sent..StringgetSignedDateTime()Reserved: For DocuSign use only.RecipientSMSAuthenticationgetSmsAuthentication()Not applicable..List<SocialAuthentication>getSocialAuthentications()Lists the social ID type that can be used for recipient authentication..StringgetStatus()Indicates the envelope status.StringgetStatusCode().StringgetSuppressEmails().TabsgetTabs()A list of tabs, which are represented graphically as symbols on documents at the time of signing.StringgetTemplateLocked()When set to **true**, the sender cannot change any attributes of the recipient.StringgetTemplateRequired()When set to **true**, the sender may not remove the recipient.StringgetTotalTabCount().StringgetUserId().inthashCode()Returns the HashCode.SealSignidCheckConfigurationName(String idCheckConfigurationName)idCheckConfigurationName.SealSignidCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)idCheckConfigurationNameMetadata.SealSignidCheckInformationInput(IdCheckInformationInput idCheckInformationInput)idCheckInformationInput.SealSignidentityVerification(RecipientIdentityVerification identityVerification)identityVerification.SealSigninheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)inheritEmailNotificationConfiguration.SealSignlockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)lockedRecipientPhoneAuthEditable.SealSignlockedRecipientSmsEditable(String lockedRecipientSmsEditable)lockedRecipientSmsEditable.SealSignname(String name)name.SealSignnote(String note)note.SealSignnoteMetadata(PropertyMetadata noteMetadata)noteMetadata.SealSignphoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)phoneAuthentication.SealSignrecipientAttachments(List<RecipientAttachment> recipientAttachments)recipientAttachments.SealSignrecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)recipientAuthenticationStatus.SealSignrecipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)recipientFeatureMetadata.SealSignrecipientId(String recipientId)recipientId.SealSignrecipientIdGuid(String recipientIdGuid)recipientIdGuid.SealSignrecipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)recipientSignatureProviders.SealSignrecipientType(String recipientType)recipientType.SealSignrecipientTypeMetadata(PropertyMetadata recipientTypeMetadata)recipientTypeMetadata.SealSignrequireIdLookup(String requireIdLookup)requireIdLookup.SealSignrequireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)requireIdLookupMetadata.SealSignroleName(String roleName)roleName.SealSignroutingOrder(String routingOrder)routingOrder.SealSignroutingOrderMetadata(PropertyMetadata routingOrderMetadata)routingOrderMetadata.SealSignsentDateTime(String sentDateTime)sentDateTime.voidsetAccessCode(String accessCode)setAccessCode.voidsetAccessCodeMetadata(PropertyMetadata accessCodeMetadata)setAccessCodeMetadata.voidsetAddAccessCodeToEmail(String addAccessCodeToEmail)setAddAccessCodeToEmail.voidsetAllowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)setAllowSystemOverrideForLockedRecipient.voidsetAutoRespondedReason(String autoRespondedReason)setAutoRespondedReason.voidsetClientUserId(String clientUserId)setClientUserId.voidsetCompletedCount(String completedCount)setCompletedCount.voidsetCustomFields(List<String> customFields)setCustomFields.voidsetDeclinedDateTime(String declinedDateTime)setDeclinedDateTime.voidsetDeclinedReason(String declinedReason)setDeclinedReason.voidsetDeliveredDateTime(String deliveredDateTime)setDeliveredDateTime.voidsetDeliveryMethod(String deliveryMethod)setDeliveryMethod.voidsetDeliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)setDeliveryMethodMetadata.voidsetDesignatorId(String designatorId)setDesignatorId.voidsetDesignatorIdGuid(String designatorIdGuid)setDesignatorIdGuid.voidsetDocumentVisibility(List<DocumentVisibility> documentVisibility)setDocumentVisibility.voidsetEmailNotification(RecipientEmailNotification emailNotification)setEmailNotification.voidsetEmbeddedRecipientStartURL(String embeddedRecipientStartURL)setEmbeddedRecipientStartURL.voidsetErrorDetails(ErrorDetails errorDetails)setErrorDetails.voidsetFaxNumber(String faxNumber)setFaxNumber.voidsetFaxNumberMetadata(PropertyMetadata faxNumberMetadata)setFaxNumberMetadata.voidsetIdCheckConfigurationName(String idCheckConfigurationName)setIdCheckConfigurationName.voidsetIdCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)setIdCheckConfigurationNameMetadata.voidsetIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput)setIdCheckInformationInput.voidsetIdentityVerification(RecipientIdentityVerification identityVerification)setIdentityVerification.voidsetInheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)setInheritEmailNotificationConfiguration.voidsetLockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)setLockedRecipientPhoneAuthEditable.voidsetLockedRecipientSmsEditable(String lockedRecipientSmsEditable)setLockedRecipientSmsEditable.voidsetName(String name)setName.voidsetNote(String note)setNote.voidsetNoteMetadata(PropertyMetadata noteMetadata)setNoteMetadata.voidsetPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)setPhoneAuthentication.voidsetRecipientAttachments(List<RecipientAttachment> recipientAttachments)setRecipientAttachments.voidsetRecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)setRecipientAuthenticationStatus.voidsetRecipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)setRecipientFeatureMetadata.voidsetRecipientId(String recipientId)setRecipientId.voidsetRecipientIdGuid(String recipientIdGuid)setRecipientIdGuid.voidsetRecipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)setRecipientSignatureProviders.voidsetRecipientType(String recipientType)setRecipientType.voidsetRecipientTypeMetadata(PropertyMetadata recipientTypeMetadata)setRecipientTypeMetadata.voidsetRequireIdLookup(String requireIdLookup)setRequireIdLookup.voidsetRequireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)setRequireIdLookupMetadata.voidsetRoleName(String roleName)setRoleName.voidsetRoutingOrder(String routingOrder)setRoutingOrder.voidsetRoutingOrderMetadata(PropertyMetadata routingOrderMetadata)setRoutingOrderMetadata.voidsetSentDateTime(String sentDateTime)setSentDateTime.voidsetSignedDateTime(String signedDateTime)setSignedDateTime.voidsetSmsAuthentication(RecipientSMSAuthentication smsAuthentication)setSmsAuthentication.voidsetSocialAuthentications(List<SocialAuthentication> socialAuthentications)setSocialAuthentications.voidsetStatus(String status)setStatus.voidsetStatusCode(String statusCode)setStatusCode.voidsetSuppressEmails(String suppressEmails)setSuppressEmails.voidsetTabs(Tabs tabs)setTabs.voidsetTemplateLocked(String templateLocked)setTemplateLocked.voidsetTemplateRequired(String templateRequired)setTemplateRequired.voidsetTotalTabCount(String totalTabCount)setTotalTabCount.voidsetUserId(String userId)setUserId.SealSignsignedDateTime(String signedDateTime)signedDateTime.SealSignsmsAuthentication(RecipientSMSAuthentication smsAuthentication)smsAuthentication.SealSignsocialAuthentications(List<SocialAuthentication> socialAuthentications)socialAuthentications.SealSignstatus(String status)status.SealSignstatusCode(String statusCode)statusCode.SealSignsuppressEmails(String suppressEmails)suppressEmails.SealSigntabs(Tabs tabs)tabs.SealSigntemplateLocked(String templateLocked)templateLocked.SealSigntemplateRequired(String templateRequired)templateRequired.StringtoString()Converts the given object to string.SealSigntotalTabCount(String totalTabCount)totalTabCount.SealSignuserId(String userId)userId.
-
-
-
Method Detail
-
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 SealSign accessCodeMetadata(PropertyMetadata accessCodeMetadata)
accessCodeMetadata.- Returns:
- SealSign
-
getAccessCodeMetadata
public PropertyMetadata getAccessCodeMetadata()
Not applicable..- Returns:
- accessCodeMetadata
-
setAccessCodeMetadata
public void setAccessCodeMetadata(PropertyMetadata accessCodeMetadata)
setAccessCodeMetadata.
-
addAccessCodeToEmail
public SealSign addAccessCodeToEmail(String addAccessCodeToEmail)
addAccessCodeToEmail.- Returns:
- SealSign
-
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.
-
allowSystemOverrideForLockedRecipient
public SealSign allowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)
allowSystemOverrideForLockedRecipient.- Returns:
- SealSign
-
getAllowSystemOverrideForLockedRecipient
public String getAllowSystemOverrideForLockedRecipient()
.- Returns:
- allowSystemOverrideForLockedRecipient
-
setAllowSystemOverrideForLockedRecipient
public void setAllowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)
setAllowSystemOverrideForLockedRecipient.
-
autoRespondedReason
public SealSign autoRespondedReason(String autoRespondedReason)
autoRespondedReason.- Returns:
- SealSign
-
getAutoRespondedReason
public String getAutoRespondedReason()
.- Returns:
- autoRespondedReason
-
setAutoRespondedReason
public void setAutoRespondedReason(String autoRespondedReason)
setAutoRespondedReason.
-
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 SealSign completedCount(String completedCount)
completedCount.- Returns:
- SealSign
-
getCompletedCount
public String getCompletedCount()
.- Returns:
- completedCount
-
setCompletedCount
public void setCompletedCount(String completedCount)
setCompletedCount.
-
customFields
public SealSign customFields(List<String> customFields)
customFields.- Returns:
- SealSign
-
addCustomFieldsItem
public SealSign addCustomFieldsItem(String customFieldsItem)
addCustomFieldsItem.- Returns:
- SealSign
-
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
-
declinedDateTime
public SealSign declinedDateTime(String declinedDateTime)
declinedDateTime.- Returns:
- SealSign
-
getDeclinedDateTime
public String getDeclinedDateTime()
The date and time the recipient declined the document..- Returns:
- declinedDateTime
-
setDeclinedDateTime
public void setDeclinedDateTime(String declinedDateTime)
setDeclinedDateTime.
-
declinedReason
public SealSign declinedReason(String declinedReason)
declinedReason.- Returns:
- SealSign
-
getDeclinedReason
public String getDeclinedReason()
The reason the recipient declined the document..- Returns:
- declinedReason
-
setDeclinedReason
public void setDeclinedReason(String declinedReason)
setDeclinedReason.
-
deliveredDateTime
public SealSign deliveredDateTime(String deliveredDateTime)
deliveredDateTime.- Returns:
- SealSign
-
getDeliveredDateTime
public String getDeliveredDateTime()
Reserved: For DocuSign use only..- Returns:
- deliveredDateTime
-
setDeliveredDateTime
public void setDeliveredDateTime(String deliveredDateTime)
setDeliveredDateTime.
-
deliveryMethod
public SealSign deliveryMethod(String deliveryMethod)
deliveryMethod.- Returns:
- SealSign
-
getDeliveryMethod
public String getDeliveryMethod()
Reserved: For DocuSign use only..- Returns:
- deliveryMethod
-
setDeliveryMethod
public void setDeliveryMethod(String deliveryMethod)
setDeliveryMethod.
-
deliveryMethodMetadata
public SealSign deliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)
deliveryMethodMetadata.- Returns:
- SealSign
-
getDeliveryMethodMetadata
public PropertyMetadata getDeliveryMethodMetadata()
Reserved for DocuSign..- Returns:
- deliveryMethodMetadata
-
setDeliveryMethodMetadata
public void setDeliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)
setDeliveryMethodMetadata.
-
getDesignatorId
public String getDesignatorId()
.- Returns:
- designatorId
-
setDesignatorId
public void setDesignatorId(String designatorId)
setDesignatorId.
-
designatorIdGuid
public SealSign designatorIdGuid(String designatorIdGuid)
designatorIdGuid.- Returns:
- SealSign
-
getDesignatorIdGuid
public String getDesignatorIdGuid()
.- Returns:
- designatorIdGuid
-
setDesignatorIdGuid
public void setDesignatorIdGuid(String designatorIdGuid)
setDesignatorIdGuid.
-
documentVisibility
public SealSign documentVisibility(List<DocumentVisibility> documentVisibility)
documentVisibility.- Returns:
- SealSign
-
addDocumentVisibilityItem
public SealSign addDocumentVisibilityItem(DocumentVisibility documentVisibilityItem)
addDocumentVisibilityItem.- Returns:
- SealSign
-
getDocumentVisibility
public List<DocumentVisibility> getDocumentVisibility()
.- Returns:
- documentVisibility
-
setDocumentVisibility
public void setDocumentVisibility(List<DocumentVisibility> documentVisibility)
setDocumentVisibility.
-
emailNotification
public SealSign emailNotification(RecipientEmailNotification emailNotification)
emailNotification.- Returns:
- SealSign
-
getEmailNotification
public RecipientEmailNotification getEmailNotification()
Not applicable..- Returns:
- emailNotification
-
setEmailNotification
public void setEmailNotification(RecipientEmailNotification emailNotification)
setEmailNotification.
-
embeddedRecipientStartURL
public SealSign embeddedRecipientStartURL(String embeddedRecipientStartURL)
embeddedRecipientStartURL.- Returns:
- SealSign
-
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 SealSign errorDetails(ErrorDetails errorDetails)
errorDetails.- Returns:
- SealSign
-
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.
-
getFaxNumber
public String getFaxNumber()
Reserved:.- Returns:
- faxNumber
-
setFaxNumber
public void setFaxNumber(String faxNumber)
setFaxNumber.
-
faxNumberMetadata
public SealSign faxNumberMetadata(PropertyMetadata faxNumberMetadata)
faxNumberMetadata.- Returns:
- SealSign
-
getFaxNumberMetadata
public PropertyMetadata getFaxNumberMetadata()
Reserved for DocuSign..- Returns:
- faxNumberMetadata
-
setFaxNumberMetadata
public void setFaxNumberMetadata(PropertyMetadata faxNumberMetadata)
setFaxNumberMetadata.
-
idCheckConfigurationName
public SealSign idCheckConfigurationName(String idCheckConfigurationName)
idCheckConfigurationName.- Returns:
- SealSign
-
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 SealSign idCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)
idCheckConfigurationNameMetadata.- Returns:
- SealSign
-
getIdCheckConfigurationNameMetadata
public PropertyMetadata getIdCheckConfigurationNameMetadata()
Not applicable..- Returns:
- idCheckConfigurationNameMetadata
-
setIdCheckConfigurationNameMetadata
public void setIdCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)
setIdCheckConfigurationNameMetadata.
-
idCheckInformationInput
public SealSign idCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
idCheckInformationInput.- Returns:
- SealSign
-
getIdCheckInformationInput
public IdCheckInformationInput getIdCheckInformationInput()
Not applicable..- Returns:
- idCheckInformationInput
-
setIdCheckInformationInput
public void setIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
setIdCheckInformationInput.
-
identityVerification
public SealSign identityVerification(RecipientIdentityVerification identityVerification)
identityVerification.- Returns:
- SealSign
-
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
-
setIdentityVerification
public void setIdentityVerification(RecipientIdentityVerification identityVerification)
setIdentityVerification.
-
inheritEmailNotificationConfiguration
public SealSign inheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)
inheritEmailNotificationConfiguration.- Returns:
- SealSign
-
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.
-
lockedRecipientPhoneAuthEditable
public SealSign lockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)
lockedRecipientPhoneAuthEditable.- Returns:
- SealSign
-
getLockedRecipientPhoneAuthEditable
public String getLockedRecipientPhoneAuthEditable()
.- Returns:
- lockedRecipientPhoneAuthEditable
-
setLockedRecipientPhoneAuthEditable
public void setLockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)
setLockedRecipientPhoneAuthEditable.
-
lockedRecipientSmsEditable
public SealSign lockedRecipientSmsEditable(String lockedRecipientSmsEditable)
lockedRecipientSmsEditable.- Returns:
- SealSign
-
getLockedRecipientSmsEditable
public String getLockedRecipientSmsEditable()
.- Returns:
- lockedRecipientSmsEditable
-
setLockedRecipientSmsEditable
public void setLockedRecipientSmsEditable(String lockedRecipientSmsEditable)
setLockedRecipientSmsEditable.
-
getName
public String getName()
.- 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.
-
noteMetadata
public SealSign noteMetadata(PropertyMetadata noteMetadata)
noteMetadata.- Returns:
- SealSign
-
getNoteMetadata
public PropertyMetadata getNoteMetadata()
Not applicable..- Returns:
- noteMetadata
-
setNoteMetadata
public void setNoteMetadata(PropertyMetadata noteMetadata)
setNoteMetadata.
-
phoneAuthentication
public SealSign phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
phoneAuthentication.- Returns:
- SealSign
-
getPhoneAuthentication
public RecipientPhoneAuthentication getPhoneAuthentication()
Not applicable..- Returns:
- phoneAuthentication
-
setPhoneAuthentication
public void setPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
setPhoneAuthentication.
-
recipientAttachments
public SealSign recipientAttachments(List<RecipientAttachment> recipientAttachments)
recipientAttachments.- Returns:
- SealSign
-
addRecipientAttachmentsItem
public SealSign addRecipientAttachmentsItem(RecipientAttachment recipientAttachmentsItem)
addRecipientAttachmentsItem.- Returns:
- SealSign
-
getRecipientAttachments
public List<RecipientAttachment> getRecipientAttachments()
Reserved:.- Returns:
- recipientAttachments
-
setRecipientAttachments
public void setRecipientAttachments(List<RecipientAttachment> recipientAttachments)
setRecipientAttachments.
-
recipientAuthenticationStatus
public SealSign recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
recipientAuthenticationStatus.- Returns:
- SealSign
-
getRecipientAuthenticationStatus
public AuthenticationStatus getRecipientAuthenticationStatus()
Not applicable..- Returns:
- recipientAuthenticationStatus
-
setRecipientAuthenticationStatus
public void setRecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
setRecipientAuthenticationStatus.
-
recipientFeatureMetadata
public SealSign recipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)
recipientFeatureMetadata.- Returns:
- SealSign
-
addRecipientFeatureMetadataItem
public SealSign addRecipientFeatureMetadataItem(FeatureAvailableMetadata recipientFeatureMetadataItem)
addRecipientFeatureMetadataItem.- Returns:
- SealSign
-
getRecipientFeatureMetadata
public List<FeatureAvailableMetadata> getRecipientFeatureMetadata()
.- Returns:
- recipientFeatureMetadata
-
setRecipientFeatureMetadata
public void setRecipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)
setRecipientFeatureMetadata.
-
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 SealSign recipientIdGuid(String recipientIdGuid)
recipientIdGuid.- Returns:
- SealSign
-
getRecipientIdGuid
public String getRecipientIdGuid()
.- Returns:
- recipientIdGuid
-
setRecipientIdGuid
public void setRecipientIdGuid(String recipientIdGuid)
setRecipientIdGuid.
-
recipientSignatureProviders
public SealSign recipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)
recipientSignatureProviders.- Returns:
- SealSign
-
addRecipientSignatureProvidersItem
public SealSign addRecipientSignatureProvidersItem(RecipientSignatureProvider recipientSignatureProvidersItem)
addRecipientSignatureProvidersItem.- Returns:
- SealSign
-
getRecipientSignatureProviders
public List<RecipientSignatureProvider> getRecipientSignatureProviders()
.- Returns:
- recipientSignatureProviders
-
setRecipientSignatureProviders
public void setRecipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)
setRecipientSignatureProviders.
-
getRecipientType
public String getRecipientType()
.- Returns:
- recipientType
-
setRecipientType
public void setRecipientType(String recipientType)
setRecipientType.
-
recipientTypeMetadata
public SealSign recipientTypeMetadata(PropertyMetadata recipientTypeMetadata)
recipientTypeMetadata.- Returns:
- SealSign
-
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 SealSign requireIdLookup(String requireIdLookup)
requireIdLookup.- Returns:
- SealSign
-
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 SealSign requireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)
requireIdLookupMetadata.- Returns:
- SealSign
-
getRequireIdLookupMetadata
public PropertyMetadata getRequireIdLookupMetadata()
Not applicable..- Returns:
- requireIdLookupMetadata
-
setRequireIdLookupMetadata
public void setRequireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)
setRequireIdLookupMetadata.
-
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.
-
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 SealSign routingOrderMetadata(PropertyMetadata routingOrderMetadata)
routingOrderMetadata.- Returns:
- SealSign
-
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.
-
getSentDateTime
public String getSentDateTime()
The date and time the envelope was sent..- Returns:
- sentDateTime
-
setSentDateTime
public void setSentDateTime(String sentDateTime)
setSentDateTime.
-
signedDateTime
public SealSign signedDateTime(String signedDateTime)
signedDateTime.- Returns:
- SealSign
-
getSignedDateTime
public String getSignedDateTime()
Reserved: For DocuSign use only. .- Returns:
- signedDateTime
-
setSignedDateTime
public void setSignedDateTime(String signedDateTime)
setSignedDateTime.
-
smsAuthentication
public SealSign smsAuthentication(RecipientSMSAuthentication smsAuthentication)
smsAuthentication.- Returns:
- SealSign
-
getSmsAuthentication
public RecipientSMSAuthentication getSmsAuthentication()
Not applicable..- Returns:
- smsAuthentication
-
setSmsAuthentication
public void setSmsAuthentication(RecipientSMSAuthentication smsAuthentication)
setSmsAuthentication.
-
socialAuthentications
public SealSign socialAuthentications(List<SocialAuthentication> socialAuthentications)
socialAuthentications.- Returns:
- SealSign
-
addSocialAuthenticationsItem
public SealSign addSocialAuthenticationsItem(SocialAuthentication socialAuthenticationsItem)
addSocialAuthenticationsItem.- Returns:
- SealSign
-
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.
-
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.
-
getStatusCode
public String getStatusCode()
.- Returns:
- statusCode
-
setStatusCode
public void setStatusCode(String statusCode)
setStatusCode.
-
suppressEmails
public SealSign suppressEmails(String suppressEmails)
suppressEmails.- Returns:
- SealSign
-
getSuppressEmails
public String getSuppressEmails()
.- Returns:
- suppressEmails
-
setSuppressEmails
public void setSuppressEmails(String suppressEmails)
setSuppressEmails.
-
getTabs
public Tabs getTabs()
A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients..- Returns:
- tabs
-
setTabs
public void setTabs(Tabs tabs)
setTabs.
-
templateLocked
public SealSign templateLocked(String templateLocked)
templateLocked.- Returns:
- SealSign
-
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 SealSign templateRequired(String templateRequired)
templateRequired.- Returns:
- SealSign
-
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.
-
getTotalTabCount
public String getTotalTabCount()
.- Returns:
- totalTabCount
-
setTotalTabCount
public void setTotalTabCount(String totalTabCount)
setTotalTabCount.
-
getUserId
public String getUserId()
.- Returns:
- userId
-
setUserId
public void setUserId(String userId)
setUserId.
-
equals
public boolean equals(Object o)
Compares objects.
-
-