com.zuora.model.OrderActionChangePlan Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of zuora-sdk-java Show documentation
Show all versions of zuora-sdk-java Show documentation
The SDK of JAVA language for Zuora pricing system
/*
* Zuora API Reference
* REST API reference for the Zuora Billing, Payments, and Central Platform! Check out the [REST API Overview](https://www.zuora.com/developer/api-references/api/overview/).
*
* The version of the OpenAPI document: 2024-05-20
* 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.zuora.model;
import java.util.Objects;
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 com.zuora.model.ChangePlanEffectivePolicy;
import com.zuora.model.ChangePlanRatePlanOverride;
import com.zuora.model.ChangePlanSubType;
import java.io.IOException;
import java.util.Arrays;
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.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import com.zuora.JSON;
/**
* Information about an order action of type `ChangePlan`. **Note**: The change plan type of order action is currently not supported for Billing - Revenue Integration. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing.
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class OrderActionChangePlan {
public static final String SERIALIZED_NAME_EFFECTIVE_POLICY = "effectivePolicy";
@SerializedName(SERIALIZED_NAME_EFFECTIVE_POLICY)
private ChangePlanEffectivePolicy effectivePolicy;
public static final String SERIALIZED_NAME_NEW_PRODUCT_RATE_PLAN = "newProductRatePlan";
@SerializedName(SERIALIZED_NAME_NEW_PRODUCT_RATE_PLAN)
private ChangePlanRatePlanOverride newProductRatePlan;
public static final String SERIALIZED_NAME_PRODUCT_RATE_PLAN_ID = "productRatePlanId";
@SerializedName(SERIALIZED_NAME_PRODUCT_RATE_PLAN_ID)
private String productRatePlanId;
public static final String SERIALIZED_NAME_PRODUCT_RATE_PLAN_NUMBER = "productRatePlanNumber";
@SerializedName(SERIALIZED_NAME_PRODUCT_RATE_PLAN_NUMBER)
private String productRatePlanNumber;
public static final String SERIALIZED_NAME_RATE_PLAN_ID = "ratePlanId";
@SerializedName(SERIALIZED_NAME_RATE_PLAN_ID)
private String ratePlanId;
public static final String SERIALIZED_NAME_SUB_TYPE = "subType";
@SerializedName(SERIALIZED_NAME_SUB_TYPE)
private ChangePlanSubType subType;
public static final String SERIALIZED_NAME_SUBSCRIPTION_RATE_PLAN_NUMBER = "subscriptionRatePlanNumber";
@SerializedName(SERIALIZED_NAME_SUBSCRIPTION_RATE_PLAN_NUMBER)
private String subscriptionRatePlanNumber;
public OrderActionChangePlan() {
}
public OrderActionChangePlan effectivePolicy(ChangePlanEffectivePolicy effectivePolicy) {
this.effectivePolicy = effectivePolicy;
return this;
}
/**
* Get effectivePolicy
* @return effectivePolicy
*/
@javax.annotation.Nullable
public ChangePlanEffectivePolicy getEffectivePolicy() {
return effectivePolicy;
}
public void setEffectivePolicy(ChangePlanEffectivePolicy effectivePolicy) {
this.effectivePolicy = effectivePolicy;
}
public OrderActionChangePlan newProductRatePlan(ChangePlanRatePlanOverride newProductRatePlan) {
this.newProductRatePlan = newProductRatePlan;
return this;
}
/**
* Get newProductRatePlan
* @return newProductRatePlan
*/
@javax.annotation.Nullable
public ChangePlanRatePlanOverride getNewProductRatePlan() {
return newProductRatePlan;
}
public void setNewProductRatePlan(ChangePlanRatePlanOverride newProductRatePlan) {
this.newProductRatePlan = newProductRatePlan;
}
public OrderActionChangePlan productRatePlanId(String productRatePlanId) {
this.productRatePlanId = productRatePlanId;
return this;
}
/**
* ID of the rate plan to remove. This can be the latest version or any history version of ID.
* @return productRatePlanId
*/
@javax.annotation.Nullable
public String getProductRatePlanId() {
return productRatePlanId;
}
public void setProductRatePlanId(String productRatePlanId) {
this.productRatePlanId = productRatePlanId;
}
public OrderActionChangePlan productRatePlanNumber(String productRatePlanNumber) {
this.productRatePlanNumber = productRatePlanNumber;
return this;
}
/**
* Number of a product rate plan for this subscription.
* @return productRatePlanNumber
*/
@javax.annotation.Nullable
public String getProductRatePlanNumber() {
return productRatePlanNumber;
}
public void setProductRatePlanNumber(String productRatePlanNumber) {
this.productRatePlanNumber = productRatePlanNumber;
}
public OrderActionChangePlan ratePlanId(String ratePlanId) {
this.ratePlanId = ratePlanId;
return this;
}
/**
* ID of the rate plan to remove. This can be the latest version or any history version of ID.
* @return ratePlanId
*/
@javax.annotation.Nullable
public String getRatePlanId() {
return ratePlanId;
}
public void setRatePlanId(String ratePlanId) {
this.ratePlanId = ratePlanId;
}
public OrderActionChangePlan subType(ChangePlanSubType subType) {
this.subType = subType;
return this;
}
/**
* Get subType
* @return subType
*/
@javax.annotation.Nullable
public ChangePlanSubType getSubType() {
return subType;
}
public void setSubType(ChangePlanSubType subType) {
this.subType = subType;
}
public OrderActionChangePlan subscriptionRatePlanNumber(String subscriptionRatePlanNumber) {
this.subscriptionRatePlanNumber = subscriptionRatePlanNumber;
return this;
}
/**
* Number of a rate plan for this subscription.
* @return subscriptionRatePlanNumber
*/
@javax.annotation.Nullable
public String getSubscriptionRatePlanNumber() {
return subscriptionRatePlanNumber;
}
public void setSubscriptionRatePlanNumber(String subscriptionRatePlanNumber) {
this.subscriptionRatePlanNumber = subscriptionRatePlanNumber;
}
/**
* 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 OrderActionChangePlan instance itself
*/
public OrderActionChangePlan 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;
}
OrderActionChangePlan orderActionChangePlan = (OrderActionChangePlan) o;
return Objects.equals(this.effectivePolicy, orderActionChangePlan.effectivePolicy) &&
Objects.equals(this.newProductRatePlan, orderActionChangePlan.newProductRatePlan) &&
Objects.equals(this.productRatePlanId, orderActionChangePlan.productRatePlanId) &&
Objects.equals(this.productRatePlanNumber, orderActionChangePlan.productRatePlanNumber) &&
Objects.equals(this.ratePlanId, orderActionChangePlan.ratePlanId) &&
Objects.equals(this.subType, orderActionChangePlan.subType) &&
Objects.equals(this.subscriptionRatePlanNumber, orderActionChangePlan.subscriptionRatePlanNumber)&&
Objects.equals(this.additionalProperties, orderActionChangePlan.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(effectivePolicy, newProductRatePlan, productRatePlanId, productRatePlanNumber, ratePlanId, subType, subscriptionRatePlanNumber, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class OrderActionChangePlan {\n");
sb.append(" effectivePolicy: ").append(toIndentedString(effectivePolicy)).append("\n");
sb.append(" newProductRatePlan: ").append(toIndentedString(newProductRatePlan)).append("\n");
sb.append(" productRatePlanId: ").append(toIndentedString(productRatePlanId)).append("\n");
sb.append(" productRatePlanNumber: ").append(toIndentedString(productRatePlanNumber)).append("\n");
sb.append(" ratePlanId: ").append(toIndentedString(ratePlanId)).append("\n");
sb.append(" subType: ").append(toIndentedString(subType)).append("\n");
sb.append(" subscriptionRatePlanNumber: ").append(toIndentedString(subscriptionRatePlanNumber)).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("effectivePolicy");
openapiFields.add("newProductRatePlan");
openapiFields.add("productRatePlanId");
openapiFields.add("productRatePlanNumber");
openapiFields.add("ratePlanId");
openapiFields.add("subType");
openapiFields.add("subscriptionRatePlanNumber");
// 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 OrderActionChangePlan
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!OrderActionChangePlan.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in OrderActionChangePlan is not found in the empty JSON string", OrderActionChangePlan.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("effectivePolicy") != null && !jsonObj.get("effectivePolicy").isJsonNull()) && !jsonObj.get("effectivePolicy").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `effectivePolicy` to be a primitive type in the JSON string but got `%s`", jsonObj.get("effectivePolicy").toString()));
}
// validate the optional field `effectivePolicy`
if (jsonObj.get("effectivePolicy") != null && !jsonObj.get("effectivePolicy").isJsonNull()) {
ChangePlanEffectivePolicy.validateJsonElement(jsonObj.get("effectivePolicy"));
}
// validate the optional field `newProductRatePlan`
if (jsonObj.get("newProductRatePlan") != null && !jsonObj.get("newProductRatePlan").isJsonNull()) {
ChangePlanRatePlanOverride.validateJsonElement(jsonObj.get("newProductRatePlan"));
}
if ((jsonObj.get("productRatePlanId") != null && !jsonObj.get("productRatePlanId").isJsonNull()) && !jsonObj.get("productRatePlanId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `productRatePlanId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("productRatePlanId").toString()));
}
if ((jsonObj.get("productRatePlanNumber") != null && !jsonObj.get("productRatePlanNumber").isJsonNull()) && !jsonObj.get("productRatePlanNumber").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `productRatePlanNumber` to be a primitive type in the JSON string but got `%s`", jsonObj.get("productRatePlanNumber").toString()));
}
if ((jsonObj.get("ratePlanId") != null && !jsonObj.get("ratePlanId").isJsonNull()) && !jsonObj.get("ratePlanId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `ratePlanId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("ratePlanId").toString()));
}
if ((jsonObj.get("subType") != null && !jsonObj.get("subType").isJsonNull()) && !jsonObj.get("subType").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `subType` to be a primitive type in the JSON string but got `%s`", jsonObj.get("subType").toString()));
}
// validate the optional field `subType`
if (jsonObj.get("subType") != null && !jsonObj.get("subType").isJsonNull()) {
ChangePlanSubType.validateJsonElement(jsonObj.get("subType"));
}
if ((jsonObj.get("subscriptionRatePlanNumber") != null && !jsonObj.get("subscriptionRatePlanNumber").isJsonNull()) && !jsonObj.get("subscriptionRatePlanNumber").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `subscriptionRatePlanNumber` to be a primitive type in the JSON string but got `%s`", jsonObj.get("subscriptionRatePlanNumber").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!OrderActionChangePlan.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'OrderActionChangePlan' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(OrderActionChangePlan.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, OrderActionChangePlan value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
obj.remove("additionalProperties");
// support null values
out.beginObject();
Iterator iterator = obj.entrySet().iterator();
while(iterator.hasNext()) {
Map.Entry e = (Map.Entry) iterator.next();
out.name((String)e.getKey());
elementAdapter.write(out, e.getValue());
}
// end
// serialize additional properties
if (value.getAdditionalProperties() != null) {
// support null values
boolean oldSerializeNulls = out.getSerializeNulls();
out.setSerializeNulls(true); //force serialize
// end
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 if (entry.getValue() == null)
obj.add(entry.getKey(), null);
else {
JsonElement jsonElement = gson.toJsonTree(entry.getValue());
if (jsonElement.isJsonArray()) {
obj.add(entry.getKey(), jsonElement.getAsJsonArray());
} else {
obj.add(entry.getKey(), jsonElement.getAsJsonObject());
}
}
out.name((String)entry.getKey());
elementAdapter.write(out, obj.get(entry.getKey()));
}
out.setSerializeNulls(oldSerializeNulls); //restore
}
out.endObject();
}
@Override
public OrderActionChangePlan read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
OrderActionChangePlan 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 OrderActionChangePlan given an JSON string
*
* @param jsonString JSON string
* @return An instance of OrderActionChangePlan
* @throws IOException if the JSON string is invalid with respect to OrderActionChangePlan
*/
public static OrderActionChangePlan fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, OrderActionChangePlan.class);
}
/**
* Convert an instance of OrderActionChangePlan to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy