com.zuora.model.BillRunSchedule 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.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;
/**
* Container for information about the scheduled bill run.
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class BillRunSchedule {
public static final String SERIALIZED_NAME_REPEAT_FROM = "repeatFrom";
@SerializedName(SERIALIZED_NAME_REPEAT_FROM)
private LocalDate repeatFrom;
public static final String SERIALIZED_NAME_REPEAT_TO = "repeatTo";
@SerializedName(SERIALIZED_NAME_REPEAT_TO)
private LocalDate repeatTo;
/**
* The repeat type of the bill run.
*/
@JsonAdapter(RepeatTypeEnum.Adapter.class)
public enum RepeatTypeEnum {
NONE("None"),
DAILY("Daily"),
WEEKLY("Weekly"),
MONTHLY("Monthly");
private String value;
RepeatTypeEnum(String value) {
this.value = value;
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static RepeatTypeEnum fromValue(String value) {
for (RepeatTypeEnum b : RepeatTypeEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
public static class Adapter extends TypeAdapter {
@Override
public void write(final JsonWriter jsonWriter, final RepeatTypeEnum enumeration) throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public RepeatTypeEnum read(final JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return RepeatTypeEnum.fromValue(value);
}
}
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
String value = jsonElement.getAsString();
RepeatTypeEnum.fromValue(value);
}
}
public static final String SERIALIZED_NAME_REPEAT_TYPE = "repeatType";
@SerializedName(SERIALIZED_NAME_REPEAT_TYPE)
private RepeatTypeEnum repeatType;
public static final String SERIALIZED_NAME_RUN_TIME = "runTime";
@SerializedName(SERIALIZED_NAME_RUN_TIME)
private Integer runTime;
/**
* Gets or Sets weeklyOnDay
*/
@JsonAdapter(WeeklyOnDayEnum.Adapter.class)
public enum WeeklyOnDayEnum {
MON("Mon"),
TUE("Tue"),
WED("Wed"),
THU("Thu"),
FRI("Fri"),
SAT("Sat"),
SUN("Sun");
private String value;
WeeklyOnDayEnum(String value) {
this.value = value;
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static WeeklyOnDayEnum fromValue(String value) {
for (WeeklyOnDayEnum b : WeeklyOnDayEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
public static class Adapter extends TypeAdapter {
@Override
public void write(final JsonWriter jsonWriter, final WeeklyOnDayEnum enumeration) throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public WeeklyOnDayEnum read(final JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return WeeklyOnDayEnum.fromValue(value);
}
}
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
String value = jsonElement.getAsString();
WeeklyOnDayEnum.fromValue(value);
}
}
public static final String SERIALIZED_NAME_WEEKLY_ON_DAY = "weeklyOnDay";
@SerializedName(SERIALIZED_NAME_WEEKLY_ON_DAY)
private List weeklyOnDay;
public static final String SERIALIZED_NAME_MONTHLY_ON_END_OF_MONTH = "monthlyOnEndOfMonth";
@SerializedName(SERIALIZED_NAME_MONTHLY_ON_END_OF_MONTH)
private Boolean monthlyOnEndOfMonth;
public BillRunSchedule() {
}
public BillRunSchedule repeatFrom(LocalDate repeatFrom) {
this.repeatFrom = repeatFrom;
return this;
}
/**
* The start date of the scheduled bill run.
* @return repeatFrom
*/
@javax.annotation.Nullable
public LocalDate getRepeatFrom() {
return repeatFrom;
}
public void setRepeatFrom(LocalDate repeatFrom) {
this.repeatFrom = repeatFrom;
}
public BillRunSchedule repeatTo(LocalDate repeatTo) {
this.repeatTo = repeatTo;
return this;
}
/**
* The end date of of the scheduled bill run.
* @return repeatTo
*/
@javax.annotation.Nullable
public LocalDate getRepeatTo() {
return repeatTo;
}
public void setRepeatTo(LocalDate repeatTo) {
this.repeatTo = repeatTo;
}
public BillRunSchedule repeatType(RepeatTypeEnum repeatType) {
this.repeatType = repeatType;
return this;
}
/**
* The repeat type of the bill run.
* @return repeatType
*/
@javax.annotation.Nullable
public RepeatTypeEnum getRepeatType() {
return repeatType;
}
public void setRepeatType(RepeatTypeEnum repeatType) {
this.repeatType = repeatType;
}
public BillRunSchedule runTime(Integer runTime) {
this.runTime = runTime;
return this;
}
/**
* The scheduled run time (hour) of day. **Values:** 0 - 23
* @return runTime
*/
@javax.annotation.Nullable
public Integer getRunTime() {
return runTime;
}
public void setRunTime(Integer runTime) {
this.runTime = runTime;
}
public BillRunSchedule weeklyOnDay(List weeklyOnDay) {
this.weeklyOnDay = weeklyOnDay;
return this;
}
public BillRunSchedule addWeeklyOnDayItem(WeeklyOnDayEnum weeklyOnDayItem) {
if (this.weeklyOnDay == null) {
this.weeklyOnDay = new ArrayList<>();
}
this.weeklyOnDay.add(weeklyOnDayItem);
return this;
}
/**
* The repeat day in a week.
* @return weeklyOnDay
*/
@javax.annotation.Nullable
public List getWeeklyOnDay() {
return weeklyOnDay;
}
public void setWeeklyOnDay(List weeklyOnDay) {
this.weeklyOnDay = weeklyOnDay;
}
public BillRunSchedule monthlyOnEndOfMonth(Boolean monthlyOnEndOfMonth) {
this.monthlyOnEndOfMonth = monthlyOnEndOfMonth;
return this;
}
/**
* Whether to schedule monthly bill run on the end of month or the specific day of month. This field is available only when repeatType is set to monthly and repeatFrom is set to the end of month. For example: - When repeatFrom = '2024-04-30' and monthlyOnEndOfMonth = true, next bill run will be scheduled on 2024-05-31 - When repeatFrom = '2024-04-30' and monthlyOnEndOfMonth = false, next bill run will be scheduled on 2024-05-30
* @return monthlyOnEndOfMonth
*/
@javax.annotation.Nullable
public Boolean getMonthlyOnEndOfMonth() {
return monthlyOnEndOfMonth;
}
public void setMonthlyOnEndOfMonth(Boolean monthlyOnEndOfMonth) {
this.monthlyOnEndOfMonth = monthlyOnEndOfMonth;
}
/**
* 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 BillRunSchedule instance itself
*/
public BillRunSchedule 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;
}
BillRunSchedule billRunSchedule = (BillRunSchedule) o;
return Objects.equals(this.repeatFrom, billRunSchedule.repeatFrom) &&
Objects.equals(this.repeatTo, billRunSchedule.repeatTo) &&
Objects.equals(this.repeatType, billRunSchedule.repeatType) &&
Objects.equals(this.runTime, billRunSchedule.runTime) &&
Objects.equals(this.weeklyOnDay, billRunSchedule.weeklyOnDay) &&
Objects.equals(this.monthlyOnEndOfMonth, billRunSchedule.monthlyOnEndOfMonth)&&
Objects.equals(this.additionalProperties, billRunSchedule.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(repeatFrom, repeatTo, repeatType, runTime, weeklyOnDay, monthlyOnEndOfMonth, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class BillRunSchedule {\n");
sb.append(" repeatFrom: ").append(toIndentedString(repeatFrom)).append("\n");
sb.append(" repeatTo: ").append(toIndentedString(repeatTo)).append("\n");
sb.append(" repeatType: ").append(toIndentedString(repeatType)).append("\n");
sb.append(" runTime: ").append(toIndentedString(runTime)).append("\n");
sb.append(" weeklyOnDay: ").append(toIndentedString(weeklyOnDay)).append("\n");
sb.append(" monthlyOnEndOfMonth: ").append(toIndentedString(monthlyOnEndOfMonth)).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("repeatFrom");
openapiFields.add("repeatTo");
openapiFields.add("repeatType");
openapiFields.add("runTime");
openapiFields.add("weeklyOnDay");
openapiFields.add("monthlyOnEndOfMonth");
// 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 BillRunSchedule
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!BillRunSchedule.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in BillRunSchedule is not found in the empty JSON string", BillRunSchedule.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("repeatType") != null && !jsonObj.get("repeatType").isJsonNull()) && !jsonObj.get("repeatType").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `repeatType` to be a primitive type in the JSON string but got `%s`", jsonObj.get("repeatType").toString()));
}
// validate the optional field `repeatType`
if (jsonObj.get("repeatType") != null && !jsonObj.get("repeatType").isJsonNull()) {
RepeatTypeEnum.validateJsonElement(jsonObj.get("repeatType"));
}
// ensure the optional json data is an array if present
if (jsonObj.get("weeklyOnDay") != null && !jsonObj.get("weeklyOnDay").isJsonNull() && !jsonObj.get("weeklyOnDay").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `weeklyOnDay` to be an array in the JSON string but got `%s`", jsonObj.get("weeklyOnDay").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!BillRunSchedule.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'BillRunSchedule' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(BillRunSchedule.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, BillRunSchedule 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 BillRunSchedule read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
BillRunSchedule 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 BillRunSchedule given an JSON string
*
* @param jsonString JSON string
* @return An instance of BillRunSchedule
* @throws IOException if the JSON string is invalid with respect to BillRunSchedule
*/
public static BillRunSchedule fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, BillRunSchedule.class);
}
/**
* Convert an instance of BillRunSchedule to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy