com.zuora.model.UpdatePaymentScheduleItemRequest 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.PaymentScheduleLinkedPaymentID;
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;
/**
* UpdatePaymentScheduleItemRequest
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class UpdatePaymentScheduleItemRequest {
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_DESCRIPTION = "description";
@SerializedName(SERIALIZED_NAME_DESCRIPTION)
private String description;
public static final String SERIALIZED_NAME_LINK_PAYMENTS = "linkPayments";
@SerializedName(SERIALIZED_NAME_LINK_PAYMENTS)
private List linkPayments;
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_ID = "paymentId";
@Deprecated
@SerializedName(SERIALIZED_NAME_PAYMENT_ID)
private String paymentId;
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;
public static final String SERIALIZED_NAME_RUN_HOUR = "runHour";
@SerializedName(SERIALIZED_NAME_RUN_HOUR)
private Integer runHour;
public static final String SERIALIZED_NAME_SCHEDULED_DATE = "scheduledDate";
@SerializedName(SERIALIZED_NAME_SCHEDULED_DATE)
private LocalDate scheduledDate;
public static final String SERIALIZED_NAME_UNLINK_PAYMENTS = "unlinkPayments";
@SerializedName(SERIALIZED_NAME_UNLINK_PAYMENTS)
private List unlinkPayments;
public UpdatePaymentScheduleItemRequest() {
}
public UpdatePaymentScheduleItemRequest amount(BigDecimal amount) {
this.amount = amount;
return this;
}
/**
* The amount of the payment.
* @return amount
*/
@javax.annotation.Nullable
public BigDecimal getAmount() {
return amount;
}
public void setAmount(BigDecimal amount) {
this.amount = amount;
}
public UpdatePaymentScheduleItemRequest currency(String currency) {
this.currency = currency;
return this;
}
/**
* The currency of the payment.
* @return currency
*/
@javax.annotation.Nullable
public String getCurrency() {
return currency;
}
public void setCurrency(String currency) {
this.currency = currency;
}
public UpdatePaymentScheduleItemRequest description(String description) {
this.description = description;
return this;
}
/**
* The description of the payment schedule item.
* @return description
*/
@javax.annotation.Nullable
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
public UpdatePaymentScheduleItemRequest linkPayments(List linkPayments) {
this.linkPayments = linkPayments;
return this;
}
public UpdatePaymentScheduleItemRequest addLinkPaymentsItem(PaymentScheduleLinkedPaymentID linkPaymentsItem) {
if (this.linkPayments == null) {
this.linkPayments = new ArrayList<>();
}
this.linkPayments.add(linkPaymentsItem);
return this;
}
/**
* Container for payments linked to the payment schedule item.
* @return linkPayments
*/
@javax.annotation.Nullable
public List getLinkPayments() {
return linkPayments;
}
public void setLinkPayments(List linkPayments) {
this.linkPayments = linkPayments;
}
public UpdatePaymentScheduleItemRequest paymentGatewayId(String paymentGatewayId) {
this.paymentGatewayId = paymentGatewayId;
return this;
}
/**
* ID of the payment gateway of the payment schedule item.
* @return paymentGatewayId
*/
@javax.annotation.Nullable
public String getPaymentGatewayId() {
return paymentGatewayId;
}
public void setPaymentGatewayId(String paymentGatewayId) {
this.paymentGatewayId = paymentGatewayId;
}
@Deprecated
public UpdatePaymentScheduleItemRequest paymentId(String paymentId) {
this.paymentId = paymentId;
return this;
}
/**
* ID of the payment to be linked to the payment schedule item. **Note**: This feild is version controlled. To enable this field, you must set `zuora-version` to equal or smaller than `336.0`.
* @return paymentId
* @deprecated
*/
@Deprecated
@javax.annotation.Nullable
public String getPaymentId() {
return paymentId;
}
@Deprecated
public void setPaymentId(String paymentId) {
this.paymentId = paymentId;
}
public UpdatePaymentScheduleItemRequest paymentMethodId(String paymentMethodId) {
this.paymentMethodId = paymentMethodId;
return this;
}
/**
* ID of the payment method of the payment schedule item.
* @return paymentMethodId
*/
@javax.annotation.Nullable
public String getPaymentMethodId() {
return paymentMethodId;
}
public void setPaymentMethodId(String paymentMethodId) {
this.paymentMethodId = paymentMethodId;
}
public UpdatePaymentScheduleItemRequest paymentOption(List paymentOption) {
this.paymentOption = paymentOption;
return this;
}
public UpdatePaymentScheduleItemRequest 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 UpdatePaymentScheduleItemRequest runHour(Integer runHour) {
this.runHour = runHour;
return this;
}
/**
* At which hour of the day in the tenant’s timezone this payment will be collected. 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;
}
public UpdatePaymentScheduleItemRequest scheduledDate(LocalDate scheduledDate) {
this.scheduledDate = scheduledDate;
return this;
}
/**
* The scheduled date when the payment is processed.
* @return scheduledDate
*/
@javax.annotation.Nullable
public LocalDate getScheduledDate() {
return scheduledDate;
}
public void setScheduledDate(LocalDate scheduledDate) {
this.scheduledDate = scheduledDate;
}
public UpdatePaymentScheduleItemRequest unlinkPayments(List unlinkPayments) {
this.unlinkPayments = unlinkPayments;
return this;
}
public UpdatePaymentScheduleItemRequest addUnlinkPaymentsItem(PaymentScheduleLinkedPaymentID unlinkPaymentsItem) {
if (this.unlinkPayments == null) {
this.unlinkPayments = new ArrayList<>();
}
this.unlinkPayments.add(unlinkPaymentsItem);
return this;
}
/**
* Container for payments to be unlinked from the payment schedule item.
* @return unlinkPayments
*/
@javax.annotation.Nullable
public List getUnlinkPayments() {
return unlinkPayments;
}
public void setUnlinkPayments(List unlinkPayments) {
this.unlinkPayments = unlinkPayments;
}
/**
* 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 UpdatePaymentScheduleItemRequest instance itself
*/
public UpdatePaymentScheduleItemRequest 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;
}
UpdatePaymentScheduleItemRequest updatePaymentScheduleItemRequest = (UpdatePaymentScheduleItemRequest) o;
return Objects.equals(this.amount, updatePaymentScheduleItemRequest.amount) &&
Objects.equals(this.currency, updatePaymentScheduleItemRequest.currency) &&
Objects.equals(this.description, updatePaymentScheduleItemRequest.description) &&
Objects.equals(this.linkPayments, updatePaymentScheduleItemRequest.linkPayments) &&
Objects.equals(this.paymentGatewayId, updatePaymentScheduleItemRequest.paymentGatewayId) &&
Objects.equals(this.paymentId, updatePaymentScheduleItemRequest.paymentId) &&
Objects.equals(this.paymentMethodId, updatePaymentScheduleItemRequest.paymentMethodId) &&
Objects.equals(this.paymentOption, updatePaymentScheduleItemRequest.paymentOption) &&
Objects.equals(this.runHour, updatePaymentScheduleItemRequest.runHour) &&
Objects.equals(this.scheduledDate, updatePaymentScheduleItemRequest.scheduledDate) &&
Objects.equals(this.unlinkPayments, updatePaymentScheduleItemRequest.unlinkPayments)&&
Objects.equals(this.additionalProperties, updatePaymentScheduleItemRequest.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(amount, currency, description, linkPayments, paymentGatewayId, paymentId, paymentMethodId, paymentOption, runHour, scheduledDate, unlinkPayments, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class UpdatePaymentScheduleItemRequest {\n");
sb.append(" amount: ").append(toIndentedString(amount)).append("\n");
sb.append(" currency: ").append(toIndentedString(currency)).append("\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" linkPayments: ").append(toIndentedString(linkPayments)).append("\n");
sb.append(" paymentGatewayId: ").append(toIndentedString(paymentGatewayId)).append("\n");
sb.append(" paymentId: ").append(toIndentedString(paymentId)).append("\n");
sb.append(" paymentMethodId: ").append(toIndentedString(paymentMethodId)).append("\n");
sb.append(" paymentOption: ").append(toIndentedString(paymentOption)).append("\n");
sb.append(" runHour: ").append(toIndentedString(runHour)).append("\n");
sb.append(" scheduledDate: ").append(toIndentedString(scheduledDate)).append("\n");
sb.append(" unlinkPayments: ").append(toIndentedString(unlinkPayments)).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("description");
openapiFields.add("linkPayments");
openapiFields.add("paymentGatewayId");
openapiFields.add("paymentId");
openapiFields.add("paymentMethodId");
openapiFields.add("paymentOption");
openapiFields.add("runHour");
openapiFields.add("scheduledDate");
openapiFields.add("unlinkPayments");
// 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 UpdatePaymentScheduleItemRequest
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!UpdatePaymentScheduleItemRequest.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in UpdatePaymentScheduleItemRequest is not found in the empty JSON string", UpdatePaymentScheduleItemRequest.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("description") != null && !jsonObj.get("description").isJsonNull()) && !jsonObj.get("description").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `description` to be a primitive type in the JSON string but got `%s`", jsonObj.get("description").toString()));
}
if (jsonObj.get("linkPayments") != null && !jsonObj.get("linkPayments").isJsonNull()) {
JsonArray jsonArraylinkPayments = jsonObj.getAsJsonArray("linkPayments");
if (jsonArraylinkPayments != null) {
// ensure the json data is an array
if (!jsonObj.get("linkPayments").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `linkPayments` to be an array in the JSON string but got `%s`", jsonObj.get("linkPayments").toString()));
}
// validate the optional field `linkPayments` (array)
for (int i = 0; i < jsonArraylinkPayments.size(); i++) {
PaymentScheduleLinkedPaymentID.validateJsonElement(jsonArraylinkPayments.get(i));
};
}
}
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("paymentId") != null && !jsonObj.get("paymentId").isJsonNull()) && !jsonObj.get("paymentId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `paymentId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("paymentId").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("unlinkPayments") != null && !jsonObj.get("unlinkPayments").isJsonNull()) {
JsonArray jsonArrayunlinkPayments = jsonObj.getAsJsonArray("unlinkPayments");
if (jsonArrayunlinkPayments != null) {
// ensure the json data is an array
if (!jsonObj.get("unlinkPayments").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `unlinkPayments` to be an array in the JSON string but got `%s`", jsonObj.get("unlinkPayments").toString()));
}
// validate the optional field `unlinkPayments` (array)
for (int i = 0; i < jsonArrayunlinkPayments.size(); i++) {
PaymentScheduleLinkedPaymentID.validateJsonElement(jsonArrayunlinkPayments.get(i));
};
}
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!UpdatePaymentScheduleItemRequest.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'UpdatePaymentScheduleItemRequest' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(UpdatePaymentScheduleItemRequest.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, UpdatePaymentScheduleItemRequest 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 UpdatePaymentScheduleItemRequest read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
UpdatePaymentScheduleItemRequest 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 UpdatePaymentScheduleItemRequest given an JSON string
*
* @param jsonString JSON string
* @return An instance of UpdatePaymentScheduleItemRequest
* @throws IOException if the JSON string is invalid with respect to UpdatePaymentScheduleItemRequest
*/
public static UpdatePaymentScheduleItemRequest fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, UpdatePaymentScheduleItemRequest.class);
}
/**
* Convert an instance of UpdatePaymentScheduleItemRequest to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy