com.zuora.model.PreviewPaymentSchedule 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.PaymentSchedulePaymentOptionFields;
import java.io.IOException;
import java.math.BigDecimal;
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;
/**
* PreviewPaymentSchedule
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class PreviewPaymentSchedule {
public static final String SERIALIZED_NAME_AMOUNT = "amount";
@SerializedName(SERIALIZED_NAME_AMOUNT)
private BigDecimal amount;
public static final String SERIALIZED_NAME_CURRENCY = "currency";
@SerializedName(SERIALIZED_NAME_CURRENCY)
private String currency;
public static final String SERIALIZED_NAME_OCCURRENCES = "occurrences";
@SerializedName(SERIALIZED_NAME_OCCURRENCES)
private Integer occurrences;
public static final String SERIALIZED_NAME_PAYMENT_GATEWAY_ID = "paymentGatewayId";
@SerializedName(SERIALIZED_NAME_PAYMENT_GATEWAY_ID)
private String paymentGatewayId;
public static final String SERIALIZED_NAME_PAYMENT_METHOD_ID = "paymentMethodId";
@SerializedName(SERIALIZED_NAME_PAYMENT_METHOD_ID)
private String paymentMethodId;
public static final String SERIALIZED_NAME_PAYMENT_OPTION = "paymentOption";
@SerializedName(SERIALIZED_NAME_PAYMENT_OPTION)
private List paymentOption;
/**
* Indicates the updated period of the pending payment schedule items.
*/
@JsonAdapter(PeriodEnum.Adapter.class)
public enum PeriodEnum {
MONTHLY("Monthly"),
WEEKLY("Weekly"),
BIWEEKLY("BiWeekly");
private String value;
PeriodEnum(String value) {
this.value = value;
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static PeriodEnum fromValue(String value) {
for (PeriodEnum b : PeriodEnum.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 PeriodEnum enumeration) throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public PeriodEnum read(final JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return PeriodEnum.fromValue(value);
}
}
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
String value = jsonElement.getAsString();
PeriodEnum.fromValue(value);
}
}
public static final String SERIALIZED_NAME_PERIOD = "period";
@SerializedName(SERIALIZED_NAME_PERIOD)
private PeriodEnum period;
public static final String SERIALIZED_NAME_PERIOD_START_DATE = "periodStartDate";
@SerializedName(SERIALIZED_NAME_PERIOD_START_DATE)
private LocalDate periodStartDate;
public static final String SERIALIZED_NAME_RUN_HOUR = "runHour";
@SerializedName(SERIALIZED_NAME_RUN_HOUR)
private Integer runHour;
public PreviewPaymentSchedule() {
}
public PreviewPaymentSchedule amount(BigDecimal amount) {
this.amount = amount;
return this;
}
/**
* Indicates the updated amount of the pending payment schedule items.
* @return amount
*/
@javax.annotation.Nullable
public BigDecimal getAmount() {
return amount;
}
public void setAmount(BigDecimal amount) {
this.amount = amount;
}
public PreviewPaymentSchedule currency(String currency) {
this.currency = currency;
return this;
}
/**
* Indicates the updated currency of the pending payment schedule items.
* @return currency
*/
@javax.annotation.Nullable
public String getCurrency() {
return currency;
}
public void setCurrency(String currency) {
this.currency = currency;
}
public PreviewPaymentSchedule occurrences(Integer occurrences) {
this.occurrences = occurrences;
return this;
}
/**
* Indicates the updated number of payment schedule items that are created by the payment schedule.
* @return occurrences
*/
@javax.annotation.Nullable
public Integer getOccurrences() {
return occurrences;
}
public void setOccurrences(Integer occurrences) {
this.occurrences = occurrences;
}
public PreviewPaymentSchedule paymentGatewayId(String paymentGatewayId) {
this.paymentGatewayId = paymentGatewayId;
return this;
}
/**
* Indicates the updated payment gateway ID of the pending payment schedule items.
* @return paymentGatewayId
*/
@javax.annotation.Nullable
public String getPaymentGatewayId() {
return paymentGatewayId;
}
public void setPaymentGatewayId(String paymentGatewayId) {
this.paymentGatewayId = paymentGatewayId;
}
public PreviewPaymentSchedule paymentMethodId(String paymentMethodId) {
this.paymentMethodId = paymentMethodId;
return this;
}
/**
* Indicates the updated payment method ID of the pending payment schedule items.
* @return paymentMethodId
*/
@javax.annotation.Nullable
public String getPaymentMethodId() {
return paymentMethodId;
}
public void setPaymentMethodId(String paymentMethodId) {
this.paymentMethodId = paymentMethodId;
}
public PreviewPaymentSchedule paymentOption(List paymentOption) {
this.paymentOption = paymentOption;
return this;
}
public PreviewPaymentSchedule addPaymentOptionItem(PaymentSchedulePaymentOptionFields paymentOptionItem) {
if (this.paymentOption == null) {
this.paymentOption = new ArrayList<>();
}
this.paymentOption.add(paymentOptionItem);
return this;
}
/**
* Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported. Here is an example: ``` \"paymentOption\": [ { \"type\": \"GatewayOptions\", \"detail\": { \"SecCode\":\"WEB\" } } ] ``` `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item. To enable this field, submit a request at [Zuora Global Support](https://support.zuora.com/). This field is only available if `zuora-version` is set to `337.0` or later.
* @return paymentOption
*/
@javax.annotation.Nullable
public List getPaymentOption() {
return paymentOption;
}
public void setPaymentOption(List paymentOption) {
this.paymentOption = paymentOption;
}
public PreviewPaymentSchedule period(PeriodEnum period) {
this.period = period;
return this;
}
/**
* Indicates the updated period of the pending payment schedule items.
* @return period
*/
@javax.annotation.Nullable
public PeriodEnum getPeriod() {
return period;
}
public void setPeriod(PeriodEnum period) {
this.period = period;
}
public PreviewPaymentSchedule periodStartDate(LocalDate periodStartDate) {
this.periodStartDate = periodStartDate;
return this;
}
/**
* Indicates the updated collection date for the next pending payment schedule item.
* @return periodStartDate
*/
@javax.annotation.Nullable
public LocalDate getPeriodStartDate() {
return periodStartDate;
}
public void setPeriodStartDate(LocalDate periodStartDate) {
this.periodStartDate = periodStartDate;
}
public PreviewPaymentSchedule runHour(Integer runHour) {
this.runHour = runHour;
return this;
}
/**
* Specifies at which hour of the day in the tenant’s time zone this payment will be collected. Available values: `[0,1,2,~,22,23]`. If the time difference between your tenant’s timezone and the timezone where Zuora servers are is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half hour later than your scheduled time. If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.
* @return runHour
*/
@javax.annotation.Nullable
public Integer getRunHour() {
return runHour;
}
public void setRunHour(Integer runHour) {
this.runHour = runHour;
}
/**
* 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 PreviewPaymentSchedule instance itself
*/
public PreviewPaymentSchedule 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;
}
PreviewPaymentSchedule previewPaymentSchedule = (PreviewPaymentSchedule) o;
return Objects.equals(this.amount, previewPaymentSchedule.amount) &&
Objects.equals(this.currency, previewPaymentSchedule.currency) &&
Objects.equals(this.occurrences, previewPaymentSchedule.occurrences) &&
Objects.equals(this.paymentGatewayId, previewPaymentSchedule.paymentGatewayId) &&
Objects.equals(this.paymentMethodId, previewPaymentSchedule.paymentMethodId) &&
Objects.equals(this.paymentOption, previewPaymentSchedule.paymentOption) &&
Objects.equals(this.period, previewPaymentSchedule.period) &&
Objects.equals(this.periodStartDate, previewPaymentSchedule.periodStartDate) &&
Objects.equals(this.runHour, previewPaymentSchedule.runHour)&&
Objects.equals(this.additionalProperties, previewPaymentSchedule.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(amount, currency, occurrences, paymentGatewayId, paymentMethodId, paymentOption, period, periodStartDate, runHour, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class PreviewPaymentSchedule {\n");
sb.append(" amount: ").append(toIndentedString(amount)).append("\n");
sb.append(" currency: ").append(toIndentedString(currency)).append("\n");
sb.append(" occurrences: ").append(toIndentedString(occurrences)).append("\n");
sb.append(" paymentGatewayId: ").append(toIndentedString(paymentGatewayId)).append("\n");
sb.append(" paymentMethodId: ").append(toIndentedString(paymentMethodId)).append("\n");
sb.append(" paymentOption: ").append(toIndentedString(paymentOption)).append("\n");
sb.append(" period: ").append(toIndentedString(period)).append("\n");
sb.append(" periodStartDate: ").append(toIndentedString(periodStartDate)).append("\n");
sb.append(" runHour: ").append(toIndentedString(runHour)).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("amount");
openapiFields.add("currency");
openapiFields.add("occurrences");
openapiFields.add("paymentGatewayId");
openapiFields.add("paymentMethodId");
openapiFields.add("paymentOption");
openapiFields.add("period");
openapiFields.add("periodStartDate");
openapiFields.add("runHour");
// 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 PreviewPaymentSchedule
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!PreviewPaymentSchedule.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in PreviewPaymentSchedule is not found in the empty JSON string", PreviewPaymentSchedule.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("currency") != null && !jsonObj.get("currency").isJsonNull()) && !jsonObj.get("currency").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `currency` to be a primitive type in the JSON string but got `%s`", jsonObj.get("currency").toString()));
}
if ((jsonObj.get("paymentGatewayId") != null && !jsonObj.get("paymentGatewayId").isJsonNull()) && !jsonObj.get("paymentGatewayId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `paymentGatewayId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("paymentGatewayId").toString()));
}
if ((jsonObj.get("paymentMethodId") != null && !jsonObj.get("paymentMethodId").isJsonNull()) && !jsonObj.get("paymentMethodId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `paymentMethodId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("paymentMethodId").toString()));
}
if (jsonObj.get("paymentOption") != null && !jsonObj.get("paymentOption").isJsonNull()) {
JsonArray jsonArraypaymentOption = jsonObj.getAsJsonArray("paymentOption");
if (jsonArraypaymentOption != null) {
// ensure the json data is an array
if (!jsonObj.get("paymentOption").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `paymentOption` to be an array in the JSON string but got `%s`", jsonObj.get("paymentOption").toString()));
}
// validate the optional field `paymentOption` (array)
for (int i = 0; i < jsonArraypaymentOption.size(); i++) {
PaymentSchedulePaymentOptionFields.validateJsonElement(jsonArraypaymentOption.get(i));
};
}
}
if ((jsonObj.get("period") != null && !jsonObj.get("period").isJsonNull()) && !jsonObj.get("period").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `period` to be a primitive type in the JSON string but got `%s`", jsonObj.get("period").toString()));
}
// validate the optional field `period`
if (jsonObj.get("period") != null && !jsonObj.get("period").isJsonNull()) {
PeriodEnum.validateJsonElement(jsonObj.get("period"));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!PreviewPaymentSchedule.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'PreviewPaymentSchedule' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(PreviewPaymentSchedule.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, PreviewPaymentSchedule 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 PreviewPaymentSchedule read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
PreviewPaymentSchedule 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 PreviewPaymentSchedule given an JSON string
*
* @param jsonString JSON string
* @return An instance of PreviewPaymentSchedule
* @throws IOException if the JSON string is invalid with respect to PreviewPaymentSchedule
*/
public static PreviewPaymentSchedule fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, PreviewPaymentSchedule.class);
}
/**
* Convert an instance of PreviewPaymentSchedule to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy