com.zuora.model.ServiceProviderResponse 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.FailedReason;
import java.io.IOException;
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;
/**
* ServiceProviderResponse
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class ServiceProviderResponse {
public static final String SERIALIZED_NAME_PROCESS_ID = "processId";
@SerializedName(SERIALIZED_NAME_PROCESS_ID)
private String processId;
public static final String SERIALIZED_NAME_REQUEST_ID = "requestId";
@SerializedName(SERIALIZED_NAME_REQUEST_ID)
private String requestId;
public static final String SERIALIZED_NAME_REASONS = "reasons";
@SerializedName(SERIALIZED_NAME_REASONS)
private List reasons;
public static final String SERIALIZED_NAME_SUCCESS = "success";
@SerializedName(SERIALIZED_NAME_SUCCESS)
private Boolean success;
public static final String SERIALIZED_NAME_ID = "id";
@SerializedName(SERIALIZED_NAME_ID)
private String id;
public static final String SERIALIZED_NAME_NAME = "name";
@SerializedName(SERIALIZED_NAME_NAME)
private String name;
public static final String SERIALIZED_NAME_TEST = "test";
@SerializedName(SERIALIZED_NAME_TEST)
private Boolean test;
/**
* The name of the e-invoicing service provider that can help you generate e-invoice files for billing documents.
*/
@JsonAdapter(ProviderEnum.Adapter.class)
public enum ProviderEnum {
SOVOS("Sovos");
private String value;
ProviderEnum(String value) {
this.value = value;
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static ProviderEnum fromValue(String value) {
for (ProviderEnum b : ProviderEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
public static class Adapter extends TypeAdapter {
@Override
public void write(final JsonWriter jsonWriter, final ProviderEnum enumeration) throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public ProviderEnum read(final JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return ProviderEnum.fromValue(value);
}
}
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
String value = jsonElement.getAsString();
ProviderEnum.fromValue(value);
}
}
public static final String SERIALIZED_NAME_PROVIDER = "provider";
@SerializedName(SERIALIZED_NAME_PROVIDER)
private ProviderEnum provider;
public static final String SERIALIZED_NAME_SERVICE_PROVIDER_NUMBER = "serviceProviderNumber";
@SerializedName(SERIALIZED_NAME_SERVICE_PROVIDER_NUMBER)
private String serviceProviderNumber;
public static final String SERIALIZED_NAME_COMPANY_IDENTIFIER = "companyIdentifier";
@SerializedName(SERIALIZED_NAME_COMPANY_IDENTIFIER)
private String companyIdentifier;
public static final String SERIALIZED_NAME_API_KEY = "apiKey";
@SerializedName(SERIALIZED_NAME_API_KEY)
private String apiKey;
public static final String SERIALIZED_NAME_CLIENT_CERTIFICATE = "clientCertificate";
@SerializedName(SERIALIZED_NAME_CLIENT_CERTIFICATE)
private String clientCertificate;
public static final String SERIALIZED_NAME_CLIENT_CERTIFICATE_TYPE = "clientCertificateType";
@SerializedName(SERIALIZED_NAME_CLIENT_CERTIFICATE_TYPE)
private String clientCertificateType;
public ServiceProviderResponse() {
}
public ServiceProviderResponse processId(String processId) {
this.processId = processId;
return this;
}
/**
* The Id of the process that handle the operation.
* @return processId
*/
@javax.annotation.Nullable
public String getProcessId() {
return processId;
}
public void setProcessId(String processId) {
this.processId = processId;
}
public ServiceProviderResponse requestId(String requestId) {
this.requestId = requestId;
return this;
}
/**
* Unique request identifier. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.
* @return requestId
*/
@javax.annotation.Nullable
public String getRequestId() {
return requestId;
}
public void setRequestId(String requestId) {
this.requestId = requestId;
}
public ServiceProviderResponse reasons(List reasons) {
this.reasons = reasons;
return this;
}
public ServiceProviderResponse addReasonsItem(FailedReason reasonsItem) {
if (this.reasons == null) {
this.reasons = new ArrayList<>();
}
this.reasons.add(reasonsItem);
return this;
}
/**
* Get reasons
* @return reasons
*/
@javax.annotation.Nullable
public List getReasons() {
return reasons;
}
public void setReasons(List reasons) {
this.reasons = reasons;
}
public ServiceProviderResponse success(Boolean success) {
this.success = success;
return this;
}
/**
* Indicates whether the call succeeded.
* @return success
*/
@javax.annotation.Nullable
public Boolean getSuccess() {
return success;
}
public void setSuccess(Boolean success) {
this.success = success;
}
public ServiceProviderResponse id(String id) {
this.id = id;
return this;
}
/**
* The ID of the e-invoicing service provider.
* @return id
*/
@javax.annotation.Nullable
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public ServiceProviderResponse name(String name) {
this.name = name;
return this;
}
/**
* The name of the e-invoicing service provider.
* @return name
*/
@javax.annotation.Nullable
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public ServiceProviderResponse test(Boolean test) {
this.test = test;
return this;
}
/**
* Whether the e-invoicing service provider's configuration is intended for testing. - If you set this field to `true`, requests are directed to the testing integration endpoints. If you set this field to `false`, requests are directed to the production integration endpoints.
* @return test
*/
@javax.annotation.Nullable
public Boolean getTest() {
return test;
}
public void setTest(Boolean test) {
this.test = test;
}
public ServiceProviderResponse provider(ProviderEnum provider) {
this.provider = provider;
return this;
}
/**
* The name of the e-invoicing service provider that can help you generate e-invoice files for billing documents.
* @return provider
*/
@javax.annotation.Nullable
public ProviderEnum getProvider() {
return provider;
}
public void setProvider(ProviderEnum provider) {
this.provider = provider;
}
public ServiceProviderResponse serviceProviderNumber(String serviceProviderNumber) {
this.serviceProviderNumber = serviceProviderNumber;
return this;
}
/**
* The unique number of the e-invoicing service provider.
* @return serviceProviderNumber
*/
@javax.annotation.Nullable
public String getServiceProviderNumber() {
return serviceProviderNumber;
}
public void setServiceProviderNumber(String serviceProviderNumber) {
this.serviceProviderNumber = serviceProviderNumber;
}
public ServiceProviderResponse companyIdentifier(String companyIdentifier) {
this.companyIdentifier = companyIdentifier;
return this;
}
/**
* The Company Identifier is used to create a SenderSystemId, which serves to identify the system from which the transactions are sent.
* @return companyIdentifier
*/
@javax.annotation.Nullable
public String getCompanyIdentifier() {
return companyIdentifier;
}
public void setCompanyIdentifier(String companyIdentifier) {
this.companyIdentifier = companyIdentifier;
}
public ServiceProviderResponse apiKey(String apiKey) {
this.apiKey = apiKey;
return this;
}
/**
* The API key is used to authenticate the e-invoicing service provider's requests.
* @return apiKey
*/
@javax.annotation.Nullable
public String getApiKey() {
return apiKey;
}
public void setApiKey(String apiKey) {
this.apiKey = apiKey;
}
public ServiceProviderResponse clientCertificate(String clientCertificate) {
this.clientCertificate = clientCertificate;
return this;
}
/**
* The client certificate is used to authenticate the e-invoicing service provider's requests, which should be in base64 encoded format.
* @return clientCertificate
*/
@javax.annotation.Nullable
public String getClientCertificate() {
return clientCertificate;
}
public void setClientCertificate(String clientCertificate) {
this.clientCertificate = clientCertificate;
}
public ServiceProviderResponse clientCertificateType(String clientCertificateType) {
this.clientCertificateType = clientCertificateType;
return this;
}
/**
* The client certificate type is used to authenticate the e-invoicing service provider's requests. The default value is `PKCS12`.
* @return clientCertificateType
*/
@javax.annotation.Nullable
public String getClientCertificateType() {
return clientCertificateType;
}
public void setClientCertificateType(String clientCertificateType) {
this.clientCertificateType = clientCertificateType;
}
/**
* 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 ServiceProviderResponse instance itself
*/
public ServiceProviderResponse 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;
}
ServiceProviderResponse serviceProviderResponse = (ServiceProviderResponse) o;
return Objects.equals(this.processId, serviceProviderResponse.processId) &&
Objects.equals(this.requestId, serviceProviderResponse.requestId) &&
Objects.equals(this.reasons, serviceProviderResponse.reasons) &&
Objects.equals(this.success, serviceProviderResponse.success) &&
Objects.equals(this.id, serviceProviderResponse.id) &&
Objects.equals(this.name, serviceProviderResponse.name) &&
Objects.equals(this.test, serviceProviderResponse.test) &&
Objects.equals(this.provider, serviceProviderResponse.provider) &&
Objects.equals(this.serviceProviderNumber, serviceProviderResponse.serviceProviderNumber) &&
Objects.equals(this.companyIdentifier, serviceProviderResponse.companyIdentifier) &&
Objects.equals(this.apiKey, serviceProviderResponse.apiKey) &&
Objects.equals(this.clientCertificate, serviceProviderResponse.clientCertificate) &&
Objects.equals(this.clientCertificateType, serviceProviderResponse.clientCertificateType)&&
Objects.equals(this.additionalProperties, serviceProviderResponse.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(processId, requestId, reasons, success, id, name, test, provider, serviceProviderNumber, companyIdentifier, apiKey, clientCertificate, clientCertificateType, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class ServiceProviderResponse {\n");
sb.append(" processId: ").append(toIndentedString(processId)).append("\n");
sb.append(" requestId: ").append(toIndentedString(requestId)).append("\n");
sb.append(" reasons: ").append(toIndentedString(reasons)).append("\n");
sb.append(" success: ").append(toIndentedString(success)).append("\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" test: ").append(toIndentedString(test)).append("\n");
sb.append(" provider: ").append(toIndentedString(provider)).append("\n");
sb.append(" serviceProviderNumber: ").append(toIndentedString(serviceProviderNumber)).append("\n");
sb.append(" companyIdentifier: ").append(toIndentedString(companyIdentifier)).append("\n");
sb.append(" apiKey: ").append(toIndentedString(apiKey)).append("\n");
sb.append(" clientCertificate: ").append(toIndentedString(clientCertificate)).append("\n");
sb.append(" clientCertificateType: ").append(toIndentedString(clientCertificateType)).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("processId");
openapiFields.add("requestId");
openapiFields.add("reasons");
openapiFields.add("success");
openapiFields.add("id");
openapiFields.add("name");
openapiFields.add("test");
openapiFields.add("provider");
openapiFields.add("serviceProviderNumber");
openapiFields.add("companyIdentifier");
openapiFields.add("apiKey");
openapiFields.add("clientCertificate");
openapiFields.add("clientCertificateType");
// 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 ServiceProviderResponse
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!ServiceProviderResponse.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in ServiceProviderResponse is not found in the empty JSON string", ServiceProviderResponse.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("processId") != null && !jsonObj.get("processId").isJsonNull()) && !jsonObj.get("processId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `processId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("processId").toString()));
}
if ((jsonObj.get("requestId") != null && !jsonObj.get("requestId").isJsonNull()) && !jsonObj.get("requestId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `requestId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("requestId").toString()));
}
if (jsonObj.get("reasons") != null && !jsonObj.get("reasons").isJsonNull()) {
JsonArray jsonArrayreasons = jsonObj.getAsJsonArray("reasons");
if (jsonArrayreasons != null) {
// ensure the json data is an array
if (!jsonObj.get("reasons").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `reasons` to be an array in the JSON string but got `%s`", jsonObj.get("reasons").toString()));
}
// validate the optional field `reasons` (array)
for (int i = 0; i < jsonArrayreasons.size(); i++) {
FailedReason.validateJsonElement(jsonArrayreasons.get(i));
};
}
}
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("name") != null && !jsonObj.get("name").isJsonNull()) && !jsonObj.get("name").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `name` to be a primitive type in the JSON string but got `%s`", jsonObj.get("name").toString()));
}
if ((jsonObj.get("provider") != null && !jsonObj.get("provider").isJsonNull()) && !jsonObj.get("provider").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `provider` to be a primitive type in the JSON string but got `%s`", jsonObj.get("provider").toString()));
}
// validate the optional field `provider`
if (jsonObj.get("provider") != null && !jsonObj.get("provider").isJsonNull()) {
ProviderEnum.validateJsonElement(jsonObj.get("provider"));
}
if ((jsonObj.get("serviceProviderNumber") != null && !jsonObj.get("serviceProviderNumber").isJsonNull()) && !jsonObj.get("serviceProviderNumber").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `serviceProviderNumber` to be a primitive type in the JSON string but got `%s`", jsonObj.get("serviceProviderNumber").toString()));
}
if ((jsonObj.get("companyIdentifier") != null && !jsonObj.get("companyIdentifier").isJsonNull()) && !jsonObj.get("companyIdentifier").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `companyIdentifier` to be a primitive type in the JSON string but got `%s`", jsonObj.get("companyIdentifier").toString()));
}
if ((jsonObj.get("apiKey") != null && !jsonObj.get("apiKey").isJsonNull()) && !jsonObj.get("apiKey").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `apiKey` to be a primitive type in the JSON string but got `%s`", jsonObj.get("apiKey").toString()));
}
if ((jsonObj.get("clientCertificate") != null && !jsonObj.get("clientCertificate").isJsonNull()) && !jsonObj.get("clientCertificate").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `clientCertificate` to be a primitive type in the JSON string but got `%s`", jsonObj.get("clientCertificate").toString()));
}
if ((jsonObj.get("clientCertificateType") != null && !jsonObj.get("clientCertificateType").isJsonNull()) && !jsonObj.get("clientCertificateType").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `clientCertificateType` to be a primitive type in the JSON string but got `%s`", jsonObj.get("clientCertificateType").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!ServiceProviderResponse.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'ServiceProviderResponse' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(ServiceProviderResponse.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, ServiceProviderResponse 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 ServiceProviderResponse read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
ServiceProviderResponse 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 ServiceProviderResponse given an JSON string
*
* @param jsonString JSON string
* @return An instance of ServiceProviderResponse
* @throws IOException if the JSON string is invalid with respect to ServiceProviderResponse
*/
public static ServiceProviderResponse fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, ServiceProviderResponse.class);
}
/**
* Convert an instance of ServiceProviderResponse to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy