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

com.zuora.model.CollectDebitMemoResponse 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.CollectDebitMemoResponseAppliedCreditMemos;
import com.zuora.model.CollectDebitMemoResponseAppliedPayments;
import com.zuora.model.CollectDebitMemoResponseDebitMemo;
import com.zuora.model.CollectDebitMemoResponseProcessedPayment;
import java.io.IOException;
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;

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

  public static final String SERIALIZED_NAME_APPLIED_PAYMENTS = "appliedPayments";
  @SerializedName(SERIALIZED_NAME_APPLIED_PAYMENTS)
  private List appliedPayments;

  public static final String SERIALIZED_NAME_DEBIT_MEMO = "debitMemo";
  @SerializedName(SERIALIZED_NAME_DEBIT_MEMO)
  private CollectDebitMemoResponseDebitMemo debitMemo;

  public static final String SERIALIZED_NAME_PROCESSED_PAYMENT = "processedPayment";
  @SerializedName(SERIALIZED_NAME_PROCESSED_PAYMENT)
  private CollectDebitMemoResponseProcessedPayment processedPayment;

  public static final String SERIALIZED_NAME_SUCCESS = "success";
  @SerializedName(SERIALIZED_NAME_SUCCESS)
  private Boolean success;

  public CollectDebitMemoResponse() {
  }

  public CollectDebitMemoResponse appliedCreditMemos(List appliedCreditMemos) {
    this.appliedCreditMemos = appliedCreditMemos;
    return this;
  }

  public CollectDebitMemoResponse addAppliedCreditMemosItem(CollectDebitMemoResponseAppliedCreditMemos appliedCreditMemosItem) {
    if (this.appliedCreditMemos == null) {
      this.appliedCreditMemos = new ArrayList<>();
    }
    this.appliedCreditMemos.add(appliedCreditMemosItem);
    return this;
  }

  /**
   * The information about which credit memo applied to the specific debit memo. 
   * @return appliedCreditMemos
   */
  @javax.annotation.Nullable
  public List getAppliedCreditMemos() {
    return appliedCreditMemos;
  }

  public void setAppliedCreditMemos(List appliedCreditMemos) {
    this.appliedCreditMemos = appliedCreditMemos;
  }


  public CollectDebitMemoResponse appliedPayments(List appliedPayments) {
    this.appliedPayments = appliedPayments;
    return this;
  }

  public CollectDebitMemoResponse addAppliedPaymentsItem(CollectDebitMemoResponseAppliedPayments appliedPaymentsItem) {
    if (this.appliedPayments == null) {
      this.appliedPayments = new ArrayList<>();
    }
    this.appliedPayments.add(appliedPaymentsItem);
    return this;
  }

  /**
   * The information about which payment applied to the specific debit memo. 
   * @return appliedPayments
   */
  @javax.annotation.Nullable
  public List getAppliedPayments() {
    return appliedPayments;
  }

  public void setAppliedPayments(List appliedPayments) {
    this.appliedPayments = appliedPayments;
  }


  public CollectDebitMemoResponse debitMemo(CollectDebitMemoResponseDebitMemo debitMemo) {
    this.debitMemo = debitMemo;
    return this;
  }

  /**
   * Get debitMemo
   * @return debitMemo
   */
  @javax.annotation.Nullable
  public CollectDebitMemoResponseDebitMemo getDebitMemo() {
    return debitMemo;
  }

  public void setDebitMemo(CollectDebitMemoResponseDebitMemo debitMemo) {
    this.debitMemo = debitMemo;
  }


  public CollectDebitMemoResponse processedPayment(CollectDebitMemoResponseProcessedPayment processedPayment) {
    this.processedPayment = processedPayment;
    return this;
  }

  /**
   * Get processedPayment
   * @return processedPayment
   */
  @javax.annotation.Nullable
  public CollectDebitMemoResponseProcessedPayment getProcessedPayment() {
    return processedPayment;
  }

  public void setProcessedPayment(CollectDebitMemoResponseProcessedPayment processedPayment) {
    this.processedPayment = processedPayment;
  }


  public CollectDebitMemoResponse success(Boolean success) {
    this.success = success;
    return this;
  }

  /**
   * Returns `true` if the request was processed successfully.
   * @return success
   */
  @javax.annotation.Nullable
  public Boolean getSuccess() {
    return success;
  }

  public void setSuccess(Boolean success) {
    this.success = success;
  }

  /**
   * 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 CollectDebitMemoResponse instance itself
   */
  public CollectDebitMemoResponse 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;
    }
    CollectDebitMemoResponse collectDebitMemoResponse = (CollectDebitMemoResponse) o;
    return Objects.equals(this.appliedCreditMemos, collectDebitMemoResponse.appliedCreditMemos) &&
        Objects.equals(this.appliedPayments, collectDebitMemoResponse.appliedPayments) &&
        Objects.equals(this.debitMemo, collectDebitMemoResponse.debitMemo) &&
        Objects.equals(this.processedPayment, collectDebitMemoResponse.processedPayment) &&
        Objects.equals(this.success, collectDebitMemoResponse.success)&&
        Objects.equals(this.additionalProperties, collectDebitMemoResponse.additionalProperties);
  }

  @Override
  public int hashCode() {
    return Objects.hash(appliedCreditMemos, appliedPayments, debitMemo, processedPayment, success, additionalProperties);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class CollectDebitMemoResponse {\n");
    sb.append("    appliedCreditMemos: ").append(toIndentedString(appliedCreditMemos)).append("\n");
    sb.append("    appliedPayments: ").append(toIndentedString(appliedPayments)).append("\n");
    sb.append("    debitMemo: ").append(toIndentedString(debitMemo)).append("\n");
    sb.append("    processedPayment: ").append(toIndentedString(processedPayment)).append("\n");
    sb.append("    success: ").append(toIndentedString(success)).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("appliedCreditMemos");
    openapiFields.add("appliedPayments");
    openapiFields.add("debitMemo");
    openapiFields.add("processedPayment");
    openapiFields.add("success");

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

          // validate the optional field `appliedCreditMemos` (array)
          for (int i = 0; i < jsonArrayappliedCreditMemos.size(); i++) {
            CollectDebitMemoResponseAppliedCreditMemos.validateJsonElement(jsonArrayappliedCreditMemos.get(i));
          };
        }
      }
      if (jsonObj.get("appliedPayments") != null && !jsonObj.get("appliedPayments").isJsonNull()) {
        JsonArray jsonArrayappliedPayments = jsonObj.getAsJsonArray("appliedPayments");
        if (jsonArrayappliedPayments != null) {
          // ensure the json data is an array
          if (!jsonObj.get("appliedPayments").isJsonArray()) {
            throw new IllegalArgumentException(String.format("Expected the field `appliedPayments` to be an array in the JSON string but got `%s`", jsonObj.get("appliedPayments").toString()));
          }

          // validate the optional field `appliedPayments` (array)
          for (int i = 0; i < jsonArrayappliedPayments.size(); i++) {
            CollectDebitMemoResponseAppliedPayments.validateJsonElement(jsonArrayappliedPayments.get(i));
          };
        }
      }
      // validate the optional field `debitMemo`
      if (jsonObj.get("debitMemo") != null && !jsonObj.get("debitMemo").isJsonNull()) {
        CollectDebitMemoResponseDebitMemo.validateJsonElement(jsonObj.get("debitMemo"));
      }
      // validate the optional field `processedPayment`
      if (jsonObj.get("processedPayment") != null && !jsonObj.get("processedPayment").isJsonNull()) {
        CollectDebitMemoResponseProcessedPayment.validateJsonElement(jsonObj.get("processedPayment"));
      }
  }

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

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

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





© 2015 - 2025 Weber Informatics LLC | Privacy Policy