Merge pull request #34 from fingerprintjs/update-schema

Update schema

README.md

@@ -128,7 +128,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)
@@ -139,19 +138,46 @@ Class | Method | HTTP request | Description
  - [ErrorVisits403](docs/ErrorVisits403.md)
  - [EventResponse](docs/EventResponse.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)
  - [IpLocation](docs/IpLocation.md)
  - [IpLocationCity](docs/IpLocationCity.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)
+ - [SignalResponseEmulatorData](docs/SignalResponseEmulatorData.md)
+ - [SignalResponseIncognito](docs/SignalResponseIncognito.md)
+ - [SignalResponseIncognitoData](docs/SignalResponseIncognitoData.md)
+ - [SignalResponseIpBlocklist](docs/SignalResponseIpBlocklist.md)
+ - [SignalResponseIpInfo](docs/SignalResponseIpInfo.md)
+ - [SignalResponseProxy](docs/SignalResponseProxy.md)
+ - [SignalResponseProxyData](docs/SignalResponseProxyData.md)
+ - [SignalResponseRootApps](docs/SignalResponseRootApps.md)
+ - [SignalResponseRootAppsData](docs/SignalResponseRootAppsData.md)
+ - [SignalResponseTampering](docs/SignalResponseTampering.md)
+ - [SignalResponseTor](docs/SignalResponseTor.md)
+ - [SignalResponseTorData](docs/SignalResponseTorData.md)
+ - [SignalResponseVpn](docs/SignalResponseVpn.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

docs/BotdDetectionResult.md

@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Result** | **string** | Bot detection result:  * `notDetected` - the visitor is not a bot  * `good` - good bot detected, such as Google bot, Baidu Spider, AlexaBot and so on  * `bad` - bad bot detected, such as Selenium, Puppeteer, Playwright, headless browsers, and so on  | [default to null]
+**Type_** | **string** |  | [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)
 

docs/BotdResult.md

@@ -6,6 +6,8 @@ Name | Type | Description | Notes
 **Ip** | **string** | IP address of the requesting browser or bot. | [default to null]
 **Time** | [**time.Time**](time.Time.md) | 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 | [default to null]
 **Url** | **string** | Page URL from which identification request was sent. | [default to null]
+**UserAgent** | **string** |  | [optional] [default to null]
+**RequestId** | **string** |  | [optional] [default to null]
 **Bot** | [***BotdDetectionResult**](BotdDetectionResult.md) |  | [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)

docs/IpBlockListResult.md

@@ -0,0 +1,10 @@
+# IpBlockListResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Result** | **bool** | `true` if request IP address is part of any database that we use to search for known malicious actors, `false` otherwise.  | [optional] [default to null]
+**Details** | [***IpBlockListResultDetails**](IpBlockListResult_details.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)
+

docs/IpBlockListResultDetails.md

@@ -0,0 +1,10 @@
+# IpBlockListResultDetails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**EmailSpam** | **bool** | IP address was part of a known email spam attack (SMTP). | [optional] [default to null]
+**AttackSource** | **bool** | IP address was part of a known network attack (SSH/HTTPS). | [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)
+

docs/IpInfoResult.md

@@ -0,0 +1,10 @@
+# IpInfoResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**V4** | [***IpInfoResultV4**](IpInfoResult_v4.md) |  | [optional] [default to null]
+**V6** | [***IpInfoResultV6**](IpInfoResult_v6.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)
+

docs/IpInfoResultV4.md

@@ -0,0 +1,10 @@
+# IpInfoResultV4
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Address** | **string** |  | [optional] [default to null]
+**Geolocation** | [***IpLocation**](IPLocation.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)
+

docs/IpInfoResultV6.md

@@ -0,0 +1,10 @@
+# IpInfoResultV6
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Address** | **string** |  | [optional] [default to null]
+**Geolocation** | [***IpLocation**](IPLocation.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)
+

docs/BotdError.md → docs/ProductError.md

@@ -1,4 +1,4 @@
-# BotdError
+# ProductError
 
 ## Properties
 Name | Type | Description | Notes

docs/ProductsResponse.md

@@ -5,6 +5,15 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Identification** | [***ProductsResponseIdentification**](ProductsResponseIdentification.md) |  | [optional] [default to null]
 **Botd** | [***ProductsResponseBotd**](ProductsResponseBotd.md) |  | [optional] [default to null]
+**IpInfo** | [***SignalResponseIpInfo**](SignalResponseIpInfo.md) |  | [optional] [default to null]
+**Incognito** | [***SignalResponseIncognito**](SignalResponseIncognito.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)
 

docs/ProductsResponseBotd.md

@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Data** | [***BotdResult**](BotdResult.md) |  | [optional] [default to null]
-**Error_** | [***BotdError**](BotdError.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)
 

docs/SignalResponseEmulator.md

@@ -0,0 +1,10 @@
+# SignalResponseEmulator
+
+## Properties
+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)
+

docs/SignalResponseEmulatorData.md

@@ -0,0 +1,9 @@
+# SignalResponseEmulatorData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Result** | **bool** | 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 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)
+

docs/SignalResponseIncognito.md

@@ -0,0 +1,10 @@
+# SignalResponseIncognito
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Data** | [***SignalResponseIncognitoData**](SignalResponseIncognito_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)
+

docs/SignalResponseIncognitoData.md

@@ -0,0 +1,9 @@
+# SignalResponseIncognitoData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Result** | **bool** | `true` if we detected incognito mode used in the browser, `false` 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)
+

docs/SignalResponseIpBlocklist.md

@@ -0,0 +1,10 @@
+# SignalResponseIpBlocklist
+
+## Properties
+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)
+

docs/SignalResponseIpInfo.md

@@ -0,0 +1,10 @@
+# SignalResponseIpInfo
+
+## Properties
+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)
+

docs/SignalResponseProxy.md

@@ -0,0 +1,10 @@
+# SignalResponseProxy
+
+## Properties
+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)
+

docs/SignalResponseProxyData.md

@@ -0,0 +1,9 @@
+# SignalResponseProxyData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Result** | **bool** | `true` if the request IP address is used by a public proxy provider, `false` 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)
+

docs/SignalResponseRootApps.md

@@ -0,0 +1,10 @@
+# SignalResponseRootApps
+
+## Properties
+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)
+

docs/SignalResponseRootAppsData.md

@@ -0,0 +1,9 @@
+# SignalResponseRootAppsData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Result** | **bool** | Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - 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)
+

docs/SignalResponseTampering.md

@@ -0,0 +1,10 @@
+# SignalResponseTampering
+
+## Properties
+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)
+

docs/SignalResponseTor.md

@@ -0,0 +1,10 @@
+# SignalResponseTor
+
+## Properties
+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)
+

docs/SignalResponseTorData.md

@@ -0,0 +1,9 @@
+# SignalResponseTorData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Result** | **bool** | `true` if the request IP address is a known tor exit node, `false` 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)
+

docs/SignalResponseVpn.md

@@ -0,0 +1,10 @@
+# SignalResponseVpn
+
+## Properties
+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)
+

docs/TamperingResult.md

@@ -0,0 +1,10 @@
+# TamperingResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Result** | **bool** | Flag indicating whether browser tampering was detected according to our internal thresholds. | [optional] [default to null]
+**AnomalyScore** | **float64** | Confidence score (`0.0 - 1.0`) for the tampering detection. Values above `0.5` suggest that we're reasonably sure there was a tampering attempt. Values below `0.5` are genuine browsers. | [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)
+

docs/VpnResult.md

@@ -0,0 +1,10 @@
+# VpnResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Result** | **bool** | VPN or other anonymising service has been used when sending the request. | [optional] [default to null]
+**Methods** | [***VpnResultMethods**](VpnResult_methods.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)
+

docs/VpnResultMethods.md

@@ -0,0 +1,10 @@
+# VpnResultMethods
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**TimezoneMismatch** | **bool** | User's browser timezone doesn't match the timezone from which the request was originally made. | [optional] [default to null]
+**PublicVPN** | **bool** | Request IP address is owned and used by a public VPN service provider. | [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)
+

docs/WebhookSignalResponseEmulator.md

@@ -0,0 +1,9 @@
+# WebhookSignalResponseEmulator
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Result** | **bool** | 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 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)
+

docs/WebhookSignalResponseProxy.md

@@ -0,0 +1,9 @@
+# WebhookSignalResponseProxy
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Result** | **bool** | `true` if the request IP address is used by a public proxy provider, `false` 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)
+

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: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - 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)
+