com.dominodatalab.api.model.DominoNotificationsCreateNotificationRequest Maven / Gradle / Ivy

Go to download
/*
 * Domino Data Lab API v4
 * This API is going to provide access to all the Domino functions available in the user interface. To authenticate your requests, include your API Key (which you can find on your account page) with the header X-Domino-Api-Key. 
 *
 * The version of the OpenAPI document: 4.0.0
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */


package com.dominodatalab.api.model;

import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.StringJoiner;
import java.util.Objects;
import java.util.Map;
import java.util.HashMap;
import com.dominodatalab.api.model.DominoNotificationsPriority;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.annotation.JsonValue;
import java.time.OffsetDateTime;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;


/**
 * Request to create a new notification. If any of (targetUsers, targetRoles, targetOrgs) contain a valid entry, then the notification will be visible to users for which at least one of these conditions apply. Otherwise, it will be visible to all users.
 */
@JsonPropertyOrder({
  DominoNotificationsCreateNotificationRequest.JSON_PROPERTY_TITLE,
  DominoNotificationsCreateNotificationRequest.JSON_PROPERTY_MESSAGE,
  DominoNotificationsCreateNotificationRequest.JSON_PROPERTY_PRIORITY,
  DominoNotificationsCreateNotificationRequest.JSON_PROPERTY_START,
  DominoNotificationsCreateNotificationRequest.JSON_PROPERTY_END,
  DominoNotificationsCreateNotificationRequest.JSON_PROPERTY_TARGET_USERS,
  DominoNotificationsCreateNotificationRequest.JSON_PROPERTY_TARGET_ORGS,
  DominoNotificationsCreateNotificationRequest.JSON_PROPERTY_TARGET_ROLES
})
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-10-17T15:20:46.682098100-04:00[America/New_York]")
public class DominoNotificationsCreateNotificationRequest {
  public static final String JSON_PROPERTY_TITLE = "title";
  private String title;

  public static final String JSON_PROPERTY_MESSAGE = "message";
  private String message;

  public static final String JSON_PROPERTY_PRIORITY = "priority";
  private DominoNotificationsPriority priority;

  public static final String JSON_PROPERTY_START = "start";
  private OffsetDateTime start;

  public static final String JSON_PROPERTY_END = "end";
  private OffsetDateTime end;

  public static final String JSON_PROPERTY_TARGET_USERS = "targetUsers";
  private List targetUsers;

  public static final String JSON_PROPERTY_TARGET_ORGS = "targetOrgs";
  private List targetOrgs;

  public static final String JSON_PROPERTY_TARGET_ROLES = "targetRoles";
  private List targetRoles;

  public DominoNotificationsCreateNotificationRequest() { 
  }

  public DominoNotificationsCreateNotificationRequest title(String title) {
    this.title = title;
    return this;
  }

   /**
   * the notification title
   * @return title
  **/
  @javax.annotation.Nonnull
  @JsonProperty(JSON_PROPERTY_TITLE)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)

  public String getTitle() {
    return title;
  }


  @JsonProperty(JSON_PROPERTY_TITLE)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public void setTitle(String title) {
    this.title = title;
  }


  public DominoNotificationsCreateNotificationRequest message(String message) {
    this.message = message;
    return this;
  }

   /**
   * the notification body
   * @return message
  **/
  @javax.annotation.Nullable
  @JsonProperty(JSON_PROPERTY_MESSAGE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getMessage() {
    return message;
  }


  @JsonProperty(JSON_PROPERTY_MESSAGE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setMessage(String message) {
    this.message = message;
  }


  public DominoNotificationsCreateNotificationRequest priority(DominoNotificationsPriority priority) {
    this.priority = priority;
    return this;
  }

   /**
   * Get priority
   * @return priority
  **/
  @javax.annotation.Nonnull
  @JsonProperty(JSON_PROPERTY_PRIORITY)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)

  public DominoNotificationsPriority getPriority() {
    return priority;
  }


  @JsonProperty(JSON_PROPERTY_PRIORITY)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public void setPriority(DominoNotificationsPriority priority) {
    this.priority = priority;
  }


  public DominoNotificationsCreateNotificationRequest start(OffsetDateTime start) {
    this.start = start;
    return this;
  }

   /**
   * optional start date/time (defaults to now)
   * @return start
  **/
  @javax.annotation.Nullable
  @JsonProperty(JSON_PROPERTY_START)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public OffsetDateTime getStart() {
    return start;
  }


  @JsonProperty(JSON_PROPERTY_START)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setStart(OffsetDateTime start) {
    this.start = start;
  }


  public DominoNotificationsCreateNotificationRequest end(OffsetDateTime end) {
    this.end = end;
    return this;
  }

   /**
   * optional end date/time
   * @return end
  **/
  @javax.annotation.Nullable
  @JsonProperty(JSON_PROPERTY_END)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public OffsetDateTime getEnd() {
    return end;
  }


  @JsonProperty(JSON_PROPERTY_END)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setEnd(OffsetDateTime end) {
    this.end = end;
  }


  public DominoNotificationsCreateNotificationRequest targetUsers(List targetUsers) {
    this.targetUsers = targetUsers;
    return this;
  }

  public DominoNotificationsCreateNotificationRequest addTargetUsersItem(String targetUsersItem) {
    if (this.targetUsers == null) {
      this.targetUsers = new ArrayList<>();
    }
    this.targetUsers.add(targetUsersItem);
    return this;
  }

   /**
   * DominoIds of users who will receive this notification.
   * @return targetUsers
  **/
  @javax.annotation.Nullable
  @JsonProperty(JSON_PROPERTY_TARGET_USERS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public List getTargetUsers() {
    return targetUsers;
  }


  @JsonProperty(JSON_PROPERTY_TARGET_USERS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setTargetUsers(List targetUsers) {
    this.targetUsers = targetUsers;
  }


  public DominoNotificationsCreateNotificationRequest targetOrgs(List targetOrgs) {
    this.targetOrgs = targetOrgs;
    return this;
  }

  public DominoNotificationsCreateNotificationRequest addTargetOrgsItem(String targetOrgsItem) {
    if (this.targetOrgs == null) {
      this.targetOrgs = new ArrayList<>();
    }
    this.targetOrgs.add(targetOrgsItem);
    return this;
  }

   /**
   * DominoIds of orgs whose users will receive this notification.
   * @return targetOrgs
  **/
  @javax.annotation.Nullable
  @JsonProperty(JSON_PROPERTY_TARGET_ORGS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public List getTargetOrgs() {
    return targetOrgs;
  }


  @JsonProperty(JSON_PROPERTY_TARGET_ORGS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setTargetOrgs(List targetOrgs) {
    this.targetOrgs = targetOrgs;
  }


  public DominoNotificationsCreateNotificationRequest targetRoles(List targetRoles) {
    this.targetRoles = targetRoles;
    return this;
  }

  public DominoNotificationsCreateNotificationRequest addTargetRolesItem(String targetRolesItem) {
    if (this.targetRoles == null) {
      this.targetRoles = new ArrayList<>();
    }
    this.targetRoles.add(targetRolesItem);
    return this;
  }

   /**
   * Ids of Roles. Users that have any of these Roles will receive this notification.
   * @return targetRoles
  **/
  @javax.annotation.Nullable
  @JsonProperty(JSON_PROPERTY_TARGET_ROLES)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public List getTargetRoles() {
    return targetRoles;
  }


  @JsonProperty(JSON_PROPERTY_TARGET_ROLES)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setTargetRoles(List targetRoles) {
    this.targetRoles = targetRoles;
  }


  /**
   * Return true if this domino.notifications.CreateNotificationRequest object is equal to o.
   */
  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    DominoNotificationsCreateNotificationRequest dominoNotificationsCreateNotificationRequest = (DominoNotificationsCreateNotificationRequest) o;
    return Objects.equals(this.title, dominoNotificationsCreateNotificationRequest.title) &&
        Objects.equals(this.message, dominoNotificationsCreateNotificationRequest.message) &&
        Objects.equals(this.priority, dominoNotificationsCreateNotificationRequest.priority) &&
        Objects.equals(this.start, dominoNotificationsCreateNotificationRequest.start) &&
        Objects.equals(this.end, dominoNotificationsCreateNotificationRequest.end) &&
        Objects.equals(this.targetUsers, dominoNotificationsCreateNotificationRequest.targetUsers) &&
        Objects.equals(this.targetOrgs, dominoNotificationsCreateNotificationRequest.targetOrgs) &&
        Objects.equals(this.targetRoles, dominoNotificationsCreateNotificationRequest.targetRoles);
  }

  @Override
  public int hashCode() {
    return Objects.hash(title, message, priority, start, end, targetUsers, targetOrgs, targetRoles);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class DominoNotificationsCreateNotificationRequest {\n");
    sb.append("    title: ").append(toIndentedString(title)).append("\n");
    sb.append("    message: ").append(toIndentedString(message)).append("\n");
    sb.append("    priority: ").append(toIndentedString(priority)).append("\n");
    sb.append("    start: ").append(toIndentedString(start)).append("\n");
    sb.append("    end: ").append(toIndentedString(end)).append("\n");
    sb.append("    targetUsers: ").append(toIndentedString(targetUsers)).append("\n");
    sb.append("    targetOrgs: ").append(toIndentedString(targetOrgs)).append("\n");
    sb.append("    targetRoles: ").append(toIndentedString(targetRoles)).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(Object o) {
    if (o == null) {
      return "null";
    }
    return o.toString().replace("\n", "\n    ");
  }

  /**
   * Convert the instance into URL query string.
   *
   * @return URL query string
   */
  public String toUrlQueryString() {
    return toUrlQueryString(null);
  }

  /**
   * Convert the instance into URL query string.
   *
   * @param prefix prefix of the query string
   * @return URL query string
   */
  public String toUrlQueryString(String prefix) {
    String suffix = "";
    String containerSuffix = "";
    String containerPrefix = "";
    if (prefix == null) {
      // style=form, explode=true, e.g. /pet?name=cat&type=manx
      prefix = "";
    } else {
      // deepObject style e.g. /pet?id[name]=cat&id[type]=manx
      prefix = prefix + "[";
      suffix = "]";
      containerSuffix = "]";
      containerPrefix = "[";
    }

    StringJoiner joiner = new StringJoiner("&");

    // add `title` to the URL query string
    if (getTitle() != null) {
      joiner.add(String.format("%stitle%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf(getTitle()), StandardCharsets.UTF_8).replaceAll("\\+", "%20")));
    }

    // add `message` to the URL query string
    if (getMessage() != null) {
      joiner.add(String.format("%smessage%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf(getMessage()), StandardCharsets.UTF_8).replaceAll("\\+", "%20")));
    }

    // add `priority` to the URL query string
    if (getPriority() != null) {
      joiner.add(String.format("%spriority%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf(getPriority()), StandardCharsets.UTF_8).replaceAll("\\+", "%20")));
    }

    // add `start` to the URL query string
    if (getStart() != null) {
      joiner.add(String.format("%sstart%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf(getStart()), StandardCharsets.UTF_8).replaceAll("\\+", "%20")));
    }

    // add `end` to the URL query string
    if (getEnd() != null) {
      joiner.add(String.format("%send%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf(getEnd()), StandardCharsets.UTF_8).replaceAll("\\+", "%20")));
    }

    // add `targetUsers` to the URL query string
    if (getTargetUsers() != null) {
      for (int i = 0; i < getTargetUsers().size(); i++) {
        joiner.add(String.format("%stargetUsers%s%s=%s", prefix, suffix,
            "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix),
            URLEncoder.encode(String.valueOf(getTargetUsers().get(i)), StandardCharsets.UTF_8).replaceAll("\\+", "%20")));
      }
    }

    // add `targetOrgs` to the URL query string
    if (getTargetOrgs() != null) {
      for (int i = 0; i < getTargetOrgs().size(); i++) {
        joiner.add(String.format("%stargetOrgs%s%s=%s", prefix, suffix,
            "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix),
            URLEncoder.encode(String.valueOf(getTargetOrgs().get(i)), StandardCharsets.UTF_8).replaceAll("\\+", "%20")));
      }
    }

    // add `targetRoles` to the URL query string
    if (getTargetRoles() != null) {
      for (int i = 0; i < getTargetRoles().size(); i++) {
        joiner.add(String.format("%stargetRoles%s%s=%s", prefix, suffix,
            "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix),
            URLEncoder.encode(String.valueOf(getTargetRoles().get(i)), StandardCharsets.UTF_8).replaceAll("\\+", "%20")));
      }
    }

    return joiner.toString();
  }
}