io.smooch.v2.client.model.Page Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
Show all versions of api Show documentation
io.smooch - api - 6.0.0-alpha.7
/*
* Sunshine Conversations API
* # # 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. ## 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/).
*
* The version of the OpenAPI document: 6.0.0-alpha.2
* 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.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
/**
* Page
*/
@JsonPropertyOrder({
Page.JSON_PROPERTY_AFTER,
Page.JSON_PROPERTY_BEFORE,
Page.JSON_PROPERTY_SIZE
})
public class Page {
public static final String JSON_PROPERTY_AFTER = "after";
private String after;
public static final String JSON_PROPERTY_BEFORE = "before";
private String before;
public static final String JSON_PROPERTY_SIZE = "size";
private Integer size = 25;
public Page after(String after) {
this.after = after;
return this;
}
/**
* A record id. Results will only contain the records that come after the specified record. Only one of `after` or `before` can be provided, not both.
* @return after
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "5e1606762556d93e9c176f69", value = "A record id. Results will only contain the records that come after the specified record. Only one of `after` or `before` can be provided, not both. ")
@JsonProperty(JSON_PROPERTY_AFTER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getAfter() {
return after;
}
public void setAfter(String after) {
this.after = after;
}
public Page before(String before) {
this.before = before;
return this;
}
/**
* A record id. Results will only contain the records that come before the specified record. Only one of `after` or `before` can be provided, not both.
* @return before
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "5e1606762556d93e9c176f69", value = "A record id. Results will only contain the records that come before the specified record. Only one of `after` or `before` can be provided, not both. ")
@JsonProperty(JSON_PROPERTY_BEFORE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getBefore() {
return before;
}
public void setBefore(String before) {
this.before = before;
}
public Page size(Integer size) {
this.size = size;
return this;
}
/**
* The number of records to return.
* minimum: 0
* maximum: 100
* @return size
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "10", value = "The number of records to return.")
@JsonProperty(JSON_PROPERTY_SIZE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Integer getSize() {
return size;
}
public void setSize(Integer size) {
this.size = size;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Page page = (Page) o;
return Objects.equals(this.after, page.after) &&
Objects.equals(this.before, page.before) &&
Objects.equals(this.size, page.size);
}
@Override
public int hashCode() {
return Objects.hash(after, before, size);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class Page {\n");
sb.append(" after: ").append(toIndentedString(after)).append("\n");
sb.append(" before: ").append(toIndentedString(before)).append("\n");
sb.append(" size: ").append(toIndentedString(size)).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 ");
}
}