com.zuora.model.PreviewOrderResult 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.OrderRampMetrics;
import com.zuora.model.PreviewOrderResultChargeMetrics;
import com.zuora.model.PreviewOrderResultCreditMemos;
import com.zuora.model.PreviewOrderResultDeltaMetrics;
import com.zuora.model.PreviewOrderResultInvoices;
import com.zuora.model.PreviewResultOrderMetricsInner;
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 result of each type of preview. Returned only when the current request is preview call.
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class PreviewOrderResult {
public static final String SERIALIZED_NAME_CHARGE_METRICS = "chargeMetrics";
@SerializedName(SERIALIZED_NAME_CHARGE_METRICS)
private List chargeMetrics;
public static final String SERIALIZED_NAME_CREDIT_MEMOS = "creditMemos";
@SerializedName(SERIALIZED_NAME_CREDIT_MEMOS)
private List creditMemos;
public static final String SERIALIZED_NAME_INVOICES = "invoices";
@SerializedName(SERIALIZED_NAME_INVOICES)
private List invoices;
public static final String SERIALIZED_NAME_ORDER_DELTA_METRICS = "orderDeltaMetrics";
@SerializedName(SERIALIZED_NAME_ORDER_DELTA_METRICS)
private PreviewOrderResultDeltaMetrics orderDeltaMetrics;
public static final String SERIALIZED_NAME_ORDER_METRICS = "orderMetrics";
@SerializedName(SERIALIZED_NAME_ORDER_METRICS)
private List orderMetrics;
public static final String SERIALIZED_NAME_RAMP_METRICS = "rampMetrics";
@SerializedName(SERIALIZED_NAME_RAMP_METRICS)
private List rampMetrics;
public PreviewOrderResult() {
}
public PreviewOrderResult chargeMetrics(List chargeMetrics) {
this.chargeMetrics = chargeMetrics;
return this;
}
public PreviewOrderResult addChargeMetricsItem(PreviewOrderResultChargeMetrics chargeMetricsItem) {
if (this.chargeMetrics == null) {
this.chargeMetrics = new ArrayList<>();
}
this.chargeMetrics.add(chargeMetricsItem);
return this;
}
/**
* Get chargeMetrics
* @return chargeMetrics
*/
@javax.annotation.Nullable
public List getChargeMetrics() {
return chargeMetrics;
}
public void setChargeMetrics(List chargeMetrics) {
this.chargeMetrics = chargeMetrics;
}
public PreviewOrderResult creditMemos(List creditMemos) {
this.creditMemos = creditMemos;
return this;
}
public PreviewOrderResult addCreditMemosItem(PreviewOrderResultCreditMemos creditMemosItem) {
if (this.creditMemos == null) {
this.creditMemos = new ArrayList<>();
}
this.creditMemos.add(creditMemosItem);
return this;
}
/**
* This field is only available if you have the Invoice Settlement feature enabled.
* @return creditMemos
*/
@javax.annotation.Nullable
public List getCreditMemos() {
return creditMemos;
}
public void setCreditMemos(List creditMemos) {
this.creditMemos = creditMemos;
}
public PreviewOrderResult invoices(List invoices) {
this.invoices = invoices;
return this;
}
public PreviewOrderResult addInvoicesItem(PreviewOrderResultInvoices invoicesItem) {
if (this.invoices == null) {
this.invoices = new ArrayList<>();
}
this.invoices.add(invoicesItem);
return this;
}
/**
* Get invoices
* @return invoices
*/
@javax.annotation.Nullable
public List getInvoices() {
return invoices;
}
public void setInvoices(List invoices) {
this.invoices = invoices;
}
public PreviewOrderResult orderDeltaMetrics(PreviewOrderResultDeltaMetrics orderDeltaMetrics) {
this.orderDeltaMetrics = orderDeltaMetrics;
return this;
}
/**
* Get orderDeltaMetrics
* @return orderDeltaMetrics
*/
@javax.annotation.Nullable
public PreviewOrderResultDeltaMetrics getOrderDeltaMetrics() {
return orderDeltaMetrics;
}
public void setOrderDeltaMetrics(PreviewOrderResultDeltaMetrics orderDeltaMetrics) {
this.orderDeltaMetrics = orderDeltaMetrics;
}
public PreviewOrderResult orderMetrics(List orderMetrics) {
this.orderMetrics = orderMetrics;
return this;
}
public PreviewOrderResult addOrderMetricsItem(PreviewResultOrderMetricsInner orderMetricsItem) {
if (this.orderMetrics == null) {
this.orderMetrics = new ArrayList<>();
}
this.orderMetrics.add(orderMetricsItem);
return this;
}
/**
* **Note:** As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders). The new methodologies are reflected in the following Order Delta Metrics objects. * [Order Delta Mrr](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Mrr) * [Order Delta Tcv](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcv) * [Order Delta Tcb](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcb) It is recommended that all customers use the new [Order Delta Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics). If you are an existing [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders) customer and want to migrate to Order Delta Metrics, submit a request at [Zuora Global Support](https://support.zuora.com/). Whereas new customers, and existing customers not currently on [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders), will no longer have access to Order Metrics, existing customers currently using Order Metrics will continue to be supported.
* @return orderMetrics
*/
@javax.annotation.Nullable
public List getOrderMetrics() {
return orderMetrics;
}
public void setOrderMetrics(List orderMetrics) {
this.orderMetrics = orderMetrics;
}
public PreviewOrderResult rampMetrics(List rampMetrics) {
this.rampMetrics = rampMetrics;
return this;
}
public PreviewOrderResult addRampMetricsItem(OrderRampMetrics rampMetricsItem) {
if (this.rampMetrics == null) {
this.rampMetrics = new ArrayList<>();
}
this.rampMetrics.add(rampMetricsItem);
return this;
}
/**
* **Note**: This field is only available if you have the Ramps feature enabled. The [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics) feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information coming October 2020. The ramp metrics.
* @return rampMetrics
*/
@javax.annotation.Nullable
public List getRampMetrics() {
return rampMetrics;
}
public void setRampMetrics(List rampMetrics) {
this.rampMetrics = rampMetrics;
}
/**
* 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 PreviewOrderResult instance itself
*/
public PreviewOrderResult 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;
}
PreviewOrderResult previewOrderResult = (PreviewOrderResult) o;
return Objects.equals(this.chargeMetrics, previewOrderResult.chargeMetrics) &&
Objects.equals(this.creditMemos, previewOrderResult.creditMemos) &&
Objects.equals(this.invoices, previewOrderResult.invoices) &&
Objects.equals(this.orderDeltaMetrics, previewOrderResult.orderDeltaMetrics) &&
Objects.equals(this.orderMetrics, previewOrderResult.orderMetrics) &&
Objects.equals(this.rampMetrics, previewOrderResult.rampMetrics)&&
Objects.equals(this.additionalProperties, previewOrderResult.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(chargeMetrics, creditMemos, invoices, orderDeltaMetrics, orderMetrics, rampMetrics, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class PreviewOrderResult {\n");
sb.append(" chargeMetrics: ").append(toIndentedString(chargeMetrics)).append("\n");
sb.append(" creditMemos: ").append(toIndentedString(creditMemos)).append("\n");
sb.append(" invoices: ").append(toIndentedString(invoices)).append("\n");
sb.append(" orderDeltaMetrics: ").append(toIndentedString(orderDeltaMetrics)).append("\n");
sb.append(" orderMetrics: ").append(toIndentedString(orderMetrics)).append("\n");
sb.append(" rampMetrics: ").append(toIndentedString(rampMetrics)).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("chargeMetrics");
openapiFields.add("creditMemos");
openapiFields.add("invoices");
openapiFields.add("orderDeltaMetrics");
openapiFields.add("orderMetrics");
openapiFields.add("rampMetrics");
// 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 PreviewOrderResult
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!PreviewOrderResult.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in PreviewOrderResult is not found in the empty JSON string", PreviewOrderResult.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if (jsonObj.get("chargeMetrics") != null && !jsonObj.get("chargeMetrics").isJsonNull()) {
JsonArray jsonArraychargeMetrics = jsonObj.getAsJsonArray("chargeMetrics");
if (jsonArraychargeMetrics != null) {
// ensure the json data is an array
if (!jsonObj.get("chargeMetrics").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `chargeMetrics` to be an array in the JSON string but got `%s`", jsonObj.get("chargeMetrics").toString()));
}
// validate the optional field `chargeMetrics` (array)
for (int i = 0; i < jsonArraychargeMetrics.size(); i++) {
PreviewOrderResultChargeMetrics.validateJsonElement(jsonArraychargeMetrics.get(i));
};
}
}
if (jsonObj.get("creditMemos") != null && !jsonObj.get("creditMemos").isJsonNull()) {
JsonArray jsonArraycreditMemos = jsonObj.getAsJsonArray("creditMemos");
if (jsonArraycreditMemos != null) {
// ensure the json data is an array
if (!jsonObj.get("creditMemos").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `creditMemos` to be an array in the JSON string but got `%s`", jsonObj.get("creditMemos").toString()));
}
// validate the optional field `creditMemos` (array)
for (int i = 0; i < jsonArraycreditMemos.size(); i++) {
PreviewOrderResultCreditMemos.validateJsonElement(jsonArraycreditMemos.get(i));
};
}
}
if (jsonObj.get("invoices") != null && !jsonObj.get("invoices").isJsonNull()) {
JsonArray jsonArrayinvoices = jsonObj.getAsJsonArray("invoices");
if (jsonArrayinvoices != null) {
// ensure the json data is an array
if (!jsonObj.get("invoices").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `invoices` to be an array in the JSON string but got `%s`", jsonObj.get("invoices").toString()));
}
// validate the optional field `invoices` (array)
for (int i = 0; i < jsonArrayinvoices.size(); i++) {
PreviewOrderResultInvoices.validateJsonElement(jsonArrayinvoices.get(i));
};
}
}
// validate the optional field `orderDeltaMetrics`
if (jsonObj.get("orderDeltaMetrics") != null && !jsonObj.get("orderDeltaMetrics").isJsonNull()) {
PreviewOrderResultDeltaMetrics.validateJsonElement(jsonObj.get("orderDeltaMetrics"));
}
if (jsonObj.get("orderMetrics") != null && !jsonObj.get("orderMetrics").isJsonNull()) {
JsonArray jsonArrayorderMetrics = jsonObj.getAsJsonArray("orderMetrics");
if (jsonArrayorderMetrics != null) {
// ensure the json data is an array
if (!jsonObj.get("orderMetrics").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `orderMetrics` to be an array in the JSON string but got `%s`", jsonObj.get("orderMetrics").toString()));
}
// validate the optional field `orderMetrics` (array)
for (int i = 0; i < jsonArrayorderMetrics.size(); i++) {
PreviewResultOrderMetricsInner.validateJsonElement(jsonArrayorderMetrics.get(i));
};
}
}
if (jsonObj.get("rampMetrics") != null && !jsonObj.get("rampMetrics").isJsonNull()) {
JsonArray jsonArrayrampMetrics = jsonObj.getAsJsonArray("rampMetrics");
if (jsonArrayrampMetrics != null) {
// ensure the json data is an array
if (!jsonObj.get("rampMetrics").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `rampMetrics` to be an array in the JSON string but got `%s`", jsonObj.get("rampMetrics").toString()));
}
// validate the optional field `rampMetrics` (array)
for (int i = 0; i < jsonArrayrampMetrics.size(); i++) {
OrderRampMetrics.validateJsonElement(jsonArrayrampMetrics.get(i));
};
}
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!PreviewOrderResult.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'PreviewOrderResult' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(PreviewOrderResult.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, PreviewOrderResult 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 PreviewOrderResult read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
PreviewOrderResult 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 PreviewOrderResult given an JSON string
*
* @param jsonString JSON string
* @return An instance of PreviewOrderResult
* @throws IOException if the JSON string is invalid with respect to PreviewOrderResult
*/
public static PreviewOrderResult fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, PreviewOrderResult.class);
}
/**
* Convert an instance of PreviewOrderResult to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy