com.zuora.model.SubscriptionCreditMemo 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.SubscriptionCreditMemoItem;
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;
/**
* Container for credit memos. **Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later in the request header, and you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class SubscriptionCreditMemo {
public static final String SERIALIZED_NAME_AMOUNT = "amount";
@SerializedName(SERIALIZED_NAME_AMOUNT)
private Double amount;
public static final String SERIALIZED_NAME_AMOUNT_WITHOUT_TAX = "amountWithoutTax";
@SerializedName(SERIALIZED_NAME_AMOUNT_WITHOUT_TAX)
private Double amountWithoutTax;
public static final String SERIALIZED_NAME_CREDIT_MEMO_ITEMS = "creditMemoItems";
@SerializedName(SERIALIZED_NAME_CREDIT_MEMO_ITEMS)
private List creditMemoItems;
public static final String SERIALIZED_NAME_TAX_AMOUNT = "taxAmount";
@SerializedName(SERIALIZED_NAME_TAX_AMOUNT)
private Double taxAmount;
public SubscriptionCreditMemo() {
}
public SubscriptionCreditMemo amount(Double amount) {
this.amount = amount;
return this;
}
/**
* Credit memo amount.
* @return amount
*/
@javax.annotation.Nullable
public Double getAmount() {
return amount;
}
public void setAmount(Double amount) {
this.amount = amount;
}
public SubscriptionCreditMemo amountWithoutTax(Double amountWithoutTax) {
this.amountWithoutTax = amountWithoutTax;
return this;
}
/**
* Credit memo amount minus tax.
* @return amountWithoutTax
*/
@javax.annotation.Nullable
public Double getAmountWithoutTax() {
return amountWithoutTax;
}
public void setAmountWithoutTax(Double amountWithoutTax) {
this.amountWithoutTax = amountWithoutTax;
}
public SubscriptionCreditMemo creditMemoItems(List creditMemoItems) {
this.creditMemoItems = creditMemoItems;
return this;
}
public SubscriptionCreditMemo addCreditMemoItemsItem(SubscriptionCreditMemoItem creditMemoItemsItem) {
if (this.creditMemoItems == null) {
this.creditMemoItems = new ArrayList<>();
}
this.creditMemoItems.add(creditMemoItemsItem);
return this;
}
/**
*
* @return creditMemoItems
*/
@javax.annotation.Nullable
public List getCreditMemoItems() {
return creditMemoItems;
}
public void setCreditMemoItems(List creditMemoItems) {
this.creditMemoItems = creditMemoItems;
}
public SubscriptionCreditMemo taxAmount(Double taxAmount) {
this.taxAmount = taxAmount;
return this;
}
/**
* Tax amount on the credit memo.
* @return taxAmount
*/
@javax.annotation.Nullable
public Double getTaxAmount() {
return taxAmount;
}
public void setTaxAmount(Double taxAmount) {
this.taxAmount = taxAmount;
}
/**
* 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 SubscriptionCreditMemo instance itself
*/
public SubscriptionCreditMemo 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;
}
SubscriptionCreditMemo subscriptionCreditMemo = (SubscriptionCreditMemo) o;
return Objects.equals(this.amount, subscriptionCreditMemo.amount) &&
Objects.equals(this.amountWithoutTax, subscriptionCreditMemo.amountWithoutTax) &&
Objects.equals(this.creditMemoItems, subscriptionCreditMemo.creditMemoItems) &&
Objects.equals(this.taxAmount, subscriptionCreditMemo.taxAmount)&&
Objects.equals(this.additionalProperties, subscriptionCreditMemo.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(amount, amountWithoutTax, creditMemoItems, taxAmount, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class SubscriptionCreditMemo {\n");
sb.append(" amount: ").append(toIndentedString(amount)).append("\n");
sb.append(" amountWithoutTax: ").append(toIndentedString(amountWithoutTax)).append("\n");
sb.append(" creditMemoItems: ").append(toIndentedString(creditMemoItems)).append("\n");
sb.append(" taxAmount: ").append(toIndentedString(taxAmount)).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("amount");
openapiFields.add("amountWithoutTax");
openapiFields.add("creditMemoItems");
openapiFields.add("taxAmount");
// 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 SubscriptionCreditMemo
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!SubscriptionCreditMemo.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in SubscriptionCreditMemo is not found in the empty JSON string", SubscriptionCreditMemo.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if (jsonObj.get("creditMemoItems") != null && !jsonObj.get("creditMemoItems").isJsonNull()) {
JsonArray jsonArraycreditMemoItems = jsonObj.getAsJsonArray("creditMemoItems");
if (jsonArraycreditMemoItems != null) {
// ensure the json data is an array
if (!jsonObj.get("creditMemoItems").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `creditMemoItems` to be an array in the JSON string but got `%s`", jsonObj.get("creditMemoItems").toString()));
}
// validate the optional field `creditMemoItems` (array)
for (int i = 0; i < jsonArraycreditMemoItems.size(); i++) {
SubscriptionCreditMemoItem.validateJsonElement(jsonArraycreditMemoItems.get(i));
};
}
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!SubscriptionCreditMemo.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'SubscriptionCreditMemo' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(SubscriptionCreditMemo.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, SubscriptionCreditMemo 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 SubscriptionCreditMemo read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
SubscriptionCreditMemo 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 SubscriptionCreditMemo given an JSON string
*
* @param jsonString JSON string
* @return An instance of SubscriptionCreditMemo
* @throws IOException if the JSON string is invalid with respect to SubscriptionCreditMemo
*/
public static SubscriptionCreditMemo fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, SubscriptionCreditMemo.class);
}
/**
* Convert an instance of SubscriptionCreditMemo to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy