com.docusign.esign.model.Notarize 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.ErrorDetails;
import com.docusign.esign.model.MergeField;
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;
/**
* Notarize
*/
public class Notarize {
@JsonProperty("anchorCaseSensitive")
private String anchorCaseSensitive = null;
@JsonProperty("anchorHorizontalAlignment")
private String anchorHorizontalAlignment = null;
@JsonProperty("anchorIgnoreIfNotPresent")
private String anchorIgnoreIfNotPresent = null;
@JsonProperty("anchorMatchWholeWord")
private String anchorMatchWholeWord = null;
@JsonProperty("anchorString")
private String anchorString = null;
@JsonProperty("anchorUnits")
private String anchorUnits = null;
@JsonProperty("anchorXOffset")
private String anchorXOffset = null;
@JsonProperty("anchorYOffset")
private String anchorYOffset = null;
@JsonProperty("conditionalParentLabel")
private String conditionalParentLabel = null;
@JsonProperty("conditionalParentValue")
private String conditionalParentValue = null;
@JsonProperty("customTabId")
private String customTabId = null;
@JsonProperty("documentId")
private String documentId = null;
@JsonProperty("errorDetails")
private ErrorDetails errorDetails = null;
@JsonProperty("locked")
private String locked = null;
@JsonProperty("mergeField")
private MergeField mergeField = null;
@JsonProperty("pageNumber")
private String pageNumber = null;
@JsonProperty("recipientId")
private String recipientId = null;
@JsonProperty("required")
private String required = null;
@JsonProperty("status")
private String status = null;
@JsonProperty("tabGroupLabels")
private java.util.List tabGroupLabels = null;
@JsonProperty("tabId")
private String tabId = null;
@JsonProperty("tabOrder")
private String tabOrder = null;
@JsonProperty("templateLocked")
private String templateLocked = null;
@JsonProperty("templateRequired")
private String templateRequired = null;
@JsonProperty("tooltip")
private String tooltip = null;
@JsonProperty("xPosition")
private String xPosition = null;
@JsonProperty("yPosition")
private String yPosition = null;
public Notarize anchorCaseSensitive(String anchorCaseSensitive) {
this.anchorCaseSensitive = anchorCaseSensitive;
return this;
}
/**
* When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.
* @return anchorCaseSensitive
**/
@ApiModelProperty(value = "When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.")
public String getAnchorCaseSensitive() {
return anchorCaseSensitive;
}
public void setAnchorCaseSensitive(String anchorCaseSensitive) {
this.anchorCaseSensitive = anchorCaseSensitive;
}
public Notarize anchorHorizontalAlignment(String anchorHorizontalAlignment) {
this.anchorHorizontalAlignment = anchorHorizontalAlignment;
return this;
}
/**
* Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.
* @return anchorHorizontalAlignment
**/
@ApiModelProperty(value = "Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.")
public String getAnchorHorizontalAlignment() {
return anchorHorizontalAlignment;
}
public void setAnchorHorizontalAlignment(String anchorHorizontalAlignment) {
this.anchorHorizontalAlignment = anchorHorizontalAlignment;
}
public Notarize anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent) {
this.anchorIgnoreIfNotPresent = anchorIgnoreIfNotPresent;
return this;
}
/**
* When set to **true**, this tab is ignored if anchorString is not found in the document.
* @return anchorIgnoreIfNotPresent
**/
@ApiModelProperty(value = "When set to **true**, this tab is ignored if anchorString is not found in the document.")
public String getAnchorIgnoreIfNotPresent() {
return anchorIgnoreIfNotPresent;
}
public void setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent) {
this.anchorIgnoreIfNotPresent = anchorIgnoreIfNotPresent;
}
public Notarize anchorMatchWholeWord(String anchorMatchWholeWord) {
this.anchorMatchWholeWord = anchorMatchWholeWord;
return this;
}
/**
* When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.
* @return anchorMatchWholeWord
**/
@ApiModelProperty(value = "When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.")
public String getAnchorMatchWholeWord() {
return anchorMatchWholeWord;
}
public void setAnchorMatchWholeWord(String anchorMatchWholeWord) {
this.anchorMatchWholeWord = anchorMatchWholeWord;
}
public Notarize anchorString(String anchorString) {
this.anchorString = anchorString;
return this;
}
/**
* Anchor text information for a radio button.
* @return anchorString
**/
@ApiModelProperty(value = "Anchor text information for a radio button.")
public String getAnchorString() {
return anchorString;
}
public void setAnchorString(String anchorString) {
this.anchorString = anchorString;
}
public Notarize anchorUnits(String anchorUnits) {
this.anchorUnits = anchorUnits;
return this;
}
/**
* Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
* @return anchorUnits
**/
@ApiModelProperty(value = "Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.")
public String getAnchorUnits() {
return anchorUnits;
}
public void setAnchorUnits(String anchorUnits) {
this.anchorUnits = anchorUnits;
}
public Notarize anchorXOffset(String anchorXOffset) {
this.anchorXOffset = anchorXOffset;
return this;
}
/**
* Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
* @return anchorXOffset
**/
@ApiModelProperty(value = "Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.")
public String getAnchorXOffset() {
return anchorXOffset;
}
public void setAnchorXOffset(String anchorXOffset) {
this.anchorXOffset = anchorXOffset;
}
public Notarize anchorYOffset(String anchorYOffset) {
this.anchorYOffset = anchorYOffset;
return this;
}
/**
* Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
* @return anchorYOffset
**/
@ApiModelProperty(value = "Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.")
public String getAnchorYOffset() {
return anchorYOffset;
}
public void setAnchorYOffset(String anchorYOffset) {
this.anchorYOffset = anchorYOffset;
}
public Notarize conditionalParentLabel(String conditionalParentLabel) {
this.conditionalParentLabel = conditionalParentLabel;
return this;
}
/**
* For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
* @return conditionalParentLabel
**/
@ApiModelProperty(value = "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.")
public String getConditionalParentLabel() {
return conditionalParentLabel;
}
public void setConditionalParentLabel(String conditionalParentLabel) {
this.conditionalParentLabel = conditionalParentLabel;
}
public Notarize conditionalParentValue(String conditionalParentValue) {
this.conditionalParentValue = conditionalParentValue;
return this;
}
/**
* For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.
* @return conditionalParentValue
**/
@ApiModelProperty(value = "For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. ")
public String getConditionalParentValue() {
return conditionalParentValue;
}
public void setConditionalParentValue(String conditionalParentValue) {
this.conditionalParentValue = conditionalParentValue;
}
public Notarize customTabId(String customTabId) {
this.customTabId = customTabId;
return this;
}
/**
* The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
* @return customTabId
**/
@ApiModelProperty(value = "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.")
public String getCustomTabId() {
return customTabId;
}
public void setCustomTabId(String customTabId) {
this.customTabId = customTabId;
}
public Notarize documentId(String documentId) {
this.documentId = documentId;
return this;
}
/**
* Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
* @return documentId
**/
@ApiModelProperty(value = "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.")
public String getDocumentId() {
return documentId;
}
public void setDocumentId(String documentId) {
this.documentId = documentId;
}
public Notarize errorDetails(ErrorDetails errorDetails) {
this.errorDetails = errorDetails;
return this;
}
/**
* Get errorDetails
* @return errorDetails
**/
@ApiModelProperty(value = "")
public ErrorDetails getErrorDetails() {
return errorDetails;
}
public void setErrorDetails(ErrorDetails errorDetails) {
this.errorDetails = errorDetails;
}
public Notarize locked(String locked) {
this.locked = locked;
return this;
}
/**
* When set to **true**, the signer cannot change the data of the custom tab.
* @return locked
**/
@ApiModelProperty(value = "When set to **true**, the signer cannot change the data of the custom tab.")
public String getLocked() {
return locked;
}
public void setLocked(String locked) {
this.locked = locked;
}
public Notarize mergeField(MergeField mergeField) {
this.mergeField = mergeField;
return this;
}
/**
* Get mergeField
* @return mergeField
**/
@ApiModelProperty(value = "")
public MergeField getMergeField() {
return mergeField;
}
public void setMergeField(MergeField mergeField) {
this.mergeField = mergeField;
}
public Notarize pageNumber(String pageNumber) {
this.pageNumber = pageNumber;
return this;
}
/**
* Specifies the page number on which the tab is located.
* @return pageNumber
**/
@ApiModelProperty(value = "Specifies the page number on which the tab is located.")
public String getPageNumber() {
return pageNumber;
}
public void setPageNumber(String pageNumber) {
this.pageNumber = pageNumber;
}
public Notarize recipientId(String recipientId) {
this.recipientId = recipientId;
return this;
}
/**
* Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
* @return recipientId
**/
@ApiModelProperty(value = "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.")
public String getRecipientId() {
return recipientId;
}
public void setRecipientId(String recipientId) {
this.recipientId = recipientId;
}
public Notarize required(String required) {
this.required = required;
return this;
}
/**
* When set to **true**, the signer is required to fill out this tab
* @return required
**/
@ApiModelProperty(value = "When set to **true**, the signer is required to fill out this tab")
public String getRequired() {
return required;
}
public void setRequired(String required) {
this.required = required;
}
public Notarize 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 Notarize tabGroupLabels(java.util.List tabGroupLabels) {
this.tabGroupLabels = tabGroupLabels;
return this;
}
public Notarize addTabGroupLabelsItem(String tabGroupLabelsItem) {
if (this.tabGroupLabels == null) {
this.tabGroupLabels = new java.util.ArrayList();
}
this.tabGroupLabels.add(tabGroupLabelsItem);
return this;
}
/**
*
* @return tabGroupLabels
**/
@ApiModelProperty(value = "")
public java.util.List getTabGroupLabels() {
return tabGroupLabels;
}
public void setTabGroupLabels(java.util.List tabGroupLabels) {
this.tabGroupLabels = tabGroupLabels;
}
public Notarize tabId(String tabId) {
this.tabId = tabId;
return this;
}
/**
* The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
* @return tabId
**/
@ApiModelProperty(value = "The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. ")
public String getTabId() {
return tabId;
}
public void setTabId(String tabId) {
this.tabId = tabId;
}
public Notarize tabOrder(String tabOrder) {
this.tabOrder = tabOrder;
return this;
}
/**
*
* @return tabOrder
**/
@ApiModelProperty(value = "")
public String getTabOrder() {
return tabOrder;
}
public void setTabOrder(String tabOrder) {
this.tabOrder = tabOrder;
}
public Notarize templateLocked(String templateLocked) {
this.templateLocked = templateLocked;
return this;
}
/**
* When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
* @return templateLocked
**/
@ApiModelProperty(value = "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ")
public String getTemplateLocked() {
return templateLocked;
}
public void setTemplateLocked(String templateLocked) {
this.templateLocked = templateLocked;
}
public Notarize templateRequired(String templateRequired) {
this.templateRequired = templateRequired;
return this;
}
/**
* When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
* @return templateRequired
**/
@ApiModelProperty(value = "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.")
public String getTemplateRequired() {
return templateRequired;
}
public void setTemplateRequired(String templateRequired) {
this.templateRequired = templateRequired;
}
public Notarize tooltip(String tooltip) {
this.tooltip = tooltip;
return this;
}
/**
*
* @return tooltip
**/
@ApiModelProperty(value = "")
public String getTooltip() {
return tooltip;
}
public void setTooltip(String tooltip) {
this.tooltip = tooltip;
}
public Notarize xPosition(String xPosition) {
this.xPosition = xPosition;
return this;
}
/**
* This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
* @return xPosition
**/
@ApiModelProperty(value = "This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.")
public String getXPosition() {
return xPosition;
}
public void setXPosition(String xPosition) {
this.xPosition = xPosition;
}
public Notarize yPosition(String yPosition) {
this.yPosition = yPosition;
return this;
}
/**
* This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
* @return yPosition
**/
@ApiModelProperty(value = "This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.")
public String getYPosition() {
return yPosition;
}
public void setYPosition(String yPosition) {
this.yPosition = yPosition;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Notarize notarize = (Notarize) o;
return Objects.equals(this.anchorCaseSensitive, notarize.anchorCaseSensitive) &&
Objects.equals(this.anchorHorizontalAlignment, notarize.anchorHorizontalAlignment) &&
Objects.equals(this.anchorIgnoreIfNotPresent, notarize.anchorIgnoreIfNotPresent) &&
Objects.equals(this.anchorMatchWholeWord, notarize.anchorMatchWholeWord) &&
Objects.equals(this.anchorString, notarize.anchorString) &&
Objects.equals(this.anchorUnits, notarize.anchorUnits) &&
Objects.equals(this.anchorXOffset, notarize.anchorXOffset) &&
Objects.equals(this.anchorYOffset, notarize.anchorYOffset) &&
Objects.equals(this.conditionalParentLabel, notarize.conditionalParentLabel) &&
Objects.equals(this.conditionalParentValue, notarize.conditionalParentValue) &&
Objects.equals(this.customTabId, notarize.customTabId) &&
Objects.equals(this.documentId, notarize.documentId) &&
Objects.equals(this.errorDetails, notarize.errorDetails) &&
Objects.equals(this.locked, notarize.locked) &&
Objects.equals(this.mergeField, notarize.mergeField) &&
Objects.equals(this.pageNumber, notarize.pageNumber) &&
Objects.equals(this.recipientId, notarize.recipientId) &&
Objects.equals(this.required, notarize.required) &&
Objects.equals(this.status, notarize.status) &&
Objects.equals(this.tabGroupLabels, notarize.tabGroupLabels) &&
Objects.equals(this.tabId, notarize.tabId) &&
Objects.equals(this.tabOrder, notarize.tabOrder) &&
Objects.equals(this.templateLocked, notarize.templateLocked) &&
Objects.equals(this.templateRequired, notarize.templateRequired) &&
Objects.equals(this.tooltip, notarize.tooltip) &&
Objects.equals(this.xPosition, notarize.xPosition) &&
Objects.equals(this.yPosition, notarize.yPosition);
}
@Override
public int hashCode() {
return Objects.hash(anchorCaseSensitive, anchorHorizontalAlignment, anchorIgnoreIfNotPresent, anchorMatchWholeWord, anchorString, anchorUnits, anchorXOffset, anchorYOffset, conditionalParentLabel, conditionalParentValue, customTabId, documentId, errorDetails, locked, mergeField, pageNumber, recipientId, required, status, tabGroupLabels, tabId, tabOrder, templateLocked, templateRequired, tooltip, xPosition, yPosition);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class Notarize {\n");
sb.append(" anchorCaseSensitive: ").append(toIndentedString(anchorCaseSensitive)).append("\n");
sb.append(" anchorHorizontalAlignment: ").append(toIndentedString(anchorHorizontalAlignment)).append("\n");
sb.append(" anchorIgnoreIfNotPresent: ").append(toIndentedString(anchorIgnoreIfNotPresent)).append("\n");
sb.append(" anchorMatchWholeWord: ").append(toIndentedString(anchorMatchWholeWord)).append("\n");
sb.append(" anchorString: ").append(toIndentedString(anchorString)).append("\n");
sb.append(" anchorUnits: ").append(toIndentedString(anchorUnits)).append("\n");
sb.append(" anchorXOffset: ").append(toIndentedString(anchorXOffset)).append("\n");
sb.append(" anchorYOffset: ").append(toIndentedString(anchorYOffset)).append("\n");
sb.append(" conditionalParentLabel: ").append(toIndentedString(conditionalParentLabel)).append("\n");
sb.append(" conditionalParentValue: ").append(toIndentedString(conditionalParentValue)).append("\n");
sb.append(" customTabId: ").append(toIndentedString(customTabId)).append("\n");
sb.append(" documentId: ").append(toIndentedString(documentId)).append("\n");
sb.append(" errorDetails: ").append(toIndentedString(errorDetails)).append("\n");
sb.append(" locked: ").append(toIndentedString(locked)).append("\n");
sb.append(" mergeField: ").append(toIndentedString(mergeField)).append("\n");
sb.append(" pageNumber: ").append(toIndentedString(pageNumber)).append("\n");
sb.append(" recipientId: ").append(toIndentedString(recipientId)).append("\n");
sb.append(" required: ").append(toIndentedString(required)).append("\n");
sb.append(" status: ").append(toIndentedString(status)).append("\n");
sb.append(" tabGroupLabels: ").append(toIndentedString(tabGroupLabels)).append("\n");
sb.append(" tabId: ").append(toIndentedString(tabId)).append("\n");
sb.append(" tabOrder: ").append(toIndentedString(tabOrder)).append("\n");
sb.append(" templateLocked: ").append(toIndentedString(templateLocked)).append("\n");
sb.append(" templateRequired: ").append(toIndentedString(templateRequired)).append("\n");
sb.append(" tooltip: ").append(toIndentedString(tooltip)).append("\n");
sb.append(" xPosition: ").append(toIndentedString(xPosition)).append("\n");
sb.append(" yPosition: ").append(toIndentedString(yPosition)).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 ");
}
}