com.zuora.model.OrderRampIntervalMetrics 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.RampIntervalChargeDeltaMetrics;
import com.zuora.model.RampIntervalChargeMetrics;
import java.io.IOException;
import java.math.BigDecimal;
import java.time.LocalDate;
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;
/**
* OrderRampIntervalMetrics
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class OrderRampIntervalMetrics {
public static final String SERIALIZED_NAME_DESCRIPTION = "description";
@SerializedName(SERIALIZED_NAME_DESCRIPTION)
private String description;
public static final String SERIALIZED_NAME_DISCOUNT_TCB = "discountTcb";
@SerializedName(SERIALIZED_NAME_DISCOUNT_TCB)
private BigDecimal discountTcb;
public static final String SERIALIZED_NAME_DISCOUNT_TCV = "discountTcv";
@SerializedName(SERIALIZED_NAME_DISCOUNT_TCV)
private BigDecimal discountTcv;
public static final String SERIALIZED_NAME_END_DATE = "endDate";
@SerializedName(SERIALIZED_NAME_END_DATE)
private LocalDate endDate;
public static final String SERIALIZED_NAME_GROSS_TCB = "grossTcb";
@SerializedName(SERIALIZED_NAME_GROSS_TCB)
private BigDecimal grossTcb;
public static final String SERIALIZED_NAME_GROSS_TCV = "grossTcv";
@SerializedName(SERIALIZED_NAME_GROSS_TCV)
private BigDecimal grossTcv;
public static final String SERIALIZED_NAME_INTERVAL_DELTA_METRICS = "intervalDeltaMetrics";
@SerializedName(SERIALIZED_NAME_INTERVAL_DELTA_METRICS)
private List intervalDeltaMetrics;
public static final String SERIALIZED_NAME_INTERVAL_METRICS = "intervalMetrics";
@SerializedName(SERIALIZED_NAME_INTERVAL_METRICS)
private List intervalMetrics;
public static final String SERIALIZED_NAME_NAME = "name";
@SerializedName(SERIALIZED_NAME_NAME)
private String name;
public static final String SERIALIZED_NAME_NET_TCB = "netTcb";
@SerializedName(SERIALIZED_NAME_NET_TCB)
private BigDecimal netTcb;
public static final String SERIALIZED_NAME_NET_TCV = "netTcv";
@SerializedName(SERIALIZED_NAME_NET_TCV)
private BigDecimal netTcv;
public static final String SERIALIZED_NAME_START_DATE = "startDate";
@SerializedName(SERIALIZED_NAME_START_DATE)
private LocalDate startDate;
public OrderRampIntervalMetrics() {
}
public OrderRampIntervalMetrics description(String description) {
this.description = description;
return this;
}
/**
* The short description of the interval.
* @return description
*/
@javax.annotation.Nullable
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
public OrderRampIntervalMetrics discountTcb(BigDecimal discountTcb) {
this.discountTcb = discountTcb;
return this;
}
/**
* The discount amount for the TCB.
* @return discountTcb
*/
@javax.annotation.Nullable
public BigDecimal getDiscountTcb() {
return discountTcb;
}
public void setDiscountTcb(BigDecimal discountTcb) {
this.discountTcb = discountTcb;
}
public OrderRampIntervalMetrics discountTcv(BigDecimal discountTcv) {
this.discountTcv = discountTcv;
return this;
}
/**
* The discount amount for the TCV.
* @return discountTcv
*/
@javax.annotation.Nullable
public BigDecimal getDiscountTcv() {
return discountTcv;
}
public void setDiscountTcv(BigDecimal discountTcv) {
this.discountTcv = discountTcv;
}
public OrderRampIntervalMetrics endDate(LocalDate endDate) {
this.endDate = endDate;
return this;
}
/**
* The end date of the interval.
* @return endDate
*/
@javax.annotation.Nullable
public LocalDate getEndDate() {
return endDate;
}
public void setEndDate(LocalDate endDate) {
this.endDate = endDate;
}
public OrderRampIntervalMetrics grossTcb(BigDecimal grossTcb) {
this.grossTcb = grossTcb;
return this;
}
/**
* The gross TCB value before discount charges are applied.
* @return grossTcb
*/
@javax.annotation.Nullable
public BigDecimal getGrossTcb() {
return grossTcb;
}
public void setGrossTcb(BigDecimal grossTcb) {
this.grossTcb = grossTcb;
}
public OrderRampIntervalMetrics grossTcv(BigDecimal grossTcv) {
this.grossTcv = grossTcv;
return this;
}
/**
* The gross TCV value before discount charges are applied.
* @return grossTcv
*/
@javax.annotation.Nullable
public BigDecimal getGrossTcv() {
return grossTcv;
}
public void setGrossTcv(BigDecimal grossTcv) {
this.grossTcv = grossTcv;
}
public OrderRampIntervalMetrics intervalDeltaMetrics(List intervalDeltaMetrics) {
this.intervalDeltaMetrics = intervalDeltaMetrics;
return this;
}
public OrderRampIntervalMetrics addIntervalDeltaMetricsItem(RampIntervalChargeDeltaMetrics intervalDeltaMetricsItem) {
if (this.intervalDeltaMetrics == null) {
this.intervalDeltaMetrics = new ArrayList<>();
}
this.intervalDeltaMetrics.add(intervalDeltaMetricsItem);
return this;
}
/**
* Container for the delta metrics for each rate plan charge in each ramp interval. The delta is the difference of the subscription metrics between before and after the order.
* @return intervalDeltaMetrics
*/
@javax.annotation.Nullable
public List getIntervalDeltaMetrics() {
return intervalDeltaMetrics;
}
public void setIntervalDeltaMetrics(List intervalDeltaMetrics) {
this.intervalDeltaMetrics = intervalDeltaMetrics;
}
public OrderRampIntervalMetrics intervalMetrics(List intervalMetrics) {
this.intervalMetrics = intervalMetrics;
return this;
}
public OrderRampIntervalMetrics addIntervalMetricsItem(RampIntervalChargeMetrics intervalMetricsItem) {
if (this.intervalMetrics == null) {
this.intervalMetrics = new ArrayList<>();
}
this.intervalMetrics.add(intervalMetricsItem);
return this;
}
/**
* Container for the detailed metrics for each rate plan charge in each ramp interval.
* @return intervalMetrics
*/
@javax.annotation.Nullable
public List getIntervalMetrics() {
return intervalMetrics;
}
public void setIntervalMetrics(List intervalMetrics) {
this.intervalMetrics = intervalMetrics;
}
public OrderRampIntervalMetrics name(String name) {
this.name = name;
return this;
}
/**
* The name of the interval.
* @return name
*/
@javax.annotation.Nullable
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public OrderRampIntervalMetrics netTcb(BigDecimal netTcb) {
this.netTcb = netTcb;
return this;
}
/**
* The net TCB value after discount charges are applied.
* @return netTcb
*/
@javax.annotation.Nullable
public BigDecimal getNetTcb() {
return netTcb;
}
public void setNetTcb(BigDecimal netTcb) {
this.netTcb = netTcb;
}
public OrderRampIntervalMetrics netTcv(BigDecimal netTcv) {
this.netTcv = netTcv;
return this;
}
/**
* The net TCV value after discount charges are applied.
* @return netTcv
*/
@javax.annotation.Nullable
public BigDecimal getNetTcv() {
return netTcv;
}
public void setNetTcv(BigDecimal netTcv) {
this.netTcv = netTcv;
}
public OrderRampIntervalMetrics startDate(LocalDate startDate) {
this.startDate = startDate;
return this;
}
/**
* The start date of the interval.
* @return startDate
*/
@javax.annotation.Nullable
public LocalDate getStartDate() {
return startDate;
}
public void setStartDate(LocalDate startDate) {
this.startDate = startDate;
}
/**
* 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 OrderRampIntervalMetrics instance itself
*/
public OrderRampIntervalMetrics 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;
}
OrderRampIntervalMetrics orderRampIntervalMetrics = (OrderRampIntervalMetrics) o;
return Objects.equals(this.description, orderRampIntervalMetrics.description) &&
Objects.equals(this.discountTcb, orderRampIntervalMetrics.discountTcb) &&
Objects.equals(this.discountTcv, orderRampIntervalMetrics.discountTcv) &&
Objects.equals(this.endDate, orderRampIntervalMetrics.endDate) &&
Objects.equals(this.grossTcb, orderRampIntervalMetrics.grossTcb) &&
Objects.equals(this.grossTcv, orderRampIntervalMetrics.grossTcv) &&
Objects.equals(this.intervalDeltaMetrics, orderRampIntervalMetrics.intervalDeltaMetrics) &&
Objects.equals(this.intervalMetrics, orderRampIntervalMetrics.intervalMetrics) &&
Objects.equals(this.name, orderRampIntervalMetrics.name) &&
Objects.equals(this.netTcb, orderRampIntervalMetrics.netTcb) &&
Objects.equals(this.netTcv, orderRampIntervalMetrics.netTcv) &&
Objects.equals(this.startDate, orderRampIntervalMetrics.startDate)&&
Objects.equals(this.additionalProperties, orderRampIntervalMetrics.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(description, discountTcb, discountTcv, endDate, grossTcb, grossTcv, intervalDeltaMetrics, intervalMetrics, name, netTcb, netTcv, startDate, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class OrderRampIntervalMetrics {\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" discountTcb: ").append(toIndentedString(discountTcb)).append("\n");
sb.append(" discountTcv: ").append(toIndentedString(discountTcv)).append("\n");
sb.append(" endDate: ").append(toIndentedString(endDate)).append("\n");
sb.append(" grossTcb: ").append(toIndentedString(grossTcb)).append("\n");
sb.append(" grossTcv: ").append(toIndentedString(grossTcv)).append("\n");
sb.append(" intervalDeltaMetrics: ").append(toIndentedString(intervalDeltaMetrics)).append("\n");
sb.append(" intervalMetrics: ").append(toIndentedString(intervalMetrics)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" netTcb: ").append(toIndentedString(netTcb)).append("\n");
sb.append(" netTcv: ").append(toIndentedString(netTcv)).append("\n");
sb.append(" startDate: ").append(toIndentedString(startDate)).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("description");
openapiFields.add("discountTcb");
openapiFields.add("discountTcv");
openapiFields.add("endDate");
openapiFields.add("grossTcb");
openapiFields.add("grossTcv");
openapiFields.add("intervalDeltaMetrics");
openapiFields.add("intervalMetrics");
openapiFields.add("name");
openapiFields.add("netTcb");
openapiFields.add("netTcv");
openapiFields.add("startDate");
// 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 OrderRampIntervalMetrics
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!OrderRampIntervalMetrics.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in OrderRampIntervalMetrics is not found in the empty JSON string", OrderRampIntervalMetrics.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("description") != null && !jsonObj.get("description").isJsonNull()) && !jsonObj.get("description").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `description` to be a primitive type in the JSON string but got `%s`", jsonObj.get("description").toString()));
}
if (jsonObj.get("intervalDeltaMetrics") != null && !jsonObj.get("intervalDeltaMetrics").isJsonNull()) {
JsonArray jsonArrayintervalDeltaMetrics = jsonObj.getAsJsonArray("intervalDeltaMetrics");
if (jsonArrayintervalDeltaMetrics != null) {
// ensure the json data is an array
if (!jsonObj.get("intervalDeltaMetrics").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `intervalDeltaMetrics` to be an array in the JSON string but got `%s`", jsonObj.get("intervalDeltaMetrics").toString()));
}
// validate the optional field `intervalDeltaMetrics` (array)
for (int i = 0; i < jsonArrayintervalDeltaMetrics.size(); i++) {
RampIntervalChargeDeltaMetrics.validateJsonElement(jsonArrayintervalDeltaMetrics.get(i));
};
}
}
if (jsonObj.get("intervalMetrics") != null && !jsonObj.get("intervalMetrics").isJsonNull()) {
JsonArray jsonArrayintervalMetrics = jsonObj.getAsJsonArray("intervalMetrics");
if (jsonArrayintervalMetrics != null) {
// ensure the json data is an array
if (!jsonObj.get("intervalMetrics").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `intervalMetrics` to be an array in the JSON string but got `%s`", jsonObj.get("intervalMetrics").toString()));
}
// validate the optional field `intervalMetrics` (array)
for (int i = 0; i < jsonArrayintervalMetrics.size(); i++) {
RampIntervalChargeMetrics.validateJsonElement(jsonArrayintervalMetrics.get(i));
};
}
}
if ((jsonObj.get("name") != null && !jsonObj.get("name").isJsonNull()) && !jsonObj.get("name").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `name` to be a primitive type in the JSON string but got `%s`", jsonObj.get("name").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!OrderRampIntervalMetrics.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'OrderRampIntervalMetrics' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(OrderRampIntervalMetrics.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, OrderRampIntervalMetrics 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 OrderRampIntervalMetrics read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
OrderRampIntervalMetrics 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 OrderRampIntervalMetrics given an JSON string
*
* @param jsonString JSON string
* @return An instance of OrderRampIntervalMetrics
* @throws IOException if the JSON string is invalid with respect to OrderRampIntervalMetrics
*/
public static OrderRampIntervalMetrics fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, OrderRampIntervalMetrics.class);
}
/**
* Convert an instance of OrderRampIntervalMetrics to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy