OpenAPI schema sync (v2.12.0)

.changeset/proud-feet-attack.md

@@ -0,0 +1,5 @@
+---
+"fingerprint-pro-server-api-python-sdk": minor
+---
+
+Add `proximity` signal that represents a fixed geographical zone in a discrete global grid within which the device is observed.

.schema-version

@@ -1 +1 @@
-v2.11.0
+v2.12.0

README.md

@@ -345,6 +345,7 @@ Class | Method | HTTP request | Description
  - [ProductLocationSpoofing](docs/ProductLocationSpoofing.md)
  - [ProductMitMAttack](docs/ProductMitMAttack.md)
  - [ProductPrivacySettings](docs/ProductPrivacySettings.md)
+ - [ProductProximity](docs/ProductProximity.md)
  - [ProductProxy](docs/ProductProxy.md)
  - [ProductRawDeviceAttributes](docs/ProductRawDeviceAttributes.md)
  - [ProductRemoteControl](docs/ProductRemoteControl.md)
@@ -356,6 +357,7 @@ Class | Method | HTTP request | Description
  - [ProductVelocity](docs/ProductVelocity.md)
  - [ProductVirtualMachine](docs/ProductVirtualMachine.md)
  - [Products](docs/Products.md)
+ - [Proximity](docs/Proximity.md)
  - [Proxy](docs/Proxy.md)
  - [ProxyConfidence](docs/ProxyConfidence.md)
  - [ProxyDetails](docs/ProxyDetails.md)
@@ -396,6 +398,7 @@ Class | Method | HTTP request | Description
  - [WebhookLocationSpoofing](docs/WebhookLocationSpoofing.md)
  - [WebhookMitMAttack](docs/WebhookMitMAttack.md)
  - [WebhookPrivacySettings](docs/WebhookPrivacySettings.md)
+ - [WebhookProximity](docs/WebhookProximity.md)
  - [WebhookProxy](docs/WebhookProxy.md)
  - [WebhookRawDeviceAttributes](docs/WebhookRawDeviceAttributes.md)
  - [WebhookRemoteControl](docs/WebhookRemoteControl.md)

docs/FingerprintApi.md

@@ -221,7 +221,7 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **search_events**
-> SearchEventsResponse search_events(limit, pagination_key=pagination_key, visitor_id=visitor_id, bot=bot, ip_address=ip_address, linked_id=linked_id, start=start, end=end, reverse=reverse, suspect=suspect, vpn=vpn, virtual_machine=virtual_machine, tampering=tampering, anti_detect_browser=anti_detect_browser, incognito=incognito, privacy_settings=privacy_settings, jailbroken=jailbroken, frida=frida, factory_reset=factory_reset, cloned_app=cloned_app, emulator=emulator, root_apps=root_apps, vpn_confidence=vpn_confidence, min_suspect_score=min_suspect_score, ip_blocklist=ip_blocklist, datacenter=datacenter, developer_tools=developer_tools, location_spoofing=location_spoofing, mitm_attack=mitm_attack, proxy=proxy, sdk_version=sdk_version, sdk_platform=sdk_platform, environment=environment)
+> SearchEventsResponse search_events(limit, pagination_key=pagination_key, visitor_id=visitor_id, bot=bot, ip_address=ip_address, linked_id=linked_id, start=start, end=end, reverse=reverse, suspect=suspect, vpn=vpn, virtual_machine=virtual_machine, tampering=tampering, anti_detect_browser=anti_detect_browser, incognito=incognito, privacy_settings=privacy_settings, jailbroken=jailbroken, frida=frida, factory_reset=factory_reset, cloned_app=cloned_app, emulator=emulator, root_apps=root_apps, vpn_confidence=vpn_confidence, min_suspect_score=min_suspect_score, ip_blocklist=ip_blocklist, datacenter=datacenter, developer_tools=developer_tools, location_spoofing=location_spoofing, mitm_attack=mitm_attack, proxy=proxy, sdk_version=sdk_version, sdk_platform=sdk_platform, environment=environment, proximity_id=proximity_id, proximity_precision_radius=proximity_precision_radius)
 
 Get events via search
 
@@ -272,10 +272,12 @@ proxy = True # bool | Filter events by Proxy detection result. > Note: When usin
 sdk_version = 'sdk_version_example' # str | Filter events by a specific SDK version associated with the identification event. Example: `3.11.14`  (optional)
 sdk_platform = 'sdk_platform_example' # str | Filter events by the SDK Platform associated with the identification event. `js` - JavaScript agent (Web). `ios` - Apple iOS based devices. `android` - Android based devices.  (optional)
 environment = ['environment_example'] # list[str] | Filter for events by providing one or more environment IDs.  (optional)
+proximity_id = 'proximity_id_example' # str | Filter events by the most precise Proximity ID provided by default. > Note: When using this parameter, only events with the `products.proximity.id` property matching the provided ID are returned. Events without a `products.proximity` result are left out of the response.  (optional)
+proximity_precision_radius = 56 # int | Filter events by Proximity Radius. > Note: When using this parameter, only events with the `products.proximity.precisionRadius` property set to a valid value are returned. Events without a `products.proximity` result are left out of the response.  (optional)
 
 try:
     # Get events via search
-    api_response = api_instance.search_events(limit, pagination_key=pagination_key, visitor_id=visitor_id, bot=bot, ip_address=ip_address, linked_id=linked_id, start=start, end=end, reverse=reverse, suspect=suspect, vpn=vpn, virtual_machine=virtual_machine, tampering=tampering, anti_detect_browser=anti_detect_browser, incognito=incognito, privacy_settings=privacy_settings, jailbroken=jailbroken, frida=frida, factory_reset=factory_reset, cloned_app=cloned_app, emulator=emulator, root_apps=root_apps, vpn_confidence=vpn_confidence, min_suspect_score=min_suspect_score, ip_blocklist=ip_blocklist, datacenter=datacenter, developer_tools=developer_tools, location_spoofing=location_spoofing, mitm_attack=mitm_attack, proxy=proxy, sdk_version=sdk_version, sdk_platform=sdk_platform, environment=environment)
+    api_response = api_instance.search_events(limit, pagination_key=pagination_key, visitor_id=visitor_id, bot=bot, ip_address=ip_address, linked_id=linked_id, start=start, end=end, reverse=reverse, suspect=suspect, vpn=vpn, virtual_machine=virtual_machine, tampering=tampering, anti_detect_browser=anti_detect_browser, incognito=incognito, privacy_settings=privacy_settings, jailbroken=jailbroken, frida=frida, factory_reset=factory_reset, cloned_app=cloned_app, emulator=emulator, root_apps=root_apps, vpn_confidence=vpn_confidence, min_suspect_score=min_suspect_score, ip_blocklist=ip_blocklist, datacenter=datacenter, developer_tools=developer_tools, location_spoofing=location_spoofing, mitm_attack=mitm_attack, proxy=proxy, sdk_version=sdk_version, sdk_platform=sdk_platform, environment=environment, proximity_id=proximity_id, proximity_precision_radius=proximity_precision_radius)
     print(api_response)
 except ApiException as e:
     print("Exception when calling FingerprintApi->search_events: %s\n" % e)
@@ -318,6 +320,8 @@ Name | Type | Description  | Notes
  **sdk_version** | **str**| Filter events by a specific SDK version associated with the identification event. Example: `3.11.14`  | [optional] 
  **sdk_platform** | **str**| Filter events by the SDK Platform associated with the identification event. `js` - JavaScript agent (Web). `ios` - Apple iOS based devices. `android` - Android based devices.  | [optional] 
  **environment** | [**list[str]**](str.md)| Filter for events by providing one or more environment IDs.  | [optional] 
+ **proximity_id** | **str**| Filter events by the most precise Proximity ID provided by default. > Note: When using this parameter, only events with the `products.proximity.id` property matching the provided ID are returned. Events without a `products.proximity` result are left out of the response.  | [optional] 
+ **proximity_precision_radius** | **int**| Filter events by Proximity Radius. > Note: When using this parameter, only events with the `products.proximity.precisionRadius` property set to a valid value are returned. Events without a `products.proximity` result are left out of the response.  | [optional] 
 
 ### Return type
 

docs/ProductProximity.md

