com.bandwidth.sdk.model.UpdateCall 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.CallStateEnum;
import com.bandwidth.sdk.model.RedirectMethodEnum;
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.net.URI;
import java.util.Arrays;
import org.openapitools.jackson.nullable.JsonNullable;
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;
/**
* UpdateCall
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class UpdateCall {
public static final String SERIALIZED_NAME_STATE = "state";
@SerializedName(SERIALIZED_NAME_STATE)
private CallStateEnum state = CallStateEnum.ACTIVE;
public static final String SERIALIZED_NAME_REDIRECT_URL = "redirectUrl";
@SerializedName(SERIALIZED_NAME_REDIRECT_URL)
private URI redirectUrl;
public static final String SERIALIZED_NAME_REDIRECT_METHOD = "redirectMethod";
@SerializedName(SERIALIZED_NAME_REDIRECT_METHOD)
private RedirectMethodEnum redirectMethod = RedirectMethodEnum.POST;
public static final String SERIALIZED_NAME_USERNAME = "username";
@SerializedName(SERIALIZED_NAME_USERNAME)
private String username;
public static final String SERIALIZED_NAME_PASSWORD = "password";
@SerializedName(SERIALIZED_NAME_PASSWORD)
private String password;
public static final String SERIALIZED_NAME_REDIRECT_FALLBACK_URL = "redirectFallbackUrl";
@SerializedName(SERIALIZED_NAME_REDIRECT_FALLBACK_URL)
private URI redirectFallbackUrl;
public static final String SERIALIZED_NAME_REDIRECT_FALLBACK_METHOD = "redirectFallbackMethod";
@SerializedName(SERIALIZED_NAME_REDIRECT_FALLBACK_METHOD)
private RedirectMethodEnum redirectFallbackMethod = RedirectMethodEnum.POST;
public static final String SERIALIZED_NAME_FALLBACK_USERNAME = "fallbackUsername";
@SerializedName(SERIALIZED_NAME_FALLBACK_USERNAME)
private String fallbackUsername;
public static final String SERIALIZED_NAME_FALLBACK_PASSWORD = "fallbackPassword";
@SerializedName(SERIALIZED_NAME_FALLBACK_PASSWORD)
private String fallbackPassword;
public static final String SERIALIZED_NAME_TAG = "tag";
@SerializedName(SERIALIZED_NAME_TAG)
private String tag;
public UpdateCall() {
}
public UpdateCall state(CallStateEnum state) {
this.state = state;
return this;
}
/**
* Get state
* @return state
**/
@javax.annotation.Nullable
public CallStateEnum getState() {
return state;
}
public void setState(CallStateEnum state) {
this.state = state;
}
public UpdateCall redirectUrl(URI redirectUrl) {
this.redirectUrl = redirectUrl;
return this;
}
/**
* The URL to send the [Redirect](/docs/voice/bxml/redirect) event to which will provide new BXML. Required if `state` is `active`. Not allowed if `state` is `completed`.
* @return redirectUrl
**/
@javax.annotation.Nullable
public URI getRedirectUrl() {
return redirectUrl;
}
public void setRedirectUrl(URI redirectUrl) {
this.redirectUrl = redirectUrl;
}
public UpdateCall redirectMethod(RedirectMethodEnum redirectMethod) {
this.redirectMethod = redirectMethod;
return this;
}
/**
* Get redirectMethod
* @return redirectMethod
**/
@javax.annotation.Nullable
public RedirectMethodEnum getRedirectMethod() {
return redirectMethod;
}
public void setRedirectMethod(RedirectMethodEnum redirectMethod) {
this.redirectMethod = redirectMethod;
}
public UpdateCall username(String username) {
this.username = username;
return this;
}
/**
* Basic auth username.
* @return username
**/
@javax.annotation.Nullable
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public UpdateCall password(String password) {
this.password = password;
return this;
}
/**
* Basic auth password.
* @return password
**/
@javax.annotation.Nullable
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
public UpdateCall redirectFallbackUrl(URI redirectFallbackUrl) {
this.redirectFallbackUrl = redirectFallbackUrl;
return this;
}
/**
* A fallback url which, if provided, will be used to retry the redirect callback delivery in case `redirectUrl` fails to respond.
* @return redirectFallbackUrl
**/
@javax.annotation.Nullable
public URI getRedirectFallbackUrl() {
return redirectFallbackUrl;
}
public void setRedirectFallbackUrl(URI redirectFallbackUrl) {
this.redirectFallbackUrl = redirectFallbackUrl;
}
public UpdateCall redirectFallbackMethod(RedirectMethodEnum redirectFallbackMethod) {
this.redirectFallbackMethod = redirectFallbackMethod;
return this;
}
/**
* Get redirectFallbackMethod
* @return redirectFallbackMethod
**/
@javax.annotation.Nullable
public RedirectMethodEnum getRedirectFallbackMethod() {
return redirectFallbackMethod;
}
public void setRedirectFallbackMethod(RedirectMethodEnum redirectFallbackMethod) {
this.redirectFallbackMethod = redirectFallbackMethod;
}
public UpdateCall fallbackUsername(String fallbackUsername) {
this.fallbackUsername = fallbackUsername;
return this;
}
/**
* Basic auth username.
* @return fallbackUsername
**/
@javax.annotation.Nullable
public String getFallbackUsername() {
return fallbackUsername;
}
public void setFallbackUsername(String fallbackUsername) {
this.fallbackUsername = fallbackUsername;
}
public UpdateCall fallbackPassword(String fallbackPassword) {
this.fallbackPassword = fallbackPassword;
return this;
}
/**
* Basic auth password.
* @return fallbackPassword
**/
@javax.annotation.Nullable
public String getFallbackPassword() {
return fallbackPassword;
}
public void setFallbackPassword(String fallbackPassword) {
this.fallbackPassword = fallbackPassword;
}
public UpdateCall tag(String tag) {
this.tag = tag;
return this;
}
/**
* A custom string that will be sent with this and all future callbacks unless overwritten by a future `tag` attribute or [`<Tag>`](/docs/voice/bxml/tag) verb, or cleared. May be cleared by setting `tag=\"\"`. Max length 256 characters. Not allowed if `state` is `completed`.
* @return tag
**/
@javax.annotation.Nullable
public String getTag() {
return tag;
}
public void setTag(String tag) {
this.tag = tag;
}
/**
* 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 UpdateCall instance itself
*/
public UpdateCall 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;
}
UpdateCall updateCall = (UpdateCall) o;
return Objects.equals(this.state, updateCall.state) &&
Objects.equals(this.redirectUrl, updateCall.redirectUrl) &&
Objects.equals(this.redirectMethod, updateCall.redirectMethod) &&
Objects.equals(this.username, updateCall.username) &&
Objects.equals(this.password, updateCall.password) &&
Objects.equals(this.redirectFallbackUrl, updateCall.redirectFallbackUrl) &&
Objects.equals(this.redirectFallbackMethod, updateCall.redirectFallbackMethod) &&
Objects.equals(this.fallbackUsername, updateCall.fallbackUsername) &&
Objects.equals(this.fallbackPassword, updateCall.fallbackPassword) &&
Objects.equals(this.tag, updateCall.tag)&&
Objects.equals(this.additionalProperties, updateCall.additionalProperties);
}
private static boolean equalsNullable(JsonNullable a, JsonNullable b) {
return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get()));
}
@Override
public int hashCode() {
return Objects.hash(state, redirectUrl, redirectMethod, username, password, redirectFallbackUrl, redirectFallbackMethod, fallbackUsername, fallbackPassword, tag, additionalProperties);
}
private static int hashCodeNullable(JsonNullable a) {
if (a == null) {
return 1;
}
return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31;
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class UpdateCall {\n");
sb.append(" state: ").append(toIndentedString(state)).append("\n");
sb.append(" redirectUrl: ").append(toIndentedString(redirectUrl)).append("\n");
sb.append(" redirectMethod: ").append(toIndentedString(redirectMethod)).append("\n");
sb.append(" username: ").append(toIndentedString(username)).append("\n");
sb.append(" password: ").append(toIndentedString(password)).append("\n");
sb.append(" redirectFallbackUrl: ").append(toIndentedString(redirectFallbackUrl)).append("\n");
sb.append(" redirectFallbackMethod: ").append(toIndentedString(redirectFallbackMethod)).append("\n");
sb.append(" fallbackUsername: ").append(toIndentedString(fallbackUsername)).append("\n");
sb.append(" fallbackPassword: ").append(toIndentedString(fallbackPassword)).append("\n");
sb.append(" tag: ").append(toIndentedString(tag)).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("state");
openapiFields.add("redirectUrl");
openapiFields.add("redirectMethod");
openapiFields.add("username");
openapiFields.add("password");
openapiFields.add("redirectFallbackUrl");
openapiFields.add("redirectFallbackMethod");
openapiFields.add("fallbackUsername");
openapiFields.add("fallbackPassword");
openapiFields.add("tag");
// 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 UpdateCall
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!UpdateCall.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in UpdateCall is not found in the empty JSON string", UpdateCall.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
// validate the optional field `state`
if (jsonObj.get("state") != null && !jsonObj.get("state").isJsonNull()) {
CallStateEnum.validateJsonElement(jsonObj.get("state"));
}
if ((jsonObj.get("redirectUrl") != null && !jsonObj.get("redirectUrl").isJsonNull()) && !jsonObj.get("redirectUrl").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `redirectUrl` to be a primitive type in the JSON string but got `%s`", jsonObj.get("redirectUrl").toString()));
}
// validate the optional field `redirectMethod`
if (jsonObj.get("redirectMethod") != null && !jsonObj.get("redirectMethod").isJsonNull()) {
RedirectMethodEnum.validateJsonElement(jsonObj.get("redirectMethod"));
}
if ((jsonObj.get("username") != null && !jsonObj.get("username").isJsonNull()) && !jsonObj.get("username").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `username` to be a primitive type in the JSON string but got `%s`", jsonObj.get("username").toString()));
}
if ((jsonObj.get("password") != null && !jsonObj.get("password").isJsonNull()) && !jsonObj.get("password").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `password` to be a primitive type in the JSON string but got `%s`", jsonObj.get("password").toString()));
}
if ((jsonObj.get("redirectFallbackUrl") != null && !jsonObj.get("redirectFallbackUrl").isJsonNull()) && !jsonObj.get("redirectFallbackUrl").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `redirectFallbackUrl` to be a primitive type in the JSON string but got `%s`", jsonObj.get("redirectFallbackUrl").toString()));
}
// validate the optional field `redirectFallbackMethod`
if (jsonObj.get("redirectFallbackMethod") != null && !jsonObj.get("redirectFallbackMethod").isJsonNull()) {
RedirectMethodEnum.validateJsonElement(jsonObj.get("redirectFallbackMethod"));
}
if ((jsonObj.get("fallbackUsername") != null && !jsonObj.get("fallbackUsername").isJsonNull()) && !jsonObj.get("fallbackUsername").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `fallbackUsername` to be a primitive type in the JSON string but got `%s`", jsonObj.get("fallbackUsername").toString()));
}
if ((jsonObj.get("fallbackPassword") != null && !jsonObj.get("fallbackPassword").isJsonNull()) && !jsonObj.get("fallbackPassword").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `fallbackPassword` to be a primitive type in the JSON string but got `%s`", jsonObj.get("fallbackPassword").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()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!UpdateCall.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'UpdateCall' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(UpdateCall.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, UpdateCall 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 UpdateCall read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
UpdateCall 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 UpdateCall given an JSON string
*
* @param jsonString JSON string
* @return An instance of UpdateCall
* @throws IOException if the JSON string is invalid with respect to UpdateCall
*/
public static UpdateCall fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, UpdateCall.class);
}
/**
* Convert an instance of UpdateCall to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}