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/active-call.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@fingerprint/php-sdk': minor
---

**events**: Add `active_call` smart signal to `Event`
5 changes: 5 additions & 0 deletions .changeset/fix-start-end-types.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@fingerprint/php-sdk': patch
---

**events**: Fix types for `start`/`start_date_time` and `end`/`end_date_time` in normalized schema
5 changes: 5 additions & 0 deletions .changeset/keyboard-layout-hash.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@fingerprint/php-sdk': minor
---

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

**events**: Add `battery_charging` field to `RawDeviceAttributes`
2 changes: 1 addition & 1 deletion .schema-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v3.4.2
v3.5.1
28 changes: 14 additions & 14 deletions docs/Api/FingerprintApi.md

Large diffs are not rendered by default.

5 changes: 3 additions & 2 deletions docs/Model/Event.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Event Class

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 @@ -28,6 +28,7 @@ Name | Type | Description | Notes
**client_referrer** | **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]
**browser_details** | [**\Fingerprint\ServerSdk\Model\BrowserDetails**](BrowserDetails.md) | | [optional]
**proximity** | [**\Fingerprint\ServerSdk\Model\Proximity**](Proximity.md) | | [optional]
**active_call** | **bool** | 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** | [**\Fingerprint\ServerSdk\Model\BotResult**](BotResult.md) | | [optional]
**bot_type** | **string** | Additional classification of the bot type if detected. | [optional]
**bot_info** | [**\Fingerprint\ServerSdk\Model\BotInfo**](BotInfo.md) | | [optional]
Expand Down Expand Up @@ -62,7 +63,7 @@ Name | Type | Description | Notes
**vpn_confidence** | [**\Fingerprint\ServerSdk\Model\VpnConfidence**](VpnConfidence.md) | | [optional]
**vpn_ml_score** | **float** | 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]
**vpn_origin_timezone** | **string** | Local timezone which is used in timezone_mismatch method. | [optional]
**vpn_origin_country** | **string** | Country of the request (only for Android SDK version >= 2.4.0, ISO 3166 format or unknown). | [optional]
**vpn_origin_country** | **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]
**vpn_methods** | [**\Fingerprint\ServerSdk\Model\VpnMethods**](VpnMethods.md) | | [optional]
**high_activity_device** | **bool** | Flag indicating if the request came from a high-activity visitor. | [optional]
**rare_device** | **bool** | `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
6 changes: 4 additions & 2 deletions docs/Model/RawDeviceAttributes.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Name | Type | Description | Notes
**font_preferences** | [**\Fingerprint\ServerSdk\Model\FontPreferences**](FontPreferences.md) | | [optional]
**emoji** | [**\Fingerprint\ServerSdk\Model\Emoji**](Emoji.md) | | [optional]
**fonts** | **string[]** | List of fonts detected on the device. | [optional]
**device_memory** | **int** | Rounded amount of RAM in gigabytes. | [optional]
**device_memory** | **int** | Rounded amount of RAM in gigabytes. Available for browsers, Android, and iOS devices. | [optional]
**timezone** | **string** | Timezone identifier detected on the client. | [optional]
**canvas** | [**\Fingerprint\ServerSdk\Model\Canvas**](Canvas.md) | | [optional]
**languages** | **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 @@ -36,7 +36,9 @@ Name | Type | Description | Notes
**device_manufacturer** | **string** | Device manufacturer string. Available only for Android and iOS devices. | [optional]
**font_hash** | **string** | Unique identifier for the user’s installed fonts. | [optional]
**timezone_offset** | **string** | UTC offset in \"±HH:MM\" format derived from the detected IANA timezone. | [optional]
**battery_level** | **int** | Battery charge level as a percentage (0-100). Available only for Android and iOS devices. | [optional]
**battery_level** | **int** | Battery charge level as a percentage (0-100). Available for Android, iOS, and web devices. On web, only available in Chromium-based browsers. | [optional]
**battery_charging** | **bool** | When `true`, the device is currently charging. Available only for web devices on Chromium-based browsers. | [optional]
**battery_low_power_mode** | **bool** | Whether the device's low power mode is enabled. Available only for Android and iOS devices. | [optional]
**keyboard_layout_hash** | **string** | Unique identifier for the user's keyboard layout. | [optional]

[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
2 changes: 1 addition & 1 deletion docs/Model/SearchEventsBotInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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.


## Values
Expand Down
4 changes: 2 additions & 2 deletions docs/Model/Velocity.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ intervals: 5 minutes, 1 hour, and 24 hours as follows:
- 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`,
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.['24h']`) is higher than 20.000.
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.
Expand Down
2 changes: 1 addition & 1 deletion docs/Model/VelocityData.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**_5_minutes** | **int** | Count for the last 5 minutes of velocity data, from the time of the event. |
**_1_hour** | **int** | Count for the last 1 hour of velocity data, from the time of the event. |
**_24_hours** | **int** | 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]
**_24_hours** | **int** | Count for the last 24 hours of velocity data, from the time of the event. | [optional]

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