com.zuora.model.ProductRatePlanChargeTier 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.PriceFormatProductRatePlanChargeTier;
import java.io.IOException;
import java.util.Arrays;
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;
/**
* ProductRatePlanChargeTier
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class ProductRatePlanChargeTier {
public static final String SERIALIZED_NAME_CURRENCY = "Currency";
@SerializedName(SERIALIZED_NAME_CURRENCY)
private String currency;
public static final String SERIALIZED_NAME_DISCOUNT_AMOUNT = "DiscountAmount";
@SerializedName(SERIALIZED_NAME_DISCOUNT_AMOUNT)
private Double discountAmount;
public static final String SERIALIZED_NAME_DISCOUNT_PERCENTAGE = "DiscountPercentage";
@SerializedName(SERIALIZED_NAME_DISCOUNT_PERCENTAGE)
private Double discountPercentage;
public static final String SERIALIZED_NAME_ENDING_UNIT = "EndingUnit";
@SerializedName(SERIALIZED_NAME_ENDING_UNIT)
private Double endingUnit;
public static final String SERIALIZED_NAME_IS_OVERAGE_PRICE = "IsOveragePrice";
@SerializedName(SERIALIZED_NAME_IS_OVERAGE_PRICE)
private Boolean isOveragePrice;
public static final String SERIALIZED_NAME_PRICE = "Price";
@SerializedName(SERIALIZED_NAME_PRICE)
private Double price;
public static final String SERIALIZED_NAME_PRICE_FORMAT = "PriceFormat";
@SerializedName(SERIALIZED_NAME_PRICE_FORMAT)
private PriceFormatProductRatePlanChargeTier priceFormat;
public static final String SERIALIZED_NAME_STARTING_UNIT = "StartingUnit";
@SerializedName(SERIALIZED_NAME_STARTING_UNIT)
private Double startingUnit;
public ProductRatePlanChargeTier() {
}
public ProductRatePlanChargeTier currency(String currency) {
this.currency = currency;
return this;
}
/**
* The code corresponding to the currency for the tier's price.
* @return currency
*/
@javax.annotation.Nullable
public String getCurrency() {
return currency;
}
public void setCurrency(String currency) {
this.currency = currency;
}
public ProductRatePlanChargeTier discountAmount(Double discountAmount) {
this.discountAmount = discountAmount;
return this;
}
/**
* The specific amount for a fixed discount. Required if the charge model of the product rate plan charge is `Discount-Fixed Amount`.
* @return discountAmount
*/
@javax.annotation.Nullable
public Double getDiscountAmount() {
return discountAmount;
}
public void setDiscountAmount(Double discountAmount) {
this.discountAmount = discountAmount;
}
public ProductRatePlanChargeTier discountPercentage(Double discountPercentage) {
this.discountPercentage = discountPercentage;
return this;
}
/**
* The percentage of discount for a percentage discount. Required if the charge model of the product rate plan charge is `Discount-Percentage`.
* @return discountPercentage
*/
@javax.annotation.Nullable
public Double getDiscountPercentage() {
return discountPercentage;
}
public void setDiscountPercentage(Double discountPercentage) {
this.discountPercentage = discountPercentage;
}
public ProductRatePlanChargeTier endingUnit(Double endingUnit) {
this.endingUnit = endingUnit;
return this;
}
/**
* The end number of a range of units for the tier. Required if the charge model of the product rate plan charge is `Tiered Pricing` or `Tiered with Overage Pricing`.
* @return endingUnit
*/
@javax.annotation.Nullable
public Double getEndingUnit() {
return endingUnit;
}
public void setEndingUnit(Double endingUnit) {
this.endingUnit = endingUnit;
}
public ProductRatePlanChargeTier isOveragePrice(Boolean isOveragePrice) {
this.isOveragePrice = isOveragePrice;
return this;
}
/**
* Indicates if the price is an overage price, which is the price when usage surpasses the last defined tier.
* @return isOveragePrice
*/
@javax.annotation.Nullable
public Boolean getIsOveragePrice() {
return isOveragePrice;
}
public void setIsOveragePrice(Boolean isOveragePrice) {
this.isOveragePrice = isOveragePrice;
}
public ProductRatePlanChargeTier price(Double price) {
this.price = price;
return this;
}
/**
* The price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing.
* @return price
*/
@javax.annotation.Nullable
public Double getPrice() {
return price;
}
public void setPrice(Double price) {
this.price = price;
}
public ProductRatePlanChargeTier priceFormat(PriceFormatProductRatePlanChargeTier priceFormat) {
this.priceFormat = priceFormat;
return this;
}
/**
* Get priceFormat
* @return priceFormat
*/
@javax.annotation.Nullable
public PriceFormatProductRatePlanChargeTier getPriceFormat() {
return priceFormat;
}
public void setPriceFormat(PriceFormatProductRatePlanChargeTier priceFormat) {
this.priceFormat = priceFormat;
}
public ProductRatePlanChargeTier startingUnit(Double startingUnit) {
this.startingUnit = startingUnit;
return this;
}
/**
* The starting number of a range of units for the tier. Required if the charge model of the product rate plan charge is `Tiered Pricing` or `Tiered with Overage Pricing`.
* @return startingUnit
*/
@javax.annotation.Nullable
public Double getStartingUnit() {
return startingUnit;
}
public void setStartingUnit(Double startingUnit) {
this.startingUnit = startingUnit;
}
/**
* 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 ProductRatePlanChargeTier instance itself
*/
public ProductRatePlanChargeTier 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;
}
ProductRatePlanChargeTier productRatePlanChargeTier = (ProductRatePlanChargeTier) o;
return Objects.equals(this.currency, productRatePlanChargeTier.currency) &&
Objects.equals(this.discountAmount, productRatePlanChargeTier.discountAmount) &&
Objects.equals(this.discountPercentage, productRatePlanChargeTier.discountPercentage) &&
Objects.equals(this.endingUnit, productRatePlanChargeTier.endingUnit) &&
Objects.equals(this.isOveragePrice, productRatePlanChargeTier.isOveragePrice) &&
Objects.equals(this.price, productRatePlanChargeTier.price) &&
Objects.equals(this.priceFormat, productRatePlanChargeTier.priceFormat) &&
Objects.equals(this.startingUnit, productRatePlanChargeTier.startingUnit)&&
Objects.equals(this.additionalProperties, productRatePlanChargeTier.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(currency, discountAmount, discountPercentage, endingUnit, isOveragePrice, price, priceFormat, startingUnit, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class ProductRatePlanChargeTier {\n");
sb.append(" currency: ").append(toIndentedString(currency)).append("\n");
sb.append(" discountAmount: ").append(toIndentedString(discountAmount)).append("\n");
sb.append(" discountPercentage: ").append(toIndentedString(discountPercentage)).append("\n");
sb.append(" endingUnit: ").append(toIndentedString(endingUnit)).append("\n");
sb.append(" isOveragePrice: ").append(toIndentedString(isOveragePrice)).append("\n");
sb.append(" price: ").append(toIndentedString(price)).append("\n");
sb.append(" priceFormat: ").append(toIndentedString(priceFormat)).append("\n");
sb.append(" startingUnit: ").append(toIndentedString(startingUnit)).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("Currency");
openapiFields.add("DiscountAmount");
openapiFields.add("DiscountPercentage");
openapiFields.add("EndingUnit");
openapiFields.add("IsOveragePrice");
openapiFields.add("Price");
openapiFields.add("PriceFormat");
openapiFields.add("StartingUnit");
// 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 ProductRatePlanChargeTier
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!ProductRatePlanChargeTier.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in ProductRatePlanChargeTier is not found in the empty JSON string", ProductRatePlanChargeTier.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("Currency") != null && !jsonObj.get("Currency").isJsonNull()) && !jsonObj.get("Currency").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `Currency` to be a primitive type in the JSON string but got `%s`", jsonObj.get("Currency").toString()));
}
// validate the optional field `PriceFormat`
if (jsonObj.get("PriceFormat") != null && !jsonObj.get("PriceFormat").isJsonNull()) {
PriceFormatProductRatePlanChargeTier.validateJsonElement(jsonObj.get("PriceFormat"));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!ProductRatePlanChargeTier.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'ProductRatePlanChargeTier' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(ProductRatePlanChargeTier.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, ProductRatePlanChargeTier 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 ProductRatePlanChargeTier read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
ProductRatePlanChargeTier 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 ProductRatePlanChargeTier given an JSON string
*
* @param jsonString JSON string
* @return An instance of ProductRatePlanChargeTier
* @throws IOException if the JSON string is invalid with respect to ProductRatePlanChargeTier
*/
public static ProductRatePlanChargeTier fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, ProductRatePlanChargeTier.class);
}
/**
* Convert an instance of ProductRatePlanChargeTier to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy