com.zuora.model.ProcessingOptions 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.BillingOptions;
import com.zuora.model.ElectronicPaymentOptions;
import com.zuora.model.WriteOffBehavior;
import java.io.IOException;
import java.math.BigDecimal;
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;
/**
* The container for billing processing options and payment processing options. **Note:** - This field is not supported in draft orders. - When you use the \"Create an order\" operation to create an account, create a subscription, run billing, and collect payment in a single call, if any error occurs during the call, such as a payment processing failure and a tax engine failure, then all the other steps will be rolled back. In this case, neither the invoice will be generated, nor the subscription nor the account will be created. - When you use the \"Create an order\" operation to cancel a subscription with `refund` and `writeOff`, if the `refund` or `writeOff` fails, `cancelSubscription`, `runBilling`, and `collectPayment` still can succeed. - When you use the \"Create an order\" operation, the `collectPayment` and `refund` fields cannot be set to `true` simultaneously. Otherwise, the order will not be proceeded.
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class ProcessingOptions {
public static final String SERIALIZED_NAME_APPLICATION_ORDER = "applicationOrder";
@SerializedName(SERIALIZED_NAME_APPLICATION_ORDER)
private List applicationOrder;
public static final String SERIALIZED_NAME_APPLY_CREDIT = "applyCredit";
@SerializedName(SERIALIZED_NAME_APPLY_CREDIT)
private Boolean applyCredit;
public static final String SERIALIZED_NAME_APPLY_CREDIT_BALANCE = "applyCreditBalance";
@SerializedName(SERIALIZED_NAME_APPLY_CREDIT_BALANCE)
private Boolean applyCreditBalance;
public static final String SERIALIZED_NAME_BILLING_OPTIONS = "billingOptions";
@SerializedName(SERIALIZED_NAME_BILLING_OPTIONS)
private BillingOptions billingOptions;
public static final String SERIALIZED_NAME_COLLECT_PAYMENT = "collectPayment";
@SerializedName(SERIALIZED_NAME_COLLECT_PAYMENT)
private Boolean collectPayment;
public static final String SERIALIZED_NAME_ELECTRONIC_PAYMENT_OPTIONS = "electronicPaymentOptions";
@SerializedName(SERIALIZED_NAME_ELECTRONIC_PAYMENT_OPTIONS)
private ElectronicPaymentOptions electronicPaymentOptions;
public static final String SERIALIZED_NAME_REFUND = "refund";
@SerializedName(SERIALIZED_NAME_REFUND)
private Boolean refund;
public static final String SERIALIZED_NAME_REFUND_AMOUNT = "refundAmount";
@SerializedName(SERIALIZED_NAME_REFUND_AMOUNT)
private BigDecimal refundAmount;
public static final String SERIALIZED_NAME_REFUND_REASON_CODE = "refundReasonCode";
@SerializedName(SERIALIZED_NAME_REFUND_REASON_CODE)
private String refundReasonCode;
public static final String SERIALIZED_NAME_RUN_BILLING = "runBilling";
@SerializedName(SERIALIZED_NAME_RUN_BILLING)
private Boolean runBilling;
public static final String SERIALIZED_NAME_WRITE_OFF = "writeOff";
@SerializedName(SERIALIZED_NAME_WRITE_OFF)
private Boolean writeOff;
public static final String SERIALIZED_NAME_WRITE_OFF_BEHAVIOR = "writeOffBehavior";
@SerializedName(SERIALIZED_NAME_WRITE_OFF_BEHAVIOR)
private WriteOffBehavior writeOffBehavior;
public ProcessingOptions() {
}
public ProcessingOptions applicationOrder(List applicationOrder) {
this.applicationOrder = applicationOrder;
return this;
}
public ProcessingOptions addApplicationOrderItem(String applicationOrderItem) {
if (this.applicationOrder == null) {
this.applicationOrder = new ArrayList<>();
}
this.applicationOrder.add(applicationOrderItem);
return this;
}
/**
* The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`. **Note:** - This field is valid only if the `applyCredit` field is set to `true`. - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments. - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices.
* @return applicationOrder
*/
@javax.annotation.Nullable
public List getApplicationOrder() {
return applicationOrder;
}
public void setApplicationOrder(List applicationOrder) {
this.applicationOrder = applicationOrder;
}
public ProcessingOptions applyCredit(Boolean applyCredit) {
this.applyCredit = applyCredit;
return this;
}
/**
* Whether to automatically apply credit memos or unapplied payments, or both to an invoice. If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices. **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.
* @return applyCredit
*/
@javax.annotation.Nullable
public Boolean getApplyCredit() {
return applyCredit;
}
public void setApplyCredit(Boolean applyCredit) {
this.applyCredit = applyCredit;
}
public ProcessingOptions applyCreditBalance(Boolean applyCreditBalance) {
this.applyCreditBalance = applyCreditBalance;
return this;
}
/**
* Indicates if any credit balance on a customer's account is automatically applied to invoices. If no value is specified then this field defaults to false. This feature is not available if you have enabled the Invoice Settlement feature.
* @return applyCreditBalance
*/
@javax.annotation.Nullable
public Boolean getApplyCreditBalance() {
return applyCreditBalance;
}
public void setApplyCreditBalance(Boolean applyCreditBalance) {
this.applyCreditBalance = applyCreditBalance;
}
public ProcessingOptions billingOptions(BillingOptions billingOptions) {
this.billingOptions = billingOptions;
return this;
}
/**
* Get billingOptions
* @return billingOptions
*/
@javax.annotation.Nullable
public BillingOptions getBillingOptions() {
return billingOptions;
}
public void setBillingOptions(BillingOptions billingOptions) {
this.billingOptions = billingOptions;
}
public ProcessingOptions collectPayment(Boolean collectPayment) {
this.collectPayment = collectPayment;
return this;
}
/**
* Indicates if the current request needs to collect payments. This value can not be 'true' when 'runBilling' flag is 'false'.
* @return collectPayment
*/
@javax.annotation.Nullable
public Boolean getCollectPayment() {
return collectPayment;
}
public void setCollectPayment(Boolean collectPayment) {
this.collectPayment = collectPayment;
}
public ProcessingOptions electronicPaymentOptions(ElectronicPaymentOptions electronicPaymentOptions) {
this.electronicPaymentOptions = electronicPaymentOptions;
return this;
}
/**
* Get electronicPaymentOptions
* @return electronicPaymentOptions
*/
@javax.annotation.Nullable
public ElectronicPaymentOptions getElectronicPaymentOptions() {
return electronicPaymentOptions;
}
public void setElectronicPaymentOptions(ElectronicPaymentOptions electronicPaymentOptions) {
this.electronicPaymentOptions = electronicPaymentOptions;
}
public ProcessingOptions refund(Boolean refund) {
this.refund = refund;
return this;
}
/**
* Indicates whether to refund after subscription cancelation. Default is `false`. **Note**: When refunding a subscription that is not invoiced separately, if you do not enable the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Invoice_Settlement/C_Invoice_Item_Settlement\" target=\"_blank\">Invoice Item Settlement</a> feature, you will encounter the following error during the cancel and refund process: “Cancellation/Refund failed because of the following reason: Invoice is linked to multiple subscriptions. Cancellation was not processed.”
* @return refund
*/
@javax.annotation.Nullable
public Boolean getRefund() {
return refund;
}
public void setRefund(Boolean refund) {
this.refund = refund;
}
public ProcessingOptions refundAmount(BigDecimal refundAmount) {
this.refundAmount = refundAmount;
return this;
}
/**
* Indicates the amount to be refunded. Required if the `refund` field is `true`.
* @return refundAmount
*/
@javax.annotation.Nullable
public BigDecimal getRefundAmount() {
return refundAmount;
}
public void setRefundAmount(BigDecimal refundAmount) {
this.refundAmount = refundAmount;
}
public ProcessingOptions refundReasonCode(String refundReasonCode) {
this.refundReasonCode = refundReasonCode;
return this;
}
/**
* A code identifying the reason for the refund transaction. The value must be an existing payment refund reason code listed in **Payments Settings** > **Configure Reason Codes**. If you do not specify the field or leave the field with an empty value, Zuora uses the default payment refund reason code.
* @return refundReasonCode
*/
@javax.annotation.Nullable
public String getRefundReasonCode() {
return refundReasonCode;
}
public void setRefundReasonCode(String refundReasonCode) {
this.refundReasonCode = refundReasonCode;
}
public ProcessingOptions runBilling(Boolean runBilling) {
this.runBilling = runBilling;
return this;
}
/**
* Indicates if the current request needs to generate an invoice. The invoice will be generated against all subscriptions included in this order.
* @return runBilling
*/
@javax.annotation.Nullable
public Boolean getRunBilling() {
return runBilling;
}
public void setRunBilling(Boolean runBilling) {
this.runBilling = runBilling;
}
public ProcessingOptions writeOff(Boolean writeOff) {
this.writeOff = writeOff;
return this;
}
/**
* Indicates whether to write off the outstanding balance on the invoice after refund. Default is `false`. **Note**: - When refunding a subscription that is not invoiced separately, if you do not enable the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Invoice_Settlement/C_Invoice_Item_Settlement\" target=\"_blank\">Invoice Item Settlement</a> feature, you will encounter the following error during the cancel and refund process: “Cancellation/Refund failed because of the following reason: Invoice is linked to multiple subscriptions. Cancellation was not processed.” - The <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Invoice_Settlement\" target=\"_blank\">Invoice Settlement</a> feature must have been enabled for write-off.
* @return writeOff
*/
@javax.annotation.Nullable
public Boolean getWriteOff() {
return writeOff;
}
public void setWriteOff(Boolean writeOff) {
this.writeOff = writeOff;
}
public ProcessingOptions writeOffBehavior(WriteOffBehavior writeOffBehavior) {
this.writeOffBehavior = writeOffBehavior;
return this;
}
/**
* Get writeOffBehavior
* @return writeOffBehavior
*/
@javax.annotation.Nullable
public WriteOffBehavior getWriteOffBehavior() {
return writeOffBehavior;
}
public void setWriteOffBehavior(WriteOffBehavior writeOffBehavior) {
this.writeOffBehavior = writeOffBehavior;
}
/**
* 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 ProcessingOptions instance itself
*/
public ProcessingOptions 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;
}
ProcessingOptions processingOptions = (ProcessingOptions) o;
return Objects.equals(this.applicationOrder, processingOptions.applicationOrder) &&
Objects.equals(this.applyCredit, processingOptions.applyCredit) &&
Objects.equals(this.applyCreditBalance, processingOptions.applyCreditBalance) &&
Objects.equals(this.billingOptions, processingOptions.billingOptions) &&
Objects.equals(this.collectPayment, processingOptions.collectPayment) &&
Objects.equals(this.electronicPaymentOptions, processingOptions.electronicPaymentOptions) &&
Objects.equals(this.refund, processingOptions.refund) &&
Objects.equals(this.refundAmount, processingOptions.refundAmount) &&
Objects.equals(this.refundReasonCode, processingOptions.refundReasonCode) &&
Objects.equals(this.runBilling, processingOptions.runBilling) &&
Objects.equals(this.writeOff, processingOptions.writeOff) &&
Objects.equals(this.writeOffBehavior, processingOptions.writeOffBehavior)&&
Objects.equals(this.additionalProperties, processingOptions.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(applicationOrder, applyCredit, applyCreditBalance, billingOptions, collectPayment, electronicPaymentOptions, refund, refundAmount, refundReasonCode, runBilling, writeOff, writeOffBehavior, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class ProcessingOptions {\n");
sb.append(" applicationOrder: ").append(toIndentedString(applicationOrder)).append("\n");
sb.append(" applyCredit: ").append(toIndentedString(applyCredit)).append("\n");
sb.append(" applyCreditBalance: ").append(toIndentedString(applyCreditBalance)).append("\n");
sb.append(" billingOptions: ").append(toIndentedString(billingOptions)).append("\n");
sb.append(" collectPayment: ").append(toIndentedString(collectPayment)).append("\n");
sb.append(" electronicPaymentOptions: ").append(toIndentedString(electronicPaymentOptions)).append("\n");
sb.append(" refund: ").append(toIndentedString(refund)).append("\n");
sb.append(" refundAmount: ").append(toIndentedString(refundAmount)).append("\n");
sb.append(" refundReasonCode: ").append(toIndentedString(refundReasonCode)).append("\n");
sb.append(" runBilling: ").append(toIndentedString(runBilling)).append("\n");
sb.append(" writeOff: ").append(toIndentedString(writeOff)).append("\n");
sb.append(" writeOffBehavior: ").append(toIndentedString(writeOffBehavior)).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("applicationOrder");
openapiFields.add("applyCredit");
openapiFields.add("applyCreditBalance");
openapiFields.add("billingOptions");
openapiFields.add("collectPayment");
openapiFields.add("electronicPaymentOptions");
openapiFields.add("refund");
openapiFields.add("refundAmount");
openapiFields.add("refundReasonCode");
openapiFields.add("runBilling");
openapiFields.add("writeOff");
openapiFields.add("writeOffBehavior");
// 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 ProcessingOptions
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!ProcessingOptions.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in ProcessingOptions is not found in the empty JSON string", ProcessingOptions.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
// ensure the optional json data is an array if present
if (jsonObj.get("applicationOrder") != null && !jsonObj.get("applicationOrder").isJsonNull() && !jsonObj.get("applicationOrder").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `applicationOrder` to be an array in the JSON string but got `%s`", jsonObj.get("applicationOrder").toString()));
}
// validate the optional field `billingOptions`
if (jsonObj.get("billingOptions") != null && !jsonObj.get("billingOptions").isJsonNull()) {
BillingOptions.validateJsonElement(jsonObj.get("billingOptions"));
}
// validate the optional field `electronicPaymentOptions`
if (jsonObj.get("electronicPaymentOptions") != null && !jsonObj.get("electronicPaymentOptions").isJsonNull()) {
ElectronicPaymentOptions.validateJsonElement(jsonObj.get("electronicPaymentOptions"));
}
if ((jsonObj.get("refundReasonCode") != null && !jsonObj.get("refundReasonCode").isJsonNull()) && !jsonObj.get("refundReasonCode").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `refundReasonCode` to be a primitive type in the JSON string but got `%s`", jsonObj.get("refundReasonCode").toString()));
}
// validate the optional field `writeOffBehavior`
if (jsonObj.get("writeOffBehavior") != null && !jsonObj.get("writeOffBehavior").isJsonNull()) {
WriteOffBehavior.validateJsonElement(jsonObj.get("writeOffBehavior"));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!ProcessingOptions.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'ProcessingOptions' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(ProcessingOptions.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, ProcessingOptions 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 ProcessingOptions read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
ProcessingOptions 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 ProcessingOptions given an JSON string
*
* @param jsonString JSON string
* @return An instance of ProcessingOptions
* @throws IOException if the JSON string is invalid with respect to ProcessingOptions
*/
public static ProcessingOptions fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, ProcessingOptions.class);
}
/**
* Convert an instance of ProcessingOptions to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy