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/beige-places-drop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'java-sdk': patch
---

**events**: Clarify availability of proxy and VM ML score signals
5 changes: 5 additions & 0 deletions .changeset/blue-roses-film.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'java-sdk': patch
---

**events**: Clarify semantics of `incremental_identification_status`
5 changes: 5 additions & 0 deletions .changeset/curvy-rice-chew.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'java-sdk': patch
---

**visitors**: Clarify rate limits for `deleteVisitorData` operation
5 changes: 5 additions & 0 deletions .changeset/cute-pumas-pull.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'java-sdk': minor
---

**events-search**: Add `start_date_time` and `end_date_time` RFC3339 timestamp filters
5 changes: 5 additions & 0 deletions .changeset/developer-tools-android-v4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'java-sdk': minor
---

**events**: Add Android platform support to `developer_tools` smart signal
5 changes: 5 additions & 0 deletions .changeset/fancy-spiders-flash.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'java-sdk': minor
---

**events**: Add `labels` to `Event`
5 changes: 5 additions & 0 deletions .changeset/loud-donuts-lead.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'java-sdk': patch
---

**events-search**: Clarify availability of `rare_device` and `rare_device_percentile_bucket` query parameters
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": {
"java-sdk": "8.2.0"
},
"changesets": []
}
5 changes: 5 additions & 0 deletions .changeset/quick-cows-battle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'java-sdk': minor
---

**events**: Add iOS platform support to `developer_tools`
5 changes: 5 additions & 0 deletions .changeset/wet-socks-fold.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'java-sdk': patch
---

**events-search**: Fix `pagination_key` example
5 changes: 5 additions & 0 deletions .changeset/witty-lions-worry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'java-sdk': minor
---

**events-search**: Add `bot_info` filter parameters
5 changes: 5 additions & 0 deletions .changeset/yellow-ducks-spend.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'java-sdk': minor
---

**events-search**: Add `unknown` value to `BotInfoCategory`
2 changes: 1 addition & 1 deletion .schema-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v3.2.0
v3.3.0
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ All URIs are relative to *https://api.fpjs.io/v4*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*FingerprintApi* | [**deleteVisitorData**](docs/FingerprintApi.md#deleteVisitorData) | **DELETE** /visitors/{visitor_id} | Delete data by visitor ID
*FingerprintApi* | [**deleteVisitorData**](docs/FingerprintApi.md#deleteVisitorData) | **DELETE** /visitors/{visitor_id} | Delete a visitor ID
*FingerprintApi* | [**getEvent**](docs/FingerprintApi.md#getEvent) | **GET** /events/{event_id} | Get an event by event ID
*FingerprintApi* | [**searchEvents**](docs/FingerprintApi.md#searchEvents) | **GET** /events | Search events
*FingerprintApi* | [**updateEvent**](docs/FingerprintApi.md#updateEvent) | **PATCH** /events/{event_id} | Update an event
Expand All @@ -298,6 +298,9 @@ Class | Method | HTTP request | Description
## Documentation for Models

- [BotInfo](docs/BotInfo.md)
- [BotInfoCategory](docs/BotInfoCategory.md)
- [BotInfoConfidence](docs/BotInfoConfidence.md)
- [BotInfoIdentity](docs/BotInfoIdentity.md)
- [BotResult](docs/BotResult.md)
- [BrowserDetails](docs/BrowserDetails.md)
- [Canvas](docs/Canvas.md)
Expand All @@ -323,6 +326,7 @@ Class | Method | HTTP request | Description
- [IncrementalIdentificationStatus](docs/IncrementalIdentificationStatus.md)
- [Integration](docs/Integration.md)
- [IntegrationSubintegration](docs/IntegrationSubintegration.md)
- [LabelsInner](docs/LabelsInner.md)
- [PluginsInner](docs/PluginsInner.md)
- [PluginsInnerMimeTypesInner](docs/PluginsInnerMimeTypesInner.md)
- [Proximity](docs/Proximity.md)
Expand All @@ -335,6 +339,7 @@ Class | Method | HTTP request | Description
- [RuleActionType](docs/RuleActionType.md)
- [SDK](docs/SDK.md)
- [SearchEventsBot](docs/SearchEventsBot.md)
- [SearchEventsBotInfo](docs/SearchEventsBotInfo.md)
- [SearchEventsIncrementalIdentificationStatus](docs/SearchEventsIncrementalIdentificationStatus.md)
- [SearchEventsRareDevicePercentileBucket](docs/SearchEventsRareDevicePercentileBucket.md)
- [SearchEventsSdkPlatform](docs/SearchEventsSdkPlatform.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/BotInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Extended bot information.

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**category** | **String** | The type and purpose of the bot. | |
|**category** | **String** | The type and purpose of the bot. | |
|**provider** | **String** | The organization or company operating the bot. | |
|**providerUrl** | **String** | The URL of the bot provider's website. | [optional] |
|**name** | **String** | The specific name or identifier of the bot. | |
|**identity** | [**IdentityEnum**](#IdentityEnum) | The verification status of the bot's identity: * `verified` - well-known bot with publicly verifiable identity, directed by the bot provider. * `signed` - bot that signs its platform via Web Bot Auth, directed by the bot providers customers. * `spoofed` - bot that claims a public identity but fails verification. * `unknown` - bot that does not publish a verifiable identity. | |
|**identity** | [**IdentityEnum**](#IdentityEnum) | The verification status of the bot's identity: * `verified` - well-known bot with publicly verifiable identity, directed by the bot provider. * `signed` - bot that signs its platform via Web Bot Auth, directed by the bot provider's customers. * `spoofed` - bot that claims a public identity but fails verification. * `unknown` - bot that does not publish a verifiable identity. | |
|**confidence** | [**ConfidenceEnum**](#ConfidenceEnum) | Confidence level of the bot identification. | |


Expand Down
45 changes: 45 additions & 0 deletions docs/BotInfoCategory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@


# BotInfoCategory
The type and purpose of the bot.


## Enum


* `ADVERTISING_AND_MARKETING` (value: `"advertising_and_marketing"`)

* `AGGREGATOR` (value: `"aggregator"`)

* `AI_AGENT` (value: `"ai_agent"`)

* `AI_ASSISTANT` (value: `"ai_assistant"`)

* `AI_BROWSER` (value: `"ai_browser"`)

* `AI_CRAWLER` (value: `"ai_crawler"`)

* `AI_SEARCH` (value: `"ai_search"`)

* `BROWSER_AUTOMATION` (value: `"browser_automation"`)

* `ECOMMERCE` (value: `"ecommerce"`)

* `MONITORING_AND_ANALYTICS` (value: `"monitoring_and_analytics"`)

* `OTHER` (value: `"other"`)

* `SCRAPING` (value: `"scraping"`)

* `SECURITY` (value: `"security"`)

* `SEARCH_ENGINE_CRAWLER` (value: `"search_engine_crawler"`)

* `SEARCH_ENGINE_OPTIMIZATION` (value: `"search_engine_optimization"`)

* `UNKNOWN` (value: `"unknown"`)

* `UNSUPPORTED_VALUE_SDK_UPGRADE_REQUIRED` (value: `"unsupported_value_sdk_upgrade_required"`)



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


# BotInfoConfidence
Confidence level of the bot identification.

## Enum


* `LOW` (value: `"low"`)

* `MEDIUM` (value: `"medium"`)

* `HIGH` (value: `"high"`)

* `UNSUPPORTED_VALUE_SDK_UPGRADE_REQUIRED` (value: `"unsupported_value_sdk_upgrade_required"`)



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


# BotInfoIdentity
The verification status of the bot's identity:
* `verified` - well-known bot with publicly verifiable identity, directed by the bot provider.
* `signed` - bot that signs its platform via Web Bot Auth, directed by the bot provider's customers.
* `spoofed` - bot that claims a public identity but fails verification.
* `unknown` - bot that does not publish a verifiable identity.


## Enum


* `VERIFIED` (value: `"verified"`)

* `SIGNED` (value: `"signed"`)

* `SPOOFED` (value: `"spoofed"`)

* `UNKNOWN` (value: `"unknown"`)

* `UNSUPPORTED_VALUE_SDK_UPGRADE_REQUIRED` (value: `"unsupported_value_sdk_upgrade_required"`)



7 changes: 4 additions & 3 deletions docs/Event.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Contains results from Fingerprint Identification and all active Smart Signals.
|**botType** | **String** | Additional classification of the bot type if detected. | [optional] |
|**botInfo** | [**BotInfo**](BotInfo.md) | | [optional] |
|**clonedApp** | **Boolean** | Android specific cloned application detection. There are 2 values: * `true` - Presence of app cloners work detected (e.g. fully cloned application found or launch of it inside of a not main working profile detected). * `false` - No signs of cloned application detected or the client is not Android. | [optional] |
|**developerTools** | **Boolean** | `true` if the browser is Chrome with DevTools open or Firefox with Developer Tools open, `false` otherwise. | [optional] |
|**developerTools** | **Boolean** | `true` if the browser has DevTools open (Chrome, Firefox) or the Android/iOS device has Developer Tools enabled, `false` otherwise. | [optional] |
|**emulator** | **Boolean** | Android specific emulator detection. There are 2 values: * `true` - Emulated environment detected (e.g. launch inside of AVD). * `false` - No signs of emulated environment detected or the client is not Android. | [optional] |
|**factoryResetTimestamp** | **Long** | The time of the most recent factory reset that happened on the **mobile device** is expressed as Unix epoch time. When a factory reset cannot be detected on the mobile device or when the request is initiated from a browser, this field will correspond to the *epoch* time (i.e 1 Jan 1970 UTC) as a value of 0. See [Factory Reset Detection](https://docs.fingerprint.com/docs/smart-signals-reference#factory-reset-detection) to learn more about this Smart Signal. | [optional] |
|**frida** | **Boolean** | [Frida](https://frida.re/docs/) detection for Android and iOS devices. There are 2 values: * `true` - Frida detected * `false` - No signs of Frida or the client is not a mobile device. | [optional] |
Expand All @@ -40,7 +40,7 @@ Contains results from Fingerprint Identification and all active Smart Signals.
|**proxy** | **Boolean** | IP address was used by a public proxy provider or belonged to a known recent residential proxy | [optional] |
|**proxyConfidence** | [**ProxyConfidence**](ProxyConfidence.md) | | [optional] |
|**proxyDetails** | [**ProxyDetails**](ProxyDetails.md) | | [optional] |
|**proxyMlScore** | **Double** | Machine learning–based proxy score, represented as a floating-point value between 0 and 1 (inclusive), with up to three decimal places of precision. A higher score means a higher confidence in the positive `proxy` detection result | [optional] |
|**proxyMlScore** | **Double** | Machine learning–based proxy score, represented as a floating-point value between 0 and 1 (inclusive), with up to three decimal places of precision. A higher score means a higher confidence in the positive `proxy` detection result. This Smart Signal is currently in beta and only available to select customers. If you are interested, please [contact our support team](https://fingerprint.com/support/). | [optional] |
|**incognito** | **Boolean** | `true` if we detected incognito mode used in the browser, `false` otherwise. | [optional] |
|**jailbroken** | **Boolean** | iOS specific jailbreak detection. There are 2 values: * `true` - Jailbreak detected. * `false` - No signs of jailbreak or the client is not iOS. | [optional] |
|**locationSpoofing** | **Boolean** | Flag indicating whether the request came from a mobile device with location spoofing enabled. | [optional] |
Expand All @@ -56,7 +56,7 @@ Contains results from Fingerprint Identification and all active Smart Signals.
|**tamperingDetails** | [**TamperingDetails**](TamperingDetails.md) | | [optional] |
|**velocity** | [**Velocity**](Velocity.md) | | [optional] |
|**virtualMachine** | **Boolean** | `true` if the request came from a browser running inside a virtual machine (e.g. VMWare), `false` otherwise. | [optional] |
|**virtualMachineMlScore** | **Double** | Machine learning–based virtual machine score, represented as a floating-point value between 0 and 1 (inclusive), with up to three decimal places of precision. A higher score means a higher confidence in the positive `virtual_machine` detection result | [optional] |
|**virtualMachineMlScore** | **Double** | Machine learning–based virtual machine score, represented as a floating-point value between 0 and 1 (inclusive), with up to three decimal places of precision. A higher score means a higher confidence in the positive `virtual_machine` detection result. This Smart Signal is currently in beta and only available to select customers. If you are interested, please [contact our support team](https://fingerprint.com/support/). | [optional] |
|**vpn** | **Boolean** | VPN or other anonymizing service has been used when sending the request. | [optional] |
|**vpnConfidence** | [**VpnConfidence**](VpnConfidence.md) | | [optional] |
|**vpnOriginTimezone** | **String** | Local timezone which is used in timezone_mismatch method. | [optional] |
Expand All @@ -66,6 +66,7 @@ Contains results from Fingerprint Identification and all active Smart Signals.
|**rareDevice** | **Boolean** | `true` if the device is considered rare based on its combination of hardware and software attributes. A device is classified as rare if it falls within the top 99.9 percentile (lowest-frequency segment) of observed traffic, or if its configuration has not been previously seen (`not_seen`). > This Smart Signal is currently in beta and only available to select customers. If you are interested, please [contact our support team](https://fingerprint.com/support/). | [optional] |
|**rareDevicePercentileBucket** | [**RareDevicePercentileBucket**](RareDevicePercentileBucket.md) | | [optional] |
|**rawDeviceAttributes** | [**RawDeviceAttributes**](RawDeviceAttributes.md) | | [optional] |
|**labels** | [**List<LabelsInner>**](LabelsInner.md) | Each label returns a prediction (true or false) for a specific use case (label field) based on a machine learning score. The machine learning score is determined by a model trained on customer data for that use case. This field is in the beta phase and only available to select customers. If you are interested, please [contact our support team](https://fingerprint.com/support/). | [optional] |



Loading
Loading