com.docusign.esign.model.EnvelopeDefinition Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of docusign-esign-java Show documentation
Show all versions of docusign-esign-java Show documentation
The official Docusign eSignature JAVA client is based on version 2.1 of the Docusign REST API and provides libraries for JAVA application integration. It is recommended that you use this version of the library for new development.
package com.docusign.esign.model;
import java.util.Objects;
import java.util.Arrays;
import com.docusign.esign.model.Attachment;
import com.docusign.esign.model.CompositeTemplate;
import com.docusign.esign.model.CustomFields;
import com.docusign.esign.model.Document;
import com.docusign.esign.model.EmailSettings;
import com.docusign.esign.model.EnvelopeDocument;
import com.docusign.esign.model.EnvelopeMetadata;
import com.docusign.esign.model.EventNotification;
import com.docusign.esign.model.Folder;
import com.docusign.esign.model.LockInformation;
import com.docusign.esign.model.Notification;
import com.docusign.esign.model.PowerForm;
import com.docusign.esign.model.Recipients;
import com.docusign.esign.model.TemplateRole;
import com.docusign.esign.model.UserInfo;
import com.docusign.esign.model.Workflow;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
/**
* EnvelopeDefinition
*/
public class EnvelopeDefinition {
@JsonProperty("accessControlListBase64")
private String accessControlListBase64 = null;
@JsonProperty("accessibility")
private String accessibility = null;
@JsonProperty("allowComments")
private String allowComments = null;
@JsonProperty("allowMarkup")
private String allowMarkup = null;
@JsonProperty("allowReassign")
private String allowReassign = null;
@JsonProperty("allowRecipientRecursion")
private String allowRecipientRecursion = null;
@JsonProperty("allowViewHistory")
private String allowViewHistory = null;
@JsonProperty("anySigner")
private String anySigner = null;
@JsonProperty("asynchronous")
private String asynchronous = null;
@JsonProperty("attachments")
private java.util.List attachments = null;
@JsonProperty("attachmentsUri")
private String attachmentsUri = null;
@JsonProperty("authoritativeCopy")
private String authoritativeCopy = null;
@JsonProperty("authoritativeCopyDefault")
private String authoritativeCopyDefault = null;
@JsonProperty("autoNavigation")
private String autoNavigation = null;
@JsonProperty("brandId")
private String brandId = null;
@JsonProperty("brandLock")
private String brandLock = null;
@JsonProperty("certificateUri")
private String certificateUri = null;
@JsonProperty("completedDateTime")
private String completedDateTime = null;
@JsonProperty("compositeTemplates")
private java.util.List compositeTemplates = null;
@JsonProperty("copyRecipientData")
private String copyRecipientData = null;
@JsonProperty("createdDateTime")
private String createdDateTime = null;
@JsonProperty("customFields")
private CustomFields customFields = null;
@JsonProperty("customFieldsUri")
private String customFieldsUri = null;
@JsonProperty("declinedDateTime")
private String declinedDateTime = null;
@JsonProperty("deletedDateTime")
private String deletedDateTime = null;
@JsonProperty("deliveredDateTime")
private String deliveredDateTime = null;
@JsonProperty("disableResponsiveDocument")
private String disableResponsiveDocument = null;
@JsonProperty("documents")
private java.util.List documents = null;
@JsonProperty("documentsCombinedUri")
private String documentsCombinedUri = null;
@JsonProperty("documentsUri")
private String documentsUri = null;
@JsonProperty("emailBlurb")
private String emailBlurb = null;
@JsonProperty("emailSettings")
private EmailSettings emailSettings = null;
@JsonProperty("emailSubject")
private String emailSubject = null;
@JsonProperty("enableWetSign")
private String enableWetSign = null;
@JsonProperty("enforceSignerVisibility")
private String enforceSignerVisibility = null;
@JsonProperty("envelopeAttachments")
private java.util.List envelopeAttachments = null;
@JsonProperty("envelopeDocuments")
private java.util.List envelopeDocuments = null;
@JsonProperty("envelopeId")
private String envelopeId = null;
@JsonProperty("envelopeIdStamping")
private String envelopeIdStamping = null;
@JsonProperty("envelopeLocation")
private String envelopeLocation = null;
@JsonProperty("envelopeMetadata")
private EnvelopeMetadata envelopeMetadata = null;
@JsonProperty("envelopeUri")
private String envelopeUri = null;
@JsonProperty("eventNotification")
private EventNotification eventNotification = null;
@JsonProperty("eventNotifications")
private java.util.List eventNotifications = null;
@JsonProperty("expireAfter")
private String expireAfter = null;
@JsonProperty("expireDateTime")
private String expireDateTime = null;
@JsonProperty("expireEnabled")
private String expireEnabled = null;
@JsonProperty("externalEnvelopeId")
private String externalEnvelopeId = null;
@JsonProperty("folders")
private java.util.List folders = null;
@JsonProperty("hasComments")
private String hasComments = null;
@JsonProperty("hasFormDataChanged")
private String hasFormDataChanged = null;
@JsonProperty("hasWavFile")
private String hasWavFile = null;
@JsonProperty("holder")
private String holder = null;
@JsonProperty("initialSentDateTime")
private String initialSentDateTime = null;
@JsonProperty("is21CFRPart11")
private String is21CFRPart11 = null;
@JsonProperty("isDynamicEnvelope")
private String isDynamicEnvelope = null;
@JsonProperty("isSignatureProviderEnvelope")
private String isSignatureProviderEnvelope = null;
@JsonProperty("lastModifiedDateTime")
private String lastModifiedDateTime = null;
@JsonProperty("location")
private String location = null;
@JsonProperty("lockInformation")
private LockInformation lockInformation = null;
@JsonProperty("messageLock")
private String messageLock = null;
@JsonProperty("notification")
private Notification notification = null;
@JsonProperty("notificationUri")
private String notificationUri = null;
@JsonProperty("password")
private String password = null;
@JsonProperty("powerForm")
private PowerForm powerForm = null;
@JsonProperty("purgeCompletedDate")
private String purgeCompletedDate = null;
@JsonProperty("purgeRequestDate")
private String purgeRequestDate = null;
@JsonProperty("purgeState")
private String purgeState = null;
@JsonProperty("recipients")
private Recipients recipients = null;
@JsonProperty("recipientsLock")
private String recipientsLock = null;
@JsonProperty("recipientsUri")
private String recipientsUri = null;
@JsonProperty("sender")
private UserInfo sender = null;
@JsonProperty("sentDateTime")
private String sentDateTime = null;
@JsonProperty("signerCanSignOnMobile")
private String signerCanSignOnMobile = null;
@JsonProperty("signingLocation")
private String signingLocation = null;
@JsonProperty("status")
private String status = null;
@JsonProperty("statusChangedDateTime")
private String statusChangedDateTime = null;
@JsonProperty("statusDateTime")
private String statusDateTime = null;
@JsonProperty("templateId")
private String templateId = null;
@JsonProperty("templateRoles")
private java.util.List templateRoles = null;
@JsonProperty("templatesUri")
private String templatesUri = null;
@JsonProperty("transactionId")
private String transactionId = null;
@JsonProperty("useDisclosure")
private String useDisclosure = null;
@JsonProperty("voidedDateTime")
private String voidedDateTime = null;
@JsonProperty("voidedReason")
private String voidedReason = null;
@JsonProperty("workflow")
private Workflow workflow = null;
public EnvelopeDefinition accessControlListBase64(String accessControlListBase64) {
this.accessControlListBase64 = accessControlListBase64;
return this;
}
/**
*
* @return accessControlListBase64
**/
@ApiModelProperty(value = "")
public String getAccessControlListBase64() {
return accessControlListBase64;
}
public void setAccessControlListBase64(String accessControlListBase64) {
this.accessControlListBase64 = accessControlListBase64;
}
public EnvelopeDefinition accessibility(String accessibility) {
this.accessibility = accessibility;
return this;
}
/**
* Sets the document reading zones for screen reader applications. This element can only be used if Document Accessibility is enabled for the account. ###### Note: This information is currently generated from the DocuSign web console by setting the reading zones when creating a template, exporting the reading zone string information, and adding it here.
* @return accessibility
**/
@ApiModelProperty(value = "Sets the document reading zones for screen reader applications. This element can only be used if Document Accessibility is enabled for the account. ###### Note: This information is currently generated from the DocuSign web console by setting the reading zones when creating a template, exporting the reading zone string information, and adding it here.")
public String getAccessibility() {
return accessibility;
}
public void setAccessibility(String accessibility) {
this.accessibility = accessibility;
}
public EnvelopeDefinition allowComments(String allowComments) {
this.allowComments = allowComments;
return this;
}
/**
*
* @return allowComments
**/
@ApiModelProperty(value = "")
public String getAllowComments() {
return allowComments;
}
public void setAllowComments(String allowComments) {
this.allowComments = allowComments;
}
public EnvelopeDefinition allowMarkup(String allowMarkup) {
this.allowMarkup = allowMarkup;
return this;
}
/**
* When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this
* @return allowMarkup
**/
@ApiModelProperty(value = "When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this")
public String getAllowMarkup() {
return allowMarkup;
}
public void setAllowMarkup(String allowMarkup) {
this.allowMarkup = allowMarkup;
}
public EnvelopeDefinition allowReassign(String allowReassign) {
this.allowReassign = allowReassign;
return this;
}
/**
* When set to **true**, the recipient can redirect an envelope to a more appropriate recipient.
* @return allowReassign
**/
@ApiModelProperty(value = "When set to **true**, the recipient can redirect an envelope to a more appropriate recipient.")
public String getAllowReassign() {
return allowReassign;
}
public void setAllowReassign(String allowReassign) {
this.allowReassign = allowReassign;
}
public EnvelopeDefinition allowRecipientRecursion(String allowRecipientRecursion) {
this.allowRecipientRecursion = allowRecipientRecursion;
return this;
}
/**
* When set to **true**, this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order.
* @return allowRecipientRecursion
**/
@ApiModelProperty(value = "When set to **true**, this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order.")
public String getAllowRecipientRecursion() {
return allowRecipientRecursion;
}
public void setAllowRecipientRecursion(String allowRecipientRecursion) {
this.allowRecipientRecursion = allowRecipientRecursion;
}
public EnvelopeDefinition allowViewHistory(String allowViewHistory) {
this.allowViewHistory = allowViewHistory;
return this;
}
/**
*
* @return allowViewHistory
**/
@ApiModelProperty(value = "")
public String getAllowViewHistory() {
return allowViewHistory;
}
public void setAllowViewHistory(String allowViewHistory) {
this.allowViewHistory = allowViewHistory;
}
public EnvelopeDefinition anySigner(String anySigner) {
this.anySigner = anySigner;
return this;
}
/**
*
* @return anySigner
**/
@ApiModelProperty(value = "")
public String getAnySigner() {
return anySigner;
}
public void setAnySigner(String anySigner) {
this.anySigner = anySigner;
}
public EnvelopeDefinition asynchronous(String asynchronous) {
this.asynchronous = asynchronous;
return this;
}
/**
* When set to **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed.
* @return asynchronous
**/
@ApiModelProperty(value = "When set to **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed.")
public String getAsynchronous() {
return asynchronous;
}
public void setAsynchronous(String asynchronous) {
this.asynchronous = asynchronous;
}
public EnvelopeDefinition attachments(java.util.List attachments) {
this.attachments = attachments;
return this;
}
public EnvelopeDefinition addAttachmentsItem(Attachment attachmentsItem) {
if (this.attachments == null) {
this.attachments = new java.util.ArrayList();
}
this.attachments.add(attachmentsItem);
return this;
}
/**
*
* @return attachments
**/
@ApiModelProperty(value = "")
public java.util.List getAttachments() {
return attachments;
}
public void setAttachments(java.util.List attachments) {
this.attachments = attachments;
}
public EnvelopeDefinition attachmentsUri(String attachmentsUri) {
this.attachmentsUri = attachmentsUri;
return this;
}
/**
*
* @return attachmentsUri
**/
@ApiModelProperty(value = "")
public String getAttachmentsUri() {
return attachmentsUri;
}
public void setAttachmentsUri(String attachmentsUri) {
this.attachmentsUri = attachmentsUri;
}
public EnvelopeDefinition authoritativeCopy(String authoritativeCopy) {
this.authoritativeCopy = authoritativeCopy;
return this;
}
/**
* Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.
* @return authoritativeCopy
**/
@ApiModelProperty(value = "Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.")
public String getAuthoritativeCopy() {
return authoritativeCopy;
}
public void setAuthoritativeCopy(String authoritativeCopy) {
this.authoritativeCopy = authoritativeCopy;
}
public EnvelopeDefinition authoritativeCopyDefault(String authoritativeCopyDefault) {
this.authoritativeCopyDefault = authoritativeCopyDefault;
return this;
}
/**
*
* @return authoritativeCopyDefault
**/
@ApiModelProperty(value = "")
public String getAuthoritativeCopyDefault() {
return authoritativeCopyDefault;
}
public void setAuthoritativeCopyDefault(String authoritativeCopyDefault) {
this.authoritativeCopyDefault = authoritativeCopyDefault;
}
public EnvelopeDefinition autoNavigation(String autoNavigation) {
this.autoNavigation = autoNavigation;
return this;
}
/**
*
* @return autoNavigation
**/
@ApiModelProperty(value = "")
public String getAutoNavigation() {
return autoNavigation;
}
public void setAutoNavigation(String autoNavigation) {
this.autoNavigation = autoNavigation;
}
public EnvelopeDefinition brandId(String brandId) {
this.brandId = brandId;
return this;
}
/**
* This sets the brand profile format used for the envelope. The value in the string is the brandId associated with the profile. Account branding must be enabled for the account to use this option.
* @return brandId
**/
@ApiModelProperty(value = "This sets the brand profile format used for the envelope. The value in the string is the brandId associated with the profile. Account branding must be enabled for the account to use this option.")
public String getBrandId() {
return brandId;
}
public void setBrandId(String brandId) {
this.brandId = brandId;
}
public EnvelopeDefinition brandLock(String brandLock) {
this.brandLock = brandLock;
return this;
}
/**
*
* @return brandLock
**/
@ApiModelProperty(value = "")
public String getBrandLock() {
return brandLock;
}
public void setBrandLock(String brandLock) {
this.brandLock = brandLock;
}
public EnvelopeDefinition certificateUri(String certificateUri) {
this.certificateUri = certificateUri;
return this;
}
/**
* Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.
* @return certificateUri
**/
@ApiModelProperty(value = "Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.")
public String getCertificateUri() {
return certificateUri;
}
public void setCertificateUri(String certificateUri) {
this.certificateUri = certificateUri;
}
public EnvelopeDefinition completedDateTime(String completedDateTime) {
this.completedDateTime = completedDateTime;
return this;
}
/**
* Specifies the date and time this item was completed.
* @return completedDateTime
**/
@ApiModelProperty(value = "Specifies the date and time this item was completed.")
public String getCompletedDateTime() {
return completedDateTime;
}
public void setCompletedDateTime(String completedDateTime) {
this.completedDateTime = completedDateTime;
}
public EnvelopeDefinition compositeTemplates(java.util.List compositeTemplates) {
this.compositeTemplates = compositeTemplates;
return this;
}
public EnvelopeDefinition addCompositeTemplatesItem(CompositeTemplate compositeTemplatesItem) {
if (this.compositeTemplates == null) {
this.compositeTemplates = new java.util.ArrayList();
}
this.compositeTemplates.add(compositeTemplatesItem);
return this;
}
/**
* A complex type that can be added to create envelopes from a combination of DocuSign templates and PDF forms. The basic envelope remains the same, while the Composite Template adds new document and template overlays into the envelope. There can be any number of Composite Template structures in the envelope.
* @return compositeTemplates
**/
@ApiModelProperty(value = "A complex type that can be added to create envelopes from a combination of DocuSign templates and PDF forms. The basic envelope remains the same, while the Composite Template adds new document and template overlays into the envelope. There can be any number of Composite Template structures in the envelope.")
public java.util.List getCompositeTemplates() {
return compositeTemplates;
}
public void setCompositeTemplates(java.util.List compositeTemplates) {
this.compositeTemplates = compositeTemplates;
}
public EnvelopeDefinition copyRecipientData(String copyRecipientData) {
this.copyRecipientData = copyRecipientData;
return this;
}
/**
*
* @return copyRecipientData
**/
@ApiModelProperty(value = "")
public String getCopyRecipientData() {
return copyRecipientData;
}
public void setCopyRecipientData(String copyRecipientData) {
this.copyRecipientData = copyRecipientData;
}
public EnvelopeDefinition createdDateTime(String createdDateTime) {
this.createdDateTime = createdDateTime;
return this;
}
/**
* Indicates the date and time the item was created.
* @return createdDateTime
**/
@ApiModelProperty(value = "Indicates the date and time the item was created.")
public String getCreatedDateTime() {
return createdDateTime;
}
public void setCreatedDateTime(String createdDateTime) {
this.createdDateTime = createdDateTime;
}
public EnvelopeDefinition customFields(CustomFields customFields) {
this.customFields = customFields;
return this;
}
/**
* Get customFields
* @return customFields
**/
@ApiModelProperty(value = "")
public CustomFields getCustomFields() {
return customFields;
}
public void setCustomFields(CustomFields customFields) {
this.customFields = customFields;
}
public EnvelopeDefinition customFieldsUri(String customFieldsUri) {
this.customFieldsUri = customFieldsUri;
return this;
}
/**
* Contains a URI for an endpoint that you can use to retrieve the custom fields.
* @return customFieldsUri
**/
@ApiModelProperty(value = "Contains a URI for an endpoint that you can use to retrieve the custom fields.")
public String getCustomFieldsUri() {
return customFieldsUri;
}
public void setCustomFieldsUri(String customFieldsUri) {
this.customFieldsUri = customFieldsUri;
}
public EnvelopeDefinition declinedDateTime(String declinedDateTime) {
this.declinedDateTime = declinedDateTime;
return this;
}
/**
* The date and time the recipient declined the document.
* @return declinedDateTime
**/
@ApiModelProperty(value = "The date and time the recipient declined the document.")
public String getDeclinedDateTime() {
return declinedDateTime;
}
public void setDeclinedDateTime(String declinedDateTime) {
this.declinedDateTime = declinedDateTime;
}
public EnvelopeDefinition deletedDateTime(String deletedDateTime) {
this.deletedDateTime = deletedDateTime;
return this;
}
/**
* Specifies the data and time the item was deleted.
* @return deletedDateTime
**/
@ApiModelProperty(value = "Specifies the data and time the item was deleted.")
public String getDeletedDateTime() {
return deletedDateTime;
}
public void setDeletedDateTime(String deletedDateTime) {
this.deletedDateTime = deletedDateTime;
}
public EnvelopeDefinition deliveredDateTime(String deliveredDateTime) {
this.deliveredDateTime = deliveredDateTime;
return this;
}
/**
* Reserved: For DocuSign use only.
* @return deliveredDateTime
**/
@ApiModelProperty(value = "Reserved: For DocuSign use only.")
public String getDeliveredDateTime() {
return deliveredDateTime;
}
public void setDeliveredDateTime(String deliveredDateTime) {
this.deliveredDateTime = deliveredDateTime;
}
public EnvelopeDefinition disableResponsiveDocument(String disableResponsiveDocument) {
this.disableResponsiveDocument = disableResponsiveDocument;
return this;
}
/**
*
* @return disableResponsiveDocument
**/
@ApiModelProperty(value = "")
public String getDisableResponsiveDocument() {
return disableResponsiveDocument;
}
public void setDisableResponsiveDocument(String disableResponsiveDocument) {
this.disableResponsiveDocument = disableResponsiveDocument;
}
public EnvelopeDefinition documents(java.util.List documents) {
this.documents = documents;
return this;
}
public EnvelopeDefinition addDocumentsItem(Document documentsItem) {
if (this.documents == null) {
this.documents = new java.util.ArrayList();
}
this.documents.add(documentsItem);
return this;
}
/**
* Complex element contains the details on the documents in the envelope.
* @return documents
**/
@ApiModelProperty(value = "Complex element contains the details on the documents in the envelope.")
public java.util.List getDocuments() {
return documents;
}
public void setDocuments(java.util.List documents) {
this.documents = documents;
}
public EnvelopeDefinition documentsCombinedUri(String documentsCombinedUri) {
this.documentsCombinedUri = documentsCombinedUri;
return this;
}
/**
*
* @return documentsCombinedUri
**/
@ApiModelProperty(value = "")
public String getDocumentsCombinedUri() {
return documentsCombinedUri;
}
public void setDocumentsCombinedUri(String documentsCombinedUri) {
this.documentsCombinedUri = documentsCombinedUri;
}
public EnvelopeDefinition documentsUri(String documentsUri) {
this.documentsUri = documentsUri;
return this;
}
/**
* Contains a URI for an endpoint that you can use to retrieve the documents.
* @return documentsUri
**/
@ApiModelProperty(value = "Contains a URI for an endpoint that you can use to retrieve the documents.")
public String getDocumentsUri() {
return documentsUri;
}
public void setDocumentsUri(String documentsUri) {
this.documentsUri = documentsUri;
}
public EnvelopeDefinition emailBlurb(String emailBlurb) {
this.emailBlurb = emailBlurb;
return this;
}
/**
* Optional element. This is the same as the email body. If specified it is included in email body for all envelope recipients. This can be a maximum of 10000 characters
* @return emailBlurb
**/
@ApiModelProperty(value = "Optional element. This is the same as the email body. If specified it is included in email body for all envelope recipients. This can be a maximum of 10000 characters")
public String getEmailBlurb() {
return emailBlurb;
}
public void setEmailBlurb(String emailBlurb) {
this.emailBlurb = emailBlurb;
}
public EnvelopeDefinition emailSettings(EmailSettings emailSettings) {
this.emailSettings = emailSettings;
return this;
}
/**
* Get emailSettings
* @return emailSettings
**/
@ApiModelProperty(value = "")
public EmailSettings getEmailSettings() {
return emailSettings;
}
public void setEmailSettings(EmailSettings emailSettings) {
this.emailSettings = emailSettings;
}
public EnvelopeDefinition emailSubject(String emailSubject) {
this.emailSubject = emailSubject;
return this;
}
/**
* Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.
* @return emailSubject
**/
@ApiModelProperty(value = "Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.")
public String getEmailSubject() {
return emailSubject;
}
public void setEmailSubject(String emailSubject) {
this.emailSubject = emailSubject;
}
public EnvelopeDefinition enableWetSign(String enableWetSign) {
this.enableWetSign = enableWetSign;
return this;
}
/**
* When set to **true**, the signer is allowed to print the document and sign it on paper.
* @return enableWetSign
**/
@ApiModelProperty(value = "When set to **true**, the signer is allowed to print the document and sign it on paper.")
public String getEnableWetSign() {
return enableWetSign;
}
public void setEnableWetSign(String enableWetSign) {
this.enableWetSign = enableWetSign;
}
public EnvelopeDefinition enforceSignerVisibility(String enforceSignerVisibility) {
this.enforceSignerVisibility = enforceSignerVisibility;
return this;
}
/**
* When set to **true**, 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. Your account must have Document Visibility enabled to use this.
* @return enforceSignerVisibility
**/
@ApiModelProperty(value = "When set to **true**, 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. Your account must have Document Visibility enabled to use this.")
public String getEnforceSignerVisibility() {
return enforceSignerVisibility;
}
public void setEnforceSignerVisibility(String enforceSignerVisibility) {
this.enforceSignerVisibility = enforceSignerVisibility;
}
public EnvelopeDefinition envelopeAttachments(java.util.List envelopeAttachments) {
this.envelopeAttachments = envelopeAttachments;
return this;
}
public EnvelopeDefinition addEnvelopeAttachmentsItem(Attachment envelopeAttachmentsItem) {
if (this.envelopeAttachments == null) {
this.envelopeAttachments = new java.util.ArrayList();
}
this.envelopeAttachments.add(envelopeAttachmentsItem);
return this;
}
/**
*
* @return envelopeAttachments
**/
@ApiModelProperty(value = "")
public java.util.List getEnvelopeAttachments() {
return envelopeAttachments;
}
public void setEnvelopeAttachments(java.util.List envelopeAttachments) {
this.envelopeAttachments = envelopeAttachments;
}
public EnvelopeDefinition envelopeDocuments(java.util.List envelopeDocuments) {
this.envelopeDocuments = envelopeDocuments;
return this;
}
public EnvelopeDefinition addEnvelopeDocumentsItem(EnvelopeDocument envelopeDocumentsItem) {
if (this.envelopeDocuments == null) {
this.envelopeDocuments = new java.util.ArrayList();
}
this.envelopeDocuments.add(envelopeDocumentsItem);
return this;
}
/**
*
* @return envelopeDocuments
**/
@ApiModelProperty(value = "")
public java.util.List getEnvelopeDocuments() {
return envelopeDocuments;
}
public void setEnvelopeDocuments(java.util.List envelopeDocuments) {
this.envelopeDocuments = envelopeDocuments;
}
public EnvelopeDefinition envelopeId(String envelopeId) {
this.envelopeId = envelopeId;
return this;
}
/**
* The envelope ID of the envelope status that failed to post.
* @return envelopeId
**/
@ApiModelProperty(value = "The envelope ID of the envelope status that failed to post.")
public String getEnvelopeId() {
return envelopeId;
}
public void setEnvelopeId(String envelopeId) {
this.envelopeId = envelopeId;
}
public EnvelopeDefinition envelopeIdStamping(String envelopeIdStamping) {
this.envelopeIdStamping = envelopeIdStamping;
return this;
}
/**
* When set to **true**, Envelope ID Stamping is enabled.
* @return envelopeIdStamping
**/
@ApiModelProperty(value = "When set to **true**, Envelope ID Stamping is enabled.")
public String getEnvelopeIdStamping() {
return envelopeIdStamping;
}
public void setEnvelopeIdStamping(String envelopeIdStamping) {
this.envelopeIdStamping = envelopeIdStamping;
}
public EnvelopeDefinition envelopeLocation(String envelopeLocation) {
this.envelopeLocation = envelopeLocation;
return this;
}
/**
*
* @return envelopeLocation
**/
@ApiModelProperty(value = "")
public String getEnvelopeLocation() {
return envelopeLocation;
}
public void setEnvelopeLocation(String envelopeLocation) {
this.envelopeLocation = envelopeLocation;
}
public EnvelopeDefinition envelopeMetadata(EnvelopeMetadata envelopeMetadata) {
this.envelopeMetadata = envelopeMetadata;
return this;
}
/**
* Get envelopeMetadata
* @return envelopeMetadata
**/
@ApiModelProperty(value = "")
public EnvelopeMetadata getEnvelopeMetadata() {
return envelopeMetadata;
}
public void setEnvelopeMetadata(EnvelopeMetadata envelopeMetadata) {
this.envelopeMetadata = envelopeMetadata;
}
public EnvelopeDefinition envelopeUri(String envelopeUri) {
this.envelopeUri = envelopeUri;
return this;
}
/**
* Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
* @return envelopeUri
**/
@ApiModelProperty(value = "Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.")
public String getEnvelopeUri() {
return envelopeUri;
}
public void setEnvelopeUri(String envelopeUri) {
this.envelopeUri = envelopeUri;
}
public EnvelopeDefinition eventNotification(EventNotification eventNotification) {
this.eventNotification = eventNotification;
return this;
}
/**
* Get eventNotification
* @return eventNotification
**/
@ApiModelProperty(value = "")
public EventNotification getEventNotification() {
return eventNotification;
}
public void setEventNotification(EventNotification eventNotification) {
this.eventNotification = eventNotification;
}
public EnvelopeDefinition eventNotifications(java.util.List eventNotifications) {
this.eventNotifications = eventNotifications;
return this;
}
public EnvelopeDefinition addEventNotificationsItem(EventNotification eventNotificationsItem) {
if (this.eventNotifications == null) {
this.eventNotifications = new java.util.ArrayList();
}
this.eventNotifications.add(eventNotificationsItem);
return this;
}
/**
*
* @return eventNotifications
**/
@ApiModelProperty(value = "")
public java.util.List getEventNotifications() {
return eventNotifications;
}
public void setEventNotifications(java.util.List eventNotifications) {
this.eventNotifications = eventNotifications;
}
public EnvelopeDefinition expireAfter(String expireAfter) {
this.expireAfter = expireAfter;
return this;
}
/**
*
* @return expireAfter
**/
@ApiModelProperty(value = "")
public String getExpireAfter() {
return expireAfter;
}
public void setExpireAfter(String expireAfter) {
this.expireAfter = expireAfter;
}
public EnvelopeDefinition expireDateTime(String expireDateTime) {
this.expireDateTime = expireDateTime;
return this;
}
/**
*
* @return expireDateTime
**/
@ApiModelProperty(value = "")
public String getExpireDateTime() {
return expireDateTime;
}
public void setExpireDateTime(String expireDateTime) {
this.expireDateTime = expireDateTime;
}
public EnvelopeDefinition expireEnabled(String expireEnabled) {
this.expireEnabled = expireEnabled;
return this;
}
/**
*
* @return expireEnabled
**/
@ApiModelProperty(value = "")
public String getExpireEnabled() {
return expireEnabled;
}
public void setExpireEnabled(String expireEnabled) {
this.expireEnabled = expireEnabled;
}
public EnvelopeDefinition externalEnvelopeId(String externalEnvelopeId) {
this.externalEnvelopeId = externalEnvelopeId;
return this;
}
/**
*
* @return externalEnvelopeId
**/
@ApiModelProperty(value = "")
public String getExternalEnvelopeId() {
return externalEnvelopeId;
}
public void setExternalEnvelopeId(String externalEnvelopeId) {
this.externalEnvelopeId = externalEnvelopeId;
}
public EnvelopeDefinition folders(java.util.List folders) {
this.folders = folders;
return this;
}
public EnvelopeDefinition addFoldersItem(Folder foldersItem) {
if (this.folders == null) {
this.folders = new java.util.ArrayList();
}
this.folders.add(foldersItem);
return this;
}
/**
*
* @return folders
**/
@ApiModelProperty(value = "")
public java.util.List getFolders() {
return folders;
}
public void setFolders(java.util.List folders) {
this.folders = folders;
}
public EnvelopeDefinition hasComments(String hasComments) {
this.hasComments = hasComments;
return this;
}
/**
*
* @return hasComments
**/
@ApiModelProperty(value = "")
public String getHasComments() {
return hasComments;
}
public void setHasComments(String hasComments) {
this.hasComments = hasComments;
}
public EnvelopeDefinition hasFormDataChanged(String hasFormDataChanged) {
this.hasFormDataChanged = hasFormDataChanged;
return this;
}
/**
*
* @return hasFormDataChanged
**/
@ApiModelProperty(value = "")
public String getHasFormDataChanged() {
return hasFormDataChanged;
}
public void setHasFormDataChanged(String hasFormDataChanged) {
this.hasFormDataChanged = hasFormDataChanged;
}
public EnvelopeDefinition hasWavFile(String hasWavFile) {
this.hasWavFile = hasWavFile;
return this;
}
/**
*
* @return hasWavFile
**/
@ApiModelProperty(value = "")
public String getHasWavFile() {
return hasWavFile;
}
public void setHasWavFile(String hasWavFile) {
this.hasWavFile = hasWavFile;
}
public EnvelopeDefinition holder(String holder) {
this.holder = holder;
return this;
}
/**
*
* @return holder
**/
@ApiModelProperty(value = "")
public String getHolder() {
return holder;
}
public void setHolder(String holder) {
this.holder = holder;
}
public EnvelopeDefinition initialSentDateTime(String initialSentDateTime) {
this.initialSentDateTime = initialSentDateTime;
return this;
}
/**
*
* @return initialSentDateTime
**/
@ApiModelProperty(value = "")
public String getInitialSentDateTime() {
return initialSentDateTime;
}
public void setInitialSentDateTime(String initialSentDateTime) {
this.initialSentDateTime = initialSentDateTime;
}
public EnvelopeDefinition is21CFRPart11(String is21CFRPart11) {
this.is21CFRPart11 = is21CFRPart11;
return this;
}
/**
* When set to **true**, indicates that this module is enabled on the account.
* @return is21CFRPart11
**/
@ApiModelProperty(value = "When set to **true**, indicates that this module is enabled on the account.")
public String getIs21CFRPart11() {
return is21CFRPart11;
}
public void setIs21CFRPart11(String is21CFRPart11) {
this.is21CFRPart11 = is21CFRPart11;
}
public EnvelopeDefinition isDynamicEnvelope(String isDynamicEnvelope) {
this.isDynamicEnvelope = isDynamicEnvelope;
return this;
}
/**
*
* @return isDynamicEnvelope
**/
@ApiModelProperty(value = "")
public String getIsDynamicEnvelope() {
return isDynamicEnvelope;
}
public void setIsDynamicEnvelope(String isDynamicEnvelope) {
this.isDynamicEnvelope = isDynamicEnvelope;
}
public EnvelopeDefinition isSignatureProviderEnvelope(String isSignatureProviderEnvelope) {
this.isSignatureProviderEnvelope = isSignatureProviderEnvelope;
return this;
}
/**
*
* @return isSignatureProviderEnvelope
**/
@ApiModelProperty(value = "")
public String getIsSignatureProviderEnvelope() {
return isSignatureProviderEnvelope;
}
public void setIsSignatureProviderEnvelope(String isSignatureProviderEnvelope) {
this.isSignatureProviderEnvelope = isSignatureProviderEnvelope;
}
public EnvelopeDefinition lastModifiedDateTime(String lastModifiedDateTime) {
this.lastModifiedDateTime = lastModifiedDateTime;
return this;
}
/**
* The date and time the item was last modified.
* @return lastModifiedDateTime
**/
@ApiModelProperty(value = "The date and time the item was last modified.")
public String getLastModifiedDateTime() {
return lastModifiedDateTime;
}
public void setLastModifiedDateTime(String lastModifiedDateTime) {
this.lastModifiedDateTime = lastModifiedDateTime;
}
public EnvelopeDefinition location(String location) {
this.location = location;
return this;
}
/**
*
* @return location
**/
@ApiModelProperty(value = "")
public String getLocation() {
return location;
}
public void setLocation(String location) {
this.location = location;
}
public EnvelopeDefinition lockInformation(LockInformation lockInformation) {
this.lockInformation = lockInformation;
return this;
}
/**
* Get lockInformation
* @return lockInformation
**/
@ApiModelProperty(value = "")
public LockInformation getLockInformation() {
return lockInformation;
}
public void setLockInformation(LockInformation lockInformation) {
this.lockInformation = lockInformation;
}
public EnvelopeDefinition messageLock(String messageLock) {
this.messageLock = messageLock;
return this;
}
/**
* When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. However, if the `messageLock` node is set to true**** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope.
* @return messageLock
**/
@ApiModelProperty(value = "When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. However, if the `messageLock` node is set to true**** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope.")
public String getMessageLock() {
return messageLock;
}
public void setMessageLock(String messageLock) {
this.messageLock = messageLock;
}
public EnvelopeDefinition notification(Notification notification) {
this.notification = notification;
return this;
}
/**
* Get notification
* @return notification
**/
@ApiModelProperty(value = "")
public Notification getNotification() {
return notification;
}
public void setNotification(Notification notification) {
this.notification = notification;
}
public EnvelopeDefinition notificationUri(String notificationUri) {
this.notificationUri = notificationUri;
return this;
}
/**
* Contains a URI for an endpoint that you can use to retrieve the notifications.
* @return notificationUri
**/
@ApiModelProperty(value = "Contains a URI for an endpoint that you can use to retrieve the notifications.")
public String getNotificationUri() {
return notificationUri;
}
public void setNotificationUri(String notificationUri) {
this.notificationUri = notificationUri;
}
public EnvelopeDefinition password(String password) {
this.password = password;
return this;
}
/**
*
* @return password
**/
@ApiModelProperty(value = "")
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
public EnvelopeDefinition powerForm(PowerForm powerForm) {
this.powerForm = powerForm;
return this;
}
/**
* Get powerForm
* @return powerForm
**/
@ApiModelProperty(value = "")
public PowerForm getPowerForm() {
return powerForm;
}
public void setPowerForm(PowerForm powerForm) {
this.powerForm = powerForm;
}
public EnvelopeDefinition purgeCompletedDate(String purgeCompletedDate) {
this.purgeCompletedDate = purgeCompletedDate;
return this;
}
/**
*
* @return purgeCompletedDate
**/
@ApiModelProperty(value = "")
public String getPurgeCompletedDate() {
return purgeCompletedDate;
}
public void setPurgeCompletedDate(String purgeCompletedDate) {
this.purgeCompletedDate = purgeCompletedDate;
}
public EnvelopeDefinition purgeRequestDate(String purgeRequestDate) {
this.purgeRequestDate = purgeRequestDate;
return this;
}
/**
*
* @return purgeRequestDate
**/
@ApiModelProperty(value = "")
public String getPurgeRequestDate() {
return purgeRequestDate;
}
public void setPurgeRequestDate(String purgeRequestDate) {
this.purgeRequestDate = purgeRequestDate;
}
public EnvelopeDefinition purgeState(String purgeState) {
this.purgeState = purgeState;
return this;
}
/**
* Initiates a purge request. Valid values are: * documents_queued: Places envelope documents in the purge queue. * documents_and_metadata_queued: Places envelope documents and metadata in the purge queue.
* @return purgeState
**/
@ApiModelProperty(value = "Initiates a purge request. Valid values are: * documents_queued: Places envelope documents in the purge queue. * documents_and_metadata_queued: Places envelope documents and metadata in the purge queue. ")
public String getPurgeState() {
return purgeState;
}
public void setPurgeState(String purgeState) {
this.purgeState = purgeState;
}
public EnvelopeDefinition recipients(Recipients recipients) {
this.recipients = recipients;
return this;
}
/**
* Get recipients
* @return recipients
**/
@ApiModelProperty(value = "")
public Recipients getRecipients() {
return recipients;
}
public void setRecipients(Recipients recipients) {
this.recipients = recipients;
}
public EnvelopeDefinition recipientsLock(String recipientsLock) {
this.recipientsLock = recipientsLock;
return this;
}
/**
* When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
* @return recipientsLock
**/
@ApiModelProperty(value = "When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.")
public String getRecipientsLock() {
return recipientsLock;
}
public void setRecipientsLock(String recipientsLock) {
this.recipientsLock = recipientsLock;
}
public EnvelopeDefinition recipientsUri(String recipientsUri) {
this.recipientsUri = recipientsUri;
return this;
}
/**
* Contains a URI for an endpoint that you can use to retrieve the recipients.
* @return recipientsUri
**/
@ApiModelProperty(value = "Contains a URI for an endpoint that you can use to retrieve the recipients.")
public String getRecipientsUri() {
return recipientsUri;
}
public void setRecipientsUri(String recipientsUri) {
this.recipientsUri = recipientsUri;
}
public EnvelopeDefinition sender(UserInfo sender) {
this.sender = sender;
return this;
}
/**
* Get sender
* @return sender
**/
@ApiModelProperty(value = "")
public UserInfo getSender() {
return sender;
}
public void setSender(UserInfo sender) {
this.sender = sender;
}
public EnvelopeDefinition sentDateTime(String sentDateTime) {
this.sentDateTime = sentDateTime;
return this;
}
/**
* The date and time the envelope was sent.
* @return sentDateTime
**/
@ApiModelProperty(value = "The date and time the envelope was sent.")
public String getSentDateTime() {
return sentDateTime;
}
public void setSentDateTime(String sentDateTime) {
this.sentDateTime = sentDateTime;
}
public EnvelopeDefinition signerCanSignOnMobile(String signerCanSignOnMobile) {
this.signerCanSignOnMobile = signerCanSignOnMobile;
return this;
}
/**
*
* @return signerCanSignOnMobile
**/
@ApiModelProperty(value = "")
public String getSignerCanSignOnMobile() {
return signerCanSignOnMobile;
}
public void setSignerCanSignOnMobile(String signerCanSignOnMobile) {
this.signerCanSignOnMobile = signerCanSignOnMobile;
}
public EnvelopeDefinition signingLocation(String signingLocation) {
this.signingLocation = signingLocation;
return this;
}
/**
* Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.
* @return signingLocation
**/
@ApiModelProperty(value = "Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.")
public String getSigningLocation() {
return signingLocation;
}
public void setSigningLocation(String signingLocation) {
this.signingLocation = signingLocation;
}
public EnvelopeDefinition status(String status) {
this.status = status;
return this;
}
/**
* 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.
* @return status
**/
@ApiModelProperty(value = "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.")
public String getStatus() {
return status;
}
public void setStatus(String status) {
this.status = status;
}
public EnvelopeDefinition statusChangedDateTime(String statusChangedDateTime) {
this.statusChangedDateTime = statusChangedDateTime;
return this;
}
/**
* The data and time the status changed.
* @return statusChangedDateTime
**/
@ApiModelProperty(value = "The data and time the status changed.")
public String getStatusChangedDateTime() {
return statusChangedDateTime;
}
public void setStatusChangedDateTime(String statusChangedDateTime) {
this.statusChangedDateTime = statusChangedDateTime;
}
public EnvelopeDefinition statusDateTime(String statusDateTime) {
this.statusDateTime = statusDateTime;
return this;
}
/**
*
* @return statusDateTime
**/
@ApiModelProperty(value = "")
public String getStatusDateTime() {
return statusDateTime;
}
public void setStatusDateTime(String statusDateTime) {
this.statusDateTime = statusDateTime;
}
public EnvelopeDefinition templateId(String templateId) {
this.templateId = templateId;
return this;
}
/**
* The unique identifier of the template. If this is not provided, DocuSign will generate a value.
* @return templateId
**/
@ApiModelProperty(value = "The unique identifier of the template. If this is not provided, DocuSign will generate a value. ")
public String getTemplateId() {
return templateId;
}
public void setTemplateId(String templateId) {
this.templateId = templateId;
}
public EnvelopeDefinition templateRoles(java.util.List templateRoles) {
this.templateRoles = templateRoles;
return this;
}
public EnvelopeDefinition addTemplateRolesItem(TemplateRole templateRolesItem) {
if (this.templateRoles == null) {
this.templateRoles = new java.util.ArrayList();
}
this.templateRoles.add(templateRolesItem);
return this;
}
/**
* Specifies the template recipients. Each roleName in the template must have a recipient assigned to it. This is made up elements: * email - The recipient's email address. * name - The recipient's name. * roleName - The template roleName associated with the recipient. * clientUserId - Optional, this sets if the signer is This specifies if the recipient is embedded or remote. If the clientUserId is not null then the recipient is embedded. Note that if a ClientUserId is used and the account settings SignerMustHaveAccount or SignerMustLoginToSign are true, an error is generated on sending. * defaultRecipient - Optional, When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. * routingOrder - This specifies the routing order of the recipient in the envelope. * accessCode - This optional element specifies the access code a recipient has to enter to validate the identity. This can be a maximum of 50 characters. * inPersonSignerName - Optional, if the template role is an in person signer, this is the full legal name of the signer. This can be a maximum of 100 characters. * emailNotification - This is an optional complex element that has a role specific emailSubject, emailBody, and language. It follows the same format as the emailNotification node for Recipients. * tabs - This allows the tab values to be specified for matching to tabs in the template.
* @return templateRoles
**/
@ApiModelProperty(value = "Specifies the template recipients. Each roleName in the template must have a recipient assigned to it. This is made up elements: * email - The recipient's email address. * name - The recipient's name. * roleName - The template roleName associated with the recipient. * clientUserId - Optional, this sets if the signer is This specifies if the recipient is embedded or remote. If the clientUserId is not null then the recipient is embedded. Note that if a ClientUserId is used and the account settings SignerMustHaveAccount or SignerMustLoginToSign are true, an error is generated on sending. * defaultRecipient - Optional, When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. * routingOrder - This specifies the routing order of the recipient in the envelope. * accessCode - This optional element specifies the access code a recipient has to enter to validate the identity. This can be a maximum of 50 characters. * inPersonSignerName - Optional, if the template role is an in person signer, this is the full legal name of the signer. This can be a maximum of 100 characters. * emailNotification - This is an optional complex element that has a role specific emailSubject, emailBody, and language. It follows the same format as the emailNotification node for Recipients. * tabs - This allows the tab values to be specified for matching to tabs in the template. ")
public java.util.List getTemplateRoles() {
return templateRoles;
}
public void setTemplateRoles(java.util.List templateRoles) {
this.templateRoles = templateRoles;
}
public EnvelopeDefinition templatesUri(String templatesUri) {
this.templatesUri = templatesUri;
return this;
}
/**
* Contains a URI for an endpoint which you can use to retrieve the templates.
* @return templatesUri
**/
@ApiModelProperty(value = "Contains a URI for an endpoint which you can use to retrieve the templates.")
public String getTemplatesUri() {
return templatesUri;
}
public void setTemplatesUri(String templatesUri) {
this.templatesUri = templatesUri;
}
public EnvelopeDefinition transactionId(String transactionId) {
this.transactionId = transactionId;
return this;
}
/**
* Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.
* @return transactionId
**/
@ApiModelProperty(value = " Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.")
public String getTransactionId() {
return transactionId;
}
public void setTransactionId(String transactionId) {
this.transactionId = transactionId;
}
public EnvelopeDefinition useDisclosure(String useDisclosure) {
this.useDisclosure = useDisclosure;
return this;
}
/**
* When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information.
* @return useDisclosure
**/
@ApiModelProperty(value = "When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information.")
public String getUseDisclosure() {
return useDisclosure;
}
public void setUseDisclosure(String useDisclosure) {
this.useDisclosure = useDisclosure;
}
public EnvelopeDefinition voidedDateTime(String voidedDateTime) {
this.voidedDateTime = voidedDateTime;
return this;
}
/**
* The date and time the envelope or template was voided.
* @return voidedDateTime
**/
@ApiModelProperty(value = "The date and time the envelope or template was voided.")
public String getVoidedDateTime() {
return voidedDateTime;
}
public void setVoidedDateTime(String voidedDateTime) {
this.voidedDateTime = voidedDateTime;
}
public EnvelopeDefinition voidedReason(String voidedReason) {
this.voidedReason = voidedReason;
return this;
}
/**
* The reason the envelope or template was voided.
* @return voidedReason
**/
@ApiModelProperty(value = "The reason the envelope or template was voided.")
public String getVoidedReason() {
return voidedReason;
}
public void setVoidedReason(String voidedReason) {
this.voidedReason = voidedReason;
}
public EnvelopeDefinition workflow(Workflow workflow) {
this.workflow = workflow;
return this;
}
/**
* Get workflow
* @return workflow
**/
@ApiModelProperty(value = "")
public Workflow getWorkflow() {
return workflow;
}
public void setWorkflow(Workflow workflow) {
this.workflow = workflow;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
EnvelopeDefinition envelopeDefinition = (EnvelopeDefinition) o;
return Objects.equals(this.accessControlListBase64, envelopeDefinition.accessControlListBase64) &&
Objects.equals(this.accessibility, envelopeDefinition.accessibility) &&
Objects.equals(this.allowComments, envelopeDefinition.allowComments) &&
Objects.equals(this.allowMarkup, envelopeDefinition.allowMarkup) &&
Objects.equals(this.allowReassign, envelopeDefinition.allowReassign) &&
Objects.equals(this.allowRecipientRecursion, envelopeDefinition.allowRecipientRecursion) &&
Objects.equals(this.allowViewHistory, envelopeDefinition.allowViewHistory) &&
Objects.equals(this.anySigner, envelopeDefinition.anySigner) &&
Objects.equals(this.asynchronous, envelopeDefinition.asynchronous) &&
Objects.equals(this.attachments, envelopeDefinition.attachments) &&
Objects.equals(this.attachmentsUri, envelopeDefinition.attachmentsUri) &&
Objects.equals(this.authoritativeCopy, envelopeDefinition.authoritativeCopy) &&
Objects.equals(this.authoritativeCopyDefault, envelopeDefinition.authoritativeCopyDefault) &&
Objects.equals(this.autoNavigation, envelopeDefinition.autoNavigation) &&
Objects.equals(this.brandId, envelopeDefinition.brandId) &&
Objects.equals(this.brandLock, envelopeDefinition.brandLock) &&
Objects.equals(this.certificateUri, envelopeDefinition.certificateUri) &&
Objects.equals(this.completedDateTime, envelopeDefinition.completedDateTime) &&
Objects.equals(this.compositeTemplates, envelopeDefinition.compositeTemplates) &&
Objects.equals(this.copyRecipientData, envelopeDefinition.copyRecipientData) &&
Objects.equals(this.createdDateTime, envelopeDefinition.createdDateTime) &&
Objects.equals(this.customFields, envelopeDefinition.customFields) &&
Objects.equals(this.customFieldsUri, envelopeDefinition.customFieldsUri) &&
Objects.equals(this.declinedDateTime, envelopeDefinition.declinedDateTime) &&
Objects.equals(this.deletedDateTime, envelopeDefinition.deletedDateTime) &&
Objects.equals(this.deliveredDateTime, envelopeDefinition.deliveredDateTime) &&
Objects.equals(this.disableResponsiveDocument, envelopeDefinition.disableResponsiveDocument) &&
Objects.equals(this.documents, envelopeDefinition.documents) &&
Objects.equals(this.documentsCombinedUri, envelopeDefinition.documentsCombinedUri) &&
Objects.equals(this.documentsUri, envelopeDefinition.documentsUri) &&
Objects.equals(this.emailBlurb, envelopeDefinition.emailBlurb) &&
Objects.equals(this.emailSettings, envelopeDefinition.emailSettings) &&
Objects.equals(this.emailSubject, envelopeDefinition.emailSubject) &&
Objects.equals(this.enableWetSign, envelopeDefinition.enableWetSign) &&
Objects.equals(this.enforceSignerVisibility, envelopeDefinition.enforceSignerVisibility) &&
Objects.equals(this.envelopeAttachments, envelopeDefinition.envelopeAttachments) &&
Objects.equals(this.envelopeDocuments, envelopeDefinition.envelopeDocuments) &&
Objects.equals(this.envelopeId, envelopeDefinition.envelopeId) &&
Objects.equals(this.envelopeIdStamping, envelopeDefinition.envelopeIdStamping) &&
Objects.equals(this.envelopeLocation, envelopeDefinition.envelopeLocation) &&
Objects.equals(this.envelopeMetadata, envelopeDefinition.envelopeMetadata) &&
Objects.equals(this.envelopeUri, envelopeDefinition.envelopeUri) &&
Objects.equals(this.eventNotification, envelopeDefinition.eventNotification) &&
Objects.equals(this.eventNotifications, envelopeDefinition.eventNotifications) &&
Objects.equals(this.expireAfter, envelopeDefinition.expireAfter) &&
Objects.equals(this.expireDateTime, envelopeDefinition.expireDateTime) &&
Objects.equals(this.expireEnabled, envelopeDefinition.expireEnabled) &&
Objects.equals(this.externalEnvelopeId, envelopeDefinition.externalEnvelopeId) &&
Objects.equals(this.folders, envelopeDefinition.folders) &&
Objects.equals(this.hasComments, envelopeDefinition.hasComments) &&
Objects.equals(this.hasFormDataChanged, envelopeDefinition.hasFormDataChanged) &&
Objects.equals(this.hasWavFile, envelopeDefinition.hasWavFile) &&
Objects.equals(this.holder, envelopeDefinition.holder) &&
Objects.equals(this.initialSentDateTime, envelopeDefinition.initialSentDateTime) &&
Objects.equals(this.is21CFRPart11, envelopeDefinition.is21CFRPart11) &&
Objects.equals(this.isDynamicEnvelope, envelopeDefinition.isDynamicEnvelope) &&
Objects.equals(this.isSignatureProviderEnvelope, envelopeDefinition.isSignatureProviderEnvelope) &&
Objects.equals(this.lastModifiedDateTime, envelopeDefinition.lastModifiedDateTime) &&
Objects.equals(this.location, envelopeDefinition.location) &&
Objects.equals(this.lockInformation, envelopeDefinition.lockInformation) &&
Objects.equals(this.messageLock, envelopeDefinition.messageLock) &&
Objects.equals(this.notification, envelopeDefinition.notification) &&
Objects.equals(this.notificationUri, envelopeDefinition.notificationUri) &&
Objects.equals(this.password, envelopeDefinition.password) &&
Objects.equals(this.powerForm, envelopeDefinition.powerForm) &&
Objects.equals(this.purgeCompletedDate, envelopeDefinition.purgeCompletedDate) &&
Objects.equals(this.purgeRequestDate, envelopeDefinition.purgeRequestDate) &&
Objects.equals(this.purgeState, envelopeDefinition.purgeState) &&
Objects.equals(this.recipients, envelopeDefinition.recipients) &&
Objects.equals(this.recipientsLock, envelopeDefinition.recipientsLock) &&
Objects.equals(this.recipientsUri, envelopeDefinition.recipientsUri) &&
Objects.equals(this.sender, envelopeDefinition.sender) &&
Objects.equals(this.sentDateTime, envelopeDefinition.sentDateTime) &&
Objects.equals(this.signerCanSignOnMobile, envelopeDefinition.signerCanSignOnMobile) &&
Objects.equals(this.signingLocation, envelopeDefinition.signingLocation) &&
Objects.equals(this.status, envelopeDefinition.status) &&
Objects.equals(this.statusChangedDateTime, envelopeDefinition.statusChangedDateTime) &&
Objects.equals(this.statusDateTime, envelopeDefinition.statusDateTime) &&
Objects.equals(this.templateId, envelopeDefinition.templateId) &&
Objects.equals(this.templateRoles, envelopeDefinition.templateRoles) &&
Objects.equals(this.templatesUri, envelopeDefinition.templatesUri) &&
Objects.equals(this.transactionId, envelopeDefinition.transactionId) &&
Objects.equals(this.useDisclosure, envelopeDefinition.useDisclosure) &&
Objects.equals(this.voidedDateTime, envelopeDefinition.voidedDateTime) &&
Objects.equals(this.voidedReason, envelopeDefinition.voidedReason) &&
Objects.equals(this.workflow, envelopeDefinition.workflow);
}
@Override
public int hashCode() {
return Objects.hash(accessControlListBase64, accessibility, allowComments, allowMarkup, allowReassign, allowRecipientRecursion, allowViewHistory, anySigner, asynchronous, attachments, attachmentsUri, authoritativeCopy, authoritativeCopyDefault, autoNavigation, brandId, brandLock, certificateUri, completedDateTime, compositeTemplates, copyRecipientData, createdDateTime, customFields, customFieldsUri, declinedDateTime, deletedDateTime, deliveredDateTime, disableResponsiveDocument, documents, documentsCombinedUri, documentsUri, emailBlurb, emailSettings, emailSubject, enableWetSign, enforceSignerVisibility, envelopeAttachments, envelopeDocuments, envelopeId, envelopeIdStamping, envelopeLocation, envelopeMetadata, envelopeUri, eventNotification, eventNotifications, expireAfter, expireDateTime, expireEnabled, externalEnvelopeId, folders, hasComments, hasFormDataChanged, hasWavFile, holder, initialSentDateTime, is21CFRPart11, isDynamicEnvelope, isSignatureProviderEnvelope, lastModifiedDateTime, location, lockInformation, messageLock, notification, notificationUri, password, powerForm, purgeCompletedDate, purgeRequestDate, purgeState, recipients, recipientsLock, recipientsUri, sender, sentDateTime, signerCanSignOnMobile, signingLocation, status, statusChangedDateTime, statusDateTime, templateId, templateRoles, templatesUri, transactionId, useDisclosure, voidedDateTime, voidedReason, workflow);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class EnvelopeDefinition {\n");
sb.append(" accessControlListBase64: ").append(toIndentedString(accessControlListBase64)).append("\n");
sb.append(" accessibility: ").append(toIndentedString(accessibility)).append("\n");
sb.append(" allowComments: ").append(toIndentedString(allowComments)).append("\n");
sb.append(" allowMarkup: ").append(toIndentedString(allowMarkup)).append("\n");
sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n");
sb.append(" allowRecipientRecursion: ").append(toIndentedString(allowRecipientRecursion)).append("\n");
sb.append(" allowViewHistory: ").append(toIndentedString(allowViewHistory)).append("\n");
sb.append(" anySigner: ").append(toIndentedString(anySigner)).append("\n");
sb.append(" asynchronous: ").append(toIndentedString(asynchronous)).append("\n");
sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n");
sb.append(" attachmentsUri: ").append(toIndentedString(attachmentsUri)).append("\n");
sb.append(" authoritativeCopy: ").append(toIndentedString(authoritativeCopy)).append("\n");
sb.append(" authoritativeCopyDefault: ").append(toIndentedString(authoritativeCopyDefault)).append("\n");
sb.append(" autoNavigation: ").append(toIndentedString(autoNavigation)).append("\n");
sb.append(" brandId: ").append(toIndentedString(brandId)).append("\n");
sb.append(" brandLock: ").append(toIndentedString(brandLock)).append("\n");
sb.append(" certificateUri: ").append(toIndentedString(certificateUri)).append("\n");
sb.append(" completedDateTime: ").append(toIndentedString(completedDateTime)).append("\n");
sb.append(" compositeTemplates: ").append(toIndentedString(compositeTemplates)).append("\n");
sb.append(" copyRecipientData: ").append(toIndentedString(copyRecipientData)).append("\n");
sb.append(" createdDateTime: ").append(toIndentedString(createdDateTime)).append("\n");
sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n");
sb.append(" customFieldsUri: ").append(toIndentedString(customFieldsUri)).append("\n");
sb.append(" declinedDateTime: ").append(toIndentedString(declinedDateTime)).append("\n");
sb.append(" deletedDateTime: ").append(toIndentedString(deletedDateTime)).append("\n");
sb.append(" deliveredDateTime: ").append(toIndentedString(deliveredDateTime)).append("\n");
sb.append(" disableResponsiveDocument: ").append(toIndentedString(disableResponsiveDocument)).append("\n");
sb.append(" documents: ").append(toIndentedString(documents)).append("\n");
sb.append(" documentsCombinedUri: ").append(toIndentedString(documentsCombinedUri)).append("\n");
sb.append(" documentsUri: ").append(toIndentedString(documentsUri)).append("\n");
sb.append(" emailBlurb: ").append(toIndentedString(emailBlurb)).append("\n");
sb.append(" emailSettings: ").append(toIndentedString(emailSettings)).append("\n");
sb.append(" emailSubject: ").append(toIndentedString(emailSubject)).append("\n");
sb.append(" enableWetSign: ").append(toIndentedString(enableWetSign)).append("\n");
sb.append(" enforceSignerVisibility: ").append(toIndentedString(enforceSignerVisibility)).append("\n");
sb.append(" envelopeAttachments: ").append(toIndentedString(envelopeAttachments)).append("\n");
sb.append(" envelopeDocuments: ").append(toIndentedString(envelopeDocuments)).append("\n");
sb.append(" envelopeId: ").append(toIndentedString(envelopeId)).append("\n");
sb.append(" envelopeIdStamping: ").append(toIndentedString(envelopeIdStamping)).append("\n");
sb.append(" envelopeLocation: ").append(toIndentedString(envelopeLocation)).append("\n");
sb.append(" envelopeMetadata: ").append(toIndentedString(envelopeMetadata)).append("\n");
sb.append(" envelopeUri: ").append(toIndentedString(envelopeUri)).append("\n");
sb.append(" eventNotification: ").append(toIndentedString(eventNotification)).append("\n");
sb.append(" eventNotifications: ").append(toIndentedString(eventNotifications)).append("\n");
sb.append(" expireAfter: ").append(toIndentedString(expireAfter)).append("\n");
sb.append(" expireDateTime: ").append(toIndentedString(expireDateTime)).append("\n");
sb.append(" expireEnabled: ").append(toIndentedString(expireEnabled)).append("\n");
sb.append(" externalEnvelopeId: ").append(toIndentedString(externalEnvelopeId)).append("\n");
sb.append(" folders: ").append(toIndentedString(folders)).append("\n");
sb.append(" hasComments: ").append(toIndentedString(hasComments)).append("\n");
sb.append(" hasFormDataChanged: ").append(toIndentedString(hasFormDataChanged)).append("\n");
sb.append(" hasWavFile: ").append(toIndentedString(hasWavFile)).append("\n");
sb.append(" holder: ").append(toIndentedString(holder)).append("\n");
sb.append(" initialSentDateTime: ").append(toIndentedString(initialSentDateTime)).append("\n");
sb.append(" is21CFRPart11: ").append(toIndentedString(is21CFRPart11)).append("\n");
sb.append(" isDynamicEnvelope: ").append(toIndentedString(isDynamicEnvelope)).append("\n");
sb.append(" isSignatureProviderEnvelope: ").append(toIndentedString(isSignatureProviderEnvelope)).append("\n");
sb.append(" lastModifiedDateTime: ").append(toIndentedString(lastModifiedDateTime)).append("\n");
sb.append(" location: ").append(toIndentedString(location)).append("\n");
sb.append(" lockInformation: ").append(toIndentedString(lockInformation)).append("\n");
sb.append(" messageLock: ").append(toIndentedString(messageLock)).append("\n");
sb.append(" notification: ").append(toIndentedString(notification)).append("\n");
sb.append(" notificationUri: ").append(toIndentedString(notificationUri)).append("\n");
sb.append(" password: ").append(toIndentedString(password)).append("\n");
sb.append(" powerForm: ").append(toIndentedString(powerForm)).append("\n");
sb.append(" purgeCompletedDate: ").append(toIndentedString(purgeCompletedDate)).append("\n");
sb.append(" purgeRequestDate: ").append(toIndentedString(purgeRequestDate)).append("\n");
sb.append(" purgeState: ").append(toIndentedString(purgeState)).append("\n");
sb.append(" recipients: ").append(toIndentedString(recipients)).append("\n");
sb.append(" recipientsLock: ").append(toIndentedString(recipientsLock)).append("\n");
sb.append(" recipientsUri: ").append(toIndentedString(recipientsUri)).append("\n");
sb.append(" sender: ").append(toIndentedString(sender)).append("\n");
sb.append(" sentDateTime: ").append(toIndentedString(sentDateTime)).append("\n");
sb.append(" signerCanSignOnMobile: ").append(toIndentedString(signerCanSignOnMobile)).append("\n");
sb.append(" signingLocation: ").append(toIndentedString(signingLocation)).append("\n");
sb.append(" status: ").append(toIndentedString(status)).append("\n");
sb.append(" statusChangedDateTime: ").append(toIndentedString(statusChangedDateTime)).append("\n");
sb.append(" statusDateTime: ").append(toIndentedString(statusDateTime)).append("\n");
sb.append(" templateId: ").append(toIndentedString(templateId)).append("\n");
sb.append(" templateRoles: ").append(toIndentedString(templateRoles)).append("\n");
sb.append(" templatesUri: ").append(toIndentedString(templatesUri)).append("\n");
sb.append(" transactionId: ").append(toIndentedString(transactionId)).append("\n");
sb.append(" useDisclosure: ").append(toIndentedString(useDisclosure)).append("\n");
sb.append(" voidedDateTime: ").append(toIndentedString(voidedDateTime)).append("\n");
sb.append(" voidedReason: ").append(toIndentedString(voidedReason)).append("\n");
sb.append(" workflow: ").append(toIndentedString(workflow)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(java.lang.Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}