com.zuora.model.CreateRamp 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.RampChargeRequest;
import com.zuora.model.RampIntervalRequest;
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 of the ramp definitions. It is used to create, update, or remove the ramp definition for the new subscription.
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class CreateRamp {
public static final String SERIALIZED_NAME_CHARGES = "charges";
@SerializedName(SERIALIZED_NAME_CHARGES)
private List charges;
public static final String SERIALIZED_NAME_DELETE = "delete";
@SerializedName(SERIALIZED_NAME_DELETE)
private Boolean delete;
public static final String SERIALIZED_NAME_DESCRIPTION = "description";
@SerializedName(SERIALIZED_NAME_DESCRIPTION)
private String description;
public static final String SERIALIZED_NAME_INTERVALS = "intervals";
@SerializedName(SERIALIZED_NAME_INTERVALS)
private List intervals;
public static final String SERIALIZED_NAME_NAME = "name";
@SerializedName(SERIALIZED_NAME_NAME)
private String name;
public CreateRamp() {
}
public CreateRamp charges(List charges) {
this.charges = charges;
return this;
}
public CreateRamp addChargesItem(RampChargeRequest chargesItem) {
if (this.charges == null) {
this.charges = new ArrayList<>();
}
this.charges.add(chargesItem);
return this;
}
/**
* Container for the rate plan charges that are considered as part of the ramp deal. * If this field is not specified, all the one-time and recurring regular charges of the new subscription are automatically considered as part of the ramp deal. * If this field is specified, either 'chargeNumber' or 'uniqueToken' must be specified.
* @return charges
*/
@javax.annotation.Nullable
public List getCharges() {
return charges;
}
public void setCharges(List charges) {
this.charges = charges;
}
public CreateRamp delete(Boolean delete) {
this.delete = delete;
return this;
}
/**
* Whether to remove the ramp definition from the new subscription. If you want to remove the ramp definition, this field is the only required field for the `ramp` object.
* @return delete
*/
@javax.annotation.Nullable
public Boolean getDelete() {
return delete;
}
public void setDelete(Boolean delete) {
this.delete = delete;
}
public CreateRamp description(String description) {
this.description = description;
return this;
}
/**
* The short description of the ramp.
* @return description
*/
@javax.annotation.Nullable
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
public CreateRamp intervals(List intervals) {
this.intervals = intervals;
return this;
}
public CreateRamp addIntervalsItem(RampIntervalRequest intervalsItem) {
if (this.intervals == null) {
this.intervals = new ArrayList<>();
}
this.intervals.add(intervalsItem);
return this;
}
/**
* Container for the intervals that the ramp is split into in its timeline. It is required when you want to create or update the ramp definition. The ramp intervals cannot have any overlap or gap between each other.
* @return intervals
*/
@javax.annotation.Nullable
public List getIntervals() {
return intervals;
}
public void setIntervals(List intervals) {
this.intervals = intervals;
}
public CreateRamp name(String name) {
this.name = name;
return this;
}
/**
* The name of the ramp.
* @return name
*/
@javax.annotation.Nullable
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
/**
* 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 CreateRamp instance itself
*/
public CreateRamp 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;
}
CreateRamp createRamp = (CreateRamp) o;
return Objects.equals(this.charges, createRamp.charges) &&
Objects.equals(this.delete, createRamp.delete) &&
Objects.equals(this.description, createRamp.description) &&
Objects.equals(this.intervals, createRamp.intervals) &&
Objects.equals(this.name, createRamp.name)&&
Objects.equals(this.additionalProperties, createRamp.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(charges, delete, description, intervals, name, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class CreateRamp {\n");
sb.append(" charges: ").append(toIndentedString(charges)).append("\n");
sb.append(" delete: ").append(toIndentedString(delete)).append("\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" intervals: ").append(toIndentedString(intervals)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).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("charges");
openapiFields.add("delete");
openapiFields.add("description");
openapiFields.add("intervals");
openapiFields.add("name");
// 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 CreateRamp
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!CreateRamp.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in CreateRamp is not found in the empty JSON string", CreateRamp.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if (jsonObj.get("charges") != null && !jsonObj.get("charges").isJsonNull()) {
JsonArray jsonArraycharges = jsonObj.getAsJsonArray("charges");
if (jsonArraycharges != null) {
// ensure the json data is an array
if (!jsonObj.get("charges").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `charges` to be an array in the JSON string but got `%s`", jsonObj.get("charges").toString()));
}
// validate the optional field `charges` (array)
for (int i = 0; i < jsonArraycharges.size(); i++) {
RampChargeRequest.validateJsonElement(jsonArraycharges.get(i));
};
}
}
if ((jsonObj.get("description") != null && !jsonObj.get("description").isJsonNull()) && !jsonObj.get("description").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `description` to be a primitive type in the JSON string but got `%s`", jsonObj.get("description").toString()));
}
if (jsonObj.get("intervals") != null && !jsonObj.get("intervals").isJsonNull()) {
JsonArray jsonArrayintervals = jsonObj.getAsJsonArray("intervals");
if (jsonArrayintervals != null) {
// ensure the json data is an array
if (!jsonObj.get("intervals").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `intervals` to be an array in the JSON string but got `%s`", jsonObj.get("intervals").toString()));
}
// validate the optional field `intervals` (array)
for (int i = 0; i < jsonArrayintervals.size(); i++) {
RampIntervalRequest.validateJsonElement(jsonArrayintervals.get(i));
};
}
}
if ((jsonObj.get("name") != null && !jsonObj.get("name").isJsonNull()) && !jsonObj.get("name").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `name` to be a primitive type in the JSON string but got `%s`", jsonObj.get("name").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!CreateRamp.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'CreateRamp' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(CreateRamp.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, CreateRamp 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 CreateRamp read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
CreateRamp 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 CreateRamp given an JSON string
*
* @param jsonString JSON string
* @return An instance of CreateRamp
* @throws IOException if the JSON string is invalid with respect to CreateRamp
*/
public static CreateRamp fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, CreateRamp.class);
}
/**
* Convert an instance of CreateRamp to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy