feat: use shared structures for webhooks and event

BREAKING CHANGE: change models for the most smart signals
fingerprintjs · Feb 27, 2024 · 69bfd84 · 69bfd84
1 parent 1a7451b
commit 69bfd84
Show file tree

Hide file tree

Showing 83 changed files with 1,471 additions and 8,956 deletions.
diff --git a/README.md b/README.md
@@ -255,6 +255,7 @@ Class | Method | HTTP request | Description
  - [BotdDetectionResult](docs/BotdDetectionResult.md)
  - [BotdResult](docs/BotdResult.md)
  - [BrowserDetails](docs/BrowserDetails.md)
+ - [ClonedAppResult](docs/ClonedAppResult.md)
  - [Confidence](docs/Confidence.md)
  - [DataCenter](docs/DataCenter.md)
  - [DeprecatedIPLocation](docs/DeprecatedIPLocation.md)
@@ -267,71 +268,61 @@ Class | Method | HTTP request | Description
  - [ErrorEvent404ResponseError](docs/ErrorEvent404ResponseError.md)
  - [ErrorVisits403](docs/ErrorVisits403.md)
  - [EventResponse](docs/EventResponse.md)
+ - [FactoryResetResult](docs/FactoryResetResult.md)
+ - [FridaResult](docs/FridaResult.md)
  - [HighActivityResult](docs/HighActivityResult.md)
  - [IPLocation](docs/IPLocation.md)
  - [IPLocationCity](docs/IPLocationCity.md)
  - [IdentificationError](docs/IdentificationError.md)
+ - [IncognitoResult](docs/IncognitoResult.md)
  - [IpBlockListResult](docs/IpBlockListResult.md)
  - [IpBlockListResultDetails](docs/IpBlockListResultDetails.md)
  - [IpInfoResult](docs/IpInfoResult.md)
  - [IpInfoResultV4](docs/IpInfoResultV4.md)
  - [IpInfoResultV6](docs/IpInfoResultV6.md)
+ - [JailbrokenResult](docs/JailbrokenResult.md)
  - [Location](docs/Location.md)
  - [LocationSpoofingResult](docs/LocationSpoofingResult.md)
  - [ManyRequestsResponse](docs/ManyRequestsResponse.md)
+ - [PrivacySettingsResult](docs/PrivacySettingsResult.md)
  - [ProductError](docs/ProductError.md)
  - [ProductsResponse](docs/ProductsResponse.md)
  - [ProductsResponseBotd](docs/ProductsResponseBotd.md)
  - [ProductsResponseIdentification](docs/ProductsResponseIdentification.md)
  - [ProductsResponseIdentificationData](docs/ProductsResponseIdentificationData.md)
+ - [ProxyResult](docs/ProxyResult.md)
  - [RawDeviceAttributesResultValue](docs/RawDeviceAttributesResultValue.md)
  - [Response](docs/Response.md)
  - [ResponseVisits](docs/ResponseVisits.md)
+ - [RootAppsResult](docs/RootAppsResult.md)
  - [SeenAt](docs/SeenAt.md)
  - [SignalResponseClonedApp](docs/SignalResponseClonedApp.md)
- - [SignalResponseClonedAppData](docs/SignalResponseClonedAppData.md)
  - [SignalResponseEmulator](docs/SignalResponseEmulator.md)
- - [SignalResponseEmulatorData](docs/SignalResponseEmulatorData.md)
  - [SignalResponseFactoryReset](docs/SignalResponseFactoryReset.md)
- - [SignalResponseFactoryResetData](docs/SignalResponseFactoryResetData.md)
  - [SignalResponseFrida](docs/SignalResponseFrida.md)
- - [SignalResponseFridaData](docs/SignalResponseFridaData.md)
  - [SignalResponseHighActivity](docs/SignalResponseHighActivity.md)
  - [SignalResponseIncognito](docs/SignalResponseIncognito.md)
- - [SignalResponseIncognitoData](docs/SignalResponseIncognitoData.md)
  - [SignalResponseIpBlocklist](docs/SignalResponseIpBlocklist.md)
  - [SignalResponseIpInfo](docs/SignalResponseIpInfo.md)
  - [SignalResponseJailbroken](docs/SignalResponseJailbroken.md)
- - [SignalResponseJailbrokenData](docs/SignalResponseJailbrokenData.md)
  - [SignalResponseLocationSpoofing](docs/SignalResponseLocationSpoofing.md)
  - [SignalResponsePrivacySettings](docs/SignalResponsePrivacySettings.md)
- - [SignalResponsePrivacySettingsData](docs/SignalResponsePrivacySettingsData.md)
  - [SignalResponseProxy](docs/SignalResponseProxy.md)
- - [SignalResponseProxyData](docs/SignalResponseProxyData.md)
  - [SignalResponseRawDeviceAttributes](docs/SignalResponseRawDeviceAttributes.md)
  - [SignalResponseRootApps](docs/SignalResponseRootApps.md)
- - [SignalResponseRootAppsData](docs/SignalResponseRootAppsData.md)
+ - [SignalResponseSuspectScore](docs/SignalResponseSuspectScore.md)
  - [SignalResponseTampering](docs/SignalResponseTampering.md)
  - [SignalResponseTor](docs/SignalResponseTor.md)
- - [SignalResponseTorData](docs/SignalResponseTorData.md)
  - [SignalResponseVirtualMachine](docs/SignalResponseVirtualMachine.md)
- - [SignalResponseVirtualMachineData](docs/SignalResponseVirtualMachineData.md)
  - [SignalResponseVpn](docs/SignalResponseVpn.md)
  - [Subdivision](docs/Subdivision.md)
+ - [SuspectScoreResult](docs/SuspectScoreResult.md)
  - [TamperingResult](docs/TamperingResult.md)
+ - [TorResult](docs/TorResult.md)
+ - [VirtualMachineResult](docs/VirtualMachineResult.md)
  - [Visit](docs/Visit.md)
  - [VpnResult](docs/VpnResult.md)
  - [VpnResultMethods](docs/VpnResultMethods.md)
- - [WebhookSignalResponseClonedApp](docs/WebhookSignalResponseClonedApp.md)
- - [WebhookSignalResponseEmulator](docs/WebhookSignalResponseEmulator.md)
- - [WebhookSignalResponseFactoryReset](docs/WebhookSignalResponseFactoryReset.md)
- - [WebhookSignalResponseFrida](docs/WebhookSignalResponseFrida.md)
- - [WebhookSignalResponseJailbroken](docs/WebhookSignalResponseJailbroken.md)
- - [WebhookSignalResponsePrivacySettings](docs/WebhookSignalResponsePrivacySettings.md)
- - [WebhookSignalResponseProxy](docs/WebhookSignalResponseProxy.md)
- - [WebhookSignalResponseRootApps](docs/WebhookSignalResponseRootApps.md)
- - [WebhookSignalResponseTor](docs/WebhookSignalResponseTor.md)
- - [WebhookSignalResponseVirtualMachine](docs/WebhookSignalResponseVirtualMachine.md)
  - [WebhookVisit](docs/WebhookVisit.md)
 
 

diff --git a/docs/SignalResponseClonedAppData.md → docs/ClonedAppResult.md b/docs/SignalResponseClonedAppData.md → docs/ClonedAppResult.md
@@ -1,13 +1,13 @@
 
 
-# SignalResponseClonedAppData
+# ClonedAppResult
 
 
 ## Properties
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**result** | **Boolean** | Android specific cloned application detection. There are 2 values: • `true` - Presence of app cloners work detected (e.g. fully cloned application found or launch of it inside of a not main working profile detected). • `false` - No signs of cloned application detected or the client is not Android.  |  [optional] |
+|**result** | **Boolean** | Android specific cloned application detection. There are 2 values: • `true` - Presence of app cloners work detected (e.g. fully cloned application found or launch of it inside of a not main working profile detected). • `false` - No signs of cloned application detected or the client is not Android.  |  |
 
 
 
diff --git a/docs/SignalResponseEmulatorData.md → docs/EmulatorResult.md b/docs/SignalResponseEmulatorData.md → docs/EmulatorResult.md
@@ -1,13 +1,13 @@
 
 
-# SignalResponseEmulatorData
+# EmulatorResult
 
 
 ## Properties
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**result** | **Boolean** | Android specific emulator detection. There are 2 values: • `true` - Emulated environment detected (e.g. launch inside of AVD) • `false` - No signs of emulated environment detected or the client is not Android.  |  [optional] |
+|**result** | **Boolean** | Android specific emulator detection. There are 2 values: • `true` - Emulated environment detected (e.g. launch inside of AVD) • `false` - No signs of emulated environment detected or the client is not Android.  |  |
 
 
 
diff --git a/docs/FactoryResetResult.md b/docs/FactoryResetResult.md
@@ -0,0 +1,14 @@
+
+
+# FactoryResetResult
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**time** | **OffsetDateTime** | Time in UTC when the most recent factory reset of the Android or iOS device was done.  If there is no sign of factory reset or the client is not a mobile device, the field will contain the epoch time (1 January 1970) in UTC.  |  |
+|**timestamp** | **Long** | Same value as it's in the `time` field but represented in timestamp format. |  |
+
+
+
diff --git a/docs/FingerprintApi.md b/docs/FingerprintApi.md
@@ -17,7 +17,7 @@ All URIs are relative to *https://api.fpjs.io*
 Get event by requestId
 
 This endpoint allows you to get a detailed analysis of an individual request. 
-**Only for Enterprise customers:** Please note that the response includes mobile signals (e.g. `rootApps`) even if the request orignated from a non-mobile platform.
+**Only for Enterprise customers:** Please note that the response includes mobile signals (e.g. `rootApps`) even if the request originated from a non-mobile platform.
 It is highly recommended that you **ignore** the mobile signals for such requests. 
 
 Use `requestId` as the URL path parameter. This API method is scoped to a request, i.e. all returned information is by `requestId`.

diff --git a/docs/FridaResult.md b/docs/FridaResult.md
@@ -0,0 +1,13 @@
+
+
+# FridaResult
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**result** | **Boolean** | [Frida](https://frida.re/docs/) detection for Android and iOS devices. There are 2 values: • `true` - Frida detected • `false` - No signs of Frida or the client is not a mobile device.  |  |
+
+
+
diff --git a/docs/SignalResponseIncognitoData.md → docs/IncognitoResult.md b/docs/SignalResponseIncognitoData.md → docs/IncognitoResult.md
@@ -1,13 +1,13 @@
 
 
-# SignalResponseIncognitoData
+# IncognitoResult
 
 
 ## Properties
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**result** | **Boolean** | `true` if we detected incognito mode used in the browser, `false` otherwise.  |  [optional] |
+|**result** | **Boolean** | `true` if we detected incognito mode used in the browser, `false` otherwise.  |  |
 
 
 
diff --git a/docs/SignalResponseJailbrokenData.md → docs/JailbrokenResult.md b/docs/SignalResponseJailbrokenData.md → docs/JailbrokenResult.md
@@ -1,13 +1,13 @@
 
 
-# SignalResponseJailbrokenData
+# JailbrokenResult
 
 
 ## Properties
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**result** | **Boolean** | iOS specific jailbreak detection. There are 2 values: • `true` - Jailbreak detected • `false` - No signs of jailbreak or the client is not iOS.  |  [optional] |
+|**result** | **Boolean** | iOS specific jailbreak detection. There are 2 values: • `true` - Jailbreak detected • `false` - No signs of jailbreak or the client is not iOS.  |  |
 
 
 
diff --git a/docs/SignalResponsePrivacySettingsData.md → docs/PrivacySettingsResult.md b/docs/SignalResponsePrivacySettingsData.md → docs/PrivacySettingsResult.md
@@ -1,13 +1,13 @@
 
 
-# SignalResponsePrivacySettingsData
+# PrivacySettingsResult
 
 
 ## Properties
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**result** | **Boolean** | `true` if the request is from a privacy aware browser (e.g. Tor) or from a browser in which fingerprinting is blocked. Otherwise `false`.  |  [optional] |
+|**result** | **Boolean** | `true` if the request is from a privacy aware browser (e.g. Tor) or from a browser in which fingerprinting is blocked. Otherwise `false`.  |  |
 
 
 
diff --git a/docs/SignalResponseTorData.md → docs/ProxyResult.md b/docs/SignalResponseTorData.md → docs/ProxyResult.md
@@ -1,13 +1,13 @@
 
 
-# SignalResponseTorData
+# ProxyResult
 
 
 ## Properties
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**result** | **Boolean** | `true` if the request IP address is a known tor exit node, `false` otherwise.  |  [optional] |
+|**result** | **Boolean** | `true` if the request IP address is used by a public proxy provider, `false` otherwise.  |  |
 
 
 
diff --git a/docs/SignalResponseRootAppsData.md → docs/RootAppsResult.md b/docs/SignalResponseRootAppsData.md → docs/RootAppsResult.md
@@ -1,13 +1,13 @@
 
 
-# SignalResponseRootAppsData
+# RootAppsResult
 
 
 ## Properties
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**result** | **Boolean** | Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - No Root Management Apps detected or the client is not Android.  |  [optional] |
+|**result** | **Boolean** | Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - No Root Management Apps detected or the client isn't Android.  |  |
 
 
 
diff --git a/docs/SignalResponseClonedApp.md b/docs/SignalResponseClonedApp.md
@@ -7,7 +7,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**data** | [**SignalResponseClonedAppData**](SignalResponseClonedAppData.md) |  |  [optional] |
+|**data** | [**ClonedAppResult**](ClonedAppResult.md) |  |  [optional] |
 |**error** | [**ProductError**](ProductError.md) |  |  [optional] |
 
 

diff --git a/docs/SignalResponseEmulator.md b/docs/SignalResponseEmulator.md
@@ -7,7 +7,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**data** | [**SignalResponseEmulatorData**](SignalResponseEmulatorData.md) |  |  [optional] |
+|**data** | [**EmulatorResult**](EmulatorResult.md) |  |  [optional] |
 |**error** | [**ProductError**](ProductError.md) |  |  [optional] |
 
 

diff --git a/docs/SignalResponseFactoryReset.md b/docs/SignalResponseFactoryReset.md
@@ -7,7 +7,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**data** | [**SignalResponseFactoryResetData**](SignalResponseFactoryResetData.md) |  |  [optional] |
+|**data** | [**FactoryResetResult**](FactoryResetResult.md) |  |  [optional] |
 |**error** | [**ProductError**](ProductError.md) |  |  [optional] |
 
 

diff --git a/docs/SignalResponseFactoryResetData.md b/docs/SignalResponseFactoryResetData.md
diff --git a/docs/SignalResponseFrida.md b/docs/SignalResponseFrida.md
@@ -7,7 +7,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**data** | [**SignalResponseFridaData**](SignalResponseFridaData.md) |  |  [optional] |
+|**data** | [**FridaResult**](FridaResult.md) |  |  [optional] |
 |**error** | [**ProductError**](ProductError.md) |  |  [optional] |
 
 

diff --git a/docs/SignalResponseFridaData.md b/docs/SignalResponseFridaData.md
diff --git a/docs/SignalResponseIncognito.md b/docs/SignalResponseIncognito.md
@@ -7,7 +7,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**data** | [**SignalResponseIncognitoData**](SignalResponseIncognitoData.md) |  |  [optional] |
+|**data** | [**IncognitoResult**](IncognitoResult.md) |  |  [optional] |
 |**error** | [**ProductError**](ProductError.md) |  |  [optional] |
 
 

diff --git a/docs/SignalResponseJailbroken.md b/docs/SignalResponseJailbroken.md
@@ -7,7 +7,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**data** | [**SignalResponseJailbrokenData**](SignalResponseJailbrokenData.md) |  |  [optional] |
+|**data** | [**JailbrokenResult**](JailbrokenResult.md) |  |  [optional] |
 |**error** | [**ProductError**](ProductError.md) |  |  [optional] |
 
 

diff --git a/docs/SignalResponsePrivacySettings.md b/docs/SignalResponsePrivacySettings.md
@@ -7,7 +7,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**data** | [**SignalResponsePrivacySettingsData**](SignalResponsePrivacySettingsData.md) |  |  [optional] |
+|**data** | [**PrivacySettingsResult**](PrivacySettingsResult.md) |  |  [optional] |
 |**error** | [**ProductError**](ProductError.md) |  |  [optional] |
 
 

diff --git a/docs/SignalResponseProxy.md b/docs/SignalResponseProxy.md
@@ -7,7 +7,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**data** | [**SignalResponseProxyData**](SignalResponseProxyData.md) |  |  [optional] |
+|**data** | [**ProxyResult**](ProxyResult.md) |  |  [optional] |
 |**error** | [**ProductError**](ProductError.md) |  |  [optional] |
 
 

diff --git a/docs/SignalResponseProxyData.md b/docs/SignalResponseProxyData.md
diff --git a/docs/SignalResponseRootApps.md b/docs/SignalResponseRootApps.md
@@ -7,7 +7,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**data** | [**SignalResponseRootAppsData**](SignalResponseRootAppsData.md) |  |  [optional] |
+|**data** | [**RootAppsResult**](RootAppsResult.md) |  |  [optional] |
 |**error** | [**ProductError**](ProductError.md) |  |  [optional] |
 
 

diff --git a/docs/SignalResponseTor.md b/docs/SignalResponseTor.md
@@ -7,7 +7,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**data** | [**SignalResponseTorData**](SignalResponseTorData.md) |  |  [optional] |
+|**data** | [**TorResult**](TorResult.md) |  |  [optional] |
 |**error** | [**ProductError**](ProductError.md) |  |  [optional] |
 
 

diff --git a/docs/SignalResponseVirtualMachine.md b/docs/SignalResponseVirtualMachine.md
@@ -7,7 +7,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**data** | [**SignalResponseVirtualMachineData**](SignalResponseVirtualMachineData.md) |  |  [optional] |
+|**data** | [**VirtualMachineResult**](VirtualMachineResult.md) |  |  [optional] |
 |**error** | [**ProductError**](ProductError.md) |  |  [optional] |
 
 

diff --git a/docs/WebhookSignalResponseTor.md → docs/TorResult.md b/docs/WebhookSignalResponseTor.md → docs/TorResult.md
@@ -1,13 +1,13 @@
 
 
-# WebhookSignalResponseTor
+# TorResult
 
 
 ## Properties
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**result** | **Boolean** | `true` if the request IP address is a known tor exit node, `false` otherwise.  |  [optional] |
+|**result** | **Boolean** | `true` if the request IP address is a known tor exit node, `false` otherwise.  |  |