@@ -0,0 +1,10 @@
+# ProductProximity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Proximity**](Proximity.md) |  | [optional] 
+**error** | [**Error**](Error.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/Products.md

@@ -30,6 +30,7 @@ Name | Type | Description | Notes
 **velocity** | [**ProductVelocity**](ProductVelocity.md) |  | [optional] 
 **developer_tools** | [**ProductDeveloperTools**](ProductDeveloperTools.md) |  | [optional] 
 **mitm_attack** | [**ProductMitMAttack**](ProductMitMAttack.md) |  | [optional] 
+**proximity** | [**ProductProximity**](ProductProximity.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/Proximity.md

@@ -0,0 +1,14 @@
+# Proximity
+Proximity ID represents a fixed geographical zone in a discrete global grid within which the device is observed.
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | A stable privacy-preserving identifier for a given proximity zone.  | 
+**precision_radius** | **int** | The radius of the proximity zone’s precision level, in meters.  | 
+**confidence** | **float** | A value between `0` and `1` representing the likelihood that the true device location lies within the mapped proximity zone.   * Scores closer to `1` indicate high confidence that the location is inside the mapped proximity zone.   * Scores closer to `0` indicate lower confidence, suggesting the true location may fall in an adjacent zone.  | 
+
+[[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/Webhook.md

@@ -48,6 +48,7 @@ Name | Type | Description | Notes
 **replayed** | **bool** | `true` if we determined that this payload was replayed, `false` otherwise.  | [optional] 
 **sdk** | [**SDK**](SDK.md) |  | 
 **supplementary_ids** | [**WebhookSupplementaryIDs**](WebhookSupplementaryIDs.md) |  | [optional] 
+**proximity** | [**WebhookProximity**](WebhookProximity.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/WebhookProximity.md

@@ -0,0 +1,14 @@
+# WebhookProximity
+Proximity ID represents a fixed geographical zone in a discrete global grid within which the device is observed.
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | A stable privacy-preserving identifier for a given proximity zone.  | 
+**precision_radius** | **int** | The radius of the proximity zone’s precision level, in meters.  | 
+**confidence** | **float** | A value between `0` and `1` representing the likelihood that the true device location lies within the mapped proximity zone.   * Scores closer to `1` indicate high confidence that the location is inside the mapped proximity zone.   * Scores closer to `0` indicate lower confidence, suggesting the true location may fall in an adjacent zone.  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

fingerprint_pro_server_api_sdk/__init__.py

@@ -73,6 +73,7 @@
 from fingerprint_pro_server_api_sdk.models.product_location_spoofing import ProductLocationSpoofing
 from fingerprint_pro_server_api_sdk.models.product_mit_m_attack import ProductMitMAttack
 from fingerprint_pro_server_api_sdk.models.product_privacy_settings import ProductPrivacySettings
+from fingerprint_pro_server_api_sdk.models.product_proximity import ProductProximity
 from fingerprint_pro_server_api_sdk.models.product_proxy import ProductProxy
 from fingerprint_pro_server_api_sdk.models.product_raw_device_attributes import ProductRawDeviceAttributes
 from fingerprint_pro_server_api_sdk.models.product_remote_control import ProductRemoteControl
@@ -84,6 +85,7 @@
 from fingerprint_pro_server_api_sdk.models.product_velocity import ProductVelocity
 from fingerprint_pro_server_api_sdk.models.product_virtual_machine import ProductVirtualMachine
 from fingerprint_pro_server_api_sdk.models.products import Products
+from fingerprint_pro_server_api_sdk.models.proximity import Proximity
 from fingerprint_pro_server_api_sdk.models.proxy import Proxy
 from fingerprint_pro_server_api_sdk.models.proxy_confidence import ProxyConfidence
 from fingerprint_pro_server_api_sdk.models.proxy_details import ProxyDetails
@@ -124,6 +126,7 @@
 from fingerprint_pro_server_api_sdk.models.webhook_location_spoofing import WebhookLocationSpoofing
 from fingerprint_pro_server_api_sdk.models.webhook_mit_m_attack import WebhookMitMAttack
 from fingerprint_pro_server_api_sdk.models.webhook_privacy_settings import WebhookPrivacySettings
+from fingerprint_pro_server_api_sdk.models.webhook_proximity import WebhookProximity
 from fingerprint_pro_server_api_sdk.models.webhook_proxy import WebhookProxy
 from fingerprint_pro_server_api_sdk.models.webhook_raw_device_attributes import WebhookRawDeviceAttributes
 from fingerprint_pro_server_api_sdk.models.webhook_remote_control import WebhookRemoteControl

fingerprint_pro_server_api_sdk/api/fingerprint_api.py

@@ -539,6 +539,8 @@ def search_events(self, limit: int, **kwargs) -> Union[SearchEventsResponse, Asy
         :param sdk_version: Filter events by a specific SDK version associated with the identification event. Example: `3.11.14` 
         :param sdk_platform: Filter events by the SDK Platform associated with the identification event. `js` - JavaScript agent (Web). `ios` - Apple iOS based devices. `android` - Android based devices. 
         :param environment: Filter for events by providing one or more environment IDs. 
+        :param proximity_id: Filter events by the most precise Proximity ID provided by default. > Note: When using this parameter, only events with the `products.proximity.id` property matching the provided ID are returned. Events without a `products.proximity` result are left out of the response. 
+        :param proximity_precision_radius: Filter events by Proximity Radius. > Note: When using this parameter, only events with the `products.proximity.precisionRadius` property set to a valid value are returned. Events without a `products.proximity` result are left out of the response. 
         :return: SearchEventsResponse
                  If the method is called asynchronously,
                  returns the request thread.
@@ -593,6 +595,8 @@ def search_events_with_http_info(self, limit: int, **kwargs):  # noqa: E501
         :param str sdk_version: Filter events by a specific SDK version associated with the identification event. Example: `3.11.14` 
         :param str sdk_platform: Filter events by the SDK Platform associated with the identification event. `js` - JavaScript agent (Web). `ios` - Apple iOS based devices. `android` - Android based devices. 
         :param list[str] environment: Filter for events by providing one or more environment IDs. 
+        :param str proximity_id: Filter events by the most precise Proximity ID provided by default. > Note: When using this parameter, only events with the `products.proximity.id` property matching the provided ID are returned. Events without a `products.proximity` result are left out of the response. 
+        :param int proximity_precision_radius: Filter events by Proximity Radius. > Note: When using this parameter, only events with the `products.proximity.precisionRadius` property set to a valid value are returned. Events without a `products.proximity` result are left out of the response. 
         :return: SearchEventsResponse
                  If the method is called asynchronously,
                  returns the request thread.
@@ -632,6 +636,8 @@ def search_events_with_http_info(self, limit: int, **kwargs):  # noqa: E501
             'sdk_version',
             'sdk_platform',
             'environment',
+            'proximity_id',
+            'proximity_precision_radius',
             'async_req',
             '_return_http_data_only',
             '_preload_content',
@@ -722,6 +728,10 @@ def search_events_with_http_info(self, limit: int, **kwargs):  # noqa: E501
         if 'environment' in params:
             query_params.append(('environment', params['environment']))  # noqa: E501
             collection_formats['environment'] = 'multi'  # noqa: E501
+        if 'proximity_id' in params:
+            query_params.append(('proximity_id', params['proximity_id']))  # noqa: E501
+        if 'proximity_precision_radius' in params:
+            query_params.append(('proximity_precision_radius', params['proximity_precision_radius']))  # noqa: E501
 
         header_params = {}
 

fingerprint_pro_server_api_sdk/models/__init__.py

@@ -65,6 +65,7 @@
 from fingerprint_pro_server_api_sdk.models.product_location_spoofing import ProductLocationSpoofing
 from fingerprint_pro_server_api_sdk.models.product_mit_m_attack import ProductMitMAttack
 from fingerprint_pro_server_api_sdk.models.product_privacy_settings import ProductPrivacySettings
+from fingerprint_pro_server_api_sdk.models.product_proximity import ProductProximity
 from fingerprint_pro_server_api_sdk.models.product_proxy import ProductProxy
 from fingerprint_pro_server_api_sdk.models.product_raw_device_attributes import ProductRawDeviceAttributes
 from fingerprint_pro_server_api_sdk.models.product_remote_control import ProductRemoteControl
@@ -76,6 +77,7 @@
 from fingerprint_pro_server_api_sdk.models.product_velocity import ProductVelocity
 from fingerprint_pro_server_api_sdk.models.product_virtual_machine import ProductVirtualMachine
 from fingerprint_pro_server_api_sdk.models.products import Products
+from fingerprint_pro_server_api_sdk.models.proximity import Proximity
 from fingerprint_pro_server_api_sdk.models.proxy import Proxy
 from fingerprint_pro_server_api_sdk.models.proxy_confidence import ProxyConfidence
 from fingerprint_pro_server_api_sdk.models.proxy_details import ProxyDetails
@@ -116,6 +118,7 @@
 from fingerprint_pro_server_api_sdk.models.webhook_location_spoofing import WebhookLocationSpoofing
 from fingerprint_pro_server_api_sdk.models.webhook_mit_m_attack import WebhookMitMAttack
 from fingerprint_pro_server_api_sdk.models.webhook_privacy_settings import WebhookPrivacySettings
+from fingerprint_pro_server_api_sdk.models.webhook_proximity import WebhookProximity
 from fingerprint_pro_server_api_sdk.models.webhook_proxy import WebhookProxy
 from fingerprint_pro_server_api_sdk.models.webhook_raw_device_attributes import WebhookRawDeviceAttributes
 from fingerprint_pro_server_api_sdk.models.webhook_remote_control import WebhookRemoteControl