io.smooch.v2.client.model.ConversationListResponse Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api Show documentation

io.smooch - api - 6.0.0-alpha.7

There is a newer version: 6.0.0-alpha.7

/*
 * Sunshine Conversations API
 * #  As a stepping stone to new and greater things, we’ve released an update to the SunCo API, which is v2. For users wanting to access v1, please proceed here.  
  # Introduction  Welcome to the Sunshine Conversations API. The API allows you to craft entirely unique messaging experiences for your app and website as well as talk to any backend or external service.  The Sunshine Conversations API is designed according to REST principles. The API accepts JSON in request bodies and requires that the content-type: application/json header be specified for  all such requests. The API will always respond with an object. Depending on context, resources may be returned as single objects or as arrays of objects, nested within the response object.  In some cases, the API will also facilitate cross-origin resource sharing so that it can be called from a web application.  Note that for authenticated requests, cross-origin resource sharing is only available to appUser scoped credentials. Attempting to call the API from the browser using  app or account scoped credentials will result in a same-origin policy browser error. For more information, refer  to the Authorization guide.
  ## API pagination and records limits  Some APIs can be paginated by providing the `offset` query string parameter.  The `offset` is the number of initial records to skip before picking records to return (default 0).  The `limit` query string can also be provided to change the number of records to return (maximum 100, default 25).  All paginated endpoints will eventually support cursor pagination and `offset` based pagination support will be dropped.  ### Cursor Pagination  Some APIs are paginated through cursor pagination. Rather than providing an `offset`, a `page[after]` or `page[before]` query string parameter may be provided. `page[after]` and `page[before]` are cursors pointing to a record id.  The `page[after]` cursor indicates that only records **subsequent** to it should be returned.  The `page[before]` cursor indicates that only records **preceding** it should be returned.  **Only one** of `page[after]` or `page[before]` may be provided in a query, not both.  In cursor pagination, the equivalent to the `limit` query string is the `page[size]` query string parameter.  ## Regions  Sunshine Conversations is available in the following regions. Each Sunshine Conversations region has its own API host.  | Region         | Host                       | | -------------- | -------------------------- | | United States  | https://api.smooch.io      | | European Union | https://api.eu-1.smooch.io |    For more information on regions, visit [the guide](/guide/regions/).    When configuring an API host, make sure to always use `https`. Some API clients can have unexpected behaviour when following redirects from `http` to `https`. 
 *
 * The version of the OpenAPI document: 6.0.0-alpha.1
 * Contact: [email protected]
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */


package io.smooch.v2.client.model;

import java.util.Objects;
import java.util.Arrays;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import io.smooch.v2.client.model.Conversation;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.util.ArrayList;
import java.util.List;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;

/**
 * ConversationListResponse
 */
@JsonPropertyOrder({
  ConversationListResponse.JSON_PROPERTY_CONVERSATIONS,
  ConversationListResponse.JSON_PROPERTY_HAS_MORE,
  ConversationListResponse.JSON_PROPERTY_OFFSET
})

public class ConversationListResponse {
  public static final String JSON_PROPERTY_CONVERSATIONS = "conversations";
  private List conversations = null;

  public static final String JSON_PROPERTY_HAS_MORE = "hasMore";
  private Boolean hasMore;

  public static final String JSON_PROPERTY_OFFSET = "offset";
  private Integer offset;


  public ConversationListResponse conversations(List conversations) {
    
    this.conversations = conversations;
    return this;
  }

  public ConversationListResponse addConversationsItem(Conversation conversationsItem) {
    if (this.conversations == null) {
      this.conversations = new ArrayList();
    }
    this.conversations.add(conversationsItem);
    return this;
  }

   /**
   * List of returned conversations.
   * @return conversations
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "List of returned conversations.")
  @JsonProperty(JSON_PROPERTY_CONVERSATIONS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public List getConversations() {
    return conversations;
  }


  public void setConversations(List conversations) {
    this.conversations = conversations;
  }


  public ConversationListResponse hasMore(Boolean hasMore) {
    
    this.hasMore = hasMore;
    return this;
  }

   /**
   * A flag that indicates if there are more records that can be fetched.
   * @return hasMore
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "A flag that indicates if there are more records that can be fetched.")
  @JsonProperty(JSON_PROPERTY_HAS_MORE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Boolean getHasMore() {
    return hasMore;
  }


  public void setHasMore(Boolean hasMore) {
    this.hasMore = hasMore;
  }


  public ConversationListResponse offset(Integer offset) {
    
    this.offset = offset;
    return this;
  }

   /**
   * The offset parameter sent with the request.
   * @return offset
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "The offset parameter sent with the request.")
  @JsonProperty(JSON_PROPERTY_OFFSET)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Integer getOffset() {
    return offset;
  }


  public void setOffset(Integer offset) {
    this.offset = offset;
  }


  @Override
  public boolean equals(java.lang.Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    ConversationListResponse conversationListResponse = (ConversationListResponse) o;
    return Objects.equals(this.conversations, conversationListResponse.conversations) &&
        Objects.equals(this.hasMore, conversationListResponse.hasMore) &&
        Objects.equals(this.offset, conversationListResponse.offset);
  }

  @Override
  public int hashCode() {
    return Objects.hash(conversations, hasMore, offset);
  }


  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class ConversationListResponse {\n");
    sb.append("    conversations: ").append(toIndentedString(conversations)).append("\n");
    sb.append("    hasMore: ").append(toIndentedString(hasMore)).append("\n");
    sb.append("    offset: ").append(toIndentedString(offset)).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    ");
  }

}