Skip to content

OpenAPI schema sync (v3.5.0) #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
fingerprint-dx-team-actions-runner wants to merge 1 commit into from
Closed

OpenAPI schema sync (v3.5.0) #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/active-call.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'java-sdk': minor
---

**events**: Add `active_call` smart signal to `Event`
5 changes: 5 additions & 0 deletions .changeset/automation-intelligence-edge-tag.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'java-sdk': minor
---

Add `Edge` tag to the Automation Intelligence API endpoint
5 changes: 5 additions & 0 deletions .changeset/keyboard-layout-hash.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'java-sdk': minor
---

**events**: Add `keyboard_layout_hash` to `RawDeviceAttributes`
5 changes: 5 additions & 0 deletions .changeset/raw-device-attributes-battery-charging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'java-sdk': minor
---

**events**: Add `battery_charging` field to `RawDeviceAttributes`
5 changes: 5 additions & 0 deletions .changeset/search-error-responses-events-search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'java-sdk': minor
---

**events-search**: Add 429 and 504 error responses to Search Events endpoint
5 changes: 5 additions & 0 deletions .changeset/search-error-responses-events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'java-sdk': minor
---

**events**: Add 504 error response to Get Event endpoint
2 changes: 1 addition & 1 deletion .schema-version
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v3.4.2
v3.5.0
5 changes: 3 additions & 2 deletions docs/Event.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Event

Contains results from Fingerprint Identification and all active Smart Signals.
Contains results from Fingerprint Identification and all active Smart Signals. Some Smart Signals are only supported for certain device types, these fields will be omitted for events not generated from the supported devices. Consult the [Smart Signals reference](https://docs.fingerprint.com/docs/smart-signals-reference) for more details.

## Properties

Expand Down Expand Up @@ -30,6 +30,7 @@ Contains results from Fingerprint Identification and all active Smart Signals.
|**clientReferrer** | **String** | Client Referrer field corresponds to the `document.referrer` field gathered during an identification request. The value is an empty string if the user navigated to the page directly (not through a link, but, for example, by using a bookmark). | [optional] |
|**browserDetails** | [**BrowserDetails**](BrowserDetails.md) | | [optional] |
|**proximity** | [**Proximity**](Proximity.md) | | [optional] |
|**activeCall** | **Boolean** | Indicates whether the mobile device had an active call (cellular or VoIP) at the time of the request. Available from SDK 2.16.0+ on iOS and Android. | [optional] |
|**bot** | [**BotResult**](BotResult.md) | | [optional] |
|**botType** | **String** | Additional classification of the bot type if detected. | [optional] |
|**botInfo** | [**BotInfo**](BotInfo.md) | | [optional] |
Expand Down Expand Up @@ -64,7 +65,7 @@ Contains results from Fingerprint Identification and all active Smart Signals.
|**vpnConfidence** | [**VpnConfidence**](VpnConfidence.md) | | [optional] |
|**vpnMlScore** | **Double** | Machine learning–based VPN 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 `vpn` 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] |
|**vpnOriginTimezone** | **String** | Local timezone which is used in timezone_mismatch method. | [optional] |
|**vpnOriginCountry** | **String** | Country of the request (only for Android SDK version >= 2.4.0, ISO 3166 format or unknown). | [optional] |
|**vpnOriginCountry** | **String** | Country of the request (Android SDK version >= 2.4.0, iOS SDK version >= 2.9.0, JS agent >= 3.12.9 / 4.0.2), ISO 3166 format or unknown. | [optional] |
|**vpnMethods** | [**VpnMethods**](VpnMethods.md) | | [optional] |
|**highActivityDevice** | **Boolean** | Flag indicating if the request came from a high-activity visitor. | [optional] |
|**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] |
Expand Down
41 changes: 22 additions & 19 deletions docs/FingerprintApi.md
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 4 additions & 2 deletions docs/RawDeviceAttributes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ A curated subset of raw browser/device attributes that the API surface exposes.
|**fontPreferences** | [**FontPreferences**](FontPreferences.md) | | [optional] |
|**emoji** | [**Emoji**](Emoji.md) | | [optional] |
|**fonts** | **List<String>** | List of fonts detected on the device. | [optional] |
|**deviceMemory** | **Integer** | Rounded amount of RAM in gigabytes. | [optional] |
|**deviceMemory** | **Integer** | Rounded amount of RAM in gigabytes. Available for browsers, Android, and iOS devices. | [optional] |
|**timezone** | **String** | Timezone identifier detected on the client. | [optional] |
|**canvas** | [**Canvas**](Canvas.md) | | [optional] |
|**languages** | **List<List<String>>** | Navigator languages reported by the agent including fallbacks. Each inner array represents ordered language preferences reported by different APIs. Available for browsers, iOS, and Android devices. | [optional] |
Expand All @@ -37,8 +37,10 @@ A curated subset of raw browser/device attributes that the API surface exposes.
|**deviceManufacturer** | **String** | Device manufacturer string. Available only for Android and iOS devices. | [optional] |
|**fontHash** | **String** | Unique identifier for the user’s installed fonts. | [optional] |
|**timezoneOffset** | **String** | UTC offset in \"±HH:MM\" format derived from the detected IANA timezone. | [optional] |
|**batteryLevel** | **Integer** | Battery charge level as a percentage (0-100). Available only for Android and iOS devices. | [optional] |
|**batteryLevel** | **Integer** | Battery charge level as a percentage (0-100). Available for Android, iOS, and web devices. On web, only available in Chromium-based browsers. | [optional] |
|**batteryCharging** | **Boolean** | When `true`, the device is currently charging. Available only for web devices on Chromium-based browsers. | [optional] |
|**batteryLowPowerMode** | **Boolean** | Whether the device's low power mode is enabled. Available only for Android and iOS devices. | [optional] |
|**keyboardLayoutHash** | **String** | Unique identifier for the user's keyboard layout. | [optional] |



2 changes: 1 addition & 1 deletion docs/SearchEventsBotInfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# SearchEventsBotInfo
Filter events by their Bot Info result, specifically:
- `all` - events where any kind of bot was detected.
- `none` - events where no bot was detected.
- `none` - events where no bot was detected, and no `bot_info` was present.


## Enum
Expand Down
2 changes: 1 addition & 1 deletion docs/Velocity.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Velocity

Sums key data points for a specific `visitor_id`, `ip_address` and `linked_id` at three distinct time intervals: 5 minutes, 1 hour, and 24 hours as follows: - Number of distinct IP addresses associated to the visitor Id. - Number of distinct linked Ids associated with the visitor Id. - Number of distinct countries associated with the visitor Id. - Number of identification events associated with the visitor Id. - Number of identification events associated with the detected IP address. - Number of distinct IP addresses associated with the provided linked Id. - Number of distinct visitor Ids associated with the provided linked Id. The `24h` interval of `distinct_ip`, `distinct_linked_id`, `distinct_country`, `distinct_ip_by_linked_id` and `distinct_visitor_id_by_linked_id` will be omitted if the number of `events` for the visitor Id in the last 24 hours (`events.['24h']`) is higher than 20.000. All will not necessarily be returned in a response, some may be omitted if the associated event does not have the required data, such as a linked_id.
Sums key data points for a specific `visitor_id`, `ip_address` and `linked_id` at three distinct time intervals: 5 minutes, 1 hour, and 24 hours as follows: - Number of distinct IP addresses associated to the visitor Id. - Number of distinct linked Ids associated with the visitor Id. - Number of distinct countries associated with the visitor Id. - Number of identification events associated with the visitor Id. - Number of identification events associated with the detected IP address. - Number of distinct IP addresses associated with the provided linked Id. - Number of distinct visitor Ids associated with the provided linked Id. The `24_hours` interval of `distinct_ip`, `distinct_linked_id`, `distinct_country`, `distinct_ip_by_linked_id` and `distinct_visitor_id_by_linked_id` will be omitted if the number of `events` for the visitor Id in the last 24 hours (`events.['24_hours']`) is higher than 20.000. All will not necessarily be returned in a response, some may be omitted if the associated event does not have the required data, such as a linked_id.

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/VelocityData.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Is absent if the velocity data could not be generated for the visitor Id.
|------------ | ------------- | ------------- | -------------|
|**_5minutes** | **Integer** | Count for the last 5 minutes of velocity data, from the time of the event. | |
|**_1hour** | **Integer** | Count for the last 1 hour of velocity data, from the time of the event. | |
|**_24hours** | **Integer** | The `24_hours` interval of `distinct_ip`, `distinct_linked_id`, `distinct_country`, `distinct_ip_by_linked_id` and `distinct_visitor_id_by_linked_id` will be omitted if the number of `events` for the visitor Id in the last 24 hours (`events.['24_hours']`) is higher than 20.000. | [optional] |
|**_24hours** | **Integer** | Count for the last 24 hours of velocity data, from the time of the event. | [optional] |



Loading
Loading