Shopper insights rp2 feature presentment details

BraintreeCore/src/main/java/com/braintreepayments/api/core/AnalyticsEventParams.kt

@@ -28,5 +28,8 @@ data class AnalyticsEventParams @JvmOverloads constructor(
     var endpoint: String? = null,
     val experiment: String? = null,
     val paymentMethodsDisplayed: List<String> = emptyList(),
-    val appSwitchUrl: String? = null
+    val appSwitchUrl: String? = null,
+    val buttonType: String? = null,
+    val buttonOrder: String? = null,
+    val pageType: String? = null
 )

Demo/src/main/java/com/braintreepayments/demo/ShopperInsightsFragment.kt

@@ -18,6 +18,11 @@ import com.braintreepayments.api.paypal.PayPalPaymentAuthRequest
 import com.braintreepayments.api.paypal.PayPalPaymentAuthResult
 import com.braintreepayments.api.paypal.PayPalPendingRequest
 import com.braintreepayments.api.paypal.PayPalResult
+import com.braintreepayments.api.shopperinsights.ButtonOrder
+import com.braintreepayments.api.shopperinsights.ButtonType
+import com.braintreepayments.api.shopperinsights.ExperimentType
+import com.braintreepayments.api.shopperinsights.PageType
+import com.braintreepayments.api.shopperinsights.PresentmentDetails
 import com.braintreepayments.api.shopperinsights.ShopperInsightsBuyerPhone
 import com.braintreepayments.api.shopperinsights.ShopperInsightsClient
 import com.braintreepayments.api.shopperinsights.ShopperInsightsRequest
@@ -191,18 +196,28 @@ class ShopperInsightsFragment : BaseFragment() {
                 is ShopperInsightsResult.Success -> {
                     if (result.response.isPayPalRecommended) {
                         payPalVaultButton.isEnabled = true
-                        shopperInsightsClient.sendPayPalPresentedEvent(
-                            """{"exp_name":"PaymentReady","treatment_name":"control"}""",
-                            listOf("PayPal", "Venmo", "other")
+                        shopperInsightsClient.sendPresentedEvent(
+                            PresentmentDetails("PaymentReady", ExperimentType.CONTROL),
+                            listOf("PayPal", "Venmo", "other"),
+                            ButtonType.PAYPAL,
+                            ButtonOrder.OTHER,
+                            PageType.HOMEPAGE
                         )
+
+                        //"""{"exp_name":"PaymentReady","treatment_name":"control"}""",
                     }
 
                     if (result.response.isVenmoRecommended) {
                         venmoButton.isEnabled = true
-                        shopperInsightsClient.sendVenmoPresentedEvent(
-                            """{"exp_name":"PaymentReady","treatment_name":"test"}""",
-                            listOf("Venmo", "PayPal", "other")
+                        shopperInsightsClient.sendPresentedEvent(
+                            PresentmentDetails("PaymentReady", ExperimentType.TEST),
+                            listOf("Venmo", "PayPal", "other"),
+                            ButtonType.VENMO,
+                            ButtonOrder.OTHER,
+                            PageType.HOMEPAGE
                         )
+
+                        //"""{"exp_name":"PaymentReady","treatment_name":"test"}""",
                     }
 
                     responseTextView.text =

ShopperInsights/src/main/java/com/braintreepayments/api/shopperinsights/ButtonOrder.kt

@@ -0,0 +1,52 @@
+package com.braintreepayments.api.shopperinsights
+
+/**
+ * The order or ranking in which payment buttons appear.
+ */
+enum class ButtonOrder {
+
+    /**
+     * First place
+     */
+    FIRST,
+
+    /**
+     * Second place
+     */
+    SECOND,
+
+    /**
+     * Third place
+     */
+    THIRD,
+
+    /**
+     * Fourth place
+     */
+    FOURTH,
+
+    /**
+     * Fifth place
+     */
+    FIFTH,
+
+    /**
+     * Sixth place
+     */
+    SIXTH,
+
+    /**
+     * Seventh place
+     */
+    SEVENTH,
+
+    /**
+     * Eighth place
+     */
+    Eights,
+
+    /**
+     * Greater than Eighth place
+     */
+    OTHER
+}

ShopperInsights/src/main/java/com/braintreepayments/api/shopperinsights/ButtonType.kt

@@ -0,0 +1,21 @@
+package com.braintreepayments.api.shopperinsights
+
+/**
+The button type to be displayed or presented.
+ */
+enum class ButtonType(internal val stringValue: String) {
+    /**
+     * PayPal button
+     */
+    PAYPAL("paypal"),
+
+    /**
+     * Venmo button
+     */
+    VENMO("venmo"),
+
+    /**
+     * Other button
+     */
+    OTHER("other"),
+}

ShopperInsights/src/main/java/com/braintreepayments/api/shopperinsights/ExperimentType.kt

@@ -0,0 +1,6 @@
+package com.braintreepayments.api.shopperinsights
+
+enum class ExperimentType {
+    CONTROL,
+    TEST
+}

ShopperInsights/src/main/java/com/braintreepayments/api/shopperinsights/PageType.kt

@@ -0,0 +1,61 @@
+package com.braintreepayments.api.shopperinsights
+
+/**
+ * The page or view that a button is displayed on.
+ */
+enum class PageType {
+    /**
+     * The homepage
+     */
+    HOMEPAGE,
+
+    /**
+     * The about page
+     */
+    ABOUT,
+
+    /**
+     * The contact page
+     */
+    CONTACT,
+
+    /**
+     * A product category page
+     */
+    PRODUCT_CATEGORY,
+
+    /**
+     * The product details page
+     */
+    PRODUCT_DETAILS,
+
+    /**
+     * The search page
+     */
+    SEARCH,
+
+    /**
+     * The checkout page
+     */
+    CHECKOUT,
+
+    /**
+     * The order review page
+     */
+    ORDER_REVIEW,
+
+    /**
+     * The order confirmation page
+     */
+    ORDER_CONFIRMATION,
+
+    /**
+     * The mini cart
+     */
+    MINI_CART,
+
+    /**
+     * Some other page
+     */
+    OTHER
+}

ShopperInsights/src/main/java/com/braintreepayments/api/shopperinsights/PresentmentDetails.kt

@@ -0,0 +1,13 @@
+package com.braintreepayments.api.shopperinsights
+
+
+/**
+ * Initializes a new PresentmentDetails instance
+ *
+ * @param treatmentName The experiment or treatment name
+ * @param type An ExperimentType that is either a control or test type
+ */
+data class PresentmentDetails (
+    val treatmentName: String,
+    val type: ExperimentType
+)

ShopperInsights/src/main/java/com/braintreepayments/api/shopperinsights/ShopperInsightsClient.kt

@@ -13,7 +13,6 @@ import com.braintreepayments.api.shopperinsights.ShopperInsightsAnalytics.GET_RE
 import com.braintreepayments.api.shopperinsights.ShopperInsightsAnalytics.GET_RECOMMENDED_PAYMENTS_SUCCEEDED
 import com.braintreepayments.api.shopperinsights.ShopperInsightsAnalytics.PAYPAL_PRESENTED
 import com.braintreepayments.api.shopperinsights.ShopperInsightsAnalytics.PAYPAL_SELECTED
-import com.braintreepayments.api.shopperinsights.ShopperInsightsAnalytics.VENMO_PRESENTED
 import com.braintreepayments.api.shopperinsights.ShopperInsightsAnalytics.VENMO_SELECTED
 
 /**
@@ -161,20 +160,28 @@ class ShopperInsightsClient internal constructor(
     /**
      * Call this method when the PayPal button has been successfully displayed to the buyer.
      * This method sends analytics to help improve the Shopper Insights feature experience.
-     *
-     * @param experiment optional JSON string representing an experiment you want to run
+     * @param presentmentDetails optional JSON string representing an experiment you want to run.
      * @param paymentMethodsDisplayed optional The list of available payment methods,
      * rendered in the same order in which they are displayed
+     * @param buttonType optional Represents the tapped button type.
+     * @param buttonOrder optional Represents this buttons order in context of other buttons.
+     * @param pageType optional Represents the page or view the button is rendered on.
      */
-    fun sendPayPalPresentedEvent(
-        experiment: String? = null,
-        paymentMethodsDisplayed: List<String> = emptyList()
+    fun sendPresentedEvent(
+        presentmentDetails: PresentmentDetails,
+        paymentMethodsDisplayed: List<String> = emptyList(),
+        buttonType: ButtonType,
+        buttonOrder: ButtonOrder,
+        pageType: PageType
     ) {
         braintreeClient.sendAnalyticsEvent(
             PAYPAL_PRESENTED,
             AnalyticsEventParams(
-                experiment = experiment,
-                paymentMethodsDisplayed = paymentMethodsDisplayed
+                experiment = presentmentDetails.toString(),
+                paymentMethodsDisplayed = paymentMethodsDisplayed,
+                buttonType = buttonType.toString(),
+                buttonOrder = buttonOrder.toString(),
+                pageType = pageType.toString()
             )
         )
     }
@@ -187,27 +194,6 @@ class ShopperInsightsClient internal constructor(
         braintreeClient.sendAnalyticsEvent(PAYPAL_SELECTED)
     }
 
-    /**
-     * Call this method when the Venmo button has been successfully displayed to the buyer.
-     * This method sends analytics to help improve the Shopper Insights feature experience.
-     *
-     * @param experiment optional JSON string representing an experiment you want to run
-     * @param paymentMethodsDisplayed optional The list of available payment methods,
-     * rendered in the same order in which they are displayed
-     */
-    fun sendVenmoPresentedEvent(
-        experiment: String? = null,
-        paymentMethodsDisplayed: List<String> = emptyList()
-    ) {
-        braintreeClient.sendAnalyticsEvent(
-            VENMO_PRESENTED,
-            AnalyticsEventParams(
-                experiment = experiment,
-                paymentMethodsDisplayed = paymentMethodsDisplayed
-            )
-        )
-    }
-
     /**
      * Call this method when the Venmo button has been selected/tapped by the buyer.
      * This method sends analytics to help improve the Shopper Insights feature experience.