docs: replace old models EventResponse and Response with `EventsG…

…etResponse` and `VisitorsGetResponse` in docs
fingerprintjs · Oct 28, 2024 · 388f950 · 388f950
1 parent e505975
commit 388f950
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 14 deletions.
diff --git a/docs/FingerprintApi.md b/docs/FingerprintApi.md
@@ -49,8 +49,9 @@ Please [contact our support team](https://fingerprint.com/support/) to enable it
 package main;
 
 import com.fingerprint.api.FingerprintApi;
-import com.fingerprint.model.EventResponse;
-import com.fingerprint.model.Response;
+import com.fingerprint.model.EventsGetResponse;
+import com.fingerprint.model.EventsUpdateRequest;
+import com.fingerprint.model.VisitorsGetResponse;
 import com.fingerprint.sdk.ApiClient;
 import com.fingerprint.sdk.ApiException;
 import com.fingerprint.sdk.Configuration;
@@ -131,8 +132,9 @@ Use `requestId` as the URL path parameter. This API method is scoped to a reques
 package main;
 
 import com.fingerprint.api.FingerprintApi;
-import com.fingerprint.model.EventResponse;
-import com.fingerprint.model.Response;
+import com.fingerprint.model.EventsGetResponse;
+import com.fingerprint.model.EventsUpdateRequest;
+import com.fingerprint.model.VisitorsGetResponse;
 import com.fingerprint.sdk.ApiClient;
 import com.fingerprint.sdk.ApiException;
 import com.fingerprint.sdk.Configuration;
@@ -213,8 +215,9 @@ Only information from the _Identification_ product is returned.
 package main;
 
 import com.fingerprint.api.FingerprintApi;
-import com.fingerprint.model.EventResponse;
-import com.fingerprint.model.Response;
+import com.fingerprint.model.EventsGetResponse;
+import com.fingerprint.model.EventsUpdateRequest;
+import com.fingerprint.model.VisitorsGetResponse;
 import com.fingerprint.sdk.ApiClient;
 import com.fingerprint.sdk.ApiException;
 import com.fingerprint.sdk.Configuration;
@@ -305,8 +308,9 @@ When an event is created, it is assigned `linkedId` and `tag` submitted through
 package main;
 
 import com.fingerprint.api.FingerprintApi;
-import com.fingerprint.model.EventResponse;
-import com.fingerprint.model.Response;
+import com.fingerprint.model.EventsGetResponse;
+import com.fingerprint.model.EventsUpdateRequest;
+import com.fingerprint.model.VisitorsGetResponse;
 import com.fingerprint.sdk.ApiClient;
 import com.fingerprint.sdk.ApiException;
 import com.fingerprint.sdk.Configuration;
@@ -384,8 +388,9 @@ Fake path to describe webhook format. More information about webhooks can be fou
 package main;
 
 import com.fingerprint.api.FingerprintApi;
-import com.fingerprint.model.EventResponse;
-import com.fingerprint.model.Response;
+import com.fingerprint.model.EventsGetResponse;
+import com.fingerprint.model.EventsUpdateRequest;
+import com.fingerprint.model.VisitorsGetResponse;
 import com.fingerprint.sdk.ApiClient;
 import com.fingerprint.sdk.ApiException;
 import com.fingerprint.sdk.Configuration;

diff --git a/docs/Sealed.md b/docs/Sealed.md
@@ -1,7 +1,7 @@
 # Sealed
 
 ## **UnsealEventsResponse**
-> EventResponse unsealEventResponse(sealed []byte, keys DecryptionKey[])
+> EventsGetResponse unsealEventResponse(sealed []byte, keys DecryptionKey[])
 
 Decrypts the sealed response with provided keys.
 ### Required Parameters

diff --git a/sdk/src/main/java/com/fingerprint/Sealed.java b/sdk/src/main/java/com/fingerprint/Sealed.java
@@ -115,7 +115,7 @@ public static byte[] unseal(byte[] sealed, DecryptionKey[] keys) throws IllegalA
      *
      * @param sealed Base64 encoded sealed data
      * @param keys   Decryption keys. The SDK will try to decrypt the result with each key until it succeeds.
-     * @return EventResponse
+     * @return EventsGetResponse
      *
      * @throws IllegalArgumentException if invalid decryption algorithm is provided in any of the keys
      * @throws UnsealAggregateException if the sealed data cannot be decrypted with any of the keys. The exception contains the list of exceptions thrown by each key.

diff --git a/template/libraries/jersey3/api_doc.mustache b/template/libraries/jersey3/api_doc.mustache
@@ -31,8 +31,9 @@ All URIs are relative to *{{basePath}}*
 package main;
 
 import com.fingerprint.api.FingerprintApi;
-import com.fingerprint.model.EventResponse;
-import com.fingerprint.model.Response;
+import com.fingerprint.model.EventsGetResponse;
+import com.fingerprint.model.EventsUpdateRequest;
+import com.fingerprint.model.VisitorsGetResponse;
 import com.fingerprint.sdk.ApiClient;
 import com.fingerprint.sdk.ApiException;
 import com.fingerprint.sdk.Configuration;