v7.0.0-develop.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. (a09ca88)
• • 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.
  • Rename RawDeviceAttributesResult -> RawDeviceAttributes:
    • Extract item type as RawDeviceAttribute.
    • Extract error type as RawDeviceAttributeError.
  • Rename RemoteControlResult -> RemoteControl.
  • Rename RootAppsResult -> RootApps.
  • Rename SuspectScoreResult -> SuspectScore.
  • Extract new model Tag.
  • 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, WebhookRawDeviceAttributes, WebhookHighActivity, WebhookLocationSpoofing, WebhookSuspectScore, WebhookRemoteControl, WebhookVelocity, WebhookDeveloperTools. (a09ca88)

Minor Changes

• Added new ipEvents, distinctIpByLinkedId, and distinctVisitorIdByLinkedId fields to the velocity Smart Signal. (a09ca88)
• • 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. (a09ca88)
• Remove ipv4 format from ip field in Botd, Identification, Visit and Webhook models. (d608cfe)
• events: Add antiDetectBrowser detection method to the tampering Smart Signal. (a09ca88)

Patch Changes

• • Fix descriptions formatting:
    • Remove extra line breaks.
      ...

v6.2.0

Minor Changes

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

v6.2.0-develop.0

Minor Changes

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

v6.1.0

6.1.0 (2024-09-11)

Features

• don't use jackson-databind-nullable to fix serialization problems with Jackson default configuration (979b800)

v6.1.0-develop.1

6.1.0-develop.1 (2024-09-10)

Features

• don't use jackson-databind-nullable to fix serialization problems with Jackson default configuration (979b800)

v6.0.2

6.0.2 (2024-09-09)

Bug Fixes

• for Sealed use same ObjectMapper as for FingerprintApi (7343655)

v6.0.1

6.0.1 (2024-08-20)

Bug Fixes

• fix supported Java versions in the readme (f889f03)

v6.0.1-develop.1

6.0.1-develop.1 (2024-08-20)

Bug Fixes

• fix supported Java versions in the readme (f889f03)

v6.0.0

6.0.0 (2024-08-08)

⚠ BREAKING CHANGES

• use Jakarta EE 9
• use java 11 as minimal supported version

Features

• add Confidence Score v1.1
• add remoteControl, velocity and developerTools signals (5648a7f)
• add Webhook.IsValidWebhookSignature function for validating webhook signature (033a98f)
• add PUT API for Events (db4832f)
• add DELETE API for Visitors (7557b24)

Continuous Integration

• update jakarta annotation api to 2.0.0 (ac41c7a)
• use java 11 for release build (b9e9a00)

v6.0.0-develop.1

6.0.0-develop.1 (2024-08-07)

⚠ BREAKING CHANGES

• use Jakarta EE 9
• use Java 11 as minimal supported version

Features

• add remoteControl, velocity and developerTools signals (f46e242)
• add Webhook.IsValidWebhookSignature function for validating webhook signature (0922380)
• add DELETE API (0b8d7b5)
• Build scripts are rewritten to Kotlin (6f25c8d)

Miscellaneous Chores

• update Jakarta Annotation API to 2.0.0 (5c30ce2)