v7.2.0-beta.2

Patch Changes

• temporary changeset: fix date-time formatting in query parameters (bb21f46)

v7.2.0-develop.0

Minor Changes

• events-search: Add start_date_time and end_date_time RFC3339 timestamp filters (c68cc6a)
• events: Add Android platform support to developer_tools smart signal (c68cc6a)
• events: Add labels to Event (c68cc6a)
• events: Add iOS platform support to developer_tools (c68cc6a)
• events-search: Add bot_info filter parameters (c68cc6a)
• events-search: Add unknown value to BotInfoCategory (c68cc6a)

Patch Changes

• events: Clarify availability of proxy and VM ML score signals (c68cc6a)
• events: Clarify semantics of incremental_identification_status (c68cc6a)
• visitors: Clarify rate limits for deleteVisitorData operation (c68cc6a)
• search-events: Fix BackedEnum query parameters causing "Object could not be converted to string" error in buildQuery (4fcd455)
• events-search: Clarify availability of rare_device and rare_device_percentile_bucket query parameters (c68cc6a)
• events-search: Fix pagination_key example (c68cc6a)

v7.2.0-beta.1

Minor Changes

• events-search: Add start_date_time and end_date_time RFC3339 timestamp filters (c68cc6a)
• events: Add Android platform support to developer_tools smart signal (c68cc6a)
• events: Add labels to Event (c68cc6a)
• events: Add iOS platform support to developer_tools (c68cc6a)
• events-search: Add bot_info filter parameters (c68cc6a)
• events-search: Add unknown value to BotInfoCategory (c68cc6a)

Patch Changes

• events: Clarify availability of proxy and VM ML score signals (c68cc6a)
• events: Clarify semantics of incremental_identification_status (c68cc6a)
• visitors: Clarify rate limits for deleteVisitorData operation (c68cc6a)
• search-events: Fix BackedEnum query parameters causing "Object could not be converted to string" error in buildQuery (4fcd455)
• events-search: Clarify availability of rare_device and rare_device_percentile_bucket query parameters (c68cc6a)
• events-search: Fix pagination_key example (c68cc6a)

v7.1.0

Minor Changes

• events: Add Device Rarity Smart Signal (2fb58fb)
• events: Add proxy_ml_score to Event (2fb58fb)
• events: Add font_hash and timezone_offset fields for the RawDeviceAttributes (2fb58fb)
• events: Enable raw_device_attributes for Android devices. Only device_manufacturer and device_model are currently supported for Android devices. (2fb58fb)
• events: Enable raw_device_attributes for iOS devices. Only device_manufacturer, device_model, hardware_concurrency, languages, and screen_resolution are currently supported for iOS devices. (2fb58fb)
• events: Add request_read_timeout error code (2fb58fb)

v6.11.0

Minor Changes

• Deprecated: fingerprint/fingerprint-pro-server-api-sdk uses Server API v3, which is deprecated. Please migrate to the new fingerprint/server-sdk package which uses Server API v4. (941be0c)
• • Add rareDevice Smart Signal for detecting rare or previously unseen devices.
  • events-search: Add rare_device and rare_device_percentile_bucket filter parameters.
  • Add type property to IPInfoASN.
  • Add integrations property to the SDK model.
  • Add confidence and mlScore properties to the Tampering signal.
  • Add mlScore property to the VirtualMachine signal.
  • Add WORKSPACE_SCOPED_SECRET_KEY_REQUIRED to the ErrorCode enum.
  • webhook: Add rareDevice property to the Webhook schema.
  • webhook: Add confidence and mlScore properties to WebhookTampering.
  • webhook: Add mlScore property to WebhookVirtualMachine. (0abc29f)

v6.11.0-beta.0

Minor Changes

• Deprecated: fingerprint/fingerprint-pro-server-api-sdk uses Server API v3, which is deprecated. Please migrate to the new fingerprint/server-sdk package which uses Server API v4. (941be0c)
• • Add rareDevice Smart Signal for detecting rare or previously unseen devices.
  • events-search: Add rare_device and rare_device_percentile_bucket filter parameters.
  • Add type property to IPInfoASN.
  • Add integrations property to the SDK model.
  • Add confidence and mlScore properties to the Tampering signal.
  • Add mlScore property to the VirtualMachine signal.
  • Add WORKSPACE_SCOPED_SECRET_KEY_REQUIRED to the ErrorCode enum.
  • webhook: Add rareDevice property to the Webhook schema.
  • webhook: Add confidence and mlScore properties to WebhookTampering.
  • webhook: Add mlScore property to WebhookVirtualMachine. (0abc29f)

v7.0.0

Major Changes

• Migrate to Server API v4.

  Breaking Changes

  • Flatten event structure. Access fields directly instead of through products wrapper/container.
  • Remove getVisits and getRelatedVisitors endpoints (use searchEvents instead).
  • Remove deprecated v3 models (webhook models, product wrapper models, etc.).
  • Rename getEvent parameter $request_id to $event_id. Return type changed from array to Event.
  • Change updateEvent parameter order and body class (EventsUpdateRequest → EventUpdate). Return type changed from array to void. HTTP method changed from PUT to PATCH.
  • Change searchEvents return type from array to EventSearch. new search parameters added.
  • Change deleteVisitorData return type from array to void.
  • Require API key in Configuration constructor: new Configuration(string $apiKey). Remove getDefaultConfiguration() and setDefaultConfiguration().
  • Simplify setApiKey/getApiKey to single-key (no identifier). Remove unnecessary setApiKeyPrefix, setAccessToken, setUsername, setPassword methods.
  • Switch authentication from API key header to Authorization: Bearer token.
  • Change all JSON serialization keys from camelCase to snake_case.
  • Change ErrorCode enum values from PascalCase to snake_case.
  • Append /v4 to all region base URLs.
  • Changed method return signature of operations.

  Migration Guide

  Fingerprint Server API Client initialization:

  - new FingerprintApi($client, $config);
  + new FingerprintApi($config, $client);

  Response/Model structure:

  - $event->getProducts()->getIdentification()->getData()->getVisitorId()
  + $event->getIdentification()->getVisitorId()

  Configuration:

  - $config = Configuration::getDefaultConfiguration('secret-api-key');
  + $config = new Configuration('secret-api-key');

  Region parameter:

  - $config = Configuration::getDefaultConfiguration('key', Configuration::REGION_EUROPE);
  + $config = new Configuration('key', Configuration::REGION_EUROPE);

  New operation return format:

  - list($event, $response) = $api->getEvent($requestId);
  + $event = $api->getEvent($eventId);

  If you need raw response:

  - list($event, $response) = $api->getEvent($requestId);
  + list($event, $response) = $api->getEventWithHttpInfo($eventId);

  Update event:

  - $body = new EventsUpdateRequest(['tag' => ['key' => 'value']]);
  - $api->updateEvent($body, $requestId);
  + $body = new EventUpdate(['tags' => ['key' => 'value']]);
  + $api->updateEvent($eventId, $body);

  New Features

  • New v4 models: BotInfo, Canvas, Emoji, EventRuleAction, RawDeviceAttributes, TamperingDetails, ...
  • New enum models: BotResult, TamperingConfidence, VpnConfidence, ProxyConfidence, RuleActionType, ...
  • New WithHttpInfo method variants for all operations. Each operation now exposes four methods: {operationId}(), {operationId}WithHttpInfo(), {operationId}Async(), {operationId}AsyncWithHttpInfo().
  • mTLS support with setCertFile() and setKeyFile() on Configuration. (67ac090)

• Drop PHP 8.1 support. Minimum required PHP version is now 8.2. (72432d3)

• Changed package name to fingerprint/server-sdk

  BREAKING CHANGE:

  • Update the composer dependency to fingerprint/server-sdk
  • Update all use statements to the new namespace Fingerprint\ServerSdk

  MIGRATION GUIDE:

  Replace composer.json dependency:

  "require": {
  -    "fingerprint/fingerprint-pro-server-api-sdk": "^6.10.0"
  +    "fingerprint/server-sdk": "^7.0.0"
  }

  Replace all use statements with the new namespace:

  -use Fingerprint\ServerAPI\Configuration;
  +use Fingerprint\ServerSdk\Configuration;

  The above example applies to all Fingerprint\ServerAPI references. (c72108a)

v7.0.0-develop.0

Major Changes

• Migrate to Server API v4.

  Breaking Changes

  • Flatten event structure. Access fields directly instead of through products wrapper/container.
  • Remove getVisits and getRelatedVisitors endpoints (use searchEvents instead).
  • Remove deprecated v3 models (webhook models, product wrapper models, etc.).
  • Rename getEvent parameter $request_id to $event_id. Return type changed from array to Event.
  • Change updateEvent parameter order and body class (EventsUpdateRequest → EventUpdate). Return type changed from array to void. HTTP method changed from PUT to PATCH.
  • Change searchEvents return type from array to EventSearch. new search parameters added.
  • Change deleteVisitorData return type from array to void.
  • Require API key in Configuration constructor: new Configuration(string $apiKey). Remove getDefaultConfiguration() and setDefaultConfiguration().
  • Simplify setApiKey/getApiKey to single-key (no identifier). Remove unnecessary setApiKeyPrefix, setAccessToken, setUsername, setPassword methods.
  • Switch authentication from API key header to Authorization: Bearer token.
  • Change all JSON serialization keys from camelCase to snake_case.
  • Change ErrorCode enum values from PascalCase to snake_case.
  • Append /v4 to all region base URLs.
  • Changed method return signature of operations.

  Migration Guide

  Response/Model structure:

  - $event->getProducts()->getIdentification()->getData()->getVisitorId()
  + $event->getIdentification()->getVisitorId()

  Configuration:

  - $config = Configuration::getDefaultConfiguration('secret-api-key');
  + $config = new Configuration('secret-api-key');

  Region parameter:

  - $config = Configuration::getDefaultConfiguration('key', Configuration::REGION_EUROPE);
  + $config = new Configuration('key', Configuration::REGION_EUROPE);

  New operation return format:

  - list($event, $response) = $api->getEvent($requestId);
  + $event = $api->getEvent($eventId);

  If you need raw response:

  - list($event, $response) = $api->getEvent($requestId);
  + list($event, $response) = $api->getEventWithHttpInfo($eventId);

  Update event:

  - $body = new EventsUpdateRequest(['tag' => ['key' => 'value']]);
  - $api->updateEvent($body, $requestId);
  + $body = new EventUpdate(['tags' => ['key' => 'value']]);
  + $api->updateEvent($eventId, $body);

  New Features

  • New v4 models: BotInfo, Canvas, Emoji, EventRuleAction, RawDeviceAttributes, TamperingDetails, ...
  • New enum models: BotResult, TamperingConfidence, VpnConfidence, ProxyConfidence, RuleActionType, ...
  • New WithHttpInfo method variants for all operations. Each operation now exposes four methods: {operationId}(), {operationId}WithHttpInfo(), {operationId}Async(), {operationId}AsyncWithHttpInfo().
  • mTLS support with setCertFile() and setKeyFile() on Configuration. (67ac090)

• Drop PHP 8.1 support. Minimum required PHP version is now 8.2. (72432d3)

• Changed package name to fingerprint/server-sdk

  BREAKING CHANGE:

  • Update the composer dependency to fingerprint/server-sdk
  • Update all use statements to the new namespace Fingerprint\ServerSdk

  MIGRATION GUIDE:

  Replace composer.json dependency:

  "require": {
  -    "fingerprint/fingerprint-pro-server-api-sdk": "^6.10.0"
  +    "fingerprint/server-sdk": "^7.0.0"
  }

  Replace all use statements with the new namespace:

  -use Fingerprint\ServerAPI\Configuration;
  +use Fingerprint\ServerSdk\Configuration;

  The above example applies to all Fingerprint\ServerAPI references. (c72108a)

v7.0.0-beta.1

Major Changes

• Migrate to Server API v4.

  Breaking Changes

  • Flatten event structure. Access fields directly instead of through products wrapper/container.
  • Remove getVisits and getRelatedVisitors endpoints (use searchEvents instead).
  • Remove deprecated v3 models (webhook models, product wrapper models, etc.).
  • Rename getEvent parameter $request_id to $event_id. Return type changed from array to Event.
  • Change updateEvent parameter order and body class (EventsUpdateRequest → EventUpdate). Return type changed from array to void. HTTP method changed from PUT to PATCH.
  • Change searchEvents return type from array to EventSearch. new search parameters added.
  • Change deleteVisitorData return type from array to void.
  • Require API key in Configuration constructor: new Configuration(string $apiKey). Remove getDefaultConfiguration() and setDefaultConfiguration().
  • Simplify setApiKey/getApiKey to single-key (no identifier). Remove unnecessary setApiKeyPrefix, setAccessToken, setUsername, setPassword methods.
  • Switch authentication from API key header to Authorization: Bearer token.
  • Change all JSON serialization keys from camelCase to snake_case.
  • Change ErrorCode enum values from PascalCase to snake_case.
  • Append /v4 to all region base URLs.
  • Changed method return signature of operations.

  Migration Guide

  Response/Model structure:

  - $event->getProducts()->getIdentification()->getData()->getVisitorId()
  + $event->getIdentification()->getVisitorId()

  Configuration:

  - $config = Configuration::getDefaultConfiguration('secret-api-key');
  + $config = new Configuration('secret-api-key');

  Region parameter:

  - $config = Configuration::getDefaultConfiguration('key', Configuration::REGION_EUROPE);
  + $config = new Configuration('key', Configuration::REGION_EUROPE);

  New operation return format:

  - list($event, $response) = $api->getEvent($requestId);
  + $event = $api->getEvent($eventId);

  If you need raw response:

  - list($event, $response) = $api->getEvent($requestId);
  + list($event, $response) = $api->getEventWithHttpInfo($eventId);

  Update event:

  - $body = new EventsUpdateRequest(['tag' => ['key' => 'value']]);
  - $api->updateEvent($body, $requestId);
  + $body = new EventUpdate(['tags' => ['key' => 'value']]);
  + $api->updateEvent($eventId, $body);

  New Features

  • New v4 models: BotInfo, Canvas, Emoji, EventRuleAction, RawDeviceAttributes, TamperingDetails, ...
  • New enum models: BotResult, TamperingConfidence, VpnConfidence, ProxyConfidence, RuleActionType, ...
  • New WithHttpInfo method variants for all operations. Each operation now exposes four methods: {operationId}(), {operationId}WithHttpInfo(), {operationId}Async(), {operationId}AsyncWithHttpInfo().
  • mTLS support with setCertFile() and setKeyFile() on Configuration. (67ac090)

• Drop PHP 8.1 support. Minimum required PHP version is now 8.2. (72432d3)

• Changed package name to fingerprint/server-sdk

  BREAKING CHANGE:

  • Update the composer dependency to fingerprint/server-sdk
  • Update all use statements to the new namespace Fingerprint\ServerSdk

  MIGRATION GUIDE:

  Replace composer.json dependency:

  "require": {
  -    "fingerprint/fingerprint-pro-server-api-sdk": "^6.10.0"
  +    "fingerprint/server-sdk": "^7.0.0"
  }

  Replace all use statements with the new namespace:

  -use Fingerprint\ServerAPI\Configuration;
  +use Fingerprint\ServerSdk\Configuration;

  The above example applies to all Fingerprint\ServerAPI references. (c72108a)

v6.10.0

Minor Changes

• events-search: Event search now supports a new set of filter parameters: developer_tools, location_spoofing, mitm_attack, proxy, sdk_version, sdk_platform, environment (f385bfa)
• webhook: Add supplementaryIds property to the Webhooks schema. (f385bfa)
• Add proximity signal that represents a fixed geographical zone in a discrete global grid within which the device is observed. (47a43dc)
• Add environmentId property to identification (f385bfa)