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

/** Information about shared templates.. */
@Schema(description = "Information about shared templates.")
public class TemplateSharedItem {
  @JsonProperty("errorDetails")
  private ErrorDetails errorDetails = null;

  @JsonProperty("owner")
  private UserInfo owner = null;

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

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

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

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

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

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

  /**
   * errorDetails.
   *
   * @return TemplateSharedItem
   */
  public TemplateSharedItem errorDetails(ErrorDetails errorDetails) {
    this.errorDetails = errorDetails;
    return this;
  }

  /**
   * Array or errors..
   *
   * @return errorDetails
   */
  @Schema(description = "Array or errors.")
  public ErrorDetails getErrorDetails() {
    return errorDetails;
  }

  /** setErrorDetails. */
  public void setErrorDetails(ErrorDetails errorDetails) {
    this.errorDetails = errorDetails;
  }

  /**
   * owner.
   *
   * @return TemplateSharedItem
   */
  public TemplateSharedItem owner(UserInfo owner) {
    this.owner = owner;
    return this;
  }

  /**
   * Information about the user who owns the template..
   *
   * @return owner
   */
  @Schema(description = "Information about the user who owns the template.")
  public UserInfo getOwner() {
    return owner;
  }

  /** setOwner. */
  public void setOwner(UserInfo owner) {
    this.owner = owner;
  }

  /**
   * password.
   *
   * @return TemplateSharedItem
   */
  public TemplateSharedItem password(String password) {
    this.password = password;
    return this;
  }

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

  /** setPassword. */
  public void setPassword(String password) {
    this.password = password;
  }

  /**
   * shared.
   *
   * @return TemplateSharedItem
   */
  public TemplateSharedItem shared(String shared) {
    this.shared = shared;
    return this;
  }

  /**
   * When set to **true**, this custom tab is shared..
   *
   * @return shared
   */
  @Schema(description = "When set to **true**, this custom tab is shared.")
  public String getShared() {
    return shared;
  }

  /** setShared. */
  public void setShared(String shared) {
    this.shared = shared;
  }

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

  /**
   * addSharedGroupsItem.
   *
   * @return TemplateSharedItem
   */
  public TemplateSharedItem addSharedGroupsItem(MemberGroupSharedItem sharedGroupsItem) {
    if (this.sharedGroups == null) {
      this.sharedGroups = new java.util.ArrayList<>();
    }
    this.sharedGroups.add(sharedGroupsItem);
    return this;
  }

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

  /** setSharedGroups. */
  public void setSharedGroups(java.util.List sharedGroups) {
    this.sharedGroups = sharedGroups;
  }

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

  /**
   * addSharedUsersItem.
   *
   * @return TemplateSharedItem
   */
  public TemplateSharedItem addSharedUsersItem(UserSharedItem sharedUsersItem) {
    if (this.sharedUsers == null) {
      this.sharedUsers = new java.util.ArrayList<>();
    }
    this.sharedUsers.add(sharedUsersItem);
    return this;
  }

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

  /** setSharedUsers. */
  public void setSharedUsers(java.util.List sharedUsers) {
    this.sharedUsers = sharedUsers;
  }

  /**
   * templateId.
   *
   * @return TemplateSharedItem
   */
  public TemplateSharedItem templateId(String templateId) {
    this.templateId = templateId;
    return this;
  }

  /**
   * The unique identifier of the template. If this is not provided, DocuSign will generate a value.
   * .
   *
   * @return templateId
   */
  @Schema(
      description =
          "The unique identifier of the template. If this is not provided, DocuSign will generate a value. ")
  public String getTemplateId() {
    return templateId;
  }

  /** setTemplateId. */
  public void setTemplateId(String templateId) {
    this.templateId = templateId;
  }

  /**
   * templateName.
   *
   * @return TemplateSharedItem
   */
  public TemplateSharedItem templateName(String templateName) {
    this.templateName = templateName;
    return this;
  }

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

  /** setTemplateName. */
  public void setTemplateName(String templateName) {
    this.templateName = templateName;
  }

  /**
   * 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;
    }
    TemplateSharedItem templateSharedItem = (TemplateSharedItem) o;
    return Objects.equals(this.errorDetails, templateSharedItem.errorDetails)
        && Objects.equals(this.owner, templateSharedItem.owner)
        && Objects.equals(this.password, templateSharedItem.password)
        && Objects.equals(this.shared, templateSharedItem.shared)
        && Objects.equals(this.sharedGroups, templateSharedItem.sharedGroups)
        && Objects.equals(this.sharedUsers, templateSharedItem.sharedUsers)
        && Objects.equals(this.templateId, templateSharedItem.templateId)
        && Objects.equals(this.templateName, templateSharedItem.templateName);
  }

  /** Returns the HashCode. */
  @Override
  public int hashCode() {
    return Objects.hash(
        errorDetails, owner, password, shared, sharedGroups, sharedUsers, templateId, templateName);
  }

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

    sb.append("    errorDetails: ").append(toIndentedString(errorDetails)).append("\n");
    sb.append("    owner: ").append(toIndentedString(owner)).append("\n");
    sb.append("    password: ").append(toIndentedString(password)).append("\n");
    sb.append("    shared: ").append(toIndentedString(shared)).append("\n");
    sb.append("    sharedGroups: ").append(toIndentedString(sharedGroups)).append("\n");
    sb.append("    sharedUsers: ").append(toIndentedString(sharedUsers)).append("\n");
    sb.append("    templateId: ").append(toIndentedString(templateId)).append("\n");
    sb.append("    templateName: ").append(toIndentedString(templateName)).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    ");
  }
}