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

OpenAPI schema sync #83

Merged
merged 9 commits into from
Nov 14, 2024
Merged

OpenAPI schema sync #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a09ca88
feat: update OpenAPI schema
ilfa Oct 25, 2024
cc5627b
fix: fix type used in `Sealed`
ilfa Oct 25, 2024
fd779d9
test: fix types and mocks paths for tests after schema update
ilfa Oct 25, 2024
dd1b2d8
feat: add .env support for the examples
ilfa Oct 25, 2024
b1197fe
chore: remove only schema related updates from the changelog
ilfa Oct 25, 2024
804979f
chore: remove legacy test mocks
ilfa Oct 25, 2024
64a242e
docs: fix examples in the documentation
ilfa Oct 28, 2024
e505975
chore: update schema, remove unused model `RelatedVisitors`
ilfa Oct 28, 2024
388f950
docs: replace old models `EventResponse` and `Response` with `EventsG…
ilfa Oct 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 5 additions & 0 deletions .changeset/fuzzy-apes-talk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'fingerprint-pro-server-api-java-sdk': minor
---

Added new `ipEvents`, `distinctIpByLinkedId`, and `distinctVisitorIdByLinkedId` fields to the `velocity` Smart Signal.
15 changes: 15 additions & 0 deletions .changeset/khaki-results-help.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
'fingerprint-pro-server-api-java-sdk': minor
---

- 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`.
33 changes: 33 additions & 0 deletions .changeset/large-lights-push.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
'fingerprint-pro-server-api-java-sdk': major
---

- 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`.
65 changes: 65 additions & 0 deletions .changeset/quiet-parrots-stick.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
'fingerprint-pro-server-api-java-sdk': major
---

- 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`.
8 changes: 8 additions & 0 deletions .changeset/short-icons-wish.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
'fingerprint-pro-server-api-java-sdk': patch
---

- Fix descriptions formatting:
- Remove extra line breaks.
- Fix block styles.
- Fix links in descriptions.
7 changes: 7 additions & 0 deletions .changeset/tender-bottles-kneel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
'fingerprint-pro-server-api-java-sdk': patch
---

- Replace GET /events TooManyRequests examples with a single `get_event_200_too_many_requests_error.json`.
- Update `products.identification.error.message` in `get_event_200_<...>.json` examples.
- Rename GET /visitors example files.
5 changes: 5 additions & 0 deletions .changeset/three-files-kneel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'fingerprint-pro-server-api-java-sdk': minor
---

**events**: Add `antiDetectBrowser` detection method to the `tampering` Smart Signal.
2 changes: 1 addition & 1 deletion .schema-version
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v1.2.0
v2.0.0
Loading
Loading