Merge branch '328-pace-drive-business-starter-new-sdk-handlers' into 'master'

MelissaAtPace · MelissaAtPace · commit 6374dc267f00 · 2024-08-30T14:12:29.000Z
Resolve "[PACE Drive Business Starter] New SDK Handlers"

Closes #328

See merge request pace/mobile/android/pace-cloud-sdk!356
diff --git a/library/src/main/java/cloud/pace/sdk/appkit/app/webview/AppWebViewModel.kt b/library/src/main/java/cloud/pace/sdk/appkit/app/webview/AppWebViewModel.kt
@@ -32,6 +32,8 @@ import cloud.pace.sdk.appkit.communication.generated.model.request.GooglePayPaym
 import cloud.pace.sdk.appkit.communication.generated.model.request.ImageDataRequest
 import cloud.pace.sdk.appkit.communication.generated.model.request.LogEventRequest
 import cloud.pace.sdk.appkit.communication.generated.model.request.OpenURLInNewTabRequest
+import cloud.pace.sdk.appkit.communication.generated.model.request.ReceiptAttachmentsRequest
+import cloud.pace.sdk.appkit.communication.generated.model.request.ReceiptEmailRequest
 import cloud.pace.sdk.appkit.communication.generated.model.request.SetSecureDataRequest
 import cloud.pace.sdk.appkit.communication.generated.model.request.SetTOTPRequest
 import cloud.pace.sdk.appkit.communication.generated.model.request.SetUserPropertyRequest
@@ -97,6 +99,12 @@ import cloud.pace.sdk.appkit.communication.generated.model.response.LogoutError
 import cloud.pace.sdk.appkit.communication.generated.model.response.LogoutResult
 import cloud.pace.sdk.appkit.communication.generated.model.response.OpenURLInNewTabError
 import cloud.pace.sdk.appkit.communication.generated.model.response.OpenURLInNewTabResult
+import cloud.pace.sdk.appkit.communication.generated.model.response.ReceiptAttachmentsError
+import cloud.pace.sdk.appkit.communication.generated.model.response.ReceiptAttachmentsResponse
+import cloud.pace.sdk.appkit.communication.generated.model.response.ReceiptAttachmentsResult
+import cloud.pace.sdk.appkit.communication.generated.model.response.ReceiptEmailError
+import cloud.pace.sdk.appkit.communication.generated.model.response.ReceiptEmailResponse
+import cloud.pace.sdk.appkit.communication.generated.model.response.ReceiptEmailResult
 import cloud.pace.sdk.appkit.communication.generated.model.response.Result
 import cloud.pace.sdk.appkit.communication.generated.model.response.SetSecureDataError
 import cloud.pace.sdk.appkit.communication.generated.model.response.SetSecureDataResult
@@ -925,6 +933,30 @@ class AppWebViewModelImpl(
         }
     }
 
+    override suspend fun receiptEmail(timeout: Long?, receiptEmailRequest: ReceiptEmailRequest): ReceiptEmailResult {
+        return handleAsync(
+            timeout,
+            ReceiptEmailResult(ReceiptEmailResult.Failure(ReceiptEmailResult.Failure.StatusCode.RequestTimeout, ReceiptEmailError("Timeout for receiptEmail"))),
+            ReceiptEmailResult(ReceiptEmailResult.Failure(ReceiptEmailResult.Failure.StatusCode.InternalServerError, ReceiptEmailError("An error occurred")))
+        ) { continuation ->
+            appModel.onReceiptEmailRequestReceived(receiptEmailRequest.paymentMethod) {
+                continuation.resumeIfActive(ReceiptEmailResult(ReceiptEmailResult.Success(ReceiptEmailResponse(it))))
+            }
+        }
+    }
+
+    override suspend fun receiptAttachments(timeout: Long?, receiptAttachmentsRequest: ReceiptAttachmentsRequest): ReceiptAttachmentsResult {
+        return handleAsync(
+            timeout,
+            ReceiptAttachmentsResult(ReceiptAttachmentsResult.Failure(ReceiptAttachmentsResult.Failure.StatusCode.RequestTimeout, ReceiptAttachmentsError("Timeout for receiptAttachments"))),
+            ReceiptAttachmentsResult(ReceiptAttachmentsResult.Failure(ReceiptAttachmentsResult.Failure.StatusCode.InternalServerError, ReceiptAttachmentsError("An error occurred")))
+        ) { continuation ->
+            appModel.onReceiptAttachmentsRequestReceived(receiptAttachmentsRequest.paymentMethod) {
+                continuation.resumeIfActive(ReceiptAttachmentsResult(ReceiptAttachmentsResult.Success(ReceiptAttachmentsResponse(it))))
+            }
+        }
+    }
+
     private fun handleImageData(image: String): Boolean {
         return try {
             val decodedString = Base64.decode(image, Base64.DEFAULT)
diff --git a/library/src/main/java/cloud/pace/sdk/appkit/communication/AppCallback.kt b/library/src/main/java/cloud/pace/sdk/appkit/communication/AppCallback.kt
@@ -176,6 +176,22 @@ interface AppCallback {
      * @param name The name of the location.
      */
     fun onNavigationRequestReceived(lat: Double, lon: Double, name: String)
+
+    /**
+     * Is called when the app asks for an additional email to send the receipt to besides the user's email
+     *
+     * @param paymentMethod For which payment method the email is requested
+     * @param email Call this function to specify an email or not
+     */
+    fun onReceiptEmailRequestReceived(paymentMethod: String, email: (String?) -> Unit)
+
+    /**
+     * Is called when the app asks for additional attachments that should be printed on the fueling receipt
+     *
+     * @param paymentMethod For which payment method the attachments are requested
+     * @param attachments Call this function to specify attachments or not
+     */
+    fun onReceiptAttachmentsRequestReceived(paymentMethod: String, attachments: (List<String>?) -> Unit)
 }
 
 abstract class AppCallbackImpl : AppCallback, CloudSDKKoinComponent {
@@ -235,4 +251,12 @@ abstract class AppCallbackImpl : AppCallback, CloudSDKKoinComponent {
     override fun onNavigationRequestReceived(lat: Double, lon: Double, name: String) {
         appModel.startNavigation(lat, lon)
     }
+
+    override fun onReceiptEmailRequestReceived(paymentMethod: String, email: (String?) -> Unit) {
+        email(null)
+    }
+
+    override fun onReceiptAttachmentsRequestReceived(paymentMethod: String, attachments: (List<String>?) -> Unit) {
+        attachments(null)
+    }
 }
diff --git a/library/src/main/java/cloud/pace/sdk/appkit/communication/AppModel.kt b/library/src/main/java/cloud/pace/sdk/appkit/communication/AppModel.kt
@@ -74,6 +74,8 @@ interface AppModel {
     fun onGooglePayAvailabilityRequest(request: GooglePayAvailabilityCheckRequest, onResult: (Completion<GooglePayAvailabilityCheckResponse>) -> Unit)
     fun onGooglePayPayment(googlePayPaymentRequest: GooglePayPaymentRequest, onResult: (Completion<GooglePayPaymentResponse>) -> Unit)
     fun onNavigationRequestReceived(lat: Double, lon: Double, name: String)
+    fun onReceiptEmailRequestReceived(paymentMethod: String, email: (String?) -> Unit)
+    fun onReceiptAttachmentsRequestReceived(paymentMethod: String, attachments: (List<String>?) -> Unit)
 
     class Result<T>(val onResult: (T) -> Unit)
 }
@@ -386,6 +388,18 @@ class AppModelImpl(
         }
     }
 
+    override fun onReceiptEmailRequestReceived(paymentMethod: String, email: (String?) -> Unit) {
+        coroutineScope.launch {
+            callback?.onReceiptEmailRequestReceived(paymentMethod, email)
+        }
+    }
+
+    override fun onReceiptAttachmentsRequestReceived(paymentMethod: String, attachments: (List<String>?) -> Unit) {
+        coroutineScope.launch {
+            callback?.onReceiptAttachmentsRequestReceived(paymentMethod, attachments)
+        }
+    }
+
     companion object {
         private const val SHARED_DIRECTORY_NAME = "shared"
         private const val RECEIPT_FILENAME = "receipt"
diff --git a/library/src/main/java/cloud/pace/sdk/appkit/communication/generated/Communication.kt b/library/src/main/java/cloud/pace/sdk/appkit/communication/generated/Communication.kt
@@ -18,6 +18,8 @@ import cloud.pace.sdk.appkit.communication.generated.model.request.GooglePayPaym
 import cloud.pace.sdk.appkit.communication.generated.model.request.ImageDataRequest
 import cloud.pace.sdk.appkit.communication.generated.model.request.LogEventRequest
 import cloud.pace.sdk.appkit.communication.generated.model.request.OpenURLInNewTabRequest
+import cloud.pace.sdk.appkit.communication.generated.model.request.ReceiptAttachmentsRequest
+import cloud.pace.sdk.appkit.communication.generated.model.request.ReceiptEmailRequest
 import cloud.pace.sdk.appkit.communication.generated.model.request.SetSecureDataRequest
 import cloud.pace.sdk.appkit.communication.generated.model.request.SetTOTPRequest
 import cloud.pace.sdk.appkit.communication.generated.model.request.SetUserPropertyRequest
@@ -48,6 +50,8 @@ import cloud.pace.sdk.appkit.communication.generated.model.response.IsSignedInRe
 import cloud.pace.sdk.appkit.communication.generated.model.response.LogEventResult
 import cloud.pace.sdk.appkit.communication.generated.model.response.LogoutResult
 import cloud.pace.sdk.appkit.communication.generated.model.response.OpenURLInNewTabResult
+import cloud.pace.sdk.appkit.communication.generated.model.response.ReceiptAttachmentsResult
+import cloud.pace.sdk.appkit.communication.generated.model.response.ReceiptEmailResult
 import cloud.pace.sdk.appkit.communication.generated.model.response.SetSecureDataResult
 import cloud.pace.sdk.appkit.communication.generated.model.response.SetTOTPResult
 import cloud.pace.sdk.appkit.communication.generated.model.response.SetUserPropertyResult
@@ -345,4 +349,25 @@ public interface Communication {
      * @param shareFileRequest The shareFile request body object
      */
     public suspend fun shareFile(timeout: Long?, shareFileRequest: ShareFileRequest): ShareFileResult
+
+    /**
+     * Asks the client for an optional additional receipt email.
+     *
+     * @param timeout The timeout of receiptEmail in milliseconds or null if no timeout should be used
+     * @param receiptEmailRequest The receiptEmail request body object
+     */
+    public suspend fun receiptEmail(timeout: Long?, receiptEmailRequest: ReceiptEmailRequest):
+        ReceiptEmailResult
+
+    /**
+     * Asks the client for optional attachments to be included in the fueling receipt.
+     *
+     * @param timeout The timeout of receiptAttachments in milliseconds or null if no timeout should
+     * be used
+     * @param receiptAttachmentsRequest The receiptAttachments request body object
+     */
+    public suspend fun receiptAttachments(
+        timeout: Long?,
+        receiptAttachmentsRequest: ReceiptAttachmentsRequest
+    ): ReceiptAttachmentsResult
 }
diff --git a/library/src/main/java/cloud/pace/sdk/appkit/communication/generated/CommunicationManager.kt b/library/src/main/java/cloud/pace/sdk/appkit/communication/generated/CommunicationManager.kt
@@ -18,6 +18,8 @@ import cloud.pace.sdk.appkit.communication.generated.model.request.GooglePayPaym
 import cloud.pace.sdk.appkit.communication.generated.model.request.ImageDataRequest
 import cloud.pace.sdk.appkit.communication.generated.model.request.LogEventRequest
 import cloud.pace.sdk.appkit.communication.generated.model.request.OpenURLInNewTabRequest
+import cloud.pace.sdk.appkit.communication.generated.model.request.ReceiptAttachmentsRequest
+import cloud.pace.sdk.appkit.communication.generated.model.request.ReceiptEmailRequest
 import cloud.pace.sdk.appkit.communication.generated.model.request.Request
 import cloud.pace.sdk.appkit.communication.generated.model.request.SetSecureDataRequest
 import cloud.pace.sdk.appkit.communication.generated.model.request.SetTOTPRequest
@@ -672,6 +674,56 @@ public data class CommunicationManager(
                 }
             }
 
+            "/receiptEmail" -> {
+                CoroutineScope(Dispatchers.Default).launch {
+                    val timeout = (request.header?.get("Keep-Alive") as? Double)?.toLong()?.let {
+                        TimeUnit.SECONDS.toMillis(it)
+                    }
+                    val receiptEmailRequest = gson.fromJson<ReceiptEmailRequest>(message)
+                    val body = receiptEmailRequest?.body
+                    if (body == null) {
+                        withContext(Dispatchers.Main) {
+                            respond(
+                                Response(
+                                    request.id, HttpURLConnection.HTTP_BAD_REQUEST, request.header,
+                                    Message("Could not deserialize the JSON request message")
+                                )
+                            )
+                        }
+                    } else {
+                        val result = listener.receiptEmail(timeout, body)
+                        withContext(Dispatchers.Main) {
+                            respond(Response(request.id, result.status, request.header, result.body))
+                        }
+                    }
+                }
+            }
+
+            "/receiptAttachments" -> {
+                CoroutineScope(Dispatchers.Default).launch {
+                    val timeout = (request.header?.get("Keep-Alive") as? Double)?.toLong()?.let {
+                        TimeUnit.SECONDS.toMillis(it)
+                    }
+                    val receiptAttachmentsRequest = gson.fromJson<ReceiptAttachmentsRequest>(message)
+                    val body = receiptAttachmentsRequest?.body
+                    if (body == null) {
+                        withContext(Dispatchers.Main) {
+                            respond(
+                                Response(
+                                    request.id, HttpURLConnection.HTTP_BAD_REQUEST, request.header,
+                                    Message("Could not deserialize the JSON request message")
+                                )
+                            )
+                        }
+                    } else {
+                        val result = listener.receiptAttachments(timeout, body)
+                        withContext(Dispatchers.Main) {
+                            respond(Response(request.id, result.status, request.header, result.body))
+                        }
+                    }
+                }
+            }
+
             else -> {
                 CoroutineScope(Dispatchers.Main).launch {
                     respond(
diff --git a/library/src/main/java/cloud/pace/sdk/appkit/communication/generated/Metadata.kt b/library/src/main/java/cloud/pace/sdk/appkit/communication/generated/Metadata.kt
@@ -25,6 +25,7 @@ public object Metadata {
         "/applePayAvailabilityCheck", "/back", "/appInterceptableLink", "/setUserProperty",
         "/logEvent", "/getConfig", "/getTraceId", "/getLocation", "/appRedirect",
         "/isBiometricAuthEnabled", "/isSignedIn", "/isRemoteConfigAvailable", "/shareText",
-        "/googlePayAvailabilityCheck", "/googlePayPayment", "/startNavigation", "/shareFile"
+        "/googlePayAvailabilityCheck", "/googlePayPayment", "/startNavigation", "/shareFile",
+        "/receiptEmail", "/receiptAttachments"
     )
 }
diff --git a/library/src/main/java/cloud/pace/sdk/appkit/communication/generated/model/request/ReceiptAttachmentsRequest.kt b/library/src/main/java/cloud/pace/sdk/appkit/communication/generated/model/request/ReceiptAttachmentsRequest.kt
@@ -0,0 +1,14 @@
+//
+// Generated by KotlinPoet:
+// https://github.com/square/kotlinpoet
+//    
+// Please do not edit!
+//
+package cloud.pace.sdk.appkit.communication.generated.model.request
+
+public data class ReceiptAttachmentsRequest(
+    /**
+     * The id of the user payment method.
+     */
+    public val paymentMethod: String
+)
diff --git a/library/src/main/java/cloud/pace/sdk/appkit/communication/generated/model/request/ReceiptEmailRequest.kt b/library/src/main/java/cloud/pace/sdk/appkit/communication/generated/model/request/ReceiptEmailRequest.kt
@@ -0,0 +1,14 @@
+//
+// Generated by KotlinPoet:
+// https://github.com/square/kotlinpoet
+//    
+// Please do not edit!
+//
+package cloud.pace.sdk.appkit.communication.generated.model.request
+
+public data class ReceiptEmailRequest(
+    /**
+     * The id of the user payment method.
+     */
+    public val paymentMethod: String
+)
diff --git a/library/src/main/java/cloud/pace/sdk/appkit/communication/generated/model/response/ReceiptAttachmentsResult.kt b/library/src/main/java/cloud/pace/sdk/appkit/communication/generated/model/response/ReceiptAttachmentsResult.kt
@@ -0,0 +1,42 @@
+//
+// Generated by KotlinPoet:
+// https://github.com/square/kotlinpoet
+//    
+// Please do not edit!
+//
+package cloud.pace.sdk.appkit.communication.generated.model.response
+
+public data class ReceiptAttachmentsResponse(
+    public val attachments: List<String>?
+) : ResponseBody()
+
+public data class ReceiptAttachmentsError(
+    public val message: String? = null
+) : ResponseBody()
+
+public class ReceiptAttachmentsResult private constructor(
+    status: Int,
+    body: ResponseBody?
+) : Result(status, body) {
+    public constructor(success: Success) : this(200, success.response)
+
+    public constructor(failure: Failure) : this(failure.statusCode.code, failure.response)
+
+    public class Success(
+        public val response: ReceiptAttachmentsResponse
+    )
+
+    public class Failure(
+        public val statusCode: StatusCode,
+        public val response: ReceiptAttachmentsError
+    ) {
+        public enum class StatusCode(
+            public val code: Int
+        ) {
+            BadRequest(400),
+            RequestTimeout(408),
+            InternalServerError(500),
+            ;
+        }
+    }
+}
diff --git a/library/src/main/java/cloud/pace/sdk/appkit/communication/generated/model/response/ReceiptEmailResult.kt b/library/src/main/java/cloud/pace/sdk/appkit/communication/generated/model/response/ReceiptEmailResult.kt
@@ -0,0 +1,42 @@
+//
+// Generated by KotlinPoet:
+// https://github.com/square/kotlinpoet
+//    
+// Please do not edit!
+//
+package cloud.pace.sdk.appkit.communication.generated.model.response
+
+public data class ReceiptEmailResponse(
+    public val email: String?
+) : ResponseBody()
+
+public data class ReceiptEmailError(
+    public val message: String? = null
+) : ResponseBody()
+
+public class ReceiptEmailResult private constructor(
+    status: Int,
+    body: ResponseBody?
+) : Result(status, body) {
+    public constructor(success: Success) : this(200, success.response)
+
+    public constructor(failure: Failure) : this(failure.statusCode.code, failure.response)
+
+    public class Success(
+        public val response: ReceiptEmailResponse
+    )
+
+    public class Failure(
+        public val statusCode: StatusCode,
+        public val response: ReceiptEmailError
+    ) {
+        public enum class StatusCode(
+            public val code: Int
+        ) {
+            BadRequest(400),
+            RequestTimeout(408),
+            InternalServerError(500),
+            ;
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@ public object Metadata {`
`25`	`25`	`"/applePayAvailabilityCheck", "/back", "/appInterceptableLink", "/setUserProperty",`
`26`	`26`	`"/logEvent", "/getConfig", "/getTraceId", "/getLocation", "/appRedirect",`
`27`	`27`	`"/isBiometricAuthEnabled", "/isSignedIn", "/isRemoteConfigAvailable", "/shareText",`
`28`		`- "/googlePayAvailabilityCheck", "/googlePayPayment", "/startNavigation", "/shareFile"`
	`28`	`+ "/googlePayAvailabilityCheck", "/googlePayPayment", "/startNavigation", "/shareFile",`
	`29`	`+ "/receiptEmail", "/receiptAttachments"`
`29`	`30`	`)`
`30`	`31`	`}`