com.docusign.esign.model.ScheduledSending Maven / Gradle / Ivy

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;

/** ScheduledSending. */
public class ScheduledSending {
  @JsonProperty("bulkListId")
  private String bulkListId = null;

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

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

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

  /**
   * bulkListId.
   *
   * @return ScheduledSending
   */
  public ScheduledSending bulkListId(String bulkListId) {
    this.bulkListId = bulkListId;
    return this;
  }

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

  /** setBulkListId. */
  public void setBulkListId(String bulkListId) {
    this.bulkListId = bulkListId;
  }

  /**
   * resumeDate.
   *
   * @return ScheduledSending
   */
  public ScheduledSending resumeDate(String resumeDate) {
    this.resumeDate = resumeDate;
    return this;
  }

  /**
   * An ISO 8601 formatted datetime string indicating the date and time that the envelope is (or
   * was) scheduled to be sent or null if the envelope has not yet been sent..
   *
   * @return resumeDate
   */
  @Schema(
      description =
          "An ISO 8601 formatted datetime string indicating the date and time that the envelope is (or was) scheduled to be sent or null if the envelope has not yet been sent.")
  public String getResumeDate() {
    return resumeDate;
  }

  /** setResumeDate. */
  public void setResumeDate(String resumeDate) {
    this.resumeDate = resumeDate;
  }

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

  /**
   * addRulesItem.
   *
   * @return ScheduledSending
   */
  public ScheduledSending addRulesItem(EnvelopeDelayRule rulesItem) {
    if (this.rules == null) {
      this.rules = new java.util.ArrayList<>();
    }
    this.rules.add(rulesItem);
    return this;
  }

  /**
   * A list of envelope delay rules specified by the user indicating how and when the envelope
   * should be scheduled for sending in the future. Currently only 1 rule may be specified..
   *
   * @return rules
   */
  @Schema(
      description =
          "A list of envelope delay rules specified by the user indicating how and when the envelope should be scheduled for sending in the future. Currently only 1 rule may be specified.")
  public java.util.List getRules() {
    return rules;
  }

  /** setRules. */
  public void setRules(java.util.List rules) {
    this.rules = rules;
  }

  /**
   * status.
   *
   * @return ScheduledSending
   */
  public ScheduledSending status(String status) {
    this.status = status;
    return this;
  }

  /**
   * \\\"pending\\\" if the envelope has not yet been sent and the scheduled sending delay has not
   * iniaited. \\\"started\\\" if the scheduled sending delay is in progress. \\\"completed\\\" if
   * the scheduled sending delay has elapsed and the envelope has been sent..
   *
   * @return status
   */
  @Schema(
      description =
          "\\\"pending\\\" if the envelope has not yet been sent and the scheduled sending delay has not iniaited. \\\"started\\\" if the scheduled sending delay is in progress. \\\"completed\\\" if the scheduled sending delay has elapsed and the envelope has been sent.")
  public String getStatus() {
    return status;
  }

  /** setStatus. */
  public void setStatus(String status) {
    this.status = status;
  }

  /**
   * 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;
    }
    ScheduledSending scheduledSending = (ScheduledSending) o;
    return Objects.equals(this.bulkListId, scheduledSending.bulkListId)
        && Objects.equals(this.resumeDate, scheduledSending.resumeDate)
        && Objects.equals(this.rules, scheduledSending.rules)
        && Objects.equals(this.status, scheduledSending.status);
  }

  /** Returns the HashCode. */
  @Override
  public int hashCode() {
    return Objects.hash(bulkListId, resumeDate, rules, status);
  }

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

    sb.append("    bulkListId: ").append(toIndentedString(bulkListId)).append("\n");
    sb.append("    resumeDate: ").append(toIndentedString(resumeDate)).append("\n");
    sb.append("    rules: ").append(toIndentedString(rules)).append("\n");
    sb.append("    status: ").append(toIndentedString(status)).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    ");
  }
}