OpenAPI schema sync (v3.3.0)

.changeset/all-showers-trade.md

@@ -0,0 +1,5 @@
+---
+'@fingerprint/python-sdk': patch
+---
+
+**events-search**: Remove `default` property from `reverse` query parameter

.changeset/beige-places-drop.md

@@ -0,0 +1,5 @@
+---
+'@fingerprint/python-sdk': patch
+---
+
+**events**: Clarify availability of proxy and VM ML score signals

.changeset/blue-roses-film.md

@@ -0,0 +1,5 @@
+---
+'@fingerprint/python-sdk': patch
+---
+
+**events**: Clarify semantics of `incremental_identification_status`

.changeset/curvy-rice-chew.md

@@ -0,0 +1,5 @@
+---
+'@fingerprint/python-sdk': patch
+---
+
+**visitors**: Clarify rate limits for `deleteVisitorData` operation

.changeset/cute-pumas-pull.md

@@ -0,0 +1,5 @@
+---
+'@fingerprint/python-sdk': minor
+---
+
+**events-search**: Add `start_date_time` and `end_date_time` RFC3339 timestamp filters

.changeset/developer-tools-android-v4.md

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

.changeset/developer-tools-ios.md

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

.changeset/events-rfc3339-timestamps.md

@@ -0,0 +1,5 @@
+---
+'@fingerprint/python-sdk': minor
+---
+
+**events-search**: Accept RFC3339 timestamps for `start` and `end` filter parameters in addition to Unix milliseconds

.changeset/fancy-spiders-flash.md

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

.changeset/loud-donuts-lead.md

@@ -0,0 +1,5 @@
+---
+'@fingerprint/python-sdk': patch
+---
+
+**events-search**: Clarify availability of `rare_device` and `rare_device_percentile_bucket` query parameters

.changeset/quick-cows-battle.md

@@ -0,0 +1,5 @@
+---
+'@fingerprint/python-sdk': minor
+---
+
+**events**: Add iOS platform support to `developer_tools`

.changeset/wet-socks-fold.md

@@ -0,0 +1,5 @@
+---
+'@fingerprint/python-sdk': patch
+---
+
+**events-search**: Fix `pagination_key` example

.changeset/witty-lions-worry.md

@@ -0,0 +1,5 @@
+---
+'@fingerprint/python-sdk': minor
+---
+
+**events-search**: Add `bot_info` filter parameters

.changeset/yellow-ducks-spend.md

@@ -0,0 +1,5 @@
+---
+'@fingerprint/python-sdk': minor
+---
+
+**events-search**: Add `unknown` value to `BotInfoCategory`

.openapi-generator/FILES

@@ -1,5 +1,8 @@
 README.md
 docs/BotInfo.md
+docs/BotInfoCategory.md
+docs/BotInfoConfidence.md
+docs/BotInfoIdentity.md
 docs/BotResult.md
 docs/BrowserDetails.md
 docs/Canvas.md
@@ -27,6 +30,7 @@ docs/IdentificationConfidence.md
 docs/IncrementalIdentificationStatus.md
 docs/Integration.md
 docs/IntegrationSubintegration.md
+docs/LabelsInner.md
 docs/PluginsInner.md
 docs/PluginsInnerMimeTypesInner.md
 docs/Proximity.md
@@ -40,9 +44,12 @@ docs/RuleActionType.md
 docs/SDK.md
 docs/SealedResults.md
 docs/SearchEventsBot.md
+docs/SearchEventsBotInfo.md
+docs/SearchEventsEndParameter.md
 docs/SearchEventsIncrementalIdentificationStatus.md
 docs/SearchEventsRareDevicePercentileBucket.md
 docs/SearchEventsSdkPlatform.md
+docs/SearchEventsStartParameter.md
 docs/SearchEventsVpnConfidence.md
 docs/SupplementaryIDHighRecall.md
 docs/TamperingConfidence.md
@@ -63,6 +70,9 @@ fingerprint_server_sdk/configuration.py
 fingerprint_server_sdk/exceptions.py
 fingerprint_server_sdk/models/__init__.py
 fingerprint_server_sdk/models/bot_info.py
+fingerprint_server_sdk/models/bot_info_category.py
+fingerprint_server_sdk/models/bot_info_confidence.py
+fingerprint_server_sdk/models/bot_info_identity.py
 fingerprint_server_sdk/models/bot_result.py
 fingerprint_server_sdk/models/browser_details.py
 fingerprint_server_sdk/models/canvas.py
@@ -88,6 +98,7 @@ fingerprint_server_sdk/models/ip_block_list.py
 fingerprint_server_sdk/models/ip_info.py
 fingerprint_server_sdk/models/ip_info_v4.py
 fingerprint_server_sdk/models/ip_info_v6.py
