com.onfido.model.WorkflowRunSharedLink 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 java.io.IOException;
import java.time.OffsetDateTime;
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.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;
/**
* Object for the configuration of the Workflow Run link.
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class WorkflowRunSharedLink {
public static final String SERIALIZED_NAME_URL = "url";
@SerializedName(SERIALIZED_NAME_URL)
private String url;
public static final String SERIALIZED_NAME_COMPLETED_REDIRECT_URL = "completed_redirect_url";
@SerializedName(SERIALIZED_NAME_COMPLETED_REDIRECT_URL)
private String completedRedirectUrl;
public static final String SERIALIZED_NAME_EXPIRED_REDIRECT_URL = "expired_redirect_url";
@SerializedName(SERIALIZED_NAME_EXPIRED_REDIRECT_URL)
private String expiredRedirectUrl;
public static final String SERIALIZED_NAME_EXPIRES_AT = "expires_at";
@SerializedName(SERIALIZED_NAME_EXPIRES_AT)
private OffsetDateTime expiresAt;
/**
* The code for the language when the workflow run is acessed using the link.
*/
@JsonAdapter(LanguageEnum.Adapter.class)
public enum LanguageEnum {
EN_US("en_US"),
DE_DE("de_DE"),
ES_ES("es_ES"),
FR_FR("fr_FR"),
IT_IT("it_IT"),
PT_PT("pt_PT"),
NL_NL("nl_NL"),
UNKNOWN_DEFAULT_OPEN_API("unknown_default_open_api");
private String value;
LanguageEnum(String value) {
this.value = value;
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static LanguageEnum fromValue(String value) {
for (LanguageEnum b : LanguageEnum.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 LanguageEnum enumeration) throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public LanguageEnum read(final JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return LanguageEnum.fromValue(value);
}
}
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
String value = jsonElement.getAsString();
LanguageEnum.fromValue(value);
}
}
public static final String SERIALIZED_NAME_LANGUAGE = "language";
@SerializedName(SERIALIZED_NAME_LANGUAGE)
private LanguageEnum language;
public WorkflowRunSharedLink() {
}
public WorkflowRunSharedLink url(String url) {
this.url = url;
return this;
}
/**
* Link to access the Workflow Run without the need to integrate with Onfido's SDKs.
* @return url
**/
@javax.annotation.Nullable
public String getUrl() {
return url;
}
public void setUrl(String url) {
this.url = url;
}
public WorkflowRunSharedLink completedRedirectUrl(String completedRedirectUrl) {
this.completedRedirectUrl = completedRedirectUrl;
return this;
}
/**
* When the interactive section of the Workflow Run has completed successfully, the user will be redirected to this URL instead of seeing the default Onfido 'thank you' page.
* @return completedRedirectUrl
**/
@javax.annotation.Nullable
public String getCompletedRedirectUrl() {
return completedRedirectUrl;
}
public void setCompletedRedirectUrl(String completedRedirectUrl) {
this.completedRedirectUrl = completedRedirectUrl;
}
public WorkflowRunSharedLink expiredRedirectUrl(String expiredRedirectUrl) {
this.expiredRedirectUrl = expiredRedirectUrl;
return this;
}
/**
* When the link has expired, the user will be immediately redirected to this URL instead of seeing the default Onfido error message.
* @return expiredRedirectUrl
**/
@javax.annotation.Nullable
public String getExpiredRedirectUrl() {
return expiredRedirectUrl;
}
public void setExpiredRedirectUrl(String expiredRedirectUrl) {
this.expiredRedirectUrl = expiredRedirectUrl;
}
public WorkflowRunSharedLink expiresAt(OffsetDateTime expiresAt) {
this.expiresAt = expiresAt;
return this;
}
/**
* Date and time when the link will expire.
* @return expiresAt
**/
@javax.annotation.Nullable
public OffsetDateTime getExpiresAt() {
return expiresAt;
}
public void setExpiresAt(OffsetDateTime expiresAt) {
this.expiresAt = expiresAt;
}
public WorkflowRunSharedLink language(LanguageEnum language) {
this.language = language;
return this;
}
/**
* The code for the language when the workflow run is acessed using the link.
* @return language
**/
@javax.annotation.Nullable
public LanguageEnum getLanguage() {
return language;
}
public void setLanguage(LanguageEnum language) {
this.language = language;
}
/**
* 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 WorkflowRunSharedLink instance itself
*/
public WorkflowRunSharedLink 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;
}
WorkflowRunSharedLink workflowRunSharedLink = (WorkflowRunSharedLink) o;
return Objects.equals(this.url, workflowRunSharedLink.url) &&
Objects.equals(this.completedRedirectUrl, workflowRunSharedLink.completedRedirectUrl) &&
Objects.equals(this.expiredRedirectUrl, workflowRunSharedLink.expiredRedirectUrl) &&
Objects.equals(this.expiresAt, workflowRunSharedLink.expiresAt) &&
Objects.equals(this.language, workflowRunSharedLink.language)&&
Objects.equals(this.additionalProperties, workflowRunSharedLink.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(url, completedRedirectUrl, expiredRedirectUrl, expiresAt, language, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class WorkflowRunSharedLink {\n");
sb.append(" url: ").append(toIndentedString(url)).append("\n");
sb.append(" completedRedirectUrl: ").append(toIndentedString(completedRedirectUrl)).append("\n");
sb.append(" expiredRedirectUrl: ").append(toIndentedString(expiredRedirectUrl)).append("\n");
sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n");
sb.append(" language: ").append(toIndentedString(language)).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("url");
openapiFields.add("completed_redirect_url");
openapiFields.add("expired_redirect_url");
openapiFields.add("expires_at");
openapiFields.add("language");
// 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 WorkflowRunSharedLink
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!WorkflowRunSharedLink.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in WorkflowRunSharedLink is not found in the empty JSON string", WorkflowRunSharedLink.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("url") != null && !jsonObj.get("url").isJsonNull()) && !jsonObj.get("url").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `url` to be a primitive type in the JSON string but got `%s`", jsonObj.get("url").toString()));
}
if ((jsonObj.get("completed_redirect_url") != null && !jsonObj.get("completed_redirect_url").isJsonNull()) && !jsonObj.get("completed_redirect_url").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `completed_redirect_url` to be a primitive type in the JSON string but got `%s`", jsonObj.get("completed_redirect_url").toString()));
}
if ((jsonObj.get("expired_redirect_url") != null && !jsonObj.get("expired_redirect_url").isJsonNull()) && !jsonObj.get("expired_redirect_url").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `expired_redirect_url` to be a primitive type in the JSON string but got `%s`", jsonObj.get("expired_redirect_url").toString()));
}
if ((jsonObj.get("language") != null && !jsonObj.get("language").isJsonNull()) && !jsonObj.get("language").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `language` to be a primitive type in the JSON string but got `%s`", jsonObj.get("language").toString()));
}
// validate the optional field `language`
if (jsonObj.get("language") != null && !jsonObj.get("language").isJsonNull()) {
LanguageEnum.validateJsonElement(jsonObj.get("language"));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!WorkflowRunSharedLink.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'WorkflowRunSharedLink' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(WorkflowRunSharedLink.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, WorkflowRunSharedLink 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 WorkflowRunSharedLink read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
WorkflowRunSharedLink 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 WorkflowRunSharedLink given an JSON string
*
* @param jsonString JSON string
* @return An instance of WorkflowRunSharedLink
* @throws IOException if the JSON string is invalid with respect to WorkflowRunSharedLink
*/
public static WorkflowRunSharedLink fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, WorkflowRunSharedLink.class);
}
/**
* Convert an instance of WorkflowRunSharedLink to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy