@@ -6,6 +6,53 @@ major versions of the client library.
66It covers changes in core resources, other endpoints, and the OpenAPI generator,
77ensuring a smooth transition between versions.
88
9+ ## Upgrading from 6.x to 7.x
10+
11+ ### Core Resources
12+
13+ - ** All API methods** : All API method calls now use request builder pattern with ` .execute() `
14+ - This change enables backward compatibility when new optional parameters are added
15+ - Example migration:
16+ ``` java
17+ // Before (v6.x)
18+ List<WorkflowRun > runs = api. listWorkflowRuns(applicantId, status, page, perPage);
19+
20+ // After (v7.x)
21+ List<WorkflowRun > runs = api. listWorkflowRuns()
22+ .applicantId(applicantId)
23+ .status(status)
24+ .page(page)
25+ .perPage(perPage)
26+ .execute();
27+ ```
28+ - Documents
29+ - Driving licence information properties removed from general `DocumentProperties `
30+ and moved to new `DocumentPropertiesWithDrivingLicenceInformation` class
31+ - Workflow Runs
32+ - `createdAtGt` and `createdAtLt` parameters in `listWorkflowRuns` changed from
33+ date-time format to date format (YYYY - MM - DD )
34+
35+ ### Other Endpoints
36+
37+ - Reports
38+ - Device Intelligence : Removed deprecated `breakdown` property and related
39+ breakdown classes:
40+ - `DeviceIntelligenceBreakdownProperties ` removed
41+ - `DeviceIntelligenceBreakdownPropertiesDevice ` → `DeviceIntelligencePropertiesDevice `
42+ - `DeviceIntelligenceBreakdownPropertiesGeolocation ` → `DeviceIntelligencePropertiesGeolocation `
43+ - `DeviceIntelligenceBreakdownPropertiesIp ` → `DeviceIntelligencePropertiesIp `
44+ - Identity Enhanced : Changed `totalNumberOfSources` and `numberOfMatches` from
45+ number to string type
46+
47+ ### Security
48+
49+ - SSL certificate validation: Removed support for self- signed certificates unless
50+ explicitly configured via `setSslCaCert()`
51+
52+ ### OpenAPI generator
53+
54+ - Version upgraded from `7.11 . 0 ` to `7.16 . 0 `
55+
956## Upgrading from 5. x to 6. x
1057
1158### Core Resources
0 commit comments