com.zuora.model.TriggerParams 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.StartDatePolicy;
import com.zuora.model.StartPeriodsType;
import com.zuora.model.TriggerEvent;
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;
/**
* Specifies when a charge becomes active.
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class TriggerParams {
public static final String SERIALIZED_NAME_SPECIFIC_TRIGGER_DATE = "specificTriggerDate";
@SerializedName(SERIALIZED_NAME_SPECIFIC_TRIGGER_DATE)
private LocalDate specificTriggerDate;
public static final String SERIALIZED_NAME_TRIGGER_EVENT = "triggerEvent";
@SerializedName(SERIALIZED_NAME_TRIGGER_EVENT)
private TriggerEvent triggerEvent;
public static final String SERIALIZED_NAME_START_DATE_POLICY = "startDatePolicy";
@SerializedName(SERIALIZED_NAME_START_DATE_POLICY)
private StartDatePolicy startDatePolicy;
public static final String SERIALIZED_NAME_PERIODS_AFTER_CHARGE_START = "periodsAfterChargeStart";
@SerializedName(SERIALIZED_NAME_PERIODS_AFTER_CHARGE_START)
private Integer periodsAfterChargeStart;
public static final String SERIALIZED_NAME_START_PERIODS_TYPE = "startPeriodsType";
@SerializedName(SERIALIZED_NAME_START_PERIODS_TYPE)
private StartPeriodsType startPeriodsType;
public TriggerParams() {
}
public TriggerParams specificTriggerDate(LocalDate specificTriggerDate) {
this.specificTriggerDate = specificTriggerDate;
return this;
}
/**
* Date in YYYY-MM-DD format. Only applicable if the value of the `triggerEvent` field is `SpecificDate`. While this field is applicable, if this field is not set, your `CreateSubscription` order action creates a `Pending` order and a `Pending Acceptance` subscription. If at the same time the service activation date is required and not set, a `Pending Activation` subscription is created. While this field is applicable, if this field is not set, the following order actions create a `Pending` order but do not impact the subscription status. **Note**: This feature is in **Limited Availability**. If you want to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). * AddProduct * UpdateProduct * RemoveProduct * RenewSubscription * TermsAndConditions
* @return specificTriggerDate
*/
@javax.annotation.Nullable
public LocalDate getSpecificTriggerDate() {
return specificTriggerDate;
}
public void setSpecificTriggerDate(LocalDate specificTriggerDate) {
this.specificTriggerDate = specificTriggerDate;
}
public TriggerParams triggerEvent(TriggerEvent triggerEvent) {
this.triggerEvent = triggerEvent;
return this;
}
/**
* Get triggerEvent
* @return triggerEvent
*/
@javax.annotation.Nullable
public TriggerEvent getTriggerEvent() {
return triggerEvent;
}
public void setTriggerEvent(TriggerEvent triggerEvent) {
this.triggerEvent = triggerEvent;
}
public TriggerParams startDatePolicy(StartDatePolicy startDatePolicy) {
this.startDatePolicy = startDatePolicy;
return this;
}
/**
* Get startDatePolicy
* @return startDatePolicy
*/
@javax.annotation.Nullable
public StartDatePolicy getStartDatePolicy() {
return startDatePolicy;
}
public void setStartDatePolicy(StartDatePolicy startDatePolicy) {
this.startDatePolicy = startDatePolicy;
}
public TriggerParams periodsAfterChargeStart(Integer periodsAfterChargeStart) {
this.periodsAfterChargeStart = periodsAfterChargeStart;
return this;
}
/**
* Duration of the discount charge in days, weeks, months, or years, depending on the value of the `startPeriodsType` field. Only applicable if the value of the `startDatePolicy` field is `FixedPeriodAfterApplyToChargeStartDate`. **Note**: You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.
* @return periodsAfterChargeStart
*/
@javax.annotation.Nullable
public Integer getPeriodsAfterChargeStart() {
return periodsAfterChargeStart;
}
public void setPeriodsAfterChargeStart(Integer periodsAfterChargeStart) {
this.periodsAfterChargeStart = periodsAfterChargeStart;
}
public TriggerParams startPeriodsType(StartPeriodsType startPeriodsType) {
this.startPeriodsType = startPeriodsType;
return this;
}
/**
* Get startPeriodsType
* @return startPeriodsType
*/
@javax.annotation.Nullable
public StartPeriodsType getStartPeriodsType() {
return startPeriodsType;
}
public void setStartPeriodsType(StartPeriodsType startPeriodsType) {
this.startPeriodsType = startPeriodsType;
}
/**
* 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 TriggerParams instance itself
*/
public TriggerParams 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;
}
TriggerParams triggerParams = (TriggerParams) o;
return Objects.equals(this.specificTriggerDate, triggerParams.specificTriggerDate) &&
Objects.equals(this.triggerEvent, triggerParams.triggerEvent) &&
Objects.equals(this.startDatePolicy, triggerParams.startDatePolicy) &&
Objects.equals(this.periodsAfterChargeStart, triggerParams.periodsAfterChargeStart) &&
Objects.equals(this.startPeriodsType, triggerParams.startPeriodsType)&&
Objects.equals(this.additionalProperties, triggerParams.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(specificTriggerDate, triggerEvent, startDatePolicy, periodsAfterChargeStart, startPeriodsType, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class TriggerParams {\n");
sb.append(" specificTriggerDate: ").append(toIndentedString(specificTriggerDate)).append("\n");
sb.append(" triggerEvent: ").append(toIndentedString(triggerEvent)).append("\n");
sb.append(" startDatePolicy: ").append(toIndentedString(startDatePolicy)).append("\n");
sb.append(" periodsAfterChargeStart: ").append(toIndentedString(periodsAfterChargeStart)).append("\n");
sb.append(" startPeriodsType: ").append(toIndentedString(startPeriodsType)).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("specificTriggerDate");
openapiFields.add("triggerEvent");
openapiFields.add("startDatePolicy");
openapiFields.add("periodsAfterChargeStart");
openapiFields.add("startPeriodsType");
// 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 TriggerParams
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!TriggerParams.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in TriggerParams is not found in the empty JSON string", TriggerParams.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("triggerEvent") != null && !jsonObj.get("triggerEvent").isJsonNull()) && !jsonObj.get("triggerEvent").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `triggerEvent` to be a primitive type in the JSON string but got `%s`", jsonObj.get("triggerEvent").toString()));
}
// validate the optional field `triggerEvent`
if (jsonObj.get("triggerEvent") != null && !jsonObj.get("triggerEvent").isJsonNull()) {
TriggerEvent.validateJsonElement(jsonObj.get("triggerEvent"));
}
if ((jsonObj.get("startDatePolicy") != null && !jsonObj.get("startDatePolicy").isJsonNull()) && !jsonObj.get("startDatePolicy").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `startDatePolicy` to be a primitive type in the JSON string but got `%s`", jsonObj.get("startDatePolicy").toString()));
}
// validate the optional field `startDatePolicy`
if (jsonObj.get("startDatePolicy") != null && !jsonObj.get("startDatePolicy").isJsonNull()) {
StartDatePolicy.validateJsonElement(jsonObj.get("startDatePolicy"));
}
if ((jsonObj.get("startPeriodsType") != null && !jsonObj.get("startPeriodsType").isJsonNull()) && !jsonObj.get("startPeriodsType").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `startPeriodsType` to be a primitive type in the JSON string but got `%s`", jsonObj.get("startPeriodsType").toString()));
}
// validate the optional field `startPeriodsType`
if (jsonObj.get("startPeriodsType") != null && !jsonObj.get("startPeriodsType").isJsonNull()) {
StartPeriodsType.validateJsonElement(jsonObj.get("startPeriodsType"));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!TriggerParams.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'TriggerParams' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(TriggerParams.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, TriggerParams 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 TriggerParams read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
TriggerParams 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 TriggerParams given an JSON string
*
* @param jsonString JSON string
* @return An instance of TriggerParams
* @throws IOException if the JSON string is invalid with respect to TriggerParams
*/
public static TriggerParams fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, TriggerParams.class);
}
/**
* Convert an instance of TriggerParams to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy