Package com.docusign.esign.model
Class NotaryWitness
- java.lang.Object
-
- com.docusign.esign.model.NotaryWitness
-
- All Implemented Interfaces:
Serializable
public class NotaryWitness extends Object implements Serializable
NotaryWitness.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description NotaryWitness()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NotaryWitnessaccessCode(String accessCode)accessCode.NotaryWitnessaccessCodeMetadata(PropertyMetadata accessCodeMetadata)accessCodeMetadata.NotaryWitnessaddAccessCodeToEmail(String addAccessCodeToEmail)addAccessCodeToEmail.NotaryWitnessaddAdditionalNotificationsItem(RecipientAdditionalNotification additionalNotificationsItem)addAdditionalNotificationsItem.NotaryWitnessaddConsentDetailsListItem(ConsentDetails consentDetailsListItem)addConsentDetailsListItem.NotaryWitnessaddCustomFieldsItem(String customFieldsItem)addCustomFieldsItem.NotaryWitnessaddDelegatedToItem(DelegationInfo delegatedToItem)addDelegatedToItem.NotaryWitnessaddDocumentVisibilityItem(DocumentVisibility documentVisibilityItem)addDocumentVisibilityItem.NotaryWitnessaddExcludedDocumentsItem(String excludedDocumentsItem)addExcludedDocumentsItem.NotaryWitnessadditionalNotifications(List<RecipientAdditionalNotification> additionalNotifications)additionalNotifications.NotaryWitnessaddRecipientAttachmentsItem(RecipientAttachment recipientAttachmentsItem)addRecipientAttachmentsItem.NotaryWitnessaddRecipientFeatureMetadataItem(FeatureAvailableMetadata recipientFeatureMetadataItem)addRecipientFeatureMetadataItem.NotaryWitnessaddRecipientSignatureProvidersItem(RecipientSignatureProvider recipientSignatureProvidersItem)addRecipientSignatureProvidersItem.NotaryWitnessaddSigningGroupUsersItem(UserInfo signingGroupUsersItem)addSigningGroupUsersItem.NotaryWitnessaddSocialAuthenticationsItem(SocialAuthentication socialAuthenticationsItem)addSocialAuthenticationsItem.NotaryWitnessagentCanEditEmail(String agentCanEditEmail)agentCanEditEmail.NotaryWitnessagentCanEditName(String agentCanEditName)agentCanEditName.NotaryWitnessallowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)allowSystemOverrideForLockedRecipient.NotaryWitnessautoNavigation(String autoNavigation)autoNavigation.NotaryWitnessautoRespondedReason(String autoRespondedReason)autoRespondedReason.NotaryWitnessbulkRecipientsUri(String bulkRecipientsUri)bulkRecipientsUri.NotaryWitnessbulkSendV2Recipient(String bulkSendV2Recipient)bulkSendV2Recipient.NotaryWitnesscanSignOffline(String canSignOffline)canSignOffline.NotaryWitnessclientUserId(String clientUserId)clientUserId.NotaryWitnesscompletedCount(String completedCount)completedCount.NotaryWitnessconsentDetailsList(List<ConsentDetails> consentDetailsList)consentDetailsList.NotaryWitnesscreationReason(String creationReason)creationReason.NotaryWitnesscustomFields(List<String> customFields)customFields.NotaryWitnessdeclinedDateTime(String declinedDateTime)declinedDateTime.NotaryWitnessdeclinedReason(String declinedReason)declinedReason.NotaryWitnessdefaultRecipient(String defaultRecipient)defaultRecipient.NotaryWitnessdelegatedBy(DelegationInfo delegatedBy)delegatedBy.NotaryWitnessdelegatedTo(List<DelegationInfo> delegatedTo)delegatedTo.NotaryWitnessdeliveredDateTime(String deliveredDateTime)deliveredDateTime.NotaryWitnessdeliveryMethod(String deliveryMethod)deliveryMethod.NotaryWitnessdeliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)deliveryMethodMetadata.NotaryWitnessdesignatorId(String designatorId)designatorId.NotaryWitnessdesignatorIdGuid(String designatorIdGuid)designatorIdGuid.NotaryWitnessdocumentTemplateId(String documentTemplateId)documentTemplateId.NotaryWitnessdocumentVisibility(List<DocumentVisibility> documentVisibility)documentVisibility.NotaryWitnessemail(String email)email.NotaryWitnessemailMetadata(PropertyMetadata emailMetadata)emailMetadata.NotaryWitnessemailNotification(RecipientEmailNotification emailNotification)emailNotification.NotaryWitnessemailRecipientPostSigningURL(String emailRecipientPostSigningURL)emailRecipientPostSigningURL.NotaryWitnessembeddedRecipientStartURL(String embeddedRecipientStartURL)embeddedRecipientStartURL.booleanequals(Object o)Compares objects.NotaryWitnesserrorDetails(ErrorDetails errorDetails)errorDetails.NotaryWitnessexcludedDocuments(List<String> excludedDocuments)excludedDocuments.NotaryWitnessfaxNumber(String faxNumber)faxNumber.NotaryWitnessfaxNumberMetadata(PropertyMetadata faxNumberMetadata)faxNumberMetadata.NotaryWitnessfirstName(String firstName)firstName.NotaryWitnessfirstNameMetadata(PropertyMetadata firstNameMetadata)firstNameMetadata.NotaryWitnessfullName(String fullName)fullName.NotaryWitnessfullNameMetadata(PropertyMetadata fullNameMetadata)fullNameMetadata.StringgetAccessCode()If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.PropertyMetadatagetAccessCodeMetadata().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..List<RecipientAdditionalNotification>getAdditionalNotifications().StringgetAgentCanEditEmail().StringgetAgentCanEditName().StringgetAllowSystemOverrideForLockedRecipient().StringgetAutoNavigation().StringgetAutoRespondedReason().StringgetBulkRecipientsUri()Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information..StringgetBulkSendV2Recipient().StringgetCanSignOffline()When set to **true**, specifies that the signer can perform the signing ceremony offline..StringgetClientUserId()Specifies whether the recipient is embedded or remote.StringgetCompletedCount().List<ConsentDetails>getConsentDetailsList().StringgetCreationReason().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..StringgetDefaultRecipient().DelegationInfogetDelegatedBy().List<DelegationInfo>getDelegatedTo().StringgetDeliveredDateTime()Reserved: For DocuSign use only..StringgetDeliveryMethod()Reserved: For DocuSign use only..PropertyMetadatagetDeliveryMethodMetadata().StringgetDesignatorId().StringgetDesignatorIdGuid().StringgetDocumentTemplateId().List<DocumentVisibility>getDocumentVisibility().StringgetEmail().PropertyMetadatagetEmailMetadata().RecipientEmailNotificationgetEmailNotification()A complex type that contains information sets the language of the recipient's email information.StringgetEmailRecipientPostSigningURL().StringgetEmbeddedRecipientStartURL()Specifies a sender provided valid URL string for redirecting an embedded recipient.ErrorDetailsgetErrorDetails()Array or errors..List<String>getExcludedDocuments()Specifies the documents that are not visible to this recipient.StringgetFaxNumber()Reserved:.PropertyMetadatagetFaxNumberMetadata().StringgetFirstName()The user's first name.PropertyMetadatagetFirstNameMetadata().StringgetFullName().PropertyMetadatagetFullNameMetadata().StringgetIdCheckConfigurationName()Specifies authentication check by name.PropertyMetadatagetIdCheckConfigurationNameMetadata().IdCheckInformationInputgetIdCheckInformationInput().RecipientIdentityVerificationgetIdentityVerification().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.StringgetIsBulkRecipient().PropertyMetadatagetIsBulkRecipientMetadata().StringgetLastName().PropertyMetadatagetLastNameMetadata().StringgetLockedRecipientPhoneAuthEditable().StringgetLockedRecipientSmsEditable().StringgetName().PropertyMetadatagetNameMetadata().StringgetNotaryId().StringgetNotarySignerEmailSent().StringgetNote()Specifies a note that is unique to this recipient.PropertyMetadatagetNoteMetadata().OfflineAttributesgetOfflineAttributes().RecipientPhoneAuthenticationgetPhoneAuthentication().RecipientPhoneNumbergetPhoneNumber().RecipientProofFilegetProofFile().List<RecipientAttachment>getRecipientAttachments()Reserved:.AuthenticationStatusgetRecipientAuthenticationStatus().List<FeatureAvailableMetadata>getRecipientFeatureMetadata().StringgetRecipientId()Unique for the recipient.StringgetRecipientIdGuid().List<RecipientSignatureProvider>getRecipientSignatureProviders().StringgetRecipientSuppliesTabs().StringgetRecipientType().PropertyMetadatagetRecipientTypeMetadata().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().StringgetRequireSignerCertificate().StringgetRequireSignOnPaper().StringgetRequireUploadSignature().StringgetRoleName()Optional element.StringgetRoutingOrder()Specifies the routing order of the recipient in the envelope.PropertyMetadatagetRoutingOrderMetadata().StringgetSentDateTime()The date and time the envelope was sent..RecipientSignatureInformationgetSignatureInfo().StringgetSignedDateTime()Reserved: For DocuSign use only.StringgetSignInEachLocation()When set to **true**, specifies that the signer must sign in all locations..PropertyMetadatagetSignInEachLocationMetadata().StringgetSigningGroupId()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)..PropertyMetadatagetSigningGroupIdMetadata().StringgetSigningGroupName()The display name for the signing group.List<UserInfo>getSigningGroupUsers()A complex type that contains information about users in the signing group..RecipientSMSAuthenticationgetSmsAuthentication().List<SocialAuthentication>getSocialAuthentications()Lists the social ID type that can be used for recipient authentication..StringgetStatus()Indicates the envelope status.StringgetStatusCode().StringgetSuppressEmails().TabsgetTabs().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().StringgetType().StringgetUserId().StringgetWebFormRecipientViewId().StringgetWitnessFor().StringgetWitnessForGuid().inthashCode()Returns the HashCode.NotaryWitnessidCheckConfigurationName(String idCheckConfigurationName)idCheckConfigurationName.NotaryWitnessidCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)idCheckConfigurationNameMetadata.NotaryWitnessidCheckInformationInput(IdCheckInformationInput idCheckInformationInput)idCheckInformationInput.NotaryWitnessidentityVerification(RecipientIdentityVerification identityVerification)identityVerification.NotaryWitnessinheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)inheritEmailNotificationConfiguration.NotaryWitnessisBulkRecipient(String isBulkRecipient)isBulkRecipient.NotaryWitnessisBulkRecipientMetadata(PropertyMetadata isBulkRecipientMetadata)isBulkRecipientMetadata.NotaryWitnesslastName(String lastName)lastName.NotaryWitnesslastNameMetadata(PropertyMetadata lastNameMetadata)lastNameMetadata.NotaryWitnesslockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)lockedRecipientPhoneAuthEditable.NotaryWitnesslockedRecipientSmsEditable(String lockedRecipientSmsEditable)lockedRecipientSmsEditable.NotaryWitnessname(String name)name.NotaryWitnessnameMetadata(PropertyMetadata nameMetadata)nameMetadata.NotaryWitnessnotaryId(String notaryId)notaryId.NotaryWitnessnotarySignerEmailSent(String notarySignerEmailSent)notarySignerEmailSent.NotaryWitnessnote(String note)note.NotaryWitnessnoteMetadata(PropertyMetadata noteMetadata)noteMetadata.NotaryWitnessofflineAttributes(OfflineAttributes offlineAttributes)offlineAttributes.NotaryWitnessphoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)phoneAuthentication.NotaryWitnessphoneNumber(RecipientPhoneNumber phoneNumber)phoneNumber.NotaryWitnessproofFile(RecipientProofFile proofFile)proofFile.NotaryWitnessrecipientAttachments(List<RecipientAttachment> recipientAttachments)recipientAttachments.NotaryWitnessrecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)recipientAuthenticationStatus.NotaryWitnessrecipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)recipientFeatureMetadata.NotaryWitnessrecipientId(String recipientId)recipientId.NotaryWitnessrecipientIdGuid(String recipientIdGuid)recipientIdGuid.NotaryWitnessrecipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)recipientSignatureProviders.NotaryWitnessrecipientSuppliesTabs(String recipientSuppliesTabs)recipientSuppliesTabs.NotaryWitnessrecipientType(String recipientType)recipientType.NotaryWitnessrecipientTypeMetadata(PropertyMetadata recipientTypeMetadata)recipientTypeMetadata.NotaryWitnessrequireIdLookup(String requireIdLookup)requireIdLookup.NotaryWitnessrequireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)requireIdLookupMetadata.NotaryWitnessrequireSignerCertificate(String requireSignerCertificate)requireSignerCertificate.NotaryWitnessrequireSignOnPaper(String requireSignOnPaper)requireSignOnPaper.NotaryWitnessrequireUploadSignature(String requireUploadSignature)requireUploadSignature.NotaryWitnessroleName(String roleName)roleName.NotaryWitnessroutingOrder(String routingOrder)routingOrder.NotaryWitnessroutingOrderMetadata(PropertyMetadata routingOrderMetadata)routingOrderMetadata.NotaryWitnesssentDateTime(String sentDateTime)sentDateTime.voidsetAccessCode(String accessCode)setAccessCode.voidsetAccessCodeMetadata(PropertyMetadata accessCodeMetadata)setAccessCodeMetadata.voidsetAddAccessCodeToEmail(String addAccessCodeToEmail)setAddAccessCodeToEmail.voidsetAdditionalNotifications(List<RecipientAdditionalNotification> additionalNotifications)setAdditionalNotifications.voidsetAgentCanEditEmail(String agentCanEditEmail)setAgentCanEditEmail.voidsetAgentCanEditName(String agentCanEditName)setAgentCanEditName.voidsetAllowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)setAllowSystemOverrideForLockedRecipient.voidsetAutoNavigation(String autoNavigation)setAutoNavigation.voidsetAutoRespondedReason(String autoRespondedReason)setAutoRespondedReason.voidsetBulkRecipientsUri(String bulkRecipientsUri)setBulkRecipientsUri.voidsetBulkSendV2Recipient(String bulkSendV2Recipient)setBulkSendV2Recipient.voidsetCanSignOffline(String canSignOffline)setCanSignOffline.voidsetClientUserId(String clientUserId)setClientUserId.voidsetCompletedCount(String completedCount)setCompletedCount.voidsetConsentDetailsList(List<ConsentDetails> consentDetailsList)setConsentDetailsList.voidsetCreationReason(String creationReason)setCreationReason.voidsetCustomFields(List<String> customFields)setCustomFields.voidsetDeclinedDateTime(String declinedDateTime)setDeclinedDateTime.voidsetDeclinedReason(String declinedReason)setDeclinedReason.voidsetDefaultRecipient(String defaultRecipient)setDefaultRecipient.voidsetDelegatedBy(DelegationInfo delegatedBy)setDelegatedBy.voidsetDelegatedTo(List<DelegationInfo> delegatedTo)setDelegatedTo.voidsetDeliveredDateTime(String deliveredDateTime)setDeliveredDateTime.voidsetDeliveryMethod(String deliveryMethod)setDeliveryMethod.voidsetDeliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)setDeliveryMethodMetadata.voidsetDesignatorId(String designatorId)setDesignatorId.voidsetDesignatorIdGuid(String designatorIdGuid)setDesignatorIdGuid.voidsetDocumentTemplateId(String documentTemplateId)setDocumentTemplateId.voidsetDocumentVisibility(List<DocumentVisibility> documentVisibility)setDocumentVisibility.voidsetEmail(String email)setEmail.voidsetEmailMetadata(PropertyMetadata emailMetadata)setEmailMetadata.voidsetEmailNotification(RecipientEmailNotification emailNotification)setEmailNotification.voidsetEmailRecipientPostSigningURL(String emailRecipientPostSigningURL)setEmailRecipientPostSigningURL.voidsetEmbeddedRecipientStartURL(String embeddedRecipientStartURL)setEmbeddedRecipientStartURL.voidsetErrorDetails(ErrorDetails errorDetails)setErrorDetails.voidsetExcludedDocuments(List<String> excludedDocuments)setExcludedDocuments.voidsetFaxNumber(String faxNumber)setFaxNumber.voidsetFaxNumberMetadata(PropertyMetadata faxNumberMetadata)setFaxNumberMetadata.voidsetFirstName(String firstName)setFirstName.voidsetFirstNameMetadata(PropertyMetadata firstNameMetadata)setFirstNameMetadata.voidsetFullName(String fullName)setFullName.voidsetFullNameMetadata(PropertyMetadata fullNameMetadata)setFullNameMetadata.voidsetIdCheckConfigurationName(String idCheckConfigurationName)setIdCheckConfigurationName.voidsetIdCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)setIdCheckConfigurationNameMetadata.voidsetIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput)setIdCheckInformationInput.voidsetIdentityVerification(RecipientIdentityVerification identityVerification)setIdentityVerification.voidsetInheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)setInheritEmailNotificationConfiguration.voidsetIsBulkRecipient(String isBulkRecipient)setIsBulkRecipient.voidsetIsBulkRecipientMetadata(PropertyMetadata isBulkRecipientMetadata)setIsBulkRecipientMetadata.voidsetLastName(String lastName)setLastName.voidsetLastNameMetadata(PropertyMetadata lastNameMetadata)setLastNameMetadata.voidsetLockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)setLockedRecipientPhoneAuthEditable.voidsetLockedRecipientSmsEditable(String lockedRecipientSmsEditable)setLockedRecipientSmsEditable.voidsetName(String name)setName.voidsetNameMetadata(PropertyMetadata nameMetadata)setNameMetadata.voidsetNotaryId(String notaryId)setNotaryId.voidsetNotarySignerEmailSent(String notarySignerEmailSent)setNotarySignerEmailSent.voidsetNote(String note)setNote.voidsetNoteMetadata(PropertyMetadata noteMetadata)setNoteMetadata.voidsetOfflineAttributes(OfflineAttributes offlineAttributes)setOfflineAttributes.voidsetPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)setPhoneAuthentication.voidsetPhoneNumber(RecipientPhoneNumber phoneNumber)setPhoneNumber.voidsetProofFile(RecipientProofFile proofFile)setProofFile.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.voidsetRecipientSuppliesTabs(String recipientSuppliesTabs)setRecipientSuppliesTabs.voidsetRecipientType(String recipientType)setRecipientType.voidsetRecipientTypeMetadata(PropertyMetadata recipientTypeMetadata)setRecipientTypeMetadata.voidsetRequireIdLookup(String requireIdLookup)setRequireIdLookup.voidsetRequireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)setRequireIdLookupMetadata.voidsetRequireSignerCertificate(String requireSignerCertificate)setRequireSignerCertificate.voidsetRequireSignOnPaper(String requireSignOnPaper)setRequireSignOnPaper.voidsetRequireUploadSignature(String requireUploadSignature)setRequireUploadSignature.voidsetRoleName(String roleName)setRoleName.voidsetRoutingOrder(String routingOrder)setRoutingOrder.voidsetRoutingOrderMetadata(PropertyMetadata routingOrderMetadata)setRoutingOrderMetadata.voidsetSentDateTime(String sentDateTime)setSentDateTime.voidsetSignatureInfo(RecipientSignatureInformation signatureInfo)setSignatureInfo.voidsetSignedDateTime(String signedDateTime)setSignedDateTime.voidsetSignInEachLocation(String signInEachLocation)setSignInEachLocation.voidsetSignInEachLocationMetadata(PropertyMetadata signInEachLocationMetadata)setSignInEachLocationMetadata.voidsetSigningGroupId(String signingGroupId)setSigningGroupId.voidsetSigningGroupIdMetadata(PropertyMetadata signingGroupIdMetadata)setSigningGroupIdMetadata.voidsetSigningGroupName(String signingGroupName)setSigningGroupName.voidsetSigningGroupUsers(List<UserInfo> signingGroupUsers)setSigningGroupUsers.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.voidsetType(String type)setType.voidsetUserId(String userId)setUserId.voidsetWebFormRecipientViewId(String webFormRecipientViewId)setWebFormRecipientViewId.voidsetWitnessFor(String witnessFor)setWitnessFor.voidsetWitnessForGuid(String witnessForGuid)setWitnessForGuid.NotaryWitnesssignatureInfo(RecipientSignatureInformation signatureInfo)signatureInfo.NotaryWitnesssignedDateTime(String signedDateTime)signedDateTime.NotaryWitnesssignInEachLocation(String signInEachLocation)signInEachLocation.NotaryWitnesssignInEachLocationMetadata(PropertyMetadata signInEachLocationMetadata)signInEachLocationMetadata.NotaryWitnesssigningGroupId(String signingGroupId)signingGroupId.NotaryWitnesssigningGroupIdMetadata(PropertyMetadata signingGroupIdMetadata)signingGroupIdMetadata.NotaryWitnesssigningGroupName(String signingGroupName)signingGroupName.NotaryWitnesssigningGroupUsers(List<UserInfo> signingGroupUsers)signingGroupUsers.NotaryWitnesssmsAuthentication(RecipientSMSAuthentication smsAuthentication)smsAuthentication.NotaryWitnesssocialAuthentications(List<SocialAuthentication> socialAuthentications)socialAuthentications.NotaryWitnessstatus(String status)status.NotaryWitnessstatusCode(String statusCode)statusCode.NotaryWitnesssuppressEmails(String suppressEmails)suppressEmails.NotaryWitnesstabs(Tabs tabs)tabs.NotaryWitnesstemplateLocked(String templateLocked)templateLocked.NotaryWitnesstemplateRequired(String templateRequired)templateRequired.StringtoString()Converts the given object to string.NotaryWitnesstotalTabCount(String totalTabCount)totalTabCount.NotaryWitnesstype(String type)type.NotaryWitnessuserId(String userId)userId.NotaryWitnesswebFormRecipientViewId(String webFormRecipientViewId)webFormRecipientViewId.NotaryWitnesswitnessFor(String witnessFor)witnessFor.NotaryWitnesswitnessForGuid(String witnessForGuid)witnessForGuid.
-
-
-
Method Detail
-
accessCode
public NotaryWitness accessCode(String accessCode)
accessCode.- Returns:
- NotaryWitness
-
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 NotaryWitness accessCodeMetadata(PropertyMetadata accessCodeMetadata)
accessCodeMetadata.- Returns:
- NotaryWitness
-
getAccessCodeMetadata
public PropertyMetadata getAccessCodeMetadata()
.- Returns:
- accessCodeMetadata
-
setAccessCodeMetadata
public void setAccessCodeMetadata(PropertyMetadata accessCodeMetadata)
setAccessCodeMetadata.
-
addAccessCodeToEmail
public NotaryWitness addAccessCodeToEmail(String addAccessCodeToEmail)
addAccessCodeToEmail.- Returns:
- NotaryWitness
-
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.
-
additionalNotifications
public NotaryWitness additionalNotifications(List<RecipientAdditionalNotification> additionalNotifications)
additionalNotifications.- Returns:
- NotaryWitness
-
addAdditionalNotificationsItem
public NotaryWitness addAdditionalNotificationsItem(RecipientAdditionalNotification additionalNotificationsItem)
addAdditionalNotificationsItem.- Returns:
- NotaryWitness
-
getAdditionalNotifications
public List<RecipientAdditionalNotification> getAdditionalNotifications()
.- Returns:
- additionalNotifications
-
setAdditionalNotifications
public void setAdditionalNotifications(List<RecipientAdditionalNotification> additionalNotifications)
setAdditionalNotifications.
-
agentCanEditEmail
public NotaryWitness agentCanEditEmail(String agentCanEditEmail)
agentCanEditEmail.- Returns:
- NotaryWitness
-
getAgentCanEditEmail
public String getAgentCanEditEmail()
.- Returns:
- agentCanEditEmail
-
setAgentCanEditEmail
public void setAgentCanEditEmail(String agentCanEditEmail)
setAgentCanEditEmail.
-
agentCanEditName
public NotaryWitness agentCanEditName(String agentCanEditName)
agentCanEditName.- Returns:
- NotaryWitness
-
getAgentCanEditName
public String getAgentCanEditName()
.- Returns:
- agentCanEditName
-
setAgentCanEditName
public void setAgentCanEditName(String agentCanEditName)
setAgentCanEditName.
-
allowSystemOverrideForLockedRecipient
public NotaryWitness allowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)
allowSystemOverrideForLockedRecipient.- Returns:
- NotaryWitness
-
getAllowSystemOverrideForLockedRecipient
public String getAllowSystemOverrideForLockedRecipient()
.- Returns:
- allowSystemOverrideForLockedRecipient
-
setAllowSystemOverrideForLockedRecipient
public void setAllowSystemOverrideForLockedRecipient(String allowSystemOverrideForLockedRecipient)
setAllowSystemOverrideForLockedRecipient.
-
autoNavigation
public NotaryWitness autoNavigation(String autoNavigation)
autoNavigation.- Returns:
- NotaryWitness
-
getAutoNavigation
public String getAutoNavigation()
.- Returns:
- autoNavigation
-
setAutoNavigation
public void setAutoNavigation(String autoNavigation)
setAutoNavigation.
-
autoRespondedReason
public NotaryWitness autoRespondedReason(String autoRespondedReason)
autoRespondedReason.- Returns:
- NotaryWitness
-
getAutoRespondedReason
public String getAutoRespondedReason()
.- Returns:
- autoRespondedReason
-
setAutoRespondedReason
public void setAutoRespondedReason(String autoRespondedReason)
setAutoRespondedReason.
-
bulkRecipientsUri
public NotaryWitness bulkRecipientsUri(String bulkRecipientsUri)
bulkRecipientsUri.- Returns:
- NotaryWitness
-
getBulkRecipientsUri
public String getBulkRecipientsUri()
Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information..- Returns:
- bulkRecipientsUri
-
setBulkRecipientsUri
public void setBulkRecipientsUri(String bulkRecipientsUri)
setBulkRecipientsUri.
-
bulkSendV2Recipient
public NotaryWitness bulkSendV2Recipient(String bulkSendV2Recipient)
bulkSendV2Recipient.- Returns:
- NotaryWitness
-
getBulkSendV2Recipient
public String getBulkSendV2Recipient()
.- Returns:
- bulkSendV2Recipient
-
setBulkSendV2Recipient
public void setBulkSendV2Recipient(String bulkSendV2Recipient)
setBulkSendV2Recipient.
-
canSignOffline
public NotaryWitness canSignOffline(String canSignOffline)
canSignOffline.- Returns:
- NotaryWitness
-
getCanSignOffline
public String getCanSignOffline()
When set to **true**, specifies that the signer can perform the signing ceremony offline..- Returns:
- canSignOffline
-
setCanSignOffline
public void setCanSignOffline(String canSignOffline)
setCanSignOffline.
-
clientUserId
public NotaryWitness clientUserId(String clientUserId)
clientUserId.- Returns:
- NotaryWitness
-
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 NotaryWitness completedCount(String completedCount)
completedCount.- Returns:
- NotaryWitness
-
getCompletedCount
public String getCompletedCount()
.- Returns:
- completedCount
-
setCompletedCount
public void setCompletedCount(String completedCount)
setCompletedCount.
-
consentDetailsList
public NotaryWitness consentDetailsList(List<ConsentDetails> consentDetailsList)
consentDetailsList.- Returns:
- NotaryWitness
-
addConsentDetailsListItem
public NotaryWitness addConsentDetailsListItem(ConsentDetails consentDetailsListItem)
addConsentDetailsListItem.- Returns:
- NotaryWitness
-
getConsentDetailsList
public List<ConsentDetails> getConsentDetailsList()
.- Returns:
- consentDetailsList
-
setConsentDetailsList
public void setConsentDetailsList(List<ConsentDetails> consentDetailsList)
setConsentDetailsList.
-
creationReason
public NotaryWitness creationReason(String creationReason)
creationReason.- Returns:
- NotaryWitness
-
getCreationReason
public String getCreationReason()
.- Returns:
- creationReason
-
setCreationReason
public void setCreationReason(String creationReason)
setCreationReason.
-
customFields
public NotaryWitness customFields(List<String> customFields)
customFields.- Returns:
- NotaryWitness
-
addCustomFieldsItem
public NotaryWitness addCustomFieldsItem(String customFieldsItem)
addCustomFieldsItem.- Returns:
- NotaryWitness
-
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 NotaryWitness declinedDateTime(String declinedDateTime)
declinedDateTime.- Returns:
- NotaryWitness
-
getDeclinedDateTime
public String getDeclinedDateTime()
The date and time the recipient declined the document..- Returns:
- declinedDateTime
-
setDeclinedDateTime
public void setDeclinedDateTime(String declinedDateTime)
setDeclinedDateTime.
-
declinedReason
public NotaryWitness declinedReason(String declinedReason)
declinedReason.- Returns:
- NotaryWitness
-
getDeclinedReason
public String getDeclinedReason()
The reason the recipient declined the document..- Returns:
- declinedReason
-
setDeclinedReason
public void setDeclinedReason(String declinedReason)
setDeclinedReason.
-
defaultRecipient
public NotaryWitness defaultRecipient(String defaultRecipient)
defaultRecipient.- Returns:
- NotaryWitness
-
getDefaultRecipient
public String getDefaultRecipient()
.- Returns:
- defaultRecipient
-
setDefaultRecipient
public void setDefaultRecipient(String defaultRecipient)
setDefaultRecipient.
-
delegatedBy
public NotaryWitness delegatedBy(DelegationInfo delegatedBy)
delegatedBy.- Returns:
- NotaryWitness
-
getDelegatedBy
public DelegationInfo getDelegatedBy()
.- Returns:
- delegatedBy
-
setDelegatedBy
public void setDelegatedBy(DelegationInfo delegatedBy)
setDelegatedBy.
-
delegatedTo
public NotaryWitness delegatedTo(List<DelegationInfo> delegatedTo)
delegatedTo.- Returns:
- NotaryWitness
-
addDelegatedToItem
public NotaryWitness addDelegatedToItem(DelegationInfo delegatedToItem)
addDelegatedToItem.- Returns:
- NotaryWitness
-
getDelegatedTo
public List<DelegationInfo> getDelegatedTo()
.- Returns:
- delegatedTo
-
setDelegatedTo
public void setDelegatedTo(List<DelegationInfo> delegatedTo)
setDelegatedTo.
-
deliveredDateTime
public NotaryWitness deliveredDateTime(String deliveredDateTime)
deliveredDateTime.- Returns:
- NotaryWitness
-
getDeliveredDateTime
public String getDeliveredDateTime()
Reserved: For DocuSign use only..- Returns:
- deliveredDateTime
-
setDeliveredDateTime
public void setDeliveredDateTime(String deliveredDateTime)
setDeliveredDateTime.
-
deliveryMethod
public NotaryWitness deliveryMethod(String deliveryMethod)
deliveryMethod.- Returns:
- NotaryWitness
-
getDeliveryMethod
public String getDeliveryMethod()
Reserved: For DocuSign use only..- Returns:
- deliveryMethod
-
setDeliveryMethod
public void setDeliveryMethod(String deliveryMethod)
setDeliveryMethod.
-
deliveryMethodMetadata
public NotaryWitness deliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)
deliveryMethodMetadata.- Returns:
- NotaryWitness
-
getDeliveryMethodMetadata
public PropertyMetadata getDeliveryMethodMetadata()
.- Returns:
- deliveryMethodMetadata
-
setDeliveryMethodMetadata
public void setDeliveryMethodMetadata(PropertyMetadata deliveryMethodMetadata)
setDeliveryMethodMetadata.
-
designatorId
public NotaryWitness designatorId(String designatorId)
designatorId.- Returns:
- NotaryWitness
-
getDesignatorId
public String getDesignatorId()
.- Returns:
- designatorId
-
setDesignatorId
public void setDesignatorId(String designatorId)
setDesignatorId.
-
designatorIdGuid
public NotaryWitness designatorIdGuid(String designatorIdGuid)
designatorIdGuid.- Returns:
- NotaryWitness
-
getDesignatorIdGuid
public String getDesignatorIdGuid()
.- Returns:
- designatorIdGuid
-
setDesignatorIdGuid
public void setDesignatorIdGuid(String designatorIdGuid)
setDesignatorIdGuid.
-
documentTemplateId
public NotaryWitness documentTemplateId(String documentTemplateId)
documentTemplateId.- Returns:
- NotaryWitness
-
getDocumentTemplateId
public String getDocumentTemplateId()
.- Returns:
- documentTemplateId
-
setDocumentTemplateId
public void setDocumentTemplateId(String documentTemplateId)
setDocumentTemplateId.
-
documentVisibility
public NotaryWitness documentVisibility(List<DocumentVisibility> documentVisibility)
documentVisibility.- Returns:
- NotaryWitness
-
addDocumentVisibilityItem
public NotaryWitness addDocumentVisibilityItem(DocumentVisibility documentVisibilityItem)
addDocumentVisibilityItem.- Returns:
- NotaryWitness
-
getDocumentVisibility
public List<DocumentVisibility> getDocumentVisibility()
.- Returns:
- documentVisibility
-
setDocumentVisibility
public void setDocumentVisibility(List<DocumentVisibility> documentVisibility)
setDocumentVisibility.
-
email
public NotaryWitness email(String email)
email.- Returns:
- NotaryWitness
-
getEmail
public String getEmail()
.- Returns:
-
setEmail
public void setEmail(String email)
setEmail.
-
emailMetadata
public NotaryWitness emailMetadata(PropertyMetadata emailMetadata)
emailMetadata.- Returns:
- NotaryWitness
-
getEmailMetadata
public PropertyMetadata getEmailMetadata()
.- Returns:
- emailMetadata
-
setEmailMetadata
public void setEmailMetadata(PropertyMetadata emailMetadata)
setEmailMetadata.
-
emailNotification
public NotaryWitness emailNotification(RecipientEmailNotification emailNotification)
emailNotification.- Returns:
- NotaryWitness
-
getEmailNotification
public RecipientEmailNotification getEmailNotification()
A complex type that contains information sets the language of the recipient's email information. **IMPORTANT**: If you enable email notification for one recipient, you must enable email notification for all recipients as it overrides the Envelope Subject and `EmailBlurb` property settings. .- Returns:
- emailNotification
-
setEmailNotification
public void setEmailNotification(RecipientEmailNotification emailNotification)
setEmailNotification.
-
emailRecipientPostSigningURL
public NotaryWitness emailRecipientPostSigningURL(String emailRecipientPostSigningURL)
emailRecipientPostSigningURL.- Returns:
- NotaryWitness
-
getEmailRecipientPostSigningURL
public String getEmailRecipientPostSigningURL()
.- Returns:
- emailRecipientPostSigningURL
-
setEmailRecipientPostSigningURL
public void setEmailRecipientPostSigningURL(String emailRecipientPostSigningURL)
setEmailRecipientPostSigningURL.
-
embeddedRecipientStartURL
public NotaryWitness embeddedRecipientStartURL(String embeddedRecipientStartURL)
embeddedRecipientStartURL.- Returns:
- NotaryWitness
-
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 NotaryWitness errorDetails(ErrorDetails errorDetails)
errorDetails.- Returns:
- NotaryWitness
-
getErrorDetails
public ErrorDetails getErrorDetails()
Array or errors..- Returns:
- errorDetails
-
setErrorDetails
public void setErrorDetails(ErrorDetails errorDetails)
setErrorDetails.
-
excludedDocuments
public NotaryWitness excludedDocuments(List<String> excludedDocuments)
excludedDocuments.- Returns:
- NotaryWitness
-
addExcludedDocumentsItem
public NotaryWitness addExcludedDocumentsItem(String excludedDocumentsItem)
addExcludedDocumentsItem.- Returns:
- NotaryWitness
-
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 NotaryWitness faxNumber(String faxNumber)
faxNumber.- Returns:
- NotaryWitness
-
getFaxNumber
public String getFaxNumber()
Reserved:.- Returns:
- faxNumber
-
setFaxNumber
public void setFaxNumber(String faxNumber)
setFaxNumber.
-
faxNumberMetadata
public NotaryWitness faxNumberMetadata(PropertyMetadata faxNumberMetadata)
faxNumberMetadata.- Returns:
- NotaryWitness
-
getFaxNumberMetadata
public PropertyMetadata getFaxNumberMetadata()
.- Returns:
- faxNumberMetadata
-
setFaxNumberMetadata
public void setFaxNumberMetadata(PropertyMetadata faxNumberMetadata)
setFaxNumberMetadata.
-
firstName
public NotaryWitness firstName(String firstName)
firstName.- Returns:
- NotaryWitness
-
getFirstName
public String getFirstName()
The user's first name. Maximum Length: 50 characters..- Returns:
- firstName
-
setFirstName
public void setFirstName(String firstName)
setFirstName.
-
firstNameMetadata
public NotaryWitness firstNameMetadata(PropertyMetadata firstNameMetadata)
firstNameMetadata.- Returns:
- NotaryWitness
-
getFirstNameMetadata
public PropertyMetadata getFirstNameMetadata()
.- Returns:
- firstNameMetadata
-
setFirstNameMetadata
public void setFirstNameMetadata(PropertyMetadata firstNameMetadata)
setFirstNameMetadata.
-
fullName
public NotaryWitness fullName(String fullName)
fullName.- Returns:
- NotaryWitness
-
getFullName
public String getFullName()
.- Returns:
- fullName
-
setFullName
public void setFullName(String fullName)
setFullName.
-
fullNameMetadata
public NotaryWitness fullNameMetadata(PropertyMetadata fullNameMetadata)
fullNameMetadata.- Returns:
- NotaryWitness
-
getFullNameMetadata
public PropertyMetadata getFullNameMetadata()
.- Returns:
- fullNameMetadata
-
setFullNameMetadata
public void setFullNameMetadata(PropertyMetadata fullNameMetadata)
setFullNameMetadata.
-
idCheckConfigurationName
public NotaryWitness idCheckConfigurationName(String idCheckConfigurationName)
idCheckConfigurationName.- Returns:
- NotaryWitness
-
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 NotaryWitness idCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)
idCheckConfigurationNameMetadata.- Returns:
- NotaryWitness
-
getIdCheckConfigurationNameMetadata
public PropertyMetadata getIdCheckConfigurationNameMetadata()
.- Returns:
- idCheckConfigurationNameMetadata
-
setIdCheckConfigurationNameMetadata
public void setIdCheckConfigurationNameMetadata(PropertyMetadata idCheckConfigurationNameMetadata)
setIdCheckConfigurationNameMetadata.
-
idCheckInformationInput
public NotaryWitness idCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
idCheckInformationInput.- Returns:
- NotaryWitness
-
getIdCheckInformationInput
public IdCheckInformationInput getIdCheckInformationInput()
.- Returns:
- idCheckInformationInput
-
setIdCheckInformationInput
public void setIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
setIdCheckInformationInput.
-
identityVerification
public NotaryWitness identityVerification(RecipientIdentityVerification identityVerification)
identityVerification.- Returns:
- NotaryWitness
-
getIdentityVerification
public RecipientIdentityVerification getIdentityVerification()
.- Returns:
- identityVerification
-
setIdentityVerification
public void setIdentityVerification(RecipientIdentityVerification identityVerification)
setIdentityVerification.
-
inheritEmailNotificationConfiguration
public NotaryWitness inheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)
inheritEmailNotificationConfiguration.- Returns:
- NotaryWitness
-
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.
-
isBulkRecipient
public NotaryWitness isBulkRecipient(String isBulkRecipient)
isBulkRecipient.- Returns:
- NotaryWitness
-
getIsBulkRecipient
public String getIsBulkRecipient()
.- Returns:
- isBulkRecipient
-
setIsBulkRecipient
public void setIsBulkRecipient(String isBulkRecipient)
setIsBulkRecipient.
-
isBulkRecipientMetadata
public NotaryWitness isBulkRecipientMetadata(PropertyMetadata isBulkRecipientMetadata)
isBulkRecipientMetadata.- Returns:
- NotaryWitness
-
getIsBulkRecipientMetadata
public PropertyMetadata getIsBulkRecipientMetadata()
.- Returns:
- isBulkRecipientMetadata
-
setIsBulkRecipientMetadata
public void setIsBulkRecipientMetadata(PropertyMetadata isBulkRecipientMetadata)
setIsBulkRecipientMetadata.
-
lastName
public NotaryWitness lastName(String lastName)
lastName.- Returns:
- NotaryWitness
-
getLastName
public String getLastName()
.- Returns:
- lastName
-
setLastName
public void setLastName(String lastName)
setLastName.
-
lastNameMetadata
public NotaryWitness lastNameMetadata(PropertyMetadata lastNameMetadata)
lastNameMetadata.- Returns:
- NotaryWitness
-
getLastNameMetadata
public PropertyMetadata getLastNameMetadata()
.- Returns:
- lastNameMetadata
-
setLastNameMetadata
public void setLastNameMetadata(PropertyMetadata lastNameMetadata)
setLastNameMetadata.
-
lockedRecipientPhoneAuthEditable
public NotaryWitness lockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)
lockedRecipientPhoneAuthEditable.- Returns:
- NotaryWitness
-
getLockedRecipientPhoneAuthEditable
public String getLockedRecipientPhoneAuthEditable()
.- Returns:
- lockedRecipientPhoneAuthEditable
-
setLockedRecipientPhoneAuthEditable
public void setLockedRecipientPhoneAuthEditable(String lockedRecipientPhoneAuthEditable)
setLockedRecipientPhoneAuthEditable.
-
lockedRecipientSmsEditable
public NotaryWitness lockedRecipientSmsEditable(String lockedRecipientSmsEditable)
lockedRecipientSmsEditable.- Returns:
- NotaryWitness
-
getLockedRecipientSmsEditable
public String getLockedRecipientSmsEditable()
.- Returns:
- lockedRecipientSmsEditable
-
setLockedRecipientSmsEditable
public void setLockedRecipientSmsEditable(String lockedRecipientSmsEditable)
setLockedRecipientSmsEditable.
-
name
public NotaryWitness name(String name)
name.- Returns:
- NotaryWitness
-
getName
public String getName()
.- Returns:
- name
-
setName
public void setName(String name)
setName.
-
nameMetadata
public NotaryWitness nameMetadata(PropertyMetadata nameMetadata)
nameMetadata.- Returns:
- NotaryWitness
-
getNameMetadata
public PropertyMetadata getNameMetadata()
.- Returns:
- nameMetadata
-
setNameMetadata
public void setNameMetadata(PropertyMetadata nameMetadata)
setNameMetadata.
-
notaryId
public NotaryWitness notaryId(String notaryId)
notaryId.- Returns:
- NotaryWitness
-
getNotaryId
public String getNotaryId()
.- Returns:
- notaryId
-
setNotaryId
public void setNotaryId(String notaryId)
setNotaryId.
-
notarySignerEmailSent
public NotaryWitness notarySignerEmailSent(String notarySignerEmailSent)
notarySignerEmailSent.- Returns:
- NotaryWitness
-
getNotarySignerEmailSent
public String getNotarySignerEmailSent()
.- Returns:
- notarySignerEmailSent
-
setNotarySignerEmailSent
public void setNotarySignerEmailSent(String notarySignerEmailSent)
setNotarySignerEmailSent.
-
note
public NotaryWitness note(String note)
note.- Returns:
- NotaryWitness
-
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 NotaryWitness noteMetadata(PropertyMetadata noteMetadata)
noteMetadata.- Returns:
- NotaryWitness
-
getNoteMetadata
public PropertyMetadata getNoteMetadata()
.- Returns:
- noteMetadata
-
setNoteMetadata
public void setNoteMetadata(PropertyMetadata noteMetadata)
setNoteMetadata.
-
offlineAttributes
public NotaryWitness offlineAttributes(OfflineAttributes offlineAttributes)
offlineAttributes.- Returns:
- NotaryWitness
-
getOfflineAttributes
public OfflineAttributes getOfflineAttributes()
.- Returns:
- offlineAttributes
-
setOfflineAttributes
public void setOfflineAttributes(OfflineAttributes offlineAttributes)
setOfflineAttributes.
-
phoneAuthentication
public NotaryWitness phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
phoneAuthentication.- Returns:
- NotaryWitness
-
getPhoneAuthentication
public RecipientPhoneAuthentication getPhoneAuthentication()
.- Returns:
- phoneAuthentication
-
setPhoneAuthentication
public void setPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
setPhoneAuthentication.
-
phoneNumber
public NotaryWitness phoneNumber(RecipientPhoneNumber phoneNumber)
phoneNumber.- Returns:
- NotaryWitness
-
getPhoneNumber
public RecipientPhoneNumber getPhoneNumber()
.- Returns:
- phoneNumber
-
setPhoneNumber
public void setPhoneNumber(RecipientPhoneNumber phoneNumber)
setPhoneNumber.
-
proofFile
public NotaryWitness proofFile(RecipientProofFile proofFile)
proofFile.- Returns:
- NotaryWitness
-
getProofFile
public RecipientProofFile getProofFile()
.- Returns:
- proofFile
-
setProofFile
public void setProofFile(RecipientProofFile proofFile)
setProofFile.
-
recipientAttachments
public NotaryWitness recipientAttachments(List<RecipientAttachment> recipientAttachments)
recipientAttachments.- Returns:
- NotaryWitness
-
addRecipientAttachmentsItem
public NotaryWitness addRecipientAttachmentsItem(RecipientAttachment recipientAttachmentsItem)
addRecipientAttachmentsItem.- Returns:
- NotaryWitness
-
getRecipientAttachments
public List<RecipientAttachment> getRecipientAttachments()
Reserved:.- Returns:
- recipientAttachments
-
setRecipientAttachments
public void setRecipientAttachments(List<RecipientAttachment> recipientAttachments)
setRecipientAttachments.
-
recipientAuthenticationStatus
public NotaryWitness recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
recipientAuthenticationStatus.- Returns:
- NotaryWitness
-
getRecipientAuthenticationStatus
public AuthenticationStatus getRecipientAuthenticationStatus()
.- Returns:
- recipientAuthenticationStatus
-
setRecipientAuthenticationStatus
public void setRecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
setRecipientAuthenticationStatus.
-
recipientFeatureMetadata
public NotaryWitness recipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)
recipientFeatureMetadata.- Returns:
- NotaryWitness
-
addRecipientFeatureMetadataItem
public NotaryWitness addRecipientFeatureMetadataItem(FeatureAvailableMetadata recipientFeatureMetadataItem)
addRecipientFeatureMetadataItem.- Returns:
- NotaryWitness
-
getRecipientFeatureMetadata
public List<FeatureAvailableMetadata> getRecipientFeatureMetadata()
.- Returns:
- recipientFeatureMetadata
-
setRecipientFeatureMetadata
public void setRecipientFeatureMetadata(List<FeatureAvailableMetadata> recipientFeatureMetadata)
setRecipientFeatureMetadata.
-
recipientId
public NotaryWitness recipientId(String recipientId)
recipientId.- Returns:
- NotaryWitness
-
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 NotaryWitness recipientIdGuid(String recipientIdGuid)
recipientIdGuid.- Returns:
- NotaryWitness
-
getRecipientIdGuid
public String getRecipientIdGuid()
.- Returns:
- recipientIdGuid
-
setRecipientIdGuid
public void setRecipientIdGuid(String recipientIdGuid)
setRecipientIdGuid.
-
recipientSignatureProviders
public NotaryWitness recipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)
recipientSignatureProviders.- Returns:
- NotaryWitness
-
addRecipientSignatureProvidersItem
public NotaryWitness addRecipientSignatureProvidersItem(RecipientSignatureProvider recipientSignatureProvidersItem)
addRecipientSignatureProvidersItem.- Returns:
- NotaryWitness
-
getRecipientSignatureProviders
public List<RecipientSignatureProvider> getRecipientSignatureProviders()
.- Returns:
- recipientSignatureProviders
-
setRecipientSignatureProviders
public void setRecipientSignatureProviders(List<RecipientSignatureProvider> recipientSignatureProviders)
setRecipientSignatureProviders.
-
recipientSuppliesTabs
public NotaryWitness recipientSuppliesTabs(String recipientSuppliesTabs)
recipientSuppliesTabs.- Returns:
- NotaryWitness
-
getRecipientSuppliesTabs
public String getRecipientSuppliesTabs()
.- Returns:
- recipientSuppliesTabs
-
setRecipientSuppliesTabs
public void setRecipientSuppliesTabs(String recipientSuppliesTabs)
setRecipientSuppliesTabs.
-
recipientType
public NotaryWitness recipientType(String recipientType)
recipientType.- Returns:
- NotaryWitness
-
getRecipientType
public String getRecipientType()
.- Returns:
- recipientType
-
setRecipientType
public void setRecipientType(String recipientType)
setRecipientType.
-
recipientTypeMetadata
public NotaryWitness recipientTypeMetadata(PropertyMetadata recipientTypeMetadata)
recipientTypeMetadata.- Returns:
- NotaryWitness
-
getRecipientTypeMetadata
public PropertyMetadata getRecipientTypeMetadata()
.- Returns:
- recipientTypeMetadata
-
setRecipientTypeMetadata
public void setRecipientTypeMetadata(PropertyMetadata recipientTypeMetadata)
setRecipientTypeMetadata.
-
requireIdLookup
public NotaryWitness requireIdLookup(String requireIdLookup)
requireIdLookup.- Returns:
- NotaryWitness
-
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 NotaryWitness requireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)
requireIdLookupMetadata.- Returns:
- NotaryWitness
-
getRequireIdLookupMetadata
public PropertyMetadata getRequireIdLookupMetadata()
.- Returns:
- requireIdLookupMetadata
-
setRequireIdLookupMetadata
public void setRequireIdLookupMetadata(PropertyMetadata requireIdLookupMetadata)
setRequireIdLookupMetadata.
-
requireSignerCertificate
public NotaryWitness requireSignerCertificate(String requireSignerCertificate)
requireSignerCertificate.- Returns:
- NotaryWitness
-
getRequireSignerCertificate
public String getRequireSignerCertificate()
.- Returns:
- requireSignerCertificate
-
setRequireSignerCertificate
public void setRequireSignerCertificate(String requireSignerCertificate)
setRequireSignerCertificate.
-
requireSignOnPaper
public NotaryWitness requireSignOnPaper(String requireSignOnPaper)
requireSignOnPaper.- Returns:
- NotaryWitness
-
getRequireSignOnPaper
public String getRequireSignOnPaper()
.- Returns:
- requireSignOnPaper
-
setRequireSignOnPaper
public void setRequireSignOnPaper(String requireSignOnPaper)
setRequireSignOnPaper.
-
requireUploadSignature
public NotaryWitness requireUploadSignature(String requireUploadSignature)
requireUploadSignature.- Returns:
- NotaryWitness
-
getRequireUploadSignature
public String getRequireUploadSignature()
.- Returns:
- requireUploadSignature
-
setRequireUploadSignature
public void setRequireUploadSignature(String requireUploadSignature)
setRequireUploadSignature.
-
roleName
public NotaryWitness roleName(String roleName)
roleName.- Returns:
- NotaryWitness
-
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 NotaryWitness routingOrder(String routingOrder)
routingOrder.- Returns:
- NotaryWitness
-
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 NotaryWitness routingOrderMetadata(PropertyMetadata routingOrderMetadata)
routingOrderMetadata.- Returns:
- NotaryWitness
-
getRoutingOrderMetadata
public PropertyMetadata getRoutingOrderMetadata()
.- Returns:
- routingOrderMetadata
-
setRoutingOrderMetadata
public void setRoutingOrderMetadata(PropertyMetadata routingOrderMetadata)
setRoutingOrderMetadata.
-
sentDateTime
public NotaryWitness sentDateTime(String sentDateTime)
sentDateTime.- Returns:
- NotaryWitness
-
getSentDateTime
public String getSentDateTime()
The date and time the envelope was sent..- Returns:
- sentDateTime
-
setSentDateTime
public void setSentDateTime(String sentDateTime)
setSentDateTime.
-
signatureInfo
public NotaryWitness signatureInfo(RecipientSignatureInformation signatureInfo)
signatureInfo.- Returns:
- NotaryWitness
-
getSignatureInfo
public RecipientSignatureInformation getSignatureInfo()
.- Returns:
- signatureInfo
-
setSignatureInfo
public void setSignatureInfo(RecipientSignatureInformation signatureInfo)
setSignatureInfo.
-
signedDateTime
public NotaryWitness signedDateTime(String signedDateTime)
signedDateTime.- Returns:
- NotaryWitness
-
getSignedDateTime
public String getSignedDateTime()
Reserved: For DocuSign use only. .- Returns:
- signedDateTime
-
setSignedDateTime
public void setSignedDateTime(String signedDateTime)
setSignedDateTime.
-
signInEachLocation
public NotaryWitness signInEachLocation(String signInEachLocation)
signInEachLocation.- Returns:
- NotaryWitness
-
getSignInEachLocation
public String getSignInEachLocation()
When set to **true**, specifies that the signer must sign in all locations..- Returns:
- signInEachLocation
-
setSignInEachLocation
public void setSignInEachLocation(String signInEachLocation)
setSignInEachLocation.
-
signInEachLocationMetadata
public NotaryWitness signInEachLocationMetadata(PropertyMetadata signInEachLocationMetadata)
signInEachLocationMetadata.- Returns:
- NotaryWitness
-
getSignInEachLocationMetadata
public PropertyMetadata getSignInEachLocationMetadata()
.- Returns:
- signInEachLocationMetadata
-
setSignInEachLocationMetadata
public void setSignInEachLocationMetadata(PropertyMetadata signInEachLocationMetadata)
setSignInEachLocationMetadata.
-
signingGroupId
public NotaryWitness signingGroupId(String signingGroupId)
signingGroupId.- Returns:
- NotaryWitness
-
getSigningGroupId
public String getSigningGroupId()
When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once)..- Returns:
- signingGroupId
-
setSigningGroupId
public void setSigningGroupId(String signingGroupId)
setSigningGroupId.
-
signingGroupIdMetadata
public NotaryWitness signingGroupIdMetadata(PropertyMetadata signingGroupIdMetadata)
signingGroupIdMetadata.- Returns:
- NotaryWitness
-
getSigningGroupIdMetadata
public PropertyMetadata getSigningGroupIdMetadata()
.- Returns:
- signingGroupIdMetadata
-
setSigningGroupIdMetadata
public void setSigningGroupIdMetadata(PropertyMetadata signingGroupIdMetadata)
setSigningGroupIdMetadata.
-
signingGroupName
public NotaryWitness signingGroupName(String signingGroupName)
signingGroupName.- Returns:
- NotaryWitness
-
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 NotaryWitness signingGroupUsers(List<UserInfo> signingGroupUsers)
signingGroupUsers.- Returns:
- NotaryWitness
-
addSigningGroupUsersItem
public NotaryWitness addSigningGroupUsersItem(UserInfo signingGroupUsersItem)
addSigningGroupUsersItem.- Returns:
- NotaryWitness
-
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.
-
smsAuthentication
public NotaryWitness smsAuthentication(RecipientSMSAuthentication smsAuthentication)
smsAuthentication.- Returns:
- NotaryWitness
-
getSmsAuthentication
public RecipientSMSAuthentication getSmsAuthentication()
.- Returns:
- smsAuthentication
-
setSmsAuthentication
public void setSmsAuthentication(RecipientSMSAuthentication smsAuthentication)
setSmsAuthentication.
-
socialAuthentications
public NotaryWitness socialAuthentications(List<SocialAuthentication> socialAuthentications)
socialAuthentications.- Returns:
- NotaryWitness
-
addSocialAuthenticationsItem
public NotaryWitness addSocialAuthenticationsItem(SocialAuthentication socialAuthenticationsItem)
addSocialAuthenticationsItem.- Returns:
- NotaryWitness
-
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 NotaryWitness status(String status)
status.- Returns:
- NotaryWitness
-
getStatus
public String getStatus()
Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later..- Returns:
- status
-
setStatus
public void setStatus(String status)
setStatus.
-
statusCode
public NotaryWitness statusCode(String statusCode)
statusCode.- Returns:
- NotaryWitness
-
getStatusCode
public String getStatusCode()
.- Returns:
- statusCode
-
setStatusCode
public void setStatusCode(String statusCode)
setStatusCode.
-
suppressEmails
public NotaryWitness suppressEmails(String suppressEmails)
suppressEmails.- Returns:
- NotaryWitness
-
getSuppressEmails
public String getSuppressEmails()
.- Returns:
- suppressEmails
-
setSuppressEmails
public void setSuppressEmails(String suppressEmails)
setSuppressEmails.
-
tabs
public NotaryWitness tabs(Tabs tabs)
tabs.- Returns:
- NotaryWitness
-
getTabs
public Tabs getTabs()
.- Returns:
- tabs
-
setTabs
public void setTabs(Tabs tabs)
setTabs.
-
templateLocked
public NotaryWitness templateLocked(String templateLocked)
templateLocked.- Returns:
- NotaryWitness
-
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 NotaryWitness templateRequired(String templateRequired)
templateRequired.- Returns:
- NotaryWitness
-
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 NotaryWitness totalTabCount(String totalTabCount)
totalTabCount.- Returns:
- NotaryWitness
-
getTotalTabCount
public String getTotalTabCount()
.- Returns:
- totalTabCount
-
setTotalTabCount
public void setTotalTabCount(String totalTabCount)
setTotalTabCount.
-
type
public NotaryWitness type(String type)
type.- Returns:
- NotaryWitness
-
getType
public String getType()
.- Returns:
- type
-
setType
public void setType(String type)
setType.
-
userId
public NotaryWitness userId(String userId)
userId.- Returns:
- NotaryWitness
-
getUserId
public String getUserId()
.- Returns:
- userId
-
setUserId
public void setUserId(String userId)
setUserId.
-
webFormRecipientViewId
public NotaryWitness webFormRecipientViewId(String webFormRecipientViewId)
webFormRecipientViewId.- Returns:
- NotaryWitness
-
getWebFormRecipientViewId
public String getWebFormRecipientViewId()
.- Returns:
- webFormRecipientViewId
-
setWebFormRecipientViewId
public void setWebFormRecipientViewId(String webFormRecipientViewId)
setWebFormRecipientViewId.
-
witnessFor
public NotaryWitness witnessFor(String witnessFor)
witnessFor.- Returns:
- NotaryWitness
-
getWitnessFor
public String getWitnessFor()
.- Returns:
- witnessFor
-
setWitnessFor
public void setWitnessFor(String witnessFor)
setWitnessFor.
-
witnessForGuid
public NotaryWitness witnessForGuid(String witnessForGuid)
witnessForGuid.- Returns:
- NotaryWitness
-
getWitnessForGuid
public String getWitnessForGuid()
.- Returns:
- witnessForGuid
-
setWitnessForGuid
public void setWitnessForGuid(String witnessForGuid)
setWitnessForGuid.
-
equals
public boolean equals(Object o)
Compares objects.
-
-