fix: update schema with correct Webhook Signals description

fingerprintjs · May 10, 2023 · 54f2085 · 54f2085
1 parent 8a7b0c3
commit 54f2085
Show file tree

Hide file tree

Showing 46 changed files with 322 additions and 306 deletions.
diff --git a/README.md b/README.md
@@ -156,32 +156,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)
 
 ## Documentation For Authorization

diff --git a/docs/ProductsResponse.md b/docs/ProductsResponse.md
@@ -5,15 +5,15 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Identification** | [***ProductsResponseIdentification**](ProductsResponseIdentification.md) |  | [optional] [default to null]
 **Botd** | [***ProductsResponseBotd**](ProductsResponseBotd.md) |  | [optional] [default to null]
-**IpInfo** | [***SignalResponseIpInfo1**](SignalResponseIpInfo_1.md) |  | [optional] [default to null]
+**IpInfo** | [***SignalResponseIpInfo**](SignalResponseIpInfo.md) |  | [optional] [default to null]
 **Incognito** | [***SignalResponseIncognito**](SignalResponseIncognito.md) |  | [optional] [default to null]
-**RootApps** | [***SignalResponseRootApps1**](SignalResponseRootApps_1.md) |  | [optional] [default to null]
-**Emulator** | [***SignalResponseEmulator1**](SignalResponseEmulator_1.md) |  | [optional] [default to null]
-**IpBlocklist** | [***SignalResponseIpBlocklist1**](SignalResponseIpBlocklist_1.md) |  | [optional] [default to null]
-**Tor** | [***SignalResponseTor1**](SignalResponseTor_1.md) |  | [optional] [default to null]
-**Vpn** | [***SignalResponseVpn1**](SignalResponseVpn_1.md) |  | [optional] [default to null]
-**Proxy** | [***SignalResponseProxy1**](SignalResponseProxy_1.md) |  | [optional] [default to null]
-**Tampering** | [***SignalResponseTampering1**](SignalResponseTampering_1.md) |  | [optional] [default to null]
+**RootApps** | [***SignalResponseRootApps**](SignalResponseRootApps.md) |  | [optional] [default to null]
+**Emulator** | [***SignalResponseEmulator**](SignalResponseEmulator.md) |  | [optional] [default to null]
+**IpBlocklist** | [***SignalResponseIpBlocklist**](SignalResponseIpBlocklist.md) |  | [optional] [default to null]
+**Tor** | [***SignalResponseTor**](SignalResponseTor.md) |  | [optional] [default to null]
+**Vpn** | [***SignalResponseVpn**](SignalResponseVpn.md) |  | [optional] [default to null]
+**Proxy** | [***SignalResponseProxy**](SignalResponseProxy.md) |  | [optional] [default to null]
+**Tampering** | [***SignalResponseTampering**](SignalResponseTampering.md) |  | [optional] [default to null]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/SignalResponseEmulator.md b/docs/SignalResponseEmulator.md
@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Data** | [***SignalResponseEmulatorData**](SignalResponseEmulator_data.md) |  | [optional] [default to null]
+**Error_** | [***ProductError**](ProductError.md) |  | [optional] [default to null]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/SignalResponseEmulator1.md b/docs/SignalResponseEmulator1.md
diff --git a/docs/SignalResponseEmulatorData.md b/docs/SignalResponseEmulatorData.md
@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Result** | **bool** | 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] [default to null]
+**Result** | **bool** | 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] [default to null]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/SignalResponseIpBlocklist.md b/docs/SignalResponseIpBlocklist.md
@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Data** | [***IpBlockListResult**](IpBlockListResult.md) |  | [optional] [default to null]
+**Error_** | [***ProductError**](ProductError.md) |  | [optional] [default to null]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/SignalResponseIpBlocklist1.md b/docs/SignalResponseIpBlocklist1.md
diff --git a/docs/SignalResponseIpInfo.md b/docs/SignalResponseIpInfo.md
@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Data** | [***IpInfoResult**](IpInfoResult.md) |  | [optional] [default to null]
+**Error_** | [***ProductError**](ProductError.md) |  | [optional] [default to null]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/SignalResponseProxy.md b/docs/SignalResponseProxy.md
@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Data** | [***SignalResponseProxyData**](SignalResponseProxy_data.md) |  | [optional] [default to null]
+**Error_** | [***ProductError**](ProductError.md) |  | [optional] [default to null]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/SignalResponseProxy1.md b/docs/SignalResponseProxy1.md
diff --git a/docs/SignalResponseRootApps.md b/docs/SignalResponseRootApps.md
@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Data** | [***SignalResponseRootAppsData**](SignalResponseRootApps_data.md) |  | [optional] [default to null]
+**Error_** | [***ProductError**](ProductError.md) |  | [optional] [default to null]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/SignalResponseRootApps1.md b/docs/SignalResponseRootApps1.md
diff --git a/docs/SignalResponseRootAppsData.md b/docs/SignalResponseRootAppsData.md
@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Result** | **bool** | 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] [default to null]
+**Result** | **bool** | 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] [default to null]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/SignalResponseTampering.md b/docs/SignalResponseTampering.md
@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Data** | [***TamperingResult**](TamperingResult.md) |  | [optional] [default to null]
+**Error_** | [***ProductError**](ProductError.md) |  | [optional] [default to null]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/SignalResponseTampering1.md b/docs/SignalResponseTampering1.md
diff --git a/docs/SignalResponseTor.md b/docs/SignalResponseTor.md
@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Data** | [***SignalResponseTorData**](SignalResponseTor_data.md) |  | [optional] [default to null]
+**Error_** | [***ProductError**](ProductError.md) |  | [optional] [default to null]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/SignalResponseTor1.md b/docs/SignalResponseTor1.md
diff --git a/docs/SignalResponseVpn.md b/docs/SignalResponseVpn.md
@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Data** | [***VpnResult**](VpnResult.md) |  | [optional] [default to null]
+**Error_** | [***ProductError**](ProductError.md) |  | [optional] [default to null]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/WebhookSignalResponseEmulator.md b/docs/WebhookSignalResponseEmulator.md
@@ -0,0 +1,9 @@
+# WebhookSignalResponseEmulator
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Result** | **bool** | 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] [default to null]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/SignalResponseIpInfo1.md → docs/WebhookSignalResponseProxy.md b/docs/SignalResponseIpInfo1.md → docs/WebhookSignalResponseProxy.md
@@ -1,10 +1,9 @@
-# SignalResponseIpInfo1
+# WebhookSignalResponseProxy
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Data** | [***IpInfoResult**](IpInfoResult.md) |  | [optional] [default to null]
-**Error_** | [***ProductError**](ProductError.md) |  | [optional] [default to null]
+**Result** | **bool** | &#x60;true&#x60; if the request IP address is used by a public proxy provider, &#x60;false&#x60; otherwise.  | [optional] [default to null]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/WebhookSignalResponseRootApps.md b/docs/WebhookSignalResponseRootApps.md
@@ -0,0 +1,9 @@
+# WebhookSignalResponseRootApps
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Result** | **bool** | 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] [default to null]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/SignalResponseVpn1.md → docs/WebhookSignalResponseTor.md b/docs/SignalResponseVpn1.md → docs/WebhookSignalResponseTor.md
@@ -1,10 +1,9 @@
-# SignalResponseVpn1
+# WebhookSignalResponseTor
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Data** | [***VpnResult**](VpnResult.md) |  | [optional] [default to null]
-**Error_** | [***ProductError**](ProductError.md) |  | [optional] [default to null]
+**Result** | **bool** | &#x60;true&#x60; if the request IP address is a known tor exit node, &#x60;false&#x60; otherwise.  | [optional] [default to null]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/WebhookVisit.md b/docs/WebhookVisit.md
@@ -7,15 +7,15 @@ Name | Type | Description | Notes
 **ClientReferrer** | **string** |  | [optional] [default to null]
 **UserAgent** | **string** |  | [optional] [default to null]
 **Bot** | [***BotdDetectionResult**](BotdDetectionResult.md) |  | [optional] [default to null]
-**IpInfo** | [***SignalResponseIpInfo**](SignalResponseIpInfo.md) |  | [optional] [default to null]
+**IpInfo** | [***IpInfoResult**](IpInfoResult.md) |  | [optional] [default to null]
 **Incognito** | **bool** | Flag if user used incognito session. | [default to null]
-**RootApps** | [***SignalResponseRootApps**](SignalResponseRootApps.md) |  | [optional] [default to null]
-**Emulator** | [***SignalResponseEmulator**](SignalResponseEmulator.md) |  | [optional] [default to null]
-**IpBlocklist** | [***SignalResponseIpBlocklist**](SignalResponseIpBlocklist.md) |  | [optional] [default to null]
-**Tor** | [***SignalResponseTor**](SignalResponseTor.md) |  | [optional] [default to null]
-**Vpn** | [***SignalResponseVpn**](SignalResponseVpn.md) |  | [optional] [default to null]
-**Proxy** | [***SignalResponseProxy**](SignalResponseProxy.md) |  | [optional] [default to null]
-**Tampering** | [***SignalResponseTampering**](SignalResponseTampering.md) |  | [optional] [default to null]
+**RootApps** | [***WebhookSignalResponseRootApps**](WebhookSignalResponseRootApps.md) |  | [optional] [default to null]
+**Emulator** | [***WebhookSignalResponseEmulator**](WebhookSignalResponseEmulator.md) |  | [optional] [default to null]
+**IpBlocklist** | [***IpBlockListResult**](IpBlockListResult.md) |  | [optional] [default to null]
+**Tor** | [***WebhookSignalResponseTor**](WebhookSignalResponseTor.md) |  | [optional] [default to null]
+**Vpn** | [***VpnResult**](VpnResult.md) |  | [optional] [default to null]
+**Proxy** | [***WebhookSignalResponseProxy**](WebhookSignalResponseProxy.md) |  | [optional] [default to null]
+**Tampering** | [***TamperingResult**](TamperingResult.md) |  | [optional] [default to null]
 **RequestId** | **string** | Unique identifier of the user&#x27;s identification request. | [default to null]
 **BrowserDetails** | [***BrowserDetails**](BrowserDetails.md) |  | [default to null]
 **Ip** | **string** |  | [default to null]