com.zuora.model.EmailBillingDocumentRequest 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 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;
/**
* EmailBillingDocumentRequest
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class EmailBillingDocumentRequest {
public static final String SERIALIZED_NAME_EMAIL_ADDRESSES = "emailAddresses";
@SerializedName(SERIALIZED_NAME_EMAIL_ADDRESSES)
private String emailAddresses;
public static final String SERIALIZED_NAME_INCLUDE_ADDITIONAL_EMAIL_ADDRESSES = "includeAdditionalEmailAddresses";
@SerializedName(SERIALIZED_NAME_INCLUDE_ADDITIONAL_EMAIL_ADDRESSES)
private Boolean includeAdditionalEmailAddresses = false;
public static final String SERIALIZED_NAME_PDF_FILE_ID = "pdfFileId";
@SerializedName(SERIALIZED_NAME_PDF_FILE_ID)
private String pdfFileId;
public static final String SERIALIZED_NAME_USE_EMAIL_TEMPLATE_SETTING = "useEmailTemplateSetting";
@SerializedName(SERIALIZED_NAME_USE_EMAIL_TEMPLATE_SETTING)
private Boolean useEmailTemplateSetting = false;
public EmailBillingDocumentRequest() {
}
public EmailBillingDocumentRequest emailAddresses(String emailAddresses) {
this.emailAddresses = emailAddresses;
return this;
}
/**
* The valid email addresses you want to email a billing document to. Use commas to separate email addresses. **Note:** This field is only applicable if you set the `useEmailTemplateSetting` field to `false`.
* @return emailAddresses
*/
@javax.annotation.Nullable
public String getEmailAddresses() {
return emailAddresses;
}
public void setEmailAddresses(String emailAddresses) {
this.emailAddresses = emailAddresses;
}
public EmailBillingDocumentRequest includeAdditionalEmailAddresses(Boolean includeAdditionalEmailAddresses) {
this.includeAdditionalEmailAddresses = includeAdditionalEmailAddresses;
return this;
}
/**
* Indicates whether to send a billing document to the additional email addresses of the memo account. You can set the additional email addresses in the **Additional Email Addresses** field on the account detail page from the Zuora UI. See [Create a Customer Account](https://knowledgecenter.zuora.com/BC_Subscription_Management/Customer_Accounts/B_Create_a_Customer_Account#section_2) for more information.
* @return includeAdditionalEmailAddresses
*/
@javax.annotation.Nullable
public Boolean getIncludeAdditionalEmailAddresses() {
return includeAdditionalEmailAddresses;
}
public void setIncludeAdditionalEmailAddresses(Boolean includeAdditionalEmailAddresses) {
this.includeAdditionalEmailAddresses = includeAdditionalEmailAddresses;
}
public EmailBillingDocumentRequest pdfFileId(String pdfFileId) {
this.pdfFileId = pdfFileId;
return this;
}
/**
* The ID of the PDF file that you want to send in the email. If you do not specify any PDF file ID, the latest PDF file generated for the billing document is sent in the email.
* @return pdfFileId
*/
@javax.annotation.Nullable
public String getPdfFileId() {
return pdfFileId;
}
public void setPdfFileId(String pdfFileId) {
this.pdfFileId = pdfFileId;
}
public EmailBillingDocumentRequest useEmailTemplateSetting(Boolean useEmailTemplateSetting) {
this.useEmailTemplateSetting = useEmailTemplateSetting;
return this;
}
/**
* Indicates whether to email a billing document based on the email template setting. If you set this field to `true`, the billing document is sent to the email addresses specified in the **To Email** field of the email template. The email template is the one you set in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. See [Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information about how to edit the **To Email** field in the email template.
* @return useEmailTemplateSetting
*/
@javax.annotation.Nullable
public Boolean getUseEmailTemplateSetting() {
return useEmailTemplateSetting;
}
public void setUseEmailTemplateSetting(Boolean useEmailTemplateSetting) {
this.useEmailTemplateSetting = useEmailTemplateSetting;
}
/**
* 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 EmailBillingDocumentRequest instance itself
*/
public EmailBillingDocumentRequest 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;
}
EmailBillingDocumentRequest emailBillingDocumentRequest = (EmailBillingDocumentRequest) o;
return Objects.equals(this.emailAddresses, emailBillingDocumentRequest.emailAddresses) &&
Objects.equals(this.includeAdditionalEmailAddresses, emailBillingDocumentRequest.includeAdditionalEmailAddresses) &&
Objects.equals(this.pdfFileId, emailBillingDocumentRequest.pdfFileId) &&
Objects.equals(this.useEmailTemplateSetting, emailBillingDocumentRequest.useEmailTemplateSetting)&&
Objects.equals(this.additionalProperties, emailBillingDocumentRequest.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(emailAddresses, includeAdditionalEmailAddresses, pdfFileId, useEmailTemplateSetting, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class EmailBillingDocumentRequest {\n");
sb.append(" emailAddresses: ").append(toIndentedString(emailAddresses)).append("\n");
sb.append(" includeAdditionalEmailAddresses: ").append(toIndentedString(includeAdditionalEmailAddresses)).append("\n");
sb.append(" pdfFileId: ").append(toIndentedString(pdfFileId)).append("\n");
sb.append(" useEmailTemplateSetting: ").append(toIndentedString(useEmailTemplateSetting)).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("emailAddresses");
openapiFields.add("includeAdditionalEmailAddresses");
openapiFields.add("pdfFileId");
openapiFields.add("useEmailTemplateSetting");
// 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 EmailBillingDocumentRequest
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!EmailBillingDocumentRequest.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in EmailBillingDocumentRequest is not found in the empty JSON string", EmailBillingDocumentRequest.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("emailAddresses") != null && !jsonObj.get("emailAddresses").isJsonNull()) && !jsonObj.get("emailAddresses").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `emailAddresses` to be a primitive type in the JSON string but got `%s`", jsonObj.get("emailAddresses").toString()));
}
if ((jsonObj.get("pdfFileId") != null && !jsonObj.get("pdfFileId").isJsonNull()) && !jsonObj.get("pdfFileId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `pdfFileId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("pdfFileId").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!EmailBillingDocumentRequest.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'EmailBillingDocumentRequest' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(EmailBillingDocumentRequest.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, EmailBillingDocumentRequest 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 EmailBillingDocumentRequest read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
EmailBillingDocumentRequest 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 EmailBillingDocumentRequest given an JSON string
*
* @param jsonString JSON string
* @return An instance of EmailBillingDocumentRequest
* @throws IOException if the JSON string is invalid with respect to EmailBillingDocumentRequest
*/
public static EmailBillingDocumentRequest fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, EmailBillingDocumentRequest.class);
}
/**
* Convert an instance of EmailBillingDocumentRequest to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy