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

/**
 * An Electronic or Standards Based Signature (digital signature) provider for the signer to use.
 * [More information](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/). .
 */
@Schema(
    description =
        "An Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/). ")
public class RecipientSignatureProvider {
  @JsonProperty("sealDocumentsWithTabsOnly")
  private String sealDocumentsWithTabsOnly = null;

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

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

  @JsonProperty("signatureProviderNameMetadata")
  private PropertyMetadata signatureProviderNameMetadata = null;

  @JsonProperty("signatureProviderOptions")
  private RecipientSignatureProviderOptions signatureProviderOptions = null;

  /**
   * sealDocumentsWithTabsOnly.
   *
   * @return RecipientSignatureProvider
   */
  public RecipientSignatureProvider sealDocumentsWithTabsOnly(String sealDocumentsWithTabsOnly) {
    this.sealDocumentsWithTabsOnly = sealDocumentsWithTabsOnly;
    return this;
  }

  /**
   * .
   *
   * @return sealDocumentsWithTabsOnly
   */
  @Schema(description = "")
  public String getSealDocumentsWithTabsOnly() {
    return sealDocumentsWithTabsOnly;
  }

  /** setSealDocumentsWithTabsOnly. */
  public void setSealDocumentsWithTabsOnly(String sealDocumentsWithTabsOnly) {
    this.sealDocumentsWithTabsOnly = sealDocumentsWithTabsOnly;
  }

  /**
   * sealName.
   *
   * @return RecipientSignatureProvider
   */
  public RecipientSignatureProvider sealName(String sealName) {
    this.sealName = sealName;
    return this;
  }

  /**
   * .
   *
   * @return sealName
   */
  @Schema(description = "")
  public String getSealName() {
    return sealName;
  }

  /** setSealName. */
  public void setSealName(String sealName) {
    this.sealName = sealName;
  }

  /**
   * signatureProviderName.
   *
   * @return RecipientSignatureProvider
   */
  public RecipientSignatureProvider signatureProviderName(String signatureProviderName) {
    this.signatureProviderName = signatureProviderName;
    return this;
  }

  /**
   * .
   *
   * @return signatureProviderName
   */
  @Schema(description = "")
  public String getSignatureProviderName() {
    return signatureProviderName;
  }

  /** setSignatureProviderName. */
  public void setSignatureProviderName(String signatureProviderName) {
    this.signatureProviderName = signatureProviderName;
  }

  /**
   * signatureProviderNameMetadata.
   *
   * @return RecipientSignatureProvider
   */
  public RecipientSignatureProvider signatureProviderNameMetadata(
      PropertyMetadata signatureProviderNameMetadata) {
    this.signatureProviderNameMetadata = signatureProviderNameMetadata;
    return this;
  }

  /**
   * Metadata that indicates whether the `signatureProviderName` property is editable. .
   *
   * @return signatureProviderNameMetadata
   */
  @Schema(
      description =
          "Metadata that indicates whether the `signatureProviderName` property is editable. ")
  public PropertyMetadata getSignatureProviderNameMetadata() {
    return signatureProviderNameMetadata;
  }

  /** setSignatureProviderNameMetadata. */
  public void setSignatureProviderNameMetadata(PropertyMetadata signatureProviderNameMetadata) {
    this.signatureProviderNameMetadata = signatureProviderNameMetadata;
  }

  /**
   * signatureProviderOptions.
   *
   * @return RecipientSignatureProvider
   */
  public RecipientSignatureProvider signatureProviderOptions(
      RecipientSignatureProviderOptions signatureProviderOptions) {
    this.signatureProviderOptions = signatureProviderOptions;
    return this;
  }

  /**
   * Not applicable for this object..
   *
   * @return signatureProviderOptions
   */
  @Schema(description = "Not applicable for this object.")
  public RecipientSignatureProviderOptions getSignatureProviderOptions() {
    return signatureProviderOptions;
  }

  /** setSignatureProviderOptions. */
  public void setSignatureProviderOptions(
      RecipientSignatureProviderOptions signatureProviderOptions) {
    this.signatureProviderOptions = signatureProviderOptions;
  }

  /**
   * Compares objects.
   *
   * @return true or false depending on comparison result.
   */
  @Override
  public boolean equals(java.lang.Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    RecipientSignatureProvider recipientSignatureProvider = (RecipientSignatureProvider) o;
    return Objects.equals(
            this.sealDocumentsWithTabsOnly, recipientSignatureProvider.sealDocumentsWithTabsOnly)
        && Objects.equals(this.sealName, recipientSignatureProvider.sealName)
        && Objects.equals(
            this.signatureProviderName, recipientSignatureProvider.signatureProviderName)
        && Objects.equals(
            this.signatureProviderNameMetadata,
            recipientSignatureProvider.signatureProviderNameMetadata)
        && Objects.equals(
            this.signatureProviderOptions, recipientSignatureProvider.signatureProviderOptions);
  }

  /** Returns the HashCode. */
  @Override
  public int hashCode() {
    return Objects.hash(
        sealDocumentsWithTabsOnly,
        sealName,
        signatureProviderName,
        signatureProviderNameMetadata,
        signatureProviderOptions);
  }

  /** Converts the given object to string. */
  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class RecipientSignatureProvider {\n");

    sb.append("    sealDocumentsWithTabsOnly: ")
        .append(toIndentedString(sealDocumentsWithTabsOnly))
        .append("\n");
    sb.append("    sealName: ").append(toIndentedString(sealName)).append("\n");
    sb.append("    signatureProviderName: ")
        .append(toIndentedString(signatureProviderName))
        .append("\n");
    sb.append("    signatureProviderNameMetadata: ")
        .append(toIndentedString(signatureProviderNameMetadata))
        .append("\n");
    sb.append("    signatureProviderOptions: ")
        .append(toIndentedString(signatureProviderOptions))
        .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    ");
  }
}