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

/** Information for a folder request.. */
@Schema(description = "Information for a folder request.")
public class FoldersRequest {
  @JsonProperty("envelopeIds")
  private java.util.List envelopeIds = null;

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

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

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

  /**
   * addEnvelopeIdsItem.
   *
   * @return FoldersRequest
   */
  public FoldersRequest addEnvelopeIdsItem(String envelopeIdsItem) {
    if (this.envelopeIds == null) {
      this.envelopeIds = new java.util.ArrayList<>();
    }
    this.envelopeIds.add(envelopeIdsItem);
    return this;
  }

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

  /** setEnvelopeIds. */
  public void setEnvelopeIds(java.util.List envelopeIds) {
    this.envelopeIds = envelopeIds;
  }

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

  /**
   * addFoldersItem.
   *
   * @return FoldersRequest
   */
  public FoldersRequest addFoldersItem(Folder foldersItem) {
    if (this.folders == null) {
      this.folders = new java.util.ArrayList<>();
    }
    this.folders.add(foldersItem);
    return this;
  }

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

  /** setFolders. */
  public void setFolders(java.util.List folders) {
    this.folders = folders;
  }

  /**
   * fromFolderId.
   *
   * @return FoldersRequest
   */
  public FoldersRequest fromFolderId(String fromFolderId) {
    this.fromFolderId = fromFolderId;
    return this;
  }

  /**
   * The folder ID the envelope is being moved from..
   *
   * @return fromFolderId
   */
  @Schema(description = " The folder ID the envelope is being moved from.")
  public String getFromFolderId() {
    return fromFolderId;
  }

  /** setFromFolderId. */
  public void setFromFolderId(String fromFolderId) {
    this.fromFolderId = fromFolderId;
  }

  /**
   * 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;
    }
    FoldersRequest foldersRequest = (FoldersRequest) o;
    return Objects.equals(this.envelopeIds, foldersRequest.envelopeIds)
        && Objects.equals(this.folders, foldersRequest.folders)
        && Objects.equals(this.fromFolderId, foldersRequest.fromFolderId);
  }

  /** Returns the HashCode. */
  @Override
  public int hashCode() {
    return Objects.hash(envelopeIds, folders, fromFolderId);
  }

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

    sb.append("    envelopeIds: ").append(toIndentedString(envelopeIds)).append("\n");
    sb.append("    folders: ").append(toIndentedString(folders)).append("\n");
    sb.append("    fromFolderId: ").append(toIndentedString(fromFolderId)).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    ");
  }
}