com.zuora.model.CreateStoredCredentialProfileRequest 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.CreateStoredCredentialProfileRequestStatus;
import com.zuora.model.StoredCredentialProfileAction;
import com.zuora.model.StoredCredentialProfileConsentAgreementSrc;
import com.zuora.model.StoredCredentialProfileType;
import java.io.IOException;
import java.time.LocalDate;
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;
/**
* CreateStoredCredentialProfileRequest
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class CreateStoredCredentialProfileRequest {
public static final String SERIALIZED_NAME_ACTION = "action";
@SerializedName(SERIALIZED_NAME_ACTION)
private StoredCredentialProfileAction action;
public static final String SERIALIZED_NAME_AGREED_ON = "agreedOn";
@SerializedName(SERIALIZED_NAME_AGREED_ON)
private LocalDate agreedOn;
public static final String SERIALIZED_NAME_AUTH_GATEWAY = "authGateway";
@SerializedName(SERIALIZED_NAME_AUTH_GATEWAY)
private String authGateway;
public static final String SERIALIZED_NAME_CARD_SECURITY_CODE = "cardSecurityCode";
@SerializedName(SERIALIZED_NAME_CARD_SECURITY_CODE)
private String cardSecurityCode;
public static final String SERIALIZED_NAME_CONSENT_AGREEMENT_REF = "consentAgreementRef";
@SerializedName(SERIALIZED_NAME_CONSENT_AGREEMENT_REF)
private String consentAgreementRef;
public static final String SERIALIZED_NAME_CONSENT_AGREEMENT_SRC = "consentAgreementSrc";
@SerializedName(SERIALIZED_NAME_CONSENT_AGREEMENT_SRC)
private StoredCredentialProfileConsentAgreementSrc consentAgreementSrc;
public static final String SERIALIZED_NAME_NETWORK_TRANSACTION_ID = "networkTransactionId";
@SerializedName(SERIALIZED_NAME_NETWORK_TRANSACTION_ID)
private String networkTransactionId;
public static final String SERIALIZED_NAME_STATUS = "status";
@SerializedName(SERIALIZED_NAME_STATUS)
private CreateStoredCredentialProfileRequestStatus status;
public static final String SERIALIZED_NAME_TYPE = "type";
@SerializedName(SERIALIZED_NAME_TYPE)
private StoredCredentialProfileType type;
public CreateStoredCredentialProfileRequest() {
}
public CreateStoredCredentialProfileRequest action(StoredCredentialProfileAction action) {
this.action = action;
return this;
}
/**
* Get action
* @return action
*/
@javax.annotation.Nullable
public StoredCredentialProfileAction getAction() {
return action;
}
public void setAction(StoredCredentialProfileAction action) {
this.action = action;
}
public CreateStoredCredentialProfileRequest agreedOn(LocalDate agreedOn) {
this.agreedOn = agreedOn;
return this;
}
/**
* The date on which the profile is agreed. The date format is `yyyy-mm-dd`.
* @return agreedOn
*/
@javax.annotation.Nullable
public LocalDate getAgreedOn() {
return agreedOn;
}
public void setAgreedOn(LocalDate agreedOn) {
this.agreedOn = agreedOn;
}
public CreateStoredCredentialProfileRequest authGateway(String authGateway) {
this.authGateway = authGateway;
return this;
}
/**
* Specifies the ID of the payment gateway that Zuora will use when activating the stored credential profile.
* @return authGateway
*/
@javax.annotation.Nullable
public String getAuthGateway() {
return authGateway;
}
public void setAuthGateway(String authGateway) {
this.authGateway = authGateway;
}
public CreateStoredCredentialProfileRequest cardSecurityCode(String cardSecurityCode) {
this.cardSecurityCode = cardSecurityCode;
return this;
}
/**
* The security code of the credit card.
* @return cardSecurityCode
*/
@javax.annotation.Nullable
public String getCardSecurityCode() {
return cardSecurityCode;
}
public void setCardSecurityCode(String cardSecurityCode) {
this.cardSecurityCode = cardSecurityCode;
}
public CreateStoredCredentialProfileRequest consentAgreementRef(String consentAgreementRef) {
this.consentAgreementRef = consentAgreementRef;
return this;
}
/**
* Specifies your reference for the consent agreement that you have established with the customer.
* @return consentAgreementRef
*/
@javax.annotation.Nullable
public String getConsentAgreementRef() {
return consentAgreementRef;
}
public void setConsentAgreementRef(String consentAgreementRef) {
this.consentAgreementRef = consentAgreementRef;
}
public CreateStoredCredentialProfileRequest consentAgreementSrc(StoredCredentialProfileConsentAgreementSrc consentAgreementSrc) {
this.consentAgreementSrc = consentAgreementSrc;
return this;
}
/**
* Get consentAgreementSrc
* @return consentAgreementSrc
*/
@javax.annotation.Nonnull
public StoredCredentialProfileConsentAgreementSrc getConsentAgreementSrc() {
return consentAgreementSrc;
}
public void setConsentAgreementSrc(StoredCredentialProfileConsentAgreementSrc consentAgreementSrc) {
this.consentAgreementSrc = consentAgreementSrc;
}
public CreateStoredCredentialProfileRequest networkTransactionId(String networkTransactionId) {
this.networkTransactionId = networkTransactionId;
return this;
}
/**
* The ID of a network transaction. Only applicable if you set the `action` field to `Persist`.
* @return networkTransactionId
*/
@javax.annotation.Nullable
public String getNetworkTransactionId() {
return networkTransactionId;
}
public void setNetworkTransactionId(String networkTransactionId) {
this.networkTransactionId = networkTransactionId;
}
public CreateStoredCredentialProfileRequest status(CreateStoredCredentialProfileRequestStatus status) {
this.status = status;
return this;
}
/**
* Get status
* @return status
*/
@javax.annotation.Nonnull
public CreateStoredCredentialProfileRequestStatus getStatus() {
return status;
}
public void setStatus(CreateStoredCredentialProfileRequestStatus status) {
this.status = status;
}
public CreateStoredCredentialProfileRequest type(StoredCredentialProfileType type) {
this.type = type;
return this;
}
/**
* Get type
* @return type
*/
@javax.annotation.Nonnull
public StoredCredentialProfileType getType() {
return type;
}
public void setType(StoredCredentialProfileType type) {
this.type = type;
}
/**
* 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 CreateStoredCredentialProfileRequest instance itself
*/
public CreateStoredCredentialProfileRequest 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;
}
CreateStoredCredentialProfileRequest createStoredCredentialProfileRequest = (CreateStoredCredentialProfileRequest) o;
return Objects.equals(this.action, createStoredCredentialProfileRequest.action) &&
Objects.equals(this.agreedOn, createStoredCredentialProfileRequest.agreedOn) &&
Objects.equals(this.authGateway, createStoredCredentialProfileRequest.authGateway) &&
Objects.equals(this.cardSecurityCode, createStoredCredentialProfileRequest.cardSecurityCode) &&
Objects.equals(this.consentAgreementRef, createStoredCredentialProfileRequest.consentAgreementRef) &&
Objects.equals(this.consentAgreementSrc, createStoredCredentialProfileRequest.consentAgreementSrc) &&
Objects.equals(this.networkTransactionId, createStoredCredentialProfileRequest.networkTransactionId) &&
Objects.equals(this.status, createStoredCredentialProfileRequest.status) &&
Objects.equals(this.type, createStoredCredentialProfileRequest.type)&&
Objects.equals(this.additionalProperties, createStoredCredentialProfileRequest.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(action, agreedOn, authGateway, cardSecurityCode, consentAgreementRef, consentAgreementSrc, networkTransactionId, status, type, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class CreateStoredCredentialProfileRequest {\n");
sb.append(" action: ").append(toIndentedString(action)).append("\n");
sb.append(" agreedOn: ").append(toIndentedString(agreedOn)).append("\n");
sb.append(" authGateway: ").append(toIndentedString(authGateway)).append("\n");
sb.append(" cardSecurityCode: ").append(toIndentedString(cardSecurityCode)).append("\n");
sb.append(" consentAgreementRef: ").append(toIndentedString(consentAgreementRef)).append("\n");
sb.append(" consentAgreementSrc: ").append(toIndentedString(consentAgreementSrc)).append("\n");
sb.append(" networkTransactionId: ").append(toIndentedString(networkTransactionId)).append("\n");
sb.append(" status: ").append(toIndentedString(status)).append("\n");
sb.append(" type: ").append(toIndentedString(type)).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("action");
openapiFields.add("agreedOn");
openapiFields.add("authGateway");
openapiFields.add("cardSecurityCode");
openapiFields.add("consentAgreementRef");
openapiFields.add("consentAgreementSrc");
openapiFields.add("networkTransactionId");
openapiFields.add("status");
openapiFields.add("type");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("consentAgreementSrc");
openapiRequiredFields.add("status");
openapiRequiredFields.add("type");
}
/**
* 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 CreateStoredCredentialProfileRequest
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!CreateStoredCredentialProfileRequest.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in CreateStoredCredentialProfileRequest is not found in the empty JSON string", CreateStoredCredentialProfileRequest.openapiRequiredFields.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : CreateStoredCredentialProfileRequest.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("action") != null && !jsonObj.get("action").isJsonNull()) && !jsonObj.get("action").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `action` to be a primitive type in the JSON string but got `%s`", jsonObj.get("action").toString()));
}
// validate the optional field `action`
if (jsonObj.get("action") != null && !jsonObj.get("action").isJsonNull()) {
StoredCredentialProfileAction.validateJsonElement(jsonObj.get("action"));
}
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("cardSecurityCode") != null && !jsonObj.get("cardSecurityCode").isJsonNull()) && !jsonObj.get("cardSecurityCode").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `cardSecurityCode` to be a primitive type in the JSON string but got `%s`", jsonObj.get("cardSecurityCode").toString()));
}
if ((jsonObj.get("consentAgreementRef") != null && !jsonObj.get("consentAgreementRef").isJsonNull()) && !jsonObj.get("consentAgreementRef").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `consentAgreementRef` to be a primitive type in the JSON string but got `%s`", jsonObj.get("consentAgreementRef").toString()));
}
if (!jsonObj.get("consentAgreementSrc").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `consentAgreementSrc` to be a primitive type in the JSON string but got `%s`", jsonObj.get("consentAgreementSrc").toString()));
}
// validate the required field `consentAgreementSrc`
StoredCredentialProfileConsentAgreementSrc.validateJsonElement(jsonObj.get("consentAgreementSrc"));
if ((jsonObj.get("networkTransactionId") != null && !jsonObj.get("networkTransactionId").isJsonNull()) && !jsonObj.get("networkTransactionId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `networkTransactionId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("networkTransactionId").toString()));
}
if (!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 required field `status`
CreateStoredCredentialProfileRequestStatus.validateJsonElement(jsonObj.get("status"));
if (!jsonObj.get("type").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `type` to be a primitive type in the JSON string but got `%s`", jsonObj.get("type").toString()));
}
// validate the required field `type`
StoredCredentialProfileType.validateJsonElement(jsonObj.get("type"));
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!CreateStoredCredentialProfileRequest.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'CreateStoredCredentialProfileRequest' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(CreateStoredCredentialProfileRequest.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, CreateStoredCredentialProfileRequest 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 CreateStoredCredentialProfileRequest read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
CreateStoredCredentialProfileRequest 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 CreateStoredCredentialProfileRequest given an JSON string
*
* @param jsonString JSON string
* @return An instance of CreateStoredCredentialProfileRequest
* @throws IOException if the JSON string is invalid with respect to CreateStoredCredentialProfileRequest
*/
public static CreateStoredCredentialProfileRequest fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, CreateStoredCredentialProfileRequest.class);
}
/**
* Convert an instance of CreateStoredCredentialProfileRequest to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy