Add migration guide

braintree · Oct 9, 2023 · b42422b · b42422b
1 parent e69e5db
commit b42422b
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,7 +7,7 @@
     * Remove `union-pay` module
       * UnionPay cards can now be processed as regular cards (through the `card` module) due to their partnership with Discover
   * BraintreeDataCollector
-    * Remove module (use PayPalDataCollector)
+    * Remove `data-collector` module (use `paypal-data-collector`) 
   * PayPalDataCollector
     * Rename `PayPalDataCollector` to `DataCollector` 
     * Rename `PayPalDataCollectorRequest` to `DataCollectorRequest`

diff --git a/v5_MIGRATION_GUIDE.md b/v5_MIGRATION_GUIDE.md
@@ -5,12 +5,30 @@ See the [CHANGELOG](/CHANGELOG.md) for a complete list of changes. This migratio
 ## Table of Contents
 
 1. [Android API](#android-api)
+1. [Data Collector](#data-collector)
 1. [Union Pay](#union-pay)
 
 ## Android API
 
 The minimum supported Android API level for v5 of this SDK has increased to 23.
-
+
+## Data Collector
+
+The `data-collector` module has been removed and replaced by the `paypal-data-collector` module. 
+The `DataCollector` class within the `paypal-data-collector` module has the same 
+`collectDeviceData` methods, so if you were previously using the `data-collector` library, no code 
+changes are required aside from updating your dependency.
+
+If you were using the `paypal-data-collector` library in v4, the `PayPal` prefix has been 
+removed from all class names in v5.
+
+```kotlin
+val dataCollector = DataCollector(braintreeClient)
+dataCollector.collectDeviceData(context) { deviceData, error -> 
+    // send deviceData to your server
+}
+```
+
 ## Union Pay
 
 The `union-pay` module, and all containing classes, was removed in v5. UnionPay cards can now be processed as regular cards, through the `card` module. You no longer need to manage card enrollment via SMS authorization.