com.zuora.model.ChargeMetrics 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 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;

/**
 * Container for charge metrics. 
 */
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class ChargeMetrics {
  public static final String SERIALIZED_NAME_DMRR = "dmrr";
  @SerializedName(SERIALIZED_NAME_DMRR)
  private BigDecimal dmrr;

  public static final String SERIALIZED_NAME_DTCV = "dtcv";
  @SerializedName(SERIALIZED_NAME_DTCV)
  private BigDecimal dtcv;

  public static final String SERIALIZED_NAME_MRR = "mrr";
  @SerializedName(SERIALIZED_NAME_MRR)
  private BigDecimal mrr;

  public static final String SERIALIZED_NAME_NUMBER = "number";
  @SerializedName(SERIALIZED_NAME_NUMBER)
  private String number;

  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_ORIGINAL_ID = "originalId";
  @SerializedName(SERIALIZED_NAME_ORIGINAL_ID)
  private String originalId;

  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_TCV = "tcv";
  @SerializedName(SERIALIZED_NAME_TCV)
  private BigDecimal tcv;

  public ChargeMetrics() {
  }

  public ChargeMetrics dmrr(BigDecimal dmrr) {
    this.dmrr = dmrr;
    return this;
  }

  /**
   * Change in monthly recurring revenue. 
   * @return dmrr
   */
  @javax.annotation.Nullable
  public BigDecimal getDmrr() {
    return dmrr;
  }

  public void setDmrr(BigDecimal dmrr) {
    this.dmrr = dmrr;
  }


  public ChargeMetrics dtcv(BigDecimal dtcv) {
    this.dtcv = dtcv;
    return this;
  }

  /**
   * Change in total contract value. 
   * @return dtcv
   */
  @javax.annotation.Nullable
  public BigDecimal getDtcv() {
    return dtcv;
  }

  public void setDtcv(BigDecimal dtcv) {
    this.dtcv = dtcv;
  }


  public ChargeMetrics mrr(BigDecimal mrr) {
    this.mrr = mrr;
    return this;
  }

  /**
   * Monthly recurring revenue. 
   * @return mrr
   */
  @javax.annotation.Nullable
  public BigDecimal getMrr() {
    return mrr;
  }

  public void setMrr(BigDecimal mrr) {
    this.mrr = mrr;
  }


  public ChargeMetrics number(String number) {
    this.number = number;
    return this;
  }

  /**
   * The charge number of the subscription. Only available for update subscription. 
   * @return number
   */
  @javax.annotation.Nullable
  public String getNumber() {
    return number;
  }

  public void setNumber(String number) {
    this.number = number;
  }


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

  /**
   * The origin rate plan ID. Only available for update subscription. 
   * @return originRatePlanId
   */
  @javax.annotation.Nullable
  public String getOriginRatePlanId() {
    return originRatePlanId;
  }

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


  public ChargeMetrics originalId(String originalId) {
    this.originalId = originalId;
    return this;
  }

  /**
   * The original rate plan charge ID. Only available for update subscription. 
   * @return originalId
   */
  @javax.annotation.Nullable
  public String getOriginalId() {
    return originalId;
  }

  public void setOriginalId(String originalId) {
    this.originalId = originalId;
  }


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

  /**
   * The product rate plan charge ID. 
   * @return productRatePlanChargeId
   */
  @javax.annotation.Nullable
  public String getProductRatePlanChargeId() {
    return productRatePlanChargeId;
  }

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


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

  /**
   * The product rate plan ID. 
   * @return productRatePlanId
   */
  @javax.annotation.Nullable
  public String getProductRatePlanId() {
    return productRatePlanId;
  }

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


  public ChargeMetrics tcv(BigDecimal tcv) {
    this.tcv = tcv;
    return this;
  }

  /**
   * Total contract value. 
   * @return tcv
   */
  @javax.annotation.Nullable
  public BigDecimal getTcv() {
    return tcv;
  }

  public void setTcv(BigDecimal 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 ChargeMetrics instance itself
   */
  public ChargeMetrics 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;
    }
    ChargeMetrics chargeMetrics = (ChargeMetrics) o;
    return Objects.equals(this.dmrr, chargeMetrics.dmrr) &&
        Objects.equals(this.dtcv, chargeMetrics.dtcv) &&
        Objects.equals(this.mrr, chargeMetrics.mrr) &&
        Objects.equals(this.number, chargeMetrics.number) &&
        Objects.equals(this.originRatePlanId, chargeMetrics.originRatePlanId) &&
        Objects.equals(this.originalId, chargeMetrics.originalId) &&
        Objects.equals(this.productRatePlanChargeId, chargeMetrics.productRatePlanChargeId) &&
        Objects.equals(this.productRatePlanId, chargeMetrics.productRatePlanId) &&
        Objects.equals(this.tcv, chargeMetrics.tcv)&&
        Objects.equals(this.additionalProperties, chargeMetrics.additionalProperties);
  }

  @Override
  public int hashCode() {
    return Objects.hash(dmrr, dtcv, mrr, number, originRatePlanId, originalId, productRatePlanChargeId, productRatePlanId, tcv, additionalProperties);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class ChargeMetrics {\n");
    sb.append("    dmrr: ").append(toIndentedString(dmrr)).append("\n");
    sb.append("    dtcv: ").append(toIndentedString(dtcv)).append("\n");
    sb.append("    mrr: ").append(toIndentedString(mrr)).append("\n");
    sb.append("    number: ").append(toIndentedString(number)).append("\n");
    sb.append("    originRatePlanId: ").append(toIndentedString(originRatePlanId)).append("\n");
    sb.append("    originalId: ").append(toIndentedString(originalId)).append("\n");
    sb.append("    productRatePlanChargeId: ").append(toIndentedString(productRatePlanChargeId)).append("\n");
    sb.append("    productRatePlanId: ").append(toIndentedString(productRatePlanId)).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("dmrr");
    openapiFields.add("dtcv");
    openapiFields.add("mrr");
    openapiFields.add("number");
    openapiFields.add("originRatePlanId");
    openapiFields.add("originalId");
    openapiFields.add("productRatePlanChargeId");
    openapiFields.add("productRatePlanId");
    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 ChargeMetrics
   */
  public static void validateJsonElement(JsonElement jsonElement) throws IOException {
      if (jsonElement == null) {
        if (!ChargeMetrics.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
          throw new IllegalArgumentException(String.format("The required field(s) %s in ChargeMetrics is not found in the empty JSON string", ChargeMetrics.openapiRequiredFields.toString()));
        }
      }
        JsonObject jsonObj = jsonElement.getAsJsonObject();
      if ((jsonObj.get("number") != null && !jsonObj.get("number").isJsonNull()) && !jsonObj.get("number").isJsonPrimitive()) {
        throw new IllegalArgumentException(String.format("Expected the field `number` to be a primitive type in the JSON string but got `%s`", jsonObj.get("number").toString()));
      }
      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("originalId") != null && !jsonObj.get("originalId").isJsonNull()) && !jsonObj.get("originalId").isJsonPrimitive()) {
        throw new IllegalArgumentException(String.format("Expected the field `originalId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("originalId").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()));
      }
  }

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

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

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