io.smooch.v2.client.model.MessageBird 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.IntegrationBase;
import io.smooch.v2.client.model.MessageBirdAllOf;
import io.smooch.v2.client.model.Status;
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;
/**
* MessageBird
*/
@JsonPropertyOrder({
MessageBird.JSON_PROPERTY_ID,
MessageBird.JSON_PROPERTY_TYPE,
MessageBird.JSON_PROPERTY_STATUS,
MessageBird.JSON_PROPERTY_ERROR,
MessageBird.JSON_PROPERTY_DISPLAY_NAME,
MessageBird.JSON_PROPERTY_ACCESS_KEY,
MessageBird.JSON_PROPERTY_SIGNING_KEY,
MessageBird.JSON_PROPERTY_ORIGINATOR,
MessageBird.JSON_PROPERTY_WEBHOOK_SECRET
})
public class MessageBird 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_ACCESS_KEY = "accessKey";
private String accessKey;
public static final String JSON_PROPERTY_SIGNING_KEY = "signingKey";
private String signingKey;
public static final String JSON_PROPERTY_ORIGINATOR = "originator";
private String originator;
public static final String JSON_PROPERTY_WEBHOOK_SECRET = "webhookSecret";
private String webhookSecret;
/**
* 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 MessageBird 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 MessageBird 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 MessageBird 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 MessageBird accessKey(String accessKey) {
this.accessKey = accessKey;
return this;
}
/**
* The public API key of your MessageBird account.
* @return accessKey
**/
@ApiModelProperty(required = true, value = "The public API key of your MessageBird account.")
@JsonProperty(JSON_PROPERTY_ACCESS_KEY)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getAccessKey() {
return accessKey;
}
public void setAccessKey(String accessKey) {
this.accessKey = accessKey;
}
public MessageBird signingKey(String signingKey) {
this.signingKey = signingKey;
return this;
}
/**
* The signing key of your MessageBird account. Used to validate the webhooks' origin.
* @return signingKey
**/
@ApiModelProperty(required = true, value = "The signing key of your MessageBird account. Used to validate the webhooks' origin.")
@JsonProperty(JSON_PROPERTY_SIGNING_KEY)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getSigningKey() {
return signingKey;
}
public void setSigningKey(String signingKey) {
this.signingKey = signingKey;
}
public MessageBird originator(String originator) {
this.originator = originator;
return this;
}
/**
* Sunshine Conversations will receive all messages sent to this phone number.
* @return originator
**/
@ApiModelProperty(required = true, value = "Sunshine Conversations will receive all messages sent to this phone number.")
@JsonProperty(JSON_PROPERTY_ORIGINATOR)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getOriginator() {
return originator;
}
public void setOriginator(String originator) {
this.originator = originator;
}
/**
* The secret that is used to configure webhooks in MessageBird.
* @return webhookSecret
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The secret that is used to configure webhooks in MessageBird.")
@JsonProperty(JSON_PROPERTY_WEBHOOK_SECRET)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getWebhookSecret() {
return webhookSecret;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
MessageBird messageBird = (MessageBird) o;
return Objects.equals(this.id, messageBird.id) &&
Objects.equals(this.type, messageBird.type) &&
Objects.equals(this.status, messageBird.status) &&
Objects.equals(this.error, messageBird.error) &&
Objects.equals(this.displayName, messageBird.displayName) &&
Objects.equals(this.accessKey, messageBird.accessKey) &&
Objects.equals(this.signingKey, messageBird.signingKey) &&
Objects.equals(this.originator, messageBird.originator) &&
Objects.equals(this.webhookSecret, messageBird.webhookSecret);
}
@Override
public int hashCode() {
return Objects.hash(id, type, status, error, displayName, accessKey, signingKey, originator, webhookSecret);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class MessageBird {\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(" accessKey: ").append(toIndentedString(accessKey)).append("\n");
sb.append(" signingKey: ").append(toIndentedString(signingKey)).append("\n");
sb.append(" originator: ").append(toIndentedString(originator)).append("\n");
sb.append(" webhookSecret: ").append(toIndentedString(webhookSecret)).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 ");
}
}