Skip to content

Commit 113990b

Browse files
OrkuncakilkayaOrkuncakilkaya
authored
Merge pull request #131 from fingerprintjs/feat/open-api-v2.12.0
OpenAPI schema sync (v2.12.0)
2 parents e3868b7 + 61221aa commit 113990b

23 files changed

+927
-8
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-java-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
@@ -351,6 +351,7 @@ Class | Method | HTTP request | Description
351351
- [ProductLocationSpoofing](docs/ProductLocationSpoofing.md)
352352
- [ProductMitMAttack](docs/ProductMitMAttack.md)
353353
- [ProductPrivacySettings](docs/ProductPrivacySettings.md)
354+
- [ProductProximity](docs/ProductProximity.md)
354355
- [ProductProxy](docs/ProductProxy.md)
355356
- [ProductRawDeviceAttributes](docs/ProductRawDeviceAttributes.md)
356357
- [ProductRemoteControl](docs/ProductRemoteControl.md)
@@ -362,6 +363,7 @@ Class | Method | HTTP request | Description
362363
- [ProductVelocity](docs/ProductVelocity.md)
363364
- [ProductVirtualMachine](docs/ProductVirtualMachine.md)
364365
- [Products](docs/Products.md)
366+
- [Proximity](docs/Proximity.md)
365367
- [Proxy](docs/Proxy.md)
366368
- [ProxyConfidence](docs/ProxyConfidence.md)
367369
- [ProxyDetails](docs/ProxyDetails.md)
@@ -400,6 +402,7 @@ Class | Method | HTTP request | Description
400402
- [WebhookLocationSpoofing](docs/WebhookLocationSpoofing.md)
401403
- [WebhookMitMAttack](docs/WebhookMitMAttack.md)
402404
- [WebhookPrivacySettings](docs/WebhookPrivacySettings.md)
405+
- [WebhookProximity](docs/WebhookProximity.md)
403406
- [WebhookProxy](docs/WebhookProxy.md)
404407
- [WebhookRemoteControl](docs/WebhookRemoteControl.md)
405408
- [WebhookRootApps](docs/WebhookRootApps.md)

‎docs/FingerprintApi.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -450,6 +450,8 @@ public class FingerprintApiExample {
450450
String sdkVersion = "sdkVersion_example"; // String | Filter events by a specific SDK version associated with the identification event. Example: `3.11.14`
451451
String sdkPlatform = "js"; // 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.
452452
List<String> environment = Arrays.asList(); // List<String> | Filter for events by providing one or more environment IDs.
453+
String proximityId = "proximityId_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.
454+
Integer proximityPrecisionRadius = 10; // Integer | 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.
453455
try {
454456
SearchEventsResponse result = api.searchEvents(limit, new FingerprintApi.SearchEventsOptionalParams()
455457
.setPaginationKey(paginationKey)
@@ -483,7 +485,9 @@ public class FingerprintApiExample {
483485
.setProxy(proxy)
484486
.setSdkVersion(sdkVersion)
485487
.setSdkPlatform(sdkPlatform)
486-
.setEnvironment(environment));
488+
.setEnvironment(environment)
489+
.setProximityId(proximityId)
490+
.setProximityPrecisionRadius(proximityPrecisionRadius));
487491
System.out.println(result);
488492
} catch (ApiException e) {
489493
System.err.println("Exception when calling FingerprintApi.searchEvents:" + e.getMessage());
@@ -539,6 +543,8 @@ Object containing optional parameters for API method. Supports a fluent interfac
539543
| **sdkVersion** | **String**| Filter events by a specific SDK version associated with the identification event. Example: `3.11.14` | [optional] |
540544
| **sdkPlatform** | **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] [enum: js, android, ios] |
541545
| **environment** | **List&lt;String&gt;**| Filter for events by providing one or more environment IDs. | [optional] |
546+
| **proximityId** | **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] |
547+
| **proximityPrecisionRadius** | **Integer**| 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] [enum: 10, 25, 65, 175, 450, 1200, 3300, 8500, 22500] |
542548

543549
### Return type
544550

‎docs/ProductProximity.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
3+
# ProductProximity
4+
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
|**data** | [**Proximity**](Proximity.md) | | [optional] |
11+
|**error** | [**Error**](Error.md) | | [optional] |
12+
13+
14+

‎docs/Products.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ Contains all information about the request identified by `requestId`, depending
3333
|**velocity** | [**ProductVelocity**](ProductVelocity.md) | | [optional] |
3434
|**developerTools** | [**ProductDeveloperTools**](ProductDeveloperTools.md) | | [optional] |
3535
|**mitmAttack** | [**ProductMitMAttack**](ProductMitMAttack.md) | | [optional] |
36+
|**proximity** | [**ProductProximity**](ProductProximity.md) | | [optional] |
3637

3738

3839

‎docs/Proximity.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
2+
3+
# Proximity
4+
5+
Proximity ID represents a fixed geographical zone in a discrete global grid within which the device is observed.
6+
7+
8+
## Properties
9+
10+
| Name | Type | Description | Notes |
11+
|------------ | ------------- | ------------- | -------------|
12+
|**id** | **String** | A stable privacy-preserving identifier for a given proximity zone. | |
13+
|**precisionRadius** | [**PrecisionRadiusEnum**](#PrecisionRadiusEnum) | The radius of the proximity zone’s precision level, in meters. | |
14+
|**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. | |
15+
16+
17+
## Enum: PrecisionRadiusEnum
18+
19+
| Name | Value |
20+
|---- | ----- |
21+
| NUMBER_10 | 10 |
22+
| NUMBER_25 | 25 |
23+
| NUMBER_65 | 65 |
24+
| NUMBER_175 | 175 |
25+
| NUMBER_450 | 450 |
26+
| NUMBER_1200 | 1200 |
27+
| NUMBER_3300 | 3300 |
28+
| NUMBER_8500 | 8500 |
29+
| NUMBER_22500 | 22500 |
30+
31+
32+

‎docs/Webhook.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@
5252
|**replayed** | **Boolean** | `true` if we determined that this payload was replayed, `false` otherwise. | [optional] |
5353
|**sdk** | [**SDK**](SDK.md) | | |
5454
|**supplementaryIds** | [**WebhookSupplementaryIDs**](WebhookSupplementaryIDs.md) | | [optional] |
55+
|**proximity** | [**WebhookProximity**](WebhookProximity.md) | | [optional] |
5556

5657

5758

‎docs/WebhookProximity.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
2+
3+
# WebhookProximity
4+
5+
Proximity ID represents a fixed geographical zone in a discrete global grid within which the device is observed.
6+
7+
8+
## Properties
9+
10+
| Name | Type | Description | Notes |
11+
|------------ | ------------- | ------------- | -------------|
12+
|**id** | **String** | A stable privacy-preserving identifier for a given proximity zone. | |
13+
|**precisionRadius** | [**PrecisionRadiusEnum**](#PrecisionRadiusEnum) | The radius of the proximity zone’s precision level, in meters. | |
14+
|**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. | |
15+
16+
17+
## Enum: PrecisionRadiusEnum
18+
19+
| Name | Value |
20+
|---- | ----- |
21+
| NUMBER_10 | 10 |
22+
| NUMBER_25 | 25 |
23+
| NUMBER_65 | 65 |
24+
| NUMBER_175 | 175 |
25+
| NUMBER_450 | 450 |
26+
| NUMBER_1200 | 1200 |
27+
| NUMBER_3300 | 3300 |
28+
| NUMBER_8500 | 8500 |
29+
| NUMBER_22500 | 22500 |
30+
31+
32+

‎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)