com.zuora.model.UpdatePaymentMethodRequest 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.GatewayOptions;
import com.zuora.model.PaymentMethodRequestMandateInfo;
import com.zuora.model.PaymentMethodRequestProcessingOptions;
import com.zuora.model.UpdaterPaymentMethodRequestAccountHolderInfo;
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;
/**
* UpdatePaymentMethodRequest
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class UpdatePaymentMethodRequest {
public static final String SERIALIZED_NAME_EXPIRATION_MONTH = "expirationMonth";
@SerializedName(SERIALIZED_NAME_EXPIRATION_MONTH)
private Integer expirationMonth;
public static final String SERIALIZED_NAME_EXPIRATION_YEAR = "expirationYear";
@SerializedName(SERIALIZED_NAME_EXPIRATION_YEAR)
private Integer expirationYear;
public static final String SERIALIZED_NAME_SECURITY_CODE = "securityCode";
@SerializedName(SERIALIZED_NAME_SECURITY_CODE)
private String securityCode;
public static final String SERIALIZED_NAME_ACCOUNT_HOLDER_INFO = "accountHolderInfo";
@SerializedName(SERIALIZED_NAME_ACCOUNT_HOLDER_INFO)
private UpdaterPaymentMethodRequestAccountHolderInfo accountHolderInfo;
public static final String SERIALIZED_NAME_ACCOUNT_KEY = "accountKey";
@SerializedName(SERIALIZED_NAME_ACCOUNT_KEY)
private String accountKey;
public static final String SERIALIZED_NAME_AUTH_GATEWAY = "authGateway";
@SerializedName(SERIALIZED_NAME_AUTH_GATEWAY)
private String authGateway;
public static final String SERIALIZED_NAME_CURRENCY_CODE = "currencyCode";
@SerializedName(SERIALIZED_NAME_CURRENCY_CODE)
private String currencyCode;
public static final String SERIALIZED_NAME_GATEWAY_OPTIONS = "gatewayOptions";
@SerializedName(SERIALIZED_NAME_GATEWAY_OPTIONS)
private GatewayOptions gatewayOptions;
public static final String SERIALIZED_NAME_IP_ADDRESS = "ipAddress";
@SerializedName(SERIALIZED_NAME_IP_ADDRESS)
private String ipAddress;
public static final String SERIALIZED_NAME_MANDATE_INFO = "mandateInfo";
@SerializedName(SERIALIZED_NAME_MANDATE_INFO)
private PaymentMethodRequestMandateInfo mandateInfo;
public static final String SERIALIZED_NAME_PROCESSING_OPTIONS = "processingOptions";
@SerializedName(SERIALIZED_NAME_PROCESSING_OPTIONS)
private PaymentMethodRequestProcessingOptions processingOptions;
public UpdatePaymentMethodRequest() {
}
public UpdatePaymentMethodRequest expirationMonth(Integer expirationMonth) {
this.expirationMonth = expirationMonth;
return this;
}
/**
* One or two digits expiration month (1-12).
* @return expirationMonth
*/
@javax.annotation.Nullable
public Integer getExpirationMonth() {
return expirationMonth;
}
public void setExpirationMonth(Integer expirationMonth) {
this.expirationMonth = expirationMonth;
}
public UpdatePaymentMethodRequest expirationYear(Integer expirationYear) {
this.expirationYear = expirationYear;
return this;
}
/**
* Four-digit expiration year.
* @return expirationYear
*/
@javax.annotation.Nullable
public Integer getExpirationYear() {
return expirationYear;
}
public void setExpirationYear(Integer expirationYear) {
this.expirationYear = expirationYear;
}
public UpdatePaymentMethodRequest securityCode(String securityCode) {
this.securityCode = securityCode;
return this;
}
/**
* Optional. It is the CVV or CVV2 security code specific for the credit card or debit card. To ensure PCI compliance, this value is not stored and cannot be queried. If securityCode code is not passed in the request payload, this operation only updates related fields in the payload. It does not validate the payment method through the gateway. If securityCode is passed in the request payload, this operation retrieves the credit card information from payload and validates them through the gateway.
* @return securityCode
*/
@javax.annotation.Nullable
public String getSecurityCode() {
return securityCode;
}
public void setSecurityCode(String securityCode) {
this.securityCode = securityCode;
}
public UpdatePaymentMethodRequest accountHolderInfo(UpdaterPaymentMethodRequestAccountHolderInfo accountHolderInfo) {
this.accountHolderInfo = accountHolderInfo;
return this;
}
/**
* Get accountHolderInfo
* @return accountHolderInfo
*/
@javax.annotation.Nullable
public UpdaterPaymentMethodRequestAccountHolderInfo getAccountHolderInfo() {
return accountHolderInfo;
}
public void setAccountHolderInfo(UpdaterPaymentMethodRequestAccountHolderInfo accountHolderInfo) {
this.accountHolderInfo = accountHolderInfo;
}
public UpdatePaymentMethodRequest accountKey(String accountKey) {
this.accountKey = accountKey;
return this;
}
/**
* The ID of the customer account associated with this payment method, such as `2x92c0f859b0480f0159d3a4a6ee5bb6`. **Note:** You can use this field to associate an orphan payment method with a customer account. If a payment method is already associated with a customer account, you cannot change the associated payment method through this operation. You cannot remove the previous account ID and leave this field empty, either.
* @return accountKey
*/
@javax.annotation.Nullable
public String getAccountKey() {
return accountKey;
}
public void setAccountKey(String accountKey) {
this.accountKey = accountKey;
}
public UpdatePaymentMethodRequest authGateway(String authGateway) {
this.authGateway = authGateway;
return this;
}
/**
* Specifies the ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method. This field is not supported in updating Credit Card Reference Transaction payment methods.
* @return authGateway
*/
@javax.annotation.Nullable
public String getAuthGateway() {
return authGateway;
}
public void setAuthGateway(String authGateway) {
this.authGateway = authGateway;
}
public UpdatePaymentMethodRequest currencyCode(String currencyCode) {
this.currencyCode = currencyCode;
return this;
}
/**
* The currency used for payment method authorization.
* @return currencyCode
*/
@javax.annotation.Nullable
public String getCurrencyCode() {
return currencyCode;
}
public void setCurrencyCode(String currencyCode) {
this.currencyCode = currencyCode;
}
public UpdatePaymentMethodRequest gatewayOptions(GatewayOptions gatewayOptions) {
this.gatewayOptions = gatewayOptions;
return this;
}
/**
* Get gatewayOptions
* @return gatewayOptions
*/
@javax.annotation.Nullable
public GatewayOptions getGatewayOptions() {
return gatewayOptions;
}
public void setGatewayOptions(GatewayOptions gatewayOptions) {
this.gatewayOptions = gatewayOptions;
}
public UpdatePaymentMethodRequest ipAddress(String ipAddress) {
this.ipAddress = ipAddress;
return this;
}
/**
* The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. If the IP address length is beyond 45 characters, a validation error occurs. For validating SEPA payment methods on Stripe v2, this field is required.
* @return ipAddress
*/
@javax.annotation.Nullable
public String getIpAddress() {
return ipAddress;
}
public void setIpAddress(String ipAddress) {
this.ipAddress = ipAddress;
}
public UpdatePaymentMethodRequest mandateInfo(PaymentMethodRequestMandateInfo mandateInfo) {
this.mandateInfo = mandateInfo;
return this;
}
/**
* Get mandateInfo
* @return mandateInfo
*/
@javax.annotation.Nullable
public PaymentMethodRequestMandateInfo getMandateInfo() {
return mandateInfo;
}
public void setMandateInfo(PaymentMethodRequestMandateInfo mandateInfo) {
this.mandateInfo = mandateInfo;
}
public UpdatePaymentMethodRequest processingOptions(PaymentMethodRequestProcessingOptions processingOptions) {
this.processingOptions = processingOptions;
return this;
}
/**
* Get processingOptions
* @return processingOptions
*/
@javax.annotation.Nullable
public PaymentMethodRequestProcessingOptions getProcessingOptions() {
return processingOptions;
}
public void setProcessingOptions(PaymentMethodRequestProcessingOptions processingOptions) {
this.processingOptions = processingOptions;
}
/**
* 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 UpdatePaymentMethodRequest instance itself
*/
public UpdatePaymentMethodRequest 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;
}
UpdatePaymentMethodRequest updatePaymentMethodRequest = (UpdatePaymentMethodRequest) o;
return Objects.equals(this.expirationMonth, updatePaymentMethodRequest.expirationMonth) &&
Objects.equals(this.expirationYear, updatePaymentMethodRequest.expirationYear) &&
Objects.equals(this.securityCode, updatePaymentMethodRequest.securityCode) &&
Objects.equals(this.accountHolderInfo, updatePaymentMethodRequest.accountHolderInfo) &&
Objects.equals(this.accountKey, updatePaymentMethodRequest.accountKey) &&
Objects.equals(this.authGateway, updatePaymentMethodRequest.authGateway) &&
Objects.equals(this.currencyCode, updatePaymentMethodRequest.currencyCode) &&
Objects.equals(this.gatewayOptions, updatePaymentMethodRequest.gatewayOptions) &&
Objects.equals(this.ipAddress, updatePaymentMethodRequest.ipAddress) &&
Objects.equals(this.mandateInfo, updatePaymentMethodRequest.mandateInfo) &&
Objects.equals(this.processingOptions, updatePaymentMethodRequest.processingOptions)&&
Objects.equals(this.additionalProperties, updatePaymentMethodRequest.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(expirationMonth, expirationYear, securityCode, accountHolderInfo, accountKey, authGateway, currencyCode, gatewayOptions, ipAddress, mandateInfo, processingOptions, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class UpdatePaymentMethodRequest {\n");
sb.append(" expirationMonth: ").append(toIndentedString(expirationMonth)).append("\n");
sb.append(" expirationYear: ").append(toIndentedString(expirationYear)).append("\n");
sb.append(" securityCode: ").append(toIndentedString(securityCode)).append("\n");
sb.append(" accountHolderInfo: ").append(toIndentedString(accountHolderInfo)).append("\n");
sb.append(" accountKey: ").append(toIndentedString(accountKey)).append("\n");
sb.append(" authGateway: ").append(toIndentedString(authGateway)).append("\n");
sb.append(" currencyCode: ").append(toIndentedString(currencyCode)).append("\n");
sb.append(" gatewayOptions: ").append(toIndentedString(gatewayOptions)).append("\n");
sb.append(" ipAddress: ").append(toIndentedString(ipAddress)).append("\n");
sb.append(" mandateInfo: ").append(toIndentedString(mandateInfo)).append("\n");
sb.append(" processingOptions: ").append(toIndentedString(processingOptions)).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("expirationMonth");
openapiFields.add("expirationYear");
openapiFields.add("securityCode");
openapiFields.add("accountHolderInfo");
openapiFields.add("accountKey");
openapiFields.add("authGateway");
openapiFields.add("currencyCode");
openapiFields.add("gatewayOptions");
openapiFields.add("ipAddress");
openapiFields.add("mandateInfo");
openapiFields.add("processingOptions");
// 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 UpdatePaymentMethodRequest
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!UpdatePaymentMethodRequest.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in UpdatePaymentMethodRequest is not found in the empty JSON string", UpdatePaymentMethodRequest.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("securityCode") != null && !jsonObj.get("securityCode").isJsonNull()) && !jsonObj.get("securityCode").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `securityCode` to be a primitive type in the JSON string but got `%s`", jsonObj.get("securityCode").toString()));
}
// validate the optional field `accountHolderInfo`
if (jsonObj.get("accountHolderInfo") != null && !jsonObj.get("accountHolderInfo").isJsonNull()) {
UpdaterPaymentMethodRequestAccountHolderInfo.validateJsonElement(jsonObj.get("accountHolderInfo"));
}
if ((jsonObj.get("accountKey") != null && !jsonObj.get("accountKey").isJsonNull()) && !jsonObj.get("accountKey").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `accountKey` to be a primitive type in the JSON string but got `%s`", jsonObj.get("accountKey").toString()));
}
if ((jsonObj.get("authGateway") != null && !jsonObj.get("authGateway").isJsonNull()) && !jsonObj.get("authGateway").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `authGateway` to be a primitive type in the JSON string but got `%s`", jsonObj.get("authGateway").toString()));
}
if ((jsonObj.get("currencyCode") != null && !jsonObj.get("currencyCode").isJsonNull()) && !jsonObj.get("currencyCode").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `currencyCode` to be a primitive type in the JSON string but got `%s`", jsonObj.get("currencyCode").toString()));
}
// validate the optional field `gatewayOptions`
if (jsonObj.get("gatewayOptions") != null && !jsonObj.get("gatewayOptions").isJsonNull()) {
GatewayOptions.validateJsonElement(jsonObj.get("gatewayOptions"));
}
if ((jsonObj.get("ipAddress") != null && !jsonObj.get("ipAddress").isJsonNull()) && !jsonObj.get("ipAddress").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `ipAddress` to be a primitive type in the JSON string but got `%s`", jsonObj.get("ipAddress").toString()));
}
// validate the optional field `mandateInfo`
if (jsonObj.get("mandateInfo") != null && !jsonObj.get("mandateInfo").isJsonNull()) {
PaymentMethodRequestMandateInfo.validateJsonElement(jsonObj.get("mandateInfo"));
}
// validate the optional field `processingOptions`
if (jsonObj.get("processingOptions") != null && !jsonObj.get("processingOptions").isJsonNull()) {
PaymentMethodRequestProcessingOptions.validateJsonElement(jsonObj.get("processingOptions"));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!UpdatePaymentMethodRequest.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'UpdatePaymentMethodRequest' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(UpdatePaymentMethodRequest.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, UpdatePaymentMethodRequest 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 UpdatePaymentMethodRequest read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
UpdatePaymentMethodRequest 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 UpdatePaymentMethodRequest given an JSON string
*
* @param jsonString JSON string
* @return An instance of UpdatePaymentMethodRequest
* @throws IOException if the JSON string is invalid with respect to UpdatePaymentMethodRequest
*/
public static UpdatePaymentMethodRequest fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, UpdatePaymentMethodRequest.class);
}
/**
* Convert an instance of UpdatePaymentMethodRequest to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy