com.zuora.model.PaymentRun 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.PaymentRunStatus;
import java.io.IOException;
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;
/**
* PaymentRun
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class PaymentRun {
public static final String SERIALIZED_NAME_ACCOUNT_ID = "accountId";
@SerializedName(SERIALIZED_NAME_ACCOUNT_ID)
private String accountId;
public static final String SERIALIZED_NAME_APPLY_CREDIT_BALANCE = "applyCreditBalance";
@SerializedName(SERIALIZED_NAME_APPLY_CREDIT_BALANCE)
private Boolean applyCreditBalance;
public static final String SERIALIZED_NAME_AUTO_APPLY_CREDIT_MEMO = "autoApplyCreditMemo";
@SerializedName(SERIALIZED_NAME_AUTO_APPLY_CREDIT_MEMO)
private Boolean autoApplyCreditMemo;
public static final String SERIALIZED_NAME_AUTO_APPLY_UNAPPLIED_PAYMENT = "autoApplyUnappliedPayment";
@SerializedName(SERIALIZED_NAME_AUTO_APPLY_UNAPPLIED_PAYMENT)
private Boolean autoApplyUnappliedPayment;
public static final String SERIALIZED_NAME_BATCH = "batch";
@SerializedName(SERIALIZED_NAME_BATCH)
private String batch;
public static final String SERIALIZED_NAME_BILL_CYCLE_DAY = "billCycleDay";
@SerializedName(SERIALIZED_NAME_BILL_CYCLE_DAY)
private String billCycleDay;
public static final String SERIALIZED_NAME_BILLING_RUN_ID = "billingRunId";
@SerializedName(SERIALIZED_NAME_BILLING_RUN_ID)
private String billingRunId;
public static final String SERIALIZED_NAME_COLLECT_PAYMENT = "collectPayment";
@SerializedName(SERIALIZED_NAME_COLLECT_PAYMENT)
private Boolean collectPayment;
public static final String SERIALIZED_NAME_COMPLETED_ON = "completedOn";
@SerializedName(SERIALIZED_NAME_COMPLETED_ON)
private String completedOn;
public static final String SERIALIZED_NAME_CONSOLIDATED_PAYMENT = "consolidatedPayment";
@SerializedName(SERIALIZED_NAME_CONSOLIDATED_PAYMENT)
private Boolean consolidatedPayment;
public static final String SERIALIZED_NAME_CREATED_BY_ID = "createdById";
@SerializedName(SERIALIZED_NAME_CREATED_BY_ID)
private String createdById;
public static final String SERIALIZED_NAME_CREATED_DATE = "createdDate";
@SerializedName(SERIALIZED_NAME_CREATED_DATE)
private String createdDate;
public static final String SERIALIZED_NAME_CURRENCY = "currency";
@SerializedName(SERIALIZED_NAME_CURRENCY)
private String currency;
public static final String SERIALIZED_NAME_EXECUTED_ON = "executedOn";
@SerializedName(SERIALIZED_NAME_EXECUTED_ON)
private String executedOn;
public static final String SERIALIZED_NAME_ID = "id";
@SerializedName(SERIALIZED_NAME_ID)
private String id;
public static final String SERIALIZED_NAME_NUMBER = "number";
@SerializedName(SERIALIZED_NAME_NUMBER)
private String number;
public static final String SERIALIZED_NAME_PAYMENT_GATEWAY_ID = "paymentGatewayId";
@SerializedName(SERIALIZED_NAME_PAYMENT_GATEWAY_ID)
private String paymentGatewayId;
public static final String SERIALIZED_NAME_PROCESS_PAYMENT_WITH_CLOSED_P_M = "processPaymentWithClosedPM";
@SerializedName(SERIALIZED_NAME_PROCESS_PAYMENT_WITH_CLOSED_P_M)
private Boolean processPaymentWithClosedPM;
public static final String SERIALIZED_NAME_RUN_DATE = "runDate";
@SerializedName(SERIALIZED_NAME_RUN_DATE)
private String runDate;
public static final String SERIALIZED_NAME_PAYMENT_GATEWAY_NUMBER = "paymentGatewayNumber";
@SerializedName(SERIALIZED_NAME_PAYMENT_GATEWAY_NUMBER)
private String paymentGatewayNumber;
public static final String SERIALIZED_NAME_STATUS = "status";
@SerializedName(SERIALIZED_NAME_STATUS)
private PaymentRunStatus status;
public static final String SERIALIZED_NAME_TARGET_DATE = "targetDate";
@SerializedName(SERIALIZED_NAME_TARGET_DATE)
private String targetDate;
public static final String SERIALIZED_NAME_UPDATED_BY_ID = "updatedById";
@SerializedName(SERIALIZED_NAME_UPDATED_BY_ID)
private String updatedById;
public static final String SERIALIZED_NAME_UPDATED_DATE = "updatedDate";
@SerializedName(SERIALIZED_NAME_UPDATED_DATE)
private String updatedDate;
public static final String SERIALIZED_NAME_ORGANIZATION_LABELS = "organizationLabels";
@SerializedName(SERIALIZED_NAME_ORGANIZATION_LABELS)
private String organizationLabels;
public PaymentRun() {
}
public PaymentRun accountId(String accountId) {
this.accountId = accountId;
return this;
}
/**
* The ID of the customer account associated with the payment run.
* @return accountId
*/
@javax.annotation.Nullable
public String getAccountId() {
return accountId;
}
public void setAccountId(String accountId) {
this.accountId = accountId;
}
public PaymentRun applyCreditBalance(Boolean applyCreditBalance) {
this.applyCreditBalance = applyCreditBalance;
return this;
}
/**
* **Note:** This field is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled. Whether to apply credit balances in the payment run. This field is only available when you have Invoice Settlement feature disabled.
* @return applyCreditBalance
*/
@javax.annotation.Nullable
public Boolean getApplyCreditBalance() {
return applyCreditBalance;
}
public void setApplyCreditBalance(Boolean applyCreditBalance) {
this.applyCreditBalance = applyCreditBalance;
}
public PaymentRun autoApplyCreditMemo(Boolean autoApplyCreditMemo) {
this.autoApplyCreditMemo = autoApplyCreditMemo;
return this;
}
/**
* **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Whether to automatically apply a posted credit memo to one or more receivables in the payment run.
* @return autoApplyCreditMemo
*/
@javax.annotation.Nullable
public Boolean getAutoApplyCreditMemo() {
return autoApplyCreditMemo;
}
public void setAutoApplyCreditMemo(Boolean autoApplyCreditMemo) {
this.autoApplyCreditMemo = autoApplyCreditMemo;
}
public PaymentRun autoApplyUnappliedPayment(Boolean autoApplyUnappliedPayment) {
this.autoApplyUnappliedPayment = autoApplyUnappliedPayment;
return this;
}
/**
* **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Whether to automatically apply unapplied payments to one or more receivables in the payment run.
* @return autoApplyUnappliedPayment
*/
@javax.annotation.Nullable
public Boolean getAutoApplyUnappliedPayment() {
return autoApplyUnappliedPayment;
}
public void setAutoApplyUnappliedPayment(Boolean autoApplyUnappliedPayment) {
this.autoApplyUnappliedPayment = autoApplyUnappliedPayment;
}
public PaymentRun batch(String batch) {
this.batch = batch;
return this;
}
/**
* The alias name given to a batch.
* @return batch
*/
@javax.annotation.Nullable
public String getBatch() {
return batch;
}
public void setBatch(String batch) {
this.batch = batch;
}
public PaymentRun billCycleDay(String billCycleDay) {
this.billCycleDay = billCycleDay;
return this;
}
/**
* The billing cycle day (BCD), the day of the month when a bill run generates invoices for the account.
* @return billCycleDay
*/
@javax.annotation.Nullable
public String getBillCycleDay() {
return billCycleDay;
}
public void setBillCycleDay(String billCycleDay) {
this.billCycleDay = billCycleDay;
}
public PaymentRun billingRunId(String billingRunId) {
this.billingRunId = billingRunId;
return this;
}
/**
* The ID of the bill run.
* @return billingRunId
*/
@javax.annotation.Nullable
public String getBillingRunId() {
return billingRunId;
}
public void setBillingRunId(String billingRunId) {
this.billingRunId = billingRunId;
}
public PaymentRun collectPayment(Boolean collectPayment) {
this.collectPayment = collectPayment;
return this;
}
/**
* Whether to process electronic payments during the execution of payment runs.
* @return collectPayment
*/
@javax.annotation.Nullable
public Boolean getCollectPayment() {
return collectPayment;
}
public void setCollectPayment(Boolean collectPayment) {
this.collectPayment = collectPayment;
}
public PaymentRun completedOn(String completedOn) {
this.completedOn = completedOn;
return this;
}
/**
* The date and time when the payment run is completed, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 11:39:58.
* @return completedOn
*/
@javax.annotation.Nullable
public String getCompletedOn() {
return completedOn;
}
public void setCompletedOn(String completedOn) {
this.completedOn = completedOn;
}
public PaymentRun consolidatedPayment(Boolean consolidatedPayment) {
this.consolidatedPayment = consolidatedPayment;
return this;
}
/**
* **Note:** The **Process Electronic Payment** permission also needs to be allowed for a Manage Payment Runs role to work. See [Payments Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles) for more information. Whether to process a single payment for all receivables that are due on an account.
* @return consolidatedPayment
*/
@javax.annotation.Nullable
public Boolean getConsolidatedPayment() {
return consolidatedPayment;
}
public void setConsolidatedPayment(Boolean consolidatedPayment) {
this.consolidatedPayment = consolidatedPayment;
}
public PaymentRun createdById(String createdById) {
this.createdById = createdById;
return this;
}
/**
* The ID of the Zuora user who created the payment run.
* @return createdById
*/
@javax.annotation.Nullable
public String getCreatedById() {
return createdById;
}
public void setCreatedById(String createdById) {
this.createdById = createdById;
}
public PaymentRun createdDate(String createdDate) {
this.createdDate = createdDate;
return this;
}
/**
* The date and time when the payment run was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.
* @return createdDate
*/
@javax.annotation.Nullable
public String getCreatedDate() {
return createdDate;
}
public void setCreatedDate(String createdDate) {
this.createdDate = createdDate;
}
public PaymentRun currency(String currency) {
this.currency = currency;
return this;
}
/**
* A currency defined in the web-based UI administrative settings.
* @return currency
*/
@javax.annotation.Nullable
public String getCurrency() {
return currency;
}
public void setCurrency(String currency) {
this.currency = currency;
}
public PaymentRun executedOn(String executedOn) {
this.executedOn = executedOn;
return this;
}
/**
* The date and time when the payment run is executed, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 11:30:37.
* @return executedOn
*/
@javax.annotation.Nullable
public String getExecutedOn() {
return executedOn;
}
public void setExecutedOn(String executedOn) {
this.executedOn = executedOn;
}
public PaymentRun id(String id) {
this.id = id;
return this;
}
/**
* The ID of the payment run.
* @return id
*/
@javax.annotation.Nullable
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public PaymentRun number(String number) {
this.number = number;
return this;
}
/**
* The identification number of the payment run.
* @return number
*/
@javax.annotation.Nullable
public String getNumber() {
return number;
}
public void setNumber(String number) {
this.number = number;
}
public PaymentRun paymentGatewayId(String paymentGatewayId) {
this.paymentGatewayId = paymentGatewayId;
return this;
}
/**
* The ID of the gateway instance that processes the payment.
* @return paymentGatewayId
*/
@javax.annotation.Nullable
public String getPaymentGatewayId() {
return paymentGatewayId;
}
public void setPaymentGatewayId(String paymentGatewayId) {
this.paymentGatewayId = paymentGatewayId;
}
public PaymentRun processPaymentWithClosedPM(Boolean processPaymentWithClosedPM) {
this.processPaymentWithClosedPM = processPaymentWithClosedPM;
return this;
}
/**
* **Note:** The **Process Electronic Payment** permission also needs to be allowed for a Manage Payment Runs role to work. See [Payments Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles) for more information. Whether to process payments even if the default payment method is closed.
* @return processPaymentWithClosedPM
*/
@javax.annotation.Nullable
public Boolean getProcessPaymentWithClosedPM() {
return processPaymentWithClosedPM;
}
public void setProcessPaymentWithClosedPM(Boolean processPaymentWithClosedPM) {
this.processPaymentWithClosedPM = processPaymentWithClosedPM;
}
public PaymentRun runDate(String runDate) {
this.runDate = runDate;
return this;
}
/**
* The date and time when the scheduled payment run is to be executed for collecting payments.
* @return runDate
*/
@javax.annotation.Nullable
public String getRunDate() {
return runDate;
}
public void setRunDate(String runDate) {
this.runDate = runDate;
}
public PaymentRun paymentGatewayNumber(String paymentGatewayNumber) {
this.paymentGatewayNumber = paymentGatewayNumber;
return this;
}
/**
* Get paymentGatewayNumber
* @return paymentGatewayNumber
*/
@javax.annotation.Nullable
public String getPaymentGatewayNumber() {
return paymentGatewayNumber;
}
public void setPaymentGatewayNumber(String paymentGatewayNumber) {
this.paymentGatewayNumber = paymentGatewayNumber;
}
public PaymentRun status(PaymentRunStatus status) {
this.status = status;
return this;
}
/**
* Get status
* @return status
*/
@javax.annotation.Nullable
public PaymentRunStatus getStatus() {
return status;
}
public void setStatus(PaymentRunStatus status) {
this.status = status;
}
public PaymentRun targetDate(String targetDate) {
this.targetDate = targetDate;
return this;
}
/**
* The target date used to determine which receivables to be collected in the payment run.
* @return targetDate
*/
@javax.annotation.Nullable
public String getTargetDate() {
return targetDate;
}
public void setTargetDate(String targetDate) {
this.targetDate = targetDate;
}
public PaymentRun updatedById(String updatedById) {
this.updatedById = updatedById;
return this;
}
/**
* The ID of the Zuora user who last updated the payment run.
* @return updatedById
*/
@javax.annotation.Nullable
public String getUpdatedById() {
return updatedById;
}
public void setUpdatedById(String updatedById) {
this.updatedById = updatedById;
}
public PaymentRun updatedDate(String updatedDate) {
this.updatedDate = updatedDate;
return this;
}
/**
* The date and time when the payment run was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
* @return updatedDate
*/
@javax.annotation.Nullable
public String getUpdatedDate() {
return updatedDate;
}
public void setUpdatedDate(String updatedDate) {
this.updatedDate = updatedDate;
}
public PaymentRun organizationLabels(String organizationLabels) {
this.organizationLabels = organizationLabels;
return this;
}
/**
* Get organizationLabels
* @return organizationLabels
*/
@javax.annotation.Nullable
public String getOrganizationLabels() {
return organizationLabels;
}
public void setOrganizationLabels(String organizationLabels) {
this.organizationLabels = organizationLabels;
}
/**
* 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 PaymentRun instance itself
*/
public PaymentRun 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;
}
PaymentRun paymentRun = (PaymentRun) o;
return Objects.equals(this.accountId, paymentRun.accountId) &&
Objects.equals(this.applyCreditBalance, paymentRun.applyCreditBalance) &&
Objects.equals(this.autoApplyCreditMemo, paymentRun.autoApplyCreditMemo) &&
Objects.equals(this.autoApplyUnappliedPayment, paymentRun.autoApplyUnappliedPayment) &&
Objects.equals(this.batch, paymentRun.batch) &&
Objects.equals(this.billCycleDay, paymentRun.billCycleDay) &&
Objects.equals(this.billingRunId, paymentRun.billingRunId) &&
Objects.equals(this.collectPayment, paymentRun.collectPayment) &&
Objects.equals(this.completedOn, paymentRun.completedOn) &&
Objects.equals(this.consolidatedPayment, paymentRun.consolidatedPayment) &&
Objects.equals(this.createdById, paymentRun.createdById) &&
Objects.equals(this.createdDate, paymentRun.createdDate) &&
Objects.equals(this.currency, paymentRun.currency) &&
Objects.equals(this.executedOn, paymentRun.executedOn) &&
Objects.equals(this.id, paymentRun.id) &&
Objects.equals(this.number, paymentRun.number) &&
Objects.equals(this.paymentGatewayId, paymentRun.paymentGatewayId) &&
Objects.equals(this.processPaymentWithClosedPM, paymentRun.processPaymentWithClosedPM) &&
Objects.equals(this.runDate, paymentRun.runDate) &&
Objects.equals(this.paymentGatewayNumber, paymentRun.paymentGatewayNumber) &&
Objects.equals(this.status, paymentRun.status) &&
Objects.equals(this.targetDate, paymentRun.targetDate) &&
Objects.equals(this.updatedById, paymentRun.updatedById) &&
Objects.equals(this.updatedDate, paymentRun.updatedDate) &&
Objects.equals(this.organizationLabels, paymentRun.organizationLabels)&&
Objects.equals(this.additionalProperties, paymentRun.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(accountId, applyCreditBalance, autoApplyCreditMemo, autoApplyUnappliedPayment, batch, billCycleDay, billingRunId, collectPayment, completedOn, consolidatedPayment, createdById, createdDate, currency, executedOn, id, number, paymentGatewayId, processPaymentWithClosedPM, runDate, paymentGatewayNumber, status, targetDate, updatedById, updatedDate, organizationLabels, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class PaymentRun {\n");
sb.append(" accountId: ").append(toIndentedString(accountId)).append("\n");
sb.append(" applyCreditBalance: ").append(toIndentedString(applyCreditBalance)).append("\n");
sb.append(" autoApplyCreditMemo: ").append(toIndentedString(autoApplyCreditMemo)).append("\n");
sb.append(" autoApplyUnappliedPayment: ").append(toIndentedString(autoApplyUnappliedPayment)).append("\n");
sb.append(" batch: ").append(toIndentedString(batch)).append("\n");
sb.append(" billCycleDay: ").append(toIndentedString(billCycleDay)).append("\n");
sb.append(" billingRunId: ").append(toIndentedString(billingRunId)).append("\n");
sb.append(" collectPayment: ").append(toIndentedString(collectPayment)).append("\n");
sb.append(" completedOn: ").append(toIndentedString(completedOn)).append("\n");
sb.append(" consolidatedPayment: ").append(toIndentedString(consolidatedPayment)).append("\n");
sb.append(" createdById: ").append(toIndentedString(createdById)).append("\n");
sb.append(" createdDate: ").append(toIndentedString(createdDate)).append("\n");
sb.append(" currency: ").append(toIndentedString(currency)).append("\n");
sb.append(" executedOn: ").append(toIndentedString(executedOn)).append("\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" number: ").append(toIndentedString(number)).append("\n");
sb.append(" paymentGatewayId: ").append(toIndentedString(paymentGatewayId)).append("\n");
sb.append(" processPaymentWithClosedPM: ").append(toIndentedString(processPaymentWithClosedPM)).append("\n");
sb.append(" runDate: ").append(toIndentedString(runDate)).append("\n");
sb.append(" paymentGatewayNumber: ").append(toIndentedString(paymentGatewayNumber)).append("\n");
sb.append(" status: ").append(toIndentedString(status)).append("\n");
sb.append(" targetDate: ").append(toIndentedString(targetDate)).append("\n");
sb.append(" updatedById: ").append(toIndentedString(updatedById)).append("\n");
sb.append(" updatedDate: ").append(toIndentedString(updatedDate)).append("\n");
sb.append(" organizationLabels: ").append(toIndentedString(organizationLabels)).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("accountId");
openapiFields.add("applyCreditBalance");
openapiFields.add("autoApplyCreditMemo");
openapiFields.add("autoApplyUnappliedPayment");
openapiFields.add("batch");
openapiFields.add("billCycleDay");
openapiFields.add("billingRunId");
openapiFields.add("collectPayment");
openapiFields.add("completedOn");
openapiFields.add("consolidatedPayment");
openapiFields.add("createdById");
openapiFields.add("createdDate");
openapiFields.add("currency");
openapiFields.add("executedOn");
openapiFields.add("id");
openapiFields.add("number");
openapiFields.add("paymentGatewayId");
openapiFields.add("processPaymentWithClosedPM");
openapiFields.add("runDate");
openapiFields.add("paymentGatewayNumber");
openapiFields.add("status");
openapiFields.add("targetDate");
openapiFields.add("updatedById");
openapiFields.add("updatedDate");
openapiFields.add("organizationLabels");
// 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 PaymentRun
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!PaymentRun.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in PaymentRun is not found in the empty JSON string", PaymentRun.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("accountId") != null && !jsonObj.get("accountId").isJsonNull()) && !jsonObj.get("accountId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `accountId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("accountId").toString()));
}
if ((jsonObj.get("batch") != null && !jsonObj.get("batch").isJsonNull()) && !jsonObj.get("batch").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `batch` to be a primitive type in the JSON string but got `%s`", jsonObj.get("batch").toString()));
}
if ((jsonObj.get("billCycleDay") != null && !jsonObj.get("billCycleDay").isJsonNull()) && !jsonObj.get("billCycleDay").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `billCycleDay` to be a primitive type in the JSON string but got `%s`", jsonObj.get("billCycleDay").toString()));
}
if ((jsonObj.get("billingRunId") != null && !jsonObj.get("billingRunId").isJsonNull()) && !jsonObj.get("billingRunId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `billingRunId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("billingRunId").toString()));
}
if ((jsonObj.get("completedOn") != null && !jsonObj.get("completedOn").isJsonNull()) && !jsonObj.get("completedOn").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `completedOn` to be a primitive type in the JSON string but got `%s`", jsonObj.get("completedOn").toString()));
}
if ((jsonObj.get("createdById") != null && !jsonObj.get("createdById").isJsonNull()) && !jsonObj.get("createdById").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `createdById` to be a primitive type in the JSON string but got `%s`", jsonObj.get("createdById").toString()));
}
if ((jsonObj.get("createdDate") != null && !jsonObj.get("createdDate").isJsonNull()) && !jsonObj.get("createdDate").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `createdDate` to be a primitive type in the JSON string but got `%s`", jsonObj.get("createdDate").toString()));
}
if ((jsonObj.get("currency") != null && !jsonObj.get("currency").isJsonNull()) && !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()));
}
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("id") != null && !jsonObj.get("id").isJsonNull()) && !jsonObj.get("id").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `id` to be a primitive type in the JSON string but got `%s`", jsonObj.get("id").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("paymentGatewayId") != null && !jsonObj.get("paymentGatewayId").isJsonNull()) && !jsonObj.get("paymentGatewayId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `paymentGatewayId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("paymentGatewayId").toString()));
}
if ((jsonObj.get("runDate") != null && !jsonObj.get("runDate").isJsonNull()) && !jsonObj.get("runDate").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `runDate` to be a primitive type in the JSON string but got `%s`", jsonObj.get("runDate").toString()));
}
if ((jsonObj.get("paymentGatewayNumber") != null && !jsonObj.get("paymentGatewayNumber").isJsonNull()) && !jsonObj.get("paymentGatewayNumber").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `paymentGatewayNumber` to be a primitive type in the JSON string but got `%s`", jsonObj.get("paymentGatewayNumber").toString()));
}
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()));
}
// validate the optional field `status`
if (jsonObj.get("status") != null && !jsonObj.get("status").isJsonNull()) {
PaymentRunStatus.validateJsonElement(jsonObj.get("status"));
}
if ((jsonObj.get("targetDate") != null && !jsonObj.get("targetDate").isJsonNull()) && !jsonObj.get("targetDate").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `targetDate` to be a primitive type in the JSON string but got `%s`", jsonObj.get("targetDate").toString()));
}
if ((jsonObj.get("updatedById") != null && !jsonObj.get("updatedById").isJsonNull()) && !jsonObj.get("updatedById").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `updatedById` to be a primitive type in the JSON string but got `%s`", jsonObj.get("updatedById").toString()));
}
if ((jsonObj.get("updatedDate") != null && !jsonObj.get("updatedDate").isJsonNull()) && !jsonObj.get("updatedDate").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `updatedDate` to be a primitive type in the JSON string but got `%s`", jsonObj.get("updatedDate").toString()));
}
if ((jsonObj.get("organizationLabels") != null && !jsonObj.get("organizationLabels").isJsonNull()) && !jsonObj.get("organizationLabels").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `organizationLabels` to be a primitive type in the JSON string but got `%s`", jsonObj.get("organizationLabels").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!PaymentRun.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'PaymentRun' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(PaymentRun.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, PaymentRun 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 PaymentRun read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
PaymentRun 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 PaymentRun given an JSON string
*
* @param jsonString JSON string
* @return An instance of PaymentRun
* @throws IOException if the JSON string is invalid with respect to PaymentRun
*/
public static PaymentRun fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, PaymentRun.class);
}
/**
* Convert an instance of PaymentRun to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy