io.smooch.v2.client.model.Custom 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.smooch.v2.client.model.CustomAllOf;
import io.smooch.v2.client.model.IntegrationBase;
import io.smooch.v2.client.model.Status;
import io.smooch.v2.client.model.Webhook;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import com.fasterxml.jackson.annotation.JsonIgnore;
import org.openapitools.jackson.nullable.JsonNullable;
import java.util.NoSuchElementException;
import io.smooch.v2.client.model.Integration;
import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import java.util.ArrayList;
import java.util.List;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
/**
* Custom
*/
@JsonPropertyOrder({
Custom.JSON_PROPERTY_ID,
Custom.JSON_PROPERTY_TYPE,
Custom.JSON_PROPERTY_STATUS,
Custom.JSON_PROPERTY_ERROR,
Custom.JSON_PROPERTY_DISPLAY_NAME,
Custom.JSON_PROPERTY_WEBHOOK
})
public class Custom implements Integration {
public static final String JSON_PROPERTY_ID = "id";
private String id;
public static final String JSON_PROPERTY_TYPE = "type";
private String type;
public static final String JSON_PROPERTY_STATUS = "status";
private Status status;
public static final String JSON_PROPERTY_ERROR = "error";
private JsonNullable error = JsonNullable.undefined();
public static final String JSON_PROPERTY_DISPLAY_NAME = "displayName";
private JsonNullable displayName = JsonNullable.undefined();
public static final String JSON_PROPERTY_WEBHOOK = "webhook";
private Webhook webhook = null;
/**
* The unique ID of the integration.
* @return id
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The unique ID of the integration.")
@JsonProperty(JSON_PROPERTY_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getId() {
return id;
}
public Custom type(String type) {
this.type = type;
return this;
}
/**
* The type of integration.
* @return type
**/
@ApiModelProperty(required = true, value = "The type of integration.")
@JsonProperty(JSON_PROPERTY_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getType() {
return type;
}
public void setType(String type) {
this.type = type;
}
public Custom status(Status status) {
this.status = status;
return this;
}
/**
* Get status
* @return status
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_STATUS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Status getStatus() {
return status;
}
public void setStatus(Status status) {
this.status = status;
}
/**
* If the integration status is error, contains a description of the problem.
* @return error
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "If the integration status is error, contains a description of the problem.")
@JsonIgnore
public String getError() {
if (error == null) {
error = JsonNullable.undefined();
}
return error.orElse(null);
}
@JsonProperty(JSON_PROPERTY_ERROR)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public JsonNullable getError_JsonNullable() {
return error;
}
@JsonProperty(JSON_PROPERTY_ERROR)
private void setError_JsonNullable(JsonNullable error) {
this.error = error;
}
public Custom displayName(String displayName) {
this.displayName = JsonNullable.of(displayName);
return this;
}
/**
* A human-friendly name used to identify the integration.
* @return displayName
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "Channel name", value = "A human-friendly name used to identify the integration.")
@JsonIgnore
public String getDisplayName() {
return displayName.orElse(null);
}
@JsonProperty(JSON_PROPERTY_DISPLAY_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public JsonNullable getDisplayName_JsonNullable() {
return displayName;
}
@JsonProperty(JSON_PROPERTY_DISPLAY_NAME)
public void setDisplayName_JsonNullable(JsonNullable displayName) {
this.displayName = displayName;
}
public void setDisplayName(String displayName) {
this.displayName = JsonNullable.of(displayName);
}
public Custom webhook(Webhook webhook) {
this.webhook = webhook;
return this;
}
/**
* The webhook associated with the integration.
* @return webhook
**/
@ApiModelProperty(required = true, value = "The webhook associated with the integration.")
@JsonProperty(JSON_PROPERTY_WEBHOOK)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public Webhook getWebhook() {
return webhook;
}
public void setWebhook(Webhook webhook) {
this.webhook = webhook;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Custom custom = (Custom) o;
return Objects.equals(this.id, custom.id) &&
Objects.equals(this.type, custom.type) &&
Objects.equals(this.status, custom.status) &&
Objects.equals(this.error, custom.error) &&
Objects.equals(this.displayName, custom.displayName) &&
Objects.equals(this.webhook, custom.webhook);
}
@Override
public int hashCode() {
return Objects.hash(id, type, status, error, displayName, webhook);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class Custom {\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" type: ").append(toIndentedString(type)).append("\n");
sb.append(" status: ").append(toIndentedString(status)).append("\n");
sb.append(" error: ").append(toIndentedString(error)).append("\n");
sb.append(" displayName: ").append(toIndentedString(displayName)).append("\n");
sb.append(" webhook: ").append(toIndentedString(webhook)).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 ");
}
}