com.zuora.model.PreviewResultOrderMetricsInnerOrderActionsInner 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.OrderItem;
import com.zuora.model.OrderMetric;
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;
/**
* PreviewResultOrderMetricsInnerOrderActionsInner
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class PreviewResultOrderMetricsInnerOrderActionsInner {
public static final String SERIALIZED_NAME_ORDER_ITEMS = "orderItems";
@SerializedName(SERIALIZED_NAME_ORDER_ITEMS)
private List orderItems;
public static final String SERIALIZED_NAME_ORDER_METRICS = "orderMetrics";
@SerializedName(SERIALIZED_NAME_ORDER_METRICS)
private List orderMetrics;
public static final String SERIALIZED_NAME_SEQUENCE = "sequence";
@SerializedName(SERIALIZED_NAME_SEQUENCE)
private String sequence;
public static final String SERIALIZED_NAME_TYPE = "type";
@SerializedName(SERIALIZED_NAME_TYPE)
private String type;
public PreviewResultOrderMetricsInnerOrderActionsInner() {
}
public PreviewResultOrderMetricsInnerOrderActionsInner orderItems(List orderItems) {
this.orderItems = orderItems;
return this;
}
public PreviewResultOrderMetricsInnerOrderActionsInner addOrderItemsItem(OrderItem orderItemsItem) {
if (this.orderItems == null) {
this.orderItems = new ArrayList<>();
}
this.orderItems.add(orderItemsItem);
return this;
}
/**
* The `orderItems` 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 orderItems
*/
@javax.annotation.Nullable
public List getOrderItems() {
return orderItems;
}
public void setOrderItems(List orderItems) {
this.orderItems = orderItems;
}
public PreviewResultOrderMetricsInnerOrderActionsInner orderMetrics(List orderMetrics) {
this.orderMetrics = orderMetrics;
return this;
}
public PreviewResultOrderMetricsInnerOrderActionsInner addOrderMetricsItem(OrderMetric orderMetricsItem) {
if (this.orderMetrics == null) {
this.orderMetrics = new ArrayList<>();
}
this.orderMetrics.add(orderMetricsItem);
return this;
}
/**
* The container for order metrics. **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 orderMetrics
*/
@javax.annotation.Nullable
public List getOrderMetrics() {
return orderMetrics;
}
public void setOrderMetrics(List orderMetrics) {
this.orderMetrics = orderMetrics;
}
public PreviewResultOrderMetricsInnerOrderActionsInner sequence(String sequence) {
this.sequence = sequence;
return this;
}
/**
* Get sequence
* @return sequence
*/
@javax.annotation.Nullable
public String getSequence() {
return sequence;
}
public void setSequence(String sequence) {
this.sequence = sequence;
}
public PreviewResultOrderMetricsInnerOrderActionsInner type(String type) {
this.type = type;
return this;
}
/**
* Get type
* @return type
*/
@javax.annotation.Nullable
public String getType() {
return type;
}
public void setType(String type) {
this.type = type;
}
/**
* 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 PreviewResultOrderMetricsInnerOrderActionsInner instance itself
*/
public PreviewResultOrderMetricsInnerOrderActionsInner 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;
}
PreviewResultOrderMetricsInnerOrderActionsInner previewResultOrderMetricsInnerOrderActionsInner = (PreviewResultOrderMetricsInnerOrderActionsInner) o;
return Objects.equals(this.orderItems, previewResultOrderMetricsInnerOrderActionsInner.orderItems) &&
Objects.equals(this.orderMetrics, previewResultOrderMetricsInnerOrderActionsInner.orderMetrics) &&
Objects.equals(this.sequence, previewResultOrderMetricsInnerOrderActionsInner.sequence) &&
Objects.equals(this.type, previewResultOrderMetricsInnerOrderActionsInner.type)&&
Objects.equals(this.additionalProperties, previewResultOrderMetricsInnerOrderActionsInner.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(orderItems, orderMetrics, sequence, type, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class PreviewResultOrderMetricsInnerOrderActionsInner {\n");
sb.append(" orderItems: ").append(toIndentedString(orderItems)).append("\n");
sb.append(" orderMetrics: ").append(toIndentedString(orderMetrics)).append("\n");
sb.append(" sequence: ").append(toIndentedString(sequence)).append("\n");
sb.append(" type: ").append(toIndentedString(type)).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("orderItems");
openapiFields.add("orderMetrics");
openapiFields.add("sequence");
openapiFields.add("type");
// 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 PreviewResultOrderMetricsInnerOrderActionsInner
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!PreviewResultOrderMetricsInnerOrderActionsInner.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in PreviewResultOrderMetricsInnerOrderActionsInner is not found in the empty JSON string", PreviewResultOrderMetricsInnerOrderActionsInner.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if (jsonObj.get("orderItems") != null && !jsonObj.get("orderItems").isJsonNull()) {
JsonArray jsonArrayorderItems = jsonObj.getAsJsonArray("orderItems");
if (jsonArrayorderItems != null) {
// ensure the json data is an array
if (!jsonObj.get("orderItems").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `orderItems` to be an array in the JSON string but got `%s`", jsonObj.get("orderItems").toString()));
}
// validate the optional field `orderItems` (array)
for (int i = 0; i < jsonArrayorderItems.size(); i++) {
OrderItem.validateJsonElement(jsonArrayorderItems.get(i));
};
}
}
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++) {
OrderMetric.validateJsonElement(jsonArrayorderMetrics.get(i));
};
}
}
if ((jsonObj.get("sequence") != null && !jsonObj.get("sequence").isJsonNull()) && !jsonObj.get("sequence").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `sequence` to be a primitive type in the JSON string but got `%s`", jsonObj.get("sequence").toString()));
}
if ((jsonObj.get("type") != null && !jsonObj.get("type").isJsonNull()) && !jsonObj.get("type").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `type` to be a primitive type in the JSON string but got `%s`", jsonObj.get("type").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!PreviewResultOrderMetricsInnerOrderActionsInner.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'PreviewResultOrderMetricsInnerOrderActionsInner' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(PreviewResultOrderMetricsInnerOrderActionsInner.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, PreviewResultOrderMetricsInnerOrderActionsInner 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 PreviewResultOrderMetricsInnerOrderActionsInner read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
PreviewResultOrderMetricsInnerOrderActionsInner 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 PreviewResultOrderMetricsInnerOrderActionsInner given an JSON string
*
* @param jsonString JSON string
* @return An instance of PreviewResultOrderMetricsInnerOrderActionsInner
* @throws IOException if the JSON string is invalid with respect to PreviewResultOrderMetricsInnerOrderActionsInner
*/
public static PreviewResultOrderMetricsInnerOrderActionsInner fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, PreviewResultOrderMetricsInnerOrderActionsInner.class);
}
/**
* Convert an instance of PreviewResultOrderMetricsInnerOrderActionsInner to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy