com.zuora.model.GenerateBillingDocumentResponse 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.GenerateBillingDocumentResponseCreditMemo;
import com.zuora.model.GenerateBillingDocumentResponseInvoice;
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;
/**
* GenerateBillingDocumentResponse
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class GenerateBillingDocumentResponse {
public static final String SERIALIZED_NAME_CREDIT_MEMOS = "creditMemos";
@SerializedName(SERIALIZED_NAME_CREDIT_MEMOS)
private List creditMemos;
public static final String SERIALIZED_NAME_INVOICES = "invoices";
@SerializedName(SERIALIZED_NAME_INVOICES)
private List invoices;
public static final String SERIALIZED_NAME_SUCCESS = "success";
@SerializedName(SERIALIZED_NAME_SUCCESS)
private Boolean success;
public GenerateBillingDocumentResponse() {
}
public GenerateBillingDocumentResponse creditMemos(List creditMemos) {
this.creditMemos = creditMemos;
return this;
}
public GenerateBillingDocumentResponse addCreditMemosItem(GenerateBillingDocumentResponseCreditMemo creditMemosItem) {
if (this.creditMemos == null) {
this.creditMemos = new ArrayList<>();
}
this.creditMemos.add(creditMemosItem);
return this;
}
/**
* Container for generated credit memos. **Note:** This container is only available if 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.
* @return creditMemos
*/
@javax.annotation.Nullable
public List getCreditMemos() {
return creditMemos;
}
public void setCreditMemos(List creditMemos) {
this.creditMemos = creditMemos;
}
public GenerateBillingDocumentResponse invoices(List invoices) {
this.invoices = invoices;
return this;
}
public GenerateBillingDocumentResponse addInvoicesItem(GenerateBillingDocumentResponseInvoice invoicesItem) {
if (this.invoices == null) {
this.invoices = new ArrayList<>();
}
this.invoices.add(invoicesItem);
return this;
}
/**
* Container for generated invoices.
* @return invoices
*/
@javax.annotation.Nullable
public List getInvoices() {
return invoices;
}
public void setInvoices(List invoices) {
this.invoices = invoices;
}
public GenerateBillingDocumentResponse success(Boolean success) {
this.success = success;
return this;
}
/**
* Returns `true` if the request was processed successfully.
* @return success
*/
@javax.annotation.Nullable
public Boolean getSuccess() {
return success;
}
public void setSuccess(Boolean success) {
this.success = success;
}
/**
* 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 GenerateBillingDocumentResponse instance itself
*/
public GenerateBillingDocumentResponse 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;
}
GenerateBillingDocumentResponse generateBillingDocumentResponse = (GenerateBillingDocumentResponse) o;
return Objects.equals(this.creditMemos, generateBillingDocumentResponse.creditMemos) &&
Objects.equals(this.invoices, generateBillingDocumentResponse.invoices) &&
Objects.equals(this.success, generateBillingDocumentResponse.success)&&
Objects.equals(this.additionalProperties, generateBillingDocumentResponse.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(creditMemos, invoices, success, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class GenerateBillingDocumentResponse {\n");
sb.append(" creditMemos: ").append(toIndentedString(creditMemos)).append("\n");
sb.append(" invoices: ").append(toIndentedString(invoices)).append("\n");
sb.append(" success: ").append(toIndentedString(success)).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("creditMemos");
openapiFields.add("invoices");
openapiFields.add("success");
// 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 GenerateBillingDocumentResponse
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!GenerateBillingDocumentResponse.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in GenerateBillingDocumentResponse is not found in the empty JSON string", GenerateBillingDocumentResponse.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if (jsonObj.get("creditMemos") != null && !jsonObj.get("creditMemos").isJsonNull()) {
JsonArray jsonArraycreditMemos = jsonObj.getAsJsonArray("creditMemos");
if (jsonArraycreditMemos != null) {
// ensure the json data is an array
if (!jsonObj.get("creditMemos").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `creditMemos` to be an array in the JSON string but got `%s`", jsonObj.get("creditMemos").toString()));
}
// validate the optional field `creditMemos` (array)
for (int i = 0; i < jsonArraycreditMemos.size(); i++) {
GenerateBillingDocumentResponseCreditMemo.validateJsonElement(jsonArraycreditMemos.get(i));
};
}
}
if (jsonObj.get("invoices") != null && !jsonObj.get("invoices").isJsonNull()) {
JsonArray jsonArrayinvoices = jsonObj.getAsJsonArray("invoices");
if (jsonArrayinvoices != null) {
// ensure the json data is an array
if (!jsonObj.get("invoices").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `invoices` to be an array in the JSON string but got `%s`", jsonObj.get("invoices").toString()));
}
// validate the optional field `invoices` (array)
for (int i = 0; i < jsonArrayinvoices.size(); i++) {
GenerateBillingDocumentResponseInvoice.validateJsonElement(jsonArrayinvoices.get(i));
};
}
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!GenerateBillingDocumentResponse.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'GenerateBillingDocumentResponse' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(GenerateBillingDocumentResponse.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, GenerateBillingDocumentResponse 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 GenerateBillingDocumentResponse read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
GenerateBillingDocumentResponse 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 GenerateBillingDocumentResponse given an JSON string
*
* @param jsonString JSON string
* @return An instance of GenerateBillingDocumentResponse
* @throws IOException if the JSON string is invalid with respect to GenerateBillingDocumentResponse
*/
public static GenerateBillingDocumentResponse fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, GenerateBillingDocumentResponse.class);
}
/**
* Convert an instance of GenerateBillingDocumentResponse to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy