Merge pull request #31 from fingerprintjs/feature/INTER-569-update-sc…

…hema [INTER-569] Update schema
fingerprintjs · Feb 29, 2024 · 53f8546 · 53f8546
2 parents 6c7897d + a704324
commit 53f8546
Show file tree

Hide file tree

Showing 125 changed files with 2,043 additions and 5,411 deletions.
diff --git a/README.md b/README.md
@@ -255,80 +255,74 @@ 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)
  - [Error](docs/Error.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)
  - [RawDeviceAttributesResultValue](docs/RawDeviceAttributesResultValue.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)
 
 

diff --git a/docs/BotdResult.md b/docs/BotdResult.md
@@ -11,8 +11,9 @@ 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] |
+|**userAgent** | **String** |  |  |
+|**requestId** | **String** |  |  |
+|**linkedId** | **String** |  |  [optional] |
 |**bot** | [**BotdDetectionResult**](BotdDetectionResult.md) |  |  |
 
 

diff --git a/docs/SignalResponseClonedAppData.md → docs/ClonedAppResult.md b/docs/SignalResponseClonedAppData.md → docs/ClonedAppResult.md
@@ -1,13 +1,13 @@
 
 
-# SignalResponseClonedAppData
+# ClonedAppResult
 
 
 ## Properties
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**result** | **Boolean** | 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** | **Boolean** | 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.  |  |
 
 
 
diff --git a/docs/DeprecatedIPLocation.md b/docs/DeprecatedIPLocation.md
@@ -0,0 +1,22 @@
+
+
+# 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 |
+|------------ | ------------- | ------------- | -------------|
+|**accuracyRadius** | **Integer** | The IP address is likely to be within this radius (in km) of the specified location. |  [optional] |
+|**latitude** | **Double** |  |  [optional] |
+|**longitude** | **Double** |  |  [optional] |
+|**postalCode** | **String** |  |  [optional] |
+|**timezone** | **String** |  |  [optional] |
+|**city** | [**DeprecatedIPLocationCity**](DeprecatedIPLocationCity.md) |  |  [optional] |
+|**country** | [**Location**](Location.md) |  |  [optional] |
+|**continent** | [**Location**](Location.md) |  |  [optional] |
+|**subdivisions** | [**List&lt;Subdivision&gt;**](Subdivision.md) |  |  [optional] |
+
+
+
diff --git a/docs/DeprecatedIPLocationCity.md b/docs/DeprecatedIPLocationCity.md
@@ -0,0 +1,13 @@
+
+
+# DeprecatedIPLocationCity
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**name** | **String** |  |  [optional] |
+
+
+
diff --git a/docs/SignalResponseEmulatorData.md → docs/EmulatorResult.md b/docs/SignalResponseEmulatorData.md → docs/EmulatorResult.md
@@ -1,13 +1,13 @@
 
 
-# SignalResponseEmulatorData
+# EmulatorResult
 
 
 ## Properties
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**result** | **Boolean** | 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** | **Boolean** | 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.  |  |
 
 
 
diff --git a/docs/EventResponse.md b/docs/EventResponse.md
@@ -8,7 +8,8 @@ Contains results from all activated products - Fingerprint Pro, Bot Detection, a
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**products** | [**ProductsResponse**](ProductsResponse.md) |  |  [optional] |
+|**products** | [**ProductsResponse**](ProductsResponse.md) |  |  |
+|**error** | [**ProductError**](ProductError.md) |  |  [optional] |
 
 
 
diff --git a/docs/FactoryResetResult.md b/docs/FactoryResetResult.md
@@ -0,0 +1,14 @@
+
+
+# FactoryResetResult
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**time** | **OffsetDateTime** | 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** | **Long** | Same value as it's in the `time` field but represented in timestamp format. |  |
+
+
+
diff --git a/docs/FingerprintApi.md b/docs/FingerprintApi.md
@@ -17,7 +17,7 @@ All URIs are relative to *https://api.fpjs.io*
 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.
+**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`.

diff --git a/docs/FridaResult.md b/docs/FridaResult.md
@@ -0,0 +1,13 @@
+
+
+# FridaResult
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**result** | **Boolean** | [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.  |  |
+
+
+
diff --git a/docs/HighActivityResult.md b/docs/HighActivityResult.md
@@ -7,7 +7,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**result** | **Boolean** | Flag indicating whether the request came from a high activity visitor. |  [optional] |
+|**result** | **Boolean** | Flag indicating whether the request came from a high activity visitor. |  |
 |**dailyRequests** | [**BigDecimal**](BigDecimal.md) | Number of requests from the same visitor in the previous day. |  [optional] |
 
 

diff --git a/docs/IPLocation.md b/docs/IPLocation.md
@@ -2,7 +2,6 @@
 
 # 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
 

diff --git a/docs/SignalResponseIncognitoData.md → docs/IncognitoResult.md b/docs/SignalResponseIncognitoData.md → docs/IncognitoResult.md
@@ -1,13 +1,13 @@
 
 
-# SignalResponseIncognitoData
+# IncognitoResult
 
 
 ## Properties
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**result** | **Boolean** | `true` if we detected incognito mode used in the browser, `false` otherwise.  |  [optional] |
+|**result** | **Boolean** | `true` if we detected incognito mode used in the browser, `false` otherwise.  |  |
 
 
 
diff --git a/docs/IpBlockListResult.md b/docs/IpBlockListResult.md
@@ -7,8 +7,8 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**result** | **Boolean** | `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** | **Boolean** | `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) |  |  |
 
 
 
diff --git a/docs/IpBlockListResultDetails.md b/docs/IpBlockListResultDetails.md
@@ -7,8 +7,8 @@
 
 | 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] |
+|**emailSpam** | **Boolean** | IP address was part of a known email spam attack (SMTP). |  |
+|**attackSource** | **Boolean** | IP address was part of a known network attack (SSH/HTTPS). |  |
 
 
 
diff --git a/docs/IpInfoResultV4.md b/docs/IpInfoResultV4.md
@@ -7,8 +7,8 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**address** | **String** |  |  [optional] |
-|**geolocation** | [**IPLocation**](IPLocation.md) |  |  [optional] |
+|**address** | **String** |  |  |
+|**geolocation** | [**IPLocation**](IPLocation.md) |  |  |
 |**asn** | [**ASN**](ASN.md) |  |  [optional] |
 |**datacenter** | [**DataCenter**](DataCenter.md) |  |  [optional] |
 

diff --git a/docs/IpInfoResultV6.md b/docs/IpInfoResultV6.md
@@ -7,8 +7,8 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**address** | **String** |  |  [optional] |
-|**geolocation** | [**IPLocation**](IPLocation.md) |  |  [optional] |
+|**address** | **String** |  |  |
+|**geolocation** | [**IPLocation**](IPLocation.md) |  |  |
 |**asn** | [**ASN**](ASN.md) |  |  [optional] |
 |**datacenter** | [**DataCenter**](DataCenter.md) |  |  [optional] |
 

diff --git a/docs/SignalResponseJailbrokenData.md → docs/JailbrokenResult.md b/docs/SignalResponseJailbrokenData.md → docs/JailbrokenResult.md
@@ -1,13 +1,13 @@
 
 
-# SignalResponseJailbrokenData
+# JailbrokenResult
 
 
 ## Properties
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**result** | **Boolean** | iOS specific jailbreak detection. There are 2 values: • `true` - Jailbreak detected • `false` - No signs of jailbreak or the client is not iOS.  |  [optional] |
+|**result** | **Boolean** | iOS specific jailbreak detection. There are 2 values: • `true` - Jailbreak detected • `false` - No signs of jailbreak or the client is not iOS.  |  |
 
 
 
diff --git a/docs/LocationSpoofingResult.md b/docs/LocationSpoofingResult.md
@@ -7,7 +7,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**result** | **Boolean** | Flag indicating whether the request came from a device with location spoofing enabled. |  [optional] |
+|**result** | **Boolean** | Flag indicating whether the request came from a mobile device with location spoofing enabled. |  |
 
 
 
diff --git a/docs/SignalResponsePrivacySettingsData.md → docs/PrivacySettingsResult.md b/docs/SignalResponsePrivacySettingsData.md → docs/PrivacySettingsResult.md
@@ -1,13 +1,13 @@
 
 
-# SignalResponsePrivacySettingsData
+# PrivacySettingsResult
 
 
 ## Properties
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**result** | **Boolean** | `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** | **Boolean** | `true` if the request is from a privacy aware browser (e.g. Tor) or from a browser in which fingerprinting is blocked. Otherwise `false`.  |  |
 
 
 
diff --git a/docs/ProductsResponse.md b/docs/ProductsResponse.md
@@ -27,6 +27,7 @@ Contains all information about the request identified by `requestId`, depending
 |**tampering** | [**SignalResponseTampering**](SignalResponseTampering.md) |  |  [optional] |
 |**highActivity** | [**SignalResponseHighActivity**](SignalResponseHighActivity.md) |  |  [optional] |
 |**locationSpoofing** | [**SignalResponseLocationSpoofing**](SignalResponseLocationSpoofing.md) |  |  [optional] |
+|**suspectScore** | [**SignalResponseSuspectScore**](SignalResponseSuspectScore.md) |  |  [optional] |
 |**rawDeviceAttributes** | [**SignalResponseRawDeviceAttributes**](SignalResponseRawDeviceAttributes.md) |  |  [optional] |
 
 

diff --git a/docs/ProductsResponseIdentificationData.md b/docs/ProductsResponseIdentificationData.md
@@ -11,13 +11,13 @@
 |**browserDetails** | [**BrowserDetails**](BrowserDetails.md) |  |  |
 |**incognito** | **Boolean** | Flag if user used incognito session. |  |
 |**ip** | **String** |  |  |
-|**ipLocation** | [**IPLocation**](IPLocation.md) |  |  [optional] |
+|**ipLocation** | [**DeprecatedIPLocation**](DeprecatedIPLocation.md) |  |  [optional] |
 |**timestamp** | **Long** | Timestamp of the event with millisecond precision in Unix time. |  |
 |**time** | **OffsetDateTime** | Time expressed according to ISO 8601 in UTC format. |  |
-|**url** | **URI** | Page URL from which identification request was sent. |  |
-|**tag** | **Map&lt;String, Object&gt;** | A customer-provided value or an object that was sent with identification request. |  [optional] |
+|**url** | **URI** | Page URL from which the identification request was sent. |  |
+|**tag** | **Map&lt;String, Object&gt;** | A customer-provided value or an object that was sent with identification request. |  |
 |**linkedId** | **String** | A customer-provided id that was sent with identification request. |  [optional] |
-|**confidence** | [**Confidence**](Confidence.md) |  |  |
+|**confidence** | [**Confidence**](Confidence.md) |  |  [optional] |
 |**visitorFound** | **Boolean** | Attribute represents if a visitor had been identified before. |  |
 |**firstSeenAt** | [**SeenAt**](SeenAt.md) |  |  |
 |**lastSeenAt** | [**SeenAt**](SeenAt.md) |  |  |

diff --git a/docs/SignalResponseTorData.md → docs/ProxyResult.md b/docs/SignalResponseTorData.md → docs/ProxyResult.md
@@ -1,13 +1,13 @@
 
 
-# SignalResponseTorData
+# ProxyResult
 
 
 ## Properties
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**result** | **Boolean** | `true` if the request IP address is a known tor exit node, `false` otherwise.  |  [optional] |
+|**result** | **Boolean** | `true` if the request IP address is used by a public proxy provider, `false` otherwise.  |  |
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,7 +2,6 @@

		# 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

Expand Down