Package com.docusign.esign.model
Class SealSign
- java.lang.Object
-
- com.docusign.esign.model.SealSign
-
public class SealSign extends java.lang.ObjectSealSign.
-
-
Constructor Summary
Constructors Constructor Description SealSign()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SealSignaccessCode(java.lang.String accessCode)accessCode.SealSignaccessCodeMetadata(PropertyMetadata accessCodeMetadata)accessCodeMetadata.SealSignaddAccessCodeToEmail(java.lang.String addAccessCodeToEmail)addAccessCodeToEmail.SealSignaddCustomFieldsItem(java.lang.String customFieldsItem)addCustomFieldsItem.SealSignaddDocumentVisibilityItem(DocumentVisibility documentVisibilityItem)addDocumentVisibilityItem.SealSignaddRecipientAttachmentsItem(RecipientAttachment recipientAttachmentsItem)addRecipientAttachmentsItem.SealSignaddRecipientFeatureMetadataItem(FeatureAvailableMetadata recipientFeatureMetadataItem)addRecipientFeatureMetadataItem.SealSignaddRecipientSignatureProvidersItem(RecipientSignatureProvider recipientSignatureProvidersItem)addRecipientSignatureProvidersItem.SealSignaddSocialAuthenticationsItem(SocialAuthentication socialAuthenticationsItem)addSocialAuthenticationsItem.SealSignallowSystemOverrideForLockedRecipient(java.lang.String allowSystemOverrideForLockedRecipient)allowSystemOverrideForLockedRecipient.SealSignautoRespondedReason(java.lang.String autoRespondedReason)autoRespondedReason.SealSignclientUserId(java.lang.String clientUserId)clientUserId.SealSigncompletedCount(java.lang.String completedCount)completedCount.SealSigncustomFields(java.util.List<java.lang.String> customFields)customFields.SealSigndeclinedDateTime(java.lang.String declinedDateTime)declinedDateTime.SealSigndeclinedReason(java.lang.String declinedReason)declinedReason.SealSigndeliveredDateTime(java.lang.String deliveredDateTime)deliveredDateTime.SealSigndeliveryMethod(java.lang.String deliveryMethod)deliveryMethod.SealSigndeliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)deliveryMethodMetadata.SealSigndesignatorId(java.lang.String designatorId)designatorId.SealSigndesignatorIdGuid(java.lang.String designatorIdGuid)designatorIdGuid.SealSigndocumentVisibility(java.util.List<DocumentVisibility> documentVisibility)documentVisibility.SealSignemailNotification(RecipientEmailNotification emailNotification)emailNotification.SealSignembeddedRecipientStartURL(java.lang.String embeddedRecipientStartURL)embeddedRecipientStartURL.booleanequals(java.lang.Object o)Compares objects.SealSignerrorDetails(ErrorDetails errorDetails)errorDetails.SealSignfaxNumber(java.lang.String faxNumber)faxNumber.SealSignfaxNumberMetadata(PropertyMetadata faxNumberMetadata)faxNumberMetadata.java.lang.StringgetAccessCode()If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.PropertyMetadatagetAccessCodeMetadata()Get accessCodeMetadata.java.lang.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..java.lang.StringgetAllowSystemOverrideForLockedRecipient().java.lang.StringgetAutoRespondedReason().java.lang.StringgetClientUserId()Specifies whether the recipient is embedded or remote.java.lang.StringgetCompletedCount().java.util.List<java.lang.String>getCustomFields()An optional array of strings that allows the sender to provide custom data about the recipient.java.lang.StringgetDeclinedDateTime()The date and time the recipient declined the document..java.lang.StringgetDeclinedReason()The reason the recipient declined the document..java.lang.StringgetDeliveredDateTime()Reserved: For DocuSign use only..java.lang.StringgetDeliveryMethod()Reserved: For DocuSign use only..PropertyMetadatagetDeliveryMethodMetadata()Get deliveryMethodMetadata.java.lang.StringgetDesignatorId().java.lang.StringgetDesignatorIdGuid().java.util.List<DocumentVisibility>getDocumentVisibility().RecipientEmailNotificationgetEmailNotification()Get emailNotification.java.lang.StringgetEmbeddedRecipientStartURL()Specifies a sender provided valid URL string for redirecting an embedded recipient.ErrorDetailsgetErrorDetails()Get errorDetails.java.lang.StringgetFaxNumber()Reserved:.PropertyMetadatagetFaxNumberMetadata()Get faxNumberMetadata.java.lang.StringgetIdCheckConfigurationName()Specifies authentication check by name.PropertyMetadatagetIdCheckConfigurationNameMetadata()Get idCheckConfigurationNameMetadata.IdCheckInformationInputgetIdCheckInformationInput()Get idCheckInformationInput.RecipientIdentityVerificationgetIdentityVerification()Get identityVerification.java.lang.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.java.lang.StringgetLockedRecipientPhoneAuthEditable().java.lang.StringgetLockedRecipientSmsEditable().java.lang.StringgetName().java.lang.StringgetNote()Specifies a note that is unique to this recipient.PropertyMetadatagetNoteMetadata()Get noteMetadata.RecipientPhoneAuthenticationgetPhoneAuthentication()Get phoneAuthentication.java.util.List<RecipientAttachment>getRecipientAttachments()Reserved:.AuthenticationStatusgetRecipientAuthenticationStatus()Get recipientAuthenticationStatus.java.util.List<FeatureAvailableMetadata>getRecipientFeatureMetadata().java.lang.StringgetRecipientId()Unique for the recipient.java.lang.StringgetRecipientIdGuid().java.util.List<RecipientSignatureProvider>getRecipientSignatureProviders().java.lang.StringgetRecipientType().PropertyMetadatagetRecipientTypeMetadata()Get recipientTypeMetadata.java.lang.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()Get requireIdLookupMetadata.java.lang.StringgetRoleName()Optional element.java.lang.StringgetRoutingOrder()Specifies the routing order of the recipient in the envelope.PropertyMetadatagetRoutingOrderMetadata()Get routingOrderMetadata.java.lang.StringgetSentDateTime()The date and time the envelope was sent..java.lang.StringgetSignedDateTime()Reserved: For DocuSign use only.RecipientSMSAuthenticationgetSmsAuthentication()Get smsAuthentication.java.util.List<SocialAuthentication>getSocialAuthentications()Lists the social ID type that can be used for recipient authentication..java.lang.StringgetStatus()Indicates the envelope status.java.lang.StringgetStatusCode().java.lang.StringgetSuppressEmails().TabsgetTabs()Get tabs.java.lang.StringgetTemplateLocked()When set to **true**, the sender cannot change any attributes of the recipient.java.lang.StringgetTemplateRequired()When set to **true**, the sender may not remove the recipient.java.lang.StringgetTotalTabCount().java.lang.StringgetUserId().inthashCode()Returns the HashCode.SealSignidCheckConfigurationName(java.lang.String idCheckConfigurationName)idCheckConfigurationName.SealSignidCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)idCheckConfigurationNameMetadata.SealSignidCheckInformationInput(IdCheckInformationInput idCheckInformationInput)idCheckInformationInput.SealSignidentityVerification(RecipientIdentityVerification identityVerification)identityVerification.SealSigninheritEmailNotificationConfiguration(java.lang.String inheritEmailNotificationConfiguration)inheritEmailNotificationConfiguration.SealSignlockedRecipientPhoneAuthEditable(java.lang.String lockedRecipientPhoneAuthEditable)lockedRecipientPhoneAuthEditable.SealSignlockedRecipientSmsEditable(java.lang.String lockedRecipientSmsEditable)lockedRecipientSmsEditable.SealSignname(java.lang.String name)name.SealSignnote(java.lang.String note)note.SealSignnoteMetadata(PropertyMetadata noteMetadata)noteMetadata.SealSignphoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)phoneAuthentication.SealSignrecipientAttachments(java.util.List<RecipientAttachment> recipientAttachments)recipientAttachments.SealSignrecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)recipientAuthenticationStatus.SealSignrecipientFeatureMetadata(java.util.List<FeatureAvailableMetadata> recipientFeatureMetadata)recipientFeatureMetadata.SealSignrecipientId(java.lang.String recipientId)recipientId.SealSignrecipientIdGuid(java.lang.String recipientIdGuid)recipientIdGuid.SealSignrecipientSignatureProviders(java.util.List<RecipientSignatureProvider> recipientSignatureProviders)recipientSignatureProviders.SealSignrecipientType(java.lang.String recipientType)recipientType.SealSignrecipientTypeMetadata(PropertyMetadata recipientTypeMetadata)recipientTypeMetadata.SealSignrequireIdLookup(java.lang.String requireIdLookup)requireIdLookup.SealSignrequireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)requireIdLookupMetadata.SealSignroleName(java.lang.String roleName)roleName.SealSignroutingOrder(java.lang.String routingOrder)routingOrder.SealSignroutingOrderMetadata(PropertyMetadata routingOrderMetadata)routingOrderMetadata.SealSignsentDateTime(java.lang.String sentDateTime)sentDateTime.voidsetAccessCode(java.lang.String accessCode)setAccessCode.voidsetAccessCodeMetadata(PropertyMetadata accessCodeMetadata)setAccessCodeMetadata.voidsetAddAccessCodeToEmail(java.lang.String addAccessCodeToEmail)setAddAccessCodeToEmail.voidsetAllowSystemOverrideForLockedRecipient(java.lang.String allowSystemOverrideForLockedRecipient)setAllowSystemOverrideForLockedRecipient.voidsetAutoRespondedReason(java.lang.String autoRespondedReason)setAutoRespondedReason.voidsetClientUserId(java.lang.String clientUserId)setClientUserId.voidsetCompletedCount(java.lang.String completedCount)setCompletedCount.voidsetCustomFields(java.util.List<java.lang.String> customFields)setCustomFields.voidsetDeclinedDateTime(java.lang.String declinedDateTime)setDeclinedDateTime.voidsetDeclinedReason(java.lang.String declinedReason)setDeclinedReason.voidsetDeliveredDateTime(java.lang.String deliveredDateTime)setDeliveredDateTime.voidsetDeliveryMethod(java.lang.String deliveryMethod)setDeliveryMethod.voidsetDeliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)setDeliveryMethodMetadata.voidsetDesignatorId(java.lang.String designatorId)setDesignatorId.voidsetDesignatorIdGuid(java.lang.String designatorIdGuid)setDesignatorIdGuid.voidsetDocumentVisibility(java.util.List<DocumentVisibility> documentVisibility)setDocumentVisibility.voidsetEmailNotification(RecipientEmailNotification emailNotification)setEmailNotification.voidsetEmbeddedRecipientStartURL(java.lang.String embeddedRecipientStartURL)setEmbeddedRecipientStartURL.voidsetErrorDetails(ErrorDetails errorDetails)setErrorDetails.voidsetFaxNumber(java.lang.String faxNumber)setFaxNumber.voidsetFaxNumberMetadata(PropertyMetadata faxNumberMetadata)setFaxNumberMetadata.voidsetIdCheckConfigurationName(java.lang.String idCheckConfigurationName)setIdCheckConfigurationName.voidsetIdCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)setIdCheckConfigurationNameMetadata.voidsetIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput)setIdCheckInformationInput.voidsetIdentityVerification(RecipientIdentityVerification identityVerification)setIdentityVerification.voidsetInheritEmailNotificationConfiguration(java.lang.String inheritEmailNotificationConfiguration)setInheritEmailNotificationConfiguration.voidsetLockedRecipientPhoneAuthEditable(java.lang.String lockedRecipientPhoneAuthEditable)setLockedRecipientPhoneAuthEditable.voidsetLockedRecipientSmsEditable(java.lang.String lockedRecipientSmsEditable)setLockedRecipientSmsEditable.voidsetName(java.lang.String name)setName.voidsetNote(java.lang.String note)setNote.voidsetNoteMetadata(PropertyMetadata noteMetadata)setNoteMetadata.voidsetPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)setPhoneAuthentication.voidsetRecipientAttachments(java.util.List<RecipientAttachment> recipientAttachments)setRecipientAttachments.voidsetRecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)setRecipientAuthenticationStatus.voidsetRecipientFeatureMetadata(java.util.List<FeatureAvailableMetadata> recipientFeatureMetadata)setRecipientFeatureMetadata.voidsetRecipientId(java.lang.String recipientId)setRecipientId.voidsetRecipientIdGuid(java.lang.String recipientIdGuid)setRecipientIdGuid.voidsetRecipientSignatureProviders(java.util.List<RecipientSignatureProvider> recipientSignatureProviders)setRecipientSignatureProviders.voidsetRecipientType(java.lang.String recipientType)setRecipientType.voidsetRecipientTypeMetadata(PropertyMetadata recipientTypeMetadata)setRecipientTypeMetadata.voidsetRequireIdLookup(java.lang.String requireIdLookup)setRequireIdLookup.voidsetRequireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)setRequireIdLookupMetadata.voidsetRoleName(java.lang.String roleName)setRoleName.voidsetRoutingOrder(java.lang.String routingOrder)setRoutingOrder.voidsetRoutingOrderMetadata(PropertyMetadata routingOrderMetadata)setRoutingOrderMetadata.voidsetSentDateTime(java.lang.String sentDateTime)setSentDateTime.voidsetSignedDateTime(java.lang.String signedDateTime)setSignedDateTime.voidsetSmsAuthentication(RecipientSMSAuthentication smsAuthentication)setSmsAuthentication.voidsetSocialAuthentications(java.util.List<SocialAuthentication> socialAuthentications)setSocialAuthentications.voidsetStatus(java.lang.String status)setStatus.voidsetStatusCode(java.lang.String statusCode)setStatusCode.voidsetSuppressEmails(java.lang.String suppressEmails)setSuppressEmails.voidsetTabs(Tabs tabs)setTabs.voidsetTemplateLocked(java.lang.String templateLocked)setTemplateLocked.voidsetTemplateRequired(java.lang.String templateRequired)setTemplateRequired.voidsetTotalTabCount(java.lang.String totalTabCount)setTotalTabCount.voidsetUserId(java.lang.String userId)setUserId.SealSignsignedDateTime(java.lang.String signedDateTime)signedDateTime.SealSignsmsAuthentication(RecipientSMSAuthentication smsAuthentication)smsAuthentication.SealSignsocialAuthentications(java.util.List<SocialAuthentication> socialAuthentications)socialAuthentications.SealSignstatus(java.lang.String status)status.SealSignstatusCode(java.lang.String statusCode)statusCode.SealSignsuppressEmails(java.lang.String suppressEmails)suppressEmails.SealSigntabs(Tabs tabs)tabs.SealSigntemplateLocked(java.lang.String templateLocked)templateLocked.SealSigntemplateRequired(java.lang.String templateRequired)templateRequired.java.lang.StringtoString()Converts the given object to string.SealSigntotalTabCount(java.lang.String totalTabCount)totalTabCount.SealSignuserId(java.lang.String userId)userId.
-
-
-
Method Detail
-
accessCode
public SealSign accessCode(java.lang.String accessCode)
accessCode.- Returns:
- SealSign
-
getAccessCode
public java.lang.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(java.lang.String accessCode)
setAccessCode.
-
accessCodeMetadata
public SealSign accessCodeMetadata(PropertyMetadata accessCodeMetadata)
accessCodeMetadata.- Returns:
- SealSign
-
getAccessCodeMetadata
public PropertyMetadata getAccessCodeMetadata()
Get accessCodeMetadata.- Returns:
- accessCodeMetadata
-
setAccessCodeMetadata
public void setAccessCodeMetadata(PropertyMetadata accessCodeMetadata)
setAccessCodeMetadata.
-
addAccessCodeToEmail
public SealSign addAccessCodeToEmail(java.lang.String addAccessCodeToEmail)
addAccessCodeToEmail.- Returns:
- SealSign
-
getAddAccessCodeToEmail
public java.lang.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(java.lang.String addAccessCodeToEmail)
setAddAccessCodeToEmail.
-
allowSystemOverrideForLockedRecipient
public SealSign allowSystemOverrideForLockedRecipient(java.lang.String allowSystemOverrideForLockedRecipient)
allowSystemOverrideForLockedRecipient.- Returns:
- SealSign
-
getAllowSystemOverrideForLockedRecipient
public java.lang.String getAllowSystemOverrideForLockedRecipient()
.- Returns:
- allowSystemOverrideForLockedRecipient
-
setAllowSystemOverrideForLockedRecipient
public void setAllowSystemOverrideForLockedRecipient(java.lang.String allowSystemOverrideForLockedRecipient)
setAllowSystemOverrideForLockedRecipient.
-
autoRespondedReason
public SealSign autoRespondedReason(java.lang.String autoRespondedReason)
autoRespondedReason.- Returns:
- SealSign
-
getAutoRespondedReason
public java.lang.String getAutoRespondedReason()
.- Returns:
- autoRespondedReason
-
setAutoRespondedReason
public void setAutoRespondedReason(java.lang.String autoRespondedReason)
setAutoRespondedReason.
-
clientUserId
public SealSign clientUserId(java.lang.String clientUserId)
clientUserId.- Returns:
- SealSign
-
getClientUserId
public java.lang.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(java.lang.String clientUserId)
setClientUserId.
-
completedCount
public SealSign completedCount(java.lang.String completedCount)
completedCount.- Returns:
- SealSign
-
getCompletedCount
public java.lang.String getCompletedCount()
.- Returns:
- completedCount
-
setCompletedCount
public void setCompletedCount(java.lang.String completedCount)
setCompletedCount.
-
customFields
public SealSign customFields(java.util.List<java.lang.String> customFields)
customFields.- Returns:
- SealSign
-
addCustomFieldsItem
public SealSign addCustomFieldsItem(java.lang.String customFieldsItem)
addCustomFieldsItem.- Returns:
- SealSign
-
getCustomFields
public java.util.List<java.lang.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(java.util.List<java.lang.String> customFields)
setCustomFields.
-
declinedDateTime
public SealSign declinedDateTime(java.lang.String declinedDateTime)
declinedDateTime.- Returns:
- SealSign
-
getDeclinedDateTime
public java.lang.String getDeclinedDateTime()
The date and time the recipient declined the document..- Returns:
- declinedDateTime
-
setDeclinedDateTime
public void setDeclinedDateTime(java.lang.String declinedDateTime)
setDeclinedDateTime.
-
declinedReason
public SealSign declinedReason(java.lang.String declinedReason)
declinedReason.- Returns:
- SealSign
-
getDeclinedReason
public java.lang.String getDeclinedReason()
The reason the recipient declined the document..- Returns:
- declinedReason
-
setDeclinedReason
public void setDeclinedReason(java.lang.String declinedReason)
setDeclinedReason.
-
deliveredDateTime
public SealSign deliveredDateTime(java.lang.String deliveredDateTime)
deliveredDateTime.- Returns:
- SealSign
-
getDeliveredDateTime
public java.lang.String getDeliveredDateTime()
Reserved: For DocuSign use only..- Returns:
- deliveredDateTime
-
setDeliveredDateTime
public void setDeliveredDateTime(java.lang.String deliveredDateTime)
setDeliveredDateTime.
-
deliveryMethod
public SealSign deliveryMethod(java.lang.String deliveryMethod)
deliveryMethod.- Returns:
- SealSign
-
getDeliveryMethod
public java.lang.String getDeliveryMethod()
Reserved: For DocuSign use only..- Returns:
- deliveryMethod
-
setDeliveryMethod
public void setDeliveryMethod(java.lang.String deliveryMethod)
setDeliveryMethod.
-
deliveryMethodMetadata
public SealSign deliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)
deliveryMethodMetadata.- Returns:
- SealSign
-
getDeliveryMethodMetadata
public PropertyMetadata getDeliveryMethodMetadata()
Get deliveryMethodMetadata.- Returns:
- deliveryMethodMetadata
-
setDeliveryMethodMetadata
public void setDeliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)
setDeliveryMethodMetadata.
-
designatorId
public SealSign designatorId(java.lang.String designatorId)
designatorId.- Returns:
- SealSign
-
getDesignatorId
public java.lang.String getDesignatorId()
.- Returns:
- designatorId
-
setDesignatorId
public void setDesignatorId(java.lang.String designatorId)
setDesignatorId.
-
designatorIdGuid
public SealSign designatorIdGuid(java.lang.String designatorIdGuid)
designatorIdGuid.- Returns:
- SealSign
-
getDesignatorIdGuid
public java.lang.String getDesignatorIdGuid()
.- Returns:
- designatorIdGuid
-
setDesignatorIdGuid
public void setDesignatorIdGuid(java.lang.String designatorIdGuid)
setDesignatorIdGuid.
-
documentVisibility
public SealSign documentVisibility(java.util.List<DocumentVisibility> documentVisibility)
documentVisibility.- Returns:
- SealSign
-
addDocumentVisibilityItem
public SealSign addDocumentVisibilityItem(DocumentVisibility documentVisibilityItem)
addDocumentVisibilityItem.- Returns:
- SealSign
-
getDocumentVisibility
public java.util.List<DocumentVisibility> getDocumentVisibility()
.- Returns:
- documentVisibility
-
setDocumentVisibility
public void setDocumentVisibility(java.util.List<DocumentVisibility> documentVisibility)
setDocumentVisibility.
-
emailNotification
public SealSign emailNotification(RecipientEmailNotification emailNotification)
emailNotification.- Returns:
- SealSign
-
getEmailNotification
public RecipientEmailNotification getEmailNotification()
Get emailNotification.- Returns:
- emailNotification
-
setEmailNotification
public void setEmailNotification(RecipientEmailNotification emailNotification)
setEmailNotification.
-
embeddedRecipientStartURL
public SealSign embeddedRecipientStartURL(java.lang.String embeddedRecipientStartURL)
embeddedRecipientStartURL.- Returns:
- SealSign
-
getEmbeddedRecipientStartURL
public java.lang.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(java.lang.String embeddedRecipientStartURL)
setEmbeddedRecipientStartURL.
-
errorDetails
public SealSign errorDetails(ErrorDetails errorDetails)
errorDetails.- Returns:
- SealSign
-
getErrorDetails
public ErrorDetails getErrorDetails()
Get errorDetails.- Returns:
- errorDetails
-
setErrorDetails
public void setErrorDetails(ErrorDetails errorDetails)
setErrorDetails.
-
faxNumber
public SealSign faxNumber(java.lang.String faxNumber)
faxNumber.- Returns:
- SealSign
-
getFaxNumber
public java.lang.String getFaxNumber()
Reserved:.- Returns:
- faxNumber
-
setFaxNumber
public void setFaxNumber(java.lang.String faxNumber)
setFaxNumber.
-
faxNumberMetadata
public SealSign faxNumberMetadata(PropertyMetadata faxNumberMetadata)
faxNumberMetadata.- Returns:
- SealSign
-
getFaxNumberMetadata
public PropertyMetadata getFaxNumberMetadata()
Get faxNumberMetadata.- Returns:
- faxNumberMetadata
-
setFaxNumberMetadata
public void setFaxNumberMetadata(PropertyMetadata faxNumberMetadata)
setFaxNumberMetadata.
-
idCheckConfigurationName
public SealSign idCheckConfigurationName(java.lang.String idCheckConfigurationName)
idCheckConfigurationName.- Returns:
- SealSign
-
getIdCheckConfigurationName
public java.lang.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(java.lang.String idCheckConfigurationName)
setIdCheckConfigurationName.
-
idCheckConfigurationNameMetadata
public SealSign idCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)
idCheckConfigurationNameMetadata.- Returns:
- SealSign
-
getIdCheckConfigurationNameMetadata
public PropertyMetadata getIdCheckConfigurationNameMetadata()
Get idCheckConfigurationNameMetadata.- Returns:
- idCheckConfigurationNameMetadata
-
setIdCheckConfigurationNameMetadata
public void setIdCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)
setIdCheckConfigurationNameMetadata.
-
idCheckInformationInput
public SealSign idCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
idCheckInformationInput.- Returns:
- SealSign
-
getIdCheckInformationInput
public IdCheckInformationInput getIdCheckInformationInput()
Get idCheckInformationInput.- Returns:
- idCheckInformationInput
-
setIdCheckInformationInput
public void setIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
setIdCheckInformationInput.
-
identityVerification
public SealSign identityVerification(RecipientIdentityVerification identityVerification)
identityVerification.- Returns:
- SealSign
-
getIdentityVerification
public RecipientIdentityVerification getIdentityVerification()
Get identityVerification.- Returns:
- identityVerification
-
setIdentityVerification
public void setIdentityVerification(RecipientIdentityVerification identityVerification)
setIdentityVerification.
-
inheritEmailNotificationConfiguration
public SealSign inheritEmailNotificationConfiguration(java.lang.String inheritEmailNotificationConfiguration)
inheritEmailNotificationConfiguration.- Returns:
- SealSign
-
getInheritEmailNotificationConfiguration
public java.lang.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(java.lang.String inheritEmailNotificationConfiguration)
setInheritEmailNotificationConfiguration.
-
lockedRecipientPhoneAuthEditable
public SealSign lockedRecipientPhoneAuthEditable(java.lang.String lockedRecipientPhoneAuthEditable)
lockedRecipientPhoneAuthEditable.- Returns:
- SealSign
-
getLockedRecipientPhoneAuthEditable
public java.lang.String getLockedRecipientPhoneAuthEditable()
.- Returns:
- lockedRecipientPhoneAuthEditable
-
setLockedRecipientPhoneAuthEditable
public void setLockedRecipientPhoneAuthEditable(java.lang.String lockedRecipientPhoneAuthEditable)
setLockedRecipientPhoneAuthEditable.
-
lockedRecipientSmsEditable
public SealSign lockedRecipientSmsEditable(java.lang.String lockedRecipientSmsEditable)
lockedRecipientSmsEditable.- Returns:
- SealSign
-
getLockedRecipientSmsEditable
public java.lang.String getLockedRecipientSmsEditable()
.- Returns:
- lockedRecipientSmsEditable
-
setLockedRecipientSmsEditable
public void setLockedRecipientSmsEditable(java.lang.String lockedRecipientSmsEditable)
setLockedRecipientSmsEditable.
-
name
public SealSign name(java.lang.String name)
name.- Returns:
- SealSign
-
getName
public java.lang.String getName()
.- Returns:
- name
-
setName
public void setName(java.lang.String name)
setName.
-
note
public SealSign note(java.lang.String note)
note.- Returns:
- SealSign
-
getNote
public java.lang.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(java.lang.String note)
setNote.
-
noteMetadata
public SealSign noteMetadata(PropertyMetadata noteMetadata)
noteMetadata.- Returns:
- SealSign
-
getNoteMetadata
public PropertyMetadata getNoteMetadata()
Get noteMetadata.- Returns:
- noteMetadata
-
setNoteMetadata
public void setNoteMetadata(PropertyMetadata noteMetadata)
setNoteMetadata.
-
phoneAuthentication
public SealSign phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
phoneAuthentication.- Returns:
- SealSign
-
getPhoneAuthentication
public RecipientPhoneAuthentication getPhoneAuthentication()
Get phoneAuthentication.- Returns:
- phoneAuthentication
-
setPhoneAuthentication
public void setPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
setPhoneAuthentication.
-
recipientAttachments
public SealSign recipientAttachments(java.util.List<RecipientAttachment> recipientAttachments)
recipientAttachments.- Returns:
- SealSign
-
addRecipientAttachmentsItem
public SealSign addRecipientAttachmentsItem(RecipientAttachment recipientAttachmentsItem)
addRecipientAttachmentsItem.- Returns:
- SealSign
-
getRecipientAttachments
public java.util.List<RecipientAttachment> getRecipientAttachments()
Reserved:.- Returns:
- recipientAttachments
-
setRecipientAttachments
public void setRecipientAttachments(java.util.List<RecipientAttachment> recipientAttachments)
setRecipientAttachments.
-
recipientAuthenticationStatus
public SealSign recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
recipientAuthenticationStatus.- Returns:
- SealSign
-
getRecipientAuthenticationStatus
public AuthenticationStatus getRecipientAuthenticationStatus()
Get recipientAuthenticationStatus.- Returns:
- recipientAuthenticationStatus
-
setRecipientAuthenticationStatus
public void setRecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
setRecipientAuthenticationStatus.
-
recipientFeatureMetadata
public SealSign recipientFeatureMetadata(java.util.List<FeatureAvailableMetadata> recipientFeatureMetadata)
recipientFeatureMetadata.- Returns:
- SealSign
-
addRecipientFeatureMetadataItem
public SealSign addRecipientFeatureMetadataItem(FeatureAvailableMetadata recipientFeatureMetadataItem)
addRecipientFeatureMetadataItem.- Returns:
- SealSign
-
getRecipientFeatureMetadata
public java.util.List<FeatureAvailableMetadata> getRecipientFeatureMetadata()
.- Returns:
- recipientFeatureMetadata
-
setRecipientFeatureMetadata
public void setRecipientFeatureMetadata(java.util.List<FeatureAvailableMetadata> recipientFeatureMetadata)
setRecipientFeatureMetadata.
-
recipientId
public SealSign recipientId(java.lang.String recipientId)
recipientId.- Returns:
- SealSign
-
getRecipientId
public java.lang.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(java.lang.String recipientId)
setRecipientId.
-
recipientIdGuid
public SealSign recipientIdGuid(java.lang.String recipientIdGuid)
recipientIdGuid.- Returns:
- SealSign
-
getRecipientIdGuid
public java.lang.String getRecipientIdGuid()
.- Returns:
- recipientIdGuid
-
setRecipientIdGuid
public void setRecipientIdGuid(java.lang.String recipientIdGuid)
setRecipientIdGuid.
-
recipientSignatureProviders
public SealSign recipientSignatureProviders(java.util.List<RecipientSignatureProvider> recipientSignatureProviders)
recipientSignatureProviders.- Returns:
- SealSign
-
addRecipientSignatureProvidersItem
public SealSign addRecipientSignatureProvidersItem(RecipientSignatureProvider recipientSignatureProvidersItem)
addRecipientSignatureProvidersItem.- Returns:
- SealSign
-
getRecipientSignatureProviders
public java.util.List<RecipientSignatureProvider> getRecipientSignatureProviders()
.- Returns:
- recipientSignatureProviders
-
setRecipientSignatureProviders
public void setRecipientSignatureProviders(java.util.List<RecipientSignatureProvider> recipientSignatureProviders)
setRecipientSignatureProviders.
-
recipientType
public SealSign recipientType(java.lang.String recipientType)
recipientType.- Returns:
- SealSign
-
getRecipientType
public java.lang.String getRecipientType()
.- Returns:
- recipientType
-
setRecipientType
public void setRecipientType(java.lang.String recipientType)
setRecipientType.
-
recipientTypeMetadata
public SealSign recipientTypeMetadata(PropertyMetadata recipientTypeMetadata)
recipientTypeMetadata.- Returns:
- SealSign
-
getRecipientTypeMetadata
public PropertyMetadata getRecipientTypeMetadata()
Get recipientTypeMetadata.- Returns:
- recipientTypeMetadata
-
setRecipientTypeMetadata
public void setRecipientTypeMetadata(PropertyMetadata recipientTypeMetadata)
setRecipientTypeMetadata.
-
requireIdLookup
public SealSign requireIdLookup(java.lang.String requireIdLookup)
requireIdLookup.- Returns:
- SealSign
-
getRequireIdLookup
public java.lang.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(java.lang.String requireIdLookup)
setRequireIdLookup.
-
requireIdLookupMetadata
public SealSign requireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)
requireIdLookupMetadata.- Returns:
- SealSign
-
getRequireIdLookupMetadata
public PropertyMetadata getRequireIdLookupMetadata()
Get requireIdLookupMetadata.- Returns:
- requireIdLookupMetadata
-
setRequireIdLookupMetadata
public void setRequireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)
setRequireIdLookupMetadata.
-
roleName
public SealSign roleName(java.lang.String roleName)
roleName.- Returns:
- SealSign
-
getRoleName
public java.lang.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(java.lang.String roleName)
setRoleName.
-
routingOrder
public SealSign routingOrder(java.lang.String routingOrder)
routingOrder.- Returns:
- SealSign
-
getRoutingOrder
public java.lang.String getRoutingOrder()
Specifies the routing order of the recipient in the envelope. .- Returns:
- routingOrder
-
setRoutingOrder
public void setRoutingOrder(java.lang.String routingOrder)
setRoutingOrder.
-
routingOrderMetadata
public SealSign routingOrderMetadata(PropertyMetadata routingOrderMetadata)
routingOrderMetadata.- Returns:
- SealSign
-
getRoutingOrderMetadata
public PropertyMetadata getRoutingOrderMetadata()
Get routingOrderMetadata.- Returns:
- routingOrderMetadata
-
setRoutingOrderMetadata
public void setRoutingOrderMetadata(PropertyMetadata routingOrderMetadata)
setRoutingOrderMetadata.
-
sentDateTime
public SealSign sentDateTime(java.lang.String sentDateTime)
sentDateTime.- Returns:
- SealSign
-
getSentDateTime
public java.lang.String getSentDateTime()
The date and time the envelope was sent..- Returns:
- sentDateTime
-
setSentDateTime
public void setSentDateTime(java.lang.String sentDateTime)
setSentDateTime.
-
signedDateTime
public SealSign signedDateTime(java.lang.String signedDateTime)
signedDateTime.- Returns:
- SealSign
-
getSignedDateTime
public java.lang.String getSignedDateTime()
Reserved: For DocuSign use only. .- Returns:
- signedDateTime
-
setSignedDateTime
public void setSignedDateTime(java.lang.String signedDateTime)
setSignedDateTime.
-
smsAuthentication
public SealSign smsAuthentication(RecipientSMSAuthentication smsAuthentication)
smsAuthentication.- Returns:
- SealSign
-
getSmsAuthentication
public RecipientSMSAuthentication getSmsAuthentication()
Get smsAuthentication.- Returns:
- smsAuthentication
-
setSmsAuthentication
public void setSmsAuthentication(RecipientSMSAuthentication smsAuthentication)
setSmsAuthentication.
-
socialAuthentications
public SealSign socialAuthentications(java.util.List<SocialAuthentication> socialAuthentications)
socialAuthentications.- Returns:
- SealSign
-
addSocialAuthenticationsItem
public SealSign addSocialAuthenticationsItem(SocialAuthentication socialAuthenticationsItem)
addSocialAuthenticationsItem.- Returns:
- SealSign
-
getSocialAuthentications
public java.util.List<SocialAuthentication> getSocialAuthentications()
Lists the social ID type that can be used for recipient authentication..- Returns:
- socialAuthentications
-
setSocialAuthentications
public void setSocialAuthentications(java.util.List<SocialAuthentication> socialAuthentications)
setSocialAuthentications.
-
status
public SealSign status(java.lang.String status)
status.- Returns:
- SealSign
-
getStatus
public java.lang.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(java.lang.String status)
setStatus.
-
statusCode
public SealSign statusCode(java.lang.String statusCode)
statusCode.- Returns:
- SealSign
-
getStatusCode
public java.lang.String getStatusCode()
.- Returns:
- statusCode
-
setStatusCode
public void setStatusCode(java.lang.String statusCode)
setStatusCode.
-
suppressEmails
public SealSign suppressEmails(java.lang.String suppressEmails)
suppressEmails.- Returns:
- SealSign
-
getSuppressEmails
public java.lang.String getSuppressEmails()
.- Returns:
- suppressEmails
-
setSuppressEmails
public void setSuppressEmails(java.lang.String suppressEmails)
setSuppressEmails.
-
getTabs
public Tabs getTabs()
Get tabs.- Returns:
- tabs
-
setTabs
public void setTabs(Tabs tabs)
setTabs.
-
templateLocked
public SealSign templateLocked(java.lang.String templateLocked)
templateLocked.- Returns:
- SealSign
-
getTemplateLocked
public java.lang.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(java.lang.String templateLocked)
setTemplateLocked.
-
templateRequired
public SealSign templateRequired(java.lang.String templateRequired)
templateRequired.- Returns:
- SealSign
-
getTemplateRequired
public java.lang.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(java.lang.String templateRequired)
setTemplateRequired.
-
totalTabCount
public SealSign totalTabCount(java.lang.String totalTabCount)
totalTabCount.- Returns:
- SealSign
-
getTotalTabCount
public java.lang.String getTotalTabCount()
.- Returns:
- totalTabCount
-
setTotalTabCount
public void setTotalTabCount(java.lang.String totalTabCount)
setTotalTabCount.
-
userId
public SealSign userId(java.lang.String userId)
userId.- Returns:
- SealSign
-
getUserId
public java.lang.String getUserId()
.- Returns:
- userId
-
setUserId
public void setUserId(java.lang.String userId)
setUserId.
-
equals
public boolean equals(java.lang.Object o)
Compares objects.- Overrides:
equalsin classjava.lang.Object- Returns:
- true or false depending on comparison result.
-
hashCode
public int hashCode()
Returns the HashCode.- Overrides:
hashCodein classjava.lang.Object
-
toString
public java.lang.String toString()
Converts the given object to string.- Overrides:
toStringin classjava.lang.Object
-
-