com.zuora.model.GetProductRatePlanResponse 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.ProductRatePlanStatus;
import java.io.IOException;
import java.math.BigDecimal;
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;
/**
* GetProductRatePlanResponse
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class GetProductRatePlanResponse {
public static final String SERIALIZED_NAME_EXTERNAL_ID_SOURCE_SYSTEM = "ExternalIdSourceSystem";
@SerializedName(SERIALIZED_NAME_EXTERNAL_ID_SOURCE_SYSTEM)
private String externalIdSourceSystem;
public static final String SERIALIZED_NAME_DESCRIPTION = "description";
@SerializedName(SERIALIZED_NAME_DESCRIPTION)
private String description;
public static final String SERIALIZED_NAME_EFFECTIVE_END_DATE = "effectiveEndDate";
@SerializedName(SERIALIZED_NAME_EFFECTIVE_END_DATE)
private LocalDate effectiveEndDate;
public static final String SERIALIZED_NAME_EFFECTIVE_START_DATE = "effectiveStartDate";
@SerializedName(SERIALIZED_NAME_EFFECTIVE_START_DATE)
private LocalDate effectiveStartDate;
public static final String SERIALIZED_NAME_EXTERNALLY_MANAGED_PLAN_IDS = "externallyManagedPlanIds";
@SerializedName(SERIALIZED_NAME_EXTERNALLY_MANAGED_PLAN_IDS)
private List externallyManagedPlanIds;
public static final String SERIALIZED_NAME_GRADE = "grade";
@SerializedName(SERIALIZED_NAME_GRADE)
private BigDecimal grade;
public static final String SERIALIZED_NAME_ID = "id";
@SerializedName(SERIALIZED_NAME_ID)
private String id;
public static final String SERIALIZED_NAME_NAME = "name";
@SerializedName(SERIALIZED_NAME_NAME)
private String name;
public static final String SERIALIZED_NAME_STATUS = "status";
@SerializedName(SERIALIZED_NAME_STATUS)
private ProductRatePlanStatus status;
public static final String SERIALIZED_NAME_SUCCESS = "success";
@SerializedName(SERIALIZED_NAME_SUCCESS)
private Boolean success;
public GetProductRatePlanResponse() {
}
public GetProductRatePlanResponse externalIdSourceSystem(String externalIdSourceSystem) {
this.externalIdSourceSystem = externalIdSourceSystem;
return this;
}
/**
* The combination of `externallyManagedPlanId` and `externalIdSourceSystem` is the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.
* @return externalIdSourceSystem
*/
@javax.annotation.Nullable
public String getExternalIdSourceSystem() {
return externalIdSourceSystem;
}
public void setExternalIdSourceSystem(String externalIdSourceSystem) {
this.externalIdSourceSystem = externalIdSourceSystem;
}
public GetProductRatePlanResponse description(String description) {
this.description = description;
return this;
}
/**
* The short description of the product rate plan.
* @return description
*/
@javax.annotation.Nullable
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
public GetProductRatePlanResponse effectiveEndDate(LocalDate effectiveEndDate) {
this.effectiveEndDate = effectiveEndDate;
return this;
}
/**
* The end date of the product rate plan.
* @return effectiveEndDate
*/
@javax.annotation.Nullable
public LocalDate getEffectiveEndDate() {
return effectiveEndDate;
}
public void setEffectiveEndDate(LocalDate effectiveEndDate) {
this.effectiveEndDate = effectiveEndDate;
}
public GetProductRatePlanResponse effectiveStartDate(LocalDate effectiveStartDate) {
this.effectiveStartDate = effectiveStartDate;
return this;
}
/**
* The start date of the product rate plan.
* @return effectiveStartDate
*/
@javax.annotation.Nullable
public LocalDate getEffectiveStartDate() {
return effectiveStartDate;
}
public void setEffectiveStartDate(LocalDate effectiveStartDate) {
this.effectiveStartDate = effectiveStartDate;
}
public GetProductRatePlanResponse externallyManagedPlanIds(List externallyManagedPlanIds) {
this.externallyManagedPlanIds = externallyManagedPlanIds;
return this;
}
public GetProductRatePlanResponse addExternallyManagedPlanIdsItem(String externallyManagedPlanIdsItem) {
if (this.externallyManagedPlanIds == null) {
this.externallyManagedPlanIds = new ArrayList<>();
}
this.externallyManagedPlanIds.add(externallyManagedPlanIdsItem);
return this;
}
/**
* The unique identifier for the product rate plan in a third-party store. This field is used to represent a rate plan created through third-party stores.
* @return externallyManagedPlanIds
*/
@javax.annotation.Nullable
public List getExternallyManagedPlanIds() {
return externallyManagedPlanIds;
}
public void setExternallyManagedPlanIds(List externallyManagedPlanIds) {
this.externallyManagedPlanIds = externallyManagedPlanIds;
}
public GetProductRatePlanResponse grade(BigDecimal grade) {
this.grade = grade;
return this;
}
/**
* The grade of the product rate plan. **Note**: This field is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/).
* @return grade
*/
@javax.annotation.Nullable
public BigDecimal getGrade() {
return grade;
}
public void setGrade(BigDecimal grade) {
this.grade = grade;
}
public GetProductRatePlanResponse id(String id) {
this.id = id;
return this;
}
/**
* The unique product rate plan ID.
* @return id
*/
@javax.annotation.Nullable
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public GetProductRatePlanResponse name(String name) {
this.name = name;
return this;
}
/**
* The name of the product rate plan.
* @return name
*/
@javax.annotation.Nullable
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public GetProductRatePlanResponse status(ProductRatePlanStatus status) {
this.status = status;
return this;
}
/**
* Get status
* @return status
*/
@javax.annotation.Nullable
public ProductRatePlanStatus getStatus() {
return status;
}
public void setStatus(ProductRatePlanStatus status) {
this.status = status;
}
public GetProductRatePlanResponse success(Boolean success) {
this.success = success;
return this;
}
/**
* Returns `true` if the request was processed successfully.
* @return success
*/
@javax.annotation.Nullable
public Boolean getSuccess() {
return success;
}
public void setSuccess(Boolean success) {
this.success = success;
}
/**
* 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 GetProductRatePlanResponse instance itself
*/
public GetProductRatePlanResponse 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;
}
GetProductRatePlanResponse getProductRatePlanResponse = (GetProductRatePlanResponse) o;
return Objects.equals(this.externalIdSourceSystem, getProductRatePlanResponse.externalIdSourceSystem) &&
Objects.equals(this.description, getProductRatePlanResponse.description) &&
Objects.equals(this.effectiveEndDate, getProductRatePlanResponse.effectiveEndDate) &&
Objects.equals(this.effectiveStartDate, getProductRatePlanResponse.effectiveStartDate) &&
Objects.equals(this.externallyManagedPlanIds, getProductRatePlanResponse.externallyManagedPlanIds) &&
Objects.equals(this.grade, getProductRatePlanResponse.grade) &&
Objects.equals(this.id, getProductRatePlanResponse.id) &&
Objects.equals(this.name, getProductRatePlanResponse.name) &&
Objects.equals(this.status, getProductRatePlanResponse.status) &&
Objects.equals(this.success, getProductRatePlanResponse.success)&&
Objects.equals(this.additionalProperties, getProductRatePlanResponse.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(externalIdSourceSystem, description, effectiveEndDate, effectiveStartDate, externallyManagedPlanIds, grade, id, name, status, success, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class GetProductRatePlanResponse {\n");
sb.append(" externalIdSourceSystem: ").append(toIndentedString(externalIdSourceSystem)).append("\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" effectiveEndDate: ").append(toIndentedString(effectiveEndDate)).append("\n");
sb.append(" effectiveStartDate: ").append(toIndentedString(effectiveStartDate)).append("\n");
sb.append(" externallyManagedPlanIds: ").append(toIndentedString(externallyManagedPlanIds)).append("\n");
sb.append(" grade: ").append(toIndentedString(grade)).append("\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" status: ").append(toIndentedString(status)).append("\n");
sb.append(" success: ").append(toIndentedString(success)).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("ExternalIdSourceSystem");
openapiFields.add("description");
openapiFields.add("effectiveEndDate");
openapiFields.add("effectiveStartDate");
openapiFields.add("externallyManagedPlanIds");
openapiFields.add("grade");
openapiFields.add("id");
openapiFields.add("name");
openapiFields.add("status");
openapiFields.add("success");
// 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 GetProductRatePlanResponse
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!GetProductRatePlanResponse.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in GetProductRatePlanResponse is not found in the empty JSON string", GetProductRatePlanResponse.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("ExternalIdSourceSystem") != null && !jsonObj.get("ExternalIdSourceSystem").isJsonNull()) && !jsonObj.get("ExternalIdSourceSystem").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `ExternalIdSourceSystem` to be a primitive type in the JSON string but got `%s`", jsonObj.get("ExternalIdSourceSystem").toString()));
}
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()));
}
// ensure the optional json data is an array if present
if (jsonObj.get("externallyManagedPlanIds") != null && !jsonObj.get("externallyManagedPlanIds").isJsonNull() && !jsonObj.get("externallyManagedPlanIds").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `externallyManagedPlanIds` to be an array in the JSON string but got `%s`", jsonObj.get("externallyManagedPlanIds").toString()));
}
if ((jsonObj.get("id") != null && !jsonObj.get("id").isJsonNull()) && !jsonObj.get("id").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `id` to be a primitive type in the JSON string but got `%s`", jsonObj.get("id").toString()));
}
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()));
}
if ((jsonObj.get("status") != null && !jsonObj.get("status").isJsonNull()) && !jsonObj.get("status").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `status` to be a primitive type in the JSON string but got `%s`", jsonObj.get("status").toString()));
}
// validate the optional field `status`
if (jsonObj.get("status") != null && !jsonObj.get("status").isJsonNull()) {
ProductRatePlanStatus.validateJsonElement(jsonObj.get("status"));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!GetProductRatePlanResponse.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'GetProductRatePlanResponse' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(GetProductRatePlanResponse.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, GetProductRatePlanResponse 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 GetProductRatePlanResponse read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
GetProductRatePlanResponse 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 GetProductRatePlanResponse given an JSON string
*
* @param jsonString JSON string
* @return An instance of GetProductRatePlanResponse
* @throws IOException if the JSON string is invalid with respect to GetProductRatePlanResponse
*/
public static GetProductRatePlanResponse fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, GetProductRatePlanResponse.class);
}
/**
* Convert an instance of GetProductRatePlanResponse to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy