com.zuora.model.PostScheduledEventRequest 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
The newest version!
/*
* 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.PostScheduledEventRequestParametersValue;
import java.io.IOException;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
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;
/**
* namespace.name pair should be unique universally
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class PostScheduledEventRequest {
public static final String SERIALIZED_NAME_ACTIVE = "active";
@SerializedName(SERIALIZED_NAME_ACTIVE)
private Boolean active = true;
public static final String SERIALIZED_NAME_API_FIELD = "apiField";
@SerializedName(SERIALIZED_NAME_API_FIELD)
private String apiField;
public static final String SERIALIZED_NAME_API_OBJECT = "apiObject";
@SerializedName(SERIALIZED_NAME_API_OBJECT)
private String apiObject;
public static final String SERIALIZED_NAME_CONDITION = "condition";
@SerializedName(SERIALIZED_NAME_CONDITION)
private String condition;
public static final String SERIALIZED_NAME_DESCRIPTION = "description";
@SerializedName(SERIALIZED_NAME_DESCRIPTION)
private String description;
public static final String SERIALIZED_NAME_DISPLAY_NAME = "displayName";
@SerializedName(SERIALIZED_NAME_DISPLAY_NAME)
private String displayName;
public static final String SERIALIZED_NAME_HOURS = "hours";
@SerializedName(SERIALIZED_NAME_HOURS)
private Integer hours;
public static final String SERIALIZED_NAME_MINUTES = "minutes";
@SerializedName(SERIALIZED_NAME_MINUTES)
private Integer minutes;
public static final String SERIALIZED_NAME_NAME = "name";
@SerializedName(SERIALIZED_NAME_NAME)
private String name;
public static final String SERIALIZED_NAME_PARAMETERS = "parameters";
@SerializedName(SERIALIZED_NAME_PARAMETERS)
private Map parameters;
public PostScheduledEventRequest() {
}
public PostScheduledEventRequest active(Boolean active) {
this.active = active;
return this;
}
/**
* Indicate whether the scheduled event is active or inactive.
* @return active
*/
@javax.annotation.Nullable
public Boolean getActive() {
return active;
}
public void setActive(Boolean active) {
this.active = active;
}
public PostScheduledEventRequest apiField(String apiField) {
this.apiField = apiField;
return this;
}
/**
* The base field of the base object in the `apiObject` field, should be in date or timestamp format. The scheduled event notifications are triggered based on this date and the event parameters (before or after a specified number of days) from notification definitions. Should be specified in the pattern: ^[A-Z][\\\\w\\\\-]*$ See [Custom Scheduled Events](https://knowledgecenter.zuora.com/Central_Platform/Events_and_Notifications/A_Z_Custom_Scheduled_Events) for all available base fields.
* @return apiField
*/
@javax.annotation.Nonnull
public String getApiField() {
return apiField;
}
public void setApiField(String apiField) {
this.apiField = apiField;
}
public PostScheduledEventRequest apiObject(String apiObject) {
this.apiObject = apiObject;
return this;
}
/**
* The base object that the scheduled event is defined upon. The base object should contain a date or timestamp format field. Should be specified in the pattern: ^[A-Z][\\\\w\\\\-]*$ See [Custom Scheduled Events](https://knowledgecenter.zuora.com/Central_Platform/Events_and_Notifications/A_Z_Custom_Scheduled_Events) for all available base objects.
* @return apiObject
*/
@javax.annotation.Nonnull
public String getApiObject() {
return apiObject;
}
public void setApiObject(String apiObject) {
this.apiObject = apiObject;
}
public PostScheduledEventRequest condition(String condition) {
this.condition = condition;
return this;
}
/**
* The filter rule conditions, written in [JEXL](http://commons.apache.org/proper/commons-jexl/). The scheduled event is triggered only if the condition is evaluated as true. The rule might contain event context merge fields and data source merge fields. Data source merge fields must be from [the base object of the event or from the joined objects of the base object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects). Scheduled events with invalid merge fields will fail to evaluate, thus will not be triggered. For example, to trigger an invoice due date scheduled event to only invoices with an amount over 1000, you would define the following condition: ```Invoice.Amount > 1000``` `Invoice.Amount` refers to the `Amount` field of the Zuora object `Invoice`.
* @return condition
*/
@javax.annotation.Nullable
public String getCondition() {
return condition;
}
public void setCondition(String condition) {
this.condition = condition;
}
public PostScheduledEventRequest description(String description) {
this.description = description;
return this;
}
/**
* The description of the scheduled event.
* @return description
*/
@javax.annotation.Nullable
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
public PostScheduledEventRequest displayName(String displayName) {
this.displayName = displayName;
return this;
}
/**
* The display name of the scheduled event.
* @return displayName
*/
@javax.annotation.Nonnull
public String getDisplayName() {
return displayName;
}
public void setDisplayName(String displayName) {
this.displayName = displayName;
}
public PostScheduledEventRequest hours(Integer hours) {
this.hours = hours;
return this;
}
/**
* The scheduled time (hour) that the scheduled event notifications are sent. This time is based on the localized timezone of your tenant.
* minimum: 0
* maximum: 23
* @return hours
*/
@javax.annotation.Nonnull
public Integer getHours() {
return hours;
}
public void setHours(Integer hours) {
this.hours = hours;
}
public PostScheduledEventRequest minutes(Integer minutes) {
this.minutes = minutes;
return this;
}
/**
* The scheduled time (minute) that the scheduled event notifications are sent. This time is based on the localized timezone of your tenant.
* minimum: 0
* maximum: 59
* @return minutes
*/
@javax.annotation.Nonnull
public Integer getMinutes() {
return minutes;
}
public void setMinutes(Integer minutes) {
this.minutes = minutes;
}
public PostScheduledEventRequest name(String name) {
this.name = name;
return this;
}
/**
* The name of the scheduled event. Should be unique, contain no space, and be in the pattern: ^[A-Za-z]{1,}[\\\\w\\\\-]*$
* @return name
*/
@javax.annotation.Nonnull
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public PostScheduledEventRequest parameters(Map parameters) {
this.parameters = parameters;
return this;
}
public PostScheduledEventRequest putParametersItem(String key, PostScheduledEventRequestParametersValue parametersItem) {
if (this.parameters == null) {
this.parameters = new HashMap<>();
}
this.parameters.put(key, parametersItem);
return this;
}
/**
* The parameter definitions of the filter rule. The names of the parameters must match with the filter rule and can't be duplicated. You should specify all the parameters when creating scheduled event notifications.
* @return parameters
*/
@javax.annotation.Nullable
public Map getParameters() {
return parameters;
}
public void setParameters(Map parameters) {
this.parameters = parameters;
}
/**
* 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 PostScheduledEventRequest instance itself
*/
public PostScheduledEventRequest 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;
}
PostScheduledEventRequest postScheduledEventRequest = (PostScheduledEventRequest) o;
return Objects.equals(this.active, postScheduledEventRequest.active) &&
Objects.equals(this.apiField, postScheduledEventRequest.apiField) &&
Objects.equals(this.apiObject, postScheduledEventRequest.apiObject) &&
Objects.equals(this.condition, postScheduledEventRequest.condition) &&
Objects.equals(this.description, postScheduledEventRequest.description) &&
Objects.equals(this.displayName, postScheduledEventRequest.displayName) &&
Objects.equals(this.hours, postScheduledEventRequest.hours) &&
Objects.equals(this.minutes, postScheduledEventRequest.minutes) &&
Objects.equals(this.name, postScheduledEventRequest.name) &&
Objects.equals(this.parameters, postScheduledEventRequest.parameters)&&
Objects.equals(this.additionalProperties, postScheduledEventRequest.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(active, apiField, apiObject, condition, description, displayName, hours, minutes, name, parameters, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class PostScheduledEventRequest {\n");
sb.append(" active: ").append(toIndentedString(active)).append("\n");
sb.append(" apiField: ").append(toIndentedString(apiField)).append("\n");
sb.append(" apiObject: ").append(toIndentedString(apiObject)).append("\n");
sb.append(" condition: ").append(toIndentedString(condition)).append("\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" displayName: ").append(toIndentedString(displayName)).append("\n");
sb.append(" hours: ").append(toIndentedString(hours)).append("\n");
sb.append(" minutes: ").append(toIndentedString(minutes)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" parameters: ").append(toIndentedString(parameters)).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("active");
openapiFields.add("apiField");
openapiFields.add("apiObject");
openapiFields.add("condition");
openapiFields.add("description");
openapiFields.add("displayName");
openapiFields.add("hours");
openapiFields.add("minutes");
openapiFields.add("name");
openapiFields.add("parameters");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("apiField");
openapiRequiredFields.add("apiObject");
openapiRequiredFields.add("displayName");
openapiRequiredFields.add("hours");
openapiRequiredFields.add("minutes");
openapiRequiredFields.add("name");
}
/**
* 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 PostScheduledEventRequest
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!PostScheduledEventRequest.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in PostScheduledEventRequest is not found in the empty JSON string", PostScheduledEventRequest.openapiRequiredFields.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : PostScheduledEventRequest.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("apiField").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `apiField` to be a primitive type in the JSON string but got `%s`", jsonObj.get("apiField").toString()));
}
if (!jsonObj.get("apiObject").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `apiObject` to be a primitive type in the JSON string but got `%s`", jsonObj.get("apiObject").toString()));
}
if ((jsonObj.get("condition") != null && !jsonObj.get("condition").isJsonNull()) && !jsonObj.get("condition").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `condition` to be a primitive type in the JSON string but got `%s`", jsonObj.get("condition").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()));
}
if (!jsonObj.get("displayName").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `displayName` to be a primitive type in the JSON string but got `%s`", jsonObj.get("displayName").toString()));
}
if (!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 (!PostScheduledEventRequest.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'PostScheduledEventRequest' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(PostScheduledEventRequest.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, PostScheduledEventRequest 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 PostScheduledEventRequest read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
PostScheduledEventRequest 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 PostScheduledEventRequest given an JSON string
*
* @param jsonString JSON string
* @return An instance of PostScheduledEventRequest
* @throws IOException if the JSON string is invalid with respect to PostScheduledEventRequest
*/
public static PostScheduledEventRequest fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, PostScheduledEventRequest.class);
}
/**
* Convert an instance of PostScheduledEventRequest to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy