Skip to content

Commit e4f4a98

Browse files
OrkuncakilkayaOrkuncakilkaya
authored
Merge pull request #185 from fingerprintjs/feat/open-api-v2.12.0
OpenAPI schema sync (v2.12.0)
2 parents aead240 + 6eb2083 commit e4f4a98

23 files changed

+1440
-85
lines changed

‎.changeset/proud-feet-attack.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-php-sdk": minor
3+
---
4+
5+
Add `proximity` signal that represents a fixed geographical zone in a discrete global grid within which the device is observed.

‎.schema-version‎

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

‎README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -306,6 +306,7 @@ Class | Method | HTTP request | Description
306306
- [ProductLocationSpoofing](docs/Model/ProductLocationSpoofing.md)
307307
- [ProductMitMAttack](docs/Model/ProductMitMAttack.md)
308308
- [ProductPrivacySettings](docs/Model/ProductPrivacySettings.md)
309+
- [ProductProximity](docs/Model/ProductProximity.md)
309310
- [ProductProxy](docs/Model/ProductProxy.md)
310311
- [ProductRawDeviceAttributes](docs/Model/ProductRawDeviceAttributes.md)
311312
- [ProductRemoteControl](docs/Model/ProductRemoteControl.md)
@@ -317,6 +318,7 @@ Class | Method | HTTP request | Description
317318
- [ProductVelocity](docs/Model/ProductVelocity.md)
318319
- [ProductVirtualMachine](docs/Model/ProductVirtualMachine.md)
319320
- [Products](docs/Model/Products.md)
321+
- [Proximity](docs/Model/Proximity.md)
320322
- [Proxy](docs/Model/Proxy.md)
321323
- [ProxyConfidence](docs/Model/ProxyConfidence.md)
322324
- [ProxyDetails](docs/Model/ProxyDetails.md)
@@ -353,6 +355,7 @@ Class | Method | HTTP request | Description
353355
- [WebhookLocationSpoofing](docs/Model/WebhookLocationSpoofing.md)
354356
- [WebhookMitMAttack](docs/Model/WebhookMitMAttack.md)
355357
- [WebhookPrivacySettings](docs/Model/WebhookPrivacySettings.md)
358+
- [WebhookProximity](docs/Model/WebhookProximity.md)
356359
- [WebhookProxy](docs/Model/WebhookProxy.md)
357360
- [WebhookRemoteControl](docs/Model/WebhookRemoteControl.md)
358361
- [WebhookRootApps](docs/Model/WebhookRootApps.md)

‎docs/Api/FingerprintApi.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ Array:
269269
[[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)
270270

271271
# **searchEvents**
272-
> [ \Fingerprint\ServerAPI\Model\SearchEventsResponse, \Psr\Http\Message\ResponseInterface ] searchEvents($limit, $pagination_key, $visitor_id, $bot, $ip_address, $linked_id, $start, $end, $reverse, $suspect, $vpn, $virtual_machine, $tampering, $anti_detect_browser, $incognito, $privacy_settings, $jailbroken, $frida, $factory_reset, $cloned_app, $emulator, $root_apps, $vpn_confidence, $min_suspect_score, $ip_blocklist, $datacenter, $developer_tools, $location_spoofing, $mitm_attack, $proxy, $sdk_version, $sdk_platform, $environment)
272+
> [ \Fingerprint\ServerAPI\Model\SearchEventsResponse, \Psr\Http\Message\ResponseInterface ] searchEvents($limit, $pagination_key, $visitor_id, $bot, $ip_address, $linked_id, $start, $end, $reverse, $suspect, $vpn, $virtual_machine, $tampering, $anti_detect_browser, $incognito, $privacy_settings, $jailbroken, $frida, $factory_reset, $cloned_app, $emulator, $root_apps, $vpn_confidence, $min_suspect_score, $ip_blocklist, $datacenter, $developer_tools, $location_spoofing, $mitm_attack, $proxy, $sdk_version, $sdk_platform, $environment, $proximity_id, $proximity_precision_radius)
273273
274274
Get events via search
275275

@@ -328,9 +328,11 @@ $proxy = true; // bool | Filter events by Proxy detection result. > Note: When u
328328
$sdk_version = "sdk_version_example"; // string | Filter events by a specific SDK version associated with the identification event. Example: `3.11.14`
329329
$sdk_platform = "sdk_platform_example"; // string | Filter events by the SDK Platform associated with the identification event. `js` - JavaScript agent (Web). `ios` - Apple iOS based devices. `android` - Android based devices.
330330
$environment = array("environment_example"); // string[] | Filter for events by providing one or more environment IDs.
331+
$proximity_id = "proximity_id_example"; // string | 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.
332+
$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.
331333

332334
try {
333-
list($model, $httpResponse) = $client->searchEvents($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);
335+
list($model, $httpResponse) = $client->searchEvents($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);
334336
echo "<pre>" . $httpResponse->getBody()->getContents() . "</pre>";
335337
} catch (Exception $e) {
336338
echo 'Exception when calling FingerprintApi->searchEvents: ', $e->getMessage(), PHP_EOL;
@@ -375,6 +377,8 @@ Name | Type | Description | Notes
375377
**sdk_version** | **string**| Filter events by a specific SDK version associated with the identification event. Example: `3.11.14` | [optional]
376378
**sdk_platform** | **string**| 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]
377379
**environment** | [**string[]**](../Model/string.md)| Filter for events by providing one or more environment IDs. | [optional]
380+
**proximity_id** | **string**| 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]
381+
**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]
378382

379383
### Return type
380384

‎docs/Model/ProductProximity.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# ProductProximity
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**data** | [**\Fingerprint\ServerAPI\Model\Proximity**](Proximity.md) | | [optional]
7+
**error** | [**\Fingerprint\ServerAPI\Model\Error**](Error.md) | | [optional]
8+
9+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
10+

‎docs/Model/Products.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Name | Type | Description | Notes
3030
**velocity** | [**\Fingerprint\ServerAPI\Model\ProductVelocity**](ProductVelocity.md) | | [optional]
3131
**developer_tools** | [**\Fingerprint\ServerAPI\Model\ProductDeveloperTools**](ProductDeveloperTools.md) | | [optional]
3232
**mitm_attack** | [**\Fingerprint\ServerAPI\Model\ProductMitMAttack**](ProductMitMAttack.md) | | [optional]
33+
**proximity** | [**\Fingerprint\ServerAPI\Model\ProductProximity**](ProductProximity.md) | | [optional]
3334

3435
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
3536

‎docs/Model/Proximity.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Proximity
2+
Proximity ID represents a fixed geographical zone in a discrete global grid within which the device is observed.
3+
4+
5+
6+
## Properties
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**id** | **string** | A stable privacy-preserving identifier for a given proximity zone. |
10+
**precision_radius** | **int** | The radius of the proximity zone’s precision level, in meters. |
11+
**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. |
12+
13+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
14+

‎docs/Model/Webhook.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ Name | Type | Description | Notes
4848
**replayed** | **bool** | `true` if we determined that this payload was replayed, `false` otherwise. | [optional]
4949
**sdk** | [**\Fingerprint\ServerAPI\Model\SDK**](SDK.md) | |
5050
**supplementary_ids** | [**\Fingerprint\ServerAPI\Model\WebhookSupplementaryIDs**](WebhookSupplementaryIDs.md) | | [optional]
51+
**proximity** | [**\Fingerprint\ServerAPI\Model\WebhookProximity**](WebhookProximity.md) | | [optional]
5152

5253
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
5354

‎docs/Model/WebhookProximity.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# WebhookProximity
2+
Proximity ID represents a fixed geographical zone in a discrete global grid within which the device is observed.
3+
4+
5+
6+
## Properties
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**id** | **string** | A stable privacy-preserving identifier for a given proximity zone. |
10+
**precision_radius** | **int** | The radius of the proximity zone’s precision level, in meters. |
11+
**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. |
12+
13+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
14+

‎res/fingerprint-server-api.yaml‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -550,6 +550,39 @@ paths:
550550
type: string
551551
style: form
552552
explode: true
553+
- name: proximity_id
554+
in: query
555+
schema:
556+
type: string
557+
description: >
558+
Filter events by the most precise Proximity ID provided by default.
559+
560+
> Note: When using this parameter, only events with the
561+
`products.proximity.id` property matching the provided ID are
562+
returned. Events without a `products.proximity` result are left out
563+
of the response.
564+
- name: proximity_precision_radius
565+
in: query
566+
schema:
567+
type: integer
568+
format: int32
569+
enum:
570+
- 10
571+
- 25
572+
- 65
573+
- 175
574+
- 450
575+
- 1200
576+
- 3300
577+
- 8500
578+
- 22500
579+
description: >
580+
Filter events by Proximity Radius.
581+
582+
> Note: When using this parameter, only events with the
583+
`products.proximity.precisionRadius` property set to a valid value
584+
are returned. Events without a `products.proximity` result are left
585+
out of the response.
553586
responses:
554587
'200':
555588
description: Events matching the filter(s).
@@ -2150,6 +2183,54 @@ components:
21502183
$ref: '#/components/schemas/MitMAttack'
21512184
error:
21522185
$ref: '#/components/schemas/Error'
2186+
Proximity:
2187+
type: object
2188+
description: >
2189+
Proximity ID represents a fixed geographical zone in a discrete global
2190+
grid within which the device is observed.
2191+
additionalProperties: false
2192+
required:
2193+
- id
2194+
- precisionRadius
2195+
- confidence
2196+
properties:
2197+
id:
2198+
type: string
2199+
description: |
2200+
A stable privacy-preserving identifier for a given proximity zone.
2201+
precisionRadius:
2202+
type: integer
2203+
format: int32
2204+
enum:
2205+
- 10
2206+
- 25
2207+
- 65
2208+
- 175
2209+
- 450
2210+
- 1200
2211+
- 3300
2212+
- 8500
2213+
- 22500
2214+
description: |
2215+
The radius of the proximity zone’s precision level, in meters.
2216+
confidence:
2217+
type: number
2218+
format: float
2219+
minimum: 0
2220+
maximum: 1
2221+
description: >
2222+
A value between `0` and `1` representing the likelihood that the
2223+
true device location lies within the mapped proximity zone.
2224+
* Scores closer to `1` indicate high confidence that the location is inside the mapped proximity zone.
2225+
* Scores closer to `0` indicate lower confidence, suggesting the true location may fall in an adjacent zone.
2226+
ProductProximity:
2227+
type: object
2228+
additionalProperties: false
2229+
properties:
2230+
data:
2231+
$ref: '#/components/schemas/Proximity'
2232+
error:
2233+
$ref: '#/components/schemas/Error'
21532234
Products:
21542235
type: object
21552236
description: >-
@@ -2207,6 +2288,8 @@ components:
22072288
$ref: '#/components/schemas/ProductDeveloperTools'
22082289
mitmAttack:
22092290
$ref: '#/components/schemas/ProductMitMAttack'
2291+
proximity:
2292+
$ref: '#/components/schemas/ProductProximity'
22102293
EventsGetResponse:
22112294
type: object
22122295
description: >-
@@ -2745,6 +2828,46 @@ components:
27452828
$ref: '#/components/schemas/SupplementaryID'
27462829
highRecall:
27472830
$ref: '#/components/schemas/SupplementaryID'
2831+
WebhookProximity:
2832+
type: object
2833+
description: >
2834+
Proximity ID represents a fixed geographical zone in a discrete global
2835+
grid within which the device is observed.
2836+
additionalProperties: false
2837+
required:
2838+
- id
2839+
- precisionRadius
2840+
- confidence
2841+
properties:
2842+
id:
2843+
type: string
2844+
description: |
2845+
A stable privacy-preserving identifier for a given proximity zone.
2846+
precisionRadius:
2847+
type: integer
2848+
format: int32
2849+
enum:
2850+
- 10
2851+
- 25
2852+
- 65
2853+
- 175
2854+
- 450
2855+
- 1200
2856+
- 3300
2857+
- 8500
2858+
- 22500
2859+
description: |
2860+
The radius of the proximity zone’s precision level, in meters.
2861+
confidence:
2862+
type: number
2863+
format: float
2864+
minimum: 0
2865+
maximum: 1
2866+
description: >
2867+
A value between `0` and `1` representing the likelihood that the
2868+
true device location lies within the mapped proximity zone.
2869+
* Scores closer to `1` indicate high confidence that the location is inside the mapped proximity zone.
2870+
* Scores closer to `0` indicate lower confidence, suggesting the true location may fall in an adjacent zone.
27482871
Webhook:
27492872
type: object
27502873
required:
@@ -2867,3 +2990,5 @@ components:
28672990
$ref: '#/components/schemas/SDK'
28682991
supplementaryIds:
28692992
$ref: '#/components/schemas/WebhookSupplementaryIDs'
2993+
proximity:
2994+
$ref: '#/components/schemas/WebhookProximity'

0 commit comments

Comments
 (0)