OpenAPI schema sync (v3.2.0)

.changeset/developer-tools-android.md

@@ -0,0 +1,5 @@
+---
+'@fingerprint/python-sdk': minor
+---
+
+**events**: Add Android platform support to `developer_tools` smart signal for API v3

.changeset/device-rarity-smart-signal.md

@@ -0,0 +1,5 @@
+---
+'@fingerprint/python-sdk': minor
+---
+
+**events**: Add Device Rarity Smart Signal

.changeset/proxy-ml-score.md

@@ -0,0 +1,5 @@
+---
+'@fingerprint/python-sdk': minor
+---
+
+**events**: Add `proxy_ml_score` to `Event`

.changeset/raw-device-attributes-font-hash-timezone-offset.md

@@ -0,0 +1,5 @@
+---
+'@fingerprint/python-sdk': minor
+---
+
+**events**: Add `font_hash` and `timezone_offset` fields for the `RawDeviceAttributes`

.changeset/raw-device-attributes-mobile-android.md

@@ -0,0 +1,5 @@
+---
+'@fingerprint/python-sdk': minor
+---
+
+**events**: Enable `raw_device_attributes` for Android devices. Only `device_manufacturer` and `device_model` are currently supported for Android devices.

.changeset/raw-device-attributes-mobile-ios.md

@@ -0,0 +1,5 @@
+---
+'@fingerprint/python-sdk': minor
+---
+
+**events**: Enable `raw_device_attributes` for iOS devices. Only `device_manufacturer`, `device_model`, `hardware_concurrency`, `languages`, and `screen_resolution` are currently supported for iOS devices.

.changeset/request-read-timeout-error-code.md

@@ -0,0 +1,5 @@
+---
+'@fingerprint/python-sdk': minor
+---
+
+**events**: Add `request_read_timeout` error code

.openapi-generator/FILES

@@ -32,6 +32,7 @@ docs/PluginsInnerMimeTypesInner.md
 docs/Proximity.md
 docs/ProxyConfidence.md
 docs/ProxyDetails.md
+docs/RareDevicePercentileBucket.md
 docs/RawDeviceAttributes.md
 docs/RequestHeaderModifications.md
 docs/RuleActionHeaderField.md
@@ -40,6 +41,7 @@ docs/SDK.md
 docs/SealedResults.md
 docs/SearchEventsBot.md
 docs/SearchEventsIncrementalIdentificationStatus.md
+docs/SearchEventsRareDevicePercentileBucket.md
 docs/SearchEventsSdkPlatform.md
 docs/SearchEventsVpnConfidence.md
 docs/SupplementaryIDHighRecall.md
@@ -91,13 +93,15 @@ fingerprint_server_sdk/models/plugins_inner_mime_types_inner.py
 fingerprint_server_sdk/models/proximity.py
 fingerprint_server_sdk/models/proxy_confidence.py
 fingerprint_server_sdk/models/proxy_details.py
+fingerprint_server_sdk/models/rare_device_percentile_bucket.py
 fingerprint_server_sdk/models/raw_device_attributes.py
 fingerprint_server_sdk/models/request_header_modifications.py
 fingerprint_server_sdk/models/rule_action_header_field.py
 fingerprint_server_sdk/models/rule_action_type.py
 fingerprint_server_sdk/models/sdk.py
 fingerprint_server_sdk/models/search_events_bot.py
 fingerprint_server_sdk/models/search_events_incremental_identification_status.py
+fingerprint_server_sdk/models/search_events_rare_device_percentile_bucket.py
 fingerprint_server_sdk/models/search_events_sdk_platform.py
 fingerprint_server_sdk/models/search_events_vpn_confidence.py
 fingerprint_server_sdk/models/supplementary_id_high_recall.py

.schema-version

@@ -1 +1 @@
-v3.1.0
+v3.2.0

README.md

@@ -356,13 +356,15 @@ Class | Method | HTTP request | Description
  - [Proximity](docs/Proximity.md)
  - [ProxyConfidence](docs/ProxyConfidence.md)
  - [ProxyDetails](docs/ProxyDetails.md)
+ - [RareDevicePercentileBucket](docs/RareDevicePercentileBucket.md)
  - [RawDeviceAttributes](docs/RawDeviceAttributes.md)
  - [RequestHeaderModifications](docs/RequestHeaderModifications.md)
  - [RuleActionHeaderField](docs/RuleActionHeaderField.md)
  - [RuleActionType](docs/RuleActionType.md)
  - [SDK](docs/SDK.md)
  - [SearchEventsBot](docs/SearchEventsBot.md)
  - [SearchEventsIncrementalIdentificationStatus](docs/SearchEventsIncrementalIdentificationStatus.md)
+ - [SearchEventsRareDevicePercentileBucket](docs/SearchEventsRareDevicePercentileBucket.md)
  - [SearchEventsSdkPlatform](docs/SearchEventsSdkPlatform.md)
  - [SearchEventsVpnConfidence](docs/SearchEventsVpnConfidence.md)
  - [SupplementaryIDHighRecall](docs/SupplementaryIDHighRecall.md)

docs/ErrorCode.md

@@ -2,6 +2,7 @@
 Error code:
 * `request_cannot_be_parsed` - The query parameters or JSON payload contains some errors
   that prevented us from parsing it (wrong type/surpassed limits).
+* `request_read_timeout` - The request body could not be read before the connection timed out.
 * `secret_api_key_required` - secret API key in header is missing or empty.
 * `secret_api_key_not_found` - No Fingerprint workspace found for specified secret API key.
 * `public_api_key_required` - public API key in header is missing or empty.
@@ -27,6 +28,7 @@ Error code:
 ## Enum
 
 * `REQUEST_CANNOT_BE_PARSED` (value: `'request_cannot_be_parsed'`)
+* `REQUEST_READ_TIMEOUT` (value: `'request_read_timeout'`)
 * `SECRET_API_KEY_REQUIRED` (value: `'secret_api_key_required'`)
 * `SECRET_API_KEY_NOT_FOUND` (value: `'secret_api_key_not_found'`)
 * `PUBLIC_API_KEY_REQUIRED` (value: `'public_api_key_required'`)

docs/Event.md

@@ -36,6 +36,7 @@ Name | Type | Description | Notes
 **proxy** | **bool** | IP address was used by a public proxy provider or belonged to a known recent residential proxy  | [optional] 
 **proxy_confidence** | [**ProxyConfidence**](ProxyConfidence.md) |  | [optional] 
 **proxy_details** | [**ProxyDetails**](ProxyDetails.md) |  | [optional] 
+**proxy_ml_score** | **float** | Machine learning–based proxy score, represented as a floating-point value between 0 and 1 (inclusive), with up to three decimal places of precision. A higher score means a higher confidence in the positive `proxy` detection result  | [optional] 
 **incognito** | **bool** | `true` if we detected incognito mode used in the browser, `false` otherwise.  | [optional] 
 **jailbroken** | **bool** | iOS specific jailbreak detection. There are 2 values:  * `true` - Jailbreak detected. * `false` - No signs of jailbreak or the client is not iOS.  | [optional] 
 **location_spoofing** | **bool** | Flag indicating whether the request came from a mobile device with location spoofing enabled. | [optional] 
@@ -45,9 +46,9 @@ Name | Type | Description | Notes
 **rule_action** | [**EventRuleAction**](EventRuleAction.md) |  | [optional] 
 **simulator** | **bool** | iOS specific simulator detection. There are 2 values: * `true` - Simulator environment detected. * `false` - No signs of simulator or the client is not iOS.  | [optional] 
 **suspect_score** | **int** | Suspect Score is an easy way to integrate Smart Signals into your fraud protection work flow.  It is a weighted representation of all Smart Signals present in the payload that helps identify suspicious activity. The value range is [0; S] where S is sum of all Smart Signals weights.  See more details here: https://docs.fingerprint.com/docs/suspect-score  | [optional] 
-**tampering** | **bool** | Flag indicating browser tampering was detected. This happens when either:   * There are inconsistencies in the browser configuration that cross internal tampering thresholds (see `tampering_details.anomaly_score`).   * The browser signature resembles an \"anti-detect\" browser specifically designed to evade fingerprinting (see `tampering_details.anti_detect_browser`).  | [optional] 
+**tampering** | **bool** | The field can be used as a standalone flag for tampering detection. Alternatively, the more granular fields documented below can be used for workflows that require more context. * `true` if tampering is detected through an anomalous browser signature, anti-detect browser detection, or other tampering-related methods * `false` if none of the tampering checks return a positive result  | [optional] 
 **tampering_confidence** | [**TamperingConfidence**](TamperingConfidence.md) |  | [optional] 
-**tampering_ml_score** | **float** | A score that indicates the models calculated probability that an event is coming from an anti detect browser.   * Values above `0.8` indicate that the request is an anti detect browser based on the ml model   * Values below `0.8` indicate that the request is not an anti detect browser based on the ml model  | [optional] 
+**tampering_ml_score** | **float** | The output of this model is captured as tampering_ml_score, a number indicating how likely an event is coming from an anti detect browser. Values close to 1 signify higher confidence and we consider anything above the threshold of 0.8 to be actionable (the result and anti_detect_browser fields conveniently captures that fact)  | [optional] 
 **tampering_details** | [**TamperingDetails**](TamperingDetails.md) |  | [optional] 
 **velocity** | [**Velocity**](Velocity.md) |  | [optional] 
 **virtual_machine** | **bool** | `true` if the request came from a browser running inside a virtual machine (e.g. VMWare), `false` otherwise.  | [optional] 
@@ -58,6 +59,8 @@ Name | Type | Description | Notes
 **vpn_origin_country** | **str** | Country of the request (only for Android SDK version >= 2.4.0, ISO 3166 format or unknown).  | [optional] 
 **vpn_methods** | [**VpnMethods**](VpnMethods.md) |  | [optional] 
 **high_activity_device** | **bool** | Flag indicating if the request came from a high-activity visitor. | [optional] 
+**rare_device** | **bool** | `true` if the device is considered rare based on its combination of hardware and software attributes.  A device is classified as rare if it falls within the top 99.9 percentile (lowest-frequency segment) of observed traffic,  or if its configuration has not been previously seen (`not_seen`). > This Smart Signal is currently in beta and only available to select customers. If you are interested, please [contact our support team](https://fingerprint.com/support/).  | [optional] 
+**rare_device_percentile_bucket** | [**RareDevicePercentileBucket**](RareDevicePercentileBucket.md) |  | [optional] 
 **raw_device_attributes** | [**RawDeviceAttributes**](RawDeviceAttributes.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)