package com.box.sdkgen.schemas.signrequestbase;

import com.box.sdkgen.internal.Nullable;
import com.box.sdkgen.internal.NullableFieldTracker;
import com.box.sdkgen.internal.SerializableObject;
import com.box.sdkgen.schemas.signrequestprefilltag.SignRequestPrefillTag;
import com.fasterxml.jackson.annotation.JsonFilter;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.List;
import java.util.Objects;

/** A standard representation of a signature request object. */
@JsonFilter("nullablePropertyFilter")
public class SignRequestBase extends SerializableObject {

  /**
   * Indicates if the sender should receive a `prepare_url` in the response to complete document
   * preparation using the UI.
   */
  @JsonProperty("is_document_preparation_needed")
  protected Boolean isDocumentPreparationNeeded;

  /**
   * When specified, the signature request will be redirected to this url when a document is signed.
   */
  @JsonProperty("redirect_url")
  @Nullable
  protected String redirectUrl;

  /** The uri that a signer will be redirected to after declining to sign a document. */
  @JsonProperty("declined_redirect_url")
  @Nullable
  protected String declinedRedirectUrl;

  /** Disables the usage of signatures generated by typing (text). */
  @JsonProperty("are_text_signatures_enabled")
  protected Boolean areTextSignaturesEnabled;

  /**
   * Subject of sign request email. This is cleaned by sign request. If this field is not passed, a
   * default subject will be used.
   */
  @JsonProperty("email_subject")
  @Nullable
  protected String emailSubject;

  /**
   * Message to include in sign request email. The field is cleaned through sanitization of specific
   * characters. However, some html tags are allowed. Links included in the message are also
   * converted to hyperlinks in the email. The message may contain the following html tags including
   * `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong`.
   * Be aware that when the text to html ratio is too high, the email may end up in spam filters.
   * Custom styles on these tags are not allowed. If this field is not passed, a default message
   * will be used.
   */
  @JsonProperty("email_message")
  @Nullable
  protected String emailMessage;

  /**
   * Reminds signers to sign a document on day 3, 8, 13 and 18. Reminders are only sent to
   * outstanding signers.
   */
  @JsonProperty("are_reminders_enabled")
  protected Boolean areRemindersEnabled;

  /** Name of the signature request. */
  protected String name;

  /**
   * When a document contains sign-related tags in the content, you can prefill them using this
   * `prefill_tags` by referencing the 'id' of the tag as the `external_id` field of the prefill
   * tag.
   */
  @JsonProperty("prefill_tags")
  protected List<SignRequestPrefillTag> prefillTags;

  /**
   * Set the number of days after which the created signature request will automatically expire if
   * not completed. By default, we do not apply any expiration date on signature requests, and the
   * signature request does not expire.
   */
  @JsonProperty("days_valid")
  @Nullable
  protected Long daysValid;

  /**
   * This can be used to reference an ID in an external system that the sign request is related to.
   */
  @JsonProperty("external_id")
  @Nullable
  protected String externalId;

  /**
   * When a signature request is created from a template this field will indicate the id of that
   * template.
   */
  @JsonProperty("template_id")
  @Nullable
  protected String templateId;

  /**
   * Used as an optional system name to appear in the signature log next to the signers who have
   * been assigned the `embed_url_external_id`.
   */
  @JsonProperty("external_system_name")
  @Nullable
  protected String externalSystemName;

  /**
   * The flow type of the sign request. Values can include `standard` or `cfr11`. When not specified
   * during creation, a default is chosen based on admin settings.
   */
  @JsonProperty("request_flow")
  @Nullable
  protected String requestFlow;

  public SignRequestBase() {
    super();
  }

  protected SignRequestBase(Builder builder) {
    super();
    this.isDocumentPreparationNeeded = builder.isDocumentPreparationNeeded;
    this.redirectUrl = builder.redirectUrl;
    this.declinedRedirectUrl = builder.declinedRedirectUrl;
    this.areTextSignaturesEnabled = builder.areTextSignaturesEnabled;
    this.emailSubject = builder.emailSubject;
    this.emailMessage = builder.emailMessage;
    this.areRemindersEnabled = builder.areRemindersEnabled;
    this.name = builder.name;
    this.prefillTags = builder.prefillTags;
    this.daysValid = builder.daysValid;
    this.externalId = builder.externalId;
    this.templateId = builder.templateId;
    this.externalSystemName = builder.externalSystemName;
    this.requestFlow = builder.requestFlow;
    markNullableFieldsAsSet(builder.getExplicitlySetNullableFields());
  }

  public Boolean getIsDocumentPreparationNeeded() {
    return isDocumentPreparationNeeded;
  }

  public String getRedirectUrl() {
    return redirectUrl;
  }

  public String getDeclinedRedirectUrl() {
    return declinedRedirectUrl;
  }

  public Boolean getAreTextSignaturesEnabled() {
    return areTextSignaturesEnabled;
  }

  public String getEmailSubject() {
    return emailSubject;
  }

  public String getEmailMessage() {
    return emailMessage;
  }

  public Boolean getAreRemindersEnabled() {
    return areRemindersEnabled;
  }

  public String getName() {
    return name;
  }

  public List<SignRequestPrefillTag> getPrefillTags() {
    return prefillTags;
  }

  public Long getDaysValid() {
    return daysValid;
  }

  public String getExternalId() {
    return externalId;
  }

  public String getTemplateId() {
    return templateId;
  }

  public String getExternalSystemName() {
    return externalSystemName;
  }

