com.zuora.model.CreateOrderResume 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.ResumePeriodsType;
import com.zuora.model.ResumePolicy;
import java.io.IOException;
import java.time.LocalDate;
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;
/**
* Information about an order action of type `Resume`.
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class CreateOrderResume {
public static final String SERIALIZED_NAME_EXTENDS_TERM = "extendsTerm";
@SerializedName(SERIALIZED_NAME_EXTENDS_TERM)
private Boolean extendsTerm;
public static final String SERIALIZED_NAME_RESUME_PERIODS = "resumePeriods";
@SerializedName(SERIALIZED_NAME_RESUME_PERIODS)
private Integer resumePeriods;
public static final String SERIALIZED_NAME_RESUME_PERIODS_TYPE = "resumePeriodsType";
@SerializedName(SERIALIZED_NAME_RESUME_PERIODS_TYPE)
private ResumePeriodsType resumePeriodsType;
public static final String SERIALIZED_NAME_RESUME_POLICY = "resumePolicy";
@SerializedName(SERIALIZED_NAME_RESUME_POLICY)
private ResumePolicy resumePolicy;
public static final String SERIALIZED_NAME_RESUME_SPECIFIC_DATE = "resumeSpecificDate";
@SerializedName(SERIALIZED_NAME_RESUME_SPECIFIC_DATE)
private LocalDate resumeSpecificDate;
public CreateOrderResume() {
}
public CreateOrderResume extendsTerm(Boolean extendsTerm) {
this.extendsTerm = extendsTerm;
return this;
}
/**
* Specifies whether to extend the subscription term by the length of time the suspension is in effect.
* @return extendsTerm
*/
@javax.annotation.Nullable
public Boolean getExtendsTerm() {
return extendsTerm;
}
public void setExtendsTerm(Boolean extendsTerm) {
this.extendsTerm = extendsTerm;
}
public CreateOrderResume resumePeriods(Integer resumePeriods) {
this.resumePeriods = resumePeriods;
return this;
}
/**
* This field is applicable only when the `resumePolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. It must be used together with the `resumePeriodsType` field. The total number of the periods used to specify when a subscription resumption takes effect. The subscription resumption will take place after the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from today's date.
* @return resumePeriods
*/
@javax.annotation.Nullable
public Integer getResumePeriods() {
return resumePeriods;
}
public void setResumePeriods(Integer resumePeriods) {
this.resumePeriods = resumePeriods;
}
public CreateOrderResume resumePeriodsType(ResumePeriodsType resumePeriodsType) {
this.resumePeriodsType = resumePeriodsType;
return this;
}
/**
* Get resumePeriodsType
* @return resumePeriodsType
*/
@javax.annotation.Nullable
public ResumePeriodsType getResumePeriodsType() {
return resumePeriodsType;
}
public void setResumePeriodsType(ResumePeriodsType resumePeriodsType) {
this.resumePeriodsType = resumePeriodsType;
}
public CreateOrderResume resumePolicy(ResumePolicy resumePolicy) {
this.resumePolicy = resumePolicy;
return this;
}
/**
* Get resumePolicy
* @return resumePolicy
*/
@javax.annotation.Nonnull
public ResumePolicy getResumePolicy() {
return resumePolicy;
}
public void setResumePolicy(ResumePolicy resumePolicy) {
this.resumePolicy = resumePolicy;
}
public CreateOrderResume resumeSpecificDate(LocalDate resumeSpecificDate) {
this.resumeSpecificDate = resumeSpecificDate;
return this;
}
/**
* This field is applicable only when the `resumePolicy` field is set to `SpecificDate`. A specific date when the subscription resumption takes effect, in YYYY-MM-DD format. The value should not be earlier than the subscription suspension date.
* @return resumeSpecificDate
*/
@javax.annotation.Nullable
public LocalDate getResumeSpecificDate() {
return resumeSpecificDate;
}
public void setResumeSpecificDate(LocalDate resumeSpecificDate) {
this.resumeSpecificDate = resumeSpecificDate;
}
/**
* 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 CreateOrderResume instance itself
*/
public CreateOrderResume 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;
}
CreateOrderResume createOrderResume = (CreateOrderResume) o;
return Objects.equals(this.extendsTerm, createOrderResume.extendsTerm) &&
Objects.equals(this.resumePeriods, createOrderResume.resumePeriods) &&
Objects.equals(this.resumePeriodsType, createOrderResume.resumePeriodsType) &&
Objects.equals(this.resumePolicy, createOrderResume.resumePolicy) &&
Objects.equals(this.resumeSpecificDate, createOrderResume.resumeSpecificDate)&&
Objects.equals(this.additionalProperties, createOrderResume.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(extendsTerm, resumePeriods, resumePeriodsType, resumePolicy, resumeSpecificDate, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class CreateOrderResume {\n");
sb.append(" extendsTerm: ").append(toIndentedString(extendsTerm)).append("\n");
sb.append(" resumePeriods: ").append(toIndentedString(resumePeriods)).append("\n");
sb.append(" resumePeriodsType: ").append(toIndentedString(resumePeriodsType)).append("\n");
sb.append(" resumePolicy: ").append(toIndentedString(resumePolicy)).append("\n");
sb.append(" resumeSpecificDate: ").append(toIndentedString(resumeSpecificDate)).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("extendsTerm");
openapiFields.add("resumePeriods");
openapiFields.add("resumePeriodsType");
openapiFields.add("resumePolicy");
openapiFields.add("resumeSpecificDate");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("resumePolicy");
}
/**
* 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 CreateOrderResume
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!CreateOrderResume.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in CreateOrderResume is not found in the empty JSON string", CreateOrderResume.openapiRequiredFields.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : CreateOrderResume.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();
if ((jsonObj.get("resumePeriodsType") != null && !jsonObj.get("resumePeriodsType").isJsonNull()) && !jsonObj.get("resumePeriodsType").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `resumePeriodsType` to be a primitive type in the JSON string but got `%s`", jsonObj.get("resumePeriodsType").toString()));
}
// validate the optional field `resumePeriodsType`
if (jsonObj.get("resumePeriodsType") != null && !jsonObj.get("resumePeriodsType").isJsonNull()) {
ResumePeriodsType.validateJsonElement(jsonObj.get("resumePeriodsType"));
}
if (!jsonObj.get("resumePolicy").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `resumePolicy` to be a primitive type in the JSON string but got `%s`", jsonObj.get("resumePolicy").toString()));
}
// validate the required field `resumePolicy`
ResumePolicy.validateJsonElement(jsonObj.get("resumePolicy"));
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!CreateOrderResume.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'CreateOrderResume' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(CreateOrderResume.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, CreateOrderResume 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 CreateOrderResume read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
CreateOrderResume 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 CreateOrderResume given an JSON string
*
* @param jsonString JSON string
* @return An instance of CreateOrderResume
* @throws IOException if the JSON string is invalid with respect to CreateOrderResume
*/
public static CreateOrderResume fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, CreateOrderResume.class);
}
/**
* Convert an instance of CreateOrderResume to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy