Merge pull request #72 from fingerprintjs/feature/INTER-109-smart-sig…

…nals

feat: add smart signals support

README.md

@@ -188,32 +188,52 @@ Class | Method | HTTP request | Description
  - [ProductsResponseBotd](docs/Model/ProductsResponseBotd.md)
  - [ProductsResponseIdentification](docs/Model/ProductsResponseIdentification.md)
  - [ProductsResponseIdentificationData](docs/Model/ProductsResponseIdentificationData.md)
+ - [RawDeviceAttributesResult](docs/Model/RawDeviceAttributesResult.md)
  - [Response](docs/Model/Response.md)
  - [ResponseVisits](docs/Model/ResponseVisits.md)
  - [SeenAt](docs/Model/SeenAt.md)
+ - [SignalResponseClonedApp](docs/Model/SignalResponseClonedApp.md)
+ - [SignalResponseClonedAppData](docs/Model/SignalResponseClonedAppData.md)
  - [SignalResponseEmulator](docs/Model/SignalResponseEmulator.md)
  - [SignalResponseEmulatorData](docs/Model/SignalResponseEmulatorData.md)
+ - [SignalResponseFactoryReset](docs/Model/SignalResponseFactoryReset.md)
+ - [SignalResponseFactoryResetData](docs/Model/SignalResponseFactoryResetData.md)
+ - [SignalResponseFrida](docs/Model/SignalResponseFrida.md)
+ - [SignalResponseFridaData](docs/Model/SignalResponseFridaData.md)
  - [SignalResponseIncognito](docs/Model/SignalResponseIncognito.md)
  - [SignalResponseIncognitoData](docs/Model/SignalResponseIncognitoData.md)
  - [SignalResponseIpBlocklist](docs/Model/SignalResponseIpBlocklist.md)
  - [SignalResponseIpInfo](docs/Model/SignalResponseIpInfo.md)
+ - [SignalResponseJailbroken](docs/Model/SignalResponseJailbroken.md)
+ - [SignalResponseJailbrokenData](docs/Model/SignalResponseJailbrokenData.md)
+ - [SignalResponsePrivacySettings](docs/Model/SignalResponsePrivacySettings.md)
+ - [SignalResponsePrivacySettingsData](docs/Model/SignalResponsePrivacySettingsData.md)
  - [SignalResponseProxy](docs/Model/SignalResponseProxy.md)
  - [SignalResponseProxyData](docs/Model/SignalResponseProxyData.md)
+ - [SignalResponseRawDeviceAttributes](docs/Model/SignalResponseRawDeviceAttributes.md)
  - [SignalResponseRootApps](docs/Model/SignalResponseRootApps.md)
  - [SignalResponseRootAppsData](docs/Model/SignalResponseRootAppsData.md)
  - [SignalResponseTampering](docs/Model/SignalResponseTampering.md)
  - [SignalResponseTor](docs/Model/SignalResponseTor.md)
  - [SignalResponseTorData](docs/Model/SignalResponseTorData.md)
+ - [SignalResponseVirtualMachine](docs/Model/SignalResponseVirtualMachine.md)
+ - [SignalResponseVirtualMachineData](docs/Model/SignalResponseVirtualMachineData.md)
  - [SignalResponseVpn](docs/Model/SignalResponseVpn.md)
  - [Subdivision](docs/Model/Subdivision.md)
  - [TamperingResult](docs/Model/TamperingResult.md)
  - [Visit](docs/Model/Visit.md)
  - [VpnResult](docs/Model/VpnResult.md)
  - [VpnResultMethods](docs/Model/VpnResultMethods.md)
+ - [WebhookSignalResponseClonedApp](docs/Model/WebhookSignalResponseClonedApp.md)
  - [WebhookSignalResponseEmulator](docs/Model/WebhookSignalResponseEmulator.md)
+ - [WebhookSignalResponseFactoryReset](docs/Model/WebhookSignalResponseFactoryReset.md)
+ - [WebhookSignalResponseFrida](docs/Model/WebhookSignalResponseFrida.md)
+ - [WebhookSignalResponseJailbroken](docs/Model/WebhookSignalResponseJailbroken.md)
+ - [WebhookSignalResponsePrivacySettings](docs/Model/WebhookSignalResponsePrivacySettings.md)
  - [WebhookSignalResponseProxy](docs/Model/WebhookSignalResponseProxy.md)
  - [WebhookSignalResponseRootApps](docs/Model/WebhookSignalResponseRootApps.md)
  - [WebhookSignalResponseTor](docs/Model/WebhookSignalResponseTor.md)
+ - [WebhookSignalResponseVirtualMachine](docs/Model/WebhookSignalResponseVirtualMachine.md)
  - [WebhookVisit](docs/Model/WebhookVisit.md)
 
 ## Documentation for Authorization

docs/Api/FingerprintApi.md

@@ -12,7 +12,7 @@ Method | HTTP request | Description
 
 Get event by requestId
 
-This endpoint allows you to retrieve an individual analysis event with all the information from each activated product (Identification, Bot Detection, and others). Products that are not activated for your application or not relevant to the event's detected platform (web, iOS, Android) are not included in the response.   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 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`.
 
 ### Example
 ```php

docs/Model/BotdDetectionResult.md

@@ -1,4 +1,6 @@
 # BotdDetectionResult
+Stores bot detection result
+
 
 ## Properties
 Name | Type | Description | Notes

docs/Model/BotdResult.md

@@ -1,4 +1,6 @@
 # BotdResult
+Contains all the information from Bot Detection product
+
 
 ## Properties
 Name | Type | Description | Notes

docs/Model/EventResponse.md

@@ -1,4 +1,6 @@
 # EventResponse
+Contains results from all activated products - Fingerprint Pro, Bot Detection, and others.
+
 
 ## Properties
 Name | Type | Description | Notes

docs/Model/IpInfoResult.md

@@ -1,4 +1,6 @@
 # IpInfoResult
+Details about the request IP address. Has separate fields for v4 and v6 IP address versions.
+
 
 ## Properties
 Name | Type | Description | Notes

docs/Model/ProductsResponse.md

@@ -1,4 +1,6 @@
 # ProductsResponse
+Contains all the information from each activated product - Fingerprint Pro or Bot Detection
+
 
 ## Properties
 Name | Type | Description | Notes
@@ -9,11 +11,18 @@ Name | Type | Description | Notes
 **incognito** | [**\Fingerprint\ServerAPI\Model\SignalResponseIncognito**](SignalResponseIncognito.md) |  | [optional] 
 **root_apps** | [**\Fingerprint\ServerAPI\Model\SignalResponseRootApps**](SignalResponseRootApps.md) |  | [optional] 
 **emulator** | [**\Fingerprint\ServerAPI\Model\SignalResponseEmulator**](SignalResponseEmulator.md) |  | [optional] 
+**cloned_app** | [**\Fingerprint\ServerAPI\Model\SignalResponseClonedApp**](SignalResponseClonedApp.md) |  | [optional] 
+**factory_reset** | [**\Fingerprint\ServerAPI\Model\SignalResponseFactoryReset**](SignalResponseFactoryReset.md) |  | [optional] 
+**jailbroken** | [**\Fingerprint\ServerAPI\Model\SignalResponseJailbroken**](SignalResponseJailbroken.md) |  | [optional] 
+**frida** | [**\Fingerprint\ServerAPI\Model\SignalResponseFrida**](SignalResponseFrida.md) |  | [optional] 
 **ip_blocklist** | [**\Fingerprint\ServerAPI\Model\SignalResponseIpBlocklist**](SignalResponseIpBlocklist.md) |  | [optional] 
 **tor** | [**\Fingerprint\ServerAPI\Model\SignalResponseTor**](SignalResponseTor.md) |  | [optional] 
+**privacy_settings** | [**\Fingerprint\ServerAPI\Model\SignalResponsePrivacySettings**](SignalResponsePrivacySettings.md) |  | [optional] 
+**virtual_machine** | [**\Fingerprint\ServerAPI\Model\SignalResponseVirtualMachine**](SignalResponseVirtualMachine.md) |  | [optional] 
 **vpn** | [**\Fingerprint\ServerAPI\Model\SignalResponseVpn**](SignalResponseVpn.md) |  | [optional] 
 **proxy** | [**\Fingerprint\ServerAPI\Model\SignalResponseProxy**](SignalResponseProxy.md) |  | [optional] 
 **tampering** | [**\Fingerprint\ServerAPI\Model\SignalResponseTampering**](SignalResponseTampering.md) |  | [optional] 
+**raw_device_attributes** | [**\Fingerprint\ServerAPI\Model\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)
 

docs/Model/RawDeviceAttributesResult.md

@@ -0,0 +1,9 @@
+# RawDeviceAttributesResult
+It includes 35+ raw browser identification attributes to provide Fingerprint users with even more information than our standard visitor ID provides. This enables Fingerprint users to not have to run our open-source product in conjunction with Fingerprint Pro Plus and Enterprise to get those additional attributes. Warning: The raw signals data can change at any moment as we improve the product. We cannot guarantee the internal shape of raw device attributes to be stable, so typical semantic versioning rules do not apply here. Use this data with caution without assuming a specific structure beyond the generic type provided here.
+
+
+## Properties
+The rawAttributes object follows this general shape: `{ value: any } | { error: { name: string; message: string; } }`
+
+[[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/Model/Response.md

@@ -1,4 +1,6 @@
 # Response
+Fields `lastTimestamp` and `paginationKey` added when `limit` or `before` parameter provided and there is more data to show
+
 
 ## Properties
 Name | Type | Description | Notes

docs/Model/SignalResponseClonedApp.md

@@ -0,0 +1,10 @@
+# SignalResponseClonedApp
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**\Fingerprint\ServerAPI\Model\SignalResponseClonedAppData**](SignalResponseClonedAppData.md) |  | [optional] 
+**error** | [**\Fingerprint\ServerAPI\Model\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/Model/SignalResponseClonedAppData.md

@@ -0,0 +1,9 @@
+# SignalResponseClonedAppData
+
+## 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] 
+
+[[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/Model/SignalResponseEmulatorData.md

@@ -3,7 +3,7 @@
 ## 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] 
+**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] 
 
 [[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/Model/SignalResponseFactoryReset.md

@@ -0,0 +1,10 @@
+# SignalResponseFactoryReset
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**\Fingerprint\ServerAPI\Model\SignalResponseFactoryResetData**](SignalResponseFactoryResetData.md) |  | [optional] 
+**error** | [**\Fingerprint\ServerAPI\Model\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/Model/SignalResponseFactoryResetData.md

@@ -0,0 +1,10 @@
+# SignalResponseFactoryResetData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**time** | [**\DateTime**](\DateTime.md) | 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] 
+
+[[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/Model/SignalResponseFrida.md

@@ -0,0 +1,10 @@
+# SignalResponseFrida
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**\Fingerprint\ServerAPI\Model\SignalResponseFridaData**](SignalResponseFridaData.md) |  | [optional] 
+**error** | [**\Fingerprint\ServerAPI\Model\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/Model/SignalResponseFridaData.md

@@ -0,0 +1,9 @@
+# SignalResponseFridaData
+
+## 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] 
+
+[[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/Model/SignalResponseJailbroken.md

@@ -0,0 +1,10 @@
+# SignalResponseJailbroken
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**\Fingerprint\ServerAPI\Model\SignalResponseJailbrokenData**](SignalResponseJailbrokenData.md) |  | [optional] 
+**error** | [**\Fingerprint\ServerAPI\Model\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/Model/SignalResponseJailbrokenData.md

@@ -0,0 +1,9 @@
+# SignalResponseJailbrokenData
+
+## 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] 
+
+[[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/Model/SignalResponsePrivacySettings.md

@@ -0,0 +1,10 @@
+# SignalResponsePrivacySettings
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**\Fingerprint\ServerAPI\Model\SignalResponsePrivacySettingsData**](SignalResponsePrivacySettingsData.md) |  | [optional] 
+**error** | [**\Fingerprint\ServerAPI\Model\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/Model/SignalResponsePrivacySettingsData.md

@@ -0,0 +1,9 @@
+# SignalResponsePrivacySettingsData
+
+## 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] 
+
+[[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/Model/SignalResponseRawDeviceAttributes.md

@@ -0,0 +1,9 @@
+# SignalResponseRawDeviceAttributes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**\Fingerprint\ServerAPI\Model\RawDeviceAttributesResult**](RawDeviceAttributesResult.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/Model/SignalResponseRootAppsData.md

@@ -3,7 +3,7 @@
 ## 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] 
+**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 or the client is not Android. | [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/Model/SignalResponseVirtualMachine.md

@@ -0,0 +1,10 @@
+# SignalResponseVirtualMachine
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**\Fingerprint\ServerAPI\Model\SignalResponseVirtualMachineData**](SignalResponseVirtualMachineData.md) |  | [optional] 
+**error** | [**\Fingerprint\ServerAPI\Model\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/Model/SignalResponseVirtualMachineData.md

@@ -0,0 +1,9 @@
+# SignalResponseVirtualMachineData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**result** | **bool** | `true` if the request came from a browser running inside a virtual machine (e.g. VMWare), `false` otherwise. | [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/Model/WebhookSignalResponseClonedApp.md

@@ -0,0 +1,9 @@
+# WebhookSignalResponseClonedApp
+
+## 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] 
+
+[[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/Model/WebhookSignalResponseEmulator.md

@@ -3,7 +3,7 @@
 ## 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] 
+**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 isn't Android. | [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/Model/WebhookSignalResponseFactoryReset.md

@@ -0,0 +1,10 @@
+# WebhookSignalResponseFactoryReset
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**time** | [**\DateTime**](\DateTime.md) | 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] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+