com.mypurecloud.sdk.model.UserDetailsQuery Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of platform-client Show documentation
The official Java SDK for the PureCloud Platform API SDK
The newest version!
package com.mypurecloud.sdk.model;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import java.util.Objects;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonValue;
import com.mypurecloud.sdk.model.AnalyticsQueryAggregation;
import com.mypurecloud.sdk.model.AnalyticsQueryFilter;
import com.mypurecloud.sdk.model.PagingSpec;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.util.ArrayList;
import java.util.List;

import java.io.Serializable;
/**
 * UserDetailsQuery
 */

public class UserDetailsQuery  implements Serializable {
  
  private String interval = null;
  private List userFilters = new ArrayList();
  private List presenceFilters = new ArrayList();
  private List routingStatusFilters = new ArrayList();
  private List presenceAggregations = new ArrayList();
  private List routingStatusAggregations = new ArrayList();
  private PagingSpec paging = null;

  /**
   * Sort the result set in ascending/descending order. Default is ascending
   */
  public enum OrderEnum {
    OUTDATEDSDKVERSION("OutdatedSdkVersion"),
    ASC("asc"),
    DESC("desc");

    private String value;

    OrderEnum(String value) {
      this.value = value;
    }

    @JsonCreator
    public static OrderEnum fromString(String key) {
      if (key == null) return null;

      for (OrderEnum value : OrderEnum.values()) {
        if (key.equalsIgnoreCase(value.toString())) {
          return value;
        }
      }

      return OrderEnum.values()[0];
    }

    @Override
    @JsonValue
    public String toString() {
      return String.valueOf(value);
    }
  }
  private OrderEnum order = null;

  
  /**
   * Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
   **/
  public UserDetailsQuery interval(String interval) {
    this.interval = interval;
    return this;
  }
  
  @ApiModelProperty(example = "null", value = "Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss")
  @JsonProperty("interval")
  public String getInterval() {
    return interval;
  }
  public void setInterval(String interval) {
    this.interval = interval;
  }


  /**
   * Filters that target the users to retrieve data for
   **/
  public UserDetailsQuery userFilters(List userFilters) {
    this.userFilters = userFilters;
    return this;
  }
  
  @ApiModelProperty(example = "null", value = "Filters that target the users to retrieve data for")
  @JsonProperty("userFilters")
  public List getUserFilters() {
    return userFilters;
  }
  public void setUserFilters(List userFilters) {
    this.userFilters = userFilters;
  }


  /**
   * Filters that target system and organization presence-level data
   **/
  public UserDetailsQuery presenceFilters(List presenceFilters) {
    this.presenceFilters = presenceFilters;
    return this;
  }
  
  @ApiModelProperty(example = "null", value = "Filters that target system and organization presence-level data")
  @JsonProperty("presenceFilters")
  public List getPresenceFilters() {
    return presenceFilters;
  }
  public void setPresenceFilters(List presenceFilters) {
    this.presenceFilters = presenceFilters;
  }


  /**
   * Filters that target agent routing status-level data
   **/
  public UserDetailsQuery routingStatusFilters(List routingStatusFilters) {
    this.routingStatusFilters = routingStatusFilters;
    return this;
  }
  
  @ApiModelProperty(example = "null", value = "Filters that target agent routing status-level data")
  @JsonProperty("routingStatusFilters")
  public List getRoutingStatusFilters() {
    return routingStatusFilters;
  }
  public void setRoutingStatusFilters(List routingStatusFilters) {
    this.routingStatusFilters = routingStatusFilters;
  }


  /**
   * Include faceted search and aggregate roll-ups of presence data in your search results. This does not function as a filter, but rather, summary data about the presence results matching your filters
   **/
  public UserDetailsQuery presenceAggregations(List presenceAggregations) {
    this.presenceAggregations = presenceAggregations;
    return this;
  }
  
  @ApiModelProperty(example = "null", value = "Include faceted search and aggregate roll-ups of presence data in your search results. This does not function as a filter, but rather, summary data about the presence results matching your filters")
  @JsonProperty("presenceAggregations")
  public List getPresenceAggregations() {
    return presenceAggregations;
  }
  public void setPresenceAggregations(List presenceAggregations) {
    this.presenceAggregations = presenceAggregations;
  }


  /**
   * Include faceted search and aggregate roll-ups of agent routing status data in your search results. This does not function as a filter, but rather, summary data about the agent routing status results matching your filters
   **/
  public UserDetailsQuery routingStatusAggregations(List routingStatusAggregations) {
    this.routingStatusAggregations = routingStatusAggregations;
    return this;
  }
  
  @ApiModelProperty(example = "null", value = "Include faceted search and aggregate roll-ups of agent routing status data in your search results. This does not function as a filter, but rather, summary data about the agent routing status results matching your filters")
  @JsonProperty("routingStatusAggregations")
  public List getRoutingStatusAggregations() {
    return routingStatusAggregations;
  }
  public void setRoutingStatusAggregations(List routingStatusAggregations) {
    this.routingStatusAggregations = routingStatusAggregations;
  }


  /**
   * Page size and number to control iterating through large result sets. Default page size is 25
   **/
  public UserDetailsQuery paging(PagingSpec paging) {
    this.paging = paging;
    return this;
  }
  
  @ApiModelProperty(example = "null", value = "Page size and number to control iterating through large result sets. Default page size is 25")
  @JsonProperty("paging")
  public PagingSpec getPaging() {
    return paging;
  }
  public void setPaging(PagingSpec paging) {
    this.paging = paging;
  }


  /**
   * Sort the result set in ascending/descending order. Default is ascending
   **/
  public UserDetailsQuery order(OrderEnum order) {
    this.order = order;
    return this;
  }
  
  @ApiModelProperty(example = "null", value = "Sort the result set in ascending/descending order. Default is ascending")
  @JsonProperty("order")
  public OrderEnum getOrder() {
    return order;
  }
  public void setOrder(OrderEnum order) {
    this.order = order;
  }


  @Override
  public boolean equals(java.lang.Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    UserDetailsQuery userDetailsQuery = (UserDetailsQuery) o;
    return Objects.equals(this.interval, userDetailsQuery.interval) &&
        Objects.equals(this.userFilters, userDetailsQuery.userFilters) &&
        Objects.equals(this.presenceFilters, userDetailsQuery.presenceFilters) &&
        Objects.equals(this.routingStatusFilters, userDetailsQuery.routingStatusFilters) &&
        Objects.equals(this.presenceAggregations, userDetailsQuery.presenceAggregations) &&
        Objects.equals(this.routingStatusAggregations, userDetailsQuery.routingStatusAggregations) &&
        Objects.equals(this.paging, userDetailsQuery.paging) &&
        Objects.equals(this.order, userDetailsQuery.order);
  }

  @Override
  public int hashCode() {
    return Objects.hash(interval, userFilters, presenceFilters, routingStatusFilters, presenceAggregations, routingStatusAggregations, paging, order);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class UserDetailsQuery {\n");
    
    sb.append("    interval: ").append(toIndentedString(interval)).append("\n");
    sb.append("    userFilters: ").append(toIndentedString(userFilters)).append("\n");
    sb.append("    presenceFilters: ").append(toIndentedString(presenceFilters)).append("\n");
    sb.append("    routingStatusFilters: ").append(toIndentedString(routingStatusFilters)).append("\n");
    sb.append("    presenceAggregations: ").append(toIndentedString(presenceAggregations)).append("\n");
    sb.append("    routingStatusAggregations: ").append(toIndentedString(routingStatusAggregations)).append("\n");
    sb.append("    paging: ").append(toIndentedString(paging)).append("\n");
    sb.append("    order: ").append(toIndentedString(order)).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    ");
  }
}