com.zuora.model.UsageOveragePricingOverride 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
The SDK of JAVA language for Zuora pricing system
The newest version!
/*
 * 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.PriceChangeOption;
import java.io.IOException;
import java.math.BigDecimal;
import java.util.Arrays;

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 usage charge that uses the \"overage\" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed. 
 */
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class UsageOveragePricingOverride {
  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_PRICE_INCREASE_PERCENTAGE = "priceIncreasePercentage";
  @SerializedName(SERIALIZED_NAME_PRICE_INCREASE_PERCENTAGE)
  private BigDecimal priceIncreasePercentage;

  public static final String SERIALIZED_NAME_INCLUDED_UNITS = "includedUnits";
  @SerializedName(SERIALIZED_NAME_INCLUDED_UNITS)
  private BigDecimal includedUnits;

  public static final String SERIALIZED_NAME_NUMBER_OF_PERIODS = "numberOfPeriods";
  @SerializedName(SERIALIZED_NAME_NUMBER_OF_PERIODS)
  private Integer numberOfPeriods;

  public static final String SERIALIZED_NAME_OVERAGE_PRICE = "overagePrice";
  @SerializedName(SERIALIZED_NAME_OVERAGE_PRICE)
  private BigDecimal overagePrice;

  /**
   * Specifies whether to credit the customer for unused units.  If the value of this field is `CreditBySpecificRate`, use the `unusedUnitsCreditRates` field to specify the rate at which to credit the customer for unused units. 
   */
  @JsonAdapter(OverageUnusedUnitsCreditOptionEnum.Adapter.class)
  public enum OverageUnusedUnitsCreditOptionEnum {
    NOCREDIT("NoCredit"),
    
    CREDITBYSPECIFICRATE("CreditBySpecificRate");

    private String value;

    OverageUnusedUnitsCreditOptionEnum(String value) {
      this.value = value;
    }

    public String getValue() {
      return value;
    }

    @Override
    public String toString() {
      return String.valueOf(value);
    }

    public static OverageUnusedUnitsCreditOptionEnum fromValue(String value) {
      for (OverageUnusedUnitsCreditOptionEnum b : OverageUnusedUnitsCreditOptionEnum.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 OverageUnusedUnitsCreditOptionEnum enumeration) throws IOException {
        jsonWriter.value(enumeration.getValue());
      }

      @Override
      public OverageUnusedUnitsCreditOptionEnum read(final JsonReader jsonReader) throws IOException {
        String value =  jsonReader.nextString();
        return OverageUnusedUnitsCreditOptionEnum.fromValue(value);
      }
    }

    public static void validateJsonElement(JsonElement jsonElement) throws IOException {
      String value = jsonElement.getAsString();
      OverageUnusedUnitsCreditOptionEnum.fromValue(value);
    }
  }

  public static final String SERIALIZED_NAME_OVERAGE_UNUSED_UNITS_CREDIT_OPTION = "overageUnusedUnitsCreditOption";
  @SerializedName(SERIALIZED_NAME_OVERAGE_UNUSED_UNITS_CREDIT_OPTION)
  private OverageUnusedUnitsCreditOptionEnum overageUnusedUnitsCreditOption;

  public static final String SERIALIZED_NAME_UNUSED_UNITS_CREDIT_RATES = "unusedUnitsCreditRates";
  @SerializedName(SERIALIZED_NAME_UNUSED_UNITS_CREDIT_RATES)
  private BigDecimal unusedUnitsCreditRates;

  public UsageOveragePricingOverride() {
  }

  public UsageOveragePricingOverride 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 UsageOveragePricingOverride priceIncreasePercentage(BigDecimal priceIncreasePercentage) {
    this.priceIncreasePercentage = priceIncreasePercentage;
    return this;
  }

  /**
   * Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the `priceChangeOption` field is `SpecificPercentageValue`. 
   * minimum: -100
   * @return priceIncreasePercentage
   */
  @javax.annotation.Nullable
  public BigDecimal getPriceIncreasePercentage() {
    return priceIncreasePercentage;
  }

  public void setPriceIncreasePercentage(BigDecimal priceIncreasePercentage) {
    this.priceIncreasePercentage = priceIncreasePercentage;
  }


  public UsageOveragePricingOverride includedUnits(BigDecimal includedUnits) {
    this.includedUnits = includedUnits;
    return this;
  }

  /**
   * Number of free units that may be consumed. 
   * minimum: 0
   * @return includedUnits
   */
  @javax.annotation.Nullable
  public BigDecimal getIncludedUnits() {
    return includedUnits;
  }

  public void setIncludedUnits(BigDecimal includedUnits) {
    this.includedUnits = includedUnits;
  }


  public UsageOveragePricingOverride numberOfPeriods(Integer numberOfPeriods) {
    this.numberOfPeriods = numberOfPeriods;
    return this;
  }

  /**
   * Number of periods that Zuora considers when calculating overage charges with overage smoothing. 
   * minimum: 1
   * @return numberOfPeriods
   */
  @javax.annotation.Nullable
  public Integer getNumberOfPeriods() {
    return numberOfPeriods;
  }

  public void setNumberOfPeriods(Integer numberOfPeriods) {
    this.numberOfPeriods = numberOfPeriods;
  }


  public UsageOveragePricingOverride overagePrice(BigDecimal overagePrice) {
    this.overagePrice = overagePrice;
    return this;
  }

  /**
   * Price per overage unit consumed. 
   * @return overagePrice
   */
  @javax.annotation.Nullable
  public BigDecimal getOveragePrice() {
    return overagePrice;
  }

  public void setOveragePrice(BigDecimal overagePrice) {
    this.overagePrice = overagePrice;
  }


  public UsageOveragePricingOverride overageUnusedUnitsCreditOption(OverageUnusedUnitsCreditOptionEnum overageUnusedUnitsCreditOption) {
    this.overageUnusedUnitsCreditOption = overageUnusedUnitsCreditOption;
    return this;
  }

  /**
   * Specifies whether to credit the customer for unused units.  If the value of this field is `CreditBySpecificRate`, use the `unusedUnitsCreditRates` field to specify the rate at which to credit the customer for unused units. 
   * @return overageUnusedUnitsCreditOption
   */
  @javax.annotation.Nullable
  public OverageUnusedUnitsCreditOptionEnum getOverageUnusedUnitsCreditOption() {
    return overageUnusedUnitsCreditOption;
  }

  public void setOverageUnusedUnitsCreditOption(OverageUnusedUnitsCreditOptionEnum overageUnusedUnitsCreditOption) {
    this.overageUnusedUnitsCreditOption = overageUnusedUnitsCreditOption;
  }


  public UsageOveragePricingOverride unusedUnitsCreditRates(BigDecimal unusedUnitsCreditRates) {
    this.unusedUnitsCreditRates = unusedUnitsCreditRates;
    return this;
  }

  /**
   * Per-unit rate at which to credit the customer for unused units. Only applicable if the value of the `overageUnusedUnitsCreditOption` field is `CreditBySpecificRate`. 
   * @return unusedUnitsCreditRates
   */
  @javax.annotation.Nullable
  public BigDecimal getUnusedUnitsCreditRates() {
    return unusedUnitsCreditRates;
  }

  public void setUnusedUnitsCreditRates(BigDecimal unusedUnitsCreditRates) {
    this.unusedUnitsCreditRates = unusedUnitsCreditRates;
  }

  /**
   * 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 UsageOveragePricingOverride instance itself
   */
  public UsageOveragePricingOverride 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;
    }
    UsageOveragePricingOverride usageOveragePricingOverride = (UsageOveragePricingOverride) o;
    return Objects.equals(this.priceChangeOption, usageOveragePricingOverride.priceChangeOption) &&
        Objects.equals(this.priceIncreasePercentage, usageOveragePricingOverride.priceIncreasePercentage) &&
        Objects.equals(this.includedUnits, usageOveragePricingOverride.includedUnits) &&
        Objects.equals(this.numberOfPeriods, usageOveragePricingOverride.numberOfPeriods) &&
        Objects.equals(this.overagePrice, usageOveragePricingOverride.overagePrice) &&
        Objects.equals(this.overageUnusedUnitsCreditOption, usageOveragePricingOverride.overageUnusedUnitsCreditOption) &&
        Objects.equals(this.unusedUnitsCreditRates, usageOveragePricingOverride.unusedUnitsCreditRates)&&
        Objects.equals(this.additionalProperties, usageOveragePricingOverride.additionalProperties);
  }

  @Override
  public int hashCode() {
    return Objects.hash(priceChangeOption, priceIncreasePercentage, includedUnits, numberOfPeriods, overagePrice, overageUnusedUnitsCreditOption, unusedUnitsCreditRates, additionalProperties);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class UsageOveragePricingOverride {\n");
    sb.append("    priceChangeOption: ").append(toIndentedString(priceChangeOption)).append("\n");
    sb.append("    priceIncreasePercentage: ").append(toIndentedString(priceIncreasePercentage)).append("\n");
    sb.append("    includedUnits: ").append(toIndentedString(includedUnits)).append("\n");
    sb.append("    numberOfPeriods: ").append(toIndentedString(numberOfPeriods)).append("\n");
    sb.append("    overagePrice: ").append(toIndentedString(overagePrice)).append("\n");
    sb.append("    overageUnusedUnitsCreditOption: ").append(toIndentedString(overageUnusedUnitsCreditOption)).append("\n");
    sb.append("    unusedUnitsCreditRates: ").append(toIndentedString(unusedUnitsCreditRates)).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("priceChangeOption");
    openapiFields.add("priceIncreasePercentage");
    openapiFields.add("includedUnits");
    openapiFields.add("numberOfPeriods");
    openapiFields.add("overagePrice");
    openapiFields.add("overageUnusedUnitsCreditOption");
    openapiFields.add("unusedUnitsCreditRates");

    // 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 UsageOveragePricingOverride
   */
  public static void validateJsonElement(JsonElement jsonElement) throws IOException {
      if (jsonElement == null) {
        if (!UsageOveragePricingOverride.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
          throw new IllegalArgumentException(String.format("The required field(s) %s in UsageOveragePricingOverride is not found in the empty JSON string", UsageOveragePricingOverride.openapiRequiredFields.toString()));
        }
      }
        JsonObject jsonObj = jsonElement.getAsJsonObject();
      // validate the optional field `priceChangeOption`
      if (jsonObj.get("priceChangeOption") != null && !jsonObj.get("priceChangeOption").isJsonNull()) {
        PriceChangeOption.validateJsonElement(jsonObj.get("priceChangeOption"));
      }
      if ((jsonObj.get("overageUnusedUnitsCreditOption") != null && !jsonObj.get("overageUnusedUnitsCreditOption").isJsonNull()) && !jsonObj.get("overageUnusedUnitsCreditOption").isJsonPrimitive()) {
        throw new IllegalArgumentException(String.format("Expected the field `overageUnusedUnitsCreditOption` to be a primitive type in the JSON string but got `%s`", jsonObj.get("overageUnusedUnitsCreditOption").toString()));
      }
      // validate the optional field `overageUnusedUnitsCreditOption`
      if (jsonObj.get("overageUnusedUnitsCreditOption") != null && !jsonObj.get("overageUnusedUnitsCreditOption").isJsonNull()) {
        OverageUnusedUnitsCreditOptionEnum.validateJsonElement(jsonObj.get("overageUnusedUnitsCreditOption"));
      }
  }

  public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
    @SuppressWarnings("unchecked")
    @Override
    public  TypeAdapter create(Gson gson, TypeToken type) {
       if (!UsageOveragePricingOverride.class.isAssignableFrom(type.getRawType())) {
         return null; // this class only serializes 'UsageOveragePricingOverride' and its subtypes
       }
       final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
       final TypeAdapter thisAdapter
                        = gson.getDelegateAdapter(this, TypeToken.get(UsageOveragePricingOverride.class));

       return (TypeAdapter) new TypeAdapter() {
           @Override
           public void write(JsonWriter out, UsageOveragePricingOverride 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 UsageOveragePricingOverride read(JsonReader in) throws IOException {
             JsonElement jsonElement = elementAdapter.read(in);
             validateJsonElement(jsonElement);
             JsonObject jsonObj = jsonElement.getAsJsonObject();
             // store additional fields in the deserialized instance
             UsageOveragePricingOverride 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 UsageOveragePricingOverride given an JSON string
   *
   * @param jsonString JSON string
   * @return An instance of UsageOveragePricingOverride
   * @throws IOException if the JSON string is invalid with respect to UsageOveragePricingOverride
   */
  public static UsageOveragePricingOverride fromJson(String jsonString) throws IOException {
    return JSON.getGson().fromJson(jsonString, UsageOveragePricingOverride.class);
  }

  /**
   * Convert an instance of UsageOveragePricingOverride to an JSON string
   *
   * @return JSON string
   */
  public String toJson() {
    return JSON.getGson().toJson(this);
  }
}