com.zuora.model.CreateJournalEntryRequest 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.CreateJournalEntryRequestItem;
import com.zuora.model.CreateJournalEntryRequestSegment;
import com.zuora.model.TransferredToAccountingStatus;
import java.io.IOException;
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;
/**
* CreateJournalEntryRequest
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class CreateJournalEntryRequest {
public static final String SERIALIZED_NAME_ACCOUNTING_PERIOD_NAME = "accountingPeriodName";
@SerializedName(SERIALIZED_NAME_ACCOUNTING_PERIOD_NAME)
private String accountingPeriodName;
public static final String SERIALIZED_NAME_CURRENCY = "currency";
@SerializedName(SERIALIZED_NAME_CURRENCY)
private String currency;
public static final String SERIALIZED_NAME_JOURNAL_ENTRY_DATE = "journalEntryDate";
@SerializedName(SERIALIZED_NAME_JOURNAL_ENTRY_DATE)
private LocalDate journalEntryDate;
public static final String SERIALIZED_NAME_JOURNAL_ENTRY_ITEMS = "journalEntryItems";
@SerializedName(SERIALIZED_NAME_JOURNAL_ENTRY_ITEMS)
private List journalEntryItems;
public static final String SERIALIZED_NAME_NOTES = "notes";
@SerializedName(SERIALIZED_NAME_NOTES)
private String notes;
public static final String SERIALIZED_NAME_ORGANIZATION_LABEL = "organizationLabel";
@SerializedName(SERIALIZED_NAME_ORGANIZATION_LABEL)
private String organizationLabel;
public static final String SERIALIZED_NAME_SEGMENTS = "segments";
@SerializedName(SERIALIZED_NAME_SEGMENTS)
private List segments;
public static final String SERIALIZED_NAME_TRANSFERRED_TO_ACCOUNTING = "transferredToAccounting";
@SerializedName(SERIALIZED_NAME_TRANSFERRED_TO_ACCOUNTING)
private TransferredToAccountingStatus transferredToAccounting;
public CreateJournalEntryRequest() {
}
public CreateJournalEntryRequest accountingPeriodName(String accountingPeriodName) {
this.accountingPeriodName = accountingPeriodName;
return this;
}
/**
* Name of the accounting period. The open-ended accounting period is named `Open-Ended`.
* @return accountingPeriodName
*/
@javax.annotation.Nonnull
public String getAccountingPeriodName() {
return accountingPeriodName;
}
public void setAccountingPeriodName(String accountingPeriodName) {
this.accountingPeriodName = accountingPeriodName;
}
public CreateJournalEntryRequest currency(String currency) {
this.currency = currency;
return this;
}
/**
* The type of currency used. Currency must be active.
* @return currency
*/
@javax.annotation.Nonnull
public String getCurrency() {
return currency;
}
public void setCurrency(String currency) {
this.currency = currency;
}
public CreateJournalEntryRequest journalEntryDate(LocalDate journalEntryDate) {
this.journalEntryDate = journalEntryDate;
return this;
}
/**
* Date of the journal entry.
* @return journalEntryDate
*/
@javax.annotation.Nonnull
public LocalDate getJournalEntryDate() {
return journalEntryDate;
}
public void setJournalEntryDate(LocalDate journalEntryDate) {
this.journalEntryDate = journalEntryDate;
}
public CreateJournalEntryRequest journalEntryItems(List journalEntryItems) {
this.journalEntryItems = journalEntryItems;
return this;
}
public CreateJournalEntryRequest addJournalEntryItemsItem(CreateJournalEntryRequestItem journalEntryItemsItem) {
if (this.journalEntryItems == null) {
this.journalEntryItems = new ArrayList<>();
}
this.journalEntryItems.add(journalEntryItemsItem);
return this;
}
/**
* Key name that represents the list of journal entry items.
* @return journalEntryItems
*/
@javax.annotation.Nonnull
public List getJournalEntryItems() {
return journalEntryItems;
}
public void setJournalEntryItems(List journalEntryItems) {
this.journalEntryItems = journalEntryItems;
}
public CreateJournalEntryRequest notes(String notes) {
this.notes = notes;
return this;
}
/**
* The number associated with the revenue event. Character limit: 2,000
* @return notes
*/
@javax.annotation.Nullable
public String getNotes() {
return notes;
}
public void setNotes(String notes) {
this.notes = notes;
}
public CreateJournalEntryRequest organizationLabel(String organizationLabel) {
this.organizationLabel = organizationLabel;
return this;
}
/**
* Organization Label
* @return organizationLabel
*/
@javax.annotation.Nullable
public String getOrganizationLabel() {
return organizationLabel;
}
public void setOrganizationLabel(String organizationLabel) {
this.organizationLabel = organizationLabel;
}
public CreateJournalEntryRequest segments(List segments) {
this.segments = segments;
return this;
}
public CreateJournalEntryRequest addSegmentsItem(CreateJournalEntryRequestSegment segmentsItem) {
if (this.segments == null) {
this.segments = new ArrayList<>();
}
this.segments.add(segmentsItem);
return this;
}
/**
* List of segments that apply to the summary journal entry.
* @return segments
*/
@javax.annotation.Nullable
public List getSegments() {
return segments;
}
public void setSegments(List segments) {
this.segments = segments;
}
public CreateJournalEntryRequest transferredToAccounting(TransferredToAccountingStatus transferredToAccounting) {
this.transferredToAccounting = transferredToAccounting;
return this;
}
/**
* Get transferredToAccounting
* @return transferredToAccounting
*/
@javax.annotation.Nullable
public TransferredToAccountingStatus getTransferredToAccounting() {
return transferredToAccounting;
}
public void setTransferredToAccounting(TransferredToAccountingStatus transferredToAccounting) {
this.transferredToAccounting = transferredToAccounting;
}
/**
* 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 CreateJournalEntryRequest instance itself
*/
public CreateJournalEntryRequest 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;
}
CreateJournalEntryRequest createJournalEntryRequest = (CreateJournalEntryRequest) o;
return Objects.equals(this.accountingPeriodName, createJournalEntryRequest.accountingPeriodName) &&
Objects.equals(this.currency, createJournalEntryRequest.currency) &&
Objects.equals(this.journalEntryDate, createJournalEntryRequest.journalEntryDate) &&
Objects.equals(this.journalEntryItems, createJournalEntryRequest.journalEntryItems) &&
Objects.equals(this.notes, createJournalEntryRequest.notes) &&
Objects.equals(this.organizationLabel, createJournalEntryRequest.organizationLabel) &&
Objects.equals(this.segments, createJournalEntryRequest.segments) &&
Objects.equals(this.transferredToAccounting, createJournalEntryRequest.transferredToAccounting)&&
Objects.equals(this.additionalProperties, createJournalEntryRequest.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(accountingPeriodName, currency, journalEntryDate, journalEntryItems, notes, organizationLabel, segments, transferredToAccounting, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class CreateJournalEntryRequest {\n");
sb.append(" accountingPeriodName: ").append(toIndentedString(accountingPeriodName)).append("\n");
sb.append(" currency: ").append(toIndentedString(currency)).append("\n");
sb.append(" journalEntryDate: ").append(toIndentedString(journalEntryDate)).append("\n");
sb.append(" journalEntryItems: ").append(toIndentedString(journalEntryItems)).append("\n");
sb.append(" notes: ").append(toIndentedString(notes)).append("\n");
sb.append(" organizationLabel: ").append(toIndentedString(organizationLabel)).append("\n");
sb.append(" segments: ").append(toIndentedString(segments)).append("\n");
sb.append(" transferredToAccounting: ").append(toIndentedString(transferredToAccounting)).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("accountingPeriodName");
openapiFields.add("currency");
openapiFields.add("journalEntryDate");
openapiFields.add("journalEntryItems");
openapiFields.add("notes");
openapiFields.add("organizationLabel");
openapiFields.add("segments");
openapiFields.add("transferredToAccounting");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("accountingPeriodName");
openapiRequiredFields.add("currency");
openapiRequiredFields.add("journalEntryDate");
openapiRequiredFields.add("journalEntryItems");
}
/**
* 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 CreateJournalEntryRequest
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!CreateJournalEntryRequest.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in CreateJournalEntryRequest is not found in the empty JSON string", CreateJournalEntryRequest.openapiRequiredFields.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : CreateJournalEntryRequest.openapiRequiredFields) {
if (jsonElement.getAsJsonObject().get(requiredField) == null) {
throw new IllegalArgumentException(String.format("The required field `%s` is not found in the JSON string: %s", requiredField, jsonElement.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if (!jsonObj.get("accountingPeriodName").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `accountingPeriodName` to be a primitive type in the JSON string but got `%s`", jsonObj.get("accountingPeriodName").toString()));
}
if (!jsonObj.get("currency").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `currency` to be a primitive type in the JSON string but got `%s`", jsonObj.get("currency").toString()));
}
// ensure the required json array is present
if (jsonObj.get("journalEntryItems") == null) {
throw new IllegalArgumentException("Expected the field `linkedContent` to be an array in the JSON string but got `null`");
} else if (!jsonObj.get("journalEntryItems").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `journalEntryItems` to be an array in the JSON string but got `%s`", jsonObj.get("journalEntryItems").toString()));
}
if ((jsonObj.get("notes") != null && !jsonObj.get("notes").isJsonNull()) && !jsonObj.get("notes").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `notes` to be a primitive type in the JSON string but got `%s`", jsonObj.get("notes").toString()));
}
if ((jsonObj.get("organizationLabel") != null && !jsonObj.get("organizationLabel").isJsonNull()) && !jsonObj.get("organizationLabel").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `organizationLabel` to be a primitive type in the JSON string but got `%s`", jsonObj.get("organizationLabel").toString()));
}
if (jsonObj.get("segments") != null && !jsonObj.get("segments").isJsonNull()) {
JsonArray jsonArraysegments = jsonObj.getAsJsonArray("segments");
if (jsonArraysegments != null) {
// ensure the json data is an array
if (!jsonObj.get("segments").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `segments` to be an array in the JSON string but got `%s`", jsonObj.get("segments").toString()));
}
// validate the optional field `segments` (array)
for (int i = 0; i < jsonArraysegments.size(); i++) {
CreateJournalEntryRequestSegment.validateJsonElement(jsonArraysegments.get(i));
};
}
}
// validate the optional field `transferredToAccounting`
if (jsonObj.get("transferredToAccounting") != null && !jsonObj.get("transferredToAccounting").isJsonNull()) {
TransferredToAccountingStatus.validateJsonElement(jsonObj.get("transferredToAccounting"));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!CreateJournalEntryRequest.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'CreateJournalEntryRequest' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(CreateJournalEntryRequest.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, CreateJournalEntryRequest 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 CreateJournalEntryRequest read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
CreateJournalEntryRequest 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 CreateJournalEntryRequest given an JSON string
*
* @param jsonString JSON string
* @return An instance of CreateJournalEntryRequest
* @throws IOException if the JSON string is invalid with respect to CreateJournalEntryRequest
*/
public static CreateJournalEntryRequest fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, CreateJournalEntryRequest.class);
}
/**
* Convert an instance of CreateJournalEntryRequest to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy