CHANGELOG.md

Fingerprint Server PHP SDK

7.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

  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)

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

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

6.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)

6.10.0-develop.1

Minor Changes

• Add proximity signal that represents a fixed geographical zone in a discrete global grid within which the device is observed. (47a43dc)

6.10.0-develop.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 environmentId property to identification (f385bfa)

6.9.0

Minor Changes

• Add details object to the proxy signal. This field includes the type of the detected proxy (residential or data_center) and the lastSeenAt timestamp of when an IP was last observed to show proxy-like behavior. (e7f492e)

6.8.0

Minor Changes

• Mark replayed field required in the identification product schema. This field will always be present. (b12c11e)
• Add sdk field with platform metadata to identification (b12c11e)

Patch Changes

• Deprecate the Remote Control Detection Smart Signal. This signal is no longer available. (b12c11e)

6.8.0-develop.0

Minor Changes

• Mark replayed field required in the identification product schema. This field will always be present. (b12c11e)
• Add sdk field with platform metadata to identification (b12c11e)

Patch Changes

• Deprecate the Remote Control Detection Smart Signal. This signal is no longer available. (b12c11e)

6.7.0

Minor Changes

• add replayed field to identification in Events and Webhooks (098df62)

6.6.0

Minor Changes

• Add confidence property to the Proxy detection Smart Signal, which now supports both residential and public web proxies. (c370f3c)

6.5.0

Minor Changes

• events-search: Event search now supports a new set of filter parameters: vpn, virtual_machine, tampering, anti_detect_browser, incognito, privacy_settings, jailbroken, frida, factory_reset, cloned_app, emulator, root_apps, vpn_confidence, min_suspect_score. (9ec63ea)
• events-search: Event search now supports two new filter parameters: ip_blocklist, datacenter (e2b6aba)

Patch Changes

• webhook: Apply x-flatten-optional-params: true in correct place in the webhook.yaml (9ec63ea)
• events: Update Tampering descriptions to reflect Android support. (9ec63ea)
• webhook: Add environmentId property (9ec63ea)

6.5.0-develop.0

Minor Changes

• events-search: Event search now supports a new set of filter parameters: vpn, virtual_machine, tampering, anti_detect_browser, incognito, privacy_settings, jailbroken, frida, factory_reset, cloned_app, emulator, root_apps, vpn_confidence, min_suspect_score. (9ec63ea)
• events-search: Event search now supports two new filter parameters: ip_blocklist, datacenter (e2b6aba)

Patch Changes

• webhook: Apply x-flatten-optional-params: true in correct place in the webhook.yaml (9ec63ea)
• events: Update Tampering descriptions to reflect Android support. (9ec63ea)
• webhook: Add environmentId property (9ec63ea)

6.4.0

Minor Changes

• Add mitmAttack (man-in-the-middle attack) Smart Signal. (ac79de9)

6.3.0

Minor Changes

• events-search: Add a new events/search API endpoint. Allow users to search for identification events matching one or more search criteria, for example, visitor ID, IP address, bot detection result, etc. (3a45444)

6.3.0-develop.1

Minor Changes

• events-search: Add 'pagination_key' parameter (35d2807)

Patch Changes

• events-search: Improve parameter descriptions for bot, suspect (99481d8)

6.3.0-develop.0

Minor Changes

• events-search: Add a new events/search API endpoint. Allow users to search for identification events matching one or more search criteria, for example, visitor ID, IP address, bot detection result, etc. (3a45444)

6.2.1

Patch Changes

• Fix problem with empty Sibdivisions array in the Geolocation model (ebd29b3)
• Fix scalar values serialization (affects EventsUpdateRequest) (123ca07)

6.2.0

Minor Changes

• Add Related Visitors API (4f3030b)

6.1.0

Minor Changes

• Add relay detection method to the VPN Detection Smart Signal (afcf2e9)
• events: Add a suspect field to the identification product schema (afcf2e9)

6.0.0

The underlying Server API hasn’t changed, but we made SDK type and class generation more precise, resulting in small breaking changes for the SDK itself. This change should make the SDK API a lot more stable going forward

Major Changes

• • Remove the BrowserDetails field botProbability.
  • Update the IdentificationConfidence field score type format: float -> double.
  • Make the RawDeviceAttributeError field name optional .
  • Make the RawDeviceAttributeError field message optional .
  • events: Remove the EventsResponse field error.
    • [note]: The errors are represented by ErrorResponse model.
  • events: Update the HighActivity field dailyRequests type format: number -> int64.
  • events: Specify the Tampering field anomalyScore type format: double.
  • webhook: Make the Webhook fields optional: visitorId, visitorFound, firstSeenAt, lastSeenAt, browserDetails, incognito.
  • webhook: Make the WebhookClonedApp field result optional.
  • webhook: Make the WebhookDeveloperTools field result optional.
  • webhook: Make the WebhookEmulator field result optional.
  • webhook: Make the WebhookFactoryReset fields time and timestamp optional.
  • webhook: Make the WebhookFrida field result optional.
  • webhook: Update the WebhookHighActivity field dailyRequests type format: number -> int64.
  • webhook: Make the WebhookIPBlocklist fields result and details optional.
  • webhook: Make the WebhookJailbroken field result optional.
  • webhook: Make the WebhookLocationSpoofing field result optional.
  • webhook: Make the WebhookPrivacySettings field result optional.
  • webhook: Make the WebhookProxy field result optional.
  • webhook: Make the WebhookRemoteControl field result optional.
  • webhook: Make the WebhookRootApps field result optional.
  • webhook: Make the WebhookSuspectScore field result optional.
  • webhook: Make the WebhookTampering fields result, anomalyScore and antiDetectBrowser optional.
  • webhook: Specify the WebhookTampering field anomalyScore type format: double.
  • webhook: Make the WebhookTor field result optional.
  • webhook: Make the WebhookVelocity fields optional: distinctIp, distinctLinkedId, distinctCountry, events, ipEvents, distinctIpByLinkedId, distinctVisitorIdByLinkedId.
  • webhook: Make the WebhookVirtualMachine field result optional.
  • webhook: Make the WebhookVPN fields optional: result, confidence, originTimezone, methods. (5645bf0)
• • Rename BotdResult -> Botd.
  • Rename BotdDetectionResult -> BotdBot:
    • Extract result type as BotdBotResult.
  • Rename ClonedAppResult -> ClonedApp.
  • Rename DeveloperToolsResult -> DeveloperTools.
  • Rename EmulatorResult -> Emulator.
  • Refactor error models:
    • Remove ErrorCommon403Response, ErrorCommon429Response, ErrorEvent404Response, TooManyRequestsResponse, ErrorVisits403, ErrorUpdateEvent400Response, ErrorUpdateEvent409Response, ErrorVisitor400Response, ErrorVisitor404Response, IdentificationError, ProductError.
    • Introduce ErrorResponse and ErrorPlainResponse.
      • [note]: ErrorPlainResponse has a different format { "error": string } and it is used only in GET /visitors.
    • Extract error type as Error.
    • Extract error.code type as ErrorCode.
  • Rename EventResponse -> EventsGetResponse.
  • Rename EventUpdateRequest -> EventsUpdateRequest.
  • Rename FactoryResetResult -> FactoryReset.
  • Rename FridaResult -> Frida.
  • Rename IPLocation -> Geolocation:
    • Rename IPLocationCity -> GeolocationCity.
    • Extract subdivisions type as GeolocationSubdivisions.
    • Rename Location -> GeolocationContinent:
    • Introduce a dedicated type GeolocationCountry.
    • Rename Subdivision -> GeolocationSubdivision.
  • Rename HighActivityResult -> HighActivity.
  • Rename Confidence -> IdentificationConfidence.
  • Rename SeenAt -> IdentificationSeenAt.
  • Rename IncognitoResult -> Incognito.
  • Rename IpBlockListResult -> IPBlocklist:
    • Extract details type as IPBlocklistDetails.
  • Rename IpInfoResult -> IPInfo:
    • Rename IpInfoResultV4 -> IPInfoV4.
    • Rename IpInfoResultV6 -> IPInfoV6.
    • Rename ASN -> IPInfoASN.
    • Rename DataCenter -> IPInfoDataCenter.
  • Rename JailbrokenResult -> Jailbroken.
  • Rename LocationSpoofingResult -> LocationSpoofing.
  • Rename PrivacySettingsResult -> PrivacySettings.
  • Rename ProductsResponse -> Products:
    • Rename inner types: ProductsResponseIdentification -> ProductIdentification, ProductsResponseIdentificationData -> Identification, ProductsResponseBotd -> ProductBotd, SignalResponseRootApps -> ProductRootApps, SignalResponseEmulator -> ProductEmulator, SignalResponseIpInfo -> ProductIPInfo, SignalResponseIpBlocklist -> ProductIPBlocklist, SignalResponseTor -> ProductTor, SignalResponseVpn -> ProductVPN, SignalResponseProxy -> ProductProxy, ProxyResult -> Proxy, SignalResponseIncognito -> ProductIncognito, SignalResponseTampering -> ProductTampering, SignalResponseClonedApp -> ProductClonedApp, SignalResponseFactoryReset -> ProductFactoryReset, SignalResponseJailbroken -> ProductJailbroken, SignalResponseFrida -> ProductFrida, SignalResponsePrivacySettings -> ProductPrivacySettings, SignalResponseVirtualMachine -> ProductVirtualMachine, SignalResponseRawDeviceAttributes -> ProductRawDeviceAttributes, RawDeviceAttributesResultValue -> RawDeviceAttributes, SignalResponseHighActivity -> ProductHighActivity, SignalResponseLocationSpoofing -> ProductLocationSpoofing, SignalResponseSuspectScore -> ProductSuspectScore, SignalResponseRemoteControl -> ProductRemoteControl, SignalResponseVelocity -> ProductVelocity, SignalResponseDeveloperTools -> ProductDeveloperTools.
    • Extract identification.data type as Identification.
  • Use PHP array instead of RawDeviceAttributesResult
  • Rename RemoteControlResult -> RemoteControl.
  • Rename RootAppsResult -> RootApps.
  • Rename SuspectScoreResult -> SuspectScore.
  • Rename TamperingResult -> Tampering.
  • Rename TorResult -> Tor.
  • Rename VelocityResult -> Velocity:
    • Rename VelocityIntervals -> VelocityData.
    • Rename VelocityIntervalResult -> VelocityIntervals.
  • Rename VirtualMachineResult -> VirtualMachine.
  • Rename the Visit field ipLocation type DeprecatedIPLocation -> DeprecatedGeolocation.
    • Instead of DeprecatedIPLocationCity use common GeolocationCity
  • Rename Response -> VisitorsGetResponse.
    • Omit extra inner type ResponseVisits
  • Rename VpnResult -> VPN.
    • Extract confidence type as VPNConfidence.
    • Extract methods type as VPNMethods.
  • Rename WebhookVisit -> Webhook.
    • Introduce new inner types: WebhookRootApps, WebhookEmulator, WebhookIPInfo, WebhookIPBlocklist, WebhookTor, WebhookVPN, WebhookProxy, WebhookTampering, WebhookClonedApp, WebhookFactoryReset, WebhookJailbroken, WebhookFrida, WebhookPrivacySettings, WebhookVirtualMachine, WebhookHighActivity, WebhookLocationSpoofing, WebhookSuspectScore, WebhookRemoteControl, WebhookVelocity, WebhookDeveloperTools. (5645bf0)

Minor Changes

• Added new ipEvents, distinctIpByLinkedId, and distinctVisitorIdByLinkedId fields to the velocity Smart Signal. (5645bf0)
• • Make the GeolocationCity field name required.
  • Make the GeolocationSubdivision field isoCode required.
  • Make the GeolocationSubdivision field name required.
  • Make the IPInfoASN field name required .
  • Make the IPInfoDataCenter field name required.
  • Add optional IdentificationConfidence field comment.
  • events: Add optional Botd field meta.
  • events: Add optional Identification field components.
  • events: Make the VPN field originCountry required.
  • visitors: Add optional Visit field components.
  • webhook: Add optional Webhook field components. (5645bf0)
• Remove ipv4 format from ip field in Botd, Identification, Visit and Webhook models. (5645bf0)
• events: Add antiDetectBrowser detection method to the tampering Smart Signal. (5645bf0)

6.0.0-rc.0

Major Changes

• • Remove the BrowserDetails field botProbability.
  • Update the IdentificationConfidence field score type format: float -> double.
  • Make the RawDeviceAttributeError field name optional .
  • Make the RawDeviceAttributeError field message optional .
  • events: Remove the EventsResponse field error.
    • [note]: The errors are represented by ErrorResponse model.
  • events: Update the HighActivity field dailyRequests type format: number -> int64.
  • events: Specify the Tampering field anomalyScore type format: double.
  • webhook: Make the Webhook fields optional: visitorId, visitorFound, firstSeenAt, lastSeenAt, browserDetails, incognito.
  • webhook: Make the WebhookClonedApp field result optional.
  • webhook: Make the WebhookDeveloperTools field result optional.
  • webhook: Make the WebhookEmulator field result optional.
  • webhook: Make the WebhookFactoryReset fields time and timestamp optional.
  • webhook: Make the WebhookFrida field result optional.
  • webhook: Update the WebhookHighActivity field dailyRequests type format: number -> int64.
  • webhook: Make the WebhookIPBlocklist fields result and details optional.
  • webhook: Make the WebhookJailbroken field result optional.
  • webhook: Make the WebhookLocationSpoofing field result optional.
  • webhook: Make the WebhookPrivacySettings field result optional.
  • webhook: Make the WebhookProxy field result optional.
  • webhook: Make the WebhookRemoteControl field result optional.
  • webhook: Make the WebhookRootApps field result optional.
  • webhook: Make the WebhookSuspectScore field result optional.
  • webhook: Make the WebhookTampering fields result, anomalyScore and antiDetectBrowser optional.
  • webhook: Specify the WebhookTampering field anomalyScore type format: double.
  • webhook: Make the WebhookTor field result optional.
  • webhook: Make the WebhookVelocity fields optional: distinctIp, distinctLinkedId, distinctCountry, events, ipEvents, distinctIpByLinkedId, distinctVisitorIdByLinkedId.
  • webhook: Make the WebhookVirtualMachine field result optional.
  • webhook: Make the WebhookVPN fields optional: result, confidence, originTimezone, methods. (5645bf0)
• • Rename BotdResult -> Botd.
  • Rename BotdDetectionResult -> BotdBot:
    • Extract result type as BotdBotResult.
  • Rename ClonedAppResult -> ClonedApp.
  • Rename DeveloperToolsResult -> DeveloperTools.
  • Rename EmulatorResult -> Emulator.
  • Refactor error models:
    • Remove ErrorCommon403Response, ErrorCommon429Response, ErrorEvent404Response, TooManyRequestsResponse, ErrorVisits403, ErrorUpdateEvent400Response, ErrorUpdateEvent409Response, ErrorVisitor400Response, ErrorVisitor404Response, IdentificationError, ProductError.
    • Introduce ErrorResponse and ErrorPlainResponse.
      • [note]: ErrorPlainResponse has a different format { "error": string } and it is used only in GET /visitors.
    • Extract error type as Error.
    • Extract error.code type as ErrorCode.
  • Rename EventResponse -> EventsGetResponse.
  • Rename EventUpdateRequest -> EventsUpdateRequest.
  • Rename FactoryResetResult -> FactoryReset.
  • Rename FridaResult -> Frida.
  • Rename IPLocation -> Geolocation:
    • Rename IPLocationCity -> GeolocationCity.
    • Extract subdivisions type as GeolocationSubdivisions.
    • Rename Location -> GeolocationContinent:
    • Introduce a dedicated type GeolocationCountry.
    • Rename Subdivision -> GeolocationSubdivision.
  • Rename HighActivityResult -> HighActivity.
  • Rename Confidence -> IdentificationConfidence.
  • Rename SeenAt -> IdentificationSeenAt.
  • Rename IncognitoResult -> Incognito.
  • Rename IpBlockListResult -> IPBlocklist:
    • Extract details type as IPBlocklistDetails.
  • Rename IpInfoResult -> IPInfo:
    • Rename IpInfoResultV4 -> IPInfoV4.
    • Rename IpInfoResultV6 -> IPInfoV6.
    • Rename ASN -> IPInfoASN.
    • Rename DataCenter -> IPInfoDataCenter.
  • Rename JailbrokenResult -> Jailbroken.
  • Rename LocationSpoofingResult -> LocationSpoofing.
  • Rename PrivacySettingsResult -> PrivacySettings.
  • Rename ProductsResponse -> Products:
    • Rename inner types: ProductsResponseIdentification -> ProductIdentification, ProductsResponseIdentificationData -> Identification, ProductsResponseBotd -> ProductBotd, SignalResponseRootApps -> ProductRootApps, SignalResponseEmulator -> ProductEmulator, SignalResponseIpInfo -> ProductIPInfo, SignalResponseIpBlocklist -> ProductIPBlocklist, SignalResponseTor -> ProductTor, SignalResponseVpn -> ProductVPN, SignalResponseProxy -> ProductProxy, ProxyResult -> Proxy, SignalResponseIncognito -> ProductIncognito, SignalResponseTampering -> ProductTampering, SignalResponseClonedApp -> ProductClonedApp, SignalResponseFactoryReset -> ProductFactoryReset, SignalResponseJailbroken -> ProductJailbroken, SignalResponseFrida -> ProductFrida, SignalResponsePrivacySettings -> ProductPrivacySettings, SignalResponseVirtualMachine -> ProductVirtualMachine, SignalResponseRawDeviceAttributes -> ProductRawDeviceAttributes, RawDeviceAttributesResultValue -> RawDeviceAttributes, SignalResponseHighActivity -> ProductHighActivity, SignalResponseLocationSpoofing -> ProductLocationSpoofing, SignalResponseSuspectScore -> ProductSuspectScore, SignalResponseRemoteControl -> ProductRemoteControl, SignalResponseVelocity -> ProductVelocity, SignalResponseDeveloperTools -> ProductDeveloperTools.
    • Extract identification.data type as Identification.
  • Use PHP array instead of RawDeviceAttributesResult
  • Rename RemoteControlResult -> RemoteControl.
  • Rename RootAppsResult -> RootApps.
  • Rename SuspectScoreResult -> SuspectScore.
  • Rename TamperingResult -> Tampering.
  • Rename TorResult -> Tor.
  • Rename VelocityResult -> Velocity:
    • Rename VelocityIntervals -> VelocityData.
    • Rename VelocityIntervalResult -> VelocityIntervals.
  • Rename VirtualMachineResult -> VirtualMachine.
  • Rename the Visit field ipLocation type DeprecatedIPLocation -> DeprecatedGeolocation.
    • Instead of DeprecatedIPLocationCity use common GeolocationCity
  • Rename Response -> VisitorsGetResponse.
    • Omit extra inner type ResponseVisits
  • Rename VpnResult -> VPN.
    • Extract confidence type as VPNConfidence.
    • Extract methods type as VPNMethods.
  • Rename WebhookVisit -> Webhook.
    • Introduce new inner types: WebhookRootApps, WebhookEmulator, WebhookIPInfo, WebhookIPBlocklist, WebhookTor, WebhookVPN, WebhookProxy, WebhookTampering, WebhookClonedApp, WebhookFactoryReset, WebhookJailbroken, WebhookFrida, WebhookPrivacySettings, WebhookVirtualMachine, WebhookHighActivity, WebhookLocationSpoofing, WebhookSuspectScore, WebhookRemoteControl, WebhookVelocity, WebhookDeveloperTools. (5645bf0)

Minor Changes

• Added new ipEvents, distinctIpByLinkedId, and distinctVisitorIdByLinkedId fields to the velocity Smart Signal. (5645bf0)
• • Make the GeolocationCity field name required.
  • Make the GeolocationSubdivision field isoCode required.
  • Make the GeolocationSubdivision field name required.
  • Make the IPInfoASN field name required .
  • Make the IPInfoDataCenter field name required.
  • Add optional IdentificationConfidence field comment.
  • events: Add optional Botd field meta.
  • events: Add optional Identification field components.
  • events: Make the VPN field originCountry required.
  • visitors: Add optional Visit field components.
  • webhook: Add optional Webhook field components. (5645bf0)
• Remove ipv4 format from ip field in Botd, Identification, Visit and Webhook models. (5645bf0)
• events: Add antiDetectBrowser detection method to the tampering Smart Signal. (5645bf0)

5.1.1

Patch Changes

• Mark nullable types as an optional, will fix #123 (9e8f44a)

5.1.0

Minor Changes

• Introduce toPrettyString in models that returns json encoded model in a pretty format (2e5010b)
• visitors: Add the confidence field to the VPN Detection Smart Signal (4f809a0)

Patch Changes

• Correctly handle boolean values in updateEvent method request body (d5a8d80)
• Fix body in updateEvent method always being sent as empty json (acdc56e)

5.1.0-develop.2

Patch Changes

• Correctly handle boolean values in updateEvent method request body (d5a8d80)

5.1.0-develop.1

Minor Changes

• Introduce toPrettyString in models that returns json encoded model in a pretty format (2e5010b)

Patch Changes

• Fix body in updateEvent method always being sent as empty json (acdc56e)

5.1.0-develop.0

Minor Changes

• visitors: Add the confidence field to the VPN Detection Smart Signal (4f809a0)

5.0.0 (2024-09-09)

⚠ BREAKING CHANGES

• Renamed Error Response Model Names ErrorEvent403ResponseError → Common403ErrorResponse ManyRequestsResponse → TooManyRequestsResponse
• Webhook tag field is now optional
• API Methods now throws SerializationException
• API Methods returns tuple instead of models
• API Methods removed other than getModel
• Upgraded minimum php version to 8.1
• Request logic is rewritten, Upgraded minimum php version to 8.1

Features

• add Confidence Score v1.1
• add remoteControl, velocity and developerTools signals (5bf9368)
• add delete visitor data endpoint (a00f325)
• add retry after policy to api exception (64e0510)
• add support for validating webhook signatures inter-768 (6a4cbd6)
• add update event endpoint (PUT) (cb21d0b)
• change api to return tuple instead of serialized model (62e4ad3)
• introduce rawResponse for getVisits and getEvent methods (9b01ba6)
• introduce serialization exception (bfea23a)
• only generate models and docs from swagger codegen (26e984f)
• remove raw response and introduce with http info (ce2fedf)
• rewrite request logic (0016822)
• upgrade min php version to 8 (5698871)

Bug Fixes

• php-cs-fixer keep nullable return annotations (99011b7)
• serializaiton problem on sealed results (29cb26c)
• use linter with current config via docker (9613c34)

5.0.0-develop.3 (2024-09-09)

Bug Fixes

• php-cs-fixer keep nullable return annotations (99011b7)

5.0.0-develop.3 (2024-09-04)

Bug Fixes

• php-cs-fixer keep nullable return annotations (99011b7)

5.0.0-develop.2 (2024-09-04)

Bug Fixes

• use linter with current config via docker (9613c34)

5.0.0-develop.1 (2024-09-04)

⚠ BREAKING CHANGES

• Renamed Error Response Model Names ErrorEvent403ResponseError → Common403ErrorResponse ManyRequestsResponse → TooManyRequestsResponse
• Webhook tag field is now optional
• API Methods now throws SerializationException
• API Methods returns tuple instead of models
• API Methods removed other than getModel
• Upgraded minimum php version to 8.1
• Request logic is rewritten, Upgraded minimum php version to 8.1

Features

• add remoteControl, velocity and developerTools signals (5bf9368)
• add delete visitor data endpoint (a00f325)
• add retry after policy to api exception (64e0510)
• add support for validating webhook signatures inter-768 (6a4cbd6)
• add update event endpoint (PUT) (cb21d0b)
• change api to return tuple instead of serialized model (62e4ad3)
• introduce rawResponse for getVisits and getEvent methods (9b01ba6)
• introduce serialization exception (bfea23a)
• only generate models and docs from swagger codegen (26e984f)
• remove raw response and introduce with http info (ce2fedf)
• rewrite request logic (0016822)
• upgrade min php version to 8 (5698871)

Bug Fixes

• serializaiton problem on sealed results (29cb26c)

4.1.0 (2024-03-26)

Features

• deprecate support for PHP versions older than 8.1 (56042c3)

Documentation

• README: fix badges formatting (779c726)

4.0.0 (2024-03-12)

⚠ BREAKING CHANGES

• change models for the most smart signals
• make identification field confidence optional
• deprecated ipLocation field uses DeprecatedIpLocation model

Features

• add linkedId field to the BotdResult type (13d1998)
• add originCountry field to the vpn signal (d3763f9)
• add SuspectScore smart signal support (aad70df)
• change url field format from URI to regular String (425576e)
• fix ipLocation deprecation (60c77d8)
• make identification field tag required (fbcb954)
• use shared structures for webhooks and event (49480f9)

Bug Fixes

• make fields required according to real API response (d129f54)

3.1.0 (2024-02-13)

Features

• add method for decoding sealed results (2008cf6)

3.0.0 (2024-01-11)

⚠ BREAKING CHANGES

• IpInfo field data_center renamed to datacenter

Features

• deprecate IPLocation (ad6201c)
• use datacenter instead of the wrong dataCenter (19158aa)

2.2.0 (2023-11-27)

Features

• add highActivity and locationSpoofing signals, support originTimezone for vpn signal (e35961c)

2.1.1 (2023-09-19)

Bug Fixes

• update OpenAPI Schema with asn and dataCenter signals (36fcfe3)
• update OpenAPI Schema with auxiliaryMobile method for VPN signal (ab8c25a)

2.1.0 (2023-07-31)

Features

• add raw attributes support (d47e33a)
• add smart signals support (40011bb)

Bug Fixes

• generate correct code for the RawDeviceAttributes signal (fd71960)

2.0.0 (2023-06-06)

⚠ BREAKING CHANGES

• For getVisits method $before argument is deprecated Use $pagination_key instead.

Features

• update schema with correct IpLocation format and doc updates (0318b55)

1.2.2 (2023-05-26)

Bug Fixes

• generate backtick symbol correctly for model documentation (e33153c)
• update schema (788dddb)

1.2.1 (2023-05-26)

Bug Fixes

• update schema with improved documentation (69c8bab)
• update templates to correctly generate backtick symbol instead of html variant ` (bb7f732), closes #x60

1.2.0 (2023-05-16)

Features

• update schema to introduce new signals (cc7640a)

1.1.0 (2023-03-01)

Features

• guzzle: support laravel9 by guzzle 7.4 (4368166)
• laravel: support for 2 latest major laravel version (e648b5e)

1.1.0-develop.2 (2023-03-01)

Features

• laravel: support for 2 latest major laravel version (e648b5e)

1.1.0-develop.1 (2023-03-01)

Features

• guzzle: support laravel9 by guzzle 7.4 (4368166)

1.0.1 (2022-11-11)

Documentation

• README: change description formatting (dd0acbe)
• README: extra information about regions (1310806)
• README: move tests section to bottom (c2b0bab)

1.0.0 (2022-11-02)

⚠ BREAKING CHANGES

• We now have a mature version of the sdk

Features

• remove beta disclaimer from readme (cb39ecd)

Documentation

• README: add packagist badges (3aea456)

0.4.1 (2022-11-02)

Documentation

• README: update installation instructions & introduce new tags on composer.json: (e8e6ad6)

0.4.0 (2022-11-02)

Features

• add integration info query parameter (e4a6c18)

0.3.0 (2022-11-01)

Features

• simplified configuration api (#40) (0ea6edd)
• update php version for public consts & simplify docs (#42) (18eb759)
• update schema to support url field for botd result (#32) (002542b)

Bug Fixes

• add force flag to rm command (#33) (b8d8b9d)
• api doc fixed for simpler use (#43) (dca0952)
• change prepareCmd command (#36) (ece2766)
• changed readme instructions & renamed organization name (334138c)
• posix error on releaserc (#38) (6a66999)
• updated list of ignored generated files (#37) (8fced34)

0.3.0-develop.7 (2022-11-01)

Bug Fixes

• api doc fixed for simpler use (#43) (dca0952)

0.3.0-develop.6 (2022-11-01)

Features

• update php version for public consts & simplify docs (#42) (18eb759)

0.3.0-develop.5 (2022-10-31)

Features

• simplified configuration api (#40) (0ea6edd)

0.3.0-develop.4 (2022-10-26)

Bug Fixes

• changed readme instructions & renamed organization name (334138c)

0.3.0-develop.3 (2022-10-25)

Bug Fixes

• posix error on releaserc (#38) (6a66999)
• updated list of ignored generated files (#37) (8fced34)

0.3.0-develop.2 (2022-10-25)

Bug Fixes

• change prepareCmd command (#36) (ece2766)

0.3.0-develop.1 (2022-10-25)

Features

• update schema to support url field for botd result (#32) (002542b)

Bug Fixes

• add force flag to rm command (#33) (b8d8b9d)