com.zuora.model.GetJournalRunResponse 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.GetJournalRunTransactionResponse;
import com.zuora.model.JournalRunStatus;
import com.zuora.model.OrganizationLabel;
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;
/**
* GetJournalRunResponse
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class GetJournalRunResponse {
public static final String SERIALIZED_NAME_AGGREGATE_CURRENCY = "aggregateCurrency";
@SerializedName(SERIALIZED_NAME_AGGREGATE_CURRENCY)
private Boolean aggregateCurrency;
public static final String SERIALIZED_NAME_EXECUTED_ON = "executedOn";
@SerializedName(SERIALIZED_NAME_EXECUTED_ON)
private String executedOn;
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_NUMBER = "number";
@SerializedName(SERIALIZED_NAME_NUMBER)
private String number;
public static final String SERIALIZED_NAME_SEGMENTATION_RULE_NAME = "segmentationRuleName";
@SerializedName(SERIALIZED_NAME_SEGMENTATION_RULE_NAME)
private String segmentationRuleName;
public static final String SERIALIZED_NAME_STATUS = "status";
@SerializedName(SERIALIZED_NAME_STATUS)
private JournalRunStatus status;
public static final String SERIALIZED_NAME_SUCCESS = "success";
@SerializedName(SERIALIZED_NAME_SUCCESS)
private Boolean success;
public static final String SERIALIZED_NAME_TARGET_END_DATE = "targetEndDate";
@SerializedName(SERIALIZED_NAME_TARGET_END_DATE)
private LocalDate targetEndDate;
public static final String SERIALIZED_NAME_TARGET_START_DATE = "targetStartDate";
@SerializedName(SERIALIZED_NAME_TARGET_START_DATE)
private LocalDate targetStartDate;
public static final String SERIALIZED_NAME_TOTAL_JOURNAL_ENTRY_COUNT = "totalJournalEntryCount";
@SerializedName(SERIALIZED_NAME_TOTAL_JOURNAL_ENTRY_COUNT)
private Long totalJournalEntryCount;
public static final String SERIALIZED_NAME_ORGANIZATION_LABELS = "organizationLabels";
@SerializedName(SERIALIZED_NAME_ORGANIZATION_LABELS)
private List organizationLabels;
public static final String SERIALIZED_NAME_TRANSACTION_TYPES = "transactionTypes";
@SerializedName(SERIALIZED_NAME_TRANSACTION_TYPES)
private List transactionTypes;
public GetJournalRunResponse() {
}
public GetJournalRunResponse aggregateCurrency(Boolean aggregateCurrency) {
this.aggregateCurrency = aggregateCurrency;
return this;
}
/**
*
* @return aggregateCurrency
*/
@javax.annotation.Nullable
public Boolean getAggregateCurrency() {
return aggregateCurrency;
}
public void setAggregateCurrency(Boolean aggregateCurrency) {
this.aggregateCurrency = aggregateCurrency;
}
public GetJournalRunResponse executedOn(String executedOn) {
this.executedOn = executedOn;
return this;
}
/**
* Date and time the journal run was executed.
* @return executedOn
*/
@javax.annotation.Nullable
public String getExecutedOn() {
return executedOn;
}
public void setExecutedOn(String executedOn) {
this.executedOn = executedOn;
}
public GetJournalRunResponse journalEntryDate(LocalDate journalEntryDate) {
this.journalEntryDate = journalEntryDate;
return this;
}
/**
* Date of the journal entry.
* @return journalEntryDate
*/
@javax.annotation.Nullable
public LocalDate getJournalEntryDate() {
return journalEntryDate;
}
public void setJournalEntryDate(LocalDate journalEntryDate) {
this.journalEntryDate = journalEntryDate;
}
public GetJournalRunResponse number(String number) {
this.number = number;
return this;
}
/**
* Journal run number.
* @return number
*/
@javax.annotation.Nullable
public String getNumber() {
return number;
}
public void setNumber(String number) {
this.number = number;
}
public GetJournalRunResponse segmentationRuleName(String segmentationRuleName) {
this.segmentationRuleName = segmentationRuleName;
return this;
}
/**
* Name of GL segmentation rule used in the journal run.
* @return segmentationRuleName
*/
@javax.annotation.Nullable
public String getSegmentationRuleName() {
return segmentationRuleName;
}
public void setSegmentationRuleName(String segmentationRuleName) {
this.segmentationRuleName = segmentationRuleName;
}
public GetJournalRunResponse status(JournalRunStatus status) {
this.status = status;
return this;
}
/**
* Get status
* @return status
*/
@javax.annotation.Nullable
public JournalRunStatus getStatus() {
return status;
}
public void setStatus(JournalRunStatus status) {
this.status = status;
}
public GetJournalRunResponse 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;
}
public GetJournalRunResponse targetEndDate(LocalDate targetEndDate) {
this.targetEndDate = targetEndDate;
return this;
}
/**
* The target end date of the journal run.
* @return targetEndDate
*/
@javax.annotation.Nullable
public LocalDate getTargetEndDate() {
return targetEndDate;
}
public void setTargetEndDate(LocalDate targetEndDate) {
this.targetEndDate = targetEndDate;
}
public GetJournalRunResponse targetStartDate(LocalDate targetStartDate) {
this.targetStartDate = targetStartDate;
return this;
}
/**
* The target start date of the journal run.
* @return targetStartDate
*/
@javax.annotation.Nullable
public LocalDate getTargetStartDate() {
return targetStartDate;
}
public void setTargetStartDate(LocalDate targetStartDate) {
this.targetStartDate = targetStartDate;
}
public GetJournalRunResponse totalJournalEntryCount(Long totalJournalEntryCount) {
this.totalJournalEntryCount = totalJournalEntryCount;
return this;
}
/**
* Total number of journal entries in the journal run.
* @return totalJournalEntryCount
*/
@javax.annotation.Nullable
public Long getTotalJournalEntryCount() {
return totalJournalEntryCount;
}
public void setTotalJournalEntryCount(Long totalJournalEntryCount) {
this.totalJournalEntryCount = totalJournalEntryCount;
}
public GetJournalRunResponse organizationLabels(List organizationLabels) {
this.organizationLabels = organizationLabels;
return this;
}
public GetJournalRunResponse addOrganizationLabelsItem(OrganizationLabel organizationLabelsItem) {
if (this.organizationLabels == null) {
this.organizationLabels = new ArrayList<>();
}
this.organizationLabels.add(organizationLabelsItem);
return this;
}
/**
* Organization Labels.
* @return organizationLabels
*/
@javax.annotation.Nullable
public List getOrganizationLabels() {
return organizationLabels;
}
public void setOrganizationLabels(List organizationLabels) {
this.organizationLabels = organizationLabels;
}
public GetJournalRunResponse transactionTypes(List transactionTypes) {
this.transactionTypes = transactionTypes;
return this;
}
public GetJournalRunResponse addTransactionTypesItem(GetJournalRunTransactionResponse transactionTypesItem) {
if (this.transactionTypes == null) {
this.transactionTypes = new ArrayList<>();
}
this.transactionTypes.add(transactionTypesItem);
return this;
}
/**
* Transaction types included in the journal run.
* @return transactionTypes
*/
@javax.annotation.Nullable
public List getTransactionTypes() {
return transactionTypes;
}
public void setTransactionTypes(List transactionTypes) {
this.transactionTypes = transactionTypes;
}
/**
* 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 GetJournalRunResponse instance itself
*/
public GetJournalRunResponse 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;
}
GetJournalRunResponse getJournalRunResponse = (GetJournalRunResponse) o;
return Objects.equals(this.aggregateCurrency, getJournalRunResponse.aggregateCurrency) &&
Objects.equals(this.executedOn, getJournalRunResponse.executedOn) &&
Objects.equals(this.journalEntryDate, getJournalRunResponse.journalEntryDate) &&
Objects.equals(this.number, getJournalRunResponse.number) &&
Objects.equals(this.segmentationRuleName, getJournalRunResponse.segmentationRuleName) &&
Objects.equals(this.status, getJournalRunResponse.status) &&
Objects.equals(this.success, getJournalRunResponse.success) &&
Objects.equals(this.targetEndDate, getJournalRunResponse.targetEndDate) &&
Objects.equals(this.targetStartDate, getJournalRunResponse.targetStartDate) &&
Objects.equals(this.totalJournalEntryCount, getJournalRunResponse.totalJournalEntryCount) &&
Objects.equals(this.organizationLabels, getJournalRunResponse.organizationLabels) &&
Objects.equals(this.transactionTypes, getJournalRunResponse.transactionTypes)&&
Objects.equals(this.additionalProperties, getJournalRunResponse.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(aggregateCurrency, executedOn, journalEntryDate, number, segmentationRuleName, status, success, targetEndDate, targetStartDate, totalJournalEntryCount, organizationLabels, transactionTypes, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class GetJournalRunResponse {\n");
sb.append(" aggregateCurrency: ").append(toIndentedString(aggregateCurrency)).append("\n");
sb.append(" executedOn: ").append(toIndentedString(executedOn)).append("\n");
sb.append(" journalEntryDate: ").append(toIndentedString(journalEntryDate)).append("\n");
sb.append(" number: ").append(toIndentedString(number)).append("\n");
sb.append(" segmentationRuleName: ").append(toIndentedString(segmentationRuleName)).append("\n");
sb.append(" status: ").append(toIndentedString(status)).append("\n");
sb.append(" success: ").append(toIndentedString(success)).append("\n");
sb.append(" targetEndDate: ").append(toIndentedString(targetEndDate)).append("\n");
sb.append(" targetStartDate: ").append(toIndentedString(targetStartDate)).append("\n");
sb.append(" totalJournalEntryCount: ").append(toIndentedString(totalJournalEntryCount)).append("\n");
sb.append(" organizationLabels: ").append(toIndentedString(organizationLabels)).append("\n");
sb.append(" transactionTypes: ").append(toIndentedString(transactionTypes)).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("aggregateCurrency");
openapiFields.add("executedOn");
openapiFields.add("journalEntryDate");
openapiFields.add("number");
openapiFields.add("segmentationRuleName");
openapiFields.add("status");
openapiFields.add("success");
openapiFields.add("targetEndDate");
openapiFields.add("targetStartDate");
openapiFields.add("totalJournalEntryCount");
openapiFields.add("organizationLabels");
openapiFields.add("transactionTypes");
// 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 GetJournalRunResponse
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!GetJournalRunResponse.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in GetJournalRunResponse is not found in the empty JSON string", GetJournalRunResponse.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("executedOn") != null && !jsonObj.get("executedOn").isJsonNull()) && !jsonObj.get("executedOn").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `executedOn` to be a primitive type in the JSON string but got `%s`", jsonObj.get("executedOn").toString()));
}
if ((jsonObj.get("number") != null && !jsonObj.get("number").isJsonNull()) && !jsonObj.get("number").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `number` to be a primitive type in the JSON string but got `%s`", jsonObj.get("number").toString()));
}
if ((jsonObj.get("segmentationRuleName") != null && !jsonObj.get("segmentationRuleName").isJsonNull()) && !jsonObj.get("segmentationRuleName").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `segmentationRuleName` to be a primitive type in the JSON string but got `%s`", jsonObj.get("segmentationRuleName").toString()));
}
// validate the optional field `status`
if (jsonObj.get("status") != null && !jsonObj.get("status").isJsonNull()) {
JournalRunStatus.validateJsonElement(jsonObj.get("status"));
}
if (jsonObj.get("organizationLabels") != null && !jsonObj.get("organizationLabels").isJsonNull()) {
JsonArray jsonArrayorganizationLabels = jsonObj.getAsJsonArray("organizationLabels");
if (jsonArrayorganizationLabels != null) {
// ensure the json data is an array
if (!jsonObj.get("organizationLabels").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `organizationLabels` to be an array in the JSON string but got `%s`", jsonObj.get("organizationLabels").toString()));
}
// validate the optional field `organizationLabels` (array)
for (int i = 0; i < jsonArrayorganizationLabels.size(); i++) {
OrganizationLabel.validateJsonElement(jsonArrayorganizationLabels.get(i));
};
}
}
if (jsonObj.get("transactionTypes") != null && !jsonObj.get("transactionTypes").isJsonNull()) {
JsonArray jsonArraytransactionTypes = jsonObj.getAsJsonArray("transactionTypes");
if (jsonArraytransactionTypes != null) {
// ensure the json data is an array
if (!jsonObj.get("transactionTypes").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `transactionTypes` to be an array in the JSON string but got `%s`", jsonObj.get("transactionTypes").toString()));
}
// validate the optional field `transactionTypes` (array)
for (int i = 0; i < jsonArraytransactionTypes.size(); i++) {
GetJournalRunTransactionResponse.validateJsonElement(jsonArraytransactionTypes.get(i));
};
}
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!GetJournalRunResponse.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'GetJournalRunResponse' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(GetJournalRunResponse.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, GetJournalRunResponse 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 GetJournalRunResponse read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
GetJournalRunResponse 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 GetJournalRunResponse given an JSON string
*
* @param jsonString JSON string
* @return An instance of GetJournalRunResponse
* @throws IOException if the JSON string is invalid with respect to GetJournalRunResponse
*/
public static GetJournalRunResponse fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, GetJournalRunResponse.class);
}
/**
* Convert an instance of GetJournalRunResponse to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy