com.zuora.model.RampIntervalChargeMetrics 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.RampIntervalChargeMetricsMrrInner;
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;
/**
* RampIntervalChargeMetrics
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class RampIntervalChargeMetrics {
public static final String SERIALIZED_NAME_CHARGE_NUMBER = "chargeNumber";
@SerializedName(SERIALIZED_NAME_CHARGE_NUMBER)
private String chargeNumber;
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_MRR = "mrr";
@SerializedName(SERIALIZED_NAME_MRR)
private List mrr;
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_PRODUCT_RATE_PLAN_CHARGE_ID = "productRatePlanChargeId";
@SerializedName(SERIALIZED_NAME_PRODUCT_RATE_PLAN_CHARGE_ID)
private String productRatePlanChargeId;
public static final String SERIALIZED_NAME_QUANTITY = "quantity";
@SerializedName(SERIALIZED_NAME_QUANTITY)
private BigDecimal quantity;
public static final String SERIALIZED_NAME_RATE_PLAN_CHARGE_ID = "ratePlanChargeId";
@SerializedName(SERIALIZED_NAME_RATE_PLAN_CHARGE_ID)
private String ratePlanChargeId;
public static final String SERIALIZED_NAME_START_DATE = "startDate";
@SerializedName(SERIALIZED_NAME_START_DATE)
private LocalDate startDate;
public static final String SERIALIZED_NAME_SUBSCRIPTION_NUMBER = "subscriptionNumber";
@SerializedName(SERIALIZED_NAME_SUBSCRIPTION_NUMBER)
private String subscriptionNumber;
public RampIntervalChargeMetrics() {
}
public RampIntervalChargeMetrics chargeNumber(String chargeNumber) {
this.chargeNumber = chargeNumber;
return this;
}
/**
* The number of the charge.
* @return chargeNumber
*/
@javax.annotation.Nullable
public String getChargeNumber() {
return chargeNumber;
}
public void setChargeNumber(String chargeNumber) {
this.chargeNumber = chargeNumber;
}
public RampIntervalChargeMetrics 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 RampIntervalChargeMetrics 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 RampIntervalChargeMetrics endDate(LocalDate endDate) {
this.endDate = endDate;
return this;
}
/**
* The end date of the rate plan charge in the current ramp interval.
* @return endDate
*/
@javax.annotation.Nullable
public LocalDate getEndDate() {
return endDate;
}
public void setEndDate(LocalDate endDate) {
this.endDate = endDate;
}
public RampIntervalChargeMetrics 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 RampIntervalChargeMetrics 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 RampIntervalChargeMetrics mrr(List mrr) {
this.mrr = mrr;
return this;
}
public RampIntervalChargeMetrics addMrrItem(RampIntervalChargeMetricsMrrInner mrrItem) {
if (this.mrr == null) {
this.mrr = new ArrayList<>();
}
this.mrr.add(mrrItem);
return this;
}
/**
* The MRR changing history of the current rate plan charge in the current ramp interval.
* @return mrr
*/
@javax.annotation.Nullable
public List getMrr() {
return mrr;
}
public void setMrr(List mrr) {
this.mrr = mrr;
}
public RampIntervalChargeMetrics 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 RampIntervalChargeMetrics 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 RampIntervalChargeMetrics productRatePlanChargeId(String productRatePlanChargeId) {
this.productRatePlanChargeId = productRatePlanChargeId;
return this;
}
/**
* The ID of the corresponding product rate plan charge.
* @return productRatePlanChargeId
*/
@javax.annotation.Nullable
public String getProductRatePlanChargeId() {
return productRatePlanChargeId;
}
public void setProductRatePlanChargeId(String productRatePlanChargeId) {
this.productRatePlanChargeId = productRatePlanChargeId;
}
public RampIntervalChargeMetrics quantity(BigDecimal quantity) {
this.quantity = quantity;
return this;
}
/**
* The quantity of the rate plan charge.
* @return quantity
*/
@javax.annotation.Nullable
public BigDecimal getQuantity() {
return quantity;
}
public void setQuantity(BigDecimal quantity) {
this.quantity = quantity;
}
public RampIntervalChargeMetrics ratePlanChargeId(String ratePlanChargeId) {
this.ratePlanChargeId = ratePlanChargeId;
return this;
}
/**
* The ID of the rate plan charge.
* @return ratePlanChargeId
*/
@javax.annotation.Nullable
public String getRatePlanChargeId() {
return ratePlanChargeId;
}
public void setRatePlanChargeId(String ratePlanChargeId) {
this.ratePlanChargeId = ratePlanChargeId;
}
public RampIntervalChargeMetrics startDate(LocalDate startDate) {
this.startDate = startDate;
return this;
}
/**
* The start date of the rate plan charge in the current ramp interval.
* @return startDate
*/
@javax.annotation.Nullable
public LocalDate getStartDate() {
return startDate;
}
public void setStartDate(LocalDate startDate) {
this.startDate = startDate;
}
public RampIntervalChargeMetrics subscriptionNumber(String subscriptionNumber) {
this.subscriptionNumber = subscriptionNumber;
return this;
}
/**
* The number of the subscription that the current rate plan charge belongs to.
* @return subscriptionNumber
*/
@javax.annotation.Nullable
public String getSubscriptionNumber() {
return subscriptionNumber;
}
public void setSubscriptionNumber(String subscriptionNumber) {
this.subscriptionNumber = subscriptionNumber;
}
/**
* 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 RampIntervalChargeMetrics instance itself
*/
public RampIntervalChargeMetrics 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;
}
RampIntervalChargeMetrics rampIntervalChargeMetrics = (RampIntervalChargeMetrics) o;
return Objects.equals(this.chargeNumber, rampIntervalChargeMetrics.chargeNumber) &&
Objects.equals(this.discountTcb, rampIntervalChargeMetrics.discountTcb) &&
Objects.equals(this.discountTcv, rampIntervalChargeMetrics.discountTcv) &&
Objects.equals(this.endDate, rampIntervalChargeMetrics.endDate) &&
Objects.equals(this.grossTcb, rampIntervalChargeMetrics.grossTcb) &&
Objects.equals(this.grossTcv, rampIntervalChargeMetrics.grossTcv) &&
Objects.equals(this.mrr, rampIntervalChargeMetrics.mrr) &&
Objects.equals(this.netTcb, rampIntervalChargeMetrics.netTcb) &&
Objects.equals(this.netTcv, rampIntervalChargeMetrics.netTcv) &&
Objects.equals(this.productRatePlanChargeId, rampIntervalChargeMetrics.productRatePlanChargeId) &&
Objects.equals(this.quantity, rampIntervalChargeMetrics.quantity) &&
Objects.equals(this.ratePlanChargeId, rampIntervalChargeMetrics.ratePlanChargeId) &&
Objects.equals(this.startDate, rampIntervalChargeMetrics.startDate) &&
Objects.equals(this.subscriptionNumber, rampIntervalChargeMetrics.subscriptionNumber)&&
Objects.equals(this.additionalProperties, rampIntervalChargeMetrics.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(chargeNumber, discountTcb, discountTcv, endDate, grossTcb, grossTcv, mrr, netTcb, netTcv, productRatePlanChargeId, quantity, ratePlanChargeId, startDate, subscriptionNumber, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class RampIntervalChargeMetrics {\n");
sb.append(" chargeNumber: ").append(toIndentedString(chargeNumber)).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(" mrr: ").append(toIndentedString(mrr)).append("\n");
sb.append(" netTcb: ").append(toIndentedString(netTcb)).append("\n");
sb.append(" netTcv: ").append(toIndentedString(netTcv)).append("\n");
sb.append(" productRatePlanChargeId: ").append(toIndentedString(productRatePlanChargeId)).append("\n");
sb.append(" quantity: ").append(toIndentedString(quantity)).append("\n");
sb.append(" ratePlanChargeId: ").append(toIndentedString(ratePlanChargeId)).append("\n");
sb.append(" startDate: ").append(toIndentedString(startDate)).append("\n");
sb.append(" subscriptionNumber: ").append(toIndentedString(subscriptionNumber)).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("discountTcb");
openapiFields.add("discountTcv");
openapiFields.add("endDate");
openapiFields.add("grossTcb");
openapiFields.add("grossTcv");
openapiFields.add("mrr");
openapiFields.add("netTcb");
openapiFields.add("netTcv");
openapiFields.add("productRatePlanChargeId");
openapiFields.add("quantity");
openapiFields.add("ratePlanChargeId");
openapiFields.add("startDate");
openapiFields.add("subscriptionNumber");
// 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 RampIntervalChargeMetrics
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!RampIntervalChargeMetrics.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in RampIntervalChargeMetrics is not found in the empty JSON string", RampIntervalChargeMetrics.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("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++) {
RampIntervalChargeMetricsMrrInner.validateJsonElement(jsonArraymrr.get(i));
};
}
}
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("ratePlanChargeId") != null && !jsonObj.get("ratePlanChargeId").isJsonNull()) && !jsonObj.get("ratePlanChargeId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `ratePlanChargeId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("ratePlanChargeId").toString()));
}
if ((jsonObj.get("subscriptionNumber") != null && !jsonObj.get("subscriptionNumber").isJsonNull()) && !jsonObj.get("subscriptionNumber").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `subscriptionNumber` to be a primitive type in the JSON string but got `%s`", jsonObj.get("subscriptionNumber").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!RampIntervalChargeMetrics.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'RampIntervalChargeMetrics' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(RampIntervalChargeMetrics.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, RampIntervalChargeMetrics 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 RampIntervalChargeMetrics read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
RampIntervalChargeMetrics 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 RampIntervalChargeMetrics given an JSON string
*
* @param jsonString JSON string
* @return An instance of RampIntervalChargeMetrics
* @throws IOException if the JSON string is invalid with respect to RampIntervalChargeMetrics
*/
public static RampIntervalChargeMetrics fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, RampIntervalChargeMetrics.class);
}
/**
* Convert an instance of RampIntervalChargeMetrics to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy