com.zuora.model.PreviewOptions 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 com.zuora.model.PreviewOptionsPreviewThruType;
import java.io.IOException;
import java.time.LocalDate;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
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;
/**
* PreviewOptions
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class PreviewOptions {
public static final String SERIALIZED_NAME_PREVIEW_NUMBER_OF_PERIODS = "previewNumberOfPeriods";
@SerializedName(SERIALIZED_NAME_PREVIEW_NUMBER_OF_PERIODS)
private Integer previewNumberOfPeriods;
public static final String SERIALIZED_NAME_PREVIEW_THRU_TYPE = "previewThruType";
@SerializedName(SERIALIZED_NAME_PREVIEW_THRU_TYPE)
private PreviewOptionsPreviewThruType previewThruType;
/**
* Gets or Sets previewTypes
*/
@JsonAdapter(PreviewTypesEnum.Adapter.class)
public enum PreviewTypesEnum {
CHARGEMETRICS("ChargeMetrics"),
BILLINGDOCS("BillingDocs"),
ORDERDELTAMETRICS("OrderDeltaMetrics"),
ORDERMETRICS("OrderMetrics"),
RAMPMETRICS("RampMetrics"),
RAMPDELTAMETRICS("RampDeltaMetrics");
private String value;
PreviewTypesEnum(String value) {
this.value = value;
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static PreviewTypesEnum fromValue(String value) {
for (PreviewTypesEnum b : PreviewTypesEnum.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 PreviewTypesEnum enumeration) throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public PreviewTypesEnum read(final JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return PreviewTypesEnum.fromValue(value);
}
}
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
String value = jsonElement.getAsString();
PreviewTypesEnum.fromValue(value);
}
}
public static final String SERIALIZED_NAME_PREVIEW_TYPES = "previewTypes";
@SerializedName(SERIALIZED_NAME_PREVIEW_TYPES)
private List previewTypes;
public static final String SERIALIZED_NAME_SPECIFIC_PREVIEW_THRU_DATE = "specificPreviewThruDate";
@SerializedName(SERIALIZED_NAME_SPECIFIC_PREVIEW_THRU_DATE)
private LocalDate specificPreviewThruDate;
public PreviewOptions() {
}
public PreviewOptions previewNumberOfPeriods(Integer previewNumberOfPeriods) {
this.previewNumberOfPeriods = previewNumberOfPeriods;
return this;
}
/**
* The number of periods to preview when the value of the `previewThroughType` field is set to `NumberOfPeriods`.
* @return previewNumberOfPeriods
*/
@javax.annotation.Nullable
public Integer getPreviewNumberOfPeriods() {
return previewNumberOfPeriods;
}
public void setPreviewNumberOfPeriods(Integer previewNumberOfPeriods) {
this.previewNumberOfPeriods = previewNumberOfPeriods;
}
public PreviewOptions previewThruType(PreviewOptionsPreviewThruType previewThruType) {
this.previewThruType = previewThruType;
return this;
}
/**
* Get previewThruType
* @return previewThruType
*/
@javax.annotation.Nullable
public PreviewOptionsPreviewThruType getPreviewThruType() {
return previewThruType;
}
public void setPreviewThruType(PreviewOptionsPreviewThruType previewThruType) {
this.previewThruType = previewThruType;
}
public PreviewOptions previewTypes(List previewTypes) {
this.previewTypes = previewTypes;
return this;
}
public PreviewOptions addPreviewTypesItem(PreviewTypesEnum previewTypesItem) {
if (this.previewTypes == null) {
this.previewTypes = new ArrayList<>();
}
this.previewTypes.add(previewTypesItem);
return this;
}
/**
* One or more types of the preview. It can include: * ChargeMetrics: charge level metrics will be returned in the response, including: `cmrr`, `tcv`, `tcb`, and `tax`. * BillingDocs: `invoices` and `creditMemos` will be returned in the response. Note `creditMemos` is only available if the Invoice Settlement feature is enabled. * OrderDeltaMetrics: order delta metrics will be returned in the response, including: `orderDeltaMrr`, `orderDeltaTcb` and `orderDeltaTcv`. * OrderMetrics: order metrics will be returned in the response, including: `quantity`, `mrr`, `tcb`, `tcv`, and `elp`. **Note:** As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders). The new methodologies are reflected in the OrderDeltaMetrics. It is recommended that all customers use the [Order Delta Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics). If you are an existing [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders) customer and want to migrate to Order Delta Metrics, submit a request at [Zuora Global Support](https://support.zuora.com/). Whereas new customers, and existing customers not currently on [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders), will no longer have access to Order Metrics, existing customers currently using Order Metrics will continue to be supported. * RampMetrics: ramp metrics will be returned in the response, including: `quantity`, `mrr`, `tcb`, `tcv` metrics for each charge and each ramp interval. * RampDeltaMetrics: ramp metrics changes will be returned in the response, including: `deltaQuantity`, `deltaMrr`, `deltaTcb`, `deltaTcv` metrics for each charge and each ramp interval.
* @return previewTypes
*/
@javax.annotation.Nullable
public List getPreviewTypes() {
return previewTypes;
}
public void setPreviewTypes(List previewTypes) {
this.previewTypes = previewTypes;
}
public PreviewOptions specificPreviewThruDate(LocalDate specificPreviewThruDate) {
this.specificPreviewThruDate = specificPreviewThruDate;
return this;
}
/**
* The end date of the order preview. You can preview the invoice charges through the preview through date. (Invoice preview only) **Note:** This field is only applicable if the 'previewThruType' field is set to 'SpecificDate'.
* @return specificPreviewThruDate
*/
@javax.annotation.Nullable
public LocalDate getSpecificPreviewThruDate() {
return specificPreviewThruDate;
}
public void setSpecificPreviewThruDate(LocalDate specificPreviewThruDate) {
this.specificPreviewThruDate = specificPreviewThruDate;
}
/**
* 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 PreviewOptions instance itself
*/
public PreviewOptions 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;
}
PreviewOptions previewOptions = (PreviewOptions) o;
return Objects.equals(this.previewNumberOfPeriods, previewOptions.previewNumberOfPeriods) &&
Objects.equals(this.previewThruType, previewOptions.previewThruType) &&
Objects.equals(this.previewTypes, previewOptions.previewTypes) &&
Objects.equals(this.specificPreviewThruDate, previewOptions.specificPreviewThruDate)&&
Objects.equals(this.additionalProperties, previewOptions.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(previewNumberOfPeriods, previewThruType, previewTypes, specificPreviewThruDate, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class PreviewOptions {\n");
sb.append(" previewNumberOfPeriods: ").append(toIndentedString(previewNumberOfPeriods)).append("\n");
sb.append(" previewThruType: ").append(toIndentedString(previewThruType)).append("\n");
sb.append(" previewTypes: ").append(toIndentedString(previewTypes)).append("\n");
sb.append(" specificPreviewThruDate: ").append(toIndentedString(specificPreviewThruDate)).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("previewNumberOfPeriods");
openapiFields.add("previewThruType");
openapiFields.add("previewTypes");
openapiFields.add("specificPreviewThruDate");
// 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 PreviewOptions
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!PreviewOptions.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in PreviewOptions is not found in the empty JSON string", PreviewOptions.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("previewThruType") != null && !jsonObj.get("previewThruType").isJsonNull()) && !jsonObj.get("previewThruType").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `previewThruType` to be a primitive type in the JSON string but got `%s`", jsonObj.get("previewThruType").toString()));
}
// validate the optional field `previewThruType`
if (jsonObj.get("previewThruType") != null && !jsonObj.get("previewThruType").isJsonNull()) {
PreviewOptionsPreviewThruType.validateJsonElement(jsonObj.get("previewThruType"));
}
// ensure the optional json data is an array if present
if (jsonObj.get("previewTypes") != null && !jsonObj.get("previewTypes").isJsonNull() && !jsonObj.get("previewTypes").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `previewTypes` to be an array in the JSON string but got `%s`", jsonObj.get("previewTypes").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!PreviewOptions.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'PreviewOptions' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(PreviewOptions.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, PreviewOptions 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 PreviewOptions read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
PreviewOptions 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 PreviewOptions given an JSON string
*
* @param jsonString JSON string
* @return An instance of PreviewOptions
* @throws IOException if the JSON string is invalid with respect to PreviewOptions
*/
public static PreviewOptions fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, PreviewOptions.class);
}
/**
* Convert an instance of PreviewOptions to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy