com.zuora.model.OrderMetric 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.TimeSlicedElpNetMetrics;
import com.zuora.model.TimeSlicedMetrics;
import com.zuora.model.TimeSlicedNetMetrics;
import com.zuora.model.TimeSlicedTcbNetMetrics;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
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;
/**
* The set of order metrics for an order action.
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class OrderMetric {
public static final String SERIALIZED_NAME_CHARGE_NUMBER = "chargeNumber";
@SerializedName(SERIALIZED_NAME_CHARGE_NUMBER)
private String chargeNumber;
public static final String SERIALIZED_NAME_ELP = "elp";
@SerializedName(SERIALIZED_NAME_ELP)
private List elp;
public static final String SERIALIZED_NAME_MRR = "mrr";
@SerializedName(SERIALIZED_NAME_MRR)
private List mrr;
public static final String SERIALIZED_NAME_ORIGIN_RATE_PLAN_ID = "originRatePlanId";
@SerializedName(SERIALIZED_NAME_ORIGIN_RATE_PLAN_ID)
private String originRatePlanId;
public static final String SERIALIZED_NAME_PRODUCT_RATE_PLAN_CHARGE_ID = "productRatePlanChargeId";
@SerializedName(SERIALIZED_NAME_PRODUCT_RATE_PLAN_CHARGE_ID)
private String productRatePlanChargeId;
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_SUBSCRIPTION_RATE_PLAN_NUMBER = "subscriptionRatePlanNumber";
@SerializedName(SERIALIZED_NAME_SUBSCRIPTION_RATE_PLAN_NUMBER)
private String subscriptionRatePlanNumber;
public static final String SERIALIZED_NAME_QUANTITY = "quantity";
@SerializedName(SERIALIZED_NAME_QUANTITY)
private List quantity;
public static final String SERIALIZED_NAME_TCB = "tcb";
@SerializedName(SERIALIZED_NAME_TCB)
private List tcb;
public static final String SERIALIZED_NAME_TCV = "tcv";
@SerializedName(SERIALIZED_NAME_TCV)
private List tcv;
public OrderMetric() {
}
public OrderMetric chargeNumber(String chargeNumber) {
this.chargeNumber = chargeNumber;
return this;
}
/**
* Get chargeNumber
* @return chargeNumber
*/
@javax.annotation.Nullable
public String getChargeNumber() {
return chargeNumber;
}
public void setChargeNumber(String chargeNumber) {
this.chargeNumber = chargeNumber;
}
public OrderMetric elp(List elp) {
this.elp = elp;
return this;
}
public OrderMetric addElpItem(TimeSlicedElpNetMetrics elpItem) {
if (this.elp == null) {
this.elp = new ArrayList<>();
}
this.elp.add(elpItem);
return this;
}
/**
* The extended list price which is calculated by the original product catalog list price multiplied by the delta quantity. The `elp` nested field is only available to existing Orders customers who already have access to the field. **Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics. * The Order ELP and Order Item objects * The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects Existing Orders customers who have these metrics will continue to be supported.
* @return elp
*/
@javax.annotation.Nullable
public List getElp() {
return elp;
}
public void setElp(List elp) {
this.elp = elp;
}
public OrderMetric mrr(List mrr) {
this.mrr = mrr;
return this;
}
public OrderMetric addMrrItem(TimeSlicedNetMetrics mrrItem) {
if (this.mrr == null) {
this.mrr = new ArrayList<>();
}
this.mrr.add(mrrItem);
return this;
}
/**
* Get mrr
* @return mrr
*/
@javax.annotation.Nullable
public List getMrr() {
return mrr;
}
public void setMrr(List mrr) {
this.mrr = mrr;
}
public OrderMetric originRatePlanId(String originRatePlanId) {
this.originRatePlanId = originRatePlanId;
return this;
}
/**
* Get originRatePlanId
* @return originRatePlanId
*/
@javax.annotation.Nullable
public String getOriginRatePlanId() {
return originRatePlanId;
}
public void setOriginRatePlanId(String originRatePlanId) {
this.originRatePlanId = originRatePlanId;
}
public OrderMetric productRatePlanChargeId(String productRatePlanChargeId) {
this.productRatePlanChargeId = productRatePlanChargeId;
return this;
}
/**
* Get productRatePlanChargeId
* @return productRatePlanChargeId
*/
@javax.annotation.Nullable
public String getProductRatePlanChargeId() {
return productRatePlanChargeId;
}
public void setProductRatePlanChargeId(String productRatePlanChargeId) {
this.productRatePlanChargeId = productRatePlanChargeId;
}
public OrderMetric productRatePlanId(String productRatePlanId) {
this.productRatePlanId = productRatePlanId;
return this;
}
/**
* Get productRatePlanId
* @return productRatePlanId
*/
@javax.annotation.Nullable
public String getProductRatePlanId() {
return productRatePlanId;
}
public void setProductRatePlanId(String productRatePlanId) {
this.productRatePlanId = productRatePlanId;
}
public OrderMetric subscriptionRatePlanNumber(String subscriptionRatePlanNumber) {
this.subscriptionRatePlanNumber = subscriptionRatePlanNumber;
return this;
}
/**
* Get subscriptionRatePlanNumber
* @return subscriptionRatePlanNumber
*/
@javax.annotation.Nullable
public String getSubscriptionRatePlanNumber() {
return subscriptionRatePlanNumber;
}
public void setSubscriptionRatePlanNumber(String subscriptionRatePlanNumber) {
this.subscriptionRatePlanNumber = subscriptionRatePlanNumber;
}
public OrderMetric quantity(List quantity) {
this.quantity = quantity;
return this;
}
public OrderMetric addQuantityItem(TimeSlicedMetrics quantityItem) {
if (this.quantity == null) {
this.quantity = new ArrayList<>();
}
this.quantity.add(quantityItem);
return this;
}
/**
* Get quantity
* @return quantity
*/
@javax.annotation.Nullable
public List getQuantity() {
return quantity;
}
public void setQuantity(List quantity) {
this.quantity = quantity;
}
public OrderMetric tcb(List tcb) {
this.tcb = tcb;
return this;
}
public OrderMetric addTcbItem(TimeSlicedTcbNetMetrics tcbItem) {
if (this.tcb == null) {
this.tcb = new ArrayList<>();
}
this.tcb.add(tcbItem);
return this;
}
/**
* Total contracted billing which is the forecast value for the total invoice amount.
* @return tcb
*/
@javax.annotation.Nullable
public List getTcb() {
return tcb;
}
public void setTcb(List tcb) {
this.tcb = tcb;
}
public OrderMetric tcv(List tcv) {
this.tcv = tcv;
return this;
}
public OrderMetric addTcvItem(TimeSlicedNetMetrics tcvItem) {
if (this.tcv == null) {
this.tcv = new ArrayList<>();
}
this.tcv.add(tcvItem);
return this;
}
/**
* Total contracted value.
* @return tcv
*/
@javax.annotation.Nullable
public List getTcv() {
return tcv;
}
public void setTcv(List tcv) {
this.tcv = tcv;
}
/**
* 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 OrderMetric instance itself
*/
public OrderMetric 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;
}
OrderMetric orderMetric = (OrderMetric) o;
return Objects.equals(this.chargeNumber, orderMetric.chargeNumber) &&
Objects.equals(this.elp, orderMetric.elp) &&
Objects.equals(this.mrr, orderMetric.mrr) &&
Objects.equals(this.originRatePlanId, orderMetric.originRatePlanId) &&
Objects.equals(this.productRatePlanChargeId, orderMetric.productRatePlanChargeId) &&
Objects.equals(this.productRatePlanId, orderMetric.productRatePlanId) &&
Objects.equals(this.subscriptionRatePlanNumber, orderMetric.subscriptionRatePlanNumber) &&
Objects.equals(this.quantity, orderMetric.quantity) &&
Objects.equals(this.tcb, orderMetric.tcb) &&
Objects.equals(this.tcv, orderMetric.tcv)&&
Objects.equals(this.additionalProperties, orderMetric.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(chargeNumber, elp, mrr, originRatePlanId, productRatePlanChargeId, productRatePlanId, subscriptionRatePlanNumber, quantity, tcb, tcv, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class OrderMetric {\n");
sb.append(" chargeNumber: ").append(toIndentedString(chargeNumber)).append("\n");
sb.append(" elp: ").append(toIndentedString(elp)).append("\n");
sb.append(" mrr: ").append(toIndentedString(mrr)).append("\n");
sb.append(" originRatePlanId: ").append(toIndentedString(originRatePlanId)).append("\n");
sb.append(" productRatePlanChargeId: ").append(toIndentedString(productRatePlanChargeId)).append("\n");
sb.append(" productRatePlanId: ").append(toIndentedString(productRatePlanId)).append("\n");
sb.append(" subscriptionRatePlanNumber: ").append(toIndentedString(subscriptionRatePlanNumber)).append("\n");
sb.append(" quantity: ").append(toIndentedString(quantity)).append("\n");
sb.append(" tcb: ").append(toIndentedString(tcb)).append("\n");
sb.append(" tcv: ").append(toIndentedString(tcv)).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("chargeNumber");
openapiFields.add("elp");
openapiFields.add("mrr");
openapiFields.add("originRatePlanId");
openapiFields.add("productRatePlanChargeId");
openapiFields.add("productRatePlanId");
openapiFields.add("subscriptionRatePlanNumber");
openapiFields.add("quantity");
openapiFields.add("tcb");
openapiFields.add("tcv");
// 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 OrderMetric
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!OrderMetric.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in OrderMetric is not found in the empty JSON string", OrderMetric.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("chargeNumber") != null && !jsonObj.get("chargeNumber").isJsonNull()) && !jsonObj.get("chargeNumber").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `chargeNumber` to be a primitive type in the JSON string but got `%s`", jsonObj.get("chargeNumber").toString()));
}
if (jsonObj.get("elp") != null && !jsonObj.get("elp").isJsonNull()) {
JsonArray jsonArrayelp = jsonObj.getAsJsonArray("elp");
if (jsonArrayelp != null) {
// ensure the json data is an array
if (!jsonObj.get("elp").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `elp` to be an array in the JSON string but got `%s`", jsonObj.get("elp").toString()));
}
// validate the optional field `elp` (array)
for (int i = 0; i < jsonArrayelp.size(); i++) {
TimeSlicedElpNetMetrics.validateJsonElement(jsonArrayelp.get(i));
};
}
}
if (jsonObj.get("mrr") != null && !jsonObj.get("mrr").isJsonNull()) {
JsonArray jsonArraymrr = jsonObj.getAsJsonArray("mrr");
if (jsonArraymrr != null) {
// ensure the json data is an array
if (!jsonObj.get("mrr").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `mrr` to be an array in the JSON string but got `%s`", jsonObj.get("mrr").toString()));
}
// validate the optional field `mrr` (array)
for (int i = 0; i < jsonArraymrr.size(); i++) {
TimeSlicedNetMetrics.validateJsonElement(jsonArraymrr.get(i));
};
}
}
if ((jsonObj.get("originRatePlanId") != null && !jsonObj.get("originRatePlanId").isJsonNull()) && !jsonObj.get("originRatePlanId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `originRatePlanId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("originRatePlanId").toString()));
}
if ((jsonObj.get("productRatePlanChargeId") != null && !jsonObj.get("productRatePlanChargeId").isJsonNull()) && !jsonObj.get("productRatePlanChargeId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `productRatePlanChargeId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("productRatePlanChargeId").toString()));
}
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("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()));
}
if (jsonObj.get("quantity") != null && !jsonObj.get("quantity").isJsonNull()) {
JsonArray jsonArrayquantity = jsonObj.getAsJsonArray("quantity");
if (jsonArrayquantity != null) {
// ensure the json data is an array
if (!jsonObj.get("quantity").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `quantity` to be an array in the JSON string but got `%s`", jsonObj.get("quantity").toString()));
}
// validate the optional field `quantity` (array)
for (int i = 0; i < jsonArrayquantity.size(); i++) {
TimeSlicedMetrics.validateJsonElement(jsonArrayquantity.get(i));
};
}
}
if (jsonObj.get("tcb") != null && !jsonObj.get("tcb").isJsonNull()) {
JsonArray jsonArraytcb = jsonObj.getAsJsonArray("tcb");
if (jsonArraytcb != null) {
// ensure the json data is an array
if (!jsonObj.get("tcb").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `tcb` to be an array in the JSON string but got `%s`", jsonObj.get("tcb").toString()));
}
// validate the optional field `tcb` (array)
for (int i = 0; i < jsonArraytcb.size(); i++) {
TimeSlicedTcbNetMetrics.validateJsonElement(jsonArraytcb.get(i));
};
}
}
if (jsonObj.get("tcv") != null && !jsonObj.get("tcv").isJsonNull()) {
JsonArray jsonArraytcv = jsonObj.getAsJsonArray("tcv");
if (jsonArraytcv != null) {
// ensure the json data is an array
if (!jsonObj.get("tcv").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `tcv` to be an array in the JSON string but got `%s`", jsonObj.get("tcv").toString()));
}
// validate the optional field `tcv` (array)
for (int i = 0; i < jsonArraytcv.size(); i++) {
TimeSlicedNetMetrics.validateJsonElement(jsonArraytcv.get(i));
};
}
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!OrderMetric.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'OrderMetric' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(OrderMetric.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, OrderMetric 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 OrderMetric read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
OrderMetric 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 OrderMetric given an JSON string
*
* @param jsonString JSON string
* @return An instance of OrderMetric
* @throws IOException if the JSON string is invalid with respect to OrderMetric
*/
public static OrderMetric fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, OrderMetric.class);
}
/**
* Convert an instance of OrderMetric to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy