Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
50 changes: 32 additions & 18 deletions docs/FingerprintApi.md

Large diffs are not rendered by default.

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
36 changes: 36 additions & 0 deletions fingerprint_pro_server_api_sdk/api/fingerprint_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -532,6 +532,13 @@ def search_events(self, limit: int, **kwargs) -> Union[SearchEventsResponse, Asy
:param min_suspect_score: 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.
:param ip_blocklist: 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.
:param datacenter: 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.
:param developer_tools: 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.
:param location_spoofing: 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.
:param mitm_attack: 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.
:param proxy: 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.
: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.
:return: SearchEventsResponse
If the method is called asynchronously,
returns the request thread.
Expand Down Expand Up @@ -579,6 +586,13 @@ def search_events_with_http_info(self, limit: int, **kwargs): # noqa: E501
:param float min_suspect_score: 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.
:param bool ip_blocklist: 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.
:param bool datacenter: 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.
:param bool developer_tools: 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.
:param bool location_spoofing: 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.
:param bool mitm_attack: 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.
:param bool proxy: 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.
: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.
:return: SearchEventsResponse
If the method is called asynchronously,
returns the request thread.
Expand Down Expand Up @@ -611,6 +625,13 @@ def search_events_with_http_info(self, limit: int, **kwargs): # noqa: E501
'min_suspect_score',
'ip_blocklist',
'datacenter',
'developer_tools',
'location_spoofing',
'mitm_attack',
'proxy',
'sdk_version',
'sdk_platform',
'environment',
'async_req',
'_return_http_data_only',
'_preload_content',
Expand Down Expand Up @@ -686,6 +707,21 @@ def search_events_with_http_info(self, limit: int, **kwargs): # noqa: E501
query_params.append(('ip_blocklist', params['ip_blocklist'])) # noqa: E501
if 'datacenter' in params:
query_params.append(('datacenter', params['datacenter'])) # noqa: E501
if 'developer_tools' in params:
query_params.append(('developer_tools', params['developer_tools'])) # noqa: E501
if 'location_spoofing' in params:
query_params.append(('location_spoofing', params['location_spoofing'])) # noqa: E501
if 'mitm_attack' in params:
query_params.append(('mitm_attack', params['mitm_attack'])) # noqa: E501
if 'proxy' in params:
query_params.append(('proxy', params['proxy'])) # noqa: E501
if 'sdk_version' in params:
query_params.append(('sdk_version', params['sdk_version'])) # noqa: E501
if 'sdk_platform' in params:
query_params.append(('sdk_platform', params['sdk_platform'])) # noqa: E501
if 'environment' in params:
query_params.append(('environment', params['environment'])) # noqa: E501
collection_formats['environment'] = 'multi' # noqa: E501

header_params = {}

Expand Down
2 changes: 2 additions & 0 deletions fingerprint_pro_server_api_sdk/models/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,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 @@ -119,6 +120,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
39 changes: 33 additions & 6 deletions fingerprint_pro_server_api_sdk/models/identification.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,8 @@ class Identification(BaseModel):
'last_seen_at': 'IdentificationSeenAt',
'components': 'RawDeviceAttributes',
'replayed': 'bool',
'sdk': 'SDK'
'sdk': 'SDK',
'environment_id': 'str'
}

nullable_map = {
Expand All @@ -77,7 +78,8 @@ class Identification(BaseModel):
'last_seen_at': False,
'components': False,
'replayed': False,
'sdk': False
'sdk': False,
'environment_id': False
}

attribute_map = {
Expand All @@ -99,10 +101,11 @@ class Identification(BaseModel):
'last_seen_at': 'lastSeenAt',
'components': 'components',
'replayed': 'replayed',
'sdk': 'sdk'
'sdk': 'sdk',
'environment_id': 'environmentId'
}

def __init__(self, visitor_id=None, request_id=None, browser_details=None, incognito=None, ip=None, ip_location=None, linked_id=None, suspect=None, timestamp=None, time=None, url=None, tag=None, confidence=None, visitor_found=None, first_seen_at=None, last_seen_at=None, components=None, replayed=None, sdk=None): # noqa: E501
def __init__(self, visitor_id=None, request_id=None, browser_details=None, incognito=None, ip=None, ip_location=None, linked_id=None, suspect=None, timestamp=None, time=None, url=None, tag=None, confidence=None, visitor_found=None, first_seen_at=None, last_seen_at=None, components=None, replayed=None, sdk=None, environment_id=None): # noqa: E501
"""Identification - a model defined in Swagger""" # noqa: E501
self._visitor_id = None
self._request_id = None
Expand All @@ -123,6 +126,7 @@ def __init__(self, visitor_id=None, request_id=None, browser_details=None, incog
self._components = None
self._replayed = None
self._sdk = None
self._environment_id = None
self.discriminator = None
self.visitor_id = visitor_id
self.request_id = request_id
Expand All @@ -149,12 +153,14 @@ def __init__(self, visitor_id=None, request_id=None, browser_details=None, incog
self.replayed = replayed
if sdk is not None:
self.sdk = sdk
if environment_id is not None:
self.environment_id = environment_id

@property
def visitor_id(self) -> str:
"""Gets the visitor_id of this Identification. # noqa: E501

String of 20 characters that uniquely identifies the visitor's browser. # noqa: E501
String of 20 characters that uniquely identifies the visitor's browser or mobile device. # noqa: E501

:return: The visitor_id of this Identification. # noqa: E501
"""
Expand All @@ -164,7 +170,7 @@ def visitor_id(self) -> str:
def visitor_id(self, visitor_id: str):
"""Sets the visitor_id of this Identification.

String of 20 characters that uniquely identifies the visitor's browser. # noqa: E501
String of 20 characters that uniquely identifies the visitor's browser or mobile device. # noqa: E501

:param visitor_id: The visitor_id of this Identification. # noqa: E501
"""
Expand Down Expand Up @@ -559,3 +565,24 @@ def sdk(self, sdk: Optional[SDK]):

self._sdk = sdk

@property
def environment_id(self) -> Optional[str]:
"""Gets the environment_id of this Identification. # noqa: E501

Environment ID associated with the event # noqa: E501

:return: The environment_id of this Identification. # noqa: E501
"""
return self._environment_id

@environment_id.setter
def environment_id(self, environment_id: Optional[str]):
"""Sets the environment_id of this Identification.

Environment ID associated with the event # noqa: E501

:param environment_id: The environment_id of this Identification. # noqa: E501
"""

self._environment_id = environment_id

Loading
Loading