com.zuora.model.BulkPdfGenerationJobRequest 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.DocumentIdList;
import com.zuora.model.IndexFileFormat;
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;
/**
* BulkPdfGenerationJobRequest
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class BulkPdfGenerationJobRequest {
public static final String SERIALIZED_NAME_DOCUMENTS = "documents";
@SerializedName(SERIALIZED_NAME_DOCUMENTS)
private List documents;
public static final String SERIALIZED_NAME_FILE_NAME = "fileName";
@SerializedName(SERIALIZED_NAME_FILE_NAME)
private String fileName;
public static final String SERIALIZED_NAME_NAME = "name";
@SerializedName(SERIALIZED_NAME_NAME)
private String name;
public static final String SERIALIZED_NAME_INDEX_FILE_FORMAT = "indexFileFormat";
@SerializedName(SERIALIZED_NAME_INDEX_FILE_FORMAT)
private IndexFileFormat indexFileFormat;
public static final String SERIALIZED_NAME_GENERATE_MISSING_P_D_F = "generateMissingPDF";
@SerializedName(SERIALIZED_NAME_GENERATE_MISSING_P_D_F)
private Boolean generateMissingPDF;
public static final String SERIALIZED_NAME_PERSIST_INDEX_FILE = "persistIndexFile";
@SerializedName(SERIALIZED_NAME_PERSIST_INDEX_FILE)
private Boolean persistIndexFile;
public BulkPdfGenerationJobRequest() {
}
public BulkPdfGenerationJobRequest documents(List documents) {
this.documents = documents;
return this;
}
public BulkPdfGenerationJobRequest addDocumentsItem(DocumentIdList documentsItem) {
if (this.documents == null) {
this.documents = new ArrayList<>();
}
this.documents.add(documentsItem);
return this;
}
/**
* Array that contains the collection of Objects where each object contains billing document type and their ids
* @return documents
*/
@javax.annotation.Nonnull
public List getDocuments() {
return documents;
}
public void setDocuments(List documents) {
this.documents = documents;
}
public BulkPdfGenerationJobRequest fileName(String fileName) {
this.fileName = fileName;
return this;
}
/**
* Prefix part of output file name(s). Eg: if fileName is \"all-invoices-posted-jan-2024\" then fileURL(s) contains this name as a prefix followed by suffix _{number}
* @return fileName
*/
@javax.annotation.Nonnull
public String getFileName() {
return fileName;
}
public void setFileName(String fileName) {
this.fileName = fileName;
}
public BulkPdfGenerationJobRequest name(String name) {
this.name = name;
return this;
}
/**
* Name of the Job
* @return name
*/
@javax.annotation.Nullable
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public BulkPdfGenerationJobRequest indexFileFormat(IndexFileFormat indexFileFormat) {
this.indexFileFormat = indexFileFormat;
return this;
}
/**
* Get indexFileFormat
* @return indexFileFormat
*/
@javax.annotation.Nonnull
public IndexFileFormat getIndexFileFormat() {
return indexFileFormat;
}
public void setIndexFileFormat(IndexFileFormat indexFileFormat) {
this.indexFileFormat = indexFileFormat;
}
public BulkPdfGenerationJobRequest generateMissingPDF(Boolean generateMissingPDF) {
this.generateMissingPDF = generateMissingPDF;
return this;
}
/**
* Flag which controls the behaviour of whether to generate the PDF(s) for the billing documents that doesn't have one - setting it to true indicates service would go through the provided document id list and then find those billing documents that doesn't have PDF generated and generate them all at once and then proceed to the zipping process - setting it to false indicates service would go through the provided document id list and find those billing documents that doesn't have PDF generated and mark them as Invalid and would skip them from zipping it. Ids marked invalid would be part of the response Default value is false
* @return generateMissingPDF
*/
@javax.annotation.Nullable
public Boolean getGenerateMissingPDF() {
return generateMissingPDF;
}
public void setGenerateMissingPDF(Boolean generateMissingPDF) {
this.generateMissingPDF = generateMissingPDF;
}
public BulkPdfGenerationJobRequest persistIndexFile(Boolean persistIndexFile) {
this.persistIndexFile = persistIndexFile;
return this;
}
/**
* Flag which controls whether to generated metadata/index file should be present in the final output file or not. - setting it to true will generate the metadata/index file and store them along with other PDF files in the final zip file(s). - setting it to false doesn't generate the metadata/index file and do not store them in the final zip file(s) Default value is true
* @return persistIndexFile
*/
@javax.annotation.Nullable
public Boolean getPersistIndexFile() {
return persistIndexFile;
}
public void setPersistIndexFile(Boolean persistIndexFile) {
this.persistIndexFile = persistIndexFile;
}
/**
* 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 BulkPdfGenerationJobRequest instance itself
*/
public BulkPdfGenerationJobRequest 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;
}
BulkPdfGenerationJobRequest bulkPdfGenerationJobRequest = (BulkPdfGenerationJobRequest) o;
return Objects.equals(this.documents, bulkPdfGenerationJobRequest.documents) &&
Objects.equals(this.fileName, bulkPdfGenerationJobRequest.fileName) &&
Objects.equals(this.name, bulkPdfGenerationJobRequest.name) &&
Objects.equals(this.indexFileFormat, bulkPdfGenerationJobRequest.indexFileFormat) &&
Objects.equals(this.generateMissingPDF, bulkPdfGenerationJobRequest.generateMissingPDF) &&
Objects.equals(this.persistIndexFile, bulkPdfGenerationJobRequest.persistIndexFile)&&
Objects.equals(this.additionalProperties, bulkPdfGenerationJobRequest.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(documents, fileName, name, indexFileFormat, generateMissingPDF, persistIndexFile, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class BulkPdfGenerationJobRequest {\n");
sb.append(" documents: ").append(toIndentedString(documents)).append("\n");
sb.append(" fileName: ").append(toIndentedString(fileName)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" indexFileFormat: ").append(toIndentedString(indexFileFormat)).append("\n");
sb.append(" generateMissingPDF: ").append(toIndentedString(generateMissingPDF)).append("\n");
sb.append(" persistIndexFile: ").append(toIndentedString(persistIndexFile)).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("documents");
openapiFields.add("fileName");
openapiFields.add("name");
openapiFields.add("indexFileFormat");
openapiFields.add("generateMissingPDF");
openapiFields.add("persistIndexFile");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("documents");
openapiRequiredFields.add("fileName");
openapiRequiredFields.add("indexFileFormat");
}
/**
* 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 BulkPdfGenerationJobRequest
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!BulkPdfGenerationJobRequest.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in BulkPdfGenerationJobRequest is not found in the empty JSON string", BulkPdfGenerationJobRequest.openapiRequiredFields.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : BulkPdfGenerationJobRequest.openapiRequiredFields) {
if (jsonElement.getAsJsonObject().get(requiredField) == null) {
throw new IllegalArgumentException(String.format("The required field `%s` is not found in the JSON string: %s", requiredField, jsonElement.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
// ensure the json data is an array
if (!jsonObj.get("documents").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `documents` to be an array in the JSON string but got `%s`", jsonObj.get("documents").toString()));
}
JsonArray jsonArraydocuments = jsonObj.getAsJsonArray("documents");
// validate the required field `documents` (array)
for (int i = 0; i < jsonArraydocuments.size(); i++) {
DocumentIdList.validateJsonElement(jsonArraydocuments.get(i));
};
if (!jsonObj.get("fileName").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `fileName` to be a primitive type in the JSON string but got `%s`", jsonObj.get("fileName").toString()));
}
if ((jsonObj.get("name") != null && !jsonObj.get("name").isJsonNull()) && !jsonObj.get("name").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `name` to be a primitive type in the JSON string but got `%s`", jsonObj.get("name").toString()));
}
// validate the required field `indexFileFormat`
IndexFileFormat.validateJsonElement(jsonObj.get("indexFileFormat"));
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!BulkPdfGenerationJobRequest.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'BulkPdfGenerationJobRequest' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(BulkPdfGenerationJobRequest.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, BulkPdfGenerationJobRequest 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 BulkPdfGenerationJobRequest read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
BulkPdfGenerationJobRequest 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 BulkPdfGenerationJobRequest given an JSON string
*
* @param jsonString JSON string
* @return An instance of BulkPdfGenerationJobRequest
* @throws IOException if the JSON string is invalid with respect to BulkPdfGenerationJobRequest
*/
public static BulkPdfGenerationJobRequest fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, BulkPdfGenerationJobRequest.class);
}
/**
* Convert an instance of BulkPdfGenerationJobRequest to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy