com.docusign.esign.model.SignHashDocument 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
The official DocuSign eSignature JAVA client is based on version 2 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.
There is a newer version: 6.0.0
Show newest version
package com.docusign.esign.model;

import com.fasterxml.jackson.annotation.JsonProperty;
import io.swagger.v3.oas.annotations.media.Schema;
import java.util.Objects;

/** SignHashDocument */
public class SignHashDocument {
  @JsonProperty("data")
  private String data = null;

  @JsonProperty("documentId")
  private String documentId = null;

  @JsonProperty("format")
  private String format = null;

  @JsonProperty("name")
  private String name = null;

  @JsonProperty("remainingSignatures")
  private Long remainingSignatures = null;

  @JsonProperty("revisions")
  private java.util.List revisions = null;

  @JsonProperty("signatureProperties")
  private SignatureProperties signatureProperties = null;

  @JsonProperty("signatureType")
  private String signatureType = null;

  public SignHashDocument data(String data) {
    this.data = data;
    return this;
  }

  /** @return data */
  @Schema(description = "")
  public String getData() {
    return data;
  }

  public void setData(String data) {
    this.data = data;
  }

  public SignHashDocument 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
   */
  @Schema(
      description =
          "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 SignHashDocument format(String format) {
    this.format = format;
    return this;
  }

  /** @return format */
  @Schema(description = "")
  public String getFormat() {
    return format;
  }

  public void setFormat(String format) {
    this.format = format;
  }

  public SignHashDocument name(String name) {
    this.name = name;
    return this;
  }

  /** @return name */
  @Schema(description = "")
  public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }

  public SignHashDocument remainingSignatures(Long remainingSignatures) {
    this.remainingSignatures = remainingSignatures;
    return this;
  }

  /** @return remainingSignatures */
  @Schema(description = "")
  public Long getRemainingSignatures() {
    return remainingSignatures;
  }

  public void setRemainingSignatures(Long remainingSignatures) {
    this.remainingSignatures = remainingSignatures;
  }

  public SignHashDocument revisions(java.util.List revisions) {
    this.revisions = revisions;
    return this;
  }

  public SignHashDocument addRevisionsItem(Revision revisionsItem) {
    if (this.revisions == null) {
      this.revisions = new java.util.ArrayList();
    }
    this.revisions.add(revisionsItem);
    return this;
  }

  /** @return revisions */
  @Schema(description = "")
  public java.util.List getRevisions() {
    return revisions;
  }

  public void setRevisions(java.util.List revisions) {
    this.revisions = revisions;
  }

  public SignHashDocument signatureProperties(SignatureProperties signatureProperties) {
    this.signatureProperties = signatureProperties;
    return this;
  }

  /**
   * Get signatureProperties
   *
   * @return signatureProperties
   */
  @Schema(description = "")
  public SignatureProperties getSignatureProperties() {
    return signatureProperties;
  }

  public void setSignatureProperties(SignatureProperties signatureProperties) {
    this.signatureProperties = signatureProperties;
  }

  public SignHashDocument signatureType(String signatureType) {
    this.signatureType = signatureType;
    return this;
  }

  /** @return signatureType */
  @Schema(description = "")
  public String getSignatureType() {
    return signatureType;
  }

  public void setSignatureType(String signatureType) {
    this.signatureType = signatureType;
  }

  @Override
  public boolean equals(java.lang.Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    SignHashDocument signHashDocument = (SignHashDocument) o;
    return Objects.equals(this.data, signHashDocument.data)
        && Objects.equals(this.documentId, signHashDocument.documentId)
        && Objects.equals(this.format, signHashDocument.format)
        && Objects.equals(this.name, signHashDocument.name)
        && Objects.equals(this.remainingSignatures, signHashDocument.remainingSignatures)
        && Objects.equals(this.revisions, signHashDocument.revisions)
        && Objects.equals(this.signatureProperties, signHashDocument.signatureProperties)
        && Objects.equals(this.signatureType, signHashDocument.signatureType);
  }

  @Override
  public int hashCode() {
    return Objects.hash(
        data,
        documentId,
        format,
        name,
        remainingSignatures,
        revisions,
        signatureProperties,
        signatureType);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class SignHashDocument {\n");

    sb.append("    data: ").append(toIndentedString(data)).append("\n");
    sb.append("    documentId: ").append(toIndentedString(documentId)).append("\n");
    sb.append("    format: ").append(toIndentedString(format)).append("\n");
    sb.append("    name: ").append(toIndentedString(name)).append("\n");
    sb.append("    remainingSignatures: ")
        .append(toIndentedString(remainingSignatures))
        .append("\n");
    sb.append("    revisions: ").append(toIndentedString(revisions)).append("\n");
    sb.append("    signatureProperties: ")
        .append(toIndentedString(signatureProperties))
        .append("\n");
    sb.append("    signatureType: ").append(toIndentedString(signatureType)).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    ");
  }
}