com.zuora.model.UpdateInvoiceScheduleRequest 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.InvoiceScheduleSubscription;
import com.zuora.model.UpdateInvoiceScheduleItem;
import java.io.IOException;
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;
/**
* UpdateInvoiceScheduleRequest
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class UpdateInvoiceScheduleRequest {
public static final String SERIALIZED_NAME_ADDITIONAL_SUBSCRIPTIONS_TO_BILL = "additionalSubscriptionsToBill";
@SerializedName(SERIALIZED_NAME_ADDITIONAL_SUBSCRIPTIONS_TO_BILL)
private List additionalSubscriptionsToBill;
public static final String SERIALIZED_NAME_INVOICE_SEPARATELY = "invoiceSeparately";
@SerializedName(SERIALIZED_NAME_INVOICE_SEPARATELY)
private Boolean invoiceSeparately;
public static final String SERIALIZED_NAME_NEXT_RUN_DATE = "nextRunDate";
@SerializedName(SERIALIZED_NAME_NEXT_RUN_DATE)
private LocalDate nextRunDate;
public static final String SERIALIZED_NAME_NOTES = "notes";
@SerializedName(SERIALIZED_NAME_NOTES)
private String notes;
public static final String SERIALIZED_NAME_ORDERS = "orders";
@SerializedName(SERIALIZED_NAME_ORDERS)
private List orders;
public static final String SERIALIZED_NAME_SCHEDULE_ITEMS = "scheduleItems";
@SerializedName(SERIALIZED_NAME_SCHEDULE_ITEMS)
private List scheduleItems;
public static final String SERIALIZED_NAME_SPECIFIC_SUBSCRIPTIONS = "specificSubscriptions";
@SerializedName(SERIALIZED_NAME_SPECIFIC_SUBSCRIPTIONS)
private List specificSubscriptions;
public UpdateInvoiceScheduleRequest() {
}
public UpdateInvoiceScheduleRequest additionalSubscriptionsToBill(List additionalSubscriptionsToBill) {
this.additionalSubscriptionsToBill = additionalSubscriptionsToBill;
return this;
}
public UpdateInvoiceScheduleRequest addAdditionalSubscriptionsToBillItem(String additionalSubscriptionsToBillItem) {
if (this.additionalSubscriptionsToBill == null) {
this.additionalSubscriptionsToBill = new ArrayList<>();
}
this.additionalSubscriptionsToBill.add(additionalSubscriptionsToBillItem);
return this;
}
/**
* A list of the numbers of the subscriptions that need to be billed together with the invoice schedule. One invoice schedule can have at most 600 additional subscriptions.
* @return additionalSubscriptionsToBill
*/
@javax.annotation.Nullable
public List getAdditionalSubscriptionsToBill() {
return additionalSubscriptionsToBill;
}
public void setAdditionalSubscriptionsToBill(List additionalSubscriptionsToBill) {
this.additionalSubscriptionsToBill = additionalSubscriptionsToBill;
}
public UpdateInvoiceScheduleRequest invoiceSeparately(Boolean invoiceSeparately) {
this.invoiceSeparately = invoiceSeparately;
return this;
}
/**
* Whether the invoice items created from the invoice schedule appears on a separate invoice when Zuora generates invoices.
* @return invoiceSeparately
*/
@javax.annotation.Nullable
public Boolean getInvoiceSeparately() {
return invoiceSeparately;
}
public void setInvoiceSeparately(Boolean invoiceSeparately) {
this.invoiceSeparately = invoiceSeparately;
}
public UpdateInvoiceScheduleRequest nextRunDate(LocalDate nextRunDate) {
this.nextRunDate = nextRunDate;
return this;
}
/**
* The run date of the next execution of the invoice schedule. By default, the next run date is the same as the run date of next pending invoice schedule item. The date can be overwritten by a different date other than the default value. If the invoice schedule has completed the execution, the next run date is `null`.
* @return nextRunDate
*/
@javax.annotation.Nullable
public LocalDate getNextRunDate() {
return nextRunDate;
}
public void setNextRunDate(LocalDate nextRunDate) {
this.nextRunDate = nextRunDate;
}
public UpdateInvoiceScheduleRequest notes(String notes) {
this.notes = notes;
return this;
}
/**
* Comments on the invoice schedule.
* @return notes
*/
@javax.annotation.Nullable
public String getNotes() {
return notes;
}
public void setNotes(String notes) {
this.notes = notes;
}
public UpdateInvoiceScheduleRequest orders(List orders) {
this.orders = orders;
return this;
}
public UpdateInvoiceScheduleRequest addOrdersItem(String ordersItem) {
if (this.orders == null) {
this.orders = new ArrayList<>();
}
this.orders.add(ordersItem);
return this;
}
/**
* A list of the IDs or numbers of the orders associated with the invoice schedule. One invoice schedule can be associated with at most 10 orders. The orders specified in this field override all the existing orders associated with the invoice schedule.
* @return orders
*/
@javax.annotation.Nullable
public List getOrders() {
return orders;
}
public void setOrders(List orders) {
this.orders = orders;
}
public UpdateInvoiceScheduleRequest scheduleItems(List scheduleItems) {
this.scheduleItems = scheduleItems;
return this;
}
public UpdateInvoiceScheduleRequest addScheduleItemsItem(UpdateInvoiceScheduleItem scheduleItemsItem) {
if (this.scheduleItems == null) {
this.scheduleItems = new ArrayList<>();
}
this.scheduleItems.add(scheduleItemsItem);
return this;
}
/**
* Container for invoice schedule items. The maximum number of schedule items is 50. The invoice schedule items specified in this field override all the existing invoice schedule items.
* @return scheduleItems
*/
@javax.annotation.Nullable
public List getScheduleItems() {
return scheduleItems;
}
public void setScheduleItems(List scheduleItems) {
this.scheduleItems = scheduleItems;
}
public UpdateInvoiceScheduleRequest specificSubscriptions(List specificSubscriptions) {
this.specificSubscriptions = specificSubscriptions;
return this;
}
public UpdateInvoiceScheduleRequest addSpecificSubscriptionsItem(InvoiceScheduleSubscription specificSubscriptionsItem) {
if (this.specificSubscriptions == null) {
this.specificSubscriptions = new ArrayList<>();
}
this.specificSubscriptions.add(specificSubscriptionsItem);
return this;
}
/**
* A list of the numbers of specific subscriptions associated with the invoice schedule. - If the subscriptions specified in this field belong to the orders specified in the `orders` field, only the specific subscriptions instead of the orders are associated with the invoice schedule. - If only the `orders` field is specified, all the subscriptions from the order are associated with the invoice schedule. The specific subscriptions specified in this field override all the existing specific subscriptions associated with the invoice schedule. Example: ``` { \"orders\": [ \"O-00000001\", \"O-00000002\" ], \"specificSubscriptions\": [ { \"orderKey\": \"O-00000001\", \"subscriptionKey\": \"S-00000001\" } ] } ``` - For the order with number O-00000001, only subscription S-00000001 contained in the order is associated with the invoice schedule. - For the order with number O-00000002, all subscriptions contained in the order are associated with the invoice schedule.
* @return specificSubscriptions
*/
@javax.annotation.Nullable
public List getSpecificSubscriptions() {
return specificSubscriptions;
}
public void setSpecificSubscriptions(List specificSubscriptions) {
this.specificSubscriptions = specificSubscriptions;
}
/**
* 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 UpdateInvoiceScheduleRequest instance itself
*/
public UpdateInvoiceScheduleRequest 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;
}
UpdateInvoiceScheduleRequest updateInvoiceScheduleRequest = (UpdateInvoiceScheduleRequest) o;
return Objects.equals(this.additionalSubscriptionsToBill, updateInvoiceScheduleRequest.additionalSubscriptionsToBill) &&
Objects.equals(this.invoiceSeparately, updateInvoiceScheduleRequest.invoiceSeparately) &&
Objects.equals(this.nextRunDate, updateInvoiceScheduleRequest.nextRunDate) &&
Objects.equals(this.notes, updateInvoiceScheduleRequest.notes) &&
Objects.equals(this.orders, updateInvoiceScheduleRequest.orders) &&
Objects.equals(this.scheduleItems, updateInvoiceScheduleRequest.scheduleItems) &&
Objects.equals(this.specificSubscriptions, updateInvoiceScheduleRequest.specificSubscriptions)&&
Objects.equals(this.additionalProperties, updateInvoiceScheduleRequest.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(additionalSubscriptionsToBill, invoiceSeparately, nextRunDate, notes, orders, scheduleItems, specificSubscriptions, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class UpdateInvoiceScheduleRequest {\n");
sb.append(" additionalSubscriptionsToBill: ").append(toIndentedString(additionalSubscriptionsToBill)).append("\n");
sb.append(" invoiceSeparately: ").append(toIndentedString(invoiceSeparately)).append("\n");
sb.append(" nextRunDate: ").append(toIndentedString(nextRunDate)).append("\n");
sb.append(" notes: ").append(toIndentedString(notes)).append("\n");
sb.append(" orders: ").append(toIndentedString(orders)).append("\n");
sb.append(" scheduleItems: ").append(toIndentedString(scheduleItems)).append("\n");
sb.append(" specificSubscriptions: ").append(toIndentedString(specificSubscriptions)).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("additionalSubscriptionsToBill");
openapiFields.add("invoiceSeparately");
openapiFields.add("nextRunDate");
openapiFields.add("notes");
openapiFields.add("orders");
openapiFields.add("scheduleItems");
openapiFields.add("specificSubscriptions");
// 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 UpdateInvoiceScheduleRequest
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!UpdateInvoiceScheduleRequest.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in UpdateInvoiceScheduleRequest is not found in the empty JSON string", UpdateInvoiceScheduleRequest.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
// ensure the optional json data is an array if present
if (jsonObj.get("additionalSubscriptionsToBill") != null && !jsonObj.get("additionalSubscriptionsToBill").isJsonNull() && !jsonObj.get("additionalSubscriptionsToBill").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `additionalSubscriptionsToBill` to be an array in the JSON string but got `%s`", jsonObj.get("additionalSubscriptionsToBill").toString()));
}
if ((jsonObj.get("notes") != null && !jsonObj.get("notes").isJsonNull()) && !jsonObj.get("notes").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `notes` to be a primitive type in the JSON string but got `%s`", jsonObj.get("notes").toString()));
}
// ensure the optional json data is an array if present
if (jsonObj.get("orders") != null && !jsonObj.get("orders").isJsonNull() && !jsonObj.get("orders").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `orders` to be an array in the JSON string but got `%s`", jsonObj.get("orders").toString()));
}
if (jsonObj.get("scheduleItems") != null && !jsonObj.get("scheduleItems").isJsonNull()) {
JsonArray jsonArrayscheduleItems = jsonObj.getAsJsonArray("scheduleItems");
if (jsonArrayscheduleItems != null) {
// ensure the json data is an array
if (!jsonObj.get("scheduleItems").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `scheduleItems` to be an array in the JSON string but got `%s`", jsonObj.get("scheduleItems").toString()));
}
// validate the optional field `scheduleItems` (array)
for (int i = 0; i < jsonArrayscheduleItems.size(); i++) {
UpdateInvoiceScheduleItem.validateJsonElement(jsonArrayscheduleItems.get(i));
};
}
}
if (jsonObj.get("specificSubscriptions") != null && !jsonObj.get("specificSubscriptions").isJsonNull()) {
JsonArray jsonArrayspecificSubscriptions = jsonObj.getAsJsonArray("specificSubscriptions");
if (jsonArrayspecificSubscriptions != null) {
// ensure the json data is an array
if (!jsonObj.get("specificSubscriptions").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `specificSubscriptions` to be an array in the JSON string but got `%s`", jsonObj.get("specificSubscriptions").toString()));
}
// validate the optional field `specificSubscriptions` (array)
for (int i = 0; i < jsonArrayspecificSubscriptions.size(); i++) {
InvoiceScheduleSubscription.validateJsonElement(jsonArrayspecificSubscriptions.get(i));
};
}
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!UpdateInvoiceScheduleRequest.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'UpdateInvoiceScheduleRequest' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(UpdateInvoiceScheduleRequest.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, UpdateInvoiceScheduleRequest 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 UpdateInvoiceScheduleRequest read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
UpdateInvoiceScheduleRequest 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 UpdateInvoiceScheduleRequest given an JSON string
*
* @param jsonString JSON string
* @return An instance of UpdateInvoiceScheduleRequest
* @throws IOException if the JSON string is invalid with respect to UpdateInvoiceScheduleRequest
*/
public static UpdateInvoiceScheduleRequest fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, UpdateInvoiceScheduleRequest.class);
}
/**
* Convert an instance of UpdateInvoiceScheduleRequest to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy