com.zuora.model.SubscriptionMetrics 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 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;
/**
* SubscriptionMetrics
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class SubscriptionMetrics {
public static final String SERIALIZED_NAME_SUBSCRIPTION_NUMBER = "subscriptionNumber";
@SerializedName(SERIALIZED_NAME_SUBSCRIPTION_NUMBER)
private String subscriptionNumber;
public static final String SERIALIZED_NAME_CONTRACTED_MRR = "contractedMrr";
@SerializedName(SERIALIZED_NAME_CONTRACTED_MRR)
private BigDecimal contractedMrr;
public static final String SERIALIZED_NAME_CONTRACTED_NET_MRR = "contractedNetMrr";
@SerializedName(SERIALIZED_NAME_CONTRACTED_NET_MRR)
private BigDecimal contractedNetMrr;
public static final String SERIALIZED_NAME_AS_OF_DAY_GROSS_MRR = "asOfDayGrossMrr";
@SerializedName(SERIALIZED_NAME_AS_OF_DAY_GROSS_MRR)
private BigDecimal asOfDayGrossMrr;
public static final String SERIALIZED_NAME_AS_OF_DAY_NET_MRR = "asOfDayNetMrr";
@SerializedName(SERIALIZED_NAME_AS_OF_DAY_NET_MRR)
private BigDecimal asOfDayNetMrr;
public static final String SERIALIZED_NAME_TOTAL_CONTRACTED_VALUE = "totalContractedValue";
@SerializedName(SERIALIZED_NAME_TOTAL_CONTRACTED_VALUE)
private BigDecimal totalContractedValue;
public static final String SERIALIZED_NAME_NET_TOTAL_CONTRACTED_VALUE = "netTotalContractedValue";
@SerializedName(SERIALIZED_NAME_NET_TOTAL_CONTRACTED_VALUE)
private BigDecimal netTotalContractedValue;
public SubscriptionMetrics() {
}
public SubscriptionMetrics subscriptionNumber(String subscriptionNumber) {
this.subscriptionNumber = subscriptionNumber;
return this;
}
/**
* The number for the subscription.
* @return subscriptionNumber
*/
@javax.annotation.Nullable
public String getSubscriptionNumber() {
return subscriptionNumber;
}
public void setSubscriptionNumber(String subscriptionNumber) {
this.subscriptionNumber = subscriptionNumber;
}
public SubscriptionMetrics contractedMrr(BigDecimal contractedMrr) {
this.contractedMrr = contractedMrr;
return this;
}
/**
* Monthly recurring revenue of the subscription.
* @return contractedMrr
*/
@javax.annotation.Nullable
public BigDecimal getContractedMrr() {
return contractedMrr;
}
public void setContractedMrr(BigDecimal contractedMrr) {
this.contractedMrr = contractedMrr;
}
public SubscriptionMetrics contractedNetMrr(BigDecimal contractedNetMrr) {
this.contractedNetMrr = contractedNetMrr;
return this;
}
/**
* Monthly recurring revenue of the subscription rate plan inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts.
* @return contractedNetMrr
*/
@javax.annotation.Nullable
public BigDecimal getContractedNetMrr() {
return contractedNetMrr;
}
public void setContractedNetMrr(BigDecimal contractedNetMrr) {
this.contractedNetMrr = contractedNetMrr;
}
public SubscriptionMetrics asOfDayGrossMrr(BigDecimal asOfDayGrossMrr) {
this.asOfDayGrossMrr = asOfDayGrossMrr;
return this;
}
/**
* Monthly recurring revenue of the subscription rate plan exclusive of any discounts applicable as of specified day.
* @return asOfDayGrossMrr
*/
@javax.annotation.Nullable
public BigDecimal getAsOfDayGrossMrr() {
return asOfDayGrossMrr;
}
public void setAsOfDayGrossMrr(BigDecimal asOfDayGrossMrr) {
this.asOfDayGrossMrr = asOfDayGrossMrr;
}
public SubscriptionMetrics asOfDayNetMrr(BigDecimal asOfDayNetMrr) {
this.asOfDayNetMrr = asOfDayNetMrr;
return this;
}
/**
* Monthly recurring revenue of the subscription rate plan inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts as of specified day.
* @return asOfDayNetMrr
*/
@javax.annotation.Nullable
public BigDecimal getAsOfDayNetMrr() {
return asOfDayNetMrr;
}
public void setAsOfDayNetMrr(BigDecimal asOfDayNetMrr) {
this.asOfDayNetMrr = asOfDayNetMrr;
}
public SubscriptionMetrics totalContractedValue(BigDecimal totalContractedValue) {
this.totalContractedValue = totalContractedValue;
return this;
}
/**
* Total contract value of the subscription.
* @return totalContractedValue
*/
@javax.annotation.Nullable
public BigDecimal getTotalContractedValue() {
return totalContractedValue;
}
public void setTotalContractedValue(BigDecimal totalContractedValue) {
this.totalContractedValue = totalContractedValue;
}
public SubscriptionMetrics netTotalContractedValue(BigDecimal netTotalContractedValue) {
this.netTotalContractedValue = netTotalContractedValue;
return this;
}
/**
* Total contract value of the subscription rate plan inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts.
* @return netTotalContractedValue
*/
@javax.annotation.Nullable
public BigDecimal getNetTotalContractedValue() {
return netTotalContractedValue;
}
public void setNetTotalContractedValue(BigDecimal netTotalContractedValue) {
this.netTotalContractedValue = netTotalContractedValue;
}
/**
* 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 SubscriptionMetrics instance itself
*/
public SubscriptionMetrics 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;
}
SubscriptionMetrics subscriptionMetrics = (SubscriptionMetrics) o;
return Objects.equals(this.subscriptionNumber, subscriptionMetrics.subscriptionNumber) &&
Objects.equals(this.contractedMrr, subscriptionMetrics.contractedMrr) &&
Objects.equals(this.contractedNetMrr, subscriptionMetrics.contractedNetMrr) &&
Objects.equals(this.asOfDayGrossMrr, subscriptionMetrics.asOfDayGrossMrr) &&
Objects.equals(this.asOfDayNetMrr, subscriptionMetrics.asOfDayNetMrr) &&
Objects.equals(this.totalContractedValue, subscriptionMetrics.totalContractedValue) &&
Objects.equals(this.netTotalContractedValue, subscriptionMetrics.netTotalContractedValue)&&
Objects.equals(this.additionalProperties, subscriptionMetrics.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(subscriptionNumber, contractedMrr, contractedNetMrr, asOfDayGrossMrr, asOfDayNetMrr, totalContractedValue, netTotalContractedValue, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class SubscriptionMetrics {\n");
sb.append(" subscriptionNumber: ").append(toIndentedString(subscriptionNumber)).append("\n");
sb.append(" contractedMrr: ").append(toIndentedString(contractedMrr)).append("\n");
sb.append(" contractedNetMrr: ").append(toIndentedString(contractedNetMrr)).append("\n");
sb.append(" asOfDayGrossMrr: ").append(toIndentedString(asOfDayGrossMrr)).append("\n");
sb.append(" asOfDayNetMrr: ").append(toIndentedString(asOfDayNetMrr)).append("\n");
sb.append(" totalContractedValue: ").append(toIndentedString(totalContractedValue)).append("\n");
sb.append(" netTotalContractedValue: ").append(toIndentedString(netTotalContractedValue)).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("subscriptionNumber");
openapiFields.add("contractedMrr");
openapiFields.add("contractedNetMrr");
openapiFields.add("asOfDayGrossMrr");
openapiFields.add("asOfDayNetMrr");
openapiFields.add("totalContractedValue");
openapiFields.add("netTotalContractedValue");
// 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 SubscriptionMetrics
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!SubscriptionMetrics.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in SubscriptionMetrics is not found in the empty JSON string", SubscriptionMetrics.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("subscriptionNumber") != null && !jsonObj.get("subscriptionNumber").isJsonNull()) && !jsonObj.get("subscriptionNumber").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `subscriptionNumber` to be a primitive type in the JSON string but got `%s`", jsonObj.get("subscriptionNumber").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!SubscriptionMetrics.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'SubscriptionMetrics' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(SubscriptionMetrics.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, SubscriptionMetrics 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 SubscriptionMetrics read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
SubscriptionMetrics 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 SubscriptionMetrics given an JSON string
*
* @param jsonString JSON string
* @return An instance of SubscriptionMetrics
* @throws IOException if the JSON string is invalid with respect to SubscriptionMetrics
*/
public static SubscriptionMetrics fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, SubscriptionMetrics.class);
}
/**
* Convert an instance of SubscriptionMetrics to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy