com.zuora.model.AccountMetrics 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;
/**
* Container for account metrics.
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class AccountMetrics {
public static final String SERIALIZED_NAME_BALANCE = "balance";
@SerializedName(SERIALIZED_NAME_BALANCE)
private BigDecimal balance;
public static final String SERIALIZED_NAME_CURRENCY = "currency";
@SerializedName(SERIALIZED_NAME_CURRENCY)
private String currency;
public static final String SERIALIZED_NAME_CONTRACTED_MRR = "contractedMrr";
@SerializedName(SERIALIZED_NAME_CONTRACTED_MRR)
private BigDecimal contractedMrr;
public static final String SERIALIZED_NAME_CREDIT_BALANCE = "creditBalance";
@SerializedName(SERIALIZED_NAME_CREDIT_BALANCE)
private BigDecimal creditBalance;
public static final String SERIALIZED_NAME_RESERVED_PAYMENT_AMOUNT = "reservedPaymentAmount";
@SerializedName(SERIALIZED_NAME_RESERVED_PAYMENT_AMOUNT)
private BigDecimal reservedPaymentAmount;
public static final String SERIALIZED_NAME_TOTAL_DEBIT_MEMO_BALANCE = "totalDebitMemoBalance";
@SerializedName(SERIALIZED_NAME_TOTAL_DEBIT_MEMO_BALANCE)
private BigDecimal totalDebitMemoBalance;
public static final String SERIALIZED_NAME_TOTAL_INVOICE_BALANCE = "totalInvoiceBalance";
@SerializedName(SERIALIZED_NAME_TOTAL_INVOICE_BALANCE)
private BigDecimal totalInvoiceBalance;
public static final String SERIALIZED_NAME_UNAPPLIED_CREDIT_MEMO_AMOUNT = "unappliedCreditMemoAmount";
@SerializedName(SERIALIZED_NAME_UNAPPLIED_CREDIT_MEMO_AMOUNT)
private BigDecimal unappliedCreditMemoAmount;
public static final String SERIALIZED_NAME_UNAPPLIED_PAYMENT_AMOUNT = "unappliedPaymentAmount";
@SerializedName(SERIALIZED_NAME_UNAPPLIED_PAYMENT_AMOUNT)
private BigDecimal unappliedPaymentAmount;
public AccountMetrics() {
}
public AccountMetrics balance(BigDecimal balance) {
this.balance = balance;
return this;
}
/**
* The customer's total invoice balance minus credit balance.
* @return balance
*/
@javax.annotation.Nullable
public BigDecimal getBalance() {
return balance;
}
public void setBalance(BigDecimal balance) {
this.balance = balance;
}
public AccountMetrics currency(String currency) {
this.currency = currency;
return this;
}
/**
* The currency that metrics are aggregated based on.
* @return currency
*/
@javax.annotation.Nullable
public String getCurrency() {
return currency;
}
public void setCurrency(String currency) {
this.currency = currency;
}
public AccountMetrics contractedMrr(BigDecimal contractedMrr) {
this.contractedMrr = contractedMrr;
return this;
}
/**
* Future expected MRR that accounts for future upgrades, downgrades, upsells and cancellations.
* @return contractedMrr
*/
@javax.annotation.Nullable
public BigDecimal getContractedMrr() {
return contractedMrr;
}
public void setContractedMrr(BigDecimal contractedMrr) {
this.contractedMrr = contractedMrr;
}
public AccountMetrics creditBalance(BigDecimal creditBalance) {
this.creditBalance = creditBalance;
return this;
}
/**
* Current credit balance.
* @return creditBalance
*/
@javax.annotation.Nullable
public BigDecimal getCreditBalance() {
return creditBalance;
}
public void setCreditBalance(BigDecimal creditBalance) {
this.creditBalance = creditBalance;
}
public AccountMetrics reservedPaymentAmount(BigDecimal reservedPaymentAmount) {
this.reservedPaymentAmount = reservedPaymentAmount;
return this;
}
/**
* The Reserved Payment Amount of the customer account.
* @return reservedPaymentAmount
*/
@javax.annotation.Nullable
public BigDecimal getReservedPaymentAmount() {
return reservedPaymentAmount;
}
public void setReservedPaymentAmount(BigDecimal reservedPaymentAmount) {
this.reservedPaymentAmount = reservedPaymentAmount;
}
public AccountMetrics totalDebitMemoBalance(BigDecimal totalDebitMemoBalance) {
this.totalDebitMemoBalance = totalDebitMemoBalance;
return this;
}
/**
* Total balance of all posted debit memos.
* @return totalDebitMemoBalance
*/
@javax.annotation.Nullable
public BigDecimal getTotalDebitMemoBalance() {
return totalDebitMemoBalance;
}
public void setTotalDebitMemoBalance(BigDecimal totalDebitMemoBalance) {
this.totalDebitMemoBalance = totalDebitMemoBalance;
}
public AccountMetrics totalInvoiceBalance(BigDecimal totalInvoiceBalance) {
this.totalInvoiceBalance = totalInvoiceBalance;
return this;
}
/**
* Total balance of all posted invoices.
* @return totalInvoiceBalance
*/
@javax.annotation.Nullable
public BigDecimal getTotalInvoiceBalance() {
return totalInvoiceBalance;
}
public void setTotalInvoiceBalance(BigDecimal totalInvoiceBalance) {
this.totalInvoiceBalance = totalInvoiceBalance;
}
public AccountMetrics unappliedCreditMemoAmount(BigDecimal unappliedCreditMemoAmount) {
this.unappliedCreditMemoAmount = unappliedCreditMemoAmount;
return this;
}
/**
* Get unappliedCreditMemoAmount
* @return unappliedCreditMemoAmount
*/
@javax.annotation.Nullable
public BigDecimal getUnappliedCreditMemoAmount() {
return unappliedCreditMemoAmount;
}
public void setUnappliedCreditMemoAmount(BigDecimal unappliedCreditMemoAmount) {
this.unappliedCreditMemoAmount = unappliedCreditMemoAmount;
}
public AccountMetrics unappliedPaymentAmount(BigDecimal unappliedPaymentAmount) {
this.unappliedPaymentAmount = unappliedPaymentAmount;
return this;
}
/**
* Total unapplied amount of all posted payments.
* @return unappliedPaymentAmount
*/
@javax.annotation.Nullable
public BigDecimal getUnappliedPaymentAmount() {
return unappliedPaymentAmount;
}
public void setUnappliedPaymentAmount(BigDecimal unappliedPaymentAmount) {
this.unappliedPaymentAmount = unappliedPaymentAmount;
}
/**
* 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 AccountMetrics instance itself
*/
public AccountMetrics 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;
}
AccountMetrics accountMetrics = (AccountMetrics) o;
return Objects.equals(this.balance, accountMetrics.balance) &&
Objects.equals(this.currency, accountMetrics.currency) &&
Objects.equals(this.contractedMrr, accountMetrics.contractedMrr) &&
Objects.equals(this.creditBalance, accountMetrics.creditBalance) &&
Objects.equals(this.reservedPaymentAmount, accountMetrics.reservedPaymentAmount) &&
Objects.equals(this.totalDebitMemoBalance, accountMetrics.totalDebitMemoBalance) &&
Objects.equals(this.totalInvoiceBalance, accountMetrics.totalInvoiceBalance) &&
Objects.equals(this.unappliedCreditMemoAmount, accountMetrics.unappliedCreditMemoAmount) &&
Objects.equals(this.unappliedPaymentAmount, accountMetrics.unappliedPaymentAmount)&&
Objects.equals(this.additionalProperties, accountMetrics.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(balance, currency, contractedMrr, creditBalance, reservedPaymentAmount, totalDebitMemoBalance, totalInvoiceBalance, unappliedCreditMemoAmount, unappliedPaymentAmount, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class AccountMetrics {\n");
sb.append(" balance: ").append(toIndentedString(balance)).append("\n");
sb.append(" currency: ").append(toIndentedString(currency)).append("\n");
sb.append(" contractedMrr: ").append(toIndentedString(contractedMrr)).append("\n");
sb.append(" creditBalance: ").append(toIndentedString(creditBalance)).append("\n");
sb.append(" reservedPaymentAmount: ").append(toIndentedString(reservedPaymentAmount)).append("\n");
sb.append(" totalDebitMemoBalance: ").append(toIndentedString(totalDebitMemoBalance)).append("\n");
sb.append(" totalInvoiceBalance: ").append(toIndentedString(totalInvoiceBalance)).append("\n");
sb.append(" unappliedCreditMemoAmount: ").append(toIndentedString(unappliedCreditMemoAmount)).append("\n");
sb.append(" unappliedPaymentAmount: ").append(toIndentedString(unappliedPaymentAmount)).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("balance");
openapiFields.add("currency");
openapiFields.add("contractedMrr");
openapiFields.add("creditBalance");
openapiFields.add("reservedPaymentAmount");
openapiFields.add("totalDebitMemoBalance");
openapiFields.add("totalInvoiceBalance");
openapiFields.add("unappliedCreditMemoAmount");
openapiFields.add("unappliedPaymentAmount");
// 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 AccountMetrics
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!AccountMetrics.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in AccountMetrics is not found in the empty JSON string", AccountMetrics.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("currency") != null && !jsonObj.get("currency").isJsonNull()) && !jsonObj.get("currency").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `currency` to be a primitive type in the JSON string but got `%s`", jsonObj.get("currency").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!AccountMetrics.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'AccountMetrics' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(AccountMetrics.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, AccountMetrics 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 AccountMetrics read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
AccountMetrics 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 AccountMetrics given an JSON string
*
* @param jsonString JSON string
* @return An instance of AccountMetrics
* @throws IOException if the JSON string is invalid with respect to AccountMetrics
*/
public static AccountMetrics fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, AccountMetrics.class);
}
/**
* Convert an instance of AccountMetrics to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy