feat: update schema and add more signals

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

Hide file tree

Showing 77 changed files with 5,768 additions and 75 deletions.
diff --git a/README.md b/README.md
@@ -208,7 +208,6 @@ Class | Method | HTTP request | Description
 ## Documentation for Models
 
  - [BotdDetectionResult](docs/BotdDetectionResult.md)
- - [BotdError](docs/BotdError.md)
  - [BotdResult](docs/BotdResult.md)
  - [BrowserDetails](docs/BrowserDetails.md)
  - [Confidence](docs/Confidence.md)
@@ -221,17 +220,48 @@ Class | Method | HTTP request | Description
  - [IPLocation](docs/IPLocation.md)
  - [IPLocationCity](docs/IPLocationCity.md)
  - [IdentificationError](docs/IdentificationError.md)
+ - [IpBlockListResult](docs/IpBlockListResult.md)
+ - [IpBlockListResultDetails](docs/IpBlockListResultDetails.md)
+ - [IpInfoResult](docs/IpInfoResult.md)
+ - [IpInfoResultV4](docs/IpInfoResultV4.md)
+ - [IpInfoResultV6](docs/IpInfoResultV6.md)
  - [Location](docs/Location.md)
  - [ManyRequestsResponse](docs/ManyRequestsResponse.md)
+ - [ProductError](docs/ProductError.md)
  - [ProductsResponse](docs/ProductsResponse.md)
  - [ProductsResponseBotd](docs/ProductsResponseBotd.md)
  - [ProductsResponseIdentification](docs/ProductsResponseIdentification.md)
  - [ProductsResponseIdentificationData](docs/ProductsResponseIdentificationData.md)
  - [Response](docs/Response.md)
  - [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)
  - [WebhookVisit](docs/WebhookVisit.md)
 
 

diff --git a/docs/BotdDetectionResult.md b/docs/BotdDetectionResult.md
@@ -9,6 +9,7 @@ Stores bot detection result
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 |**result** | [**ResultEnum**](#ResultEnum) | Bot detection result:  * &#x60;notDetected&#x60; - the visitor is not a bot  * &#x60;good&#x60; - good bot detected, such as Google bot, Baidu Spider, AlexaBot and so on  * &#x60;bad&#x60; - bad bot detected, such as Selenium, Puppeteer, Playwright, headless browsers, and so on  |  |
+|**type** | **String** |  |  [optional] |
 
 
 ## Enum: ResultEnum

diff --git a/docs/BotdResult.md b/docs/BotdResult.md
@@ -11,6 +11,8 @@ Contains all the information from Bot Detection product
 |**ip** | **String** | IP address of the requesting browser or bot. |  |
 |**time** | **OffsetDateTime** | Time in UTC when the request from the JS agent was made. We recommend to treat requests that are older than 2 minutes as malicious. Otherwise, request replay attacks are possible |  |
 |**url** | **String** | Page URL from which identification request was sent. |  |
+|**userAgent** | **String** |  |  [optional] |
+|**requestId** | **String** |  |  [optional] |
 |**bot** | [**BotdDetectionResult**](BotdDetectionResult.md) |  |  |
 
 

diff --git a/docs/IpBlockListResult.md b/docs/IpBlockListResult.md
@@ -0,0 +1,14 @@
+
+
+# IpBlockListResult
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**result** | **Boolean** | &#x60;true&#x60; if request IP address is part of any database that we use to search for known malicious actors, &#x60;false&#x60; otherwise.  |  [optional] |
+|**details** | [**IpBlockListResultDetails**](IpBlockListResultDetails.md) |  |  [optional] |
+
+
+
diff --git a/docs/IpBlockListResultDetails.md b/docs/IpBlockListResultDetails.md
@@ -0,0 +1,14 @@
+
+
+# IpBlockListResultDetails
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**emailSpam** | **Boolean** | IP address was part of a known email spam attack (SMTP). |  [optional] |
+|**attackSource** | **Boolean** | IP address was part of a known network attack (SSH/HTTPS). |  [optional] |
+
+
+
diff --git a/docs/IpInfoResult.md b/docs/IpInfoResult.md
@@ -0,0 +1,15 @@
+
+
+# IpInfoResult
+
+Details about the request IP address. Has separate fields for v4 and v6 IP address versions.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**v4** | [**IpInfoResultV4**](IpInfoResultV4.md) |  |  [optional] |
+|**v6** | [**IpInfoResultV6**](IpInfoResultV6.md) |  |  [optional] |
+
+
+
diff --git a/docs/IpInfoResultV4.md b/docs/IpInfoResultV4.md
@@ -0,0 +1,14 @@
+
+
+# IpInfoResultV4
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**address** | **String** |  |  [optional] |
+|**geolocation** | [**IPLocation**](IPLocation.md) |  |  [optional] |
+
+
+
diff --git a/docs/IpInfoResultV6.md b/docs/IpInfoResultV6.md
@@ -0,0 +1,14 @@
+
+
+# IpInfoResultV6
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**address** | **String** |  |  [optional] |
+|**geolocation** | [**IPLocation**](IPLocation.md) |  |  [optional] |
+
+
+
diff --git a/docs/BotdError.md → docs/ProductError.md b/docs/BotdError.md → docs/ProductError.md
@@ -1,6 +1,6 @@
 
 
-# BotdError
+# ProductError
 
 
 ## Properties

diff --git a/docs/ProductsResponse.md b/docs/ProductsResponse.md
@@ -10,6 +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] |
+|**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] |
 
 
 
diff --git a/docs/ProductsResponseBotd.md b/docs/ProductsResponseBotd.md
@@ -8,7 +8,7 @@
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 |**data** | [**BotdResult**](BotdResult.md) |  |  [optional] |
-|**error** | [**BotdError**](BotdError.md) |  |  [optional] |
+|**error** | [**ProductError**](ProductError.md) |  |  [optional] |
 
 
 
diff --git a/docs/SignalResponseEmulator.md b/docs/SignalResponseEmulator.md
@@ -0,0 +1,13 @@
+
+
+# SignalResponseEmulator
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**SignalResponseEmulatorData**](SignalResponseEmulatorData.md) |  |  [optional] |
+
+
+
diff --git a/docs/SignalResponseEmulator1.md b/docs/SignalResponseEmulator1.md
@@ -0,0 +1,14 @@
+
+
+# SignalResponseEmulator1
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**SignalResponseEmulatorData**](SignalResponseEmulatorData.md) |  |  [optional] |
+|**error** | [**ProductError**](ProductError.md) |  |  [optional] |
+
+
+
diff --git a/docs/SignalResponseEmulatorData.md b/docs/SignalResponseEmulatorData.md
@@ -0,0 +1,13 @@
+
+
+# SignalResponseEmulatorData
+
+
+## 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 be empty for a browser/iOS event.  |  [optional] |
+
+
+
diff --git a/docs/SignalResponseIncognito.md b/docs/SignalResponseIncognito.md
@@ -0,0 +1,14 @@
+
+
+# SignalResponseIncognito
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**SignalResponseIncognitoData**](SignalResponseIncognitoData.md) |  |  [optional] |
+|**error** | [**ProductError**](ProductError.md) |  |  [optional] |
+
+
+
diff --git a/docs/SignalResponseIncognitoData.md b/docs/SignalResponseIncognitoData.md
@@ -0,0 +1,13 @@
+
+
+# SignalResponseIncognitoData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**result** | **Boolean** | &#x60;true&#x60; if we detected incognito mode used in the browser, &#x60;false&#x60; otherwise.  |  [optional] |
+
+
+
diff --git a/docs/SignalResponseIpBlocklist.md b/docs/SignalResponseIpBlocklist.md
@@ -0,0 +1,13 @@
+
+
+# SignalResponseIpBlocklist
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**IpBlockListResult**](IpBlockListResult.md) |  |  [optional] |
+
+
+
diff --git a/docs/SignalResponseIpBlocklist1.md b/docs/SignalResponseIpBlocklist1.md
@@ -0,0 +1,14 @@
+
+
+# SignalResponseIpBlocklist1
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**IpBlockListResult**](IpBlockListResult.md) |  |  [optional] |
+|**error** | [**ProductError**](ProductError.md) |  |  [optional] |
+
+
+
diff --git a/docs/SignalResponseIpInfo.md b/docs/SignalResponseIpInfo.md
@@ -0,0 +1,13 @@
+
+
+# SignalResponseIpInfo
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**IpInfoResult**](IpInfoResult.md) |  |  [optional] |
+
+
+
diff --git a/docs/SignalResponseIpInfo1.md b/docs/SignalResponseIpInfo1.md
@@ -0,0 +1,14 @@
+
+
+# SignalResponseIpInfo1
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**IpInfoResult**](IpInfoResult.md) |  |  [optional] |
+|**error** | [**ProductError**](ProductError.md) |  |  [optional] |
+
+
+
diff --git a/docs/SignalResponseProxy.md b/docs/SignalResponseProxy.md
@@ -0,0 +1,13 @@
+
+
+# SignalResponseProxy
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**SignalResponseProxyData**](SignalResponseProxyData.md) |  |  [optional] |
+
+
+
diff --git a/docs/SignalResponseProxy1.md b/docs/SignalResponseProxy1.md
@@ -0,0 +1,14 @@
+
+
+# SignalResponseProxy1
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**SignalResponseProxyData**](SignalResponseProxyData.md) |  |  [optional] |
+|**error** | [**ProductError**](ProductError.md) |  |  [optional] |
+
+
+
diff --git a/docs/SignalResponseProxyData.md b/docs/SignalResponseProxyData.md
@@ -0,0 +1,13 @@
+
+
+# SignalResponseProxyData
+
+
+## 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/SignalResponseRootApps.md b/docs/SignalResponseRootApps.md
@@ -0,0 +1,13 @@
+
+
+# SignalResponseRootApps
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**SignalResponseRootAppsData**](SignalResponseRootAppsData.md) |  |  [optional] |
+
+
+
diff --git a/docs/SignalResponseRootApps1.md b/docs/SignalResponseRootApps1.md
@@ -0,0 +1,14 @@
+
+
+# SignalResponseRootApps1
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**data** | [**SignalResponseRootAppsData**](SignalResponseRootAppsData.md) |  |  [optional] |
+|**error** | [**ProductError**](ProductError.md) |  |  [optional] |
+
+
+
diff --git a/docs/SignalResponseRootAppsData.md b/docs/SignalResponseRootAppsData.md
@@ -0,0 +1,13 @@
+
+
+# SignalResponseRootAppsData
+
+
+## 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 be empty for a browser/iOS event.  |  [optional] |
+
+
+