fix: update OpenAPI Schema with auxiliaryMobile method for VPN signal

fingerprintjs · Sep 19, 2023 · 15ca8db · 15ca8db
1 parent 9fd2591
commit 15ca8db
Show file tree

Hide file tree

Showing 6 changed files with 50 additions and 8 deletions.
diff --git a/docs/VpnResult.md b/docs/VpnResult.md
@@ -7,7 +7,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**result** | **Boolean** | VPN or other anonymising service has been used when sending the request. |  [optional] |
+|**result** | **Boolean** | VPN or other anonymizing service has been used when sending the request. |  [optional] |
 |**methods** | [**VpnResultMethods**](VpnResultMethods.md) |  |  [optional] |
 
 

diff --git a/docs/VpnResultMethods.md b/docs/VpnResultMethods.md
@@ -9,6 +9,7 @@
 |------------ | ------------- | ------------- | -------------|
 |**timezoneMismatch** | **Boolean** | User's browser timezone doesn't match the timezone from which the request was originally made. |  [optional] |
 |**publicVPN** | **Boolean** | Request IP address is owned and used by a public VPN service provider. |  [optional] |
+|**auxiliaryMobile** | **Boolean** | This method applies to mobile devices only. Indicates the result of additional methods used to detect a VPN in mobile devices. |  [optional] |
 
 
 
diff --git a/res/fingerprint-server-api.yaml b/res/fingerprint-server-api.yaml
@@ -185,6 +185,7 @@ paths:
                           methods:
                             timezoneMismatch: false
                             publicVPN: false
+                            auxiliaryMobile: false
                       proxy:
                         data:
                           result: false
@@ -3812,6 +3813,7 @@ paths:
                           methods:
                             timezoneMismatch: false
                             publicVPN: false
+                            auxiliaryMobile: false
                         proxy:
                           result: false
                         tampering:
@@ -4970,7 +4972,7 @@ components:
         result:
           type: boolean
           description: >-
-            VPN or other anonymising service has been used when sending the
+            VPN or other anonymizing service has been used when sending the
             request.
           example: false
         methods:
@@ -4988,6 +4990,12 @@ components:
                 Request IP address is owned and used by a public VPN service
                 provider.
               example: false
+            auxiliaryMobile:
+              type: boolean
+              description: >-
+                This method applies to mobile devices only. Indicates the result
+                of additional methods used to detect a VPN in mobile devices.
+              example: false
     TamperingResult:
       type: object
       properties:

diff --git a/src/main/java/com/fingerprint/model/VpnResult.java b/src/main/java/com/fingerprint/model/VpnResult.java
@@ -53,11 +53,11 @@ public VpnResult result(Boolean result) {
   }
 
    /**
-   * VPN or other anonymising service has been used when sending the request.
+   * VPN or other anonymizing service has been used when sending the request.
    * @return result
   **/
   @javax.annotation.Nullable
-  @ApiModelProperty(example = "false", value = "VPN or other anonymising service has been used when sending the request.")
+  @ApiModelProperty(example = "false", value = "VPN or other anonymizing service has been used when sending the request.")
   @JsonProperty(JSON_PROPERTY_RESULT)
   @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
 

diff --git a/src/main/java/com/fingerprint/model/VpnResultMethods.java b/src/main/java/com/fingerprint/model/VpnResultMethods.java
@@ -33,7 +33,8 @@
  */
 @JsonPropertyOrder({
   VpnResultMethods.JSON_PROPERTY_TIMEZONE_MISMATCH,
-  VpnResultMethods.JSON_PROPERTY_PUBLIC_V_P_N
+  VpnResultMethods.JSON_PROPERTY_PUBLIC_V_P_N,
+  VpnResultMethods.JSON_PROPERTY_AUXILIARY_MOBILE
 })
 @JsonTypeName("VpnResult_methods")
 @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
@@ -44,6 +45,9 @@ public class VpnResultMethods {
   public static final String JSON_PROPERTY_PUBLIC_V_P_N = "publicVPN";
   private Boolean publicVPN;
 
+  public static final String JSON_PROPERTY_AUXILIARY_MOBILE = "auxiliaryMobile";
+  private Boolean auxiliaryMobile;
+
   public VpnResultMethods() { 
   }
 
@@ -99,6 +103,32 @@ public void setPublicVPN(Boolean publicVPN) {
   }
 
 
+  public VpnResultMethods auxiliaryMobile(Boolean auxiliaryMobile) {
+    this.auxiliaryMobile = auxiliaryMobile;
+    return this;
+  }
+
+   /**
+   * This method applies to mobile devices only. Indicates the result of additional methods used to detect a VPN in mobile devices.
+   * @return auxiliaryMobile
+  **/
+  @javax.annotation.Nullable
+  @ApiModelProperty(example = "false", value = "This method applies to mobile devices only. Indicates the result of additional methods used to detect a VPN in mobile devices.")
+  @JsonProperty(JSON_PROPERTY_AUXILIARY_MOBILE)
+  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+
+  public Boolean getAuxiliaryMobile() {
+    return auxiliaryMobile;
+  }
+
+
+  @JsonProperty(JSON_PROPERTY_AUXILIARY_MOBILE)
+  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+  public void setAuxiliaryMobile(Boolean auxiliaryMobile) {
+    this.auxiliaryMobile = auxiliaryMobile;
+  }
+
+
   /**
    * Return true if this VpnResult_methods object is equal to o.
    */
@@ -112,12 +142,13 @@ public boolean equals(Object o) {
     }
     VpnResultMethods vpnResultMethods = (VpnResultMethods) o;
     return Objects.equals(this.timezoneMismatch, vpnResultMethods.timezoneMismatch) &&
-        Objects.equals(this.publicVPN, vpnResultMethods.publicVPN);
+        Objects.equals(this.publicVPN, vpnResultMethods.publicVPN) &&
+        Objects.equals(this.auxiliaryMobile, vpnResultMethods.auxiliaryMobile);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(timezoneMismatch, publicVPN);
+    return Objects.hash(timezoneMismatch, publicVPN, auxiliaryMobile);
   }
 
   @Override
@@ -126,6 +157,7 @@ public String toString() {
     sb.append("class VpnResultMethods {\n");
     sb.append("    timezoneMismatch: ").append(toIndentedString(timezoneMismatch)).append("\n");
     sb.append("    publicVPN: ").append(toIndentedString(publicVPN)).append("\n");
+    sb.append("    auxiliaryMobile: ").append(toIndentedString(auxiliaryMobile)).append("\n");
     sb.append("}");
     return sb.toString();
   }

diff --git a/src/test/resources/mocks/get_event.json b/src/test/resources/mocks/get_event.json
@@ -141,7 +141,8 @@
         "result": false,
         "methods": {
           "timezoneMismatch": false,
-          "publicVPN": false
+          "publicVPN": false,
+          "auxiliaryMobile": false
         }
       }
     },