Renames LinkAccountSession to FinancialConnectionsSession. (#4910)

* Renames LinkAccountSession to FinancialConnectionsSession. * Renames endpoints (WIP) * Style fixes. * Revert endpoint changes. * Updates missing session and account occurrences. * Updates example. * Updates example. * Updates payments api. * Updates changelog. * Adds missing renames. * Removes double financial occurrences. * Api updates.
stripe · Apr 28, 2022 · a3a2796 · a3a2796
1 parent 8b93a5e
commit a3a2796
Show file tree

Hide file tree

Showing 64 changed files with 941 additions and 944 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # CHANGELOG
 ## x.x.x - xxxx-xx-xx
+
+### Payments
+
+* [CHANGED] [4910](https://github.com/stripe/stripe-android/pull/4910) Some changes affecting CollectBankAccountLauncher (ACH)
+  * `CollectBankAccountResponse#LinkAccountSession` to `FinancialConnectionsSession`
+  * `LinkedAccount` to `FinancialConnectionsAccount`.
+
 ### PaymentSheet
 * [FIXED] [4909](https://github.com/stripe/stripe-android/pull/4909) In the multi-step flow when re-opening to a new card the form will pre-populate.  Also the default billing address will pre-populate in the form.
 

diff --git a/...va/com/stripe/android/financialconnections/example/FinancialConnectionsExampleActivity.kt b/...va/com/stripe/android/financialconnections/example/FinancialConnectionsExampleActivity.kt
@@ -33,7 +33,7 @@ class FinancialConnectionsExampleActivity : AppCompatActivity() {
     }
 
     private fun ActivityFinancialconnectionsExampleBinding.observeViews() {
-        launchConnectionsSheet.setOnClickListener { viewModel.startLinkAccountSession() }
+        launchConnectionsSheet.setOnClickListener { viewModel.startFinancialConnectionsSession() }
     }
 
     private fun ActivityFinancialconnectionsExampleBinding.observeState() {

diff --git a/...a/com/stripe/android/financialconnections/example/FinancialConnectionsExampleViewModel.kt b/...a/com/stripe/android/financialconnections/example/FinancialConnectionsExampleViewModel.kt
@@ -25,21 +25,21 @@ class FinancialConnectionsExampleViewModel : ViewModel() {
     private val _viewEffect = MutableSharedFlow<FinancialConnectionsExampleViewEffect>()
     val viewEffect: SharedFlow<FinancialConnectionsExampleViewEffect> = _viewEffect
 
-    fun startLinkAccountSession() {
+    fun startFinancialConnectionsSession() {
         viewModelScope.launch {
             setState {
                 copy(
                     loading = true,
-                    status = "Fetching link account session from example backend!"
+                    status = "Fetching financial connections session from example backend!"
                 )
             }
             kotlin.runCatching { repository.createLinkAccountSession() }
-                // Success creating session: open ConnectionsSheet with received secret
+                // Success creating session: open FinancialConnectionsSheet with received secret
                 .onSuccess {
                     setState {
                         copy(
                             loading = false,
-                            status = "Session created, opening ConnectionsSheet."
+                            status = "Session created, opening FinancialConnectionsSheet."
                         )
                     }
                     _viewEffect.emit(
@@ -56,7 +56,7 @@ class FinancialConnectionsExampleViewModel : ViewModel() {
                     setState {
                         copy(
                             loading = false,
-                            status = "Error starting linked account session: $it"
+                            status = "Error retrieving financial connections session: $it"
                         )
                     }
                 }
@@ -66,8 +66,8 @@ class FinancialConnectionsExampleViewModel : ViewModel() {
     fun onFinancialConnectionsSheetResult(result: FinancialConnectionsSheetResult) {
         val statusText = when (result) {
             is Completed -> {
-                val linkedAccountList = result.linkAccountSession.linkedAccounts
-                linkedAccountList.linkedAccounts.joinToString("\n") {
+                val accountList = result.financialConnectionsSession.accounts
+                accountList.financialConnectionsAccounts.joinToString("\n") {
                     "${it.institutionName} - ${it.displayName} - ${it.last4} - ${it.category}/${it.subcategory}"
                 }
             }

diff --git a/financial-connections-example/src/main/res/values/strings.xml b/financial-connections-example/src/main/res/values/strings.xml
@@ -1,4 +1,4 @@
 <resources>
     <string name="app_name">Financial Connections Example</string>
-    <string name="launch_connections_sheet">Link Account</string>
+    <string name="launch_connections_sheet">Connect an Account</string>
 </resources>
diff --git a/financial-connections/api/financial-connections.api b/financial-connections/api/financial-connections.api
diff --git a/...ctions/src/main/java/com/stripe/android/financialconnections/FinancialConnectionsSheet.kt b/...ctions/src/main/java/com/stripe/android/financialconnections/FinancialConnectionsSheet.kt
@@ -3,14 +3,13 @@ package com.stripe.android.financialconnections
 import android.os.Parcelable
 import androidx.activity.ComponentActivity
 import androidx.fragment.app.Fragment
-import com.stripe.android.connections.FinancialConnectionsSheetForTokenResult
 import com.stripe.android.financialconnections.launcher.DefaultFinancialConnectionsSheetLauncher
 import com.stripe.android.financialconnections.launcher.FinancialConnectionsSheetForTokenLauncher
 import com.stripe.android.financialconnections.launcher.FinancialConnectionsSheetLauncher
 import kotlinx.parcelize.Parcelize
 
 /**
- * A drop in class to present the Link Account Session Auth Flow.
+ * A drop in class to present the Financial Connections Auth Flow.
  *
  * This *must* be called unconditionally, as part of initialization path,
  * typically as a field initializer of an Activity or Fragment.
@@ -21,12 +20,12 @@ class FinancialConnectionsSheet internal constructor(
     /**
      * Configuration for a [FinancialConnectionsSheet]
      *
-     * @param linkAccountSessionClientSecret the client secret for the Link Account Session
+     * @param financialConnectionsSessionClientSecret the session client secret
      * @param publishableKey the Stripe publishable key
      */
     @Parcelize
     data class Configuration(
-        val linkAccountSessionClientSecret: String,
+        val financialConnectionsSessionClientSecret: String,
         val publishableKey: String,
     ) : Parcelable
 

diff --git a/...rc/main/java/com/stripe/android/financialconnections/FinancialConnectionsSheetActivity.kt b/...rc/main/java/com/stripe/android/financialconnections/FinancialConnectionsSheetActivity.kt
@@ -107,7 +107,7 @@ internal class FinancialConnectionsSheetActivity : AppCompatActivity() {
     }
 
     /**
-     * If the back button is pressed during the manifest fetch or link account session fetch
+     * If the back button is pressed during the manifest fetch or session fetch
      * return canceled result
      */
     override fun onBackPressed() {

diff --git a/...rc/main/java/com/stripe/android/financialconnections/FinancialConnectionsSheetContract.kt b/...rc/main/java/com/stripe/android/financialconnections/FinancialConnectionsSheetContract.kt
@@ -6,7 +6,7 @@ import android.os.Bundle
 import android.os.Parcelable
 import androidx.activity.result.contract.ActivityResultContract
 import androidx.core.os.bundleOf
-import com.stripe.android.financialconnections.model.LinkAccountSession
+import com.stripe.android.financialconnections.model.FinancialConnectionsSession
 import com.stripe.android.model.Token
 import kotlinx.parcelize.Parcelize
 import java.security.InvalidParameterException
@@ -48,9 +48,9 @@ internal class FinancialConnectionsSheetContract :
         ) : Args(configuration)
 
         fun validate() {
-            if (configuration.linkAccountSessionClientSecret.isBlank()) {
+            if (configuration.financialConnectionsSessionClientSecret.isBlank()) {
                 throw InvalidParameterException(
-                    "The link account session client secret cannot be an empty string."
+                    "The session client secret cannot be an empty string."
                 )
             }
             if (configuration.publishableKey.isBlank()) {
@@ -70,11 +70,11 @@ internal class FinancialConnectionsSheetContract :
     internal sealed class Result : Parcelable {
         /**
          * The customer completed the connections session.
-         * @param linkAccountSession The link account session connected
+         * @param financialConnectionsSession The financial connections session connected
          */
         @Parcelize
         data class Completed(
-            val linkAccountSession: LinkAccountSession,
+            val financialConnectionsSession: FinancialConnectionsSession,
             val token: Token? = null
         ) : Result()
 
@@ -100,8 +100,8 @@ internal class FinancialConnectionsSheetContract :
 
     companion object {
         const val EXTRA_ARGS =
-            "com.stripe.android.connections.ConnectionsSheetContract.extra_args"
+            "com.stripe.android.financialconnections.ConnectionsSheetContract.extra_args"
         private const val EXTRA_RESULT =
-            "com.stripe.android.connections.ConnectionsSheetContract.extra_result"
+            "com.stripe.android.financialconnections.ConnectionsSheetContract.extra_result"
     }
 }
diff --git a/...n/java/com/stripe/android/financialconnections/FinancialConnectionsSheetForTokenResult.kt b/...n/java/com/stripe/android/financialconnections/FinancialConnectionsSheetForTokenResult.kt
@@ -1,7 +1,7 @@
-package com.stripe.android.connections
+package com.stripe.android.financialconnections
 
 import android.os.Parcelable
-import com.stripe.android.financialconnections.model.LinkAccountSession
+import com.stripe.android.financialconnections.model.FinancialConnectionsSession
 import com.stripe.android.model.Token
 import kotlinx.parcelize.Parcelize
 
@@ -11,11 +11,11 @@ import kotlinx.parcelize.Parcelize
 sealed class FinancialConnectionsSheetForTokenResult : Parcelable {
     /**
      * The customer completed the connections session.
-     * @param linkAccountSession The link account session connected
+     * @param financialConnectionsSession The financial connections session connected
      */
     @Parcelize
     data class Completed(
-        val linkAccountSession: LinkAccountSession,
+        val financialConnectionsSession: FinancialConnectionsSession,
         val token: Token
     ) : FinancialConnectionsSheetForTokenResult()
 

diff --git a/.../src/main/java/com/stripe/android/financialconnections/FinancialConnectionsSheetResult.kt b/.../src/main/java/com/stripe/android/financialconnections/FinancialConnectionsSheetResult.kt
@@ -1,7 +1,7 @@
 package com.stripe.android.financialconnections
 
 import android.os.Parcelable
-import com.stripe.android.financialconnections.model.LinkAccountSession
+import com.stripe.android.financialconnections.model.FinancialConnectionsSession
 import kotlinx.parcelize.Parcelize
 
 /**
@@ -10,11 +10,11 @@ import kotlinx.parcelize.Parcelize
 sealed class FinancialConnectionsSheetResult : Parcelable {
     /**
      * The customer completed the connections session.
-     * @param linkAccountSession The link account session connected
+     * @param financialConnectionsSession The financial connections session connected
      */
     @Parcelize
     data class Completed(
-        val linkAccountSession: LinkAccountSession
+        val financialConnectionsSession: FinancialConnectionsSession
     ) : FinancialConnectionsSheetResult()
 
     /**

diff --git a/...s/src/main/java/com/stripe/android/financialconnections/FinancialConnectionsSheetState.kt b/...s/src/main/java/com/stripe/android/financialconnections/FinancialConnectionsSheetState.kt
@@ -1,14 +1,14 @@
 package com.stripe.android.financialconnections
 
 import androidx.lifecycle.SavedStateHandle
-import com.stripe.android.financialconnections.model.LinkAccountSessionManifest
+import com.stripe.android.financialconnections.model.FinancialConnectionsSessionManifest
 
 /**
  *  Class containing all of the data needed to represent the screen.
  */
 internal data class FinancialConnectionsSheetState(
     val activityRecreated: Boolean = false,
-    val manifest: LinkAccountSessionManifest? = null,
+    val manifest: FinancialConnectionsSessionManifest? = null,
     val authFlowActive: Boolean = false
 ) {
 

diff --git a/...c/main/java/com/stripe/android/financialconnections/FinancialConnectionsSheetViewModel.kt b/...c/main/java/com/stripe/android/financialconnections/FinancialConnectionsSheetViewModel.kt
@@ -8,7 +8,6 @@ import androidx.lifecycle.SavedStateHandle
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
 import androidx.savedstate.SavedStateRegistryOwner
-import com.stripe.android.connections.domain.FetchLinkAccountSessionForToken
 import com.stripe.android.financialconnections.FinancialConnectionsSheetContract.Result.Canceled
 import com.stripe.android.financialconnections.FinancialConnectionsSheetContract.Result.Completed
 import com.stripe.android.financialconnections.FinancialConnectionsSheetContract.Result.Failed
@@ -17,10 +16,11 @@ import com.stripe.android.financialconnections.FinancialConnectionsSheetViewEffe
 import com.stripe.android.financialconnections.analytics.FinancialConnectionsEventReporter
 import com.stripe.android.financialconnections.di.APPLICATION_ID
 import com.stripe.android.financialconnections.di.DaggerFinancialConnectionsSheetComponent
-import com.stripe.android.financialconnections.domain.FetchLinkAccountSession
-import com.stripe.android.financialconnections.domain.GenerateLinkAccountSessionManifest
-import com.stripe.android.financialconnections.model.LinkAccountSession
-import com.stripe.android.financialconnections.model.LinkAccountSessionManifest
+import com.stripe.android.financialconnections.domain.FetchFinancialConnectionsSession
+import com.stripe.android.financialconnections.domain.FetchFinancialConnectionsSessionForToken
+import com.stripe.android.financialconnections.domain.GenerateFinancialConnectionsSessionManifest
+import com.stripe.android.financialconnections.model.FinancialConnectionsSession
+import com.stripe.android.financialconnections.model.FinancialConnectionsSessionManifest
 import kotlinx.coroutines.flow.MutableSharedFlow
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.SharedFlow
@@ -34,9 +34,9 @@ import javax.inject.Named
 internal class FinancialConnectionsSheetViewModel @Inject constructor(
     @Named(APPLICATION_ID) private val applicationId: String,
     private val starterArgs: FinancialConnectionsSheetContract.Args,
-    private val generateLinkAccountSessionManifest: GenerateLinkAccountSessionManifest,
-    private val fetchLinkAccountSession: FetchLinkAccountSession,
-    private val fetchLinkAccountSessionForToken: FetchLinkAccountSessionForToken,
+    private val generateFinancialConnectionsSessionManifest: GenerateFinancialConnectionsSessionManifest,
+    private val fetchFinancialConnectionsSession: FetchFinancialConnectionsSession,
+    private val fetchFinancialConnectionsSessionForToken: FetchFinancialConnectionsSessionForToken,
     private val savedStateHandle: SavedStateHandle,
     private val eventReporter: FinancialConnectionsEventReporter
 ) : ViewModel() {
@@ -57,14 +57,14 @@ internal class FinancialConnectionsSheetViewModel @Inject constructor(
     }
 
     /**
-     * Fetches the [LinkAccountSessionManifest] from the Stripe API to get the hosted auth flow URL
+     * Fetches the [FinancialConnectionsSessionManifest] from the Stripe API to get the hosted auth flow URL
      * as well as the success and cancel callback URLs to verify.
      */
     private fun fetchManifest() {
         viewModelScope.launch {
             kotlin.runCatching {
-                generateLinkAccountSessionManifest(
-                    clientSecret = starterArgs.configuration.linkAccountSessionClientSecret,
+                generateFinancialConnectionsSessionManifest(
+                    clientSecret = starterArgs.configuration.financialConnectionsSessionClientSecret,
                     applicationId = applicationId
                 )
             }.onFailure {
@@ -81,7 +81,7 @@ internal class FinancialConnectionsSheetViewModel @Inject constructor(
      * @param manifest the manifest containing the hosted auth flow URL to launch
      *
      */
-    private suspend fun openAuthFlow(manifest: LinkAccountSessionManifest) {
+    private suspend fun openAuthFlow(manifest: FinancialConnectionsSessionManifest) {
         // stores manifest in state for future references.
         _state.updateAndPersist {
             it.copy(
@@ -139,16 +139,16 @@ internal class FinancialConnectionsSheetViewModel @Inject constructor(
     }
 
     /**
-     * For regular connections flows requesting a link account session:
+     * For regular connections flows requesting a session:
      *
      * On successfully completing the hosted auth flow and receiving the success callback intent,
-     * fetch the updated [LinkAccountSession] model from the API
+     * fetch the updated [FinancialConnectionsSession] model from the API
      * and return it back as a [Completed] result.
      */
-    private fun fetchLinkAccountSession() {
+    private fun fetchFinancialConnectionsSession() {
         viewModelScope.launch {
             kotlin.runCatching {
-                fetchLinkAccountSession(starterArgs.configuration.linkAccountSessionClientSecret)
+                fetchFinancialConnectionsSession(starterArgs.configuration.financialConnectionsSessionClientSecret)
             }.onSuccess {
                 val result = Completed(it)
                 eventReporter.onResult(starterArgs.configuration, result)
@@ -163,13 +163,15 @@ internal class FinancialConnectionsSheetViewModel @Inject constructor(
      * For connections flows requesting an account [com.stripe.android.model.Token]:
      *
      * On successfully completing the hosted auth flow and receiving the success callback intent,
-     * fetch the updated [LinkAccountSession] and the generated [com.stripe.android.model.Token]
+     * fetch the updated [FinancialConnectionsSession] and the generated [com.stripe.android.model.Token]
      * and return it back as a [Completed] result.
      */
-    private fun fetchLinkAccountSessionForToken() {
+    private fun fetchFinancialConnectionsSessionForToken() {
         viewModelScope.launch {
             kotlin.runCatching {
-                fetchLinkAccountSessionForToken(starterArgs.configuration.linkAccountSessionClientSecret)
+                fetchFinancialConnectionsSessionForToken(
+                    clientSecret = starterArgs.configuration.financialConnectionsSessionClientSecret
+                )
             }.onSuccess { (las, token) ->
                 val result = Completed(las, token)
                 eventReporter.onResult(starterArgs.configuration, result)
@@ -217,8 +219,8 @@ internal class FinancialConnectionsSheetViewModel @Inject constructor(
             val manifest = _state.value.manifest
             when (intent?.data.toString()) {
                 manifest?.successUrl -> when (starterArgs) {
-                    is FinancialConnectionsSheetContract.Args.Default -> fetchLinkAccountSession()
-                    is FinancialConnectionsSheetContract.Args.ForToken -> fetchLinkAccountSessionForToken()
+                    is FinancialConnectionsSheetContract.Args.Default -> fetchFinancialConnectionsSession()
+                    is FinancialConnectionsSheetContract.Args.ForToken -> fetchFinancialConnectionsSessionForToken()
                 }
                 manifest?.cancelUrl -> onUserCancel()
                 else -> onFatal(Exception("Error processing FinancialConnectionsSheet intent"))

diff --git a/...ncialFinancialConnectionsEventReporter.kt → ...faultFinancialConnectionsEventReporter.kt b/...ncialFinancialConnectionsEventReporter.kt → ...faultFinancialConnectionsEventReporter.kt
@@ -10,7 +10,7 @@ import kotlinx.coroutines.launch
 import javax.inject.Inject
 import kotlin.coroutines.CoroutineContext
 
-internal class DefaultFinancialFinancialConnectionsEventReporter @Inject constructor(
+internal class DefaultFinancialConnectionsEventReporter @Inject constructor(
     private val analyticsRequestExecutor: AnalyticsRequestExecutor,
     private val analyticsRequestFactory: AnalyticsRequestFactory,
     @IOContext private val workContext: CoroutineContext
@@ -20,7 +20,7 @@ internal class DefaultFinancialFinancialConnectionsEventReporter @Inject constru
         fireEvent(
             FinancialConnectionsAnalyticsEvent(
                 FinancialConnectionsAnalyticsEvent.Code.SheetPresented,
-                mapOf(PARAM_CLIENT_SECRET to configuration.linkAccountSessionClientSecret)
+                mapOf(PARAM_CLIENT_SECRET to configuration.financialConnectionsSessionClientSecret)
             )
         )
     }
@@ -34,23 +34,23 @@ internal class DefaultFinancialFinancialConnectionsEventReporter @Inject constru
                 FinancialConnectionsAnalyticsEvent(
                     FinancialConnectionsAnalyticsEvent.Code.SheetClosed,
                     mapOf(
-                        PARAM_CLIENT_SECRET to configuration.linkAccountSessionClientSecret,
+                        PARAM_CLIENT_SECRET to configuration.financialConnectionsSessionClientSecret,
                         PARAM_SESSION_RESULT to "completed"
                     )
                 )
             is FinancialConnectionsSheetContract.Result.Canceled ->
                 FinancialConnectionsAnalyticsEvent(
                     FinancialConnectionsAnalyticsEvent.Code.SheetClosed,
                     mapOf(
-                        PARAM_CLIENT_SECRET to configuration.linkAccountSessionClientSecret,
+                        PARAM_CLIENT_SECRET to configuration.financialConnectionsSessionClientSecret,
                         PARAM_SESSION_RESULT to "cancelled"
                     )
                 )
             is FinancialConnectionsSheetContract.Result.Failed ->
                 FinancialConnectionsAnalyticsEvent(
                     FinancialConnectionsAnalyticsEvent.Code.SheetFailed,
                     mapOf(
-                        PARAM_CLIENT_SECRET to configuration.linkAccountSessionClientSecret,
+                        PARAM_CLIENT_SECRET to configuration.financialConnectionsSessionClientSecret,
                         PARAM_SESSION_RESULT to "failure"
                     )
                 )