com.zuora.model.PreviewExistingSubscriptionResultCreditMemos 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
The SDK of JAVA language for Zuora pricing system
There is a newer version: 3.2.1
/*
 * 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.PreviewExistingSubscriptionCreditMemoItemResult;
import java.io.IOException;
import java.math.BigDecimal;
import java.time.LocalDate;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

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;

/**
 * PreviewExistingSubscriptionResultCreditMemos
 */
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class PreviewExistingSubscriptionResultCreditMemos {
  public static final String SERIALIZED_NAME_CREDIT_MEMO_NUMBER = "creditMemoNumber";
  @SerializedName(SERIALIZED_NAME_CREDIT_MEMO_NUMBER)
  private String creditMemoNumber;

  public static final String SERIALIZED_NAME_AMOUNT = "amount";
  @SerializedName(SERIALIZED_NAME_AMOUNT)
  private BigDecimal amount;

  public static final String SERIALIZED_NAME_AMOUNT_WITHOUT_TAX = "amountWithoutTax";
  @SerializedName(SERIALIZED_NAME_AMOUNT_WITHOUT_TAX)
  private BigDecimal amountWithoutTax;

  public static final String SERIALIZED_NAME_TAX_AMOUNT = "taxAmount";
  @SerializedName(SERIALIZED_NAME_TAX_AMOUNT)
  private BigDecimal taxAmount;

  public static final String SERIALIZED_NAME_TARGET_DATE = "targetDate";
  @SerializedName(SERIALIZED_NAME_TARGET_DATE)
  private LocalDate targetDate;

  public static final String SERIALIZED_NAME_CREDIT_MEMO_ITEMS = "creditMemoItems";
  @SerializedName(SERIALIZED_NAME_CREDIT_MEMO_ITEMS)
  private List creditMemoItems;

  public static final String SERIALIZED_NAME_STATUS = "status";
  @SerializedName(SERIALIZED_NAME_STATUS)
  private String status;

  public static final String SERIALIZED_NAME_IS_FROM_EXISTING_CREDIT_MEMO = "isFromExistingCreditMemo";
  @SerializedName(SERIALIZED_NAME_IS_FROM_EXISTING_CREDIT_MEMO)
  private Boolean isFromExistingCreditMemo;

  public PreviewExistingSubscriptionResultCreditMemos() {
  }

  public PreviewExistingSubscriptionResultCreditMemos creditMemoNumber(String creditMemoNumber) {
    this.creditMemoNumber = creditMemoNumber;
    return this;
  }

  /**
   * The credit memo number.
   * @return creditMemoNumber
   */
  @javax.annotation.Nullable
  public String getCreditMemoNumber() {
    return creditMemoNumber;
  }

  public void setCreditMemoNumber(String creditMemoNumber) {
    this.creditMemoNumber = creditMemoNumber;
  }


  public PreviewExistingSubscriptionResultCreditMemos amount(BigDecimal amount) {
    this.amount = amount;
    return this;
  }

  /**
   * Credit memo amount.
   * @return amount
   */
  @javax.annotation.Nullable
  public BigDecimal getAmount() {
    return amount;
  }

  public void setAmount(BigDecimal amount) {
    this.amount = amount;
  }


  public PreviewExistingSubscriptionResultCreditMemos amountWithoutTax(BigDecimal amountWithoutTax) {
    this.amountWithoutTax = amountWithoutTax;
    return this;
  }

  /**
   * Credit memo amount minus tax.
   * @return amountWithoutTax
   */
  @javax.annotation.Nullable
  public BigDecimal getAmountWithoutTax() {
    return amountWithoutTax;
  }

  public void setAmountWithoutTax(BigDecimal amountWithoutTax) {
    this.amountWithoutTax = amountWithoutTax;
  }


  public PreviewExistingSubscriptionResultCreditMemos taxAmount(BigDecimal taxAmount) {
    this.taxAmount = taxAmount;
    return this;
  }

  /**
   * The tax amount of the credit memo.
   * @return taxAmount
   */
  @javax.annotation.Nullable
  public BigDecimal getTaxAmount() {
    return taxAmount;
  }

  public void setTaxAmount(BigDecimal taxAmount) {
    this.taxAmount = taxAmount;
  }


  public PreviewExistingSubscriptionResultCreditMemos targetDate(LocalDate targetDate) {
    this.targetDate = targetDate;
    return this;
  }

  /**
   * Date through which to calculate charges if a credit memo is generated, as yyyy-mm-dd.
   * @return targetDate
   */
  @javax.annotation.Nullable
  public LocalDate getTargetDate() {
    return targetDate;
  }

  public void setTargetDate(LocalDate targetDate) {
    this.targetDate = targetDate;
  }


  public PreviewExistingSubscriptionResultCreditMemos creditMemoItems(List creditMemoItems) {
    this.creditMemoItems = creditMemoItems;
    return this;
  }

  public PreviewExistingSubscriptionResultCreditMemos addCreditMemoItemsItem(PreviewExistingSubscriptionCreditMemoItemResult creditMemoItemsItem) {
    if (this.creditMemoItems == null) {
      this.creditMemoItems = new ArrayList<>();
    }
    this.creditMemoItems.add(creditMemoItemsItem);
    return this;
  }

  /**
   * Container for credit memo items.
   * @return creditMemoItems
   */
  @javax.annotation.Nullable
  public List getCreditMemoItems() {
    return creditMemoItems;
  }

  public void setCreditMemoItems(List creditMemoItems) {
    this.creditMemoItems = creditMemoItems;
  }


  public PreviewExistingSubscriptionResultCreditMemos status(String status) {
    this.status = status;
    return this;
  }

  /**
   * The status of the credit memo.
   * @return status
   */
  @javax.annotation.Nullable
  public String getStatus() {
    return status;
  }

  public void setStatus(String status) {
    this.status = status;
  }


  public PreviewExistingSubscriptionResultCreditMemos isFromExistingCreditMemo(Boolean isFromExistingCreditMemo) {
    this.isFromExistingCreditMemo = isFromExistingCreditMemo;
    return this;
  }

  /**
   * Indicates whether the credit memo information is from an existing credit memo.
   * @return isFromExistingCreditMemo
   */
  @javax.annotation.Nullable
  public Boolean getIsFromExistingCreditMemo() {
    return isFromExistingCreditMemo;
  }

  public void setIsFromExistingCreditMemo(Boolean isFromExistingCreditMemo) {
    this.isFromExistingCreditMemo = isFromExistingCreditMemo;
  }

  /**
   * 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 PreviewExistingSubscriptionResultCreditMemos instance itself
   */
  public PreviewExistingSubscriptionResultCreditMemos 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;
    }
    PreviewExistingSubscriptionResultCreditMemos previewExistingSubscriptionResultCreditMemos = (PreviewExistingSubscriptionResultCreditMemos) o;
    return Objects.equals(this.creditMemoNumber, previewExistingSubscriptionResultCreditMemos.creditMemoNumber) &&
        Objects.equals(this.amount, previewExistingSubscriptionResultCreditMemos.amount) &&
        Objects.equals(this.amountWithoutTax, previewExistingSubscriptionResultCreditMemos.amountWithoutTax) &&
        Objects.equals(this.taxAmount, previewExistingSubscriptionResultCreditMemos.taxAmount) &&
        Objects.equals(this.targetDate, previewExistingSubscriptionResultCreditMemos.targetDate) &&
        Objects.equals(this.creditMemoItems, previewExistingSubscriptionResultCreditMemos.creditMemoItems) &&
        Objects.equals(this.status, previewExistingSubscriptionResultCreditMemos.status) &&
        Objects.equals(this.isFromExistingCreditMemo, previewExistingSubscriptionResultCreditMemos.isFromExistingCreditMemo)&&
        Objects.equals(this.additionalProperties, previewExistingSubscriptionResultCreditMemos.additionalProperties);
  }

  @Override
  public int hashCode() {
    return Objects.hash(creditMemoNumber, amount, amountWithoutTax, taxAmount, targetDate, creditMemoItems, status, isFromExistingCreditMemo, additionalProperties);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class PreviewExistingSubscriptionResultCreditMemos {\n");
    sb.append("    creditMemoNumber: ").append(toIndentedString(creditMemoNumber)).append("\n");
    sb.append("    amount: ").append(toIndentedString(amount)).append("\n");
    sb.append("    amountWithoutTax: ").append(toIndentedString(amountWithoutTax)).append("\n");
    sb.append("    taxAmount: ").append(toIndentedString(taxAmount)).append("\n");
    sb.append("    targetDate: ").append(toIndentedString(targetDate)).append("\n");
    sb.append("    creditMemoItems: ").append(toIndentedString(creditMemoItems)).append("\n");
    sb.append("    status: ").append(toIndentedString(status)).append("\n");
    sb.append("    isFromExistingCreditMemo: ").append(toIndentedString(isFromExistingCreditMemo)).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("creditMemoNumber");
    openapiFields.add("amount");
    openapiFields.add("amountWithoutTax");
    openapiFields.add("taxAmount");
    openapiFields.add("targetDate");
    openapiFields.add("creditMemoItems");
    openapiFields.add("status");
    openapiFields.add("isFromExistingCreditMemo");

    // 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 PreviewExistingSubscriptionResultCreditMemos
   */
  public static void validateJsonElement(JsonElement jsonElement) throws IOException {
      if (jsonElement == null) {
        if (!PreviewExistingSubscriptionResultCreditMemos.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
          throw new IllegalArgumentException(String.format("The required field(s) %s in PreviewExistingSubscriptionResultCreditMemos is not found in the empty JSON string", PreviewExistingSubscriptionResultCreditMemos.openapiRequiredFields.toString()));
        }
      }
        JsonObject jsonObj = jsonElement.getAsJsonObject();
      if ((jsonObj.get("creditMemoNumber") != null && !jsonObj.get("creditMemoNumber").isJsonNull()) && !jsonObj.get("creditMemoNumber").isJsonPrimitive()) {
        throw new IllegalArgumentException(String.format("Expected the field `creditMemoNumber` to be a primitive type in the JSON string but got `%s`", jsonObj.get("creditMemoNumber").toString()));
      }
      if (jsonObj.get("creditMemoItems") != null && !jsonObj.get("creditMemoItems").isJsonNull()) {
        JsonArray jsonArraycreditMemoItems = jsonObj.getAsJsonArray("creditMemoItems");
        if (jsonArraycreditMemoItems != null) {
          // ensure the json data is an array
          if (!jsonObj.get("creditMemoItems").isJsonArray()) {
            throw new IllegalArgumentException(String.format("Expected the field `creditMemoItems` to be an array in the JSON string but got `%s`", jsonObj.get("creditMemoItems").toString()));
          }

          // validate the optional field `creditMemoItems` (array)
          for (int i = 0; i < jsonArraycreditMemoItems.size(); i++) {
            PreviewExistingSubscriptionCreditMemoItemResult.validateJsonElement(jsonArraycreditMemoItems.get(i));
          };
        }
      }
      if ((jsonObj.get("status") != null && !jsonObj.get("status").isJsonNull()) && !jsonObj.get("status").isJsonPrimitive()) {
        throw new IllegalArgumentException(String.format("Expected the field `status` to be a primitive type in the JSON string but got `%s`", jsonObj.get("status").toString()));
      }
  }

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

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

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