  public String getRequestFlow() {
    return requestFlow;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    SignRequestBase casted = (SignRequestBase) o;
    return Objects.equals(isDocumentPreparationNeeded, casted.isDocumentPreparationNeeded)
        && Objects.equals(redirectUrl, casted.redirectUrl)
        && Objects.equals(declinedRedirectUrl, casted.declinedRedirectUrl)
        && Objects.equals(areTextSignaturesEnabled, casted.areTextSignaturesEnabled)
        && Objects.equals(emailSubject, casted.emailSubject)
        && Objects.equals(emailMessage, casted.emailMessage)
        && Objects.equals(areRemindersEnabled, casted.areRemindersEnabled)
        && Objects.equals(name, casted.name)
        && Objects.equals(prefillTags, casted.prefillTags)
        && Objects.equals(daysValid, casted.daysValid)
        && Objects.equals(externalId, casted.externalId)
        && Objects.equals(templateId, casted.templateId)
        && Objects.equals(externalSystemName, casted.externalSystemName)
        && Objects.equals(requestFlow, casted.requestFlow);
  }

  @Override
  public int hashCode() {
    return Objects.hash(
        isDocumentPreparationNeeded,
        redirectUrl,
        declinedRedirectUrl,
        areTextSignaturesEnabled,
        emailSubject,
        emailMessage,
        areRemindersEnabled,
        name,
        prefillTags,
        daysValid,
        externalId,
        templateId,
        externalSystemName,
        requestFlow);
  }

  @Override
  public String toString() {
    return "SignRequestBase{"
        + "isDocumentPreparationNeeded='"
        + isDocumentPreparationNeeded
        + '\''
        + ", "
        + "redirectUrl='"
        + redirectUrl
        + '\''
        + ", "
        + "declinedRedirectUrl='"
        + declinedRedirectUrl
        + '\''
        + ", "
        + "areTextSignaturesEnabled='"
        + areTextSignaturesEnabled
        + '\''
        + ", "
        + "emailSubject='"
        + emailSubject
        + '\''
        + ", "
        + "emailMessage='"
        + emailMessage
        + '\''
        + ", "
        + "areRemindersEnabled='"
        + areRemindersEnabled
        + '\''
        + ", "
        + "name='"
        + name
        + '\''
        + ", "
        + "prefillTags='"
        + prefillTags
        + '\''
        + ", "
        + "daysValid='"
        + daysValid
        + '\''
        + ", "
        + "externalId='"
        + externalId
        + '\''
        + ", "
        + "templateId='"
        + templateId
        + '\''
        + ", "
        + "externalSystemName='"
        + externalSystemName
        + '\''
        + ", "
        + "requestFlow='"
        + requestFlow
        + '\''
        + "}";
  }

  public static class Builder extends NullableFieldTracker {

    protected Boolean isDocumentPreparationNeeded;

    protected String redirectUrl;

    protected String declinedRedirectUrl;

    protected Boolean areTextSignaturesEnabled;

    protected String emailSubject;

    protected String emailMessage;

    protected Boolean areRemindersEnabled;

    protected String name;

    protected List<SignRequestPrefillTag> prefillTags;

    protected Long daysValid;

    protected String externalId;

    protected String templateId;

    protected String externalSystemName;

    protected String requestFlow;

    public Builder isDocumentPreparationNeeded(Boolean isDocumentPreparationNeeded) {
      this.isDocumentPreparationNeeded = isDocumentPreparationNeeded;
      return this;
    }

    public Builder redirectUrl(String redirectUrl) {
      this.redirectUrl = redirectUrl;
      this.markNullableFieldAsSet("redirect_url");
      return this;
    }

    public Builder declinedRedirectUrl(String declinedRedirectUrl) {
      this.declinedRedirectUrl = declinedRedirectUrl;
      this.markNullableFieldAsSet("declined_redirect_url");
      return this;
    }

    public Builder areTextSignaturesEnabled(Boolean areTextSignaturesEnabled) {
      this.areTextSignaturesEnabled = areTextSignaturesEnabled;
      return this;
    }

    public Builder emailSubject(String emailSubject) {
      this.emailSubject = emailSubject;
      this.markNullableFieldAsSet("email_subject");
      return this;
    }

    public Builder emailMessage(String emailMessage) {
      this.emailMessage = emailMessage;
      this.markNullableFieldAsSet("email_message");
      return this;
    }

    public Builder areRemindersEnabled(Boolean areRemindersEnabled) {
      this.areRemindersEnabled = areRemindersEnabled;
      return this;
    }

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

    public Builder prefillTags(List<SignRequestPrefillTag> prefillTags) {
      this.prefillTags = prefillTags;
      return this;
    }

    public Builder daysValid(Long daysValid) {
      this.daysValid = daysValid;
      this.markNullableFieldAsSet("days_valid");
      return this;
    }

    public Builder externalId(String externalId) {
      this.externalId = externalId;
      this.markNullableFieldAsSet("external_id");
      return this;
    }

    public Builder templateId(String templateId) {
      this.templateId = templateId;
      this.markNullableFieldAsSet("template_id");
      return this;
    }

    public Builder externalSystemName(String externalSystemName) {
      this.externalSystemName = externalSystemName;
      this.markNullableFieldAsSet("external_system_name");
      return this;
    }

    public Builder requestFlow(String requestFlow) {
      this.requestFlow = requestFlow;
      this.markNullableFieldAsSet("request_flow");
      return this;
    }

    public SignRequestBase build() {
      return new SignRequestBase(this);
    }
  }
}