Skip to content
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

Jump to bottom

Fix naming for prerelease #137

Merged
merged 1 commit into from
Nov 15, 2024
Merged

Fix naming for prerelease #137

merged 1 commit into from
Nov 15, 2024

Conversation

ilfa
Copy link
Member

@ilfa ilfa commented Nov 15, 2024

Composer is not happy about a name like 6.0.0-dev.0.
Name like 6.0.0-rc.0 should be better.

@github-actions GitHub Actions
Copy link
Contributor

🚀 Following releases will be created using changesets from this PR:

[email protected]

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)

@github-actions GitHub Actions
Copy link
Contributor

🟢 Coverage increased by 8.10%

Code Coverage Report

Coverage Report

St. Category Percentage Covered / Total
🔴 Statements 8.10% 334 / 4125
🔴 Functions 6.39% 135 / 2112
Files Coverage
St. File Methods Statements Total Coverage
🔴 src/Api/FingerprintApi.php 0.00% 0.00% 0.00%
🔴 src/ApiException.php 0.00% 0.00% 0.00%
🔴 src/Configuration.php 0.00% 0.00% 0.00%
🔴 src/Model/Botd.php 41.94% 42.19% 42.11%
🔴 src/Model/BotdBot.php 26.32% 23.33% 24.49%
🔴 src/Model/BrowserDetails.php 37.93% 38.71% 38.46%
🔴 src/Model/ClonedApp.php 0.00% 0.00% 0.00%
🔴 src/Model/DeprecatedGeolocation.php 39.39% 54.55% 48.86%
🔴 src/Model/DeveloperTools.php 0.00% 0.00% 0.00%
🔴 src/Model/Emulator.php 0.00% 0.00% 0.00%
🔴 src/Model/Error.php 0.00% 0.00% 0.00%
🔴 src/Model/ErrorPlainResponse.php 0.00% 0.00% 0.00%
🔴 src/Model/ErrorResponse.php 0.00% 0.00% 0.00%
🔴 src/Model/EventsGetResponse.php 35.29% 26.92% 30.23%
🔴 src/Model/EventsUpdateRequest.php 0.00% 0.00% 0.00%
🔴 src/Model/FactoryReset.php 0.00% 0.00% 0.00%
🔴 src/Model/Frida.php 0.00% 0.00% 0.00%
🔴 src/Model/Geolocation.php 0.00% 0.00% 0.00%
🔴 src/Model/GeolocationCity.php 29.41% 23.08% 25.58%
🔴 src/Model/GeolocationContinent.php 31.58% 28.12% 29.41%
🔴 src/Model/GeolocationCountry.php 31.58% 28.12% 29.41%
🔴 src/Model/GeolocationSubdivision.php 0.00% 0.00% 0.00%
🔴 src/Model/GeolocationSubdivisions.php 7.14% 5.26% 6.06%
🔴 src/Model/HighActivity.php 0.00% 0.00% 0.00%
🔴 src/Model/IPBlocklist.php 0.00% 0.00% 0.00%
🔴 src/Model/IPBlocklistDetails.php 0.00% 0.00% 0.00%
🔴 src/Model/IPInfo.php 0.00% 0.00% 0.00%
🔴 src/Model/IPInfoASN.php 0.00% 0.00% 0.00%
🔴 src/Model/IPInfoDataCenter.php 0.00% 0.00% 0.00%
🔴 src/Model/IPInfoV4.php 0.00% 0.00% 0.00%
🔴 src/Model/IPInfoV6.php 0.00% 0.00% 0.00%
🔴 src/Model/Identification.php 46.81% 47.22% 47.10%
🔴 src/Model/IdentificationConfidence.php 23.81% 23.53% 23.64%
🔴 src/Model/IdentificationSeenAt.php 31.58% 28.12% 29.41%
🔴 src/Model/Incognito.php 0.00% 0.00% 0.00%
🔴 src/Model/Jailbroken.php 0.00% 0.00% 0.00%
🔴 src/Model/LocationSpoofing.php 0.00% 0.00% 0.00%
🔴 src/Model/PrivacySettings.php 0.00% 0.00% 0.00%
🔴 src/Model/ProductBotd.php 31.58% 29.63% 30.43%
🔴 src/Model/ProductClonedApp.php 0.00% 0.00% 0.00%
🔴 src/Model/ProductDeveloperTools.php 0.00% 0.00% 0.00%
🔴 src/Model/ProductEmulator.php 0.00% 0.00% 0.00%
🔴 src/Model/ProductFactoryReset.php 0.00% 0.00% 0.00%
🔴 src/Model/ProductFrida.php 0.00% 0.00% 0.00%
🔴 src/Model/ProductHighActivity.php 0.00% 0.00% 0.00%
🔴 src/Model/ProductIPBlocklist.php 0.00% 0.00% 0.00%
🔴 src/Model/ProductIPInfo.php 0.00% 0.00% 0.00%
🔴 src/Model/ProductIdentification.php 31.58% 29.63% 30.43%
🔴 src/Model/ProductIncognito.php 0.00% 0.00% 0.00%
🔴 src/Model/ProductJailbroken.php 0.00% 0.00% 0.00%
🔴 src/Model/ProductLocationSpoofing.php 0.00% 0.00% 0.00%
🔴 src/Model/ProductPrivacySettings.php 0.00% 0.00% 0.00%
🔴 src/Model/ProductProxy.php 0.00% 0.00% 0.00%
🔴 src/Model/ProductRawDeviceAttributes.php 0.00% 0.00% 0.00%
🔴 src/Model/ProductRemoteControl.php 0.00% 0.00% 0.00%
🔴 src/Model/ProductRootApps.php 0.00% 0.00% 0.00%
🔴 src/Model/ProductSuspectScore.php 0.00% 0.00% 0.00%
🔴 src/Model/ProductTampering.php 0.00% 0.00% 0.00%
🔴 src/Model/ProductTor.php 0.00% 0.00% 0.00%
🔴 src/Model/ProductVPN.php 0.00% 0.00% 0.00%
🔴 src/Model/ProductVelocity.php 0.00% 0.00% 0.00%
🔴 src/Model/ProductVirtualMachine.php 0.00% 0.00% 0.00%
🔴 src/Model/Products.php 12.70% 28.70% 23.03%
🔴 src/Model/Proxy.php 0.00% 0.00% 0.00%
🔴 src/Model/RelatedVisitor.php 0.00% 0.00% 0.00%
🔴 src/Model/RemoteControl.php 0.00% 0.00% 0.00%
🔴 src/Model/RootApps.php 0.00% 0.00% 0.00%
🔴 src/Model/SuspectScore.php 0.00% 0.00% 0.00%
🔴 src/Model/Tampering.php 0.00% 0.00% 0.00%
🔴 src/Model/Tor.php 0.00% 0.00% 0.00%
🔴 src/Model/VPN.php 0.00% 0.00% 0.00%
🔴 src/Model/VPNMethods.php 0.00% 0.00% 0.00%
🔴 src/Model/Velocity.php 0.00% 0.00% 0.00%
🔴 src/Model/VelocityData.php 0.00% 0.00% 0.00%
🔴 src/Model/VelocityIntervals.php 0.00% 0.00% 0.00%
🔴 src/Model/VirtualMachine.php 0.00% 0.00% 0.00%
🔴 src/Model/Visit.php 0.00% 0.00% 0.00%
🔴 src/Model/VisitorsGetResponse.php 0.00% 0.00% 0.00%
🔴 src/Model/Webhook.php 0.00% 0.00% 0.00%
🔴 src/Model/WebhookClonedApp.php 0.00% 0.00% 0.00%
🔴 src/Model/WebhookDeveloperTools.php 0.00% 0.00% 0.00%
🔴 src/Model/WebhookEmulator.php 0.00% 0.00% 0.00%
🔴 src/Model/WebhookFactoryReset.php 0.00% 0.00% 0.00%
🔴 src/Model/WebhookFrida.php 0.00% 0.00% 0.00%
🔴 src/Model/WebhookHighActivity.php 0.00% 0.00% 0.00%
🔴 src/Model/WebhookIPBlocklist.php 0.00% 0.00% 0.00%
🔴 src/Model/WebhookIPInfo.php 0.00% 0.00% 0.00%
🔴 src/Model/WebhookJailbroken.php 0.00% 0.00% 0.00%
🔴 src/Model/WebhookLocationSpoofing.php 0.00% 0.00% 0.00%
🔴 src/Model/WebhookPrivacySettings.php 0.00% 0.00% 0.00%
🔴 src/Model/WebhookProxy.php 0.00% 0.00% 0.00%
🔴 src/Model/WebhookRemoteControl.php 0.00% 0.00% 0.00%
🔴 src/Model/WebhookRootApps.php 0.00% 0.00% 0.00%
🔴 src/Model/WebhookSuspectScore.php 0.00% 0.00% 0.00%
🔴 src/Model/WebhookTampering.php 0.00% 0.00% 0.00%
🔴 src/Model/WebhookTor.php 0.00% 0.00% 0.00%
🔴 src/Model/WebhookVPN.php 0.00% 0.00% 0.00%
🔴 src/Model/WebhookVelocity.php 0.00% 0.00% 0.00%
🔴 src/Model/WebhookVirtualMachine.php 0.00% 0.00% 0.00%
🔴 src/ObjectSerializer.php 28.57% 38.68% 38.05%
🟢 src/Sealed/DecompressionException.php 100.00% 100.00% 100.00%
🔴 src/Sealed/DecryptionAlgorithm.php 0.00% 0.00% 0.00%
🟢 src/Sealed/DecryptionKey.php 100.00% 100.00% 100.00%
🟢 src/Sealed/InvalidSealedDataException.php 100.00% 100.00% 100.00%
🟢 src/Sealed/InvalidSealedDataHeaderException.php 100.00% 100.00% 100.00%
🟢 src/Sealed/Sealed.php 50.00% 94.44% 90.00%
🟢 src/Sealed/UnsealAggregateException.php 100.00% 100.00% 100.00%
🔴 src/Sealed/UnsealException.php 50.00% 28.57% 33.33%
🔴 src/SerializationException.php 0.00% 0.00% 0.00%
🟢 src/Webhook/WebhookVerifier.php 100.00% 100.00% 100.00%

@ilfa ilfa merged commit 148d7d0 into main Nov 15, 2024
11 checks passed
@ilfa ilfa deleted the fix/prerelease-tag branch November 15, 2024 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Orkuncakilkaya Orkuncakilkaya Orkuncakilkaya approved these changes

@TheUnderScorer TheUnderScorer Awaiting requested review from TheUnderScorer TheUnderScorer is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ilfa @Orkuncakilkaya