com.zuora.model.PreviewSubscriptionInvoiceItem 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.SubscriptionTaxationItem;
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;
/**
* PreviewSubscriptionInvoiceItem
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class PreviewSubscriptionInvoiceItem {
public static final String SERIALIZED_NAME_CHARGE_AMOUNT = "chargeAmount";
@SerializedName(SERIALIZED_NAME_CHARGE_AMOUNT)
private BigDecimal chargeAmount;
public static final String SERIALIZED_NAME_CHARGE_DESCRIPTION = "chargeDescription";
@SerializedName(SERIALIZED_NAME_CHARGE_DESCRIPTION)
private String chargeDescription;
public static final String SERIALIZED_NAME_CHARGE_NAME = "chargeName";
@SerializedName(SERIALIZED_NAME_CHARGE_NAME)
private String chargeName;
public static final String SERIALIZED_NAME_PRODUCT_NAME = "productName";
@SerializedName(SERIALIZED_NAME_PRODUCT_NAME)
private String productName;
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_SERVICE_END_DATE = "serviceEndDate";
@SerializedName(SERIALIZED_NAME_SERVICE_END_DATE)
private LocalDate serviceEndDate;
public static final String SERIALIZED_NAME_SERVICE_START_DATE = "serviceStartDate";
@SerializedName(SERIALIZED_NAME_SERVICE_START_DATE)
private LocalDate serviceStartDate;
public static final String SERIALIZED_NAME_TAX_AMOUNT = "taxAmount";
@SerializedName(SERIALIZED_NAME_TAX_AMOUNT)
private Double taxAmount;
public static final String SERIALIZED_NAME_TAXATION_ITEMS = "taxationItems";
@SerializedName(SERIALIZED_NAME_TAXATION_ITEMS)
private List taxationItems;
public static final String SERIALIZED_NAME_UNIT_OF_MEASURE = "unitOfMeasure";
@SerializedName(SERIALIZED_NAME_UNIT_OF_MEASURE)
private String unitOfMeasure;
public PreviewSubscriptionInvoiceItem() {
}
public PreviewSubscriptionInvoiceItem chargeAmount(BigDecimal chargeAmount) {
this.chargeAmount = chargeAmount;
return this;
}
/**
* The amount of the charge. This amount doesn't include taxes unless the charge's tax mode is inclusive.
* @return chargeAmount
*/
@javax.annotation.Nullable
public BigDecimal getChargeAmount() {
return chargeAmount;
}
public void setChargeAmount(BigDecimal chargeAmount) {
this.chargeAmount = chargeAmount;
}
public PreviewSubscriptionInvoiceItem chargeDescription(String chargeDescription) {
this.chargeDescription = chargeDescription;
return this;
}
/**
* Description of the charge.
* @return chargeDescription
*/
@javax.annotation.Nullable
public String getChargeDescription() {
return chargeDescription;
}
public void setChargeDescription(String chargeDescription) {
this.chargeDescription = chargeDescription;
}
public PreviewSubscriptionInvoiceItem chargeName(String chargeName) {
this.chargeName = chargeName;
return this;
}
/**
* Name of the charge.
* @return chargeName
*/
@javax.annotation.Nullable
public String getChargeName() {
return chargeName;
}
public void setChargeName(String chargeName) {
this.chargeName = chargeName;
}
public PreviewSubscriptionInvoiceItem productName(String productName) {
this.productName = productName;
return this;
}
/**
* Name of the product associated with this item.
* @return productName
*/
@javax.annotation.Nullable
public String getProductName() {
return productName;
}
public void setProductName(String productName) {
this.productName = productName;
}
public PreviewSubscriptionInvoiceItem productRatePlanChargeId(String productRatePlanChargeId) {
this.productRatePlanChargeId = productRatePlanChargeId;
return this;
}
/**
* ID of the product rate plan charge.
* @return productRatePlanChargeId
*/
@javax.annotation.Nullable
public String getProductRatePlanChargeId() {
return productRatePlanChargeId;
}
public void setProductRatePlanChargeId(String productRatePlanChargeId) {
this.productRatePlanChargeId = productRatePlanChargeId;
}
public PreviewSubscriptionInvoiceItem quantity(BigDecimal quantity) {
this.quantity = quantity;
return this;
}
/**
* Quantity of this item.
* @return quantity
*/
@javax.annotation.Nullable
public BigDecimal getQuantity() {
return quantity;
}
public void setQuantity(BigDecimal quantity) {
this.quantity = quantity;
}
public PreviewSubscriptionInvoiceItem serviceEndDate(LocalDate serviceEndDate) {
this.serviceEndDate = serviceEndDate;
return this;
}
/**
* End date of the service period for this item, i.e., the last day of the period, as yyyy-mm-dd.
* @return serviceEndDate
*/
@javax.annotation.Nullable
public LocalDate getServiceEndDate() {
return serviceEndDate;
}
public void setServiceEndDate(LocalDate serviceEndDate) {
this.serviceEndDate = serviceEndDate;
}
public PreviewSubscriptionInvoiceItem serviceStartDate(LocalDate serviceStartDate) {
this.serviceStartDate = serviceStartDate;
return this;
}
/**
* Service start date as yyyy-mm-dd. If the charge is a one-time fee, this is the date of that charge.
* @return serviceStartDate
*/
@javax.annotation.Nullable
public LocalDate getServiceStartDate() {
return serviceStartDate;
}
public void setServiceStartDate(LocalDate serviceStartDate) {
this.serviceStartDate = serviceStartDate;
}
public PreviewSubscriptionInvoiceItem taxAmount(Double taxAmount) {
this.taxAmount = taxAmount;
return this;
}
/**
* The tax amount of the invoice item.
* @return taxAmount
*/
@javax.annotation.Nullable
public Double getTaxAmount() {
return taxAmount;
}
public void setTaxAmount(Double taxAmount) {
this.taxAmount = taxAmount;
}
public PreviewSubscriptionInvoiceItem taxationItems(List taxationItems) {
this.taxationItems = taxationItems;
return this;
}
public PreviewSubscriptionInvoiceItem addTaxationItemsItem(SubscriptionTaxationItem taxationItemsItem) {
if (this.taxationItems == null) {
this.taxationItems = new ArrayList<>();
}
this.taxationItems.add(taxationItemsItem);
return this;
}
/**
* List of taxation items. **Note**: This field is only available if you set the `zuora-version` request header to `315.0` or later.
* @return taxationItems
*/
@javax.annotation.Nullable
public List getTaxationItems() {
return taxationItems;
}
public void setTaxationItems(List taxationItems) {
this.taxationItems = taxationItems;
}
public PreviewSubscriptionInvoiceItem unitOfMeasure(String unitOfMeasure) {
this.unitOfMeasure = unitOfMeasure;
return this;
}
/**
*
* @return unitOfMeasure
*/
@javax.annotation.Nullable
public String getUnitOfMeasure() {
return unitOfMeasure;
}
public void setUnitOfMeasure(String unitOfMeasure) {
this.unitOfMeasure = unitOfMeasure;
}
/**
* 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 PreviewSubscriptionInvoiceItem instance itself
*/
public PreviewSubscriptionInvoiceItem 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;
}
PreviewSubscriptionInvoiceItem previewSubscriptionInvoiceItem = (PreviewSubscriptionInvoiceItem) o;
return Objects.equals(this.chargeAmount, previewSubscriptionInvoiceItem.chargeAmount) &&
Objects.equals(this.chargeDescription, previewSubscriptionInvoiceItem.chargeDescription) &&
Objects.equals(this.chargeName, previewSubscriptionInvoiceItem.chargeName) &&
Objects.equals(this.productName, previewSubscriptionInvoiceItem.productName) &&
Objects.equals(this.productRatePlanChargeId, previewSubscriptionInvoiceItem.productRatePlanChargeId) &&
Objects.equals(this.quantity, previewSubscriptionInvoiceItem.quantity) &&
Objects.equals(this.serviceEndDate, previewSubscriptionInvoiceItem.serviceEndDate) &&
Objects.equals(this.serviceStartDate, previewSubscriptionInvoiceItem.serviceStartDate) &&
Objects.equals(this.taxAmount, previewSubscriptionInvoiceItem.taxAmount) &&
Objects.equals(this.taxationItems, previewSubscriptionInvoiceItem.taxationItems) &&
Objects.equals(this.unitOfMeasure, previewSubscriptionInvoiceItem.unitOfMeasure)&&
Objects.equals(this.additionalProperties, previewSubscriptionInvoiceItem.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(chargeAmount, chargeDescription, chargeName, productName, productRatePlanChargeId, quantity, serviceEndDate, serviceStartDate, taxAmount, taxationItems, unitOfMeasure, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class PreviewSubscriptionInvoiceItem {\n");
sb.append(" chargeAmount: ").append(toIndentedString(chargeAmount)).append("\n");
sb.append(" chargeDescription: ").append(toIndentedString(chargeDescription)).append("\n");
sb.append(" chargeName: ").append(toIndentedString(chargeName)).append("\n");
sb.append(" productName: ").append(toIndentedString(productName)).append("\n");
sb.append(" productRatePlanChargeId: ").append(toIndentedString(productRatePlanChargeId)).append("\n");
sb.append(" quantity: ").append(toIndentedString(quantity)).append("\n");
sb.append(" serviceEndDate: ").append(toIndentedString(serviceEndDate)).append("\n");
sb.append(" serviceStartDate: ").append(toIndentedString(serviceStartDate)).append("\n");
sb.append(" taxAmount: ").append(toIndentedString(taxAmount)).append("\n");
sb.append(" taxationItems: ").append(toIndentedString(taxationItems)).append("\n");
sb.append(" unitOfMeasure: ").append(toIndentedString(unitOfMeasure)).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("chargeAmount");
openapiFields.add("chargeDescription");
openapiFields.add("chargeName");
openapiFields.add("productName");
openapiFields.add("productRatePlanChargeId");
openapiFields.add("quantity");
openapiFields.add("serviceEndDate");
openapiFields.add("serviceStartDate");
openapiFields.add("taxAmount");
openapiFields.add("taxationItems");
openapiFields.add("unitOfMeasure");
// 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 PreviewSubscriptionInvoiceItem
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!PreviewSubscriptionInvoiceItem.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in PreviewSubscriptionInvoiceItem is not found in the empty JSON string", PreviewSubscriptionInvoiceItem.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("chargeDescription") != null && !jsonObj.get("chargeDescription").isJsonNull()) && !jsonObj.get("chargeDescription").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `chargeDescription` to be a primitive type in the JSON string but got `%s`", jsonObj.get("chargeDescription").toString()));
}
if ((jsonObj.get("chargeName") != null && !jsonObj.get("chargeName").isJsonNull()) && !jsonObj.get("chargeName").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `chargeName` to be a primitive type in the JSON string but got `%s`", jsonObj.get("chargeName").toString()));
}
if ((jsonObj.get("productName") != null && !jsonObj.get("productName").isJsonNull()) && !jsonObj.get("productName").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `productName` to be a primitive type in the JSON string but got `%s`", jsonObj.get("productName").toString()));
}
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("taxationItems") != null && !jsonObj.get("taxationItems").isJsonNull()) {
JsonArray jsonArraytaxationItems = jsonObj.getAsJsonArray("taxationItems");
if (jsonArraytaxationItems != null) {
// ensure the json data is an array
if (!jsonObj.get("taxationItems").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `taxationItems` to be an array in the JSON string but got `%s`", jsonObj.get("taxationItems").toString()));
}
// validate the optional field `taxationItems` (array)
for (int i = 0; i < jsonArraytaxationItems.size(); i++) {
SubscriptionTaxationItem.validateJsonElement(jsonArraytaxationItems.get(i));
};
}
}
if ((jsonObj.get("unitOfMeasure") != null && !jsonObj.get("unitOfMeasure").isJsonNull()) && !jsonObj.get("unitOfMeasure").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `unitOfMeasure` to be a primitive type in the JSON string but got `%s`", jsonObj.get("unitOfMeasure").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!PreviewSubscriptionInvoiceItem.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'PreviewSubscriptionInvoiceItem' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(PreviewSubscriptionInvoiceItem.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, PreviewSubscriptionInvoiceItem 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 PreviewSubscriptionInvoiceItem read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
PreviewSubscriptionInvoiceItem 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 PreviewSubscriptionInvoiceItem given an JSON string
*
* @param jsonString JSON string
* @return An instance of PreviewSubscriptionInvoiceItem
* @throws IOException if the JSON string is invalid with respect to PreviewSubscriptionInvoiceItem
*/
public static PreviewSubscriptionInvoiceItem fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, PreviewSubscriptionInvoiceItem.class);
}
/**
* Convert an instance of PreviewSubscriptionInvoiceItem to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy