All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.zuora.model.OrderActionSuspend Maven / Gradle / Ivy

There is a newer version: 3.2.1
Show 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.SuspendPeriodsType;
import com.zuora.model.SuspendPolicy;
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 `Suspend`. 
 */
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class OrderActionSuspend {
  public static final String SERIALIZED_NAME_SUSPEND_DATE = "suspendDate";
  @SerializedName(SERIALIZED_NAME_SUSPEND_DATE)
  private LocalDate suspendDate;

  public static final String SERIALIZED_NAME_SUSPEND_PERIODS = "suspendPeriods";
  @SerializedName(SERIALIZED_NAME_SUSPEND_PERIODS)
  private Integer suspendPeriods;

  public static final String SERIALIZED_NAME_SUSPEND_PERIODS_TYPE = "suspendPeriodsType";
  @SerializedName(SERIALIZED_NAME_SUSPEND_PERIODS_TYPE)
  private SuspendPeriodsType suspendPeriodsType;

  public static final String SERIALIZED_NAME_SUSPEND_POLICY = "suspendPolicy";
  @SerializedName(SERIALIZED_NAME_SUSPEND_POLICY)
  private SuspendPolicy suspendPolicy;

  public static final String SERIALIZED_NAME_SUSPEND_SPECIFIC_DATE = "suspendSpecificDate";
  @SerializedName(SERIALIZED_NAME_SUSPEND_SPECIFIC_DATE)
  private LocalDate suspendSpecificDate;

  public OrderActionSuspend() {
  }

  public OrderActionSuspend suspendDate(LocalDate suspendDate) {
    this.suspendDate = suspendDate;
    return this;
  }

  /**
   * The suspend date when the suspension takes effect.  
   * @return suspendDate
   */
  @javax.annotation.Nullable
  public LocalDate getSuspendDate() {
    return suspendDate;
  }

  public void setSuspendDate(LocalDate suspendDate) {
    this.suspendDate = suspendDate;
  }


  public OrderActionSuspend suspendPeriods(Integer suspendPeriods) {
    this.suspendPeriods = suspendPeriods;
    return this;
  }

  /**
   * This field is applicable only when the `suspendPolicy` field is set to `FixedPeriodsFromToday`. It must be used together with the `suspendPeriodsType` field. Note this field is not applicable in a Suspend order action auto-created by the Order Metrics migration.  The total number of the periods used to specify when a subscription suspension takes effect. The subscription suspension will take place after the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from today's date.  
   * @return suspendPeriods
   */
  @javax.annotation.Nullable
  public Integer getSuspendPeriods() {
    return suspendPeriods;
  }

  public void setSuspendPeriods(Integer suspendPeriods) {
    this.suspendPeriods = suspendPeriods;
  }


  public OrderActionSuspend suspendPeriodsType(SuspendPeriodsType suspendPeriodsType) {
    this.suspendPeriodsType = suspendPeriodsType;
    return this;
  }

  /**
   * Get suspendPeriodsType
   * @return suspendPeriodsType
   */
  @javax.annotation.Nullable
  public SuspendPeriodsType getSuspendPeriodsType() {
    return suspendPeriodsType;
  }

  public void setSuspendPeriodsType(SuspendPeriodsType suspendPeriodsType) {
    this.suspendPeriodsType = suspendPeriodsType;
  }


  public OrderActionSuspend suspendPolicy(SuspendPolicy suspendPolicy) {
    this.suspendPolicy = suspendPolicy;
    return this;
  }

  /**
   * Get suspendPolicy
   * @return suspendPolicy
   */
  @javax.annotation.Nullable
  public SuspendPolicy getSuspendPolicy() {
    return suspendPolicy;
  }

  public void setSuspendPolicy(SuspendPolicy suspendPolicy) {
    this.suspendPolicy = suspendPolicy;
  }


  public OrderActionSuspend suspendSpecificDate(LocalDate suspendSpecificDate) {
    this.suspendSpecificDate = suspendSpecificDate;
    return this;
  }

  /**
   * This field is applicable only when the `suspendPolicy` field is set to `SpecificDate`. Note this field is not applicable in a Suspend order action auto-created by the Order Metrics migration.  A specific date when the subscription suspension takes effect, in YYYY-MM-DD format. The value should not be earlier than the subscription's contract effective date or later than the subscription's term end date. 
   * @return suspendSpecificDate
   */
  @javax.annotation.Nullable
  public LocalDate getSuspendSpecificDate() {
    return suspendSpecificDate;
  }

  public void setSuspendSpecificDate(LocalDate suspendSpecificDate) {
    this.suspendSpecificDate = suspendSpecificDate;
  }

  /**
   * 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 OrderActionSuspend instance itself
   */
  public OrderActionSuspend 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;
    }
    OrderActionSuspend orderActionSuspend = (OrderActionSuspend) o;
    return Objects.equals(this.suspendDate, orderActionSuspend.suspendDate) &&
        Objects.equals(this.suspendPeriods, orderActionSuspend.suspendPeriods) &&
        Objects.equals(this.suspendPeriodsType, orderActionSuspend.suspendPeriodsType) &&
        Objects.equals(this.suspendPolicy, orderActionSuspend.suspendPolicy) &&
        Objects.equals(this.suspendSpecificDate, orderActionSuspend.suspendSpecificDate)&&
        Objects.equals(this.additionalProperties, orderActionSuspend.additionalProperties);
  }

  @Override
  public int hashCode() {
    return Objects.hash(suspendDate, suspendPeriods, suspendPeriodsType, suspendPolicy, suspendSpecificDate, additionalProperties);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class OrderActionSuspend {\n");
    sb.append("    suspendDate: ").append(toIndentedString(suspendDate)).append("\n");
    sb.append("    suspendPeriods: ").append(toIndentedString(suspendPeriods)).append("\n");
    sb.append("    suspendPeriodsType: ").append(toIndentedString(suspendPeriodsType)).append("\n");
    sb.append("    suspendPolicy: ").append(toIndentedString(suspendPolicy)).append("\n");
    sb.append("    suspendSpecificDate: ").append(toIndentedString(suspendSpecificDate)).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("suspendDate");
    openapiFields.add("suspendPeriods");
    openapiFields.add("suspendPeriodsType");
    openapiFields.add("suspendPolicy");
    openapiFields.add("suspendSpecificDate");

    // 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 OrderActionSuspend
   */
  public static void validateJsonElement(JsonElement jsonElement) throws IOException {
      if (jsonElement == null) {
        if (!OrderActionSuspend.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
          throw new IllegalArgumentException(String.format("The required field(s) %s in OrderActionSuspend is not found in the empty JSON string", OrderActionSuspend.openapiRequiredFields.toString()));
        }
      }
        JsonObject jsonObj = jsonElement.getAsJsonObject();
      if ((jsonObj.get("suspendPeriodsType") != null && !jsonObj.get("suspendPeriodsType").isJsonNull()) && !jsonObj.get("suspendPeriodsType").isJsonPrimitive()) {
        throw new IllegalArgumentException(String.format("Expected the field `suspendPeriodsType` to be a primitive type in the JSON string but got `%s`", jsonObj.get("suspendPeriodsType").toString()));
      }
      // validate the optional field `suspendPeriodsType`
      if (jsonObj.get("suspendPeriodsType") != null && !jsonObj.get("suspendPeriodsType").isJsonNull()) {
        SuspendPeriodsType.validateJsonElement(jsonObj.get("suspendPeriodsType"));
      }
      if ((jsonObj.get("suspendPolicy") != null && !jsonObj.get("suspendPolicy").isJsonNull()) && !jsonObj.get("suspendPolicy").isJsonPrimitive()) {
        throw new IllegalArgumentException(String.format("Expected the field `suspendPolicy` to be a primitive type in the JSON string but got `%s`", jsonObj.get("suspendPolicy").toString()));
      }
      // validate the optional field `suspendPolicy`
      if (jsonObj.get("suspendPolicy") != null && !jsonObj.get("suspendPolicy").isJsonNull()) {
        SuspendPolicy.validateJsonElement(jsonObj.get("suspendPolicy"));
      }
  }

  public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
    @SuppressWarnings("unchecked")
    @Override
    public  TypeAdapter create(Gson gson, TypeToken type) {
       if (!OrderActionSuspend.class.isAssignableFrom(type.getRawType())) {
         return null; // this class only serializes 'OrderActionSuspend' and its subtypes
       }
       final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
       final TypeAdapter thisAdapter
                        = gson.getDelegateAdapter(this, TypeToken.get(OrderActionSuspend.class));

       return (TypeAdapter) new TypeAdapter() {
           @Override
           public void write(JsonWriter out, OrderActionSuspend 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 OrderActionSuspend read(JsonReader in) throws IOException {
             JsonElement jsonElement = elementAdapter.read(in);
             validateJsonElement(jsonElement);
             JsonObject jsonObj = jsonElement.getAsJsonObject();
             // store additional fields in the deserialized instance
             OrderActionSuspend 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 OrderActionSuspend given an JSON string
   *
   * @param jsonString JSON string
   * @return An instance of OrderActionSuspend
   * @throws IOException if the JSON string is invalid with respect to OrderActionSuspend
   */
  public static OrderActionSuspend fromJson(String jsonString) throws IOException {
    return JSON.getGson().fromJson(jsonString, OrderActionSuspend.class);
  }

  /**
   * Convert an instance of OrderActionSuspend to an JSON string
   *
   * @return JSON string
   */
  public String toJson() {
    return JSON.getGson().toJson(this);
  }
}





© 2015 - 2025 Weber Informatics LLC | Privacy Policy