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

com.zuora.model.EndConditions 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.EndDateCondition;
import com.zuora.model.EndDatePolicy;
import com.zuora.model.UpToPeriodsType;
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 inactive. 
 */
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class EndConditions {
  public static final String SERIALIZED_NAME_END_DATE_CONDITION = "endDateCondition";
  @SerializedName(SERIALIZED_NAME_END_DATE_CONDITION)
  private EndDateCondition endDateCondition;

  public static final String SERIALIZED_NAME_END_DATE_POLICY = "endDatePolicy";
  @SerializedName(SERIALIZED_NAME_END_DATE_POLICY)
  private EndDatePolicy endDatePolicy;

  public static final String SERIALIZED_NAME_SPECIFIC_END_DATE = "specificEndDate";
  @SerializedName(SERIALIZED_NAME_SPECIFIC_END_DATE)
  private LocalDate specificEndDate;

  public static final String SERIALIZED_NAME_UP_TO_PERIODS = "upToPeriods";
  @SerializedName(SERIALIZED_NAME_UP_TO_PERIODS)
  private Integer upToPeriods;

  public static final String SERIALIZED_NAME_UP_TO_PERIODS_TYPE = "upToPeriodsType";
  @SerializedName(SERIALIZED_NAME_UP_TO_PERIODS_TYPE)
  private UpToPeriodsType upToPeriodsType;

  public EndConditions() {
  }

  public EndConditions endDateCondition(EndDateCondition endDateCondition) {
    this.endDateCondition = endDateCondition;
    return this;
  }

  /**
   * Get endDateCondition
   * @return endDateCondition
   */
  @javax.annotation.Nullable
  public EndDateCondition getEndDateCondition() {
    return endDateCondition;
  }

  public void setEndDateCondition(EndDateCondition endDateCondition) {
    this.endDateCondition = endDateCondition;
  }


  public EndConditions endDatePolicy(EndDatePolicy endDatePolicy) {
    this.endDatePolicy = endDatePolicy;
    return this;
  }

  /**
   * Get endDatePolicy
   * @return endDatePolicy
   */
  @javax.annotation.Nullable
  public EndDatePolicy getEndDatePolicy() {
    return endDatePolicy;
  }

  public void setEndDatePolicy(EndDatePolicy endDatePolicy) {
    this.endDatePolicy = endDatePolicy;
  }


  public EndConditions specificEndDate(LocalDate specificEndDate) {
    this.specificEndDate = specificEndDate;
    return this;
  }

  /**
   * Date in YYYY-MM-DD format. Only applicable if the value of the `endDateCondition` field is `Specific_End_Date`. 
   * @return specificEndDate
   */
  @javax.annotation.Nullable
  public LocalDate getSpecificEndDate() {
    return specificEndDate;
  }

  public void setSpecificEndDate(LocalDate specificEndDate) {
    this.specificEndDate = specificEndDate;
  }


  public EndConditions upToPeriods(Integer upToPeriods) {
    this.upToPeriods = upToPeriods;
    return this;
  }

  /**
   * Duration of the charge in billing periods, days, weeks, months, or years, depending on the value of the `upToPeriodsType` field. Only applicable if the value of the `endDateCondition` field is `Fixed_Period`. 
   * @return upToPeriods
   */
  @javax.annotation.Nullable
  public Integer getUpToPeriods() {
    return upToPeriods;
  }

  public void setUpToPeriods(Integer upToPeriods) {
    this.upToPeriods = upToPeriods;
  }


  public EndConditions upToPeriodsType(UpToPeriodsType upToPeriodsType) {
    this.upToPeriodsType = upToPeriodsType;
    return this;
  }

  /**
   * Get upToPeriodsType
   * @return upToPeriodsType
   */
  @javax.annotation.Nullable
  public UpToPeriodsType getUpToPeriodsType() {
    return upToPeriodsType;
  }

  public void setUpToPeriodsType(UpToPeriodsType upToPeriodsType) {
    this.upToPeriodsType = upToPeriodsType;
  }

  /**
   * 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 EndConditions instance itself
   */
  public EndConditions 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;
    }
    EndConditions endConditions = (EndConditions) o;
    return Objects.equals(this.endDateCondition, endConditions.endDateCondition) &&
        Objects.equals(this.endDatePolicy, endConditions.endDatePolicy) &&
        Objects.equals(this.specificEndDate, endConditions.specificEndDate) &&
        Objects.equals(this.upToPeriods, endConditions.upToPeriods) &&
        Objects.equals(this.upToPeriodsType, endConditions.upToPeriodsType)&&
        Objects.equals(this.additionalProperties, endConditions.additionalProperties);
  }

  @Override
  public int hashCode() {
    return Objects.hash(endDateCondition, endDatePolicy, specificEndDate, upToPeriods, upToPeriodsType, additionalProperties);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class EndConditions {\n");
    sb.append("    endDateCondition: ").append(toIndentedString(endDateCondition)).append("\n");
    sb.append("    endDatePolicy: ").append(toIndentedString(endDatePolicy)).append("\n");
    sb.append("    specificEndDate: ").append(toIndentedString(specificEndDate)).append("\n");
    sb.append("    upToPeriods: ").append(toIndentedString(upToPeriods)).append("\n");
    sb.append("    upToPeriodsType: ").append(toIndentedString(upToPeriodsType)).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("endDateCondition");
    openapiFields.add("endDatePolicy");
    openapiFields.add("specificEndDate");
    openapiFields.add("upToPeriods");
    openapiFields.add("upToPeriodsType");

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

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

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

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





© 2015 - 2025 Weber Informatics LLC | Privacy Policy