[QL] PP App Switch - cleanup docstrings for release (#1334)

braintree · Jun 12, 2024 · ec3488a · ec3488a
1 parent e18408b
commit ec3488a
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,12 +2,11 @@
 
 ## unreleased
 * BraintreePayPal
-  * Add `BTPayPalVaultRequest(userAuthenticationEmail:enablePayPalAppSwitch:offerCredit:)`
-    * This init should be used for the PayPal App Switch flow
-  * Add `BTPayPalClient(apiClient:universalLink:)`
-    * This init should be used for the PayPal App Switch flow
-  * Send `link_type` and `paypal_installed` in `event_params` when available to PayPal's analytics service (FPTI)
-  * **Note:** This feature is currently in beta and may change or be removed in future releases.
+  * Add PayPal App Switch vault flow (BETA)
+    * Add `BTPayPalVaultRequest(userAuthenticationEmail:enablePayPalAppSwitch:offerCredit:)`
+    * Add `BTPayPalClient(apiClient:universalLink:)`
+    * Send `link_type` and `paypal_installed` in `event_params` when available to PayPal's analytics service (FPTI)
+    * **Note:** This feature is currently in beta and may change or be removed in future releases.
 
 ## 6.20.0 (2024-06-06)
 * Re-use existing URLSession instance for `v1/configuration` and subsequent BT GW API calls

diff --git a/Sources/BraintreePayPal/BTPayPalClient.swift b/Sources/BraintreePayPal/BTPayPalClient.swift
@@ -87,7 +87,7 @@ import BraintreeDataCollector
     /// Initialize a new PayPal client instance for the PayPal App Switch flow.
     /// - Parameters:
     ///   - apiClient: The API Client
-    ///   - universalLink: The URL to use for the PayPal app switch flow. Must be a valid HTTPS URL dedicated to Braintree app switch returns.
+    ///   - universalLink: The URL to use for the PayPal app switch flow. Must be a valid HTTPS URL dedicated to Braintree app switch returns. This URL must be allow-listed in your Braintree Control Panel.
     /// - Warning: This initializer should be used for merchants using the PayPal App Switch flow. This feature is currently in beta and may change or be removed in future releases.
     @objc(initWithAPIClient:universalLink:)
     public convenience init(apiClient: BTAPIClient, universalLink: URL) {

diff --git a/Sources/BraintreePayPal/BTPayPalVaultRequest.swift b/Sources/BraintreePayPal/BTPayPalVaultRequest.swift
@@ -27,6 +27,7 @@ import BraintreeCore
     ///   - enablePayPalAppSwitch: Required: Used to determine if the customer will use the PayPal app switch flow.
     ///   - offerCredit: Optional: Offers PayPal Credit if the customer qualifies. Defaults to `false`.
     /// - Warning: This initializer should be used for merchants using the PayPal App Switch flow. This feature is currently in beta and may change or be removed in future releases.
+    /// - Note: The PayPal App Switch flow currently only supports the production environment.
     public convenience init(
         userAuthenticationEmail: String,
         enablePayPalAppSwitch: Bool,