com.docusign.esign.model.CompleteSignRequest 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.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.
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;

/** CompleteSignRequest */
public class CompleteSignRequest {
  @JsonProperty("certificate")
  private String certificate = null;

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

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

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

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

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

  public CompleteSignRequest certificate(String certificate) {
    this.certificate = certificate;
    return this;
  }

  /** @return certificate */
  @Schema(description = "")
  public String getCertificate() {
    return certificate;
  }

  public void setCertificate(String certificate) {
    this.certificate = certificate;
  }

  public CompleteSignRequest correlationId(String correlationId) {
    this.correlationId = correlationId;
    return this;
  }

  /** @return correlationId */
  @Schema(description = "")
  public String getCorrelationId() {
    return correlationId;
  }

  public void setCorrelationId(String correlationId) {
    this.correlationId = correlationId;
  }

  public CompleteSignRequest documentUpdateInfos(
      java.util.List documentUpdateInfos) {
    this.documentUpdateInfos = documentUpdateInfos;
    return this;
  }

  public CompleteSignRequest addDocumentUpdateInfosItem(
      DocumentUpdateInfo documentUpdateInfosItem) {
    if (this.documentUpdateInfos == null) {
      this.documentUpdateInfos = new java.util.ArrayList();
    }
    this.documentUpdateInfos.add(documentUpdateInfosItem);
    return this;
  }

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

  public void setDocumentUpdateInfos(java.util.List documentUpdateInfos) {
    this.documentUpdateInfos = documentUpdateInfos;
  }

  public CompleteSignRequest maxSignatureLength(String maxSignatureLength) {
    this.maxSignatureLength = maxSignatureLength;
    return this;
  }

  /** @return maxSignatureLength */
  @Schema(description = "")
  public String getMaxSignatureLength() {
    return maxSignatureLength;
  }

  public void setMaxSignatureLength(String maxSignatureLength) {
    this.maxSignatureLength = maxSignatureLength;
  }

  public CompleteSignRequest 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
   */
  @Schema(
      description =
          "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 CompleteSignRequest 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
   */
  @Schema(
      description =
          " 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;
  }

  @Override
  public boolean equals(java.lang.Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    CompleteSignRequest completeSignRequest = (CompleteSignRequest) o;
    return Objects.equals(this.certificate, completeSignRequest.certificate)
        && Objects.equals(this.correlationId, completeSignRequest.correlationId)
        && Objects.equals(this.documentUpdateInfos, completeSignRequest.documentUpdateInfos)
        && Objects.equals(this.maxSignatureLength, completeSignRequest.maxSignatureLength)
        && Objects.equals(this.signingLocation, completeSignRequest.signingLocation)
        && Objects.equals(this.transactionId, completeSignRequest.transactionId);
  }

  @Override
  public int hashCode() {
    return Objects.hash(
        certificate,
        correlationId,
        documentUpdateInfos,
        maxSignatureLength,
        signingLocation,
        transactionId);
  }

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

    sb.append("    certificate: ").append(toIndentedString(certificate)).append("\n");
    sb.append("    correlationId: ").append(toIndentedString(correlationId)).append("\n");
    sb.append("    documentUpdateInfos: ")
        .append(toIndentedString(documentUpdateInfos))
        .append("\n");
    sb.append("    maxSignatureLength: ").append(toIndentedString(maxSignatureLength)).append("\n");
    sb.append("    signingLocation: ").append(toIndentedString(signingLocation)).append("\n");
    sb.append("    transactionId: ").append(toIndentedString(transactionId)).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    ");
  }
}