com.zuora.model.DiscountPricingOverride 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.ApplyDiscountTo;
import com.zuora.model.DiscountLevel;
import com.zuora.model.OverrideDiscountApplyDetail;
import com.zuora.model.PriceChangeOption;
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;
/**
* Pricing information about a discount charge.
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class DiscountPricingOverride {
public static final String SERIALIZED_NAME_APPLY_DISCOUNT_TO = "applyDiscountTo";
@SerializedName(SERIALIZED_NAME_APPLY_DISCOUNT_TO)
private ApplyDiscountTo applyDiscountTo;
public static final String SERIALIZED_NAME_ORIGINAL_DISCOUNT_AMOUNT = "originalDiscountAmount";
@SerializedName(SERIALIZED_NAME_ORIGINAL_DISCOUNT_AMOUNT)
private BigDecimal originalDiscountAmount;
public static final String SERIALIZED_NAME_DISCOUNT_AMOUNT = "discountAmount";
@SerializedName(SERIALIZED_NAME_DISCOUNT_AMOUNT)
private BigDecimal discountAmount;
public static final String SERIALIZED_NAME_DISCOUNT_LEVEL = "discountLevel";
@SerializedName(SERIALIZED_NAME_DISCOUNT_LEVEL)
private DiscountLevel discountLevel;
public static final String SERIALIZED_NAME_ORIGINAL_DISCOUNT_PERCENTAGE = "originalDiscountPercentage";
@SerializedName(SERIALIZED_NAME_ORIGINAL_DISCOUNT_PERCENTAGE)
private BigDecimal originalDiscountPercentage;
public static final String SERIALIZED_NAME_DISCOUNT_PERCENTAGE = "discountPercentage";
@SerializedName(SERIALIZED_NAME_DISCOUNT_PERCENTAGE)
private BigDecimal discountPercentage;
public static final String SERIALIZED_NAME_PRICE_CHANGE_OPTION = "priceChangeOption";
@SerializedName(SERIALIZED_NAME_PRICE_CHANGE_OPTION)
private PriceChangeOption priceChangeOption = PriceChangeOption.NOCHANGE;
public static final String SERIALIZED_NAME_DISCOUNT_CLASS = "discountClass";
@SerializedName(SERIALIZED_NAME_DISCOUNT_CLASS)
private String discountClass;
public static final String SERIALIZED_NAME_APPLY_TO_BILLING_PERIOD_PARTIALLY = "applyToBillingPeriodPartially";
@SerializedName(SERIALIZED_NAME_APPLY_TO_BILLING_PERIOD_PARTIALLY)
private Boolean applyToBillingPeriodPartially;
public static final String SERIALIZED_NAME_DISCOUNT_APPLY_DETAILS = "discountApplyDetails";
@SerializedName(SERIALIZED_NAME_DISCOUNT_APPLY_DETAILS)
private List discountApplyDetails;
public DiscountPricingOverride() {
}
public DiscountPricingOverride applyDiscountTo(ApplyDiscountTo applyDiscountTo) {
this.applyDiscountTo = applyDiscountTo;
return this;
}
/**
* Get applyDiscountTo
* @return applyDiscountTo
*/
@javax.annotation.Nullable
public ApplyDiscountTo getApplyDiscountTo() {
return applyDiscountTo;
}
public void setApplyDiscountTo(ApplyDiscountTo applyDiscountTo) {
this.applyDiscountTo = applyDiscountTo;
}
public DiscountPricingOverride originalDiscountAmount(BigDecimal originalDiscountAmount) {
this.originalDiscountAmount = originalDiscountAmount;
return this;
}
/**
* The manufacturer's suggested retail discount price for standalone charge. Only applicable if the standalone discount charge is a fixed-amount discount. **Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.
* @return originalDiscountAmount
*/
@javax.annotation.Nullable
public BigDecimal getOriginalDiscountAmount() {
return originalDiscountAmount;
}
public void setOriginalDiscountAmount(BigDecimal originalDiscountAmount) {
this.originalDiscountAmount = originalDiscountAmount;
}
public DiscountPricingOverride discountAmount(BigDecimal discountAmount) {
this.discountAmount = discountAmount;
return this;
}
/**
* Only applicable if the discount charge is a fixed-amount discount.
* @return discountAmount
*/
@javax.annotation.Nullable
public BigDecimal getDiscountAmount() {
return discountAmount;
}
public void setDiscountAmount(BigDecimal discountAmount) {
this.discountAmount = discountAmount;
}
public DiscountPricingOverride discountLevel(DiscountLevel discountLevel) {
this.discountLevel = discountLevel;
return this;
}
/**
* Get discountLevel
* @return discountLevel
*/
@javax.annotation.Nullable
public DiscountLevel getDiscountLevel() {
return discountLevel;
}
public void setDiscountLevel(DiscountLevel discountLevel) {
this.discountLevel = discountLevel;
}
public DiscountPricingOverride originalDiscountPercentage(BigDecimal originalDiscountPercentage) {
this.originalDiscountPercentage = originalDiscountPercentage;
return this;
}
/**
* The manufacturer's suggested retail discount percentage for standalone charge. Only applicable if the standalone discount charge is a percentage discount. **Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.
* @return originalDiscountPercentage
*/
@javax.annotation.Nullable
public BigDecimal getOriginalDiscountPercentage() {
return originalDiscountPercentage;
}
public void setOriginalDiscountPercentage(BigDecimal originalDiscountPercentage) {
this.originalDiscountPercentage = originalDiscountPercentage;
}
public DiscountPricingOverride discountPercentage(BigDecimal discountPercentage) {
this.discountPercentage = discountPercentage;
return this;
}
/**
* Only applicable if the discount charge is a percentage discount.
* @return discountPercentage
*/
@javax.annotation.Nullable
public BigDecimal getDiscountPercentage() {
return discountPercentage;
}
public void setDiscountPercentage(BigDecimal discountPercentage) {
this.discountPercentage = discountPercentage;
}
public DiscountPricingOverride priceChangeOption(PriceChangeOption priceChangeOption) {
this.priceChangeOption = priceChangeOption;
return this;
}
/**
* Get priceChangeOption
* @return priceChangeOption
*/
@javax.annotation.Nullable
public PriceChangeOption getPriceChangeOption() {
return priceChangeOption;
}
public void setPriceChangeOption(PriceChangeOption priceChangeOption) {
this.priceChangeOption = priceChangeOption;
}
public DiscountPricingOverride discountClass(String discountClass) {
this.discountClass = discountClass;
return this;
}
/**
* The discount class defines the sequence in which discount product rate plan charges are applied. **Note**: You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.
* @return discountClass
*/
@javax.annotation.Nullable
public String getDiscountClass() {
return discountClass;
}
public void setDiscountClass(String discountClass) {
this.discountClass = discountClass;
}
public DiscountPricingOverride applyToBillingPeriodPartially(Boolean applyToBillingPeriodPartially) {
this.applyToBillingPeriodPartially = applyToBillingPeriodPartially;
return this;
}
/**
* Allow the discount duration to be aligned with the billing period partially. **Note**: You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.
* @return applyToBillingPeriodPartially
*/
@javax.annotation.Nullable
public Boolean getApplyToBillingPeriodPartially() {
return applyToBillingPeriodPartially;
}
public void setApplyToBillingPeriodPartially(Boolean applyToBillingPeriodPartially) {
this.applyToBillingPeriodPartially = applyToBillingPeriodPartially;
}
public DiscountPricingOverride discountApplyDetails(List discountApplyDetails) {
this.discountApplyDetails = discountApplyDetails;
return this;
}
public DiscountPricingOverride addDiscountApplyDetailsItem(OverrideDiscountApplyDetail discountApplyDetailsItem) {
if (this.discountApplyDetails == null) {
this.discountApplyDetails = new ArrayList<>();
}
this.discountApplyDetails.add(discountApplyDetailsItem);
return this;
}
/**
* Charge list of discount be applied to. **Note**: You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.
* @return discountApplyDetails
*/
@javax.annotation.Nullable
public List getDiscountApplyDetails() {
return discountApplyDetails;
}
public void setDiscountApplyDetails(List discountApplyDetails) {
this.discountApplyDetails = discountApplyDetails;
}
/**
* 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 DiscountPricingOverride instance itself
*/
public DiscountPricingOverride 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;
}
DiscountPricingOverride discountPricingOverride = (DiscountPricingOverride) o;
return Objects.equals(this.applyDiscountTo, discountPricingOverride.applyDiscountTo) &&
Objects.equals(this.originalDiscountAmount, discountPricingOverride.originalDiscountAmount) &&
Objects.equals(this.discountAmount, discountPricingOverride.discountAmount) &&
Objects.equals(this.discountLevel, discountPricingOverride.discountLevel) &&
Objects.equals(this.originalDiscountPercentage, discountPricingOverride.originalDiscountPercentage) &&
Objects.equals(this.discountPercentage, discountPricingOverride.discountPercentage) &&
Objects.equals(this.priceChangeOption, discountPricingOverride.priceChangeOption) &&
Objects.equals(this.discountClass, discountPricingOverride.discountClass) &&
Objects.equals(this.applyToBillingPeriodPartially, discountPricingOverride.applyToBillingPeriodPartially) &&
Objects.equals(this.discountApplyDetails, discountPricingOverride.discountApplyDetails)&&
Objects.equals(this.additionalProperties, discountPricingOverride.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(applyDiscountTo, originalDiscountAmount, discountAmount, discountLevel, originalDiscountPercentage, discountPercentage, priceChangeOption, discountClass, applyToBillingPeriodPartially, discountApplyDetails, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class DiscountPricingOverride {\n");
sb.append(" applyDiscountTo: ").append(toIndentedString(applyDiscountTo)).append("\n");
sb.append(" originalDiscountAmount: ").append(toIndentedString(originalDiscountAmount)).append("\n");
sb.append(" discountAmount: ").append(toIndentedString(discountAmount)).append("\n");
sb.append(" discountLevel: ").append(toIndentedString(discountLevel)).append("\n");
sb.append(" originalDiscountPercentage: ").append(toIndentedString(originalDiscountPercentage)).append("\n");
sb.append(" discountPercentage: ").append(toIndentedString(discountPercentage)).append("\n");
sb.append(" priceChangeOption: ").append(toIndentedString(priceChangeOption)).append("\n");
sb.append(" discountClass: ").append(toIndentedString(discountClass)).append("\n");
sb.append(" applyToBillingPeriodPartially: ").append(toIndentedString(applyToBillingPeriodPartially)).append("\n");
sb.append(" discountApplyDetails: ").append(toIndentedString(discountApplyDetails)).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("applyDiscountTo");
openapiFields.add("originalDiscountAmount");
openapiFields.add("discountAmount");
openapiFields.add("discountLevel");
openapiFields.add("originalDiscountPercentage");
openapiFields.add("discountPercentage");
openapiFields.add("priceChangeOption");
openapiFields.add("discountClass");
openapiFields.add("applyToBillingPeriodPartially");
openapiFields.add("discountApplyDetails");
// 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 DiscountPricingOverride
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!DiscountPricingOverride.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in DiscountPricingOverride is not found in the empty JSON string", DiscountPricingOverride.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("applyDiscountTo") != null && !jsonObj.get("applyDiscountTo").isJsonNull()) && !jsonObj.get("applyDiscountTo").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `applyDiscountTo` to be a primitive type in the JSON string but got `%s`", jsonObj.get("applyDiscountTo").toString()));
}
// validate the optional field `applyDiscountTo`
if (jsonObj.get("applyDiscountTo") != null && !jsonObj.get("applyDiscountTo").isJsonNull()) {
ApplyDiscountTo.validateJsonElement(jsonObj.get("applyDiscountTo"));
}
if ((jsonObj.get("discountLevel") != null && !jsonObj.get("discountLevel").isJsonNull()) && !jsonObj.get("discountLevel").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `discountLevel` to be a primitive type in the JSON string but got `%s`", jsonObj.get("discountLevel").toString()));
}
// validate the optional field `discountLevel`
if (jsonObj.get("discountLevel") != null && !jsonObj.get("discountLevel").isJsonNull()) {
DiscountLevel.validateJsonElement(jsonObj.get("discountLevel"));
}
// validate the optional field `priceChangeOption`
if (jsonObj.get("priceChangeOption") != null && !jsonObj.get("priceChangeOption").isJsonNull()) {
PriceChangeOption.validateJsonElement(jsonObj.get("priceChangeOption"));
}
if ((jsonObj.get("discountClass") != null && !jsonObj.get("discountClass").isJsonNull()) && !jsonObj.get("discountClass").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `discountClass` to be a primitive type in the JSON string but got `%s`", jsonObj.get("discountClass").toString()));
}
if (jsonObj.get("discountApplyDetails") != null && !jsonObj.get("discountApplyDetails").isJsonNull()) {
JsonArray jsonArraydiscountApplyDetails = jsonObj.getAsJsonArray("discountApplyDetails");
if (jsonArraydiscountApplyDetails != null) {
// ensure the json data is an array
if (!jsonObj.get("discountApplyDetails").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `discountApplyDetails` to be an array in the JSON string but got `%s`", jsonObj.get("discountApplyDetails").toString()));
}
// validate the optional field `discountApplyDetails` (array)
for (int i = 0; i < jsonArraydiscountApplyDetails.size(); i++) {
OverrideDiscountApplyDetail.validateJsonElement(jsonArraydiscountApplyDetails.get(i));
};
}
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!DiscountPricingOverride.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'DiscountPricingOverride' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(DiscountPricingOverride.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, DiscountPricingOverride 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 DiscountPricingOverride read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
DiscountPricingOverride 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 DiscountPricingOverride given an JSON string
*
* @param jsonString JSON string
* @return An instance of DiscountPricingOverride
* @throws IOException if the JSON string is invalid with respect to DiscountPricingOverride
*/
public static DiscountPricingOverride fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, DiscountPricingOverride.class);
}
/**
* Convert an instance of DiscountPricingOverride to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy