Convert CustomizableShippingField to enum

MIGRATING.md

@@ -133,6 +133,10 @@
             }
         }
         ```
+- Changes to `ShippingInfoWidget`
+    - `setOptionalFields()` is now `optionalFields`
+    - `setHiddenFields()` is now `hiddenFields`
+    - `CustomizableShippingField` is now an enum
 - Changes to `Source`
     - `Source.SourceFlow` has been renamed to `Source.Flow` and is now an enum
     - `Source.SourceStatus` has been renamed to `Source.Status` and is now an enum

example/src/main/java/com/stripe/example/activity/FragmentExamplesFragment.kt

@@ -51,8 +51,8 @@ class FragmentExamplesFragment : Fragment() {
             config = PaymentSessionConfig.Builder()
                 .setShippingMethodsRequired(false)
                 .setHiddenShippingInfoFields(
-                    ShippingInfoWidget.CustomizableShippingField.PHONE_FIELD,
-                    ShippingInfoWidget.CustomizableShippingField.CITY_FIELD
+                    ShippingInfoWidget.CustomizableShippingField.Phone,
+                    ShippingInfoWidget.CustomizableShippingField.City
                 )
                 .build()
         )

stripe/src/main/java/com/stripe/android/PaymentSessionConfig.kt

@@ -1,6 +1,5 @@
 package com.stripe.android
 
-import android.annotation.SuppressLint
 import android.os.Parcelable
 import androidx.annotation.LayoutRes
 import androidx.annotation.WorkerThread
@@ -24,8 +23,8 @@ import kotlinx.android.parcel.Parcelize
  */
 @Parcelize
 data class PaymentSessionConfig internal constructor(
-    val hiddenShippingInfoFields: List<String> = emptyList(),
-    val optionalShippingInfoFields: List<String> = emptyList(),
+    val hiddenShippingInfoFields: List<CustomizableShippingField> = emptyList(),
+    val optionalShippingInfoFields: List<CustomizableShippingField> = emptyList(),
     val prepopulatedShippingInfo: ShippingInformation? = null,
     val isShippingInfoRequired: Boolean = false,
     val isShippingMethodRequired: Boolean = false,
@@ -93,8 +92,8 @@ data class PaymentSessionConfig internal constructor(
         private var billingAddressFields: BillingAddressFields = DEFAULT_BILLING_ADDRESS_FIELDS
         private var shippingInfoRequired = true
         private var shippingMethodsRequired = true
-        private var hiddenShippingInfoFields: List<String>? = null
-        private var optionalShippingInfoFields: List<String>? = null
+        private var hiddenShippingInfoFields: List<CustomizableShippingField>? = null
+        private var optionalShippingInfoFields: List<CustomizableShippingField>? = null
         private var shippingInformation: ShippingInformation? = null
         private var paymentMethodTypes: List<PaymentMethod.Type> = listOf(PaymentMethod.Type.Card)
         private var shouldShowGooglePay: Boolean = false
@@ -122,9 +121,8 @@ data class PaymentSessionConfig internal constructor(
          * hidden in the shipping information screen. All fields will be shown if this list is
          * empty. Note that not all fields can be hidden, such as country or name.
          */
-        @SuppressLint("WrongConstant")
         fun setHiddenShippingInfoFields(
-            @CustomizableShippingField vararg hiddenShippingInfoFields: String
+            vararg hiddenShippingInfoFields: CustomizableShippingField
         ): Builder = apply {
             this.hiddenShippingInfoFields = listOf(*hiddenShippingInfoFields)
         }
@@ -133,9 +131,8 @@ data class PaymentSessionConfig internal constructor(
          * @param optionalShippingInfoFields [CustomizableShippingField] fields that should be
          * optional in the [ShippingInfoWidget]
          */
-        @SuppressLint("WrongConstant")
         fun setOptionalShippingInfoFields(
-            @CustomizableShippingField vararg optionalShippingInfoFields: String
+            vararg optionalShippingInfoFields: CustomizableShippingField
         ): Builder = apply {
             this.optionalShippingInfoFields = listOf(*optionalShippingInfoFields)
         }

stripe/src/main/java/com/stripe/android/view/PaymentFlowPagerAdapter.kt

@@ -123,10 +123,8 @@ internal class PaymentFlowPagerAdapter(
                 shippingInformation: ShippingInformation?,
                 allowedShippingCountryCodes: Set<String>
             ) {
-                shippingInfoWidget
-                    .setHiddenFields(paymentSessionConfig.hiddenShippingInfoFields)
-                shippingInfoWidget
-                    .setOptionalFields(paymentSessionConfig.optionalShippingInfoFields)
+                shippingInfoWidget.hiddenFields = paymentSessionConfig.hiddenShippingInfoFields
+                shippingInfoWidget.optionalFields = paymentSessionConfig.optionalShippingInfoFields
                 shippingInfoWidget
                     .setAllowedCountryCodes(allowedShippingCountryCodes)
                 shippingInfoWidget

stripe/src/main/java/com/stripe/android/view/PostalCodeValidator.kt

@@ -11,8 +11,8 @@ internal class PostalCodeValidator {
     fun isValid(
         postalCode: String,
         countryCode: String?,
-        optionalShippingInfoFields: List<String>,
-        hiddenShippingInfoFields: List<String>
+        optionalShippingInfoFields: List<ShippingInfoWidget.CustomizableShippingField>,
+        hiddenShippingInfoFields: List<ShippingInfoWidget.CustomizableShippingField>
     ): Boolean {
         if (countryCode == null) {
             return false
@@ -42,13 +42,13 @@ internal class PostalCodeValidator {
         )
 
         private fun isPostalCodeNotRequired(
-            optionalShippingInfoFields: List<String>,
-            hiddenShippingInfoFields: List<String>
+            optionalShippingInfoFields: List<ShippingInfoWidget.CustomizableShippingField>,
+            hiddenShippingInfoFields: List<ShippingInfoWidget.CustomizableShippingField>
         ): Boolean {
             return optionalShippingInfoFields.contains(
-                ShippingInfoWidget.CustomizableShippingField.POSTAL_CODE_FIELD
+                ShippingInfoWidget.CustomizableShippingField.PostalCode
             ) || hiddenShippingInfoFields.contains(
-                ShippingInfoWidget.CustomizableShippingField.POSTAL_CODE_FIELD
+                ShippingInfoWidget.CustomizableShippingField.PostalCode
             )
         }
     }