All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.zuora.model.PreviewChargeMetrics Maven / Gradle / Ivy

There is a newer version: 3.2.1
Show 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.PreviewChargeMetricsCmrr;
import com.zuora.model.PreviewChargeMetricsTax;
import com.zuora.model.PreviewChargeMetricsTcb;
import com.zuora.model.PreviewChargeMetricsTcv;
import java.io.IOException;
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;

/**
 * PreviewChargeMetrics
 */
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class PreviewChargeMetrics {
  public static final String SERIALIZED_NAME_CHARGE_NUMBER = "chargeNumber";
  @SerializedName(SERIALIZED_NAME_CHARGE_NUMBER)
  private String chargeNumber;

  public static final String SERIALIZED_NAME_CMRR = "cmrr";
  @SerializedName(SERIALIZED_NAME_CMRR)
  private PreviewChargeMetricsCmrr cmrr;

  public static final String SERIALIZED_NAME_ORIGIN_RATE_PLAN_ID = "originRatePlanId";
  @SerializedName(SERIALIZED_NAME_ORIGIN_RATE_PLAN_ID)
  private String originRatePlanId;

  public static final String SERIALIZED_NAME_PRODUCT_RATE_PLAN_CHARGE_ID = "productRatePlanChargeId";
  @SerializedName(SERIALIZED_NAME_PRODUCT_RATE_PLAN_CHARGE_ID)
  private String productRatePlanChargeId;

  public static final String SERIALIZED_NAME_PRODUCT_RATE_PLAN_ID = "productRatePlanId";
  @SerializedName(SERIALIZED_NAME_PRODUCT_RATE_PLAN_ID)
  private String productRatePlanId;

  public static final String SERIALIZED_NAME_SUBSCRIPTION_RATE_PLAN_NUMBER = "subscriptionRatePlanNumber";
  @SerializedName(SERIALIZED_NAME_SUBSCRIPTION_RATE_PLAN_NUMBER)
  private String subscriptionRatePlanNumber;

  public static final String SERIALIZED_NAME_TAX = "tax";
  @SerializedName(SERIALIZED_NAME_TAX)
  private PreviewChargeMetricsTax tax;

  public static final String SERIALIZED_NAME_TCB = "tcb";
  @SerializedName(SERIALIZED_NAME_TCB)
  private PreviewChargeMetricsTcb tcb;

  public static final String SERIALIZED_NAME_TCV = "tcv";
  @SerializedName(SERIALIZED_NAME_TCV)
  private PreviewChargeMetricsTcv tcv;

  public PreviewChargeMetrics() {
  }

  public PreviewChargeMetrics chargeNumber(String chargeNumber) {
    this.chargeNumber = chargeNumber;
    return this;
  }

  /**
   * Get chargeNumber
   * @return chargeNumber
   */
  @javax.annotation.Nullable
  public String getChargeNumber() {
    return chargeNumber;
  }

  public void setChargeNumber(String chargeNumber) {
    this.chargeNumber = chargeNumber;
  }


  public PreviewChargeMetrics cmrr(PreviewChargeMetricsCmrr cmrr) {
    this.cmrr = cmrr;
    return this;
  }

  /**
   * Get cmrr
   * @return cmrr
   */
  @javax.annotation.Nullable
  public PreviewChargeMetricsCmrr getCmrr() {
    return cmrr;
  }

  public void setCmrr(PreviewChargeMetricsCmrr cmrr) {
    this.cmrr = cmrr;
  }


  public PreviewChargeMetrics originRatePlanId(String originRatePlanId) {
    this.originRatePlanId = originRatePlanId;
    return this;
  }

  /**
   * Get originRatePlanId
   * @return originRatePlanId
   */
  @javax.annotation.Nullable
  public String getOriginRatePlanId() {
    return originRatePlanId;
  }

  public void setOriginRatePlanId(String originRatePlanId) {
    this.originRatePlanId = originRatePlanId;
  }


  public PreviewChargeMetrics productRatePlanChargeId(String productRatePlanChargeId) {
    this.productRatePlanChargeId = productRatePlanChargeId;
    return this;
  }

  /**
   * Get productRatePlanChargeId
   * @return productRatePlanChargeId
   */
  @javax.annotation.Nullable
  public String getProductRatePlanChargeId() {
    return productRatePlanChargeId;
  }

  public void setProductRatePlanChargeId(String productRatePlanChargeId) {
    this.productRatePlanChargeId = productRatePlanChargeId;
  }


  public PreviewChargeMetrics productRatePlanId(String productRatePlanId) {
    this.productRatePlanId = productRatePlanId;
    return this;
  }

  /**
   * Get productRatePlanId
   * @return productRatePlanId
   */
  @javax.annotation.Nullable
  public String getProductRatePlanId() {
    return productRatePlanId;
  }

  public void setProductRatePlanId(String productRatePlanId) {
    this.productRatePlanId = productRatePlanId;
  }


  public PreviewChargeMetrics subscriptionRatePlanNumber(String subscriptionRatePlanNumber) {
    this.subscriptionRatePlanNumber = subscriptionRatePlanNumber;
    return this;
  }

  /**
   * Get subscriptionRatePlanNumber
   * @return subscriptionRatePlanNumber
   */
  @javax.annotation.Nullable
  public String getSubscriptionRatePlanNumber() {
    return subscriptionRatePlanNumber;
  }

  public void setSubscriptionRatePlanNumber(String subscriptionRatePlanNumber) {
    this.subscriptionRatePlanNumber = subscriptionRatePlanNumber;
  }


  public PreviewChargeMetrics tax(PreviewChargeMetricsTax tax) {
    this.tax = tax;
    return this;
  }

  /**
   * Get tax
   * @return tax
   */
  @javax.annotation.Nullable
  public PreviewChargeMetricsTax getTax() {
    return tax;
  }

  public void setTax(PreviewChargeMetricsTax tax) {
    this.tax = tax;
  }


  public PreviewChargeMetrics tcb(PreviewChargeMetricsTcb tcb) {
    this.tcb = tcb;
    return this;
  }

  /**
   * Get tcb
   * @return tcb
   */
  @javax.annotation.Nullable
  public PreviewChargeMetricsTcb getTcb() {
    return tcb;
  }

  public void setTcb(PreviewChargeMetricsTcb tcb) {
    this.tcb = tcb;
  }


  public PreviewChargeMetrics tcv(PreviewChargeMetricsTcv tcv) {
    this.tcv = tcv;
    return this;
  }

  /**
   * Get tcv
   * @return tcv
   */
  @javax.annotation.Nullable
  public PreviewChargeMetricsTcv getTcv() {
    return tcv;
  }

  public void setTcv(PreviewChargeMetricsTcv tcv) {
    this.tcv = tcv;
  }

  /**
   * 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 PreviewChargeMetrics instance itself
   */
  public PreviewChargeMetrics 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;
    }
    PreviewChargeMetrics previewChargeMetrics = (PreviewChargeMetrics) o;
    return Objects.equals(this.chargeNumber, previewChargeMetrics.chargeNumber) &&
        Objects.equals(this.cmrr, previewChargeMetrics.cmrr) &&
        Objects.equals(this.originRatePlanId, previewChargeMetrics.originRatePlanId) &&
        Objects.equals(this.productRatePlanChargeId, previewChargeMetrics.productRatePlanChargeId) &&
        Objects.equals(this.productRatePlanId, previewChargeMetrics.productRatePlanId) &&
        Objects.equals(this.subscriptionRatePlanNumber, previewChargeMetrics.subscriptionRatePlanNumber) &&
        Objects.equals(this.tax, previewChargeMetrics.tax) &&
        Objects.equals(this.tcb, previewChargeMetrics.tcb) &&
        Objects.equals(this.tcv, previewChargeMetrics.tcv)&&
        Objects.equals(this.additionalProperties, previewChargeMetrics.additionalProperties);
  }

  @Override
  public int hashCode() {
    return Objects.hash(chargeNumber, cmrr, originRatePlanId, productRatePlanChargeId, productRatePlanId, subscriptionRatePlanNumber, tax, tcb, tcv, additionalProperties);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class PreviewChargeMetrics {\n");
    sb.append("    chargeNumber: ").append(toIndentedString(chargeNumber)).append("\n");
    sb.append("    cmrr: ").append(toIndentedString(cmrr)).append("\n");
    sb.append("    originRatePlanId: ").append(toIndentedString(originRatePlanId)).append("\n");
    sb.append("    productRatePlanChargeId: ").append(toIndentedString(productRatePlanChargeId)).append("\n");
    sb.append("    productRatePlanId: ").append(toIndentedString(productRatePlanId)).append("\n");
    sb.append("    subscriptionRatePlanNumber: ").append(toIndentedString(subscriptionRatePlanNumber)).append("\n");
    sb.append("    tax: ").append(toIndentedString(tax)).append("\n");
    sb.append("    tcb: ").append(toIndentedString(tcb)).append("\n");
    sb.append("    tcv: ").append(toIndentedString(tcv)).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("chargeNumber");
    openapiFields.add("cmrr");
    openapiFields.add("originRatePlanId");
    openapiFields.add("productRatePlanChargeId");
    openapiFields.add("productRatePlanId");
    openapiFields.add("subscriptionRatePlanNumber");
    openapiFields.add("tax");
    openapiFields.add("tcb");
    openapiFields.add("tcv");

    // 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 PreviewChargeMetrics
   */
  public static void validateJsonElement(JsonElement jsonElement) throws IOException {
      if (jsonElement == null) {
        if (!PreviewChargeMetrics.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
          throw new IllegalArgumentException(String.format("The required field(s) %s in PreviewChargeMetrics is not found in the empty JSON string", PreviewChargeMetrics.openapiRequiredFields.toString()));
        }
      }
        JsonObject jsonObj = jsonElement.getAsJsonObject();
      if ((jsonObj.get("chargeNumber") != null && !jsonObj.get("chargeNumber").isJsonNull()) && !jsonObj.get("chargeNumber").isJsonPrimitive()) {
        throw new IllegalArgumentException(String.format("Expected the field `chargeNumber` to be a primitive type in the JSON string but got `%s`", jsonObj.get("chargeNumber").toString()));
      }
      // validate the optional field `cmrr`
      if (jsonObj.get("cmrr") != null && !jsonObj.get("cmrr").isJsonNull()) {
        PreviewChargeMetricsCmrr.validateJsonElement(jsonObj.get("cmrr"));
      }
      if ((jsonObj.get("originRatePlanId") != null && !jsonObj.get("originRatePlanId").isJsonNull()) && !jsonObj.get("originRatePlanId").isJsonPrimitive()) {
        throw new IllegalArgumentException(String.format("Expected the field `originRatePlanId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("originRatePlanId").toString()));
      }
      if ((jsonObj.get("productRatePlanChargeId") != null && !jsonObj.get("productRatePlanChargeId").isJsonNull()) && !jsonObj.get("productRatePlanChargeId").isJsonPrimitive()) {
        throw new IllegalArgumentException(String.format("Expected the field `productRatePlanChargeId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("productRatePlanChargeId").toString()));
      }
      if ((jsonObj.get("productRatePlanId") != null && !jsonObj.get("productRatePlanId").isJsonNull()) && !jsonObj.get("productRatePlanId").isJsonPrimitive()) {
        throw new IllegalArgumentException(String.format("Expected the field `productRatePlanId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("productRatePlanId").toString()));
      }
      if ((jsonObj.get("subscriptionRatePlanNumber") != null && !jsonObj.get("subscriptionRatePlanNumber").isJsonNull()) && !jsonObj.get("subscriptionRatePlanNumber").isJsonPrimitive()) {
        throw new IllegalArgumentException(String.format("Expected the field `subscriptionRatePlanNumber` to be a primitive type in the JSON string but got `%s`", jsonObj.get("subscriptionRatePlanNumber").toString()));
      }
      // validate the optional field `tax`
      if (jsonObj.get("tax") != null && !jsonObj.get("tax").isJsonNull()) {
        PreviewChargeMetricsTax.validateJsonElement(jsonObj.get("tax"));
      }
      // validate the optional field `tcb`
      if (jsonObj.get("tcb") != null && !jsonObj.get("tcb").isJsonNull()) {
        PreviewChargeMetricsTcb.validateJsonElement(jsonObj.get("tcb"));
      }
      // validate the optional field `tcv`
      if (jsonObj.get("tcv") != null && !jsonObj.get("tcv").isJsonNull()) {
        PreviewChargeMetricsTcv.validateJsonElement(jsonObj.get("tcv"));
      }
  }

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

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

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





© 2015 - 2025 Weber Informatics LLC | Privacy Policy