PR feedback to clarify phone number to not contain special chars; add…

… note that beta API could be removed
braintree · Dec 4, 2023 · 5973db0 · 5973db0
1 parent e00be07
commit 5973db0
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 5 deletions.
diff --git a/Sources/BraintreeCore/BTShopperInsightsClient.swift b/Sources/BraintreeCore/BTShopperInsightsClient.swift
@@ -2,7 +2,7 @@ import Foundation
 
 ///  Use `BTShopperInsightsClient` to optimize your checkout experience by prioritizing the customer’s preferred payment methods in your UI.
 ///  By customizing each customer’s checkout experience, you can improve conversion, increase sales/repeat buys and boost user retention/loyalty.
-///  - Note: This feature is in beta. It's public API may change in future releases.
+/// - Note: This feature is in beta. It's public API may change or be removed in future releases.
 @objcMembers class BTShopperInsightsClient: NSObject {
 
     private let apiClient: BTAPIClient
@@ -18,7 +18,7 @@ import Foundation
     /// - Parameters:
     ///   - request: A `BTShopperInsightsRequest` containing the buyer's user information
     /// - Returns: A `BTShopperInsightsResult` instance
-    /// - Note: This feature is in beta. It's public API may change in future releases.
+    /// - Note: This feature is in beta. It's public API may change or be removed in future releases.
     public func getRecommendedPaymentMethods(request: BTShopperInsightsRequest) async throws -> BTShopperInsightsResult {
         // TODO: - Add isAppInstalled checks for PP & Venmo. DTBTSDK-3176
         // TODO: - Make API call to PaymentReadyAPI. DTBTSDK-3176

diff --git a/Sources/BraintreeCore/BTShopperInsightsRequest.swift b/Sources/BraintreeCore/BTShopperInsightsRequest.swift
@@ -1,23 +1,25 @@
 import Foundation
 
 /// Buyer data required to use the Shopper Insights feature.
-/// - Note: This feature is in beta. It's public API may change in future releases.
+/// - Note: This feature is in beta. It's public API may change or be removed in future releases.
 @objcMembers public class BTShopperInsightsRequest: NSObject {
 
     /// The buyer's email address.
     public let email: String
 
     /// The buyer's country code prefix to the national telephone number. An identifier for a specific country.
+    /// Must not contain special characters.
     public let phoneCountryCode: String
 
-    /// The buyer's national phone number.
+    /// The buyer's national phone number. Must not contain special characters.
     public let phoneNationalNumber: String
 
     /// Initialize a `BTShopperInsightsRequest`
     /// - Parameters:
     ///   - email: The buyer's email address.
     ///   - phoneCountryCode: The buyer's country code prefix to the national telephone number. An identifier for a specific country.
     ///   - phoneNationalNumber: The buyer's national phone number.
+    /// - Note: This feature is in beta. It's public API may change or be removed in future releases.
     init(email: String, phoneCountryCode: String, phoneNationalNumber: String) {
         self.email = email
         self.phoneCountryCode = phoneCountryCode

diff --git a/Sources/BraintreeCore/BTShopperInsightsResult.swift b/Sources/BraintreeCore/BTShopperInsightsResult.swift
@@ -1,7 +1,7 @@
 import Foundation
 
 /// A summary of the buyer's recommended payment methods.
-/// - Note: This feature is in beta. It's public API may change in future releases.
+/// - Note: This feature is in beta. It's public API may change or be removed in future releases.
 @objcMembers public class BTShopperInsightsResult: NSObject {
 
     /// If true, display the PayPal button with high priority.