com.onfido.model.WorkflowRun 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.WorkflowRunResponseError;
import com.onfido.model.WorkflowRunSharedLink;
import java.io.IOException;
import java.time.OffsetDateTime;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.UUID;
import org.openapitools.jackson.nullable.JsonNullable;
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;
/**
* WorkflowRun
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class WorkflowRun {
public static final String SERIALIZED_NAME_APPLICANT_ID = "applicant_id";
@SerializedName(SERIALIZED_NAME_APPLICANT_ID)
private UUID applicantId;
public static final String SERIALIZED_NAME_WORKFLOW_ID = "workflow_id";
@SerializedName(SERIALIZED_NAME_WORKFLOW_ID)
private UUID workflowId;
public static final String SERIALIZED_NAME_TAGS = "tags";
@SerializedName(SERIALIZED_NAME_TAGS)
private List tags;
public static final String SERIALIZED_NAME_CUSTOMER_USER_ID = "customer_user_id";
@SerializedName(SERIALIZED_NAME_CUSTOMER_USER_ID)
private String customerUserId;
public static final String SERIALIZED_NAME_LINK = "link";
@SerializedName(SERIALIZED_NAME_LINK)
private WorkflowRunSharedLink link;
public static final String SERIALIZED_NAME_CREATED_AT = "created_at";
@SerializedName(SERIALIZED_NAME_CREATED_AT)
private OffsetDateTime createdAt;
public static final String SERIALIZED_NAME_UPDATED_AT = "updated_at";
@SerializedName(SERIALIZED_NAME_UPDATED_AT)
private OffsetDateTime updatedAt;
public static final String SERIALIZED_NAME_ID = "id";
@SerializedName(SERIALIZED_NAME_ID)
private UUID id;
public static final String SERIALIZED_NAME_WORKFLOW_VERSION_ID = "workflow_version_id";
@SerializedName(SERIALIZED_NAME_WORKFLOW_VERSION_ID)
private Integer workflowVersionId;
public static final String SERIALIZED_NAME_DASHBOARD_URL = "dashboard_url";
@SerializedName(SERIALIZED_NAME_DASHBOARD_URL)
private String dashboardUrl;
/**
* The status of the Workflow Run.
*/
@JsonAdapter(StatusEnum.Adapter.class)
public enum StatusEnum {
AWAITING_INPUT("awaiting_input"),
PROCESSING("processing"),
ABANDONED("abandoned"),
ERROR("error"),
APPROVED("approved"),
REVIEW("review"),
DECLINED("declined"),
UNKNOWN_DEFAULT_OPEN_API("unknown_default_open_api");
private String value;
StatusEnum(String value) {
this.value = value;
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static StatusEnum fromValue(String value) {
for (StatusEnum b : StatusEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
return UNKNOWN_DEFAULT_OPEN_API;
}
public static class Adapter extends TypeAdapter {
@Override
public void write(final JsonWriter jsonWriter, final StatusEnum enumeration) throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public StatusEnum read(final JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return StatusEnum.fromValue(value);
}
}
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
String value = jsonElement.getAsString();
StatusEnum.fromValue(value);
}
}
public static final String SERIALIZED_NAME_STATUS = "status";
@SerializedName(SERIALIZED_NAME_STATUS)
private StatusEnum status;
public static final String SERIALIZED_NAME_OUTPUT = "output";
@SerializedName(SERIALIZED_NAME_OUTPUT)
private Object output;
public static final String SERIALIZED_NAME_REASONS = "reasons";
@SerializedName(SERIALIZED_NAME_REASONS)
private List reasons = new ArrayList<>();
public static final String SERIALIZED_NAME_ERROR = "error";
@SerializedName(SERIALIZED_NAME_ERROR)
private WorkflowRunResponseError error;
public static final String SERIALIZED_NAME_SDK_TOKEN = "sdk_token";
@SerializedName(SERIALIZED_NAME_SDK_TOKEN)
private String sdkToken;
public WorkflowRun() {
}
public WorkflowRun applicantId(UUID applicantId) {
this.applicantId = applicantId;
return this;
}
/**
* The unique identifier for the Applicant.
* @return applicantId
**/
@javax.annotation.Nonnull
public UUID getApplicantId() {
return applicantId;
}
public void setApplicantId(UUID applicantId) {
this.applicantId = applicantId;
}
public WorkflowRun workflowId(UUID workflowId) {
this.workflowId = workflowId;
return this;
}
/**
* The unique identifier for the Workflow.
* @return workflowId
**/
@javax.annotation.Nonnull
public UUID getWorkflowId() {
return workflowId;
}
public void setWorkflowId(UUID workflowId) {
this.workflowId = workflowId;
}
public WorkflowRun tags(List tags) {
this.tags = tags;
return this;
}
public WorkflowRun addTagsItem(String tagsItem) {
if (this.tags == null) {
this.tags = new ArrayList<>();
}
this.tags.add(tagsItem);
return this;
}
/**
* Tags or labels assigned to the workflow run.
* @return tags
**/
@javax.annotation.Nullable
public List getTags() {
return tags;
}
public void setTags(List tags) {
this.tags = tags;
}
public WorkflowRun customerUserId(String customerUserId) {
this.customerUserId = customerUserId;
return this;
}
/**
* Customer-provided user identifier.
* @return customerUserId
**/
@javax.annotation.Nullable
public String getCustomerUserId() {
return customerUserId;
}
public void setCustomerUserId(String customerUserId) {
this.customerUserId = customerUserId;
}
public WorkflowRun link(WorkflowRunSharedLink link) {
this.link = link;
return this;
}
/**
* Get link
* @return link
**/
@javax.annotation.Nullable
public WorkflowRunSharedLink getLink() {
return link;
}
public void setLink(WorkflowRunSharedLink link) {
this.link = link;
}
public WorkflowRun createdAt(OffsetDateTime createdAt) {
this.createdAt = createdAt;
return this;
}
/**
* The date and time when the Workflow Run was created.
* @return createdAt
**/
@javax.annotation.Nullable
public OffsetDateTime getCreatedAt() {
return createdAt;
}
public void setCreatedAt(OffsetDateTime createdAt) {
this.createdAt = createdAt;
}
public WorkflowRun updatedAt(OffsetDateTime updatedAt) {
this.updatedAt = updatedAt;
return this;
}
/**
* The date and time when the Workflow Run was last updated.
* @return updatedAt
**/
@javax.annotation.Nullable
public OffsetDateTime getUpdatedAt() {
return updatedAt;
}
public void setUpdatedAt(OffsetDateTime updatedAt) {
this.updatedAt = updatedAt;
}
public WorkflowRun id(UUID id) {
this.id = id;
return this;
}
/**
* The unique identifier for the Workflow Run.
* @return id
**/
@javax.annotation.Nonnull
public UUID getId() {
return id;
}
public void setId(UUID id) {
this.id = id;
}
public WorkflowRun workflowVersionId(Integer workflowVersionId) {
this.workflowVersionId = workflowVersionId;
return this;
}
/**
* The identifier for the Workflow version.
* @return workflowVersionId
**/
@javax.annotation.Nullable
public Integer getWorkflowVersionId() {
return workflowVersionId;
}
public void setWorkflowVersionId(Integer workflowVersionId) {
this.workflowVersionId = workflowVersionId;
}
public WorkflowRun dashboardUrl(String dashboardUrl) {
this.dashboardUrl = dashboardUrl;
return this;
}
/**
* The URL for viewing the Workflow Run results on your Onfido Dashboard.
* @return dashboardUrl
**/
@javax.annotation.Nullable
public String getDashboardUrl() {
return dashboardUrl;
}
public void setDashboardUrl(String dashboardUrl) {
this.dashboardUrl = dashboardUrl;
}
public WorkflowRun status(StatusEnum status) {
this.status = status;
return this;
}
/**
* The status of the Workflow Run.
* @return status
**/
@javax.annotation.Nullable
public StatusEnum getStatus() {
return status;
}
public void setStatus(StatusEnum status) {
this.status = status;
}
public WorkflowRun output(Object output) {
this.output = output;
return this;
}
/**
* Output object contains all of the properties configured on the Workflow version.
* @return output
**/
@javax.annotation.Nullable
public Object getOutput() {
return output;
}
public void setOutput(Object output) {
this.output = output;
}
public WorkflowRun reasons(List reasons) {
this.reasons = reasons;
return this;
}
public WorkflowRun addReasonsItem(String reasonsItem) {
if (this.reasons == null) {
this.reasons = new ArrayList<>();
}
this.reasons.add(reasonsItem);
return this;
}
/**
* The reasons the Workflow Run outcome was reached. Configurable when creating the Workflow version.
* @return reasons
**/
@javax.annotation.Nullable
public List getReasons() {
return reasons;
}
public void setReasons(List reasons) {
this.reasons = reasons;
}
public WorkflowRun error(WorkflowRunResponseError error) {
this.error = error;
return this;
}
/**
* Get error
* @return error
**/
@javax.annotation.Nullable
public WorkflowRunResponseError getError() {
return error;
}
public void setError(WorkflowRunResponseError error) {
this.error = error;
}
public WorkflowRun sdkToken(String sdkToken) {
this.sdkToken = sdkToken;
return this;
}
/**
* Client token to use when loading this workflow run in the Onfido SDK.
* @return sdkToken
**/
@javax.annotation.Nullable
public String getSdkToken() {
return sdkToken;
}
public void setSdkToken(String sdkToken) {
this.sdkToken = sdkToken;
}
/**
* 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 WorkflowRun instance itself
*/
public WorkflowRun 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;
}
WorkflowRun workflowRun = (WorkflowRun) o;
return Objects.equals(this.applicantId, workflowRun.applicantId) &&
Objects.equals(this.workflowId, workflowRun.workflowId) &&
Objects.equals(this.tags, workflowRun.tags) &&
Objects.equals(this.customerUserId, workflowRun.customerUserId) &&
Objects.equals(this.link, workflowRun.link) &&
Objects.equals(this.createdAt, workflowRun.createdAt) &&
Objects.equals(this.updatedAt, workflowRun.updatedAt) &&
Objects.equals(this.id, workflowRun.id) &&
Objects.equals(this.workflowVersionId, workflowRun.workflowVersionId) &&
Objects.equals(this.dashboardUrl, workflowRun.dashboardUrl) &&
Objects.equals(this.status, workflowRun.status) &&
Objects.equals(this.output, workflowRun.output) &&
Objects.equals(this.reasons, workflowRun.reasons) &&
Objects.equals(this.error, workflowRun.error) &&
Objects.equals(this.sdkToken, workflowRun.sdkToken)&&
Objects.equals(this.additionalProperties, workflowRun.additionalProperties);
}
private static boolean equalsNullable(JsonNullable a, JsonNullable b) {
return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get()));
}
@Override
public int hashCode() {
return Objects.hash(applicantId, workflowId, tags, customerUserId, link, createdAt, updatedAt, id, workflowVersionId, dashboardUrl, status, output, reasons, error, sdkToken, additionalProperties);
}
private static int hashCodeNullable(JsonNullable a) {
if (a == null) {
return 1;
}
return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31;
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class WorkflowRun {\n");
sb.append(" applicantId: ").append(toIndentedString(applicantId)).append("\n");
sb.append(" workflowId: ").append(toIndentedString(workflowId)).append("\n");
sb.append(" tags: ").append(toIndentedString(tags)).append("\n");
sb.append(" customerUserId: ").append(toIndentedString(customerUserId)).append("\n");
sb.append(" link: ").append(toIndentedString(link)).append("\n");
sb.append(" createdAt: ").append(toIndentedString(createdAt)).append("\n");
sb.append(" updatedAt: ").append(toIndentedString(updatedAt)).append("\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" workflowVersionId: ").append(toIndentedString(workflowVersionId)).append("\n");
sb.append(" dashboardUrl: ").append(toIndentedString(dashboardUrl)).append("\n");
sb.append(" status: ").append(toIndentedString(status)).append("\n");
sb.append(" output: ").append(toIndentedString(output)).append("\n");
sb.append(" reasons: ").append(toIndentedString(reasons)).append("\n");
sb.append(" error: ").append(toIndentedString(error)).append("\n");
sb.append(" sdkToken: ").append(toIndentedString(sdkToken)).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("applicant_id");
openapiFields.add("workflow_id");
openapiFields.add("tags");
openapiFields.add("customer_user_id");
openapiFields.add("link");
openapiFields.add("created_at");
openapiFields.add("updated_at");
openapiFields.add("id");
openapiFields.add("workflow_version_id");
openapiFields.add("dashboard_url");
openapiFields.add("status");
openapiFields.add("output");
openapiFields.add("reasons");
openapiFields.add("error");
openapiFields.add("sdk_token");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("applicant_id");
openapiRequiredFields.add("workflow_id");
openapiRequiredFields.add("id");
}
/**
* 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 WorkflowRun
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!WorkflowRun.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in WorkflowRun is not found in the empty JSON string", WorkflowRun.openapiRequiredFields.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : WorkflowRun.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("applicant_id").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `applicant_id` to be a primitive type in the JSON string but got `%s`", jsonObj.get("applicant_id").toString()));
}
if (!jsonObj.get("workflow_id").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `workflow_id` to be a primitive type in the JSON string but got `%s`", jsonObj.get("workflow_id").toString()));
}
// ensure the optional json data is an array if present
if (jsonObj.get("tags") != null && !jsonObj.get("tags").isJsonNull() && !jsonObj.get("tags").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `tags` to be an array in the JSON string but got `%s`", jsonObj.get("tags").toString()));
}
if ((jsonObj.get("customer_user_id") != null && !jsonObj.get("customer_user_id").isJsonNull()) && !jsonObj.get("customer_user_id").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `customer_user_id` to be a primitive type in the JSON string but got `%s`", jsonObj.get("customer_user_id").toString()));
}
// validate the optional field `link`
if (jsonObj.get("link") != null && !jsonObj.get("link").isJsonNull()) {
WorkflowRunSharedLink.validateJsonElement(jsonObj.get("link"));
}
if (!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("dashboard_url") != null && !jsonObj.get("dashboard_url").isJsonNull()) && !jsonObj.get("dashboard_url").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `dashboard_url` to be a primitive type in the JSON string but got `%s`", jsonObj.get("dashboard_url").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()) {
StatusEnum.validateJsonElement(jsonObj.get("status"));
}
// ensure the optional json data is an array if present
if (jsonObj.get("reasons") != null && !jsonObj.get("reasons").isJsonNull() && !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 `error`
if (jsonObj.get("error") != null && !jsonObj.get("error").isJsonNull()) {
WorkflowRunResponseError.validateJsonElement(jsonObj.get("error"));
}
if ((jsonObj.get("sdk_token") != null && !jsonObj.get("sdk_token").isJsonNull()) && !jsonObj.get("sdk_token").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `sdk_token` to be a primitive type in the JSON string but got `%s`", jsonObj.get("sdk_token").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!WorkflowRun.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'WorkflowRun' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(WorkflowRun.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, WorkflowRun 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 WorkflowRun read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
WorkflowRun 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 WorkflowRun given an JSON string
*
* @param jsonString JSON string
* @return An instance of WorkflowRun
* @throws IOException if the JSON string is invalid with respect to WorkflowRun
*/
public static WorkflowRun fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, WorkflowRun.class);
}
/**
* Convert an instance of WorkflowRun to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy