fix: update schema with correct Webhook Signals description

fingerprintjs · May 10, 2023 · 6a0c48d · 6a0c48d
1 parent c48bd62
commit 6a0c48d
Show file tree

Hide file tree

Showing 47 changed files with 701 additions and 1,177 deletions.
diff --git a/README.md b/README.md
@@ -236,32 +236,28 @@ Class | Method | HTTP request | Description
  - [ResponseVisits](docs/ResponseVisits.md)
  - [SeenAt](docs/SeenAt.md)
  - [SignalResponseEmulator](docs/SignalResponseEmulator.md)
- - [SignalResponseEmulator1](docs/SignalResponseEmulator1.md)
  - [SignalResponseEmulatorData](docs/SignalResponseEmulatorData.md)
  - [SignalResponseIncognito](docs/SignalResponseIncognito.md)
  - [SignalResponseIncognitoData](docs/SignalResponseIncognitoData.md)
  - [SignalResponseIpBlocklist](docs/SignalResponseIpBlocklist.md)
- - [SignalResponseIpBlocklist1](docs/SignalResponseIpBlocklist1.md)
  - [SignalResponseIpInfo](docs/SignalResponseIpInfo.md)
- - [SignalResponseIpInfo1](docs/SignalResponseIpInfo1.md)
  - [SignalResponseProxy](docs/SignalResponseProxy.md)
- - [SignalResponseProxy1](docs/SignalResponseProxy1.md)
  - [SignalResponseProxyData](docs/SignalResponseProxyData.md)
  - [SignalResponseRootApps](docs/SignalResponseRootApps.md)
- - [SignalResponseRootApps1](docs/SignalResponseRootApps1.md)
  - [SignalResponseRootAppsData](docs/SignalResponseRootAppsData.md)
  - [SignalResponseTampering](docs/SignalResponseTampering.md)
- - [SignalResponseTampering1](docs/SignalResponseTampering1.md)
  - [SignalResponseTor](docs/SignalResponseTor.md)
- - [SignalResponseTor1](docs/SignalResponseTor1.md)
  - [SignalResponseTorData](docs/SignalResponseTorData.md)
  - [SignalResponseVpn](docs/SignalResponseVpn.md)
- - [SignalResponseVpn1](docs/SignalResponseVpn1.md)
  - [Subdivision](docs/Subdivision.md)
  - [TamperingResult](docs/TamperingResult.md)
  - [Visit](docs/Visit.md)
  - [VpnResult](docs/VpnResult.md)
  - [VpnResultMethods](docs/VpnResultMethods.md)
+ - [WebhookSignalResponseEmulator](docs/WebhookSignalResponseEmulator.md)
+ - [WebhookSignalResponseProxy](docs/WebhookSignalResponseProxy.md)
+ - [WebhookSignalResponseRootApps](docs/WebhookSignalResponseRootApps.md)
+ - [WebhookSignalResponseTor](docs/WebhookSignalResponseTor.md)
  - [WebhookVisit](docs/WebhookVisit.md)
 
 

diff --git a/docs/ProductsResponse.md b/docs/ProductsResponse.md
@@ -10,15 +10,15 @@ Contains all the information from each activated product - Fingerprint Pro or Bo
 |------------ | ------------- | ------------- | -------------|
 |**identification** | [**ProductsResponseIdentification**](ProductsResponseIdentification.md) |  |  [optional] |
 |**botd** | [**ProductsResponseBotd**](ProductsResponseBotd.md) |  |  [optional] |
-|**ipInfo** | [**SignalResponseIpInfo1**](SignalResponseIpInfo1.md) |  |  [optional] |
+|**ipInfo** | [**SignalResponseIpInfo**](SignalResponseIpInfo.md) |  |  [optional] |
 |**incognito** | [**SignalResponseIncognito**](SignalResponseIncognito.md) |  |  [optional] |
-|**rootApps** | [**SignalResponseRootApps1**](SignalResponseRootApps1.md) |  |  [optional] |
-|**emulator** | [**SignalResponseEmulator1**](SignalResponseEmulator1.md) |  |  [optional] |
-|**ipBlocklist** | [**SignalResponseIpBlocklist1**](SignalResponseIpBlocklist1.md) |  |  [optional] |
-|**tor** | [**SignalResponseTor1**](SignalResponseTor1.md) |  |  [optional] |
-|**vpn** | [**SignalResponseVpn1**](SignalResponseVpn1.md) |  |  [optional] |
-|**proxy** | [**SignalResponseProxy1**](SignalResponseProxy1.md) |  |  [optional] |
-|**tampering** | [**SignalResponseTampering1**](SignalResponseTampering1.md) |  |  [optional] |
+|**rootApps** | [**SignalResponseRootApps**](SignalResponseRootApps.md) |  |  [optional] |
+|**emulator** | [**SignalResponseEmulator**](SignalResponseEmulator.md) |  |  [optional] |
+|**ipBlocklist** | [**SignalResponseIpBlocklist**](SignalResponseIpBlocklist.md) |  |  [optional] |
+|**tor** | [**SignalResponseTor**](SignalResponseTor.md) |  |  [optional] |
+|**vpn** | [**SignalResponseVpn**](SignalResponseVpn.md) |  |  [optional] |
+|**proxy** | [**SignalResponseProxy**](SignalResponseProxy.md) |  |  [optional] |
+|**tampering** | [**SignalResponseTampering**](SignalResponseTampering.md) |  |  [optional] |
 
 
 
diff --git a/docs/SignalResponseEmulator.md b/docs/SignalResponseEmulator.md
@@ -8,6 +8,7 @@
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 |**data** | [**SignalResponseEmulatorData**](SignalResponseEmulatorData.md) |  |  [optional] |
+|**error** | [**ProductError**](ProductError.md) |  |  [optional] |
 
 
 
diff --git a/docs/SignalResponseEmulator1.md b/docs/SignalResponseEmulator1.md
diff --git a/docs/SignalResponseEmulatorData.md b/docs/SignalResponseEmulatorData.md
@@ -7,7 +7,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**result** | **Boolean** | Android specific emulator detection. There are 2 values: • &#x60;true&#x60; - Emulated environment detected (e.g. launch inside of AVD) • &#x60;false&#x60; - No signs of emulated environment detected Available only for events from Android client. The field will be empty for a browser/iOS event.  |  [optional] |
+|**result** | **Boolean** | Android specific emulator detection. There are 2 values: • &#x60;true&#x60; - Emulated environment detected (e.g. launch inside of AVD) • &#x60;false&#x60; - No signs of emulated environment detected Available only for events from Android client. The field will not be present for a browser or iOS event.  |  [optional] |
 
 
 
diff --git a/docs/SignalResponseIpBlocklist.md b/docs/SignalResponseIpBlocklist.md
@@ -8,6 +8,7 @@
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 |**data** | [**IpBlockListResult**](IpBlockListResult.md) |  |  [optional] |
+|**error** | [**ProductError**](ProductError.md) |  |  [optional] |
 
 
 
diff --git a/docs/SignalResponseIpBlocklist1.md b/docs/SignalResponseIpBlocklist1.md
diff --git a/docs/SignalResponseIpInfo.md b/docs/SignalResponseIpInfo.md
@@ -8,6 +8,7 @@
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 |**data** | [**IpInfoResult**](IpInfoResult.md) |  |  [optional] |
+|**error** | [**ProductError**](ProductError.md) |  |  [optional] |
 
 
 
diff --git a/docs/SignalResponseIpInfo1.md b/docs/SignalResponseIpInfo1.md
diff --git a/docs/SignalResponseProxy.md b/docs/SignalResponseProxy.md
@@ -8,6 +8,7 @@
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 |**data** | [**SignalResponseProxyData**](SignalResponseProxyData.md) |  |  [optional] |
+|**error** | [**ProductError**](ProductError.md) |  |  [optional] |
 
 
 
diff --git a/docs/SignalResponseProxy1.md b/docs/SignalResponseProxy1.md
diff --git a/docs/SignalResponseRootApps.md b/docs/SignalResponseRootApps.md
@@ -8,6 +8,7 @@
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 |**data** | [**SignalResponseRootAppsData**](SignalResponseRootAppsData.md) |  |  [optional] |
+|**error** | [**ProductError**](ProductError.md) |  |  [optional] |
 
 
 
diff --git a/docs/SignalResponseRootApps1.md b/docs/SignalResponseRootApps1.md
diff --git a/docs/SignalResponseRootAppsData.md b/docs/SignalResponseRootAppsData.md
@@ -7,7 +7,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**result** | **Boolean** | Android specific root management apps detection. There are 2 values: • &#x60;true&#x60; - Root Management Apps detected (e.g. Magisk) • &#x60;false&#x60; - No Root Management Apps detected Available only for events from Android client. The field will be empty for a browser/iOS event.  |  [optional] |
+|**result** | **Boolean** | Android specific root management apps detection. There are 2 values: • &#x60;true&#x60; - Root Management Apps detected (e.g. Magisk) • &#x60;false&#x60; - No Root Management Apps detected Available only for events from Android client. The field will not be present for a browser or iOS event.  |  [optional] |
 
 
 
diff --git a/docs/SignalResponseTampering.md b/docs/SignalResponseTampering.md
@@ -8,6 +8,7 @@
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 |**data** | [**TamperingResult**](TamperingResult.md) |  |  [optional] |
+|**error** | [**ProductError**](ProductError.md) |  |  [optional] |
 
 
 
diff --git a/docs/SignalResponseTampering1.md b/docs/SignalResponseTampering1.md
diff --git a/docs/SignalResponseTor.md b/docs/SignalResponseTor.md
@@ -8,6 +8,7 @@
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 |**data** | [**SignalResponseTorData**](SignalResponseTorData.md) |  |  [optional] |
+|**error** | [**ProductError**](ProductError.md) |  |  [optional] |
 
 
 
diff --git a/docs/SignalResponseTor1.md b/docs/SignalResponseTor1.md
diff --git a/docs/SignalResponseVpn.md b/docs/SignalResponseVpn.md
@@ -8,6 +8,7 @@
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 |**data** | [**VpnResult**](VpnResult.md) |  |  [optional] |
+|**error** | [**ProductError**](ProductError.md) |  |  [optional] |
 
 
 
diff --git a/docs/SignalResponseVpn1.md b/docs/SignalResponseVpn1.md
diff --git a/docs/WebhookSignalResponseEmulator.md b/docs/WebhookSignalResponseEmulator.md
@@ -0,0 +1,13 @@
+
+
+# WebhookSignalResponseEmulator
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**result** | **Boolean** | Android specific emulator detection. There are 2 values: • &#x60;true&#x60; - Emulated environment detected (e.g. launch inside of AVD) • &#x60;false&#x60; - No signs of emulated environment detected Available only for events from Android client. The field will not be present for a browser or iOS event.  |  [optional] |
+
+
+
diff --git a/docs/WebhookSignalResponseProxy.md b/docs/WebhookSignalResponseProxy.md
@@ -0,0 +1,13 @@
+
+
+# WebhookSignalResponseProxy
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**result** | **Boolean** | &#x60;true&#x60; if the request IP address is used by a public proxy provider, &#x60;false&#x60; otherwise.  |  [optional] |
+
+
+
diff --git a/docs/WebhookSignalResponseRootApps.md b/docs/WebhookSignalResponseRootApps.md
@@ -0,0 +1,13 @@
+
+
+# WebhookSignalResponseRootApps
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**result** | **Boolean** | Android specific root management apps detection. There are 2 values: • &#x60;true&#x60; - Root Management Apps detected (e.g. Magisk) • &#x60;false&#x60; - No Root Management Apps detected Available only for events from Android client. The field will not be present for a browser or iOS event.  |  [optional] |
+
+
+
diff --git a/docs/WebhookSignalResponseTor.md b/docs/WebhookSignalResponseTor.md
@@ -0,0 +1,13 @@
+
+
+# WebhookSignalResponseTor
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**result** | **Boolean** | &#x60;true&#x60; if the request IP address is a known tor exit node, &#x60;false&#x60; otherwise.  |  [optional] |
+
+
+
diff --git a/docs/WebhookVisit.md b/docs/WebhookVisit.md
@@ -11,15 +11,15 @@
 |**clientReferrer** | **String** |  |  [optional] |
 |**userAgent** | **String** |  |  [optional] |
 |**bot** | [**BotdDetectionResult**](BotdDetectionResult.md) |  |  [optional] |
-|**ipInfo** | [**SignalResponseIpInfo**](SignalResponseIpInfo.md) |  |  [optional] |
+|**ipInfo** | [**IpInfoResult**](IpInfoResult.md) |  |  [optional] |
 |**incognito** | **Boolean** | Flag if user used incognito session. |  |
-|**rootApps** | [**SignalResponseRootApps**](SignalResponseRootApps.md) |  |  [optional] |
-|**emulator** | [**SignalResponseEmulator**](SignalResponseEmulator.md) |  |  [optional] |
-|**ipBlocklist** | [**SignalResponseIpBlocklist**](SignalResponseIpBlocklist.md) |  |  [optional] |
-|**tor** | [**SignalResponseTor**](SignalResponseTor.md) |  |  [optional] |
-|**vpn** | [**SignalResponseVpn**](SignalResponseVpn.md) |  |  [optional] |
-|**proxy** | [**SignalResponseProxy**](SignalResponseProxy.md) |  |  [optional] |
-|**tampering** | [**SignalResponseTampering**](SignalResponseTampering.md) |  |  [optional] |
+|**rootApps** | [**WebhookSignalResponseRootApps**](WebhookSignalResponseRootApps.md) |  |  [optional] |
+|**emulator** | [**WebhookSignalResponseEmulator**](WebhookSignalResponseEmulator.md) |  |  [optional] |
+|**ipBlocklist** | [**IpBlockListResult**](IpBlockListResult.md) |  |  [optional] |
+|**tor** | [**WebhookSignalResponseTor**](WebhookSignalResponseTor.md) |  |  [optional] |
+|**vpn** | [**VpnResult**](VpnResult.md) |  |  [optional] |
+|**proxy** | [**WebhookSignalResponseProxy**](WebhookSignalResponseProxy.md) |  |  [optional] |
+|**tampering** | [**TamperingResult**](TamperingResult.md) |  |  [optional] |
 |**requestId** | **String** | Unique identifier of the user&#39;s identification request. |  |
 |**browserDetails** | [**BrowserDetails**](BrowserDetails.md) |  |  |
 |**ip** | **String** |  |  |