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

/**
 * Specifies ID Verification applied on an envelope by workflow ID. See the
 * [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the
 * [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource
 * for more information on how to retrieve workflow IDs available for an account. This can be used
 * in addition to other [recipient
 * authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication)
 * methods..
 */
@Schema(
    description =
        "Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.")
public class RecipientIdentityVerification {
  @JsonProperty("inputOptions")
  private java.util.List inputOptions = null;

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

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

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

  /**
   * inputOptions.
   *
   * @return RecipientIdentityVerification
   */
  public RecipientIdentityVerification inputOptions(
      java.util.List inputOptions) {
    this.inputOptions = inputOptions;
    return this;
  }

  /**
   * addInputOptionsItem.
   *
   * @return RecipientIdentityVerification
   */
  public RecipientIdentityVerification addInputOptionsItem(
      RecipientIdentityInputOption inputOptionsItem) {
    if (this.inputOptions == null) {
      this.inputOptions = new java.util.ArrayList<>();
    }
    this.inputOptions.add(inputOptionsItem);
    return this;
  }

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

  /** setInputOptions. */
  public void setInputOptions(java.util.List inputOptions) {
    this.inputOptions = inputOptions;
  }

  /**
   * workflowId.
   *
   * @return RecipientIdentityVerification
   */
  public RecipientIdentityVerification workflowId(String workflowId) {
    this.workflowId = workflowId;
    return this;
  }

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

  /** setWorkflowId. */
  public void setWorkflowId(String workflowId) {
    this.workflowId = workflowId;
  }

  /**
   * workflowIdMetadata.
   *
   * @return RecipientIdentityVerification
   */
  public RecipientIdentityVerification workflowIdMetadata(PropertyMetadata workflowIdMetadata) {
    this.workflowIdMetadata = workflowIdMetadata;
    return this;
  }

  /**
   * .
   *
   * @return workflowIdMetadata
   */
  @Schema(description = "")
  public PropertyMetadata getWorkflowIdMetadata() {
    return workflowIdMetadata;
  }

  /** setWorkflowIdMetadata. */
  public void setWorkflowIdMetadata(PropertyMetadata workflowIdMetadata) {
    this.workflowIdMetadata = workflowIdMetadata;
  }

  /**
   * workflowLabel.
   *
   * @return RecipientIdentityVerification
   */
  public RecipientIdentityVerification workflowLabel(String workflowLabel) {
    this.workflowLabel = workflowLabel;
    return this;
  }

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

  /** setWorkflowLabel. */
  public void setWorkflowLabel(String workflowLabel) {
    this.workflowLabel = workflowLabel;
  }

  /**
   * 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;
    }
    RecipientIdentityVerification recipientIdentityVerification = (RecipientIdentityVerification) o;
    return Objects.equals(this.inputOptions, recipientIdentityVerification.inputOptions)
        && Objects.equals(this.workflowId, recipientIdentityVerification.workflowId)
        && Objects.equals(this.workflowIdMetadata, recipientIdentityVerification.workflowIdMetadata)
        && Objects.equals(this.workflowLabel, recipientIdentityVerification.workflowLabel);
  }

  /** Returns the HashCode. */
  @Override
  public int hashCode() {
    return Objects.hash(inputOptions, workflowId, workflowIdMetadata, workflowLabel);
  }

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

    sb.append("    inputOptions: ").append(toIndentedString(inputOptions)).append("\n");
    sb.append("    workflowId: ").append(toIndentedString(workflowId)).append("\n");
    sb.append("    workflowIdMetadata: ").append(toIndentedString(workflowIdMetadata)).append("\n");
    sb.append("    workflowLabel: ").append(toIndentedString(workflowLabel)).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    ");
  }
}