Merge pull request #49 from fingerprintjs/update-schema-INTER-578

Big schema update

CODEOWNERS

@@ -1 +1 @@
-* @ilfa
+* @ilfa @sshelomentsev @TheUnderScorer

README.md

@@ -191,79 +191,73 @@ 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)
+ - [DeprecatedIPLocationCity](docs/DeprecatedIPLocationCity.md)
+ - [EmulatorResult](docs/EmulatorResult.md)
  - [ErrorEvent403Response](docs/ErrorEvent403Response.md)
  - [ErrorEvent403ResponseError](docs/ErrorEvent403ResponseError.md)
  - [ErrorEvent404Response](docs/ErrorEvent404Response.md)
  - [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)
  - [RawDeviceAttributesResult](docs/RawDeviceAttributesResult.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)
 
 ## Documentation For Authorization

docs/BotdResult.md

@@ -8,8 +8,9 @@ Name | Type | Description | Notes
 **ip** | **str** | IP address of the requesting browser or bot. | 
 **time** | **datetime** | 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** | **str** | Page URL from which identification request was sent. | 
-**user_agent** | **str** |  | [optional] 
-**request_id** | **str** |  | [optional] 
+**user_agent** | **str** |  | 
+**request_id** | **str** |  | 
+**linked_id** | **str** |  | [optional] 
 **bot** | [**BotdDetectionResult**](BotdDetectionResult.md) |  | 
 
 [[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/SignalResponseClonedAppData.md → docs/ClonedAppResult.md

@@ -1,9 +1,9 @@
-# SignalResponseClonedAppData
+# ClonedAppResult
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**result** | **bool** | 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** | **bool** | 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.  | 
 
 [[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/DeprecatedIPLocation.md

@@ -0,0 +1,19 @@
+# DeprecatedIPLocation
+This field is **deprecated** and will not return a result for **applications created after January 23rd, 2024**. Please use the [IP Geolocation Smart signal](https://dev.fingerprint.com/docs/smart-signals-overview#ip-geolocation) for geolocation information.
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accuracy_radius** | **int** | The IP address is likely to be within this radius (in km) of the specified location. | [optional] 
+**latitude** | **float** |  | [optional] 
+**longitude** | **float** |  | [optional] 
+**postal_code** | **str** |  | [optional] 
+**timezone** | **str** |  | [optional] 
+**city** | [**DeprecatedIPLocationCity**](DeprecatedIPLocationCity.md) |  | [optional] 
+**country** | [**Location**](Location.md) |  | [optional] 
+**continent** | [**Location**](Location.md) |  | [optional] 
+**subdivisions** | [**list[Subdivision]**](Subdivision.md) |  | [optional] 
+
+[[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/WebhookSignalResponseTor.md → docs/DeprecatedIPLocationCity.md

@@ -1,9 +1,9 @@
-# WebhookSignalResponseTor
+# DeprecatedIPLocationCity
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**result** | **bool** | `true` if the request IP address is a known tor exit node, `false` otherwise.  | [optional] 
+**name** | **str** |  | [optional] 
 
 [[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 → docs/EmulatorResult.md

@@ -1,9 +1,9 @@
-# SignalResponseEmulatorData
+# EmulatorResult
 
 ## 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 or the client is not Android.  | [optional] 
+**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 or the client is not Android.  | 
 
 [[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/EventResponse.md

@@ -5,7 +5,8 @@ Contains results from all activated products - Fingerprint Pro, Bot Detection, a
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**products** | [**ProductsResponse**](ProductsResponse.md) |  | [optional] 
+**products** | [**ProductsResponse**](ProductsResponse.md) |  | 
+**error** | [**ProductError**](ProductError.md) |  | [optional] 
 
 [[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/WebhookSignalResponseFactoryReset.md → docs/FactoryResetResult.md

@@ -1,10 +1,10 @@
-# WebhookSignalResponseFactoryReset
+# FactoryResetResult
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**time** | **datetime** | Time in UTC for the Android client when recent factory reset was done.  If there is no sign of factory reset or the client isn't Android, the field will be epoch time.  | [optional] 
-**timestamp** | **int** | Same value as it's in the `time` field but represented in timestamp format. | [optional] 
+**time** | **datetime** | 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** | **int** | Same value as it's in the `time` field but represented in timestamp format. | 
 
 [[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/FingerprintApi.md

@@ -12,7 +12,7 @@ Method | HTTP request | Description
 
 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. 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`. 
+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 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`. 
 
 ### Example
 ```python

docs/SignalResponseFridaData.md → docs/FridaResult.md

@@ -1,9 +1,9 @@
-# SignalResponseFridaData
+# FridaResult
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**result** | **bool** | iOS specific [Frida](https://frida.re/docs/ios/) detection. There are 2 values: • `true` - Frida detected • `false` - No signs of Frida or the client is not iOS.  | [optional] 
+**result** | **bool** | [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.  | 
 
 [[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/HighActivityResult.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**result** | **bool** | Flag indicating whether the request came from a high activity visitor. | [optional] 
+**result** | **bool** | Flag indicating whether the request came from a high activity visitor. | 
 **daily_requests** | **float** | Number of requests from the same visitor in the previous day. | [optional] 
 
 [[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/IPLocation.md

@@ -1,6 +1,4 @@
 # IPLocation
-This field is **deprecated** and will not return a result for **accounts created after December 18th, 2023**. Please use the [`ipInfo` Smart signal](https://dev.fingerprint.com/docs/smart-signals-overview#ip-geolocation) for geolocation information.
-
 
 ## Properties
 Name | Type | Description | Notes

docs/SignalResponseIncognitoData.md → docs/IncognitoResult.md

@@ -1,9 +1,9 @@
-# SignalResponseIncognitoData
+# IncognitoResult
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**result** | **bool** | `true` if we detected incognito mode used in the browser, `false` otherwise.  | [optional] 
+**result** | **bool** | `true` if we detected incognito mode used in the browser, `false` otherwise.  | 
 
 [[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

@@ -3,8 +3,8 @@
 ## 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] 
-**details** | [**IpBlockListResultDetails**](IpBlockListResultDetails.md) |  | [optional] 
+**result** | **bool** | `true` if request IP address is part of any database that we use to search for known malicious actors, `false` otherwise.  | 
+**details** | [**IpBlockListResultDetails**](IpBlockListResultDetails.md) |  | 
 
 [[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

@@ -3,8 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**email_spam** | **bool** | IP address was part of a known email spam attack (SMTP). | [optional] 
-**attack_source** | **bool** | IP address was part of a known network attack (SSH/HTTPS). | [optional] 
+**email_spam** | **bool** | IP address was part of a known email spam attack (SMTP). | 
+**attack_source** | **bool** | IP address was part of a known network attack (SSH/HTTPS). | 
 
 [[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

@@ -3,8 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**address** | **str** |  | [optional] 
-**geolocation** | [**IPLocation**](IPLocation.md) |  | [optional] 
+**address** | **str** |  | 
+**geolocation** | [**IPLocation**](IPLocation.md) |  | 
 **asn** | [**ASN**](ASN.md) |  | [optional] 
 **datacenter** | [**DataCenter**](DataCenter.md) |  | [optional] 
 

docs/IpInfoResultV6.md

@@ -3,8 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**address** | **str** |  | [optional] 
-**geolocation** | [**IPLocation**](IPLocation.md) |  | [optional] 
+**address** | **str** |  | 
+**geolocation** | [**IPLocation**](IPLocation.md) |  | 
 **asn** | [**ASN**](ASN.md) |  | [optional] 
 **datacenter** | [**DataCenter**](DataCenter.md) |  | [optional] 
 

docs/SignalResponseJailbrokenData.md → docs/JailbrokenResult.md

@@ -1,9 +1,9 @@
-# SignalResponseJailbrokenData
+# JailbrokenResult
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**result** | **bool** | iOS specific jailbreak detection. There are 2 values: • `true` - Jailbreak detected • `false` - No signs of jailbreak or the client is not iOS.  | [optional] 
+**result** | **bool** | iOS specific jailbreak detection. There are 2 values: • `true` - Jailbreak detected • `false` - No signs of jailbreak or the client is not iOS.  | 
 
 [[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/LocationSpoofingResult.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**result** | **bool** | Flag indicating whether the request came from a device with location spoofing enabled. | [optional] 
+**result** | **bool** | Flag indicating whether the request came from a mobile device with location spoofing enabled. | 
 
 [[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/SignalResponsePrivacySettingsData.md → docs/PrivacySettingsResult.md

@@ -1,9 +1,9 @@
-# SignalResponsePrivacySettingsData
+# PrivacySettingsResult
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**result** | **bool** | `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** | **bool** | `true` if the request is from a privacy aware browser (e.g. Tor) or from a browser in which fingerprinting is blocked. Otherwise `false`.  | 
 
 [[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/ProductsResponse.md

@@ -24,6 +24,7 @@ Name | Type | Description | Notes
 **tampering** | [**SignalResponseTampering**](SignalResponseTampering.md) |  | [optional] 
 **high_activity** | [**SignalResponseHighActivity**](SignalResponseHighActivity.md) |  | [optional] 
 **location_spoofing** | [**SignalResponseLocationSpoofing**](SignalResponseLocationSpoofing.md) |  | [optional] 
+**suspect_score** | [**SignalResponseSuspectScore**](SignalResponseSuspectScore.md) |  | [optional] 
 **raw_device_attributes** | [**SignalResponseRawDeviceAttributes**](SignalResponseRawDeviceAttributes.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)