Skip to content
Merged
5 changes: 5 additions & 0 deletions .changeset/cute-buses-attend.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'fingerprint-pro-server-api-python-sdk': minor
---

**events-search**: Event search now supports a new set of filter parameters: `developer_tools`, `location_spoofing`, `mitm_attack`, `proxy`, `sdk_version`, `sdk_platform`, `environment`
5 changes: 5 additions & 0 deletions .changeset/fast-hotels-hunt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'fingerprint-pro-server-api-python-sdk': minor
---

**webhook**: Add `supplementaryIds` property to the Webhooks schema.
8 changes: 8 additions & 0 deletions .changeset/pre.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"mode": "pre",
"tag": "rc",
"initialVersions": {
"fingerprint-pro-server-api-python-sdk": "8.10.0"
},
"changesets": []
}
5 changes: 5 additions & 0 deletions .changeset/quick-kiwis-visit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'fingerprint-pro-server-api-python-sdk': minor
---

Add `environmentId` property to `identification`
2 changes: 1 addition & 1 deletion .schema-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.10.0
v2.11.0
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -369,6 +369,7 @@ Class | Method | HTTP request | Description
- [SDK](docs/SDK.md)
- [SearchEventsResponse](docs/SearchEventsResponse.md)
- [SearchEventsResponseEvents](docs/SearchEventsResponseEvents.md)
- [SupplementaryID](docs/SupplementaryID.md)
- [SuspectScore](docs/SuspectScore.md)
- [Tag](docs/Tag.md)
- [Tampering](docs/Tampering.md)
Expand Down Expand Up @@ -399,6 +400,7 @@ Class | Method | HTTP request | Description
- [WebhookRawDeviceAttributes](docs/WebhookRawDeviceAttributes.md)
- [WebhookRemoteControl](docs/WebhookRemoteControl.md)
- [WebhookRootApps](docs/WebhookRootApps.md)
- [WebhookSupplementaryIDs](docs/WebhookSupplementaryIDs.md)
- [WebhookSuspectScore](docs/WebhookSuspectScore.md)
- [WebhookTampering](docs/WebhookTampering.md)
- [WebhookTor](docs/WebhookTor.md)
Expand Down
18 changes: 16 additions & 2 deletions docs/FingerprintApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
> 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)

Get events via search

Expand Down Expand Up @@ -265,10 +265,17 @@ vpn_confidence = 'vpn_confidence_example' # str | Filter events by VPN Detection
min_suspect_score = 3.4 # float | Filter events with Suspect Score result above a provided minimum threshold. > Note: When using this parameter, only events where the `products.suspectScore.data.result` property set to a value exceeding your threshold are returned. Events without a `products.suspectScore` Smart Signal result are left out of the response. (optional)
ip_blocklist = true # bool | Filter events by IP Blocklist Detection result. > Note: When using this parameter, only events with the `products.ipBlocklist.data.result` property set to `true` or `false` are returned. Events without a `products.ipBlocklist` Smart Signal result are left out of the response. (optional)
datacenter = true # bool | Filter events by Datacenter Detection result. > Note: When using this parameter, only events with the `products.ipInfo.data.v4.datacenter.result` or `products.ipInfo.data.v6.datacenter.result` property set to `true` or `false` are returned. Events without a `products.ipInfo` Smart Signal result are left out of the response. (optional)
developer_tools = true # bool | Filter events by Developer Tools detection result. > Note: When using this parameter, only events with the `products.developerTools.data.result` property set to `true` or `false` are returned. Events without a `products.developerTools` Smart Signal result are left out of the response. (optional)
location_spoofing = true # bool | Filter events by Location Spoofing detection result. > Note: When using this parameter, only events with the `products.locationSpoofing.data.result` property set to `true` or `false` are returned. Events without a `products.locationSpoofing` Smart Signal result are left out of the response. (optional)
mitm_attack = true # bool | Filter events by MITM (Man-in-the-Middle) Attack detection result. > Note: When using this parameter, only events with the `products.mitmAttack.data.result` property set to `true` or `false` are returned. Events without a `products.mitmAttack` Smart Signal result are left out of the response. (optional)
proxy = true # bool | Filter events by Proxy detection result. > Note: When using this parameter, only events with the `products.proxy.data.result` property set to `true` or `false` are returned. Events without a `products.proxy` Smart Signal result are left out of the response. (optional)
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)

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)
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)
print(api_response)
except ApiException as e:
print("Exception when calling FingerprintApi->search_events: %s\n" % e)
Expand Down Expand Up @@ -304,6 +311,13 @@ Name | Type | Description | Notes
**min_suspect_score** | **float**| Filter events with Suspect Score result above a provided minimum threshold. > Note: When using this parameter, only events where the `products.suspectScore.data.result` property set to a value exceeding your threshold are returned. Events without a `products.suspectScore` Smart Signal result are left out of the response. | [optional]
**ip_blocklist** | **bool**| Filter events by IP Blocklist Detection result. > Note: When using this parameter, only events with the `products.ipBlocklist.data.result` property set to `true` or `false` are returned. Events without a `products.ipBlocklist` Smart Signal result are left out of the response. | [optional]
**datacenter** | **bool**| Filter events by Datacenter Detection result. > Note: When using this parameter, only events with the `products.ipInfo.data.v4.datacenter.result` or `products.ipInfo.data.v6.datacenter.result` property set to `true` or `false` are returned. Events without a `products.ipInfo` Smart Signal result are left out of the response. | [optional]
**developer_tools** | **bool**| Filter events by Developer Tools detection result. > Note: When using this parameter, only events with the `products.developerTools.data.result` property set to `true` or `false` are returned. Events without a `products.developerTools` Smart Signal result are left out of the response. | [optional]
**location_spoofing** | **bool**| Filter events by Location Spoofing detection result. > Note: When using this parameter, only events with the `products.locationSpoofing.data.result` property set to `true` or `false` are returned. Events without a `products.locationSpoofing` Smart Signal result are left out of the response. | [optional]
**mitm_attack** | **bool**| Filter events by MITM (Man-in-the-Middle) Attack detection result. > Note: When using this parameter, only events with the `products.mitmAttack.data.result` property set to `true` or `false` are returned. Events without a `products.mitmAttack` Smart Signal result are left out of the response. | [optional]
**proxy** | **bool**| Filter events by Proxy detection result. > Note: When using this parameter, only events with the `products.proxy.data.result` property set to `true` or `false` are returned. Events without a `products.proxy` Smart Signal result are left out of the response. | [optional]
**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]

