com.bandwidth.sdk.model.Message Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of bandwidth-sdk Show documentation
Show all versions of bandwidth-sdk Show documentation
The official client SDK for Bandwidth's Voice, Messaging, MFA, and WebRTC APIs
The newest version!
/*
* Bandwidth
* Bandwidth's Communication APIs
*
* The version of the OpenAPI document: 1.0.0
* 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 com.bandwidth.sdk.model;
import java.util.Objects;
import com.bandwidth.sdk.model.MessageDirectionEnum;
import com.bandwidth.sdk.model.PriorityEnum;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import java.io.IOException;
import java.time.OffsetDateTime;
import java.util.Arrays;
import java.util.LinkedHashSet;
import java.util.Set;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonArray;
import com.google.gson.JsonDeserializationContext;
import com.google.gson.JsonDeserializer;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonParseException;
import com.google.gson.TypeAdapterFactory;
import com.google.gson.reflect.TypeToken;
import com.google.gson.TypeAdapter;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import java.io.IOException;
import java.lang.reflect.Type;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import com.bandwidth.sdk.JSON;
/**
* Message
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class Message {
public static final String SERIALIZED_NAME_ID = "id";
@SerializedName(SERIALIZED_NAME_ID)
private String id;
public static final String SERIALIZED_NAME_OWNER = "owner";
@SerializedName(SERIALIZED_NAME_OWNER)
private String owner;
public static final String SERIALIZED_NAME_APPLICATION_ID = "applicationId";
@SerializedName(SERIALIZED_NAME_APPLICATION_ID)
private String applicationId;
public static final String SERIALIZED_NAME_TIME = "time";
@SerializedName(SERIALIZED_NAME_TIME)
private OffsetDateTime time;
public static final String SERIALIZED_NAME_SEGMENT_COUNT = "segmentCount";
@SerializedName(SERIALIZED_NAME_SEGMENT_COUNT)
private Integer segmentCount;
public static final String SERIALIZED_NAME_DIRECTION = "direction";
@SerializedName(SERIALIZED_NAME_DIRECTION)
private MessageDirectionEnum direction;
public static final String SERIALIZED_NAME_TO = "to";
@SerializedName(SERIALIZED_NAME_TO)
private Set to = new LinkedHashSet<>();
public static final String SERIALIZED_NAME_FROM = "from";
@SerializedName(SERIALIZED_NAME_FROM)
private String from;
public static final String SERIALIZED_NAME_MEDIA = "media";
@SerializedName(SERIALIZED_NAME_MEDIA)
private Set media = new LinkedHashSet<>();
public static final String SERIALIZED_NAME_TEXT = "text";
@SerializedName(SERIALIZED_NAME_TEXT)
private String text;
public static final String SERIALIZED_NAME_TAG = "tag";
@SerializedName(SERIALIZED_NAME_TAG)
private String tag;
public static final String SERIALIZED_NAME_PRIORITY = "priority";
@SerializedName(SERIALIZED_NAME_PRIORITY)
private PriorityEnum priority;
public static final String SERIALIZED_NAME_EXPIRATION = "expiration";
@SerializedName(SERIALIZED_NAME_EXPIRATION)
private OffsetDateTime expiration;
public Message() {
}
public Message id(String id) {
this.id = id;
return this;
}
/**
* The id of the message.
* @return id
**/
@javax.annotation.Nullable
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public Message owner(String owner) {
this.owner = owner;
return this;
}
/**
* The Bandwidth phone number associated with the message.
* @return owner
**/
@javax.annotation.Nullable
public String getOwner() {
return owner;
}
public void setOwner(String owner) {
this.owner = owner;
}
public Message applicationId(String applicationId) {
this.applicationId = applicationId;
return this;
}
/**
* The application ID associated with the message.
* @return applicationId
**/
@javax.annotation.Nullable
public String getApplicationId() {
return applicationId;
}
public void setApplicationId(String applicationId) {
this.applicationId = applicationId;
}
public Message time(OffsetDateTime time) {
this.time = time;
return this;
}
/**
* The datetime stamp of the message in ISO 8601
* @return time
**/
@javax.annotation.Nullable
public OffsetDateTime getTime() {
return time;
}
public void setTime(OffsetDateTime time) {
this.time = time;
}
public Message segmentCount(Integer segmentCount) {
this.segmentCount = segmentCount;
return this;
}
/**
* The number of segments the original message from the user is broken into before sending over to carrier networks.
* @return segmentCount
**/
@javax.annotation.Nullable
public Integer getSegmentCount() {
return segmentCount;
}
public void setSegmentCount(Integer segmentCount) {
this.segmentCount = segmentCount;
}
public Message direction(MessageDirectionEnum direction) {
this.direction = direction;
return this;
}
/**
* Get direction
* @return direction
**/
@javax.annotation.Nullable
public MessageDirectionEnum getDirection() {
return direction;
}
public void setDirection(MessageDirectionEnum direction) {
this.direction = direction;
}
public Message to(Set to) {
this.to = to;
return this;
}
public Message addToItem(String toItem) {
if (this.to == null) {
this.to = new LinkedHashSet<>();
}
this.to.add(toItem);
return this;
}
/**
* The phone number recipients of the message.
* @return to
**/
@javax.annotation.Nullable
public Set getTo() {
return to;
}
public void setTo(Set to) {
this.to = to;
}
public Message from(String from) {
this.from = from;
return this;
}
/**
* The phone number the message was sent from.
* @return from
**/
@javax.annotation.Nullable
public String getFrom() {
return from;
}
public void setFrom(String from) {
this.from = from;
}
public Message media(Set media) {
this.media = media;
return this;
}
public Message addMediaItem(String mediaItem) {
if (this.media == null) {
this.media = new LinkedHashSet<>();
}
this.media.add(mediaItem);
return this;
}
/**
* The list of media URLs sent in the message. Including a `filename` field in the `Content-Disposition` header of the media linked with a URL will set the displayed file name. This is a best practice to ensure that your media has a readable file name.
* @return media
**/
@javax.annotation.Nullable
public Set getMedia() {
return media;
}
public void setMedia(Set media) {
this.media = media;
}
public Message text(String text) {
this.text = text;
return this;
}
/**
* The contents of the message.
* @return text
**/
@javax.annotation.Nullable
public String getText() {
return text;
}
public void setText(String text) {
this.text = text;
}
public Message tag(String tag) {
this.tag = tag;
return this;
}
/**
* The custom string set by the user.
* @return tag
**/
@javax.annotation.Nullable
public String getTag() {
return tag;
}
public void setTag(String tag) {
this.tag = tag;
}
public Message priority(PriorityEnum priority) {
this.priority = priority;
return this;
}
/**
* Get priority
* @return priority
**/
@javax.annotation.Nullable
public PriorityEnum getPriority() {
return priority;
}
public void setPriority(PriorityEnum priority) {
this.priority = priority;
}
public Message expiration(OffsetDateTime expiration) {
this.expiration = expiration;
return this;
}
/**
* The expiration date-time set by the user.
* @return expiration
**/
@javax.annotation.Nullable
public OffsetDateTime getExpiration() {
return expiration;
}
public void setExpiration(OffsetDateTime expiration) {
this.expiration = expiration;
}
/**
* A container for additional, undeclared properties.
* This is a holder for any undeclared properties as specified with
* the 'additionalProperties' keyword in the OAS document.
*/
private Map additionalProperties;
/**
* Set the additional (undeclared) property with the specified name and value.
* If the property does not already exist, create it otherwise replace it.
*
* @param key name of the property
* @param value value of the property
* @return the Message instance itself
*/
public Message putAdditionalProperty(String key, Object value) {
if (this.additionalProperties == null) {
this.additionalProperties = new HashMap();
}
this.additionalProperties.put(key, value);
return this;
}
/**
* Return the additional (undeclared) property.
*
* @return a map of objects
*/
public Map getAdditionalProperties() {
return additionalProperties;
}
/**
* Return the additional (undeclared) property with the specified name.
*
* @param key name of the property
* @return an object
*/
public Object getAdditionalProperty(String key) {
if (this.additionalProperties == null) {
return null;
}
return this.additionalProperties.get(key);
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Message message = (Message) o;
return Objects.equals(this.id, message.id) &&
Objects.equals(this.owner, message.owner) &&
Objects.equals(this.applicationId, message.applicationId) &&
Objects.equals(this.time, message.time) &&
Objects.equals(this.segmentCount, message.segmentCount) &&
Objects.equals(this.direction, message.direction) &&
Objects.equals(this.to, message.to) &&
Objects.equals(this.from, message.from) &&
Objects.equals(this.media, message.media) &&
Objects.equals(this.text, message.text) &&
Objects.equals(this.tag, message.tag) &&
Objects.equals(this.priority, message.priority) &&
Objects.equals(this.expiration, message.expiration)&&
Objects.equals(this.additionalProperties, message.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(id, owner, applicationId, time, segmentCount, direction, to, from, media, text, tag, priority, expiration, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class Message {\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" owner: ").append(toIndentedString(owner)).append("\n");
sb.append(" applicationId: ").append(toIndentedString(applicationId)).append("\n");
sb.append(" time: ").append(toIndentedString(time)).append("\n");
sb.append(" segmentCount: ").append(toIndentedString(segmentCount)).append("\n");
sb.append(" direction: ").append(toIndentedString(direction)).append("\n");
sb.append(" to: ").append(toIndentedString(to)).append("\n");
sb.append(" from: ").append(toIndentedString(from)).append("\n");
sb.append(" media: ").append(toIndentedString(media)).append("\n");
sb.append(" text: ").append(toIndentedString(text)).append("\n");
sb.append(" tag: ").append(toIndentedString(tag)).append("\n");
sb.append(" priority: ").append(toIndentedString(priority)).append("\n");
sb.append(" expiration: ").append(toIndentedString(expiration)).append("\n");
sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).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(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
public static HashSet openapiFields;
public static HashSet openapiRequiredFields;
static {
// a set of all properties/fields (JSON key names)
openapiFields = new HashSet();
openapiFields.add("id");
openapiFields.add("owner");
openapiFields.add("applicationId");
openapiFields.add("time");
openapiFields.add("segmentCount");
openapiFields.add("direction");
openapiFields.add("to");
openapiFields.add("from");
openapiFields.add("media");
openapiFields.add("text");
openapiFields.add("tag");
openapiFields.add("priority");
openapiFields.add("expiration");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
}
/**
* Validates the JSON Element and throws an exception if issues found
*
* @param jsonElement JSON Element
* @throws IOException if the JSON Element is invalid with respect to Message
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!Message.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in Message is not found in the empty JSON string", Message.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("id") != null && !jsonObj.get("id").isJsonNull()) && !jsonObj.get("id").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `id` to be a primitive type in the JSON string but got `%s`", jsonObj.get("id").toString()));
}
if ((jsonObj.get("owner") != null && !jsonObj.get("owner").isJsonNull()) && !jsonObj.get("owner").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `owner` to be a primitive type in the JSON string but got `%s`", jsonObj.get("owner").toString()));
}
if ((jsonObj.get("applicationId") != null && !jsonObj.get("applicationId").isJsonNull()) && !jsonObj.get("applicationId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `applicationId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("applicationId").toString()));
}
// validate the optional field `direction`
if (jsonObj.get("direction") != null && !jsonObj.get("direction").isJsonNull()) {
MessageDirectionEnum.validateJsonElement(jsonObj.get("direction"));
}
// ensure the optional json data is an array if present
if (jsonObj.get("to") != null && !jsonObj.get("to").isJsonNull() && !jsonObj.get("to").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `to` to be an array in the JSON string but got `%s`", jsonObj.get("to").toString()));
}
if ((jsonObj.get("from") != null && !jsonObj.get("from").isJsonNull()) && !jsonObj.get("from").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `from` to be a primitive type in the JSON string but got `%s`", jsonObj.get("from").toString()));
}
// ensure the optional json data is an array if present
if (jsonObj.get("media") != null && !jsonObj.get("media").isJsonNull() && !jsonObj.get("media").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `media` to be an array in the JSON string but got `%s`", jsonObj.get("media").toString()));
}
if ((jsonObj.get("text") != null && !jsonObj.get("text").isJsonNull()) && !jsonObj.get("text").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `text` to be a primitive type in the JSON string but got `%s`", jsonObj.get("text").toString()));
}
if ((jsonObj.get("tag") != null && !jsonObj.get("tag").isJsonNull()) && !jsonObj.get("tag").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `tag` to be a primitive type in the JSON string but got `%s`", jsonObj.get("tag").toString()));
}
// validate the optional field `priority`
if (jsonObj.get("priority") != null && !jsonObj.get("priority").isJsonNull()) {
PriorityEnum.validateJsonElement(jsonObj.get("priority"));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!Message.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'Message' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(Message.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, Message value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
obj.remove("additionalProperties");
// serialize additional properties
if (value.getAdditionalProperties() != null) {
for (Map.Entry entry : value.getAdditionalProperties().entrySet()) {
if (entry.getValue() instanceof String)
obj.addProperty(entry.getKey(), (String) entry.getValue());
else if (entry.getValue() instanceof Number)
obj.addProperty(entry.getKey(), (Number) entry.getValue());
else if (entry.getValue() instanceof Boolean)
obj.addProperty(entry.getKey(), (Boolean) entry.getValue());
else if (entry.getValue() instanceof Character)
obj.addProperty(entry.getKey(), (Character) entry.getValue());
else {
JsonElement jsonElement = gson.toJsonTree(entry.getValue());
if (jsonElement.isJsonArray()) {
obj.add(entry.getKey(), jsonElement.getAsJsonArray());
} else {
obj.add(entry.getKey(), jsonElement.getAsJsonObject());
}
}
}
}
elementAdapter.write(out, obj);
}
@Override
public Message read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
Message instance = thisAdapter.fromJsonTree(jsonObj);
for (Map.Entry entry : jsonObj.entrySet()) {
if (!openapiFields.contains(entry.getKey())) {
if (entry.getValue().isJsonPrimitive()) { // primitive type
if (entry.getValue().getAsJsonPrimitive().isString())
instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString());
else if (entry.getValue().getAsJsonPrimitive().isNumber())
instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber());
else if (entry.getValue().getAsJsonPrimitive().isBoolean())
instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean());
else
throw new IllegalArgumentException(String.format("The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString()));
} else if (entry.getValue().isJsonArray()) {
instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class));
} else { // JSON object
instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class));
}
}
}
return instance;
}
}.nullSafe();
}
}
/**
* Create an instance of Message given an JSON string
*
* @param jsonString JSON string
* @return An instance of Message
* @throws IOException if the JSON string is invalid with respect to Message
*/
public static Message fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, Message.class);
}
/**
* Convert an instance of Message to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}