From 1e8b66111be98ca062afa8d7dce47090511123b2 Mon Sep 17 00:00:00 2001
From: Davide Vacca <davide.vacca@onfido.com>
Date: Wed, 23 Oct 2024 15:17:54 +0200
Subject: [PATCH] Add Migration guide

---
 MIGRATION.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 MIGRATION.md

diff --git a/MIGRATION.md b/MIGRATION.md
new file mode 100644
index 0000000..cad9050
--- /dev/null
+++ b/MIGRATION.md
@@ -0,0 +1,30 @@
+# Migration Guide
+
+## Upgrading from 3.x to 4.0
+
+### Core Resources
+
+- Applicants
+  - Replace broken `ConsentsBuilder` object with a list of `ApplicantConsentBuilder` ones
+- Workflow Runs
+  - Rename `WorkflowRunSharedLink` object into `WorkflowRunLink`
+  - Define `WorkflowRunStatus` enum for storing status information
+  - Rename `WorkflowRunResponseError` object into `WorkflowRunError`
+- Documents
+  - Reuse already existent `DocumentTypes` enum when uploading documents
+
+### Other Endpoints
+
+- Webhooks
+  - Define `WebhookEventObjectStatus` enum to collect webhook event object's status
+  - Define `WebhookEventResourceType` enum to collect webhhok event resource's type
+  - Define `WebhookEventPayloadResource` object to store webhook payload's contents
+- Checks
+  - Define `CheckStatus` enum for accessing checks status
+- Reports
+  - Remove properties from `DeviceIntelligenceBreakdownPropertiesDevice` object: `true_os`, `os_anomaly`, `rooted` and `remote_software`
+  - Remove properties from `DeviceIntelligenceBreakdownPropertiesIp` object: `vpn_detection`, `proxy_detection` and `type`
+
+### OpenAPI generator
+
+- Version upgraded from 7.6.0 to 7.9.0