### Return type

Expand Down
3 changes: 2 additions & 1 deletion docs/Identification.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**visitor_id** | **str** | String of 20 characters that uniquely identifies the visitor's browser. |
**visitor_id** | **str** | String of 20 characters that uniquely identifies the visitor's browser or mobile device. |
**request_id** | **str** | Unique identifier of the user's request. |
**browser_details** | [**BrowserDetails**](BrowserDetails.md) | |
**incognito** | **bool** | Flag if user used incognito session. |
Expand All @@ -22,6 +22,7 @@ Name | Type | Description | Notes
**components** | [**RawDeviceAttributes**](RawDeviceAttributes.md) | | [optional]
**replayed** | **bool** | `true` if we determined that this payload was replayed, `false` otherwise. |
**sdk** | [**SDK**](SDK.md) | | [optional]
**environment_id** | **str** | Environment ID associated with the event | [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)

13 changes: 13 additions & 0 deletions docs/SupplementaryID.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# SupplementaryID

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**visitor_id** | **str** | String of 20 characters that uniquely identifies the visitor's browser or mobile device. | [optional]
**visitor_found** | **bool** | Attribute represents if a visitor had been identified before. | [optional]
**confidence** | [**IdentificationConfidence**](IdentificationConfidence.md) | | [optional]
**first_seen_at** | [**IdentificationSeenAt**](IdentificationSeenAt.md) | | [optional]
**last_seen_at** | [**IdentificationSeenAt**](IdentificationSeenAt.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)

3 changes: 2 additions & 1 deletion docs/Webhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Name | Type | Description | Notes
**timestamp** | **int** | Timestamp of the event with millisecond precision in Unix time. |
**ip_location** | [**DeprecatedGeolocation**](DeprecatedGeolocation.md) | | [optional]
**linked_id** | **str** | A customer-provided id that was sent with the request. | [optional]
**visitor_id** | **str** | String of 20 characters that uniquely identifies the visitor's browser. | [optional]
**visitor_id** | **str** | String of 20 characters that uniquely identifies the visitor's browser or mobile device. | [optional]
**visitor_found** | **bool** | Attribute represents if a visitor had been identified before. | [optional]
**confidence** | [**IdentificationConfidence**](IdentificationConfidence.md) | | [optional]
**first_seen_at** | [**IdentificationSeenAt**](IdentificationSeenAt.md) | | [optional]
Expand Down Expand Up @@ -47,6 +47,7 @@ Name | Type | Description | Notes
**mitm_attack** | [**WebhookMitMAttack**](WebhookMitMAttack.md) | | [optional]
**replayed** | **bool** | `true` if we determined that this payload was replayed, `false` otherwise. | [optional]
**sdk** | [**SDK**](SDK.md) | |
**supplementary_ids** | [**WebhookSupplementaryIDs**](WebhookSupplementaryIDs.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)

12 changes: 12 additions & 0 deletions docs/WebhookSupplementaryIDs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# WebhookSupplementaryIDs
Other identities that have been established for a given Visitor.


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**standard** | [**SupplementaryID**](SupplementaryID.md) | |
**high_recall** | [**SupplementaryID**](SupplementaryID.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)

2 changes: 2 additions & 0 deletions fingerprint_pro_server_api_sdk/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@
from fingerprint_pro_server_api_sdk.models.sdk import SDK
from fingerprint_pro_server_api_sdk.models.search_events_response import SearchEventsResponse
from fingerprint_pro_server_api_sdk.models.search_events_response_events import SearchEventsResponseEvents
from fingerprint_pro_server_api_sdk.models.supplementary_id import SupplementaryID
from fingerprint_pro_server_api_sdk.models.suspect_score import SuspectScore
from fingerprint_pro_server_api_sdk.models.tag import Tag
from fingerprint_pro_server_api_sdk.models.tampering import Tampering
Expand Down Expand Up @@ -127,6 +128,7 @@
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
from fingerprint_pro_server_api_sdk.models.webhook_root_apps import WebhookRootApps
from fingerprint_pro_server_api_sdk.models.webhook_supplementary_i_ds import WebhookSupplementaryIDs
from fingerprint_pro_server_api_sdk.models.webhook_suspect_score import WebhookSuspectScore
from fingerprint_pro_server_api_sdk.models.webhook_tampering import WebhookTampering
from fingerprint_pro_server_api_sdk.models.webhook_tor import WebhookTor
Expand Down
Loading
Loading