Merge pull request #140 from onfido/release-upgrade

Refresh onfido-java after onfido-openapi-spec update (be823e7)

Author: dvacca-onfido

.release.json

@@ -1,9 +1,9 @@
 {
   "source": {
     "repo_url": "https://github.com/onfido/onfido-openapi-spec",
-    "short_sha": "54ce45f",
-    "long_sha": "54ce45f2138f044cc5cb40f6904dc7bc1a675be6",
-    "version": "v4.5.0"
+    "short_sha": "be823e7",
+    "long_sha": "be823e7815c93bfbfc3fb764c0548f57cb851fe9",
+    "version": "v4.6.0"
   },
-  "release": "v5.5.0"
+  "release": "v5.6.0"
 }

README.md

@@ -2,11 +2,18 @@
 
 The official Java library for integrating with the Onfido API.
 
-Documentation can be found at <https://documentation.onfido.com>.
+Documentation is available at <https://documentation.onfido.com>.
 
-This library is only for use on the backend, as it uses Onfido API tokens which must be kept secret. If you do need to collect applicant data in the frontend of your application, we recommend that you use the Onfido SDKs: [iOS](https://github.com/onfido/onfido-ios-sdk), [Android](https://github.com/onfido/onfido-android-sdk), [Web](https://github.com/onfido/onfido-sdk-ui), and [React Native](https://github.com/onfido/react-native-sdk).
+This library is for backend use only, as it requires secret Onfido API tokens and should not be used in the frontend due to security reasons.
 
-This version uses Onfido API v3.6. Refer to our [API versioning guide](https://developers.onfido.com/guide/api-versioning-policy#client-libraries) for details of which client library versions use which versions of the API.
+If you need to collect applicant data in the frontend of your application, we recommend that you use the Onfido SDKs:
+
+- [iOS](https://github.com/onfido/onfido-ios-sdk)
+- [Android](https://github.com/onfido/onfido-android-sdk)
+- [Web](https://github.com/onfido/onfido-sdk-ui)
+- [React Native](https://github.com/onfido/react-native-sdk)
+
+This version uses Onfido API v3.6. Refer to our [API versioning guide](https://developers.onfido.com/guide/api-versioning-policy#client-libraries) for details. The guide explains which client library versions use which API versions.
 
 ![Build Status](https://github.com/onfido/onfido-java/actions/workflows/maven.yml/badge.svg)
 
@@ -33,7 +40,7 @@ To deploy it to a remote Maven repository instead, configure the settings of the
 mvn clean deploy
 ```
 
-Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
+Refer to the [OSSRH Guide](https://central.sonatype.org/publish/publish-guide) for more information.
 
 #### Maven users
 
@@ -43,7 +50,7 @@ Add this dependency to your project's POM:
 <dependency>
   <groupId>com.onfido</groupId>
   <artifactId>onfido-api-java</artifactId>
-  <version>5.5.0</version>
+  <version>5.6.0</version>
   <scope>compile</scope>
 </dependency>
 ```
@@ -59,7 +66,7 @@ Add this dependency to your project's build file:
   }
 
   dependencies {
-     implementation "com.onfido:onfido-api-java:5.5.0"
+     implementation "com.onfido:onfido-api-java:5.6.0"
   }
 ```
 
@@ -73,10 +80,10 @@ mvn clean package
 
 Then manually install the following JARs:
 
-- `target/onfido-api-java-5.5.0.jar`
+- `target/onfido-api-java-5.6.0.jar`
 - `target/lib/*.jar`
 
-The latest version can be found at: https://search.maven.org/artifact/com.onfido/5.5.0
+The latest version can be found at <https://search.maven.org/artifact/com.onfido/onfido-api-java/5.6.0/jar>.
 
 ## Getting Started
 
@@ -98,10 +105,11 @@ DefaultApi onfido = new DefaultApi(Configuration.getDefaultApiClient()
                       .setApiToken(System.getenv("ONFIDO_API_TOKEN"))
                       .setRegion(Region.EU)     // Supports `EU`, `US` and `CA`
                       .setConnectTimeout(60_000)
-                      .setReadTimeout(60_000));
+                      .setReadTimeout(60_000)
+                      .setProxy(new Proxy(Proxy.Type.HTTP, new InetSocketAddress(host, port))));   // Optionally define a connection proxy with the specified host and port
 ```
 
-NB: by default, timeout values are set to 30 seconds.
+NB: By default, the connection and read timeout values are set to 30 seconds. You can adjust these values as shown in the configuration section.
 
 ### Making a call to the API
 
@@ -111,7 +119,7 @@ Most of the request bodies can be created using a builder pattern, this would lo
 new ApplicantBuilder().firstName("First").lastName("Last");
 ```
 
-The above will return an `Applicant.Request` object that can be provided to the `create()` method as the request body, so a full call to to the API will look something like:
+The above will return an `ApplicantBuilder` object that can be provided to the `createApplicant()` method as the request body, a full call to the API will look something like:
 
 ```java
 try {
@@ -136,7 +144,7 @@ try {
 
 ### Webhook event verification
 
-Webhook events payload needs to be verified before it can be accessed. Library allows to easily decode the payload and verify its signature before returning it as an object for user convenience:
+Webhook events payload needs to be verified before it can be accessed. Verifying webhook payloads is crucial for security reasons, as it ensures that the payloads are indeed from Onfido and have not been tampered with. The library allows you to easily decode the payload and verify its signature before returning it as an object for user convenience:
 
 ```java
 try {
@@ -156,45 +164,47 @@ try {
 
 ### Don't share DefaultApi among different threads
 
-It's recommended to create an instance of `DefaultApi` per thread in a multithreaded environment to avoid any potential issues.
+It's recommended to create an instance of `DefaultApi` per thread in a multithreaded environment to avoid potential issues.
 
 #### Do not use additional properties
 
-Retain from using `getAdditionalProperty()` or `getAdditionalProperties()` methods to access not defined properties to avoid breaking changes when these fields will appear.
+Except for retrieving Task object's outputs, avoid using `getAdditionalProperty()` or `getAdditionalProperties()` methods to access undefined properties to prevent breaking changes when these fields appear.
 
 ## Contributing
 
-This library is automatically generated using [OpenAPI Generator](https://openapi-generator.tech) (version: 7.9.0); therefore all the contributions, except tests files, should target [Onfido OpenAPI specification repository](https://github.com/onfido/onfido-openapi-spec/tree/master) instead of this repository.
+This library is automatically generated using [OpenAPI Generator](https://openapi-generator.tech) (version: 7.9.0); therefore, all contributions (except test files) should target the [Onfido OpenAPI specification repository](https://github.com/onfido/onfido-openapi-spec/tree/master) instead of this repository. Please follow the contribution guidelines provided in the OpenAPI specification repository.
 
 For contributions to the tests instead, please follow the steps below:
 
-1. [Fork](https://github.com/onfido/onfido-java/fork) repository
+1. Fork the [repository](https://github.com/onfido/onfido-java/fork)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Make your changes
-4. Commit your changes (`git commit -am 'Add some feature'`)
+4. Commit your changes (`git commit -am 'Add detailed description of the feature'`)
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create a new Pull Request
 
 ## Versioning policy
 
-[Semantic Versioning](https://semver.org) policy is used for library versioning, following guidelines and limitations below:
+Versioning helps manage changes and ensures compatibility across different versions of the library.
+
+[Semantic Versioning](https://semver.org) policy is used for library versioning, following the guidelines and limitations outlined below:
 
-- MAJOR versions (x.0.0) might:
+- MAJOR versions (x.0.0) may:
   - target a new API version
   - include non-backward compatible change
-- MINOR versions (0.x.0) might:
+- MINOR versions (0.x.0) may:
   - add a new functionality, non-mandatory parameter or property
   - deprecate an old functionality
   - include non-backward compatible change to a functionality which is:
     - labelled as alpha or beta
     - completely broken and not usable
-- PATCH version (0.0.x) might:
+- PATCH version (0.0.x) will:
   - fix a bug
   - include backward compatible changes only
 
 ## More documentation
 
-More documentation and code examples can be found at <https://documentation.onfido.com>.
+Additional documentation and code examples can be found at <https://documentation.onfido.com>.
 
 ## Support
 

build.gradle

@@ -4,7 +4,7 @@ apply plugin: 'java'
 apply plugin: 'com.diffplug.spotless'
 
 group = 'com.onfido'
-version = '5.5.0'
+version = '5.6.0'
 
 buildscript {
     repositories {

build.sbt

@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
   settings(
     organization := "com.onfido",
     name := "onfido-api-java",
-    version := "5.5.0",
+    version := "5.6.0",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     javacOptions in compile ++= Seq("-Xlint:deprecation"),

pom.xml

@@ -5,7 +5,7 @@
     <artifactId>onfido-api-java</artifactId>
     <packaging>jar</packaging>
     <name>onfido-api-java</name>
-    <version>5.5.0</version>
+    <version>5.6.0</version>
     <url>https://documentation.onfido.com</url>
     <description>Official Java API client library for the Onfido API</description>
     <scm>

src/main/java/com/onfido/ApiClient.java

@@ -50,6 +50,7 @@
 import java.util.function.Supplier;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
+import java.net.Proxy;
 
 import com.onfido.auth.Authentication;
 import com.onfido.auth.HttpBasicAuth;
@@ -160,7 +161,7 @@ private void init() {
         json = new JSON();
 
         // Set default User-Agent.
-        setUserAgent("onfido-java/5.5.0");
+        setUserAgent("onfido-java/5.6.0");
 
         authentications = new HashMap<String, Authentication>();
     }
@@ -406,12 +407,24 @@ protected void setApiKey(String apiKey) {
 
 
 
+    /**
+     * Sets the Api Token.
+     *
+     * @param apiToken a String with the api token
+     * @return Api client
+     */
     public ApiClient setApiToken(String apiToken) {
         this.setApiKey("Token token=" + apiToken);
 
         return this;
     }
 
+    /**
+     * Sets the region.
+     *
+     * @param region a Region enum value
+     * @return Api client
+     */
     public ApiClient setRegion(Region region) {
         Map<String, String> serverVariables = getServerVariables();
 
@@ -425,6 +438,27 @@ public ApiClient setRegion(Region region) {
         return this;
     }
 
+    /**
+     * Return the HTTP proxy used by connections.
+     *
+     * @return Proxy
+     */
+    public Proxy getProxy() {
+        return httpClient.proxy();
+    }
+
+    /**
+     * Sets the HTTP proxy that will be used by connections.
+     *
+     * @param proxy a Proxy object
+     * @return Api client
+     */
+    public ApiClient setProxy(Proxy proxy) {
+        httpClient = httpClient.newBuilder().proxy(proxy).build();
+        return this;
+    }
+
+
     /**
      * Helper method to set access token for the first OAuth2 authentication.
      *

src/main/java/com/onfido/Configuration.java

@@ -15,7 +15,7 @@
 
 @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.9.0")
 public class Configuration {
-    public static final String VERSION = "5.5.0";
+    public static final String VERSION = "5.6.0";
 
     private static ApiClient defaultApiClient = new ApiClient();
 

src/main/java/com/onfido/model/IdNumber.java

@@ -63,6 +63,8 @@ public enum TypeEnum {
 
     IDENTITY_CARD("identity_card"),
 
+    DRIVING_LICENSE("driving_license"),
+    
     DRIVING_LICENCE("driving_licence"),
 
     SHARE_CODE("share_code"),

src/main/java/com/onfido/model/WebhookEventPayloadResource.java

@@ -117,6 +117,10 @@ public class WebhookEventPayloadResource {
   @SerializedName(SERIALIZED_NAME_ERROR)
   private WorkflowRunError error;
 
+  public static final String SERIALIZED_NAME_CUSTOMER_USER_ID = "customer_user_id";
+  @SerializedName(SERIALIZED_NAME_CUSTOMER_USER_ID)
+  private String customerUserId;
+
   public WebhookEventPayloadResource() {
   }
 
@@ -412,6 +416,25 @@ public void setError(WorkflowRunError error) {
     this.error = error;
   }
 
+
+  public WebhookEventPayloadResource 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;
+  }
+
   /**
    * A container for additional, undeclared properties.
    * This is a holder for any undeclared properties as specified with
@@ -481,7 +504,8 @@ public boolean equals(Object o) {
         Objects.equals(this.output, webhookEventPayloadResource.output) &&
         Objects.equals(this.reasons, webhookEventPayloadResource.reasons) &&
         Objects.equals(this.link, webhookEventPayloadResource.link) &&
-        Objects.equals(this.error, webhookEventPayloadResource.error)&&
+        Objects.equals(this.error, webhookEventPayloadResource.error) &&
+        Objects.equals(this.customerUserId, webhookEventPayloadResource.customerUserId)&&
         Objects.equals(this.additionalProperties, webhookEventPayloadResource.additionalProperties);
   }
 
@@ -491,7 +515,7 @@ private static <T> boolean equalsNullable(JsonNullable<T> a, JsonNullable<T> b)
 
   @Override
   public int hashCode() {
-    return Objects.hash(id, applicantId, createdAt, updatedAt, dashboardUrl, workflowId, workflowRunId, workflowVersionId, taskDefId, taskDefVersion, input, output, reasons, link, error, additionalProperties);
+    return Objects.hash(id, applicantId, createdAt, updatedAt, dashboardUrl, workflowId, workflowRunId, workflowVersionId, taskDefId, taskDefVersion, input, output, reasons, link, error, customerUserId, additionalProperties);
   }
 
   private static <T> int hashCodeNullable(JsonNullable<T> a) {
@@ -520,6 +544,7 @@ public String toString() {
     sb.append("    reasons: ").append(toIndentedString(reasons)).append("\n");
     sb.append("    link: ").append(toIndentedString(link)).append("\n");
     sb.append("    error: ").append(toIndentedString(error)).append("\n");
+    sb.append("    customerUserId: ").append(toIndentedString(customerUserId)).append("\n");
     sb.append("    additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n");
     sb.append("}");
     return sb.toString();
@@ -558,6 +583,7 @@ private String toIndentedString(Object o) {
     openapiFields.add("reasons");
     openapiFields.add("link");
     openapiFields.add("error");
+    openapiFields.add("customer_user_id");
 
     // a set of required properties/fields (JSON key names)
     openapiRequiredFields = new HashSet<String>();
@@ -609,6 +635,9 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti
       if (jsonObj.get("error") != null && !jsonObj.get("error").isJsonNull()) {
         WorkflowRunError.validateJsonElement(jsonObj.get("error"));
       }
+      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()));
+      }
   }
 
   public static class CustomTypeAdapterFactory implements TypeAdapterFactory {

src/test/java/com/onfido/OnfidoTest.java

@@ -5,6 +5,8 @@
 
 import com.onfido.ApiClient.Region;
 import com.onfido.api.DefaultApi;
+import java.net.InetSocketAddress;
+import java.net.Proxy;
 import java.util.UUID;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.BeforeEach;
@@ -73,4 +75,12 @@ public void usesCARegionApiUrl() {
 
     Assertions.assertEquals("https://api.ca.onfido.com/v3.6", url);
   }
+
+  @Test()
+  public void usesProxy() {
+    Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress("localhost", 3128));
+    DefaultApi onfido = new DefaultApi(apiClient.setApiToken("token").setProxy(proxy));
+
+    Assertions.assertEquals(proxy, onfido.getApiClient().getProxy());
+  }
 }