refactor: use new package structure for v4 server API

.changeset/twelve-games-turn.md

@@ -0,0 +1,5 @@
+---
+"java-sdk": patch
+---
+
+Change root package from `com.fingerprint` to `com.fingerprint.v4`

.changeset/weak-eagles-deliver.md

@@ -8,6 +8,7 @@ Migrate to Server API v4
 
 - SDK version bumped to `8.0.0`
 - Server API version upgraded from v3 to v4
+- Changed root package for the SDK from `com.fingerprint` to `com.fingerprint.v4`
 - Removed `GetVisits` and `GetRelatedVisitors` operations.
 - Improved models used by the `GetEvent` and `SearchEvents` operations to use a more concise shape and clearer names.
 

.openapi-generator-ignore

@@ -2,8 +2,8 @@
 build.sbt
 git_push.sh
 api/*
-src/test/java/com/fingerprint/model/*
-src/main/java/com/fingerprint/model/AbstractOpenApiSchema.java
+src/test/java/com/fingerprint/v4/model/*
+src/main/java/com/fingerprint/v4/model/AbstractOpenApiSchema.java
 src/main/AndroidManifest.xml
 .github/workflows/maven.yml
 pom.xml

README.md

@@ -109,14 +109,14 @@ Please follow the [installation](#installation) instruction and execute the foll
 ```java
 package main;
 
-import com.fingerprint.api.FingerprintApi;
-import com.fingerprint.model.Events;
-import com.fingerprint.model.UpdateEvents;
-import com.fingerprint.model.VisitorsGetResponse;
-import com.fingerprint.sdk.ApiClient;
-import com.fingerprint.sdk.ApiException;
-import com.fingerprint.sdk.Configuration;
-import com.fingerprint.sdk.Region;
+import com.fingerprint.v4.api.FingerprintApi;
+import com.fingerprint.v4.model.Events;
+import com.fingerprint.v4.model.UpdateEvents;
+import com.fingerprint.v4.model.VisitorsGetResponse;
+import com.fingerprint.v4.sdk.ApiClient;
+import com.fingerprint.v4.sdk.ApiException;
+import com.fingerprint.v4.sdk.Configuration;
+import com.fingerprint.v4.sdk.Region;
 
 public class FingerprintApiExample {
     // Fingerprint Secret API Key
@@ -191,10 +191,10 @@ public class FingerprintApiExample {
 
 This SDK provides utility methods for decoding [sealed results](https://dev.fingerprint.com/docs/sealed-client-results).
 ```java
-package com.fingerprint.example;
+package com.fingerprint.v4.example;
 
-import com.fingerprint.Sealed;
-import com.fingerprint.model.EventsGetResponse;
+import com.fingerprint.v4.Sealed;
+import com.fingerprint.v4.model.EventsGetResponse;
 
 import java.util.Base64;
 
@@ -229,7 +229,7 @@ This SDK provides utility method for verifying the HMAC signature of the incomin
 
 Here is an example implementation using Spring Boot:
 ```java
-import com.fingerprint.sdk.WebhookValidation;
+import com.fingerprint.v4.sdk.WebhookValidation;
 
 @RestController
 class WebhookController {

build.gradle.kts

@@ -1,7 +1,7 @@
 val projectVersion: String by project
 
 allprojects {
-    group = "com.fingerprint"
+    group = "com.github.fingerprintjs"
     version = projectVersion
 }
 

docs/FingerprintApi.md

@@ -47,11 +47,11 @@ Please [contact our support team](https://fingerprint.com/support/) to enable it
 ```java
 package main;
 
-import com.fingerprint.api.FingerprintApi;
-import com.fingerprint.sdk.model.*;
-import com.fingerprint.sdk.ApiClient;
-import com.fingerprint.sdk.ApiException;
-import com.fingerprint.sdk.Region;
+import com.fingerprint.v4.api.FingerprintApi;
+import com.fingerprint.v4.sdk.model.*;
+import com.fingerprint.v4.sdk.ApiClient;
+import com.fingerprint.v4.sdk.ApiException;
+import com.fingerprint.v4.sdk.Region;
 
 public class FingerprintApiExample {
     // Fingerprint Secret API Key
@@ -124,11 +124,11 @@ Use `event_id` as the URL path parameter. This API method is scoped to a request
 ```java
 package main;
 
-import com.fingerprint.api.FingerprintApi;
-import com.fingerprint.sdk.model.*;
-import com.fingerprint.sdk.ApiClient;
-import com.fingerprint.sdk.ApiException;
-import com.fingerprint.sdk.Region;
+import com.fingerprint.v4.api.FingerprintApi;
+import com.fingerprint.v4.sdk.model.*;
+import com.fingerprint.v4.sdk.ApiClient;
+import com.fingerprint.v4.sdk.ApiException;
+import com.fingerprint.v4.sdk.Region;
 
 public class FingerprintApiExample {
     // Fingerprint Secret API Key
@@ -232,11 +232,11 @@ Smart Signals not activated for your workspace or are not included in the respon
 ```java
 package main;
 
-import com.fingerprint.api.FingerprintApi;
-import com.fingerprint.sdk.model.*;
-import com.fingerprint.sdk.ApiClient;
-import com.fingerprint.sdk.ApiException;
-import com.fingerprint.sdk.Region;
+import com.fingerprint.v4.api.FingerprintApi;
+import com.fingerprint.v4.sdk.model.*;
+import com.fingerprint.v4.sdk.ApiClient;
+import com.fingerprint.v4.sdk.ApiException;
+import com.fingerprint.v4.sdk.Region;
 
 public class FingerprintApiExample {
     // Fingerprint Secret API Key
@@ -438,11 +438,11 @@ error (HTTP 409 Conflict. The event is not mutable yet.) as the event is fully p
 ```java
 package main;
 
-import com.fingerprint.api.FingerprintApi;
-import com.fingerprint.sdk.model.*;
-import com.fingerprint.sdk.ApiClient;
-import com.fingerprint.sdk.ApiException;
-import com.fingerprint.sdk.Region;
+import com.fingerprint.v4.api.FingerprintApi;
+import com.fingerprint.v4.sdk.model.*;
+import com.fingerprint.v4.sdk.ApiClient;
+import com.fingerprint.v4.sdk.ApiException;
+import com.fingerprint.v4.sdk.Region;
 
 public class FingerprintApiExample {
     // Fingerprint Secret API Key

examples/src/main/java/com/fingerprint/example/FunctionalTests.java

@@ -1,9 +1,9 @@
 package com.fingerprint.example;
 
-import com.fingerprint.api.FingerprintApi;
-import com.fingerprint.model.*;
-import com.fingerprint.sdk.ApiException;
-import com.fingerprint.sdk.Configuration;
+import com.fingerprint.v4.api.FingerprintApi;
+import com.fingerprint.v4.model.*;
+import com.fingerprint.v4.sdk.ApiException;
+import com.fingerprint.v4.sdk.Configuration;
 
 import java.sql.Timestamp;
 import java.time.Instant;

examples/src/main/java/com/fingerprint/example/SealedResults.java

@@ -1,7 +1,7 @@
 package com.fingerprint.example;
 
-import com.fingerprint.Sealed;
-import com.fingerprint.model.Event;
+import com.fingerprint.v4.model.Event;
+import com.fingerprint.v4.Sealed;
 
 import java.util.Base64;
 

examples/src/main/java/com/fingerprint/example/WebhookSignatureSample.java

@@ -1,6 +1,6 @@
 package com.fingerprint.example;
 
-import com.fingerprint.sdk.WebhookValidation;
+import com.fingerprint.v4.sdk.WebhookValidation;
 
 import java.nio.charset.StandardCharsets;
 import java.security.NoSuchAlgorithmException;

sdk/sdk.gradle.kts

@@ -55,12 +55,12 @@ openApiGenerate {
     generatorName.set("java")
     inputSpec.set("$rootDir/res/fingerprint-server-api.yaml")
     outputDir.set(layout.buildDirectory.dir("generated").get().asFile.path)
-    groupId.set("com.fingerprint")
+    groupId.set("com.github.fingerprintjs")
     id.set("java-sdk")
     version.set(projectVersion)
-    apiPackage.set("com.fingerprint.api")
-    modelPackage.set("com.fingerprint.model")
-    invokerPackage.set("com.fingerprint.sdk")
+    apiPackage.set("com.fingerprint.v4.api")
+    modelPackage.set("com.fingerprint.v4.model")
+    invokerPackage.set("com.fingerprint.v4.sdk")
     library.set("jersey3")
     templateDir.set("$rootDir/template")
 
@@ -85,8 +85,8 @@ tasks.register("removeDocs") {
 
 tasks.register("removeClasses") {
     doLast {
-        File("$rootDir/sdk/src/main/java/com/fingerprint/model").deleteRecursively()
-        File("$rootDir/sdk/src/main/java/com/fingerprint/api").deleteRecursively()
+        File("$rootDir/sdk/src/main/java/com/fingerprint/v4/model").deleteRecursively()
+        File("$rootDir/sdk/src/main/java/com/fingerprint/v4/api").deleteRecursively()
     }
 }
 

sdk/src/main/java/com/fingerprint/Sealed.java → sdk/src/main/java/com/fingerprint/v4/Sealed.java

@@ -1,8 +1,8 @@
-package com.fingerprint;
+package com.fingerprint.v4;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fingerprint.model.Event;
-import com.fingerprint.sdk.JSON;
+import com.fingerprint.v4.model.Event;
+import com.fingerprint.v4.sdk.JSON;
 
 import javax.crypto.Cipher;
 import javax.crypto.spec.GCMParameterSpec;

sdk/src/main/java/com/fingerprint/api/FingerprintApi.java → sdk/src/main/java/com/fingerprint/v4/api/FingerprintApi.java

@@ -1,21 +1,21 @@
-package com.fingerprint.api;
+package com.fingerprint.v4.api;
 
-import com.fingerprint.sdk.ApiException;
-import com.fingerprint.sdk.ApiClient;
-import com.fingerprint.sdk.ApiResponse;
-import com.fingerprint.sdk.Configuration;
-import com.fingerprint.sdk.Pair;
-import com.fingerprint.sdk.Region;
+import com.fingerprint.v4.sdk.ApiException;
+import com.fingerprint.v4.sdk.ApiClient;
+import com.fingerprint.v4.sdk.ApiResponse;
+import com.fingerprint.v4.sdk.Configuration;
+import com.fingerprint.v4.sdk.Pair;
+import com.fingerprint.v4.sdk.Region;
 
 import jakarta.ws.rs.core.GenericType;
 
-import com.fingerprint.model.ErrorResponse;
-import com.fingerprint.model.Event;
-import com.fingerprint.model.EventSearch;
-import com.fingerprint.model.EventUpdate;
-import com.fingerprint.model.SearchEventsBot;
-import com.fingerprint.model.SearchEventsSdkPlatform;
-import com.fingerprint.model.SearchEventsVpnConfidence;
+import com.fingerprint.v4.model.ErrorResponse;
+import com.fingerprint.v4.model.Event;
+import com.fingerprint.v4.model.EventSearch;
+import com.fingerprint.v4.model.EventUpdate;
+import com.fingerprint.v4.model.SearchEventsBot;
+import com.fingerprint.v4.model.SearchEventsSdkPlatform;
+import com.fingerprint.v4.model.SearchEventsVpnConfidence;
 
 import java.util.ArrayList;
 import java.util.HashMap;

sdk/src/main/java/com/fingerprint/model/BotInfo.java → sdk/src/main/java/com/fingerprint/v4/model/BotInfo.java

@@ -11,7 +11,7 @@
  */
 
 
-package com.fingerprint.model;
+package com.fingerprint.v4.model;
 
 import java.util.Objects;
 import java.util.Map;
@@ -24,7 +24,7 @@
 import com.fasterxml.jackson.annotation.JsonValue;
 import java.util.Arrays;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
-import com.fingerprint.sdk.JSON;
+import com.fingerprint.v4.sdk.JSON;
 
 
 /**

sdk/src/main/java/com/fingerprint/model/BotResult.java → sdk/src/main/java/com/fingerprint/v4/model/BotResult.java

@@ -11,14 +11,14 @@
  */
 
 
-package com.fingerprint.model;
+package com.fingerprint.v4.model;
 
 import java.util.Objects;
 import java.util.Map;
 import java.util.HashMap;
 import java.util.Locale;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
-import com.fingerprint.sdk.JSON;
+import com.fingerprint.v4.sdk.JSON;
 
 
 import com.fasterxml.jackson.annotation.JsonCreator;

sdk/src/main/java/com/fingerprint/model/BrowserDetails.java → sdk/src/main/java/com/fingerprint/v4/model/BrowserDetails.java

@@ -11,7 +11,7 @@
  */
 
 
-package com.fingerprint.model;
+package com.fingerprint.v4.model;
 
 import java.util.Objects;
 import java.util.Map;
@@ -24,7 +24,7 @@
 import com.fasterxml.jackson.annotation.JsonValue;
 import java.util.Arrays;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
-import com.fingerprint.sdk.JSON;
+import com.fingerprint.v4.sdk.JSON;
 
 
 /**

sdk/src/main/java/com/fingerprint/model/Canvas.java → sdk/src/main/java/com/fingerprint/v4/model/Canvas.java

@@ -11,7 +11,7 @@
  */
 
 
-package com.fingerprint.model;
+package com.fingerprint.v4.model;
 
 import java.util.Objects;
 import java.util.Map;
@@ -24,7 +24,7 @@
 import com.fasterxml.jackson.annotation.JsonValue;
 import java.util.Arrays;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
-import com.fingerprint.sdk.JSON;
+import com.fingerprint.v4.sdk.JSON;
 
 
 /**

sdk/src/main/java/com/fingerprint/model/Emoji.java → sdk/src/main/java/com/fingerprint/v4/model/Emoji.java

@@ -11,7 +11,7 @@
  */
 
 
-package com.fingerprint.model;
+package com.fingerprint.v4.model;
 
 import java.util.Objects;
 import java.util.Map;
@@ -24,7 +24,7 @@
 import com.fasterxml.jackson.annotation.JsonValue;
 import java.util.Arrays;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
