com.zuora.model.PreviewOrderCreateSubscriptionTerms 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.InitialTerm;
import com.zuora.model.RenewalSetting;
import com.zuora.model.RenewalTerm;
import java.io.IOException;
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;
/**
* Container for the terms and renewal settings of the subscription.
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class PreviewOrderCreateSubscriptionTerms {
public static final String SERIALIZED_NAME_AUTO_RENEW = "autoRenew";
@SerializedName(SERIALIZED_NAME_AUTO_RENEW)
private Boolean autoRenew;
public static final String SERIALIZED_NAME_INITIAL_TERM = "initialTerm";
@SerializedName(SERIALIZED_NAME_INITIAL_TERM)
private InitialTerm initialTerm;
public static final String SERIALIZED_NAME_RENEWAL_SETTING = "renewalSetting";
@SerializedName(SERIALIZED_NAME_RENEWAL_SETTING)
private RenewalSetting renewalSetting;
public static final String SERIALIZED_NAME_RENEWAL_TERMS = "renewalTerms";
@SerializedName(SERIALIZED_NAME_RENEWAL_TERMS)
private List renewalTerms;
public PreviewOrderCreateSubscriptionTerms() {
}
public PreviewOrderCreateSubscriptionTerms autoRenew(Boolean autoRenew) {
this.autoRenew = autoRenew;
return this;
}
/**
* Specifies whether the subscription automatically renews at the end of the each term. Only applicable if the type of the first term is `TERMED`.
* @return autoRenew
*/
@javax.annotation.Nullable
public Boolean getAutoRenew() {
return autoRenew;
}
public void setAutoRenew(Boolean autoRenew) {
this.autoRenew = autoRenew;
}
public PreviewOrderCreateSubscriptionTerms initialTerm(InitialTerm initialTerm) {
this.initialTerm = initialTerm;
return this;
}
/**
* Get initialTerm
* @return initialTerm
*/
@javax.annotation.Nonnull
public InitialTerm getInitialTerm() {
return initialTerm;
}
public void setInitialTerm(InitialTerm initialTerm) {
this.initialTerm = initialTerm;
}
public PreviewOrderCreateSubscriptionTerms renewalSetting(RenewalSetting renewalSetting) {
this.renewalSetting = renewalSetting;
return this;
}
/**
* Get renewalSetting
* @return renewalSetting
*/
@javax.annotation.Nullable
public RenewalSetting getRenewalSetting() {
return renewalSetting;
}
public void setRenewalSetting(RenewalSetting renewalSetting) {
this.renewalSetting = renewalSetting;
}
public PreviewOrderCreateSubscriptionTerms renewalTerms(List renewalTerms) {
this.renewalTerms = renewalTerms;
return this;
}
public PreviewOrderCreateSubscriptionTerms addRenewalTermsItem(RenewalTerm renewalTermsItem) {
if (this.renewalTerms == null) {
this.renewalTerms = new ArrayList<>();
}
this.renewalTerms.add(renewalTermsItem);
return this;
}
/**
* List of renewal terms of the subscription. Only applicable if the type of the first term is `TERMED` and the value of the `renewalSetting` field is `RENEW_WITH_SPECIFIC_TERM`.
* @return renewalTerms
*/
@javax.annotation.Nullable
public List getRenewalTerms() {
return renewalTerms;
}
public void setRenewalTerms(List renewalTerms) {
this.renewalTerms = renewalTerms;
}
/**
* 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 PreviewOrderCreateSubscriptionTerms instance itself
*/
public PreviewOrderCreateSubscriptionTerms 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;
}
PreviewOrderCreateSubscriptionTerms previewOrderCreateSubscriptionTerms = (PreviewOrderCreateSubscriptionTerms) o;
return Objects.equals(this.autoRenew, previewOrderCreateSubscriptionTerms.autoRenew) &&
Objects.equals(this.initialTerm, previewOrderCreateSubscriptionTerms.initialTerm) &&
Objects.equals(this.renewalSetting, previewOrderCreateSubscriptionTerms.renewalSetting) &&
Objects.equals(this.renewalTerms, previewOrderCreateSubscriptionTerms.renewalTerms)&&
Objects.equals(this.additionalProperties, previewOrderCreateSubscriptionTerms.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(autoRenew, initialTerm, renewalSetting, renewalTerms, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class PreviewOrderCreateSubscriptionTerms {\n");
sb.append(" autoRenew: ").append(toIndentedString(autoRenew)).append("\n");
sb.append(" initialTerm: ").append(toIndentedString(initialTerm)).append("\n");
sb.append(" renewalSetting: ").append(toIndentedString(renewalSetting)).append("\n");
sb.append(" renewalTerms: ").append(toIndentedString(renewalTerms)).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("autoRenew");
openapiFields.add("initialTerm");
openapiFields.add("renewalSetting");
openapiFields.add("renewalTerms");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("initialTerm");
}
/**
* 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 PreviewOrderCreateSubscriptionTerms
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!PreviewOrderCreateSubscriptionTerms.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in PreviewOrderCreateSubscriptionTerms is not found in the empty JSON string", PreviewOrderCreateSubscriptionTerms.openapiRequiredFields.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : PreviewOrderCreateSubscriptionTerms.openapiRequiredFields) {
if (jsonElement.getAsJsonObject().get(requiredField) == null) {
throw new IllegalArgumentException(String.format("The required field `%s` is not found in the JSON string: %s", requiredField, jsonElement.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
// validate the required field `initialTerm`
InitialTerm.validateJsonElement(jsonObj.get("initialTerm"));
if ((jsonObj.get("renewalSetting") != null && !jsonObj.get("renewalSetting").isJsonNull()) && !jsonObj.get("renewalSetting").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `renewalSetting` to be a primitive type in the JSON string but got `%s`", jsonObj.get("renewalSetting").toString()));
}
// validate the optional field `renewalSetting`
if (jsonObj.get("renewalSetting") != null && !jsonObj.get("renewalSetting").isJsonNull()) {
RenewalSetting.validateJsonElement(jsonObj.get("renewalSetting"));
}
if (jsonObj.get("renewalTerms") != null && !jsonObj.get("renewalTerms").isJsonNull()) {
JsonArray jsonArrayrenewalTerms = jsonObj.getAsJsonArray("renewalTerms");
if (jsonArrayrenewalTerms != null) {
// ensure the json data is an array
if (!jsonObj.get("renewalTerms").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `renewalTerms` to be an array in the JSON string but got `%s`", jsonObj.get("renewalTerms").toString()));
}
// validate the optional field `renewalTerms` (array)
for (int i = 0; i < jsonArrayrenewalTerms.size(); i++) {
RenewalTerm.validateJsonElement(jsonArrayrenewalTerms.get(i));
};
}
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!PreviewOrderCreateSubscriptionTerms.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'PreviewOrderCreateSubscriptionTerms' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(PreviewOrderCreateSubscriptionTerms.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, PreviewOrderCreateSubscriptionTerms 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 PreviewOrderCreateSubscriptionTerms read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
PreviewOrderCreateSubscriptionTerms 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 PreviewOrderCreateSubscriptionTerms given an JSON string
*
* @param jsonString JSON string
* @return An instance of PreviewOrderCreateSubscriptionTerms
* @throws IOException if the JSON string is invalid with respect to PreviewOrderCreateSubscriptionTerms
*/
public static PreviewOrderCreateSubscriptionTerms fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, PreviewOrderCreateSubscriptionTerms.class);
}
/**
* Convert an instance of PreviewOrderCreateSubscriptionTerms to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy