com.zuora.model.PutPublicNotificationDefinitionRequest 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.PutPublicNotificationDefinitionRequestCallout;
import com.zuora.model.PutPublicNotificationDefinitionRequestFilterRule;
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;
/**
* PutPublicNotificationDefinitionRequest
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class PutPublicNotificationDefinitionRequest {
public static final String SERIALIZED_NAME_ACTIVE = "active";
@SerializedName(SERIALIZED_NAME_ACTIVE)
private Boolean active = true;
public static final String SERIALIZED_NAME_ASSOCIATED_ACCOUNT = "associatedAccount";
@SerializedName(SERIALIZED_NAME_ASSOCIATED_ACCOUNT)
private String associatedAccount;
public static final String SERIALIZED_NAME_CALLOUT = "callout";
@SerializedName(SERIALIZED_NAME_CALLOUT)
private PutPublicNotificationDefinitionRequestCallout callout;
public static final String SERIALIZED_NAME_CALLOUT_ACTIVE = "calloutActive";
@SerializedName(SERIALIZED_NAME_CALLOUT_ACTIVE)
private Boolean calloutActive = false;
public static final String SERIALIZED_NAME_COMMUNICATION_PROFILE_ID = "communicationProfileId";
@SerializedName(SERIALIZED_NAME_COMMUNICATION_PROFILE_ID)
private String communicationProfileId;
public static final String SERIALIZED_NAME_DESCRIPTION = "description";
@SerializedName(SERIALIZED_NAME_DESCRIPTION)
private String description;
public static final String SERIALIZED_NAME_EMAIL_ACTIVE = "emailActive";
@SerializedName(SERIALIZED_NAME_EMAIL_ACTIVE)
private Boolean emailActive = false;
public static final String SERIALIZED_NAME_EMAIL_TEMPLATE_ID = "emailTemplateId";
@SerializedName(SERIALIZED_NAME_EMAIL_TEMPLATE_ID)
private String emailTemplateId;
public static final String SERIALIZED_NAME_FILTER_RULE = "filterRule";
@SerializedName(SERIALIZED_NAME_FILTER_RULE)
private PutPublicNotificationDefinitionRequestFilterRule filterRule;
public static final String SERIALIZED_NAME_FILTER_RULE_PARAMS = "filterRuleParams";
@SerializedName(SERIALIZED_NAME_FILTER_RULE_PARAMS)
private Map filterRuleParams;
public static final String SERIALIZED_NAME_NAME = "name";
@SerializedName(SERIALIZED_NAME_NAME)
private String name;
public PutPublicNotificationDefinitionRequest() {
}
public PutPublicNotificationDefinitionRequest active(Boolean active) {
this.active = active;
return this;
}
/**
* The status of the notification definition. The default value is `true`.
* @return active
*/
@javax.annotation.Nullable
public Boolean getActive() {
return active;
}
public void setActive(Boolean active) {
this.active = active;
}
public PutPublicNotificationDefinitionRequest associatedAccount(String associatedAccount) {
this.associatedAccount = associatedAccount;
return this;
}
/**
* Indicates with which type of account this notification is associated. Depending on your environment, you can use one of the following values: * `Account.Id`: ID of the primary customer account related to the notification. It is also the default value. * `ParentAccount.Id`: this option is available only if you have <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy\" target=\"_blank\">Customer Hierarchy</a> enabled for your tenant. * `SubscriptionOwnerAccount.Id`: this option is available if the base object of the notification is Order Action. **Note:** before specifying this field, we recommend that you use [Data Source](https://knowledgecenter.zuora.com/Billing/Reporting/D_Data_Sources_and_Exports/C_Data_Source_Reference) to check the available types of accounts for the current notification.
* @return associatedAccount
*/
@javax.annotation.Nullable
public String getAssociatedAccount() {
return associatedAccount;
}
public void setAssociatedAccount(String associatedAccount) {
this.associatedAccount = associatedAccount;
}
public PutPublicNotificationDefinitionRequest callout(PutPublicNotificationDefinitionRequestCallout callout) {
this.callout = callout;
return this;
}
/**
* Get callout
* @return callout
*/
@javax.annotation.Nullable
public PutPublicNotificationDefinitionRequestCallout getCallout() {
return callout;
}
public void setCallout(PutPublicNotificationDefinitionRequestCallout callout) {
this.callout = callout;
}
public PutPublicNotificationDefinitionRequest calloutActive(Boolean calloutActive) {
this.calloutActive = calloutActive;
return this;
}
/**
* The status of the callout action. The default value is `false`.
* @return calloutActive
*/
@javax.annotation.Nullable
public Boolean getCalloutActive() {
return calloutActive;
}
public void setCalloutActive(Boolean calloutActive) {
this.calloutActive = calloutActive;
}
public PutPublicNotificationDefinitionRequest communicationProfileId(String communicationProfileId) {
this.communicationProfileId = communicationProfileId;
return this;
}
/**
* The profile that notification definition belongs to. If you want to update the notification to a system notification, you should pass 'SystemNotification'. '
* @return communicationProfileId
*/
@javax.annotation.Nullable
public String getCommunicationProfileId() {
return communicationProfileId;
}
public void setCommunicationProfileId(String communicationProfileId) {
this.communicationProfileId = communicationProfileId;
}
public PutPublicNotificationDefinitionRequest description(String description) {
this.description = description;
return this;
}
/**
* The description of the notification definition.
* @return description
*/
@javax.annotation.Nullable
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
public PutPublicNotificationDefinitionRequest emailActive(Boolean emailActive) {
this.emailActive = emailActive;
return this;
}
/**
* The status of the email action. The default value is `false`.
* @return emailActive
*/
@javax.annotation.Nullable
public Boolean getEmailActive() {
return emailActive;
}
public void setEmailActive(Boolean emailActive) {
this.emailActive = emailActive;
}
public PutPublicNotificationDefinitionRequest emailTemplateId(String emailTemplateId) {
this.emailTemplateId = emailTemplateId;
return this;
}
/**
* The ID of the email template. If emailActive is updated from false to true, an email template is required, and the EventType of the email template MUST be the same as the EventType of the notification definition.
* @return emailTemplateId
*/
@javax.annotation.Nullable
public String getEmailTemplateId() {
return emailTemplateId;
}
public void setEmailTemplateId(String emailTemplateId) {
this.emailTemplateId = emailTemplateId;
}
public PutPublicNotificationDefinitionRequest filterRule(PutPublicNotificationDefinitionRequestFilterRule filterRule) {
this.filterRule = filterRule;
return this;
}
/**
* Get filterRule
* @return filterRule
*/
@javax.annotation.Nullable
public PutPublicNotificationDefinitionRequestFilterRule getFilterRule() {
return filterRule;
}
public void setFilterRule(PutPublicNotificationDefinitionRequestFilterRule filterRule) {
this.filterRule = filterRule;
}
public PutPublicNotificationDefinitionRequest filterRuleParams(Map filterRuleParams) {
this.filterRuleParams = filterRuleParams;
return this;
}
public PutPublicNotificationDefinitionRequest putFilterRuleParamsItem(String key, String filterRuleParamsItem) {
if (this.filterRuleParams == null) {
this.filterRuleParams = new HashMap<>();
}
this.filterRuleParams.put(key, filterRuleParamsItem);
return this;
}
/**
* The parameter values used to configure the filter rule.
* @return filterRuleParams
*/
@javax.annotation.Nullable
public Map getFilterRuleParams() {
return filterRuleParams;
}
public void setFilterRuleParams(Map filterRuleParams) {
this.filterRuleParams = filterRuleParams;
}
public PutPublicNotificationDefinitionRequest name(String name) {
this.name = name;
return this;
}
/**
* The name of the notification definition, which is unique in the profile.
* @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 PutPublicNotificationDefinitionRequest instance itself
*/
public PutPublicNotificationDefinitionRequest 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;
}
PutPublicNotificationDefinitionRequest putPublicNotificationDefinitionRequest = (PutPublicNotificationDefinitionRequest) o;
return Objects.equals(this.active, putPublicNotificationDefinitionRequest.active) &&
Objects.equals(this.associatedAccount, putPublicNotificationDefinitionRequest.associatedAccount) &&
Objects.equals(this.callout, putPublicNotificationDefinitionRequest.callout) &&
Objects.equals(this.calloutActive, putPublicNotificationDefinitionRequest.calloutActive) &&
Objects.equals(this.communicationProfileId, putPublicNotificationDefinitionRequest.communicationProfileId) &&
Objects.equals(this.description, putPublicNotificationDefinitionRequest.description) &&
Objects.equals(this.emailActive, putPublicNotificationDefinitionRequest.emailActive) &&
Objects.equals(this.emailTemplateId, putPublicNotificationDefinitionRequest.emailTemplateId) &&
Objects.equals(this.filterRule, putPublicNotificationDefinitionRequest.filterRule) &&
Objects.equals(this.filterRuleParams, putPublicNotificationDefinitionRequest.filterRuleParams) &&
Objects.equals(this.name, putPublicNotificationDefinitionRequest.name)&&
Objects.equals(this.additionalProperties, putPublicNotificationDefinitionRequest.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(active, associatedAccount, callout, calloutActive, communicationProfileId, description, emailActive, emailTemplateId, filterRule, filterRuleParams, name, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class PutPublicNotificationDefinitionRequest {\n");
sb.append(" active: ").append(toIndentedString(active)).append("\n");
sb.append(" associatedAccount: ").append(toIndentedString(associatedAccount)).append("\n");
sb.append(" callout: ").append(toIndentedString(callout)).append("\n");
sb.append(" calloutActive: ").append(toIndentedString(calloutActive)).append("\n");
sb.append(" communicationProfileId: ").append(toIndentedString(communicationProfileId)).append("\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" emailActive: ").append(toIndentedString(emailActive)).append("\n");
sb.append(" emailTemplateId: ").append(toIndentedString(emailTemplateId)).append("\n");
sb.append(" filterRule: ").append(toIndentedString(filterRule)).append("\n");
sb.append(" filterRuleParams: ").append(toIndentedString(filterRuleParams)).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("active");
openapiFields.add("associatedAccount");
openapiFields.add("callout");
openapiFields.add("calloutActive");
openapiFields.add("communicationProfileId");
openapiFields.add("description");
openapiFields.add("emailActive");
openapiFields.add("emailTemplateId");
openapiFields.add("filterRule");
openapiFields.add("filterRuleParams");
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 PutPublicNotificationDefinitionRequest
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!PutPublicNotificationDefinitionRequest.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in PutPublicNotificationDefinitionRequest is not found in the empty JSON string", PutPublicNotificationDefinitionRequest.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("associatedAccount") != null && !jsonObj.get("associatedAccount").isJsonNull()) && !jsonObj.get("associatedAccount").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `associatedAccount` to be a primitive type in the JSON string but got `%s`", jsonObj.get("associatedAccount").toString()));
}
// validate the optional field `callout`
if (jsonObj.get("callout") != null && !jsonObj.get("callout").isJsonNull()) {
PutPublicNotificationDefinitionRequestCallout.validateJsonElement(jsonObj.get("callout"));
}
if ((jsonObj.get("communicationProfileId") != null && !jsonObj.get("communicationProfileId").isJsonNull()) && !jsonObj.get("communicationProfileId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `communicationProfileId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("communicationProfileId").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("emailTemplateId") != null && !jsonObj.get("emailTemplateId").isJsonNull()) && !jsonObj.get("emailTemplateId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `emailTemplateId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("emailTemplateId").toString()));
}
// validate the optional field `filterRule`
if (jsonObj.get("filterRule") != null && !jsonObj.get("filterRule").isJsonNull()) {
PutPublicNotificationDefinitionRequestFilterRule.validateJsonElement(jsonObj.get("filterRule"));
}
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 (!PutPublicNotificationDefinitionRequest.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'PutPublicNotificationDefinitionRequest' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(PutPublicNotificationDefinitionRequest.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, PutPublicNotificationDefinitionRequest 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 PutPublicNotificationDefinitionRequest read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
PutPublicNotificationDefinitionRequest 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 PutPublicNotificationDefinitionRequest given an JSON string
*
* @param jsonString JSON string
* @return An instance of PutPublicNotificationDefinitionRequest
* @throws IOException if the JSON string is invalid with respect to PutPublicNotificationDefinitionRequest
*/
public static PutPublicNotificationDefinitionRequest fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, PutPublicNotificationDefinitionRequest.class);
}
/**
* Convert an instance of PutPublicNotificationDefinitionRequest to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy