com.docusign.esign.model.RecipientPreviewRequest 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.
The newest version!
package com.docusign.esign.model;

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

/** This request object contains the information necessary to create a recipient preview.. */
@Schema(
    description =
        "This request object contains the information necessary to create a recipient preview.")
public class RecipientPreviewRequest implements Serializable {
  private static final long serialVersionUID = 1L;

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

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

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

  @JsonProperty("clientURLs")
  private RecipientTokenClientURLs clientURLs = null;

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

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

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

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

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

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

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

  /**
   * assertionId.
   *
   * @return RecipientPreviewRequest
   */
  public RecipientPreviewRequest assertionId(String assertionId) {
    this.assertionId = assertionId;
    return this;
  }

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

  /** setAssertionId. */
  public void setAssertionId(String assertionId) {
    this.assertionId = assertionId;
  }

  /**
   * authenticationInstant.
   *
   * @return RecipientPreviewRequest
   */
  public RecipientPreviewRequest authenticationInstant(String authenticationInstant) {
    this.authenticationInstant = authenticationInstant;
    return this;
  }

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

  /** setAuthenticationInstant. */
  public void setAuthenticationInstant(String authenticationInstant) {
    this.authenticationInstant = authenticationInstant;
  }

  /**
   * authenticationMethod.
   *
   * @return RecipientPreviewRequest
   */
  public RecipientPreviewRequest authenticationMethod(String authenticationMethod) {
    this.authenticationMethod = authenticationMethod;
    return this;
  }

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

  /** setAuthenticationMethod. */
  public void setAuthenticationMethod(String authenticationMethod) {
    this.authenticationMethod = authenticationMethod;
  }

  /**
   * clientURLs.
   *
   * @return RecipientPreviewRequest
   */
  public RecipientPreviewRequest clientURLs(RecipientTokenClientURLs clientURLs) {
    this.clientURLs = clientURLs;
    return this;
  }

  /**
   * .
   *
   * @return clientURLs
   */
  @Schema(description = "")
  public RecipientTokenClientURLs getClientURLs() {
    return clientURLs;
  }

  /** setClientURLs. */
  public void setClientURLs(RecipientTokenClientURLs clientURLs) {
    this.clientURLs = clientURLs;
  }

  /**
   * pingFrequency.
   *
   * @return RecipientPreviewRequest
   */
  public RecipientPreviewRequest pingFrequency(String pingFrequency) {
    this.pingFrequency = pingFrequency;
    return this;
  }

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

  /** setPingFrequency. */
  public void setPingFrequency(String pingFrequency) {
    this.pingFrequency = pingFrequency;
  }

  /**
   * pingUrl.
   *
   * @return RecipientPreviewRequest
   */
  public RecipientPreviewRequest pingUrl(String pingUrl) {
    this.pingUrl = pingUrl;
    return this;
  }

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

  /** setPingUrl. */
  public void setPingUrl(String pingUrl) {
    this.pingUrl = pingUrl;
  }

  /**
   * recipientId.
   *
   * @return RecipientPreviewRequest
   */
  public RecipientPreviewRequest 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
   */
  @Schema(
      description =
          "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;
  }

  /** setRecipientId. */
  public void setRecipientId(String recipientId) {
    this.recipientId = recipientId;
  }

  /**
   * returnUrl.
   *
   * @return RecipientPreviewRequest
   */
  public RecipientPreviewRequest returnUrl(String returnUrl) {
    this.returnUrl = returnUrl;
    return this;
  }

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

  /** setReturnUrl. */
  public void setReturnUrl(String returnUrl) {
    this.returnUrl = returnUrl;
  }

  /**
   * securityDomain.
   *
   * @return RecipientPreviewRequest
   */
  public RecipientPreviewRequest securityDomain(String securityDomain) {
    this.securityDomain = securityDomain;
    return this;
  }

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

  /** setSecurityDomain. */
  public void setSecurityDomain(String securityDomain) {
    this.securityDomain = securityDomain;
  }

  /**
   * xFrameOptions.
   *
   * @return RecipientPreviewRequest
   */
  public RecipientPreviewRequest xFrameOptions(String xFrameOptions) {
    this.xFrameOptions = xFrameOptions;
    return this;
  }

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

  /** setXFrameOptions. */
  public void setXFrameOptions(String xFrameOptions) {
    this.xFrameOptions = xFrameOptions;
  }

  /**
   * xFrameOptionsAllowFromUrl.
   *
   * @return RecipientPreviewRequest
   */
  public RecipientPreviewRequest xFrameOptionsAllowFromUrl(String xFrameOptionsAllowFromUrl) {
    this.xFrameOptionsAllowFromUrl = xFrameOptionsAllowFromUrl;
    return this;
  }

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

  /** setXFrameOptionsAllowFromUrl. */
  public void setXFrameOptionsAllowFromUrl(String xFrameOptionsAllowFromUrl) {
    this.xFrameOptionsAllowFromUrl = xFrameOptionsAllowFromUrl;
  }

  /**
   * 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;
    }
    RecipientPreviewRequest recipientPreviewRequest = (RecipientPreviewRequest) o;
    return Objects.equals(this.assertionId, recipientPreviewRequest.assertionId)
        && Objects.equals(this.authenticationInstant, recipientPreviewRequest.authenticationInstant)
        && Objects.equals(this.authenticationMethod, recipientPreviewRequest.authenticationMethod)
        && Objects.equals(this.clientURLs, recipientPreviewRequest.clientURLs)
        && Objects.equals(this.pingFrequency, recipientPreviewRequest.pingFrequency)
        && Objects.equals(this.pingUrl, recipientPreviewRequest.pingUrl)
        && Objects.equals(this.recipientId, recipientPreviewRequest.recipientId)
        && Objects.equals(this.returnUrl, recipientPreviewRequest.returnUrl)
        && Objects.equals(this.securityDomain, recipientPreviewRequest.securityDomain)
        && Objects.equals(this.xFrameOptions, recipientPreviewRequest.xFrameOptions)
        && Objects.equals(
            this.xFrameOptionsAllowFromUrl, recipientPreviewRequest.xFrameOptionsAllowFromUrl);
  }

  /** Returns the HashCode. */
  @Override
  public int hashCode() {
    return Objects.hash(
        assertionId,
        authenticationInstant,
        authenticationMethod,
        clientURLs,
        pingFrequency,
        pingUrl,
        recipientId,
        returnUrl,
        securityDomain,
        xFrameOptions,
        xFrameOptionsAllowFromUrl);
  }

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

    sb.append("    assertionId: ").append(toIndentedString(assertionId)).append("\n");
    sb.append("    authenticationInstant: ")
        .append(toIndentedString(authenticationInstant))
        .append("\n");
    sb.append("    authenticationMethod: ")
        .append(toIndentedString(authenticationMethod))
        .append("\n");
    sb.append("    clientURLs: ").append(toIndentedString(clientURLs)).append("\n");
    sb.append("    pingFrequency: ").append(toIndentedString(pingFrequency)).append("\n");
    sb.append("    pingUrl: ").append(toIndentedString(pingUrl)).append("\n");
    sb.append("    recipientId: ").append(toIndentedString(recipientId)).append("\n");
    sb.append("    returnUrl: ").append(toIndentedString(returnUrl)).append("\n");
    sb.append("    securityDomain: ").append(toIndentedString(securityDomain)).append("\n");
    sb.append("    xFrameOptions: ").append(toIndentedString(xFrameOptions)).append("\n");
    sb.append("    xFrameOptionsAllowFromUrl: ")
        .append(toIndentedString(xFrameOptionsAllowFromUrl))
        .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    ");
  }
}