+fingerprint_server_sdk/models/labels_inner.py
 fingerprint_server_sdk/models/plugins_inner.py
 fingerprint_server_sdk/models/plugins_inner_mime_types_inner.py
 fingerprint_server_sdk/models/proximity.py
@@ -100,9 +111,12 @@ 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_bot_info.py
+fingerprint_server_sdk/models/search_events_end_parameter.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_start_parameter.py
 fingerprint_server_sdk/models/search_events_vpn_confidence.py
 fingerprint_server_sdk/models/supplementary_id_high_recall.py
 fingerprint_server_sdk/models/tampering_confidence.py

.schema-version

@@ -1 +1 @@
-v3.2.0
+v3.3.0

README.md

@@ -317,7 +317,7 @@ All URIs are relative to *https://api.fpjs.io/v4*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*FingerprintApi* | [**delete_visitor_data**](docs/FingerprintApi.md#delete_visitor_data) | **DELETE** /visitors/{visitor_id} | Delete data by visitor ID
+*FingerprintApi* | [**delete_visitor_data**](docs/FingerprintApi.md#delete_visitor_data) | **DELETE** /visitors/{visitor_id} | Delete a visitor ID
 *FingerprintApi* | [**get_event**](docs/FingerprintApi.md#get_event) | **GET** /events/{event_id} | Get an event by event ID
 *FingerprintApi* | [**search_events**](docs/FingerprintApi.md#search_events) | **GET** /events | Search events
 *FingerprintApi* | [**update_event**](docs/FingerprintApi.md#update_event) | **PATCH** /events/{event_id} | Update an event
@@ -326,6 +326,9 @@ Class | Method | HTTP request | Description
 ## Documentation For Models
 
  - [BotInfo](docs/BotInfo.md)
+ - [BotInfoCategory](docs/BotInfoCategory.md)
+ - [BotInfoConfidence](docs/BotInfoConfidence.md)
+ - [BotInfoIdentity](docs/BotInfoIdentity.md)
  - [BotResult](docs/BotResult.md)
  - [BrowserDetails](docs/BrowserDetails.md)
  - [Canvas](docs/Canvas.md)
@@ -351,6 +354,7 @@ Class | Method | HTTP request | Description
  - [IncrementalIdentificationStatus](docs/IncrementalIdentificationStatus.md)
  - [Integration](docs/Integration.md)
  - [IntegrationSubintegration](docs/IntegrationSubintegration.md)
+ - [LabelsInner](docs/LabelsInner.md)
  - [PluginsInner](docs/PluginsInner.md)
  - [PluginsInnerMimeTypesInner](docs/PluginsInnerMimeTypesInner.md)
  - [Proximity](docs/Proximity.md)
@@ -363,9 +367,12 @@ Class | Method | HTTP request | Description
  - [RuleActionType](docs/RuleActionType.md)
  - [SDK](docs/SDK.md)
  - [SearchEventsBot](docs/SearchEventsBot.md)
+ - [SearchEventsBotInfo](docs/SearchEventsBotInfo.md)
+ - [SearchEventsEndParameter](docs/SearchEventsEndParameter.md)
  - [SearchEventsIncrementalIdentificationStatus](docs/SearchEventsIncrementalIdentificationStatus.md)
  - [SearchEventsRareDevicePercentileBucket](docs/SearchEventsRareDevicePercentileBucket.md)
  - [SearchEventsSdkPlatform](docs/SearchEventsSdkPlatform.md)
+ - [SearchEventsStartParameter](docs/SearchEventsStartParameter.md)
  - [SearchEventsVpnConfidence](docs/SearchEventsVpnConfidence.md)
  - [SupplementaryIDHighRecall](docs/SupplementaryIDHighRecall.md)
  - [TamperingConfidence](docs/TamperingConfidence.md)

docs/BotInfo.md

@@ -4,12 +4,12 @@ Extended bot information.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**category** | **str** | The type and purpose of the bot. | 
+**category** | [**BotInfoCategory**](BotInfoCategory.md) |  | 
 **provider** | **str** | The organization or company operating the bot. | 
 **provider_url** | **str** | The URL of the bot provider's website. | [optional] 
 **name** | **str** | The specific name or identifier of the bot. | 
-**identity** | **str** | The verification status of the bot's identity:  * `verified` - well-known bot with publicly verifiable identity, directed by the bot provider.  * `signed` - bot that signs its platform via Web Bot Auth, directed by the bot provider’s customers.  * `spoofed` - bot that claims a public identity but fails verification.  * `unknown` - bot that does not publish a verifiable identity.  | 
-**confidence** | **str** | Confidence level of the bot identification. | 
+**identity** | [**BotInfoIdentity**](BotInfoIdentity.md) |  | 
+**confidence** | [**BotInfoConfidence**](BotInfoConfidence.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/BotInfoCategory.md

@@ -0,0 +1,25 @@
+# BotInfoCategory
+The type and purpose of the bot.
+
+
+## Enum
+
+* `ADVERTISING_AND_MARKETING` (value: `'advertising_and_marketing'`)
+* `AGGREGATOR` (value: `'aggregator'`)
+* `AI_AGENT` (value: `'ai_agent'`)
+* `AI_ASSISTANT` (value: `'ai_assistant'`)
+* `AI_BROWSER` (value: `'ai_browser'`)
+* `AI_CRAWLER` (value: `'ai_crawler'`)
+* `AI_SEARCH` (value: `'ai_search'`)
+* `BROWSER_AUTOMATION` (value: `'browser_automation'`)
+* `ECOMMERCE` (value: `'ecommerce'`)
+* `MONITORING_AND_ANALYTICS` (value: `'monitoring_and_analytics'`)
+* `OTHER` (value: `'other'`)
+* `SCRAPING` (value: `'scraping'`)
+* `SECURITY` (value: `'security'`)
+* `SEARCH_ENGINE_CRAWLER` (value: `'search_engine_crawler'`)
+* `SEARCH_ENGINE_OPTIMIZATION` (value: `'search_engine_optimization'`)
+* `UNKNOWN` (value: `'unknown'`)
+
+[[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/BotInfoConfidence.md

@@ -0,0 +1,11 @@
+# BotInfoConfidence
+Confidence level of the bot identification.
+
+## Enum
+
+* `LOW` (value: `'low'`)
+* `MEDIUM` (value: `'medium'`)
+* `HIGH` (value: `'high'`)
+
+[[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/BotInfoIdentity.md

@@ -0,0 +1,17 @@
+# BotInfoIdentity
+The verification status of the bot's identity:
+ * `verified` - well-known bot with publicly verifiable identity, directed by the bot provider.
+ * `signed` - bot that signs its platform via Web Bot Auth, directed by the bot provider's customers.
+ * `spoofed` - bot that claims a public identity but fails verification.
+ * `unknown` - bot that does not publish a verifiable identity.
+
+
+## Enum
+
+* `VERIFIED` (value: `'verified'`)
+* `SIGNED` (value: `'signed'`)
+* `SPOOFED` (value: `'spoofed'`)
+* `UNKNOWN` (value: `'unknown'`)
+
+[[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/Event.md

@@ -27,7 +27,7 @@ Name | Type | Description | Notes
 **bot_type** | **str** | Additional classification of the bot type if detected.  | [optional] 
 **bot_info** | [**BotInfo**](BotInfo.md) |  | [optional] 
 **cloned_app** | **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] 
-**developer_tools** | **bool** | `true` if the browser is Chrome with DevTools open or Firefox with Developer Tools open, `false` otherwise.  | [optional] 
+**developer_tools** | **bool** | `true` if the browser has DevTools open (Chrome, Firefox) or the Android/iOS device has Developer Tools enabled, `false` otherwise.  | [optional] 
 **emulator** | **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] 
 **factory_reset_timestamp** | **int** | The time of the most recent factory reset that happened on the **mobile device** is expressed as Unix epoch time. When a factory reset cannot be detected on the mobile device or when the request is initiated from a browser,  this field will correspond to the *epoch* time (i.e 1 Jan 1970 UTC) as a value of 0. See [Factory Reset Detection](https://docs.fingerprint.com/docs/smart-signals-reference#factory-reset-detection) to learn more about this Smart Signal.  | [optional] 
 **frida** | **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.  | [optional] 
@@ -36,7 +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] 
+**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. 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] 
 **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] 
@@ -52,7 +52,7 @@ Name | Type | Description | Notes
 **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] 
-**virtual_machine_ml_score** | **float** | Machine learning–based virtual machine 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 `virtual_machine` detection result  | [optional] 
+**virtual_machine_ml_score** | **float** | Machine learning–based virtual machine 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 `virtual_machine` detection result. 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] 
 **vpn** | **bool** | VPN or other anonymizing service has been used when sending the request.  | [optional] 
 **vpn_confidence** | [**VpnConfidence**](VpnConfidence.md) |  | [optional] 
 **vpn_origin_timezone** | **str** | Local timezone which is used in timezone_mismatch method.  | [optional] 
@@ -62,6 +62,7 @@ Name | Type | Description | Notes
 **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] 
+**labels** | [**List[LabelsInner]**](LabelsInner.md) | Each label returns a prediction (true or false) for a specific use case (label field) based on a machine learning score. The machine learning score is determined by a model trained on customer data for that use case. This field is in the beta phase and only available to select customers. If you are interested, please [contact our support team](https://fingerprint.com/support/).  | [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)