io.smooch.v2.client.model.CarouselMessageDisplaySettings 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.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.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
/**
* Settings to adjust the carousel layout.
*/
@ApiModel(description = "Settings to adjust the carousel layout.")
@JsonPropertyOrder({
CarouselMessageDisplaySettings.JSON_PROPERTY_IMAGE_ASPECT_RATIO
})
public class CarouselMessageDisplaySettings {
/**
* Specifies how to display all carousel images. Valid values are horizontal (default) and square. Only supported in Facebook Messenger, Web Messenger, Android SDK and iOS SDK carousels.
*/
public enum ImageAspectRatioEnum {
HORIZONTAL("horizontal"),
SQUARE("square");
private String value;
ImageAspectRatioEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static ImageAspectRatioEnum fromValue(String value) {
for (ImageAspectRatioEnum b : ImageAspectRatioEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_IMAGE_ASPECT_RATIO = "imageAspectRatio";
private ImageAspectRatioEnum imageAspectRatio;
public CarouselMessageDisplaySettings imageAspectRatio(ImageAspectRatioEnum imageAspectRatio) {
this.imageAspectRatio = imageAspectRatio;
return this;
}
/**
* Specifies how to display all carousel images. Valid values are horizontal (default) and square. Only supported in Facebook Messenger, Web Messenger, Android SDK and iOS SDK carousels.
* @return imageAspectRatio
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "Specifies how to display all carousel images. Valid values are horizontal (default) and square. Only supported in Facebook Messenger, Web Messenger, Android SDK and iOS SDK carousels.")
@JsonProperty(JSON_PROPERTY_IMAGE_ASPECT_RATIO)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public ImageAspectRatioEnum getImageAspectRatio() {
return imageAspectRatio;
}
public void setImageAspectRatio(ImageAspectRatioEnum imageAspectRatio) {
this.imageAspectRatio = imageAspectRatio;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
CarouselMessageDisplaySettings carouselMessageDisplaySettings = (CarouselMessageDisplaySettings) o;
return Objects.equals(this.imageAspectRatio, carouselMessageDisplaySettings.imageAspectRatio);
}
@Override
public int hashCode() {
return Objects.hash(imageAspectRatio);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class CarouselMessageDisplaySettings {\n");
sb.append(" imageAspectRatio: ").append(toIndentedString(imageAspectRatio)).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 ");
}
}