Skip to content

Commit 826cb8e

Browse files
committed
feat: sync OpenAPI schema to v2.6.0
1 parent 26913c1 commit 826cb8e

File tree

6 files changed

+51
-4
lines changed

6 files changed

+51
-4
lines changed

.changeset/gold-flies-doubt.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'fingerprint-pro-server-api-python-sdk': patch
3+
---
4+
5+
**events-search**: Fixed `vpn_confidence` query parameter enum value formatting (`high,` -> `high`)

.changeset/shiny-ghosts-sin.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'fingerprint-pro-server-api-python-sdk': minor
3+
---
4+
5+
**events-search**: Event search now supports two new filter parameters: `ip_blocklist`, `datacenter`

.schema-version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
v2.5.0
1+
v2.6.0

docs/FingerprintApi.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ Name | Type | Description | Notes
221221
[[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)
222222

223223
# **search_events**
224-
> 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)
224+
> 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)
225225
226226
Get events via search
227227

@@ -263,10 +263,12 @@ emulator = true # bool | Filter events by Android Emulator Detection result. >
263263
root_apps = true # bool | Filter events by Rooted Device Detection result. > Note: When using this parameter, only events with the `products.rootApps.data.result` property set to `true` or `false` are returned. Events without a `products.rootApps` Smart Signal result are left out of the response. (optional)
264264
vpn_confidence = 'vpn_confidence_example' # str | Filter events by VPN Detection result confidence level. `high` - events with high VPN Detection confidence. `medium` - events with medium VPN Detection confidence. `low` - events with low VPN Detection confidence. > Note: When using this parameter, only events with the `products.vpn.data.confidence` property set to a valid value are returned. Events without a `products.vpn` Smart Signal result are left out of the response. (optional)
265265
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)
266+
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)
267+
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)
266268

267269
try:
268270
# Get events via search
269-
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)
271+
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)
270272
print(api_response)
271273
except ApiException as e:
272274
print("Exception when calling FingerprintApi->search_events: %s\n" % e)
@@ -300,6 +302,8 @@ Name | Type | Description | Notes
300302
**root_apps** | **bool**| Filter events by Rooted Device Detection result. > Note: When using this parameter, only events with the `products.rootApps.data.result` property set to `true` or `false` are returned. Events without a `products.rootApps` Smart Signal result are left out of the response. | [optional]
301303
**vpn_confidence** | **str**| Filter events by VPN Detection result confidence level. `high` - events with high VPN Detection confidence. `medium` - events with medium VPN Detection confidence. `low` - events with low VPN Detection confidence. > Note: When using this parameter, only events with the `products.vpn.data.confidence` property set to a valid value are returned. Events without a `products.vpn` Smart Signal result are left out of the response. | [optional]
302304
**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]
305+
**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]
306+
**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]
303307

304308
### Return type
305309

fingerprint_pro_server_api_sdk/api/fingerprint_api.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -530,6 +530,8 @@ def search_events(self, limit: int, **kwargs) -> Union[SearchEventsResponse, Asy
530530
:param root_apps: Filter events by Rooted Device Detection result. > Note: When using this parameter, only events with the `products.rootApps.data.result` property set to `true` or `false` are returned. Events without a `products.rootApps` Smart Signal result are left out of the response.
531531
:param vpn_confidence: Filter events by VPN Detection result confidence level. `high` - events with high VPN Detection confidence. `medium` - events with medium VPN Detection confidence. `low` - events with low VPN Detection confidence. > Note: When using this parameter, only events with the `products.vpn.data.confidence` property set to a valid value are returned. Events without a `products.vpn` Smart Signal result are left out of the response.
532532
: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.
533+
: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.
534+
: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.
533535
:return: SearchEventsResponse
534536
If the method is called asynchronously,
535537
returns the request thread.
@@ -575,6 +577,8 @@ def search_events_with_http_info(self, limit: int, **kwargs): # noqa: E501
575577
:param bool root_apps: Filter events by Rooted Device Detection result. > Note: When using this parameter, only events with the `products.rootApps.data.result` property set to `true` or `false` are returned. Events without a `products.rootApps` Smart Signal result are left out of the response.
576578
:param str vpn_confidence: Filter events by VPN Detection result confidence level. `high` - events with high VPN Detection confidence. `medium` - events with medium VPN Detection confidence. `low` - events with low VPN Detection confidence. > Note: When using this parameter, only events with the `products.vpn.data.confidence` property set to a valid value are returned. Events without a `products.vpn` Smart Signal result are left out of the response.
577579
: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.
580+
: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.
581+
: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.
578582
:return: SearchEventsResponse
579583
If the method is called asynchronously,
580584
returns the request thread.
@@ -605,6 +609,8 @@ def search_events_with_http_info(self, limit: int, **kwargs): # noqa: E501
605609
'root_apps',
606610
'vpn_confidence',
607611
'min_suspect_score',
612+
'ip_blocklist',
613+
'datacenter',
608614
'async_req',
609615
'_return_http_data_only',
610616
'_preload_content',
@@ -676,6 +682,10 @@ def search_events_with_http_info(self, limit: int, **kwargs): # noqa: E501
676682
query_params.append(('vpn_confidence', params['vpn_confidence'])) # noqa: E501
677683
if 'min_suspect_score' in params:
678684
query_params.append(('min_suspect_score', params['min_suspect_score'])) # noqa: E501
685+
if 'ip_blocklist' in params:
686+
query_params.append(('ip_blocklist', params['ip_blocklist'])) # noqa: E501
687+
if 'datacenter' in params:
688+
query_params.append(('datacenter', params['datacenter'])) # noqa: E501
679689

680690
header_params = {}
681691

res/fingerprint-server-api.yaml

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -414,7 +414,7 @@ paths:
414414
schema:
415415
type: string
416416
enum:
417-
- high,
417+
- high
418418
- medium
419419
- low
420420
description: >
@@ -444,6 +444,29 @@ paths:
444444
exceeding your threshold are returned. Events without a
445445
`products.suspectScore` Smart Signal result are left out of the
446446
response.
447+
- name: ip_blocklist
448+
in: query
449+
schema:
450+
type: boolean
451+
description: >
452+
Filter events by IP Blocklist Detection result.
453+
454+
> Note: When using this parameter, only events with the
455+
`products.ipBlocklist.data.result` property set to `true` or `false`
456+
are returned. Events without a `products.ipBlocklist` Smart Signal
457+
result are left out of the response.
458+
- name: datacenter
459+
in: query
460+
schema:
461+
type: boolean
462+
description: >
463+
Filter events by Datacenter Detection result.
464+
465+
> Note: When using this parameter, only events with the
466+
`products.ipInfo.data.v4.datacenter.result` or
467+
`products.ipInfo.data.v6.datacenter.result` property set to `true`
468+
or `false` are returned. Events without a `products.ipInfo` Smart
469+
Signal result are left out of the response.
447470
responses:
448471
'200':
449472
description: Events matching the filter(s).

0 commit comments

Comments
 (0)