-import com.fingerprint.sdk.JSON;
+import com.fingerprint.v4.sdk.JSON;
 
 
 /**

sdk/src/main/java/com/fingerprint/model/Error.java → sdk/src/main/java/com/fingerprint/v4/model/Error.java

@@ -11,7 +11,7 @@
  */
 
 
-package com.fingerprint.model;
+package com.fingerprint.v4.model;
 
 import java.util.Objects;
 import java.util.Map;
@@ -22,10 +22,10 @@
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.fasterxml.jackson.annotation.JsonValue;
-import com.fingerprint.model.ErrorCode;
+import com.fingerprint.v4.model.ErrorCode;
 import java.util.Arrays;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
-import com.fingerprint.sdk.JSON;
+import com.fingerprint.v4.sdk.JSON;
 
 
 /**

sdk/src/main/java/com/fingerprint/model/ErrorCode.java → sdk/src/main/java/com/fingerprint/v4/model/ErrorCode.java

@@ -11,14 +11,14 @@
  */
 
 
-package com.fingerprint.model;
+package com.fingerprint.v4.model;
 
 import java.util.Objects;
 import java.util.Map;
 import java.util.HashMap;
 import java.util.Locale;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
-import com.fingerprint.sdk.JSON;
+import com.fingerprint.v4.sdk.JSON;
 
 
 import com.fasterxml.jackson.annotation.JsonCreator;