com.onfido.model.RepeatAttemptsList Maven / Gradle / Ivy
/*
* Onfido API v3.6
* The Onfido API (v3.6)
*
* The version of the OpenAPI document: v3.6
*
*
* 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.onfido.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.onfido.model.RepeatAttemptsListRepeatAttemptsInner;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.UUID;
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.lang.reflect.Type;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import com.onfido.JSON;
/**
* RepeatAttemptsList
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class RepeatAttemptsList {
public static final String SERIALIZED_NAME_REPORT_ID = "report_id";
@SerializedName(SERIALIZED_NAME_REPORT_ID)
private UUID reportId;
public static final String SERIALIZED_NAME_REPEAT_ATTEMPTS = "repeat_attempts";
@SerializedName(SERIALIZED_NAME_REPEAT_ATTEMPTS)
private List repeatAttempts = new ArrayList<>();
public static final String SERIALIZED_NAME_ATTEMPTS_COUNT = "attempts_count";
@SerializedName(SERIALIZED_NAME_ATTEMPTS_COUNT)
private Integer attemptsCount;
public static final String SERIALIZED_NAME_ATTEMPTS_CLEAR_RATE = "attempts_clear_rate";
@SerializedName(SERIALIZED_NAME_ATTEMPTS_CLEAR_RATE)
private Float attemptsClearRate;
public static final String SERIALIZED_NAME_UNIQUE_MISMATCHES_COUNT = "unique_mismatches_count";
@SerializedName(SERIALIZED_NAME_UNIQUE_MISMATCHES_COUNT)
private Integer uniqueMismatchesCount;
public RepeatAttemptsList() {
}
public RepeatAttemptsList reportId(UUID reportId) {
this.reportId = reportId;
return this;
}
/**
* The unique identifier of the completed Document report.
* @return reportId
**/
@javax.annotation.Nullable
public UUID getReportId() {
return reportId;
}
public void setReportId(UUID reportId) {
this.reportId = reportId;
}
public RepeatAttemptsList repeatAttempts(List repeatAttempts) {
this.repeatAttempts = repeatAttempts;
return this;
}
public RepeatAttemptsList addRepeatAttemptsItem(RepeatAttemptsListRepeatAttemptsInner repeatAttemptsItem) {
if (this.repeatAttempts == null) {
this.repeatAttempts = new ArrayList<>();
}
this.repeatAttempts.add(repeatAttemptsItem);
return this;
}
/**
* An array of repeat attempt objects. If no repeat attempts were found, the array will be empty. The number of objects returned can increase over time if more matches are received.
* @return repeatAttempts
**/
@javax.annotation.Nonnull
public List getRepeatAttempts() {
return repeatAttempts;
}
public void setRepeatAttempts(List repeatAttempts) {
this.repeatAttempts = repeatAttempts;
}
public RepeatAttemptsList attemptsCount(Integer attemptsCount) {
this.attemptsCount = attemptsCount;
return this;
}
/**
* The total number of attempts using the same document, including the current report under assessment.
* @return attemptsCount
**/
@javax.annotation.Nullable
public Integer getAttemptsCount() {
return attemptsCount;
}
public void setAttemptsCount(Integer attemptsCount) {
this.attemptsCount = attemptsCount;
}
public RepeatAttemptsList attemptsClearRate(Float attemptsClearRate) {
this.attemptsClearRate = attemptsClearRate;
return this;
}
/**
* A number between 0 and 1 which indicates the proportion of attempts that have been cleared, including the current report under assessment.
* minimum: 0
* maximum: 1
* @return attemptsClearRate
**/
@javax.annotation.Nullable
public Float getAttemptsClearRate() {
return attemptsClearRate;
}
public void setAttemptsClearRate(Float attemptsClearRate) {
this.attemptsClearRate = attemptsClearRate;
}
public RepeatAttemptsList uniqueMismatchesCount(Integer uniqueMismatchesCount) {
this.uniqueMismatchesCount = uniqueMismatchesCount;
return this;
}
/**
* The number of unique entries in the repeat_attempts field for which at least one of the fields is a mismatch.
* @return uniqueMismatchesCount
**/
@javax.annotation.Nullable
public Integer getUniqueMismatchesCount() {
return uniqueMismatchesCount;
}
public void setUniqueMismatchesCount(Integer uniqueMismatchesCount) {
this.uniqueMismatchesCount = uniqueMismatchesCount;
}
/**
* 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 RepeatAttemptsList instance itself
*/
public RepeatAttemptsList 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;
}
RepeatAttemptsList repeatAttemptsList = (RepeatAttemptsList) o;
return Objects.equals(this.reportId, repeatAttemptsList.reportId) &&
Objects.equals(this.repeatAttempts, repeatAttemptsList.repeatAttempts) &&
Objects.equals(this.attemptsCount, repeatAttemptsList.attemptsCount) &&
Objects.equals(this.attemptsClearRate, repeatAttemptsList.attemptsClearRate) &&
Objects.equals(this.uniqueMismatchesCount, repeatAttemptsList.uniqueMismatchesCount)&&
Objects.equals(this.additionalProperties, repeatAttemptsList.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(reportId, repeatAttempts, attemptsCount, attemptsClearRate, uniqueMismatchesCount, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class RepeatAttemptsList {\n");
sb.append(" reportId: ").append(toIndentedString(reportId)).append("\n");
sb.append(" repeatAttempts: ").append(toIndentedString(repeatAttempts)).append("\n");
sb.append(" attemptsCount: ").append(toIndentedString(attemptsCount)).append("\n");
sb.append(" attemptsClearRate: ").append(toIndentedString(attemptsClearRate)).append("\n");
sb.append(" uniqueMismatchesCount: ").append(toIndentedString(uniqueMismatchesCount)).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("report_id");
openapiFields.add("repeat_attempts");
openapiFields.add("attempts_count");
openapiFields.add("attempts_clear_rate");
openapiFields.add("unique_mismatches_count");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("repeat_attempts");
}
/**
* 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 RepeatAttemptsList
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!RepeatAttemptsList.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in RepeatAttemptsList is not found in the empty JSON string", RepeatAttemptsList.openapiRequiredFields.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : RepeatAttemptsList.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("report_id") != null && !jsonObj.get("report_id").isJsonNull()) && !jsonObj.get("report_id").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `report_id` to be a primitive type in the JSON string but got `%s`", jsonObj.get("report_id").toString()));
}
// ensure the json data is an array
if (!jsonObj.get("repeat_attempts").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `repeat_attempts` to be an array in the JSON string but got `%s`", jsonObj.get("repeat_attempts").toString()));
}
JsonArray jsonArrayrepeatAttempts = jsonObj.getAsJsonArray("repeat_attempts");
// validate the required field `repeat_attempts` (array)
for (int i = 0; i < jsonArrayrepeatAttempts.size(); i++) {
RepeatAttemptsListRepeatAttemptsInner.validateJsonElement(jsonArrayrepeatAttempts.get(i));
};
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!RepeatAttemptsList.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'RepeatAttemptsList' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(RepeatAttemptsList.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, RepeatAttemptsList value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
obj.remove("additionalProperties");
// serialize additional properties
if (value.getAdditionalProperties() != null) {
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 {
JsonElement jsonElement = gson.toJsonTree(entry.getValue());
if (jsonElement.isJsonArray()) {
obj.add(entry.getKey(), jsonElement.getAsJsonArray());
} else {
obj.add(entry.getKey(), jsonElement.getAsJsonObject());
}
}
}
}
elementAdapter.write(out, obj);
}
@Override
public RepeatAttemptsList read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
RepeatAttemptsList 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 RepeatAttemptsList given an JSON string
*
* @param jsonString JSON string
* @return An instance of RepeatAttemptsList
* @throws IOException if the JSON string is invalid with respect to RepeatAttemptsList
*/
public static RepeatAttemptsList fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, RepeatAttemptsList.class);
}
/**
* Convert an instance of RepeatAttemptsList to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy